(cvs-menu): Don't move point. Use popup-menu.
[emacs.git] / man / gnus.texi
blob59021f3510d3f80818e1993c9a700716d3352de0
1 \input texinfo                  @c -*-texinfo-*-
3 @setfilename ../info/gnus
4 @settitle Gnus Manual
5 @synindex fn cp
6 @synindex vr cp
7 @synindex pg cp
8 @direntry
9 * Gnus: (gnus).         The newsreader Gnus.
10 @end direntry
11 @iftex
12 @finalout
13 @end iftex
14 @setchapternewpage odd
16 @iftex
17 @end iftex
20 @ifinfo
22 This file documents Gnus, the GNU Emacs newsreader.
24 Copyright (C) 1995,96 Free Software Foundation, Inc.
26 Permission is granted to make and distribute verbatim copies of
27 this manual provided the copyright notice and this permission notice
28 are preserved on all copies.
30 @ignore
31 Permission is granted to process this file through Tex and print the
32 results, provided the printed document carries copying permission
33 notice identical to this one except for the removal of this paragraph
34 (this paragraph not being relevant to the printed manual).
36 @end ignore
37 Permission is granted to copy and distribute modified versions of this
38 manual under the conditions for verbatim copying, provided also that the
39 entire resulting derived work is distributed under the terms of a
40 permission notice identical to this one.
42 Permission is granted to copy and distribute translations of this manual
43 into another language, under the above conditions for modified versions.
44 @end ifinfo
46 @tex
48 @titlepage
49 @title Gnus 5.7 Manual
51 @author by Lars Magne Ingebrigtsen
52 @page
54 @vskip 0pt plus 1filll
55 Copyright @copyright{} 1995,96,97 Free Software Foundation, Inc.
57 Permission is granted to make and distribute verbatim copies of
58 this manual provided the copyright notice and this permission notice
59 are preserved on all copies.
61 Permission is granted to copy and distribute modified versions of this
62 manual under the conditions for verbatim copying, provided that the
63 entire resulting derived work is distributed under the terms of a
64 permission notice identical to this one.
66 Permission is granted to copy and distribute translations of this manual
67 into another language, under the above conditions for modified versions.
69 @end titlepage
70 @page
72 @end tex
75 @node Top
76 @top The Gnus Newsreader
78 @ifinfo
80 You can read news (and mail) from within Emacs by using Gnus.  The news
81 can be gotten by any nefarious means you can think of---@sc{nntp}, local
82 spool or your mbox file.  All at the same time, if you want to push your
83 luck.
85 This manual corresponds to Gnus 5.7.
87 @end ifinfo
89 @iftex
91 Gnus is the advanced, self-documenting, customizable, extensible
92 unreal-time newsreader for GNU Emacs.
94 Oops.  That sounds oddly familiar, so let's start over again to avoid
95 being accused of plagiarism:
97 Gnus is a message-reading laboratory.  It will let you look at just
98 about anything as if it were a newsgroup.  You can read mail with it,
99 you can browse directories with it, you can @code{ftp} with it---you can
100 even read news with it!
102 Gnus tries to empower people who read news the same way Emacs empowers
103 people who edit text.  Gnus sets no limits to what the user should be
104 allowed to do.  Users are encouraged to extend Gnus to make it behave
105 like they want it to behave.  A program should not control people;
106 people should be empowered to do what they want by using (or abusing)
107 the program.
109 @end iftex
112 @menu
113 * Starting Up::           Finding news can be a pain.
114 * The Group Buffer::      Selecting, subscribing and killing groups.
115 * The Summary Buffer::    Reading, saving and posting articles.
116 * The Article Buffer::    Displaying and handling articles.
117 * Composing Messages::    Information on sending mail and news.
118 * Select Methods::        Gnus reads all messages from various select methods.
119 * Scoring::               Assigning values to articles.
120 * Various::               General purpose settings.
121 * The End::               Farewell and goodbye.
122 * Appendices::            Terminology, Emacs intro, FAQ, History, Internals.
123 * Index::                 Variable, function and concept index.
124 * Key Index::             Key Index.
125 @end menu
127 @node Starting Up
128 @chapter Starting Gnus
129 @cindex starting up
131 @kindex M-x gnus
132 @findex gnus
133 If your system administrator has set things up properly, starting Gnus
134 and reading news is extremely easy---you just type @kbd{M-x gnus} in
135 your Emacs.
137 @findex gnus-other-frame
138 @kindex M-x gnus-other-frame
139 If you want to start Gnus in a different frame, you can use the command
140 @kbd{M-x gnus-other-frame} instead.
142 If things do not go smoothly at startup, you have to twiddle some
143 variables in your @file{~/.gnus} file.  This file is similar to
144 @file{~/.emacs}, but is read when gnus starts.
146 If you puzzle at any terms used in this manual, please refer to the
147 terminology section (@pxref{Terminology}).
149 @menu
150 * Finding the News::    Choosing a method for getting news.
151 * The First Time::      What does Gnus do the first time you start it?
152 * The Server is Down::  How can I read my mail then?
153 * Slave Gnusae::        You can have more than one Gnus active at a time.
154 * Fetching a Group::    Starting Gnus just to read a group.
155 * New Groups::          What is Gnus supposed to do with new groups?
156 * Startup Files::       Those pesky startup files---@file{.newsrc}.
157 * Auto Save::           Recovering from a crash.
158 * The Active File::     Reading the active file over a slow line Takes Time.
159 * Changing Servers::    You may want to move from one server to another.
160 * Startup Variables::   Other variables you might change.
161 @end menu
164 @node Finding the News
165 @section Finding the News
166 @cindex finding news
168 @vindex gnus-select-method
169 @c @head
170 The @code{gnus-select-method} variable says where Gnus should look for
171 news.  This variable should be a list where the first element says
172 @dfn{how} and the second element says @dfn{where}.  This method is your
173 native method.  All groups not fetched with this method are
174 foreign groups.
176 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
177 you want to get your daily dosage of news from, you'd say:
179 @lisp
180 (setq gnus-select-method '(nntp "news.somewhere.edu"))
181 @end lisp
183 If you want to read directly from the local spool, say:
185 @lisp
186 (setq gnus-select-method '(nnspool ""))
187 @end lisp
189 If you can use a local spool, you probably should, as it will almost
190 certainly be much faster.
192 @vindex gnus-nntpserver-file
193 @cindex NNTPSERVER
194 @cindex @sc{nntp} server
195 If this variable is not set, Gnus will take a look at the
196 @code{NNTPSERVER} environment variable.  If that variable isn't set,
197 Gnus will see whether @code{gnus-nntpserver-file}
198 (@file{/etc/nntpserver} by default) has any opinions on the matter.  If
199 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server.  That's a long shot, though.
201 @vindex gnus-nntp-server
202 If @code{gnus-nntp-server} is set, this variable will override
203 @code{gnus-select-method}.  You should therefore set
204 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
206 @vindex gnus-secondary-servers
207 You can also make Gnus prompt you interactively for the name of an
208 @sc{nntp} server.  If you give a non-numerical prefix to @code{gnus}
209 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
210 in the @code{gnus-secondary-servers} list (if any).  You can also just
211 type in the name of any server you feel like visiting.
213 @findex gnus-group-browse-foreign-server
214 @kindex B (Group)
215 However, if you use one @sc{nntp} server regularly and are just
216 interested in a couple of groups from a different server, you would be
217 better served by using the @kbd{B} command in the group buffer.  It will
218 let you have a look at what groups are available, and you can subscribe
219 to any of the groups you want to.  This also makes @file{.newsrc}
220 maintenance much tidier.  @xref{Foreign Groups}.
222 @vindex gnus-secondary-select-methods
223 @c @head
224 A slightly different approach to foreign groups is to set the
225 @code{gnus-secondary-select-methods} variable.  The select methods
226 listed in this variable are in many ways just as native as the
227 @code{gnus-select-method} server.  They will also be queried for active
228 files during startup (if that's required), and new newsgroups that
229 appear on these servers will be subscribed (or not) just as native
230 groups are.
232 For instance, if you use the @code{nnmbox} backend to read your mail, you
233 would typically set this variable to
235 @lisp
236 (setq gnus-secondary-select-methods '((nnmbox "")))
237 @end lisp
240 @node The First Time
241 @section The First Time
242 @cindex first time usage
244 If no startup files exist, Gnus will try to determine what groups should
245 be subscribed by default.
247 @vindex gnus-default-subscribed-newsgroups
248 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
249 will subscribe you to just those groups in that list, leaving the rest
250 killed.  Your system administrator should have set this variable to
251 something useful.
253 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
254 picked groups (i.e., @samp{*.newusers}).  (@dfn{Arbitrary} is defined
255 here as @dfn{whatever Lars thinks you should read}.)
257 You'll also be subscribed to the Gnus documentation group, which should
258 help you with most common problems.
260 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
261 use the normal functions for handling new groups, and not do anything
262 special.
265 @node The Server is Down
266 @section The Server is Down
267 @cindex server errors
269 If the default server is down, Gnus will understandably have some
270 problems starting.  However, if you have some mail groups in addition to
271 the news groups, you may want to start Gnus anyway.
273 Gnus, being the trusting sort of program, will ask whether to proceed
274 without a native select method if that server can't be contacted.  This
275 will happen whether the server doesn't actually exist (i.e., you have
276 given the wrong address) or the server has just momentarily taken ill
277 for some reason or other.  If you decide to continue and have no foreign
278 groups, you'll find it difficult to actually do anything in the group
279 buffer.  But, hey, that's your problem.  Blllrph!
281 @findex gnus-no-server
282 @kindex M-x gnus-no-server
283 @c @head
284 If you know that the server is definitely down, or you just want to read
285 your mail without bothering with the server at all, you can use the
286 @code{gnus-no-server} command to start Gnus.  That might come in handy
287 if you're in a hurry as well.  This command will not attempt to contact
288 your primary server---instead, it will just activate all groups on level
289 1 and 2.  (You should preferably keep no native groups on those two
290 levels.)
293 @node Slave Gnusae
294 @section Slave Gnusae
295 @cindex slave
297 You might want to run more than one Emacs with more than one Gnus at the
298 same time.  If you are using different @file{.newsrc} files (e.g., if you
299 are using the two different Gnusae to read from two different servers),
300 that is no problem whatsoever.  You just do it.
302 The problem appears when you want to run two Gnusae that use the same
303 @code{.newsrc} file.
305 To work around that problem some, we here at the Think-Tank at the Gnus
306 Towers have come up with a new concept: @dfn{Masters} and
307 @dfn{slaves}.  (We have applied for a patent on this concept, and have
308 taken out a copyright on those words.  If you wish to use those words in
309 conjunction with each other, you have to send $1 per usage instance to
310 me.  Usage of the patent (@dfn{Master/Slave Relationships In Computer
311 Applications}) will be much more expensive, of course.)
313 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
314 however you do it).  Each subsequent slave Gnusae should be started with
315 @kbd{M-x gnus-slave}.  These slaves won't save normal @file{.newsrc}
316 files, but instead save @dfn{slave files} that contain information only
317 on what groups have been read in the slave session.  When a master Gnus
318 starts, it will read (and delete) these slave files, incorporating all
319 information from them.  (The slave files will be read in the sequence
320 they were created, so the latest changes will have precedence.)
322 Information from the slave files has, of course, precedence over the
323 information in the normal (i.e., master) @code{.newsrc} file.
326 @node Fetching a Group
327 @section Fetching a Group
328 @cindex fetching a group
330 @findex gnus-fetch-group
331 It is sometimes convenient to be able to just say ``I want to read this
332 group and I don't care whether Gnus has been started or not''.  This is
333 perhaps more useful for people who write code than for users, but the
334 command @code{gnus-fetch-group} provides this functionality in any case.
335 It takes the group name as a parameter.
338 @node New Groups
339 @section New Groups
340 @cindex new groups
341 @cindex subscription
343 @vindex gnus-check-new-newsgroups
344 If you are satisfied that you really never want to see any new groups,
345 you can set @code{gnus-check-new-newsgroups} to @code{nil}.  This will
346 also save you some time at startup.  Even if this variable is
347 @code{nil}, you can always subscribe to the new groups just by pressing
348 @kbd{U} in the group buffer (@pxref{Group Maintenance}).  This variable
349 is @code{ask-server} by default.  If you set this variable to
350 @code{always}, then Gnus will query the backends for new groups even
351 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
353 @menu
354 * Checking New Groups::      Determining what groups are new.
355 * Subscription Methods::     What Gnus should do with new groups.
356 * Filtering New Groups::     Making Gnus ignore certain new groups.
357 @end menu
360 @node Checking New Groups
361 @subsection Checking New Groups
363 Gnus normally determines whether a group is new or not by comparing the
364 list of groups from the active file(s) with the lists of subscribed and
365 dead groups.  This isn't a particularly fast method.  If
366 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
367 server for new groups since the last time.  This is both faster and
368 cheaper.  This also means that you can get rid of the list of killed
369 groups altogether, so you may set @code{gnus-save-killed-list} to
370 @code{nil}, which will save time both at startup, at exit, and all over.
371 Saves disk space, too.  Why isn't this the default, then?
372 Unfortunately, not all servers support this command.
374 I bet I know what you're thinking now: How do I find out whether my
375 server supports @code{ask-server}?  No?  Good, because I don't have a
376 fail-safe answer.  I would suggest just setting this variable to
377 @code{ask-server} and see whether any new groups appear within the next
378 few days.  If any do, then it works.  If none do, then it doesn't
379 work.  I could write a function to make Gnus guess whether the server
380 supports @code{ask-server}, but it would just be a guess.  So I won't.
381 You could @code{telnet} to the server and say @code{HELP} and see
382 whether it lists @samp{NEWGROUPS} among the commands it understands.  If
383 it does, then it might work.  (But there are servers that lists
384 @samp{NEWGROUPS} without supporting the function properly.)
386 This variable can also be a list of select methods.  If so, Gnus will
387 issue an @code{ask-server} command to each of the select methods, and
388 subscribe them (or not) using the normal methods.  This might be handy
389 if you are monitoring a few servers for new groups.  A side effect is
390 that startup will take much longer, so you can meditate while waiting.
391 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
394 @node Subscription Methods
395 @subsection Subscription Methods
397 @vindex gnus-subscribe-newsgroup-method
398 What Gnus does when it encounters a new group is determined by the
399 @code{gnus-subscribe-newsgroup-method} variable.
401 This variable should contain a function.  This function will be called
402 with the name of the new group as the only parameter.
404 Some handy pre-fab functions are:
406 @table @code
408 @item gnus-subscribe-zombies
409 @vindex gnus-subscribe-zombies
410 Make all new groups zombies.  This is the default.  You can browse the
411 zombies later (with @kbd{A z}) and either kill them all off properly
412 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
414 @item gnus-subscribe-randomly
415 @vindex gnus-subscribe-randomly
416 Subscribe all new groups in arbitrary order.  This really means that all
417 new groups will be added at ``the top'' of the group buffer.
419 @item gnus-subscribe-alphabetically
420 @vindex gnus-subscribe-alphabetically
421 Subscribe all new groups in alphabetical order.
423 @item gnus-subscribe-hierarchically
424 @vindex gnus-subscribe-hierarchically
425 Subscribe all new groups hierarchically.  The difference between this
426 function and @code{gnus-subscribe-alphabetically} is slight.
427 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
428 alphabetical fashion, while this function will enter groups into it's
429 hierarchy.  So if you want to have the @samp{rec} hierarchy before the
430 @samp{comp} hierarchy, this function will not mess that configuration
431 up.  Or something like that.
433 @item gnus-subscribe-interactively
434 @vindex gnus-subscribe-interactively
435 Subscribe new groups interactively.  This means that Gnus will ask
436 you about @strong{all} new groups.  The groups you choose to subscribe
437 to will be subscribed hierarchically.
439 @item gnus-subscribe-killed
440 @vindex gnus-subscribe-killed
441 Kill all new groups.
443 @end table
445 @vindex gnus-subscribe-hierarchical-interactive
446 A closely related variable is
447 @code{gnus-subscribe-hierarchical-interactive}.  (That's quite a
448 mouthful.)  If this variable is non-@code{nil}, Gnus will ask you in a
449 hierarchical fashion whether to subscribe to new groups or not.  Gnus
450 will ask you for each sub-hierarchy whether you want to descend the
451 hierarchy or not.
453 One common mistake is to set the variable a few paragraphs above
454 (@code{gnus-subscribe-newsgroup-method}) to
455 @code{gnus-subscribe-hierarchical-interactive}.  This is an error.  This
456 will not work.  This is ga-ga.  So don't do it.
459 @node Filtering New Groups
460 @subsection Filtering New Groups
462 A nice and portable way to control which new newsgroups should be
463 subscribed (or ignored) is to put an @dfn{options} line at the start of
464 the @file{.newsrc} file.  Here's an example:
466 @example
467 options -n !alt.all !rec.all sci.all
468 @end example
470 @vindex gnus-subscribe-options-newsgroup-method
471 This line obviously belongs to a serious-minded intellectual scientific
472 person (or she may just be plain old boring), because it says that all
473 groups that have names beginning with @samp{alt} and @samp{rec} should
474 be ignored, and all groups with names beginning with @samp{sci} should
475 be subscribed.  Gnus will not use the normal subscription method for
476 subscribing these groups.
477 @code{gnus-subscribe-options-newsgroup-method} is used instead.  This
478 variable defaults to @code{gnus-subscribe-alphabetically}.
480 @vindex gnus-options-not-subscribe
481 @vindex gnus-options-subscribe
482 If you don't want to mess with your @file{.newsrc} file, you can just
483 set the two variables @code{gnus-options-subscribe} and
484 @code{gnus-options-not-subscribe}.  These two variables do exactly the
485 same as the @file{.newsrc} @samp{options -n} trick.  Both are regexps,
486 and if the new group matches the former, it will be unconditionally
487 subscribed, and if it matches the latter, it will be ignored.
489 @vindex gnus-auto-subscribed-groups
490 Yet another variable that meddles here is
491 @code{gnus-auto-subscribed-groups}.  It works exactly like
492 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
493 thought it would be nice to have two of these.  This variable is more
494 meant for setting some ground rules, while the other variable is used
495 more for user fiddling.  By default this variable makes all new groups
496 that come from mail backends (@code{nnml}, @code{nnbabyl},
497 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed.  If you
498 don't like that, just set this variable to @code{nil}.
500 New groups that match this regexp are subscribed using
501 @code{gnus-subscribe-options-newsgroup-method}.
504 @node Changing Servers
505 @section Changing Servers
506 @cindex changing servers
508 Sometimes it is necessary to move from one @sc{nntp} server to another.
509 This happens very rarely, but perhaps you change jobs, or one server is
510 very flaky and you want to use another.
512 Changing the server is pretty easy, right?  You just change
513 @code{gnus-select-method} to point to the new server?
515 @emph{Wrong!}
517 Article numbers are not (in any way) kept synchronized between different
518 @sc{nntp} servers, and the only way Gnus keeps track of what articles
519 you have read is by keeping track of article numbers.  So when you
520 change @code{gnus-select-method}, your @file{.newsrc} file becomes
521 worthless.
523 Gnus provides a few functions to attempt to translate a @file{.newsrc}
524 file from one server to another.  They all have one thing in
525 common---they take a looong time to run.  You don't want to use these
526 functions more than absolutely necessary.
528 @kindex M-x gnus-change-server
529 @findex gnus-change-server
530 If you have access to both servers, Gnus can request the headers for all
531 the articles you have read and compare @code{Message-ID}s and map the
532 article numbers of the read articles and article marks.  The @kbd{M-x
533 gnus-change-server} command will do this for all your native groups.  It
534 will prompt for the method you want to move to.
536 @kindex M-x gnus-group-move-group-to-server
537 @findex gnus-group-move-group-to-server
538 You can also move individual groups with the @kbd{M-x
539 gnus-group-move-group-to-server} command.  This is useful if you want to
540 move a (foreign) group from one server to another.
542 @kindex M-x gnus-group-clear-data-on-native-groups
543 @findex gnus-group-clear-data-on-native-groups
544 If you don't have access to both the old and new server, all your marks
545 and read ranges have become worthless.  You can use the @kbd{M-x
546 gnus-group-clear-data-on-native-groups} command to clear out all data
547 that you have on your native groups.  Use with caution.
550 @node Startup Files
551 @section Startup Files
552 @cindex startup files
553 @cindex .newsrc
554 @cindex .newsrc.el
555 @cindex .newsrc.eld
557 Now, you all know about the @file{.newsrc} file.  All subscription
558 information is traditionally stored in this file.
560 Things got a bit more complicated with @sc{gnus}.  In addition to
561 keeping the @file{.newsrc} file updated, it also used a file called
562 @file{.newsrc.el} for storing all the information that didn't fit into
563 the @file{.newsrc} file.  (Actually, it also duplicated everything in
564 the @file{.newsrc} file.)  @sc{gnus} would read whichever one of these
565 files was the most recently saved, which enabled people to swap between
566 @sc{gnus} and other newsreaders.
568 That was kinda silly, so Gnus went one better: In addition to the
569 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
570 @file{.newsrc.eld}.  It will read whichever of these files that are most
571 recent, but it will never write a @file{.newsrc.el} file.  You should
572 never delete the @file{.newsrc.eld} file---it contains much information
573 not stored in the @file{.newsrc} file.
575 @vindex gnus-save-newsrc-file
576 You can turn off writing the @file{.newsrc} file by setting
577 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
578 the file and save some space, as well as exiting from Gnus faster.
579 However, this will make it impossible to use other newsreaders than
580 Gnus.  But hey, who would want to, right?
582 @vindex gnus-save-killed-list
583 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
584 will not save the list of killed groups to the startup file.  This will
585 save both time (when starting and quitting) and space (on disk).  It
586 will also mean that Gnus has no record of what groups are new or old,
587 so the automatic new groups subscription methods become meaningless.
588 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
589 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
590 Groups}).  This variable can also be a regular expression.  If that's
591 the case, remove all groups that do not match this regexp before
592 saving.  This can be useful in certain obscure situations that involve
593 several servers where not all servers support @code{ask-server}.
595 @vindex gnus-startup-file
596 The @code{gnus-startup-file} variable says where the startup files are.
597 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
598 file being whatever that one is, with a @samp{.eld} appended.
600 @vindex gnus-save-newsrc-hook
601 @vindex gnus-save-quick-newsrc-hook
602 @vindex gnus-save-standard-newsrc-hook
603 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
604 files, while @code{gnus-save-quick-newsrc-hook} is called just before
605 saving the @file{.newsrc.eld} file, and
606 @code{gnus-save-standard-newsrc-hook} is called just before saving the
607 @file{.newsrc} file.  The latter two are commonly used to turn version
608 control on or off.  Version control is on by default when saving the
609 startup files.  If you want to turn backup creation off, say something like:
611 @lisp
612 (defun turn-off-backup ()
613   (set (make-local-variable 'backup-inhibited) t))
615 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
616 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
617 @end lisp
619 @vindex gnus-init-file
620 When Gnus starts, it will read the @code{gnus-site-init-file}
621 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
622 (@file{~/.gnus} by default) files.  These are normal Emacs Lisp files
623 and can be used to avoid cluttering your @file{~/.emacs} and
624 @file{site-init} files with Gnus stuff.  Gnus will also check for files
625 with the same names as these, but with @file{.elc} and @file{.el}
626 suffixes.  In other words, if you have set @code{gnus-init-file} to
627 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
628 and finally @file{~/.gnus} (in this order).
632 @node Auto Save
633 @section Auto Save
634 @cindex dribble file
635 @cindex auto-save
637 Whenever you do something that changes the Gnus data (reading articles,
638 catching up, killing/subscribing groups), the change is added to a
639 special @dfn{dribble buffer}.  This buffer is auto-saved the normal
640 Emacs way.  If your Emacs should crash before you have saved the
641 @file{.newsrc} files, all changes you have made can be recovered from
642 this file.
644 If Gnus detects this file at startup, it will ask the user whether to
645 read it.  The auto save file is deleted whenever the real startup file is
646 saved.
648 @vindex gnus-use-dribble-file
649 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
650 maintain a dribble buffer.  The default is @code{t}.
652 @vindex gnus-dribble-directory
653 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}.  If
654 this variable is @code{nil}, which it is by default, Gnus will dribble
655 into the directory where the @file{.newsrc} file is located.  (This is
656 normally the user's home directory.)  The dribble file will get the same
657 file permissions as the @code{.newsrc} file.
659 @vindex gnus-always-read-dribble-file
660 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
661 read the dribble file on startup without querying the user.
664 @node The Active File
665 @section The Active File
666 @cindex active file
667 @cindex ignored groups
669 When Gnus starts, or indeed whenever it tries to determine whether new
670 articles have arrived, it reads the active file.  This is a very large
671 file that lists all the active groups and articles on the server.
673 @vindex gnus-ignored-newsgroups
674 Before examining the active file, Gnus deletes all lines that match the
675 regexp @code{gnus-ignored-newsgroups}.  This is done primarily to reject
676 any groups with bogus names, but you can use this variable to make Gnus
677 ignore hierarchies you aren't ever interested in.  However, this is not
678 recommended.  In fact, it's highly discouraged.  Instead, @pxref{New
679 Groups} for an overview of other variables that can be used instead.
681 @c This variable is
682 @c @code{nil} by default, and will slow down active file handling somewhat
683 @c if you set it to anything else.
685 @vindex gnus-read-active-file
686 @c @head
687 The active file can be rather Huge, so if you have a slow network, you
688 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
689 reading the active file.  This variable is @code{some} by default.
691 Gnus will try to make do by getting information just on the groups that
692 you actually subscribe to.
694 Note that if you subscribe to lots and lots of groups, setting this
695 variable to @code{nil} will probably make Gnus slower, not faster.  At
696 present, having this variable @code{nil} will slow Gnus down
697 considerably, unless you read news over a 2400 baud modem.
699 This variable can also have the value @code{some}.  Gnus will then
700 attempt to read active info only on the subscribed groups.  On some
701 servers this is quite fast (on sparkling, brand new INN servers that
702 support the @code{LIST ACTIVE group} command), on others this isn't fast
703 at all.  In any case, @code{some} should be faster than @code{nil}, and
704 is certainly faster than @code{t} over slow lines.
706 If this variable is @code{nil}, Gnus will ask for group info in total
707 lock-step, which isn't very fast.  If it is @code{some} and you use an
708 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
709 read all the replies in one swoop.  This will normally result in better
710 performance, but if the server does not support the aforementioned
711 @code{LIST ACTIVE group} command, this isn't very nice to the server.
713 In any case, if you use @code{some} or @code{nil}, you should definitely
714 kill all groups that you aren't interested in to speed things up.
716 Note that this variable also affects active file retrieval from
717 secondary select methods.
720 @node Startup Variables
721 @section Startup Variables
723 @table @code
725 @item gnus-load-hook
726 @vindex gnus-load-hook
727 A hook run while Gnus is being loaded.  Note that this hook will
728 normally be run just once in each Emacs session, no matter how many
729 times you start Gnus.
731 @item gnus-before-startup-hook
732 @vindex gnus-before-startup-hook
733 A hook run after starting up Gnus successfully.
735 @item gnus-startup-hook
736 @vindex gnus-startup-hook
737 A hook run as the very last thing after starting up Gnus
739 @item gnus-started-hook
740 @vindex gnus-started-hook
741 A hook that is run as the very last thing after starting up Gnus
742 successfully.
744 @item gnus-started-hook
745 @vindex gnus-started-hook
746 A hook that is run after reading the @file{.newsrc} file(s), but before
747 generating the group buffer.
749 @item gnus-check-bogus-newsgroups
750 @vindex gnus-check-bogus-newsgroups
751 If non-@code{nil}, Gnus will check for and delete all bogus groups at
752 startup.  A @dfn{bogus group} is a group that you have in your
753 @file{.newsrc} file, but doesn't exist on the news server.  Checking for
754 bogus groups can take quite a while, so to save time and resources it's
755 best to leave this option off, and do the checking for bogus groups once
756 in a while from the group buffer instead (@pxref{Group Maintenance}).
758 @item gnus-inhibit-startup-message
759 @vindex gnus-inhibit-startup-message
760 If non-@code{nil}, the startup message won't be displayed.  That way,
761 your boss might not notice as easily that you are reading news instead
762 of doing your job.  Note that this variable is used before
763 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
765 @item gnus-no-groups-message
766 @vindex gnus-no-groups-message
767 Message displayed by Gnus when no groups are available.
769 @item gnus-play-startup-jingle
770 @vindex gnus-play-startup-jingle
771 If non-@code{nil}, play the Gnus jingle at startup.
773 @item gnus-startup-jingle
774 @vindex gnus-startup-jingle
775 Jingle to be played if the above variable is non-@code{nil}.  The
776 default is @samp{Tuxedomoon.Jingle4.au}.
778 @end table
781 @node The Group Buffer
782 @chapter The Group Buffer
783 @cindex group buffer
785 The @dfn{group buffer} lists all (or parts) of the available groups.  It
786 is the first buffer shown when Gnus starts, and will never be killed as
787 long as Gnus is active.
790 @menu
791 * Group Buffer Format::    Information listed and how you can change it.
792 * Group Maneuvering::      Commands for moving in the group buffer.
793 * Selecting a Group::      Actually reading news.
794 * Group Data::             Changing the info for a group.
795 * Subscription Commands::  Unsubscribing, killing, subscribing.
796 * Group Levels::           Levels? What are those, then?
797 * Group Score::            A mechanism for finding out what groups you like.
798 * Marking Groups::         You can mark groups for later processing.
799 * Foreign Groups::         Creating and editing groups.
800 * Group Parameters::       Each group may have different parameters set.
801 * Listing Groups::         Gnus can list various subsets of the groups.
802 * Sorting Groups::         Re-arrange the group order.
803 * Group Maintenance::      Maintaining a tidy @file{.newsrc} file.
804 * Browse Foreign Server::  You can browse a server.  See what it has to offer.
805 * Exiting Gnus::           Stop reading news and get some work done.
806 * Group Topics::           A folding group mode divided into topics.
807 * Misc Group Stuff::       Other stuff that you can to do.
808 @end menu
811 @node Group Buffer Format
812 @section Group Buffer Format
814 @menu
815 * Group Line Specification::       Deciding how the group buffer is to look.
816 * Group Modeline Specification::   The group buffer modeline.
817 * Group Highlighting::             Having nice colors in the group buffer.
818 @end menu
821 @node Group Line Specification
822 @subsection Group Line Specification
823 @cindex group buffer format
825 The default format of the group buffer is nice and dull, but you can
826 make it as exciting and ugly as you feel like.
828 Here's a couple of example group lines:
830 @example
831      25: news.announce.newusers
832  *    0: alt.fan.andrea-dworkin
833 @end example
835 Quite simple, huh?
837 You can see that there are 25 unread articles in
838 @samp{news.announce.newusers}.  There are no unread articles, but some
839 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
840 asterisk at the beginning of the line?).
842 @vindex gnus-group-line-format
843 You can change that format to whatever you want by fiddling with the
844 @code{gnus-group-line-format} variable.  This variable works along the
845 lines of a @code{format} specification, which is pretty much the same as
846 a @code{printf} specifications, for those of you who use (feh!) C.
847 @xref{Formatting Variables}.
849 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
851 There should always be a colon on the line; the cursor always moves to
852 the colon after performing an operation.  Nothing else is required---not
853 even the group name.  All displayed text is just window dressing, and is
854 never examined by Gnus.  Gnus stores all real information it needs using
855 text properties.
857 (Note that if you make a really strange, wonderful, spreadsheet-like
858 layout, everybody will believe you are hard at work with the accounting
859 instead of wasting time reading news.)
861 Here's a list of all available format characters:
863 @table @samp
865 @item M
866 An asterisk if the group only has marked articles.
868 @item S
869 Whether the group is subscribed.
871 @item L
872 Level of subscribedness.
874 @item N
875 Number of unread articles.
877 @item I
878 Number of dormant articles.
880 @item T
881 Number of ticked articles.
883 @item R
884 Number of read articles.
886 @item t
887 Estimated total number of articles.  (This is really @var{max-number}
888 minus @var{min-number} plus 1.)
890 @item y
891 Number of unread, unticked, non-dormant articles.
893 @item i
894 Number of ticked and dormant articles.
896 @item g
897 Full group name.
899 @item G
900 Group name.
902 @item D
903 Newsgroup description.
905 @item o
906 @samp{m} if moderated.
908 @item O
909 @samp{(m)} if moderated.
911 @item s
912 Select method.
914 @item n
915 Select from where.
917 @item z
918 A string that looks like @samp{<%s:%n>} if a foreign select method is
919 used.
921 @item P
922 Indentation based on the level of the topic (@pxref{Group Topics}).
924 @item c
925 @vindex gnus-group-uncollapsed-levels
926 Short (collapsed) group name.  The @code{gnus-group-uncollapsed-levels}
927 variable says how many levels to leave at the end of the group name.
928 The default is 1---this will mean that group names like
929 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
931 @item m
932 @vindex gnus-new-mail-mark
933 @cindex %
934 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
935 the group lately.
937 @item d
938 A string that says when you last read the group (@pxref{Group
939 Timestamp}).
941 @item u
942 User defined specifier.  The next character in the format string should
943 be a letter.  Gnus will call the function
944 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
945 following @samp{%u}.  The function will be passed a single dummy
946 parameter as argument.  The function should return a string, which will
947 be inserted into the buffer just like information from any other
948 specifier.
949 @end table
951 @cindex *
952 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
953 if no info is available---for instance, if it is a non-activated foreign
954 group, or a bogus native group.
957 @node Group Modeline Specification
958 @subsection Group Modeline Specification
959 @cindex group modeline
961 @vindex gnus-group-mode-line-format
962 The mode line can be changed by setting
963 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}).  It
964 doesn't understand that many format specifiers:
966 @table @samp
967 @item S
968 The native news server.
969 @item M
970 The native select method.
971 @end table
974 @node Group Highlighting
975 @subsection Group Highlighting
976 @cindex highlighting
977 @cindex group highlighting
979 @vindex gnus-group-highlight
980 Highlighting in the group buffer is controlled by the
981 @code{gnus-group-highlight} variable.  This is an alist with elements
982 that look like @code{(@var{form} . @var{face})}.  If @var{form} evaluates to
983 something non-@code{nil}, the @var{face} will be used on the line.
985 Here's an example value for this variable that might look nice if the
986 background is dark:
988 @lisp
989 (face-spec-set 'my-group-face-1
990                '((t (:foreground "Red" :bold t))))
991 (face-spec-set 'my-group-face-2
992                '((t (:foreground "SeaGreen" :bold t))))
993 (face-spec-set 'my-group-face-3
994                '((t (:foreground "SpringGreen" :bold t))))
995 (face-spec-set 'my-group-face-4
996                '((t (:foreground "SteelBlue" :bold t))))
997 (face-spec-set 'my-group-face-5
998                '((t (:foreground "SkyBlue" :bold t))))
1000 (setq gnus-group-highlight
1001       '(((> unread 200) . my-group-face-1)
1002         ((and (< level 3) (zerop unread)) . my-group-face-2)
1003         ((< level 3) . my-group-face-3)
1004         ((zerop unread) . my-group-face-4)
1005         (t . my-group-face-5)))
1006 @end lisp
1008 Also @pxref{Faces and Fonts}.
1010 Variables that are dynamically bound when the forms are evaluated
1011 include:
1013 @table @code
1014 @item group
1015 The group name.
1016 @item unread
1017 The number of unread articles in the group.
1018 @item method
1019 The select method.
1020 @item mailp
1021 Whether the group is a mail group.
1022 @item level
1023 The level of the group.
1024 @item score
1025 The score of the group.
1026 @item ticked
1027 The number of ticked articles in the group.
1028 @item total
1029 The total number of articles in the group.  Or rather, MAX-NUMBER minus
1030 MIN-NUMBER plus one.
1031 @item topic
1032 When using the topic minor mode, this variable is bound to the current
1033 topic being inserted.
1034 @end table
1036 When the forms are @code{eval}ed, point is at the beginning of the line
1037 of the group in question, so you can use many of the normal Gnus
1038 functions for snarfing info on the group.
1040 @vindex gnus-group-update-hook
1041 @findex gnus-group-highlight-line
1042 @code{gnus-group-update-hook} is called when a group line is changed.
1043 It will not be called when @code{gnus-visual} is @code{nil}.  This hook
1044 calls @code{gnus-group-highlight-line} by default.
1047 @node Group Maneuvering
1048 @section Group Maneuvering
1049 @cindex group movement
1051 All movement commands understand the numeric prefix and will behave as
1052 expected, hopefully.
1054 @table @kbd
1056 @item n
1057 @kindex n (Group)
1058 @findex gnus-group-next-unread-group
1059 Go to the next group that has unread articles
1060 (@code{gnus-group-next-unread-group}).
1062 @item p
1063 @itemx DEL
1064 @kindex DEL (Group)
1065 @kindex p (Group)
1066 @findex gnus-group-prev-unread-group
1067 Go to the previous group that has unread articles
1068 (@code{gnus-group-prev-unread-group}).
1070 @item N
1071 @kindex N (Group)
1072 @findex gnus-group-next-group
1073 Go to the next group (@code{gnus-group-next-group}).
1075 @item P
1076 @kindex P (Group)
1077 @findex gnus-group-prev-group
1078 Go to the previous group (@code{gnus-group-prev-group}).
1080 @item M-n
1081 @kindex M-n (Group)
1082 @findex gnus-group-next-unread-group-same-level
1083 Go to the next unread group on the same (or lower) level
1084 (@code{gnus-group-next-unread-group-same-level}).
1086 @item M-p
1087 @kindex M-p (Group)
1088 @findex gnus-group-prev-unread-group-same-level
1089 Go to the previous unread group on the same (or lower) level
1090 (@code{gnus-group-prev-unread-group-same-level}).
1091 @end table
1093 Three commands for jumping to groups:
1095 @table @kbd
1097 @item j
1098 @kindex j (Group)
1099 @findex gnus-group-jump-to-group
1100 Jump to a group (and make it visible if it isn't already)
1101 (@code{gnus-group-jump-to-group}).  Killed groups can be jumped to, just
1102 like living groups.
1104 @item ,
1105 @kindex , (Group)
1106 @findex gnus-group-best-unread-group
1107 Jump to the unread group with the lowest level
1108 (@code{gnus-group-best-unread-group}).
1110 @item .
1111 @kindex . (Group)
1112 @findex gnus-group-first-unread-group
1113 Jump to the first group with unread articles
1114 (@code{gnus-group-first-unread-group}).
1115 @end table
1117 @vindex gnus-group-goto-unread
1118 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1119 commands will move to the next group, not the next unread group.  Even
1120 the commands that say they move to the next unread group.  The default
1121 is @code{t}.
1124 @node Selecting a Group
1125 @section Selecting a Group
1126 @cindex group selection
1128 @table @kbd
1130 @item SPACE
1131 @kindex SPACE (Group)
1132 @findex gnus-group-read-group
1133 Select the current group, switch to the summary buffer and display the
1134 first unread article (@code{gnus-group-read-group}).  If there are no
1135 unread articles in the group, or if you give a non-numerical prefix to
1136 this command, Gnus will offer to fetch all the old articles in this
1137 group from the server.  If you give a numerical prefix @var{N}, @var{N}
1138 determines the number of articles Gnus will fetch.  If @var{N} is
1139 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1140 negative, Gnus fetches the @math{abs(N)} oldest articles.
1142 @item RET
1143 @kindex RET (Group)
1144 @findex gnus-group-select-group
1145 Select the current group and switch to the summary buffer
1146 (@code{gnus-group-select-group}).  Takes the same arguments as
1147 @code{gnus-group-read-group}---the only difference is that this command
1148 does not display the first unread article automatically upon group
1149 entry.
1151 @item M-RET
1152 @kindex M-RET (Group)
1153 @findex gnus-group-quick-select-group
1154 This does the same as the command above, but tries to do it with the
1155 minimum amount of fuzz (@code{gnus-group-quick-select-group}).  No
1156 scoring/killing will be performed, there will be no highlights and no
1157 expunging.  This might be useful if you're in a real hurry and have to
1158 enter some humongous group.  If you give a 0 prefix to this command
1159 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1160 which is useful if you want to toggle threading before generating the
1161 summary buffer (@pxref{Summary Generation Commands}).
1163 @item M-SPACE
1164 @kindex M-SPACE (Group)
1165 @findex gnus-group-visible-select-group
1166 This is yet one more command that does the same as the @kbd{RET}
1167 command, but this one does it without expunging and hiding dormants
1168 (@code{gnus-group-visible-select-group}).
1170 @item M-C-RET
1171 @kindex M-C-RET (Group)
1172 @findex gnus-group-select-group-ephemerally
1173 Finally, this command selects the current group ephemerally without
1174 doing any processing of its contents
1175 (@code{gnus-group-select-group-ephemerally}).  Even threading has been
1176 turned off.  Everything you do in the group after selecting it in this
1177 manner will have no permanent effects.
1179 @end table
1181 @vindex gnus-large-newsgroup
1182 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1183 to be a big group.  This is 200 by default.  If the group has more
1184 (unread and/or ticked) articles than this, Gnus will query the user
1185 before entering the group.  The user can then specify how many articles
1186 should be fetched from the server.  If the user specifies a negative
1187 number (@code{-n}), the @code{n} oldest articles will be fetched.  If it
1188 is positive, the @code{n} articles that have arrived most recently will
1189 be fetched.
1191 @vindex gnus-select-group-hook
1192 @vindex gnus-auto-select-first
1193 @code{gnus-auto-select-first} control whether any articles are selected
1194 automatically when entering a group with the @kbd{SPACE} command.
1196 @table @code
1198 @item nil
1199 Don't select any articles when entering the group.  Just display the
1200 full summary buffer.
1202 @item t
1203 Select the first unread article when entering the group.
1205 @item best
1206 Select the highest scored article in the group when entering the
1207 group.
1208 @end table
1210 If you want to prevent automatic selection in some group (say, in a
1211 binary group with Huge articles) you can set this variable to @code{nil}
1212 in @code{gnus-select-group-hook}, which is called when a group is
1213 selected.
1216 @node Subscription Commands
1217 @section Subscription Commands
1218 @cindex subscription
1220 @table @kbd
1222 @item S t
1223 @itemx u
1224 @kindex S t (Group)
1225 @kindex u (Group)
1226 @findex gnus-group-unsubscribe-current-group
1227 @c @icon{gnus-group-unsubscribe}
1228 Toggle subscription to the current group
1229 (@code{gnus-group-unsubscribe-current-group}).
1231 @item S s
1232 @itemx U
1233 @kindex S s (Group)
1234 @kindex U (Group)
1235 @findex gnus-group-unsubscribe-group
1236 Prompt for a group to subscribe, and then subscribe it.  If it was
1237 subscribed already, unsubscribe it instead
1238 (@code{gnus-group-unsubscribe-group}).
1240 @item S k
1241 @itemx C-k
1242 @kindex S k (Group)
1243 @kindex C-k (Group)
1244 @findex gnus-group-kill-group
1245 @c @icon{gnus-group-kill-group}
1246 Kill the current group (@code{gnus-group-kill-group}).
1248 @item S y
1249 @itemx C-y
1250 @kindex S y (Group)
1251 @kindex C-y (Group)
1252 @findex gnus-group-yank-group
1253 Yank the last killed group (@code{gnus-group-yank-group}).
1255 @item C-x C-t
1256 @kindex C-x C-t (Group)
1257 @findex gnus-group-transpose-groups
1258 Transpose two groups (@code{gnus-group-transpose-groups}).  This isn't
1259 really a subscription command, but you can use it instead of a
1260 kill-and-yank sequence sometimes.
1262 @item S w
1263 @itemx C-w
1264 @kindex S w (Group)
1265 @kindex C-w (Group)
1266 @findex gnus-group-kill-region
1267 Kill all groups in the region (@code{gnus-group-kill-region}).
1269 @item S z
1270 @kindex S z (Group)
1271 @findex gnus-group-kill-all-zombies
1272 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1274 @item S C-k
1275 @kindex S C-k (Group)
1276 @findex gnus-group-kill-level
1277 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1278 These groups can't be yanked back after killing, so this command should
1279 be used with some caution.  The only time where this command comes in
1280 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1281 groups that you want to get rid off.  @kbd{S C-k} on level 7 will
1282 kill off all unsubscribed groups that do not have message numbers in the
1283 @file{.newsrc} file.
1285 @end table
1287 Also @pxref{Group Levels}.
1290 @node Group Data
1291 @section Group Data
1293 @table @kbd
1295 @item c
1296 @kindex c (Group)
1297 @findex gnus-group-catchup-current
1298 @vindex gnus-group-catchup-group-hook
1299 @c @icon{gnus-group-catchup-current}
1300 Mark all unticked articles in this group as read
1301 (@code{gnus-group-catchup-current}).
1302 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1303 the group buffer.
1305 @item C
1306 @kindex C (Group)
1307 @findex gnus-group-catchup-current-all
1308 Mark all articles in this group, even the ticked ones, as read
1309 (@code{gnus-group-catchup-current-all}).
1311 @item M-c
1312 @kindex M-c (Group)
1313 @findex gnus-group-clear-data
1314 Clear the data from the current group---nix out marks and the list of
1315 read articles (@code{gnus-group-clear-data}).
1317 @item M-x gnus-group-clear-data-on-native-groups
1318 @kindex M-x gnus-group-clear-data-on-native-groups
1319 @findex gnus-group-clear-data-on-native-groups
1320 If you have switched from one @sc{nntp} server to another, all your marks
1321 and read ranges have become worthless.  You can use this command to
1322 clear out all data that you have on your native groups.  Use with
1323 caution.
1325 @end table
1328 @node Group Levels
1329 @section Group Levels
1330 @cindex group level
1331 @cindex level
1333 All groups have a level of @dfn{subscribedness}.  For instance, if a
1334 group is on level 2, it is more subscribed than a group on level 5.  You
1335 can ask Gnus to just list groups on a given level or lower
1336 (@pxref{Listing Groups}), or to just check for new articles in groups on
1337 a given level or lower (@pxref{Scanning New Messages}).
1339 Remember:  The higher the level of the group, the less important it is.
1341 @table @kbd
1343 @item S l
1344 @kindex S l (Group)
1345 @findex gnus-group-set-current-level
1346 Set the level of the current group.  If a numeric prefix is given, the
1347 next @var{n} groups will have their levels set.  The user will be
1348 prompted for a level.
1349 @end table
1351 @vindex gnus-level-killed
1352 @vindex gnus-level-zombie
1353 @vindex gnus-level-unsubscribed
1354 @vindex gnus-level-subscribed
1355 Gnus considers groups from levels 1 to
1356 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1357 @code{gnus-level-subscribed} (exclusive) and
1358 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1359 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1360 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1361 (default 9).  Gnus treats subscribed and unsubscribed groups exactly the
1362 same, but zombie and killed groups have no information on what articles
1363 you have read, etc, stored.  This distinction between dead and living
1364 groups isn't done because it is nice or clever, it is done purely for
1365 reasons of efficiency.
1367 It is recommended that you keep all your mail groups (if any) on quite
1368 low levels (e.g. 1 or 2).
1370 If you want to play with the level variables, you should show some care.
1371 Set them once, and don't touch them ever again.  Better yet, don't touch
1372 them at all unless you know exactly what you're doing.
1374 @vindex gnus-level-default-unsubscribed
1375 @vindex gnus-level-default-subscribed
1376 Two closely related variables are @code{gnus-level-default-subscribed}
1377 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1378 which are the levels that new groups will be put on if they are
1379 (un)subscribed.  These two variables should, of course, be inside the
1380 relevant valid ranges.
1382 @vindex gnus-keep-same-level
1383 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1384 will only move to groups of the same level (or lower).  In
1385 particular, going from the last article in one group to the next group
1386 will go to the next group of the same level (or lower).  This might be
1387 handy if you want to read the most important groups before you read the
1388 rest.
1390 @vindex gnus-group-default-list-level
1391 All groups with a level less than or equal to
1392 @code{gnus-group-default-list-level} will be listed in the group buffer
1393 by default.
1395 @vindex gnus-group-list-inactive-groups
1396 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1397 groups will be listed along with the unread groups.  This variable is
1398 @code{t} by default.  If it is @code{nil}, inactive groups won't be
1399 listed.
1401 @vindex gnus-group-use-permanent-levels
1402 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1403 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1404 use this level as the ``work'' level.
1406 @vindex gnus-activate-level
1407 Gnus will normally just activate (i. e., query the server about) groups
1408 on level @code{gnus-activate-level} or less.  If you don't want to
1409 activate unsubscribed groups, for instance, you might set this variable
1410 to 5.  The default is 6.
1413 @node Group Score
1414 @section Group Score
1415 @cindex group score
1416 @cindex group rank
1417 @cindex rank
1419 You would normally keep important groups on high levels, but that scheme
1420 is somewhat restrictive.  Don't you wish you could have Gnus sort the
1421 group buffer according to how often you read groups, perhaps?  Within
1422 reason?
1424 This is what @dfn{group score} is for.  You can assign a score to each
1425 group.  You can then sort the group buffer based on this score.
1426 Alternatively, you can sort on score and then level.  (Taken together,
1427 the level and the score is called the @dfn{rank} of the group.  A group
1428 that is on level 4 and has a score of 1 has a higher rank than a group
1429 on level 5 that has a score of 300.  (The level is the most significant
1430 part and the score is the least significant part.))
1432 @findex gnus-summary-bubble-group
1433 If you want groups you read often to get higher scores than groups you
1434 read seldom you can add the @code{gnus-summary-bubble-group} function to
1435 the @code{gnus-summary-exit-hook} hook.  This will result (after
1436 sorting) in a bubbling sort of action.  If you want to see that in
1437 action after each summary exit, you can add
1438 @code{gnus-group-sort-groups-by-rank} or
1439 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1440 slow things down somewhat.
1443 @node Marking Groups
1444 @section Marking Groups
1445 @cindex marking groups
1447 If you want to perform some command on several groups, and they appear
1448 subsequently in the group buffer, you would normally just give a
1449 numerical prefix to the command.  Most group commands will then do your
1450 bidding on those groups.
1452 However, if the groups are not in sequential order, you can still
1453 perform a command on several groups.  You simply mark the groups first
1454 with the process mark and then execute the command.
1456 @table @kbd
1458 @item #
1459 @kindex # (Group)
1460 @itemx M m
1461 @kindex M m (Group)
1462 @findex gnus-group-mark-group
1463 Set the mark on the current group (@code{gnus-group-mark-group}).
1465 @item M-#
1466 @kindex M-# (Group)
1467 @itemx M u
1468 @kindex M u (Group)
1469 @findex gnus-group-unmark-group
1470 Remove the mark from the current group
1471 (@code{gnus-group-unmark-group}).
1473 @item M U
1474 @kindex M U (Group)
1475 @findex gnus-group-unmark-all-groups
1476 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1478 @item M w
1479 @kindex M w (Group)
1480 @findex gnus-group-mark-region
1481 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1483 @item M b
1484 @kindex M b (Group)
1485 @findex gnus-group-mark-buffer
1486 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1488 @item M r
1489 @kindex M r (Group)
1490 @findex gnus-group-mark-regexp
1491 Mark all groups that match some regular expression
1492 (@code{gnus-group-mark-regexp}).
1493 @end table
1495 Also @pxref{Process/Prefix}.
1497 @findex gnus-group-universal-argument
1498 If you want to execute some command on all groups that have been marked
1499 with the process mark, you can use the @kbd{M-&}
1500 (@code{gnus-group-universal-argument}) command.  It will prompt you for
1501 the command to be executed.
1504 @node Foreign Groups
1505 @section Foreign Groups
1506 @cindex foreign groups
1508 Below are some group mode commands for making and editing general foreign
1509 groups, as well as commands to ease the creation of a few
1510 special-purpose groups.  All these commands insert the newly created
1511 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1512 consulted.
1514 @table @kbd
1516 @item G m
1517 @kindex G m (Group)
1518 @findex gnus-group-make-group
1519 @cindex making groups
1520 Make a new group (@code{gnus-group-make-group}).  Gnus will prompt you
1521 for a name, a method and possibly an @dfn{address}.  For an easier way
1522 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1524 @item G r
1525 @kindex G r (Group)
1526 @findex gnus-group-rename-group
1527 @cindex renaming groups
1528 Rename the current group to something else
1529 (@code{gnus-group-rename-group}).  This is valid only on some
1530 groups---mail groups mostly.  This command might very well be quite slow
1531 on some backends.
1533 @item G c
1534 @kindex G c (Group)
1535 @cindex customizing
1536 @findex gnus-group-customize
1537 Customize the group parameters (@code{gnus-group-customize}).
1539 @item G e
1540 @kindex G e (Group)
1541 @findex gnus-group-edit-group-method
1542 @cindex renaming groups
1543 Enter a buffer where you can edit the select method of the current
1544 group (@code{gnus-group-edit-group-method}).
1546 @item G p
1547 @kindex G p (Group)
1548 @findex gnus-group-edit-group-parameters
1549 Enter a buffer where you can edit the group parameters
1550 (@code{gnus-group-edit-group-parameters}).
1552 @item G E
1553 @kindex G E (Group)
1554 @findex gnus-group-edit-group
1555 Enter a buffer where you can edit the group info
1556 (@code{gnus-group-edit-group}).
1558 @item G d
1559 @kindex G d (Group)
1560 @findex gnus-group-make-directory-group
1561 @cindex nndir
1562 Make a directory group (@pxref{Directory Groups}).  You will be prompted
1563 for a directory name (@code{gnus-group-make-directory-group}).
1565 @item G h
1566 @kindex G h (Group)
1567 @cindex help group
1568 @findex gnus-group-make-help-group
1569 Make the Gnus help group (@code{gnus-group-make-help-group}).
1571 @item G a
1572 @kindex G a (Group)
1573 @cindex (ding) archive
1574 @cindex archive group
1575 @findex gnus-group-make-archive-group
1576 @vindex gnus-group-archive-directory
1577 @vindex gnus-group-recent-archive-directory
1578 Make a Gnus archive group (@code{gnus-group-make-archive-group}).  By
1579 default a group pointing to the most recent articles will be created
1580 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1581 group will be created from @code{gnus-group-archive-directory}.
1583 @item G k
1584 @kindex G k (Group)
1585 @findex gnus-group-make-kiboze-group
1586 @cindex nnkiboze
1587 Make a kiboze group.  You will be prompted for a name, for a regexp to
1588 match groups to be ``included'' in the kiboze group, and a series of
1589 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1590 @xref{Kibozed Groups}.
1592 @item G D
1593 @kindex G D (Group)
1594 @findex gnus-group-enter-directory
1595 @cindex nneething
1596 Read an arbitrary directory as if it were a newsgroup with the
1597 @code{nneething} backend (@code{gnus-group-enter-directory}).
1598 @xref{Anything Groups}.
1600 @item G f
1601 @kindex G f (Group)
1602 @findex gnus-group-make-doc-group
1603 @cindex ClariNet Briefs
1604 @cindex nndoc
1605 Make a group based on some file or other
1606 (@code{gnus-group-make-doc-group}).  If you give a prefix to this
1607 command, you will be prompted for a file name and a file type.
1608 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1609 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1610 @code{rfc934}, @code{rfc822-forward}, and @code{forward}.  If you run
1611 this command without a prefix, Gnus will guess at the file type.
1612 @xref{Document Groups}.
1614 @item G u
1615 @kindex G u (Group)
1616 @vindex gnus-useful-groups
1617 @findex gnus-group-make-useful-group
1618 Create one of the groups mentioned in @code{gnus-useful-groups}
1619 (@code{gnus-group-make-useful-group}).
1621 @item G w
1622 @kindex G w (Group)
1623 @findex gnus-group-make-web-group
1624 @cindex DejaNews
1625 @cindex Alta Vista
1626 @cindex InReference
1627 @cindex nnweb
1628 Make an ephemeral group based on a web search
1629 (@code{gnus-group-make-web-group}).  If you give a prefix to this
1630 command, make a solid group instead.  You will be prompted for the
1631 search engine type and the search string.  Valid search engine types
1632 include @code{dejanews}, @code{altavista} and @code{reference}.
1633 @xref{Web Searches}.
1635 If you use the @code{dejanews} search engine, you can limit the search
1636 to a particular group by using a match string like
1637 @samp{~g alt.sysadmin.recovery shaving}.
1639 @item G DEL
1640 @kindex G DEL (Group)
1641 @findex gnus-group-delete-group
1642 This function will delete the current group
1643 (@code{gnus-group-delete-group}).  If given a prefix, this function will
1644 actually delete all the articles in the group, and forcibly remove the
1645 group itself from the face of the Earth.  Use a prefix only if you are
1646 absolutely sure of what you are doing.  This command can't be used on
1647 read-only groups (like @code{nntp} group), though.
1649 @item G V
1650 @kindex G V (Group)
1651 @findex gnus-group-make-empty-virtual
1652 Make a new, fresh, empty @code{nnvirtual} group
1653 (@code{gnus-group-make-empty-virtual}).  @xref{Virtual Groups}.
1655 @item G v
1656 @kindex G v (Group)
1657 @findex gnus-group-add-to-virtual
1658 Add the current group to an @code{nnvirtual} group
1659 (@code{gnus-group-add-to-virtual}).  Uses the process/prefix convention.
1660 @end table
1662 @xref{Select Methods}, for more information on the various select
1663 methods.
1665 @vindex gnus-activate-foreign-newsgroups
1666 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1667 Gnus will check all foreign groups with this level or lower at startup.
1668 This might take quite a while, especially if you subscribe to lots of
1669 groups from different @sc{nntp} servers.  Also @pxref{Group Levels};
1670 @code{gnus-activate-level} also affects activation of foreign
1671 newsgroups. 
1674 @node Group Parameters
1675 @section Group Parameters
1676 @cindex group parameters
1678 The group parameters store information local to a particular group.
1679 Here's an example group parameter list:
1681 @example
1682 ((to-address . "ding@@gnus.org")
1683  (auto-expire . t))
1684 @end example
1686 We see that each element consists of a "dotted pair"---the thing before
1687 the dot is the key, while the thing after the dot is the value.  All the
1688 parameters have this form @emph{except} local variable specs, which are
1689 not dotted pairs, but proper lists.
1691 The following group parameters can be used:
1693 @table @code
1694 @item to-address
1695 @cindex to-address
1696 Address used by when doing followups and new posts.
1698 @example
1699 (to-address .  "some@@where.com")
1700 @end example
1702 This is primarily useful in mail groups that represent closed mailing
1703 lists---mailing lists where it's expected that everybody that writes to
1704 the mailing list is subscribed to it.  Since using this parameter
1705 ensures that the mail only goes to the mailing list itself, it means
1706 that members won't receive two copies of your followups.
1708 Using @code{to-address} will actually work whether the group is foreign
1709 or not.  Let's say there's a group on the server that is called
1710 @samp{fa.4ad-l}.  This is a real newsgroup, but the server has gotten
1711 the articles from a mail-to-news gateway.  Posting directly to this
1712 group is therefore impossible---you have to send mail to the mailing
1713 list address instead.
1715 @item to-list
1716 @cindex to-list
1717 Address used when doing a @kbd{a} in that group.
1719 @example
1720 (to-list . "some@@where.com")
1721 @end example
1723 It is totally ignored
1724 when doing a followup---except that if it is present in a news group,
1725 you'll get mail group semantics when doing @kbd{f}.
1727 If you do an @kbd{a} command in a mail group and you have neither a
1728 @code{to-list} group parameter nor a @code{to-address} group parameter,
1729 then a @code{to-list} group parameter will be added automatically upon
1730 sending the message if @code{gnus-add-to-list} is set to @code{t}.
1731 @vindex gnus-add-to-list
1733 If you do an @kbd{a} command in a mail group and you don't have a
1734 @code{to-list} group parameter, one will be added automatically upon
1735 sending the message.
1737 @item visible
1738 @cindex visible
1739 If the group parameter list has the element @code{(visible . t)},
1740 that group will always be visible in the Group buffer, regardless
1741 of whether it has any unread articles.
1743 @item broken-reply-to
1744 @cindex broken-reply-to
1745 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
1746 headers in this group are to be ignored.  This can be useful if you're
1747 reading a mailing list group where the listserv has inserted
1748 @code{Reply-To} headers that point back to the listserv itself.  This is
1749 broken behavior.  So there!
1751 @item to-group
1752 @cindex to-group
1753 Elements like @code{(to-group . "some.group.name")} means that all
1754 posts in that group will be sent to @code{some.group.name}.
1756 @item newsgroup
1757 @cindex newsgroup
1758 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
1759 will treat all responses as if they were responses to news articles.
1760 This can be useful if you have a mail group that's really a mirror of a
1761 news group.
1763 @item gcc-self
1764 @cindex gcc-self
1765 If @code{(gcc-self . t)} is present in the group parameter list, newly
1766 composed messages will be @code{Gcc}'d to the current group. If
1767 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
1768 generated, if @code{(gcc-self . "string")} is present, this string will
1769 be inserted literally as a @code{gcc} header.  This parameter takes
1770 precedence over any default @code{Gcc} rules as described later
1771 (@pxref{Archived Messages}).
1773 @item auto-expire
1774 @cindex auto-expire
1775 If the group parameter has an element that looks like @code{(auto-expire
1776 . t)}, all articles read will be marked as expirable.  For an
1777 alternative approach, @pxref{Expiring Mail}.
1779 @item total-expire
1780 @cindex total-expire
1781 If the group parameter has an element that looks like
1782 @code{(total-expire . t)}, all read articles will be put through the
1783 expiry process, even if they are not marked as expirable.  Use with
1784 caution.  Unread, ticked and dormant articles are not eligible for
1785 expiry.
1787 @item expiry-wait
1788 @cindex expiry-wait
1789 @vindex nnmail-expiry-wait-function
1790 If the group parameter has an element that looks like @code{(expiry-wait
1791 . 10)}, this value will override any @code{nnmail-expiry-wait} and
1792 @code{nnmail-expiry-wait-function} when expiring expirable messages.
1793 The value can either be a number of days (not necessarily an integer) or
1794 the symbols @code{never} or @code{immediate}.
1796 @item score-file
1797 @cindex score file group parameter
1798 Elements that look like @code{(score-file . "file")} will make
1799 @file{file} into the current score file for the group in question.  All
1800 interactive score entries will be put into this file.
1802 @item adapt-file
1803 @cindex adapt file group parameter
1804 Elements that look like @code{(adapt-file . "file")} will make
1805 @file{file} into the current adaptive file for the group in question.
1806 All adaptive score entries will be put into this file.
1808 @item admin-address
1809 When unsubscribing from a mailing list you should never send the
1810 unsubscription notice to the mailing list itself.  Instead, you'd send
1811 messages to the administrative address.  This parameter allows you to
1812 put the admin address somewhere convenient.
1814 @item display
1815 Elements that look like @code{(display . MODE)} say which articles to
1816 display on entering the group.  Valid values are:
1818 @table @code
1819 @item all
1820 Display all articles, both read and unread.
1822 @item default
1823 Display the default visible articles, which normally includes unread and
1824 ticked articles.
1825 @end table
1827 @item comment
1828 Elements that look like @code{(comment . "This is a comment")}
1829 are arbitrary comments on the group.  They are currently ignored by
1830 Gnus, but provide a place for you to store information on particular
1831 groups.
1833 @item @code{(@var{variable} @var{form})}
1834 You can use the group parameters to set variables local to the group you
1835 are entering.  If you want to turn threading off in @samp{news.answers},
1836 you could put @code{(gnus-show-threads nil)} in the group parameters of
1837 that group.  @code{gnus-show-threads} will be made into a local variable
1838 in the summary buffer you enter, and the form @code{nil} will be
1839 @code{eval}ed there.
1841 This can also be used as a group-specific hook function, if you'd like.
1842 If you want to hear a beep when you enter a group, you could put
1843 something like @code{(dummy-variable (ding))} in the parameters of that
1844 group.  @code{dummy-variable} will be set to the result of the
1845 @code{(ding)} form, but who cares?
1847 @end table
1849 Use the @kbd{G p} command to edit group parameters of a group.  You
1850 might also be interested in reading about topic parameters (@pxref{Topic
1851 Parameters}).
1854 @node Listing Groups
1855 @section Listing Groups
1856 @cindex group listing
1858 These commands all list various slices of the groups available.
1860 @table @kbd
1862 @item l
1863 @itemx A s
1864 @kindex A s (Group)
1865 @kindex l (Group)
1866 @findex gnus-group-list-groups
1867 List all groups that have unread articles
1868 (@code{gnus-group-list-groups}).  If the numeric prefix is used, this
1869 command will list only groups of level ARG and lower.  By default, it
1870 only lists groups of level five (i. e.,
1871 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
1872 groups).
1874 @item L
1875 @itemx A u
1876 @kindex A u (Group)
1877 @kindex L (Group)
1878 @findex gnus-group-list-all-groups
1879 List all groups, whether they have unread articles or not
1880 (@code{gnus-group-list-all-groups}).  If the numeric prefix is used,
1881 this command will list only groups of level ARG and lower.  By default,
1882 it lists groups of level seven or lower (i.e., just subscribed and
1883 unsubscribed groups).
1885 @item A l
1886 @kindex A l (Group)
1887 @findex gnus-group-list-level
1888 List all unread groups on a specific level
1889 (@code{gnus-group-list-level}).  If given a prefix, also list the groups
1890 with no unread articles.
1892 @item A k
1893 @kindex A k (Group)
1894 @findex gnus-group-list-killed
1895 List all killed groups (@code{gnus-group-list-killed}).  If given a
1896 prefix argument, really list all groups that are available, but aren't
1897 currently (un)subscribed.  This could entail reading the active file
1898 from the server.
1900 @item A z
1901 @kindex A z (Group)
1902 @findex gnus-group-list-zombies
1903 List all zombie groups (@code{gnus-group-list-zombies}).
1905 @item A m
1906 @kindex A m (Group)
1907 @findex gnus-group-list-matching
1908 List all unread, subscribed groups with names that match a regexp
1909 (@code{gnus-group-list-matching}).
1911 @item A M
1912 @kindex A M (Group)
1913 @findex gnus-group-list-all-matching
1914 List groups that match a regexp (@code{gnus-group-list-all-matching}).
1916 @item A A
1917 @kindex A A (Group)
1918 @findex gnus-group-list-active
1919 List absolutely all groups in the active file(s) of the
1920 server(s) you are connected to (@code{gnus-group-list-active}).  This
1921 might very well take quite a while.  It might actually be a better idea
1922 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
1923 thing to match on.  Also note that this command may list groups that
1924 don't exist (yet)---these will be listed as if they were killed groups.
1925 Take the output with some grains of salt.
1927 @item A a
1928 @kindex A a (Group)
1929 @findex gnus-group-apropos
1930 List all groups that have names that match a regexp
1931 (@code{gnus-group-apropos}).
1933 @item A d
1934 @kindex A d (Group)
1935 @findex gnus-group-description-apropos
1936 List all groups that have names or descriptions that match a regexp
1937 (@code{gnus-group-description-apropos}).
1939 @end table
1941 @vindex gnus-permanently-visible-groups
1942 @cindex visible group parameter
1943 Groups that match the @code{gnus-permanently-visible-groups} regexp will
1944 always be shown, whether they have unread articles or not.  You can also
1945 add the @code{visible} element to the group parameters in question to
1946 get the same effect.
1948 @vindex gnus-list-groups-with-ticked-articles
1949 Groups that have just ticked articles in it are normally listed in the
1950 group buffer.  If @code{gnus-list-groups-with-ticked-articles} is
1951 @code{nil}, these groups will be treated just like totally empty
1952 groups.  It is @code{t} by default.
1955 @node Sorting Groups
1956 @section Sorting Groups
1957 @cindex sorting groups
1959 @kindex C-c C-s (Group)
1960 @findex gnus-group-sort-groups
1961 @vindex gnus-group-sort-function
1962 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
1963 group buffer according to the function(s) given by the
1964 @code{gnus-group-sort-function} variable.  Available sorting functions
1965 include:
1967 @table @code
1969 @item gnus-group-sort-by-alphabet
1970 @findex gnus-group-sort-by-alphabet
1971 Sort the group names alphabetically.  This is the default.
1973 @item gnus-group-sort-by-real-name
1974 @findex gnus-group-sort-by-real-name
1975 Sort the group alphabetically on the real (unprefixed) group names.
1977 @item gnus-group-sort-by-level
1978 @findex gnus-group-sort-by-level
1979 Sort by group level.
1981 @item gnus-group-sort-by-score
1982 @findex gnus-group-sort-by-score
1983 Sort by group score.  @xref{Group Score}.
1985 @item gnus-group-sort-by-rank
1986 @findex gnus-group-sort-by-rank
1987 Sort by group score and then the group level.  The level and the score
1988 are, when taken together, the group's @dfn{rank}.  @xref{Group Score}.
1990 @item gnus-group-sort-by-unread
1991 @findex gnus-group-sort-by-unread
1992 Sort by number of unread articles.
1994 @item gnus-group-sort-by-method
1995 @findex gnus-group-sort-by-method
1996 Sort alphabetically on the select method.
1999 @end table
2001 @code{gnus-group-sort-function} can also be a list of sorting
2002 functions.  In that case, the most significant sort key function must be
2003 the last one.
2006 There are also a number of commands for sorting directly according to
2007 some sorting criteria:
2009 @table @kbd
2010 @item G S a
2011 @kindex G S a (Group)
2012 @findex gnus-group-sort-groups-by-alphabet
2013 Sort the group buffer alphabetically by group name
2014 (@code{gnus-group-sort-groups-by-alphabet}).
2016 @item G S u
2017 @kindex G S u (Group)
2018 @findex gnus-group-sort-groups-by-unread
2019 Sort the group buffer by the number of unread articles
2020 (@code{gnus-group-sort-groups-by-unread}).
2022 @item G S l
2023 @kindex G S l (Group)
2024 @findex gnus-group-sort-groups-by-level
2025 Sort the group buffer by group level
2026 (@code{gnus-group-sort-groups-by-level}).
2028 @item G S v
2029 @kindex G S v (Group)
2030 @findex gnus-group-sort-groups-by-score
2031 Sort the group buffer by group score
2032 (@code{gnus-group-sort-groups-by-score}).  @xref{Group Score}.
2034 @item G S r
2035 @kindex G S r (Group)
2036 @findex gnus-group-sort-groups-by-rank
2037 Sort the group buffer by group rank
2038 (@code{gnus-group-sort-groups-by-rank}).  @xref{Group Score}.
2040 @item G S m
2041 @kindex G S m (Group)
2042 @findex gnus-group-sort-groups-by-method
2043 Sort the group buffer alphabetically by backend name
2044 (@code{gnus-group-sort-groups-by-method}).
2046 @end table
2048 When given a prefix, all these commands will sort in reverse order.
2050 You can also sort a subset of the groups:
2052 @table @kbd
2053 @item G P a
2054 @kindex G P a (Group)
2055 @findex gnus-group-sort-selected-groups-by-alphabet
2056 Sort the process/prefixed groups in the group buffer alphabetically by
2057 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2059 @item G P u
2060 @kindex G P u (Group)
2061 @findex gnus-group-sort-selected-groups-by-unread
2062 Sort the process/prefixed groups in the group buffer by the number of
2063 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2065 @item G P l
2066 @kindex G P l (Group)
2067 @findex gnus-group-sort-selected-groups-by-level
2068 Sort the process/prefixed groups in the group buffer by group level
2069 (@code{gnus-group-sort-selected-groups-by-level}).
2071 @item G P v
2072 @kindex G P v (Group)
2073 @findex gnus-group-sort-selected-groups-by-score
2074 Sort the process/prefixed groups in the group buffer by group score
2075 (@code{gnus-group-sort-selected-groups-by-score}).  @xref{Group Score}.
2077 @item G P r
2078 @kindex G P r (Group)
2079 @findex gnus-group-sort-selected-groups-by-rank
2080 Sort the process/prefixed groups in the group buffer by group rank
2081 (@code{gnus-group-sort-selected-groups-by-rank}).  @xref{Group Score}.
2083 @item G P m
2084 @kindex G P m (Group)
2085 @findex gnus-group-sort-selected-groups-by-method
2086 Sort the process/prefixed groups in the group buffer alphabetically by
2087 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2089 @end table
2093 @node Group Maintenance
2094 @section Group Maintenance
2095 @cindex bogus groups
2097 @table @kbd
2098 @item b
2099 @kindex b (Group)
2100 @findex gnus-group-check-bogus-groups
2101 Find bogus groups and delete them
2102 (@code{gnus-group-check-bogus-groups}).
2104 @item F
2105 @kindex F (Group)
2106 @findex gnus-group-find-new-groups
2107 Find new groups and process them (@code{gnus-group-find-new-groups}).
2108 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
2109 for new groups.  With 2 @kbd{C-u}'s, use most complete method possible
2110 to query the server for new groups, and subscribe the new groups as
2111 zombies.
2113 @item C-c C-x
2114 @kindex C-c C-x (Group)
2115 @findex gnus-group-expire-articles
2116 Run all expirable articles in the current group through the expiry
2117 process (if any) (@code{gnus-group-expire-articles}).
2119 @item C-c M-C-x
2120 @kindex C-c M-C-x (Group)
2121 @findex gnus-group-expire-all-groups
2122 Run all articles in all groups through the expiry process
2123 (@code{gnus-group-expire-all-groups}).
2125 @end table
2128 @node Browse Foreign Server
2129 @section Browse Foreign Server
2130 @cindex foreign servers
2131 @cindex browsing servers
2133 @table @kbd
2134 @item B
2135 @kindex B (Group)
2136 @findex gnus-group-browse-foreign-server
2137 You will be queried for a select method and a server name.  Gnus will
2138 then attempt to contact this server and let you browse the groups there
2139 (@code{gnus-group-browse-foreign-server}).
2140 @end table
2142 @findex gnus-browse-mode
2143 A new buffer with a list of available groups will appear.  This buffer
2144 will use the @code{gnus-browse-mode}.  This buffer looks a bit (well,
2145 a lot) like a normal group buffer.
2147 Here's a list of keystrokes available in the browse mode:
2149 @table @kbd
2150 @item n
2151 @kindex n (Browse)
2152 @findex gnus-group-next-group
2153 Go to the next group (@code{gnus-group-next-group}).
2155 @item p
2156 @kindex p (Browse)
2157 @findex gnus-group-prev-group
2158 Go to the previous group (@code{gnus-group-prev-group}).
2160 @item SPACE
2161 @kindex SPACE (Browse)
2162 @findex gnus-browse-read-group
2163 Enter the current group and display the first article
2164 (@code{gnus-browse-read-group}).
2166 @item RET
2167 @kindex RET (Browse)
2168 @findex gnus-browse-select-group
2169 Enter the current group (@code{gnus-browse-select-group}).
2171 @item u
2172 @kindex u (Browse)
2173 @findex gnus-browse-unsubscribe-current-group
2174 Unsubscribe to the current group, or, as will be the case here,
2175 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2177 @item l
2178 @itemx q
2179 @kindex q (Browse)
2180 @kindex l (Browse)
2181 @findex gnus-browse-exit
2182 Exit browse mode (@code{gnus-browse-exit}).
2184 @item ?
2185 @kindex ? (Browse)
2186 @findex gnus-browse-describe-briefly
2187 Describe browse mode briefly (well, there's not much to describe, is
2188 there) (@code{gnus-browse-describe-briefly}).
2189 @end table
2192 @node Exiting Gnus
2193 @section Exiting Gnus
2194 @cindex exiting Gnus
2196 Yes, Gnus is ex(c)iting.
2198 @table @kbd
2199 @item z
2200 @kindex z (Group)
2201 @findex gnus-group-suspend
2202 Suspend Gnus (@code{gnus-group-suspend}).  This doesn't really exit Gnus,
2203 but it kills all buffers except the Group buffer.  I'm not sure why this
2204 is a gain, but then who am I to judge?
2206 @item q
2207 @kindex q (Group)
2208 @findex gnus-group-exit
2209 @c @icon{gnus-group-exit}
2210 Quit Gnus (@code{gnus-group-exit}).
2212 @item Q
2213 @kindex Q (Group)
2214 @findex gnus-group-quit
2215 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2216 The dribble file will be saved, though (@pxref{Auto Save}).
2217 @end table
2219 @vindex gnus-exit-gnus-hook
2220 @vindex gnus-suspend-gnus-hook
2221 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2222 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2223 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2224 exiting Gnus.
2226 @findex gnus-unload
2227 @cindex unloading
2228 If you wish to completely unload Gnus and all its adherents, you can use
2229 the @code{gnus-unload} command.  This command is also very handy when
2230 trying to customize meta-variables.
2232 Note:
2234 @quotation
2235 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2236 numbly heavy and herself fall into a hazy trance as the boy sitting
2237 behind her drew repeated lines with his pencil across the back of her
2238 plastic chair.
2239 @end quotation
2242 @node Group Topics
2243 @section Group Topics
2244 @cindex topics
2246 If you read lots and lots of groups, it might be convenient to group
2247 them hierarchically according to topics.  You put your Emacs groups over
2248 here, your sex groups over there, and the rest (what, two groups or so?)
2249 you put in some misc section that you never bother with anyway.  You can
2250 even group the Emacs sex groups as a sub-topic to either the Emacs
2251 groups or the sex groups---or both!  Go wild!
2253 Here's an example:
2255 @example
2256 Gnus
2257   Emacs -- I wuw it!
2258      3: comp.emacs
2259      2: alt.religion.emacs
2260     Naughty Emacs
2261      452: alt.sex.emacs
2262        0: comp.talk.emacs.recovery
2263   Misc
2264      8: comp.binaries.fractals
2265     13: comp.sources.unix
2266 @end example
2268 @findex gnus-topic-mode
2269 @kindex t (Group)
2270 To get this @emph{fab} functionality you simply turn on (ooh!) the
2271 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer.  (This
2272 is a toggling command.)
2274 Go ahead, just try it.  I'll still be here when you get back.  La de
2275 dum...  Nice tune, that...  la la la...  What, you're back? Yes, and now
2276 press @kbd{l}.  There.  All your groups are now listed under
2277 @samp{misc}.  Doesn't that make you feel all warm and fuzzy?  Hot and
2278 bothered?
2280 If you want this permanently enabled, you should add that minor mode to
2281 the hook for the group mode:
2283 @lisp
2284 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2285 @end lisp
2287 @menu
2288 * Topic Variables::    How to customize the topics the Lisp Way.
2289 * Topic Commands::     Interactive E-Z commands.
2290 * Topic Sorting::      Sorting each topic individually.
2291 * Topic Topology::     A map of the world.
2292 * Topic Parameters::   Parameters that apply to all groups in a topic.
2293 @end menu
2296 @node Topic Variables
2297 @subsection Topic Variables
2298 @cindex topic variables
2300 Now, if you select a topic, it will fold/unfold that topic, which is
2301 really neat, I think.
2303 @vindex gnus-topic-line-format
2304 The topic lines themselves are created according to the
2305 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2306 Valid elements are:
2308 @table @samp
2309 @item i
2310 Indentation.
2311 @item n
2312 Topic name.
2313 @item v
2314 Visibility.
2315 @item l
2316 Level.
2317 @item g
2318 Number of groups in the topic.
2319 @item a
2320 Number of unread articles in the topic.
2321 @item A
2322 Number of unread articles in the topic and all its subtopics.
2323 @end table
2325 @vindex gnus-topic-indent-level
2326 Each sub-topic (and the groups in the sub-topics) will be indented with
2327 @code{gnus-topic-indent-level} times the topic level number of spaces.
2328 The default is 2.
2330 @vindex gnus-topic-mode-hook
2331 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2333 @vindex gnus-topic-display-empty-topics
2334 The @code{gnus-topic-display-empty-topics} says whether to display even
2335 topics that have no unread articles in them.  The default is @code{t}.
2338 @node Topic Commands
2339 @subsection Topic Commands
2340 @cindex topic commands
2342 When the topic minor mode is turned on, a new @kbd{T} submap will be
2343 available.  In addition, a few of the standard keys change their
2344 definitions slightly.
2346 @table @kbd
2348 @item T n
2349 @kindex T n (Topic)
2350 @findex gnus-topic-create-topic
2351 Prompt for a new topic name and create it
2352 (@code{gnus-topic-create-topic}).
2354 @item T m
2355 @kindex T m (Topic)
2356 @findex gnus-topic-move-group
2357 Move the current group to some other topic
2358 (@code{gnus-topic-move-group}).  This command uses the process/prefix
2359 convention (@pxref{Process/Prefix}).
2361 @item T c
2362 @kindex T c (Topic)
2363 @findex gnus-topic-copy-group
2364 Copy the current group to some other topic
2365 (@code{gnus-topic-copy-group}).  This command uses the process/prefix
2366 convention (@pxref{Process/Prefix}).
2368 @item T D
2369 @kindex T D (Topic)
2370 @findex gnus-topic-remove-group
2371 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2372 This command is mainly useful if you have the same group in several
2373 topics and wish to remove it from one of the topics.  You may also
2374 remove a group from all topics, but in that case, Gnus will add it to
2375 the root topic the next time you start Gnus.  In fact, all new groups
2376 (which, naturally, don't belong to any topic) will show up in the root
2377 topic. 
2379 This command uses the process/prefix convention
2380 (@pxref{Process/Prefix}).
2382 @item T M
2383 @kindex T M (Topic)
2384 @findex gnus-topic-move-matching
2385 Move all groups that match some regular expression to a topic
2386 (@code{gnus-topic-move-matching}).
2388 @item T C
2389 @kindex T C (Topic)
2390 @findex gnus-topic-copy-matching
2391 Copy all groups that match some regular expression to a topic
2392 (@code{gnus-topic-copy-matching}).
2394 @item T H
2395 @kindex T H (Topic)
2396 @findex gnus-topic-toggle-display-empty-topics
2397 Toggle hiding empty topics
2398 (@code{gnus-topic-toggle-display-empty-topics}).
2400 @item T #
2401 @kindex T # (Topic)
2402 @findex gnus-topic-mark-topic
2403 Mark all groups in the current topic with the process mark
2404 (@code{gnus-topic-mark-topic}).
2406 @item T M-#
2407 @kindex T M-# (Topic)
2408 @findex gnus-topic-unmark-topic
2409 Remove the process mark from all groups in the current topic
2410 (@code{gnus-topic-unmark-topic}).
2412 @item RET
2413 @kindex RET (Topic)
2414 @findex gnus-topic-select-group
2415 @itemx SPACE
2416 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2417 When you perform this command on a group, you'll enter the group, as
2418 usual.  When done on a topic line, the topic will be folded (if it was
2419 visible) or unfolded (if it was folded already).  So it's basically a
2420 toggling command on topics.  In addition, if you give a numerical
2421 prefix, group on that level (and lower) will be displayed.
2423 @item T TAB
2424 @itemx TAB
2425 @kindex T TAB (Topic)
2426 @kindex TAB (Topic)
2427 @findex gnus-topic-indent
2428 ``Indent'' the current topic so that it becomes a sub-topic of the
2429 previous topic (@code{gnus-topic-indent}).  If given a prefix,
2430 ``un-indent'' the topic instead.
2432 @item M-TAB
2433 @kindex M-TAB (Topic)
2434 @findex gnus-topic-unindent
2435 ``Un-indent'' the current topic so that it becomes a sub-topic of the
2436 parent of its current parent (@code{gnus-topic-unindent}).  
2438 @item C-k
2439 @kindex C-k (Topic)
2440 @findex gnus-topic-kill-group
2441 Kill a group or topic (@code{gnus-topic-kill-group}).  All groups in the
2442 topic will be removed along with the topic.
2444 @item C-y
2445 @kindex C-y (Topic)
2446 @findex gnus-topic-yank-group
2447 Yank the previously killed group or topic
2448 (@code{gnus-topic-yank-group}).  Note that all topics will be yanked
2449 before all groups.
2451 @item T r
2452 @kindex T r (Topic)
2453 @findex gnus-topic-rename
2454 Rename a topic (@code{gnus-topic-rename}).
2456 @item T DEL
2457 @kindex T DEL (Topic)
2458 @findex gnus-topic-delete
2459 Delete an empty topic (@code{gnus-topic-delete}).
2461 @item A T
2462 @kindex A T (Topic)
2463 @findex gnus-topic-list-active
2464 List all groups that Gnus knows about in a topics-ified way
2465 (@code{gnus-topic-list-active}).
2467 @item G p
2468 @kindex G p (Topic)
2469 @findex gnus-topic-edit-parameters
2470 @cindex group parameters
2471 @cindex topic parameters
2472 @cindex parameters
2473 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2474 @xref{Topic Parameters}.
2476 @end table
2479 @node Topic Sorting
2480 @subsection Topic Sorting
2481 @cindex topic sorting
2483 You can sort the groups in each topic individually with the following
2484 commands:
2487 @table @kbd
2488 @item T S a
2489 @kindex T S a (Topic)
2490 @findex gnus-topic-sort-groups-by-alphabet
2491 Sort the current topic alphabetically by group name
2492 (@code{gnus-topic-sort-groups-by-alphabet}).
2494 @item T S u
2495 @kindex T S u (Topic)
2496 @findex gnus-topic-sort-groups-by-unread
2497 Sort the current topic by the number of unread articles
2498 (@code{gnus-topic-sort-groups-by-unread}).
2500 @item T S l
2501 @kindex T S l (Topic)
2502 @findex gnus-topic-sort-groups-by-level
2503 Sort the current topic by group level
2504 (@code{gnus-topic-sort-groups-by-level}).
2506 @item T S v
2507 @kindex T S v (Topic)
2508 @findex gnus-topic-sort-groups-by-score
2509 Sort the current topic by group score
2510 (@code{gnus-topic-sort-groups-by-score}).  @xref{Group Score}.
2512 @item T S r
2513 @kindex T S r (Topic)
2514 @findex gnus-topic-sort-groups-by-rank
2515 Sort the current topic by group rank
2516 (@code{gnus-topic-sort-groups-by-rank}).  @xref{Group Score}.
2518 @item T S m
2519 @kindex T S m (Topic)
2520 @findex gnus-topic-sort-groups-by-method
2521 Sort the current topic alphabetically by backend name
2522 (@code{gnus-topic-sort-groups-by-method}).
2524 @end table
2526 @xref{Sorting Groups}, for more information about group sorting.
2529 @node Topic Topology
2530 @subsection Topic Topology
2531 @cindex topic topology
2532 @cindex topology
2534 So, let's have a look at an example group buffer:
2536 @example
2537 Gnus
2538   Emacs -- I wuw it!
2539      3: comp.emacs
2540      2: alt.religion.emacs
2541     Naughty Emacs
2542      452: alt.sex.emacs
2543        0: comp.talk.emacs.recovery
2544   Misc
2545      8: comp.binaries.fractals
2546     13: comp.sources.unix
2547 @end example
2549 So, here we have one top-level topic (@samp{Gnus}), two topics under
2550 that, and one sub-topic under one of the sub-topics.  (There is always
2551 just one (1) top-level topic).  This topology can be expressed as
2552 follows:
2554 @lisp
2555 (("Gnus" visible)
2556  (("Emacs -- I wuw it!" visible)
2557   (("Naughty Emacs" visible)))
2558  (("Misc" visible)))
2559 @end lisp
2561 @vindex gnus-topic-topology
2562 This is in fact how the variable @code{gnus-topic-topology} would look
2563 for the display above.  That variable is saved in the @file{.newsrc.eld}
2564 file, and shouldn't be messed with manually---unless you really want
2565 to.  Since this variable is read from the @file{.newsrc.eld} file,
2566 setting it in any other startup files will have no effect.
2568 This topology shows what topics are sub-topics of what topics (right),
2569 and which topics are visible.  Two settings are currently
2570 allowed---@code{visible} and @code{invisible}.
2573 @node Topic Parameters
2574 @subsection Topic Parameters
2575 @cindex topic parameters
2577 All groups in a topic will inherit group parameters from the parent (and
2578 ancestor) topic parameters.  All valid group parameters are valid topic
2579 parameters (@pxref{Group Parameters}).
2581 Group parameters (of course) override topic parameters, and topic
2582 parameters in sub-topics override topic parameters in super-topics.  You
2583 know.  Normal inheritance rules.  (@dfn{Rules} is here a noun, not a
2584 verb, although you may feel free to disagree with me here.)
2586 @example
2587 Gnus
2588   Emacs
2589      3: comp.emacs
2590      2: alt.religion.emacs
2591    452: alt.sex.emacs
2592     Relief
2593      452: alt.sex.emacs
2594        0: comp.talk.emacs.recovery
2595   Misc
2596      8: comp.binaries.fractals
2597     13: comp.sources.unix
2598    452: alt.sex.emacs
2599 @end example
2601 The @samp{Emacs} topic has the topic parameter @code{(score-file
2602 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2603 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2604 topic parameter @code{(score-file . "emacs.SCORE")}.  In addition,
2605 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
2606 . "religion.SCORE")}.
2608 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2609 will get the @file{relief.SCORE} home score file.  If you enter the same
2610 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2611 score file.  If you enter the group @samp{alt.religion.emacs}, you'll
2612 get the @file{religion.SCORE} home score file.
2614 This seems rather simple and self-evident, doesn't it?  Well, yes.  But
2615 there are some problems, especially with the @code{total-expiry}
2616 parameter.  Say you have a mail group in two topics; one with
2617 @code{total-expiry} and one without.  What happens when you do @kbd{M-x
2618 gnus-expire-all-expirable-groups}?  Gnus has no way of telling which one
2619 of these topics you mean to expire articles from, so anything may
2620 happen.  In fact, I hereby declare that it is @dfn{undefined} what
2621 happens.  You just have to be careful if you do stuff like that.
2624 @node Misc Group Stuff
2625 @section Misc Group Stuff
2627 @menu
2628 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2629 * Group Information::     Information and help on groups and Gnus.
2630 * Group Timestamp::       Making Gnus keep track of when you last read a group.
2631 * File Commands::         Reading and writing the Gnus files.
2632 @end menu
2634 @table @kbd
2636 @item ^
2637 @kindex ^ (Group)
2638 @findex gnus-group-enter-server-mode
2639 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2640 @xref{The Server Buffer}.
2642 @item a
2643 @kindex a (Group)
2644 @findex gnus-group-post-news
2645 Post an article to a group (@code{gnus-group-post-news}).  If given a
2646 prefix, the current group name will be used as the default.
2648 @item m
2649 @kindex m (Group)
2650 @findex gnus-group-mail
2651 Mail a message somewhere (@code{gnus-group-mail}).
2653 @end table
2655 Variables for the group buffer:
2657 @table @code
2659 @item gnus-group-mode-hook
2660 @vindex gnus-group-mode-hook
2661 is called after the group buffer has been
2662 created.
2664 @item gnus-group-prepare-hook
2665 @vindex gnus-group-prepare-hook
2666 is called after the group buffer is
2667 generated.  It may be used to modify the buffer in some strange,
2668 unnatural way.
2670 @item gnus-group-prepared-hook
2671 @vindex gnus-group-prepare-hook
2672 is called as the very last thing after the group buffer has been
2673 generated.  It may be used to move point around, for instance.
2675 @item gnus-permanently-visible-groups
2676 @vindex gnus-permanently-visible-groups
2677 Groups matching this regexp will always be listed in the group buffer,
2678 whether they are empty or not.
2680 @end table
2683 @node Scanning New Messages
2684 @subsection Scanning New Messages
2685 @cindex new messages
2686 @cindex scanning new news
2688 @table @kbd
2690 @item g
2691 @kindex g (Group)
2692 @findex gnus-group-get-new-news
2693 @c @icon{gnus-group-get-new-news}
2694 Check the server(s) for new articles.  If the numerical prefix is used,
2695 this command will check only groups of level @var{arg} and lower
2696 (@code{gnus-group-get-new-news}).  If given a non-numerical prefix, this
2697 command will force a total re-reading of the active file(s) from the
2698 backend(s).
2700 @item M-g
2701 @kindex M-g (Group)
2702 @findex gnus-group-get-new-news-this-group
2703 @vindex gnus-goto-next-group-when-activating
2704 @c @icon{gnus-group-get-new-news-this-group}
2705 Check whether new articles have arrived in the current group
2706 (@code{gnus-group-get-new-news-this-group}).
2707 @code{gnus-goto-next-group-when-activating} says whether this command is
2708 to move point to the next group or not.  It is @code{t} by default.
2710 @findex gnus-activate-all-groups
2711 @cindex activating groups
2712 @item C-c M-g
2713 @kindex C-c M-g (Group)
2714 Activate absolutely all groups (@code{gnus-activate-all-groups}).
2716 @item R
2717 @kindex R (Group)
2718 @cindex restarting
2719 @findex gnus-group-restart
2720 Restart Gnus (@code{gnus-group-restart}).  This saves the @file{.newsrc}
2721 file(s), closes the connection to all servers, clears up all run-time
2722 Gnus variables, and then starts Gnus all over again.
2724 @end table
2726 @vindex gnus-get-new-news-hook
2727 @code{gnus-get-new-news-hook} is run just before checking for new news.
2729 @vindex gnus-after-getting-new-news-hook
2730 @code{gnus-after-getting-new-news-hook} is run after checking for new
2731 news.
2734 @node Group Information
2735 @subsection Group Information
2736 @cindex group information
2737 @cindex information on groups
2739 @table @kbd
2742 @item H f
2743 @kindex H f (Group)
2744 @findex gnus-group-fetch-faq
2745 @vindex gnus-group-faq-directory
2746 @cindex FAQ
2747 @cindex ange-ftp
2748 Try to fetch the FAQ for the current group
2749 (@code{gnus-group-fetch-faq}).  Gnus will try to get the FAQ from
2750 @code{gnus-group-faq-directory}, which is usually a directory on a
2751 remote machine.  This variable can also be a list of directories.  In
2752 that case, giving a prefix to this command will allow you to choose
2753 between the various sites.  @code{ange-ftp} (or @code{efs}) will be used
2754 for fetching the file.
2756 If fetching from the first site is unsuccessful, Gnus will attempt to go
2757 through @code{gnus-group-faq-directory} and try to open them one by one.
2759 @item H d
2760 @itemx C-c C-d
2761 @c @icon{gnus-group-describe-group}
2762 @kindex H d (Group)
2763 @kindex C-c C-d (Group)
2764 @cindex describing groups
2765 @cindex group description
2766 @findex gnus-group-describe-group
2767 Describe the current group (@code{gnus-group-describe-group}).  If given
2768 a prefix, force Gnus to re-read the description from the server.
2770 @item M-d
2771 @kindex M-d (Group)
2772 @findex gnus-group-describe-all-groups
2773 Describe all groups (@code{gnus-group-describe-all-groups}).  If given a
2774 prefix, force Gnus to re-read the description file from the server.
2776 @item H v
2777 @itemx V
2778 @kindex V (Group)
2779 @kindex H v (Group)
2780 @cindex version
2781 @findex gnus-version
2782 Display current Gnus version numbers (@code{gnus-version}).
2784 @item ?
2785 @kindex ? (Group)
2786 @findex gnus-group-describe-briefly
2787 Give a very short help message (@code{gnus-group-describe-briefly}).
2789 @item C-c C-i
2790 @kindex C-c C-i (Group)
2791 @cindex info
2792 @cindex manual
2793 @findex gnus-info-find-node
2794 Go to the Gnus info node (@code{gnus-info-find-node}).
2795 @end table
2798 @node Group Timestamp
2799 @subsection Group Timestamp
2800 @cindex timestamps
2801 @cindex group timestamps
2803 It can be convenient to let Gnus keep track of when you last read a
2804 group.  To set the ball rolling, you should add
2805 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
2807 @lisp
2808 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
2809 @end lisp
2811 After doing this, each time you enter a group, it'll be recorded.
2813 This information can be displayed in various ways---the easiest is to
2814 use the @samp{%d} spec in the group line format:
2816 @lisp
2817 (setq gnus-group-line-format
2818       "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
2819 @end lisp
2821 This will result in lines looking like:
2823 @example
2824 *        0: mail.ding                                19961002T012943
2825          0: custom                                   19961002T012713
2826 @end example
2828 As you can see, the date is displayed in compact ISO 8601 format.  This
2829 may be a bit too much, so to just display the date, you could say
2830 something like:
2832 @lisp
2833 (setq gnus-group-line-format
2834       "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
2835 @end lisp
2838 @node File Commands
2839 @subsection File Commands
2840 @cindex file commands
2842 @table @kbd
2844 @item r
2845 @kindex r (Group)
2846 @findex gnus-group-read-init-file
2847 @vindex gnus-init-file
2848 @cindex reading init file
2849 Re-read the init file (@code{gnus-init-file}, which defaults to
2850 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
2852 @item s
2853 @kindex s (Group)
2854 @findex gnus-group-save-newsrc
2855 @cindex saving .newsrc
2856 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
2857 (@code{gnus-group-save-newsrc}).  If given a prefix, force saving the
2858 file(s) whether Gnus thinks it is necessary or not.
2860 @c @item Z
2861 @c @kindex Z (Group)
2862 @c @findex gnus-group-clear-dribble
2863 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
2865 @end table
2868 @node The Summary Buffer
2869 @chapter The Summary Buffer
2870 @cindex summary buffer
2872 A line for each article is displayed in the summary buffer.  You can
2873 move around, read articles, post articles and reply to articles.
2875 The most common way to a summary buffer is to select a group from the
2876 group buffer (@pxref{Selecting a Group}).
2878 You can have as many summary buffers open as you wish.
2880 @menu
2881 * Summary Buffer Format::       Deciding how the summary buffer is to look.
2882 * Summary Maneuvering::         Moving around the summary buffer.
2883 * Choosing Articles::           Reading articles.
2884 * Paging the Article::          Scrolling the current article.
2885 * Reply Followup and Post::     Posting articles.
2886 * Canceling and Superseding::   ``Whoops, I shouldn't have called him that.''
2887 * Marking Articles::            Marking articles as read, expirable, etc.
2888 * Limiting::                    You can limit the summary buffer.
2889 * Threading::                   How threads are made.
2890 * Sorting::                     How articles and threads are sorted.
2891 * Asynchronous Fetching::       Gnus might be able to pre-fetch articles.
2892 * Article Caching::             You may store articles in a cache.
2893 * Persistent Articles::         Making articles expiry-resistant.
2894 * Article Backlog::             Having already read articles hang around.
2895 * Saving Articles::             Ways of customizing article saving.
2896 * Decoding Articles::           Gnus can treat series of (uu)encoded articles.
2897 * Article Treatment::           The article buffer can be mangled at will.
2898 * Article Commands::            Doing various things with the article buffer.
2899 * Summary Sorting::             Sorting the summary buffer in various ways.
2900 * Finding the Parent::          No child support? Get the parent.
2901 * Alternative Approaches::      Reading using non-default summaries.
2902 * Tree Display::                A more visual display of threads.
2903 * Mail Group Commands::         Some commands can only be used in mail groups.
2904 * Various Summary Stuff::       What didn't fit anywhere else.
2905 * Exiting the Summary Buffer::  Returning to the Group buffer.
2906 * Crosspost Handling::          How crossposted articles are dealt with.
2907 * Duplicate Suppression::       An alternative when crosspost handling fails.
2908 @end menu
2911 @node Summary Buffer Format
2912 @section Summary Buffer Format
2913 @cindex summary buffer format
2915 @menu
2916 * Summary Buffer Lines::     You can specify how summary lines should look.
2917 * Summary Buffer Mode Line:: You can say how the mode line should look.
2918 * Summary Highlighting::     Making the summary buffer all pretty and nice.
2919 @end menu
2921 @findex mail-extract-address-components
2922 @findex gnus-extract-address-components
2923 @vindex gnus-extract-address-components
2924 Gnus will use the value of the @code{gnus-extract-address-components}
2925 variable as a function for getting the name and address parts of a
2926 @code{From} header.  Two pre-defined functions exist:
2927 @code{gnus-extract-address-components}, which is the default, quite
2928 fast, and too simplistic solution; and
2929 @code{mail-extract-address-components}, which works very nicely, but is
2930 slower.  The default function will return the wrong answer in 5% of the
2931 cases.  If this is unacceptable to you, use the other function instead.
2933 @vindex gnus-summary-same-subject
2934 @code{gnus-summary-same-subject} is a string indicating that the current
2935 article has the same subject as the previous.  This string will be used
2936 with those specs that require it.  The default is @code{""}.
2939 @node Summary Buffer Lines
2940 @subsection Summary Buffer Lines
2942 @vindex gnus-summary-line-format
2943 You can change the format of the lines in the summary buffer by changing
2944 the @code{gnus-summary-line-format} variable.  It works along the same
2945 lines as a normal @code{format} string, with some extensions
2946 (@pxref{Formatting Variables}).
2948 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
2950 The following format specification characters are understood:
2952 @table @samp
2953 @item N
2954 Article number.
2955 @item S
2956 Subject string.
2957 @item s
2958 Subject if the article is the root of the thread or the previous article
2959 had a different subject, @code{gnus-summary-same-subject} otherwise.
2960 (@code{gnus-summary-same-subject} defaults to @code{""}.)
2961 @item F
2962 Full @code{From} header.
2963 @item n
2964 The name (from the @code{From} header).
2965 @item a
2966 The name (from the @code{From} header).  This differs from the @code{n}
2967 spec in that it uses the function designated by the
2968 @code{gnus-extract-address-components} variable, which is slower, but
2969 may be more thorough.
2970 @item A
2971 The address (from the @code{From} header).  This works the same way as
2972 the @code{a} spec.
2973 @item L
2974 Number of lines in the article.
2975 @item c
2976 Number of characters in the article.
2977 @item I
2978 Indentation based on thread level (@pxref{Customizing Threading}).
2979 @item T
2980 Nothing if the article is a root and lots of spaces if it isn't (it
2981 pushes everything after it off the screen).
2982 @item [
2983 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
2984 for adopted articles (@pxref{Customizing Threading}).
2985 @item ]
2986 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
2987 for adopted articles.
2988 @item >
2989 One space for each thread level.
2990 @item <
2991 Twenty minus thread level spaces.
2992 @item U
2993 Unread.
2995 @item R
2996 This misleadingly named specifier is the @dfn{secondary mark}.  This
2997 mark will say whether the article has been replied to, has been cached,
2998 or has been saved.  
3000 @item i
3001 Score as a number (@pxref{Scoring}).
3002 @item z
3003 @vindex gnus-summary-zcore-fuzz
3004 Zcore, @samp{+} if above the default level and @samp{-} if below the
3005 default level.  If the difference between
3006 @code{gnus-summary-default-score} and the score is less than
3007 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3008 @item V
3009 Total thread score.
3010 @item x
3011 @code{Xref}.
3012 @item D
3013 @code{Date}.
3014 @item d
3015 The @code{Date} in @code{DD-MMM} format.
3016 @item o
3017 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3018 @item M
3019 @code{Message-ID}.
3020 @item r
3021 @code{References}.
3022 @item t
3023 Number of articles in the current sub-thread.  Using this spec will slow
3024 down summary buffer generation somewhat.
3025 @item e
3026 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3027 article has any children.
3028 @item P
3029 The line number.
3030 @item O
3031 Download mark.
3032 @item u
3033 User defined specifier.  The next character in the format string should
3034 be a letter.  Gnus will call the function
3035 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3036 following @samp{%u}.  The function will be passed the current header as
3037 argument.  The function should return a string, which will be inserted
3038 into the summary just like information from any other summary specifier.
3039 @end table
3041 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3042 have to be handled with care.  For reasons of efficiency, Gnus will
3043 compute what column these characters will end up in, and ``hard-code''
3044 that.  This means that it is invalid to have these specs after a
3045 variable-length spec.  Well, you might not be arrested, but your summary
3046 buffer will look strange, which is bad enough.
3048 The smart choice is to have these specs as far to the left as possible.
3049 (Isn't that the case with everything, though?  But I digress.)
3051 This restriction may disappear in later versions of Gnus.
3054 @node Summary Buffer Mode Line
3055 @subsection Summary Buffer Mode Line
3057 @vindex gnus-summary-mode-line-format
3058 You can also change the format of the summary mode bar (@pxref{Mode Line
3059 Formatting}).  Set @code{gnus-summary-mode-line-format} to whatever you
3060 like.  The default is @samp{Gnus: %%b [%A] %Z}.
3062 Here are the elements you can play with:
3064 @table @samp
3065 @item G
3066 Group name.
3067 @item p
3068 Unprefixed group name.
3069 @item A
3070 Current article number.
3071 @item z
3072 Current article score.
3073 @item V
3074 Gnus version.
3075 @item U
3076 Number of unread articles in this group.
3077 @item e
3078 Number of unread articles in this group that aren't displayed in the
3079 summary buffer.
3080 @item Z
3081 A string with the number of unread and unselected articles represented
3082 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3083 articles, and just as @samp{<%U more>} if there are just unread articles
3084 and no unselected ones.
3085 @item g
3086 Shortish group name.  For instance, @samp{rec.arts.anime} will be
3087 shortened to @samp{r.a.anime}.
3088 @item S
3089 Subject of the current article.
3090 @item u
3091 User-defined spec (@pxref{User-Defined Specs}).
3092 @item s
3093 Name of the current score file (@pxref{Scoring}).
3094 @item d
3095 Number of dormant articles (@pxref{Unread Articles}).
3096 @item t
3097 Number of ticked articles (@pxref{Unread Articles}).
3098 @item r
3099 Number of articles that have been marked as read in this session.
3100 @item E
3101 Number of articles expunged by the score files.
3102 @end table
3105 @node Summary Highlighting
3106 @subsection Summary Highlighting
3108 @table @code
3110 @item gnus-visual-mark-article-hook
3111 @vindex gnus-visual-mark-article-hook
3112 This hook is run after selecting an article.  It is meant to be used for
3113 highlighting the article in some way.  It is not run if
3114 @code{gnus-visual} is @code{nil}.
3116 @item gnus-summary-update-hook
3117 @vindex gnus-summary-update-hook
3118 This hook is called when a summary line is changed.  It is not run if
3119 @code{gnus-visual} is @code{nil}.
3121 @item gnus-summary-selected-face
3122 @vindex gnus-summary-selected-face
3123 This is the face (or @dfn{font} as some people call it) used to
3124 highlight the current article in the summary buffer.
3126 @item gnus-summary-highlight
3127 @vindex gnus-summary-highlight
3128 Summary lines are highlighted according to this variable, which is a
3129 list where the elements are of the format @code{(@var{form} . @var{face})}.  If you
3130 would, for instance, like ticked articles to be italic and high-scored
3131 articles to be bold, you could set this variable to something like
3132 @lisp
3133 (((eq mark gnus-ticked-mark) . italic)
3134  ((> score default) . bold))
3135 @end lisp
3136 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3137 @var{FACE} will be applied to the line.
3138 @end table
3141 @node Summary Maneuvering
3142 @section Summary Maneuvering
3143 @cindex summary movement
3145 All the straight movement commands understand the numeric prefix and
3146 behave pretty much as you'd expect.
3148 None of these commands select articles.
3150 @table @kbd
3151 @item G M-n
3152 @itemx M-n
3153 @kindex M-n (Summary)
3154 @kindex G M-n (Summary)
3155 @findex gnus-summary-next-unread-subject
3156 Go to the next summary line of an unread article
3157 (@code{gnus-summary-next-unread-subject}).
3159 @item G M-p
3160 @itemx M-p
3161 @kindex M-p (Summary)
3162 @kindex G M-p (Summary)
3163 @findex gnus-summary-prev-unread-subject
3164 Go to the previous summary line of an unread article
3165 (@code{gnus-summary-prev-unread-subject}).
3167 @item G j
3168 @itemx j
3169 @kindex j (Summary)
3170 @kindex G j (Summary)
3171 @findex gnus-summary-goto-article
3172 Ask for an article number or @code{Message-ID}, and then go to that
3173 article (@code{gnus-summary-goto-article}).
3175 @item G g
3176 @kindex G g (Summary)
3177 @findex gnus-summary-goto-subject
3178 Ask for an article number and then go to the summary line of that article
3179 without displaying the article (@code{gnus-summary-goto-subject}).
3180 @end table
3182 If Gnus asks you to press a key to confirm going to the next group, you
3183 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3184 buffer, searching for the next group to read without actually returning
3185 to the group buffer.
3187 Variables related to summary movement:
3189 @table @code
3191 @vindex gnus-auto-select-next
3192 @item gnus-auto-select-next
3193 If you issue one of the movement commands (like @kbd{n}) and there are
3194 no more unread articles after the current one, Gnus will offer to go to
3195 the next group.  If this variable is @code{t} and the next group is
3196 empty, Gnus will exit summary mode and return to the group buffer.  If
3197 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3198 next group, no matter whether it has any unread articles or not.  As a
3199 special case, if this variable is @code{quietly}, Gnus will select the
3200 next group without asking for confirmation.  If this variable is
3201 @code{almost-quietly}, the same will happen only if you are located on
3202 the last article in the group.  Finally, if this variable is
3203 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3204 without confirmation.  Also @pxref{Group Levels}.
3206 @item gnus-auto-select-same
3207 @vindex gnus-auto-select-same
3208 If non-@code{nil}, all the movement commands will try to go to the next
3209 article with the same subject as the current.  (@dfn{Same} here might
3210 mean @dfn{roughly equal}.  See @code{gnus-summary-gather-subject-limit}
3211 for details (@pxref{Customizing Threading}).)  If there are no more
3212 articles with the same subject, go to the first unread article.
3214 This variable is not particularly useful if you use a threaded display.
3216 @item gnus-summary-check-current
3217 @vindex gnus-summary-check-current
3218 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3219 to the next (or previous) article if the current article is unread.
3220 Instead, they will choose the current article.
3222 @item gnus-auto-center-summary
3223 @vindex gnus-auto-center-summary
3224 If non-@code{nil}, Gnus will keep the point in the summary buffer
3225 centered at all times.  This makes things quite tidy, but if you have a
3226 slow network connection, or simply do not like this un-Emacsism, you can
3227 set this variable to @code{nil} to get the normal Emacs scrolling
3228 action.  This will also inhibit horizontal re-centering of the summary
3229 buffer, which might make it more inconvenient to read extremely long
3230 threads.
3232 @end table
3235 @node Choosing Articles
3236 @section Choosing Articles
3237 @cindex selecting articles
3239 @menu
3240 * Choosing Commands::        Commands for choosing articles.
3241 * Choosing Variables::       Variables that influence these commands.
3242 @end menu
3245 @node Choosing Commands
3246 @subsection Choosing Commands
3248 None of the following movement commands understand the numeric prefix,
3249 and they all select and display an article.
3251 @table @kbd
3252 @item SPACE
3253 @kindex SPACE (Summary)
3254 @findex gnus-summary-next-page
3255 Select the current article, or, if that one's read already, the next
3256 unread article (@code{gnus-summary-next-page}).
3258 @item G n
3259 @itemx n
3260 @kindex n (Summary)
3261 @kindex G n (Summary)
3262 @findex gnus-summary-next-unread-article
3263 @c @icon{gnus-summary-next-unread}
3264 Go to next unread article (@code{gnus-summary-next-unread-article}).
3266 @item G p
3267 @itemx p
3268 @kindex p (Summary)
3269 @findex gnus-summary-prev-unread-article
3270 @c @icon{gnus-summary-prev-unread}
3271 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3273 @item G N
3274 @itemx N
3275 @kindex N (Summary)
3276 @kindex G N (Summary)
3277 @findex gnus-summary-next-article
3278 Go to the next article (@code{gnus-summary-next-article}).
3280 @item G P
3281 @itemx P
3282 @kindex P (Summary)
3283 @kindex G P (Summary)
3284 @findex gnus-summary-prev-article
3285 Go to the previous article (@code{gnus-summary-prev-article}).
3287 @item G C-n
3288 @kindex G C-n (Summary)
3289 @findex gnus-summary-next-same-subject
3290 Go to the next article with the same subject
3291 (@code{gnus-summary-next-same-subject}).
3293 @item G C-p
3294 @kindex G C-p (Summary)
3295 @findex gnus-summary-prev-same-subject
3296 Go to the previous article with the same subject
3297 (@code{gnus-summary-prev-same-subject}).
3299 @item G f
3300 @itemx .
3301 @kindex G f  (Summary)
3302 @kindex .  (Summary)
3303 @findex gnus-summary-first-unread-article
3304 Go to the first unread article
3305 (@code{gnus-summary-first-unread-article}).
3307 @item G b
3308 @itemx ,
3309 @kindex G b (Summary)
3310 @kindex , (Summary)
3311 @findex gnus-summary-best-unread-article
3312 Go to the article with the highest score
3313 (@code{gnus-summary-best-unread-article}).
3315 @item G l
3316 @itemx l
3317 @kindex l (Summary)
3318 @kindex G l (Summary)
3319 @findex gnus-summary-goto-last-article
3320 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3322 @item G o
3323 @kindex G o (Summary)
3324 @findex gnus-summary-pop-article
3325 @cindex history
3326 @cindex article history
3327 Pop an article off the summary history and go to this article
3328 (@code{gnus-summary-pop-article}).  This command differs from the
3329 command above in that you can pop as many previous articles off the
3330 history as you like, while @kbd{l} toggles the two last read articles.
3331 For a somewhat related issue (if you use these commands a lot),
3332 @pxref{Article Backlog}.
3333 @end table
3336 @node Choosing Variables
3337 @subsection Choosing Variables
3339 Some variables relevant for moving and selecting articles:
3341 @table @code
3342 @item gnus-auto-extend-newsgroup
3343 @vindex gnus-auto-extend-newsgroup
3344 All the movement commands will try to go to the previous (or next)
3345 article, even if that article isn't displayed in the Summary buffer if
3346 this variable is non-@code{nil}.  Gnus will then fetch the article from
3347 the server and display it in the article buffer.
3349 @item gnus-select-article-hook
3350 @vindex gnus-select-article-hook
3351 This hook is called whenever an article is selected.  By default it
3352 exposes any threads hidden under the selected article.
3354 @item gnus-mark-article-hook
3355 @vindex gnus-mark-article-hook
3356 @findex gnus-summary-mark-unread-as-read
3357 @findex gnus-summary-mark-read-and-unread-as-read
3358 @findex gnus-unread-mark
3359 This hook is called whenever an article is selected.  It is intended to
3360 be used for marking articles as read.  The default value is
3361 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3362 mark of almost any article you read to @code{gnus-unread-mark}.  The
3363 only articles not affected by this function are ticked, dormant, and
3364 expirable articles.  If you'd instead like to just have unread articles
3365 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3366 instead.  It will leave marks like @code{gnus-low-score-mark},
3367 @code{gnus-del-mark} (and so on) alone.
3369 @end table
3372 @node Paging the Article
3373 @section Scrolling the Article
3374 @cindex article scrolling
3376 @table @kbd
3378 @item SPACE
3379 @kindex SPACE (Summary)
3380 @findex gnus-summary-next-page
3381 Pressing @kbd{SPACE} will scroll the current article forward one page,
3382 or, if you have come to the end of the current article, will choose the
3383 next article (@code{gnus-summary-next-page}).
3385 @item DEL
3386 @kindex DEL (Summary)
3387 @findex gnus-summary-prev-page
3388 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3390 @item RET
3391 @kindex RET (Summary)
3392 @findex gnus-summary-scroll-up
3393 Scroll the current article one line forward
3394 (@code{gnus-summary-scroll-up}).
3396 @item M-RET
3397 @kindex M-RET (Summary)
3398 @findex gnus-summary-scroll-down
3399 Scroll the current article one line backward
3400 (@code{gnus-summary-scroll-down}).
3402 @item A g
3403 @itemx g
3404 @kindex A g (Summary)
3405 @kindex g (Summary)
3406 @findex gnus-summary-show-article
3407 (Re)fetch the current article (@code{gnus-summary-show-article}).  If
3408 given a prefix, fetch the current article, but don't run any of the
3409 article treatment functions.  This will give you a ``raw'' article, just
3410 the way it came from the server.
3412 @item A <
3413 @itemx <
3414 @kindex < (Summary)
3415 @kindex A < (Summary)
3416 @findex gnus-summary-beginning-of-article
3417 Scroll to the beginning of the article
3418 (@code{gnus-summary-beginning-of-article}).
3420 @item A >
3421 @itemx >
3422 @kindex > (Summary)
3423 @kindex A > (Summary)
3424 @findex gnus-summary-end-of-article
3425 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3427 @item A s
3428 @itemx s
3429 @kindex A s (Summary)
3430 @kindex s (Summary)
3431 @findex gnus-summary-isearch-article
3432 Perform an isearch in the article buffer
3433 (@code{gnus-summary-isearch-article}).
3435 @item h
3436 @kindex h (Summary)
3437 @findex gnus-summary-select-article-buffer
3438 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3440 @end table
3443 @node Reply Followup and Post
3444 @section Reply, Followup and Post
3446 @menu
3447 * Summary Mail Commands::            Sending mail.
3448 * Summary Post Commands::            Sending news.
3449 @end menu
3452 @node Summary Mail Commands
3453 @subsection Summary Mail Commands
3454 @cindex mail
3455 @cindex composing mail
3457 Commands for composing a mail message:
3459 @table @kbd
3461 @item S r
3462 @itemx r
3463 @kindex S r (Summary)
3464 @kindex r (Summary)
3465 @findex gnus-summary-reply
3466 @c @icon{gnus-summary-mail-reply}
3467 @c @icon{gnus-summary-reply}
3468 Mail a reply to the author of the current article
3469 (@code{gnus-summary-reply}).
3471 @item S R
3472 @itemx R
3473 @kindex R (Summary)
3474 @kindex S R (Summary)
3475 @findex gnus-summary-reply-with-original
3476 @c @icon{gnus-summary-reply-with-original}
3477 Mail a reply to the author of the current article and include the
3478 original message (@code{gnus-summary-reply-with-original}).  This
3479 command uses the process/prefix convention.
3481 @item S w
3482 @kindex S w (Summary)
3483 @findex gnus-summary-wide-reply
3484 Mail a wide reply to the author of the current article
3485 (@code{gnus-summary-wide-reply}).  A @dfn{wide reply} is a reply that
3486 goes out to all people listed in the @code{To}, @code{From} (or
3487 @code{Reply-to}) and @code{Cc} headers.
3489 @item S W
3490 @kindex S W (Summary)
3491 @findex gnus-summary-wide-reply-with-original
3492 Mail a wide reply to the current article and include the original
3493 message (@code{gnus-summary-reply-with-original}).  This command uses
3494 the process/prefix convention.
3496 @item S o m
3497 @kindex S o m (Summary)
3498 @findex gnus-summary-mail-forward
3499 @c @icon{gnus-summary-mail-forward}
3500 Forward the current article to some other person
3501 (@code{gnus-summary-mail-forward}).  If given a prefix, include the full
3502 headers of the forwarded article.
3504 @item S m
3505 @itemx m
3506 @kindex m (Summary)
3507 @kindex S m (Summary)
3508 @findex gnus-summary-mail-other-window
3509 @c @icon{gnus-summary-mail-originate}
3510 Send a mail to some other person
3511 (@code{gnus-summary-mail-other-window}).
3513 @item S D b
3514 @kindex S D b (Summary)
3515 @findex gnus-summary-resend-bounced-mail
3516 @cindex bouncing mail
3517 If you have sent a mail, but the mail was bounced back to you for some
3518 reason (wrong address, transient failure), you can use this command to
3519 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}).  You
3520 will be popped into a mail buffer where you can edit the headers before
3521 sending the mail off again.  If you give a prefix to this command, and
3522 the bounced mail is a reply to some other mail, Gnus will try to fetch
3523 that mail and display it for easy perusal of its headers.  This might
3524 very well fail, though.
3526 @item S D r
3527 @kindex S D r (Summary)
3528 @findex gnus-summary-resend-message
3529 Not to be confused with the previous command,
3530 @code{gnus-summary-resend-message} will prompt you for an address to
3531 send the current message off to, and then send it to that place.  The
3532 headers of the message won't be altered---but lots of headers that say
3533 @code{Resent-To}, @code{Resent-From} and so on will be added.  This
3534 means that you actually send a mail to someone that has a @code{To}
3535 header that (probably) points to yourself.  This will confuse people.
3536 So, natcherly you'll only do that if you're really eVIl.
3538 This command is mainly used if you have several accounts and want to
3539 ship a mail to a different account of yours.  (If you're both
3540 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3541 to the @code{root} account, you may want to resend it to
3542 @code{postmaster}.  Ordnung muß sein!
3544 This command understands the process/prefix convention
3545 (@pxref{Process/Prefix}).
3547 @item S O m
3548 @kindex S O m (Summary)
3549 @findex gnus-uu-digest-mail-forward
3550 Digest the current series (@pxref{Decoding Articles}) and forward the
3551 result using mail (@code{gnus-uu-digest-mail-forward}).  This command
3552 uses the process/prefix convention (@pxref{Process/Prefix}).
3554 @item S M-c
3555 @kindex S M-c (Summary)
3556 @findex gnus-summary-mail-crosspost-complaint
3557 @cindex crossposting
3558 @cindex excessive crossposting
3559 Send a complaint about excessive crossposting to the author of the
3560 current article (@code{gnus-summary-mail-crosspost-complaint}).
3562 @findex gnus-crosspost-complaint
3563 This command is provided as a way to fight back against the current
3564 crossposting pandemic that's sweeping Usenet.  It will compose a reply
3565 using the @code{gnus-crosspost-complaint} variable as a preamble.  This
3566 command understands the process/prefix convention
3567 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3569 @end table
3571 Also @pxref{(message)Header Commands} for more information.
3574 @node Summary Post Commands
3575 @subsection Summary Post Commands
3576 @cindex post
3577 @cindex composing news
3579 Commands for posting a news article:
3581 @table @kbd
3582 @item S p
3583 @itemx a
3584 @kindex a (Summary)
3585 @kindex S p (Summary)
3586 @findex gnus-summary-post-news
3587 @c @icon{gnus-summary-post-news}
3588 Post an article to the current group
3589 (@code{gnus-summary-post-news}).
3591 @item S f
3592 @itemx f
3593 @kindex f (Summary)
3594 @kindex S f (Summary)
3595 @findex gnus-summary-followup
3596 @c @icon{gnus-summary-followup}
3597 Post a followup to the current article (@code{gnus-summary-followup}).
3599 @item S F
3600 @itemx F
3601 @kindex S F (Summary)
3602 @kindex F (Summary)
3603 @c @icon{gnus-summary-followup-with-original}
3604 @findex gnus-summary-followup-with-original
3605 Post a followup to the current article and include the original message
3606 (@code{gnus-summary-followup-with-original}).   This command uses the
3607 process/prefix convention.
3609 @item S n
3610 @kindex S n (Summary)
3611 @findex gnus-summary-followup-to-mail
3612 Post a followup to the current article via news, even if you got the
3613 message through mail (@code{gnus-summary-followup-to-mail}).
3615 @item S N
3616 @kindex S N (Summary)
3617 @findex gnus-summary-followup-to-mail-with-original
3618 Post a followup to the current article via news, even if you got the
3619 message through mail and include the original message
3620 (@code{gnus-summary-followup-to-mail-with-original}).  This command uses
3621 the process/prefix convention.
3623 @item S o p
3624 @kindex S o p (Summary)
3625 @findex gnus-summary-post-forward
3626 Forward the current article to a newsgroup
3627 (@code{gnus-summary-post-forward}).  If given a prefix, include the full
3628 headers of the forwarded article.
3630 @item S O p
3631 @kindex S O p (Summary)
3632 @findex gnus-uu-digest-post-forward
3633 @cindex digests
3634 @cindex making digests
3635 Digest the current series and forward the result to a newsgroup
3636 (@code{gnus-uu-digest-mail-forward}).  This command uses the
3637 process/prefix convention.
3639 @item S u
3640 @kindex S u (Summary)
3641 @findex gnus-uu-post-news
3642 @c @icon{gnus-uu-post-news}
3643 Uuencode a file, split it into parts, and post it as a series
3644 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
3645 @end table
3647 Also @pxref{(message)Header Commands} for more information.
3650 @node Canceling and Superseding
3651 @section Canceling Articles
3652 @cindex canceling articles
3653 @cindex superseding articles
3655 Have you ever written something, and then decided that you really,
3656 really, really wish you hadn't posted that?
3658 Well, you can't cancel mail, but you can cancel posts.
3660 @findex gnus-summary-cancel-article
3661 @kindex C (Summary)
3662 @c @icon{gnus-summary-cancel-article}
3663 Find the article you wish to cancel (you can only cancel your own
3664 articles, so don't try any funny stuff).  Then press @kbd{C} or @kbd{S
3665 c} (@code{gnus-summary-cancel-article}).  Your article will be
3666 canceled---machines all over the world will be deleting your article.
3667 This command uses the process/prefix convention (@pxref{Process/Prefix}).
3669 Be aware, however, that not all sites honor cancels, so your article may
3670 live on here and there, while most sites will delete the article in
3671 question.
3673 Gnus will use the ``current'' select method when canceling.  If you
3674 want to use the standard posting method, use the @samp{a} symbolic
3675 prefix (@pxref{Symbolic Prefixes}).
3677 If you discover that you have made some mistakes and want to do some
3678 corrections, you can post a @dfn{superseding} article that will replace
3679 your original article.
3681 @findex gnus-summary-supersede-article
3682 @kindex S (Summary)
3683 Go to the original article and press @kbd{S s}
3684 (@code{gnus-summary-supersede-article}).  You will be put in a buffer
3685 where you can edit the article all you want before sending it off the
3686 usual way.
3688 The same goes for superseding as for canceling, only more so: Some
3689 sites do not honor superseding.  On those sites, it will appear that you
3690 have posted almost the same article twice.
3692 If you have just posted the article, and change your mind right away,
3693 there is a trick you can use to cancel/supersede the article without
3694 waiting for the article to appear on your site first.  You simply return
3695 to the post buffer (which is called @code{*sent ...*}).  There you will
3696 find the article you just posted, with all the headers intact.  Change
3697 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3698 header by substituting one of those words for the word
3699 @code{Message-ID}.  Then just press @kbd{C-c C-c} to send the article as
3700 you would do normally.  The previous article will be
3701 canceled/superseded.
3703 Just remember, kids: There is no 'c' in 'supersede'.
3706 @node Marking Articles
3707 @section Marking Articles
3708 @cindex article marking
3709 @cindex article ticking
3710 @cindex marks
3712 There are several marks you can set on an article.
3714 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3715 neologism ohoy!) of the article.  Alphabetic marks generally mean
3716 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
3718 In addition, you also have marks that do not affect readedness.
3720 @menu
3721 * Unread Articles::      Marks for unread articles.
3722 * Read Articles::        Marks for read articles.
3723 * Other Marks::          Marks that do not affect readedness.
3724 @end menu
3726 @ifinfo
3727 There's a plethora of commands for manipulating these marks:
3728 @end ifinfo
3730 @menu
3731 * Setting Marks::           How to set and remove marks.
3732 * Setting Process Marks::   How to mark articles for later processing.
3733 @end menu
3736 @node Unread Articles
3737 @subsection Unread Articles
3739 The following marks mark articles as (kinda) unread, in one form or
3740 other.
3742 @table @samp
3743 @item !
3744 @vindex gnus-ticked-mark
3745 Marked as ticked (@code{gnus-ticked-mark}).
3747 @dfn{Ticked articles} are articles that will remain visible always.  If
3748 you see an article that you find interesting, or you want to put off
3749 reading it, or replying to it, until sometime later, you'd typically
3750 tick it.  However, articles can be expired, so if you want to keep an
3751 article forever, you'll have to make it persistent (@pxref{Persistent
3752 Articles}).
3754 @item ?
3755 @vindex gnus-dormant-mark
3756 Marked as dormant (@code{gnus-dormant-mark}).
3758 @dfn{Dormant articles} will only appear in the summary buffer if there
3759 are followups to it.  If you want to see them even if they don't have
3760 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
3762 @item SPACE
3763 @vindex gnus-unread-mark
3764 Marked as unread (@code{gnus-unread-mark}).
3766 @dfn{Unread articles} are articles that haven't been read at all yet.
3767 @end table
3770 @node Read Articles
3771 @subsection Read Articles
3772 @cindex expirable mark
3774 All the following marks mark articles as read.
3776 @table @samp
3778 @item r
3779 @vindex gnus-del-mark
3780 These are articles that the user has marked as read with the @kbd{d}
3781 command manually, more or less (@code{gnus-del-mark}).
3783 @item R
3784 @vindex gnus-read-mark
3785 Articles that have actually been read (@code{gnus-read-mark}).
3787 @item O
3788 @vindex gnus-ancient-mark
3789 Articles that were marked as read in previous sessions and are now
3790 @dfn{old} (@code{gnus-ancient-mark}).
3792 @item K
3793 @vindex gnus-killed-mark
3794 Marked as killed (@code{gnus-killed-mark}).
3796 @item X
3797 @vindex gnus-kill-file-mark
3798 Marked as killed by kill files (@code{gnus-kill-file-mark}).
3800 @item Y
3801 @vindex gnus-low-score-mark
3802 Marked as read by having too low a score (@code{gnus-low-score-mark}).
3804 @item C
3805 @vindex gnus-catchup-mark
3806 Marked as read by a catchup (@code{gnus-catchup-mark}).
3808 @item G
3809 @vindex gnus-canceled-mark
3810 Canceled article (@code{gnus-canceled-mark})
3812 @item F
3813 @vindex gnus-souped-mark
3814 @sc{soup}ed article (@code{gnus-souped-mark}).  @xref{SOUP}.
3816 @item Q
3817 @vindex gnus-sparse-mark
3818 Sparsely reffed article (@code{gnus-sparse-mark}).  @xref{Customizing
3819 Threading}.
3821 @item M
3822 @vindex gnus-duplicate-mark
3823 Article marked as read by duplicate suppression
3824 (@code{gnus-duplicated-mark}).  @xref{Duplicate Suppression}.
3826 @end table
3828 All these marks just mean that the article is marked as read, really.
3829 They are interpreted differently when doing adaptive scoring, though.
3831 One more special mark, though:
3833 @table @samp
3834 @item E
3835 @vindex gnus-expirable-mark
3836 Marked as expirable (@code{gnus-expirable-mark}).
3838 Marking articles as @dfn{expirable} (or have them marked as such
3839 automatically) doesn't make much sense in normal groups---a user doesn't
3840 control expiring of news articles, but in mail groups, for instance,
3841 articles marked as @dfn{expirable} can be deleted by Gnus at
3842 any time.
3843 @end table
3846 @node Other Marks
3847 @subsection Other Marks
3848 @cindex process mark
3849 @cindex bookmarks
3851 There are some marks that have nothing to do with whether the article is
3852 read or not.
3854 @itemize @bullet
3856 @item
3857 You can set a bookmark in the current article.  Say you are reading a
3858 long thesis on cats' urinary tracts, and have to go home for dinner
3859 before you've finished reading the thesis.  You can then set a bookmark
3860 in the article, and Gnus will jump to this bookmark the next time it
3861 encounters the article.  @xref{Setting Marks}.
3863 @item
3864 @vindex gnus-replied-mark
3865 All articles that you have replied to or made a followup to (i.e., have
3866 answered) will be marked with an @samp{A} in the second column
3867 (@code{gnus-replied-mark}).
3869 @item
3870 @vindex gnus-cached-mark
3871 Articles stored in the article cache will be marked with an @samp{*} in
3872 the second column (@code{gnus-cached-mark}).  @xref{Article Caching}.
3874 @item
3875 @vindex gnus-saved-mark
3876 Articles ``saved'' (in some manner or other; not necessarily
3877 religiously) are marked with an @samp{S} in the second column
3878 (@code{gnus-saved-mark}).
3880 @item
3881 @vindex gnus-not-empty-thread-mark
3882 @vindex gnus-empty-thread-mark
3883 If the @samp{%e} spec is used, the presence of threads or not will be
3884 marked with @code{gnus-not-empty-thread-mark} and
3885 @code{gnus-empty-thread-mark} in the third column, respectively.
3887 @item
3888 @vindex gnus-process-mark
3889 Finally we have the @dfn{process mark} (@code{gnus-process-mark}).  A
3890 variety of commands react to the presence of the process mark.  For
3891 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
3892 all articles that have been marked with the process mark.  Articles
3893 marked with the process mark have a @samp{#} in the second column.
3895 @end itemize
3897 You might have noticed that most of these ``non-readedness'' marks
3898 appear in the second column by default.  So if you have a cached, saved,
3899 replied article that you have process-marked, what will that look like?
3901 Nothing much.  The precedence rules go as follows: process -> cache ->
3902 replied -> saved.  So if the article is in the cache and is replied,
3903 you'll only see the cache mark and not the replied mark.
3906 @node Setting Marks
3907 @subsection Setting Marks
3908 @cindex setting marks
3910 All the marking commands understand the numeric prefix.
3912 @table @kbd
3913 @item M c
3914 @itemx M-u
3915 @kindex M c (Summary)
3916 @kindex M-u (Summary)
3917 @findex gnus-summary-clear-mark-forward
3918 @cindex mark as unread
3919 Clear all readedness-marks from the current article
3920 (@code{gnus-summary-clear-mark-forward}).  In other words, mark the
3921 article as unread.
3923 @item M t
3924 @itemx !
3925 @kindex ! (Summary)
3926 @kindex M t (Summary)
3927 @findex gnus-summary-tick-article-forward
3928 Tick the current article (@code{gnus-summary-tick-article-forward}).
3929 @xref{Article Caching}.
3931 @item M ?
3932 @itemx ?
3933 @kindex ? (Summary)
3934 @kindex M ? (Summary)
3935 @findex gnus-summary-mark-as-dormant
3936 Mark the current article as dormant
3937 (@code{gnus-summary-mark-as-dormant}).  @xref{Article Caching}.
3939 @item M d
3940 @itemx d
3941 @kindex M d (Summary)
3942 @kindex d (Summary)
3943 @findex gnus-summary-mark-as-read-forward
3944 Mark the current article as read
3945 (@code{gnus-summary-mark-as-read-forward}).
3947 @item D
3948 @kindex D (Summary)
3949 @findex gnus-summary-mark-as-read-backward
3950 Mark the current article as read and move point to the previous line
3951 (@code{gnus-summary-mark-as-read-backward}).
3953 @item M k
3954 @itemx k
3955 @kindex k (Summary)
3956 @kindex M k (Summary)
3957 @findex gnus-summary-kill-same-subject-and-select
3958 Mark all articles that have the same subject as the current one as read,
3959 and then select the next unread article
3960 (@code{gnus-summary-kill-same-subject-and-select}).
3962 @item M K
3963 @itemx C-k
3964 @kindex M K (Summary)
3965 @kindex C-k (Summary)
3966 @findex gnus-summary-kill-same-subject
3967 Mark all articles that have the same subject as the current one as read
3968 (@code{gnus-summary-kill-same-subject}).
3970 @item M C
3971 @kindex M C (Summary)
3972 @findex gnus-summary-catchup
3973 @c @icon{gnus-summary-catchup}
3974 Mark all unread articles as read (@code{gnus-summary-catchup}).
3976 @item M C-c
3977 @kindex M C-c (Summary)
3978 @findex gnus-summary-catchup-all
3979 Mark all articles in the group as read---even the ticked and dormant
3980 articles (@code{gnus-summary-catchup-all}).
3982 @item M H
3983 @kindex M H (Summary)
3984 @findex gnus-summary-catchup-to-here
3985 Catchup the current group to point
3986 (@code{gnus-summary-catchup-to-here}).
3988 @item C-w
3989 @kindex C-w (Summary)
3990 @findex gnus-summary-mark-region-as-read
3991 Mark all articles between point and mark as read
3992 (@code{gnus-summary-mark-region-as-read}).
3994 @item M V k
3995 @kindex M V k (Summary)
3996 @findex gnus-summary-kill-below
3997 Kill all articles with scores below the default score (or below the
3998 numeric prefix) (@code{gnus-summary-kill-below}).
4000 @item M e
4001 @itemx E
4002 @kindex M e (Summary)
4003 @kindex E (Summary)
4004 @findex gnus-summary-mark-as-expirable
4005 Mark the current article as expirable
4006 (@code{gnus-summary-mark-as-expirable}).
4008 @item M b
4009 @kindex M b (Summary)
4010 @findex gnus-summary-set-bookmark
4011 Set a bookmark in the current article
4012 (@code{gnus-summary-set-bookmark}).
4014 @item M B
4015 @kindex M B (Summary)
4016 @findex gnus-summary-remove-bookmark
4017 Remove the bookmark from the current article
4018 (@code{gnus-summary-remove-bookmark}).
4020 @item M V c
4021 @kindex M V c (Summary)
4022 @findex gnus-summary-clear-above
4023 Clear all marks from articles with scores over the default score (or
4024 over the numeric prefix) (@code{gnus-summary-clear-above}).
4026 @item M V u
4027 @kindex M V u (Summary)
4028 @findex gnus-summary-tick-above
4029 Tick all articles with scores over the default score (or over the
4030 numeric prefix) (@code{gnus-summary-tick-above}).
4032 @item M V m
4033 @kindex M V m (Summary)
4034 @findex gnus-summary-mark-above
4035 Prompt for a mark, and mark all articles with scores over the default
4036 score (or over the numeric prefix) with this mark
4037 (@code{gnus-summary-clear-above}).
4038 @end table
4040 @vindex gnus-summary-goto-unread
4041 The @code{gnus-summary-goto-unread} variable controls what action should
4042 be taken after setting a mark.  If non-@code{nil}, point will move to
4043 the next/previous unread article.  If @code{nil}, point will just move
4044 one line up or down.  As a special case, if this variable is
4045 @code{never}, all the marking commands as well as other commands (like
4046 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4047 The default is @code{t}.
4050 @node Setting Process Marks
4051 @subsection Setting Process Marks
4052 @cindex setting process marks
4054 @table @kbd
4056 @item M P p
4057 @itemx #
4058 @kindex # (Summary)
4059 @kindex M P p (Summary)
4060 @findex gnus-summary-mark-as-processable
4061 Mark the current article with the process mark
4062 (@code{gnus-summary-mark-as-processable}).
4063 @findex gnus-summary-unmark-as-processable
4065 @item M P u
4066 @itemx M-#
4067 @kindex M P u (Summary)
4068 @kindex M-# (Summary)
4069 Remove the process mark, if any, from the current article
4070 (@code{gnus-summary-unmark-as-processable}).
4072 @item M P U
4073 @kindex M P U (Summary)
4074 @findex gnus-summary-unmark-all-processable
4075 Remove the process mark from all articles
4076 (@code{gnus-summary-unmark-all-processable}).
4078 @item M P i
4079 @kindex M P i (Summary)
4080 @findex gnus-uu-invert-processable
4081 Invert the list of process marked articles
4082 (@code{gnus-uu-invert-processable}).
4084 @item M P R
4085 @kindex M P R (Summary)
4086 @findex gnus-uu-mark-by-regexp
4087 Mark articles that have a @code{Subject} header that matches a regular
4088 expression (@code{gnus-uu-mark-by-regexp}).
4090 @item M P r
4091 @kindex M P r (Summary)
4092 @findex gnus-uu-mark-region
4093 Mark articles in region (@code{gnus-uu-mark-region}).
4095 @item M P t
4096 @kindex M P t (Summary)
4097 @findex gnus-uu-mark-thread
4098 Mark all articles in the current (sub)thread
4099 (@code{gnus-uu-mark-thread}).
4101 @item M P T
4102 @kindex M P T (Summary)
4103 @findex gnus-uu-unmark-thread
4104 Unmark all articles in the current (sub)thread
4105 (@code{gnus-uu-unmark-thread}).
4107 @item M P v
4108 @kindex M P v (Summary)
4109 @findex gnus-uu-mark-over
4110 Mark all articles that have a score above the prefix argument
4111 (@code{gnus-uu-mark-over}).
4113 @item M P s
4114 @kindex M P s (Summary)
4115 @findex gnus-uu-mark-series
4116 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4118 @item M P S
4119 @kindex M P S (Summary)
4120 @findex gnus-uu-mark-sparse
4121 Mark all series that have already had some articles marked
4122 (@code{gnus-uu-mark-sparse}).
4124 @item M P a
4125 @kindex M P a (Summary)
4126 @findex gnus-uu-mark-all
4127 Mark all articles in series order (@code{gnus-uu-mark-series}).
4129 @item M P b
4130 @kindex M P b (Summary)
4131 @findex gnus-uu-mark-buffer
4132 Mark all articles in the buffer in the order they appear
4133 (@code{gnus-uu-mark-buffer}).
4135 @item M P k
4136 @kindex M P k (Summary)
4137 @findex gnus-summary-kill-process-mark
4138 Push the current process mark set onto the stack and unmark all articles
4139 (@code{gnus-summary-kill-process-mark}).
4141 @item M P y
4142 @kindex M P y (Summary)
4143 @findex gnus-summary-yank-process-mark
4144 Pop the previous process mark set from the stack and restore it
4145 (@code{gnus-summary-yank-process-mark}).
4147 @item M P w
4148 @kindex M P w (Summary)
4149 @findex gnus-summary-save-process-mark
4150 Push the current process mark set onto the stack
4151 (@code{gnus-summary-save-process-mark}).
4153 @end table
4156 @node Limiting
4157 @section Limiting
4158 @cindex limiting
4160 It can be convenient to limit the summary buffer to just show some
4161 subset of the articles currently in the group.  The effect most limit
4162 commands have is to remove a few (or many) articles from the summary
4163 buffer.
4165 All limiting commands work on subsets of the articles already fetched
4166 from the servers.  None of these commands query the server for
4167 additional articles.
4169 @table @kbd
4171 @item / /
4172 @itemx / s
4173 @kindex / / (Summary)
4174 @findex gnus-summary-limit-to-subject
4175 Limit the summary buffer to articles that match some subject
4176 (@code{gnus-summary-limit-to-subject}).
4178 @item / a
4179 @kindex / a (Summary)
4180 @findex gnus-summary-limit-to-author
4181 Limit the summary buffer to articles that match some author
4182 (@code{gnus-summary-limit-to-author}).
4184 @item / u
4185 @itemx x
4186 @kindex / u (Summary)
4187 @kindex x (Summary)
4188 @findex gnus-summary-limit-to-unread
4189 Limit the summary buffer to articles not marked as read
4190 (@code{gnus-summary-limit-to-unread}).  If given a prefix, limit the
4191 buffer to articles strictly unread.  This means that ticked and
4192 dormant articles will also be excluded.
4194 @item / m
4195 @kindex / m (Summary)
4196 @findex gnus-summary-limit-to-marks
4197 Ask for a mark and then limit to all articles that have been marked
4198 with that mark (@code{gnus-summary-limit-to-marks}).
4200 @item / t
4201 @kindex / t (Summary)
4202 @findex gnus-summary-limit-to-age
4203 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4204 (@code{gnus-summary-limit-to-marks}).  If given a prefix, limit to
4205 articles younger than that number of days.
4207 @item / n
4208 @kindex / n (Summary)
4209 @findex gnus-summary-limit-to-articles
4210 Limit the summary buffer to the current article
4211 (@code{gnus-summary-limit-to-articles}).  Uses the process/prefix
4212 convention (@pxref{Process/Prefix}).
4214 @item / w
4215 @kindex / w (Summary)
4216 @findex gnus-summary-pop-limit
4217 Pop the previous limit off the stack and restore it
4218 (@code{gnus-summary-pop-limit}).  If given a prefix, pop all limits off
4219 the stack.
4221 @item / v
4222 @kindex / v (Summary)
4223 @findex gnus-summary-limit-to-score
4224 Limit the summary buffer to articles that have a score at or above some
4225 score (@code{gnus-summary-limit-to-score}).
4227 @item / E
4228 @itemx M S
4229 @kindex M S (Summary)
4230 @kindex / E (Summary)
4231 @findex gnus-summary-limit-include-expunged
4232 Include all expunged articles in the limit
4233 (@code{gnus-summary-limit-include-expunged}).
4235 @item / D
4236 @kindex / D (Summary)
4237 @findex gnus-summary-limit-include-dormant
4238 Include all dormant articles in the limit
4239 (@code{gnus-summary-limit-include-dormant}).
4241 @item / *
4242 @kindex / * (Summary)
4243 @findex gnus-summary-limit-include-cached
4244 Include all cached articles in the limit
4245 (@code{gnus-summary-limit-include-cached}).
4247 @item / d
4248 @kindex / d (Summary)
4249 @findex gnus-summary-limit-exclude-dormant
4250 Exclude all dormant articles from the limit
4251 (@code{gnus-summary-limit-exclude-dormant}).
4253 @item / T
4254 @kindex / T (Summary)
4255 @findex gnus-summary-limit-include-thread
4256 Include all the articles in the current thread in the limit.
4258 @item / c
4259 @kindex / c (Summary)
4260 @findex gnus-summary-limit-exclude-childless-dormant
4261 Exclude all dormant articles that have no children from the limit
4262 (@code{gnus-summary-limit-exclude-childless-dormant}).
4264 @item / C
4265 @kindex / C (Summary)
4266 @findex gnus-summary-limit-mark-excluded-as-read
4267 Mark all excluded unread articles as read
4268 (@code{gnus-summary-limit-mark-excluded-as-read}).   If given a prefix,
4269 also mark excluded ticked and dormant articles as read.
4271 @end table
4274 @node Threading
4275 @section Threading
4276 @cindex threading
4277 @cindex article threading
4279 Gnus threads articles by default.  @dfn{To thread} is to put responses
4280 to articles directly after the articles they respond to---in a
4281 hierarchical fashion.
4283 Threading is done by looking at the @code{References} headers of the
4284 articles.  In a perfect world, this would be enough to build pretty
4285 trees, but unfortunately, the @code{References} header is often broken
4286 or simply missing.  Weird news propagation excarcerbates the problem,
4287 so one has to employ other heuristics to get pleasing results.  A
4288 plethora of approaches exists, as detailed in horrible detail in
4289 @pxref{Customizing Threading}.
4291 First, a quick overview of the concepts:
4293 @table @dfn
4294 @item root
4295 The top-most article in a thread; the first article in the thread.
4297 @item thread
4298 A tree-like article structure.
4300 @item sub-thread
4301 A small(er) section of this tree-like structure.
4303 @item loose threads
4304 Threads often lose their roots due to article expiry, or due to the root
4305 already having been read in a previous session, and not displayed in the
4306 summary buffer.  We then typically have many sub-threads that really
4307 belong to one thread, but are without connecting roots.  These are
4308 called loose threads.
4310 @item thread gathering
4311 An attempt to gather loose threads into bigger threads.
4313 @item sparse threads
4314 A thread where the missing articles have been ``guessed'' at, and are
4315 displayed as empty lines in the summary buffer.
4317 @end table
4320 @menu
4321 * Customizing Threading::     Variables you can change to affect the threading.
4322 * Thread Commands::           Thread based commands in the summary buffer.
4323 @end menu
4326 @node Customizing Threading
4327 @subsection Customizing Threading
4328 @cindex customizing threading
4330 @menu
4331 * Loose Threads::        How Gnus gathers loose threads into bigger threads.
4332 * Filling In Threads::   Making the threads displayed look fuller.
4333 * More Threading::       Even more variables for fiddling with threads.
4334 * Low-Level Threading::  You thought it was over... but you were wrong!
4335 @end menu
4338 @node Loose Threads
4339 @subsubsection Loose Threads
4340 @cindex <
4341 @cindex >
4342 @cindex loose threads
4344 @table @code
4345 @item gnus-summary-make-false-root
4346 @vindex gnus-summary-make-false-root
4347 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4348 and create a dummy root at the top.  (Wait a minute.  Root at the top?
4349 Yup.)  Loose subtrees occur when the real root has expired, or you've
4350 read or killed the root in a previous session.
4352 When there is no real root of a thread, Gnus will have to fudge
4353 something.  This variable says what fudging method Gnus should use.
4354 There are four possible values:
4356 @cindex adopting articles
4358 @table @code
4360 @item adopt
4361 Gnus will make the first of the orphaned articles the parent.  This
4362 parent will adopt all the other articles.  The adopted articles will be
4363 marked as such by pointy brackets (@samp{<>}) instead of the standard
4364 square brackets (@samp{[]}).  This is the default method.
4366 @item dummy
4367 @vindex gnus-summary-dummy-line-format
4368 Gnus will create a dummy summary line that will pretend to be the
4369 parent.  This dummy line does not correspond to any real article, so
4370 selecting it will just select the first real article after the dummy
4371 article.  @code{gnus-summary-dummy-line-format} is used to specify the
4372 format of the dummy roots.  It accepts only one format spec:  @samp{S},
4373 which is the subject of the article.  @xref{Formatting Variables}.
4375 @item empty
4376 Gnus won't actually make any article the parent, but simply leave the
4377 subject field of all orphans except the first empty.  (Actually, it will
4378 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4379 Buffer Format}).)
4381 @item none
4382 Don't make any article parent at all.  Just gather the threads and
4383 display them after one another.
4385 @item nil
4386 Don't gather loose threads.
4387 @end table
4389 @item gnus-summary-gather-subject-limit
4390 @vindex gnus-summary-gather-subject-limit
4391 Loose threads are gathered by comparing subjects of articles.  If this
4392 variable is @code{nil}, Gnus requires an exact match between the
4393 subjects of the loose threads before gathering them into one big
4394 super-thread.  This might be too strict a requirement, what with the
4395 presence of stupid newsreaders that chop off long subject lines.  If
4396 you think so, set this variable to, say, 20 to require that only the
4397 first 20 characters of the subjects have to match.  If you set this
4398 variable to a really low number, you'll find that Gnus will gather
4399 everything in sight into one thread, which isn't very helpful.
4401 @cindex fuzzy article gathering
4402 If you set this variable to the special value @code{fuzzy}, Gnus will
4403 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4404 Matching}).
4406 @item gnus-simplify-subject-fuzzy-regexp
4407 @vindex gnus-simplify-subject-fuzzy-regexp
4408 This can either be a regular expression or list of regular expressions
4409 that match strings that will be removed from subjects if fuzzy subject
4410 simplification is used.
4412 @item gnus-simplify-ignored-prefixes
4413 @vindex gnus-simplify-ignored-prefixes
4414 If you set @code{gnus-summary-gather-subject-limit} to something as low
4415 as 10, you might consider setting this variable to something sensible:
4417 @c Written by Michael Ernst <mernst@cs.rice.edu>
4418 @lisp
4419 (setq gnus-simplify-ignored-prefixes
4420       (concat
4421        "\\`\\[?\\("
4422        (mapconcat
4423         'identity
4424         '("looking"
4425           "wanted" "followup" "summary\\( of\\)?"
4426           "help" "query" "problem" "question"
4427           "answer" "reference" "announce"
4428           "How can I" "How to" "Comparison of"
4429           ;; ...
4430           )
4431         "\\|")
4432        "\\)\\s *\\("
4433        (mapconcat 'identity
4434                   '("for" "for reference" "with" "about")
4435                   "\\|")
4436        "\\)?\\]?:?[ \t]*"))
4437 @end lisp
4439 All words that match this regexp will be removed before comparing two
4440 subjects.
4442 @item gnus-simplify-subject-functions
4443 @vindex gnus-simplify-subject-functions
4444 If non-@code{nil}, this variable overrides
4445 @code{gnus-summary-gather-subject-limit}.  This variable should be a
4446 list of functions to apply to the @code{Subject} string iteratively to
4447 arrive at the simplified version of the string.
4449 Useful functions to put in this list include:
4451 @table @code
4452 @item gnus-simplify-subject-re
4453 @findex gnus-simplify-subject-re
4454 Strip the leading @samp{Re:}.
4456 @item gnus-simplify-subject-fuzzy
4457 @findex gnus-simplify-subject-fuzzy
4458 Simplify fuzzily.
4460 @item gnus-simplify-whitespace
4461 @findex gnus-simplify-whitespace
4462 Remove excessive whitespace.
4463 @end table
4465 You may also write your own functions, of course.
4468 @item gnus-summary-gather-exclude-subject
4469 @vindex gnus-summary-gather-exclude-subject
4470 Since loose thread gathering is done on subjects only, that might lead
4471 to many false hits, especially with certain common subjects like
4472 @samp{} and @samp{(none)}.  To make the situation slightly better,
4473 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4474 what subjects should be excluded from the gathering process.@*
4475 The default is @samp{^ *$\\|^(none)$}.
4477 @item gnus-summary-thread-gathering-function
4478 @vindex gnus-summary-thread-gathering-function
4479 Gnus gathers threads by looking at @code{Subject} headers.  This means
4480 that totally unrelated articles may end up in the same ``thread'', which
4481 is confusing.  An alternate approach is to look at all the
4482 @code{Message-ID}s in all the @code{References} headers to find matches.
4483 This will ensure that no gathered threads ever include unrelated
4484 articles, but it also means that people who have posted with broken
4485 newsreaders won't be gathered properly.  The choice is yours---plague or
4486 cholera:
4488 @table @code
4489 @item gnus-gather-threads-by-subject
4490 @findex gnus-gather-threads-by-subject
4491 This function is the default gathering function and looks at
4492 @code{Subject}s exclusively.
4494 @item gnus-gather-threads-by-references
4495 @findex gnus-gather-threads-by-references
4496 This function looks at @code{References} headers exclusively.
4497 @end table
4499 If you want to test gathering by @code{References}, you could say
4500 something like:
4502 @lisp
4503 (setq gnus-summary-thread-gathering-function
4504       'gnus-gather-threads-by-references)
4505 @end lisp
4507 @end table
4510 @node Filling In Threads
4511 @subsubsection Filling In Threads
4513 @table @code
4514 @item gnus-fetch-old-headers
4515 @vindex gnus-fetch-old-headers
4516 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4517 more old headers---headers to articles marked as read.  If you
4518 would like to display as few summary lines as possible, but still
4519 connect as many loose threads as possible, you should set this variable
4520 to @code{some} or a number.  If you set it to a number, no more than
4521 that number of extra old headers will be fetched.  In either case,
4522 fetching old headers only works if the backend you are using carries
4523 overview files---this would normally be @code{nntp}, @code{nnspool} and
4524 @code{nnml}.  Also remember that if the root of the thread has been
4525 expired by the server, there's not much Gnus can do about that.
4527 This variable can also be set to @code{invisible}.  This won't have any
4528 visible effects, but is useful if you use the @kbd{A T} command a lot
4529 (@pxref{Finding the Parent}).
4531 @item gnus-build-sparse-threads
4532 @vindex gnus-build-sparse-threads
4533 Fetching old headers can be slow.  A low-rent similar effect can be
4534 gotten by setting this variable to @code{some}.  Gnus will then look at
4535 the complete @code{References} headers of all articles and try to string
4536 together articles that belong in the same thread.  This will leave
4537 @dfn{gaps} in the threading display where Gnus guesses that an article
4538 is missing from the thread.  (These gaps appear like normal summary
4539 lines.  If you select a gap, Gnus will try to fetch the article in
4540 question.)  If this variable is @code{t}, Gnus will display all these
4541 ``gaps'' without regard for whether they are useful for completing the
4542 thread or not.  Finally, if this variable is @code{more}, Gnus won't cut
4543 off sparse leaf nodes that don't lead anywhere.  This variable is
4544 @code{nil} by default.
4546 @end table
4549 @node More Threading
4550 @subsubsection More Threading
4552 @table @code
4553 @item gnus-show-threads
4554 @vindex gnus-show-threads
4555 If this variable is @code{nil}, no threading will be done, and all of
4556 the rest of the variables here will have no effect.  Turning threading
4557 off will speed group selection up a bit, but it is sure to make reading
4558 slower and more awkward.
4560 @item gnus-thread-hide-subtree
4561 @vindex gnus-thread-hide-subtree
4562 If non-@code{nil}, all threads will be hidden when the summary buffer is
4563 generated.
4565 @item gnus-thread-expunge-below
4566 @vindex gnus-thread-expunge-below
4567 All threads that have a total score (as defined by
4568 @code{gnus-thread-score-function}) less than this number will be
4569 expunged.  This variable is @code{nil} by default, which means that no
4570 threads are expunged.
4572 @item gnus-thread-hide-killed
4573 @vindex gnus-thread-hide-killed
4574 if you kill a thread and this variable is non-@code{nil}, the subtree
4575 will be hidden.
4577 @item gnus-thread-ignore-subject
4578 @vindex gnus-thread-ignore-subject
4579 Sometimes somebody changes the subject in the middle of a thread.  If
4580 this variable is non-@code{nil}, the subject change is ignored.  If it
4581 is @code{nil}, which is the default, a change in the subject will result
4582 in a new thread.
4584 @item gnus-thread-indent-level
4585 @vindex gnus-thread-indent-level
4586 This is a number that says how much each sub-thread should be indented.
4587 The default is 4.
4589 @end table
4592 @node Low-Level Threading
4593 @subsubsection Low-Level Threading
4595 @table @code
4597 @item gnus-parse-headers-hook
4598 @vindex gnus-parse-headers-hook
4599 Hook run before parsing any headers.  The default value is
4600 @code{(gnus-decode-rfc1522)}, which means that QPized headers will be
4601 slightly decoded in a hackish way.  This is likely to change in the
4602 future when Gnus becomes @sc{mime}ified.
4604 @item gnus-alter-header-function
4605 @vindex gnus-alter-header-function
4606 If non-@code{nil}, this function will be called to allow alteration of
4607 article header structures.  The function is called with one parameter,
4608 the article header vector, which it may alter in any way.  For instance,
4609 if you have a mail-to-news gateway which alters the @code{Message-ID}s
4610 in systematic ways (by adding prefixes and such), you can use this
4611 variable to un-scramble the @code{Message-ID}s so that they are more
4612 meaningful.  Here's one example:
4614 @lisp
4615 (setq gnus-alter-header-function 'my-alter-message-id)
4617 (defun my-alter-message-id (header)
4618   (let ((id (mail-header-id header)))
4619     (when (string-match
4620            "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
4621       (mail-header-set-id
4622        (concat (match-string 1 id) "@@" (match-string 2 id))
4623        header))))
4624 @end lisp
4626 @end table
4629 @node Thread Commands
4630 @subsection Thread Commands
4631 @cindex thread commands
4633 @table @kbd
4635 @item T k
4636 @itemx M-C-k
4637 @kindex T k (Summary)
4638 @kindex M-C-k (Summary)
4639 @findex gnus-summary-kill-thread
4640 Mark all articles in the current (sub-)thread as read
4641 (@code{gnus-summary-kill-thread}).  If the prefix argument is positive,
4642 remove all marks instead.  If the prefix argument is negative, tick
4643 articles instead.
4645 @item T l
4646 @itemx M-C-l
4647 @kindex T l (Summary)
4648 @kindex M-C-l (Summary)
4649 @findex gnus-summary-lower-thread
4650 Lower the score of the current (sub-)thread
4651 (@code{gnus-summary-lower-thread}).
4653 @item T i
4654 @kindex T i (Summary)
4655 @findex gnus-summary-raise-thread
4656 Increase the score of the current (sub-)thread
4657 (@code{gnus-summary-raise-thread}).
4659 @item T #
4660 @kindex T # (Summary)
4661 @findex gnus-uu-mark-thread
4662 Set the process mark on the current (sub-)thread
4663 (@code{gnus-uu-mark-thread}).
4665 @item T M-#
4666 @kindex T M-# (Summary)
4667 @findex gnus-uu-unmark-thread
4668 Remove the process mark from the current (sub-)thread
4669 (@code{gnus-uu-unmark-thread}).
4671 @item T T
4672 @kindex T T (Summary)
4673 @findex gnus-summary-toggle-threads
4674 Toggle threading (@code{gnus-summary-toggle-threads}).
4676 @item T s
4677 @kindex T s (Summary)
4678 @findex gnus-summary-show-thread
4679 Expose the (sub-)thread hidden under the current article, if any
4680 (@code{gnus-summary-show-thread}).
4682 @item T h
4683 @kindex T h (Summary)
4684 @findex gnus-summary-hide-thread
4685 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
4687 @item T S
4688 @kindex T S (Summary)
4689 @findex gnus-summary-show-all-threads
4690 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
4692 @item T H
4693 @kindex T H (Summary)
4694 @findex gnus-summary-hide-all-threads
4695 Hide all threads (@code{gnus-summary-hide-all-threads}).
4697 @item T t
4698 @kindex T t (Summary)
4699 @findex gnus-summary-rethread-current
4700 Re-thread the current article's thread
4701 (@code{gnus-summary-rethread-current}).  This works even when the
4702 summary buffer is otherwise unthreaded.
4704 @item T ^
4705 @kindex T ^ (Summary)
4706 @findex gnus-summary-reparent-thread
4707 Make the current article the child of the marked (or previous) article
4708 (@code{gnus-summary-reparent-thread}).
4710 @end table
4712 The following commands are thread movement commands.  They all
4713 understand the numeric prefix.
4715 @table @kbd
4717 @item T n
4718 @kindex T n (Summary)
4719 @findex gnus-summary-next-thread
4720 Go to the next thread (@code{gnus-summary-next-thread}).
4722 @item T p
4723 @kindex T p (Summary)
4724 @findex gnus-summary-prev-thread
4725 Go to the previous thread (@code{gnus-summary-prev-thread}).
4727 @item T d
4728 @kindex T d (Summary)
4729 @findex gnus-summary-down-thread
4730 Descend the thread (@code{gnus-summary-down-thread}).
4732 @item T u
4733 @kindex T u (Summary)
4734 @findex gnus-summary-up-thread
4735 Ascend the thread (@code{gnus-summary-up-thread}).
4737 @item T o
4738 @kindex T o (Summary)
4739 @findex gnus-summary-top-thread
4740 Go to the top of the thread (@code{gnus-summary-top-thread}).
4741 @end table
4743 @vindex gnus-thread-operation-ignore-subject
4744 If you ignore subject while threading, you'll naturally end up with
4745 threads that have several different subjects in them.  If you then issue
4746 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
4747 wish to kill the entire thread, but just those parts of the thread that
4748 have the same subject as the current article.  If you like this idea,
4749 you can fiddle with @code{gnus-thread-operation-ignore-subject}.  If it
4750 is non-@code{nil} (which it is by default), subjects will be ignored
4751 when doing thread commands.  If this variable is @code{nil}, articles in
4752 the same thread with different subjects will not be included in the
4753 operation in question.  If this variable is @code{fuzzy}, only articles
4754 that have subjects fuzzily equal will be included (@pxref{Fuzzy
4755 Matching}).
4758 @node Sorting
4759 @section Sorting
4761 @findex gnus-thread-sort-by-total-score
4762 @findex gnus-thread-sort-by-date
4763 @findex gnus-thread-sort-by-score
4764 @findex gnus-thread-sort-by-subject
4765 @findex gnus-thread-sort-by-author
4766 @findex gnus-thread-sort-by-number
4767 @vindex gnus-thread-sort-functions
4768 If you are using a threaded summary display, you can sort the threads by
4769 setting @code{gnus-thread-sort-functions}, which is a list of functions.
4770 By default, sorting is done on article numbers.  Ready-made sorting
4771 predicate functions include @code{gnus-thread-sort-by-number},
4772 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
4773 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
4774 @code{gnus-thread-sort-by-total-score}.
4776 Each function takes two threads and returns non-@code{nil} if the first
4777 thread should be sorted before the other.  Note that sorting really is
4778 normally done by looking only at the roots of each thread.  If you use
4779 more than one function, the primary sort key should be the last function
4780 in the list.  You should probably always include
4781 @code{gnus-thread-sort-by-number} in the list of sorting
4782 functions---preferably first.  This will ensure that threads that are
4783 equal with respect to the other sort criteria will be displayed in
4784 ascending article order.
4786 If you would like to sort by score, then by subject, and finally by
4787 number, you could do something like:
4789 @lisp
4790 (setq gnus-thread-sort-functions
4791       '(gnus-thread-sort-by-number
4792         gnus-thread-sort-by-subject
4793         gnus-thread-sort-by-total-score))
4794 @end lisp
4796 The threads that have highest score will be displayed first in the
4797 summary buffer.  When threads have the same score, they will be sorted
4798 alphabetically.  The threads that have the same score and the same
4799 subject will be sorted by number, which is (normally) the sequence in
4800 which the articles arrived.
4802 If you want to sort by score and then reverse arrival order, you could
4803 say something like:
4805 @lisp
4806 (setq gnus-thread-sort-functions
4807       '((lambda (t1 t2)
4808           (not (gnus-thread-sort-by-number t1 t2)))
4809         gnus-thread-sort-by-score))
4810 @end lisp
4812 @vindex gnus-thread-score-function
4813 The function in the @code{gnus-thread-score-function} variable (default
4814 @code{+}) is used for calculating the total score of a thread.  Useful
4815 functions might be @code{max}, @code{min}, or squared means, or whatever
4816 tickles your fancy.
4818 @findex gnus-article-sort-functions
4819 @findex gnus-article-sort-by-date
4820 @findex gnus-article-sort-by-score
4821 @findex gnus-article-sort-by-subject
4822 @findex gnus-article-sort-by-author
4823 @findex gnus-article-sort-by-number
4824 If you are using an unthreaded display for some strange reason or other,
4825 you have to fiddle with the @code{gnus-article-sort-functions} variable.
4826 It is very similar to the @code{gnus-thread-sort-functions}, except that
4827 it uses slightly different functions for article comparison.  Available
4828 sorting predicate functions are @code{gnus-article-sort-by-number},
4829 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
4830 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
4832 If you want to sort an unthreaded summary display by subject, you could
4833 say something like:
4835 @lisp
4836 (setq gnus-article-sort-functions
4837       '(gnus-article-sort-by-number
4838         gnus-article-sort-by-subject))
4839 @end lisp
4843 @node Asynchronous Fetching
4844 @section Asynchronous Article Fetching
4845 @cindex asynchronous article fetching
4846 @cindex article pre-fetch
4847 @cindex pre-fetch
4849 If you read your news from an @sc{nntp} server that's far away, the
4850 network latencies may make reading articles a chore.  You have to wait
4851 for a while after pressing @kbd{n} to go to the next article before the
4852 article appears.  Why can't Gnus just go ahead and fetch the article
4853 while you are reading the previous one?  Why not, indeed.
4855 First, some caveats.  There are some pitfalls to using asynchronous
4856 article fetching, especially the way Gnus does it.
4858 Let's say you are reading article 1, which is short, and article 2 is
4859 quite long, and you are not interested in reading that.  Gnus does not
4860 know this, so it goes ahead and fetches article 2.  You decide to read
4861 article 3, but since Gnus is in the process of fetching article 2, the
4862 connection is blocked.
4864 To avoid these situations, Gnus will open two (count 'em two)
4865 connections to the server.  Some people may think this isn't a very nice
4866 thing to do, but I don't see any real alternatives.  Setting up that
4867 extra connection takes some time, so Gnus startup will be slower.
4869 Gnus will fetch more articles than you will read.  This will mean that
4870 the link between your machine and the @sc{nntp} server will become more
4871 loaded than if you didn't use article pre-fetch.  The server itself will
4872 also become more loaded---both with the extra article requests, and the
4873 extra connection.
4875 Ok, so now you know that you shouldn't really use this thing...  unless
4876 you really want to.
4878 @vindex gnus-asynchronous
4879 Here's how:  Set @code{gnus-asynchronous} to @code{t}.  The rest should
4880 happen automatically.
4882 @vindex gnus-use-article-prefetch
4883 You can control how many articles are to be pre-fetched by setting
4884 @code{gnus-use-article-prefetch}.  This is 30 by default, which means
4885 that when you read an article in the group, the backend will pre-fetch
4886 the next 30 articles.  If this variable is @code{t}, the backend will
4887 pre-fetch all the articles it can without bound.  If it is
4888 @code{nil}, no pre-fetching will be done.
4890 @vindex gnus-async-prefetch-article-p
4891 @findex gnus-async-read-p
4892 There are probably some articles that you don't want to pre-fetch---read
4893 articles, for instance.  The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched.  This function should
4894 return non-@code{nil} when the article in question is to be
4895 pre-fetched.  The default is @code{gnus-async-read-p}, which returns
4896 @code{nil} on read articles.  The function is called with an article
4897 data structure as the only parameter.
4899 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
4901 @lisp
4902 (defun my-async-short-unread-p (data)
4903   "Return non-nil for short, unread articles."
4904   (and (gnus-data-unread-p data)
4905        (< (mail-header-lines (gnus-data-header data))
4906           100)))
4908 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
4909 @end lisp
4911 These functions will be called many, many times, so they should
4912 preferably be short and sweet to avoid slowing down Gnus too much.
4913 It's probably a good idea to byte-compile things like this.
4915 @vindex gnus-prefetched-article-deletion-strategy
4916 Articles have to be removed from the asynch buffer sooner or later.  The
4917 @code{gnus-prefetched-article-deletion-strategy} says when to remove
4918 articles.  This is a list that may contain the following elements:
4920 @table @code
4921 @item read
4922 Remove articles when they are read.
4924 @item exit
4925 Remove articles when exiting the group.
4926 @end table
4928 The default value is @code{(read exit)}.
4930 @c @vindex gnus-use-header-prefetch
4931 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
4932 @c from the next group.
4935 @node Article Caching
4936 @section Article Caching
4937 @cindex article caching
4938 @cindex caching
4940 If you have an @emph{extremely} slow @sc{nntp} connection, you may
4941 consider turning article caching on.  Each article will then be stored
4942 locally under your home directory.  As you may surmise, this could
4943 potentially use @emph{huge} amounts of disk space, as well as eat up all
4944 your inodes so fast it will make your head swim.  In vodka.
4946 Used carefully, though, it could be just an easier way to save articles.
4948 @vindex gnus-use-long-file-name
4949 @vindex gnus-cache-directory
4950 @vindex gnus-use-cache
4951 To turn caching on, set @code{gnus-use-cache} to @code{t}.  By default,
4952 all articles ticked or marked as dormant will then be copied
4953 over to your local cache (@code{gnus-cache-directory}).  Whether this
4954 cache is flat or hierarchal is controlled by the
4955 @code{gnus-use-long-file-name} variable, as usual.
4957 When re-selecting a ticked or dormant article, it will be fetched from the
4958 cache instead of from the server.  As articles in your cache will never
4959 expire, this might serve as a method of saving articles while still
4960 keeping them where they belong.  Just mark all articles you want to save
4961 as dormant, and don't worry.
4963 When an article is marked as read, is it removed from the cache.
4965 @vindex gnus-cache-remove-articles
4966 @vindex gnus-cache-enter-articles
4967 The entering/removal of articles from the cache is controlled by the
4968 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
4969 variables.  Both are lists of symbols.  The first is @code{(ticked
4970 dormant)} by default, meaning that ticked and dormant articles will be
4971 put in the cache.  The latter is @code{(read)} by default, meaning that
4972 articles marked as read are removed from the cache.  Possibly
4973 symbols in these two lists are @code{ticked}, @code{dormant},
4974 @code{unread} and @code{read}.
4976 @findex gnus-jog-cache
4977 So where does the massive article-fetching and storing come into the
4978 picture?  The @code{gnus-jog-cache} command will go through all
4979 subscribed newsgroups, request all unread articles, score them, and
4980 store them in the cache.  You should only ever, ever ever ever, use this
4981 command if 1) your connection to the @sc{nntp} server is really, really,
4982 really slow and 2) you have a really, really, really huge disk.
4983 Seriously.  One way to cut down on the number of articles downloaded is
4984 to score unwanted articles down and have them marked as read.  They will
4985 not then be downloaded by this command.
4987 @vindex gnus-uncacheable-groups
4988 @vindex gnus-cacheable-groups
4989 It is likely that you do not want caching on all groups.  For instance,
4990 if your @code{nnml} mail is located under your home directory, it makes no
4991 sense to cache it somewhere else under your home directory.  Unless you
4992 feel that it's neat to use twice as much space.  
4994 To limit the caching, you could set @code{gnus-cacheable-groups} to a
4995 regexp of groups to cache, @samp{^nntp} for instance, or set the
4996 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
4997 Both variables are @code{nil} by default. If a group matches both
4998 variables, the group is not cached.
5000 @findex gnus-cache-generate-nov-databases
5001 @findex gnus-cache-generate-active
5002 @vindex gnus-cache-active-file
5003 The cache stores information on what articles it contains in its active
5004 file (@code{gnus-cache-active-file}).  If this file (or any other parts
5005 of the cache) becomes all messed up for some reason or other, Gnus
5006 offers two functions that will try to set things right.  @kbd{M-x
5007 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5008 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5009 file.
5012 @node Persistent Articles
5013 @section Persistent Articles
5014 @cindex persistent articles
5016 Closely related to article caching, we have @dfn{persistent articles}.
5017 In fact, it's just a different way of looking at caching, and much more
5018 useful in my opinion.
5020 Say you're reading a newsgroup, and you happen on to some valuable gem
5021 that you want to keep and treasure forever.  You'd normally just save it
5022 (using one of the many saving commands) in some file.  The problem with
5023 that is that it's just, well, yucky.  Ideally you'd prefer just having
5024 the article remain in the group where you found it forever; untouched by
5025 the expiry going on at the news server.
5027 This is what a @dfn{persistent article} is---an article that just won't
5028 be deleted.  It's implemented using the normal cache functions, but
5029 you use two explicit commands for managing persistent articles:
5031 @table @kbd
5033 @item *
5034 @kindex * (Summary)
5035 @findex gnus-cache-enter-article
5036 Make the current article persistent (@code{gnus-cache-enter-article}).
5038 @item M-*
5039 @kindex M-* (Summary)
5040 @findex gnus-cache-remove-article
5041 Remove the current article from the persistent articles
5042 (@code{gnus-cache-remove-article}).  This will normally delete the
5043 article.
5044 @end table
5046 Both these commands understand the process/prefix convention.
5048 To avoid having all ticked articles (and stuff) entered into the cache,
5049 you should set @code{gnus-use-cache} to @code{passive} if you're just
5050 interested in persistent articles:
5052 @lisp
5053 (setq gnus-use-cache 'passive)
5054 @end lisp
5057 @node Article Backlog
5058 @section Article Backlog
5059 @cindex backlog
5060 @cindex article backlog
5062 If you have a slow connection, but the idea of using caching seems
5063 unappealing to you (and it is, really), you can help the situation some
5064 by switching on the @dfn{backlog}.  This is where Gnus will buffer
5065 already read articles so that it doesn't have to re-fetch articles
5066 you've already read.  This only helps if you are in the habit of
5067 re-selecting articles you've recently read, of course.  If you never do
5068 that, turning the backlog on will slow Gnus down a little bit, and
5069 increase memory usage some.
5071 @vindex gnus-keep-backlog
5072 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5073 at most @var{n} old articles in a buffer for later re-fetching.  If this
5074 variable is non-@code{nil} and is not a number, Gnus will store
5075 @emph{all} read articles, which means that your Emacs will grow without
5076 bound before exploding and taking your machine down with you.  I put
5077 that in there just to keep y'all on your toes.
5079 This variable is @code{nil} by default.
5082 @node Saving Articles
5083 @section Saving Articles
5084 @cindex saving articles
5086 Gnus can save articles in a number of ways.  Below is the documentation
5087 for saving articles in a fairly straight-forward fashion (i.e., little
5088 processing of the article is done before it is saved).  For a different
5089 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5090 (@pxref{Decoding Articles}).
5092 @vindex gnus-save-all-headers
5093 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5094 unwanted headers before saving the article.
5096 @vindex gnus-saved-headers
5097 If the preceding variable is @code{nil}, all headers that match the
5098 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5099 deleted before saving.
5101 @table @kbd
5103 @item O o
5104 @itemx o
5105 @kindex O o (Summary)
5106 @kindex o (Summary)
5107 @findex gnus-summary-save-article
5108 @c @icon{gnus-summary-save-article}
5109 Save the current article using the default article saver
5110 (@code{gnus-summary-save-article}).
5112 @item O m
5113 @kindex O m (Summary)
5114 @findex gnus-summary-save-article-mail
5115 Save the current article in mail format
5116 (@code{gnus-summary-save-article-mail}).
5118 @item O r
5119 @kindex O r (Summary)
5120 @findex gnus-summary-save-article-rmail
5121 Save the current article in rmail format
5122 (@code{gnus-summary-save-article-rmail}).
5124 @item O f
5125 @kindex O f (Summary)
5126 @findex gnus-summary-save-article-file
5127 @c @icon{gnus-summary-save-article-file}
5128 Save the current article in plain file format
5129 (@code{gnus-summary-save-article-file}).
5131 @item O F
5132 @kindex O F (Summary)
5133 @findex gnus-summary-write-article-file
5134 Write the current article in plain file format, overwriting any previous
5135 file contents (@code{gnus-summary-write-article-file}).
5137 @item O b
5138 @kindex O b (Summary)
5139 @findex gnus-summary-save-article-body-file
5140 Save the current article body in plain file format
5141 (@code{gnus-summary-save-article-body-file}).
5143 @item O h
5144 @kindex O h (Summary)
5145 @findex gnus-summary-save-article-folder
5146 Save the current article in mh folder format
5147 (@code{gnus-summary-save-article-folder}).
5149 @item O v
5150 @kindex O v (Summary)
5151 @findex gnus-summary-save-article-vm
5152 Save the current article in a VM folder
5153 (@code{gnus-summary-save-article-vm}).
5155 @item O p
5156 @kindex O p (Summary)
5157 @findex gnus-summary-pipe-output
5158 Save the current article in a pipe.  Uhm, like, what I mean is---Pipe
5159 the current article to a process (@code{gnus-summary-pipe-output}).
5160 @end table
5162 @vindex gnus-prompt-before-saving
5163 All these commands use the process/prefix convention
5164 (@pxref{Process/Prefix}).  If you save bunches of articles using these
5165 functions, you might get tired of being prompted for files to save each
5166 and every article in.  The prompting action is controlled by
5167 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5168 default, giving you that excessive prompting action you know and
5169 loathe.  If you set this variable to @code{t} instead, you'll be prompted
5170 just once for each series of articles you save.  If you like to really
5171 have Gnus do all your thinking for you, you can even set this variable
5172 to @code{nil}, which means that you will never be prompted for files to
5173 save articles in.  Gnus will simply save all the articles in the default
5174 files.
5177 @vindex gnus-default-article-saver
5178 You can customize the @code{gnus-default-article-saver} variable to make
5179 Gnus do what you want it to.  You can use any of the four ready-made
5180 functions below, or you can create your own.
5182 @table @code
5184 @item gnus-summary-save-in-rmail
5185 @findex gnus-summary-save-in-rmail
5186 @vindex gnus-rmail-save-name
5187 @findex gnus-plain-save-name
5188 This is the default format, @dfn{babyl}.  Uses the function in the
5189 @code{gnus-rmail-save-name} variable to get a file name to save the
5190 article in.  The default is @code{gnus-plain-save-name}.
5192 @item gnus-summary-save-in-mail
5193 @findex gnus-summary-save-in-mail
5194 @vindex gnus-mail-save-name
5195 Save in a Unix mail (mbox) file.  Uses the function in the
5196 @code{gnus-mail-save-name} variable to get a file name to save the
5197 article in.  The default is @code{gnus-plain-save-name}.
5199 @item gnus-summary-save-in-file
5200 @findex gnus-summary-save-in-file
5201 @vindex gnus-file-save-name
5202 @findex gnus-numeric-save-name
5203 Append the article straight to an ordinary file.  Uses the function in
5204 the @code{gnus-file-save-name} variable to get a file name to save the
5205 article in.  The default is @code{gnus-numeric-save-name}.
5207 @item gnus-summary-save-body-in-file
5208 @findex gnus-summary-save-body-in-file
5209 Append the article body to an ordinary file.  Uses the function in the
5210 @code{gnus-file-save-name} variable to get a file name to save the
5211 article in.  The default is @code{gnus-numeric-save-name}.
5213 @item gnus-summary-save-in-folder
5214 @findex gnus-summary-save-in-folder
5215 @findex gnus-folder-save-name
5216 @findex gnus-Folder-save-name
5217 @vindex gnus-folder-save-name
5218 @cindex rcvstore
5219 @cindex MH folders
5220 Save the article to an MH folder using @code{rcvstore} from the MH
5221 library.  Uses the function in the @code{gnus-folder-save-name} variable
5222 to get a file name to save the article in.  The default is
5223 @code{gnus-folder-save-name}, but you can also use
5224 @code{gnus-Folder-save-name}, which creates capitalized names.
5226 @item gnus-summary-save-in-vm
5227 @findex gnus-summary-save-in-vm
5228 Save the article in a VM folder.  You have to have the VM mail
5229 reader to use this setting.
5230 @end table
5232 @vindex gnus-article-save-directory
5233 All of these functions, except for the last one, will save the article
5234 in the @code{gnus-article-save-directory}, which is initialized from the
5235 @code{SAVEDIR} environment variable.  This is @file{~/News/} by
5236 default.
5238 As you can see above, the functions use different functions to find a
5239 suitable name of a file to save the article in.  Below is a list of
5240 available functions that generate names:
5242 @table @code
5244 @item gnus-Numeric-save-name
5245 @findex gnus-Numeric-save-name
5246 File names like @file{~/News/Alt.andrea-dworkin/45}.
5248 @item gnus-numeric-save-name
5249 @findex gnus-numeric-save-name
5250 File names like @file{~/News/alt.andrea-dworkin/45}.
5252 @item gnus-Plain-save-name
5253 @findex gnus-Plain-save-name
5254 File names like @file{~/News/Alt.andrea-dworkin}.
5256 @item gnus-plain-save-name
5257 @findex gnus-plain-save-name
5258 File names like @file{~/News/alt.andrea-dworkin}.
5259 @end table
5261 @vindex gnus-split-methods
5262 You can have Gnus suggest where to save articles by plonking a regexp into
5263 the @code{gnus-split-methods} alist.  For instance, if you would like to
5264 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5265 related to VM in @code{vm-stuff}, you could set this variable to something
5266 like:
5268 @lisp
5269 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5270  ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5271  (my-choosing-function "../other-dir/my-stuff")
5272  ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5273 @end lisp
5275 We see that this is a list where each element is a list that has two
5276 elements---the @dfn{match} and the @dfn{file}.  The match can either be
5277 a string (in which case it is used as a regexp to match on the article
5278 head); it can be a symbol (which will be called as a function with the
5279 group name as a parameter); or it can be a list (which will be
5280 @code{eval}ed).  If any of these actions have a non-@code{nil} result,
5281 the @dfn{file} will be used as a default prompt.  In addition, the
5282 result of the operation itself will be used if the function or form
5283 called returns a string or a list of strings.
5285 You basically end up with a list of file names that might be used when
5286 saving the current article.  (All ``matches'' will be used.)  You will
5287 then be prompted for what you really want to use as a name, with file
5288 name completion over the results from applying this variable.
5290 This variable is @code{((gnus-article-archive-name))} by default, which
5291 means that Gnus will look at the articles it saves for an
5292 @code{Archive-name} line and use that as a suggestion for the file
5293 name.
5295 Here's an example function to clean up file names somewhat.  If you have
5296 lots of mail groups called things like
5297 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5298 these group names before creating the file name to save to.  The
5299 following will do just that:
5301 @lisp
5302 (defun my-save-name (group)
5303   (when (string-match "^nnml:mail." group)
5304     (substring group (match-end 0))))
5306 (setq gnus-split-methods
5307       '((gnus-article-archive-name)
5308         (my-save-name)))
5309 @end lisp
5312 @vindex gnus-use-long-file-name
5313 Finally, you have the @code{gnus-use-long-file-name} variable.  If it is
5314 @code{nil}, all the preceding functions will replace all periods
5315 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5316 the functions will generate hierarchies of directories instead of having
5317 all the files in the top level directory
5318 (@file{~/News/alt/andrea-dworkin} instead of
5319 @file{~/News/alt.andrea-dworkin}.)  This variable is @code{t} by default
5320 on most systems.  However, for historical reasons, this is @code{nil} on
5321 Xenix and usg-unix-v machines by default.
5323 This function also affects kill and score file names.  If this variable
5324 is a list, and the list contains the element @code{not-score}, long file
5325 names will not be used for score files, if it contains the element
5326 @code{not-save}, long file names will not be used for saving, and if it
5327 contains the element @code{not-kill}, long file names will not be used
5328 for kill files.
5330 If you'd like to save articles in a hierarchy that looks something like
5331 a spool, you could
5333 @lisp
5334 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5335 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5336 @end lisp
5338 Then just save with @kbd{o}.  You'd then read this hierarchy with
5339 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5340 the top level directory as the argument (@file{~/News/}).  Then just walk
5341 around to the groups/directories with @code{nneething}.
5344 @node Decoding Articles
5345 @section Decoding Articles
5346 @cindex decoding articles
5348 Sometime users post articles (or series of articles) that have been
5349 encoded in some way or other.  Gnus can decode them for you.
5351 @menu
5352 * Uuencoded Articles::    Uudecode articles.
5353 * Shell Archives::        Unshar articles.
5354 * PostScript Files::      Split PostScript.
5355 * Other Files::           Plain save and binhex.
5356 * Decoding Variables::    Variables for a happy decoding.
5357 * Viewing Files::         You want to look at the result of the decoding?
5358 @end menu
5360 @cindex series
5361 @cindex article series
5362 All these functions use the process/prefix convention
5363 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5364 the extension that a ``single article'' means ``a single series''.  Gnus
5365 can find out by itself what articles belong to a series, decode all the
5366 articles and unpack/view/save the resulting file(s).
5368 Gnus guesses what articles are in the series according to the following
5369 simplish rule: The subjects must be (nearly) identical, except for the
5370 last two numbers of the line.  (Spaces are largely ignored, however.)
5372 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5373 will find all the articles that match the regexp @samp{^cat.gif
5374 ([0-9]+/[0-9]+).*$}.
5376 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5377 series}, will not be properly recognized by any of the automatic viewing
5378 commands, and you have to mark the articles manually with @kbd{#}.
5381 @node Uuencoded Articles
5382 @subsection Uuencoded Articles
5383 @cindex uudecode
5384 @cindex uuencoded articles
5386 @table @kbd
5388 @item X u
5389 @kindex X u (Summary)
5390 @findex gnus-uu-decode-uu
5391 @c @icon{gnus-uu-decode-uu}
5392 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5394 @item X U
5395 @kindex X U (Summary)
5396 @findex gnus-uu-decode-uu-and-save
5397 Uudecodes and saves the current series
5398 (@code{gnus-uu-decode-uu-and-save}).
5400 @item X v u
5401 @kindex X v u (Summary)
5402 @findex gnus-uu-decode-uu-view
5403 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5405 @item X v U
5406 @kindex X v U (Summary)
5407 @findex gnus-uu-decode-uu-and-save-view
5408 Uudecodes, views and saves the current series
5409 (@code{gnus-uu-decode-uu-and-save-view}).
5411 @end table
5413 Remember that these all react to the presence of articles marked with
5414 the process mark.  If, for instance, you'd like to decode and save an
5415 entire newsgroup, you'd typically do @kbd{M P a}
5416 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5417 (@code{gnus-uu-decode-uu-and-save}).
5419 All this is very much different from how @code{gnus-uu} worked with
5420 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5421 the sun.  This version of @code{gnus-uu} generally assumes that you mark
5422 articles in some way (@pxref{Setting Process Marks}) and then press
5423 @kbd{X u}.
5425 @vindex gnus-uu-notify-files
5426 Note: When trying to decode articles that have names matching
5427 @code{gnus-uu-notify-files}, which is hard-coded to
5428 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5429 automatically post an article on @samp{comp.unix.wizards} saying that
5430 you have just viewed the file in question.  This feature can't be turned
5431 off.
5434 @node Shell Archives
5435 @subsection Shell Archives
5436 @cindex unshar
5437 @cindex shell archives
5438 @cindex shared articles
5440 Shell archives (``shar files'') used to be a popular way to distribute
5441 sources, but it isn't used all that much today.  In any case, we have
5442 some commands to deal with these:
5444 @table @kbd
5446 @item X s
5447 @kindex X s (Summary)
5448 @findex gnus-uu-decode-unshar
5449 Unshars the current series (@code{gnus-uu-decode-unshar}).
5451 @item X S
5452 @kindex X S (Summary)
5453 @findex gnus-uu-decode-unshar-and-save
5454 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5456 @item X v s
5457 @kindex X v s (Summary)
5458 @findex gnus-uu-decode-unshar-view
5459 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5461 @item X v S
5462 @kindex X v S (Summary)
5463 @findex gnus-uu-decode-unshar-and-save-view
5464 Unshars, views and saves the current series
5465 (@code{gnus-uu-decode-unshar-and-save-view}).
5466 @end table
5469 @node PostScript Files
5470 @subsection PostScript Files
5471 @cindex PostScript
5473 @table @kbd
5475 @item X p
5476 @kindex X p (Summary)
5477 @findex gnus-uu-decode-postscript
5478 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5480 @item X P
5481 @kindex X P (Summary)
5482 @findex gnus-uu-decode-postscript-and-save
5483 Unpack and save the current PostScript series
5484 (@code{gnus-uu-decode-postscript-and-save}).
5486 @item X v p
5487 @kindex X v p (Summary)
5488 @findex gnus-uu-decode-postscript-view
5489 View the current PostScript series
5490 (@code{gnus-uu-decode-postscript-view}).
5492 @item X v P
5493 @kindex X v P (Summary)
5494 @findex gnus-uu-decode-postscript-and-save-view
5495 View and save the current PostScript series
5496 (@code{gnus-uu-decode-postscript-and-save-view}).
5497 @end table
5500 @node Other Files
5501 @subsection Other Files
5503 @table @kbd
5504 @item X o
5505 @kindex X o (Summary)
5506 @findex gnus-uu-decode-save
5507 Save the current series
5508 (@code{gnus-uu-decode-save}).
5510 @item X b
5511 @kindex X b (Summary)
5512 @findex gnus-uu-decode-binhex
5513 Unbinhex the current series (@code{gnus-uu-decode-binhex}).  This
5514 doesn't really work yet.
5515 @end table
5518 @node Decoding Variables
5519 @subsection Decoding Variables
5521 Adjective, not verb.
5523 @menu
5524 * Rule Variables::          Variables that say how a file is to be viewed.
5525 * Other Decode Variables::  Other decode variables.
5526 * Uuencoding and Posting::  Variables for customizing uuencoding.
5527 @end menu
5530 @node Rule Variables
5531 @subsubsection Rule Variables
5532 @cindex rule variables
5534 Gnus uses @dfn{rule variables} to decide how to view a file.  All these
5535 variables are of the form
5537 @lisp
5538       (list '(regexp1 command2)
5539             '(regexp2 command2)
5540             ...)
5541 @end lisp
5543 @table @code
5545 @item gnus-uu-user-view-rules
5546 @vindex gnus-uu-user-view-rules
5547 @cindex sox
5548 This variable is consulted first when viewing files.  If you wish to use,
5549 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5550 say something like:
5551 @lisp
5552 (setq gnus-uu-user-view-rules
5553       (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5554 @end lisp
5556 @item gnus-uu-user-view-rules-end
5557 @vindex gnus-uu-user-view-rules-end
5558 This variable is consulted if Gnus couldn't make any matches from the
5559 user and default view rules.
5561 @item gnus-uu-user-archive-rules
5562 @vindex gnus-uu-user-archive-rules
5563 This variable can be used to say what commands should be used to unpack
5564 archives.
5565 @end table
5568 @node Other Decode Variables
5569 @subsubsection Other Decode Variables
5571 @table @code
5572 @vindex gnus-uu-grabbed-file-functions
5574 @item gnus-uu-grabbed-file-functions
5575 All functions in this list will be called right after each file has been
5576 successfully decoded---so that you can move or view files right away,
5577 and don't have to wait for all files to be decoded before you can do
5578 anything.  Ready-made functions you can put in this list are:
5580 @table @code
5582 @item gnus-uu-grab-view
5583 @findex gnus-uu-grab-view
5584 View the file.
5586 @item gnus-uu-grab-move
5587 @findex gnus-uu-grab-move
5588 Move the file (if you're using a saving function.)
5589 @end table
5591 @item gnus-uu-be-dangerous
5592 @vindex gnus-uu-be-dangerous
5593 Specifies what to do if unusual situations arise during decoding.  If
5594 @code{nil}, be as conservative as possible.  If @code{t}, ignore things
5595 that didn't work, and overwrite existing files.  Otherwise, ask each
5596 time.
5598 @item gnus-uu-ignore-files-by-name
5599 @vindex gnus-uu-ignore-files-by-name
5600 Files with name matching this regular expression won't be viewed.
5602 @item gnus-uu-ignore-files-by-type
5603 @vindex gnus-uu-ignore-files-by-type
5604 Files with a @sc{mime} type matching this variable won't be viewed.
5605 Note that Gnus tries to guess what type the file is based on the name.
5606 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5607 kludgey.
5609 @item gnus-uu-tmp-dir
5610 @vindex gnus-uu-tmp-dir
5611 Where @code{gnus-uu} does its work.
5613 @item gnus-uu-do-not-unpack-archives
5614 @vindex gnus-uu-do-not-unpack-archives
5615 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5616 looking for files to display.
5618 @item gnus-uu-view-and-save
5619 @vindex gnus-uu-view-and-save
5620 Non-@code{nil} means that the user will always be asked to save a file
5621 after viewing it.
5623 @item gnus-uu-ignore-default-view-rules
5624 @vindex gnus-uu-ignore-default-view-rules
5625 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5626 rules.
5628 @item gnus-uu-ignore-default-archive-rules
5629 @vindex gnus-uu-ignore-default-archive-rules
5630 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5631 unpacking commands.
5633 @item gnus-uu-kill-carriage-return
5634 @vindex gnus-uu-kill-carriage-return
5635 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5636 from articles.
5638 @item gnus-uu-unmark-articles-not-decoded
5639 @vindex gnus-uu-unmark-articles-not-decoded
5640 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
5641 decoded articles as unread.
5643 @item gnus-uu-correct-stripped-uucode
5644 @vindex gnus-uu-correct-stripped-uucode
5645 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5646 uuencoded files that have had trailing spaces deleted.
5648 @item gnus-uu-pre-uudecode-hook
5649 @vindex gnus-uu-pre-uudecode-hook
5650 Hook run before sending a message to @code{uudecode}.
5652 @item gnus-uu-view-with-metamail
5653 @vindex gnus-uu-view-with-metamail
5654 @cindex metamail
5655 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5656 commands defined by the rule variables and just fudge a @sc{mime}
5657 content type based on the file name.  The result will be fed to
5658 @code{metamail} for viewing.
5660 @item gnus-uu-save-in-digest
5661 @vindex gnus-uu-save-in-digest
5662 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5663 decoding, will save in digests.  If this variable is @code{nil},
5664 @code{gnus-uu} will just save everything in a file without any
5665 embellishments.  The digesting almost conforms to RFC1153---no easy way
5666 to specify any meaningful volume and issue numbers were found, so I
5667 simply dropped them.
5669 @end table
5672 @node Uuencoding and Posting
5673 @subsubsection Uuencoding and Posting
5675 @table @code
5677 @item gnus-uu-post-include-before-composing
5678 @vindex gnus-uu-post-include-before-composing
5679 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5680 before you compose the article.  If this variable is @code{t}, you can
5681 either include an encoded file with @kbd{C-c C-i} or have one included
5682 for you when you post the article.
5684 @item gnus-uu-post-length
5685 @vindex gnus-uu-post-length
5686 Maximum length of an article.  The encoded file will be split into how
5687 many articles it takes to post the entire file.
5689 @item gnus-uu-post-threaded
5690 @vindex gnus-uu-post-threaded
5691 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
5692 thread.  This may not be smart, as no other decoder I have seen is able
5693 to follow threads when collecting uuencoded articles.  (Well, I have
5694 seen one package that does that---@code{gnus-uu}, but somehow, I don't
5695 think that counts...) Default is @code{nil}.
5697 @item gnus-uu-post-separate-description
5698 @vindex gnus-uu-post-separate-description
5699 Non-@code{nil} means that the description will be posted in a separate
5700 article.  The first article will typically be numbered (0/x).  If this
5701 variable is @code{nil}, the description the user enters will be included
5702 at the beginning of the first article, which will be numbered (1/x).
5703 Default is @code{t}.
5705 @end table
5708 @node Viewing Files
5709 @subsection Viewing Files
5710 @cindex viewing files
5711 @cindex pseudo-articles
5713 After decoding, if the file is some sort of archive, Gnus will attempt
5714 to unpack the archive and see if any of the files in the archive can be
5715 viewed.  For instance, if you have a gzipped tar file @file{pics.tar.gz}
5716 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
5717 uncompress and de-tar the main file, and then view the two pictures.
5718 This unpacking process is recursive, so if the archive contains archives
5719 of archives, it'll all be unpacked.
5721 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
5722 extracted file into the summary buffer.  If you go to these
5723 ``articles'', you will be prompted for a command to run (usually Gnus
5724 will make a suggestion), and then the command will be run.
5726 @vindex gnus-view-pseudo-asynchronously
5727 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
5728 until the viewing is done before proceeding.
5730 @vindex gnus-view-pseudos
5731 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
5732 the pseudo-articles into the summary buffer, but view them
5733 immediately.  If this variable is @code{not-confirm}, the user won't even
5734 be asked for a confirmation before viewing is done.
5736 @vindex gnus-view-pseudos-separately
5737 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
5738 pseudo-article will be created for each file to be viewed.  If
5739 @code{nil}, all files that use the same viewing command will be given as
5740 a list of parameters to that command.
5742 @vindex gnus-insert-pseudo-articles
5743 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
5744 pseudo-articles when decoding.  It is @code{t} by default.
5746 So; there you are, reading your @emph{pseudo-articles} in your
5747 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
5748 Why isn't anything real anymore? How did we get here?
5751 @node Article Treatment
5752 @section Article Treatment
5754 Reading through this huge manual, you may have quite forgotten that the
5755 object of newsreaders is to actually, like, read what people have
5756 written.  Reading articles.  Unfortunately, people are quite bad at
5757 writing, so there are tons of functions and variables to make reading
5758 these articles easier.
5760 @menu
5761 * Article Highlighting::    You want to make the article look like fruit salad.
5762 * Article Fontisizing::     Making emphasized text look nice.
5763 * Article Hiding::          You also want to make certain info go away.
5764 * Article Washing::         Lots of way-neat functions to make life better.
5765 * Article Buttons::         Click on URLs, Message-IDs, addresses and the like.
5766 * Article Date::            Grumble, UT!
5767 * Article Signature::       What is a signature?
5768 @end menu
5771 @node Article Highlighting
5772 @subsection Article Highlighting
5773 @cindex highlighting
5775 Not only do you want your article buffer to look like fruit salad, but
5776 you want it to look like technicolor fruit salad.  
5778 @table @kbd
5780 @item W H a
5781 @kindex W H a (Summary)
5782 @findex gnus-article-highlight
5783 @findex gnus-article-maybe-highlight
5784 Do much highlighting of the current article
5785 (@code{gnus-article-highlight}).  This function highlights header, cited
5786 text, the signature, and adds buttons to the body and the head.
5788 Most users would prefer using @code{gnus-article-maybe-highlight} in
5789 @code{gnus-article-display-hook} (@pxref{Customizing Articles}) instead.
5790 This is a bit less agressive---it highlights only the headers, the
5791 signature and adds buttons.
5793 @item W H h
5794 @kindex W H h (Summary)
5795 @findex gnus-article-highlight-headers
5796 @vindex gnus-header-face-alist
5797 Highlight the headers (@code{gnus-article-highlight-headers}).  The
5798 highlighting will be done according to the @code{gnus-header-face-alist}
5799 variable, which is a list where each element has the form @code{(@var{regexp}
5800 @var{name} @var{content})}.  @var{regexp} is a regular expression for matching the
5801 header, @var{name} is the face used for highlighting the header name
5802 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
5803 the header value.  The first match made will be used.  Note that
5804 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
5806 @item W H c
5807 @kindex W H c (Summary)
5808 @findex gnus-article-highlight-citation
5809 Highlight cited text (@code{gnus-article-highlight-citation}).
5811 Some variables to customize the citation highlights:
5813 @table @code
5814 @vindex gnus-cite-parse-max-size
5816 @item gnus-cite-parse-max-size
5817 If the article size if bigger than this variable (which is 25000 by
5818 default), no citation highlighting will be performed.
5820 @item gnus-cite-prefix-regexp
5821 @vindex gnus-cite-prefix-regexp
5822 Regexp matching the longest possible citation prefix on a line.
5824 @item gnus-cite-max-prefix
5825 @vindex gnus-cite-max-prefix
5826 Maximum possible length for a citation prefix (default 20).
5828 @item gnus-cite-face-list
5829 @vindex gnus-cite-face-list
5830 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
5831 When there are citations from multiple articles in the same message,
5832 Gnus will try to give each citation from each article its own face.
5833 This should make it easier to see who wrote what.
5835 @item gnus-supercite-regexp
5836 @vindex gnus-supercite-regexp
5837 Regexp matching normal Supercite attribution lines.
5839 @item gnus-supercite-secondary-regexp
5840 @vindex gnus-supercite-secondary-regexp
5841 Regexp matching mangled Supercite attribution lines.
5843 @item gnus-cite-minimum-match-count
5844 @vindex gnus-cite-minimum-match-count
5845 Minimum number of identical prefixes we have to see before we believe
5846 that it's a citation.
5848 @item gnus-cite-attribution-prefix
5849 @vindex gnus-cite-attribution-prefix
5850 Regexp matching the beginning of an attribution line.
5852 @item gnus-cite-attribution-suffix
5853 @vindex gnus-cite-attribution-suffix
5854 Regexp matching the end of an attribution line.
5856 @item gnus-cite-attribution-face
5857 @vindex gnus-cite-attribution-face
5858 Face used for attribution lines.  It is merged with the face for the
5859 cited text belonging to the attribution.
5861 @end table
5864 @item W H s
5865 @kindex W H s (Summary)
5866 @vindex gnus-signature-separator
5867 @vindex gnus-signature-face
5868 @findex gnus-article-highlight-signature
5869 Highlight the signature (@code{gnus-article-highlight-signature}).
5870 Everything after @code{gnus-signature-separator} (@pxref{Article
5871 Signature}) in an article will be considered a signature and will be
5872 highlighted with @code{gnus-signature-face}, which is @code{italic} by
5873 default.
5875 @end table
5877 @xref{Customizing Articles}, for how to highlight articles automatically.
5880 @node Article Fontisizing
5881 @subsection Article Fontisizing
5882 @cindex emphasis
5883 @cindex article emphasis
5885 @findex gnus-article-emphasize
5886 @kindex W e (Summary)
5887 People commonly add emphasis to words in news articles by writing things
5888 like @samp{_this_} or @samp{*this*}.  Gnus can make this look nicer by
5889 running the article through the @kbd{W e}
5890 (@code{gnus-article-emphasize}) command.
5892 @vindex gnus-emphasis-alist
5893 How the emphasis is computed is controlled by the
5894 @code{gnus-emphasis-alist} variable.  This is an alist where the first
5895 element is a regular expression to be matched.  The second is a number
5896 that says what regular expression grouping is used to find the entire
5897 emphasized word.  The third is a number that says what regexp grouping
5898 should be displayed and highlighted.  (The text between these two
5899 groupings will be hidden.)  The fourth is the face used for
5900 highlighting.
5902 @lisp
5903 (setq gnus-article-emphasis
5904       '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
5905         ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
5906 @end lisp
5908 @vindex gnus-emphasis-underline
5909 @vindex gnus-emphasis-bold
5910 @vindex gnus-emphasis-italic
5911 @vindex gnus-emphasis-underline-bold
5912 @vindex gnus-emphasis-underline-italic
5913 @vindex gnus-emphasis-bold-italic
5914 @vindex gnus-emphasis-underline-bold-italic
5915 By default, there are seven rules, and they use the following faces:
5916 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
5917 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
5918 @code{gnus-emphasis-underline-italic},
5919 @code{gnus-emphasis-underline-bold}, and
5920 @code{gnus-emphasis-underline-bold-italic}.
5922 If you want to change these faces, you can either use @kbd{M-x
5923 customize}, or you can use @code{copy-face}.  For instance, if you want
5924 to make @code{gnus-emphasis-italic} use a red face instead, you could
5925 say something like:
5927 @lisp
5928 (copy-face 'red 'gnus-emphasis-italic)
5929 @end lisp
5931 @xref{Customizing Articles}, for how to fontize articles automatically.
5934 @node Article Hiding
5935 @subsection Article Hiding
5936 @cindex article hiding
5938 Or rather, hiding certain things in each article.  There usually is much
5939 too much cruft in most articles.
5941 @table @kbd
5943 @item W W a
5944 @kindex W W a (Summary)
5945 @findex gnus-article-hide
5946 Do quite a lot of hiding on the article buffer
5947 (@kbd{gnus-article-hide}).  In particular, this function will hide
5948 headers, PGP, cited text and the signature.  
5950 @item W W h
5951 @kindex W W h (Summary)
5952 @findex gnus-article-hide-headers
5953 Hide headers (@code{gnus-article-hide-headers}).  @xref{Hiding
5954 Headers}.
5956 @item W W b
5957 @kindex W W b (Summary)
5958 @findex gnus-article-hide-boring-headers
5959 Hide headers that aren't particularly interesting
5960 (@code{gnus-article-hide-boring-headers}).  @xref{Hiding Headers}.
5962 @item W W s
5963 @kindex W W s (Summary)
5964 @findex gnus-article-hide-signature
5965 Hide signature (@code{gnus-article-hide-signature}).  @xref{Article
5966 Signature}.
5968 @item W W p
5969 @kindex W W p (Summary)
5970 @findex gnus-article-hide-pgp
5971 @vindex gnus-article-hide-pgp-hook
5972 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).  The
5973 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
5974 signature has been hidden.
5976 @item W W P
5977 @kindex W W P (Summary)
5978 @findex gnus-article-hide-pem
5979 Hide @sc{pem} (privacy enhanced messages) cruft
5980 (@code{gnus-article-hide-pem}).
5982 @item W W c
5983 @kindex W W c (Summary)
5984 @findex gnus-article-hide-citation
5985 Hide citation (@code{gnus-article-hide-citation}).  Some variables for
5986 customizing the hiding:
5988 @table @code
5990 @item gnus-cited-opened-text-button-line-format
5991 @itemx gnus-cited-closed-text-button-line-format
5992 @vindex gnus-cited-closed-text-button-line-format
5993 @vindex gnus-cited-opened-text-button-line-format
5994 Gnus adds buttons to show where the cited text has been hidden, and to
5995 allow toggle hiding the text.  The format of the variable is specified
5996 by these format-like variable (@pxref{Formatting Variables}).  These
5997 specs are valid:
5999 @table @samp
6000 @item b
6001 Starting point of the hidden text.
6002 @item e
6003 Ending point of the hidden text.
6004 @item l
6005 Number of characters in the hidden region.
6006 @item n
6007 Number of lines of hidden text.
6008 @end table
6010 @item gnus-cited-lines-visible
6011 @vindex gnus-cited-lines-visible
6012 The number of lines at the beginning of the cited text to leave shown.
6014 @end table
6016 @item W W C-c
6017 @kindex W W C-c (Summary)
6018 @findex gnus-article-hide-citation-maybe
6020 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
6021 following two variables:
6023 @table @code
6024 @item gnus-cite-hide-percentage
6025 @vindex gnus-cite-hide-percentage
6026 If the cited text is of a bigger percentage than this variable (default
6027 50), hide the cited text.
6029 @item gnus-cite-hide-absolute
6030 @vindex gnus-cite-hide-absolute
6031 The cited text must have at least this length (default 10) before it
6032 is hidden.
6033 @end table
6035 @item W W C
6036 @kindex W W C (Summary)
6037 @findex gnus-article-hide-citation-in-followups
6038 Hide cited text in articles that aren't roots
6039 (@code{gnus-article-hide-citation-in-followups}).  This isn't very
6040 useful as an interactive command, but might be a handy function to stick
6041 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}).
6043 @end table
6045 All these ``hiding'' commands are toggles, but if you give a negative
6046 prefix to these commands, they will show what they have previously
6047 hidden.  If you give a positive prefix, they will always hide.
6049 Also @pxref{Article Highlighting} for further variables for
6050 citation customization.
6052 @xref{Customizing Articles}, for how to hide article elements
6053 automatically.
6056 @node Article Washing
6057 @subsection Article Washing
6058 @cindex washing
6059 @cindex article washing
6061 We call this ``article washing'' for a really good reason.  Namely, the
6062 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6064 @dfn{Washing} is defined by us as ``changing something from something to
6065 something else'', but normally results in something looking better.
6066 Cleaner, perhaps.
6068 @table @kbd
6070 @item W l
6071 @kindex W l (Summary)
6072 @findex gnus-summary-stop-page-breaking
6073 Remove page breaks from the current article
6074 (@code{gnus-summary-stop-page-breaking}).  @xref{Misc Article}, for page
6075 delimiters. 
6077 @item W r
6078 @kindex W r (Summary)
6079 @findex gnus-summary-caesar-message
6080 @c @icon{gnus-summary-caesar-message}
6081 Do a Caesar rotate (rot13) on the article buffer
6082 (@code{gnus-summary-caesar-message}).
6083 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6084 (Typically offensive jokes and such.)
6086 It's commonly called ``rot13'' because each letter is rotated 13
6087 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6088 #15).  It is sometimes referred to as ``Caesar rotate'' because Caesar
6089 is rumored to have employed this form of, uh, somewhat weak encryption.
6091 @item W t
6092 @kindex W t (Summary)
6093 @findex gnus-summary-toggle-header
6094 Toggle whether to display all headers in the article buffer
6095 (@code{gnus-summary-toggle-header}).
6097 @item W v
6098 @kindex W v (Summary)
6099 @findex gnus-summary-verbose-header
6100 Toggle whether to display all headers in the article buffer permanently
6101 (@code{gnus-summary-verbose-header}).
6103 @item W m
6104 @kindex W m (Summary)
6105 @findex gnus-summary-toggle-mime
6106 Toggle whether to run the article through @sc{mime} before displaying
6107 (@code{gnus-summary-toggle-mime}).
6109 @item W o
6110 @kindex W o (Summary)
6111 @findex gnus-article-treat-overstrike
6112 Treat overstrike (@code{gnus-article-treat-overstrike}).
6114 @item W d
6115 @kindex W d (Summary)
6116 @findex gnus-article-treat-dumbquotes
6117 Treat M******** sm*rtq**t*s (@code{gnus-article-treat-dumbquotes}).
6119 @item W w
6120 @kindex W w (Summary)
6121 @findex gnus-article-fill-cited-article
6122 Do word wrap (@code{gnus-article-fill-cited-article}).  If you use this
6123 function in @code{gnus-article-display-hook}, it should be run fairly
6124 late and certainly after any highlighting.
6126 You can give the command a numerical prefix to specify the width to use
6127 when filling.
6129 @item W c
6130 @kindex W c (Summary)
6131 @findex gnus-article-remove-cr
6132 Remove CR (i. e., @samp{^M}s on the end of the lines)
6133 (@code{gnus-article-remove-cr}).
6135 @item W q
6136 @kindex W q (Summary)
6137 @findex gnus-article-de-quoted-unreadable
6138 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
6139 Quoted-Printable is one common @sc{mime} encoding employed when sending
6140 non-ASCII (i. e., 8-bit) articles.  It typically makes strings like
6141 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
6142 readable to me.
6144 @item W f
6145 @kindex W f (Summary)
6146 @cindex x-face
6147 @findex gnus-article-display-x-face
6148 @findex gnus-article-x-face-command
6149 @vindex gnus-article-x-face-command
6150 @vindex gnus-article-x-face-too-ugly
6151 Look for and display any X-Face headers
6152 (@code{gnus-article-display-x-face}).  The command executed by this
6153 function is given by the @code{gnus-article-x-face-command} variable.
6154 If this variable is a string, this string will be executed in a
6155 sub-shell.  If it is a function, this function will be called with the
6156 face as the argument.  If the @code{gnus-article-x-face-too-ugly} (which
6157 is a regexp) matches the @code{From} header, the face will not be shown.
6158 The default action under Emacs is to fork off an @code{xv} to view the
6159 face; under XEmacs the default action is to display the face before the
6160 @code{From} header.  (It's nicer if XEmacs has been compiled with X-Face
6161 support---that will make display somewhat faster.  If there's no native
6162 X-Face support, Gnus will try to convert the @code{X-Face} header using
6163 external programs from the @code{pbmplus} package and friends.)  If you
6164 want to have this function in the display hook, it should probably come
6165 last.
6167 @item W b
6168 @kindex W b (Summary)
6169 @findex gnus-article-add-buttons
6170 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6171 @xref{Article Buttons}.
6173 @item W B
6174 @kindex W B (Summary)
6175 @findex gnus-article-add-buttons-to-head
6176 Add clickable buttons to the article headers
6177 (@code{gnus-article-add-buttons-to-head}).
6179 @item W E l
6180 @kindex W E l (Summary)
6181 @findex gnus-article-strip-leading-blank-lines
6182 Remove all blank lines from the beginning of the article
6183 (@code{gnus-article-strip-leading-blank-lines}).
6185 @item W E m
6186 @kindex W E m (Summary)
6187 @findex gnus-article-strip-multiple-blank-lines
6188 Replace all blank lines with empty lines and then all multiple empty
6189 lines with a single empty line.
6190 (@code{gnus-article-strip-multiple-blank-lines}).
6192 @item W E t
6193 @kindex W E t (Summary)
6194 @findex gnus-article-remove-trailing-blank-lines
6195 Remove all blank lines at the end of the article
6196 (@code{gnus-article-remove-trailing-blank-lines}).
6198 @item W E a
6199 @kindex W E a (Summary)
6200 @findex gnus-article-strip-blank-lines
6201 Do all the three commands above
6202 (@code{gnus-article-strip-blank-lines}).
6204 @item W E A
6205 @kindex W E A (Summary)
6206 @findex gnus-article-strip-all-blank-lines
6207 Remove all blank lines
6208 (@code{gnus-article-strip-all-blank-lines}).
6210 @item W E s
6211 @kindex W E s (Summary)
6212 @findex gnus-article-strip-leading-space
6213 Remove all white space from the beginning of all lines of the article
6214 body (@code{gnus-article-strip-leading-space}).
6216 @end table
6218 @xref{Customizing Articles}, for how to wash articles automatically.
6221 @node Article Buttons
6222 @subsection Article Buttons
6223 @cindex buttons
6225 People often include references to other stuff in articles, and it would
6226 be nice if Gnus could just fetch whatever it is that people talk about
6227 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6228 button on these references.
6230 Gnus adds @dfn{buttons} to certain standard references by default:
6231 Well-formed URLs, mail addresses and Message-IDs.  This is controlled by
6232 two variables, one that handles article bodies and one that handles
6233 article heads:
6235 @table @code
6237 @item gnus-button-alist
6238 @vindex gnus-button-alist
6239 This is an alist where each entry has this form:
6241 @lisp
6242 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6243 @end lisp
6245 @table @var
6247 @item regexp
6248 All text that match this regular expression will be considered an
6249 external reference.  Here's a typical regexp that matches embedded URLs:
6250 @samp{<URL:\\([^\n\r>]*\\)>}.
6252 @item button-par
6253 Gnus has to know which parts of the matches is to be highlighted.  This
6254 is a number that says what sub-expression of the regexp is to be
6255 highlighted.  If you want it all highlighted, you use 0 here.
6257 @item use-p
6258 This form will be @code{eval}ed, and if the result is non-@code{nil},
6259 this is considered a match.  This is useful if you want extra sifting to
6260 avoid false matches.
6262 @item function
6263 This function will be called when you click on this button.
6265 @item data-par
6266 As with @var{button-par}, this is a sub-expression number, but this one
6267 says which part of the match is to be sent as data to @var{function}.
6269 @end table
6271 So the full entry for buttonizing URLs is then
6273 @lisp
6274 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6275 @end lisp
6277 @item gnus-header-button-alist
6278 @vindex gnus-header-button-alist
6279 This is just like the other alist, except that it is applied to the
6280 article head only, and that each entry has an additional element that is
6281 used to say what headers to apply the buttonize coding to:
6283 @lisp
6284 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6285 @end lisp
6287 @var{HEADER} is a regular expression.
6289 @item gnus-button-url-regexp
6290 @vindex gnus-button-url-regexp
6291 A regular expression that matches embedded URLs.  It is used in the
6292 default values of the variables above.
6294 @item gnus-article-button-face
6295 @vindex gnus-article-button-face
6296 Face used on buttons.
6298 @item gnus-article-mouse-face
6299 @vindex gnus-article-mouse-face
6300 Face used when the mouse cursor is over a button.
6302 @end table
6304 @xref{Customizing Articles}, for how to buttonize articles automatically.
6307 @node Article Date
6308 @subsection Article Date
6310 The date is most likely generated in some obscure timezone you've never
6311 heard of, so it's quite nice to be able to find out what the time was
6312 when the article was sent.
6314 @table @kbd
6316 @item W T u
6317 @kindex W T u (Summary)
6318 @findex gnus-article-date-ut
6319 Display the date in UT (aka. GMT, aka ZULU)
6320 (@code{gnus-article-date-ut}).
6322 @item W T i
6323 @kindex W T i (Summary)
6324 @findex gnus-article-date-iso8601
6325 @cindex ISO 8601
6326 Display the date in international format, aka. ISO 8601
6327 (@code{gnus-article-date-iso8601}).
6329 @item W T l
6330 @kindex W T l (Summary)
6331 @findex gnus-article-date-local
6332 Display the date in the local timezone (@code{gnus-article-date-local}).
6334 @item W T s
6335 @kindex W T s (Summary)
6336 @vindex gnus-article-time-format
6337 @findex gnus-article-date-user
6338 @findex format-time-string
6339 Display the date using a user-defined format
6340 (@code{gnus-article-date-user}).  The format is specified by the
6341 @code{gnus-article-time-format} variable, and is a string that's passed
6342 to @code{format-time-string}.  See the documentation of that variable
6343 for a list of possible format specs.
6345 @item W T e
6346 @kindex W T e (Summary)
6347 @findex gnus-article-date-lapsed
6348 @findex gnus-start-date-timer
6349 @findex gnus-stop-date-timer
6350 Say how much time has elapsed between the article was posted and now
6351 (@code{gnus-article-date-lapsed}).  If you want to have this line
6352 updated continually, you can put
6354 @lisp
6355 (gnus-start-date-timer)
6356 @end lisp
6358 in your @file{.gnus.el} file, or you can run it off of some hook.  If
6359 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
6360 command.
6362 @item W T o
6363 @kindex W T o (Summary)
6364 @findex gnus-article-date-original
6365 Display the original date (@code{gnus-article-date-original}).  This can
6366 be useful if you normally use some other conversion function and are
6367 worried that it might be doing something totally wrong.  Say, claiming
6368 that the article was posted in 1854.  Although something like that is
6369 @emph{totally} impossible.  Don't you trust me? *titter*
6371 @end table
6373 @xref{Customizing Articles}, for how to display the date in your
6374 preferred format automatically.
6377 @node Article Signature
6378 @subsection Article Signature
6379 @cindex signatures
6380 @cindex article signature
6382 @vindex gnus-signature-separator
6383 Each article is divided into two parts---the head and the body.  The
6384 body can be divided into a signature part and a text part.  The variable
6385 that says what is to be considered a signature is
6386 @code{gnus-signature-separator}.  This is normally the standard
6387 @samp{^-- $} as mandated by son-of-RFC 1036.  However, many people use
6388 non-standard signature separators, so this variable can also be a list
6389 of regular expressions to be tested, one by one.  (Searches are done
6390 from the end of the body towards the beginning.)  One likely value is:
6392 @lisp
6393 (setq gnus-signature-separator
6394       '("^-- $"         ; The standard
6395         "^-- *$"        ; A common mangling
6396         "^-------*$"    ; Many people just use a looong
6397                         ; line of dashes.  Shame!
6398         "^ *--------*$" ; Double-shame!
6399         "^________*$"   ; Underscores are also popular
6400         "^========*$")) ; Pervert!
6401 @end lisp
6403 The more permissive you are, the more likely it is that you'll get false
6404 positives.
6406 @vindex gnus-signature-limit
6407 @code{gnus-signature-limit} provides a limit to what is considered a
6408 signature.
6410 @enumerate
6411 @item
6412 If it is an integer, no signature may be longer (in characters) than
6413 that integer.
6414 @item
6415 If it is a floating point number, no signature may be longer (in lines)
6416 than that number.
6417 @item
6418 If it is a function, the function will be called without any parameters,
6419 and if it returns @code{nil}, there is no signature in the buffer.
6420 @item
6421 If it is a string, it will be used as a regexp.  If it matches, the text
6422 in question is not a signature.
6423 @end enumerate
6425 This variable can also be a list where the elements may be of the types
6426 listed above.  Here's an example:
6428 @lisp
6429 (setq gnus-signature-limit
6430       '(200.0 "^---*Forwarded article"))
6431 @end lisp
6433 This means that if there are more than 200 lines after the signature
6434 separator, or the text after the signature separator is matched by
6435 the regular expression @samp{^---*Forwarded article}, then it isn't a
6436 signature after all.
6439 @node Article Commands
6440 @section Article Commands
6442 @table @kbd
6444 @item A P
6445 @cindex PostScript
6446 @cindex printing
6447 @kindex A P (Summary)
6448 @vindex gnus-ps-print-hook
6449 @findex gnus-summary-print-article
6450 Generate and print a PostScript image of the article buffer
6451 (@code{gnus-summary-print-article}).  @code{gnus-ps-print-hook} will be
6452 run just before printing the buffer.
6454 @end table
6457 @node Summary Sorting
6458 @section Summary Sorting
6459 @cindex summary sorting
6461 You can have the summary buffer sorted in various ways, even though I
6462 can't really see why you'd want that.
6464 @table @kbd
6466 @item C-c C-s C-n
6467 @kindex C-c C-s C-n (Summary)
6468 @findex gnus-summary-sort-by-number
6469 Sort by article number (@code{gnus-summary-sort-by-number}).
6471 @item C-c C-s C-a
6472 @kindex C-c C-s C-a (Summary)
6473 @findex gnus-summary-sort-by-author
6474 Sort by author (@code{gnus-summary-sort-by-author}).
6476 @item C-c C-s C-s
6477 @kindex C-c C-s C-s (Summary)
6478 @findex gnus-summary-sort-by-subject
6479 Sort by subject (@code{gnus-summary-sort-by-subject}).
6481 @item C-c C-s C-d
6482 @kindex C-c C-s C-d (Summary)
6483 @findex gnus-summary-sort-by-date
6484 Sort by date (@code{gnus-summary-sort-by-date}).
6486 @item C-c C-s C-l
6487 @kindex C-c C-s C-l (Summary)
6488 @findex gnus-summary-sort-by-lines
6489 Sort by lines (@code{gnus-summary-sort-by-lines}).
6491 @item C-c C-s C-i
6492 @kindex C-c C-s C-i (Summary)
6493 @findex gnus-summary-sort-by-score
6494 Sort by score (@code{gnus-summary-sort-by-score}).
6495 @end table
6497 These functions will work both when you use threading and when you don't
6498 use threading.  In the latter case, all summary lines will be sorted,
6499 line by line.  In the former case, sorting will be done on a
6500 root-by-root basis, which might not be what you were looking for.  To
6501 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6502 Commands}).
6505 @node Finding the Parent
6506 @section Finding the Parent
6507 @cindex parent articles
6508 @cindex referring articles
6510 @table @kbd
6511 @item ^
6512 @kindex ^ (Summary)
6513 @findex gnus-summary-refer-parent-article
6514 If you'd like to read the parent of the current article, and it is not
6515 displayed in the summary buffer, you might still be able to.  That is,
6516 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6517 and the @code{References} in the current article are not mangled, you
6518 can just press @kbd{^} or @kbd{A r}
6519 (@code{gnus-summary-refer-parent-article}).  If everything goes well,
6520 you'll get the parent.  If the parent is already displayed in the
6521 summary buffer, point will just move to this article.
6523 If given a positive numerical prefix, fetch that many articles back into
6524 the ancestry.  If given a negative numerical prefix, fetch just that
6525 ancestor.  So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6526 grandparent and the grandgrandparent of the current article.  If you say
6527 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6528 article.
6530 @item A R (Summary)
6531 @findex gnus-summary-refer-references
6532 @kindex A R (Summary)
6533 Fetch all articles mentioned in the @code{References} header of the
6534 article (@code{gnus-summary-refer-references}).
6536 @item A T (Summary)
6537 @findex gnus-summary-refer-thread
6538 @kindex A T (Summary)
6539 Display the full thread where the current article appears
6540 (@code{gnus-summary-refer-thread}).  This command has to fetch all the
6541 headers in the current group to work, so it usually takes a while.  If
6542 you do it often, you may consider setting @code{gnus-fetch-old-headers}
6543 to @code{invisible} (@pxref{Filling In Threads}).  This won't have any
6544 visible effects normally, but it'll make this command work a whole lot
6545 faster.  Of course, it'll make group entry somewhat slow.
6547 @vindex gnus-refer-thread-limit
6548 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
6549 articles before the first displayed in the current group) headers to
6550 fetch when doing this command.  The default is 200.  If @code{t}, all
6551 the available headers will be fetched.  This variable can be overridden
6552 by giving the @kbd{A T} command a numerical prefix.
6554 @item M-^ (Summary)
6555 @findex gnus-summary-refer-article
6556 @kindex M-^ (Summary)
6557 @cindex Message-ID
6558 @cindex fetching by Message-ID
6559 You can also ask the @sc{nntp} server for an arbitrary article, no
6560 matter what group it belongs to.  @kbd{M-^}
6561 (@code{gnus-summary-refer-article}) will ask you for a
6562 @code{Message-ID}, which is one of those long, hard-to-read thingies
6563 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.  You
6564 have to get it all exactly right.  No fuzzy searches, I'm afraid.
6565 @end table
6567 The current select method will be used when fetching by
6568 @code{Message-ID} from non-news select method, but you can override this
6569 by giving this command a prefix.
6571 @vindex gnus-refer-article-method
6572 If the group you are reading is located on a backend that does not
6573 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6574 you can set @code{gnus-refer-article-method} to an @sc{nntp} method.  It
6575 would, perhaps, be best if the @sc{nntp} server you consult is the one
6576 updating the spool you are reading from, but that's not really
6577 necessary.
6579 Most of the mail backends support fetching by @code{Message-ID}, but do
6580 not do a particularly excellent job at it.  That is, @code{nnmbox} and
6581 @code{nnbabyl} are able to locate articles from any groups, while
6582 @code{nnml} and @code{nnfolder} are only able to locate articles that
6583 have been posted to the current group.  (Anything else would be too time
6584 consuming.)  @code{nnmh} does not support this at all.
6587 @node Alternative Approaches
6588 @section Alternative Approaches
6590 Different people like to read news using different methods.  This being
6591 Gnus, we offer a small selection of minor modes for the summary buffers.
6593 @menu
6594 * Pick and Read::               First mark articles and then read them.
6595 * Binary Groups::               Auto-decode all articles.
6596 @end menu
6599 @node Pick and Read
6600 @subsection Pick and Read
6601 @cindex pick and read
6603 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
6604 a two-phased reading interface.  The user first marks in a summary
6605 buffer the articles she wants to read.  Then she starts reading the
6606 articles with just an article buffer displayed.
6608 @findex gnus-pick-mode
6609 @kindex M-x gnus-pick-mode
6610 Gnus provides a summary buffer minor mode that allows
6611 this---@code{gnus-pick-mode}.  This basically means that a few process
6612 mark commands become one-keystroke commands to allow easy marking, and
6613 it provides one additional command for switching to the summary buffer.
6615 Here are the available keystrokes when using pick mode:
6617 @table @kbd
6618 @item .
6619 @kindex . (Pick)
6620 @findex gnus-pick-article-or-thread
6621 Pick the article or thread on the current line
6622 (@code{gnus-pick-article-or-thread}).  If the variable
6623 @code{gnus-thread-hide-subtree} is true, then this key selects the
6624 entire thread when used at the first article of the thread.  Otherwise,
6625 it selects just the article. If given a numerical prefix, go to that
6626 thread or article and pick it.  (The line number is normally displayed
6627 at the beginning of the summary pick lines.)
6629 @item SPACE
6630 @kindex SPACE (Pick)
6631 @findex gnus-pick-next-page
6632 Scroll the summary buffer up one page (@code{gnus-pick-next-page}).  If
6633 at the end of the buffer, start reading the picked articles.
6635 @item u
6636 @kindex u (Pick)
6637 @findex gnus-pick-unmark-article-or-thread.
6638 Unpick the thread or article
6639 (@code{gnus-pick-unmark-article-or-thread}).  If the variable
6640 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
6641 thread if used at the first article of the thread.  Otherwise it unpicks 
6642 just the article.  You can give this key a numerical prefix to unpick
6643 the thread or article at that line.
6645 @item RET
6646 @kindex RET (Pick)
6647 @findex gnus-pick-start-reading
6648 @vindex gnus-pick-display-summary
6649 Start reading the picked articles (@code{gnus-pick-start-reading}).  If
6650 given a prefix, mark all unpicked articles as read first.  If
6651 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6652 will still be visible when you are reading.
6654 @end table
6656 All the normal summary mode commands are still available in the
6657 pick-mode, with the exception of @kbd{u}.  However @kbd{!} is available
6658 which is mapped to the same function
6659 @code{gnus-summary-tick-article-forward}.
6661 If this sounds like a good idea to you, you could say:
6663 @lisp
6664 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6665 @end lisp
6667 @vindex gnus-pick-mode-hook
6668 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6670 @vindex gnus-mark-unpicked-articles-as-read
6671 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6672 all unpicked articles as read.  The default is @code{nil}.
6674 @vindex gnus-summary-pick-line-format
6675 The summary line format in pick mode is slightly different from the
6676 standard format.  At the beginning of each line the line number is
6677 displayed.  The pick mode line format is controlled by the
6678 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
6679 Variables}).  It accepts the same format specs that
6680 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
6683 @node Binary Groups
6684 @subsection Binary Groups
6685 @cindex binary groups
6687 @findex gnus-binary-mode
6688 @kindex M-x gnus-binary-mode
6689 If you spend much time in binary groups, you may grow tired of hitting
6690 @kbd{X u}, @kbd{n}, @kbd{RET} all the time.  @kbd{M-x gnus-binary-mode}
6691 is a minor mode for summary buffers that makes all ordinary Gnus article
6692 selection functions uudecode series of articles and display the result
6693 instead of just displaying the articles the normal way.
6695 @kindex g (Binary)
6696 @findex gnus-binary-show-article
6697 The only way, in fact, to see the actual articles is the @kbd{g}
6698 command, when you have turned on this mode
6699 (@code{gnus-binary-show-article}).
6701 @vindex gnus-binary-mode-hook
6702 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
6705 @node Tree Display
6706 @section Tree Display
6707 @cindex trees
6709 @vindex gnus-use-trees
6710 If you don't like the normal Gnus summary display, you might try setting
6711 @code{gnus-use-trees} to @code{t}.  This will create (by default) an
6712 additional @dfn{tree buffer}.  You can execute all summary mode commands
6713 in the tree buffer.
6715 There are a few variables to customize the tree display, of course:
6717 @table @code
6718 @item gnus-tree-mode-hook
6719 @vindex gnus-tree-mode-hook
6720 A hook called in all tree mode buffers.
6722 @item gnus-tree-mode-line-format
6723 @vindex gnus-tree-mode-line-format
6724 A format string for the mode bar in the tree mode buffers (@pxref{Mode
6725 Line Formatting}).  The default is @samp{Gnus: %%b %S %Z}.  For a list
6726 of valid specs, @pxref{Summary Buffer Mode Line}.
6728 @item gnus-selected-tree-face
6729 @vindex gnus-selected-tree-face
6730 Face used for highlighting the selected article in the tree buffer.  The
6731 default is @code{modeline}.
6733 @item gnus-tree-line-format
6734 @vindex gnus-tree-line-format
6735 A format string for the tree nodes.  The name is a bit of a misnomer,
6736 though---it doesn't define a line, but just the node.  The default value
6737 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
6738 the name of the poster.  It is vital that all nodes are of the same
6739 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
6741 Valid specs are:
6743 @table @samp
6744 @item n
6745 The name of the poster.
6746 @item f
6747 The @code{From} header.
6748 @item N
6749 The number of the article.
6750 @item [
6751 The opening bracket.
6752 @item ]
6753 The closing bracket.
6754 @item s
6755 The subject.
6756 @end table
6758 @xref{Formatting Variables}.
6760 Variables related to the display are:
6762 @table @code
6763 @item gnus-tree-brackets
6764 @vindex gnus-tree-brackets
6765 This is used for differentiating between ``real'' articles and
6766 ``sparse'' articles.  The format is @code{((@var{real-open} . @var{real-close})
6767 (@var{sparse-open} . @var{sparse-close}) (@var{dummy-open} . @var{dummy-close}))}, and the
6768 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
6770 @item gnus-tree-parent-child-edges
6771 @vindex gnus-tree-parent-child-edges
6772 This is a list that contains the characters used for connecting parent
6773 nodes to their children.  The default is @code{(?- ?\\ ?|)}.
6775 @end table
6777 @item gnus-tree-minimize-window
6778 @vindex gnus-tree-minimize-window
6779 If this variable is non-@code{nil}, Gnus will try to keep the tree
6780 buffer as small as possible to allow more room for the other Gnus
6781 windows.  If this variable is a number, the tree buffer will never be
6782 higher than that number.  The default is @code{t}.  Note that if you
6783 have several windows displayed side-by-side in a frame and the tree
6784 buffer is one of these, minimizing the tree window will also resize all
6785 other windows displayed next to it.
6787 @item gnus-generate-tree-function
6788 @vindex gnus-generate-tree-function
6789 @findex gnus-generate-horizontal-tree
6790 @findex gnus-generate-vertical-tree
6791 The function that actually generates the thread tree.  Two predefined
6792 functions are available: @code{gnus-generate-horizontal-tree} and
6793 @code{gnus-generate-vertical-tree} (which is the default).
6795 @end table
6797 Here's an example from a horizontal tree buffer:
6799 @example
6800 @{***@}-(***)-[odd]-[Gun]
6801      |      \[Jan]
6802      |      \[odd]-[Eri]
6803      |      \(***)-[Eri]
6804      |            \[odd]-[Paa]
6805      \[Bjo]
6806      \[Gun]
6807      \[Gun]-[Jor]
6808 @end example
6810 Here's the same thread displayed in a vertical tree buffer:
6812 @example
6813 @{***@}
6814   |--------------------------\-----\-----\
6815 (***)                         [Bjo] [Gun] [Gun]
6816   |--\-----\-----\                          |
6817 [odd] [Jan] [odd] (***)                   [Jor]
6818   |           |     |--\
6819 [Gun]       [Eri] [Eri] [odd]
6820                           |
6821                         [Paa]
6822 @end example
6824 If you're using horizontal trees, it might be nice to display the trees
6825 side-by-side with the summary buffer.  You could add something like the
6826 following to your @file{.gnus.el} file:
6828 @lisp
6829 (setq gnus-use-trees t
6830       gnus-generate-tree-function 'gnus-generate-horizontal-tree
6831       gnus-tree-minimize-window nil)
6832 (gnus-add-configuration
6833  '(article
6834    (vertical 1.0
6835              (horizontal 0.25
6836                          (summary 0.75 point)
6837                          (tree 1.0))
6838              (article 1.0))))
6839 @end lisp
6841 @xref{Windows Configuration}.
6844 @node Mail Group Commands
6845 @section Mail Group Commands
6846 @cindex mail group commands
6848 Some commands only make sense in mail groups.  If these commands are
6849 invalid in the current group, they will raise a hell and let you know.
6851 All these commands (except the expiry and edit commands) use the
6852 process/prefix convention (@pxref{Process/Prefix}).
6854 @table @kbd
6856 @item B e
6857 @kindex B e (Summary)
6858 @findex gnus-summary-expire-articles
6859 Expire all expirable articles in the group
6860 (@code{gnus-summary-expire-articles}).
6862 @item B M-C-e
6863 @kindex B M-C-e (Summary)
6864 @findex gnus-summary-expire-articles-now
6865 Delete all the expirable articles in the group
6866 (@code{gnus-summary-expire-articles-now}).  This means that @strong{all}
6867 articles eligible for expiry in the current group will
6868 disappear forever into that big @file{/dev/null} in the sky.
6870 @item B DEL
6871 @kindex B DEL (Summary)
6872 @findex gnus-summary-delete-article
6873 @c @icon{gnus-summary-mail-delete}
6874 Delete the mail article.  This is ``delete'' as in ``delete it from your
6875 disk forever and ever, never to return again.'' Use with caution.
6876 (@code{gnus-summary-delete-article}).
6878 @item B m
6879 @kindex B m (Summary)
6880 @cindex move mail
6881 @findex gnus-summary-move-article
6882 Move the article from one mail group to another
6883 (@code{gnus-summary-move-article}).
6885 @item B c
6886 @kindex B c (Summary)
6887 @cindex copy mail
6888 @findex gnus-summary-copy-article
6889 @c @icon{gnus-summary-mail-copy}
6890 Copy the article from one group (mail group or not) to a mail group
6891 (@code{gnus-summary-copy-article}).
6893 @item B B
6894 @kindex B B (Summary)
6895 @cindex crosspost mail
6896 @findex gnus-summary-crosspost-article
6897 Crosspost the current article to some other group
6898 (@code{gnus-summary-crosspost-article}).  This will create a new copy of
6899 the article in the other group, and the Xref headers of the article will
6900 be properly updated.
6902 @item B i
6903 @kindex B i (Summary)
6904 @findex gnus-summary-import-article
6905 Import an arbitrary file into the current mail newsgroup
6906 (@code{gnus-summary-import-article}).  You will be prompted for a file
6907 name, a @code{From} header and a @code{Subject} header.
6909 @item B r
6910 @kindex B r (Summary)
6911 @findex gnus-summary-respool-article
6912 Respool the mail article (@code{gnus-summary-respool-article}).
6913 @code{gnus-summary-respool-default-method} will be used as the default
6914 select method when respooling.  This variable is @code{nil} by default,
6915 which means that the current group select method will be used instead.
6917 @item B w
6918 @itemx e
6919 @kindex B w (Summary)
6920 @kindex e (Summary)
6921 @findex gnus-summary-edit-article
6922 @kindex C-c C-c (Article)
6923 Edit the current article (@code{gnus-summary-edit-article}).  To finish
6924 editing and make the changes permanent, type @kbd{C-c C-c}
6925 (@kbd{gnus-summary-edit-article-done}).  If you give a prefix to the
6926 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
6928 @item B q
6929 @kindex B q (Summary)
6930 @findex gnus-summary-respool-query
6931 If you want to re-spool an article, you might be curious as to what group
6932 the article will end up in before you do the re-spooling.  This command
6933 will tell you (@code{gnus-summary-respool-query}).
6935 @item B t
6936 @kindex B t (Summary)
6937 @findex gnus-summary-respool-trace
6938 Similarly, this command will display all fancy splitting patterns used
6939 when repooling, if any (@code{gnus-summary-respool-trace}).
6941 @item B p
6942 @kindex B p (Summary)
6943 @findex gnus-summary-article-posted-p
6944 Some people have a tendency to send you "courtesy" copies when they
6945 follow up to articles you have posted.  These usually have a
6946 @code{Newsgroups} header in them, but not always.  This command
6947 (@code{gnus-summary-article-posted-p}) will try to fetch the current
6948 article from your news server (or rather, from
6949 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
6950 report back whether it found the article or not.  Even if it says that
6951 it didn't find the article, it may have been posted anyway---mail
6952 propagation is much faster than news propagation, and the news copy may
6953 just not have arrived yet.
6955 @end table
6957 @vindex gnus-move-split-methods
6958 @cindex moving articles
6959 If you move (or copy) articles regularly, you might wish to have Gnus
6960 suggest where to put the articles.  @code{gnus-move-split-methods} is a
6961 variable that uses the same syntax as @code{gnus-split-methods}
6962 (@pxref{Saving Articles}).  You may customize that variable to create
6963 suggestions you find reasonable.
6965 @lisp
6966 (setq gnus-move-split-methods
6967       '(("^From:.*Lars Magne" "nnml:junk")
6968         ("^Subject:.*gnus" "nnfolder:important")
6969         (".*" "nnml:misc")))
6970 @end lisp
6973 @node Various Summary Stuff
6974 @section Various Summary Stuff
6976 @menu
6977 * Summary Group Information::         Information oriented commands.
6978 * Searching for Articles::            Multiple article commands.
6979 * Summary Generation Commands::       (Re)generating the summary buffer.
6980 * Really Various Summary Commands::   Those pesky non-conformant commands.
6981 @end menu
6983 @table @code
6984 @vindex gnus-summary-mode-hook
6985 @item gnus-summary-mode-hook
6986 This hook is called when creating a summary mode buffer.
6988 @vindex gnus-summary-generate-hook
6989 @item gnus-summary-generate-hook
6990 This is called as the last thing before doing the threading and the
6991 generation of the summary buffer.  It's quite convenient for customizing
6992 the threading variables based on what data the newsgroup has.  This hook
6993 is called from the summary buffer after most summary buffer variables
6994 have been set.
6996 @vindex gnus-summary-prepare-hook
6997 @item gnus-summary-prepare-hook
6998 It is called after the summary buffer has been generated.  You might use
6999 it to, for instance, highlight lines or modify the look of the buffer in
7000 some other ungodly manner.  I don't care.
7002 @vindex gnus-summary-ignore-duplicates
7003 @item gnus-summary-ignore-duplicates
7004 When Gnus discovers two articles that have the same @code{Message-ID},
7005 it has to do something drastic.  No articles are allowed to have the
7006 same @code{Message-ID}, but this may happen when reading mail from some
7007 sources.  Gnus allows you to customize what happens with this variable.
7008 If it is @code{nil} (which is the default), Gnus will rename the
7009 @code{Message-ID} (for display purposes only) and display the article as
7010 any other article.  If this variable is @code{t}, it won't display the
7011 article---it'll be as if it never existed.
7013 @end table
7016 @node Summary Group Information
7017 @subsection Summary Group Information
7019 @table @kbd
7021 @item H f
7022 @kindex H f (Summary)
7023 @findex gnus-summary-fetch-faq
7024 @vindex gnus-group-faq-directory
7025 Try to fetch the FAQ (list of frequently asked questions) for the
7026 current group (@code{gnus-summary-fetch-faq}).  Gnus will try to get the
7027 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7028 on a remote machine.  This variable can also be a list of directories.
7029 In that case, giving a prefix to this command will allow you to choose
7030 between the various sites.  @code{ange-ftp} or @code{efs} will probably
7031 be used for fetching the file.
7033 @item H d
7034 @kindex H d (Summary)
7035 @findex gnus-summary-describe-group
7036 Give a brief description of the current group
7037 (@code{gnus-summary-describe-group}).  If given a prefix, force
7038 rereading the description from the server.
7040 @item H h
7041 @kindex H h (Summary)
7042 @findex gnus-summary-describe-briefly
7043 Give an extremely brief description of the most important summary
7044 keystrokes (@code{gnus-summary-describe-briefly}).
7046 @item H i
7047 @kindex H i (Summary)
7048 @findex gnus-info-find-node
7049 Go to the Gnus info node (@code{gnus-info-find-node}).
7050 @end table
7053 @node Searching for Articles
7054 @subsection Searching for Articles
7056 @table @kbd
7058 @item M-s
7059 @kindex M-s (Summary)
7060 @findex gnus-summary-search-article-forward
7061 Search through all subsequent articles for a regexp
7062 (@code{gnus-summary-search-article-forward}).
7064 @item M-r
7065 @kindex M-r (Summary)
7066 @findex gnus-summary-search-article-backward
7067 Search through all previous articles for a regexp
7068 (@code{gnus-summary-search-article-backward}).
7070 @item &
7071 @kindex & (Summary)
7072 @findex gnus-summary-execute-command
7073 This command will prompt you for a header field, a regular expression to
7074 match on this field, and a command to be executed if the match is made
7075 (@code{gnus-summary-execute-command}).  If given a prefix, search
7076 backward instead.
7078 @item M-&
7079 @kindex M-& (Summary)
7080 @findex gnus-summary-universal-argument
7081 Perform any operation on all articles that have been marked with
7082 the process mark (@code{gnus-summary-universal-argument}).
7083 @end table
7085 @node Summary Generation Commands
7086 @subsection Summary Generation Commands
7088 @table @kbd
7090 @item Y g
7091 @kindex Y g (Summary)
7092 @findex gnus-summary-prepare
7093 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7095 @item Y c
7096 @kindex Y c (Summary)
7097 @findex gnus-summary-insert-cached-articles
7098 Pull all cached articles (for the current group) into the summary buffer
7099 (@code{gnus-summary-insert-cached-articles}).
7101 @end table
7104 @node Really Various Summary Commands
7105 @subsection Really Various Summary Commands
7107 @table @kbd
7109 @item C-d
7110 @kindex C-d (Summary)
7111 @findex gnus-summary-enter-digest-group
7112 If the current article is a collection of other articles (for instance,
7113 a digest), you might use this command to enter a group based on the that
7114 article (@code{gnus-summary-enter-digest-group}).  Gnus will try to
7115 guess what article type is currently displayed unless you give a prefix
7116 to this command, which forces a ``digest'' interpretation.  Basically,
7117 whenever you see a message that is a collection of other messages of
7118 some format, you @kbd{C-d} and read these messages in a more convenient
7119 fashion.
7121 @item M-C-d
7122 @kindex M-C-d (Summary)
7123 @findex gnus-summary-read-document
7124 This command is very similar to the one above, but lets you gather
7125 several documents into one biiig group
7126 (@code{gnus-summary-read-document}).  It does this by opening several
7127 @code{nndoc} groups for each document, and then opening an
7128 @code{nnvirtual} group on top of these @code{nndoc} groups.  This
7129 command understands the process/prefix convention
7130 (@pxref{Process/Prefix}).
7132 @item C-t
7133 @kindex C-t (Summary)
7134 @findex gnus-summary-toggle-truncation
7135 Toggle truncation of summary lines
7136 (@code{gnus-summary-toggle-truncation}).  This will probably confuse the
7137 line centering function in the summary buffer, so it's not a good idea
7138 to have truncation switched off while reading articles.
7140 @item =
7141 @kindex = (Summary)
7142 @findex gnus-summary-expand-window
7143 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7144 If given a prefix, force an @code{article} window configuration.
7146 @item M-C-e
7147 @kindex M-C-e (Summary)
7148 @findex gnus-summary-edit-parameters
7149 Edit the group parameters (@pxref{Group Parameters}) of the current
7150 group (@code{gnus-summary-edit-parameters}).
7152 @end table
7155 @node Exiting the Summary Buffer
7156 @section Exiting the Summary Buffer
7157 @cindex summary exit
7158 @cindex exiting groups
7160 Exiting from the summary buffer will normally update all info on the
7161 group and return you to the group buffer.
7163 @table @kbd
7165 @item Z Z
7166 @itemx q
7167 @kindex Z Z (Summary)
7168 @kindex q (Summary)
7169 @findex gnus-summary-exit
7170 @vindex gnus-summary-exit-hook
7171 @vindex gnus-summary-prepare-exit-hook
7172 @c @icon{gnus-summary-exit}
7173 Exit the current group and update all information on the group
7174 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7175 called before doing much of the exiting, which calls
7176 @code{gnus-summary-expire-articles} by default.
7177 @code{gnus-summary-exit-hook} is called after finishing the exit
7178 process.  @code{gnus-group-no-more-groups-hook} is run when returning to
7179 group mode having no more (unread) groups.
7181 @item Z E
7182 @itemx Q
7183 @kindex Z E (Summary)
7184 @kindex Q (Summary)
7185 @findex gnus-summary-exit-no-update
7186 Exit the current group without updating any information on the group
7187 (@code{gnus-summary-exit-no-update}).
7189 @item Z c
7190 @itemx c
7191 @kindex Z c (Summary)
7192 @kindex c (Summary)
7193 @findex gnus-summary-catchup-and-exit
7194 @c @icon{gnus-summary-catchup-and-exit}
7195 Mark all unticked articles in the group as read and then exit
7196 (@code{gnus-summary-catchup-and-exit}).
7198 @item Z C
7199 @kindex Z C (Summary)
7200 @findex gnus-summary-catchup-all-and-exit
7201 Mark all articles, even the ticked ones, as read and then exit
7202 (@code{gnus-summary-catchup-all-and-exit}).
7204 @item Z n
7205 @kindex Z n (Summary)
7206 @findex gnus-summary-catchup-and-goto-next-group
7207 Mark all articles as read and go to the next group
7208 (@code{gnus-summary-catchup-and-goto-next-group}).
7210 @item Z R
7211 @kindex Z R (Summary)
7212 @findex gnus-summary-reselect-current-group
7213 Exit this group, and then enter it again
7214 (@code{gnus-summary-reselect-current-group}).  If given a prefix, select
7215 all articles, both read and unread.
7217 @item Z G
7218 @itemx M-g
7219 @kindex Z G (Summary)
7220 @kindex M-g (Summary)
7221 @findex gnus-summary-rescan-group
7222 @c @icon{gnus-summary-mail-get}
7223 Exit the group, check for new articles in the group, and select the
7224 group (@code{gnus-summary-rescan-group}).  If given a prefix, select all
7225 articles, both read and unread.
7227 @item Z N
7228 @kindex Z N (Summary)
7229 @findex gnus-summary-next-group
7230 Exit the group and go to the next group
7231 (@code{gnus-summary-next-group}).
7233 @item Z P
7234 @kindex Z P (Summary)
7235 @findex gnus-summary-prev-group
7236 Exit the group and go to the previous group
7237 (@code{gnus-summary-prev-group}).
7239 @item Z s
7240 @kindex Z s (Summary)
7241 @findex gnus-summary-save-newsrc
7242 Save the current number of read/marked articles in the dribble buffer
7243 and then save the dribble buffer (@code{gnus-summary-save-newsrc}).  If
7244 given a prefix, also save the @file{.newsrc} file(s).  Using this
7245 command will make exit without updating (the @kbd{Q} command) worthless.
7246 @end table
7248 @vindex gnus-exit-group-hook
7249 @code{gnus-exit-group-hook} is called when you exit the current
7250 group.
7252 @findex gnus-summary-wake-up-the-dead
7253 @findex gnus-dead-summary-mode
7254 @vindex gnus-kill-summary-on-exit
7255 If you're in the habit of exiting groups, and then changing your mind
7256 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
7257 If you do that, Gnus won't kill the summary buffer when you exit it.
7258 (Quelle surprise!)  Instead it will change the name of the buffer to
7259 something like @samp{*Dead Summary ... *} and install a minor mode
7260 called @code{gnus-dead-summary-mode}.  Now, if you switch back to this
7261 buffer, you'll find that all keys are mapped to a function called
7262 @code{gnus-summary-wake-up-the-dead}.  So tapping any keys in a dead
7263 summary buffer will result in a live, normal summary buffer.
7265 There will never be more than one dead summary buffer at any one time.
7267 @vindex gnus-use-cross-reference
7268 The data on the current group will be updated (which articles you have
7269 read, which articles you have replied to, etc.) when you exit the
7270 summary buffer.  If the @code{gnus-use-cross-reference} variable is
7271 @code{t} (which is the default), articles that are cross-referenced to
7272 this group and are marked as read, will also be marked as read in the
7273 other subscribed groups they were cross-posted to.  If this variable is
7274 neither @code{nil} nor @code{t}, the article will be marked as read in
7275 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7278 @node Crosspost Handling
7279 @section Crosspost Handling
7281 @cindex velveeta
7282 @cindex spamming
7283 Marking cross-posted articles as read ensures that you'll never have to
7284 read the same article more than once.  Unless, of course, somebody has
7285 posted it to several groups separately.  Posting the same article to
7286 several groups (not cross-posting) is called @dfn{spamming}, and you are
7287 by law required to send nasty-grams to anyone who perpetrates such a
7288 heinous crime.  You may want to try NoCeM handling to filter out spam
7289 (@pxref{NoCeM}).
7291 Remember: Cross-posting is kinda ok, but posting the same article
7292 separately to several groups is not.  Massive cross-posting (aka.
7293 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7294 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7295 excessive crossposting (@pxref{Summary Mail Commands}).
7297 @cindex cross-posting
7298 @cindex Xref
7299 @cindex @sc{nov}
7300 One thing that may cause Gnus to not do the cross-posting thing
7301 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7302 (which is very nice, because it speeds things up considerably) which
7303 does not include the @code{Xref} header in its @sc{nov} lines.  This is
7304 Evil, but all too common, alas, alack.  Gnus tries to Do The Right Thing
7305 even with @sc{xover} by registering the @code{Xref} lines of all
7306 articles you actually read, but if you kill the articles, or just mark
7307 them as read without reading them, Gnus will not get a chance to snoop
7308 the @code{Xref} lines out of these articles, and will be unable to use
7309 the cross reference mechanism.
7311 @cindex LIST overview.fmt
7312 @cindex overview.fmt
7313 To check whether your @sc{nntp} server includes the @code{Xref} header
7314 in its overview files, try @samp{telnet your.nntp.server nntp},
7315 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7316 overview.fmt}.  This may not work, but if it does, and the last line you
7317 get does not read @samp{Xref:full}, then you should shout and whine at
7318 your news admin until she includes the @code{Xref} header in the
7319 overview files.
7321 @vindex gnus-nov-is-evil
7322 If you want Gnus to get the @code{Xref}s right all the time, you have to
7323 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7324 considerably.
7326 C'est la vie.
7328 For an alternative approach, @pxref{Duplicate Suppression}.
7331 @node Duplicate Suppression
7332 @section Duplicate Suppression
7334 By default, Gnus tries to make sure that you don't have to read the same
7335 article more than once by utilizing the crossposting mechanism
7336 (@pxref{Crosspost Handling}).  However, that simple and efficient
7337 approach may not work satisfactory for some users for various
7338 reasons.
7340 @enumerate
7341 @item
7342 The @sc{nntp} server may fail to generate the @code{Xref} header.  This
7343 is evil and not very common.
7345 @item
7346 The @sc{nntp} server may fail to include the @code{Xref} header in the
7347 @file{.overview} data bases.  This is evil and all too common, alas.
7349 @item
7350 You may be reading the same group (or several related groups) from
7351 different @sc{nntp} servers.
7353 @item
7354 You may be getting mail that duplicates articles posted to groups.
7355 @end enumerate
7357 I'm sure there are other situations where @code{Xref} handling fails as
7358 well, but these four are the most common situations.
7360 If, and only if, @code{Xref} handling fails for you, then you may
7361 consider switching on @dfn{duplicate suppression}.  If you do so, Gnus
7362 will remember the @code{Message-ID}s of all articles you have read or
7363 otherwise marked as read, and then, as if by magic, mark them as read
7364 all subsequent times you see them---in @emph{all} groups.  Using this
7365 mechanism is quite likely to be somewhat inefficient, but not overly
7366 so.  It's certainly preferable to reading the same articles more than
7367 once.
7369 Duplicate suppression is not a very subtle instrument.  It's more like a
7370 sledge hammer than anything else.  It works in a very simple
7371 fashion---if you have marked an article as read, it adds this Message-ID
7372 to a cache.  The next time it sees this Message-ID, it will mark the
7373 article as read with the @samp{M} mark.  It doesn't care what group it
7374 saw the article in.
7376 @table @code
7377 @item gnus-suppress-duplicates
7378 @vindex gnus-suppress-duplicates
7379 If non-@code{nil}, suppress duplicates.
7381 @item gnus-save-duplicate-list
7382 @vindex gnus-save-duplicate-list
7383 If non-@code{nil}, save the list of duplicates to a file.  This will
7384 make startup and shutdown take longer, so the default is @code{nil}.
7385 However, this means that only duplicate articles read in a single Gnus
7386 session are suppressed.
7388 @item gnus-duplicate-list-length
7389 @vindex gnus-duplicate-list-length
7390 This variable says how many @code{Message-ID}s to keep in the duplicate
7391 suppression list.  The default is 10000.
7393 @item gnus-duplicate-file
7394 @vindex gnus-duplicate-file
7395 The name of the file to store the duplicate suppression list in.  The
7396 default is @file{~/News/suppression}.
7397 @end table
7399 If you have a tendency to stop and start Gnus often, setting
7400 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea.  If
7401 you leave Gnus running for weeks on end, you may have it @code{nil}.  On
7402 the other hand, saving the list makes startup and shutdown much slower,
7403 so that means that if you stop and start Gnus often, you should set
7404 @code{gnus-save-duplicate-list} to @code{nil}.  Uhm.  I'll leave this up
7405 to you to figure out, I think.
7408 @node The Article Buffer
7409 @chapter The Article Buffer
7410 @cindex article buffer
7412 The articles are displayed in the article buffer, of which there is only
7413 one.  All the summary buffers share the same article buffer unless you
7414 tell Gnus otherwise.
7416 @menu
7417 * Hiding Headers::        Deciding what headers should be displayed.
7418 * Using MIME::            Pushing articles through @sc{mime} before reading them.
7419 * Customizing Articles::  Tailoring the look of the articles.
7420 * Article Keymap::        Keystrokes available in the article buffer.
7421 * Misc Article::          Other stuff.
7422 @end menu
7425 @node Hiding Headers
7426 @section Hiding Headers
7427 @cindex hiding headers
7428 @cindex deleting headers
7430 The top section of each article is the @dfn{head}.  (The rest is the
7431 @dfn{body}, but you may have guessed that already.)
7433 @vindex gnus-show-all-headers
7434 There is a lot of useful information in the head: the name of the person
7435 who wrote the article, the date it was written and the subject of the
7436 article.  That's well and nice, but there's also lots of information
7437 most people do not want to see---what systems the article has passed
7438 through before reaching you, the @code{Message-ID}, the
7439 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7440 of some of those lines.  If you want to keep all those lines in the
7441 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7443 Gnus provides you with two variables for sifting headers:
7445 @table @code
7447 @item gnus-visible-headers
7448 @vindex gnus-visible-headers
7449 If this variable is non-@code{nil}, it should be a regular expression
7450 that says what headers you wish to keep in the article buffer.  All
7451 headers that do not match this variable will be hidden.
7453 For instance, if you only want to see the name of the person who wrote
7454 the article and the subject, you'd say:
7456 @lisp
7457 (setq gnus-visible-headers "^From:\\|^Subject:")
7458 @end lisp
7460 This variable can also be a list of regexps to match headers to
7461 remain visible.
7463 @item gnus-ignored-headers
7464 @vindex gnus-ignored-headers
7465 This variable is the reverse of @code{gnus-visible-headers}.  If this
7466 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7467 should be a regular expression that matches all lines that you want to
7468 hide.  All lines that do not match this variable will remain visible.
7470 For instance, if you just want to get rid of the @code{References} line
7471 and the @code{Xref} line, you might say:
7473 @lisp
7474 (setq gnus-ignored-headers "^References:\\|^Xref:")
7475 @end lisp
7477 This variable can also be a list of regexps to match headers to
7478 be removed.
7480 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7481 variable will have no effect.
7483 @end table
7485 @vindex gnus-sorted-header-list
7486 Gnus can also sort the headers for you.  (It does this by default.)  You
7487 can control the sorting by setting the @code{gnus-sorted-header-list}
7488 variable.  It is a list of regular expressions that says in what order
7489 the headers are to be displayed.
7491 For instance, if you want the name of the author of the article first,
7492 and then the subject, you might say something like:
7494 @lisp
7495 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7496 @end lisp
7498 Any headers that are to remain visible, but are not listed in this
7499 variable, will be displayed in random order after all the headers listed in this variable.
7501 @findex gnus-article-hide-boring-headers
7502 @vindex gnus-article-display-hook
7503 @vindex gnus-boring-article-headers
7504 You can hide further boring headers by entering
7505 @code{gnus-article-hide-boring-headers} into
7506 @code{gnus-article-display-hook}.  What this function does depends on
7507 the @code{gnus-boring-article-headers} variable.  It's a list, but this
7508 list doesn't actually contain header names.  Instead is lists various
7509 @dfn{boring conditions} that Gnus can check and remove from sight.
7511 These conditions are:
7512 @table @code
7513 @item empty
7514 Remove all empty headers.
7515 @item followup-to
7516 Remove the @code{Followup-To} header if it is identical to the
7517 @code{Newsgroups} header.
7518 @item reply-to
7519 Remove the @code{Reply-To} header if it lists the same address as the
7520 @code{From} header.
7521 @item newsgroups
7522 Remove the @code{Newsgroups} header if it only contains the current group
7523 name.
7524 @item date
7525 Remove the @code{Date} header if the article is less than three days
7526 old.
7527 @item long-to
7528 Remove the @code{To} header if it is very long.
7529 @item many-to
7530 Remove all @code{To} headers if there are more than one.
7531 @end table
7533 To include the four three elements, you could say something like;
7535 @lisp
7536 (setq gnus-boring-article-headers
7537       '(empty followup-to reply-to))
7538 @end lisp
7540 This is also the default value for this variable.
7543 @node Using MIME
7544 @section Using @sc{mime}
7545 @cindex @sc{mime}
7547 Mime is a standard for waving your hands through the air, aimlessly,
7548 while people stand around yawning.
7550 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7551 while all newsreaders die of fear.
7553 @sc{mime} may specify what character set the article uses, the encoding
7554 of the characters, and it also makes it possible to embed pictures and
7555 other naughty stuff in innocent-looking articles.
7557 @vindex gnus-show-mime
7558 @vindex gnus-show-mime-method
7559 @vindex gnus-strict-mime
7560 @findex metamail-buffer
7561 Gnus handles @sc{mime} by pushing the articles through
7562 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7563 default.  This function calls the external @code{metamail} program to
7564 actually do the work.  One common problem with this program is that is
7565 thinks that it can't display 8-bit things in the Emacs buffer.  To tell
7566 it the truth, put something like the following in your
7567 @file{.bash_profile} file.  (You do use @code{bash}, don't you?)
7569 @example
7570 export MM_CHARSET="iso-8859-1"
7571 @end example
7573 For more information on @code{metamail}, see its manual page.
7575 Set @code{gnus-show-mime} to @code{t} if you want to use
7576 @sc{mime} all the time.  However, if @code{gnus-strict-mime} is
7577 non-@code{nil}, the @sc{mime} method will only be used if there are
7578 @sc{mime} headers in the article.  If you have @code{gnus-show-mime}
7579 set, then you'll see some unfortunate display glitches in the article
7580 buffer.  These can't be avoided.
7582 It might be best to just use the toggling functions from the summary
7583 buffer to avoid getting nasty surprises. (For instance, you enter the
7584 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7585 decoded the sound file in the article and some horrible sing-a-long song
7586 comes screaming out your speakers, and you can't find the volume
7587 button, because there isn't one, and people are starting to look at you,
7588 and you try to stop the program, but you can't, and you can't find the
7589 program to control the volume, and everybody else in the room suddenly
7590 decides to look at you disdainfully, and you'll feel rather stupid.)
7592 Any similarity to real events and people is purely coincidental.  Ahem.
7595 @node Customizing Articles
7596 @section Customizing Articles
7597 @cindex article customization
7599 @vindex gnus-article-display-hook
7600 The @code{gnus-article-display-hook} is called after the article has
7601 been inserted into the article buffer.  It is meant to handle all
7602 treatment of the article before it is displayed.
7604 @findex gnus-article-maybe-highlight
7605 @findex gnus-article-maybe-hide-headers
7606 By default this hook just contains
7607 @code{gnus-article-maybe-hide-headers},
7608 @code{gnus-hide-boring-headers}, @code{gnus-article-treat-overstrike},
7609 and @code{gnus-article-maybe-highlight} (and under XEmacs,
7610 @code{gnus-article-display-x-face}), but there are thousands, nay
7611 millions, of functions you can put in this hook.  For an overview of
7612 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7613 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7614 Date}.  Note that the order of functions in this hook might affect
7615 things, so you may have to fiddle a bit to get the desired results.
7617 You can, of course, write your own functions.  The functions are called
7618 from the article buffer, and you can do anything you like, pretty much.
7619 There is no information that you have to keep in the buffer---you can
7620 change everything.  However, you shouldn't delete any headers.  Instead
7621 make them invisible if you want to make them go away.
7624 @node Article Keymap
7625 @section Article Keymap
7627 Most of the keystrokes in the summary buffer can also be used in the
7628 article buffer.  They should behave as if you typed them in the summary
7629 buffer, which means that you don't actually have to have a summary
7630 buffer displayed while reading.  You can do it all from the article
7631 buffer.
7633 A few additional keystrokes are available:
7635 @table @kbd
7637 @item SPACE
7638 @kindex SPACE (Article)
7639 @findex gnus-article-next-page
7640 Scroll forwards one page (@code{gnus-article-next-page}).
7642 @item DEL
7643 @kindex DEL (Article)
7644 @findex gnus-article-prev-page
7645 Scroll backwards one page (@code{gnus-article-prev-page}).
7647 @item C-c ^
7648 @kindex C-c ^ (Article)
7649 @findex gnus-article-refer-article
7650 If point is in the neighborhood of a @code{Message-ID} and you press
7651 @kbd{C-c ^}, Gnus will try to get that article from the server
7652 (@code{gnus-article-refer-article}).
7654 @item C-c C-m
7655 @kindex C-c C-m (Article)
7656 @findex gnus-article-mail
7657 Send a reply to the address near point (@code{gnus-article-mail}).  If
7658 given a prefix, include the mail.
7660 @item s
7661 @kindex s (Article)
7662 @findex gnus-article-show-summary
7663 Reconfigure the buffers so that the summary buffer becomes visible
7664 (@code{gnus-article-show-summary}).
7666 @item ?
7667 @kindex ? (Article)
7668 @findex gnus-article-describe-briefly
7669 Give a very brief description of the available keystrokes
7670 (@code{gnus-article-describe-briefly}).
7672 @item TAB
7673 @kindex TAB (Article)
7674 @findex gnus-article-next-button
7675 Go to the next button, if any (@code{gnus-article-next-button}).  This
7676 only makes sense if you have buttonizing turned on.
7678 @item M-TAB
7679 @kindex M-TAB (Article)
7680 @findex gnus-article-prev-button
7681 Go to the previous button, if any (@code{gnus-article-prev-button}).
7683 @end table
7686 @node Misc Article
7687 @section Misc Article
7689 @table @code
7691 @item gnus-single-article-buffer
7692 @vindex gnus-single-article-buffer
7693 If non-@code{nil}, use the same article buffer for all the groups.
7694 (This is the default.)  If @code{nil}, each group will have its own
7695 article buffer.
7697 @vindex gnus-article-prepare-hook
7698 @item gnus-article-prepare-hook
7699 This hook is called right after the article has been inserted into the
7700 article buffer.  It is mainly intended for functions that do something
7701 depending on the contents; it should probably not be used for changing
7702 the contents of the article buffer.
7704 @vindex gnus-article-display-hook
7705 @item gnus-article-display-hook
7706 This hook is called as the last thing when displaying an article, and is
7707 intended for modifying the contents of the buffer, doing highlights,
7708 hiding headers, and the like.
7710 @item gnus-article-mode-hook
7711 @vindex gnus-article-mode-hook
7712 Hook called in article mode buffers.
7714 @item gnus-article-mode-syntax-table
7715 @vindex gnus-article-mode-syntax-table
7716 Syntax table used in article buffers.  It is initialized from
7717 @code{text-mode-syntax-table}.
7719 @vindex gnus-article-mode-line-format
7720 @item gnus-article-mode-line-format
7721 This variable is a format string along the same lines as
7722 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}).  It
7723 accepts the same format specifications as that variable, with one
7724 extension:
7726 @table @samp
7727 @item w
7728 The @dfn{wash status} of the article.  This is a short string with one
7729 character for each possible article wash operation that may have been
7730 performed.
7731 @end table
7733 @vindex gnus-break-pages
7735 @item gnus-break-pages
7736 Controls whether @dfn{page breaking} is to take place.  If this variable
7737 is non-@code{nil}, the articles will be divided into pages whenever a
7738 page delimiter appears in the article.  If this variable is @code{nil},
7739 paging will not be done.
7741 @item gnus-page-delimiter
7742 @vindex gnus-page-delimiter
7743 This is the delimiter mentioned above.  By default, it is @samp{^L}
7744 (formfeed).
7745 @end table
7748 @node Composing Messages
7749 @chapter Composing Messages
7750 @cindex composing messages
7751 @cindex messages
7752 @cindex mail
7753 @cindex sending mail
7754 @cindex reply
7755 @cindex followup
7756 @cindex post
7758 @kindex C-c C-c (Post)
7759 All commands for posting and mailing will put you in a message buffer
7760 where you can edit the article all you like, before you send the article
7761 by pressing @kbd{C-c C-c}.  @xref{Top, , Top, message, The Message
7762 Manual}.  If you are in a foreign news group, and you wish to post the
7763 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
7764 to make Gnus try to post using the foreign server.
7766 @menu
7767 * Mail::                 Mailing and replying.
7768 * Post::                 Posting and following up.
7769 * Posting Server::       What server should you post via?
7770 * Mail and Post::        Mailing and posting at the same time.
7771 * Archived Messages::    Where Gnus stores the messages you've sent.
7772 * Posting Styles::       An easier way to specify who you are.
7773 * Drafts::               Postponing messages and rejected messages.
7774 * Rejected Articles::    What happens if the server doesn't like your article?
7775 @end menu
7777 Also see @pxref{Canceling and Superseding} for information on how to
7778 remove articles you shouldn't have posted.
7781 @node Mail
7782 @section Mail
7784 Variables for customizing outgoing mail:
7786 @table @code
7787 @item gnus-uu-digest-headers
7788 @vindex gnus-uu-digest-headers
7789 List of regexps to match headers included in digested messages.  The
7790 headers will be included in the sequence they are matched.
7792 @item gnus-add-to-list
7793 @vindex gnus-add-to-list
7794 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
7795 that have none when you do a @kbd{a}.
7797 @end table
7800 @node Post
7801 @section Post
7803 Variables for composing news articles:
7805 @table @code
7806 @item gnus-sent-message-ids-file
7807 @vindex gnus-sent-message-ids-file
7808 Gnus will keep a @code{Message-ID} history file of all the mails it has
7809 sent.  If it discovers that it has already sent a mail, it will ask the
7810 user whether to re-send the mail.  (This is primarily useful when
7811 dealing with @sc{soup} packets and the like where one is apt to send the
7812 same packet multiple times.)  This variable says what the name of this
7813 history file is.  It is @file{~/News/Sent-Message-IDs} by default.  Set
7814 this variable to @code{nil} if you don't want Gnus to keep a history
7815 file.
7817 @item gnus-sent-message-ids-length
7818 @vindex gnus-sent-message-ids-length
7819 This variable says how many @code{Message-ID}s to keep in the history
7820 file.  It is 1000 by default.
7822 @end table
7825 @node Posting Server
7826 @section Posting Server
7828 When you press those magical @kbd{C-c C-c} keys to ship off your latest
7829 (extremely intelligent, of course) article, where does it go?
7831 Thank you for asking.  I hate you.
7833 @vindex gnus-post-method
7835 It can be quite complicated.  Normally, Gnus will use the same native
7836 server.  However.  If your native server doesn't allow posting, just
7837 reading, you probably want to use some other server to post your
7838 (extremely intelligent and fabulously interesting) articles.  You can
7839 then set the @code{gnus-post-method} to some other method:
7841 @lisp
7842 (setq gnus-post-method '(nnspool ""))
7843 @end lisp
7845 Now, if you've done this, and then this server rejects your article, or
7846 this server is down, what do you do then?  To override this variable you
7847 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
7848 the ``current'' server for posting.
7850 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
7851 Gnus will prompt you for what method to use for posting.
7853 You can also set @code{gnus-post-method} to a list of select methods.
7854 If that's the case, Gnus will always prompt you for what method to use
7855 for posting.
7857 Finally, if you want to always post using the same select method as
7858 you're reading from (which might be convenient if you're reading lots of
7859 groups from different private servers), you can set this variable to
7860 @code{current}. 
7863 @node Mail and Post
7864 @section Mail and Post
7866 Here's a list of variables relevant to both mailing and
7867 posting:
7869 @table @code
7870 @item gnus-mailing-list-groups
7871 @findex gnus-mailing-list-groups
7872 @cindex mailing lists
7874 If your news server offers groups that are really mailing lists
7875 gatewayed to the @sc{nntp} server, you can read those groups without
7876 problems, but you can't post/followup to them without some difficulty.
7877 One solution is to add a @code{to-address} to the group parameters
7878 (@pxref{Group Parameters}).  An easier thing to do is set the
7879 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
7880 really are mailing lists.  Then, at least, followups to the mailing
7881 lists will work most of the time.  Posting to these groups (@kbd{a}) is
7882 still a pain, though.
7884 @end table
7886 You may want to do spell-checking on messages that you send out.  Or, if
7887 you don't want to spell-check by hand, you could add automatic
7888 spell-checking via the @code{ispell} package:
7890 @cindex ispell
7891 @findex ispell-message
7892 @lisp
7893 (add-hook 'message-send-hook 'ispell-message)
7894 @end lisp
7897 @node Archived Messages
7898 @section Archived Messages
7899 @cindex archived messages
7900 @cindex sent messages
7902 Gnus provides a few different methods for storing the mail and news you
7903 send.  The default method is to use the @dfn{archive virtual server} to
7904 store the messages.  If you want to disable this completely, the
7905 @code{gnus-message-archive-group} variable should be @code{nil}, which
7906 is the default.
7908 @vindex gnus-message-archive-method
7909 @code{gnus-message-archive-method} says what virtual server Gnus is to
7910 use to store sent messages.  The default is:
7912 @lisp
7913 (nnfolder "archive"
7914           (nnfolder-directory   "~/Mail/archive")
7915           (nnfolder-active-file "~/Mail/archive/active")
7916           (nnfolder-get-new-mail nil)
7917           (nnfolder-inhibit-expiry t))
7918 @end lisp
7920 You can, however, use any mail select method (@code{nnml},
7921 @code{nnmbox}, etc.).  @code{nnfolder} is a quite likeable select method
7922 for doing this sort of thing, though.  If you don't like the default
7923 directory chosen, you could say something like:
7925 @lisp
7926 (setq gnus-message-archive-method
7927       '(nnfolder "archive"
7928                  (nnfolder-inhibit-expiry t)
7929                  (nnfolder-active-file "~/News/sent-mail/active")
7930                  (nnfolder-directory "~/News/sent-mail/")))
7931 @end lisp
7933 @vindex gnus-message-archive-group
7934 @cindex Gcc
7935 Gnus will insert @code{Gcc} headers in all outgoing messages that point
7936 to one or more group(s) on that server.  Which group to use is
7937 determined by the @code{gnus-message-archive-group} variable.
7939 This variable can be used to do the following:
7941 @itemize @bullet
7942 @item a string
7943 Messages will be saved in that group.
7944 @item a list of strings
7945 Messages will be saved in all those groups.
7946 @item an alist of regexps, functions and forms
7947 When a key ``matches'', the result is used.
7948 @item @code{nil}
7949 No message archiving will take place.  This is the default.
7950 @end itemize
7952 Let's illustrate:
7954 Just saving to a single group called @samp{MisK}:
7955 @lisp
7956 (setq gnus-message-archive-group "MisK")
7957 @end lisp
7959 Saving to two groups, @samp{MisK} and @samp{safe}:
7960 @lisp
7961 (setq gnus-message-archive-group '("MisK" "safe"))
7962 @end lisp
7964 Save to different groups based on what group you are in:
7965 @lisp
7966 (setq gnus-message-archive-group
7967       '(("^alt" "sent-to-alt")
7968         ("mail" "sent-to-mail")
7969         (".*" "sent-to-misc")))
7970 @end lisp
7972 More complex stuff:
7973 @lisp
7974 (setq gnus-message-archive-group
7975       '((if (message-news-p)
7976             "misc-news"
7977           "misc-mail")))
7978 @end lisp
7980 How about storing all news messages in one file, but storing all mail
7981 messages in one file per month:
7983 @lisp
7984 (setq gnus-message-archive-group
7985       '((if (message-news-p)
7986             "misc-news"
7987           (concat "mail." (format-time-string
7988                            "%Y-%m" (current-time))))))
7989 @end lisp
7991 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
7992 use a different value for @code{gnus-message-archive-group} there.)
7994 Now, when you send a message off, it will be stored in the appropriate
7995 group.  (If you want to disable storing for just one particular message,
7996 you can just remove the @code{Gcc} header that has been inserted.)  The
7997 archive group will appear in the group buffer the next time you start
7998 Gnus, or the next time you press @kbd{F} in the group buffer.  You can
7999 enter it and read the articles in it just like you'd read any other
8000 group.  If the group gets really big and annoying, you can simply rename
8001 if (using @kbd{G r} in the group buffer) to something
8002 nice---@samp{misc-mail-september-1995}, or whatever.  New messages will
8003 continue to be stored in the old (now empty) group.
8005 That's the default method of archiving sent messages.  Gnus offers a
8006 different way for the people who don't like the default method.  In that
8007 case you should set @code{gnus-message-archive-group} to @code{nil};
8008 this will disable archiving.
8010 @table @code
8011 @item gnus-outgoing-message-group
8012 @vindex gnus-outgoing-message-group
8013 All outgoing messages will be put in this group.  If you want to store
8014 all your outgoing mail and articles in the group @samp{nnml:archive},
8015 you set this variable to that value.  This variable can also be a list of
8016 group names.
8018 If you want to have greater control over what group to put each
8019 message in, you can set this variable to a function that checks the
8020 current newsgroup name and then returns a suitable group name (or list
8021 of names).
8023 This variable can be used instead of @code{gnus-message-archive-group},
8024 but the latter is the preferred method.
8025 @end table
8028 @node Posting Styles
8029 @section Posting Styles
8030 @cindex posting styles
8031 @cindex styles
8033 All them variables, they make my head swim.
8035 So what if you want a different @code{Organization} and signature based
8036 on what groups you post to?  And you post both from your home machine
8037 and your work machine, and you want different @code{From} lines, and so
8040 @vindex gnus-posting-styles
8041 One way to do stuff like that is to write clever hooks that change the
8042 variables you need to have changed.  That's a bit boring, so somebody
8043 came up with the bright idea of letting the user specify these things in
8044 a handy alist.  Here's an example of a @code{gnus-posting-styles}
8045 variable:
8047 @lisp
8048 ((".*"
8049   (signature "Peace and happiness")
8050   (organization "What me?"))
8051  ("^comp"
8052   (signature "Death to everybody"))
8053  ("comp.emacs.i-love-it"
8054   (organization "Emacs is it")))
8055 @end lisp
8057 As you might surmise from this example, this alist consists of several
8058 @dfn{styles}.  Each style will be applicable if the first element
8059 ``matches'', in some form or other.  The entire alist will be iterated
8060 over, from the beginning towards the end, and each match will be
8061 applied, which means that attributes in later styles that match override
8062 the same attributes in earlier matching styles.  So
8063 @samp{comp.programming.literate} will have the @samp{Death to everybody}
8064 signature and the @samp{What me?} @code{Organization} header.
8066 The first element in each style is called the @code{match}.  If it's a
8067 string, then Gnus will try to regexp match it against the group name.
8068 If it's a function symbol, that function will be called with no
8069 arguments.  If it's a variable symbol, then the variable will be
8070 referenced.  If it's a list, then that list will be @code{eval}ed.  In
8071 any case, if this returns a non-@code{nil} value, then the style is said
8072 to @dfn{match}.
8074 Each style may contain a arbitrary amount of @dfn{attributes}.  Each
8075 attribute consists of a @code{(@var{name} . @var{value})} pair.  The attribute name
8076 can be one of @code{signature}, @code{signature-file},
8077 @code{organization}, @code{address}, @code{name} or @code{body}.  The
8078 attribute name can also be a string.  In that case, this will be used as
8079 a header name, and the value will be inserted in the headers of the
8080 article.
8082 The attribute value can be a string (used verbatim), a function (the
8083 return value will be used), a variable (its value will be used) or a
8084 list (it will be @code{eval}ed and the return value will be used).
8086 If you wish to check whether the message you are about to compose is
8087 meant to be a news article or a mail message, you can check the values
8088 of the two dynamically bound variables @code{message-this-is-news} and
8089 @code{message-this-is-mail}.
8091 @vindex message-this-is-mail
8092 @vindex message-this-is-news
8094 So here's a new example:
8096 @lisp
8097 (setq gnus-posting-styles
8098       '((".*"
8099          (signature-file "~/.signature")
8100          (name "User Name")
8101          ("X-Home-Page" (getenv "WWW_HOME"))
8102          (organization "People's Front Against MWM"))
8103         ("^rec.humor"
8104          (signature my-funny-signature-randomizer))
8105         ((equal (system-name) "gnarly")
8106          (signature my-quote-randomizer))
8107         (message-this-is-news
8108          (signature my-news-signature))
8109         (posting-from-work-p
8110          (signature-file "~/.work-signature")
8111          (address "user@@bar.foo")
8112          (body "You are fired.\n\nSincerely, your boss.")
8113          (organization "Important Work, Inc"))
8114         ("^nn.+:"
8115          (signature-file "~/.mail-signature"))))
8116 @end lisp
8119 @node Drafts
8120 @section Drafts
8121 @cindex drafts
8123 If you are writing a message (mail or news) and suddenly remember that
8124 you have a steak in the oven (or some pesto in the food processor, you
8125 craaazy vegetarians), you'll probably wish there was a method to save
8126 the message you are writing so that you can continue editing it some
8127 other day, and send it when you feel its finished.
8129 Well, don't worry about it.  Whenever you start composing a message of
8130 some sort using the Gnus mail and post commands, the buffer you get will
8131 automatically associate to an article in a special @dfn{draft} group.
8132 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
8133 article will be saved there.  (Auto-save files also go to the draft
8134 group.)
8136 @cindex nndraft
8137 @vindex nndraft-directory
8138 The draft group is a special group (which is implemented as an
8139 @code{nndraft} group, if you absolutely have to know) called
8140 @samp{nndraft:drafts}.  The variable @code{nndraft-directory} says where
8141 @code{nndraft} is to store its files.  What makes this group special is
8142 that you can't tick any articles in it or mark any articles as
8143 read---all articles in the group are permanently unread.
8145 If the group doesn't exist, it will be created and you'll be subscribed
8146 to it.  The only way to make it disappear from the Group buffer is to
8147 unsubscribe it.
8149 @c @findex gnus-dissociate-buffer-from-draft
8150 @c @kindex C-c M-d (Mail)
8151 @c @kindex C-c M-d (Post)
8152 @c @findex gnus-associate-buffer-with-draft
8153 @c @kindex C-c C-d (Mail)
8154 @c @kindex C-c C-d (Post)
8155 @c If you're writing some super-secret message that you later want to
8156 @c encode with PGP before sending, you may wish to turn the auto-saving
8157 @c (and association with the draft group) off.  You never know who might be
8158 @c interested in reading all your extremely valuable and terribly horrible
8159 @c and interesting secrets.  The @kbd{C-c M-d}
8160 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
8161 @c If you change your mind and want to turn the auto-saving back on again,
8162 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
8164 @c @vindex gnus-use-draft
8165 @c To leave association with the draft group off by default, set
8166 @c @code{gnus-use-draft} to @code{nil}.  It is @code{t} by default.
8168 @findex gnus-draft-edit-message
8169 @kindex D e (Draft)
8170 When you want to continue editing the article, you simply enter the
8171 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
8172 that.  You will be placed in a buffer where you left off.
8174 Rejected articles will also be put in this draft group (@pxref{Rejected
8175 Articles}).
8177 @findex gnus-draft-send-all-messages
8178 @findex gnus-draft-send-message
8179 If you have lots of rejected messages you want to post (or mail) without
8180 doing further editing, you can use the @kbd{D s} command
8181 (@code{gnus-draft-send-message}).  This command understands the
8182 process/prefix convention (@pxref{Process/Prefix}).  The @kbd{D S}
8183 command (@code{gnus-draft-send-all-messages}) will ship off all messages
8184 in the buffer.
8186 If you have some messages that you wish not to send, you can use the
8187 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
8188 as unsendable.  This is a toggling command.
8191 @node Rejected Articles
8192 @section Rejected Articles
8193 @cindex rejected articles
8195 Sometimes a news server will reject an article.  Perhaps the server
8196 doesn't like your face.  Perhaps it just feels miserable.  Perhaps
8197 @emph{there be demons}.  Perhaps you have included too much cited text.
8198 Perhaps the disk is full.  Perhaps the server is down.
8200 These situations are, of course, totally beyond the control of Gnus.
8201 (Gnus, of course, loves the way you look, always feels great, has angels
8202 fluttering around inside of it, doesn't care about how much cited text
8203 you include, never runs full and never goes down.)  So Gnus saves these
8204 articles until some later time when the server feels better.
8206 The rejected articles will automatically be put in a special draft group
8207 (@pxref{Drafts}).  When the server comes back up again, you'd then
8208 typically enter that group and send all the articles off.
8211 @node Select Methods
8212 @chapter Select Methods
8213 @cindex foreign groups
8214 @cindex select methods
8216 A @dfn{foreign group} is a group not read by the usual (or
8217 default) means.  It could be, for instance, a group from a different
8218 @sc{nntp} server, it could be a virtual group, or it could be your own
8219 personal mail group.
8221 A foreign group (or any group, really) is specified by a @dfn{name} and
8222 a @dfn{select method}.  To take the latter first, a select method is a
8223 list where the first element says what backend to use (e.g. @code{nntp},
8224 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
8225 name}.  There may be additional elements in the select method, where the
8226 value may have special meaning for the backend in question.
8228 One could say that a select method defines a @dfn{virtual server}---so
8229 we do just that (@pxref{The Server Buffer}).
8231 The @dfn{name} of the group is the name the backend will recognize the
8232 group as.
8234 For instance, the group @samp{soc.motss} on the @sc{nntp} server
8235 @samp{some.where.edu} will have the name @samp{soc.motss} and select
8236 method @code{(nntp "some.where.edu")}.  Gnus will call this group
8237 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
8238 backend just knows this group as @samp{soc.motss}.
8240 The different methods all have their peculiarities, of course.
8242 @menu
8243 * The Server Buffer::     Making and editing virtual servers.
8244 * Getting News::          Reading USENET news with Gnus.
8245 * Getting Mail::          Reading your personal mail with Gnus.
8246 * Other Sources::         Reading directories, files, SOUP packets.
8247 * Combined Groups::       Combining groups into one group.
8248 * Gnus Unplugged::        Reading news and mail offline.
8249 @end menu
8252 @node The Server Buffer
8253 @section The Server Buffer
8255 Traditionally, a @dfn{server} is a machine or a piece of software that
8256 one connects to, and then requests information from.  Gnus does not
8257 connect directly to any real servers, but does all transactions through
8258 one backend or other.  But that's just putting one layer more between
8259 the actual media and Gnus, so we might just as well say that each
8260 backend represents a virtual server.
8262 For instance, the @code{nntp} backend may be used to connect to several
8263 different actual @sc{nntp} servers, or, perhaps, to many different ports
8264 on the same actual @sc{nntp} server.  You tell Gnus which backend to
8265 use, and what parameters to set by specifying a @dfn{select method}.
8267 These select method specifications can sometimes become quite
8268 complicated---say, for instance, that you want to read from the
8269 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
8270 hangs if queried for @sc{nov} headers and has a buggy select.  Ahem.
8271 Anyways, if you had to specify that for each group that used this
8272 server, that would be too much work, so Gnus offers a way of naming
8273 select methods, which is what you do in the server buffer.
8275 To enter the server buffer, use the @kbd{^}
8276 (@code{gnus-group-enter-server-mode}) command in the group buffer.
8278 @menu
8279 * Server Buffer Format::      You can customize the look of this buffer.
8280 * Server Commands::           Commands to manipulate servers.
8281 * Example Methods::           Examples server specifications.
8282 * Creating a Virtual Server:: An example session.
8283 * Server Variables::          Which variables to set.
8284 * Servers and Methods::       You can use server names as select methods.
8285 * Unavailable Servers::       Some servers you try to contact may be down.
8286 @end menu
8288 @vindex gnus-server-mode-hook
8289 @code{gnus-server-mode-hook} is run when creating the server buffer.
8292 @node Server Buffer Format
8293 @subsection Server Buffer Format
8294 @cindex server buffer format
8296 @vindex gnus-server-line-format
8297 You can change the look of the server buffer lines by changing the
8298 @code{gnus-server-line-format} variable.  This is a @code{format}-like
8299 variable, with some simple extensions:
8301 @table @samp
8303 @item h
8304 How the news is fetched---the backend name.
8306 @item n
8307 The name of this server.
8309 @item w
8310 Where the news is to be fetched from---the address.
8312 @item s
8313 The opened/closed/denied status of the server.
8314 @end table
8316 @vindex gnus-server-mode-line-format
8317 The mode line can also be customized by using the
8318 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
8319 Formatting}).  The following specs are understood:
8321 @table @samp
8322 @item S
8323 Server name.
8325 @item M
8326 Server method.
8327 @end table
8329 Also @pxref{Formatting Variables}.
8332 @node Server Commands
8333 @subsection Server Commands
8334 @cindex server commands
8336 @table @kbd
8338 @item a
8339 @kindex a (Server)
8340 @findex gnus-server-add-server
8341 Add a new server (@code{gnus-server-add-server}).
8343 @item e
8344 @kindex e (Server)
8345 @findex gnus-server-edit-server
8346 Edit a server (@code{gnus-server-edit-server}).
8348 @item SPACE
8349 @kindex SPACE (Server)
8350 @findex gnus-server-read-server
8351 Browse the current server (@code{gnus-server-read-server}).
8353 @item q
8354 @kindex q (Server)
8355 @findex gnus-server-exit
8356 Return to the group buffer (@code{gnus-server-exit}).
8358 @item k
8359 @kindex k (Server)
8360 @findex gnus-server-kill-server
8361 Kill the current server (@code{gnus-server-kill-server}).
8363 @item y
8364 @kindex y (Server)
8365 @findex gnus-server-yank-server
8366 Yank the previously killed server (@code{gnus-server-yank-server}).
8368 @item c
8369 @kindex c (Server)
8370 @findex gnus-server-copy-server
8371 Copy the current server (@code{gnus-server-copy-server}).
8373 @item l
8374 @kindex l (Server)
8375 @findex gnus-server-list-servers
8376 List all servers (@code{gnus-server-list-servers}).
8378 @item s
8379 @kindex s (Server)
8380 @findex gnus-server-scan-server
8381 Request that the server scan its sources for new articles
8382 (@code{gnus-server-scan-server}).  This is mainly sensible with mail
8383 servers.
8385 @item g
8386 @kindex g (Server)
8387 @findex gnus-server-regenerate-server
8388 Request that the server regenerate all its data structures
8389 (@code{gnus-server-regenerate-server}).  This can be useful if you have
8390 a mail backend that has gotten out of synch.
8392 @end table
8395 @node Example Methods
8396 @subsection Example Methods
8398 Most select methods are pretty simple and self-explanatory:
8400 @lisp
8401 (nntp "news.funet.fi")
8402 @end lisp
8404 Reading directly from the spool is even simpler:
8406 @lisp
8407 (nnspool "")
8408 @end lisp
8410 As you can see, the first element in a select method is the name of the
8411 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8412 will.
8414 After these two elements, there may be an arbitrary number of
8415 @code{(@var{variable} @var{form})} pairs.
8417 To go back to the first example---imagine that you want to read from
8418 port 15 on that machine.  This is what the select method should
8419 look like then:
8421 @lisp
8422 (nntp "news.funet.fi" (nntp-port-number 15))
8423 @end lisp
8425 You should read the documentation to each backend to find out what
8426 variables are relevant, but here's an @code{nnmh} example:
8428 @code{nnmh} is a mail backend that reads a spool-like structure.  Say
8429 you have two structures that you wish to access: One is your private
8430 mail spool, and the other is a public one.  Here's the possible spec for
8431 your private mail:
8433 @lisp
8434 (nnmh "private" (nnmh-directory "~/private/mail/"))
8435 @end lisp
8437 (This server is then called @samp{private}, but you may have guessed
8438 that.)
8440 Here's the method for a public spool:
8442 @lisp
8443 (nnmh "public"
8444       (nnmh-directory "/usr/information/spool/")
8445       (nnmh-get-new-mail nil))
8446 @end lisp
8448 If you are behind a firewall and only have access to the @sc{nntp}
8449 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8450 on the firewall machine and telnet from there to the @sc{nntp} server.
8451 Doing this can be rather fiddly, but your virtual server definition
8452 should probably look something like this:
8454 @lisp
8455 (nntp "firewall"
8456       (nntp-address "the.firewall.machine")
8457       (nntp-open-connection-function nntp-open-rlogin)
8458       (nntp-end-of-line "\n")
8459       (nntp-rlogin-parameters
8460        ("telnet" "the.real.nntp.host" "nntp")))
8461 @end lisp
8463 If you want to use the wonderful @code{ssh} program to provide a
8464 compressed connection over the modem line, you could create a virtual
8465 server that would look something like this:
8467 @lisp
8468 (nntp "news"
8469        (nntp-address "copper.uio.no")
8470        (nntp-rlogin-program "ssh")
8471        (nntp-open-connection-function nntp-open-rlogin)
8472        (nntp-end-of-line "\n")
8473        (nntp-rlogin-parameters
8474         ("telnet" "news.uio.no" "nntp")))
8475 @end lisp
8477 This means that you have to have set up @code{ssh-agent} correctly to
8478 provide automatic authorization, of course.  And to get a compressed
8479 connection, you have to have the @samp{Compression} option in the
8480 @code{ssh} @file{config} file.
8483 @node Creating a Virtual Server
8484 @subsection Creating a Virtual Server
8486 If you're saving lots of articles in the cache by using persistent
8487 articles, you may want to create a virtual server to read the cache.
8489 First you need to add a new server.  The @kbd{a} command does that.  It
8490 would probably be best to use @code{nnspool} to read the cache.  You
8491 could also use @code{nnml} or @code{nnmh}, though.
8493 Type @kbd{a nnspool RET cache RET}.
8495 You should now have a brand new @code{nnspool} virtual server called
8496 @samp{cache}.  You now need to edit it to have the right definitions.
8497 Type @kbd{e} to edit the server.  You'll be entered into a buffer that
8498 will contain the following:
8500 @lisp
8501 (nnspool "cache")
8502 @end lisp
8504 Change that to:
8506 @lisp
8507 (nnspool "cache"
8508          (nnspool-spool-directory "~/News/cache/")
8509          (nnspool-nov-directory "~/News/cache/")
8510          (nnspool-active-file "~/News/cache/active"))
8511 @end lisp
8513 Type @kbd{C-c C-c} to return to the server buffer.  If you now press
8514 @kbd{RET} over this virtual server, you should be entered into a browse
8515 buffer, and you should be able to enter any of the groups displayed.
8518 @node Server Variables
8519 @subsection Server Variables
8521 One sticky point when defining variables (both on backends and in Emacs
8522 in general) is that some variables are typically initialized from other
8523 variables when the definition of the variables is being loaded.  If you
8524 change the "base" variable after the variables have been loaded, you
8525 won't change the "derived" variables.
8527 This typically affects directory and file variables.  For instance,
8528 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
8529 directory variables are initialized from that variable, so
8530 @code{nnml-active-file} will be @file{~/Mail/active}.  If you define a
8531 new virtual @code{nnml} server, it will @emph{not} suffice to set just
8532 @code{nnml-directory}---you have to explicitly set all the file
8533 variables to be what you want them to be.  For a complete list of
8534 variables for each backend, see each backend's section later in this
8535 manual, but here's an example @code{nnml} definition:
8537 @lisp
8538 (nnml "public"
8539       (nnml-directory "~/my-mail/")
8540       (nnml-active-file "~/my-mail/active")
8541       (nnml-newsgroups-file "~/my-mail/newsgroups"))
8542 @end lisp
8545 @node Servers and Methods
8546 @subsection Servers and Methods
8548 Wherever you would normally use a select method
8549 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8550 when browsing a foreign server) you can use a virtual server name
8551 instead.  This could potentially save lots of typing.  And it's nice all
8552 over.
8555 @node Unavailable Servers
8556 @subsection Unavailable Servers
8558 If a server seems to be unreachable, Gnus will mark that server as
8559 @code{denied}.  That means that any subsequent attempt to make contact
8560 with that server will just be ignored.  ``It can't be opened,'' Gnus
8561 will tell you, without making the least effort to see whether that is
8562 actually the case or not.
8564 That might seem quite naughty, but it does make sense most of the time.
8565 Let's say you have 10 groups subscribed to on server
8566 @samp{nephelococcygia.com}.  This server is located somewhere quite far
8567 away from you and the machine is quite slow, so it takes 1 minute just
8568 to find out that it refuses connection to you today.  If Gnus were to
8569 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
8570 attempt to do that.  Once it has gotten a single ``connection refused'',
8571 it will regard that server as ``down''.
8573 So, what happens if the machine was only feeling unwell temporarily?
8574 How do you test to see whether the machine has come up again?
8576 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8577 with the following commands:
8579 @table @kbd
8581 @item O
8582 @kindex O (Server)
8583 @findex gnus-server-open-server
8584 Try to establish connection to the server on the current line
8585 (@code{gnus-server-open-server}).
8587 @item C
8588 @kindex C (Server)
8589 @findex gnus-server-close-server
8590 Close the connection (if any) to the server
8591 (@code{gnus-server-close-server}).
8593 @item D
8594 @kindex D (Server)
8595 @findex gnus-server-deny-server
8596 Mark the current server as unreachable
8597 (@code{gnus-server-deny-server}).
8599 @item M-o
8600 @kindex M-o (Server)
8601 @findex gnus-server-open-all-servers
8602 Open the connections to all servers in the buffer
8603 (@code{gnus-server-open-all-servers}).
8605 @item M-c
8606 @kindex M-c (Server)
8607 @findex gnus-server-close-all-servers
8608 Close the connections to all servers in the buffer
8609 (@code{gnus-server-close-all-servers}).
8611 @item R
8612 @kindex R (Server)
8613 @findex gnus-server-remove-denials
8614 Remove all marks to whether Gnus was denied connection from any servers
8615 (@code{gnus-server-remove-denials}).
8617 @end table
8620 @node Getting News
8621 @section Getting News
8622 @cindex reading news
8623 @cindex news backends
8625 A newsreader is normally used for reading news.  Gnus currently provides
8626 only two methods of getting news---it can read from an @sc{nntp} server,
8627 or it can read from a local spool.
8629 @menu
8630 * NNTP::               Reading news from an @sc{nntp} server.
8631 * News Spool::         Reading news from the local spool.
8632 @end menu
8635 @node NNTP
8636 @subsection @sc{nntp}
8637 @cindex nntp
8639 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8640 You just specify @code{nntp} as method and the address of the @sc{nntp}
8641 server as the, uhm, address.
8643 If the @sc{nntp} server is located at a non-standard port, setting the
8644 third element of the select method to this port number should allow you
8645 to connect to the right port.  You'll have to edit the group info for
8646 that (@pxref{Foreign Groups}).
8648 The name of the foreign group can be the same as a native group.  In
8649 fact, you can subscribe to the same group from as many different servers
8650 you feel like.  There will be no name collisions.
8652 The following variables can be used to create a virtual @code{nntp}
8653 server:
8655 @table @code
8657 @item nntp-server-opened-hook
8658 @vindex nntp-server-opened-hook
8659 @cindex @sc{mode reader}
8660 @cindex authinfo
8661 @cindex authentification
8662 @cindex nntp authentification
8663 @findex nntp-send-authinfo
8664 @findex nntp-send-mode-reader
8665 is run after a connection has been made.  It can be used to send
8666 commands to the @sc{nntp} server after it has been contacted.  By
8667 default it sends the command @code{MODE READER} to the server with the
8668 @code{nntp-send-mode-reader} function.  This function should always be
8669 present in this hook.
8671 @item nntp-authinfo-function
8672 @vindex nntp-authinfo-function
8673 @findex nntp-send-authinfo
8674 @vindex nntp-authinfo-file
8675 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8676 server.  The default function is @code{nntp-send-authinfo}, which looks
8677 through your @file{~/.authinfo} (or whatever you've set the
8678 @code{nntp-authinfo-file} variable to) for applicable entries.  If none
8679 are found, it will prompt you for a login name and a password.  The
8680 format of the @file{~/.authinfo} file is (almost) the same as the
8681 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
8682 manual page, but here are the salient facts:
8684 @enumerate
8685 @item
8686 The file contains one or more line, each of which define one server.
8688 @item
8689 Each line may contain an arbitrary number of token/value pairs.  The
8690 valid tokens include @samp{machine}, @samp{login}, @samp{password},
8691 @samp{default} and @samp{force}.  (The latter is not a valid
8692 @file{.netrc}/@code{ftp} token, which is the only way the
8693 @file{.authinfo} file format deviates from the @file{.netrc} file
8694 format.)
8696 @end enumerate
8698 Here's an example file:
8700 @example
8701 machine news.uio.no login larsi password geheimnis
8702 machine nntp.ifi.uio.no login larsi force yes
8703 @end example
8705 The token/value pairs may appear in any order; @samp{machine} doesn't
8706 have to be first, for instance.
8708 In this example, both login name and password have been supplied for the
8709 former server, while the latter has only the login name listed, and the
8710 user will be prompted for the password.  The latter also has the
8711 @samp{force} tag, which means that the authinfo will be sent to the
8712 @var{nntp} server upon connection; the default (i.e., when there is not
8713 @samp{force} tag) is to not send authinfo to the @var{nntp} server
8714 until the @var{nntp} server asks for it.
8716 You can also add @samp{default} lines that will apply to all servers
8717 that don't have matching @samp{machine} lines.
8719 @example
8720 default force yes
8721 @end example
8723 This will force sending @samp{AUTHINFO} commands to all servers not
8724 previously mentioned.
8726 Remember to not leave the @file{~/.authinfo} file world-readable.
8728 @item nntp-server-action-alist
8729 @vindex nntp-server-action-alist
8730 This is a list of regexps to match on server types and actions to be
8731 taken when matches are made.  For instance, if you want Gnus to beep
8732 every time you connect to innd, you could say something like:
8734 @lisp
8735 (setq nntp-server-action-alist
8736       '(("innd" (ding))))
8737 @end lisp
8739 You probably don't want to do that, though.
8741 The default value is
8743 @lisp
8744 '(("nntpd 1\\.5\\.11t"
8745    (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
8746 @end lisp
8748 This ensures that Gnus doesn't send the @code{MODE READER} command to
8749 nntpd 1.5.11t, since that command chokes that server, I've been told.
8751 @item nntp-maximum-request
8752 @vindex nntp-maximum-request
8753 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
8754 will collect headers by sending a series of @code{head} commands.  To
8755 speed things up, the backend sends lots of these commands without
8756 waiting for reply, and then reads all the replies.  This is controlled
8757 by the @code{nntp-maximum-request} variable, and is 400 by default.  If
8758 your network is buggy, you should set this to 1.
8760 @item nntp-connection-timeout
8761 @vindex nntp-connection-timeout
8762 If you have lots of foreign @code{nntp} groups that you connect to
8763 regularly, you're sure to have problems with @sc{nntp} servers not
8764 responding properly, or being too loaded to reply within reasonable
8765 time.  This is can lead to awkward problems, which can be helped
8766 somewhat by setting @code{nntp-connection-timeout}.  This is an integer
8767 that says how many seconds the @code{nntp} backend should wait for a
8768 connection before giving up.  If it is @code{nil}, which is the default,
8769 no timeouts are done.
8771 @c @item nntp-command-timeout
8772 @c @vindex nntp-command-timeout
8773 @c @cindex PPP connections
8774 @c @cindex dynamic IP addresses
8775 @c If you're running Gnus on a machine that has a dynamically assigned
8776 @c address, Gnus may become confused.  If the address of your machine
8777 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
8778 @c waiting forever for replies from the server.  To help with this
8779 @c unfortunate problem, you can set this command to a number.  Gnus will
8780 @c then, if it sits waiting for a reply from the server longer than that
8781 @c number of seconds, shut down the connection, start a new one, and resend
8782 @c the command.  This should hopefully be transparent to the user.  A
8783 @c likely number is 30 seconds.
8785 @c @item nntp-retry-on-break
8786 @c @vindex nntp-retry-on-break
8787 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
8788 @c hangs.  This will have much the same effect as the command timeout
8789 @c described above.
8791 @item nntp-server-hook
8792 @vindex nntp-server-hook
8793 This hook is run as the last step when connecting to an @sc{nntp}
8794 server.
8796 @findex nntp-open-rlogin
8797 @findex nntp-open-telnet
8798 @findex nntp-open-network-stream
8799 @item nntp-open-connection-function
8800 @vindex nntp-open-connection-function
8801 This function is used to connect to the remote system.  Four pre-made
8802 functions are supplied:
8804 @table @code
8805 @item nntp-open-network-stream
8806 This is the default, and simply connects to some port or other on the
8807 remote system.
8809 @item nntp-open-rlogin
8810 Does an @samp{rlogin} on the
8811 remote system, and then does a @samp{telnet} to the @sc{nntp} server
8812 available there.
8814 @code{nntp-open-rlogin}-related variables:
8816 @table @code
8818 @item nntp-rlogin-program
8819 @vindex nntp-rlogin-program
8820 Program used to log in on remote machines.  The default is @samp{rsh},
8821 but @samp{ssh} is a popular alternative.
8823 @item nntp-rlogin-parameters
8824 @vindex nntp-rlogin-parameters
8825 This list will be used as the parameter list given to @code{rsh}.
8827 @item nntp-rlogin-user-name
8828 @vindex nntp-rlogin-user-name
8829 User name on the remote system.
8831 @end table
8833 @item nntp-open-telnet
8834 Does a @samp{telnet} to the remote system and then another @samp{telnet}
8835 to get to the @sc{nntp} server.
8837 @code{nntp-open-telnet}-related variables:
8839 @table @code
8840 @item nntp-telnet-command
8841 @vindex nntp-telnet-command
8842 Command used to start @code{telnet}.
8844 @item nntp-telnet-switches
8845 @vindex nntp-telnet-switches
8846 List of strings to be used as the switches to the @code{telnet} command.
8848 @item nntp-telnet-user-name
8849 @vindex nntp-telnet-user-name
8850 User name for log in on the remote system.
8852 @item nntp-telnet-passwd
8853 @vindex nntp-telnet-passwd
8854 Password to use when logging in.
8856 @item nntp-telnet-parameters
8857 @vindex nntp-telnet-parameters
8858 A list of strings executed as a command after logging in
8859 via @code{telnet}.
8861 @item nntp-telnet-shell-prompt
8862 @vindex nntp-telnet-shell-prompt
8863 Regexp matching the shell prompt on the remote machine.  The default is
8864 @samp{bash\\|\$ *\r?$\\|> *\r?}.
8866 @item nntp-open-telnet-envuser
8867 @vindex nntp-open-telnet-envuser
8868 If non-@code{nil}, the @code{telnet} session (client and server both)
8869 will support the @code{ENVIRON} option and not prompt for login name.
8870 This works for Solaris @code{telnet}, for instance.
8872 @end table
8874 @findex nntp-open-ssl-stream
8875 @item nntp-open-ssl-stream
8876 Opens a connection to a server over a @dfn{secure} channel.  To use this
8877 you must have SSLay installed
8878 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
8879 @file{ssl.el} (from the W3 distributeion, for instance).  You then
8880 define a server as follows:
8882 @lisp
8883 ;; Type `C-c C-c' after you've finished editing.
8885 ;; "snews" is port 563 and is predefined in our /etc/services
8887 (nntp "snews.bar.com"
8888       (nntp-open-connection-function nntp-open-ssl-stream)
8889       (nntp-port-number "snews")
8890       (nntp-address "snews.bar.com"))
8891 @end lisp
8893 @end table
8895 @item nntp-end-of-line
8896 @vindex nntp-end-of-line
8897 String to use as end-of-line marker when talking to the @sc{nntp}
8898 server.  This is @samp{\r\n} by default, but should be @samp{\n} when
8899 using @code{rlogin} to talk to the server.
8901 @item nntp-rlogin-user-name
8902 @vindex nntp-rlogin-user-name
8903 User name on the remote system when using the @code{rlogin} connect
8904 function.
8906 @item nntp-address
8907 @vindex nntp-address
8908 The address of the remote system running the @sc{nntp} server.
8910 @item nntp-port-number
8911 @vindex nntp-port-number
8912 Port number to connect to when using the @code{nntp-open-network-stream}
8913 connect function.
8915 @item nntp-buggy-select
8916 @vindex nntp-buggy-select
8917 Set this to non-@code{nil} if your select routine is buggy.
8919 @item nntp-nov-is-evil
8920 @vindex nntp-nov-is-evil
8921 If the @sc{nntp} server does not support @sc{nov}, you could set this
8922 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
8923 can be used.
8925 @item nntp-xover-commands
8926 @vindex nntp-xover-commands
8927 @cindex nov
8928 @cindex XOVER
8929 List of strings used as commands to fetch @sc{nov} lines from a
8930 server.  The default value of this variable is @code{("XOVER"
8931 "XOVERVIEW")}.
8933 @item nntp-nov-gap
8934 @vindex nntp-nov-gap
8935 @code{nntp} normally sends just one big request for @sc{nov} lines to
8936 the server.  The server responds with one huge list of lines.  However,
8937 if you have read articles 2-5000 in the group, and only want to read
8938 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
8939 lines that you will not need.  This variable says how
8940 big a gap between two consecutive articles is allowed to be before the
8941 @code{XOVER} request is split into several request.  Note that if your
8942 network is fast, setting this variable to a really small number means
8943 that fetching will probably be slower.  If this variable is @code{nil},
8944 @code{nntp} will never split requests.  The default is 5.
8946 @item nntp-prepare-server-hook
8947 @vindex nntp-prepare-server-hook
8948 A hook run before attempting to connect to an @sc{nntp} server.
8950 @item nntp-warn-about-losing-connection
8951 @vindex nntp-warn-about-losing-connection
8952 If this variable is non-@code{nil}, some noise will be made when a
8953 server closes connection.
8955 @item nntp-record-commands
8956 @vindex nntp-record-commands
8957 If non-@code{nil}, @code{nntp} will log all commands it sends to the
8958 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
8959 buffer.  This is useful if you are debugging a Gnus/@sc{nntp} connection
8960 that doesn't seem to work.
8962 @end table
8965 @node News Spool
8966 @subsection News Spool
8967 @cindex nnspool
8968 @cindex news spool
8970 Subscribing to a foreign group from the local spool is extremely easy,
8971 and might be useful, for instance, to speed up reading groups that
8972 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
8973 instance.
8975 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
8976 anything else) as the address.
8978 If you have access to a local spool, you should probably use that as the
8979 native select method (@pxref{Finding the News}).  It is normally faster
8980 than using an @code{nntp} select method, but might not be.  It depends.
8981 You just have to try to find out what's best at your site.
8983 @table @code
8985 @item nnspool-inews-program
8986 @vindex nnspool-inews-program
8987 Program used to post an article.
8989 @item nnspool-inews-switches
8990 @vindex nnspool-inews-switches
8991 Parameters given to the inews program when posting an article.
8993 @item nnspool-spool-directory
8994 @vindex nnspool-spool-directory
8995 Where @code{nnspool} looks for the articles.  This is normally
8996 @file{/usr/spool/news/}.
8998 @item nnspool-nov-directory
8999 @vindex nnspool-nov-directory
9000 Where @code{nnspool} will look for @sc{nov} files.  This is normally
9001 @file{/usr/spool/news/over.view/}.
9003 @item nnspool-lib-dir
9004 @vindex nnspool-lib-dir
9005 Where the news lib dir is (@file{/usr/lib/news/} by default).
9007 @item nnspool-active-file
9008 @vindex nnspool-active-file
9009 The path to the active file.
9011 @item nnspool-newsgroups-file
9012 @vindex nnspool-newsgroups-file
9013 The path to the group descriptions file.
9015 @item nnspool-history-file
9016 @vindex nnspool-history-file
9017 The path to the news history file.
9019 @item nnspool-active-times-file
9020 @vindex nnspool-active-times-file
9021 The path to the active date file.
9023 @item nnspool-nov-is-evil
9024 @vindex nnspool-nov-is-evil
9025 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9026 that it finds.
9028 @item nnspool-sift-nov-with-sed
9029 @vindex nnspool-sift-nov-with-sed
9030 @cindex sed
9031 If non-@code{nil}, which is the default, use @code{sed} to get the
9032 relevant portion from the overview file.  If nil, @code{nnspool} will
9033 load the entire file into a buffer and process it there.
9035 @end table
9038 @node Getting Mail
9039 @section Getting Mail
9040 @cindex reading mail
9041 @cindex mail
9043 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9044 course.
9046 @menu
9047 * Getting Started Reading Mail:: A simple cookbook example.
9048 * Splitting Mail::               How to create mail groups.
9049 * Mail Backend Variables::       Variables for customizing mail handling.
9050 * Fancy Mail Splitting::         Gnus can do hairy splitting of incoming mail.
9051 * Mail and Procmail::            Reading mail groups that procmail create.
9052 * Incorporating Old Mail::       What about the old mail you have?
9053 * Expiring Mail::                Getting rid of unwanted mail.
9054 * Washing Mail::                 Removing gruft from the mail you get.
9055 * Duplicates::                   Dealing with duplicated mail.
9056 * Not Reading Mail::             Using mail backends for reading other files.
9057 * Choosing a Mail Backend::      Gnus can read a variety of mail formats.
9058 @end menu
9061 @node Getting Started Reading Mail
9062 @subsection Getting Started Reading Mail
9064 It's quite easy to use Gnus to read your new mail.  You just plonk the
9065 mail backend of your choice into @code{gnus-secondary-select-methods},
9066 and things will happen automatically.
9068 For instance, if you want to use @code{nnml} (which is a "one file per
9069 mail" backend), you could put the following in your @file{.gnus} file:
9071 @lisp
9072 (setq gnus-secondary-select-methods
9073       '((nnml "private")))
9074 @end lisp
9076 Now, the next time you start Gnus, this backend will be queried for new
9077 articles, and it will move all the messages in your spool file to its
9078 directory, which is @code{~/Mail/} by default.  The new group that will
9079 be created (@samp{mail.misc}) will be subscribed, and you can read it
9080 like any other group.
9082 You will probably want to split the mail into several groups, though:
9084 @lisp
9085 (setq nnmail-split-methods
9086       '(("junk" "^From:.*Lars Ingebrigtsen")
9087         ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
9088         ("other" "")))
9089 @end lisp
9091 This will result in three new @code{nnml} mail groups being created:
9092 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}.  All the
9093 mail that doesn't fit into the first two groups will be placed in the
9094 last group.
9096 This should be sufficient for reading mail with Gnus.  You might want to
9097 give the other sections in this part of the manual a perusal, though.
9098 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
9101 @node Splitting Mail
9102 @subsection Splitting Mail
9103 @cindex splitting mail
9104 @cindex mail splitting
9106 @vindex nnmail-split-methods
9107 The @code{nnmail-split-methods} variable says how the incoming mail is
9108 to be split into groups.
9110 @lisp
9111 (setq nnmail-split-methods
9112   '(("mail.junk" "^From:.*Lars Ingebrigtsen")
9113     ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
9114     ("mail.other" "")))
9115 @end lisp
9117 This variable is a list of lists, where the first element of each of
9118 these lists is the name of the mail group (they do not have to be called
9119 something beginning with @samp{mail}, by the way), and the second
9120 element is a regular expression used on the header of each mail to
9121 determine if it belongs in this mail group.  The first string may
9122 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
9123 insert sub-expressions from the matched text.  For instance:
9125 @lisp
9126 ("list.\\1" "From:.*\\(.*\\)-list@@majordomo.com")
9127 @end lisp
9129 The second element can also be a function.  In that case, it will be
9130 called narrowed to the headers with the first element of the rule as the
9131 argument.  It should return a non-@code{nil} value if it thinks that the
9132 mail belongs in that group.
9134 The last of these groups should always be a general one, and the regular
9135 expression should @emph{always} be @samp{} so that it matches any mails
9136 that haven't been matched by any of the other regexps.  (These rules are
9137 processed from the beginning of the alist toward the end.  The first
9138 rule to make a match will "win", unless you have crossposting enabled.
9139 In that case, all matching rules will "win".)
9141 If you like to tinker with this yourself, you can set this variable to a
9142 function of your choice.  This function will be called without any
9143 arguments in a buffer narrowed to the headers of an incoming mail
9144 message.  The function should return a list of group names that it
9145 thinks should carry this mail message.
9147 Note that the mail backends are free to maul the poor, innocent,
9148 incoming headers all they want to.  They all add @code{Lines} headers;
9149 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
9150 @code{From<SPACE>} line to something else.
9152 @vindex nnmail-crosspost
9153 The mail backends all support cross-posting.  If several regexps match,
9154 the mail will be ``cross-posted'' to all those groups.
9155 @code{nnmail-crosspost} says whether to use this mechanism or not.  Note
9156 that no articles are crossposted to the general (@samp{}) group.
9158 @vindex nnmail-crosspost-link-function
9159 @cindex crosspost
9160 @cindex links
9161 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
9162 the crossposted articles.  However, not all file systems support hard
9163 links.  If that's the case for you, set
9164 @code{nnmail-crosspost-link-function} to @code{copy-file}.  (This
9165 variable is @code{add-name-to-file} by default.)
9167 @kindex M-x nnmail-split-history
9168 @kindex nnmail-split-history
9169 If you wish to see where the previous mail split put the messages, you
9170 can use the @kbd{M-x nnmail-split-history} command.
9172 Gnus gives you all the opportunity you could possibly want for shooting
9173 yourself in the foot.  Let's say you create a group that will contain
9174 all the mail you get from your boss.  And then you accidentally
9175 unsubscribe from the group.  Gnus will still put all the mail from your
9176 boss in the unsubscribed group, and so, when your boss mails you ``Have
9177 that report ready by Monday or you're fired!'', you'll never see it and,
9178 come Tuesday, you'll still believe that you're gainfully employed while
9179 you really should be out collecting empty bottles to save up for next
9180 month's rent money.
9183 @node Mail Backend Variables
9184 @subsection Mail Backend Variables
9186 These variables are (for the most part) pertinent to all the various
9187 mail backends.
9189 @table @code
9190 @vindex nnmail-read-incoming-hook
9191 @item nnmail-read-incoming-hook
9192 The mail backends all call this hook after reading new mail.  You can
9193 use this hook to notify any mail watch programs, if you want to.
9195 @vindex nnmail-spool-file
9196 @item nnmail-spool-file
9197 @cindex POP mail
9198 @cindex MAILHOST
9199 @cindex movemail
9200 @vindex nnmail-pop-password
9201 @vindex nnmail-pop-password-required
9202 The backends will look for new mail in this file.  If this variable is
9203 @code{nil}, the mail backends will never attempt to fetch mail by
9204 themselves.  If you are using a POP mail server and your name is
9205 @samp{larsi}, you should set this variable to @samp{po:larsi}.  If
9206 your name is not @samp{larsi}, you should probably modify that
9207 slightly, but you may have guessed that already, you smart & handsome
9208 devil!  You can also set this variable to @code{pop}, and Gnus will try
9209 to figure out the POP mail string by itself.  In any case, Gnus will
9210 call @code{movemail} which will contact the POP server named in the
9211 @code{MAILHOST} environment variable.  You may also specify the POP
9212 server host name in @code{nnmail-spool-file} using the syntax
9213 @samp{po:larsi:@var{pop-server-host-name}}.  If the POP server needs a
9214 password, you can either set @code{nnmail-pop-password-required} to
9215 @code{t} and be prompted for the password, or set
9216 @code{nnmail-pop-password} to the password itself.
9218 @code{nnmail-spool-file} can also be a list of mailboxes.
9220 Your Emacs has to have been configured with @samp{--with-pop} before
9221 compilation.  This is the default, but some installations have it
9222 switched off.
9224 When you use a mail backend, Gnus will slurp all your mail from your
9225 inbox and plonk it down in your home directory.  Gnus doesn't move any
9226 mail if you're not using a mail backend---you have to do a lot of magic
9227 invocations first.  At the time when you have finished drawing the
9228 pentagram, lightened the candles, and sacrificed the goat, you really
9229 shouldn't be too surprised when Gnus moves your mail.
9231 @vindex nnmail-use-procmail
9232 @vindex nnmail-procmail-suffix
9233 @item nnmail-use-procmail
9234 If non-@code{nil}, the mail backends will look in
9235 @code{nnmail-procmail-directory} for incoming mail.  All the files in
9236 that directory that have names ending in @code{nnmail-procmail-suffix}
9237 will be considered incoming mailboxes, and will be searched for new
9238 mail.
9240 @vindex nnmail-crash-box
9241 @item nnmail-crash-box
9242 When a mail backend reads a spool file, mail is first moved to this
9243 file, which is @file{~/.gnus-crash-box} by default.  If this file
9244 already exists, it will always be read (and incorporated) before any
9245 other spool files.
9247 @vindex nnmail-prepare-incoming-hook
9248 @item nnmail-prepare-incoming-hook
9249 This is run in a buffer that holds all the new incoming mail, and can be
9250 used for, well, anything, really.
9252 @vindex nnmail-split-hook
9253 @item nnmail-split-hook
9254 @findex article-decode-rfc1522
9255 @findex RFC1522 decoding
9256 Hook run in the buffer where the mail headers of each message is kept
9257 just before the splitting based on these headers is done.  The hook is
9258 free to modify the buffer contents in any way it sees fit---the buffer
9259 is discarded after the splitting has been done, and no changes performed
9260 in the buffer will show up in any files.  @code{gnus-article-decode-rfc1522}
9261 is one likely function to add to this hook.
9263 @vindex nnmail-pre-get-new-mail-hook
9264 @vindex nnmail-post-get-new-mail-hook
9265 @item nnmail-pre-get-new-mail-hook
9266 @itemx nnmail-post-get-new-mail-hook
9267 These are two useful hooks executed when treating new incoming
9268 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
9269 starting to handle the new mail) and
9270 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
9271 is done).  Here's and example of using these two hooks to change the
9272 default file modes the new mail files get:
9274 @lisp
9275 (add-hook 'gnus-pre-get-new-mail-hook
9276           (lambda () (set-default-file-modes 511)))
9278 (add-hook 'gnus-post-get-new-mail-hook
9279           (lambda () (set-default-file-modes 551)))
9280 @end lisp
9282 @item nnmail-tmp-directory
9283 @vindex nnmail-tmp-directory
9284 This variable says where to move incoming mail to -- while processing
9285 it.  This is usually done in the same directory that the mail backend
9286 inhabits (e.g., @file{~/Mail/}), but if this variable is non-@code{nil},
9287 it will be used instead.
9289 @item nnmail-movemail-program
9290 @vindex nnmail-movemail-program
9291 This program is executed to move mail from the user's inbox to her home
9292 directory.  The default is @samp{movemail}.
9294 This can also be a function.  In that case, the function will be called
9295 with two parameters -- the name of the inbox, and the file to be moved
9298 @item nnmail-delete-incoming
9299 @vindex nnmail-delete-incoming
9300 @cindex incoming mail files
9301 @cindex deleting incoming files
9302 If non-@code{nil}, the mail backends will delete the temporary incoming
9303 file after splitting mail into the proper groups.  This is @code{t} by
9304 default.
9306 @c This is @code{nil} by
9307 @c default for reasons of security.
9309 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
9310 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
9311 lost mail, I think, but that's not the point.  (Except certain versions
9312 of Red Gnus.))  By not deleting the Incoming* files, one can be sure not
9313 to lose mail -- if Gnus totally whacks out, one can always recover what
9314 was lost.
9316 You may delete the @file{Incoming*} files at will.
9318 @item nnmail-use-long-file-names
9319 @vindex nnmail-use-long-file-names
9320 If non-@code{nil}, the mail backends will use long file and directory
9321 names.  Groups like @samp{mail.misc} will end up in directories
9322 (assuming use of @code{nnml} backend) or files (assuming use of
9323 @code{nnfolder} backend) like @file{mail.misc}.  If it is @code{nil},
9324 the same group will end up in @file{mail/misc}.
9326 @item nnmail-delete-file-function
9327 @vindex nnmail-delete-file-function
9328 @findex delete-file
9329 Function called to delete files.  It is @code{delete-file} by default.
9331 @item nnmail-cache-accepted-message-ids
9332 @vindex nnmail-cache-accepted-message-ids
9333 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
9334 the backend (via @code{Gcc}, for instance) into the mail duplication
9335 discovery cache.  The default is @code{nil}.
9337 @end table
9340 @node Fancy Mail Splitting
9341 @subsection Fancy Mail Splitting
9342 @cindex mail splitting
9343 @cindex fancy mail splitting
9345 @vindex nnmail-split-fancy
9346 @findex nnmail-split-fancy
9347 If the rather simple, standard method for specifying how to split mail
9348 doesn't allow you to do what you want, you can set
9349 @code{nnmail-split-methods} to @code{nnmail-split-fancy}.  Then you can
9350 play with the @code{nnmail-split-fancy} variable.
9352 Let's look at an example value of this variable first:
9354 @lisp
9355 ;; Messages from the mailer daemon are not crossposted to any of
9356 ;; the ordinary groups.  Warnings are put in a separate group
9357 ;; from real errors.
9358 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
9359                    "mail.misc"))
9360    ;; Non-error messages are crossposted to all relevant
9361    ;; groups, but we don't crosspost between the group for the
9362    ;; (ding) list and the group for other (ding) related mail.
9363    (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
9364          ("subject" "ding" "ding.misc"))
9365       ;; Other mailing lists...
9366       (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
9367       (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
9368       ;; People...
9369       (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
9370    ;; Unmatched mail goes to the catch all group.
9371    "misc.misc")
9372 @end lisp
9374 This variable has the format of a @dfn{split}.  A split is a (possibly)
9375 recursive structure where each split may contain other splits.  Here are
9376 the five possible split syntaxes:
9378 @enumerate
9380 @item
9381 @samp{group}: If the split is a string, that will be taken as a group
9382 name.  Normal regexp match expansion will be done.  See below for
9383 examples. 
9385 @item
9386 @code{(@var{field} @var{value} @var{split})}: If the split is a list, the first element of
9387 which is a string, then store the message as specified by SPLIT, if
9388 header FIELD (a regexp) contains VALUE (also a regexp).
9390 @item
9391 @code{(| @var{split}...)}: If the split is a list, and the first element is
9392 @code{|} (vertical bar), then process each SPLIT until one of them
9393 matches.  A @var{split} is said to match if it will cause the mail message to
9394 be stored in one or more groups.
9396 @item
9397 @code{(& @var{split}...)}: If the split is a list, and the first element is
9398 @code{&}, then process all @var{split}s in the list.
9400 @item
9401 @code{junk}: If the split is the symbol @code{junk}, then don't save
9402 this message. Use with extreme caution.
9404 @item
9405 @code{(: @var{function} @var{arg1} @var{arg2} @dots{})}:  If the split is a list, and the first
9406 element is @code{:}, then the second element will be called as a
9407 function with @var{args} given as arguments.  The function should return
9408 a SPLIT.
9410 @item
9411 @code{nil}: If the split is @code{nil}, it is ignored.
9413 @end enumerate
9415 In these splits, @var{FIELD} must match a complete field name.
9416 @var{VALUE} must match a complete word according to the fundamental mode
9417 syntax table.  You can use @code{.*} in the regexps to match partial
9418 field names or words.  In other words, all @var{VALUE}'s are wrapped in
9419 @samp{\<} and @samp{\>} pairs.
9421 @vindex nnmail-split-abbrev-alist
9422 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
9423 are expanded as specified by the variable
9424 @code{nnmail-split-abbrev-alist}.  This is an alist of cons cells, where
9425 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
9426 value.
9428 @vindex nnmail-split-fancy-syntax-table
9429 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
9430 when all this splitting is performed.
9432 If you want to have Gnus create groups dynamically based on some
9433 information in the headers (i.e., do @code{replace-match}-like
9434 substitutions in the group names), you can say things like:
9436 @example
9437 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
9438 @end example
9440 If the string contains the element @samp{\&}, then the previously
9441 matched string will be substituted.  Similarly, the elements @samp{\\1}
9442 up to @samp{\\9} will be substituted with the text matched by the
9443 groupings 1 through 9.
9446 @node Mail and Procmail
9447 @subsection Mail and Procmail
9448 @cindex procmail
9450 @cindex slocal
9451 @cindex elm
9452 Many people use @code{procmail} (or some other mail filter program or
9453 external delivery agent---@code{slocal}, @code{elm}, etc) to split
9454 incoming mail into groups.  If you do that, you should set
9455 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
9456 backends never ever try to fetch mail by themselves.
9458 If you have a combined @code{procmail}/POP/mailbox setup, you can do
9459 something like the following:
9461 @vindex nnmail-use-procmail
9462 @lisp
9463 (setq nnmail-use-procmail t)
9464 (setq nnmail-spool-file
9465       '("/usr/spool/mail/my-name" "po:my-name"))
9466 @end lisp
9468 This also means that you probably don't want to set
9469 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
9470 side effects.
9472 When a mail backend is queried for what groups it carries, it replies
9473 with the contents of that variable, along with any groups it has figured
9474 out that it carries by other means.  None of the backends, except
9475 @code{nnmh}, actually go out to the disk and check what groups actually
9476 exist.  (It's not trivial to distinguish between what the user thinks is
9477 a basis for a newsgroup and what is just a plain old file or directory.)
9479 This means that you have to tell Gnus (and the backends) by hand what
9480 groups exist.
9482 Let's take the @code{nnmh} backend as an example:
9484 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
9485 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
9487 Go to the group buffer and type @kbd{G m}.  When prompted, answer
9488 @samp{foo} for the name and @samp{nnmh} for the method.  Repeat
9489 twice for the two other groups, @samp{bar} and @samp{mail.baz}.  Be sure
9490 to include all your mail groups.
9492 That's it.  You are now set to read your mail.  An active file for this
9493 method will be created automatically.
9495 @vindex nnmail-procmail-suffix
9496 @vindex nnmail-procmail-directory
9497 If you use @code{nnfolder} or any other backend that store more than a
9498 single article in each file, you should never have procmail add mails to
9499 the file that Gnus sees.  Instead, procmail should put all incoming mail
9500 in @code{nnmail-procmail-directory}.  To arrive at the file name to put
9501 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
9502 name.  The mail backends will read the mail from these files.
9504 @vindex nnmail-resplit-incoming
9505 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
9506 put in the @code{mail.misc}, as one would expect.  However, if you want
9507 Gnus to split the mail the normal way, you could set
9508 @code{nnmail-resplit-incoming} to @code{t}.
9510 @vindex nnmail-keep-last-article
9511 If you use @code{procmail} to split things directly into an @code{nnmh}
9512 directory (which you shouldn't do), you should set
9513 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
9514 ever expiring the final article (i.e., the article with the highest
9515 article number) in a mail newsgroup.  This is quite, quite important.
9517 Here's an example setup:  The incoming spools are located in
9518 @file{~/incoming/} and have @samp{""} as suffixes (i.e., the incoming
9519 spool files have the same names as the equivalent groups).  The
9520 @code{nnfolder} backend is to be used as the mail interface, and the
9521 @code{nnfolder} directory is @file{~/fMail/}.
9523 @lisp
9524 (setq nnfolder-directory "~/fMail/")
9525 (setq nnmail-spool-file 'procmail)
9526 (setq nnmail-procmail-directory "~/incoming/")
9527 (setq gnus-secondary-select-methods '((nnfolder "")))
9528 (setq nnmail-procmail-suffix "")
9529 @end lisp
9532 @node Incorporating Old Mail
9533 @subsection Incorporating Old Mail
9535 Most people have lots of old mail stored in various file formats.  If
9536 you have set up Gnus to read mail using one of the spiffy Gnus mail
9537 backends, you'll probably wish to have that old mail incorporated into
9538 your mail groups.
9540 Doing so can be quite easy.
9542 To take an example: You're reading mail using @code{nnml}
9543 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
9544 satisfactory value (@pxref{Splitting Mail}).  You have an old Unix mbox
9545 file filled with important, but old, mail.  You want to move it into
9546 your @code{nnml} groups.
9548 Here's how:
9550 @enumerate
9551 @item
9552 Go to the group buffer.
9554 @item
9555 Type `G f' and give the path to the mbox file when prompted to create an
9556 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9558 @item
9559 Type `SPACE' to enter the newly created group.
9561 @item
9562 Type `M P b' to process-mark all articles in this group's buffer
9563 (@pxref{Setting Process Marks}).
9565 @item
9566 Type `B r' to respool all the process-marked articles, and answer
9567 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9568 @end enumerate
9570 All the mail messages in the mbox file will now also be spread out over
9571 all your @code{nnml} groups.  Try entering them and check whether things
9572 have gone without a glitch.  If things look ok, you may consider
9573 deleting the mbox file, but I wouldn't do that unless I was absolutely
9574 sure that all the mail has ended up where it should be.
9576 Respooling is also a handy thing to do if you're switching from one mail
9577 backend to another.  Just respool all the mail in the old mail groups
9578 using the new mail backend.
9581 @node Expiring Mail
9582 @subsection Expiring Mail
9583 @cindex article expiry
9585 Traditional mail readers have a tendency to remove mail articles when
9586 you mark them as read, in some way.  Gnus takes a fundamentally
9587 different approach to mail reading.
9589 Gnus basically considers mail just to be news that has been received in
9590 a rather peculiar manner.  It does not think that it has the power to
9591 actually change the mail, or delete any mail messages.  If you enter a
9592 mail group, and mark articles as ``read'', or kill them in some other
9593 fashion, the mail articles will still exist on the system.  I repeat:
9594 Gnus will not delete your old, read mail.  Unless you ask it to, of
9595 course.
9597 To make Gnus get rid of your unwanted mail, you have to mark the
9598 articles as @dfn{expirable}.  This does not mean that the articles will
9599 disappear right away, however.  In general, a mail article will be
9600 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9601 more than one week old.  If you do not mark an article as expirable, it
9602 will remain on your system until hell freezes over.  This bears
9603 repeating one more time, with some spurious capitalizations: IF you do
9604 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9606 @vindex gnus-auto-expirable-newsgroups
9607 You do not have to mark articles as expirable by hand.  Groups that
9608 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9609 have all articles that you read marked as expirable automatically.  All
9610 articles marked as expirable have an @samp{E} in the first
9611 column in the summary buffer.
9613 By default, if you have auto expiry switched on, Gnus will mark all the
9614 articles you read as expirable, no matter if they were read or unread
9615 before.  To avoid having articles marked as read marked as expirable
9616 automatically, you can put something like the following in your
9617 @file{.gnus} file:
9619 @vindex gnus-mark-article-hook
9620 @lisp
9621 (remove-hook 'gnus-mark-article-hook
9622              'gnus-summary-mark-read-and-unread-as-read)
9623 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
9624 @end lisp
9626 Note that making a group auto-expirable doesn't mean that all read
9627 articles are expired---only the articles marked as expirable
9628 will be expired.  Also note that using the @kbd{d} command won't make
9629 groups expirable---only semi-automatic marking of articles as read will
9630 mark the articles as expirable in auto-expirable groups.
9632 Let's say you subscribe to a couple of mailing lists, and you want the
9633 articles you have read to disappear after a while:
9635 @lisp
9636 (setq gnus-auto-expirable-newsgroups
9637       "mail.nonsense-list\\|mail.nice-list")
9638 @end lisp
9640 Another way to have auto-expiry happen is to have the element
9641 @code{auto-expire} in the group parameters of the group.
9643 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9644 auto-expiring, you'll have problems.  Auto-expiring and adaptive scoring
9645 don't really mix very well.
9647 @vindex nnmail-expiry-wait
9648 The @code{nnmail-expiry-wait} variable supplies the default time an
9649 expirable article has to live.  Gnus starts counting days from when the
9650 message @emph{arrived}, not from when it was sent.  The default is seven
9651 days.
9653 Gnus also supplies a function that lets you fine-tune how long articles
9654 are to live, based on what group they are in.  Let's say you want to
9655 have one month expiry period in the @samp{mail.private} group, a one day
9656 expiry period in the @samp{mail.junk} group, and a six day expiry period
9657 everywhere else:
9659 @vindex nnmail-expiry-wait-function
9660 @lisp
9661 (setq nnmail-expiry-wait-function
9662       (lambda (group)
9663        (cond ((string= group "mail.private")
9664                31)
9665              ((string= group "mail.junk")
9666                1)
9667              ((string= group "important")
9668                'never)
9669              (t
9670                6))))
9671 @end lisp
9673 The group names this function is fed are ``unadorned'' group
9674 names---no @samp{nnml:} prefixes and the like.
9676 The @code{nnmail-expiry-wait} variable and
9677 @code{nnmail-expiry-wait-function} function can either be a number (not
9678 necessarily an integer) or one of the symbols @code{immediate} or
9679 @code{never}.
9681 You can also use the @code{expiry-wait} group parameter to selectively
9682 change the expiry period (@pxref{Group Parameters}).
9684 @vindex nnmail-keep-last-article
9685 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9686 expire the final article in a mail newsgroup.  This is to make life
9687 easier for procmail users.
9689 @vindex gnus-total-expirable-newsgroups
9690 By the way: That line up there, about Gnus never expiring non-expirable
9691 articles, is a lie.  If you put @code{total-expire} in the group
9692 parameters, articles will not be marked as expirable, but all read
9693 articles will be put through the expiry process.  Use with extreme
9694 caution.  Even more dangerous is the
9695 @code{gnus-total-expirable-newsgroups} variable.  All groups that match
9696 this regexp will have all read articles put through the expiry process,
9697 which means that @emph{all} old mail articles in the groups in question
9698 will be deleted after a while.  Use with extreme caution, and don't come
9699 crying to me when you discover that the regexp you used matched the
9700 wrong group and all your important mail has disappeared.  Be a
9701 @emph{man}!  Or a @emph{woman}!  Whatever you feel more comfortable
9702 with!  So there!
9704 Most people make most of their mail groups total-expirable, though.
9707 @node Washing Mail
9708 @subsection Washing Mail
9709 @cindex mail washing
9710 @cindex list server brain damage
9711 @cindex incoming mail treatment
9713 Mailers and list servers are notorious for doing all sorts of really,
9714 really stupid things with mail.  ``Hey, RFC822 doesn't explicitly
9715 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
9716 end of all lines passing through our server, so let's do that!!!!1!''
9717 Yes, but RFC822 wasn't designed to be read by morons.  Things that were
9718 considered to be self-evident were not discussed.  So.  Here we are.
9720 Case in point:  The German version of Microsoft Exchange adds @samp{AW:
9721 } to the subjects of replies instead of @samp{Re: }.  I could pretend to
9722 be shocked and dismayed by this, but I haven't got the energy.  It is to
9723 laugh.
9725 Gnus provides a plethora of functions for washing articles while
9726 displaying them, but it might be nicer to do the filtering before
9727 storing the mail to disc.  For that purpose, we have three hooks and
9728 various functions that can be put in these hooks.
9730 @table @code
9731 @item nnmail-prepare-incoming-hook
9732 @vindex nnmail-prepare-incoming-hook
9733 This hook is called before doing anything with the mail and is meant for
9734 grand, sweeping gestures.  Functions to be used include:
9736 @table @code
9737 @item nnheader-ms-strip-cr
9738 @findex nnheader-ms-strip-cr
9739 Remove trailing carriage returns from each line.  This is default on
9740 Emacs running on MS machines.
9742 @end table
9744 @item nnmail-prepare-incoming-header-hook
9745 @vindex nnmail-prepare-incoming-header-hook
9746 This hook is called narrowed to each header.  It can be used when
9747 cleaning up the headers.  Functions that can be used include:
9749 @table @code
9750 @item nnmail-remove-leading-whitespace
9751 @findex nnmail-remove-leading-whitespace
9752 Clear leading white space that ``helpful'' listservs have added to the
9753 headers to make them look nice.  Aaah.
9755 @item nnmail-remove-list-identifiers
9756 @findex nnmail-remove-list-identifiers
9757 Some list servers add an identifier---for example, @samp{(idm)}---to the
9758 beginning of all @code{Subject} headers.  I'm sure that's nice for
9759 people who use stone age mail readers.  This function will remove
9760 strings that match the @code{nnmail-list-identifiers} regexp, which can
9761 also be a list of regexp.
9763 For instance, if you want to remove the @samp{(idm)} and the
9764 @samp{nagnagnag} identifiers:
9766 @lisp
9767 (setq nnmail-list-identifiers
9768       '("(idm)" "nagnagnag"))
9769 @end lisp
9771 @item nnmail-remove-tabs
9772 @findex nnmail-remove-tabs
9773 Translate all @samp{TAB} characters into @samp{SPACE} characters.
9775 @end table
9777 @item nnmail-prepare-incoming-message-hook
9778 @vindex nnmail-prepare-incoming-message-hook
9779 This hook is called narrowed to each message.  Functions to be used
9780 include:
9782 @table @code
9783 @item article-de-quoted-unreadable
9784 @findex article-de-quoted-unreadable
9785 Decode Quoted Readable encoding.
9787 @end table
9788 @end table
9791 @node Duplicates
9792 @subsection Duplicates
9794 @vindex nnmail-treat-duplicates
9795 @vindex nnmail-message-id-cache-length
9796 @vindex nnmail-message-id-cache-file
9797 @cindex duplicate mails
9798 If you are a member of a couple of mailing lists, you will sometimes
9799 receive two copies of the same mail.  This can be quite annoying, so
9800 @code{nnmail} checks for and treats any duplicates it might find.  To do
9801 this, it keeps a cache of old @code{Message-ID}s---
9802 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
9803 default.  The approximate maximum number of @code{Message-ID}s stored
9804 there is controlled by the @code{nnmail-message-id-cache-length}
9805 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
9806 stored.) If all this sounds scary to you, you can set
9807 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
9808 default), and @code{nnmail} won't delete duplicate mails.  Instead it
9809 will insert a warning into the head of the mail saying that it thinks
9810 that this is a duplicate of a different message.
9812 This variable can also be a function.  If that's the case, the function
9813 will be called from a buffer narrowed to the message in question with
9814 the @code{Message-ID} as a parameter.  The function must return either
9815 @code{nil}, @code{warn}, or @code{delete}.
9817 You can turn this feature off completely by setting the variable to
9818 @code{nil}.
9820 If you want all the duplicate mails to be put into a special
9821 @dfn{duplicates} group, you could do that using the normal mail split
9822 methods:
9824 @lisp
9825 (setq nnmail-split-fancy
9826       '(| ;; Messages duplicates go to a separate group.
9827           ("gnus-warning" "duplication of message" "duplicate")
9828           ;; Message from daemons, postmaster, and the like to another.
9829           (any mail "mail.misc")
9830           ;; Other rules.
9831           [ ... ] ))
9832 @end lisp
9834 Or something like:
9835 @lisp
9836 (setq nnmail-split-methods
9837       '(("duplicates" "^Gnus-Warning:")
9838         ;; Other rules.
9839         [...]))
9840 @end lisp
9842 Here's a neat feature: If you know that the recipient reads her mail
9843 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
9844 @code{delete}, you can send her as many insults as you like, just by
9845 using a @code{Message-ID} of a mail that you know that she's already
9846 received.  Think of all the fun!  She'll never see any of it!  Whee!
9849 @node Not Reading Mail
9850 @subsection Not Reading Mail
9852 If you start using any of the mail backends, they have the annoying
9853 habit of assuming that you want to read mail with them.  This might not
9854 be unreasonable, but it might not be what you want.
9856 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
9857 will ever attempt to read incoming mail, which should help.
9859 @vindex nnbabyl-get-new-mail
9860 @vindex nnmbox-get-new-mail
9861 @vindex nnml-get-new-mail
9862 @vindex nnmh-get-new-mail
9863 @vindex nnfolder-get-new-mail
9864 This might be too much, if, for instance, you are reading mail quite
9865 happily with @code{nnml} and just want to peek at some old @sc{rmail}
9866 file you have stashed away with @code{nnbabyl}.  All backends have
9867 variables called backend-@code{get-new-mail}.  If you want to disable
9868 the @code{nnbabyl} mail reading, you edit the virtual server for the
9869 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
9871 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
9872 narrowed to the article to be saved before saving it when reading
9873 incoming mail.
9876 @node Choosing a Mail Backend
9877 @subsection Choosing a Mail Backend
9879 Gnus will read the mail spool when you activate a mail group.  The mail
9880 file is first copied to your home directory.  What happens after that
9881 depends on what format you want to store your mail in.
9883 @menu
9884 * Unix Mail Box::               Using the (quite) standard Un*x mbox.
9885 * Rmail Babyl::                 Emacs programs use the rmail babyl format.
9886 * Mail Spool::                  Store your mail in a private spool?
9887 * MH Spool::                    An mhspool-like backend.
9888 * Mail Folders::                Having one file for each group.
9889 @end menu
9892 @node Unix Mail Box
9893 @subsubsection Unix Mail Box
9894 @cindex nnmbox
9895 @cindex unix mail box
9897 @vindex nnmbox-active-file
9898 @vindex nnmbox-mbox-file
9899 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
9900 mail.  @code{nnmbox} will add extra headers to each mail article to say
9901 which group it belongs in.
9903 Virtual server settings:
9905 @table @code
9906 @item nnmbox-mbox-file
9907 @vindex nnmbox-mbox-file
9908 The name of the mail box in the user's home directory.
9910 @item nnmbox-active-file
9911 @vindex nnmbox-active-file
9912 The name of the active file for the mail box.
9914 @item nnmbox-get-new-mail
9915 @vindex nnmbox-get-new-mail
9916 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
9917 into groups.
9918 @end table
9921 @node Rmail Babyl
9922 @subsubsection Rmail Babyl
9923 @cindex nnbabyl
9924 @cindex rmail mbox
9926 @vindex nnbabyl-active-file
9927 @vindex nnbabyl-mbox-file
9928 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
9929 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
9930 article to say which group it belongs in.
9932 Virtual server settings:
9934 @table @code
9935 @item nnbabyl-mbox-file
9936 @vindex nnbabyl-mbox-file
9937 The name of the rmail mbox file.
9939 @item nnbabyl-active-file
9940 @vindex nnbabyl-active-file
9941 The name of the active file for the rmail box.
9943 @item nnbabyl-get-new-mail
9944 @vindex nnbabyl-get-new-mail
9945 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
9946 @end table
9949 @node Mail Spool
9950 @subsubsection Mail Spool
9951 @cindex nnml
9952 @cindex mail @sc{nov} spool
9954 The @dfn{nnml} spool mail format isn't compatible with any other known
9955 format.  It should be used with some caution.
9957 @vindex nnml-directory
9958 If you use this backend, Gnus will split all incoming mail into files,
9959 one file for each mail, and put the articles into the corresponding
9960 directories under the directory specified by the @code{nnml-directory}
9961 variable.  The default value is @file{~/Mail/}.
9963 You do not have to create any directories beforehand; Gnus will take
9964 care of all that.
9966 If you have a strict limit as to how many files you are allowed to store
9967 in your account, you should not use this backend.  As each mail gets its
9968 own file, you might very well occupy thousands of inodes within a few
9969 weeks.  If this is no problem for you, and it isn't a problem for you
9970 having your friendly systems administrator walking around, madly,
9971 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
9972 know that this is probably the fastest format to use.  You do not have
9973 to trudge through a big mbox file just to read your new mail.
9975 @code{nnml} is probably the slowest backend when it comes to article
9976 splitting.  It has to create lots of files, and it also generates
9977 @sc{nov} databases for the incoming mails.  This makes it the fastest
9978 backend when it comes to reading mail.
9980 Virtual server settings:
9982 @table @code
9983 @item nnml-directory
9984 @vindex nnml-directory
9985 All @code{nnml} directories will be placed under this directory.
9987 @item nnml-active-file
9988 @vindex nnml-active-file
9989 The active file for the @code{nnml} server.
9991 @item nnml-newsgroups-file
9992 @vindex nnml-newsgroups-file
9993 The @code{nnml} group descriptions file.  @xref{Newsgroups File
9994 Format}.
9996 @item nnml-get-new-mail
9997 @vindex nnml-get-new-mail
9998 If non-@code{nil}, @code{nnml} will read incoming mail.
10000 @item nnml-nov-is-evil
10001 @vindex nnml-nov-is-evil
10002 If non-@code{nil}, this backend will ignore any @sc{nov} files.
10004 @item nnml-nov-file-name
10005 @vindex nnml-nov-file-name
10006 The name of the @sc{nov} files.  The default is @file{.overview}.
10008 @item nnml-prepare-save-mail-hook
10009 @vindex nnml-prepare-save-mail-hook
10010 Hook run narrowed to an article before saving.
10012 @end table
10014 @findex nnml-generate-nov-databases
10015 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
10016 you can do a complete update by typing @kbd{M-x
10017 nnml-generate-nov-databases}.  This command will trawl through the
10018 entire @code{nnml} hierarchy, looking at each and every article, so it
10019 might take a while to complete.  A better interface to this
10020 functionality can be found in the server buffer (@pxref{Server
10021 Commands}).
10024 @node MH Spool
10025 @subsubsection MH Spool
10026 @cindex nnmh
10027 @cindex mh-e mail spool
10029 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
10030 @sc{nov} databases and it doesn't keep an active file.  This makes
10031 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
10032 makes it easier to write procmail scripts for.
10034 Virtual server settings:
10036 @table @code
10037 @item nnmh-directory
10038 @vindex nnmh-directory
10039 All @code{nnmh} directories will be located under this directory.
10041 @item nnmh-get-new-mail
10042 @vindex nnmh-get-new-mail
10043 If non-@code{nil}, @code{nnmh} will read incoming mail.
10045 @item nnmh-be-safe
10046 @vindex nnmh-be-safe
10047 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
10048 sure that the articles in the folder are actually what Gnus thinks they
10049 are.  It will check date stamps and stat everything in sight, so
10050 setting this to @code{t} will mean a serious slow-down.  If you never
10051 use anything but Gnus to read the @code{nnmh} articles, you do not have
10052 to set this variable to @code{t}.
10053 @end table
10056 @node Mail Folders
10057 @subsubsection Mail Folders
10058 @cindex nnfolder
10059 @cindex mbox folders
10060 @cindex mail folders
10062 @code{nnfolder} is a backend for storing each mail group in a separate
10063 file.  Each file is in the standard Un*x mbox format.  @code{nnfolder}
10064 will add extra headers to keep track of article numbers and arrival
10065 dates.
10067 Virtual server settings:
10069 @table @code
10070 @item nnfolder-directory
10071 @vindex nnfolder-directory
10072 All the @code{nnfolder} mail boxes will be stored under this directory.
10074 @item nnfolder-active-file
10075 @vindex nnfolder-active-file
10076 The name of the active file.
10078 @item nnfolder-newsgroups-file
10079 @vindex nnfolder-newsgroups-file
10080 The name of the group descriptions file.  @xref{Newsgroups File Format}.
10082 @item nnfolder-get-new-mail
10083 @vindex nnfolder-get-new-mail
10084 If non-@code{nil}, @code{nnfolder} will read incoming mail.
10086 @item nnfolder-save-buffer-hook
10087 @vindex nnfolder-save-buffer-hook
10088 @cindex backup files
10089 Hook run before saving the folders.  Note that Emacs does the normal
10090 backup renaming of files even with the @code{nnfolder} buffers.  If you
10091 wish to switch this off, you could say something like the following in
10092 your @file{.emacs} file:
10094 @lisp
10095 (defun turn-off-backup ()
10096   (set (make-local-variable 'backup-inhibited) t))
10098 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
10099 @end lisp
10101 @end table
10104 @findex nnfolder-generate-active-file
10105 @kindex M-x nnfolder-generate-active-file
10106 If you have lots of @code{nnfolder}-like files you'd like to read with
10107 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
10108 command to make @code{nnfolder} aware of all likely files in
10109 @code{nnfolder-directory}.
10112 @node Other Sources
10113 @section Other Sources
10115 Gnus can do more than just read news or mail.  The methods described
10116 below allow Gnus to view directories and files as if they were
10117 newsgroups.
10119 @menu
10120 * Directory Groups::      You can read a directory as if it was a newsgroup.
10121 * Anything Groups::       Dired?  Who needs dired?
10122 * Document Groups::       Single files can be the basis of a group.
10123 * SOUP::                  Reading @sc{soup} packets ``offline''.
10124 * Web Searches::          Creating groups from articles that match a string.
10125 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
10126 @end menu
10129 @node Directory Groups
10130 @subsection Directory Groups
10131 @cindex nndir
10132 @cindex directory groups
10134 If you have a directory that has lots of articles in separate files in
10135 it, you might treat it as a newsgroup.  The files have to have numerical
10136 names, of course.
10138 This might be an opportune moment to mention @code{ange-ftp} (and its
10139 successor @code{efs}), that most wonderful of all wonderful Emacs
10140 packages.  When I wrote @code{nndir}, I didn't think much about it---a
10141 backend to read directories.  Big deal.
10143 @code{ange-ftp} changes that picture dramatically.  For instance, if you
10144 enter the @code{ange-ftp} file name
10145 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
10146 @code{ange-ftp} or @code{efs} will actually allow you to read this
10147 directory over at @samp{sina} as a newsgroup.  Distributed news ahoy!
10149 @code{nndir} will use @sc{nov} files if they are present.
10151 @code{nndir} is a ``read-only'' backend---you can't delete or expire
10152 articles with this method.  You can use @code{nnmh} or @code{nnml} for
10153 whatever you use @code{nndir} for, so you could switch to any of those
10154 methods if you feel the need to have a non-read-only @code{nndir}.
10157 @node Anything Groups
10158 @subsection Anything Groups
10159 @cindex nneething
10161 From the @code{nndir} backend (which reads a single spool-like
10162 directory), it's just a hop and a skip to @code{nneething}, which
10163 pretends that any arbitrary directory is a newsgroup.  Strange, but
10164 true.
10166 When @code{nneething} is presented with a directory, it will scan this
10167 directory and assign article numbers to each file.  When you enter such
10168 a group, @code{nneething} must create ``headers'' that Gnus can use.
10169 After all, Gnus is a newsreader, in case you're
10170 forgetting. @code{nneething} does this in a two-step process.  First, it
10171 snoops each file in question.  If the file looks like an article (i.e.,
10172 the first few lines look like headers), it will use this as the head.
10173 If this is just some arbitrary file without a head (e.g. a C source
10174 file), @code{nneething} will cobble up a header out of thin air.  It
10175 will use file ownership, name and date and do whatever it can with these
10176 elements.
10178 All this should happen automatically for you, and you will be presented
10179 with something that looks very much like a newsgroup.  Totally like a
10180 newsgroup, to be precise.  If you select an article, it will be displayed
10181 in the article buffer, just as usual.
10183 If you select a line that represents a directory, Gnus will pop you into
10184 a new summary buffer for this @code{nneething} group.  And so on.  You can
10185 traverse the entire disk this way, if you feel like, but remember that
10186 Gnus is not dired, really, and does not intend to be, either.
10188 There are two overall modes to this action---ephemeral or solid.  When
10189 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
10190 will not store information on what files you have read, and what files
10191 are new, and so on.  If you create a solid @code{nneething} group the
10192 normal way with @kbd{G m}, Gnus will store a mapping table between
10193 article numbers and file names, and you can treat this group like any
10194 other groups.  When you activate a solid @code{nneething} group, you will
10195 be told how many unread articles it contains, etc., etc.
10197 Some variables:
10199 @table @code
10200 @item nneething-map-file-directory
10201 @vindex nneething-map-file-directory
10202 All the mapping files for solid @code{nneething} groups will be stored
10203 in this directory, which defaults to @file{~/.nneething/}.
10205 @item nneething-exclude-files
10206 @vindex nneething-exclude-files
10207 All files that match this regexp will be ignored.  Nice to use to exclude
10208 auto-save files and the like, which is what it does by default.
10210 @item nneething-map-file
10211 @vindex nneething-map-file
10212 Name of the map files.
10213 @end table
10216 @node Document Groups
10217 @subsection Document Groups
10218 @cindex nndoc
10219 @cindex documentation group
10220 @cindex help group
10222 @code{nndoc} is a cute little thing that will let you read a single file
10223 as a newsgroup.  Several files types are supported:
10225 @table @code
10226 @cindex babyl
10227 @cindex rmail mbox
10229 @item babyl
10230 The babyl (rmail) mail box.
10231 @cindex mbox
10232 @cindex Unix mbox
10234 @item mbox
10235 The standard Unix mbox file.
10237 @cindex MMDF mail box
10238 @item mmdf
10239 The MMDF mail box format.
10241 @item news
10242 Several news articles appended into a file.
10244 @item rnews
10245 @cindex rnews batch files
10246 The rnews batch transport format.
10247 @cindex forwarded messages
10249 @item forward
10250 Forwarded articles.
10252 @item mime-parts
10253 MIME multipart messages, besides digests.
10255 @item mime-digest
10256 @cindex digest
10257 @cindex MIME digest
10258 @cindex 1153 digest
10259 @cindex RFC 1153 digest
10260 @cindex RFC 341 digest
10261 MIME (RFC 1341) digest format.
10263 @item standard-digest
10264 The standard (RFC 1153) digest format.
10266 @item slack-digest
10267 Non-standard digest format---matches most things, but does it badly.
10268 @end table
10270 You can also use the special ``file type'' @code{guess}, which means
10271 that @code{nndoc} will try to guess what file type it is looking at.
10272 @code{digest} means that @code{nndoc} should guess what digest type the
10273 file is.
10275 @code{nndoc} will not try to change the file or insert any extra headers into
10276 it---it will simply, like, let you use the file as the basis for a
10277 group.  And that's it.
10279 If you have some old archived articles that you want to insert into your
10280 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
10281 that.  Say you have an old @file{RMAIL} file with mail that you now want
10282 to split into your new @code{nnml} groups.  You look at that file using
10283 @code{nndoc} (using the @kbd{G f} command in the group buffer
10284 (@pxref{Foreign Groups})), set the process mark on all the articles in
10285 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
10286 using @code{nnml}.  If all goes well, all the mail in the @file{RMAIL}
10287 file is now also stored in lots of @code{nnml} directories, and you can
10288 delete that pesky @file{RMAIL} file.  If you have the guts!
10290 Virtual server variables:
10292 @table @code
10293 @item nndoc-article-type
10294 @vindex nndoc-article-type
10295 This should be one of @code{mbox}, @code{babyl}, @code{digest},
10296 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
10297 @code{rfc822-forward}, @code{mime-parts}, @code{mime-digest},
10298 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs} or
10299 @code{guess}.
10301 @item nndoc-post-type
10302 @vindex nndoc-post-type
10303 This variable says whether Gnus is to consider the group a news group or
10304 a mail group.  There are two valid values:  @code{mail} (the default)
10305 and @code{news}.
10306 @end table
10308 @menu
10309 * Document Server Internals::   How to add your own document types.
10310 @end menu
10313 @node Document Server Internals
10314 @subsubsection Document Server Internals
10316 Adding new document types to be recognized by @code{nndoc} isn't
10317 difficult.  You just have to whip up a definition of what the document
10318 looks like, write a predicate function to recognize that document type,
10319 and then hook into @code{nndoc}.
10321 First, here's an example document type definition:
10323 @example
10324 (mmdf
10325  (article-begin .  "^\^A\^A\^A\^A\n")
10326  (body-end .  "^\^A\^A\^A\^A\n"))
10327 @end example
10329 The definition is simply a unique @dfn{name} followed by a series of
10330 regexp pseudo-variable settings.  Below are the possible
10331 variables---don't be daunted by the number of variables; most document
10332 types can be defined with very few settings:
10334 @table @code
10335 @item first-article
10336 If present, @code{nndoc} will skip past all text until it finds
10337 something that match this regexp.  All text before this will be
10338 totally ignored.
10340 @item article-begin
10341 This setting has to be present in all document type definitions.  It
10342 says what the beginning of each article looks like.
10344 @item head-begin-function
10345 If present, this should be a function that moves point to the head of
10346 the article.
10348 @item nndoc-head-begin
10349 If present, this should be a regexp that matches the head of the
10350 article.
10352 @item nndoc-head-end
10353 This should match the end of the head of the article.  It defaults to
10354 @samp{^$}---the empty line.
10356 @item body-begin-function
10357 If present, this function should move point to the beginning of the body
10358 of the article.
10360 @item body-begin
10361 This should match the beginning of the body of the article.  It defaults
10362 to @samp{^\n}.
10364 @item body-end-function
10365 If present, this function should move point to the end of the body of
10366 the article.
10368 @item body-end
10369 If present, this should match the end of the body of the article.
10371 @item file-end
10372 If present, this should match the end of the file.  All text after this
10373 regexp will be totally ignored.
10375 @end table
10377 So, using these variables @code{nndoc} is able to dissect a document
10378 file into a series of articles, each with a head and a body.  However, a
10379 few more variables are needed since not all document types are all that
10380 news-like---variables needed to transform the head or the body into
10381 something that's palatable for Gnus:
10383 @table @code
10384 @item prepare-body-function
10385 If present, this function will be called when requesting an article.  It
10386 will be called with point at the start of the body, and is useful if the
10387 document has encoded some parts of its contents.
10389 @item article-transform-function
10390 If present, this function is called when requesting an article.  It's
10391 meant to be used for more wide-ranging transformation of both head and
10392 body of the article.
10394 @item generate-head-function
10395 If present, this function is called to generate a head that Gnus can
10396 understand.  It is called with the article number as a parameter, and is
10397 expected to generate a nice head for the article in question.  It is
10398 called when requesting the headers of all articles.
10400 @end table
10402 Let's look at the most complicated example I can come up with---standard
10403 digests:
10405 @example
10406 (standard-digest
10407  (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
10408  (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
10409  (prepare-body-function . nndoc-unquote-dashes)
10410  (body-end-function . nndoc-digest-body-end)
10411  (head-end . "^ ?$")
10412  (body-begin . "^ ?\n")
10413  (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
10414  (subtype digest guess))
10415 @end example
10417 We see that all text before a 70-width line of dashes is ignored; all
10418 text after a line that starts with that @samp{^End of} is also ignored;
10419 each article begins with a 30-width line of dashes; the line separating
10420 the head from the body may contain a single space; and that the body is
10421 run through @code{nndoc-unquote-dashes} before being delivered.
10423 To hook your own document definition into @code{nndoc}, use the
10424 @code{nndoc-add-type} function.  It takes two parameters---the first is
10425 the definition itself and the second (optional) parameter says where in
10426 the document type definition alist to put this definition.  The alist is
10427 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
10428 is of @code{mmdf} type, and so on.  These type predicates should return
10429 @code{nil} if the document is not of the correct type; @code{t} if it is
10430 of the correct type; and a number if the document might be of the
10431 correct type.  A high number means high probability; a low number means
10432 low probability with @samp{0} being the lowest valid number.
10435 @node SOUP
10436 @subsection SOUP
10437 @cindex SOUP
10438 @cindex offline
10440 In the PC world people often talk about ``offline'' newsreaders.  These
10441 are thingies that are combined reader/news transport monstrosities.
10442 With built-in modem programs.  Yecchh!
10444 Of course, us Unix Weenie types of human beans use things like
10445 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
10446 transport things like Ghod intended.  And then we just use normal
10447 newsreaders.
10449 However, it can sometimes be convenient to do something a that's a bit
10450 easier on the brain if you have a very slow modem, and you're not really
10451 that interested in doing things properly.
10453 A file format called @sc{soup} has been developed for transporting news
10454 and mail from servers to home machines and back again.  It can be a bit
10455 fiddly.
10457 First some terminology:
10459 @table @dfn
10461 @item server
10462 This is the machine that is connected to the outside world and where you
10463 get news and/or mail from.
10465 @item home machine
10466 This is the machine that you want to do the actual reading and responding
10467 on.  It is typically not connected to the rest of the world in any way.
10469 @item packet
10470 Something that contains messages and/or commands.  There are two kinds
10471 of packets:
10473 @table @dfn
10474 @item message packets
10475 These are packets made at the server, and typically contain lots of
10476 messages for you to read.  These are called @file{SoupoutX.tgz} by
10477 default, where @var{X} is a number.
10479 @item response packets
10480 These are packets made at the home machine, and typically contains
10481 replies that you've written.  These are called @file{SoupinX.tgz} by
10482 default, where @var{X} is a number.
10484 @end table
10486 @end table
10489 @enumerate
10491 @item
10492 You log in on the server and create a @sc{soup} packet.  You can either
10493 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
10494 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
10495 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
10497 @item
10498 You transfer the packet home.  Rail, boat, car or modem will do fine.
10500 @item
10501 You put the packet in your home directory.
10503 @item
10504 You fire up Gnus on your home machine using the @code{nnsoup} backend as
10505 the native or secondary server.
10507 @item
10508 You read articles and mail and answer and followup to the things you
10509 want (@pxref{SOUP Replies}).
10511 @item
10512 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
10513 packet.
10515 @item
10516 You transfer this packet to the server.
10518 @item
10519 You use Gnus to mail this packet out with the @kbd{G s s} command.
10521 @item
10522 You then repeat until you die.
10524 @end enumerate
10526 So you basically have a bipartite system---you use @code{nnsoup} for
10527 reading and Gnus for packing/sending these @sc{soup} packets.
10529 @menu
10530 * SOUP Commands::     Commands for creating and sending @sc{soup} packets
10531 * SOUP Groups::       A backend for reading @sc{soup} packets.
10532 * SOUP Replies::      How to enable @code{nnsoup} to take over mail and news.
10533 @end menu
10536 @node SOUP Commands
10537 @subsubsection SOUP Commands
10539 These are commands for creating and manipulating @sc{soup} packets.
10541 @table @kbd
10542 @item G s b
10543 @kindex G s b (Group)
10544 @findex gnus-group-brew-soup
10545 Pack all unread articles in the current group
10546 (@code{gnus-group-brew-soup}).  This command understands the
10547 process/prefix convention.
10549 @item G s w
10550 @kindex G s w (Group)
10551 @findex gnus-soup-save-areas
10552 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
10554 @item G s s
10555 @kindex G s s (Group)
10556 @findex gnus-soup-send-replies
10557 Send all replies from the replies packet
10558 (@code{gnus-soup-send-replies}).
10560 @item G s p
10561 @kindex G s p (Group)
10562 @findex gnus-soup-pack-packet
10563 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
10565 @item G s r
10566 @kindex G s r (Group)
10567 @findex nnsoup-pack-replies
10568 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
10570 @item O s
10571 @kindex O s (Summary)
10572 @findex gnus-soup-add-article
10573 This summary-mode command adds the current article to a @sc{soup} packet
10574 (@code{gnus-soup-add-article}).  It understands the process/prefix
10575 convention (@pxref{Process/Prefix}).
10577 @end table
10580 There are a few variables to customize where Gnus will put all these
10581 thingies:
10583 @table @code
10585 @item gnus-soup-directory
10586 @vindex gnus-soup-directory
10587 Directory where Gnus will save intermediate files while composing
10588 @sc{soup} packets.  The default is @file{~/SoupBrew/}.
10590 @item gnus-soup-replies-directory
10591 @vindex gnus-soup-replies-directory
10592 This is what Gnus will use as a temporary directory while sending our
10593 reply packets.  @file{~/SoupBrew/SoupReplies/} is the default.
10595 @item gnus-soup-prefix-file
10596 @vindex gnus-soup-prefix-file
10597 Name of the file where Gnus stores the last used prefix.  The default is
10598 @samp{gnus-prefix}.
10600 @item gnus-soup-packer
10601 @vindex gnus-soup-packer
10602 A format string command for packing a @sc{soup} packet.  The default is
10603 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
10605 @item gnus-soup-unpacker
10606 @vindex gnus-soup-unpacker
10607 Format string command for unpacking a @sc{soup} packet.  The default is
10608 @samp{gunzip -c %s | tar xvf -}.
10610 @item gnus-soup-packet-directory
10611 @vindex gnus-soup-packet-directory
10612 Where Gnus will look for reply packets.  The default is @file{~/}.
10614 @item gnus-soup-packet-regexp
10615 @vindex gnus-soup-packet-regexp
10616 Regular expression matching @sc{soup} reply packets in
10617 @code{gnus-soup-packet-directory}.
10619 @end table
10622 @node SOUP Groups
10623 @subsubsection @sc{soup} Groups
10624 @cindex nnsoup
10626 @code{nnsoup} is the backend for reading @sc{soup} packets.  It will
10627 read incoming packets, unpack them, and put them in a directory where
10628 you can read them at leisure.
10630 These are the variables you can use to customize its behavior:
10632 @table @code
10634 @item nnsoup-tmp-directory
10635 @vindex nnsoup-tmp-directory
10636 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10637 directory.  (@file{/tmp/} by default.)
10639 @item nnsoup-directory
10640 @vindex nnsoup-directory
10641 @code{nnsoup} then moves each message and index file to this directory.
10642 The default is @file{~/SOUP/}.
10644 @item nnsoup-replies-directory
10645 @vindex nnsoup-replies-directory
10646 All replies will be stored in this directory before being packed into a
10647 reply packet.  The default is @file{~/SOUP/replies/"}.
10649 @item nnsoup-replies-format-type
10650 @vindex nnsoup-replies-format-type
10651 The @sc{soup} format of the replies packets.  The default is @samp{?n}
10652 (rnews), and I don't think you should touch that variable.  I probably
10653 shouldn't even have documented it.  Drats!  Too late!
10655 @item nnsoup-replies-index-type
10656 @vindex nnsoup-replies-index-type
10657 The index type of the replies packet.  The default is @samp{?n}, which
10658 means ``none''.  Don't fiddle with this one either!
10660 @item nnsoup-active-file
10661 @vindex nnsoup-active-file
10662 Where @code{nnsoup} stores lots of information.  This is not an ``active
10663 file'' in the @code{nntp} sense; it's an Emacs Lisp file.  If you lose
10664 this file or mess it up in any way, you're dead.  The default is
10665 @file{~/SOUP/active}.
10667 @item nnsoup-packer
10668 @vindex nnsoup-packer
10669 Format string command for packing a reply @sc{soup} packet.  The default
10670 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
10672 @item nnsoup-unpacker
10673 @vindex nnsoup-unpacker
10674 Format string command for unpacking incoming @sc{soup} packets.  The
10675 default is @samp{gunzip -c %s | tar xvf -}.
10677 @item nnsoup-packet-directory
10678 @vindex nnsoup-packet-directory
10679 Where @code{nnsoup} will look for incoming packets.  The default is
10680 @file{~/}.
10682 @item nnsoup-packet-regexp
10683 @vindex nnsoup-packet-regexp
10684 Regular expression matching incoming @sc{soup} packets.  The default is
10685 @samp{Soupout}.
10687 @item nnsoup-always-save
10688 @vindex nnsoup-always-save
10689 If non-@code{nil}, save the replies buffer after each posted message.
10691 @end table
10694 @node SOUP Replies
10695 @subsubsection SOUP Replies
10697 Just using @code{nnsoup} won't mean that your postings and mailings end
10698 up in @sc{soup} reply packets automagically.  You have to work a bit
10699 more for that to happen.
10701 @findex nnsoup-set-variables
10702 The @code{nnsoup-set-variables} command will set the appropriate
10703 variables to ensure that all your followups and replies end up in the
10704 @sc{soup} system.
10706 In specific, this is what it does:
10708 @lisp
10709 (setq message-send-news-function 'nnsoup-request-post)
10710 (setq message-send-mail-function 'nnsoup-request-mail)
10711 @end lisp
10713 And that's it, really.  If you only want news to go into the @sc{soup}
10714 system you just use the first line.  If you only want mail to be
10715 @sc{soup}ed you use the second.
10718 @node Web Searches
10719 @subsection Web Searches
10720 @cindex nnweb
10721 @cindex DejaNews
10722 @cindex Alta Vista
10723 @cindex InReference
10724 @cindex Usenet searches
10725 @cindex searching the Usenet
10727 It's, like, too neat to search the Usenet for articles that match a
10728 string, but it, like, totally @emph{sucks}, like, totally, to use one of
10729 those, like, Web browsers, and you, like, have to, rilly, like, look at
10730 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
10731 searches without having to use a browser.
10733 The @code{nnweb} backend allows an easy interface to the mighty search
10734 engine.  You create an @code{nnweb} group, enter a search pattern, and
10735 then enter the group and read the articles like you would any normal
10736 group.  The @kbd{G w} command in the group buffer (@pxref{Foreign
10737 Groups}) will do this in an easy-to-use fashion.
10739 @code{nnweb} groups don't really lend themselves to being solid
10740 groups---they have a very fleeting idea of article numbers.  In fact,
10741 each time you enter an @code{nnweb} group (not even changing the search
10742 pattern), you are likely to get the articles ordered in a different
10743 manner.  Not even using duplicate suppression (@pxref{Duplicate
10744 Suppression}) will help, since @code{nnweb} doesn't even know the
10745 @code{Message-ID} of the articles before reading them using some search
10746 engines (DejaNews, for instance).  The only possible way to keep track
10747 of which articles you've read is by scoring on the @code{Date}
10748 header---mark all articles posted before the last date you read the
10749 group as read.
10751 If the search engine changes its output substantially, @code{nnweb}
10752 won't be able to parse it and will fail.  One could hardly fault the Web
10753 providers if they were to do this---their @emph{raison d'être} is to
10754 make money off of advertisements, not to provide services to the
10755 community.  Since @code{nnweb} washes the ads off all the articles, one
10756 might think that the providers might be somewhat miffed.  We'll see.
10758 You must have the @code{url} and @code{w3} package installed to be able
10759 to use @code{nnweb}.
10761 Virtual server variables:
10763 @table @code
10764 @item nnweb-type
10765 @vindex nnweb-type
10766 What search engine type is being used.  The currently supported types
10767 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
10768 @code{reference}.
10770 @item nnweb-search
10771 @vindex nnweb-search
10772 The search string to feed to the search engine.
10774 @item nnweb-max-hits
10775 @vindex nnweb-max-hits
10776 Advisory maximum number of hits per search to display.  The default is
10777 100.
10779 @item nnweb-type-definition
10780 @vindex nnweb-type-definition
10781 Type-to-definition alist.  This alist says what @code{nnweb} should do
10782 with the various search engine types.  The following elements must be
10783 present:
10785 @table @code
10786 @item article
10787 Function to decode the article and provide something that Gnus
10788 understands.
10790 @item map
10791 Function to create an article number to message header and URL alist.
10793 @item search
10794 Function to send the search string to the search engine.
10796 @item address
10797 The address the aforementioned function should send the search string
10800 @item id
10801 Format string URL to fetch an article by @code{Message-ID}.
10802 @end table
10804 @end table
10808 @node Mail-To-News Gateways
10809 @subsection Mail-To-News Gateways
10810 @cindex mail-to-news gateways
10811 @cindex gateways
10813 If your local @code{nntp} server doesn't allow posting, for some reason
10814 or other, you can post using one of the numerous mail-to-news gateways.
10815 The @code{nngateway} backend provides the interface.
10817 Note that you can't read anything from this backend---it can only be
10818 used to post with.
10820 Server variables:
10822 @table @code
10823 @item nngateway-address
10824 @vindex nngateway-address
10825 This is the address of the mail-to-news gateway.
10827 @item nngateway-header-transformation
10828 @vindex nngateway-header-transformation
10829 News headers often have to be transformed in some odd way or other
10830 for the mail-to-news gateway to accept it.  This variable says what
10831 transformation should be called, and defaults to
10832 @code{nngateway-simple-header-transformation}.  The function is called
10833 narrowed to the headers to be transformed and with one parameter---the
10834 gateway address.
10836 This default function just inserts a new @code{To} header based on the
10837 @code{Newsgroups} header and the gateway address.
10838 For instance, an article with this @code{Newsgroups} header:
10840 @example
10841 Newsgroups: alt.religion.emacs
10842 @end example
10844 will get this @code{From} header inserted:
10846 @example
10847 To: alt-religion-emacs@@GATEWAY
10848 @end example
10850 The following pre-defined functions exist:
10852 @findex nngateway-simple-header-transformation
10853 @table @code
10855 @item nngateway-simple-header-transformation
10856 Creates a @code{To} header that looks like
10857 @var{newsgroup}@@@code{nngateway-address}.
10859 @findex nngateway-mail2news-header-transformation
10861 @item nngateway-mail2news-header-transformation
10862 Creates a @code{To} header that looks like
10863 @code{nngateway-address}.
10865 Here's an example:
10867 @lisp
10868 (setq gnus-post-method
10869       '(nngateway "mail2news@@replay.com"
10870                   (nngateway-header-transformation
10871                    nngateway-mail2news-header-transformation)))
10872 @end lisp
10874 @end table
10877 @end table
10879 So, to use this, simply say something like:
10881 @lisp
10882 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
10883 @end lisp
10886 @node Combined Groups
10887 @section Combined Groups
10889 Gnus allows combining a mixture of all the other group types into bigger
10890 groups.
10892 @menu
10893 * Virtual Groups::     Combining articles from many groups.
10894 * Kibozed Groups::     Looking through parts of the newsfeed for articles.
10895 @end menu
10898 @node Virtual Groups
10899 @subsection Virtual Groups
10900 @cindex nnvirtual
10901 @cindex virtual groups
10902 @cindex merging groups
10904 An @dfn{nnvirtual group} is really nothing more than a collection of
10905 other groups.
10907 For instance, if you are tired of reading many small groups, you can
10908 put them all in one big group, and then grow tired of reading one
10909 big, unwieldy group.  The joys of computing!
10911 You specify @code{nnvirtual} as the method.  The address should be a
10912 regexp to match component groups.
10914 All marks in the virtual group will stick to the articles in the
10915 component groups.  So if you tick an article in a virtual group, the
10916 article will also be ticked in the component group from whence it came.
10917 (And vice versa---marks from the component groups will also be shown in
10918 the virtual group.)
10920 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
10921 newsgroups into one, big, happy newsgroup:
10923 @lisp
10924 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
10925 @end lisp
10927 The component groups can be native or foreign; everything should work
10928 smoothly, but if your computer explodes, it was probably my fault.
10930 Collecting the same group from several servers might actually be a good
10931 idea if users have set the Distribution header to limit distribution.
10932 If you would like to read @samp{soc.motss} both from a server in Japan
10933 and a server in Norway, you could use the following as the group regexp:
10935 @example
10936 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
10937 @end example
10939 (Remember, though, that if you're creating the group with @kbd{G m}, you
10940 shouldn't double the backslashes, and you should leave off the quote
10941 characters at the beginning and the end of the string.)
10943 This should work kinda smoothly---all articles from both groups should
10944 end up in this one, and there should be no duplicates.  Threading (and
10945 the rest) will still work as usual, but there might be problems with the
10946 sequence of articles.  Sorting on date might be an option here
10947 (@pxref{Selecting a Group}).
10949 One limitation, however---all groups included in a virtual
10950 group have to be alive (i.e., subscribed or unsubscribed).  Killed or
10951 zombie groups can't be component groups for @code{nnvirtual} groups.
10953 @vindex nnvirtual-always-rescan
10954 If the @code{nnvirtual-always-rescan} is non-@code{nil},
10955 @code{nnvirtual} will always scan groups for unread articles when
10956 entering a virtual group.  If this variable is @code{nil} (which is the
10957 default) and you read articles in a component group after the virtual
10958 group has been activated, the read articles from the component group
10959 will show up when you enter the virtual group.  You'll also see this
10960 effect if you have two virtual groups that have a component group in
10961 common.  If that's the case, you should set this variable to @code{t}.
10962 Or you can just tap @code{M-g} on the virtual group every time before
10963 you enter it---it'll have much the same effect.
10965 @code{nnvirtual} can have both mail and news groups as component groups.
10966 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
10967 has to ask the backend of the component group the article comes from
10968 whether it is a news or mail backend.  However, when you do a @kbd{^},
10969 there is typically no sure way for the component backend to know this,
10970 and in that case @code{nnvirtual} tells Gnus that the article came from a
10971 not-news backend.  (Just to be on the safe side.)
10973 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
10974 line from the article you respond to in these cases.
10978 @node Kibozed Groups
10979 @subsection Kibozed Groups
10980 @cindex nnkiboze
10981 @cindex kibozing
10983 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
10984 the news feed''.  @code{nnkiboze} is a backend that will do this for
10985 you.  Oh joy!  Now you can grind any @sc{nntp} server down to a halt
10986 with useless requests!  Oh happiness!
10988 @kindex G k (Group)
10989 To create a kibozed group, use the @kbd{G k} command in the group
10990 buffer.
10992 The address field of the @code{nnkiboze} method is, as with
10993 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
10994 @code{nnkiboze} group.  That's where most similarities between @code{nnkiboze}
10995 and @code{nnvirtual} end.
10997 In addition to this regexp detailing component groups, an @code{nnkiboze} group
10998 must have a score file to say what articles are to be included in
10999 the group (@pxref{Scoring}).
11001 @kindex M-x nnkiboze-generate-groups
11002 @findex nnkiboze-generate-groups
11003 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
11004 @code{nnkiboze} groups you want to have.  This command will take time.  Lots of
11005 time.  Oodles and oodles of time.  Gnus has to fetch the headers from
11006 all the articles in all the component groups and run them through the
11007 scoring process to determine if there are any articles in the groups
11008 that are to be part of the @code{nnkiboze} groups.
11010 Please limit the number of component groups by using restrictive
11011 regexps.  Otherwise your sysadmin may become annoyed with you, and the
11012 @sc{nntp} site may throw you off and never let you back in again.
11013 Stranger things have happened.
11015 @code{nnkiboze} component groups do not have to be alive---they can be dead,
11016 and they can be foreign.  No restrictions.
11018 @vindex nnkiboze-directory
11019 The generation of an @code{nnkiboze} group means writing two files in
11020 @code{nnkiboze-directory}, which is @file{~/News/} by default.  One
11021 contains the @sc{nov} header lines for all the articles in the group,
11022 and the other is an additional @file{.newsrc} file to store information
11023 on what groups have been searched through to find component articles.
11025 Articles marked as read in the @code{nnkiboze} group will have
11026 their @sc{nov} lines removed from the @sc{nov} file.
11029 @node Gnus Unplugged
11030 @section Gnus Unplugged
11031 @cindex offline
11032 @cindex unplugged
11033 @cindex Agent
11034 @cindex Gnus Agent
11035 @cindex Gnus Unplugged
11037 In olden times (ca. February '88), people used to run their newsreaders
11038 on big machines with permanent connections to the net.  News transport
11039 was dealt with by news servers, and all the newsreaders had to do was to
11040 read news.  Believe it or not.
11042 Nowadays most people read news and mail at home, and use some sort of
11043 modem to connect to the net.  To avoid running up huge phone bills, it
11044 would be nice to have a way to slurp down all the news and mail, hang up
11045 the phone, read for several hours, and then upload any responses you
11046 have to make.  And then you repeat the procedure.
11048 Of course, you can use news servers for doing this as well.  I've used
11049 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
11050 for some years, but doing that's a bore.  Moving the news server
11051 functionality up to the newsreader makes sense if you're the only person
11052 reading news on a machine.
11054 Using Gnus as an ``offline'' newsreader is quite simple.
11056 @itemize @bullet
11057 @item
11058 First, set up Gnus as you would do if you were running it on a machine
11059 that has full connection to the net.  Go ahead.  I'll still be waiting
11060 here.
11062 @item
11063 Then, put the following magical incantation at the end of your
11064 @file{.gnus.el} file:
11066 @lisp
11067 (gnus-agentize)
11068 @end lisp
11069 @end itemize
11071 That's it.  Gnus is now an ``offline'' newsreader.
11073 Of course, to use it as such, you have to learn a few new commands.
11075 @menu
11076 * Agent Basics::           How it all is supposed to work.
11077 * Agent Categories::       How to tell the Gnus Agent what to download.
11078 * Agent Commands::         New commands for all the buffers.
11079 * Agent Expiry::           How to make old articles go away.
11080 * Outgoing Messages::      What happens when you post/mail something?
11081 * Agent Variables::        Customizing is fun.
11082 * Example Setup::          An example @file{.gnus.el} file for offline people.
11083 * Batching Agents::        How to fetch news from a @code{cron} job.
11084 @end menu
11087 @node Agent Basics
11088 @subsection Agent Basics
11090 First, let's get some terminology out of the way.
11092 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
11093 connection to the net (and notified the Agent that this is the case).
11094 When the connection to the net is up again (and Gnus knows this), the
11095 Agent is @dfn{plugged}.
11097 The @dfn{local} machine is the one you're running on, and which isn't
11098 connected to the net continuously.
11100 @dfn{Downloading} means fetching things from the net to your local
11101 machine.  @dfn{Uploading} is doing the opposite.
11103 Let's take a typical Gnus session using the Agent.
11105 @itemize @bullet
11107 @item
11108 You start Gnus with @code{gnus-unplugged}.  This brings up the Gnus
11109 Agent in a disconnected state.  You can read all the news that you have
11110 already fetched while in this mode.
11112 @item
11113 You then decide to see whether any new news has arrived.  You connect
11114 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
11115 to make Gnus become @dfn{plugged}.
11117 @item
11118 You can then read the new news immediately, or you can download the news
11119 onto your local machine.  If you want to do the latter, you press @kbd{J
11120 s} to fetch all the eligible articles in all the groups.  (To let Gnus
11121 know which articles you want to download, @pxref{Agent Categories}.)
11123 @item
11124 After fetching the articles, you press @kbd{J j} to make Gnus become
11125 unplugged again, and you shut down the PPP thing (or whatever).  And
11126 then you read the news offline.
11128 @item
11129 And then you go to step 2.
11130 @end itemize
11132 Here are some things you should do the first time (or so) that you use
11133 the Agent.
11135 @itemize @bullet
11137 @item
11138 Decide which servers should be covered by the Agent.  If you have a mail
11139 backend, it would probably be nonsensical to have it covered by the
11140 Agent.  Go to the server buffer (@kbd{^} in the group buffer) and press
11141 @kbd{J a} the server (or servers) that you wish to have covered by the
11142 Agent (@pxref{Server Agent Commands}).  This will typically be only the
11143 primary select method, which is listed on the bottom in the buffer.
11145 @item
11146 Decide on download policy.  @xref{Agent Categories}.
11148 @item
11149 Uhm... that's it.
11150 @end itemize
11153 @node Agent Categories
11154 @subsection Agent Categories
11156 One of the main reasons to integrate the news transport layer into the
11157 newsreader is to allow greater control over what articles to download.
11158 There's not much point in downloading huge amounts of articles, just to
11159 find out that you're not interested in reading any of them.  It's better
11160 to be somewhat more conservative in choosing what to download, and then
11161 mark the articles for downloading manually if it should turn out that
11162 you're interested in the articles anyway.
11164 The main way to control what is to be downloaded is to create a
11165 @dfn{category} and then assign some (or all) groups to this category.
11166 Gnus has its own buffer for creating and managing categories.
11168 @menu
11169 * Category Syntax::       What a category looks like.
11170 * The Category Buffer::   A buffer for maintaining categories.
11171 * Category Variables::    Customize'r'Us.
11172 @end menu
11175 @node Category Syntax
11176 @subsubsection Category Syntax
11178 A category consists of two things.
11180 @enumerate
11181 @item
11182 A predicate which (generally) gives a rough outline of which articles
11183 are eligible for downloading; and
11185 @item
11186 a score rule which (generally) gives you a finer granularity when
11187 deciding what articles to download.  (Note that this @dfn{download
11188 score} is wholly unrelated to normal scores.)
11189 @end enumerate
11191 A predicate consists of predicates with logical operators sprinkled in
11192 between.
11194 Perhaps some examples are in order.
11196 Here's a simple predicate.  (It's the default predicate, in fact, used
11197 for all groups that don't belong to any other category.)
11199 @lisp
11200 short
11201 @end lisp
11203 Quite simple, eh?  This predicate is true if and only if the article is
11204 short (for some value of ``short'').
11206 Here's a more complex predicate:
11208 @lisp
11209 (or high
11210     (and
11211      (not low)
11212      (not long)))
11213 @end lisp
11215 This means that an article should be downloaded if it has a high score,
11216 or if the score is not low and the article is not long.  You get the
11217 drift.
11219 The available logical operators are @code{or}, @code{and} and
11220 @code{not}.  (If you prefer, you can use the more ``C''-ish operators
11221 @samp{|}, @code{&} and @code{!} instead.)
11223 The following predicates are pre-defined, but if none of these fit what
11224 you want to do, you can write your own.
11226 @table @code
11227 @item short
11228 True iff the article is shorter than @code{gnus-agent-short-article}
11229 lines; default 100.
11231 @item long
11232 True iff the article is longer than @code{gnus-agent-long-article}
11233 lines; default 200.
11235 @item low
11236 True iff the article has a download score less than
11237 @code{gnus-agent-low-score}; default 0.
11239 @item high
11240 True iff the article has a download score greater than
11241 @code{gnus-agent-high-score}; default 0.
11243 @item spam
11244 True iff the Gnus Agent guesses that the article is spam.  The
11245 heuristics may change over time, but at present it just computes a
11246 checksum and sees whether articles match.
11248 @item true
11249 Always true.
11251 @item false
11252 Always false.
11253 @end table
11255 If you want to create your own predicate function, here's what you have
11256 to know:  The functions are called with no parameters, but the
11257 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
11258 useful values.
11260 Now, the syntax of the download score is the same as the syntax of
11261 normal score files, except that all elements that require actually
11262 seeing the article itself are verboten.  This means that only the
11263 following headers can be scored on: @code{From}, @code{Subject},
11264 @code{Date}, @code{Xref}, @code{Lines}, @code{Chars}, @code{Message-ID},
11265 and @code{References}.
11268 @node The Category Buffer
11269 @subsubsection The Category Buffer
11271 You'd normally do all category maintenance from the category buffer.
11272 When you enter it for the first time (with the @kbd{J c} command from
11273 the group buffer), you'll only see the @code{default} category.
11275 The following commands are available in this buffer:
11277 @table @kbd
11278 @item q
11279 @kindex q (Category)
11280 @findex gnus-category-exit
11281 Return to the group buffer (@code{gnus-category-exit}).
11283 @item k
11284 @kindex k (Category)
11285 @findex gnus-category-kill
11286 Kill the current category (@code{gnus-category-kill}).
11288 @item c
11289 @kindex c (Category)
11290 @findex gnus-category-copy
11291 Copy the current category (@code{gnus-category-copy}).
11293 @item a
11294 @kindex a (Category)
11295 @findex gnus-category-add
11296 Add a new category (@code{gnus-category-add}).
11298 @item p
11299 @kindex p (Category)
11300 @findex gnus-category-edit-predicate
11301 Edit the predicate of the current category
11302 (@code{gnus-category-edit-predicate}).
11304 @item g
11305 @kindex g (Category)
11306 @findex gnus-category-edit-groups
11307 Edit the list of groups belonging to the current category
11308 (@code{gnus-category-edit-groups}).
11310 @item s
11311 @kindex s (Category)
11312 @findex gnus-category-edit-score
11313 Edit the download score rule of the current category
11314 (@code{gnus-category-edit-score}).
11316 @item l
11317 @kindex l (Category)
11318 @findex gnus-category-list
11319 List all the categories (@code{gnus-category-list}).
11320 @end table
11323 @node Category Variables
11324 @subsubsection Category Variables
11326 @table @code
11327 @item gnus-category-mode-hook
11328 @vindex gnus-category-mode-hook
11329 Hook run in category buffers.
11331 @item gnus-category-line-format
11332 @vindex gnus-category-line-format
11333 Format of the lines in the category buffer (@pxref{Formatting
11334 Variables}).  Valid elements are:
11336 @table @samp
11337 @item c
11338 The name of the category.
11340 @item g
11341 The number of groups in the category.
11342 @end table
11344 @item gnus-category-mode-line-format
11345 @vindex gnus-category-mode-line-format
11346 Format of the category mode line (@pxref{Mode Line Formatting}).
11348 @item gnus-agent-short-article
11349 @vindex gnus-agent-short-article
11350 Articles that have fewer lines than this are short.  Default 100.
11352 @item gnus-agent-long-article
11353 @vindex gnus-agent-long-article
11354 Articles that have more lines than this are long.  Default 200.
11356 @item gnus-agent-low-score
11357 @vindex gnus-agent-low-score
11358 Articles that have a score lower than this have a low score.  Default
11361 @item gnus-agent-high-score
11362 @vindex gnus-agent-high-score
11363 Articles that have a score higher than this have a high score.  Default
11366 @end table
11369 @node Agent Commands
11370 @subsection Agent Commands
11372 All the Gnus Agent commands are on the @kbd{J} submap.  The @kbd{J j}
11373 (@code{gnus-agent-toggle-plugged} command works in all modes, and
11374 toggles the plugged/unplugged state of the Gnus Agent.
11377 @menu
11378 * Group Agent Commands::
11379 * Summary Agent Commands::
11380 * Server Agent Commands::
11381 @end menu
11383 You can run a complete batch fetch from the command line with the
11384 following incantation:
11386 @cindex gnus-agent-batch-fetch
11387 @example
11388 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
11389 @end example
11393 @node Group Agent Commands
11394 @subsubsection Group Agent Commands
11396 @table @kbd
11397 @item J u
11398 @kindex J u (Agent Group)
11399 @findex gnus-agent-fetch-groups
11400 Fetch all eligible articles in the current group
11401 (@code{gnus-agent-fetch-groups}).
11403 @item J c
11404 @kindex J c (Agent Group)
11405 @findex gnus-enter-category-buffer
11406 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
11408 @item J s
11409 @kindex J s (Agent Group)
11410 @findex gnus-agent-fetch-session
11411 Fetch all eligible articles in all groups
11412 (@code{gnus-agent-fetch-session}).
11414 @item J S
11415 @kindex J S (Agent Group)
11416 @findex gnus-group-send-drafts
11417 Send all sendable messages in the draft group
11418 (@code{gnus-agent-fetch-session}).  @xref{Drafts}.
11420 @item J a
11421 @kindex J a (Agent Group)
11422 @findex gnus-agent-add-group
11423 Add the current group to an Agent category
11424 (@code{gnus-agent-add-group}).
11426 @end table
11429 @node Summary Agent Commands
11430 @subsubsection Summary Agent Commands
11432 @table @kbd
11433 @item J #
11434 @kindex J # (Agent Summary)
11435 @findex gnus-agent-mark-article
11436 Mark the article for downloading (@code{gnus-agent-mark-article}).
11438 @item J M-#
11439 @kindex J M-# (Agent Summary)
11440 @findex gnus-agent-unmark-article
11441 Remove the downloading mark from the article
11442 (@code{gnus-agent-unmark-article}).
11444 @item @@ 
11445 @kindex @@ (Agent Summary)
11446 @findex gnus-agent-toggle-mark
11447 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
11449 @item J c
11450 @kindex J c (Agent Summary)
11451 @findex gnus-agent-catchup
11452 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
11454 @end table
11457 @node Server Agent Commands
11458 @subsubsection Server Agent Commands
11460 @table @kbd
11461 @item J a
11462 @kindex J a (Agent Server)
11463 @findex gnus-agent-add-server
11464 Add the current server to the list of servers covered by the Gnus Agent
11465 (@code{gnus-agent-add-server}).
11467 @item J r
11468 @kindex J r (Agent Server)
11469 @findex gnus-agent-remove-server
11470 Remove the current server from the list of servers covered by the Gnus
11471 Agent (@code{gnus-agent-remove-server}).
11473 @end table
11476 @node Agent Expiry
11477 @subsection Agent Expiry
11479 @vindex gnus-agent-expire-days
11480 @findex gnus-agent-expire
11481 @kindex M-x gnus-agent-expire
11482 @cindex Agent expire
11483 @cindex Gnus Agent expire
11484 @cindex expiry
11486 @code{nnagent} doesn't handle expiry.  Instead, there's a special
11487 @code{gnus-agent-expire} command that will expire all read articles that
11488 are older than @code{gnus-agent-expire-days} days.  It can be run
11489 whenever you feel that you're running out of space.  It's not
11490 particularly fast or efficient, and it's not a particularly good idea to
11491 interrupt it (with @kbd{C-g} or anything else) once you've started it.
11493 @vindex gnus-agent-expire-all
11494 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
11495 expire all articles---unread, read, ticked and dormant.  If @code{nil}
11496 (which is the default), only read articles are eligible for expiry, and
11497 unread, ticked and dormant articles will be kept indefinitely.
11500 @node Outgoing Messages
11501 @subsection Outgoing Messages
11503 When Gnus is unplugged, all outgoing messages (both mail and news) are
11504 stored in the draft groups (@pxref{Drafts}).  You can view them there
11505 after posting, and edit them at will.
11507 When Gnus is plugged again, you can send the messages either from the
11508 draft group with the special commands available there, or you can use
11509 the @kbd{J S} command in the group buffer to send all the sendable
11510 messages in the draft group.
11514 @node Agent Variables
11515 @subsection Agent Variables
11517 @table @code
11518 @item gnus-agent-directory
11519 @vindex gnus-agent-directory
11520 Where the Gnus Agent will store its files.  The default is
11521 @file{~/News/agent/}.
11523 @item gnus-agent-handle-level
11524 @vindex gnus-agent-handle-level
11525 Groups on levels (@pxref{Group Levels}) higher than this variable will
11526 be ignored by the Agent.  The default is @code{gnus-level-subscribed},
11527 which means that only subscribed group will be considered by the Agent
11528 by default.
11530 @item gnus-agent-plugged-hook
11531 @vindex gnus-agent-plugged-hook
11532 Hook run when connecting to the network.
11534 @item gnus-agent-unplugged-hook
11535 @vindex gnus-agent-unplugged-hook
11536 Hook run when disconnecting from the network.
11538 @end table
11541 @node Example Setup
11542 @subsection Example Setup
11544 If you don't want to read this manual, and you have a fairly standard
11545 setup, you may be able to use something like the following as your
11546 @file{.gnus.el} file to get started.
11548 @lisp
11549 ;;; Define how Gnus is to fetch news.  We do this over NNTP
11550 ;;; from your ISP's server.
11551 (setq gnus-select-method '(nntp "nntp.your-isp.com"))
11553 ;;; Define how Gnus is to read your mail.  We read mail from
11554 ;;; your ISP's POP server.
11555 (setenv "MAILHOST" "pop.your-isp.com")
11556 (setq nnmail-spool-file "po:username")
11558 ;;; Say how Gnus is to store the mail.  We use nnml groups.
11559 (setq gnus-secondary-select-methods '((nnml "")))
11561 ;;; Make Gnus into an offline newsreader.
11562 (gnus-agentize)
11563 @end lisp
11565 That should be it, basically.  Put that in your @file{~/.gnus.el} file,
11566 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
11567 gnus}.
11569 If this is the first time you've run Gnus, you will be subscribed
11570 automatically to a few default newsgroups.  You'll probably want to
11571 subscribe to more groups, and to do that, you have to query the
11572 @sc{nntp} server for a complete list of groups with the @kbd{A A}
11573 command.  This usually takes quite a while, but you only have to do it
11574 once.
11576 After reading and parsing a while, you'll be presented with a list of
11577 groups.  Subscribe to the ones you want to read with the @kbd{u}
11578 command.  @kbd{l} to make all the killed groups disappear after you've
11579 subscribe to all the groups you want to read.  (@kbd{A k} will bring
11580 back all the killed groups.)
11582 You can now read the groups at once, or you can download the articles
11583 with the @kbd{J s} command.  And then read the rest of this manual to
11584 find out which of the other gazillion things you want to customize.
11587 @node Batching Agents
11588 @subsection Batching Agents
11590 Having the Gnus Agent fetch articles (and post whatever messages you've
11591 written) is quite easy once you've gotten things set up properly.  The
11592 following shell script will do everything that is necessary:
11594 @example
11595 #!/bin/sh
11596 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
11597 @end example
11601 @node Scoring
11602 @chapter Scoring
11603 @cindex scoring
11605 Other people use @dfn{kill files}, but we here at Gnus Towers like
11606 scoring better than killing, so we'd rather switch than fight.  They do
11607 something completely different as well, so sit up straight and pay
11608 attention!
11610 @vindex gnus-summary-mark-below
11611 All articles have a default score (@code{gnus-summary-default-score}),
11612 which is 0 by default.  This score may be raised or lowered either
11613 interactively or by score files.  Articles that have a score lower than
11614 @code{gnus-summary-mark-below} are marked as read.
11616 Gnus will read any @dfn{score files} that apply to the current group
11617 before generating the summary buffer.
11619 There are several commands in the summary buffer that insert score
11620 entries based on the current article.  You can, for instance, ask Gnus to
11621 lower or increase the score of all articles with a certain subject.
11623 There are two sorts of scoring entries: Permanent and temporary.
11624 Temporary score entries are self-expiring entries.  Any entries that are
11625 temporary and have not been used for, say, a week, will be removed
11626 silently to help keep the sizes of the score files down.
11628 @menu
11629 * Summary Score Commands::   Adding score entries for the current group.
11630 * Group Score Commands::     General score commands.
11631 * Score Variables::          Customize your scoring.  (My, what terminology).
11632 * Score File Format::        What a score file may contain.
11633 * Score File Editing::       You can edit score files by hand as well.
11634 * Adaptive Scoring::         Big Sister Gnus knows what you read.
11635 * Home Score File::          How to say where new score entries are to go.
11636 * Followups To Yourself::    Having Gnus notice when people answer you.
11637 * Scoring Tips::             How to score effectively.
11638 * Reverse Scoring::          That problem child of old is not problem.
11639 * Global Score Files::       Earth-spanning, ear-splitting score files.
11640 * Kill Files::               They are still here, but they can be ignored.
11641 * Converting Kill Files::    Translating kill files to score files.
11642 * GroupLens::                Getting predictions on what you like to read.
11643 * Advanced Scoring::         Using logical expressions to build score rules.
11644 * Score Decays::             It can be useful to let scores wither away.
11645 @end menu
11648 @node Summary Score Commands
11649 @section Summary Score Commands
11650 @cindex score commands
11652 The score commands that alter score entries do not actually modify real
11653 score files.  That would be too inefficient.  Gnus maintains a cache of
11654 previously loaded score files, one of which is considered the
11655 @dfn{current score file alist}.  The score commands simply insert
11656 entries into this list, and upon group exit, this list is saved.
11658 The current score file is by default the group's local score file, even
11659 if no such score file actually exists.  To insert score commands into
11660 some other score file (e.g. @file{all.SCORE}), you must first make this
11661 score file the current one.
11663 General score commands that don't actually change the score file:
11665 @table @kbd
11667 @item V s
11668 @kindex V s (Summary)
11669 @findex gnus-summary-set-score
11670 Set the score of the current article (@code{gnus-summary-set-score}).
11672 @item V S
11673 @kindex V S (Summary)
11674 @findex gnus-summary-current-score
11675 Display the score of the current article
11676 (@code{gnus-summary-current-score}).
11678 @item V t
11679 @kindex V t (Summary)
11680 @findex gnus-score-find-trace
11681 Display all score rules that have been used on the current article
11682 (@code{gnus-score-find-trace}).
11684 @item V R
11685 @kindex V R (Summary)
11686 @findex gnus-summary-rescore
11687 Run the current summary through the scoring process
11688 (@code{gnus-summary-rescore}).  This might be useful if you're playing
11689 around with your score files behind Gnus' back and want to see the
11690 effect you're having.
11692 @item V c
11693 @kindex V c (Summary)
11694 @findex gnus-score-change-score-file
11695 Make a different score file the current
11696 (@code{gnus-score-change-score-file}).
11698 @item V e
11699 @kindex V e (Summary)
11700 @findex gnus-score-edit-current-scores
11701 Edit the current score file (@code{gnus-score-edit-current-scores}).
11702 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
11703 File Editing}).
11705 @item V f
11706 @kindex V f (Summary)
11707 @findex gnus-score-edit-file
11708 Edit a score file and make this score file the current one
11709 (@code{gnus-score-edit-file}).
11711 @item V F
11712 @kindex V F (Summary)
11713 @findex gnus-score-flush-cache
11714 Flush the score cache (@code{gnus-score-flush-cache}).  This is useful
11715 after editing score files.
11717 @item V C
11718 @kindex V C (Summary)
11719 @findex gnus-score-customize
11720 Customize a score file in a visually pleasing manner
11721 (@code{gnus-score-customize}).
11723 @end table
11725 The rest of these commands modify the local score file.
11727 @table @kbd
11729 @item V m
11730 @kindex V m (Summary)
11731 @findex gnus-score-set-mark-below
11732 Prompt for a score, and mark all articles with a score below this as
11733 read (@code{gnus-score-set-mark-below}).
11735 @item V x
11736 @kindex V x (Summary)
11737 @findex gnus-score-set-expunge-below
11738 Prompt for a score, and add a score rule to the current score file to
11739 expunge all articles below this score
11740 (@code{gnus-score-set-expunge-below}).
11741 @end table
11743 The keystrokes for actually making score entries follow a very regular
11744 pattern, so there's no need to list all the commands.  (Hundreds of
11745 them.)
11747 @findex gnus-summary-increase-score
11748 @findex gnus-summary-lower-score
11750 @enumerate
11751 @item
11752 The first key is either @kbd{I} (upper case i) for increasing the score
11753 or @kbd{L} for lowering the score.
11754 @item
11755 The second key says what header you want to score on.  The following
11756 keys are available:
11757 @table @kbd
11759 @item a
11760 Score on the author name.
11762 @item s
11763 Score on the subject line.
11765 @item x
11766 Score on the Xref line---i.e., the cross-posting line.
11768 @item r
11769 Score on the References line.
11771 @item d
11772 Score on the date.
11774 @item l
11775 Score on the number of lines.
11777 @item i
11778 Score on the Message-ID.
11780 @item f
11781 Score on followups.
11783 @item b
11784 Score on the body.
11786 @item h
11787 Score on the head.
11789 @item t
11790 Score on thead.
11792 @end table
11794 @item
11795 The third key is the match type.  Which match types are valid depends on
11796 what headers you are scoring on.
11798 @table @code
11800 @item strings
11802 @table @kbd
11804 @item e
11805 Exact matching.
11807 @item s
11808 Substring matching.
11810 @item f
11811 Fuzzy matching (@pxref{Fuzzy Matching}).
11813 @item r
11814 Regexp matching
11815 @end table
11817 @item date
11818 @table @kbd
11820 @item b
11821 Before date.
11823 @item a
11824 After date.
11826 @item n
11827 This date.
11828 @end table
11830 @item number
11831 @table @kbd
11833 @item <
11834 Less than number.
11836 @item =
11837 Equal to number.
11839 @item >
11840 Greater than number.
11841 @end table
11842 @end table
11844 @item
11845 The fourth and final key says whether this is a temporary (i.e., expiring)
11846 score entry, or a permanent (i.e., non-expiring) score entry, or whether
11847 it is to be done immediately, without adding to the score file.
11848 @table @kbd
11850 @item t
11851 Temporary score entry.
11853 @item p
11854 Permanent score entry.
11856 @item i
11857 Immediately scoring.
11858 @end table
11860 @end enumerate
11862 So, let's say you want to increase the score on the current author with
11863 exact matching permanently: @kbd{I a e p}.  If you want to lower the
11864 score based on the subject line, using substring matching, and make a
11865 temporary score entry: @kbd{L s s t}.  Pretty easy.
11867 To make things a bit more complicated, there are shortcuts.  If you use
11868 a capital letter on either the second or third keys, Gnus will use
11869 defaults for the remaining one or two keystrokes.  The defaults are
11870 ``substring'' and ``temporary''.  So @kbd{I A} is the same as @kbd{I a s
11871 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
11873 These functions take both the numerical prefix and the symbolic prefix
11874 (@pxref{Symbolic Prefixes}).  A numerical prefix says how much to lower
11875 (or increase) the score of the article.  A symbolic prefix of @code{a}
11876 says to use the @file{all.SCORE} file for the command instead of the
11877 current score file.
11879 @vindex gnus-score-mimic-keymap
11880 The @code{gnus-score-mimic-keymap} says whether these commands will
11881 pretend they are keymaps or not.
11884 @node Group Score Commands
11885 @section Group Score Commands
11886 @cindex group score commands
11888 There aren't many of these as yet, I'm afraid.
11890 @table @kbd
11892 @item W f
11893 @kindex W f (Group)
11894 @findex gnus-score-flush-cache
11895 Gnus maintains a cache of score alists to avoid having to reload them
11896 all the time.  This command will flush the cache
11897 (@code{gnus-score-flush-cache}).
11899 @end table
11901 You can do scoring from the command line by saying something like:
11903 @findex gnus-batch-score
11904 @cindex batch scoring
11905 @example
11906 $ emacs -batch -l ~/.emacs -l gnus -f gnus-batch-score
11907 @end example
11910 @node Score Variables
11911 @section Score Variables
11912 @cindex score variables
11914 @table @code
11916 @item gnus-use-scoring
11917 @vindex gnus-use-scoring
11918 If @code{nil}, Gnus will not check for score files, and will not, in
11919 general, do any score-related work.  This is @code{t} by default.
11921 @item gnus-kill-killed
11922 @vindex gnus-kill-killed
11923 If this variable is @code{nil}, Gnus will never apply score files to
11924 articles that have already been through the kill process.  While this
11925 may save you lots of time, it also means that if you apply a kill file
11926 to a group, and then change the kill file and want to run it over you
11927 group again to kill more articles, it won't work.  You have to set this
11928 variable to @code{t} to do that.  (It is @code{t} by default.)
11930 @item gnus-kill-files-directory
11931 @vindex gnus-kill-files-directory
11932 All kill and score files will be stored in this directory, which is
11933 initialized from the @code{SAVEDIR} environment variable by default.
11934 This is @file{~/News/} by default.
11936 @item gnus-score-file-suffix
11937 @vindex gnus-score-file-suffix
11938 Suffix to add to the group name to arrive at the score file name
11939 (@samp{SCORE} by default.)
11941 @item gnus-score-uncacheable-files
11942 @vindex gnus-score-uncacheable-files
11943 @cindex score cache
11944 All score files are normally cached to avoid excessive re-loading of
11945 score files.  However, if this might make you Emacs grow big and
11946 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
11947 @file{all.SCORE}, while it might be a good idea to not cache
11948 @file{comp.infosystems.www.authoring.misc.ADAPT}.  In fact, this
11949 variable is @samp{ADAPT$} by default, so no adaptive score files will
11950 be cached.
11952 @item gnus-save-score
11953 @vindex gnus-save-score
11954 If you have really complicated score files, and do lots of batch
11955 scoring, then you might set this variable to @code{t}.  This will make
11956 Gnus save the scores into the @file{.newsrc.eld} file.
11958 @item gnus-score-interactive-default-score
11959 @vindex gnus-score-interactive-default-score
11960 Score used by all the interactive raise/lower commands to raise/lower
11961 score with.  Default is 1000, which may seem excessive, but this is to
11962 ensure that the adaptive scoring scheme gets enough room to play with.
11963 We don't want the small changes from the adaptive scoring to overwrite
11964 manually entered data.
11966 @item gnus-summary-default-score
11967 @vindex gnus-summary-default-score
11968 Default score of an article, which is 0 by default.
11970 @item gnus-summary-expunge-below
11971 @vindex gnus-summary-expunge-below
11972 Don't display the summary lines of articles that have scores lower than
11973 this variable.  This is @code{nil} by default, which means that no
11974 articles will be hidden.  This variable is local to the summary buffers,
11975 and has to be set from @code{gnus-summary-mode-hook}.
11977 @item gnus-score-over-mark
11978 @vindex gnus-score-over-mark
11979 Mark (in the third column) used for articles with a score over the
11980 default.  Default is @samp{+}.
11982 @item gnus-score-below-mark
11983 @vindex gnus-score-below-mark
11984 Mark (in the third column) used for articles with a score below the
11985 default.  Default is @samp{-}.
11987 @item gnus-score-find-score-files-function
11988 @vindex gnus-score-find-score-files-function
11989 Function used to find score files for the current group.  This function
11990 is called with the name of the group as the argument.
11992 Predefined functions available are:
11993 @table @code
11995 @item gnus-score-find-single
11996 @findex gnus-score-find-single
11997 Only apply the group's own score file.
11999 @item gnus-score-find-bnews
12000 @findex gnus-score-find-bnews
12001 Apply all score files that match, using bnews syntax.  This is the
12002 default.  If the current group is @samp{gnu.emacs.gnus}, for instance,
12003 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
12004 @file{gnu.all.SCORE} would all apply.  In short, the instances of
12005 @samp{all} in the score file names are translated into @samp{.*}, and
12006 then a regexp match is done.
12008 This means that if you have some score entries that you want to apply to
12009 all groups, then you put those entries in the @file{all.SCORE} file.
12011 The score files are applied in a semi-random order, although Gnus will
12012 try to apply the more general score files before the more specific score
12013 files.  It does this by looking at the number of elements in the score
12014 file names---discarding the @samp{all} elements.
12016 @item gnus-score-find-hierarchical
12017 @findex gnus-score-find-hierarchical
12018 Apply all score files from all the parent groups.  This means that you
12019 can't have score files like @file{all.SCORE}, but you can have
12020 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
12022 @end table
12023 This variable can also be a list of functions.  In that case, all these
12024 functions will be called, and all the returned lists of score files will
12025 be applied.  These functions can also return lists of score alists
12026 directly.  In that case, the functions that return these non-file score
12027 alists should probably be placed before the ``real'' score file
12028 functions, to ensure that the last score file returned is the local
12029 score file.  Phu.
12031 @item gnus-score-expiry-days
12032 @vindex gnus-score-expiry-days
12033 This variable says how many days should pass before an unused score file
12034 entry is expired.  If this variable is @code{nil}, no score file entries
12035 are expired.  It's 7 by default.
12037 @item gnus-update-score-entry-dates
12038 @vindex gnus-update-score-entry-dates
12039 If this variable is non-@code{nil}, matching score entries will have
12040 their dates updated.  (This is how Gnus controls expiry---all
12041 non-matching entries will become too old while matching entries will
12042 stay fresh and young.)  However, if you set this variable to @code{nil},
12043 even matching entries will grow old and will have to face that oh-so
12044 grim reaper.
12046 @item gnus-score-after-write-file-function
12047 @vindex gnus-score-after-write-file-function
12048 Function called with the name of the score file just written.
12050 @item gnus-score-thread-simplify
12051 @vindex gnus-score-thread-simplify
12052 If this variable is non-@code{nil}, article subjects will be simplified
12053 for subject scoring purposes in the same manner as with
12054 threading---according to the current value of
12055 gnus-simplify-subject-functions.  If the scoring entry uses
12056 @code{substring} or @code{exact} matching, the match will also be
12057 simplified in this manner.
12059 @end table
12062 @node Score File Format
12063 @section Score File Format
12064 @cindex score file format
12066 A score file is an @code{emacs-lisp} file that normally contains just a
12067 single form.  Casual users are not expected to edit these files;
12068 everything can be changed from the summary buffer.
12070 Anyway, if you'd like to dig into it yourself, here's an example:
12072 @lisp
12073 (("from"
12074   ("Lars Ingebrigtsen" -10000)
12075   ("Per Abrahamsen")
12076   ("larsi\\|lmi" -50000 nil R))
12077  ("subject"
12078   ("Ding is Badd" nil 728373))
12079  ("xref"
12080   ("alt.politics" -1000 728372 s))
12081  ("lines"
12082   (2 -100 nil <))
12083  (mark 0)
12084  (expunge -1000)
12085  (mark-and-expunge -10)
12086  (read-only nil)
12087  (orphan -10)
12088  (adapt t)
12089  (files "/hom/larsi/News/gnu.SCORE")
12090  (exclude-files "all.SCORE")
12091  (local (gnus-newsgroup-auto-expire t)
12092         (gnus-summary-make-false-root empty))
12093  (eval (ding)))
12094 @end lisp
12096 This example demonstrates most score file elements.  For a different
12097 approach, see @pxref{Advanced Scoring}.
12099 Even though this looks much like lisp code, nothing here is actually
12100 @code{eval}ed.  The lisp reader is used to read this form, though, so it
12101 has to be valid syntactically, if not semantically.
12103 Six keys are supported by this alist:
12105 @table @code
12107 @item STRING
12108 If the key is a string, it is the name of the header to perform the
12109 match on.  Scoring can only be performed on these eight headers:
12110 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
12111 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}.  In addition to
12112 these headers, there are three strings to tell Gnus to fetch the entire
12113 article and do the match on larger parts of the article: @code{Body}
12114 will perform the match on the body of the article, @code{Head} will
12115 perform the match on the head of the article, and @code{All} will
12116 perform the match on the entire article.  Note that using any of these
12117 last three keys will slow down group entry @emph{considerably}.  The
12118 final ``header'' you can score on is @code{Followup}.  These score
12119 entries will result in new score entries being added for all follow-ups
12120 to articles that matches these score entries.
12122 Following this key is a arbitrary number of score entries, where each
12123 score entry has one to four elements.
12124 @enumerate
12126 @item
12127 The first element is the @dfn{match element}.  On most headers this will
12128 be a string, but on the Lines and Chars headers, this must be an
12129 integer.
12131 @item
12132 If the second element is present, it should be a number---the @dfn{score
12133 element}.  This number should be an integer in the neginf to posinf
12134 interval.  This number is added to the score of the article if the match
12135 is successful.  If this element is not present, the
12136 @code{gnus-score-interactive-default-score} number will be used
12137 instead.  This is 1000 by default.
12139 @item
12140 If the third element is present, it should be a number---the @dfn{date
12141 element}.  This date says when the last time this score entry matched,
12142 which provides a mechanism for expiring the score entries.  It this
12143 element is not present, the score entry is permanent.  The date is
12144 represented by the number of days since December 31, 1 BCE.
12146 @item
12147 If the fourth element is present, it should be a symbol---the @dfn{type
12148 element}.  This element specifies what function should be used to see
12149 whether this score entry matches the article.  What match types that can
12150 be used depends on what header you wish to perform the match on.
12151 @table @dfn
12153 @item From, Subject, References, Xref, Message-ID
12154 For most header types, there are the @code{r} and @code{R} (regexp), as
12155 well as @code{s} and @code{S} (substring) types, and @code{e} and
12156 @code{E} (exact match), and @code{w} (word match) types.  If this
12157 element is not present, Gnus will assume that substring matching should
12158 be used.  @code{R}, @code{S}, and @code{E} differ from the others in
12159 that the matches will be done in a case-sensitive manner.  All these
12160 one-letter types are really just abbreviations for the @code{regexp},
12161 @code{string}, @code{exact}, and @code{word} types, which you can use
12162 instead, if you feel like.
12164 @item Lines, Chars
12165 These two headers use different match types: @code{<}, @code{>},
12166 @code{=}, @code{>=} and @code{<=}.
12168 These predicates are true if
12170 @example
12171 (PREDICATE HEADER MATCH)
12172 @end example
12174 evaluates to non-@code{nil}.  For instance, the advanced match
12175 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
12176 following form:
12178 @lisp
12179 (< header-value 4)
12180 @end lisp
12182 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
12183 the match, we get the score added if the article has less than 4 lines.
12184 (It's easy to get confused and think it's the other way around.  But
12185 it's not.  I think.)
12187 When matching on @code{Lines}, be careful because some backends (like
12188 @code{nndir}) do not generate @code{Lines} header, so every article ends
12189 up being marked as having 0 lines.  This can lead to strange results if
12190 you happen to lower score of the articles with few lines.
12192 @item Date
12193 For the Date header we have three kinda silly match types:
12194 @code{before}, @code{at} and @code{after}.  I can't really imagine this
12195 ever being useful, but, like, it would feel kinda silly not to provide
12196 this function.  Just in case.  You never know.  Better safe than sorry.
12197 Once burnt, twice shy.  Don't judge a book by its cover.  Never not have
12198 sex on a first date.  (I have been told that at least one person, and I
12199 quote, ``found this function indispensable'', however.)
12201 @cindex ISO8601
12202 @cindex date
12203 A more useful match type is @code{regexp}.  With it, you can match the
12204 date string using a regular expression.  The date is normalized to
12205 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}.  If
12206 you want to match all articles that have been posted on April 1st in
12207 every year, you could use @samp{....0401.........} as a match string,
12208 for instance.  (Note that the date is kept in its original time zone, so
12209 this will match articles that were posted when it was April 1st where
12210 the article was posted from.  Time zones are such wholesome fun for the
12211 whole family, eh?)
12213 @item Head, Body, All
12214 These three match keys use the same match types as the @code{From} (etc)
12215 header uses.
12217 @item Followup
12218 This match key is somewhat special, in that it will match the
12219 @code{From} header, and affect the score of not only the matching
12220 articles, but also all followups to the matching articles.  This allows
12221 you e.g. increase the score of followups to your own articles, or
12222 decrease the score of followups to the articles of some known
12223 trouble-maker.  Uses the same match types as the @code{From} header
12224 uses.  (Using this match key will lead to creation of @file{ADAPT}
12225 files.)
12227 @item Thread
12228 This match key works along the same lines as the @code{Followup} match
12229 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
12230 @samp{thread} match.  This will add a new @samp{thread} match for each
12231 article that has @var{X} in its @code{References} header.  (These new
12232 @samp{thread} matches will use the @code{Message-ID}s of these matching
12233 articles.)  This will ensure that you can raise/lower the score of an
12234 entire thread, even though some articles in the thread may not have
12235 complete @code{References} headers.  Note that using this may lead to
12236 undeterministic scores of the articles in the thread.  (Using this match
12237 key will lead to creation of @file{ADAPT} files.)
12238 @end table
12239 @end enumerate
12241 @cindex Score File Atoms
12242 @item mark
12243 The value of this entry should be a number.  Any articles with a score
12244 lower than this number will be marked as read.
12246 @item expunge
12247 The value of this entry should be a number.  Any articles with a score
12248 lower than this number will be removed from the summary buffer.
12250 @item mark-and-expunge
12251 The value of this entry should be a number.  Any articles with a score
12252 lower than this number will be marked as read and removed from the
12253 summary buffer.
12255 @item thread-mark-and-expunge
12256 The value of this entry should be a number.  All articles that belong to
12257 a thread that has a total score below this number will be marked as read
12258 and removed from the summary buffer.  @code{gnus-thread-score-function}
12259 says how to compute the total score for a thread.
12261 @item files
12262 The value of this entry should be any number of file names.  These files
12263 are assumed to be score files as well, and will be loaded the same way
12264 this one was.
12266 @item exclude-files
12267 The clue of this entry should be any number of files.  These files will
12268 not be loaded, even though they would normally be so, for some reason or
12269 other.
12271 @item eval
12272 The value of this entry will be @code{eval}el.  This element will be
12273 ignored when handling global score files.
12275 @item read-only
12276 Read-only score files will not be updated or saved.  Global score files
12277 should feature this atom (@pxref{Global Score Files}).  (Note:
12278 @dfn{Global} here really means @dfn{global}; not your personal
12279 apply-to-all-groups score files.)
12281 @item orphan
12282 The value of this entry should be a number.  Articles that do not have
12283 parents will get this number added to their scores.  Imagine you follow
12284 some high-volume newsgroup, like @samp{comp.lang.c}.  Most likely you
12285 will only follow a few of the threads, also want to see any new threads.
12287 You can do this with the following two score file entries:
12289 @example
12290         (orphan -500)
12291         (mark-and-expunge -100)
12292 @end example
12294 When you enter the group the first time, you will only see the new
12295 threads.  You then raise the score of the threads that you find
12296 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
12297 rest.  Next time you enter the group, you will see new articles in the
12298 interesting threads, plus any new threads.
12300 I.e.---the orphan score atom is for high-volume groups where there
12301 exist a few interesting threads which can't be found automatically by
12302 ordinary scoring rules.
12304 @item adapt
12305 This entry controls the adaptive scoring.  If it is @code{t}, the
12306 default adaptive scoring rules will be used.  If it is @code{ignore}, no
12307 adaptive scoring will be performed on this group.  If it is a list, this
12308 list will be used as the adaptive scoring rules.  If it isn't present,
12309 or is something other than @code{t} or @code{ignore}, the default
12310 adaptive scoring rules will be used.  If you want to use adaptive
12311 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
12312 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
12313 not want adaptive scoring.  If you only want adaptive scoring in a few
12314 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
12315 insert @code{(adapt t)} in the score files of the groups where you want
12318 @item adapt-file
12319 All adaptive score entries will go to the file named by this entry.  It
12320 will also be applied when entering the group.  This atom might be handy
12321 if you want to adapt on several groups at once, using the same adaptive
12322 file for a number of groups.
12324 @item local
12325 @cindex local variables
12326 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
12327 Each @var{var} will be made buffer-local to the current summary buffer,
12328 and set to the value specified.  This is a convenient, if somewhat
12329 strange, way of setting variables in some groups if you don't like hooks
12330 much.  Note that the @var{value} won't be evaluated.
12331 @end table
12334 @node Score File Editing
12335 @section Score File Editing
12337 You normally enter all scoring commands from the summary buffer, but you
12338 might feel the urge to edit them by hand as well, so we've supplied you
12339 with a mode for that.
12341 It's simply a slightly customized @code{emacs-lisp} mode, with these
12342 additional commands:
12344 @table @kbd
12346 @item C-c C-c
12347 @kindex C-c C-c (Score)
12348 @findex gnus-score-edit-done
12349 Save the changes you have made and return to the summary buffer
12350 (@code{gnus-score-edit-done}).
12352 @item C-c C-d
12353 @kindex C-c C-d (Score)
12354 @findex gnus-score-edit-insert-date
12355 Insert the current date in numerical format
12356 (@code{gnus-score-edit-insert-date}).  This is really the day number, if
12357 you were wondering.
12359 @item C-c C-p
12360 @kindex C-c C-p (Score)
12361 @findex gnus-score-pretty-print
12362 The adaptive score files are saved in an unformatted fashion.  If you
12363 intend to read one of these files, you want to @dfn{pretty print} it
12364 first.  This command (@code{gnus-score-pretty-print}) does that for
12365 you.
12367 @end table
12369 Type @kbd{M-x gnus-score-mode} to use this mode.
12371 @vindex gnus-score-mode-hook
12372 @code{gnus-score-menu-hook} is run in score mode buffers.
12374 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
12375 e} to begin editing score files.
12378 @node Adaptive Scoring
12379 @section Adaptive Scoring
12380 @cindex adaptive scoring
12382 If all this scoring is getting you down, Gnus has a way of making it all
12383 happen automatically---as if by magic.  Or rather, as if by artificial
12384 stupidity, to be precise.
12386 @vindex gnus-use-adaptive-scoring
12387 When you read an article, or mark an article as read, or kill an
12388 article, you leave marks behind.  On exit from the group, Gnus can sniff
12389 these marks and add score elements depending on what marks it finds.
12390 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
12391 @code{t} or @code{(line)}.  If you want score adaptively on separate
12392 words appearing in the subjects, you should set this variable to
12393 @code{(word)}.  If you want to use both adaptive methods, set this
12394 variable to @code{(word line)}.
12396 @vindex gnus-default-adaptive-score-alist
12397 To give you complete control over the scoring process, you can customize
12398 the @code{gnus-default-adaptive-score-alist} variable.  For instance, it
12399 might look something like this:
12401 @lisp
12402 (defvar gnus-default-adaptive-score-alist
12403   '((gnus-unread-mark)
12404     (gnus-ticked-mark (from 4))
12405     (gnus-dormant-mark (from 5))
12406     (gnus-del-mark (from -4) (subject -1))
12407     (gnus-read-mark (from 4) (subject 2))
12408     (gnus-expirable-mark (from -1) (subject -1))
12409     (gnus-killed-mark (from -1) (subject -3))
12410     (gnus-kill-file-mark)
12411     (gnus-ancient-mark)
12412     (gnus-low-score-mark)
12413     (gnus-catchup-mark (from -1) (subject -1))))
12414 @end lisp
12416 As you see, each element in this alist has a mark as a key (either a
12417 variable name or a ``real'' mark---a character).  Following this key is
12418 a arbitrary number of header/score pairs.  If there are no header/score
12419 pairs following the key, no adaptive scoring will be done on articles
12420 that have that key as the article mark.  For instance, articles with
12421 @code{gnus-unread-mark} in the example above will not get adaptive score
12422 entries.
12424 Each article can have only one mark, so just a single of these rules
12425 will be applied to each article.
12427 To take @code{gnus-del-mark} as an example---this alist says that all
12428 articles that have that mark (i.e., are marked with @samp{D}) will have a
12429 score entry added to lower based on the @code{From} header by -4, and
12430 lowered by @code{Subject} by -1.  Change this to fit your prejudices.
12432 If you have marked 10 articles with the same subject with
12433 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
12434 That means that that subject will get a score of ten times -1, which
12435 should be, unless I'm much mistaken, -10.
12437 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
12438 the read articles will be marked with the @samp{E} mark.  This'll
12439 probably make adaptive scoring slightly impossible, so auto-expiring and
12440 adaptive scoring doesn't really mix very well.
12442 The headers you can score on are @code{from}, @code{subject},
12443 @code{message-id}, @code{references}, @code{xref}, @code{lines},
12444 @code{chars} and @code{date}.  In addition, you can score on
12445 @code{followup}, which will create an adaptive score entry that matches
12446 on the @code{References} header using the @code{Message-ID} of the
12447 current article, thereby matching the following thread.
12449 You can also score on @code{thread}, which will try to score all
12450 articles that appear in a thread.  @code{thread} matches uses a
12451 @code{Message-ID} to match on the @code{References} header of the
12452 article.  If the match is made, the @code{Message-ID} of the article is
12453 added to the @code{thread} rule.  (Think about it.  I'd recommend two
12454 aspirins afterwards.)
12456 If you use this scheme, you should set the score file atom @code{mark}
12457 to something small---like -300, perhaps, to avoid having small random
12458 changes result in articles getting marked as read.
12460 After using adaptive scoring for a week or so, Gnus should start to
12461 become properly trained and enhance the authors you like best, and kill
12462 the authors you like least, without you having to say so explicitly.
12464 You can control what groups the adaptive scoring is to be performed on
12465 by using the score files (@pxref{Score File Format}).  This will also
12466 let you use different rules in different groups.
12468 @vindex gnus-adaptive-file-suffix
12469 The adaptive score entries will be put into a file where the name is the
12470 group name with @code{gnus-adaptive-file-suffix} appended.  The default
12471 is @samp{ADAPT}.
12473 @vindex gnus-score-exact-adapt-limit
12474 When doing adaptive scoring, substring or fuzzy matching would probably
12475 give you the best results in most cases.  However, if the header one
12476 matches is short, the possibility for false positives is great, so if
12477 the length of the match is less than
12478 @code{gnus-score-exact-adapt-limit}, exact matching will be used.  If
12479 this variable is @code{nil}, exact matching will always be used to avoid
12480 this problem.
12482 @vindex gnus-default-adaptive-word-score-alist
12483 As mentioned above, you can adapt either on individual words or entire
12484 headers.  If you adapt on words, the
12485 @code{gnus-default-adaptive-word-score-alist} variable says what score
12486 each instance of a word should add given a mark.
12488 @lisp
12489 (setq gnus-default-adaptive-word-score-alist
12490       `((,gnus-read-mark . 30)
12491         (,gnus-catchup-mark . -10)
12492         (,gnus-killed-mark . -20)
12493         (,gnus-del-mark . -15)))
12494 @end lisp
12496 This is the default value.  If you have adaption on words enabled, every
12497 word that appears in subjects of articles marked with
12498 @code{gnus-read-mark} will result in a score rule that increase the
12499 score with 30 points.
12501 @vindex gnus-default-ignored-adaptive-words
12502 @vindex gnus-ignored-adaptive-words
12503 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
12504 will be ignored.  If you wish to add more words to be ignored, use the
12505 @code{gnus-ignored-adaptive-words} list instead.
12507 @vindex gnus-adaptive-word-syntax-table
12508 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
12509 syntax table in effect.  It is similar to the standard syntax table, but
12510 it considers numbers to be non-word-constituent characters.
12512 @vindex gnus-adaptive-word-minimum
12513 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
12514 word scoring process will never bring down the score of an article to
12515 below this number.  The default is @code{nil}.
12517 After using this scheme for a while, it might be nice to write a
12518 @code{gnus-psychoanalyze-user} command to go through the rules and see
12519 what words you like and what words you don't like.  Or perhaps not.
12521 Note that the adaptive word scoring thing is highly experimental and is
12522 likely to change in the future.  Initial impressions seem to indicate
12523 that it's totally useless as it stands.  Some more work (involving more
12524 rigorous statistical methods) will have to be done to make this useful.
12527 @node Home Score File
12528 @section Home Score File
12530 The score file where new score file entries will go is called the
12531 @dfn{home score file}.  This is normally (and by default) the score file
12532 for the group itself.  For instance, the home score file for
12533 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
12535 However, this may not be what you want.  It is often convenient to share
12536 a common home score file among many groups---all @samp{emacs} groups
12537 could perhaps use the same home score file.
12539 @vindex gnus-home-score-file
12540 The variable that controls this is @code{gnus-home-score-file}.  It can
12543 @enumerate
12544 @item
12545 A string.  Then this file will be used as the home score file for all
12546 groups.
12548 @item
12549 A function. The result of this function will be used as the home score
12550 file.  The function will be called with the name of the group as the
12551 parameter.
12553 @item
12554 A list.  The elements in this list can be:
12556 @enumerate
12557 @item
12558 @code{(@var{regexp} @var{file-name})}.  If the @var{regexp} matches the group name,
12559 the @var{file-name} will will be used as the home score file.
12561 @item
12562 A function. If the function returns non-nil, the result will be used as
12563 the home score file.
12565 @item
12566 A string.  Use the string as the home score file.
12567 @end enumerate
12569 The list will be traversed from the beginning towards the end looking
12570 for matches.
12572 @end enumerate
12574 So, if you want to use just a single score file, you could say:
12576 @lisp
12577 (setq gnus-home-score-file
12578       "my-total-score-file.SCORE")
12579 @end lisp
12581 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
12582 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
12584 @findex gnus-hierarchial-home-score-file
12585 @lisp
12586 (setq gnus-home-score-file
12587       'gnus-hierarchial-home-score-file)
12588 @end lisp
12590 This is a ready-made function provided for your convenience.
12591 Other functions include
12593 @table @code
12594 @item gnus-current-home-score-file
12595 @findex gnus-current-home-score-file
12596 Return the ``current'' regular score file.  This will make scoring
12597 commands add entry to the ``innermost'' matching score file.
12599 @end table
12601 If you want to have one score file for the @samp{emacs} groups and
12602 another for the @samp{comp} groups, while letting all other groups use
12603 their own home score files:
12605 @lisp
12606 (setq gnus-home-score-file
12607       ;; All groups that match the regexp "\\.emacs"
12608       '(("\\.emacs" "emacs.SCORE")
12609         ;; All the comp groups in one score file
12610         ("^comp" "comp.SCORE")))
12611 @end lisp
12613 @vindex gnus-home-adapt-file
12614 @code{gnus-home-adapt-file} works exactly the same way as
12615 @code{gnus-home-score-file}, but says what the home adaptive score file
12616 is instead.  All new adaptive file entries will go into the file
12617 specified by this variable, and the same syntax is allowed.
12619 In addition to using @code{gnus-home-score-file} and
12620 @code{gnus-home-adapt-file}, you can also use group parameters
12621 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
12622 Parameters}) to achieve much the same.  Group and topic parameters take
12623 precedence over this variable.
12626 @node Followups To Yourself
12627 @section Followups To Yourself
12629 Gnus offers two commands for picking out the @code{Message-ID} header in
12630 the current buffer.  Gnus will then add a score rule that scores using
12631 this @code{Message-ID} on the @code{References} header of other
12632 articles.  This will, in effect, increase the score of all articles that
12633 respond to the article in the current buffer.  Quite useful if you want
12634 to easily note when people answer what you've said.
12636 @table @code
12638 @item gnus-score-followup-article
12639 @findex gnus-score-followup-article
12640 This will add a score to articles that directly follow up your own
12641 article.
12643 @item gnus-score-followup-thread
12644 @findex gnus-score-followup-thread
12645 This will add a score to all articles that appear in a thread ``below''
12646 your own article.
12647 @end table
12649 @vindex message-sent-hook
12650 These two functions are both primarily meant to be used in hooks like
12651 @code{message-sent-hook}.
12653 If you look closely at your own @code{Message-ID}, you'll notice that
12654 the first two or three characters are always the same.  Here's two of
12655 mine:
12657 @example
12658 <x6u3u47icf.fsf@@eyesore.no>
12659 <x6sp9o7ibw.fsf@@eyesore.no>
12660 @end example
12662 So ``my'' ident on this machine is @samp{x6}.  This can be
12663 exploited---the following rule will raise the score on all followups to
12664 myself:
12666 @lisp
12667 ("references"
12668  ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
12669   1000 nil r))
12670 @end lisp
12672 Whether it's the first two or first three characters that are ``yours''
12673 is system-dependent.
12676 @node Scoring Tips
12677 @section Scoring Tips
12678 @cindex scoring tips
12680 @table @dfn
12682 @item Crossposts
12683 @cindex crossposts
12684 @cindex scoring crossposts
12685 If you want to lower the score of crossposts, the line to match on is
12686 the @code{Xref} header.
12687 @lisp
12688 ("xref" (" talk.politics.misc:" -1000))
12689 @end lisp
12691 @item Multiple crossposts
12692 If you want to lower the score of articles that have been crossposted to
12693 more than, say, 3 groups:
12694 @lisp
12695 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
12696 @end lisp
12698 @item Matching on the body
12699 This is generally not a very good idea---it takes a very long time.
12700 Gnus actually has to fetch each individual article from the server.  But
12701 you might want to anyway, I guess.  Even though there are three match
12702 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
12703 and stick with it in each score file.  If you use any two, each article
12704 will be fetched @emph{twice}.  If you want to match a bit on the
12705 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
12706 the matches.
12708 @item Marking as read
12709 You will probably want to mark articles that has a score below a certain
12710 number as read.  This is most easily achieved by putting the following
12711 in your @file{all.SCORE} file:
12712 @lisp
12713 ((mark -100))
12714 @end lisp
12715 You may also consider doing something similar with @code{expunge}.
12717 @item Negated character classes
12718 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
12719 That will match newlines, which might lead to, well, The Unknown.  Say
12720 @code{[^abcd\n]*} instead.
12721 @end table
12724 @node Reverse Scoring
12725 @section Reverse Scoring
12726 @cindex reverse scoring
12728 If you want to keep just articles that have @samp{Sex with Emacs} in the
12729 subject header, and expunge all other articles, you could put something
12730 like this in your score file:
12732 @lisp
12733 (("subject"
12734   ("Sex with Emacs" 2))
12735  (mark 1)
12736  (expunge 1))
12737 @end lisp
12739 So, you raise all articles that match @samp{Sex with Emacs} and mark the
12740 rest as read, and expunge them to boot.
12743 @node Global Score Files
12744 @section Global Score Files
12745 @cindex global score files
12747 Sure, other newsreaders have ``global kill files''.  These are usually
12748 nothing more than a single kill file that applies to all groups, stored
12749 in the user's home directory.  Bah!  Puny, weak newsreaders!
12751 What I'm talking about here are Global Score Files.  Score files from
12752 all over the world, from users everywhere, uniting all nations in one
12753 big, happy score file union!  Ange-score!  New and untested!
12755 @vindex gnus-global-score-files
12756 All you have to do to use other people's score files is to set the
12757 @code{gnus-global-score-files} variable.  One entry for each score file,
12758 or each score file directory.  Gnus will decide by itself what score
12759 files are applicable to which group.
12761 Say you want to use the score file
12762 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
12763 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
12765 @lisp
12766 (setq gnus-global-score-files
12767       '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
12768         "/ftp@@ftp.some-where:/pub/score/"))
12769 @end lisp
12771 @findex gnus-score-search-global-directories
12772 Simple, eh?  Directory names must end with a @samp{/}.  These
12773 directories are typically scanned only once during each Gnus session.
12774 If you feel the need to manually re-scan the remote directories, you can
12775 use the @code{gnus-score-search-global-directories} command.
12777 Note that, at present, using this option will slow down group entry
12778 somewhat.  (That is---a lot.)
12780 If you want to start maintaining score files for other people to use,
12781 just put your score file up for anonymous ftp and announce it to the
12782 world.  Become a retro-moderator!  Participate in the retro-moderator
12783 wars sure to ensue, where retro-moderators battle it out for the
12784 sympathy of the people, luring them to use their score files on false
12785 premises!  Yay!  The net is saved!
12787 Here are some tips for the would-be retro-moderator, off the top of my
12788 head:
12790 @itemize @bullet
12792 @item
12793 Articles heavily crossposted are probably junk.
12794 @item
12795 To lower a single inappropriate article, lower by @code{Message-ID}.
12796 @item
12797 Particularly brilliant authors can be raised on a permanent basis.
12798 @item
12799 Authors that repeatedly post off-charter for the group can safely be
12800 lowered out of existence.
12801 @item
12802 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
12803 articles completely.
12805 @item
12806 Use expiring score entries to keep the size of the file down.  You
12807 should probably have a long expiry period, though, as some sites keep
12808 old articles for a long time.
12809 @end itemize
12811 ... I wonder whether other newsreaders will support global score files
12812 in the future.  @emph{Snicker}.  Yup, any day now, newsreaders like Blue
12813 Wave, xrn and 1stReader are bound to implement scoring.  Should we start
12814 holding our breath yet?
12817 @node Kill Files
12818 @section Kill Files
12819 @cindex kill files
12821 Gnus still supports those pesky old kill files.  In fact, the kill file
12822 entries can now be expiring, which is something I wrote before Daniel
12823 Quinlan thought of doing score files, so I've left the code in there.
12825 In short, kill processing is a lot slower (and I do mean @emph{a lot})
12826 than score processing, so it might be a good idea to rewrite your kill
12827 files into score files.
12829 Anyway, a kill file is a normal @code{emacs-lisp} file.  You can put any
12830 forms into this file, which means that you can use kill files as some
12831 sort of primitive hook function to be run on group entry, even though
12832 that isn't a very good idea.
12834 Normal kill files look like this:
12836 @lisp
12837 (gnus-kill "From" "Lars Ingebrigtsen")
12838 (gnus-kill "Subject" "ding")
12839 (gnus-expunge "X")
12840 @end lisp
12842 This will mark every article written by me as read, and remove the
12843 marked articles from the summary buffer.  Very useful, you'll agree.
12845 Other programs use a totally different kill file syntax.  If Gnus
12846 encounters what looks like a @code{rn} kill file, it will take a stab at
12847 interpreting it.
12849 Two summary functions for editing a GNUS kill file:
12851 @table @kbd
12853 @item M-k
12854 @kindex M-k (Summary)
12855 @findex gnus-summary-edit-local-kill
12856 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
12858 @item M-K
12859 @kindex M-K (Summary)
12860 @findex gnus-summary-edit-global-kill
12861 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
12862 @end table
12864 Two group mode functions for editing the kill files:
12866 @table @kbd
12868 @item M-k
12869 @kindex M-k (Group)
12870 @findex gnus-group-edit-local-kill
12871 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
12873 @item M-K
12874 @kindex M-K (Group)
12875 @findex gnus-group-edit-global-kill
12876 Edit the general kill file (@code{gnus-group-edit-global-kill}).
12877 @end table
12879 Kill file variables:
12881 @table @code
12882 @item gnus-kill-file-name
12883 @vindex gnus-kill-file-name
12884 A kill file for the group @samp{soc.motss} is normally called
12885 @file{soc.motss.KILL}.  The suffix appended to the group name to get
12886 this file name is detailed by the @code{gnus-kill-file-name} variable.
12887 The ``global'' kill file (not in the score file sense of ``global'', of
12888 course) is just called @file{KILL}.
12890 @vindex gnus-kill-save-kill-file
12891 @item gnus-kill-save-kill-file
12892 If this variable is non-@code{nil}, Gnus will save the
12893 kill file after processing, which is necessary if you use expiring
12894 kills.
12896 @item gnus-apply-kill-hook
12897 @vindex gnus-apply-kill-hook
12898 @findex gnus-apply-kill-file-unless-scored
12899 @findex gnus-apply-kill-file
12900 A hook called to apply kill files to a group.  It is
12901 @code{(gnus-apply-kill-file)} by default.  If you want to ignore the
12902 kill file if you have a score file for the same group, you can set this
12903 hook to @code{(gnus-apply-kill-file-unless-scored)}.  If you don't want
12904 kill files to be processed, you should set this variable to @code{nil}.
12906 @item gnus-kill-file-mode-hook
12907 @vindex gnus-kill-file-mode-hook
12908 A hook called in kill-file mode buffers.
12910 @end table
12913 @node Converting Kill Files
12914 @section Converting Kill Files
12915 @cindex kill files
12916 @cindex converting kill files
12918 If you have loads of old kill files, you may want to convert them into
12919 score files.  If they are ``regular'', you can use
12920 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
12921 by hand.
12923 The kill to score conversion package isn't included in Gnus by default.
12924 You can fetch it from
12925 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
12927 If your old kill files are very complex---if they contain more
12928 non-@code{gnus-kill} forms than not, you'll have to convert them by
12929 hand.  Or just let them be as they are.  Gnus will still use them as
12930 before.
12933 @node GroupLens
12934 @section GroupLens
12935 @cindex GroupLens
12937 GroupLens is a collaborative filtering system that helps you work
12938 together with other people to find the quality news articles out of the
12939 huge volume of news articles generated every day.
12941 To accomplish this the GroupLens system combines your opinions about
12942 articles you have already read with the opinions of others who have done
12943 likewise and gives you a personalized prediction for each unread news
12944 article.  Think of GroupLens as a matchmaker.  GroupLens watches how you
12945 rate articles, and finds other people that rate articles the same way.
12946 Once it has found some people you agree with it tells you, in the form
12947 of a prediction, what they thought of the article.  You can use this
12948 prediction to help you decide whether or not you want to read the
12949 article.
12951 @menu
12952 * Using GroupLens::          How to make Gnus use GroupLens.
12953 * Rating Articles::          Letting GroupLens know how you rate articles.
12954 * Displaying Predictions::   Displaying predictions given by GroupLens.
12955 * GroupLens Variables::      Customizing GroupLens.
12956 @end menu
12959 @node Using GroupLens
12960 @subsection Using GroupLens
12962 To use GroupLens you must register a pseudonym with your local Better
12963 Bit Bureau (BBB).
12964 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
12965 better bit in town at the moment.
12967 Once you have registered you'll need to set a couple of variables.
12969 @table @code
12971 @item gnus-use-grouplens
12972 @vindex gnus-use-grouplens
12973 Setting this variable to a non-@code{nil} value will make Gnus hook into
12974 all the relevant GroupLens functions.
12976 @item grouplens-pseudonym
12977 @vindex grouplens-pseudonym
12978 This variable should be set to the pseudonym you got when registering
12979 with the Better Bit Bureau.
12981 @item grouplens-newsgroups
12982 @vindex grouplens-newsgroups
12983 A list of groups that you want to get GroupLens predictions for.
12985 @end table
12987 That's the minimum of what you need to get up and running with GroupLens.
12988 Once you've registered, GroupLens will start giving you scores for
12989 articles based on the average of what other people think.  But, to get
12990 the real benefit of GroupLens you need to start rating articles
12991 yourself.  Then the scores GroupLens gives you will be personalized for
12992 you, based on how the people you usually agree with have already rated.
12995 @node Rating Articles
12996 @subsection Rating Articles
12998 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
12999 Where 1 means something like this article is a waste of bandwidth and 5
13000 means that the article was really good.  The basic question to ask
13001 yourself is, "on a scale from 1 to 5 would I like to see more articles
13002 like this one?"
13004 There are four ways to enter a rating for an article in GroupLens.
13006 @table @kbd
13008 @item r
13009 @kindex r (GroupLens)
13010 @findex bbb-summary-rate-article
13011 This function will prompt you for a rating on a scale of one to five.
13013 @item k
13014 @kindex k (GroupLens)
13015 @findex grouplens-score-thread
13016 This function will prompt you for a rating, and rate all the articles in
13017 the thread.  This is really useful for some of those long running giant
13018 threads in rec.humor.
13020 @end table
13022 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
13023 the score of the article you're reading.
13025 @table @kbd
13027 @item 1-5 n
13028 @kindex n (GroupLens)
13029 @findex grouplens-next-unread-article
13030 Rate the article and go to the next unread article.
13032 @item 1-5 ,
13033 @kindex , (GroupLens)
13034 @findex grouplens-best-unread-article
13035 Rate the article and go to the next unread article with the highest score.
13037 @end table
13039 If you want to give the current article a score of 4 and then go to the
13040 next article, just type @kbd{4 n}.
13043 @node Displaying Predictions
13044 @subsection Displaying Predictions
13046 GroupLens makes a prediction for you about how much you will like a
13047 news article.  The predictions from GroupLens are on a scale from 1 to
13048 5, where 1 is the worst and 5 is the best.  You can use the predictions
13049 from GroupLens in one of three ways controlled by the variable
13050 @code{gnus-grouplens-override-scoring}.
13052 @vindex gnus-grouplens-override-scoring
13053 There are three ways to display predictions in grouplens.  You may
13054 choose to have the GroupLens scores contribute to, or override the
13055 regular gnus scoring mechanism. override is the default; however, some
13056 people prefer to see the Gnus scores plus the grouplens scores.  To get
13057 the separate scoring behavior you need to set
13058 @code{gnus-grouplens-override-scoring} to @code{'separate}.  To have the
13059 GroupLens predictions combined with the grouplens scores set it to
13060 @code{'override} and to combine the scores set
13061 @code{gnus-grouplens-override-scoring} to @code{'combine}.  When you use
13062 the combine option you will also want to set the values for
13063 @code{grouplens-prediction-offset} and
13064 @code{grouplens-score-scale-factor}.
13066 @vindex grouplens-prediction-display
13067 In either case, GroupLens gives you a few choices for how you would like
13068 to see your predictions displayed.  The display of predictions is
13069 controlled by the @code{grouplens-prediction-display} variable.
13071 The following are valid values for that variable.
13073 @table @code
13074 @item prediction-spot
13075 The higher the prediction, the further to the right an @samp{*} is
13076 displayed.
13078 @item confidence-interval
13079 A numeric confidence interval.
13081 @item prediction-bar
13082 The higher the prediction, the longer the bar.
13084 @item confidence-bar
13085 Numerical confidence.
13087 @item confidence-spot
13088 The spot gets bigger with more confidence.
13090 @item prediction-num
13091 Plain-old numeric value.
13093 @item confidence-plus-minus
13094 Prediction +/- confidence.
13096 @end table
13099 @node GroupLens Variables
13100 @subsection GroupLens Variables
13102 @table @code
13104 @item gnus-summary-grouplens-line-format
13105 The summary line format used in GroupLens-enhanced summary buffers.  It
13106 accepts the same specs as the normal summary line format (@pxref{Summary
13107 Buffer Lines}).  The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
13108 %s\n}.
13110 @item grouplens-bbb-host
13111 Host running the bbbd server.  @samp{grouplens.cs.umn.edu} is the
13112 default.
13114 @item grouplens-bbb-port
13115 Port of the host running the bbbd server.  The default is 9000.
13117 @item grouplens-score-offset
13118 Offset the prediction by this value.  In other words, subtract the
13119 prediction value by this number to arrive at the effective score.  The
13120 default is 0.
13122 @item grouplens-score-scale-factor
13123 This variable allows the user to magnify the effect of GroupLens scores.
13124 The scale factor is applied after the offset.  The default is 1.
13126 @end table
13129 @node Advanced Scoring
13130 @section Advanced Scoring
13132 Scoring on Subjects and From headers is nice enough, but what if you're
13133 really interested in what a person has to say only when she's talking
13134 about a particular subject?  Or what if you really don't want to
13135 read what person A has to say when she's following up to person B, but
13136 want to read what she says when she's following up to person C?
13138 By using advanced scoring rules you may create arbitrarily complex
13139 scoring patterns.
13141 @menu
13142 * Advanced Scoring Syntax::     A definition.
13143 * Advanced Scoring Examples::   What they look like.
13144 * Advanced Scoring Tips::       Getting the most out of it.
13145 @end menu
13148 @node Advanced Scoring Syntax
13149 @subsection Advanced Scoring Syntax
13151 Ordinary scoring rules have a string as the first element in the rule.
13152 Advanced scoring rules have a list as the first element.  The second
13153 element is the score to be applied if the first element evaluated to a
13154 non-@code{nil} value.
13156 These lists may consist of three logical operators, one redirection
13157 operator, and various match operators.
13159 Logical operators:
13161 @table @code
13162 @item &
13163 @itemx and
13164 This logical operator will evaluate each of its arguments until it finds
13165 one that evaluates to @code{false}, and then it'll stop.  If all arguments
13166 evaluate to @code{true} values, then this operator will return
13167 @code{true}.
13169 @item |
13170 @itemx or
13171 This logical operator will evaluate each of its arguments until it finds
13172 one that evaluates to @code{true}.  If no arguments are @code{true},
13173 then this operator will return @code{false}.
13175 @item !
13176 @itemx not
13177 @itemx Â¬
13178 This logical operator only takes a single argument.  It returns the
13179 logical negation of the value of its argument.
13181 @end table
13183 There is an @dfn{indirection operator} that will make its arguments
13184 apply to the ancestors of the current article being scored.  For
13185 instance, @code{1-} will make score rules apply to the parent of the
13186 current article.  @code{2-} will make score rules apply to the
13187 grandparent of the current article.  Alternatively, you can write
13188 @code{^^}, where the number of @code{^}s (carets) says how far back into
13189 the ancestry you want to go.
13191 Finally, we have the match operators.  These are the ones that do the
13192 real work.  Match operators are header name strings followed by a match
13193 and a match type.  A typical match operator looks like @samp{("from"
13194 "Lars Ingebrigtsen" s)}.  The header names are the same as when using
13195 simple scoring, and the match types are also the same.
13198 @node Advanced Scoring Examples
13199 @subsection Advanced Scoring Examples
13201 Let's say you want to increase the score of articles written by Lars
13202 when he's talking about Gnus:
13204 @example
13206   ("from" "Lars Ingebrigtsen")
13207   ("subject" "Gnus"))
13208  1000)
13209 @end example
13211 Quite simple, huh?
13213 When he writes long articles, he sometimes has something nice to say:
13215 @example
13217   ("from" "Lars Ingebrigtsen")
13218   (|
13219    ("subject" "Gnus")
13220    ("lines" 100 >)))
13221  1000)
13222 @end example
13224 However, when he responds to things written by Reig Eigil Logge, you
13225 really don't want to read what he's written:
13227 @example
13229   ("from" "Lars Ingebrigtsen")
13230   (1- ("from" "Reig Eigir Logge")))
13231  -100000)
13232 @end example
13234 Everybody that follows up Redmondo when he writes about disappearing
13235 socks should have their scores raised, but only when they talk about
13236 white socks.  However, when Lars talks about socks, it's usually not
13237 very interesting:
13239 @example
13241   (1-
13242    (&
13243     ("from" "redmondo@@.*no" r)
13244     ("body" "disappearing.*socks" t)))
13245   (! ("from" "Lars Ingebrigtsen"))
13246   ("body" "white.*socks"))
13247  1000)
13248 @end example
13250 The possibilities are endless.
13253 @node Advanced Scoring Tips
13254 @subsection Advanced Scoring Tips
13256 The @code{&} and @code{|} logical operators do short-circuit logic.
13257 That is, they stop processing their arguments when it's clear what the
13258 result of the operation will be.  For instance, if one of the arguments
13259 of an @code{&} evaluates to @code{false}, there's no point in evaluating
13260 the rest of the arguments.  This means that you should put slow matches
13261 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
13262 @samp{subject}) first.
13264 The indirection arguments (@code{1-} and so on) will make their
13265 arguments work on previous generations of the thread.  If you say
13266 something like:
13268 @example
13271  (1-
13272   ("from" "lars")))
13274 @end example
13276 Then that means "score on the from header of the grandparent of the
13277 current article".  An indirection is quite fast, but it's better to say:
13279 @example
13281  (&
13282   ("from" "Lars")
13283   ("subject" "Gnus")))
13284 @end example
13286 than it is to say:
13288 @example
13290  (1- ("from" "Lars"))
13291  (1- ("subject" "Gnus")))
13292 @end example
13295 @node Score Decays
13296 @section Score Decays
13297 @cindex score decays
13298 @cindex decays
13300 You may find that your scores have a tendency to grow without
13301 bounds, especially if you're using adaptive scoring.  If scores get too
13302 big, they lose all meaning---they simply max out and it's difficult to
13303 use them in any sensible way.
13305 @vindex gnus-decay-scores
13306 @findex gnus-decay-score
13307 @vindex gnus-decay-score-function
13308 Gnus provides a mechanism for decaying scores to help with this problem.
13309 When score files are loaded and @code{gnus-decay-scores} is
13310 non-@code{nil}, Gnus will run the score files through the decaying
13311 mechanism thereby lowering the scores of all non-permanent score rules.
13312 The decay itself if performed by the @code{gnus-decay-score-function}
13313 function, which is @code{gnus-decay-score} by default.  Here's the
13314 definition of that function:
13316 @lisp
13317 (defun gnus-decay-score (score)
13318   "Decay SCORE.
13319 This is done according to `gnus-score-decay-constant'
13320 and `gnus-score-decay-scale'."
13321   (floor
13322    (- score
13323       (* (if (< score 0) 1 -1)
13324          (min (abs score)
13325               (max gnus-score-decay-constant
13326                    (* (abs score)
13327                       gnus-score-decay-scale)))))))
13328 @end lisp
13330 @vindex gnus-score-decay-scale
13331 @vindex gnus-score-decay-constant
13332 @code{gnus-score-decay-constant} is 3 by default and
13333 @code{gnus-score-decay-scale} is 0.05.  This should cause the following:
13335 @enumerate
13336 @item
13337 Scores between -3 and 3 will be set to 0 when this function is called.
13339 @item
13340 Scores with magnitudes between 3 and 60 will be shrunk by 3.
13342 @item
13343 Scores with magnitudes greater than 60 will be shrunk by 5% of the
13344 score.
13345 @end enumerate
13347 If you don't like this decay function, write your own.  It is called
13348 with the score to be decayed as its only parameter, and it should return
13349 the new score, which should be an integer.
13351 Gnus will try to decay scores once a day.  If you haven't run Gnus for
13352 four days, Gnus will decay the scores four times, for instance.
13355 @node Various
13356 @chapter Various
13358 @menu
13359 * Process/Prefix::             A convention used by many treatment commands.
13360 * Interactive::                Making Gnus ask you many questions.
13361 * Symbolic Prefixes::          How to supply some Gnus functions with options.
13362 * Formatting Variables::       You can specify what buffers should look like.
13363 * Windows Configuration::      Configuring the Gnus buffer windows.
13364 * Faces and Fonts::            How to change how faces look.
13365 * Compilation::                How to speed Gnus up.
13366 * Mode Lines::                 Displaying information in the mode lines.
13367 * Highlighting and Menus::     Making buffers look all nice and cozy.
13368 * Buttons::                    Get tendonitis in ten easy steps!
13369 * Daemons::                    Gnus can do things behind your back.
13370 * NoCeM::                      How to avoid spam and other fatty foods.
13371 * Undo::                       Some actions can be undone.
13372 * Moderation::                 What to do if you're a moderator.
13373 * XEmacs Enhancements::        There are more pictures and stuff under XEmacs.
13374 * Fuzzy Matching::             What's the big fuzz?
13375 * Thwarting Email Spam::       A how-to on avoiding unsolicited commercial email.
13376 * Various Various::            Things that are really various.
13377 @end menu
13380 @node Process/Prefix
13381 @section Process/Prefix
13382 @cindex process/prefix convention
13384 Many functions, among them functions for moving, decoding and saving
13385 articles, use what is known as the @dfn{Process/Prefix convention}.
13387 This is a method for figuring out what articles the user wants the
13388 command to be performed on.
13390 It goes like this:
13392 If the numeric prefix is N, perform the operation on the next N
13393 articles, starting with the current one.  If the numeric prefix is
13394 negative, perform the operation on the previous N articles, starting
13395 with the current one.
13397 @vindex transient-mark-mode
13398 If @code{transient-mark-mode} in non-@code{nil} and the region is
13399 active, all articles in the region will be worked upon.
13401 If there is no numeric prefix, but some articles are marked with the
13402 process mark, perform the operation on the articles marked with
13403 the process mark.
13405 If there is neither a numeric prefix nor any articles marked with the
13406 process mark, just perform the operation on the current article.
13408 Quite simple, really, but it needs to be made clear so that surprises
13409 are avoided.
13411 Commands that react to the process mark will push the current list of
13412 process marked articles onto a stack and will then clear all process
13413 marked articles.  You can restore the previous configuration with the
13414 @kbd{M P y} command (@pxref{Setting Process Marks}).
13416 @vindex gnus-summary-goto-unread
13417 One thing that seems to shock & horrify lots of people is that, for
13418 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
13419 Since each @kbd{d} (which marks the current article as read) by default
13420 goes to the next unread article after marking, this means that @kbd{3 d}
13421 will mark the next three unread articles as read, no matter what the
13422 summary buffer looks like.  Set @code{gnus-summary-goto-unread} to
13423 @code{nil} for a more straightforward action.
13426 @node Interactive
13427 @section Interactive
13428 @cindex interaction
13430 @table @code
13432 @item gnus-novice-user
13433 @vindex gnus-novice-user
13434 If this variable is non-@code{nil}, you are either a newcomer to the
13435 World of Usenet, or you are very cautious, which is a nice thing to be,
13436 really.  You will be given questions of the type ``Are you sure you want
13437 to do this?'' before doing anything dangerous.  This is @code{t} by
13438 default.
13440 @item gnus-expert-user
13441 @vindex gnus-expert-user
13442 If this variable is non-@code{nil}, you will seldom be asked any
13443 questions by Gnus.  It will simply assume you know what you're doing, no
13444 matter how strange.
13446 @item gnus-interactive-catchup
13447 @vindex gnus-interactive-catchup
13448 Require confirmation before catching up a group if non-@code{nil}.  It
13449 is @code{t} by default.
13451 @item gnus-interactive-exit
13452 @vindex gnus-interactive-exit
13453 Require confirmation before exiting Gnus.  This variable is @code{t} by
13454 default.
13455 @end table
13458 @node Symbolic Prefixes
13459 @section Symbolic Prefixes
13460 @cindex symbolic prefixes
13462 Quite a lot of Emacs commands react to the (numeric) prefix.  For
13463 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
13464 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
13465 rule of 900 to the current article.
13467 This is all nice and well, but what if you want to give a command some
13468 additional information?  Well, what most commands do is interpret the
13469 ``raw'' prefix in some special way.  @kbd{C-u 0 C-x C-s} means that one
13470 doesn't want a backup file to be created when saving the current buffer,
13471 for instance.  But what if you want to save without making a backup
13472 file, and you want Emacs to flash lights and play a nice tune at the
13473 same time?  You can't, and you're probably perfectly happy that way.
13475 @kindex M-i (Summary)
13476 @findex gnus-symbolic-argument
13477 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}.  The
13478 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
13479 character typed in is the value.  You can stack as many @kbd{M-i}
13480 prefixes as you want.  @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
13481 command the symbolic prefix @code{a}''.  @kbd{M-i a M-i b M-C-u} means
13482 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
13483 @code{b}''.  You get the drift.
13485 Typing in symbolic prefixes to commands that don't accept them doesn't
13486 hurt, but it doesn't do any good either.  Currently not many Gnus
13487 functions make use of the symbolic prefix.
13489 If you're interested in how Gnus implements this, @pxref{Extended
13490 Interactive}.
13493 @node Formatting Variables
13494 @section Formatting Variables
13495 @cindex formatting variables
13497 Throughout this manual you've probably noticed lots of variables called
13498 things like @code{gnus-group-line-format} and
13499 @code{gnus-summary-mode-line-format}.  These control how Gnus is to
13500 output lines in the various buffers.  There's quite a lot of them.
13501 Fortunately, they all use the same syntax, so there's not that much to
13502 be annoyed by.
13504 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
13505 %(%g%)\n}.  We see that it is indeed extremely ugly, and that there are
13506 lots of percentages everywhere.
13508 @menu
13509 * Formatting Basics::     A formatting variable is basically a format string.
13510 * Mode Line Formatting::  Some rules about mode line formatting variables.
13511 * Advanced Formatting::   Modifying output in various ways.
13512 * User-Defined Specs::    Having Gnus call your own functions.
13513 * Formatting Fonts::      Making the formatting look colorful and nice.
13514 @end menu
13516 Currently Gnus uses the following formatting variables:
13517 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
13518 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
13519 @code{gnus-group-mode-line-format},
13520 @code{gnus-summary-mode-line-format},
13521 @code{gnus-article-mode-line-format},
13522 @code{gnus-server-mode-line-format}, and
13523 @code{gnus-summary-pick-line-format}.
13525 All these format variables can also be arbitrary elisp forms.  In that
13526 case, they will be @code{eval}ed to insert the required lines.
13528 @kindex M-x gnus-update-format
13529 @findex gnus-update-format
13530 Gnus includes a command to help you while creating your own format
13531 specs.  @kbd{M-x gnus-update-format} will @code{eval} the current form,
13532 update the spec in question and pop you to a buffer where you can
13533 examine the resulting lisp code to be run to generate the line.
13537 @node Formatting Basics
13538 @subsection Formatting Basics
13540 Each @samp{%} element will be replaced by some string or other when the
13541 buffer in question is generated.  @samp{%5y} means ``insert the @samp{y}
13542 spec, and pad with spaces to get a 5-character field''.
13544 As with normal C and Emacs Lisp formatting strings, the numerical
13545 modifier between the @samp{%} and the formatting type character will
13546 @dfn{pad} the output so that it is always at least that long.
13547 @samp{%5y} will make the field always (at least) five characters wide by
13548 padding with spaces to the left.  If you say @samp{%-5y}, it will pad to
13549 the right instead.
13551 You may also wish to limit the length of the field to protect against
13552 particularly wide values.  For that you can say @samp{%4,6y}, which
13553 means that the field will never be more than 6 characters wide and never
13554 less than 4 characters wide.
13557 @node Mode Line Formatting
13558 @subsection Mode Line Formatting
13560 Mode line formatting variables (e.g.,
13561 @code{gnus-summary-mode-line-format}) follow the same rules as other,
13562 buffer line oriented formatting variables (@pxref{Formatting Basics})
13563 with the following two differences:
13565 @enumerate
13567 @item
13568 There must be no newline (@samp{\n}) at the end.
13570 @item
13571 The special @samp{%%b} spec can be used to display the buffer name.
13572 Well, it's no spec at all, really---@samp{%%} is just a way to quote
13573 @samp{%} to allow it to pass through the formatting machinery unmangled,
13574 so that Emacs receives @samp{%b}, which is something the Emacs mode line
13575 display interprets to mean ``show the buffer name''.  For a full list of
13576 mode line specs Emacs understands, see the documentation of the
13577 @code{mode-line-format} variable.
13579 @end enumerate
13582 @node Advanced Formatting
13583 @subsection Advanced Formatting
13585 It is frequently useful to post-process the fields in some way.
13586 Padding, limiting, cutting off parts and suppressing certain values can
13587 be achieved by using @dfn{tilde modifiers}.  A typical tilde spec might
13588 look like @samp{%~(cut 3)~(ignore "0")y}.
13590 These are the valid modifiers:
13592 @table @code
13593 @item pad
13594 @itemx pad-left
13595 Pad the field to the left with spaces until it reaches the required
13596 length.
13598 @item pad-right
13599 Pad the field to the right with spaces until it reaches the required
13600 length.
13602 @item max
13603 @itemx max-left
13604 Cut off characters from the left until it reaches the specified length.
13606 @item max-right
13607 Cut off characters from the right until it reaches the specified
13608 length.
13610 @item cut
13611 @itemx cut-left
13612 Cut off the specified number of characters from the left.
13614 @item cut-right
13615 Cut off the specified number of characters from the right.
13617 @item ignore
13618 Return an empty string if the field is equal to the specified value.
13620 @item form
13621 Use the specified form as the field value when the @samp{@@} spec is
13622 used.
13623 @end table
13625 Let's take an example.  The @samp{%o} spec in the summary mode lines
13626 will return a date in compact ISO8601 format---@samp{19960809T230410}.
13627 This is quite a mouthful, so we want to shave off the century number and
13628 the time, leaving us with a six-character date.  That would be
13629 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}.  (Cutting is done before
13630 maxing, and we need the padding to ensure that the date is never less
13631 than 6 characters to make it look nice in columns.)
13633 Ignoring is done first; then cutting; then maxing; and then as the very
13634 last operation, padding.
13636 If you use lots of these advanced thingies, you'll find that Gnus gets
13637 quite slow.  This can be helped enormously by running @kbd{M-x
13638 gnus-compile} when you are satisfied with the look of your lines.
13639 @xref{Compilation}.
13642 @node User-Defined Specs
13643 @subsection User-Defined Specs
13645 All the specs allow for inserting user defined specifiers---@samp{u}.
13646 The next character in the format string should be a letter.  Gnus
13647 will call the function @code{gnus-user-format-function-}@samp{X}, where
13648 @samp{X} is the letter following @samp{%u}.  The function will be passed
13649 a single parameter---what the parameter means depends on what buffer
13650 it's being called from.  The function should return a string, which will
13651 be inserted into the buffer just like information from any other
13652 specifier.  This function may also be called with dummy values, so it
13653 should protect against that.
13655 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
13656 much the same without defining new functions.  Here's an example:
13657 @samp{%~(form (count-lines (point-min) (point)))@@}.  The form
13658 given here will be evaluated to yield the current line number, and then
13659 inserted.
13662 @node Formatting Fonts
13663 @subsection Formatting Fonts
13665 There are specs for highlighting, and these are shared by all the format
13666 variables.  Text inside the @samp{%(} and @samp{%)} specifiers will get
13667 the special @code{mouse-face} property set, which means that it will be
13668 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
13669 over it.
13671 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
13672 normal faces set using @code{gnus-face-0}, which is @code{bold} by
13673 default.  If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
13674 and so on.  Create as many faces as you wish.  The same goes for the
13675 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
13676 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
13678 Here's an alternative recipe for the group buffer:
13680 @lisp
13681 ;; Create three face types.
13682 (setq gnus-face-1 'bold)
13683 (setq gnus-face-3 'italic)
13685 ;; We want the article count to be in
13686 ;; a bold and green face.  So we create
13687 ;; a new face called `my-green-bold'.
13688 (copy-face 'bold 'my-green-bold)
13689 ;; Set the color.
13690 (set-face-foreground 'my-green-bold "ForestGreen")
13691 (setq gnus-face-2 'my-green-bold)
13693 ;; Set the new & fancy format.
13694 (setq gnus-group-line-format
13695       "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
13696 @end lisp
13698 I'm sure you'll be able to use this scheme to create totally unreadable
13699 and extremely vulgar displays.  Have fun!
13701 Note that the @samp{%(} specs (and friends) do not make any sense on the
13702 mode-line variables.
13705 @node Windows Configuration
13706 @section Windows Configuration
13707 @cindex windows configuration
13709 No, there's nothing here about X, so be quiet.
13711 @vindex gnus-use-full-window
13712 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
13713 other windows and occupy the entire Emacs screen by itself.  It is
13714 @code{t} by default.
13716 @vindex gnus-buffer-configuration
13717 @code{gnus-buffer-configuration} describes how much space each Gnus
13718 buffer should be given.  Here's an excerpt of this variable:
13720 @lisp
13721 ((group (vertical 1.0 (group 1.0 point)
13722                       (if gnus-carpal (group-carpal 4))))
13723  (article (vertical 1.0 (summary 0.25 point)
13724                         (article 1.0))))
13725 @end lisp
13727 This is an alist.  The @dfn{key} is a symbol that names some action or
13728 other.  For instance, when displaying the group buffer, the window
13729 configuration function will use @code{group} as the key.  A full list of
13730 possible names is listed below.
13732 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
13733 should occupy.  To take the @code{article} split as an example -
13735 @lisp
13736 (article (vertical 1.0 (summary 0.25 point)
13737                        (article 1.0)))
13738 @end lisp
13740 This @dfn{split} says that the summary buffer should occupy 25% of upper
13741 half of the screen, and that it is placed over the article buffer.  As
13742 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
13743 reaching for that calculator there).  However, the special number
13744 @code{1.0} is used to signal that this buffer should soak up all the
13745 rest of the space available after the rest of the buffers have taken
13746 whatever they need.  There should be only one buffer with the @code{1.0}
13747 size spec per split.
13749 Point will be put in the buffer that has the optional third element
13750 @code{point}.  In a @code{frame} split, the last subsplit having a leaf
13751 split where the tag @code{frame-focus} is a member (i.e. is the third or
13752 fourth element in the list, depending on whether the @code{point} tag is
13753 present) gets focus.
13755 Here's a more complicated example:
13757 @lisp
13758 (article (vertical 1.0 (group 4)
13759                        (summary 0.25 point)
13760                        (if gnus-carpal (summary-carpal 4))
13761                        (article 1.0)))
13762 @end lisp
13764 If the size spec is an integer instead of a floating point number,
13765 then that number will be used to say how many lines a buffer should
13766 occupy, not a percentage.
13768 If the @dfn{split} looks like something that can be @code{eval}ed (to be
13769 precise---if the @code{car} of the split is a function or a subr), this
13770 split will be @code{eval}ed.  If the result is non-@code{nil}, it will
13771 be used as a split.  This means that there will be three buffers if
13772 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
13773 is non-@code{nil}.
13775 Not complicated enough for you?  Well, try this on for size:
13777 @lisp
13778 (article (horizontal 1.0
13779              (vertical 0.5
13780                  (group 1.0)
13781                  (gnus-carpal 4))
13782              (vertical 1.0
13783                  (summary 0.25 point)
13784                  (summary-carpal 4)
13785                  (article 1.0))))
13786 @end lisp
13788 Whoops.  Two buffers with the mystery 100% tag.  And what's that
13789 @code{horizontal} thingie?
13791 If the first element in one of the split is @code{horizontal}, Gnus will
13792 split the window horizontally, giving you two windows side-by-side.
13793 Inside each of these strips you may carry on all you like in the normal
13794 fashion.  The number following @code{horizontal} says what percentage of
13795 the screen is to be given to this strip.
13797 For each split, there @emph{must} be one element that has the 100% tag.
13798 The splitting is never accurate, and this buffer will eat any leftover
13799 lines from the splits.
13801 To be slightly more formal, here's a definition of what a valid split
13802 may look like:
13804 @example
13805 split       = frame | horizontal | vertical | buffer | form
13806 frame       = "(frame " size *split ")"
13807 horizontal  = "(horizontal " size *split ")"
13808 vertical    = "(vertical " size *split ")"
13809 buffer      = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
13810 size        = number | frame-params
13811 buffer-name = group | article | summary ...
13812 @end example
13814 The limitations are that the @code{frame} split can only appear as the
13815 top-level split.  @var{form} should be an Emacs Lisp form that should
13816 return a valid split.  We see that each split is fully recursive, and
13817 may contain any number of @code{vertical} and @code{horizontal} splits.
13819 @vindex gnus-window-min-width
13820 @vindex gnus-window-min-height
13821 @cindex window height
13822 @cindex window width
13823 Finding the right sizes can be a bit complicated.  No window may be less
13824 than @code{gnus-window-min-height} (default 1) characters high, and all
13825 windows must be at least @code{gnus-window-min-width} (default 1)
13826 characters wide.  Gnus will try to enforce this before applying the
13827 splits.  If you want to use the normal Emacs window width/height limit,
13828 you can just set these two variables to @code{nil}.
13830 If you're not familiar with Emacs terminology, @code{horizontal} and
13831 @code{vertical} splits may work the opposite way of what you'd expect.
13832 Windows inside a @code{horizontal} split are shown side-by-side, and
13833 windows within a @code{vertical} split are shown above each other.
13835 @findex gnus-configure-frame
13836 If you want to experiment with window placement, a good tip is to call
13837 @code{gnus-configure-frame} directly with a split.  This is the function
13838 that does all the real work when splitting buffers.  Below is a pretty
13839 nonsensical configuration with 5 windows; two for the group buffer and
13840 three for the article buffer.  (I said it was nonsensical.)  If you
13841 @code{eval} the statement below, you can get an idea of how that would
13842 look straight away, without going through the normal Gnus channels.
13843 Play with it until you're satisfied, and then use
13844 @code{gnus-add-configuration} to add your new creation to the buffer
13845 configuration list.
13847 @lisp
13848 (gnus-configure-frame
13849  '(horizontal 1.0
13850     (vertical 10
13851       (group 1.0)
13852       (article 0.3 point))
13853     (vertical 1.0
13854       (article 1.0)
13855       (horizontal 4
13856         (group 1.0)
13857         (article 10)))))
13858 @end lisp
13860 You might want to have several frames as well.  No prob---just use the
13861 @code{frame} split:
13863 @lisp
13864 (gnus-configure-frame
13865  '(frame 1.0
13866          (vertical 1.0
13867                    (summary 0.25 point frame-focus)
13868                    (article 1.0))
13869          (vertical ((height . 5) (width . 15)
13870                     (user-position . t)
13871                     (left . -1) (top . 1))
13872                    (picon 1.0))))
13874 @end lisp
13876 This split will result in the familiar summary/article window
13877 configuration in the first (or ``main'') frame, while a small additional
13878 frame will be created where picons will be shown.  As you can see,
13879 instead of the normal @code{1.0} top-level spec, each additional split
13880 should have a frame parameter alist as the size spec.
13881 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
13882 Reference Manual}.  Under XEmacs, a frame property list will be
13883 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
13884 is such a plist.
13886 Here's a list of all possible keys for
13887 @code{gnus-buffer-configuration}:
13889 @code{group}, @code{summary}, @code{article}, @code{server},
13890 @code{browse}, @code{message}, @code{pick}, @code{info},
13891 @code{summary-faq}, @code{edit-group}, @code{edit-server},
13892 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
13893 @code{reply-yank}, @code{mail-bounce}, @code{draft}, @code{pipe},
13894 @code{bug}, @code{compose-bounce}, and @code{score-trace}.
13896 Note that the @code{message} key is used for both
13897 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}.  If
13898 it is desirable to distinguish between the two, something like this
13899 might be used:
13901 @lisp
13902 (message (horizontal 1.0
13903                      (vertical 1.0 (message 1.0 point))
13904                      (vertical 0.24
13905                                (if (buffer-live-p gnus-summary-buffer)
13906                                    '(summary 0.5))
13907                                (group 1.0)))))
13908 @end lisp
13910 @findex gnus-add-configuration
13911 Since the @code{gnus-buffer-configuration} variable is so long and
13912 complicated, there's a function you can use to ease changing the config
13913 of a single setting: @code{gnus-add-configuration}.  If, for instance,
13914 you want to change the @code{article} setting, you could say:
13916 @lisp
13917 (gnus-add-configuration
13918  '(article (vertical 1.0
13919                (group 4)
13920                (summary .25 point)
13921                (article 1.0))))
13922 @end lisp
13924 You'd typically stick these @code{gnus-add-configuration} calls in your
13925 @file{.gnus.el} file or in some startup hook---they should be run after
13926 Gnus has been loaded.
13928 @vindex gnus-always-force-window-configuration
13929 If all windows mentioned in the configuration are already visible, Gnus
13930 won't change the window configuration.  If you always want to force the
13931 ``right'' window configuration, you can set
13932 @code{gnus-always-force-window-configuration} to non-@code{nil}.
13935 @node Faces and Fonts
13936 @section Faces and Fonts
13937 @cindex faces
13938 @cindex fonts
13939 @cindex colors
13941 Fiddling with fonts and faces used to be very difficult, but these days
13942 it is very simple.  You simply say @kbd{M-x customize-face}, pick out
13943 the face you want to alter, and alter it via the standard Customize
13944 interface.
13947 @node Compilation
13948 @section Compilation
13949 @cindex compilation
13950 @cindex byte-compilation
13952 @findex gnus-compile
13954 Remember all those line format specification variables?
13955 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
13956 on.  Now, Gnus will of course heed whatever these variables are, but,
13957 unfortunately, changing them will mean a quite significant slow-down.
13958 (The default values of these variables have byte-compiled functions
13959 associated with them, while the user-generated versions do not, of
13960 course.)
13962 To help with this, you can run @kbd{M-x gnus-compile} after you've
13963 fiddled around with the variables and feel that you're (kind of)
13964 satisfied.  This will result in the new specs being byte-compiled, and
13965 you'll get top speed again.  Gnus will save these compiled specs in the
13966 @file{.newsrc.eld} file.  (User-defined functions aren't compiled by
13967 this function, though---you should compile them yourself by sticking
13968 them into the @code{.gnus.el} file and byte-compiling that file.)
13971 @node Mode Lines
13972 @section Mode Lines
13973 @cindex mode lines
13975 @vindex gnus-updated-mode-lines
13976 @code{gnus-updated-mode-lines} says what buffers should keep their mode
13977 lines updated.  It is a list of symbols.  Supported symbols include
13978 @code{group}, @code{article}, @code{summary}, @code{server},
13979 @code{browse}, and @code{tree}.  If the corresponding symbol is present,
13980 Gnus will keep that mode line updated with information that may be
13981 pertinent.  If this variable is @code{nil}, screen refresh may be
13982 quicker.
13984 @cindex display-time
13986 @vindex gnus-mode-non-string-length
13987 By default, Gnus displays information on the current article in the mode
13988 lines of the summary and article buffers.  The information Gnus wishes
13989 to display (e.g. the subject of the article) is often longer than the
13990 mode lines, and therefore have to be cut off at some point.  The
13991 @code{gnus-mode-non-string-length} variable says how long the other
13992 elements on the line is (i.e., the non-info part).  If you put
13993 additional elements on the mode line (e.g. a clock), you should modify
13994 this variable:
13996 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
13997 @lisp
13998 (add-hook 'display-time-hook
13999           (lambda () (setq gnus-mode-non-string-length
14000                            (+ 21
14001                               (if line-number-mode 5 0)
14002                               (if column-number-mode 4 0)
14003                               (length display-time-string)))))
14004 @end lisp
14006 If this variable is @code{nil} (which is the default), the mode line
14007 strings won't be chopped off, and they won't be padded either.  Note
14008 that the default is unlikely to be desirable, as even the percentage
14009 complete in the buffer may be crowded off the mode line; the user should
14010 configure this variable appropriately for her configuration.
14013 @node Highlighting and Menus
14014 @section Highlighting and Menus
14015 @cindex visual
14016 @cindex highlighting
14017 @cindex menus
14019 @vindex gnus-visual
14020 The @code{gnus-visual} variable controls most of the Gnus-prettifying
14021 aspects.  If @code{nil}, Gnus won't attempt to create menus or use fancy
14022 colors or fonts.  This will also inhibit loading the @file{gnus-vis.el}
14023 file.
14025 This variable can be a list of visual properties that are enabled.  The
14026 following elements are valid, and are all included by default:
14028 @table @code
14029 @item group-highlight
14030 Do highlights in the group buffer.
14031 @item summary-highlight
14032 Do highlights in the summary buffer.
14033 @item article-highlight
14034 Do highlights in the article buffer.
14035 @item highlight
14036 Turn on highlighting in all buffers.
14037 @item group-menu
14038 Create menus in the group buffer.
14039 @item summary-menu
14040 Create menus in the summary buffers.
14041 @item article-menu
14042 Create menus in the article buffer.
14043 @item browse-menu
14044 Create menus in the browse buffer.
14045 @item server-menu
14046 Create menus in the server buffer.
14047 @item score-menu
14048 Create menus in the score buffers.
14049 @item menu
14050 Create menus in all buffers.
14051 @end table
14053 So if you only want highlighting in the article buffer and menus in all
14054 buffers, you could say something like:
14056 @lisp
14057 (setq gnus-visual '(article-highlight menu))
14058 @end lisp
14060 If you want highlighting only and no menus whatsoever, you'd say:
14062 @lisp
14063 (setq gnus-visual '(highlight))
14064 @end lisp
14066 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
14067 in all Gnus buffers.
14069 Other general variables that influence the look of all buffers include:
14071 @table @code
14072 @item gnus-mouse-face
14073 @vindex gnus-mouse-face
14074 This is the face (i.e., font) used for mouse highlighting in Gnus.  No
14075 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
14077 @end table
14079 There are hooks associated with the creation of all the different menus:
14081 @table @code
14083 @item gnus-article-menu-hook
14084 @vindex gnus-article-menu-hook
14085 Hook called after creating the article mode menu.
14087 @item gnus-group-menu-hook
14088 @vindex gnus-group-menu-hook
14089 Hook called after creating the group mode menu.
14091 @item gnus-summary-menu-hook
14092 @vindex gnus-summary-menu-hook
14093 Hook called after creating the summary mode menu.
14095 @item gnus-server-menu-hook
14096 @vindex gnus-server-menu-hook
14097 Hook called after creating the server mode menu.
14099 @item gnus-browse-menu-hook
14100 @vindex gnus-browse-menu-hook
14101 Hook called after creating the browse mode menu.
14103 @item gnus-score-menu-hook
14104 @vindex gnus-score-menu-hook
14105 Hook called after creating the score mode menu.
14107 @end table
14110 @node Buttons
14111 @section Buttons
14112 @cindex buttons
14113 @cindex mouse
14114 @cindex click
14116 Those new-fangled @dfn{mouse} contraptions is very popular with the
14117 young, hep kids who don't want to learn the proper way to do things
14118 these days.  Why, I remember way back in the summer of '89, when I was
14119 using Emacs on a Tops 20 system.  Three hundred users on one single
14120 machine, and every user was running Simula compilers.  Bah!
14122 Right.
14124 @vindex gnus-carpal
14125 Well, you can make Gnus display bufferfuls of buttons you can click to
14126 do anything by setting @code{gnus-carpal} to @code{t}.  Pretty simple,
14127 really.  Tell the chiropractor I sent you.
14130 @table @code
14132 @item gnus-carpal-mode-hook
14133 @vindex gnus-carpal-mode-hook
14134 Hook run in all carpal mode buffers.
14136 @item gnus-carpal-button-face
14137 @vindex gnus-carpal-button-face
14138 Face used on buttons.
14140 @item gnus-carpal-header-face
14141 @vindex gnus-carpal-header-face
14142 Face used on carpal buffer headers.
14144 @item gnus-carpal-group-buffer-buttons
14145 @vindex gnus-carpal-group-buffer-buttons
14146 Buttons in the group buffer.
14148 @item gnus-carpal-summary-buffer-buttons
14149 @vindex gnus-carpal-summary-buffer-buttons
14150 Buttons in the summary buffer.
14152 @item gnus-carpal-server-buffer-buttons
14153 @vindex gnus-carpal-server-buffer-buttons
14154 Buttons in the server buffer.
14156 @item gnus-carpal-browse-buffer-buttons
14157 @vindex gnus-carpal-browse-buffer-buttons
14158 Buttons in the browse buffer.
14159 @end table
14161 All the @code{buttons} variables are lists.  The elements in these list
14162 are either cons cells where the @code{car} contains a text to be displayed and
14163 the @code{cdr} contains a function symbol, or a simple string.
14166 @node Daemons
14167 @section Daemons
14168 @cindex demons
14169 @cindex daemons
14171 Gnus, being larger than any program ever written (allegedly), does lots
14172 of strange stuff that you may wish to have done while you're not
14173 present.  For instance, you may want it to check for new mail once in a
14174 while.  Or you may want it to close down all connections to all servers
14175 when you leave Emacs idle.  And stuff like that.
14177 Gnus will let you do stuff like that by defining various
14178 @dfn{handlers}.  Each handler consists of three elements:  A
14179 @var{function}, a @var{time}, and an @var{idle} parameter.
14181 Here's an example of a handler that closes connections when Emacs has
14182 been idle for thirty minutes:
14184 @lisp
14185 (gnus-demon-close-connections nil 30)
14186 @end lisp
14188 Here's a handler that scans for PGP headers every hour when Emacs is
14189 idle:
14191 @lisp
14192 (gnus-demon-scan-pgp 60 t)
14193 @end lisp
14195 This @var{time} parameter and than @var{idle} parameter work together
14196 in a strange, but wonderful fashion.  Basically, if @var{idle} is
14197 @code{nil}, then the function will be called every @var{time} minutes.
14199 If @var{idle} is @code{t}, then the function will be called after
14200 @var{time} minutes only if Emacs is idle.  So if Emacs is never idle,
14201 the function will never be called.  But once Emacs goes idle, the
14202 function will be called every @var{time} minutes.
14204 If @var{idle} is a number and @var{time} is a number, the function will
14205 be called every @var{time} minutes only when Emacs has been idle for
14206 @var{idle} minutes.
14208 If @var{idle} is a number and @var{time} is @code{nil}, the function
14209 will be called once every time Emacs has been idle for @var{idle}
14210 minutes.
14212 And if @var{time} is a string, it should look like @samp{07:31}, and
14213 the function will then be called once every day somewhere near that
14214 time.  Modified by the @var{idle} parameter, of course.
14216 @vindex gnus-demon-timestep
14217 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
14218 seconds.  This is 60 by default.  If you change that variable,
14219 all the timings in the handlers will be affected.)
14221 @vindex gnus-use-demon
14222 To set the whole thing in motion, though, you have to set
14223 @code{gnus-use-demon} to @code{t}.
14225 So, if you want to add a handler, you could put something like this in
14226 your @file{.gnus} file:
14228 @findex gnus-demon-add-handler
14229 @lisp
14230 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
14231 @end lisp
14233 @findex gnus-demon-add-nocem
14234 @findex gnus-demon-add-scanmail
14235 @findex gnus-demon-add-rescan
14236 @findex gnus-demon-add-scan-timestamps
14237 @findex gnus-demon-add-disconnection
14238 Some ready-made functions to do this have been created:
14239 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
14240 @code{gnus-demon-add-nntp-close-connection},
14241 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
14242 @code{gnus-demon-add-scanmail}.  Just put those functions in your
14243 @file{.gnus} if you want those abilities.
14245 @findex gnus-demon-init
14246 @findex gnus-demon-cancel
14247 @vindex gnus-demon-handlers
14248 If you add handlers to @code{gnus-demon-handlers} directly, you should
14249 run @code{gnus-demon-init} to make the changes take hold.  To cancel all
14250 daemons, you can use the @code{gnus-demon-cancel} function.
14252 Note that adding daemons can be pretty naughty if you over do it.  Adding
14253 functions that scan all news and mail from all servers every two seconds
14254 is a sure-fire way of getting booted off any respectable system.  So
14255 behave.
14258 @node NoCeM
14259 @section NoCeM
14260 @cindex nocem
14261 @cindex spam
14263 @dfn{Spamming} is posting the same article lots and lots of times.
14264 Spamming is bad.  Spamming is evil.
14266 Spamming is usually canceled within a day or so by various anti-spamming
14267 agencies.  These agencies usually also send out @dfn{NoCeM} messages.
14268 NoCeM is pronounced ``no see-'em'', and means what the name
14269 implies---these are messages that make the offending articles, like, go
14270 away.
14272 What use are these NoCeM messages if the articles are canceled anyway?
14273 Some sites do not honor cancel messages and some sites just honor cancels
14274 from a select few people.  Then you may wish to make use of the NoCeM
14275 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
14277 Gnus can read and parse the messages in this group automatically, and
14278 this will make spam disappear.
14280 There are some variables to customize, of course:
14282 @table @code
14283 @item gnus-use-nocem
14284 @vindex gnus-use-nocem
14285 Set this variable to @code{t} to set the ball rolling.  It is @code{nil}
14286 by default.
14288 @item gnus-nocem-groups
14289 @vindex gnus-nocem-groups
14290 Gnus will look for NoCeM messages in the groups in this list.  The
14291 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
14292 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
14294 @item gnus-nocem-issuers
14295 @vindex gnus-nocem-issuers
14296 There are many people issuing NoCeM messages.  This list says what
14297 people you want to listen to.  The default is @code{("Automoose-1"
14298 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
14299 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
14300 (Richard E. Depew)")}; fine, upstanding citizens all of them.
14302 Known despammers that you can put in this list include:
14304 @table @samp
14305 @item clewis@@ferret.ocunix.on.ca;
14306 @cindex Chris Lewis
14307 Chris Lewis---Major Canadian despammer who has probably canceled more
14308 usenet abuse than anybody else.
14310 @item Automoose-1
14311 @cindex CancelMoose[tm]
14312 The CancelMoose[tm] on autopilot.  The CancelMoose[tm] is reputed to be
14313 Norwegian, and was the person(s) who invented NoCeM.
14315 @item jem@@xpat.com;
14316 @cindex Jem
14317 John Milburn---despammer located in Korea who is getting very busy these
14318 days.
14320 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
14321 Richard E. Depew---lone American despammer.  He mostly cancels binary
14322 postings to non-binary groups and removes spews (regurgitated articles).
14323 @end table
14325 You do not have to heed NoCeM messages from all these people---just the
14326 ones you want to listen to.  You also don't have to accept all NoCeM
14327 messages from the people you like.  Each NoCeM message has a @dfn{type}
14328 header that gives the message a (more or less, usually less) rigorous
14329 definition.  Common types are @samp{spam}, @samp{spew}, @samp{mmf},
14330 @samp{binary}, and @samp{troll}.  To specify this, you have to use
14331 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.  Each condition is
14332 either a string (which is a regexp that matches types you want to use)
14333 or a list on the form @code{(not STRING)}, where @var{string} is a
14334 regexp that matches types you don't want to use.
14336 For instance, if you want all NoCeM messages from Chris Lewis except his
14337 @samp{troll} messages, you'd say:
14339 @lisp
14340 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
14341 @end lisp
14343 On the other hand, if you just want nothing but his @samp{spam} and
14344 @samp{spew} messages, you'd say:
14346 @lisp
14347 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
14348 @end lisp
14350 The specs are applied left-to-right.
14353 @item gnus-nocem-verifyer
14354 @vindex gnus-nocem-verifyer
14355 @findex mc-verify
14356 This should be a function for verifying that the NoCeM issuer is who she
14357 says she is.  The default is @code{mc-verify}, which is a Mailcrypt
14358 function.  If this is too slow and you don't care for verification
14359 (which may be dangerous), you can set this variable to @code{nil}.
14361 If you want signed NoCeM messages to be verified and unsigned messages
14362 not to be verified (but used anyway), you could do something like:
14364 @lisp
14365 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
14367 (defun my-gnus-mc-verify ()
14368   (not (eq 'forged
14369            (ignore-errors
14370              (if (mc-verify)
14371                  t
14372                'forged)))))
14373 @end lisp
14375 This might be dangerous, though.
14377 @item gnus-nocem-directory
14378 @vindex gnus-nocem-directory
14379 This is where Gnus will store its NoCeM cache files.  The default is
14380 @file{~/News/NoCeM/}.
14382 @item gnus-nocem-expiry-wait
14383 @vindex gnus-nocem-expiry-wait
14384 The number of days before removing old NoCeM entries from the cache.
14385 The default is 15.  If you make it shorter Gnus will be faster, but you
14386 might then see old spam.
14388 @end table
14390 Using NoCeM could potentially be a memory hog.  If you have many living
14391 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
14392 big.  If this is a problem, you should kill off all (or most) of your
14393 unsubscribed groups (@pxref{Subscription Commands}).
14396 @node Undo
14397 @section Undo
14398 @cindex undo
14400 It is very useful to be able to undo actions one has done.  In normal
14401 Emacs buffers, it's easy enough---you just push the @code{undo} button.
14402 In Gnus buffers, however, it isn't that simple.
14404 The things Gnus displays in its buffer is of no value whatsoever to
14405 Gnus---it's all just data designed to look nice to the user.
14406 Killing a group in the group buffer with @kbd{C-k} makes the line
14407 disappear, but that's just a side-effect of the real action---the
14408 removal of the group in question from the internal Gnus structures.
14409 Undoing something like that can't be done by the normal Emacs
14410 @code{undo} function.
14412 Gnus tries to remedy this somewhat by keeping track of what the user
14413 does and coming up with actions that would reverse the actions the user
14414 takes.  When the user then presses the @code{undo} key, Gnus will run
14415 the code to reverse the previous action, or the previous actions.
14416 However, not all actions are easily reversible, so Gnus currently offers
14417 a few key functions to be undoable.  These include killing groups,
14418 yanking groups, and changing the list of read articles of groups.
14419 That's it, really.  More functions may be added in the future, but each
14420 added function means an increase in data to be stored, so Gnus will
14421 never be totally undoable.
14423 @findex gnus-undo-mode
14424 @vindex gnus-use-undo
14425 @findex gnus-undo
14426 The undoability is provided by the @code{gnus-undo-mode} minor mode.  It
14427 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
14428 default.  The @kbd{M-C-_} key performs the @code{gnus-undo} command
14429 command, which should feel kinda like the normal Emacs @code{undo}
14430 command.
14433 @node Moderation
14434 @section Moderation
14435 @cindex moderation
14437 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
14438 It is not included in the standard Gnus package.  Write a mail to
14439 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
14440 get a copy.
14442 The moderation package is implemented as a minor mode for summary
14443 buffers.  Put
14445 @lisp
14446 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
14447 @end lisp
14449 in your @file{.gnus.el} file.
14451 If you are the moderator of @samp{rec.zoofle}, this is how it's
14452 supposed to work:
14454 @enumerate
14455 @item
14456 You split your incoming mail by matching on
14457 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
14458 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
14460 @item
14461 You enter that group once in a while and post articles using the @kbd{e}
14462 (edit-and-post) or @kbd{s} (just send unedited) commands.
14464 @item
14465 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
14466 articles that weren't approved by you, you can cancel them with the
14467 @kbd{c} command.
14468 @end enumerate
14470 To use moderation mode in these two groups, say:
14472 @lisp
14473 (setq gnus-moderated-list
14474       "^nnml:rec.zoofle$\\|^rec.zoofle$")
14475 @end lisp
14478 @node XEmacs Enhancements
14479 @section XEmacs Enhancements
14480 @cindex XEmacs
14482 XEmacs is able to display pictures and stuff, so Gnus has taken
14483 advantage of that.
14485 @menu
14486 * Picons::    How to display pictures of what your reading.
14487 * Smileys::   Show all those happy faces the way they were meant to be shown.
14488 * Toolbar::   Click'n'drool.
14489 * XVarious::  Other XEmacsy Gnusey variables.
14490 @end menu
14493 @node Picons
14494 @subsection Picons
14496 So...  You want to slow down your news reader even more!  This is a
14497 good way to do so.  Its also a great way to impress people staring
14498 over your shoulder as you read news.
14500 @menu
14501 * Picon Basics::           What are picons and How do I get them.
14502 * Picon Requirements::     Don't go further if you aren't using XEmacs.
14503 * Easy Picons::            Displaying Picons---the easy way.
14504 * Hard Picons::            The way you should do it.  You'll learn something.
14505 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
14506 @end menu
14509 @node Picon Basics
14510 @subsubsection Picon Basics
14512 What are Picons?  To quote directly from the Picons Web site:
14514 @quotation
14515 @dfn{Picons} is short for ``personal icons''.  They're small,
14516 constrained images used to represent users and domains on the net,
14517 organized into databases so that the appropriate image for a given
14518 e-mail address can be found.  Besides users and domains, there are picon
14519 databases for Usenet newsgroups and weather forecasts.  The picons are
14520 in either monochrome @code{XBM} format or color @code{XPM} and
14521 @code{GIF} formats.
14522 @end quotation
14524 @vindex gnus-picons-piconsearch-url
14525 If you have a permanent connection to the Internet you can use Steve
14526 Kinzler's Picons Search engine by setting
14527 @code{gnus-picons-piconsearch-url} to the string @*
14528 @file{http://www.cs.indiana.edu/picons/search.html}.
14530 @vindex gnus-picons-database
14531 Otherwise you need a local copy of his database.  For instructions on
14532 obtaining and installing the picons databases, point your Web browser at @*
14533 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.  Gnus expects
14534 picons to be installed into a location pointed to by
14535 @code{gnus-picons-database}.
14538 @node Picon Requirements
14539 @subsubsection Picon Requirements
14541 To have Gnus display Picons for you, you must be running XEmacs
14542 19.13 or greater since all other versions of Emacs aren't yet able to
14543 display images.
14545 Additionally, you must have @code{x} support compiled into XEmacs.  To
14546 display color picons which are much nicer than the black & white one,
14547 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
14549 @vindex gnus-picons-convert-x-face
14550 If you want to display faces from @code{X-Face} headers, you should have
14551 the @code{xface} support compiled into XEmacs.  Otherwise you must have
14552 the @code{netpbm} utilities installed, or munge the
14553 @code{gnus-picons-convert-x-face} variable to use something else.
14556 @node Easy Picons
14557 @subsubsection Easy Picons
14559 To enable displaying picons, simply put the following line in your
14560 @file{~/.gnus} file and start Gnus.
14562 @lisp
14563 (setq gnus-use-picons t)
14564 (add-hook 'gnus-article-display-hook
14565           'gnus-article-display-picons t)
14566 (add-hook 'gnus-article-display-hook
14567           'gnus-picons-article-display-x-face)
14568 @end lisp
14570 and make sure @code{gnus-picons-database} points to the directory
14571 containing the Picons databases.
14573 Alternatively if you want to use the web piconsearch engine add this:
14575 @lisp
14576 (setq gnus-picons-piconsearch-url
14577       "http://www.cs.indiana.edu:800/piconsearch")
14578 @end lisp
14581 @node Hard Picons
14582 @subsubsection Hard Picons
14584 Gnus can display picons for you as you enter and leave groups and
14585 articles.  It knows how to interact with three sections of the picons
14586 database.  Namely, it can display the picons newsgroup pictures,
14587 author's face picture(s), and the authors domain.  To enable this
14588 feature, you need to select where to get the picons from, and where to
14589 display them.
14591 @table @code
14593 @item gnus-picons-database
14594 @vindex gnus-picons-database
14595 The location of the picons database.  Should point to a directory
14596 containing the @file{news}, @file{domains}, @file{users} (and so on)
14597 subdirectories.  This is only useful if
14598 @code{gnus-picons-piconsearch-url} is @code{nil}.  Defaults to
14599 @file{/usr/local/faces/}.
14601 @item gnus-picons-piconsearch-url
14602 @vindex gnus-picons-piconsearch-url
14603 The URL for the web picons search engine.  The only currently known
14604 engine is @file{http://www.cs.indiana.edu:800/piconsearch}.  To
14605 workaround network delays, icons will be fetched in the background.  If
14606 this is @code{nil} 'the default), then picons are fetched from local
14607 database indicated by @code{gnus-picons-database}.
14609 @item gnus-picons-display-where
14610 @vindex gnus-picons-display-where
14611 Where the picon images should be displayed.  It is @code{picons} by
14612 default (which by default maps to the buffer @samp{*Picons*}).  Other
14613 valid places could be @code{article}, @code{summary}, or
14614 @samp{*scratch*} for all I care.  Just make sure that you've made the
14615 buffer visible using the standard Gnus window configuration
14616 routines---@pxref{Windows Configuration}.
14618 @item gnus-picons-group-excluded-groups
14619 @vindex gnus-picons-group-excluded-groups
14620 Groups that are matched by this regexp won't have their group icons
14621 displayed.
14623 @end table
14625 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
14626 window configuration for you to include the @code{picons} buffer.
14628 Now that you've made those decision, you need to add the following
14629 functions to the appropriate hooks so these pictures will get displayed
14630 at the right time.
14632 @vindex gnus-article-display-hook
14633 @vindex gnus-picons-display-where
14634 @table @code
14635 @item gnus-article-display-picons
14636 @findex gnus-article-display-picons
14637 Looks up and displays the picons for the author and the author's domain
14638 in the @code{gnus-picons-display-where} buffer.  Should be added to the
14639 @code{gnus-article-display-hook}.
14641 @item gnus-picons-article-display-x-face
14642 @findex gnus-article-display-picons
14643 Decodes and displays the X-Face header if present.  This function
14644 should be added to @code{gnus-article-display-hook}.
14646 @end table
14648 Note:  You must append them to the hook, so make sure to specify 't'
14649 for the append flag of @code{add-hook}:
14651 @lisp
14652 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
14653 @end lisp
14656 @node Picon Useless Configuration
14657 @subsubsection Picon Useless Configuration
14659 The following variables offer further control over how things are
14660 done, where things are located, and other useless stuff you really
14661 don't need to worry about.
14663 @table @code
14665 @item gnus-picons-news-directories
14666 @vindex gnus-picons-news-directories
14667 List of subdirectories to search in @code{gnus-picons-database} for
14668 newsgroups faces.  @code{("news")} is the default.
14670 @item gnus-picons-user-directories
14671 @vindex gnus-picons-user-directories
14672 List of subdirectories to search in @code{gnus-picons-database} for user
14673 faces.  @code{("local" "users" "usenix" "misc")} is the default.
14675 @item gnus-picons-domain-directories
14676 @vindex gnus-picons-domain-directories
14677 List of subdirectories to search in @code{gnus-picons-database} for
14678 domain name faces.  Defaults to @code{("domains")}.  Some people may
14679 want to add @samp{"unknown"} to this list.
14681 @item gnus-picons-convert-x-face
14682 @vindex gnus-picons-convert-x-face
14683 If you don't have @code{xface} support builtin XEmacs, this is the
14684 command to use to convert the @code{X-Face} header to an X bitmap
14685 (@code{xbm}).  Defaults to @code{(format "@{ echo '/* Width=48,
14686 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
14687 gnus-picons-x-face-file-name)}
14689 @item gnus-picons-x-face-file-name
14690 @vindex gnus-picons-x-face-file-name
14691 Names a temporary file to store the @code{X-Face} bitmap in.  Defaults
14692 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
14694 @item gnus-picons-has-modeline-p
14695 @vindex gnus-picons-has-modeline-p
14696 If you have set @code{gnus-picons-display-where} to @code{picons}, your
14697 XEmacs frame will become really cluttered.  To alleviate this a bit you
14698 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
14699 remove the mode line from the Picons buffer.  This is only useful if
14700 @code{gnus-picons-display-where} is @code{picons}.
14702 @item gnus-picons-refresh-before-display
14703 @vindex gnus-picons-refresh-before-display
14704 If non-nil, display the article buffer before computing the picons.
14705 Defaults to @code{nil}.
14707 @item gnus-picons-display-as-address
14708 @vindex gnus-picons-display-as-address
14709 If @code{t} display textual email addresses along with pictures.
14710 Defaults to @code{t}.
14712 @item gnus-picons-file-suffixes
14713 @vindex gnus-picons-file-suffixes
14714 Ordered list of suffixes on picon file names to try.  Defaults to
14715 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
14717 @item gnus-picons-display-article-move-p
14718 @vindex gnus-picons-display-article-move-p
14719 Whether to move point to first empty line when displaying picons.  This
14720 has only an effect if `gnus-picons-display-where' has value `article'.
14722 @item gnus-picons-clear-cache-on-shutdown
14723 @vindex gnus-picons-clear-cache-on-shutdown
14724 Whether to clear the picons cache when exiting gnus.  Gnus caches every
14725 picons it finds while it is running.  This saves some time in the search
14726 process but eats some memory.  If this variable is set to @code{nil},
14727 Gnus will never clear the cache itself; you will have to manually call
14728 @code{gnus-picons-clear-cache} to clear it.  Otherwise the cache will be
14729 cleared every time you exit Gnus.  Defaults to @code{t}.
14731 @end table
14733 @node Smileys
14734 @subsection Smileys
14735 @cindex smileys
14737 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
14738 currently the only package that uses Smiley, it is documented here.
14740 In short---to use Smiley in Gnus, put the following in your
14741 @file{.gnus.el} file:
14743 @lisp
14744 (add-hook 'gnus-article-display-hook 'gnus-smiley-display t)
14745 @end lisp
14747 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
14748 the like---to pictures and displays those instead of the text smiley
14749 faces.  The conversion is controlled by a list of regexps that matches
14750 text and maps that to file names.
14752 @vindex smiley-nosey-regexp-alist
14753 @vindex smiley-deformed-regexp-alist
14754 Smiley supplies two example conversion alists by default:
14755 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
14756 and so on), and @code{smiley-nosey-regexp-alist} (which matches
14757 @samp{:-)}, @samp{:-(} and so on).
14759 The alist used is specified by the @code{smiley-regexp-alist} variable,
14760 which defaults to the value of @code{smiley-deformed-regexp-alist}.
14762 The first item in each element is the regexp to be matched; the second
14763 element is the regexp match group that is to be replaced by the picture;
14764 and the third element is the name of the file to be displayed.
14766 The following variables customize where Smiley will look for these
14767 files, as well as the color to be used and stuff:
14769 @table @code
14771 @item smiley-data-directory
14772 @vindex smiley-data-directory
14773 Where Smiley will look for smiley faces files.
14775 @item smiley-flesh-color
14776 @vindex smiley-flesh-color
14777 Skin color.  The default is @samp{yellow}, which is really racist.
14779 @item smiley-features-color
14780 @vindex smiley-features-color
14781 Color of the features of the face.  The default is @samp{black}.
14783 @item smiley-tongue-color
14784 @vindex smiley-tongue-color
14785 Color of the tongue.  The default is @samp{red}.
14787 @item smiley-circle-color
14788 @vindex smiley-circle-color
14789 Color of the circle around the face.  The default is @samp{black}.
14791 @item smiley-mouse-face
14792 @vindex smiley-mouse-face
14793 Face used for mouse highlighting over the smiley face.
14795 @end table
14798 @node Toolbar
14799 @subsection Toolbar
14801 @table @code
14803 @item gnus-use-toolbar
14804 @vindex gnus-use-toolbar
14805 If @code{nil}, don't display toolbars.  If non-@code{nil}, it should be
14806 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
14807 @code{right-toolbar}, or @code{left-toolbar}.
14809 @item gnus-group-toolbar
14810 @vindex gnus-group-toolbar
14811 The toolbar in the group buffer.
14813 @item gnus-summary-toolbar
14814 @vindex gnus-summary-toolbar
14815 The toolbar in the summary buffer.
14817 @item gnus-summary-mail-toolbar
14818 @vindex gnus-summary-mail-toolbar
14819 The toolbar in the summary buffer of mail groups.
14821 @end table
14824 @node XVarious
14825 @subsection Various XEmacs Variables
14827 @table @code
14828 @item gnus-xmas-glyph-directory
14829 @vindex gnus-xmas-glyph-directory
14830 This is where Gnus will look for pictures.  Gnus will normally
14831 auto-detect this directory, but you may set it manually if you have an
14832 unusual directory structure.
14834 @item gnus-xmas-logo-color-alist
14835 @vindex gnus-xmas-logo-color-alist
14836 This is an alist where the key is a type symbol and the values are the
14837 foreground and background color of the splash page glyph.
14839 @item gnus-xmas-logo-color-style
14840 @vindex gnus-xmas-logo-color-style
14841 This is the key used to look up the color in the alist described above.
14842 Valid values include @code{flame}, @code{pine}, @code{moss},
14843 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
14844 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
14846 @item gnus-xmas-modeline-glyph
14847 @vindex gnus-xmas-modeline-glyph
14848 A glyph displayed in all Gnus mode lines.  It is a tiny gnu head by
14849 default.
14851 @end table
14856 @node Fuzzy Matching
14857 @section Fuzzy Matching
14858 @cindex fuzzy matching
14860 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
14861 things like scoring, thread gathering and thread comparison.
14863 As opposed to regular expression matching, fuzzy matching is very fuzzy.
14864 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
14865 means, and the implementation has changed over time.
14867 Basically, it tries to remove all noise from lines before comparing.
14868 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
14869 out of the strings before comparing the results.  This often leads to
14870 adequate results---even when faced with strings generated by text
14871 manglers masquerading as newsreaders.
14874 @node Thwarting Email Spam
14875 @section Thwarting Email Spam
14876 @cindex email spam
14877 @cindex spam
14878 @cindex UCE
14879 @cindex unsolicited commercial email
14881 In these last days of the Usenet, commercial vultures are hanging about
14882 and grepping through news like crazy to find email addresses they can
14883 foist off their scams and products to.  As a reaction to this, many
14884 people have started putting nonsense addresses into their @code{From}
14885 lines.  I think this is counterproductive---it makes it difficult for
14886 people to send you legitimate mail in response to things you write, as
14887 well as making it difficult to see who wrote what.  This rewriting may
14888 perhaps be a bigger menace than the unsolicited commercial email itself
14889 in the end.
14891 The biggest problem I have with email spam is that it comes in under
14892 false pretenses.  I press @kbd{g} and Gnus merrily informs me that I
14893 have 10 new emails.  I say ``Golly gee!  Happy is me!'' and select the
14894 mail group, only to find two pyramid schemes, seven advertisements
14895 (``New!  Miracle tonic for growing full, lustrous hair on your toes!'')
14896 and one mail asking me to repent and find some god.
14898 This is annoying.
14900 The way to deal with this is having Gnus split out all spam into a
14901 @samp{spam} mail group (@pxref{Splitting Mail}).
14903 First, pick one (1) valid mail address that you can be reached at, and
14904 put it in your @code{From} header of all your news articles.  (I've
14905 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
14906 @samp{larsi+usenet@@ifi.uio.no} will be a better choice.  Ask your
14907 sysadm whether your sendmail installation accepts keywords in the local
14908 part of the mail address.)
14910 @lisp
14911 (setq message-default-news-headers
14912       "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
14913 @end lisp
14915 Then put the following split rule in @code{nnmail-split-fancy}
14916 (@pxref{Fancy Mail Splitting}):
14918 @lisp
14920  ...
14921  (to "larsi@@trym.ifi.uio.no"
14922       (| ("subject" "re:.*" "misc")
14923          ("references" ".*@@.*" "misc")
14924          "spam"))
14925  ...
14927 @end lisp
14929 This says that all mail to this address is suspect, but if it has a
14930 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
14931 header, it's probably ok.  All the rest goes to the @samp{spam} group.
14932 (This idea probably comes from Tim Pierce.)
14934 In addition, many mail spammers talk directly to your @code{smtp} server
14935 and do not include your email address explicitly in the @code{To}
14936 header.  Why they do this is unknown---perhaps it's to thwart this
14937 thwarting scheme?  In any case, this is trivial to deal with---you just
14938 put anything not addressed to you in the @samp{spam} group by ending
14939 your fancy split rule in this way:
14941 @lisp
14943  ...
14944  (to "larsi" "misc")
14945  "spam")
14946 @end lisp
14948 In my experience, this will sort virtually everything into the right
14949 group.  You still have to check the @samp{spam} group from time to time to
14950 check for legitimate mail, though.  If you feel like being a good net
14951 citizen, you can even send off complaints to the proper authorities on
14952 each unsolicited commercial email---at your leisure.
14954 If you are also a lazy net citizen, you will probably prefer complaining
14955 automatically with the @file{gnus-junk.el} package, available FOR FREE
14956 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
14957 Since most e-mail spam is sent automatically, this may reconcile the
14958 cosmic balance somewhat.
14960 This works for me.  It allows people an easy way to contact me (they can
14961 just press @kbd{r} in the usual way), and I'm not bothered at all with
14962 spam.  It's a win-win situation.  Forging @code{From} headers to point
14963 to non-existent domains is yucky, in my opinion.
14966 @node Various Various
14967 @section Various Various
14968 @cindex mode lines
14969 @cindex highlights
14971 @table @code
14973 @item gnus-home-directory
14974 All Gnus path variables will be initialized from this variable, which
14975 defaults to @file{~/}.
14977 @item gnus-directory
14978 @vindex gnus-directory
14979 Most Gnus storage path variables will be initialized from this variable,
14980 which defaults to the @samp{SAVEDIR} environment variable, or
14981 @file{~/News/} if that variable isn't set.
14983 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
14984 This means that other directory variables that are initialized from this
14985 variable won't be set properly if you set this variable in
14986 @file{.gnus.el}.  Set this variable in @file{.emacs} instead.
14988 @item gnus-default-directory
14989 @vindex gnus-default-directory
14990 Not related to the above variable at all---this variable says what the
14991 default directory of all Gnus buffers should be.  If you issue commands
14992 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
14993 default directory.  If this variable is @code{nil} (which is the
14994 default), the default directory will be the default directory of the
14995 buffer you were in when you started Gnus.
14997 @item gnus-verbose
14998 @vindex gnus-verbose
14999 This variable is an integer between zero and ten.  The higher the value,
15000 the more messages will be displayed.  If this variable is zero, Gnus
15001 will never flash any messages, if it is seven (which is the default),
15002 most important messages will be shown, and if it is ten, Gnus won't ever
15003 shut up, but will flash so many messages it will make your head swim.
15005 @item gnus-verbose-backends
15006 @vindex gnus-verbose-backends
15007 This variable works the same way as @code{gnus-verbose}, but it applies
15008 to the Gnus backends instead of Gnus proper.
15010 @item nnheader-max-head-length
15011 @vindex nnheader-max-head-length
15012 When the backends read straight heads of articles, they all try to read
15013 as little as possible.  This variable (default 4096) specifies
15014 the absolute max length the backends will try to read before giving up
15015 on finding a separator line between the head and the body.  If this
15016 variable is @code{nil}, there is no upper read bound.  If it is
15017 @code{t}, the backends won't try to read the articles piece by piece,
15018 but read the entire articles.  This makes sense with some versions of
15019 @code{ange-ftp} or @code{efs}.
15021 @item nnheader-head-chop-length
15022 @vindex nnheader-head-chop-length
15023 This variable (default 2048) says how big a piece of each article to
15024 read when doing the operation described above.
15026 @item nnheader-file-name-translation-alist
15027 @vindex nnheader-file-name-translation-alist
15028 @cindex file names
15029 @cindex invalid characters in file names
15030 @cindex characters in file names
15031 This is an alist that says how to translate characters in file names.
15032 For instance, if @samp{:} is invalid as a file character in file names
15033 on your system (you OS/2 user you), you could say something like:
15035 @lisp
15036 (setq nnheader-file-name-translation-alist
15037       '((?: . ?_)))
15038 @end lisp
15040 In fact, this is the default value for this variable on OS/2 and MS
15041 Windows (phooey) systems.
15043 @item gnus-hidden-properties
15044 @vindex gnus-hidden-properties
15045 This is a list of properties to use to hide ``invisible'' text.  It is
15046 @code{(invisible t intangible t)} by default on most systems, which
15047 makes invisible text invisible and intangible.
15049 @item gnus-parse-headers-hook
15050 @vindex gnus-parse-headers-hook
15051 A hook called before parsing headers.  It can be used, for instance, to
15052 gather statistics on the headers fetched, or perhaps you'd like to prune
15053 some headers.  I don't see why you'd want that, though.
15055 @item gnus-shell-command-separator
15056 @vindex gnus-shell-command-separator
15057 String used to separate two shell commands.  The default is @samp{;}.
15060 @end table
15063 @node The End
15064 @chapter The End
15066 Well, that's the manual---you can get on with your life now.  Keep in
15067 touch.  Say hello to your cats from me.
15069 My @strong{ghod}---I just can't stand goodbyes.  Sniffle.
15071 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
15073 @quotation
15074 @strong{Te Deum}
15076 @sp 1
15077 Not because of victories @*
15078 I sing,@*
15079 having none,@*
15080 but for the common sunshine,@*
15081 the breeze,@*
15082 the largess of the spring.
15084 @sp 1
15085 Not for victory@*
15086 but for the day's work done@*
15087 as well as I was able;@*
15088 not for a seat upon the dais@*
15089 but at the common table.@*
15090 @end quotation
15093 @node Appendices
15094 @chapter Appendices
15096 @menu
15097 * History::                        How Gnus got where it is today.
15098 * Terminology::                    We use really difficult, like, words here.
15099 * Customization::                  Tailoring Gnus to your needs.
15100 * Troubleshooting::                What you might try if things do not work.
15101 * A Programmers Guide to Gnus::    Rilly, rilly technical stuff.
15102 * Emacs for Heathens::             A short introduction to Emacsian terms.
15103 * Frequently Asked Questions::     A question-and-answer session.
15104 @end menu
15107 @node History
15108 @section History
15110 @cindex history
15111 @sc{gnus} was written by Masanobu @sc{Umeda}.  When autumn crept up in
15112 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
15114 If you want to investigate the person responsible for this outrage, you
15115 can point your (feh!) web browser to
15116 @file{http://www.stud.ifi.uio.no/~larsi/}.  This is also the primary
15117 distribution point for the new and spiffy versions of Gnus, and is known
15118 as The Site That Destroys Newsrcs And Drives People Mad.
15120 During the first extended alpha period of development, the new Gnus was
15121 called ``(ding) Gnus''.  @dfn{(ding)} is, of course, short for
15122 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
15123 (Besides, the ``Gnus'' in this abbreviation should probably be
15124 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
15125 appropriate name, don't you think?)
15127 In any case, after spending all that energy on coming up with a new and
15128 spunky name, we decided that the name was @emph{too} spunky, so we
15129 renamed it back again to ``Gnus''.  But in mixed case.  ``Gnus'' vs.
15130 ``@sc{gnus}''.  New vs. old.
15132 The first ``proper'' release of Gnus 5 was done in November 1995 when it
15133 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
15134 plus 15 Gnus 5.0 releases).
15136 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
15137 releases)) was released under the name ``Gnus 5.2'' (40 releases).
15139 On July 28th 1996 work on Red Gnus was begun, and it was released on
15140 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
15142 On September 13th 1997, Quassia Gnus was started and lasted 37
15143 releases.  If was released as ``Gnus 5.6 on March 8th 1998.
15145 If you happen upon a version of Gnus that has a prefixed name --
15146 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
15147 don't panic.  Don't let it know that you're frightened.  Back away.
15148 Slowly.  Whatever you do, don't run.  Walk away, calmly, until you're
15149 out of its reach.  Find a proper released version of Gnus and snuggle up
15150 to that instead.
15152 @menu
15153 * Why?::                What's the point of Gnus?
15154 * Compatibility::       Just how compatible is Gnus with @sc{gnus}?
15155 * Conformity::          Gnus tries to conform to all standards.
15156 * Emacsen::             Gnus can be run on a few modern Emacsen.
15157 * Contributors::        Oodles of people.
15158 * New Features::        Pointers to some of the new stuff in Gnus.
15159 * Newest Features::     Features so new that they haven't been written yet.
15160 @end menu
15163 @node Why?
15164 @subsection Why?
15166 What's the point of Gnus?
15168 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
15169 newsreader, that lets you do anything you can think of.  That was my
15170 original motivation, but while working on Gnus, it has become clear to
15171 me that this generation of newsreaders really belong in the stone age.
15172 Newsreaders haven't developed much since the infancy of the net.  If the
15173 volume continues to rise with the current rate of increase, all current
15174 newsreaders will be pretty much useless.  How do you deal with
15175 newsgroups that have thousands of new articles each day?  How do you
15176 keep track of millions of people who post?
15178 Gnus offers no real solutions to these questions, but I would very much
15179 like to see Gnus being used as a testing ground for new methods of
15180 reading and fetching news.  Expanding on @sc{Umeda}-san's wise decision
15181 to separate the newsreader from the backends, Gnus now offers a simple
15182 interface for anybody who wants to write new backends for fetching mail
15183 and news from different sources.  I have added hooks for customizations
15184 everywhere I could imagine it being useful.  By doing so, I'm inviting
15185 every one of you to explore and invent.
15187 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
15188 @kbd{C-u 100 M-x all-hail-xemacs}.
15191 @node Compatibility
15192 @subsection Compatibility
15194 @cindex compatibility
15195 Gnus was designed to be fully compatible with @sc{gnus}.  Almost all key
15196 bindings have been kept.  More key bindings have been added, of course,
15197 but only in one or two obscure cases have old bindings been changed.
15199 Our motto is:
15200 @quotation
15201 @cartouche
15202 @center In a cloud bones of steel.
15203 @end cartouche
15204 @end quotation
15206 All commands have kept their names.  Some internal functions have changed
15207 their names.
15209 The @code{gnus-uu} package has changed drastically. @xref{Decoding
15210 Articles}.
15212 One major compatibility question is the presence of several summary
15213 buffers.  All variables relevant while reading a group are
15214 buffer-local to the summary buffer they belong in.  Although many
15215 important variables have their values copied into their global
15216 counterparts whenever a command is executed in the summary buffer, this
15217 change might lead to incorrect values being used unless you are careful.
15219 All code that relies on knowledge of @sc{gnus} internals will probably
15220 fail.  To take two examples: Sorting @code{gnus-newsrc-alist} (or
15221 changing it in any way, as a matter of fact) is strictly verboten.  Gnus
15222 maintains a hash table that points to the entries in this alist (which
15223 speeds up many functions), and changing the alist directly will lead to
15224 peculiar results.
15226 @cindex hilit19
15227 @cindex highlighting
15228 Old hilit19 code does not work at all.  In fact, you should probably
15229 remove all hilit code from all Gnus hooks
15230 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
15231 Gnus provides various integrated functions for highlighting.  These are
15232 faster and more accurate.  To make life easier for everybody, Gnus will
15233 by default remove all hilit calls from all hilit hooks.  Uncleanliness!
15234 Away!
15236 Packages like @code{expire-kill} will no longer work.  As a matter of
15237 fact, you should probably remove all old @sc{gnus} packages (and other
15238 code) when you start using Gnus.  More likely than not, Gnus already
15239 does what you have written code to make @sc{gnus} do.  (Snicker.)
15241 Even though old methods of doing things are still supported, only the
15242 new methods are documented in this manual.  If you detect a new method of
15243 doing something while reading this manual, that does not mean you have
15244 to stop doing it the old way.
15246 Gnus understands all @sc{gnus} startup files.
15248 @kindex M-x gnus-bug
15249 @findex gnus-bug
15250 @cindex reporting bugs
15251 @cindex bugs
15252 Overall, a casual user who hasn't written much code that depends on
15253 @sc{gnus} internals should suffer no problems.  If problems occur,
15254 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
15256 @vindex gnus-bug-create-help-buffer
15257 If you are in the habit of sending bug reports @emph{very} often, you
15258 may find the helpful help buffer annoying after a while.  If so, set
15259 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
15260 up at you.
15263 @node Conformity
15264 @subsection Conformity
15266 No rebels without a clue here, ma'am.  We conform to all standards known
15267 to (wo)man.  Except for those standards and/or conventions we disagree
15268 with, of course.
15270 @table @strong
15272 @item RFC 822
15273 @cindex RFC 822
15274 There are no known breaches of this standard.
15276 @item RFC 1036
15277 @cindex RFC 1036
15278 There are no known breaches of this standard, either.
15280 @item Son-of-RFC 1036
15281 @cindex Son-of-RFC 1036
15282 We do have some breaches to this one.
15284 @table @emph
15286 @item MIME
15287 Gnus does no MIME handling, and this standard-to-be seems to think that
15288 MIME is the bees' knees, so we have major breakage here.
15290 @item X-Newsreader
15291 This is considered to be a ``vanity header'', while I consider it to be
15292 consumer information.  After seeing so many badly formatted articles
15293 coming from @code{tin} and @code{Netscape} I know not to use either of
15294 those for posting articles.  I would not have known that if it wasn't
15295 for the @code{X-Newsreader} header.
15296 @end table
15298 @end table
15300 If you ever notice Gnus acting non-compliant with regards to the texts
15301 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
15302 know.
15305 @node Emacsen
15306 @subsection Emacsen
15307 @cindex Emacsen
15308 @cindex XEmacs
15309 @cindex Mule
15310 @cindex Emacs
15312 Gnus should work on :
15314 @itemize @bullet
15316 @item
15317 Emacs 19.32 and up.
15319 @item
15320 XEmacs 19.14 and up.
15322 @item
15323 Mule versions based on Emacs 19.32 and up.
15325 @end itemize
15327 Gnus will absolutely not work on any Emacsen older than that.  Not
15328 reliably, at least.
15330 There are some vague differences between Gnus on the various
15331 platforms---XEmacs features more graphics (a logo and a toolbar)---but
15332 other than that, things should look pretty much the same under all
15333 Emacsen.
15336 @node Contributors
15337 @subsection Contributors
15338 @cindex contributors
15340 The new Gnus version couldn't have been done without the help of all the
15341 people on the (ding) mailing list.  Every day for over a year I have
15342 gotten billions of nice bug reports from them, filling me with joy,
15343 every single one of them.  Smooches.  The people on the list have been
15344 tried beyond endurance, what with my ``oh, that's a neat idea <type
15345 type>, yup, I'll release it right away <ship off> no wait, that doesn't
15346 work at all <type type>, yup, I'll ship that one off right away <ship
15347 off> no, wait, that absolutely does not work'' policy for releases.
15348 Micro$oft---bah.  Amateurs.  I'm @emph{much} worse.  (Or is that
15349 ``worser''? ``much worser''?  ``worsest''?)
15351 I would like to take this opportunity to thank the Academy for...  oops,
15352 wrong show.
15354 @itemize @bullet
15356 @item
15357 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
15359 @item
15360 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
15361 well as numerous other things).
15363 @item
15364 Luis Fernandes---design and graphics.
15366 @item
15367 Erik Naggum---help, ideas, support, code and stuff.
15369 @item
15370 Wes Hardaker---@file{gnus-picon.el} and the manual section on
15371 @dfn{picons} (@pxref{Picons}).
15373 @item
15374 Kim-Minh Kaplan---further work on the picon code.
15376 @item
15377 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
15378 (@pxref{GroupLens}).
15380 @item
15381 Sudish Joseph---innumerable bug fixes.
15383 @item
15384 Ilja Weis---@file{gnus-topic.el}.
15386 @item
15387 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
15389 @item
15390 Vladimir Alexiev---the refcard and reference booklets.
15392 @item
15393 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
15394 distribution by Felix Lee and JWZ.
15396 @item
15397 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
15399 @item
15400 Peter Mutsaers---orphan article scoring code.
15402 @item
15403 Ken Raeburn---POP mail support.
15405 @item
15406 Hallvard B Furuseth---various bits and pieces, especially dealing with
15407 .newsrc files.
15409 @item
15410 Brian Edmonds---@file{gnus-bbdb.el}.
15412 @item
15413 David Moore---rewrite of @file{nnvirtual.el} and many other things.
15415 @item
15416 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
15418 @item
15419 François Pinard---many, many interesting and thorough bug reports, as
15420 well as autoconf support.
15422 @end itemize
15424 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
15425 Borges, and Jost Krieger proof-reading parts of the manual.
15427 The following people have contributed many patches and suggestions:
15429 Christopher Davis,
15430 Andrew Eskilsson,
15431 Kai Grossjohann,
15432 David KÃ¥gedal,
15433 Richard Pieri,
15434 Fabrice Popineau,
15435 Daniel Quinlan,
15436 Jason L. Tibbitts, III,
15438 Jack Vinson.
15440 Also thanks to the following for patches and stuff:
15442 Jari Aalto,
15443 Adrian Aichner,
15444 Vladimir Alexiev,
15445 Russ Allbery,
15446 Peter Arius,
15447 Matt Armstrong,
15448 Marc Auslander,
15449 Frank Bennett,
15450 Robert Bihlmeyer,
15451 Chris Bone,
15452 Mark Borges,
15453 Mark Boyns,
15454 Lance A. Brown,
15455 Kees de Bruin,
15456 Martin Buchholz,
15457 Joe Buehler,
15458 Kevin Buhr,
15459 Alastair Burt,
15460 Joao Cachopo,
15461 Zlatko Calusic,
15462 Massimo Campostrini,
15463 Castor,
15464 David Charlap,
15465 Dan Christensen,
15466 Kevin Christian,
15467 Michael R. Cook,
15468 Glenn Coombs,
15469 Frank D. Cringle,
15470 Geoffrey T. Dairiki,
15471 Andre Deparade,
15472 Ulrik Dickow,
15473 Dave Disser,
15474 Rui-Tao Dong, @c ?
15475 Joev Dubach,
15476 Michael Welsh Duggan,
15477 Dave Edmondson,
15478 Paul Eggert,
15479 Enami Tsugutomo, @c Enami
15480 Michael Ernst,
15481 Luc Van Eycken,
15482 Sam Falkner,
15483 Nelson Jose dos Santos Ferreira,
15484 Sigbjorn Finne,
15485 Decklin Foster,
15486 Gary D. Foster,
15487 Paul Franklin,
15488 Guy Geens,
15489 Arne Georg Gleditsch,
15490 David S. Goldberg,
15491 Michelangelo Grigni,
15492 D. Hall,
15493 Magnus Hammerin,
15494 Kenichi Handa, @c Handa
15495 Raja R. Harinath,
15496 Yoshiki Hayashi, @c ?
15497 P. E. Jareth Hein,
15498 Hisashige Kenji, @c Hisashige
15499 Marc Horowitz,
15500 Gunnar Horrigmo,
15501 Richard Hoskins,
15502 Brad Howes,
15503 François Felix Ingrand,
15504 Ishikawa Ichiro, @c Ishikawa
15505 Lee Iverson,
15506 Iwamuro Motonori, @c Iwamuro
15507 Rajappa Iyer,
15508 Andreas Jaeger,
15509 Randell Jesup,
15510 Fred Johansen,
15511 Gareth Jones,
15512 Simon Josefsson,
15513 Greg Klanderman,
15514 Karl Kleinpaste,
15515 Peter Skov Knudsen,
15516 Shuhei Kobayashi, @c Kobayashi
15517 Koseki Yoshinori, @c Koseki
15518 Thor Kristoffersen,
15519 Jens Lautenbacher,
15520 Martin Larose,
15521 Seokchan Lee, @c Lee
15522 Carsten Leonhardt,
15523 James LewisMoss,
15524 Christian Limpach,
15525 Markus Linnala,
15526 Dave Love,
15527 Mike McEwan,
15528 Tonny Madsen,
15529 Shlomo Mahlab,
15530 Nat Makarevitch,
15531 Istvan Marko,
15532 David Martin,
15533 Jason R. Mastaler,
15534 Gordon Matzigkeit,
15535 Timo Metzemakers,
15536 Richard Mlynarik,
15537 Lantz Moore,
15538 Morioka Tomohiko, @c Morioka
15539 Erik Toubro Nielsen,
15540 Hrvoje Niksic,
15541 Andy Norman,
15542 Fred Oberhauser,
15543 C. R. Oldham,
15544 Alexandre Oliva,
15545 Ken Olstad,
15546 Masaharu Onishi, @c Onishi
15547 Hideki Ono, @c Ono
15548 William Perry,
15549 Stephen Peters,
15550 Jens-Ulrik Holger Petersen,
15551 Ulrich Pfeifer,
15552 Matt Pharr,
15553 John McClary Prevost,
15554 Bill Pringlemeir,
15555 Mike Pullen,
15556 Jim Radford,
15557 Colin Rafferty,
15558 Lasse Rasinen,
15559 Lars Balker Rasmussen,
15560 Joe Reiss,
15561 Renaud Rioboo,
15562 Roland B. Roberts,
15563 Bart Robinson,
15564 Christian von Roques,
15565 Jason Rumney,
15566 Wolfgang Rupprecht,
15567 Jay Sachs,
15568 Dewey M. Sasser,
15569 Loren Schall,
15570 Dan Schmidt,
15571 Ralph Schleicher,
15572 Philippe Schnoebelen,
15573 Andreas Schwab,
15574 Randal L. Schwartz,
15575 Justin Sheehy,
15576 Danny Siu,
15577 Matt Simmons,
15578 Paul D. Smith,
15579 Jeff Sparkes,
15580 Toby Speight,
15581 Michael Sperber,
15582 Darren Stalder,
15583 Richard Stallman,
15584 Greg Stark,
15585 Sam Steingold,
15586 Paul Stodghill,
15587 Kurt Swanson,
15588 Samuel Tardieu,
15589 Teddy,
15590 Chuck Thompson,
15591 Philippe Troin,
15592 James Troup,
15593 Trung Tran-Duc,
15594 Aaron M. Ucko,
15595 Aki Vehtari,
15596 Didier Verna,
15597 Jan Vroonhof,
15598 Stefan Waldherr,
15599 Pete Ware,
15600 Barry A. Warsaw,
15601 Christoph Wedler,
15602 Joe Wells,
15603 Katsumi Yamaoka, @c Yamaoka
15605 Shenghuo Zhu. @c Zhu
15607 For a full overview of what each person has done, the ChangeLogs
15608 included in the Gnus alpha distributions should give ample reading
15609 (550kB and counting).
15611 Apologies to everybody that I've forgotten, of which there are many, I'm
15612 sure.
15614 Gee, that's quite a list of people.  I guess that must mean that there
15615 actually are people who are using Gnus.  Who'd'a thunk it!
15618 @node New Features
15619 @subsection New Features
15620 @cindex new features
15622 @menu
15623 * ding Gnus::          New things in Gnus 5.0/5.1, the first new Gnus.
15624 * September Gnus::     The Thing Formally Known As Gnus 5.3/5.3.
15625 * Red Gnus::           Third time best---Gnus 5.4/5.5.
15626 * Quassia Gnus::       Two times two is four, or Gnus 5.6/5.7.
15627 @end menu
15629 These lists are, of course, just @emph{short} overviews of the
15630 @emph{most} important new features.  No, really.  There are tons more.
15631 Yes, we have feeping creaturism in full effect.
15634 @node ding Gnus
15635 @subsubsection (ding) Gnus
15637 New features in Gnus 5.0/5.1:
15639 @itemize @bullet
15641 @item
15642 The look of all buffers can be changed by setting format-like variables
15643 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
15645 @item
15646 Local spool and several @sc{nntp} servers can be used at once
15647 (@pxref{Select Methods}).
15649 @item
15650 You can combine groups into virtual groups (@pxref{Virtual Groups}).
15652 @item
15653 You can read a number of different mail formats (@pxref{Getting Mail}).
15654 All the mail backends implement a convenient mail expiry scheme
15655 (@pxref{Expiring Mail}).
15657 @item
15658 Gnus can use various strategies for gathering threads that have lost
15659 their roots (thereby gathering loose sub-threads into one thread) or it
15660 can go back and retrieve enough headers to build a complete thread
15661 (@pxref{Customizing Threading}).
15663 @item
15664 Killed groups can be displayed in the group buffer, and you can read
15665 them as well (@pxref{Listing Groups}).
15667 @item
15668 Gnus can do partial group updates---you do not have to retrieve the
15669 entire active file just to check for new articles in a few groups
15670 (@pxref{The Active File}).
15672 @item
15673 Gnus implements a sliding scale of subscribedness to groups
15674 (@pxref{Group Levels}).
15676 @item
15677 You can score articles according to any number of criteria
15678 (@pxref{Scoring}).  You can even get Gnus to find out how to score
15679 articles for you (@pxref{Adaptive Scoring}).
15681 @item
15682 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
15683 manner, so it should be difficult to lose much data on what you have
15684 read if your machine should go down (@pxref{Auto Save}).
15686 @item
15687 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
15688 the @file{.emacs} file.
15690 @item
15691 You can set the process mark on both groups and articles and perform
15692 operations on all the marked items (@pxref{Process/Prefix}).
15694 @item
15695 You can grep through a subset of groups and create a group from the
15696 results (@pxref{Kibozed Groups}).
15698 @item
15699 You can list subsets of groups according to, well, anything
15700 (@pxref{Listing Groups}).
15702 @item
15703 You can browse foreign servers and subscribe to groups from those
15704 servers (@pxref{Browse Foreign Server}).
15706 @item
15707 Gnus can fetch articles, asynchronously, on a second connection to the
15708 server (@pxref{Asynchronous Fetching}).
15710 @item
15711 You can cache articles locally (@pxref{Article Caching}).
15713 @item
15714 The uudecode functions have been expanded and generalized
15715 (@pxref{Decoding Articles}).
15717 @item
15718 You can still post uuencoded articles, which was a little-known feature
15719 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
15721 @item
15722 Fetching parents (and other articles) now actually works without
15723 glitches (@pxref{Finding the Parent}).
15725 @item
15726 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
15728 @item
15729 Digests (and other files) can be used as the basis for groups
15730 (@pxref{Document Groups}).
15732 @item
15733 Articles can be highlighted and customized (@pxref{Customizing
15734 Articles}).
15736 @item
15737 URLs and other external references can be buttonized (@pxref{Article
15738 Buttons}).
15740 @item
15741 You can do lots of strange stuff with the Gnus window & frame
15742 configuration (@pxref{Windows Configuration}).
15744 @item
15745 You can click on buttons instead of using the keyboard
15746 (@pxref{Buttons}).
15748 @end itemize
15751 @node September Gnus
15752 @subsubsection September Gnus
15754 New features in Gnus 5.2/5.3:
15756 @itemize @bullet
15758 @item
15759 A new message composition mode is used.  All old customization variables
15760 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
15761 now obsolete.
15763 @item
15764 Gnus is now able to generate @dfn{sparse} threads---threads where
15765 missing articles are represented by empty nodes (@pxref{Customizing
15766 Threading}).
15768 @lisp
15769 (setq gnus-build-sparse-threads 'some)
15770 @end lisp
15772 @item
15773 Outgoing articles are stored on a special archive server
15774 (@pxref{Archived Messages}).
15776 @item
15777 Partial thread regeneration now happens when articles are
15778 referred.
15780 @item
15781 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
15783 @item
15784 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
15786 @item
15787 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
15789 @lisp
15790 (setq gnus-use-trees t)
15791 @end lisp
15793 @item
15794 An @code{nn}-like pick-and-read minor mode is available for the summary
15795 buffers (@pxref{Pick and Read}).
15797 @lisp
15798 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
15799 @end lisp
15801 @item
15802 In binary groups you can use a special binary minor mode (@pxref{Binary
15803 Groups}).
15805 @item
15806 Groups can be grouped in a folding topic hierarchy (@pxref{Group
15807 Topics}).
15809 @lisp
15810 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
15811 @end lisp
15813 @item
15814 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
15816 @item
15817 Groups can now have a score, and bubbling based on entry frequency
15818 is possible (@pxref{Group Score}).
15820 @lisp
15821 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
15822 @end lisp
15824 @item
15825 Groups can be process-marked, and commands can be performed on
15826 groups of groups (@pxref{Marking Groups}).
15828 @item
15829 Caching is possible in virtual groups.
15831 @item
15832 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
15833 news batches, ClariNet briefs collections, and just about everything
15834 else (@pxref{Document Groups}).
15836 @item
15837 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
15838 (@pxref{SOUP}).
15840 @item
15841 The Gnus cache is much faster.
15843 @item
15844 Groups can be sorted according to many criteria (@pxref{Sorting
15845 Groups}).
15847 @item
15848 New group parameters have been introduced to set list-addresses and
15849 expiry times (@pxref{Group Parameters}).
15851 @item
15852 All formatting specs allow specifying faces to be used
15853 (@pxref{Formatting Fonts}).
15855 @item
15856 There are several more commands for setting/removing/acting on process
15857 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
15859 @item
15860 The summary buffer can be limited to show parts of the available
15861 articles based on a wide range of criteria.  These commands have been
15862 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
15864 @item
15865 Articles can be made persistent with the @kbd{*} command
15866 (@pxref{Persistent Articles}).
15868 @item
15869 All functions for hiding article elements are now toggles.
15871 @item
15872 Article headers can be buttonized (@pxref{Article Washing}).
15874 @lisp
15875 (add-hook 'gnus-article-display-hook
15876           'gnus-article-add-buttons-to-head)
15877 @end lisp
15879 @item
15880 All mail backends support fetching articles by @code{Message-ID}.
15882 @item
15883 Duplicate mail can now be treated properly (@pxref{Duplicates}).
15885 @item
15886 All summary mode commands are available directly from the article
15887 buffer (@pxref{Article Keymap}).
15889 @item
15890 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
15891 Configuration}).
15893 @item
15894 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
15896 @item
15897 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
15899 @lisp
15900 (setq gnus-use-nocem t)
15901 @end lisp
15903 @item
15904 Groups can be made permanently visible (@pxref{Listing Groups}).
15906 @lisp
15907 (setq gnus-permanently-visible-groups "^nnml:")
15908 @end lisp
15910 @item
15911 Many new hooks have been introduced to make customizing easier.
15913 @item
15914 Gnus respects the @code{Mail-Copies-To} header.
15916 @item
15917 Threads can be gathered by looking at the @code{References} header
15918 (@pxref{Customizing Threading}).
15920 @lisp
15921 (setq gnus-summary-thread-gathering-function
15922       'gnus-gather-threads-by-references)
15923 @end lisp
15925 @item
15926 Read articles can be stored in a special backlog buffer to avoid
15927 refetching (@pxref{Article Backlog}).
15929 @lisp
15930 (setq gnus-keep-backlog 50)
15931 @end lisp
15933 @item
15934 A clean copy of the current article is always stored in a separate
15935 buffer to allow easier treatment.
15937 @item
15938 Gnus can suggest where to save articles (@pxref{Saving Articles}).
15940 @item
15941 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
15942 Articles}).
15944 @lisp
15945 (setq gnus-prompt-before-saving t)
15946 @end lisp
15948 @item
15949 @code{gnus-uu} can view decoded files asynchronously while fetching
15950 articles (@pxref{Other Decode Variables}).
15952 @lisp
15953 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
15954 @end lisp
15956 @item
15957 Filling in the article buffer now works properly on cited text
15958 (@pxref{Article Washing}).
15960 @item
15961 Hiding cited text adds buttons to toggle hiding, and how much
15962 cited text to hide is now customizable (@pxref{Article Hiding}).
15964 @lisp
15965 (setq gnus-cited-lines-visible 2)
15966 @end lisp
15968 @item
15969 Boring headers can be hidden (@pxref{Article Hiding}).
15971 @lisp
15972 (add-hook 'gnus-article-display-hook
15973           'gnus-article-hide-boring-headers t)
15974 @end lisp
15976 @item
15977 Default scoring values can now be set from the menu bar.
15979 @item
15980 Further syntax checking of outgoing articles have been added.
15982 @end itemize
15985 @node Red Gnus
15986 @subsubsection Red Gnus
15988 New features in Gnus 5.4/5.5:
15990 @itemize @bullet
15992 @item
15993 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
15995 @item
15996 Article prefetching functionality has been moved up into
15997 Gnus (@pxref{Asynchronous Fetching}).
15999 @item
16000 Scoring can now be performed with logical operators like @code{and},
16001 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
16002 Scoring}).
16004 @item
16005 Article washing status can be displayed in the
16006 article mode line (@pxref{Misc Article}).
16008 @item
16009 @file{gnus.el} has been split into many smaller files.
16011 @item
16012 Suppression of duplicate articles based on Message-ID can be done
16013 (@pxref{Duplicate Suppression}).
16015 @lisp
16016 (setq gnus-suppress-duplicates t)
16017 @end lisp
16019 @item
16020 New variables for specifying what score and adapt files are to be
16021 considered home score and adapt files (@pxref{Home Score File}) have
16022 been added.
16024 @item
16025 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
16026 Server Internals}).
16028 @item
16029 Groups can inherit group parameters from parent topics (@pxref{Topic
16030 Parameters}).
16032 @item
16033 Article editing has been revamped and is now actually usable.
16035 @item
16036 Signatures can be recognized in more intelligent fashions
16037 (@pxref{Article Signature}).
16039 @item
16040 Summary pick mode has been made to look more @code{nn}-like.  Line
16041 numbers are displayed and the @kbd{.} command can be used to pick
16042 articles (@code{Pick and Read}).
16044 @item
16045 Commands for moving the @file{.newsrc.eld} from one server to
16046 another have been added (@pxref{Changing Servers}).
16048 @item
16049 There's a way now to specify that ``uninteresting'' fields be suppressed
16050 when generating lines in buffers (@pxref{Advanced Formatting}).
16052 @item
16053 Several commands in the group buffer can be undone with @kbd{M-C-_}
16054 (@pxref{Undo}).
16056 @item
16057 Scoring can be done on words using the new score type @code{w}
16058 (@pxref{Score File Format}).
16060 @item
16061 Adaptive scoring can be done on a Subject word-by-word basis
16062 (@pxref{Adaptive Scoring}).
16064 @lisp
16065 (setq gnus-use-adaptive-scoring '(word))
16066 @end lisp
16068 @item
16069 Scores can be decayed (@pxref{Score Decays}).
16071 @lisp
16072 (setq gnus-decay-scores t)
16073 @end lisp
16075 @item
16076 Scoring can be performed using a regexp on the Date header.  The Date is
16077 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
16079 @item
16080 A new command has been added to remove all data on articles from
16081 the native server (@pxref{Changing Servers}).
16083 @item
16084 A new command for reading collections of documents
16085 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
16086 (@pxref{Really Various Summary Commands}).
16088 @item
16089 Process mark sets can be pushed and popped (@pxref{Setting Process
16090 Marks}).
16092 @item
16093 A new mail-to-news backend makes it possible to post even when the NNTP
16094 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
16096 @item
16097 A new backend for reading searches from Web search engines
16098 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
16099 (@pxref{Web Searches}).
16101 @item
16102 Groups inside topics can now be sorted using the standard sorting
16103 functions, and each topic can be sorted independently (@pxref{Topic
16104 Sorting}).
16106 @item
16107 Subsets of the groups can be sorted independently (@code{Sorting
16108 Groups}).
16110 @item
16111 Cached articles can be pulled into the groups (@pxref{Summary Generation
16112 Commands}).
16114 @item
16115 Score files are now applied in a more reliable order (@pxref{Score
16116 Variables}).
16118 @item
16119 Reports on where mail messages end up can be generated (@pxref{Splitting
16120 Mail}).
16122 @item
16123 More hooks and functions have been added to remove junk from incoming
16124 mail before saving the mail (@pxref{Washing Mail}).
16126 @item
16127 Emphasized text can be properly fontisized:
16129 @lisp
16130 (add-hook 'gnus-article-display-hook
16131           'gnus-article-emphasize)
16132 @end lisp
16134 @end itemize
16137 @node Quassia Gnus
16138 @subsubsection Quassia Gnus
16140 New features in Gnus 5.6:
16142 @itemize @bullet
16144 @item
16145 New functionality for using Gnus as an offline newsreader has been
16146 added.  A plethora of new commands and modes have been added.  See
16147 @pxref{Gnus Unplugged} for the full story.
16149 @item
16150  The @code{nndraft} backend has returned, but works differently than
16151 before.  All Message buffers are now also articles in the @code{nndraft}
16152 group, which is created automatically.
16154 @item
16155 @code{gnus-alter-header-function} can now be used to alter header
16156 values.
16158 @item
16159  @code{gnus-summary-goto-article} now accept Message-ID's.
16161 @item
16162  A new Message command for deleting text in the body of a message
16163 outside the region: @kbd{C-c C-v}.
16165 @item
16166  You can now post to component group in @code{nnvirtual} groups with
16167 @kbd{C-u C-c C-c}.
16169 @item
16170  @code{nntp-rlogin-program}---new variable to ease customization.
16172 @item
16173  @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
16174 re-highlighting of the article buffer.
16176 @item
16177  New element in @code{gnus-boring-article-headers}---@code{long-to}.
16179 @item
16180  @kbd{M-i} symbolic prefix command.  See the section "Symbolic
16181 Prefixes" in the Gnus manual for details.
16183 @item
16184  @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
16185 @kbd{a} to add the score rule to the "all.SCORE" file.
16187 @item
16188  @code{gnus-simplify-subject-functions} variable to allow greater
16189 control over simplification.
16191 @item
16192  @kbd{A T}---new command for fetching the current thread.
16194 @item
16195  @kbd{/ T}---new command for including the current thread in the
16196 limit.
16198 @item
16199  @kbd{M-RET} is a new Message command for breaking cited text.
16201 @item
16202  @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
16204 @item
16205  The @code{custom-face-lookup} function has been removed.
16206 If you used this function in your initialization files, you must
16207 rewrite them to use @code{face-spec-set} instead.
16209 @item
16210  Canceling now uses the current select method.  Symbolic prefix
16211 @kbd{a} forces normal posting method.
16213 @item
16214  New command to translate M******** sm*rtq**t*s into proper
16215 text---@kbd{W d}.
16217 @item
16218  For easier debugging of @code{nntp}, you can set
16219 @code{nntp-record-commands} to a non-@code{nil} value.
16221 @item
16222  @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
16223 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
16225 @item
16226  A command for editing group parameters from the summary buffer
16227 has been added.
16229 @item
16230  A history of where mails have been split is available.
16232 @item
16233  A new article date command has been added---@code{article-date-iso8601}.
16235 @item
16236  Subjects can be simplified when threading by setting
16237 @code{gnus-score-thread-simplify}.
16239 @item
16240  A new function for citing in Message has been
16241 added---@code{message-cite-original-without-signature}.
16243 @item
16244  @code{article-strip-all-blank-lines}---new article command.
16246 @item
16247  A new Message command to kill to the end of the article has
16248 been added.
16250 @item
16251  A minimum adaptive score can be specified by using the
16252 @code{gnus-adaptive-word-minimum} variable.
16254 @item
16255  The "lapsed date" article header can be kept continually
16256 updated by the @code{gnus-start-date-timer} command.
16258 @item
16259  Web listserv archives can be read with the @code{nnlistserv} backend.
16261 @item
16262  Old dejanews archives can now be read by @code{nnweb}.
16264 @end itemize
16267 @node Newest Features
16268 @subsection Newest Features
16269 @cindex todo
16271 Also known as the @dfn{todo list}.  Sure to be implemented before the
16272 next millennium.
16274 Be afraid.  Be very afraid.
16276 (That a feature appears in this list doesn't necessarily mean that I've
16277 decided to actually implement it.  It just means that I think it sounds
16278 interesting.)
16280 (Yes, this is the actual, up-to-the-second todo list.)
16282 @itemize @bullet
16284 @item
16285 Native @sc{mime} support is something that should be done.
16287 @item
16288 Really do unbinhexing.
16290 @item
16291  I would like the zombie-page to contain an URL to the source of the
16292 latest version of gnus or some explanation on where to find it.
16294 @item
16295  A way to continue editing the latest Message composition.
16297 @item
16298  http://www.sonicnet.com/feature/ari3/
16300 @item
16301  facep is not declared.
16303 @item
16304  Include a section in the manual on why the number of articles
16305 isn't the same in the group buffer and on the SPC prompt.
16307 @item
16308  Interacting with rmail fcc isn't easy.
16310 @item
16311 @example
16312  Hypermail:
16313 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
16314 <URL:http://www.eit.com/software/hypermail/hypermail.html>
16315 <URL:http://homer.ncm.com/>
16316 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
16317 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
16318 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
16319 http://www.miranova.com/gnus-list/
16321 @end example
16323 @item
16324 @samp{^-- } is made into - in LaTeX.
16326 @item
16327  gnus-kill is much slower than it was in GNUS 4.1.3.
16329 @item
16330  when expunging articles on low score, the sparse nodes keep hanging on?
16331 @item
16332  starting the first time seems to hang Gnus on some systems.  Does
16333 NEWGROUPS answer too fast?
16334 @item
16335  nndir doesn't read gzipped files.
16336 @item
16337  FAQ doesn't have an up node?
16338 @item
16339  when moving mail from a procmail spool to the crash-box,
16340 the crash-box is only appropriate to one specific group.
16341 @item
16342  `t' `t' makes X-Faces disappear.
16343 @item
16344  nnmh-be-safe means that crossposted articles will
16345 be marked as unread.
16346 @item
16347  Orphan score entries don't show on "V t" score trace
16348 @item
16349  when clearing out data, the cache data should also be reset.
16350 @item
16351  rewrite gnus-summary-limit-children to be non-recursive
16352 to avoid exceeding lisp nesting on huge groups.
16353 @item
16354  expunged articles are counted when computing scores.
16355 @item
16356  implement gnus-batch-brew-soup
16357 @item
16358  ticked articles aren't easy to read in pick mode -- `n' and
16359 stuff just skips past them.  Read articles are the same.
16360 @item
16361  topics that contain just groups with ticked
16362 articles aren't displayed.
16363 @item
16364  nndoc should always allocate unique Message-IDs.
16365 @item
16366  If there are mail groups the first time you use Gnus, Gnus'll
16367 make the mail groups killed.
16368 @item
16369  no "no news is good news" when using topics.
16370 @item
16371  when doing crosspost marking, the cache has to be consulted
16372 and articles have to be removed.
16373 @item
16374  nnweb should fetch complete articles when they are split into several
16375 parts.
16376 @item
16377  scoring on head immediate doesn't work.
16378 @item
16379  finding short score file names takes forever.
16380 @item
16381  canceling articles in foreign groups.
16382 @item
16383  nntp-open-rlogin no longer works.
16384 @item
16385  C-u C-x C-s (Summary) switches to the group buffer.
16386 @item
16387  move nnmail-split-history out to the backends.
16388 @item
16389  nnweb doesn't work properly.
16390 @item
16391  using a virtual server name as `gnus-select-method' doesn't work?
16392 @item
16393  when killing/yanking a group from one topic to another in a slave, the
16394 master will yank it first to one topic and then add it to another.
16395 Perhaps.
16397 @item
16398  warn user about `=' redirection of a group in the active file?
16399 @item
16400  really unbinhex binhex files.
16401 @item
16402  take over the XEmacs menubar and offer a toggle between the XEmacs
16403 bar and the Gnus bar.
16404 @item
16405 @example
16406  push active file and NOV file parsing down into C code.
16407 `(canonize-message-id id)'
16408 `(mail-parent-message-id references n)'
16409 `(parse-news-nov-line &optional dependency-hashtb)'
16410 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
16411 `(parse-news-active-region beg end hashtb)'
16413 @end example
16415 @item
16416  nnml .overview directory with splits.
16417 @item
16418  asynchronous cache
16419 @item
16420  postponed commands.
16421 @item
16422  the selected article show have its Subject displayed in its summary line.
16423 @item
16424  when entering groups, get the real number of unread articles from
16425 the server?
16426 @item
16427  sort after gathering threads -- make false roots have the
16428 headers of the oldest orphan with a 0 article number?
16429 @item
16430  nndoc groups should inherit the score files of their parents?  Also
16431 inherit copy prompts and save files.
16432 @item
16433  command to start up Gnus (if not running) and enter a mail mode buffer.
16434 @item
16435  allow editing the group description from the group buffer
16436 for backends that support that.
16437 @item
16438 gnus-hide,show-all-topics
16439 @item
16440  groups and sub-topics should be allowed to mingle inside each topic,
16441 and not just list all subtopics at the end.
16442 @item
16443  a command to remove all read articles that are not needed to connect
16444 threads -- `gnus-summary-limit-to-sparse-unread'?
16445 @item
16446  a variable to turn off limiting/cutting of threads in the tree buffer.
16447 @item
16448  a variable to limit how many files are uudecoded.
16449 @item
16450  add zombie groups to a special "New Groups" topic.
16451 @item
16452  server mode command: close/open all connections
16453 @item
16454  put a file date in gnus-score-alist and check whether the file
16455 has been changed before using it.
16456 @item
16457  on exit from a digest group, go to the next article in the parent group.
16458 @item
16459  hide (sub)threads with low score.
16460 @item
16461  when expiring, remove all marks from expired articles.
16462 @item
16463  gnus-summary-limit-to-body
16464 @item
16465  a regexp alist that says what level groups are to be subscribed
16466 on.  Eg. -- `(("nnml:" . 1))'.
16467 @item
16468  easier interface to nnkiboze to create ephemeral groups that
16469 contain groups that match a regexp.
16470 @item
16471  allow newlines in <URL:> urls, but remove them before using
16472 the URL.
16473 @item
16474  If there is no From line, the mail backends should fudge one from the
16475 "From " line.
16476 @item
16477  fuzzy simplifying should strip all non-alpha-numerical info
16478 from subject lines.
16479 @item
16480  gnus-soup-brew-soup-with-high-scores.
16481 @item
16482  nntp-ping-before-connect
16483 @item
16484  command to check whether NOV is evil.  "list overview.fmt".
16485 @item
16486  when entering a group, Gnus should look through the score
16487 files very early for `local' atoms and set those local variables.
16488 @item
16489  message annotations.
16490 @item
16491  topics are always yanked before groups, and that's not good.
16492 @item
16493  (set-extent-property extent 'help-echo "String to display in minibuf")
16494 to display help in the minibuffer on buttons under XEmacs.
16495 @item
16496  allow group line format spec to say how many articles there
16497 are in the cache.
16498 @item
16499  AUTHINFO GENERIC
16500 @item
16501  support qmail maildir spools
16502 @item
16503  `run-with-idle-timer' in gnus-demon.
16504 @item
16505  stop using invisible text properties and start using overlays instead
16506 @item
16507  C-c C-f C-e to add an Expires header.
16508 @item
16509  go from one group to the next; everything is expunged; go to the
16510 next group instead of going to the group buffer.
16511 @item
16512  gnus-renumber-cache -- to renumber the cache using "low" numbers.
16513 @item
16514  record topic changes in the dribble buffer.
16515 @item
16516  `nnfolder-generate-active-file' should look at the folders it
16517 finds and generate proper active ranges.
16518 @item
16519  nneething-look-in-files-for-article-heads variable to control
16520 whether nneething should sniff all files in the directories.
16521 @item
16522  gnus-fetch-article -- start Gnus, enter group, display article
16523 @item
16524  gnus-dont-move-articles-to-same-group variable when respooling.
16525 @item
16526  when messages are crossposted between several auto-expirable groups,
16527 articles aren't properly marked as expirable.
16528 @item
16529  nneething should allow deletion/moving.
16530 @item
16531  TAB on the last button should go to the first button.
16532 @item
16533  if the car of an element in `mail-split-methods' is a function,
16534 and the function returns non-nil, use that as the name of the group(s) to
16535 save mail in.
16536 @item
16537  command for listing all score files that have been applied.
16538 @item
16539  a command in the article buffer to return to `summary' config.
16540 @item
16541  `gnus-always-post-using-current-server' -- variable to override
16542 `C-c C-c' when posting.
16543 @item
16544  nnmail-group-spool-alist -- says where each group should use
16545 as a spool file.
16546 @item
16547  when an article is crossposted to an auto-expirable group, the article
16548 should be marker as expirable.
16549 @item
16550  article mode command/menu for "send region as URL to browser".
16551 @item
16552  on errors, jump to info nodes that explain the error.  For instance,
16553 on invalid From headers, or on error messages from the nntp server.
16554 @item
16555  when gathering threads, make the article that has no "Re: " the parent.
16556 Also consult Date headers.
16557 @item
16558  a token in splits to call shrink-window-if-larger-than-buffer
16559 @item
16560  `1 0 A M' to do matches on the active hashtb.
16561 @item
16562  duplicates -- command to remove Gnus-Warning header, use the read
16563 Message-ID, delete the "original".
16564 @item
16565  when replying to several messages at once, put the "other" message-ids
16566 into a See-Also header.
16567 @item
16568  support setext: URL:http://www.bsdi.com/setext/
16569 @item
16570  support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
16571 @item
16572  when browsing a foreign server, the groups that are already subscribed
16573 should be listed as such and not as "K".
16574 @item
16575  generate font names dynamically.
16576 @item
16577  score file mode auto-alist.
16578 @item
16579  allow nndoc to change/add/delete things from documents.  Implement
16580 methods for each format for adding an article to the document.
16581 @item
16582  `gnus-fetch-old-headers' `all' value to incorporate
16583 absolutely all headers there is.
16584 @item
16585  function like `|', but concatenate all marked articles
16586 and pipe them to the process.
16587 @item
16588  cache the list of killed (or active) groups in a separate file.  Update
16589 the file whenever we read the active file or the list
16590 of killed groups in the .eld file reaches a certain length.
16591 @item
16592  function for starting to edit a file to put into
16593 the current mail group.
16594 @item
16595  score-find-trace should display the total score of the article.
16596 @item
16597  "ghettozie" -- score on Xref header and nix it out after using it
16598 to avoid marking as read in other groups it has been crossposted to.
16599 @item
16600  look at procmail splitting.  The backends should create
16601 the groups automatically if a spool file exists for that group.
16602 @item
16603  function for backends to register themselves with Gnus.
16604 @item
16605  when replying to several process-marked articles,
16606 have all the From end up in Cc headers?  Variable to toggle.
16607 @item
16608  command to delete a crossposted mail article from all
16609 groups it has been mailed to.
16610 @item
16611  `B c' and `B m' should be crosspost aware.
16612 @item
16613  hide-pgp should also hide PGP public key blocks.
16614 @item
16615  Command in the group buffer to respool process-marked groups.
16616 @item
16617  `gnus-summary-find-matching' should accept
16618 pseudo-"headers" like "body", "head" and "all"
16619 @item
16620  When buttifying <URL: > things, all white space (including
16621 newlines) should be ignored.
16622 @item
16623  Process-marking all groups in a topic should process-mark
16624 groups in subtopics as well.
16625 @item
16626  Add non-native groups to the list of killed groups when killing them.
16627 @item
16628  nntp-suggest-kewl-config to probe the nntp server and suggest
16629 variable settings.
16630 @item
16631  add edit and forward secondary marks.
16632 @item
16633  nnml shouldn't visit its .overview files.
16634 @item
16635  allow customizing sorting within gathered threads.
16636 @item
16637  `B q' shouldn't select the current article.
16638 @item
16639  nnmbox should support a newsgroups file for descriptions.
16640 @item
16641  allow fetching mail from several pop servers.
16642 @item
16643  Be able to specify whether the saving commands save the original
16644 or the formatted article.
16645 @item
16646  a command to reparent with the child process-marked (cf. `T ^'.).
16647 @item
16648  I think the possibility to send a password with nntp-open-rlogin
16649 should be a feature in Red Gnus.
16650 @item
16651  The `Z n' command should be possible to execute from a mouse click.
16652 @item
16653  more limiting functions -- date, etc.
16654 @item
16655  be able to limit on a random header; on body; using reverse matches.
16656 @item
16657  a group parameter (`absofucking-total-expiry') that will make Gnus expire
16658 even unread articles.
16659 @item
16660  a command to print the article buffer as postscript.
16661 @item
16662  variable to disable password fetching when opening by nntp-open-telnet.
16663 @item
16664  manual: more example servers -- nntp with rlogin, telnet
16665 @item
16666  checking for bogus groups should clean topic alists as well.
16667 @item
16668  canceling articles in foreign groups.
16669 @item
16670  article number in folded topics isn't properly updated by
16671 Xref handling.
16672 @item
16673  Movement in the group buffer to the next unread group should go to the
16674 next closed topic with unread messages if no group can be found.
16675 @item
16676  Extensive info pages generated on the fly with help everywhere --
16677 in the "*Gnus edit*" buffers, for instance.
16678 @item
16679  Topic movement commands -- like thread movement.  Up, down, forward, next.
16680 @item
16681  a way to tick/mark as read Gcc'd articles.
16682 @item
16683  a way to say that all groups within a specific topic comes
16684 from a particular server?  Hm.
16685 @item
16686  `gnus-article-fill-if-long-lines' -- a function to fill
16687 the article buffer if there are any looong lines there.
16688 @item
16689  `T h' should jump to the parent topic and fold it.
16690 @item
16691  a command to create an ephemeral nndoc group out of a file,
16692 and then splitting it/moving it to some other group/backend.
16693 @item
16694  a group parameter for nnkiboze groups that says that
16695 all kibozed articles should be entered into the cache.
16696 @item
16697  It should also probably be possible to delimit what
16698 `gnus-jog-cache' does -- for instance, work on just some groups, or on
16699 some levels, and entering just articles that have a score higher than
16700 a certain number.
16701 @item
16702  nnfolder should append to the folder instead of re-writing
16703 the entire folder to disk when accepting new messages.
16704 @item
16705  allow all backends to do the proper thing with .gz files.
16706 @item
16707  a backend for reading collections of babyl files nnbabylfolder?
16708 @item
16709  a command for making the native groups into foreign groups.
16710 @item
16711  server mode command for clearing read marks from all groups
16712 from a server.
16713 @item
16714  when following up multiple articles, include all To, Cc, etc headers
16715 from all articles.
16716 @item
16717  a command for deciding what the total score of the current
16718 thread is.  Also a way to highlight based on this.
16719 @item
16720  command to show and edit group scores
16721 @item
16722  a gnus-tree-minimize-horizontal to minimize tree buffers
16723 horizontally.
16724 @item
16725  command to generate nnml overview file for one group.
16726 @item
16727  `C-u C-u a' -- prompt for many crossposted groups.
16728 @item
16729  keep track of which mail groups have received new articles (in this session).
16730 Be able to generate a report and perhaps do some marking in the group
16731 buffer.
16732 @item
16733  gnus-build-sparse-threads to a number -- build only sparse threads
16734 that are of that length.
16735 @item
16736  have nnmh respect mh's unseen sequence in .mh_profile.
16737 @item
16738  cache the newsgroups descriptions locally.
16739 @item
16740  asynchronous posting under nntp.
16741 @item
16742  be able to control word adaptive scoring from the score files.
16743 @item
16744  a variable to make `C-c C-c' post using the "current" select method.
16745 @item
16746  `limit-exclude-low-scored-articles'.
16747 @item
16748  if `gnus-summary-show-thread' is a number, hide threads that have
16749 a score lower than this number.
16750 @item
16751  split newsgroup subscription variable up into "order" and "method".
16752 @item
16753  buttonize ange-ftp file names.
16754 @item
16755  a command to make a duplicate copy of the current article
16756 so that each copy can be edited separately.
16757 @item
16758  nnweb should allow fetching from the local nntp server.
16759 @item
16760  record the sorting done in the summary buffer so that
16761 it can be repeated when limiting/regenerating the buffer.
16762 @item
16763  nnml-generate-nov-databses should generate for
16764 all nnml servers.
16765 @item
16766  when the user does commands in the group buffer, check
16767 the modification time of the .newsrc.eld file and use
16768 ask-user-about-supersession-threat.  Also warn when trying
16769 to save .newsrc.eld and it has changed.
16770 @item
16771  M-g on a topic will display all groups with 0 articles in
16772 the topic.
16773 @item
16774  command to remove all topic stuff.
16775 @item
16776  allow exploding incoming digests when reading incoming mail
16777 and splitting the resulting digests.
16778 @item
16779  nnsoup shouldn't set the `message-' variables.
16780 @item
16781  command to nix out all nnoo state information.
16782 @item
16783  nnmail-process-alist that calls functions if group names
16784 matches an alist -- before saving.
16785 @item
16786  use buffer-invisibility-spec everywhere for hiding text.
16787 @item
16788  variable to activate each group before entering them
16789 to get the (new) number of articles.  `gnus-activate-before-entering'.
16790 @item
16791  command to fetch a Message-ID from any buffer, even
16792 starting Gnus first if necessary.
16793 @item
16794  when posting and checking whether a group exists or not, just
16795 ask the nntp server instead of relying on the active hashtb.
16796 @item
16797  buttonize the output of `C-c C-a' in an apropos-like way.
16798 @item
16799  `G p' should understand process/prefix, and allow editing
16800 of several groups at once.
16801 @item
16802  command to create an ephemeral nnvirtual group that
16803 matches some regexp(s).
16804 @item
16805  nndoc should understand "Content-Type: message/rfc822" forwarded messages.
16806 @item
16807  it should be possible to score "thread" on the From header.
16808 @item
16809  hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
16810 @item
16811  `B i' should display the article at once in the summary buffer.
16812 @item
16813  remove the "*" mark at once when unticking an article.
16814 @item
16815  `M-s' should highlight the matching text.
16816 @item
16817  when checking for duplicated mails, use Resent-Message-ID if present.
16818 @item
16819  killing and yanking groups in topics should be better.  If killing one copy
16820 of a group that exists in multiple topics, only that copy should
16821 be removed.  Yanking should insert the copy, and yanking topics
16822 should be possible to be interspersed with the other yankings.
16823 @item
16824  command for enter a group just to read the cached articles.  A way to say
16825 "ignore the nntp connection; just read from the cache."
16826 @item
16827  `X u' should decode base64 articles.
16828 @item
16829  a way to hide all "inner" cited text, leaving just the most
16830 recently cited text.
16831 @item
16832  nnvirtual should be asynchronous.
16833 @item
16834  after editing an article, gnus-original-article-buffer should
16835 be invalidated.
16836 @item
16837  there should probably be a way to make Gnus not connect to the
16838 server and just read the articles in the server
16839 @item
16840  allow a `set-default' (or something) to change the default
16841 value of nnoo variables.
16842 @item
16843  a command to import group infos from a .newsrc.eld file.
16844 @item
16845  groups from secondary servers have the entire select method
16846 listed in each group info.
16847 @item
16848  a command for just switching from the summary buffer to the group
16849 buffer.
16850 @item
16851  a way to specify that some incoming mail washing functions
16852 should only be applied to some groups.
16853 @item
16854  Message `C-f C-t' should ask the user whether to heed
16855 mail-copies-to: never.
16856 @item
16857  new group parameter -- `post-to-server' that says to post
16858 using the current server.  Also a variable to do the same.
16859 @item
16860  the slave dribble files should autosave to the slave file names.
16861 @item
16862  a group parameter that says what articles to display on group entry, based
16863 on article marks.
16864 @item
16865  a way to visually distinguish slave Gnusae from masters.  (Whip instead
16866 of normal logo?)
16867 @item
16868  Use DJ Bernstein "From " quoting/dequoting, where applicable.
16869 @item
16870  Why is hide-citation-maybe and hide-citation different?  Also
16871 clear up info.
16872 @item
16873  group user-defined meta-parameters.
16877 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
16878 @item
16879  I like the option for trying to retrieve the FAQ for a group and I was
16880 thinking it would be great if for those newsgroups that had archives
16881 you could also try to read the archive for that group.  Part of the
16882 problem is that archives are spread all over the net, unlike FAQs.
16883 What would be best I suppose is to find the one closest to your site.
16885 In any case, there is a list of general news group archives at @*
16886 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
16891 @item
16892 @example
16893 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
16894 (add-hook 'gnus-select-group-hook
16895   (lambda ()
16896     (gnus-group-add-parameter group
16897        (cons 'gnus-group-date-last-entered (list (current-time-string))))))
16899 (defun gnus-user-format-function-d (headers)
16900   "Return the date the group was last read."
16901   (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
16902       (t "")))
16903 @end example
16905 @item
16906  tanken var at nÃ¥r du bruker `gnus-startup-file' som prefix (FOO) til Ã¥ lete
16907 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
16908 liste hvor du bruker hvert element i listen som FOO, istedet.  da kunne man
16909 hatt forskjellige serveres startup-filer forskjellige steder.
16912 @item
16913 LMI> Well, nnbabyl could alter the group info to heed labels like
16914 LMI> answered and read, I guess.
16916 It could also keep them updated (the same for the Status: header of
16917 unix mbox files).
16919 They could be used like this:
16922 @example
16923 `M l <name> RET' add label <name> to current message.
16924 `M u <name> RET' remove label <name> from current message.
16925 `/ l <expr> RET' limit summary buffer according to <expr>.
16927 <expr> would be a boolean expression on the labels, e.g.
16929 `/ l bug & !fixed RET'
16930 @end example
16932 would show all the messages which are labeled `bug' but not labeled
16933 `fixed'.
16935 One could also imagine the labels being used for highlighting, or
16936 affect the summary line format.
16939 @item
16940 Sender: abraham@@dina.kvl.dk
16942 I'd like a gnus-find-file which work like find file, except that it
16943 would recognize things that looks like messages or folders:
16945 - If it is a directory containing numbered files, create an nndir
16946 summary buffer.
16948 - For other directories, create a nneething summary buffer.
16950 - For files matching "\\`From ", create a nndoc/mbox summary.
16952 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
16954 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
16956 - For other files, just find them normally.
16958 I'd like `nneething' to use this function, so it would work on a
16959 directory potentially containing mboxes or babyl files.
16961 @item
16962 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
16963 tell him what you are doing.
16965 @item
16966 Currently, I get prompted:
16968 decend into sci?
16969 - type y
16970 decend into sci.something ?
16971 - type n
16972 decend into ucd?
16974 The problem above is that since there is really only one subsection of
16975 science, shouldn't it prompt you for only descending sci.something?  If
16976 there was a sci.somethingelse group or section, then it should prompt
16977 for sci? first the sci.something? then sci.somethingelse?...
16979 @item
16980 Ja, det burde være en mÃ¥te Ã¥ si slikt.  Kanskje en ny variabel?
16981 `gnus-use-few-score-files'?  SÃ¥ kunne score-regler legges til den
16982 "mest" lokale score-fila.  F. eks. ville no-gruppene betjenes av
16983 "no.all.SCORE", osv.
16985 @item
16986 What i want is for Gnus to treat any sequence or combination of the following
16987 as a single spoiler warning and hide it all, replacing it with a "Next Page"
16988 button:
16991 ^L's
16993 more than n blank lines
16995 more than m identical lines
16996 (which should be replaced with button to show them)
16998 any whitespace surrounding any of the above
17001 @item
17002 Well, we could allow a new value to `gnus-thread-ignore-subject' --
17003 `spaces', or something.  (We could even default to that.)  And then
17004 subjects that differ in white space only could be considered the
17005 "same" subject for threading purposes.
17007 @item
17008 Modes to preprocess the contents (e.g. jka-compr) use the second form
17009 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
17010 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
17011 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
17013 @item
17014  Under XEmacs -- do funny article marks:
17015 tick - thumb tack
17016 killed - skull
17017 soup - bowl of soup
17018 score below - dim light bulb
17019 score over - bright light bulb
17021 @item
17022 Yes. I think the algorithm is as follows:
17024 @example
17025 Group-mode
17027    show-list-of-articles-in-group
17028         if (key-pressed == SPACE)
17029                 if (no-more-articles-in-group-to-select)
17030                         if (articles-selected)
17031                                 start-reading-selected-articles;
17032                         junk-unread-articles;
17033                         next-group;
17034                  else
17035                         show-next-page;
17037          else if (key-pressed = '.')
17038                 if (consolidated-menus)         # same as hide-thread in Gnus
17039                         select-thread-under-cursor;
17040                 else
17041                         select-article-under-cursor;
17044 Article-mode
17045         if (key-pressed == SPACE)
17046                 if (more-pages-in-article)
17047                         next-page;
17048                 else if (more-selected-articles-to-read)
17049                         next-article;
17050                 else
17051                         next-group;
17052 @end example
17054 @item
17055 My precise need here would have been to limit files to Incoming*.
17056 One could think of some `nneething-only-files' variable, but I guess
17057 it would have been unacceptable if one was using many unrelated such
17058 nneething groups.
17060 A more useful approach would be to, in response to the `G D' prompt, be
17061 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
17062 the top-level directory only (in case directories would be matched by
17063 the wildcard expression).
17065 @item
17066 It would be nice if it also handled
17068         <URL:news://sunsite.auc.dk/>
17070 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
17073 @item
17075   Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
17076 really well.  Each menu is 'named' by a symbol that would be on a
17077 gnus-*-menus (where * would be whatever, but at least group, summary, and
17078 article versions) variable.
17080   So for gnus-summary-menus, I would set to '(sort mark dispose ...)
17082   A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
17083 the main menubar.  This approach works really well for Emacs-W3 and VM.
17086 @item
17087  nndoc should take care to create unique Message-IDs for all its
17088 articles.
17089 @item
17090  gnus-score-followup-article only works when you have a summary buffer
17091 active.  Make it work when posting from the group buffer as well.
17092 (message-sent-hook).
17093 @item
17094  rewrite gnus-demon to use run-with-idle-timers.
17096 @item
17097  * Enhancements to Gnus:
17099   Add two commands:
17101   * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
17102     straight to the server buffer, without opening any connections to
17103     servers first.
17105   * gnus-server-read-server-newsrc--produces a buffer very similar to
17106     the group buffer, but with only groups from that server listed;
17107     quitting this buffer returns to the server buffer.
17109 @item
17110  add a command to check the integrity of an nnfolder folder --
17111 go through the article numbers and see that there are no duplicates,
17112 and stuff.
17114 @item
17115  `unsmileyfy-buffer' to undo smileification.
17117 @item
17118  a command to give all relevant info on an article, including all
17119 secondary marks.
17121 @item
17122  when doing `-request-accept-article', the backends should do
17123 the nnmail duplicate checking.
17125 @item
17126  allow `message-signature-file' to be a function to return the
17127 value of the signature file.
17129 @item
17130  In addition, I would love it if I could configure message-tab so that it
17131 could call `bbdb-complete-name' in other headers.  So, some sort of
17132 interface like
17134 (setq message-tab-alist
17135       '((message-header-regexp message-expand-group)
17136         ("^\\(To\\|[cC]c\\|[bB]cc\\)"  bbdb-complete-name)))
17138 then you could run the relevant function to complete the information in
17139 the header
17141 @item
17142  cache the newsgroups file locally to avoid reloading it all the time.
17144 @item
17145  a command to import a buffer into a group.
17147 @item
17148  nnweb should allow fetching by Message-ID from servers.
17150 @item
17151  point in the article buffer doesn't always go to the
17152 beginning of the buffer when selecting new articles.
17154 @item
17155  a command to process mark all unread articles.
17157 @item
17158  `gnus-gather-threads-by-references-and-subject' -- first
17159 do gathering by references, and then go through the dummy roots and
17160 do more gathering by subject.
17162 @item
17163  gnus-uu-mark-in-numerical-order -- process mark articles in
17164 article numerical order.
17166 @item
17167  (gnus-thread-total-score
17168  (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
17169 bind to a key.
17171 @item
17172  sorting by score is wrong when using sparse threads.
17174 @item
17175  a command to fetch an arbitrary article -- without having to be
17176 in the summary buffer.
17178 @item
17179  a new nncvs backend.  Each group would show an article, using
17180 version branches as threading, checkin date as the date, etc.
17182 @item
17183  http://www.dejanews.com/forms/dnsetfilter_exp.html ?
17184 This filter allows one to construct advance queries on the Dejanews
17185 database such as specifying start and end dates, subject, author,
17186 and/or newsgroup name.
17188 @item
17189  new Date header scoring type -- older, newer
17191 @item
17192  use the summary toolbar in the article buffer.
17194 @item
17195  a command to fetch all articles that are less than X days old.
17197 @item
17198  in pick mode, `q' should save the list of selected articles in the
17199 group info.  The next time the group is selected, these articles
17200 will automatically get the process mark.
17202 @item
17203  Isn't it possible to (also?) allow M-^ to automatically try the
17204 default server if it fails on the current server?  (controlled by a
17205 user variable, (nil, t, 'ask)).
17207 @item
17208  make it possible to cancel articles using the select method for the
17209 current group.
17211 @item
17212  `gnus-summary-select-article-on-entry' or something.  It'll default
17213 to t and will select whatever article decided by `gnus-auto-select-first'.
17215 @item
17216  a new variable to control which selection commands should be unselecting.
17217 `first', `best', `next', `prev', `next-unread', `prev-unread' are
17218 candidates.
17220 @item
17221  be able to select groups that have no articles in them
17222 to be able to post in them (using the current select method).
17224 @item
17225  be able to post via DejaNews.
17227 @item
17228  `x' should retain any sortings that have been performed.
17230 @item
17231  allow the user to specify the precedence of the secondary marks.  Also
17232 allow them to be displayed separately.
17234 @item
17235  gnus-summary-save-in-pipe should concatenate the results from
17236 the processes when doing a process marked pipe.
17238 @item
17239  a new match type, like Followup, but which adds Thread matches on all
17240 articles that match a certain From header.
17242 @item
17243  a function that can be read from kill-emacs-query-functions to offer
17244 saving living summary buffers.
17246 @item
17247  a function for selecting a particular group which will contain
17248 the articles listed in a list of article numbers/id's.
17250 @item
17251  a battery of character translation functions to translate common
17252 Mac, MS (etc) characters into ISO 8859-1.
17254 @example
17255 (defun article-fix-m$word ()
17256   "Fix M$Word smartquotes in an article."
17257   (interactive)
17258   (save-excursion
17259     (let ((buffer-read-only nil))
17260       (goto-char (point-min))
17261       (while (search-forward "\221" nil t)
17262         (replace-match "`" t t))
17263       (goto-char (point-min))
17264       (while (search-forward "\222" nil t)
17265         (replace-match "'" t t))
17266       (goto-char (point-min))
17267       (while (search-forward "\223" nil t)
17268         (replace-match "\"" t t))
17269       (goto-char (point-min))
17270       (while (search-forward "\224" nil t)
17271         (replace-match "\"" t t)))))
17272 @end example
17274 @item
17275 @example
17276  (add-hook 'gnus-exit-query-functions
17277 '(lambda ()
17278    (if (and (file-exists-p nnmail-spool-file)
17279             (> (nnheader-file-size nnmail-spool-file) 0))
17280        (yes-or-no-p "New mail has arrived.  Quit Gnus anyways? ")
17281        (y-or-n-p "Are you sure you want to quit Gnus? "))))
17282 @end example
17284 @item
17285  allow message-default-headers to be a function.
17287 @item
17288  new Date score match types -- < > = (etc) that take floating point
17289 numbers and match on the age of the article.
17291 @item
17292 @example
17293 >  > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
17294 >  > > under xemacs-19.14, it's creating a new frame, but is erasing the
17295 >  > > buffer in the frame that it was called from =:-O
17297 >  > Hm.  How do you start up Gnus?  From the toolbar or with
17298 >  > `M-x gnus-other-frame'?
17300 >    I normally start it up from the toolbar; at
17301 > least that's the way I've caught it doing the
17302 > deed before.
17303 @end example
17305 @item
17306  all commands that react to the process mark should push
17307 the current process mark set onto the stack.
17309 @item
17310  gnus-article-hide-pgp
17311 Selv ville jeg nok ha valgt Ã¥ slette den dersom teksten matcher
17312 @example
17313 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
17314 @end example
17315 og det er maks hundre tegn mellom match-end og ----linja.  Men -det-
17316 er min type heuristikk og langt fra alles.
17318 @item
17319  `gnus-subscribe-sorted' -- insert new groups where they would have been
17320 sorted to if `gnus-group-sort-function' were run.
17322 @item
17323  gnus-(group,summary)-highlight should respect any `face' text props set
17324 on the lines.
17326 @item
17327  use run-with-idle-timer for gnus-demon instead of the
17328 home-brewed stuff for better reliability.
17330 @item
17331  add a way to select which NoCeM type to apply -- spam, troll, etc.
17333 @item
17334  nndraft-request-group should tally autosave files.
17336 @item
17337  implement nntp-retry-on-break and nntp-command-timeout.
17339 @item
17340  gnus-article-highlight-limit that says when not to highlight (long)
17341 articles.
17343 @item
17344  (nnoo-set SERVER VARIABLE VALUE)
17346 @item
17347  nn*-spool-methods
17349 @item
17350  interrupitng agent fetching of articles should save articles.
17352 @item
17353  command to open a digest group, and copy all the articles there to the
17354 current group.
17356 @item
17357  a variable to disable article body highlights if there's more than
17358 X characters in the body.
17360 @item
17361  handle 480/381 authinfo requests separately.
17363 @item
17364  include the texi/dir file in the distribution.
17366 @item
17367  format spec to "tab" to a position.
17369 @item
17370  Move all prompting to the new `M-n' default style.
17372 @item
17373  command to display all dormant articles.
17375 @item
17376  gnus-auto-select-next makeover -- list of things it should do.
17378 @item
17379  a score match type that adds scores matching on From if From has replied
17380 to something someone else has said.
17382 @item
17383  Read Netscape discussion groups:
17384 snews://secnews.netscape.com/netscape.communicator.unix
17386 @item
17387 One command to edit the original version if an article, and one to edit
17388 the displayed version.
17390 @item
17391 @kbd{T v} -- make all process-marked articles the children of the
17392 current article.
17394 @item
17395 Switch from initial text to the new default text mechanism.
17397 @item
17398 How about making it possible to expire local articles?  Will it be
17399 possible to make various constraints on when an article can be
17400 expired, e.g. (read), (age > 14 days), or the more interesting (read
17401 & age > 14 days)?
17403 @item
17404 New limit command---limit to articles that have a certain string
17405 in the head or body.
17407 @item
17408 Allow breaking lengthy NNTP commands.
17410 @item
17411 gnus-article-highlight-limit, to disable highlighting in big articles.
17413 @item
17414 Editing an article should put the article to be edited
17415 in a special, unique buffer.
17417 @item
17418 A command to send a mail to the admin-address group param.
17420 @item
17421 A Date scoring type that will match if the article
17422 is less than a certain number of days old.
17424 @item
17425 New spec: %~(tab 56) to put point on column 56
17427 @item
17428 Allow Gnus Agent scoring to use normal score files.
17430 @item
17431 Rething the Agent active file thing.  `M-g' doesn't update the active
17432 file, for instance.
17434 @item
17435 With dummy roots, `^' and then selecing the first article
17436 in any other dummy thread will make Gnus highlight the
17437 dummy root instead of the first article.
17439 @item
17440 Propagate all group properties (marks, article numbers, etc) up to the
17441 topics for displaying.
17443 @item
17444 `n' in the group buffer with topics should go to the next group
17445 with unread articles, even if that group is hidden in a topic.
17447 @item
17448 gnus-posting-styles doesn't work in drafts.
17450 @item
17451 gnus-summary-limit-include-cached is slow when there are
17452 many articles in the cache, since it regenerates big parts of the
17453 summary buffer for each article.
17455 @item
17456 Implement gnus-batch-brew-soup.
17458 @item
17459 Group parameters and summary commands for un/subscribing to mailing
17460 lists. 
17462 @item
17463 Introduce nnmail-home-directory.
17465 @item
17466 gnus-fetch-group and friends should exit Gnus when the user
17467 exits the group.
17469 @item
17470 Solve the halting problem.
17472 @c TODO
17473 @end itemize
17475 @iftex
17477 @page
17478 @node The Manual
17479 @section The Manual
17480 @cindex colophon
17481 @cindex manual
17483 This manual was generated from a TeXinfo file and then run through
17484 either @code{texi2dvi}
17485 to get what you hold in your hands now.
17487 The following conventions have been used:
17489 @enumerate
17491 @item
17492 This is a @samp{string}
17494 @item
17495 This is a @kbd{keystroke}
17497 @item
17498 This is a @file{file}
17500 @item
17501 This is a @code{symbol}
17503 @end enumerate
17505 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
17506 mean:
17508 @lisp
17509 (setq flargnoze "yes")
17510 @end lisp
17512 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
17514 @lisp
17515 (setq flumphel 'yes)
17516 @end lisp
17518 @samp{yes} and @code{yes} are two @emph{very} different things---don't
17519 ever get them confused.
17522 @end iftex
17525 @page
17526 @node Terminology
17527 @section Terminology
17529 @cindex terminology
17530 @table @dfn
17532 @item news
17533 @cindex news
17534 This is what you are supposed to use this thing for---reading news.
17535 News is generally fetched from a nearby @sc{nntp} server, and is
17536 generally publicly available to everybody.  If you post news, the entire
17537 world is likely to read just what you have written, and they'll all
17538 snigger mischievously.  Behind your back.
17540 @item mail
17541 @cindex mail
17542 Everything that's delivered to you personally is mail.  Some news/mail
17543 readers (like Gnus) blur the distinction between mail and news, but
17544 there is a difference.  Mail is private.  News is public.  Mailing is
17545 not posting, and replying is not following up.
17547 @item reply
17548 @cindex reply
17549 Send a mail to the person who has written what you are reading.
17551 @item follow up
17552 @cindex follow up
17553 Post an article to the current newsgroup responding to the article you
17554 are reading.
17556 @item backend
17557 @cindex backend
17558 Gnus gets fed articles from a number of backends, both news and mail
17559 backends.  Gnus does not handle the underlying media, so to speak---this
17560 is all done by the backends.
17562 @item native
17563 @cindex native
17564 Gnus will always use one method (and backend) as the @dfn{native}, or
17565 default, way of getting news.
17567 @item foreign
17568 @cindex foreign
17569 You can also have any number of foreign groups active at the same time.
17570 These are groups that use non-native non-secondary backends for getting
17571 news.
17573 @item secondary
17574 @cindex secondary
17575 Secondary backends are somewhere half-way between being native and being
17576 foreign, but they mostly act like they are native.
17578 @item article
17579 @cindex article
17580 A message that has been posted as news.
17582 @item mail message
17583 @cindex mail message
17584 A message that has been mailed.
17586 @item message
17587 @cindex message
17588 A mail message or news article
17590 @item head
17591 @cindex head
17592 The top part of a message, where administrative information (etc.) is
17593 put.
17595 @item body
17596 @cindex body
17597 The rest of an article.  Everything not in the head is in the
17598 body.
17600 @item header
17601 @cindex header
17602 A line from the head of an article.
17604 @item headers
17605 @cindex headers
17606 A collection of such lines, or a collection of heads.  Or even a
17607 collection of @sc{nov} lines.
17609 @item @sc{nov}
17610 @cindex nov
17611 When Gnus enters a group, it asks the backend for the headers of all
17612 unread articles in the group.  Most servers support the News OverView
17613 format, which is more compact and much faster to read and parse than the
17614 normal @sc{head} format.
17616 @item level
17617 @cindex levels
17618 Each group is subscribed at some @dfn{level} or other (1-9).  The ones
17619 that have a lower level are ``more'' subscribed than the groups with a
17620 higher level.  In fact, groups on levels 1-5 are considered
17621 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
17622 are @dfn{killed}.  Commands for listing groups and scanning for new
17623 articles will all use the numeric prefix as @dfn{working level}.
17625 @item killed groups
17626 @cindex killed groups
17627 No information on killed groups is stored or updated, which makes killed
17628 groups much easier to handle than subscribed groups.
17630 @item zombie groups
17631 @cindex zombie groups
17632 Just like killed groups, only slightly less dead.
17634 @item active file
17635 @cindex active file
17636 The news server has to keep track of what articles it carries, and what
17637 groups exist.  All this information in stored in the active file, which
17638 is rather large, as you might surmise.
17640 @item bogus groups
17641 @cindex bogus groups
17642 A group that exists in the @file{.newsrc} file, but isn't known to the
17643 server (i.e.,  it isn't in the active file), is a @emph{bogus group}.
17644 This means that the group probably doesn't exist (any more).
17646 @item activating
17647 @cindex activating groups
17648 The act of asking the server for info on a group and computing the
17649 number of unread articles is called @dfn{activating the group}.
17650 Un-activated groups are listed with @samp{*} in the group buffer.
17652 @item server
17653 @cindex server
17654 A machine one can connect to and get news (or mail) from.
17656 @item select method
17657 @cindex select method
17658 A structure that specifies the backend, the server and the virtual
17659 server settings.
17661 @item virtual server
17662 @cindex virtual server
17663 A named select method.  Since a select method defines all there is to
17664 know about connecting to a (physical) server, taking the thing as a
17665 whole is a virtual server.
17667 @item washing
17668 @cindex washing
17669 Taking a buffer and running it through a filter of some sort.  The
17670 result will (more often than not) be cleaner and more pleasing than the
17671 original.
17673 @item ephemeral groups
17674 @cindex ephemeral groups
17675 Most groups store data on what articles you have read.  @dfn{Ephemeral}
17676 groups are groups that will have no data stored---when you exit the
17677 group, it'll disappear into the aether.
17679 @item solid groups
17680 @cindex solid groups
17681 This is the opposite of ephemeral groups.  All groups listed in the
17682 group buffer are solid groups.
17684 @item sparse articles
17685 @cindex sparse articles
17686 These are article placeholders shown in the summary buffer when
17687 @code{gnus-build-sparse-threads} has been switched on.
17689 @item threading
17690 @cindex threading
17691 To put responses to articles directly after the articles they respond
17692 to---in a hierarchical fashion.
17694 @item root
17695 @cindex root
17696 @cindex thread root
17697 The first article in a thread is the root.  It is the ancestor of all
17698 articles in the thread.
17700 @item parent
17701 @cindex parent
17702 An article that has responses.
17704 @item child
17705 @cindex child
17706 An article that responds to a different article---its parent.
17708 @item digest
17709 @cindex digest
17710 A collection of messages in one file.  The most common digest format is
17711 specified by RFC1153.
17713 @end table
17716 @page
17717 @node Customization
17718 @section Customization
17719 @cindex general customization
17721 All variables are properly documented elsewhere in this manual.  This
17722 section is designed to give general pointers on how to customize Gnus
17723 for some quite common situations.
17725 @menu
17726 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
17727 * Slow Terminal Connection::  You run a remote Emacs.
17728 * Little Disk Space::         You feel that having large setup files is icky.
17729 * Slow Machine::              You feel like buying a faster machine.
17730 @end menu
17733 @node Slow/Expensive Connection
17734 @subsection Slow/Expensive @sc{nntp} Connection
17736 If you run Emacs on a machine locally, and get your news from a machine
17737 over some very thin strings, you want to cut down on the amount of data
17738 Gnus has to get from the @sc{nntp} server.
17740 @table @code
17742 @item gnus-read-active-file
17743 Set this to @code{nil}, which will inhibit Gnus from requesting the
17744 entire active file from the server.  This file is often v.  large.  You
17745 also have to set @code{gnus-check-new-newsgroups} and
17746 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
17747 doesn't suddenly decide to fetch the active file anyway.
17749 @item gnus-nov-is-evil
17750 This one has to be @code{nil}.  If not, grabbing article headers from
17751 the @sc{nntp} server will not be very fast.  Not all @sc{nntp} servers
17752 support @sc{xover}; Gnus will detect this by itself.
17753 @end table
17756 @node Slow Terminal Connection
17757 @subsection Slow Terminal Connection
17759 Let's say you use your home computer for dialing up the system that runs
17760 Emacs and Gnus.  If your modem is slow, you want to reduce (as much as
17761 possible) the amount of data sent over the wires.
17763 @table @code
17765 @item gnus-auto-center-summary
17766 Set this to @code{nil} to inhibit Gnus from re-centering the summary
17767 buffer all the time.  If it is @code{vertical}, do only vertical
17768 re-centering.  If it is neither @code{nil} nor @code{vertical}, do both
17769 horizontal and vertical recentering.
17771 @item gnus-visible-headers
17772 Cut down on the headers included in the articles to the
17773 minimum.  You can, in fact, make do without them altogether---most of the
17774 useful data is in the summary buffer, anyway.  Set this variable to
17775 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
17777 @item gnus-article-display-hook
17778 Set this hook to all the available hiding commands:
17779 @lisp
17780 (setq gnus-article-display-hook
17781       '(gnus-article-hide-headers
17782         gnus-article-hide-signature
17783         gnus-article-hide-citation))
17784 @end lisp
17786 @item gnus-use-full-window
17787 By setting this to @code{nil}, you can make all the windows smaller.
17788 While this doesn't really cut down much generally, it means that you
17789 have to see smaller portions of articles before deciding that you didn't
17790 want to read them anyway.
17792 @item gnus-thread-hide-subtree
17793 If this is non-@code{nil}, all threads in the summary buffer will be
17794 hidden initially.
17796 @item gnus-updated-mode-lines
17797 If this is @code{nil}, Gnus will not put information in the buffer mode
17798 lines, which might save some time.
17799 @end table
17802 @node Little Disk Space
17803 @subsection Little Disk Space
17804 @cindex disk space
17806 The startup files can get rather large, so you may want to cut their
17807 sizes a bit if you are running out of space.
17809 @table @code
17811 @item gnus-save-newsrc-file
17812 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
17813 only save @file{.newsrc.eld}.  This means that you will not be able to
17814 use any other newsreaders than Gnus.  This variable is @code{t} by
17815 default.
17817 @item gnus-save-killed-list
17818 If this is @code{nil}, Gnus will not save the list of dead groups.  You
17819 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
17820 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
17821 variable to @code{nil}.  This variable is @code{t} by default.
17823 @end table
17826 @node Slow Machine
17827 @subsection Slow Machine
17828 @cindex slow machine
17830 If you have a slow machine, or are just really impatient, there are a
17831 few things you can do to make Gnus run faster.
17833 Set @code{gnus-check-new-newsgroups} and
17834 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
17836 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
17837 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
17838 summary buffer faster.
17840 Set @code{gnus-article-display-hook} to @code{nil} to make article
17841 processing a bit faster.
17844 @page
17845 @node Troubleshooting
17846 @section Troubleshooting
17847 @cindex troubleshooting
17849 Gnus works @emph{so} well straight out of the box---I can't imagine any
17850 problems, really.
17852 Ahem.
17854 @enumerate
17856 @item
17857 Make sure your computer is switched on.
17859 @item
17860 Make sure that you really load the current Gnus version.  If you have
17861 been running @sc{gnus}, you need to exit Emacs and start it up again before
17862 Gnus will work.
17864 @item
17865 Try doing an @kbd{M-x gnus-version}.  If you get something that looks
17866 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded.  If,
17867 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
17868 flee}, you have some old @file{.el} files lying around.  Delete these.
17870 @item
17871 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
17872 how-to.
17874 @item
17875 @vindex max-lisp-eval-depth
17876 Gnus works on many recursive structures, and in some extreme (and very
17877 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
17878 you.  If this happens to you, set @code{max-lisp-eval-depth} to 500 or
17879 something like that.
17880 @end enumerate
17882 If all else fails, report the problem as a bug.
17884 @cindex bugs
17885 @cindex reporting bugs
17887 @kindex M-x gnus-bug
17888 @findex gnus-bug
17889 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
17890 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
17891 me the backtrace.  I will fix bugs, but I can only fix them if you send
17892 me a precise description as to how to reproduce the bug.
17894 You really can never be too detailed in a bug report.  Always use the
17895 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
17896 a 10Kb mail each time you use it, and even if you have sent me your
17897 environment 500 times before.  I don't care.  I want the full info each
17898 time.
17900 It is also important to remember that I have no memory whatsoever.  If
17901 you send a bug report, and I send you a reply, and then you just send
17902 back ``No, it's not! Moron!'', I will have no idea what you are
17903 insulting me about.  Always over-explain everything.  It's much easier
17904 for all of us---if I don't have all the information I need, I will just
17905 mail you and ask for more info, and everything takes more time.
17907 If the problem you're seeing is very visual, and you can't quite explain
17908 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
17909 it somewhere it can be reached, and include the URL of the picture in
17910 the bug report.
17912 If you just need help, you are better off asking on
17913 @samp{gnu.emacs.gnus}.  I'm not very helpful.
17915 @cindex gnu.emacs.gnus
17916 @cindex ding mailing list
17917 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
17918 Write to @samp{ding-request@@gnus.org} to subscribe.
17921 @page
17922 @node A Programmers Guide to Gnus
17923 @section A Programmer@'s Guide to Gnus
17925 It is my hope that other people will figure out smart stuff that Gnus
17926 can do, and that other people will write those smart things as well.  To
17927 facilitate that I thought it would be a good idea to describe the inner
17928 workings of Gnus.  And some of the not-so-inner workings, while I'm at
17931 You can never expect the internals of a program not to change, but I
17932 will be defining (in some details) the interface between Gnus and its
17933 backends (this is written in stone), the format of the score files
17934 (ditto), data structures (some are less likely to change than others)
17935 and general methods of operation.
17937 @menu
17938 * Gnus Utility Functions::   Common functions and variable to use.
17939 * Backend Interface::        How Gnus communicates with the servers.
17940 * Score File Syntax::        A BNF definition of the score file standard.
17941 * Headers::                  How Gnus stores headers internally.
17942 * Ranges::                   A handy format for storing mucho numbers.
17943 * Group Info::               The group info format.
17944 * Extended Interactive::     Symbolic prefixes and stuff.
17945 * Emacs/XEmacs Code::        Gnus can be run under all modern Emacsen.
17946 * Various File Formats::     Formats of files that Gnus use.
17947 @end menu
17950 @node Gnus Utility Functions
17951 @subsection Gnus Utility Functions
17952 @cindex Gnus utility functions
17953 @cindex utility functions
17954 @cindex functions
17955 @cindex internal variables
17957 When writing small functions to be run from hooks (and stuff), it's
17958 vital to have access to the Gnus internal functions and variables.
17959 Below is a list of the most common ones.
17961 @table @code
17963 @item gnus-newsgroup-name
17964 @vindex gnus-newsgroup-name
17965 This variable holds the name of the current newsgroup.
17967 @item gnus-find-method-for-group
17968 @findex gnus-find-method-for-group
17969 A function that returns the select method for @var{group}.
17971 @item gnus-group-real-name
17972 @findex gnus-group-real-name
17973 Takes a full (prefixed) Gnus group name, and returns the unprefixed
17974 name.
17976 @item gnus-group-prefixed-name
17977 @findex gnus-group-prefixed-name
17978 Takes an unprefixed group name and a select method, and returns the full
17979 (prefixed) Gnus group name.
17981 @item gnus-get-info
17982 @findex gnus-get-info
17983 Returns the group info list for @var{group}.
17985 @item gnus-group-unread
17986 @findex gnus-group-unread
17987 The number of unread articles in @var{group}, or @code{t} if that is
17988 unknown.
17990 @item gnus-active
17991 @findex gnus-active
17992 The active entry for @var{group}.
17994 @item gnus-set-active
17995 @findex gnus-set-active
17996 Set the active entry for @var{group}.
17998 @item gnus-add-current-to-buffer-list
17999 @findex gnus-add-current-to-buffer-list
18000 Adds the current buffer to the list of buffers to be killed on Gnus
18001 exit.
18003 @item gnus-continuum-version
18004 @findex gnus-continuum-version
18005 Takes a Gnus version string as a parameter and returns a floating point
18006 number.  Earlier versions will always get a lower number than later
18007 versions.
18009 @item gnus-group-read-only-p
18010 @findex gnus-group-read-only-p
18011 Says whether @var{group} is read-only or not.
18013 @item gnus-news-group-p
18014 @findex gnus-news-group-p
18015 Says whether @var{group} came from a news backend.
18017 @item gnus-ephemeral-group-p
18018 @findex gnus-ephemeral-group-p
18019 Says whether @var{group} is ephemeral or not.
18021 @item gnus-server-to-method
18022 @findex gnus-server-to-method
18023 Returns the select method corresponding to @var{server}.
18025 @item gnus-server-equal
18026 @findex gnus-server-equal
18027 Says whether two virtual servers are equal.
18029 @item gnus-group-native-p
18030 @findex gnus-group-native-p
18031 Says whether @var{group} is native or not.
18033 @item gnus-group-secondary-p
18034 @findex gnus-group-secondary-p
18035 Says whether @var{group} is secondary or not.
18037 @item gnus-group-foreign-p
18038 @findex gnus-group-foreign-p
18039 Says whether @var{group} is foreign or not.
18041 @item group-group-find-parameter
18042 @findex group-group-find-parameter
18043 Returns the parameter list of @var{group}.  If given a second parameter,
18044 returns the value of that parameter for @var{group}.
18046 @item gnus-group-set-parameter
18047 @findex gnus-group-set-parameter
18048 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
18050 @item gnus-narrow-to-body
18051 @findex gnus-narrow-to-body
18052 Narrows the current buffer to the body of the article.
18054 @item gnus-check-backend-function
18055 @findex gnus-check-backend-function
18056 Takes two parameters, @var{function} and @var{group}.  If the backend
18057 @var{group} comes from supports @var{function}, return non-@code{nil}.
18059 @lisp
18060 (gnus-check-backend-function "request-scan" "nnml:misc")
18061 => t
18062 @end lisp
18064 @item gnus-read-method
18065 @findex gnus-read-method
18066 Prompts the user for a select method.
18068 @end table
18071 @node Backend Interface
18072 @subsection Backend Interface
18074 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
18075 groups.  It only knows how to talk to @dfn{virtual servers}.  A virtual
18076 server is a @dfn{backend} and some @dfn{backend variables}.  As examples
18077 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}.  As
18078 examples of the latter we have @code{nntp-port-number} and
18079 @code{nnmbox-directory}.
18081 When Gnus asks for information from a backend---say @code{nntp}---on
18082 something, it will normally include a virtual server name in the
18083 function parameters.  (If not, the backend should use the ``current''
18084 virtual server.)  For instance, @code{nntp-request-list} takes a virtual
18085 server as its only (optional) parameter.  If this virtual server hasn't
18086 been opened, the function should fail.
18088 Note that a virtual server name has no relation to some physical server
18089 name.  Take this example:
18091 @lisp
18092 (nntp "odd-one"
18093       (nntp-address "ifi.uio.no")
18094       (nntp-port-number 4324))
18095 @end lisp
18097 Here the virtual server name is @samp{odd-one} while the name of
18098 the physical server is @samp{ifi.uio.no}.
18100 The backends should be able to switch between several virtual servers.
18101 The standard backends implement this by keeping an alist of virtual
18102 server environments that they pull down/push up when needed.
18104 There are two groups of interface functions: @dfn{required functions},
18105 which must be present, and @dfn{optional functions}, which Gnus will
18106 always check for presence before attempting to call 'em.
18108 All these functions are expected to return data in the buffer
18109 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
18110 unfortunately named, but we'll have to live with it.  When I talk about
18111 @dfn{resulting data}, I always refer to the data in that buffer.  When I
18112 talk about @dfn{return value}, I talk about the function value returned by
18113 the function call.  Functions that fail should return @code{nil} as the
18114 return value.
18116 Some backends could be said to be @dfn{server-forming} backends, and
18117 some might be said not to be.  The latter are backends that generally
18118 only operate on one group at a time, and have no concept of ``server''
18119 -- they have a group, and they deliver info on that group and nothing
18120 more.
18122 In the examples and definitions I will refer to the imaginary backend
18123 @code{nnchoke}.
18125 @cindex @code{nnchoke}
18127 @menu
18128 * Required Backend Functions::        Functions that must be implemented.
18129 * Optional Backend Functions::        Functions that need not be implemented.
18130 * Error Messaging::                   How to get messages and report errors.
18131 * Writing New Backends::              Extending old backends.
18132 * Hooking New Backends Into Gnus::    What has to be done on the Gnus end.
18133 * Mail-like Backends::                Some tips on mail backends.
18134 @end menu
18137 @node Required Backend Functions
18138 @subsubsection Required Backend Functions
18140 @table @code
18142 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
18144 @var{articles} is either a range of article numbers or a list of
18145 @code{Message-ID}s.  Current backends do not fully support either---only
18146 sequences (lists) of article numbers, and most backends do not support
18147 retrieval of @code{Message-ID}s.  But they should try for both.
18149 The result data should either be HEADs or NOV lines, and the result
18150 value should either be @code{headers} or @code{nov} to reflect this.
18151 This might later be expanded to @code{various}, which will be a mixture
18152 of HEADs and NOV lines, but this is currently not supported by Gnus.
18154 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
18155 headers", in some meaning of the word.  This is generally done by
18156 fetching (at most) @var{fetch-old} extra headers less than the smallest
18157 article number in @code{articles}, and filling the gaps as well.  The
18158 presence of this parameter can be ignored if the backend finds it
18159 cumbersome to follow the request.  If this is non-@code{nil} and not a
18160 number, do maximum fetches.
18162 Here's an example HEAD:
18164 @example
18165 221 1056 Article retrieved.
18166 Path: ifi.uio.no!sturles
18167 From: sturles@@ifi.uio.no (Sturle Sunde)
18168 Newsgroups: ifi.discussion
18169 Subject: Re: Something very droll
18170 Date: 27 Oct 1994 14:02:57 +0100
18171 Organization: Dept. of Informatics, University of Oslo, Norway
18172 Lines: 26
18173 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
18174 References: <38jdmq$4qu@@visbur.ifi.uio.no>
18175 NNTP-Posting-Host: holmenkollen.ifi.uio.no
18177 @end example
18179 So a @code{headers} return value would imply that there's a number of
18180 these in the data buffer.
18182 Here's a BNF definition of such a buffer:
18184 @example
18185 headers        = *head
18186 head           = error / valid-head
18187 error-message  = [ "4" / "5" ] 2number " " <error message> eol
18188 valid-head     = valid-message *header "." eol
18189 valid-message  = "221 " <number> " Article retrieved." eol
18190 header         = <text> eol
18191 @end example
18193 If the return value is @code{nov}, the data buffer should contain
18194 @dfn{network overview database} lines.  These are basically fields
18195 separated by tabs.
18197 @example
18198 nov-buffer = *nov-line
18199 nov-line   = 8*9 [ field <TAB> ] eol
18200 field      = <text except TAB>
18201 @end example
18203 For a closer look at what should be in those fields,
18204 @pxref{Headers}.
18207 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
18209 @var{server} is here the virtual server name.  @var{definitions} is a
18210 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
18212 If the server can't be opened, no error should be signaled.  The backend
18213 may then choose to refuse further attempts at connecting to this
18214 server.  In fact, it should do so.
18216 If the server is opened already, this function should return a
18217 non-@code{nil} value.  There should be no data returned.
18220 @item (nnchoke-close-server &optional SERVER)
18222 Close connection to @var{server} and free all resources connected
18223 to it.  Return @code{nil} if the server couldn't be closed for some
18224 reason.
18226 There should be no data returned.
18229 @item (nnchoke-request-close)
18231 Close connection to all servers and free all resources that the backend
18232 have reserved.  All buffers that have been created by that backend
18233 should be killed.  (Not the @code{nntp-server-buffer}, though.)  This
18234 function is generally only called when Gnus is shutting down.
18236 There should be no data returned.
18239 @item (nnchoke-server-opened &optional SERVER)
18241 If @var{server} is the current virtual server, and the connection to the
18242 physical server is alive, then this function should return a
18243 non-@code{nil} vlue.  This function should under no circumstances
18244 attempt to reconnect to a server we have lost connection to.
18246 There should be no data returned.
18249 @item (nnchoke-status-message &optional SERVER)
18251 This function should return the last error message from @var{server}.
18253 There should be no data returned.
18256 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
18258 The result data from this function should be the article specified by
18259 @var{article}.  This might either be a @code{Message-ID} or a number.
18260 It is optional whether to implement retrieval by @code{Message-ID}, but
18261 it would be nice if that were possible.
18263 If @var{to-buffer} is non-@code{nil}, the result data should be returned
18264 in this buffer instead of the normal data buffer.  This is to make it
18265 possible to avoid copying large amounts of data from one buffer to
18266 another, while Gnus mainly requests articles to be inserted directly
18267 into its article buffer.
18269 If it is at all possible, this function should return a cons cell where
18270 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
18271 the article number.  This will enable Gnus to find out what the real
18272 group and article numbers are when fetching articles by
18273 @code{Message-ID}.  If this isn't possible, @code{t} should be returned
18274 on successful article retrieval.
18277 @item (nnchoke-request-group GROUP &optional SERVER FAST)
18279 Get data on @var{group}.  This function also has the side effect of
18280 making @var{group} the current group.
18282 If @var{FAST}, don't bother to return useful data, just make @var{group}
18283 the current group.
18285 Here's an example of some result data and a definition of the same:
18287 @example
18288 211 56 1000 1059 ifi.discussion
18289 @end example
18291 The first number is the status, which should be 211.  Next is the
18292 total number of articles in the group, the lowest article number, the
18293 highest article number, and finally the group name.  Note that the total
18294 number of articles may be less than one might think while just
18295 considering the highest and lowest article numbers, but some articles
18296 may have been canceled.  Gnus just discards the total-number, so
18297 whether one should take the bother to generate it properly (if that is a
18298 problem) is left as an exercise to the reader.
18300 @example
18301 group-status = [ error / info ] eol
18302 error        = [ "4" / "5" ] 2<number> " " <Error message>
18303 info         = "211 " 3* [ <number> " " ] <string>
18304 @end example
18307 @item (nnchoke-close-group GROUP &optional SERVER)
18309 Close @var{group} and free any resources connected to it.  This will be
18310 a no-op on most backends.
18312 There should be no data returned.
18315 @item (nnchoke-request-list &optional SERVER)
18317 Return a list of all groups available on @var{server}.  And that means
18318 @emph{all}.
18320 Here's an example from a server that only carries two groups:
18322 @example
18323 ifi.test 0000002200 0000002000 y
18324 ifi.discussion 3324 3300 n
18325 @end example
18327 On each line we have a group name, then the highest article number in
18328 that group, the lowest article number, and finally a flag.
18330 @example
18331 active-file = *active-line
18332 active-line = name " " <number> " " <number> " " flags eol
18333 name        = <string>
18334 flags       = "n" / "y" / "m" / "x" / "j" / "=" name
18335 @end example
18337 The flag says whether the group is read-only (@samp{n}), is moderated
18338 (@samp{m}), is dead (@samp{x}), is aliased to some other group
18339 (@samp{=other-group}) or none of the above (@samp{y}).
18342 @item (nnchoke-request-post &optional SERVER)
18344 This function should post the current buffer.  It might return whether
18345 the posting was successful or not, but that's not required.  If, for
18346 instance, the posting is done asynchronously, it has generally not been
18347 completed by the time this function concludes.  In that case, this
18348 function should set up some kind of sentinel to beep the user loud and
18349 clear if the posting could not be completed.
18351 There should be no result data from this function.
18353 @end table
18356 @node Optional Backend Functions
18357 @subsubsection Optional Backend Functions
18359 @table @code
18361 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
18363 @var{groups} is a list of groups, and this function should request data
18364 on all those groups.  How it does it is of no concern to Gnus, but it
18365 should attempt to do this in a speedy fashion.
18367 The return value of this function can be either @code{active} or
18368 @code{group}, which says what the format of the result data is.  The
18369 former is in the same format as the data from
18370 @code{nnchoke-request-list}, while the latter is a buffer full of lines
18371 in the same format as @code{nnchoke-request-group} gives.
18373 @example
18374 group-buffer = *active-line / *group-status
18375 @end example
18378 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
18380 A Gnus group info (@pxref{Group Info}) is handed to the backend for
18381 alterations.  This comes in handy if the backend really carries all the
18382 information (as is the case with virtual and imap groups).  This
18383 function should destructively alter the info to suit its needs, and
18384 should return the (altered) group info.
18386 There should be no result data from this function.
18389 @item (nnchoke-request-type GROUP &optional ARTICLE)
18391 When the user issues commands for ``sending news'' (@kbd{F} in the
18392 summary buffer, for instance), Gnus has to know whether the article the
18393 user is following up on is news or mail.  This function should return
18394 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
18395 is mail and @code{unknown} if the type can't be decided.  (The
18396 @var{article} parameter is necessary in @code{nnvirtual} groups which
18397 might very well combine mail groups and news groups.)  Both @var{group}
18398 and @var{article} may be @code{nil}.
18400 There should be no result data from this function.
18403 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
18405 If the user tries to set a mark that the backend doesn't like, this
18406 function may change the mark.  Gnus will use whatever this function
18407 returns as the mark for @var{article} instead of the original
18408 @var{mark}.  If the backend doesn't care, it must return the original
18409 @var{mark}, and not @code{nil} or any other type of garbage.
18411 The only use for this I can see is what @code{nnvirtual} does with
18412 it---if a component group is auto-expirable, marking an article as read
18413 in the virtual group should result in the article being marked as
18414 expirable.
18416 There should be no result data from this function.
18419 @item (nnchoke-request-scan &optional GROUP SERVER)
18421 This function may be called at any time (by Gnus or anything else) to
18422 request that the backend check for incoming articles, in one way or
18423 another.  A mail backend will typically read the spool file or query the
18424 POP server when this function is invoked.  The @var{group} doesn't have
18425 to be heeded---if the backend decides that it is too much work just
18426 scanning for a single group, it may do a total scan of all groups.  It
18427 would be nice, however, to keep things local if that's practical.
18429 There should be no result data from this function.
18432 @item (nnchoke-request-group-description GROUP &optional SERVER)
18434 The result data from this function should be a description of
18435 @var{group}.
18437 @example
18438 description-line = name <TAB> description eol
18439 name             = <string>
18440 description      = <text>
18441 @end example
18443 @item (nnchoke-request-list-newsgroups &optional SERVER)
18445 The result data from this function should be the description of all
18446 groups available on the server.
18448 @example
18449 description-buffer = *description-line
18450 @end example
18453 @item (nnchoke-request-newgroups DATE &optional SERVER)
18455 The result data from this function should be all groups that were
18456 created after @samp{date}, which is in normal human-readable date
18457 format.  The data should be in the active buffer format.
18460 @item (nnchoke-request-create-group GROUP &optional SERVER)
18462 This function should create an empty group with name @var{group}.
18464 There should be no return data.
18467 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
18469 This function should run the expiry process on all articles in the
18470 @var{articles} range (which is currently a simple list of article
18471 numbers.)  It is left up to the backend to decide how old articles
18472 should be before they are removed by this function.  If @var{force} is
18473 non-@code{nil}, all @var{articles} should be deleted, no matter how new
18474 they are.
18476 This function should return a list of articles that it did not/was not
18477 able to delete.
18479 There should be no result data returned.
18482 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
18483 &optional LAST)
18485 This function should move @var{article} (which is a number) from
18486 @var{group} by calling @var{accept-form}.
18488 This function should ready the article in question for moving by
18489 removing any header lines it has added to the article, and generally
18490 should ``tidy up'' the article.  Then it should @code{eval}
18491 @var{accept-form} in the buffer where the ``tidy'' article is.  This
18492 will do the actual copying.  If this @code{eval} returns a
18493 non-@code{nil} value, the article should be removed.
18495 If @var{last} is @code{nil}, that means that there is a high likelihood
18496 that there will be more requests issued shortly, so that allows some
18497 optimizations.
18499 The function should return a cons where the @code{car} is the group name and
18500 the @code{cdr} is the article number that the article was entered as.
18502 There should be no data returned.
18505 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
18507 This function takes the current buffer and inserts it into @var{group}.
18508 If @var{last} in @code{nil}, that means that there will be more calls to
18509 this function in short order.
18511 The function should return a cons where the @code{car} is the group name and
18512 the @code{cdr} is the article number that the article was entered as.
18514 There should be no data returned.
18517 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
18519 This function should remove @var{article} (which is a number) from
18520 @var{group} and insert @var{buffer} there instead.
18522 There should be no data returned.
18525 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
18527 This function should delete @var{group}.  If @var{force}, it should
18528 really delete all the articles in the group, and then delete the group
18529 itself.  (If there is such a thing as ``the group itself''.)
18531 There should be no data returned.
18534 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
18536 This function should rename @var{group} into @var{new-name}.  All
18537 articles in @var{group} should move to @var{new-name}.
18539 There should be no data returned.
18541 @end table
18544 @node Error Messaging
18545 @subsubsection Error Messaging
18547 @findex nnheader-report
18548 @findex nnheader-get-report
18549 The backends should use the function @code{nnheader-report} to report
18550 error conditions---they should not raise errors when they aren't able to
18551 perform a request.  The first argument to this function is the backend
18552 symbol, and the rest are interpreted as arguments to @code{format} if
18553 there are multiple of them, or just a string if there is one of them.
18554 This function must always returns @code{nil}.
18556 @lisp
18557 (nnheader-report 'nnchoke "You did something totally bogus")
18559 (nnheader-report 'nnchoke "Could not request group %s" group)
18560 @end lisp
18562 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
18563 @code{nil} back from a server, and this function returns the most
18564 recently reported message for the backend in question.  This function
18565 takes one argument---the server symbol.
18567 Internally, these functions access @var{backend}@code{-status-string},
18568 so the @code{nnchoke} backend will have its error message stored in
18569 @code{nnchoke-status-string}.
18572 @node Writing New Backends
18573 @subsubsection Writing New Backends
18575 Many backends are quite similar.  @code{nnml} is just like
18576 @code{nnspool}, but it allows you to edit the articles on the server.
18577 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
18578 and it doesn't maintain overview databases.  @code{nndir} is just like
18579 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
18580 editing articles.
18582 It would make sense if it were possible to ``inherit'' functions from
18583 backends when writing new backends.  And, indeed, you can do that if you
18584 want to.  (You don't have to if you don't want to, of course.)
18586 All the backends declare their public variables and functions by using a
18587 package called @code{nnoo}.
18589 To inherit functions from other backends (and allow other backends to
18590 inherit functions from the current backend), you should use the
18591 following macros:
18593 @table @code
18595 @item nnoo-declare
18596 This macro declares the first parameter to be a child of the subsequent
18597 parameters.  For instance:
18599 @lisp
18600 (nnoo-declare nndir
18601   nnml nnmh)
18602 @end lisp
18604 @code{nndir} has declared here that it intends to inherit functions from
18605 both @code{nnml} and @code{nnmh}.
18607 @item defvoo
18608 This macro is equivalent to @code{defvar}, but registers the variable as
18609 a public server variable.  Most state-oriented variables should be
18610 declared with @code{defvoo} instead of @code{defvar}.
18612 In addition to the normal @code{defvar} parameters, it takes a list of
18613 variables in the parent backends to map the variable to when executing
18614 a function in those backends.
18616 @lisp
18617 (defvoo nndir-directory nil
18618   "Where nndir will look for groups."
18619   nnml-current-directory nnmh-current-directory)
18620 @end lisp
18622 This means that @code{nnml-current-directory} will be set to
18623 @code{nndir-directory} when an @code{nnml} function is called on behalf
18624 of @code{nndir}.  (The same with @code{nnmh}.)
18626 @item nnoo-define-basics
18627 This macro defines some common functions that almost all backends should
18628 have.
18630 @example
18631 (nnoo-define-basics nndir)
18632 @end example
18634 @item deffoo
18635 This macro is just like @code{defun} and takes the same parameters.  In
18636 addition to doing the normal @code{defun} things, it registers the
18637 function as being public so that other backends can inherit it.
18639 @item nnoo-map-functions
18640 This macro allows mapping of functions from the current backend to
18641 functions from the parent backends.
18643 @example
18644 (nnoo-map-functions nndir
18645   (nnml-retrieve-headers 0 nndir-current-group 0 0)
18646   (nnmh-request-article 0 nndir-current-group 0 0))
18647 @end example
18649 This means that when @code{nndir-retrieve-headers} is called, the first,
18650 third, and fourth parameters will be passed on to
18651 @code{nnml-retrieve-headers}, while the second parameter is set to the
18652 value of @code{nndir-current-group}.
18654 @item nnoo-import
18655 This macro allows importing functions from backends.  It should be the
18656 last thing in the source file, since it will only define functions that
18657 haven't already been defined.
18659 @example
18660 (nnoo-import nndir
18661   (nnmh
18662    nnmh-request-list
18663    nnmh-request-newgroups)
18664   (nnml))
18665 @end example
18667 This means that calls to @code{nndir-request-list} should just be passed
18668 on to @code{nnmh-request-list}, while all public functions from
18669 @code{nnml} that haven't been defined in @code{nndir} yet should be
18670 defined now.
18672 @end table
18674 Below is a slightly shortened version of the @code{nndir} backend.
18676 @lisp
18677 ;;; nndir.el --- single directory newsgroup access for Gnus
18678 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
18680 ;;; Code:
18682 (require 'nnheader)
18683 (require 'nnmh)
18684 (require 'nnml)
18685 (require 'nnoo)
18686 (eval-when-compile (require 'cl))
18688 (nnoo-declare nndir
18689   nnml nnmh)
18691 (defvoo nndir-directory nil
18692   "Where nndir will look for groups."
18693   nnml-current-directory nnmh-current-directory)
18695 (defvoo nndir-nov-is-evil nil
18696   "*Non-nil means that nndir will never retrieve NOV headers."
18697   nnml-nov-is-evil)
18699 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
18700 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
18701 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
18703 (defvoo nndir-status-string "" nil nnmh-status-string)
18704 (defconst nndir-version "nndir 1.0")
18706 ;;; Interface functions.
18708 (nnoo-define-basics nndir)
18710 (deffoo nndir-open-server (server &optional defs)
18711   (setq nndir-directory
18712         (or (cadr (assq 'nndir-directory defs))
18713             server))
18714   (unless (assq 'nndir-directory defs)
18715     (push `(nndir-directory ,server) defs))
18716   (push `(nndir-current-group
18717           ,(file-name-nondirectory (directory-file-name nndir-directory)))
18718         defs)
18719   (push `(nndir-top-directory
18720           ,(file-name-directory (directory-file-name nndir-directory)))
18721         defs)
18722   (nnoo-change-server 'nndir server defs))
18724 (nnoo-map-functions nndir
18725   (nnml-retrieve-headers 0 nndir-current-group 0 0)
18726   (nnmh-request-article 0 nndir-current-group 0 0)
18727   (nnmh-request-group nndir-current-group 0 0)
18728   (nnmh-close-group nndir-current-group 0))
18730 (nnoo-import nndir
18731   (nnmh
18732    nnmh-status-message
18733    nnmh-request-list
18734    nnmh-request-newgroups))
18736 (provide 'nndir)
18737 @end lisp
18740 @node Hooking New Backends Into Gnus
18741 @subsubsection Hooking New Backends Into Gnus
18743 @vindex gnus-valid-select-methods
18744 Having Gnus start using your new backend is rather easy---you just
18745 declare it with the @code{gnus-declare-backend} functions.  This will
18746 enter the backend into the @code{gnus-valid-select-methods} variable.
18748 @code{gnus-declare-backend} takes two parameters---the backend name and
18749 an arbitrary number of @dfn{abilities}.
18751 Here's an example:
18753 @lisp
18754 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
18755 @end lisp
18757 The abilities can be:
18759 @table @code
18760 @item mail
18761 This is a mailish backend---followups should (probably) go via mail.
18762 @item post
18763 This is a newsish backend---followups should (probably) go via news.
18764 @item post-mail
18765 This backend supports both mail and news.
18766 @item none
18767 This is neither a post nor mail backend---it's something completely
18768 different.
18769 @item respool
18770 It supports respooling---or rather, it is able to modify its source
18771 articles and groups.
18772 @item address
18773 The name of the server should be in the virtual server name.  This is
18774 true for almost all backends.
18775 @item prompt-address
18776 The user should be prompted for an address when doing commands like
18777 @kbd{B} in the group buffer.  This is true for backends like
18778 @code{nntp}, but not @code{nnmbox}, for instance.
18779 @end table
18782 @node Mail-like Backends
18783 @subsubsection Mail-like Backends
18785 One of the things that separate the mail backends from the rest of the
18786 backends is the heavy dependence by the mail backends on common
18787 functions in @file{nnmail.el}.  For instance, here's the definition of
18788 @code{nnml-request-scan}:
18790 @lisp
18791 (deffoo nnml-request-scan (&optional group server)
18792   (setq nnml-article-file-alist nil)
18793   (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
18794 @end lisp
18796 It simply calls @code{nnmail-get-new-mail} with a few parameters,
18797 and @code{nnmail} takes care of all the moving and splitting of the
18798 mail.
18800 This function takes four parameters.
18802 @table @var
18803 @item method
18804 This should be a symbol to designate which backend is responsible for
18805 the call.
18807 @item exit-function
18808 This function should be called after the splitting has been performed.
18810 @item temp-directory
18811 Where the temporary files should be stored.
18813 @item group
18814 This optional argument should be a group name if the splitting is to be
18815 performed for one group only.
18816 @end table
18818 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
18819 save each article.  @var{backend}@code{-active-number} will be called to
18820 find the article number assigned to this article.
18822 The function also uses the following variables:
18823 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
18824 this backend); and @var{backend}@code{-group-alist} and
18825 @var{backend}@code{-active-file} to generate the new active file.
18826 @var{backend}@code{-group-alist} should be a group-active alist, like
18827 this:
18829 @example
18830 (("a-group" (1 . 10))
18831  ("some-group" (34 . 39)))
18832 @end example
18835 @node Score File Syntax
18836 @subsection Score File Syntax
18838 Score files are meant to be easily parseable, but yet extremely
18839 mallable.   It was decided that something that had the same read syntax
18840 as an Emacs Lisp list would fit that spec.
18842 Here's a typical score file:
18844 @lisp
18845 (("summary"
18846   ("win95" -10000 nil s)
18847   ("Gnus"))
18848  ("from"
18849   ("Lars" -1000))
18850  (mark -100))
18851 @end lisp
18853 BNF definition of a score file:
18855 @example
18856 score-file       = "" / "(" *element ")"
18857 element          = rule / atom
18858 rule             = string-rule / number-rule / date-rule
18859 string-rule      = "(" quote string-header quote space *string-match ")"
18860 number-rule      = "(" quote number-header quote space *number-match ")"
18861 date-rule        = "(" quote date-header quote space *date-match ")"
18862 quote            = <ascii 34>
18863 string-header    = "subject" / "from" / "references" / "message-id" /
18864                    "xref" / "body" / "head" / "all" / "followup"
18865 number-header    = "lines" / "chars"
18866 date-header      = "date"
18867 string-match     = "(" quote <string> quote [ "" / [ space score [ "" /
18868                    space date [ "" / [ space string-match-t ] ] ] ] ] ")"
18869 score            = "nil" / <integer>
18870 date             = "nil" / <natural number>
18871 string-match-t   = "nil" / "s" / "substring" / "S" / "Substring" /
18872                    "r" / "regex" / "R" / "Regex" /
18873                    "e" / "exact" / "E" / "Exact" /
18874                    "f" / "fuzzy" / "F" / "Fuzzy"
18875 number-match     = "(" <integer> [ "" / [ space score [ "" /
18876                    space date [ "" / [ space number-match-t ] ] ] ] ] ")"
18877 number-match-t   = "nil" / "=" / "<" / ">" / ">=" / "<="
18878 date-match       = "(" quote <string> quote [ "" / [ space score [ "" /
18879                    space date [ "" / [ space date-match-t ] ] ] ] ")"
18880 date-match-t     = "nil" / "at" / "before" / "after"
18881 atom             = "(" [ required-atom / optional-atom ] ")"
18882 required-atom    = mark / expunge / mark-and-expunge / files /
18883                    exclude-files / read-only / touched
18884 optional-atom    = adapt / local / eval
18885 mark             = "mark" space nil-or-number
18886 nil-or-number    = "nil" / <integer>
18887 expunge          = "expunge" space nil-or-number
18888 mark-and-expunge = "mark-and-expunge" space nil-or-number
18889 files            = "files" *[ space <string> ]
18890 exclude-files    = "exclude-files" *[ space <string> ]
18891 read-only        = "read-only" [ space "nil" / space "t" ]
18892 adapt            = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
18893 adapt-rule       = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
18894 local            = "local" *[ space "(" <string> space <form> ")" ]
18895 eval             = "eval" space <form>
18896 space            = *[ " " / <TAB> / <NEWLINE> ]
18897 @end example
18899 Any unrecognized elements in a score file should be ignored, but not
18900 discarded.
18902 As you can see, white space is needed, but the type and amount of white
18903 space is irrelevant.  This means that formatting of the score file is
18904 left up to the programmer---if it's simpler to just spew it all out on
18905 one looong line, then that's ok.
18907 The meaning of the various atoms are explained elsewhere in this
18908 manual (@pxref{Score File Format}).
18911 @node Headers
18912 @subsection Headers
18914 Internally Gnus uses a format for storing article headers that
18915 corresponds to the @sc{nov} format in a mysterious fashion.  One could
18916 almost suspect that the author looked at the @sc{nov} specification and
18917 just shamelessly @emph{stole} the entire thing, and one would be right.
18919 @dfn{Header} is a severely overloaded term.  ``Header'' is used in
18920 RFC1036 to talk about lines in the head of an article (e.g.,
18921 @code{From}).  It is used by many people as a synonym for
18922 ``head''---``the header and the body''.  (That should be avoided, in my
18923 opinion.)  And Gnus uses a format internally that it calls ``header'',
18924 which is what I'm talking about here.  This is a 9-element vector,
18925 basically, with each header (ouch) having one slot.
18927 These slots are, in order: @code{number}, @code{subject}, @code{from},
18928 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
18929 @code{xref}.  There are macros for accessing and setting these
18930 slots---they all have predictable names beginning with
18931 @code{mail-header-} and @code{mail-header-set-}, respectively.
18933 The @code{xref} slot is really a @code{misc} slot.  Any extra info will
18934 be put in there.
18937 @node Ranges
18938 @subsection Ranges
18940 @sc{gnus} introduced a concept that I found so useful that I've started
18941 using it a lot and have elaborated on it greatly.
18943 The question is simple: If you have a large amount of objects that are
18944 identified by numbers (say, articles, to take a @emph{wild} example)
18945 that you want to qualify as being ``included'', a normal sequence isn't
18946 very useful.  (A 200,000 length sequence is a bit long-winded.)
18948 The solution is as simple as the question: You just collapse the
18949 sequence.
18951 @example
18952 (1 2 3 4 5 6 10 11 12)
18953 @end example
18955 is transformed into
18957 @example
18958 ((1 . 6) (10 . 12))
18959 @end example
18961 To avoid having those nasty @samp{(13 . 13)} elements to denote a
18962 lonesome object, a @samp{13} is a valid element:
18964 @example
18965 ((1 . 6) 7 (10 . 12))
18966 @end example
18968 This means that comparing two ranges to find out whether they are equal
18969 is slightly tricky:
18971 @example
18972 ((1 . 5) 7 8 (10 . 12))
18973 @end example
18977 @example
18978 ((1 . 5) (7 . 8) (10 . 12))
18979 @end example
18981 are equal.  In fact, any non-descending list is a range:
18983 @example
18984 (1 2 3 4 5)
18985 @end example
18987 is a perfectly valid range, although a pretty long-winded one.  This is
18988 also valid:
18990 @example
18991 (1 . 5)
18992 @end example
18994 and is equal to the previous range.
18996 Here's a BNF definition of ranges.  Of course, one must remember the
18997 semantic requirement that the numbers are non-descending.  (Any number
18998 of repetition of the same number is allowed, but apt to disappear in
18999 range handling.)
19001 @example
19002 range           = simple-range / normal-range
19003 simple-range    = "(" number " . " number ")"
19004 normal-range    = "(" start-contents ")"
19005 contents        = "" / simple-range *[ " " contents ] /
19006                   number *[ " " contents ]
19007 @end example
19009 Gnus currently uses ranges to keep track of read articles and article
19010 marks.  I plan on implementing a number of range operators in C if The
19011 Powers That Be are willing to let me.  (I haven't asked yet, because I
19012 need to do some more thinking on what operators I need to make life
19013 totally range-based without ever having to convert back to normal
19014 sequences.)
19017 @node Group Info
19018 @subsection Group Info
19020 Gnus stores all permanent info on groups in a @dfn{group info} list.
19021 This list is from three to six elements (or more) long and exhaustively
19022 describes the group.
19024 Here are two example group infos; one is a very simple group while the
19025 second is a more complex one:
19027 @example
19028 ("no.group" 5 (1 . 54324))
19030 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
19031                 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
19032                 (nnml "")
19033                 ((auto-expire . t) (to-address . "ding@@gnus.org")))
19034 @end example
19036 The first element is the @dfn{group name}---as Gnus knows the group,
19037 anyway.  The second element is the @dfn{subscription level}, which
19038 normally is a small integer.  (It can also be the @dfn{rank}, which is a
19039 cons cell where the @code{car} is the level and the @code{cdr} is the
19040 score.)  The third element is a list of ranges of read articles.  The
19041 fourth element is a list of lists of article marks of various kinds.
19042 The fifth element is the select method (or virtual server, if you like).
19043 The sixth element is a list of @dfn{group parameters}, which is what
19044 this section is about.
19046 Any of the last three elements may be missing if they are not required.
19047 In fact, the vast majority of groups will normally only have the first
19048 three elements, which saves quite a lot of cons cells.
19050 Here's a BNF definition of the group info format:
19052 @example
19053 info          = "(" group space ralevel space read
19054                 [ "" / [ space marks-list [ "" / [ space method [ "" /
19055                 space parameters ] ] ] ] ] ")"
19056 group         = quote <string> quote
19057 ralevel       = rank / level
19058 level         = <integer in the range of 1 to inf>
19059 rank          = "(" level "." score ")"
19060 score         = <integer in the range of 1 to inf>
19061 read          = range
19062 marks-lists   = nil / "(" *marks ")"
19063 marks         = "(" <string> range ")"
19064 method        = "(" <string> *elisp-forms ")"
19065 parameters    = "(" *elisp-forms ")"
19066 @end example
19068 Actually that @samp{marks} rule is a fib.  A @samp{marks} is a
19069 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
19070 in pseudo-BNF.
19072 If you have a Gnus info and want to access the elements, Gnus offers a
19073 series of macros for getting/setting these elements.
19075 @table @code
19076 @item gnus-info-group
19077 @itemx gnus-info-set-group
19078 @findex gnus-info-group
19079 @findex gnus-info-set-group
19080 Get/set the group name.
19082 @item gnus-info-rank
19083 @itemx gnus-info-set-rank
19084 @findex gnus-info-rank
19085 @findex gnus-info-set-rank
19086 Get/set the group rank (@pxref{Group Score}).
19088 @item gnus-info-level
19089 @itemx gnus-info-set-level
19090 @findex gnus-info-level
19091 @findex gnus-info-set-level
19092 Get/set the group level.
19094 @item gnus-info-score
19095 @itemx gnus-info-set-score
19096 @findex gnus-info-score
19097 @findex gnus-info-set-score
19098 Get/set the group score (@pxref{Group Score}).
19100 @item gnus-info-read
19101 @itemx gnus-info-set-read
19102 @findex gnus-info-read
19103 @findex gnus-info-set-read
19104 Get/set the ranges of read articles.
19106 @item gnus-info-marks
19107 @itemx gnus-info-set-marks
19108 @findex gnus-info-marks
19109 @findex gnus-info-set-marks
19110 Get/set the lists of ranges of marked articles.
19112 @item gnus-info-method
19113 @itemx gnus-info-set-method
19114 @findex gnus-info-method
19115 @findex gnus-info-set-method
19116 Get/set the group select method.
19118 @item gnus-info-params
19119 @itemx gnus-info-set-params
19120 @findex gnus-info-params
19121 @findex gnus-info-set-params
19122 Get/set the group parameters.
19123 @end table
19125 All the getter functions take one parameter---the info list.  The setter
19126 functions take two parameters---the info list and the new value.
19128 The last three elements in the group info aren't mandatory, so it may be
19129 necessary to extend the group info before setting the element.  If this
19130 is necessary, you can just pass on a non-@code{nil} third parameter to
19131 the three final setter functions to have this happen automatically.
19134 @node Extended Interactive
19135 @subsection Extended Interactive
19136 @cindex interactive
19137 @findex gnus-interactive
19139 Gnus extends the standard Emacs @code{interactive} specification
19140 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
19141 Prefixes}).  Here's an example of how this is used:
19143 @lisp
19144 (defun gnus-summary-increase-score (&optional score symp)
19145   (interactive (gnus-interactive "P\ny"))
19146   ...
19147   )
19148 @end lisp
19150 The best thing to do would have been to implement
19151 @code{gnus-interactive} as a macro which would have returned an
19152 @code{interactive} form, but this isn't possible since Emacs checks
19153 whether a function is interactive or not by simply doing an @code{assq}
19154 on the lambda form.  So, instead we have @code{gnus-interactive}
19155 function that takes a string and returns values that are usable to
19156 @code{interactive}.
19158 This function accepts (almost) all normal @code{interactive} specs, but
19159 adds a few more.
19161 @table @samp
19162 @item y
19163 @vindex gnus-current-prefix-symbol
19164 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
19165 variable.
19167 @item Y
19168 @vindex gnus-current-prefix-symbols
19169 A list of the current symbolic prefixes---the
19170 @code{gnus-current-prefix-symbol} variable.
19172 @item A
19173 The current article number---the @code{gnus-summary-article-number}
19174 function.
19176 @item H
19177 The current article header---the @code{gnus-summary-article-header}
19178 function.
19180 @item g
19181 The current group name---the @code{gnus-group-group-name}
19182 function.
19184 @end table
19187 @node Emacs/XEmacs Code
19188 @subsection Emacs/XEmacs Code
19189 @cindex XEmacs
19190 @cindex Emacsen
19192 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
19193 platforms must be the primary one.  I chose Emacs.  Not because I don't
19194 like XEmacs or Mule, but because it comes first alphabetically.
19196 This means that Gnus will byte-compile under Emacs with nary a warning,
19197 while XEmacs will pump out gigabytes of warnings while byte-compiling.
19198 As I use byte-compilation warnings to help me root out trivial errors in
19199 Gnus, that's very useful.
19201 I've also consistently used Emacs function interfaces, but have used
19202 Gnusey aliases for the functions.  To take an example:  Emacs defines a
19203 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
19204 function.  I then define a function called @code{gnus-run-at-time} that
19205 takes the same parameters as the Emacs @code{run-at-time}.  When running
19206 Gnus under Emacs, the former function is just an alias for the latter.
19207 However, when running under XEmacs, the former is an alias for the
19208 following function:
19210 @lisp
19211 (defun gnus-xmas-run-at-time (time repeat function &rest args)
19212   (start-itimer
19213    "gnus-run-at-time"
19214    `(lambda ()
19215       (,function ,@@args))
19216    time repeat))
19217 @end lisp
19219 This sort of thing has been done for bunches of functions.  Gnus does
19220 not redefine any native Emacs functions while running under XEmacs---it
19221 does this @code{defalias} thing with Gnus equivalents instead.  Cleaner
19222 all over.
19224 In the cases where the XEmacs function interface was obviously cleaner,
19225 I used it instead.  For example @code{gnus-region-active-p} is an alias
19226 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
19228 Of course, I could have chosen XEmacs as my native platform and done
19229 mapping functions the other way around.  But I didn't.  The performance
19230 hit these indirections impose on Gnus under XEmacs should be slight.
19233 @node Various File Formats
19234 @subsection Various File Formats
19236 @menu
19237 * Active File Format::      Information on articles and groups available.
19238 * Newsgroups File Format::  Group descriptions.
19239 @end menu
19242 @node Active File Format
19243 @subsubsection Active File Format
19245 The active file lists all groups available on the server in
19246 question.  It also lists the highest and lowest current article numbers
19247 in each group.
19249 Here's an excerpt from a typical active file:
19251 @example
19252 soc.motss 296030 293865 y
19253 alt.binaries.pictures.fractals 3922 3913 n
19254 comp.sources.unix 1605 1593 m
19255 comp.binaries.ibm.pc 5097 5089 y
19256 no.general 1000 900 y
19257 @end example
19259 Here's a pseudo-BNF definition of this file:
19261 @example
19262 active      = *group-line
19263 group-line  = group space high-number space low-number space flag <NEWLINE>
19264 group       = <non-white-space string>
19265 space       = " "
19266 high-number = <non-negative integer>
19267 low-number  = <positive integer>
19268 flag        = "y" / "n" / "m" / "j" / "x" / "=" group
19269 @end example
19271 For a full description of this file, see the manual pages for
19272 @samp{innd}, in particular @samp{active(5)}.
19275 @node Newsgroups File Format
19276 @subsubsection Newsgroups File Format
19278 The newsgroups file lists groups along with their descriptions.  Not all
19279 groups on the server have to be listed,  and not all groups in the file
19280 have to exist on the server.  The file is meant purely as information to
19281 the user.
19283 The format is quite simple; a group name, a tab, and the description.
19284 Here's the definition:
19286 @example
19287 newsgroups    = *line
19288 line          = group tab description <NEWLINE>
19289 group         = <non-white-space string>
19290 tab           = <TAB>
19291 description   = <string>
19292 @end example
19295 @page
19296 @node Emacs for Heathens
19297 @section Emacs for Heathens
19299 Believe it or not, but some people who use Gnus haven't really used
19300 Emacs much before they embarked on their journey on the Gnus Love Boat.
19301 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
19302 region'', and ``set @code{gnus-flargblossen} to an alist where the key
19303 is a regexp that is used for matching on the group name'' are magical
19304 phrases with little or no meaning, then this appendix is for you.  If
19305 you are already familiar with Emacs, just ignore this and go fondle your
19306 cat instead.
19308 @menu
19309 * Keystrokes::      Entering text and executing commands.
19310 * Emacs Lisp::      The built-in Emacs programming language.
19311 @end menu
19314 @node Keystrokes
19315 @subsection Keystrokes
19317 @itemize @bullet
19318 @item
19319 Q: What is an experienced Emacs user?
19321 @item
19322 A: A person who wishes that the terminal had pedals.
19323 @end itemize
19325 Yes, when you use Emacs, you are apt to use the control key, the shift
19326 key and the meta key a lot.  This is very annoying to some people
19327 (notably @code{vi}le users), and the rest of us just love the hell out
19328 of it.  Just give up and submit.  Emacs really does stand for
19329 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
19330 may have heard from other disreputable sources (like the Emacs author).
19332 The shift keys are normally located near your pinky fingers, and are
19333 normally used to get capital letters and stuff.  You probably use it all
19334 the time.  The control key is normally marked ``CTRL'' or something like
19335 that.  The meta key is, funnily enough, never marked as such on any
19336 keyboard.  The one I'm currently at has a key that's marked ``Alt'',
19337 which is the meta key on this keyboard.  It's usually located somewhere
19338 to the left hand side of the keyboard, usually on the bottom row.
19340 Now, us Emacs people don't say ``press the meta-control-m key'',
19341 because that's just too inconvenient.  We say ``press the @kbd{M-C-m}
19342 key''.  @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
19343 prefix that means ``control''.  So ``press @kbd{C-k}'' means ``press
19344 down the control key, and hold it down while you press @kbd{k}''.
19345 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
19346 the control key and then press @kbd{k}''.  Simple, ay?
19348 This is somewhat complicated by the fact that not all keyboards have a
19349 meta key.  In that case you can use the ``escape'' key.  Then @kbd{M-k}
19350 means ``press escape, release escape, press @kbd{k}''.  That's much more
19351 work than if you have a meta key, so if that's the case, I respectfully
19352 suggest you get a real keyboard with a meta key.  You can't live without
19357 @node Emacs Lisp
19358 @subsection Emacs Lisp
19360 Emacs is the King of Editors because it's really a Lisp interpreter.
19361 Each and every key you tap runs some Emacs Lisp code snippet, and since
19362 Emacs Lisp is an interpreted language, that means that you can configure
19363 any key to run any arbitrary code.  You just, like, do it.
19365 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
19366 functions.  (These are byte-compiled for speed, but it's still
19367 interpreted.)  If you decide that you don't like the way Gnus does
19368 certain things, it's trivial to have it do something a different way.
19369 (Well, at least if you know how to write Lisp code.)  However, that's
19370 beyond the scope of this manual, so we are simply going to talk about
19371 some common constructs that you normally use in your @file{.emacs} file
19372 to customize Gnus.
19374 If you want to set the variable @code{gnus-florgbnize} to four (4), you
19375 write the following:
19377 @lisp
19378 (setq gnus-florgbnize 4)
19379 @end lisp
19381 This function (really ``special form'') @code{setq} is the one that can
19382 set a variable to some value.  This is really all you need to know.  Now
19383 you can go and fill your @code{.emacs} file with lots of these to change
19384 how Gnus works.
19386 If you have put that thing in your @code{.emacs} file, it will be read
19387 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
19388 start Emacs.  If you want to change the variable right away, simply say
19389 @kbd{C-x C-e} after the closing parenthesis.  That will @code{eval} the
19390 previous ``form'', which is a simple @code{setq} statement here.
19392 Go ahead---just try it, if you're located at your Emacs.  After you
19393 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
19394 is the return value of the form you @code{eval}ed.
19396 Some pitfalls:
19398 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
19399 that means:
19401 @lisp
19402 (setq gnus-read-active-file 'some)
19403 @end lisp
19405 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
19406 @samp{nntp.ifi.uio.no}'', that means:
19408 @lisp
19409 (setq gnus-nntp-server "nntp.ifi.uio.no")
19410 @end lisp
19412 So be careful not to mix up strings (the latter) with symbols (the
19413 former).  The manual is unambiguous, but it can be confusing.
19415 @page
19416 @include gnus-faq.texi
19418 @node Index
19419 @chapter Index
19420 @printindex cp
19422 @node Key Index
19423 @chapter Key Index
19424 @printindex ky
19426 @setchapternewpage odd
19427 @summarycontents
19428 @contents
19429 @bye
19432 @c End: