1 \input texinfo @c -*-texinfo-*-
4 @settitle Gnus 5.4 Manual
11 @setchapternewpage odd
15 \documentclass[twoside,a4paper,openright]{book}
16 \usepackage[latin1]{inputenc}
17 \usepackage{pagestyle}
19 \fontfamily{bembo}\selectfont
24 \newcommand{\gnuschaptername}{}
25 \newcommand{\gnussectionname}{}
27 \newcommand{\gnusbackslash}{/}
29 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
30 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
32 \newcommand{\gnuskindex}[1]{\index{#1}}
33 \newcommand{\gnusindex}[1]{\index{#1}}
35 \newcommand{\gnustt}[1]{{\textbf{\textsf{#1}}}}
36 \newcommand{\gnuscode}[1]{\gnustt{#1}}
37 \newcommand{\gnussamp}[1]{``\gnustt{#1}''}
38 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
39 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
40 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
41 \newcommand{\gnusdfn}[1]{\textit{#1}}
42 \newcommand{\gnusi}[1]{\textit{#1}}
43 \newcommand{\gnusstrong}[1]{\textbf{#1}}
44 \newcommand{\gnusemph}[1]{\textit{#1}}
45 \newcommand{\gnusvar}[1]{\textsl{\textsf{#1}}}
46 \newcommand{\gnussc}[1]{\textsc{#1}}
47 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
48 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
50 \newcommand{\gnusbullet}{{${\bullet}$}}
51 \newcommand{\gnusdollar}{\$}
52 \newcommand{\gnusampersand}{\&}
53 \newcommand{\gnuspercent}{\%}
54 \newcommand{\gnushash}{\#}
55 \newcommand{\gnushat}{\symbol{"5E}}
56 \newcommand{\gnusunderline}{\symbol{"5F}}
57 \newcommand{\gnusnot}{$\neg$}
58 \newcommand{\gnustilde}{\symbol{"7E}}
59 \newcommand{\gnusless}{{$<$}}
60 \newcommand{\gnusgreater}{{$>$}}
62 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=gnus-head.eps,height=1cm}}}
63 \newcommand{\gnusinteresting}{
64 \marginpar[\hspace{2.5cm}\gnushead]{\gnushead}
67 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
69 \newcommand{\gnuspagechapter}[1]{
76 \newcommand{\gnuschapter}[2]{
78 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
80 \renewcommand{\gnussectionname}{}
81 \renewcommand{\gnuschaptername}{#2}
84 \begin{picture}(500,500)(0,0)
85 \put(0,0){\makebox(480,350)[tr]{#1}}
86 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
91 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
93 \newcommand{\gnussection}[1]{
94 \renewcommand{\gnussectionname}{#1}
98 \newenvironment{codelist}%
103 \newenvironment{kbdlist}%
109 \newenvironment{dfnlist}%
114 \newenvironment{stronglist}%
119 \newenvironment{samplist}%
124 \newenvironment{varlist}%
129 \newenvironment{emphlist}%
134 \newlength\gnusheadtextwidth
135 \setlength{\gnusheadtextwidth}{\headtextwidth}
136 \addtolength{\gnusheadtextwidth}{1cm}
138 \newpagestyle{gnuspreamble}%
143 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
147 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
156 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
158 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
163 \newpagestyle{gnusindex}%
168 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
172 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
180 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
182 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
192 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}
196 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
204 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
206 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
211 \pagenumbering{roman}
212 \pagestyle{gnuspreamble}
222 %\addtolength{\oddsidemargin}{-5cm}
223 %\addtolength{\evensidemargin}{-5cm}
225 \addtolength{\textheight}{2cm}
227 \gnustitle{\gnustitlename}\\
230 \hspace*{-1cm}\epsfig{figure=gnus-big-logo.eps,height=15cm}
233 \gnusauthor{by Lars Magne Ingebrigtsen}
240 \thispagestyle{empty}
242 Copyright \copyright{} 1995,96 Free Software Foundation, Inc.
244 Permission is granted to make and distribute verbatim copies of
245 this manual provided the copyright notice and this permission notice
246 are preserved on all copies.
248 Permission is granted to copy and distribute modified versions of this
249 manual under the conditions for verbatim copying, provided that the
250 entire resulting derived work is distributed under the terms of a
251 permission notice identical to this one.
253 Permission is granted to copy and distribute translations of this manual
254 into another language, under the above conditions for modified versions.
263 This file documents Gnus, the GNU Emacs newsreader.
265 Copyright (C) 1995,96 Free Software Foundation, Inc.
267 Permission is granted to make and distribute verbatim copies of
268 this manual provided the copyright notice and this permission notice
269 are preserved on all copies.
272 Permission is granted to process this file through Tex and print the
273 results, provided the printed document carries copying permission
274 notice identical to this one except for the removal of this paragraph
275 (this paragraph not being relevant to the printed manual).
278 Permission is granted to copy and distribute modified versions of this
279 manual under the conditions for verbatim copying, provided also that the
280 entire resulting derived work is distributed under the terms of a
281 permission notice identical to this one.
283 Permission is granted to copy and distribute translations of this manual
284 into another language, under the above conditions for modified versions.
290 @title Gnus 5.4 Manual
292 @author by Lars Magne Ingebrigtsen
295 @vskip 0pt plus 1filll
296 Copyright @copyright{} 1995,96 Free Software Foundation, Inc.
298 Permission is granted to make and distribute verbatim copies of
299 this manual provided the copyright notice and this permission notice
300 are preserved on all copies.
302 Permission is granted to copy and distribute modified versions of this
303 manual under the conditions for verbatim copying, provided that the
304 entire resulting derived work is distributed under the terms of a
305 permission notice identical to this one.
307 Permission is granted to copy and distribute translations of this manual
308 into another language, under the above conditions for modified versions.
317 @top The Gnus Newsreader
321 You can read news (and mail) from within Emacs by using Gnus. The news
322 can be gotten by any nefarious means you can think of---@sc{nntp}, local
323 spool or your mbox file. All at the same time, if you want to push your
326 This manual corresponds to Gnus 5.4.
337 Gnus is the advanced, self-documenting, customizable, extensible
338 unreal-time newsreader for GNU Emacs.
340 Oops. That sounds oddly familiar, so let's start over again to avoid
341 being accused of plagiarism:
343 Gnus is a message-reading laboratory. It will let you look at just
344 about anything as if it were a newsgroup. You can read mail with it,
345 you can browse directories with it, you can @code{ftp} with it---you can
346 even read news with it!
348 Gnus tries to empower people who read news the same way Emacs empowers
349 people who edit text. Gnus sets no limits to what the user should be
350 allowed to do. Users are encouraged to extend Gnus to make it behave
351 like they want it to behave. A program should not control people;
352 people should be empowered to do what they want by using (or abusing)
359 * Starting Up:: Finding news can be a pain.
360 * The Group Buffer:: Selecting, subscribing and killing groups.
361 * The Summary Buffer:: Reading, saving and posting articles.
362 * The Article Buffer:: Displaying and handling articles.
363 * Composing Messages:: Information on sending mail and news.
364 * Select Methods:: Gnus reads all messages from various select methods.
365 * Scoring:: Assigning values to articles.
366 * Various:: General purpose settings.
367 * The End:: Farewell and goodbye.
368 * Appendices:: Terminology, Emacs intro, FAQ, History, Internals.
369 * Index:: Variable, function and concept index.
370 * Key Index:: Key Index.
374 @chapter Starting Gnus
379 If your system administrator has set things up properly, starting Gnus
380 and reading news is extremely easy---you just type @kbd{M-x gnus} in
383 @findex gnus-other-frame
384 @kindex M-x gnus-other-frame
385 If you want to start Gnus in a different frame, you can use the command
386 @kbd{M-x gnus-other-frame} instead.
388 If things do not go smoothly at startup, you have to twiddle some
392 * Finding the News:: Choosing a method for getting news.
393 * The First Time:: What does Gnus do the first time you start it?
394 * The Server is Down:: How can I read my mail then?
395 * Slave Gnusae:: You can have more than one Gnus active at a time.
396 * Fetching a Group:: Starting Gnus just to read a group.
397 * New Groups:: What is Gnus supposed to do with new groups?
398 * Startup Files:: Those pesky startup files---@file{.newsrc}.
399 * Auto Save:: Recovering from a crash.
400 * The Active File:: Reading the active file over a slow line Takes Time.
401 * Changing Servers:: You may want to move from one server to another.
402 * Startup Variables:: Other variables you might change.
406 @node Finding the News
407 @section Finding the News
410 @vindex gnus-select-method
412 The @code{gnus-select-method} variable says where Gnus should look for
413 news. This variable should be a list where the first element says
414 @dfn{how} and the second element says @dfn{where}. This method is your
415 native method. All groups that are not fetched with this method are
418 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
419 you want to get your daily dosage of news from, you'd say:
422 (setq gnus-select-method '(nntp "news.somewhere.edu"))
425 If you want to read directly from the local spool, say:
428 (setq gnus-select-method '(nnspool ""))
431 If you can use a local spool, you probably should, as it will almost
432 certainly be much faster.
434 @vindex gnus-nntpserver-file
436 @cindex @sc{nntp} server
437 If this variable is not set, Gnus will take a look at the
438 @code{NNTPSERVER} environment variable. If that variable isn't set,
439 Gnus will see whether @code{gnus-nntpserver-file}
440 (@file{/etc/nntpserver} by default) has any opinions on the matter. If
441 that fails as well, Gnus will will try to use the machine that is
442 running Emacs as an @sc{nntp} server. That's a long shot, though.
444 @vindex gnus-nntp-server
445 If @code{gnus-nntp-server} is set, this variable will override
446 @code{gnus-select-method}. You should therefore set
447 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
449 @vindex gnus-secondary-servers
450 You can also make Gnus prompt you interactively for the name of an
451 @sc{nntp} server. If you give a non-numerical prefix to @code{gnus}
452 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
453 in the @code{gnus-secondary-servers} list (if any). You can also just
454 type in the name of any server you feel like visiting.
456 @findex gnus-group-browse-foreign-server
458 However, if you use one @sc{nntp} server regularly and are just
459 interested in a couple of groups from a different server, you would be
460 better served by using the @kbd{B} command in the group buffer. It will
461 let you have a look at what groups are available, and you can subscribe
462 to any of the groups you want to. This also makes @file{.newsrc}
463 maintenance much tidier. @xref{Foreign Groups}.
465 @vindex gnus-secondary-select-methods
467 A slightly different approach to foreign groups is to set the
468 @code{gnus-secondary-select-methods} variable. The select methods
469 listed in this variable are in many ways just as native as the
470 @code{gnus-select-method} server. They will also be queried for active
471 files during startup (if that's required), and new newsgroups that
472 appear on these servers will be subscribed (or not) just as native
475 For instance, if you use the @code{nnmbox} backend to read your mail, you
476 would typically set this variable to
479 (setq gnus-secondary-select-methods '((nnmbox "")))
484 @section The First Time
485 @cindex first time usage
487 If no startup files exist, Gnus will try to determine what groups should
488 be subscribed by default.
490 @vindex gnus-default-subscribed-newsgroups
491 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
492 will subscribe you to just those groups in that list, leaving the rest
493 killed. Your system administrator should have set this variable to
496 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
497 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is here
498 defined as @dfn{whatever Lars thinks you should read}.)
500 You'll also be subscribed to the Gnus documentation group, which should
501 help you with most common problems.
503 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
504 use the normal functions for handling new groups, and not do anything
508 @node The Server is Down
509 @section The Server is Down
510 @cindex server errors
512 If the default server is down, Gnus will understandably have some
513 problems starting. However, if you have some mail groups in addition to
514 the news groups, you may want to start Gnus anyway.
516 Gnus, being the trusting sort of program, will ask whether to proceed
517 without a native select method if that server can't be contacted. This
518 will happen whether the server doesn't actually exist (i.e., you have
519 given the wrong address) or the server has just momentarily taken ill
520 for some reason or other. If you decide to continue and have no foreign
521 groups, you'll find it difficult to actually do anything in the group
522 buffer. But, hey, that's your problem. Blllrph!
524 @findex gnus-no-server
525 @kindex M-x gnus-no-server
527 If you know that the server is definitely down, or you just want to read
528 your mail without bothering with the server at all, you can use the
529 @code{gnus-no-server} command to start Gnus. That might come in handy
530 if you're in a hurry as well. This command will not attempt to contact
531 your primary server---instead, it will just activate all groups on level
532 1 and 2. (You should preferably keep no native groups on those two
537 @section Slave Gnusae
540 You might want to run more than one Emacs with more than one Gnus at the
541 same time. If you are using different @file{.newsrc} files (e.g., if you
542 are using the two different Gnusae to read from two different servers),
543 that is no problem whatsoever. You just do it.
545 The problem appears when you want to run two Gnusae that use the same
548 To work around that problem some, we here at the Think-Tank at the Gnus
549 Towers have come up with a new concept: @dfn{Masters} and
550 @dfn{slaves}. (We have applied for a patent on this concept, and have
551 taken out a copyright on those words. If you wish to use those words in
552 conjunction with each other, you have to send $1 per usage instance to
553 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
554 Applications}) will be much more expensive, of course.)
556 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
557 however you do it). Each subsequent slave Gnusae should be started with
558 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
559 files, but instead save @dfn{slave files} that contain information only
560 on what groups have been read in the slave session. When a master Gnus
561 starts, it will read (and delete) these slave files, incorporating all
562 information from them. (The slave files will be read in the sequence
563 they were created, so the latest changes will have precedence.)
565 Information from the slave files has, of course, precedence over the
566 information in the normal (i.e., master) @code{.newsrc} file.
569 @node Fetching a Group
570 @section Fetching a Group
571 @cindex fetching a group
573 @findex gnus-fetch-group
574 It it sometimes convenient to be able to just say ``I want to read this
575 group and I don't care whether Gnus has been started or not''. This is
576 perhaps more useful for people who write code than for users, but the
577 command @code{gnus-fetch-group} provides this functionality in any case.
578 It takes the group name as a parameter.
586 @vindex gnus-check-new-newsgroups
587 If you are satisfied that you really never want to see any new groups,
588 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
589 also save you some time at startup. Even if this variable is
590 @code{nil}, you can always subscribe to the new groups just by pressing
591 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
592 is @code{t} by default. If you set this variable to @code{always}, then
593 Gnus will query the backends for new groups even when you do the @kbd{g}
594 command (@pxref{Scanning New Messages}).
597 * Checking New Groups:: Determining what groups are new.
598 * Subscription Methods:: What Gnus should do with new groups.
599 * Filtering New Groups:: Making Gnus ignore certain new groups.
603 @node Checking New Groups
604 @subsection Checking New Groups
606 Gnus normally determines whether a group is new or not by comparing the
607 list of groups from the active file(s) with the lists of subscribed and
608 dead groups. This isn't a particularly fast method. If
609 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
610 server for new groups since the last time. This is both faster and
611 cheaper. This also means that you can get rid of the list of killed
612 groups altogether, so you may set @code{gnus-save-killed-list} to
613 @code{nil}, which will save time both at startup, at exit, and all over.
614 Saves disk space, too. Why isn't this the default, then?
615 Unfortunately, not all servers support this command.
617 I bet I know what you're thinking now: How do I find out whether my
618 server supports @code{ask-server}? No? Good, because I don't have a
619 fail-safe answer. I would suggest just setting this variable to
620 @code{ask-server} and see whether any new groups appear within the next
621 few days. If any do, then it works. If none do, then it doesn't
622 work. I could write a function to make Gnus guess whether the server
623 supports @code{ask-server}, but it would just be a guess. So I won't.
624 You could @code{telnet} to the server and say @code{HELP} and see
625 whether it lists @samp{NEWGROUPS} among the commands it understands. If
626 it does, then it might work. (But there are servers that lists
627 @samp{NEWGROUPS} without supporting the function properly.)
629 This variable can also be a list of select methods. If so, Gnus will
630 issue an @code{ask-server} command to each of the select methods, and
631 subscribe them (or not) using the normal methods. This might be handy
632 if you are monitoring a few servers for new groups. A side effect is
633 that startup will take much longer, so you can meditate while waiting.
634 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
637 @node Subscription Methods
638 @subsection Subscription Methods
640 @vindex gnus-subscribe-newsgroup-method
641 What Gnus does when it encounters a new group is determined by the
642 @code{gnus-subscribe-newsgroup-method} variable.
644 This variable should contain a function. Some handy pre-fab values
649 @item gnus-subscribe-zombies
650 @vindex gnus-subscribe-zombies
651 Make all new groups zombies. This is the default. You can browse the
652 zombies later (with @kbd{A z}) and either kill them all off properly
653 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
655 @item gnus-subscribe-randomly
656 @vindex gnus-subscribe-randomly
657 Subscribe all new groups randomly.
659 @item gnus-subscribe-alphabetically
660 @vindex gnus-subscribe-alphabetically
661 Subscribe all new groups alphabetically.
663 @item gnus-subscribe-hierarchically
664 @vindex gnus-subscribe-hierarchically
665 Subscribe all new groups hierarchically. The difference between this
666 function and @code{gnus-subscribe-alphabetically} is slight.
667 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
668 alphabetical fashion, while this function will enter groups into it's
669 hierarchy. So if you want to have the @samp{rec} hierarchy before the
670 @samp{comp} hierarchy, this function will not mess that configuration
671 up. Or something like that.
673 @item gnus-subscribe-interactively
674 @vindex gnus-subscribe-interactively
675 Subscribe new groups interactively. This means that Gnus will ask
676 you about @strong{all} new groups.
678 @item gnus-subscribe-killed
679 @vindex gnus-subscribe-killed
684 @vindex gnus-subscribe-hierarchical-interactive
685 A closely related variable is
686 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
687 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
688 hierarchical fashion whether to subscribe to new groups or not. Gnus
689 will ask you for each sub-hierarchy whether you want to descend the
692 One common mistake is to set the variable a few paragraphs above to
693 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
694 will not work. This is ga-ga. So don't do it.
697 @node Filtering New Groups
698 @subsection Filtering New Groups
700 A nice and portable way to control which new newsgroups should be
701 subscribed (or ignored) is to put an @dfn{options} line at the start of
702 the @file{.newsrc} file. Here's an example:
705 options -n !alt.all !rec.all sci.all
708 @vindex gnus-subscribe-options-newsgroup-method
709 This line obviously belongs to a serious-minded intellectual scientific
710 person (or she may just be plain old boring), because it says that all
711 groups that have names beginning with @samp{alt} and @samp{rec} should
712 be ignored, and all groups with names beginning with @samp{sci} should
713 be subscribed. Gnus will not use the normal subscription method for
714 subscribing these groups.
715 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
716 variable defaults to @code{gnus-subscribe-alphabetically}.
718 @vindex gnus-options-not-subscribe
719 @vindex gnus-options-subscribe
720 If you don't want to mess with your @file{.newsrc} file, you can just
721 set the two variables @code{gnus-options-subscribe} and
722 @code{gnus-options-not-subscribe}. These two variables do exactly the
723 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
724 and if the the new group matches the former, it will be unconditionally
725 subscribed, and if it matches the latter, it will be ignored.
727 @vindex gnus-auto-subscribed-groups
728 Yet another variable that meddles here is
729 @code{gnus-auto-subscribed-groups}. It works exactly like
730 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
731 thought it would be nice to have two of these. This variable is more
732 meant for setting some ground rules, while the other variable is used
733 more for user fiddling. By default this variable makes all new groups
734 that come from mail backends (@code{nnml}, @code{nnbabyl},
735 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you
736 don't like that, just set this variable to @code{nil}.
738 New groups that match this regexp are subscribed using
739 @code{gnus-subscribe-options-newsgroup-method}.
742 @node Changing Servers
743 @section Changing Servers
744 @cindex changing servers
746 Sometimes it is necessary to move from one @sc{nntp} server to another.
747 This happens very rarely, but perhaps you change jobs, or one server is
748 very flaky and you want to use another.
750 Changing the server is pretty easy, right? You just change
751 @code{gnus-select-method} to point to the new server?
755 Article numbers are not (in any way) kept synchronized between different
756 @sc{nntp} servers, and the only way Gnus keeps track of what articles
757 you have read is by keeping track of article numbers. So when you
758 change @code{gnus-select-method}, your @file{.newsrc} file becomes
761 Gnus provides a few functions to attempt to translate a @file{.newsrc}
762 file from one server to another. They all have one thing in
763 common---they take a looong time to run. You don't want to use these
764 functions more than absolutely necessary.
766 @kindex M-x gnus-change-server
767 @findex gnus-change-server
768 If you have access to both servers, Gnus can request the headers for all
769 the articles you have read and compare @code{Message-ID}s and map the
770 article numbers of the read articles and article marks. The @kbd{M-x
771 gnus-change-server} command will do this for all your native groups. It
772 will prompt for the method you want to move to.
774 @kindex M-x gnus-group-move-group-to-server
775 @findex gnus-group-move-group-to-server
776 You can also move individual groups with the @kbd{M-x
777 gnus-group-move-group-to-server} command. This is useful if you want to
778 move a (foreign) group from one server to another.
780 @kindex M-x gnus-group-clear-data-on-native-groups
781 @findex gnus-group-clear-data-on-native-groups
782 If you don't have access to both the old and new server, all your marks
783 and read ranges have become worthless. You can use the @kbd{M-x
784 gnus-group-clear-data-on-native-groups} command to clear out all data
785 that you have on your native groups. Use with caution.
789 @section Startup Files
790 @cindex startup files
795 Now, you all know about the @file{.newsrc} file. All subscription
796 information is traditionally stored in this file.
798 Things got a bit more complicated with @sc{gnus}. In addition to
799 keeping the @file{.newsrc} file updated, it also used a file called
800 @file{.newsrc.el} for storing all the information that didn't fit into
801 the @file{.newsrc} file. (Actually, it also duplicated everything in
802 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
803 files was the most recently saved, which enabled people to swap between
804 @sc{gnus} and other newsreaders.
806 That was kinda silly, so Gnus went one better: In addition to the
807 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
808 @file{.newsrc.eld}. It will read whichever of these files that are most
809 recent, but it will never write a @file{.newsrc.el} file.
811 @vindex gnus-save-newsrc-file
812 You can turn off writing the @file{.newsrc} file by setting
813 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
814 the file and save some space, as well as making exit from Gnus faster.
815 However, this will make it impossible to use other newsreaders than
816 Gnus. But hey, who would want to, right?
818 @vindex gnus-save-killed-list
819 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
820 will not save the list of killed groups to the startup file. This will
821 save both time (when starting and quitting) and space (on disk). It
822 will also mean that Gnus has no record of what groups are new or old,
823 so the automatic new groups subscription methods become meaningless.
824 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
825 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
826 Groups}). This variable can also be a regular expression. If that's
827 the case, remove all groups that do not match this regexp before
828 saving. This can be useful in certain obscure situations that involve
829 several servers where not all servers support @code{ask-server}.
831 @vindex gnus-startup-file
832 The @code{gnus-startup-file} variable says where the startup files are.
833 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
834 file being whatever that one is with a @samp{.eld} appended.
836 @vindex gnus-save-newsrc-hook
837 @vindex gnus-save-quick-newsrc-hook
838 @vindex gnus-save-standard-newsrc-hook
839 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
840 files, while @code{gnus-save-quick-newsrc-hook} is called just before
841 saving the @file{.newsrc.eld} file, and
842 @code{gnus-save-standard-newsrc-hook} is called just before saving the
843 @file{.newsrc} file. The latter two are commonly used to turn version
844 control on or off. Version control is on by default when saving the
845 startup files. If you want to turn backup creation off, say something like:
848 (defun turn-off-backup ()
849 (set (make-local-variable 'backup-inhibited) t))
851 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
852 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
855 @vindex gnus-init-file
856 When Gnus starts, it will read the @code{gnus-site-init-file}
857 (@file{.../site-lisp/gnus.el} by default) and @code{gnus-init-file}
858 (@file{~/.gnus.el} by default) files. These are normal Emacs Lisp files
859 and can be used to avoid cluttering your @file{.emacs} and
860 @file{site-init} files with Gnus stuff.
868 Whenever you do something that changes the Gnus data (reading articles,
869 catching up, killing/subscribing groups), the change is added to a
870 special @dfn{dribble buffer}. This buffer is auto-saved the normal
871 Emacs way. If your Emacs should crash before you have saved the
872 @file{.newsrc} files, all changes you have made can be recovered from
875 If Gnus detects this file at startup, it will ask the user whether to
876 read it. The auto save file is deleted whenever the real startup file is
879 @vindex gnus-use-dribble-file
880 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
881 maintain a dribble buffer. The default is @code{t}.
883 @vindex gnus-dribble-directory
884 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
885 this variable is @code{nil}, which it is by default, Gnus will dribble
886 into the directory where the @file{.newsrc} file is located. (This is
887 normally the user's home directory.) The dribble file will get the same
888 file permissions as the @code{.newsrc} file.
891 @node The Active File
892 @section The Active File
894 @cindex ignored groups
896 When Gnus starts, or indeed whenever it tries to determine whether new
897 articles have arrived, it reads the active file. This is a very large
898 file that lists all the active groups and articles on the server.
900 @vindex gnus-ignored-newsgroups
901 Before examining the active file, Gnus deletes all lines that match the
902 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
903 any groups with bogus names, but you can use this variable to make Gnus
904 ignore hierarchies you aren't ever interested in. However, this is not
905 recommended. In fact, it's highly discouraged. Instead, @pxref{New
906 Groups} for an overview of other variables that can be used instead.
909 @c @code{nil} by default, and will slow down active file handling somewhat
910 @c if you set it to anything else.
912 @vindex gnus-read-active-file
914 The active file can be rather Huge, so if you have a slow network, you
915 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
916 reading the active file. This variable is @code{t} by default.
918 Gnus will try to make do by getting information just on the groups that
919 you actually subscribe to.
921 Note that if you subscribe to lots and lots of groups, setting this
922 variable to @code{nil} will probably make Gnus slower, not faster. At
923 present, having this variable @code{nil} will slow Gnus down
924 considerably, unless you read news over a 2400 baud modem.
926 This variable can also have the value @code{some}. Gnus will then
927 attempt to read active info only on the subscribed groups. On some
928 servers this is quite fast (on sparkling, brand new INN servers that
929 support the @code{LIST ACTIVE group} command), on others this isn't fast
930 at all. In any case, @code{some} should be faster than @code{nil}, and
931 is certainly faster than @code{t} over slow lines.
933 If this variable is @code{nil}, Gnus will ask for group info in total
934 lock-step, which isn't very fast. If it is @code{some} and you use an
935 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
936 read all the replies in one swoop. This will normally result in better
937 performance, but if the server does not support the aforementioned
938 @code{LIST ACTIVE group} command, this isn't very nice to the server.
940 In any case, if you use @code{some} or @code{nil}, you should definitely
941 kill all groups that you aren't interested in to speed things up.
943 Note that this variable also affects active file retrieval from
944 secondary select methods.
947 @node Startup Variables
948 @section Startup Variables
953 @vindex gnus-load-hook
954 A hook that is run while Gnus is being loaded. Note that this hook will
955 normally be run just once in each Emacs session, no matter how many
956 times you start Gnus.
958 @item gnus-startup-hook
959 @vindex gnus-startup-hook
960 A hook that is run after starting up Gnus successfully.
962 @item gnus-check-bogus-newsgroups
963 @vindex gnus-check-bogus-newsgroups
964 If non-@code{nil}, Gnus will check for and delete all bogus groups at
965 startup. A @dfn{bogus group} is a group that you have in your
966 @file{.newsrc} file, but doesn't exist on the news server. Checking for
967 bogus groups can take quite a while, so to save time and resources it's
968 best to leave this option off, and do the checking for bogus groups once
969 in a while from the group buffer instead (@pxref{Group Maintenance}).
971 @item gnus-inhibit-startup-message
972 @vindex gnus-inhibit-startup-message
973 If non-@code{nil}, the startup message won't be displayed. That way,
974 your boss might not notice as easily that you are reading news instead
975 of doing your job. Note that this variable is used before
976 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
978 @item gnus-no-groups-message
979 @vindex gnus-no-groups-message
980 Message displayed by Gnus when no groups are available.
982 @item gnus-play-startup-jingle
983 @vindex gnus-play-startup-jingle
984 If non-@code{nil}, play the Gnus jingle at startup.
986 @item gnus-startup-jingle
987 @vindex gnus-startup-jingle
988 Jingle to be played if the above variable is non-@code{nil}. The
989 default is @samp{Tuxedomoon.Jingle4.au}.
994 @node The Group Buffer
995 @chapter The Group Buffer
998 The @dfn{group buffer} lists all (or parts) of the available groups. It
999 is the first buffer shown when Gnus starts, and will never be killed as
1000 long as Gnus is active.
1003 * Group Buffer Format:: Information listed and how you can change it.
1004 * Group Maneuvering:: Commands for moving in the group buffer.
1005 * Selecting a Group:: Actually reading news.
1006 * Group Data:: Changing the info for a group.
1007 * Subscription Commands:: Unsubscribing, killing, subscribing.
1008 * Group Levels:: Levels? What are those, then?
1009 * Group Score:: A mechanism for finding out what groups you like.
1010 * Marking Groups:: You can mark groups for later processing.
1011 * Foreign Groups:: Creating and editing groups.
1012 * Group Parameters:: Each group may have different parameters set.
1013 * Listing Groups:: Gnus can list various subsets of the groups.
1014 * Sorting Groups:: Re-arrange the group order.
1015 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1016 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1017 * Exiting Gnus:: Stop reading news and get some work done.
1018 * Group Topics:: A folding group mode divided into topics.
1019 * Misc Group Stuff:: Other stuff that you can to do.
1023 @node Group Buffer Format
1024 @section Group Buffer Format
1027 * Group Line Specification:: Deciding how the group buffer is to look.
1028 * Group Modeline Specification:: The group buffer modeline.
1029 * Group Highlighting:: Having nice colors in the group buffer.
1033 @node Group Line Specification
1034 @subsection Group Line Specification
1035 @cindex group buffer format
1037 The default format of the group buffer is nice and dull, but you can
1038 make it as exciting and ugly as you feel like.
1040 Here's a couple of example group lines:
1043 25: news.announce.newusers
1044 * 0: alt.fan.andrea-dworkin
1049 You can see that there are 25 unread articles in
1050 @samp{news.announce.newusers}. There are no unread articles, but some
1051 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1052 asterisk at the beginning of the line?)
1054 @vindex gnus-group-line-format
1055 You can change that format to whatever you want by fiddling with the
1056 @code{gnus-group-line-format} variable. This variable works along the
1057 lines of a @code{format} specification, which is pretty much the same as
1058 a @code{printf} specifications, for those of you who use (feh!) C.
1059 @xref{Formatting Variables}.
1061 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1063 There should always be a colon on the line; the cursor always moves to
1064 the colon after performing an operation. Nothing else is required---not
1065 even the group name. All displayed text is just window dressing, and is
1066 never examined by Gnus. Gnus stores all real information it needs using
1069 (Note that if you make a really strange, wonderful, spreadsheet-like
1070 layout, everybody will believe you are hard at work with the accounting
1071 instead of wasting time reading news.)
1073 Here's a list of all available format characters:
1078 An asterisk if the group only has marked articles.
1081 Whether the group is subscribed.
1084 Level of subscribedness.
1087 Number of unread articles.
1090 Number of dormant articles.
1093 Number of ticked articles.
1096 Number of read articles.
1099 Estimated total number of articles. (This is really @var{max-number}
1100 minus @var{min-number} plus 1.)
1103 Number of unread, unticked, non-dormant articles.
1106 Number of ticked and dormant articles.
1115 Newsgroup description.
1118 @samp{m} if moderated.
1121 @samp{(m)} if moderated.
1130 A string that looks like @samp{<%s:%n>} if a foreign select method is
1134 Indentation based on the level of the topic (@pxref{Group Topics}).
1137 @vindex gnus-group-uncollapsed-levels
1138 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1139 variable says how many levels to leave at the end of the group name.
1140 The default is 1---this will mean that group names like
1141 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1144 @vindex gnus-new-mail-mark
1146 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1150 A string that says when you last read the group (@pxref{Group
1154 User defined specifier. The next character in the format string should
1155 be a letter. @sc{gnus} will call the function
1156 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1157 following @samp{%u}. The function will be passed a single dummy
1158 paratere as argument. The function should return a string, which will
1159 be inserted into the buffer just like information from any other
1164 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1165 if no info is available---for instance, if it is a non-activated foreign
1166 group, or a bogus native group.
1169 @node Group Modeline Specification
1170 @subsection Group Modeline Specification
1171 @cindex group modeline
1173 @vindex gnus-group-mode-line-format
1174 The mode line can be changed by setting
1175 @code{gnus-group-mode-line-format} (@pxref{Formatting Variables}). It
1176 doesn't understand that many format specifiers:
1180 The native news server.
1182 The native select method.
1186 @node Group Highlighting
1187 @subsection Group Highlighting
1188 @cindex highlighting
1189 @cindex group highlighting
1191 @vindex gnus-group-highlight
1192 Highlighting in the group buffer is controlled by the
1193 @code{gnus-group-highlight} variable. This is an alist with elements
1194 that look like @var{(form . face)}. If @var{form} evaluates to
1195 something non-@code{nil}, the @var{face} will be used on the line.
1197 Here's an example value for this variable that might look nice if the
1201 (setq gnus-group-highlight
1203 ,(custom-face-lookup "Red" nil nil t nil nil))
1204 ((and (< level 3) (zerop unread)) .
1205 ,(custom-face-lookup "SeaGreen" nil nil t nil nil))
1207 ,(custom-face-lookup "SpringGreen" nil nil t nil nil))
1209 ,(custom-face-lookup "SteelBlue" nil nil t nil nil))
1211 ,(custom-face-lookup "SkyBlue" nil nil t nil nil))))
1214 Variables that are dynamically bound when the forms are evaluated
1221 The number of unread articles in the group.
1225 Whether the group is a mail group.
1227 The level of the group.
1229 The score of the group.
1231 The number of ticked articles in the group.
1233 The total number of articles in the group. Or rather, MAX-NUMBER minus
1236 When using the topic minor mode, this variable is bound to the current
1237 topic being inserted.
1240 When the forms are @code{eval}ed, point is at the beginning of the line
1241 of the group in question, so you can use many of the normal Gnus
1242 functions for snarfing info on the group.
1244 @vindex gnus-group-update-hook
1245 @findex gnus-group-highlight-line
1246 @code{gnus-group-update-hook} is called when a group line is changed.
1247 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1248 calls @code{gnus-group-highlight-line} by default.
1251 @node Group Maneuvering
1252 @section Group Maneuvering
1253 @cindex group movement
1255 All movement commands understand the numeric prefix and will behave as
1256 expected, hopefully.
1262 @findex gnus-group-next-unread-group
1263 Go to the next group that has unread articles
1264 (@code{gnus-group-next-unread-group}).
1270 @findex gnus-group-prev-unread-group
1271 Go to the previous group that has unread articles
1272 (@code{gnus-group-prev-unread-group}).
1276 @findex gnus-group-next-group
1277 Go to the next group (@code{gnus-group-next-group}).
1281 @findex gnus-group-prev-group
1282 Go to the previous group (@code{gnus-group-prev-group}).
1286 @findex gnus-group-next-unread-group-same-level
1287 Go to the next unread group on the same (or lower) level
1288 (@code{gnus-group-next-unread-group-same-level}).
1292 @findex gnus-group-prev-unread-group-same-level
1293 Go to the previous unread group on the same (or lower) level
1294 (@code{gnus-group-prev-unread-group-same-level}).
1297 Three commands for jumping to groups:
1303 @findex gnus-group-jump-to-group
1304 Jump to a group (and make it visible if it isn't already)
1305 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
1310 @findex gnus-group-best-unread-group
1311 Jump to the unread group with the lowest level
1312 (@code{gnus-group-best-unread-group}).
1316 @findex gnus-group-first-unread-group
1317 Jump to the first group with unread articles
1318 (@code{gnus-group-first-unread-group}).
1321 @vindex gnus-group-goto-unread
1322 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1323 commands will move to the next group, not the next unread group. Even
1324 the commands that say they move to the next unread group. The default
1328 @node Selecting a Group
1329 @section Selecting a Group
1330 @cindex group selection
1335 @kindex SPACE (Group)
1336 @findex gnus-group-read-group
1337 Select the current group, switch to the summary buffer and display the
1338 first unread article (@code{gnus-group-read-group}). If there are no
1339 unread articles in the group, or if you give a non-numerical prefix to
1340 this command, Gnus will offer to fetch all the old articles in this
1341 group from the server. If you give a numerical prefix @var{N}, @var{N}
1342 determines the number of articles Gnus will fetch. If @var{N} is
1343 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1344 negative, Gnus fetches the @var{abs(N)} oldest articles.
1348 @findex gnus-group-select-group
1349 Select the current group and switch to the summary buffer
1350 (@code{gnus-group-select-group}). Takes the same arguments as
1351 @code{gnus-group-read-group}---the only difference is that this command
1352 does not display the first unread article automatically upon group
1356 @kindex M-RET (Group)
1357 @findex gnus-group-quick-select-group
1358 This does the same as the command above, but tries to do it with the
1359 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
1360 scoring/killing will be performed, there will be no highlights and no
1361 expunging. This might be useful if you're in a real hurry and have to
1362 enter some humongous group. If you give a 0 prefix to this command
1363 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer.
1364 This might be useful if you want to toggle threading before entering the
1368 @kindex M-SPACE (Group)
1369 @findex gnus-group-visible-select-group
1370 This is yet one more command that does the same as the @kbd{RET}
1371 command, but this one does it without expunging and hiding dormants
1372 (@code{gnus-group-visible-select-group}).
1375 @kindex M-C-RET (Group)
1376 @findex gnus-group-select-group-ephemerally
1377 Finally, this command selects the current group ephemerally without
1378 doing any processing of its contents
1379 (@code{gnus-group-select-group-ephemerally}). Even threading has been
1380 turned off. Everything you do in the group after selecting it in this
1381 manner will have no permanent effects.
1385 @vindex gnus-large-newsgroup
1386 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1387 to be a big group. This is 200 by default. If the group has more
1388 (unread and/or ticked) articles than this, Gnus will query the user
1389 before entering the group. The user can then specify how many articles
1390 should be fetched from the server. If the user specifies a negative
1391 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
1392 is positive, the @code{n} articles that have arrived most recently will
1395 @vindex gnus-select-group-hook
1396 @vindex gnus-auto-select-first
1397 @code{gnus-auto-select-first} control whether any articles are selected
1398 automatically when entering a group with the @kbd{SPACE} command.
1403 Don't select any articles when entering the group. Just display the
1404 full summary buffer.
1407 Select the first unread article when entering the group.
1410 Select the most high-scored article in the group when entering the
1414 If you want to prevent automatic selection in some group (say, in a
1415 binary group with Huge articles) you can set this variable to @code{nil}
1416 in @code{gnus-select-group-hook}, which is called when a group is
1420 @node Subscription Commands
1421 @section Subscription Commands
1422 @cindex subscription
1430 @findex gnus-group-unsubscribe-current-group
1431 Toggle subscription to the current group
1432 (@code{gnus-group-unsubscribe-current-group}).
1438 @findex gnus-group-unsubscribe-group
1439 Prompt for a group to subscribe, and then subscribe it. If it was
1440 subscribed already, unsubscribe it instead
1441 (@code{gnus-group-unsubscribe-group}).
1447 @findex gnus-group-kill-group
1448 Kill the current group (@code{gnus-group-kill-group}).
1454 @findex gnus-group-yank-group
1455 Yank the last killed group (@code{gnus-group-yank-group}).
1458 @kindex C-x C-t (Group)
1459 @findex gnus-group-transpose-groups
1460 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
1461 really a subscription command, but you can use it instead of a
1462 kill-and-yank sequence sometimes.
1468 @findex gnus-group-kill-region
1469 Kill all groups in the region (@code{gnus-group-kill-region}).
1473 @findex gnus-group-kill-all-zombies
1474 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1477 @kindex S C-k (Group)
1478 @findex gnus-group-kill-level
1479 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1480 These groups can't be yanked back after killing, so this command should
1481 be used with some caution. The only time where this command comes in
1482 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1483 groups that you want to get rid off. @kbd{S C-k} on level 7 will
1484 kill off all unsubscribed groups that do not have message numbers in the
1485 @file{.newsrc} file.
1489 Also @pxref{Group Levels}.
1499 @findex gnus-group-catchup-current
1500 @vindex gnus-group-catchup-group-hook
1501 Mark all unticked articles in this group as read
1502 (@code{gnus-group-catchup-current}).
1503 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1508 @findex gnus-group-catchup-current-all
1509 Mark all articles in this group, even the ticked ones, as read
1510 (@code{gnus-group-catchup-current-all}).
1514 @findex gnus-group-clear-data
1515 Clear the data from the current group---nix out marks and the list of
1516 read articles (@code{gnus-group-clear-data}).
1518 @item M-x gnus-group-clear-data-on-native-groups
1519 @kindex M-x gnus-group-clear-data-on-native-groups
1520 @findex gnus-group-clear-data-on-native-groups
1521 If you have switched from one @sc{nntp} server to another, all your marks
1522 and read ranges have become worthless. You can use this command to
1523 clear out all data that you have on your native groups. Use with
1530 @section Group Levels
1534 All groups have a level of @dfn{subscribedness}. For instance, if a
1535 group is on level 2, it is more subscribed than a group on level 5. You
1536 can ask Gnus to just list groups on a given level or lower
1537 (@pxref{Listing Groups}), or to just check for new articles in groups on
1538 a given level or lower (@pxref{Scanning New Messages}).
1540 Remember: The higher the level of the group, the less important it is.
1546 @findex gnus-group-set-current-level
1547 Set the level of the current group. If a numeric prefix is given, the
1548 next @var{n} groups will have their levels set. The user will be
1549 prompted for a level.
1552 @vindex gnus-level-killed
1553 @vindex gnus-level-zombie
1554 @vindex gnus-level-unsubscribed
1555 @vindex gnus-level-subscribed
1556 Gnus considers groups on between levels 1 and
1557 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1558 @code{gnus-level-subscribed} (exclusive) and
1559 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1560 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1561 (default 8) and @code{gnus-level-killed} to be killed (default 9),
1562 completely dead. Gnus treats subscribed and unsubscribed groups exactly
1563 the same, but zombie and killed groups have no information on what
1564 articles you have read, etc, stored. This distinction between dead and
1565 living groups isn't done because it is nice or clever, it is done purely
1566 for reasons of efficiency.
1568 It is recommended that you keep all your mail groups (if any) on quite
1569 low levels (e.g. 1 or 2).
1571 If you want to play with the level variables, you should show some care.
1572 Set them once, and don't touch them ever again. Better yet, don't touch
1573 them at all unless you know exactly what you're doing.
1575 @vindex gnus-level-default-unsubscribed
1576 @vindex gnus-level-default-subscribed
1577 Two closely related variables are @code{gnus-level-default-subscribed}
1578 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1579 which are the levels that new groups will be put on if they are
1580 (un)subscribed. These two variables should, of course, be inside the
1581 relevant legal ranges.
1583 @vindex gnus-keep-same-level
1584 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1585 will only move to groups that are of the same level (or lower). In
1586 particular, going from the last article in one group to the next group
1587 will go to the next group of the same level (or lower). This might be
1588 handy if you want to read the most important groups before you read the
1591 @vindex gnus-group-default-list-level
1592 All groups with a level less than or equal to
1593 @code{gnus-group-default-list-level} will be listed in the group buffer
1596 @vindex gnus-group-list-inactive-groups
1597 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1598 groups will be listed along with the unread groups. This variable is
1599 @code{t} by default. If it is @code{nil}, inactive groups won't be
1602 @vindex gnus-group-use-permanent-levels
1603 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1604 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1605 use this level as the ``work'' level.
1607 @vindex gnus-activate-level
1608 Gnus will normally just activate groups that are on level
1609 @code{gnus-activate-level} or less. If you don't want to activate
1610 unsubscribed groups, for instance, you might set this variable to
1611 5. The default is 6.
1615 @section Group Score
1618 You would normally keep important groups on high levels, but that scheme
1619 is somewhat restrictive. Don't you wish you could have Gnus sort the
1620 group buffer according to how often you read groups, perhaps? Within
1623 This is what @dfn{group score} is for. You can assign a score to each
1624 group. You can then sort the group buffer based on this score.
1625 Alternatively, you can sort on score and then level. (Taken together,
1626 the level and the score is called the @dfn{rank} of the group. A group
1627 that is on level 4 and has a score of 1 has a higher rank than a group
1628 on level 5 that has a score of 300. (The level is the most significant
1629 part and the score is the least significant part.))
1631 @findex gnus-summary-bubble-group
1632 If you want groups you read often to get higher scores than groups you
1633 read seldom you can add the @code{gnus-summary-bubble-group} function to
1634 the @code{gnus-summary-exit-hook} hook. This will result (after
1635 sorting) in a bubbling sort of action. If you want to see that in
1636 action after each summary exit, you can add
1637 @code{gnus-group-sort-groups-by-rank} or
1638 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1639 slow things down somewhat.
1642 @node Marking Groups
1643 @section Marking Groups
1644 @cindex marking groups
1646 If you want to perform some command on several groups, and they appear
1647 subsequently in the group buffer, you would normally just give a
1648 numerical prefix to the command. Most group commands will then do your
1649 bidding on those groups.
1651 However, if the groups are not in sequential order, you can still
1652 perform a command on several groups. You simply mark the groups first
1653 with the process mark and then execute the command.
1661 @findex gnus-group-mark-group
1662 Set the mark on the current group (@code{gnus-group-mark-group}).
1668 @findex gnus-group-unmark-group
1669 Remove the mark from the current group
1670 (@code{gnus-group-unmark-group}).
1674 @findex gnus-group-unmark-all-groups
1675 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1679 @findex gnus-group-mark-region
1680 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1684 @findex gnus-group-mark-buffer
1685 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1689 @findex gnus-group-mark-regexp
1690 Mark all groups that match some regular expression
1691 (@code{gnus-group-mark-regexp}).
1694 Also @pxref{Process/Prefix}.
1696 @findex gnus-group-universal-argument
1697 If you want to execute some command on all groups that have been marked
1698 with the process mark, you can use the @kbd{M-&}
1699 (@code{gnus-group-universal-argument}) command. It will prompt you for
1700 the command to be executed.
1703 @node Foreign Groups
1704 @section Foreign Groups
1705 @cindex foreign groups
1707 Below are some group mode commands for making and editing general foreign
1708 groups, as well as commands to ease the creation of a few
1709 special-purpose groups. All these commands insert the newly created
1710 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1717 @findex gnus-group-make-group
1718 @cindex making groups
1719 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
1720 for a name, a method and possibly an @dfn{address}. For an easier way
1721 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1725 @findex gnus-group-rename-group
1726 @cindex renaming groups
1727 Rename the current group to something else
1728 (@code{gnus-group-rename-group}). This is legal only on some
1729 groups---mail groups mostly. This command might very well be quite slow
1735 @findex gnus-group-customize
1736 Customize the group parameters (@code{gnus-group-customize}).
1740 @findex gnus-group-edit-group-method
1741 @cindex renaming groups
1742 Enter a buffer where you can edit the select method of the current
1743 group (@code{gnus-group-edit-group-method}).
1747 @findex gnus-group-edit-group-parameters
1748 Enter a buffer where you can edit the group parameters
1749 (@code{gnus-group-edit-group-parameters}).
1753 @findex gnus-group-edit-group
1754 Enter a buffer where you can edit the group info
1755 (@code{gnus-group-edit-group}).
1759 @findex gnus-group-make-directory-group
1761 Make a directory group (@pxref{Directory Groups}). You will be prompted
1762 for a directory name (@code{gnus-group-make-directory-group}).
1767 @findex gnus-group-make-help-group
1768 Make the Gnus help group (@code{gnus-group-make-help-group}).
1772 @cindex (ding) archive
1773 @cindex archive group
1774 @findex gnus-group-make-archive-group
1775 @vindex gnus-group-archive-directory
1776 @vindex gnus-group-recent-archive-directory
1777 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
1778 default a group pointing to the most recent articles will be created
1779 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1780 group will be created from @code{gnus-group-archive-directory}.
1784 @findex gnus-group-make-kiboze-group
1786 Make a kiboze group. You will be prompted for a name, for a regexp to
1787 match groups to be ``included'' in the kiboze group, and a series of
1788 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1789 @xref{Kibozed Groups}.
1793 @findex gnus-group-enter-directory
1795 Read an arbitrary directory as if with were a newsgroup with the
1796 @code{nneething} backend (@code{gnus-group-enter-directory}).
1797 @xref{Anything Groups}.
1801 @findex gnus-group-make-doc-group
1802 @cindex ClariNet Briefs
1804 Make a group based on some file or other
1805 (@code{gnus-group-make-doc-group}). If you give a prefix to this
1806 command, you will be prompted for a file name and a file type.
1807 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1808 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs}, and
1809 @code{forward}. If you run this command without a prefix, Gnus will
1810 guess at the file type. @xref{Document Groups}.
1814 @findex gnus-group-make-web-group
1819 Make an ephemeral group based on a web search
1820 (@code{gnus-group-make-web-group}). If you give a prefix to this
1821 command, make a solid group instead. You will be prompted for the
1822 search engine type and the search string. Legal search engine types
1823 include @code{dejanews}, @code{altavista} and @code{reference}.
1824 @xref{Web Searches}.
1827 @kindex G DEL (Group)
1828 @findex gnus-group-delete-group
1829 This function will delete the current group
1830 (@code{gnus-group-delete-group}). If given a prefix, this function will
1831 actually delete all the articles in the group, and forcibly remove the
1832 group itself from the face of the Earth. Use a prefix only if you are
1833 absolutely sure of what you are doing.
1837 @findex gnus-group-make-empty-virtual
1838 Make a new, fresh, empty @code{nnvirtual} group
1839 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
1843 @findex gnus-group-add-to-virtual
1844 Add the current group to an @code{nnvirtual} group
1845 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
1848 @xref{Select Methods} for more information on the various select
1851 @vindex gnus-activate-foreign-newsgroups
1852 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1853 Gnus will check all foreign groups with this level or lower at startup.
1854 This might take quite a while, especially if you subscribe to lots of
1855 groups from different @sc{nntp} servers.
1858 @node Group Parameters
1859 @section Group Parameters
1860 @cindex group parameters
1862 The group parameters store information local to a particular group:
1867 If the group parameter list contains an element that looks like
1868 @code{(to-address . "some@@where.com")}, that address will be used by
1869 the backend when doing followups and posts. This is primarily useful in
1870 mail groups that represent closed mailing lists---mailing lists where
1871 it's expected that everybody that writes to the mailing list is
1872 subscribed to it. Since using this parameter ensures that the mail only
1873 goes to the mailing list itself, it means that members won't receive two
1874 copies of your followups.
1876 Using @code{to-address} will actually work whether the group is foreign
1877 or not. Let's say there's a group on the server that is called
1878 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
1879 the articles from a mail-to-news gateway. Posting directly to this
1880 group is therefore impossible---you have to send mail to the mailing
1881 list address instead.
1885 If the group parameter list has an element that looks like
1886 @code{(to-list . "some@@where.com")}, that address will be used when
1887 doing a @kbd{a} in any group. It is totally ignored when doing a
1888 followup---except that if it is present in a news group, you'll get mail
1889 group semantics when doing @kbd{f}.
1891 @item broken-reply-to
1892 @cindex broken-reply-to
1893 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
1894 headers in this group are to be ignored. This can be useful if you're
1895 reading a mailing list group where the listserv has inserted
1896 @code{Reply-To} headers that point back to the listserv itself. This is
1897 broken behavior. So there!
1901 Elements like @code{(to-group . "some.group.name")} means that all
1902 posts in that group will be sent to @code{some.group.name}.
1906 If this symbol is present in the group parameter list, Gnus will treat
1907 all responses as if they were responses to news articles. This can be
1908 useful if you have a mail group that's really a mirror of a news group.
1912 If this symbol is present in the group parameter list and set to
1913 @code{t}, new composed messages will be @code{Gcc}'d to the current
1914 group. If it is present and set to @code{none}, no @code{Gcc:} header
1915 will be generated, if it is present and a string, this string will be
1916 inserted literally as a @code{gcc} header (this symbol takes precedence over
1917 any default @code{Gcc} rules as described later).
1921 If the group parameter has an element that looks like @code{(auto-expire
1922 . t)}, , all articles that are read will be marked as expirable. For an
1923 alternative approach, @pxref{Expiring Mail}.
1926 @cindex total-expire
1927 If the group parameter has an element that looks like
1928 @code{(total-expire . t)}, all read articles will be put through the
1929 expiry process, even if they are not marked as expirable. Use with
1934 @vindex nnmail-expiry-wait-function
1935 If the group parameter has an element that looks like @code{(expiry-wait
1936 . 10)}, this value will override any @code{nnmail-expiry-wait} and
1937 @code{nnmail-expiry-wait-function} when expiring expirable messages.
1938 The value can either be a number of days (not necessarily an integer) or
1939 the symbols @code{never} or @code{immediate}.
1942 @cindex score file group parameter
1943 Elements that look like @code{(score-file . "file")} will make
1944 @file{file} into the current score file for the group in question. This
1945 means that all score commands you issue will end up in that file.
1948 @cindex adapt file group parameter
1949 Elements that look like @code{(adapt-file . "file")} will make
1950 @file{file} into the current adaptive file for the group in question.
1951 All adaptive score entries will be put into this file.
1954 When unsubscribing to a mailing list you should never send the
1955 unsubscription notice to the mailing list itself. Instead, you'd send
1956 messages to the administrative address. This parameter allows you to
1957 put the admin address somewhere convenient.
1960 Elements that look like @code{(display . MODE)} says which articles to
1961 display on entering the group. Legal values are:
1965 Display all articles, both read and unread.
1968 Display the default visible articles, which normally includes unread and
1973 Elements that look like @code{(comment . "This is a comment")}
1974 are arbitrary comments on the group. They are currently ignored by
1975 Gnus, but provide a place for you to store information on particular
1978 @item @var{(variable form)}
1979 You can use the group parameters to set variables local to the group you
1980 are entering. If you want to turn threading off in @samp{news.answers},
1981 you could put @code{(gnus-show-threads nil)} in the group parameters of
1982 that group. @code{gnus-show-threads} will be made into a local variable
1983 in the summary buffer you enter, and the form @code{nil} will be
1984 @code{eval}ed there.
1986 This can also be used as a group-specific hook function, if you'd like.
1987 If you want to hear a beep when you enter a group, you could put
1988 something like @code{(dummy-variable (ding))} in the parameters of that
1989 group. @code{dummy-variable} will be set to the result of the
1990 @code{(ding)} form, but who cares?
1994 Use the @kbd{G p} command to edit group parameters of a group.
1996 Also @pxref{Topic Parameters}.
1999 @node Listing Groups
2000 @section Listing Groups
2001 @cindex group listing
2003 These commands all list various slices of the groups that are available.
2011 @findex gnus-group-list-groups
2012 List all groups that have unread articles
2013 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
2014 command will list only groups of level ARG and lower. By default, it
2015 only lists groups of level five (i. e.,
2016 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2023 @findex gnus-group-list-all-groups
2024 List all groups, whether they have unread articles or not
2025 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
2026 this command will list only groups of level ARG and lower. By default,
2027 it lists groups of level seven or lower (i.e., just subscribed and
2028 unsubscribed groups).
2032 @findex gnus-group-list-level
2033 List all unread groups on a specific level
2034 (@code{gnus-group-list-level}). If given a prefix, also list the groups
2035 with no unread articles.
2039 @findex gnus-group-list-killed
2040 List all killed groups (@code{gnus-group-list-killed}). If given a
2041 prefix argument, really list all groups that are available, but aren't
2042 currently (un)subscribed. This could entail reading the active file
2047 @findex gnus-group-list-zombies
2048 List all zombie groups (@code{gnus-group-list-zombies}).
2052 @findex gnus-group-list-matching
2053 List all unread, subscribed groups with names that match a regexp
2054 (@code{gnus-group-list-matching}).
2058 @findex gnus-group-list-all-matching
2059 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2063 @findex gnus-group-list-active
2064 List absolutely all groups that are in the active file(s) of the
2065 server(s) you are connected to (@code{gnus-group-list-active}). This
2066 might very well take quite a while. It might actually be a better idea
2067 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2068 thing to match on. Also note that this command may list group that
2069 don't exist (yet)---these will be listed as if they are killed groups.
2070 Take the output with some grains of salt.
2074 @findex gnus-group-apropos
2075 List all groups that have names that match a regexp
2076 (@code{gnus-group-apropos}).
2080 @findex gnus-group-description-apropos
2081 List all groups that have names or descriptions that match a regexp
2082 (@code{gnus-group-description-apropos}).
2086 @vindex gnus-permanently-visible-groups
2087 @cindex visible group parameter
2088 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2089 always be shown, whether they have unread articles or not. You can also
2090 add the @code{visible} element to the group parameters in question to
2091 get the same effect.
2093 @vindex gnus-list-groups-with-ticked-articles
2094 Groups that have just ticked articles in it are normally listed in the
2095 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
2096 @code{nil}, these groups will be treated just like totally empty
2097 groups. It is @code{t} by default.
2100 @node Sorting Groups
2101 @section Sorting Groups
2102 @cindex sorting groups
2104 @kindex C-c C-s (Group)
2105 @findex gnus-group-sort-groups
2106 @vindex gnus-group-sort-function
2107 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2108 group buffer according to the function(s) given by the
2109 @code{gnus-group-sort-function} variable. Available sorting functions
2114 @item gnus-group-sort-by-alphabet
2115 @findex gnus-group-sort-by-alphabet
2116 Sort the group names alphabetically. This is the default.
2118 @item gnus-group-sort-by-real-name
2119 @findex gnus-group-sort-by-real-name
2120 Sort the group alphabetically on the real (unprefixed) group names.
2122 @item gnus-group-sort-by-level
2123 @findex gnus-group-sort-by-level
2124 Sort by group level.
2126 @item gnus-group-sort-by-score
2127 @findex gnus-group-sort-by-score
2128 Sort by group score.
2130 @item gnus-group-sort-by-rank
2131 @findex gnus-group-sort-by-rank
2132 Sort by group score and then the group level. The level and the score
2133 are, when taken together, the group's @dfn{rank}.
2135 @item gnus-group-sort-by-unread
2136 @findex gnus-group-sort-by-unread
2137 Sort by number of unread articles.
2139 @item gnus-group-sort-by-method
2140 @findex gnus-group-sort-by-method
2141 Sort alphabetically on the select method.
2146 @code{gnus-group-sort-function} can also be a list of sorting
2147 functions. In that case, the most significant sort key function must be
2151 There are also a number of commands for sorting directly according to
2152 some sorting criteria:
2156 @kindex G S a (Group)
2157 @findex gnus-group-sort-groups-by-alphabet
2158 Sort the group buffer alphabetically by group name
2159 (@code{gnus-group-sort-groups-by-alphabet}).
2162 @kindex G S u (Group)
2163 @findex gnus-group-sort-groups-by-unread
2164 Sort the group buffer by the number of unread articles
2165 (@code{gnus-group-sort-groups-by-unread}).
2168 @kindex G S l (Group)
2169 @findex gnus-group-sort-groups-by-level
2170 Sort the group buffer by group level
2171 (@code{gnus-group-sort-groups-by-level}).
2174 @kindex G S v (Group)
2175 @findex gnus-group-sort-groups-by-score
2176 Sort the group buffer by group score
2177 (@code{gnus-group-sort-groups-by-score}).
2180 @kindex G S r (Group)
2181 @findex gnus-group-sort-groups-by-rank
2182 Sort the group buffer by group rank
2183 (@code{gnus-group-sort-groups-by-rank}).
2186 @kindex G S m (Group)
2187 @findex gnus-group-sort-groups-by-method
2188 Sort the group buffer alphabetically by backend name
2189 (@code{gnus-group-sort-groups-by-method}).
2193 When given a prefix, all these commands will sort in reverse order.
2195 You can also sort a subset of the groups:
2199 @kindex G P a (Group)
2200 @findex gnus-group-sort-selected-groups-by-alphabet
2201 Sort the process/prefixed groups in the group buffer alphabetically by
2202 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2205 @kindex G P u (Group)
2206 @findex gnus-group-sort-selected-groups-by-unread
2207 Sort the process/prefixed groups in the group buffer by the number of
2208 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2211 @kindex G P l (Group)
2212 @findex gnus-group-sort-selected-groups-by-level
2213 Sort the process/prefixed groups in the group buffer by group level
2214 (@code{gnus-group-sort-selected-groups-by-level}).
2217 @kindex G P v (Group)
2218 @findex gnus-group-sort-selected-groups-by-score
2219 Sort the process/prefixed groups in the group buffer by group score
2220 (@code{gnus-group-sort-selected-groups-by-score}).
2223 @kindex G P r (Group)
2224 @findex gnus-group-sort-selected-groups-by-rank
2225 Sort the process/prefixed groups in the group buffer by group rank
2226 (@code{gnus-group-sort-selected-groups-by-rank}).
2229 @kindex G P m (Group)
2230 @findex gnus-group-sort-selected-groups-by-method
2231 Sort the process/prefixed groups in the group buffer alphabetically by
2232 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2238 @node Group Maintenance
2239 @section Group Maintenance
2240 @cindex bogus groups
2245 @findex gnus-group-check-bogus-groups
2246 Find bogus groups and delete them
2247 (@code{gnus-group-check-bogus-groups}).
2251 @findex gnus-find-new-newsgroups
2252 Find new groups and process them (@code{gnus-find-new-newsgroups}). If
2253 given a prefix, use the @code{ask-server} method to query the server for
2257 @kindex C-c C-x (Group)
2258 @findex gnus-group-expire-articles
2259 Run all expirable articles in the current group through the expiry
2260 process (if any) (@code{gnus-group-expire-articles}).
2263 @kindex C-c M-C-x (Group)
2264 @findex gnus-group-expire-all-groups
2265 Run all articles in all groups through the expiry process
2266 (@code{gnus-group-expire-all-groups}).
2271 @node Browse Foreign Server
2272 @section Browse Foreign Server
2273 @cindex foreign servers
2274 @cindex browsing servers
2279 @findex gnus-group-browse-foreign-server
2280 You will be queried for a select method and a server name. Gnus will
2281 then attempt to contact this server and let you browse the groups there
2282 (@code{gnus-group-browse-foreign-server}).
2285 @findex gnus-browse-mode
2286 A new buffer with a list of available groups will appear. This buffer
2287 will be use the @code{gnus-browse-mode}. This buffer looks a bit (well,
2288 a lot) like a normal group buffer.
2290 Here's a list of keystrokes available in the browse mode:
2295 @findex gnus-group-next-group
2296 Go to the next group (@code{gnus-group-next-group}).
2300 @findex gnus-group-prev-group
2301 Go to the previous group (@code{gnus-group-prev-group}).
2304 @kindex SPACE (Browse)
2305 @findex gnus-browse-read-group
2306 Enter the current group and display the first article
2307 (@code{gnus-browse-read-group}).
2310 @kindex RET (Browse)
2311 @findex gnus-browse-select-group
2312 Enter the current group (@code{gnus-browse-select-group}).
2316 @findex gnus-browse-unsubscribe-current-group
2317 Unsubscribe to the current group, or, as will be the case here,
2318 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2324 @findex gnus-browse-exit
2325 Exit browse mode (@code{gnus-browse-exit}).
2329 @findex gnus-browse-describe-briefly
2330 Describe browse mode briefly (well, there's not much to describe, is
2331 there) (@code{gnus-browse-describe-briefly}).
2336 @section Exiting Gnus
2337 @cindex exiting Gnus
2339 Yes, Gnus is ex(c)iting.
2344 @findex gnus-group-suspend
2345 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
2346 but it kills all buffers except the Group buffer. I'm not sure why this
2347 is a gain, but then who am I to judge?
2351 @findex gnus-group-exit
2352 Quit Gnus (@code{gnus-group-exit}).
2356 @findex gnus-group-quit
2357 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2358 The dribble file will be saved, though (@pxref{Auto Save}).
2361 @vindex gnus-exit-gnus-hook
2362 @vindex gnus-suspend-gnus-hook
2363 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2364 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2365 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2370 If you wish to completely unload Gnus and all its adherents, you can use
2371 the @code{gnus-unload} command. This command is also very handy when
2372 trying to customize meta-variables.
2377 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2378 numbly heavy and herself fall into a hazy trance as the boy sitting
2379 behind her drew repeated lines with his pencil across the back of her
2385 @section Group Topics
2388 If you read lots and lots of groups, it might be convenient to group
2389 them hierarchically according to topics. You put your Emacs groups over
2390 here, your sex groups over there, and the rest (what, two groups or so?)
2391 you put in some misc section that you never bother with anyway. You can
2392 even group the Emacs sex groups as a sub-topic to either the Emacs
2393 groups or the sex groups---or both! Go wild!
2401 2: alt.religion.emacs
2404 0: comp.talk.emacs.recovery
2406 8: comp.binaries.fractals
2407 13: comp.sources.unix
2410 @findex gnus-topic-mode
2412 To get this @emph{fab} functionality you simply turn on (ooh!) the
2413 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
2414 is a toggling command.)
2416 Go ahead, just try it. I'll still be here when you get back. La de
2417 dum... Nice tune, that... la la la... What, you're back? Yes, and now
2418 press @kbd{l}. There. All your groups are now listed under
2419 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
2422 If you want this permanently enabled, you should add that minor mode to
2423 the hook for the group mode:
2426 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2430 * Topic Variables:: How to customize the topics the Lisp Way.
2431 * Topic Commands:: Interactive E-Z commands.
2432 * Topic Sorting:: Sorting each topic individually.
2433 * Topic Topology:: A map of the world.
2434 * Topic Parameters:: Parameters that apply to all groups in a topic.
2438 @node Topic Variables
2439 @subsection Topic Variables
2440 @cindex topic variables
2442 Now, if you select a topic, if will fold/unfold that topic, which is
2443 really neat, I think.
2445 @vindex gnus-topic-line-format
2446 The topic lines themselves are created according to the
2447 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2460 Number of groups in the topic.
2462 Number of unread articles in the topic.
2464 Number of unread articles in the topic and all its subtopics.
2467 @vindex gnus-topic-indent-level
2468 Each sub-topic (and the groups in the sub-topics) will be indented with
2469 @code{gnus-topic-indent-level} times the topic level number of spaces.
2472 @vindex gnus-topic-mode-hook
2473 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2475 @vindex gnus-topic-display-empty-topics
2476 The @code{gnus-topic-display-empty-topics} says whether to display even
2477 topics that have no unread articles in them. The default is @code{t}.
2480 @node Topic Commands
2481 @subsection Topic Commands
2482 @cindex topic commands
2484 When the topic minor mode is turned on, a new @kbd{T} submap will be
2485 available. In addition, a few of the standard keys change their
2486 definitions slightly.
2492 @findex gnus-topic-create-topic
2493 Prompt for a new topic name and create it
2494 (@code{gnus-topic-create-topic}).
2498 @findex gnus-topic-move-group
2499 Move the current group to some other topic
2500 (@code{gnus-topic-move-group}). This command uses the process/prefix
2501 convention (@pxref{Process/Prefix}).
2505 @findex gnus-topic-copy-group
2506 Copy the current group to some other topic
2507 (@code{gnus-topic-copy-group}). This command uses the process/prefix
2508 convention (@pxref{Process/Prefix}).
2512 @findex gnus-topic-remove-group
2513 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2514 This command uses the process/prefix convention
2515 (@pxref{Process/Prefix}).
2519 @findex gnus-topic-move-matching
2520 Move all groups that match some regular expression to a topic
2521 (@code{gnus-topic-move-matching}).
2525 @findex gnus-topic-copy-matching
2526 Copy all groups that match some regular expression to a topic
2527 (@code{gnus-topic-copy-matching}).
2531 @findex gnus-topic-mark-topic
2532 Mark all groups in the current topic with the process mark
2533 (@code{gnus-topic-mark-topic}).
2536 @kindex T M-# (Topic)
2537 @findex gnus-topic-unmark-topic
2538 Remove the process mark from all groups in the current topic
2539 (@code{gnus-topic-unmark-topic}).
2543 @findex gnus-topic-select-group
2545 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2546 When you perform this command on a group, you'll enter the group, as
2547 usual. When done on a topic line, the topic will be folded (if it was
2548 visible) or unfolded (if it was folded already). So it's basically a
2549 toggling command on topics. In addition, if you give a numerical
2550 prefix, group on that level (and lower) will be displayed.
2553 @kindex T TAB (Topic)
2554 @findex gnus-topic-indent
2555 ``Indent'' the current topic so that it becomes a sub-topic of the
2556 previous topic (@code{gnus-topic-indent}). If given a prefix,
2557 ``un-indent'' the topic instead.
2561 @findex gnus-topic-kill-group
2562 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
2563 topic will be removed along with the topic.
2567 @findex gnus-topic-yank-group
2568 Yank the previously killed group or topic
2569 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
2574 @findex gnus-topic-rename
2575 Rename a topic (@code{gnus-topic-rename}).
2578 @kindex T DEL (Topic)
2579 @findex gnus-topic-delete
2580 Delete an empty topic (@code{gnus-topic-delete}).
2584 @findex gnus-topic-list-active
2585 List all groups that Gnus knows about in a topics-ified way
2586 (@code{gnus-topic-list-active}).
2590 @findex gnus-topic-edit-parameters
2591 @cindex group parameters
2592 @cindex topic parameters
2594 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2595 @xref{Topic Parameters}.
2601 @subsection Topic Sorting
2602 @cindex topic sorting
2604 You can sort the groups in each topic individually with the following
2610 @kindex T S a (Topic)
2611 @findex gnus-topic-sort-groups-by-alphabet
2612 Sort the current topic alphabetically by group name
2613 (@code{gnus-topic-sort-groups-by-alphabet}).
2616 @kindex T S u (Topic)
2617 @findex gnus-topic-sort-groups-by-unread
2618 Sort the current topic by the number of unread articles
2619 (@code{gnus-topic-sort-groups-by-unread}).
2622 @kindex T S l (Topic)
2623 @findex gnus-topic-sort-groups-by-level
2624 Sort the current topic by group level
2625 (@code{gnus-topic-sort-groups-by-level}).
2628 @kindex T S v (Topic)
2629 @findex gnus-topic-sort-groups-by-score
2630 Sort the current topic by group score
2631 (@code{gnus-topic-sort-groups-by-score}).
2634 @kindex T S r (Topic)
2635 @findex gnus-topic-sort-groups-by-rank
2636 Sort the current topic by group rank
2637 (@code{gnus-topic-sort-groups-by-rank}).
2640 @kindex T S m (Topic)
2641 @findex gnus-topic-sort-groups-by-method
2642 Sort the current topic alphabetically by backend name
2643 (@code{gnus-topic-sort-groups-by-method}).
2647 @xref{Sorting Groups} for more information about group sorting.
2650 @node Topic Topology
2651 @subsection Topic Topology
2652 @cindex topic topology
2655 So, let's have a look at an example group buffer:
2661 2: alt.religion.emacs
2664 0: comp.talk.emacs.recovery
2666 8: comp.binaries.fractals
2667 13: comp.sources.unix
2670 So, here we have one top-level topic (@samp{Gnus}), two topics under
2671 that, and one sub-topic under one of the sub-topics. (There is always
2672 just one (1) top-level topic). This topology can be expressed as
2677 (("Emacs -- I wuw it!" visible)
2678 (("Naughty Emacs" visible)))
2682 @vindex gnus-topic-topology
2683 This is in fact how the variable @code{gnus-topic-topology} would look
2684 for the display above. That variable is saved in the @file{.newsrc.eld}
2685 file, and shouldn't be messed with manually---unless you really want
2686 to. Since this variable is read from the @file{.newsrc.eld} file,
2687 setting it in any other startup files will have no effect.
2689 This topology shows what topics are sub-topics of what topics (right),
2690 and which topics are visible. Two settings are currently
2691 allowed---@code{visible} and @code{invisible}.
2694 @node Topic Parameters
2695 @subsection Topic Parameters
2696 @cindex topic parameters
2698 All groups in a topic will inherit group parameters from the parent (and
2699 ancestor) topic parameters. All legal group parameters are legal topic
2700 parameters (@pxref{Group Parameters}).
2702 Group parameters (of course) override topic parameters, and topic
2703 parameters in sub-topics override topic parameters in super-topics. You
2704 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
2705 verb, although you may feel free to disagree with me here.)
2711 2: alt.religion.emacs
2715 0: comp.talk.emacs.recovery
2717 8: comp.binaries.fractals
2718 13: comp.sources.unix
2722 The @samp{Emacs} topic has the topic parameter @code{(score-file
2723 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2724 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2725 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
2726 @samp{alt.religion.emacs} has the group parameter @code{(score-file
2727 . "religion.SCORE")}.
2729 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2730 will get the @file{relief.SCORE} home score file. If you enter the same
2731 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2732 score file. If you enter the group @samp{alt.religion.emacs}, you'll
2733 get the @file{religion.SCORE} home score file.
2735 This seems rather simple and self-evident, doesn't it? Well, yes. But
2736 there are some problems, especially with the @code{total-expiry}
2737 parameter. Say you have a mail group in two topics; one with
2738 @code{total-expiry} and one without. What happens when you do @kbd{M-x
2739 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
2740 of these topics you mean to expire articles from, so anything may
2741 happen. In fact, I hereby declare that it is @dfn{undefined} what
2742 happens. You just have to be careful if you do stuff like that.
2745 @node Misc Group Stuff
2746 @section Misc Group Stuff
2749 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2750 * Group Information:: Information and help on groups and Gnus.
2751 * Group Timestamp:: Making Gnus keep track of when you last read a group.
2752 * File Commands:: Reading and writing the Gnus files.
2759 @findex gnus-group-enter-server-mode
2760 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2761 @xref{The Server Buffer}.
2765 @findex gnus-group-post-news
2766 Post an article to a group (@code{gnus-group-post-news}). The current
2767 group name will be used as the default.
2771 @findex gnus-group-mail
2772 Mail a message somewhere (@code{gnus-group-mail}).
2776 Variables for the group buffer:
2780 @item gnus-group-mode-hook
2781 @vindex gnus-group-mode-hook
2782 @code{gnus-group-mode-hook} is called after the group buffer has been
2785 @item gnus-group-prepare-hook
2786 @vindex gnus-group-prepare-hook
2787 @code{gnus-group-prepare-hook} is called after the group buffer is
2788 generated. It may be used to modify the buffer in some strange,
2791 @item gnus-permanently-visible-groups
2792 @vindex gnus-permanently-visible-groups
2793 Groups matching this regexp will always be listed in the group buffer,
2794 whether they are empty or not.
2799 @node Scanning New Messages
2800 @subsection Scanning New Messages
2801 @cindex new messages
2802 @cindex scanning new news
2808 @findex gnus-group-get-new-news
2809 Check the server(s) for new articles. If the numerical prefix is used,
2810 this command will check only groups of level @var{arg} and lower
2811 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
2812 command will force a total rereading of the active file(s) from the
2817 @findex gnus-group-get-new-news-this-group
2818 @vindex gnus-goto-next-group-when-activating
2819 Check whether new articles have arrived in the current group
2820 (@code{gnus-group-get-new-news-this-group}).
2821 @code{gnus-goto-next-group-when-activating} says whether this command is
2822 to move point to the next group or not. It is @code{t} by default.
2824 @findex gnus-activate-all-groups
2825 @cindex activating groups
2827 @kindex C-c M-g (Group)
2828 Activate absolutely all groups (@code{gnus-activate-all-groups}).
2833 @findex gnus-group-restart
2834 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
2835 file(s), closes the connection to all servers, clears up all run-time
2836 Gnus variables, and then starts Gnus all over again.
2840 @vindex gnus-get-new-news-hook
2841 @code{gnus-get-new-news-hook} is run just before checking for new news.
2843 @vindex gnus-after-getting-new-news-hook
2844 @code{gnus-after-getting-new-news-hook} is run after checking for new
2848 @node Group Information
2849 @subsection Group Information
2850 @cindex group information
2851 @cindex information on groups
2858 @findex gnus-group-fetch-faq
2859 @vindex gnus-group-faq-directory
2862 Try to fetch the FAQ for the current group
2863 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
2864 @code{gnus-group-faq-directory}, which is usually a directory on a
2865 remote machine. This variable can also be a list of directories. In
2866 that case, giving a prefix to this command will allow you to choose
2867 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
2868 for fetching the file.
2870 If fetching from the first site is unsuccessful, Gnus will attempt to go
2871 through @code{gnus-group-faq-directory} and try to open them one by one.
2876 @kindex C-c C-d (Group)
2877 @cindex describing groups
2878 @cindex group description
2879 @findex gnus-group-describe-group
2880 Describe the current group (@code{gnus-group-describe-group}). If given
2881 a prefix, force Gnus to re-read the description from the server.
2885 @findex gnus-group-describe-all-groups
2886 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
2887 prefix, force Gnus to re-read the description file from the server.
2892 @findex gnus-version
2893 Display current Gnus version numbers (@code{gnus-version}).
2897 @findex gnus-group-describe-briefly
2898 Give a very short help message (@code{gnus-group-describe-briefly}).
2901 @kindex C-c C-i (Group)
2904 @findex gnus-info-find-node
2905 Go to the Gnus info node (@code{gnus-info-find-node}).
2909 @node Group Timestamp
2910 @subsection Group Timestamp
2912 @cindex group timestamps
2914 It can be convenient to let Gnus keep track of when you last read a
2915 group. To set the ball rolling, you should add
2916 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
2919 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
2922 After doing this, each time you enter a group, it'll be recorded.
2924 This information can be displayed in various ways---the easiest is to
2925 use the @samp{%d} spec in the group line format:
2928 (setq gnus-group-line-format
2929 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
2932 This will result in lines looking like:
2935 * 0: mail.ding 19961002T012943
2936 0: custom 19961002T012713
2939 As you can see, the date is displayed in compact ISO 8601 format. This
2940 may be a bit too much, so to just display the date, you could say
2944 (setq gnus-group-line-format
2945 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
2950 @subsection File Commands
2951 @cindex file commands
2957 @findex gnus-group-read-init-file
2958 @vindex gnus-init-file
2959 @cindex reading init file
2960 Re-read the init file (@code{gnus-init-file}, which defaults to
2961 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
2965 @findex gnus-group-save-newsrc
2966 @cindex saving .newsrc
2967 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
2968 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
2969 file(s) whether Gnus thinks it is necessary or not.
2972 @c @kindex Z (Group)
2973 @c @findex gnus-group-clear-dribble
2974 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
2979 @node The Summary Buffer
2980 @chapter The Summary Buffer
2981 @cindex summary buffer
2983 A line for each article is displayed in the summary buffer. You can
2984 move around, read articles, post articles and reply to articles.
2986 The most common way to a summary buffer is to select a group from the
2987 group buffer (@pxref{Selecting a Group}).
2989 You can have as many summary buffers open as you wish.
2992 * Summary Buffer Format:: Deciding how the summary buffer is to look.
2993 * Summary Maneuvering:: Moving around the summary buffer.
2994 * Choosing Articles:: Reading articles.
2995 * Paging the Article:: Scrolling the current article.
2996 * Reply Followup and Post:: Posting articles.
2997 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
2998 * Marking Articles:: Marking articles as read, expirable, etc.
2999 * Limiting:: You can limit the summary buffer.
3000 * Threading:: How threads are made.
3001 * Sorting:: How articles and threads are sorted.
3002 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
3003 * Article Caching:: You may store articles in a cache.
3004 * Persistent Articles:: Making articles expiry-resistant.
3005 * Article Backlog:: Having already read articles hang around.
3006 * Saving Articles:: Ways of customizing article saving.
3007 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
3008 * Article Treatment:: The article buffer can be mangled at will.
3009 * Article Commands:: Doing various things with the article buffer.
3010 * Summary Sorting:: Sorting the summary buffer in various ways.
3011 * Finding the Parent:: No child support? Get the parent.
3012 * Alternative Approaches:: Reading using non-default summaries.
3013 * Tree Display:: A more visual display of threads.
3014 * Mail Group Commands:: Some commands can only be used in mail groups.
3015 * Various Summary Stuff:: What didn't fit anywhere else.
3016 * Exiting the Summary Buffer:: Returning to the Group buffer.
3017 * Crosspost Handling:: How crossposted articles are dealt with.
3018 * Duplicate Suppression:: An alternative when crosspost handling fails.
3022 @node Summary Buffer Format
3023 @section Summary Buffer Format
3024 @cindex summary buffer format
3027 * Summary Buffer Lines:: You can specify how summary lines should look.
3028 * Summary Buffer Mode Line:: You can say how the mode line should look.
3029 * Summary Highlighting:: Making the summary buffer all pretty and nice.
3032 @findex mail-extract-address-components
3033 @findex gnus-extract-address-components
3034 @vindex gnus-extract-address-components
3035 Gnus will use the value of the @code{gnus-extract-address-components}
3036 variable as a function for getting the name and address parts of a
3037 @code{From} header. Two pre-defined function exist:
3038 @code{gnus-extract-address-components}, which is the default, quite
3039 fast, and too simplistic solution; and
3040 @code{mail-extract-address-components}, which works very nicely, but is
3041 slower. The default function will return the wrong answer in 5% of the
3042 cases. If this is unacceptable to you, use the other function instead.
3044 @vindex gnus-summary-same-subject
3045 @code{gnus-summary-same-subject} is a string indicating that the current
3046 article has the same subject as the previous. This string will be used
3047 with those specs that require it. The default is @samp{}.
3050 @node Summary Buffer Lines
3051 @subsection Summary Buffer Lines
3053 @vindex gnus-summary-line-format
3054 You can change the format of the lines in the summary buffer by changing
3055 the @code{gnus-summary-line-format} variable. It works along the same
3056 lines a a normal @code{format} string, with some extensions
3057 (@pxref{Formatting Variables}).
3059 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3061 The following format specification characters are understood:
3069 Subject if the article is the root or the previous article had a
3070 different subject, @code{gnus-summary-same-subject} otherwise.
3071 (@code{gnus-summary-same-subject} defaults to @samp{}.)
3073 Full @code{From} header.
3075 The name (from the @code{From} header).
3077 The name (from the @code{From} header). This differs from the @code{n}
3078 spec in that it uses the function designated by the
3079 @code{gnus-extract-address-components} variable, which is slower, but
3080 may be more thorough.
3082 The address (from the @code{From} header). This works the same way as
3085 Number of lines in the article.
3087 Number of characters in the article.
3089 Indentation based on thread level (@pxref{Customizing Threading}).
3091 Nothing if the article is a root and lots of spaces if it isn't (it
3092 pushes everything after it off the screen).
3094 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3095 for adopted articles (@pxref{Customizing Threading}).
3097 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3098 for adopted articles.
3100 One space for each thread level.
3102 Twenty minus thread level spaces.
3110 @vindex gnus-summary-zcore-fuzz
3111 Zcore, @samp{+} if above the default level and @samp{-} if below the
3112 default level. If the difference between
3113 @code{gnus-summary-default-level} and the score is less than
3114 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3122 The @code{Date} in @code{DD-MMM} format.
3124 The @code{Date} in @code{YYYYMMDDTHHMMSS} format.
3130 Number of articles in the current sub-thread. Using this spec will slow
3131 down summary buffer generation somewhat.
3133 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3134 article has any children.
3138 User defined specifier. The next character in the format string should
3139 be a letter. @sc{gnus} will call the function
3140 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3141 following @samp{%u}. The function will be passed the current header as
3142 argument. The function should return a string, which will be inserted
3143 into the summary just like information from any other summary specifier.
3146 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3147 have to be handled with care. For reasons of efficiency, Gnus will
3148 compute what column these characters will end up in, and ``hard-code''
3149 that. This means that it is illegal to have these specs after a
3150 variable-length spec. Well, you might not be arrested, but your summary
3151 buffer will look strange, which is bad enough.
3153 The smart choice is to have these specs as far to the left as possible.
3154 (Isn't that the case with everything, though? But I digress.)
3156 This restriction may disappear in later versions of Gnus.
3159 @node Summary Buffer Mode Line
3160 @subsection Summary Buffer Mode Line
3162 @vindex gnus-summary-mode-line-format
3163 You can also change the format of the summary mode bar. Set
3164 @code{gnus-summary-mode-line-format} to whatever you like. The default
3165 is @samp{Gnus: %%b [%A] %Z}.
3167 Here are the elements you can play with:
3173 Unprefixed group name.
3175 Current article number.
3179 Number of unread articles in this group.
3181 Number of unselected articles in this group.
3183 A string with the number of unread and unselected articles represented
3184 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3185 articles, and just as @samp{<%U more>} if there are just unread articles
3186 and no unselected ones.
3188 Shortish group name. For instance, @samp{rec.arts.anime} will be
3189 shortened to @samp{r.a.anime}.
3191 Subject of the current article.
3195 Name of the current score file.
3197 Number of dormant articles.
3199 Number of ticked articles.
3201 Number of articles that have been marked as read in this session.
3203 Number of articles expunged by the score files.
3207 @node Summary Highlighting
3208 @subsection Summary Highlighting
3212 @item gnus-visual-mark-article-hook
3213 @vindex gnus-visual-mark-article-hook
3214 This hook is run after selecting an article. It is meant to be used for
3215 highlighting the article in some way. It is not run if
3216 @code{gnus-visual} is @code{nil}.
3218 @item gnus-summary-update-hook
3219 @vindex gnus-summary-update-hook
3220 This hook is called when a summary line is changed. It is not run if
3221 @code{gnus-visual} is @code{nil}.
3223 @item gnus-summary-selected-face
3224 @vindex gnus-summary-selected-face
3225 This is the face (or @dfn{font} as some people call it) that is used to
3226 highlight the current article in the summary buffer.
3228 @item gnus-summary-highlight
3229 @vindex gnus-summary-highlight
3230 Summary lines are highlighted according to this variable, which is a
3231 list where the elements are on the format @var{(FORM . FACE)}. If you
3232 would, for instance, like ticked articles to be italic and high-scored
3233 articles to be bold, you could set this variable to something like
3235 (((eq mark gnus-ticked-mark) . italic)
3236 ((> score default) . bold))
3238 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3239 @var{FACE} will be applied to the line.
3243 @node Summary Maneuvering
3244 @section Summary Maneuvering
3245 @cindex summary movement
3247 All the straight movement commands understand the numeric prefix and
3248 behave pretty much as you'd expect.
3250 None of these commands select articles.
3255 @kindex M-n (Summary)
3256 @kindex G M-n (Summary)
3257 @findex gnus-summary-next-unread-subject
3258 Go to the next summary line of an unread article
3259 (@code{gnus-summary-next-unread-subject}).
3263 @kindex M-p (Summary)
3264 @kindex G M-p (Summary)
3265 @findex gnus-summary-prev-unread-subject
3266 Go to the previous summary line of an unread article
3267 (@code{gnus-summary-prev-unread-subject}).
3272 @kindex G j (Summary)
3273 @findex gnus-summary-goto-article
3274 Ask for an article number and then go to that article
3275 (@code{gnus-summary-goto-article}).
3278 @kindex G g (Summary)
3279 @findex gnus-summary-goto-subject
3280 Ask for an article number and then go the summary line of that article
3281 without displaying the article (@code{gnus-summary-goto-subject}).
3284 If Gnus asks you to press a key to confirm going to the next group, you
3285 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3286 buffer, searching for the next group to read without actually returning
3287 to the group buffer.
3289 Variables related to summary movement:
3293 @vindex gnus-auto-select-next
3294 @item gnus-auto-select-next
3295 If you issue one of the movement commands (like @kbd{n}) and there are
3296 no more unread articles after the current one, Gnus will offer to go to
3297 the next group. If this variable is @code{t} and the next group is
3298 empty, Gnus will exit summary mode and return to the group buffer. If
3299 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3300 next group, no matter whether it has any unread articles or not. As a
3301 special case, if this variable is @code{quietly}, Gnus will select the
3302 next group without asking for confirmation. If this variable is
3303 @code{almost-quietly}, the same will happen only if you are located on
3304 the last article in the group. Finally, if this variable is
3305 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3306 without confirmation. Also @pxref{Group Levels}.
3308 @item gnus-auto-select-same
3309 @vindex gnus-auto-select-same
3310 If non-@code{nil}, all the movement commands will try to go to the next
3311 article with the same subject as the current. (@dfn{Same} here might
3312 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
3313 for details (@pxref{Customizing Threading}).) This variable is not
3314 particularly useful if you use a threaded display.
3316 @item gnus-summary-check-current
3317 @vindex gnus-summary-check-current
3318 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3319 to the next (or previous) article if the current article is unread.
3320 Instead, they will choose the current article.
3322 @item gnus-auto-center-summary
3323 @vindex gnus-auto-center-summary
3324 If non-@code{nil}, Gnus will keep the point in the summary buffer
3325 centered at all times. This makes things quite tidy, but if you have a
3326 slow network connection, or simply do not like this un-Emacsism, you can
3327 set this variable to @code{nil} to get the normal Emacs scrolling
3328 action. This will also inhibit horizontal re-centering of the summary
3329 buffer, which might make it more inconvenient to read extremely long
3335 @node Choosing Articles
3336 @section Choosing Articles
3337 @cindex selecting articles
3340 * Choosing Commands:: Commands for choosing articles.
3341 * Choosing Variables:: Variables that influence these commands.
3345 @node Choosing Commands
3346 @subsection Choosing Commands
3348 None of the following movement commands understand the numeric prefix,
3349 and they all select and display an article.
3353 @kindex SPACE (Summary)
3354 @findex gnus-summary-next-page
3355 Select the current article, or, if that one's read already, the next
3356 unread article (@code{gnus-summary-next-page}).
3361 @kindex G n (Summary)
3362 @findex gnus-summary-next-unread-article
3363 Go to next unread article (@code{gnus-summary-next-unread-article}).
3368 @findex gnus-summary-prev-unread-article
3369 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3374 @kindex G N (Summary)
3375 @findex gnus-summary-next-article
3376 Go to the next article (@code{gnus-summary-next-article}).
3381 @kindex G P (Summary)
3382 @findex gnus-summary-prev-article
3383 Go to the previous article (@code{gnus-summary-prev-article}).
3386 @kindex G C-n (Summary)
3387 @findex gnus-summary-next-same-subject
3388 Go to the next article with the same subject
3389 (@code{gnus-summary-next-same-subject}).
3392 @kindex G C-p (Summary)
3393 @findex gnus-summary-prev-same-subject
3394 Go to the previous article with the same subject
3395 (@code{gnus-summary-prev-same-subject}).
3399 @kindex G f (Summary)
3401 @findex gnus-summary-first-unread-article
3402 Go to the first unread article
3403 (@code{gnus-summary-first-unread-article}).
3407 @kindex G b (Summary)
3409 @findex gnus-summary-best-unread-article
3410 Go to the article with the highest score
3411 (@code{gnus-summary-best-unread-article}).
3416 @kindex G l (Summary)
3417 @findex gnus-summary-goto-last-article
3418 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3421 @kindex G p (Summary)
3422 @findex gnus-summary-pop-article
3423 Pop an article off the summary history and go to this article
3424 (@code{gnus-summary-pop-article}). This command differs from the
3425 command above in that you can pop as many previous articles off the
3426 history as you like.
3430 @node Choosing Variables
3431 @subsection Choosing Variables
3433 Some variables that are relevant for moving and selecting articles:
3436 @item gnus-auto-extend-newsgroup
3437 @vindex gnus-auto-extend-newsgroup
3438 All the movement commands will try to go to the previous (or next)
3439 article, even if that article isn't displayed in the Summary buffer if
3440 this variable is non-@code{nil}. Gnus will then fetch the article from
3441 the server and display it in the article buffer.
3443 @item gnus-select-article-hook
3444 @vindex gnus-select-article-hook
3445 This hook is called whenever an article is selected. By default it
3446 exposes any threads hidden under the selected article.
3448 @item gnus-mark-article-hook
3449 @vindex gnus-mark-article-hook
3450 @findex gnus-summary-mark-unread-as-read
3451 @findex gnus-summary-mark-read-and-unread-as-read
3452 @findex gnus-unread-mark
3453 This hook is called whenever an article is selected. It is intended to
3454 be used for marking articles as read. The default value is
3455 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3456 mark of almost any article you read to @code{gnus-unread-mark}. The
3457 only articles not affected by this function are ticked, dormant, and
3458 expirable articles. If you'd instead like to just have unread articles
3459 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3460 instead. It will leave marks like @code{gnus-low-score-mark},
3461 @code{gnus-del-mark} (and so on) alone.
3466 @node Paging the Article
3467 @section Scrolling the Article
3468 @cindex article scrolling
3473 @kindex SPACE (Summary)
3474 @findex gnus-summary-next-page
3475 Pressing @kbd{SPACE} will scroll the current article forward one page,
3476 or, if you have come to the end of the current article, will choose the
3477 next article (@code{gnus-summary-next-page}).
3480 @kindex DEL (Summary)
3481 @findex gnus-summary-prev-page
3482 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3485 @kindex RET (Summary)
3486 @findex gnus-summary-scroll-up
3487 Scroll the current article one line forward
3488 (@code{gnus-summary-scroll-up}).
3492 @kindex A g (Summary)
3494 @findex gnus-summary-show-article
3495 (Re)fetch the current article (@code{gnus-summary-show-article}). If
3496 given a prefix, fetch the current article, but don't run any of the
3497 article treatment functions. This will give you a ``raw'' article, just
3498 the way it came from the server.
3503 @kindex A < (Summary)
3504 @findex gnus-summary-beginning-of-article
3505 Scroll to the beginning of the article
3506 (@code{gnus-summary-beginning-of-article}).
3511 @kindex A > (Summary)
3512 @findex gnus-summary-end-of-article
3513 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3517 @kindex A s (Summary)
3519 @findex gnus-summary-isearch-article
3520 Perform an isearch in the article buffer
3521 (@code{gnus-summary-isearch-article}).
3526 @node Reply Followup and Post
3527 @section Reply, Followup and Post
3530 * Summary Mail Commands:: Sending mail.
3531 * Summary Post Commands:: Sending news.
3535 @node Summary Mail Commands
3536 @subsection Summary Mail Commands
3538 @cindex composing mail
3540 Commands for composing a mail message:
3546 @kindex S r (Summary)
3548 @findex gnus-summary-reply
3549 Mail a reply to the author of the current article
3550 (@code{gnus-summary-reply}).
3555 @kindex S R (Summary)
3556 @findex gnus-summary-reply-with-original
3557 Mail a reply to the author of the current article and include the
3558 original message (@code{gnus-summary-reply-with-original}). This
3559 command uses the process/prefix convention.
3562 @kindex S w (Summary)
3563 @findex gnus-summary-wide-reply
3564 Mail a wide reply to the author of the current article
3565 (@code{gnus-summary-wide-reply}).
3568 @kindex S W (Summary)
3569 @findex gnus-summary-wide-reply-with-original
3570 Mail a wide reply to the current article and include the original
3571 message (@code{gnus-summary-reply-with-original}). This command uses
3572 the process/prefix convention.
3575 @kindex S o m (Summary)
3576 @findex gnus-summary-mail-forward
3577 Forward the current article to some other person
3578 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
3579 headers of the forwarded article.
3584 @kindex S m (Summary)
3585 @findex gnus-summary-mail-other-window
3586 Send a mail to some other person
3587 (@code{gnus-summary-mail-other-window}).
3590 @kindex S D b (Summary)
3591 @findex gnus-summary-resend-bounced-mail
3592 @cindex bouncing mail
3593 If you have sent a mail, but the mail was bounced back to you for some
3594 reason (wrong address, transient failure), you can use this command to
3595 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
3596 will be popped into a mail buffer where you can edit the headers before
3597 sending the mail off again. If you give a prefix to this command, and
3598 the bounced mail is a reply to some other mail, Gnus will try to fetch
3599 that mail and display it for easy perusal of its headers. This might
3600 very well fail, though.
3603 @kindex S D r (Summary)
3604 @findex gnus-summary-resend-message
3605 Not to be confused with the previous command,
3606 @code{gnus-summary-resend-message} will prompt you for an address to
3607 send the current message off to, and then send it to that place. The
3608 headers of the message won't be altered---but lots of headers that say
3609 @code{Resent-To}, @code{Resent-From} and so on will be added. This
3610 means that you actually send a mail to someone that has a @code{To}
3611 header that (probably) points to yourself. This will confuse people.
3612 So, natcherly you'll only do that if you're really eVIl.
3614 This command is mainly used if you have several accounts and want to
3615 ship a mail to a different account of yours. (If you're both
3616 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3617 to the @code{root} account, you may want to resend it to
3618 @code{postmaster}. Ordnung muß sein!
3620 This command understands the process/prefix convention
3621 (@pxref{Process/Prefix}).
3624 @kindex S O m (Summary)
3625 @findex gnus-uu-digest-mail-forward
3626 Digest the current series and forward the result using mail
3627 (@code{gnus-uu-digest-mail-forward}). This command uses the
3628 process/prefix convention (@pxref{Process/Prefix}).
3631 @kindex S M-c (Summary)
3632 @findex gnus-summary-mail-crosspost-complaint
3633 @cindex crossposting
3634 @cindex excessive crossposting
3635 Send a complaint about excessive crossposting to the author of the
3636 current article (@code{gnus-summary-mail-crosspost-complaint}).
3638 @findex gnus-crosspost-complaint
3639 This command is provided as a way to fight back agains the current
3640 crossposting pandemic that's sweeping Usenet. It will compose a reply
3641 using the @code{gnus-crosspost-complaint} variable as a preamble. This
3642 command understands the process/prefix convention
3643 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3648 @node Summary Post Commands
3649 @subsection Summary Post Commands
3651 @cindex composing news
3653 Commands for posting a news article:
3659 @kindex S p (Summary)
3660 @findex gnus-summary-post-news
3661 Post an article to the current group
3662 (@code{gnus-summary-post-news}).
3667 @kindex S f (Summary)
3668 @findex gnus-summary-followup
3669 Post a followup to the current article (@code{gnus-summary-followup}).
3673 @kindex S F (Summary)
3675 @findex gnus-summary-followup-with-original
3676 Post a followup to the current article and include the original message
3677 (@code{gnus-summary-followup-with-original}). This command uses the
3678 process/prefix convention.
3681 @kindex S n (Summary)
3682 @findex gnus-summary-followup-to-mail
3683 Post a followup to the current article via news, even if you got the
3684 message through mail (@code{gnus-summary-followup-to-mail}).
3687 @kindex S n (Summary)
3688 @findex gnus-summary-followup-to-mail
3689 Post a followup to the current article via news, even if you got the
3690 message through mail and include the original message
3691 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
3692 the process/prefix convention.
3695 @kindex S o p (Summary)
3696 @findex gnus-summary-post-forward
3697 Forward the current article to a newsgroup
3698 (@code{gnus-summary-post-forward}). If given a prefix, include the full
3699 headers of the forwarded article.
3702 @kindex S O p (Summary)
3703 @findex gnus-uu-digest-post-forward
3704 Digest the current series and forward the result to a newsgroup
3705 (@code{gnus-uu-digest-mail-forward}).
3708 @kindex S u (Summary)
3709 @findex gnus-uu-post-news
3710 Uuencode a file, split it into parts, and post it as a series
3711 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
3715 @node Canceling and Superseding
3716 @section Canceling Articles
3717 @cindex canceling articles
3718 @cindex superseding articles
3720 Have you ever written something, and then decided that you really,
3721 really, really wish you hadn't posted that?
3723 Well, you can't cancel mail, but you can cancel posts.
3725 @findex gnus-summary-cancel-article
3727 Find the article you wish to cancel (you can only cancel your own
3728 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
3729 c} (@code{gnus-summary-cancel-article}). Your article will be
3730 canceled---machines all over the world will be deleting your article.
3732 Be aware, however, that not all sites honor cancels, so your article may
3733 live on here and there, while most sites will delete the article in
3736 If you discover that you have made some mistakes and want to do some
3737 corrections, you can post a @dfn{superseding} article that will replace
3738 your original article.
3740 @findex gnus-summary-supersede-article
3742 Go to the original article and press @kbd{S s}
3743 (@code{gnus-summary-supersede-article}). You will be put in a buffer
3744 where you can edit the article all you want before sending it off the
3747 The same goes for superseding as for canceling, only more so: Some
3748 sites do not honor superseding. On those sites, it will appear that you
3749 have posted almost the same article twice.
3751 If you have just posted the article, and change your mind right away,
3752 there is a trick you can use to cancel/supersede the article without
3753 waiting for the article to appear on your site first. You simply return
3754 to the post buffer (which is called @code{*sent ...*}). There you will
3755 find the article you just posted, with all the headers intact. Change
3756 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3757 header by substituting one of those words for the word
3758 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
3759 you would do normally. The previous article will be
3760 canceled/superseded.
3762 Just remember, kids: There is no 'c' in 'supersede'.
3765 @node Marking Articles
3766 @section Marking Articles
3767 @cindex article marking
3768 @cindex article ticking
3771 There are several marks you can set on an article.
3773 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3774 neologism ohoy!) of the article. Alphabetic marks generally mean
3775 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
3777 In addition, you also have marks that do not affect readedness.
3780 * Unread Articles:: Marks for unread articles.
3781 * Read Articles:: Marks for read articles.
3782 * Other Marks:: Marks that do not affect readedness.
3786 There's a plethora of commands for manipulating these marks:
3790 * Setting Marks:: How to set and remove marks.
3791 * Setting Process Marks:: How to mark articles for later processing.
3795 @node Unread Articles
3796 @subsection Unread Articles
3798 The following marks mark articles as (kinda) unread, in one form or
3803 @vindex gnus-ticked-mark
3804 Marked as ticked (@code{gnus-ticked-mark}).
3806 @dfn{Ticked articles} are articles that will remain visible always. If
3807 you see an article that you find interesting, or you want to put off
3808 reading it, or replying to it, until sometime later, you'd typically
3809 tick it. However, articles can be expired, so if you want to keep an
3810 article forever, you'll have to make it persistent (@pxref{Persistent
3814 @vindex gnus-dormant-mark
3815 Marked as dormant (@code{gnus-dormant-mark}).
3817 @dfn{Dormant articles} will only appear in the summary buffer if there
3818 are followups to it.
3821 @vindex gnus-unread-mark
3822 Markes as unread (@code{gnus-unread-mark}).
3824 @dfn{Unread articles} are articles that haven't been read at all yet.
3829 @subsection Read Articles
3830 @cindex expirable mark
3832 All the following marks mark articles as read.
3837 @vindex gnus-del-mark
3838 These are articles that the user has marked as read with the @kbd{d}
3839 command manually, more or less (@code{gnus-del-mark}).
3842 @vindex gnus-read-mark
3843 Articles that have actually been read (@code{gnus-read-mark}).
3846 @vindex gnus-ancient-mark
3847 Articles that were marked as read in previous sessions and are now
3848 @dfn{old} (@code{gnus-ancient-mark}).
3851 @vindex gnus-killed-mark
3852 Marked as killed (@code{gnus-killed-mark}).
3855 @vindex gnus-kill-file-mark
3856 Marked as killed by kill files (@code{gnus-kill-file-mark}).
3859 @vindex gnus-low-score-mark
3860 Marked as read by having a too low score (@code{gnus-low-score-mark}).
3863 @vindex gnus-catchup-mark
3864 Marked as read by a catchup (@code{gnus-catchup-mark}).
3867 @vindex gnus-canceled-mark
3868 Canceled article (@code{gnus-canceled-mark})
3871 @vindex gnus-souped-mark
3872 @sc{SOUP}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
3875 @vindex gnus-sparse-mark
3876 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
3880 @vindex gnus-duplicate-mark
3881 Article marked as read by duplicate suppression
3882 (@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}.
3886 All these marks just mean that the article is marked as read, really.
3887 They are interpreted differently when doing adaptive scoring, though.
3889 One more special mark, though:
3893 @vindex gnus-expirable-mark
3894 Marked as expirable (@code{gnus-expirable-mark}).
3896 Marking articles as @dfn{expirable} (or have them marked as such
3897 automatically) doesn't make much sense in normal groups---a user doesn't
3898 control the expiring of news articles, but in mail groups, for instance,
3899 articles that are marked as @dfn{expirable} can be deleted by Gnus at
3905 @subsection Other Marks
3906 @cindex process mark
3909 There are some marks that have nothing to do with whether the article is
3915 You can set a bookmark in the current article. Say you are reading a
3916 long thesis on cats' urinary tracts, and have to go home for dinner
3917 before you've finished reading the thesis. You can then set a bookmark
3918 in the article, and Gnus will jump to this bookmark the next time it
3919 encounters the article. @xref{Setting Marks}
3922 @vindex gnus-replied-mark
3923 All articles that you have replied to or made a followup to (i.e., have
3924 answered) will be marked with an @samp{A} in the second column
3925 (@code{gnus-replied-mark}).
3928 @vindex gnus-cached-mark
3929 Articles that are stored in the article cache will be marked with an
3930 @samp{*} in the second column (@code{gnus-cached-mark}).
3933 @vindex gnus-saved-mark
3934 Articles that are ``saved'' (in some manner or other; not necessarily
3935 religiously) are marked with an @samp{S} in the second column
3936 (@code{gnus-saved-mark}.
3939 @vindex gnus-not-empty-thread-mark
3940 @vindex gnus-empty-thread-mark
3941 It the @samp{%e} spec is used, the presence of threads or not will be
3942 marked with @code{gnus-not-empty-thread-mark} and
3943 @code{gnus-empty-thread-mark} in the third column, respectively.
3946 @vindex gnus-process-mark
3947 Finally we have the @dfn{process mark} (@code{gnus-process-mark}. A
3948 variety of commands react to the presence of the process mark. For
3949 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
3950 all articles that have been marked with the process mark. Articles
3951 marked with the process mark have a @samp{#} in the second column.
3955 You might have noticed that most of these ``non-readedness'' marks
3956 appear in the second column by default. So if you have a cached, saved,
3957 replied article that you have process-marked, what will that look like?
3959 Nothing much. The precedence rules go as follows: process -> cache ->
3960 replied -> saved. So if the article is in the cache and is replied,
3961 you'll only see the cache mark and not the replied mark.
3965 @subsection Setting Marks
3966 @cindex setting marks
3968 All the marking commands understand the numeric prefix.
3974 @kindex M t (Summary)
3975 @findex gnus-summary-tick-article-forward
3976 Tick the current article (@code{gnus-summary-tick-article-forward}).
3981 @kindex M ? (Summary)
3982 @findex gnus-summary-mark-as-dormant
3983 Mark the current article as dormant
3984 (@code{gnus-summary-mark-as-dormant}).
3988 @kindex M d (Summary)
3990 @findex gnus-summary-mark-as-read-forward
3991 Mark the current article as read
3992 (@code{gnus-summary-mark-as-read-forward}).
3996 @findex gnus-summary-mark-as-read-backward
3997 Mark the current article as read and move point to the previous line
3998 (@code{gnus-summary-mark-as-read-backward}).
4003 @kindex M k (Summary)
4004 @findex gnus-summary-kill-same-subject-and-select
4005 Mark all articles that have the same subject as the current one as read,
4006 and then select the next unread article
4007 (@code{gnus-summary-kill-same-subject-and-select}).
4011 @kindex M K (Summary)
4012 @kindex C-k (Summary)
4013 @findex gnus-summary-kill-same-subject
4014 Mark all articles that have the same subject as the current one as read
4015 (@code{gnus-summary-kill-same-subject}).
4018 @kindex M C (Summary)
4019 @findex gnus-summary-catchup
4020 Mark all unread articles as read (@code{gnus-summary-catchup}).
4023 @kindex M C-c (Summary)
4024 @findex gnus-summary-catchup-all
4025 Mark all articles in the group as read---even the ticked and dormant
4026 articles (@code{gnus-summary-catchup-all}).
4029 @kindex M H (Summary)
4030 @findex gnus-summary-catchup-to-here
4031 Catchup the current group to point
4032 (@code{gnus-summary-catchup-to-here}).
4035 @kindex C-w (Summary)
4036 @findex gnus-summary-mark-region-as-read
4037 Mark all articles between point and mark as read
4038 (@code{gnus-summary-mark-region-as-read}).
4041 @kindex M V k (Summary)
4042 @findex gnus-summary-kill-below
4043 Kill all articles with scores below the default score (or below the
4044 numeric prefix) (@code{gnus-summary-kill-below}).
4048 @kindex M c (Summary)
4049 @kindex M-u (Summary)
4050 @findex gnus-summary-clear-mark-forward
4051 Clear all readedness-marks from the current article
4052 (@code{gnus-summary-clear-mark-forward}).
4056 @kindex M e (Summary)
4058 @findex gnus-summary-mark-as-expirable
4059 Mark the current article as expirable
4060 (@code{gnus-summary-mark-as-expirable}).
4063 @kindex M b (Summary)
4064 @findex gnus-summary-set-bookmark
4065 Set a bookmark in the current article
4066 (@code{gnus-summary-set-bookmark}).
4069 @kindex M B (Summary)
4070 @findex gnus-summary-remove-bookmark
4071 Remove the bookmark from the current article
4072 (@code{gnus-summary-remove-bookmark}).
4075 @kindex M V c (Summary)
4076 @findex gnus-summary-clear-above
4077 Clear all marks from articles with scores over the default score (or
4078 over the numeric prefix) (@code{gnus-summary-clear-above}).
4081 @kindex M V u (Summary)
4082 @findex gnus-summary-tick-above
4083 Tick all articles with scores over the default score (or over the
4084 numeric prefix) (@code{gnus-summary-tick-above}).
4087 @kindex M V m (Summary)
4088 @findex gnus-summary-mark-above
4089 Prompt for a mark, and mark all articles with scores over the default
4090 score (or over the numeric prefix) with this mark
4091 (@code{gnus-summary-clear-above}).
4094 @vindex gnus-summary-goto-unread
4095 The @code{gnus-summary-goto-unread} variable controls what action should
4096 be taken after setting a mark. If non-@code{nil}, point will move to
4097 the next/previous unread article. If @code{nil}, point will just move
4098 one line up or down. As a special case, if this variable is
4099 @code{never}, all the marking commands as well as other commands (like
4100 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4101 The default is @code{t}.
4104 @node Setting Process Marks
4105 @subsection Setting Process Marks
4106 @cindex setting process marks
4113 @kindex M P p (Summary)
4114 @findex gnus-summary-mark-as-processable
4115 Mark the current article with the process mark
4116 (@code{gnus-summary-mark-as-processable}).
4117 @findex gnus-summary-unmark-as-processable
4121 @kindex M P u (Summary)
4122 @kindex M-# (Summary)
4123 Remove the process mark, if any, from the current article
4124 (@code{gnus-summary-unmark-as-processable}).
4127 @kindex M P U (Summary)
4128 @findex gnus-summary-unmark-all-processable
4129 Remove the process mark from all articles
4130 (@code{gnus-summary-unmark-all-processable}).
4133 @kindex M P i (Summary)
4134 @findex gnus-uu-invert-processable
4135 Invert the list of process marked articles
4136 (@code{gnus-uu-invert-processable}).
4139 @kindex M P R (Summary)
4140 @findex gnus-uu-mark-by-regexp
4141 Mark articles by a regular expression (@code{gnus-uu-mark-by-regexp}).
4144 @kindex M P r (Summary)
4145 @findex gnus-uu-mark-region
4146 Mark articles in region (@code{gnus-uu-mark-region}).
4149 @kindex M P t (Summary)
4150 @findex gnus-uu-mark-thread
4151 Mark all articles in the current (sub)thread
4152 (@code{gnus-uu-mark-thread}).
4155 @kindex M P T (Summary)
4156 @findex gnus-uu-unmark-thread
4157 Unmark all articles in the current (sub)thread
4158 (@code{gnus-uu-unmark-thread}).
4161 @kindex M P v (Summary)
4162 @findex gnus-uu-mark-over
4163 Mark all articles that have a score above the prefix argument
4164 (@code{gnus-uu-mark-over}).
4167 @kindex M P s (Summary)
4168 @findex gnus-uu-mark-series
4169 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4172 @kindex M P S (Summary)
4173 @findex gnus-uu-mark-sparse
4174 Mark all series that have already had some articles marked
4175 (@code{gnus-uu-mark-sparse}).
4178 @kindex M P a (Summary)
4179 @findex gnus-uu-mark-all
4180 Mark all articles in series order (@code{gnus-uu-mark-series}).
4183 @kindex M P b (Summary)
4184 @findex gnus-uu-mark-buffer
4185 Mark all articles in the buffer in the order they appear
4186 (@code{gnus-uu-mark-buffer}).
4189 @kindex M P k (Summary)
4190 @findex gnus-summary-kill-process-mark
4191 Push the current process mark set onto the stack and unmark all articles
4192 (@code{gnus-summary-kill-process-mark}).
4195 @kindex M P y (Summary)
4196 @findex gnus-summary-yank-process-mark
4197 Pop the previous process mark set from the stack and restore it
4198 (@code{gnus-summary-yank-process-mark}).
4201 @kindex M P w (Summary)
4202 @findex gnus-summary-save-process-mark
4203 Push the current process mark set onto the stack
4204 (@code{gnus-summary-save-process-mark}).
4213 It can be convenient to limit the summary buffer to just show some
4214 subset of the articles currently in the group. The effect most limit
4215 commands have is to remove a few (or many) articles from the summary
4222 @kindex / / (Summary)
4223 @findex gnus-summary-limit-to-subject
4224 Limit the summary buffer to articles that match some subject
4225 (@code{gnus-summary-limit-to-subject}).
4228 @kindex / a (Summary)
4229 @findex gnus-summary-limit-to-author
4230 Limit the summary buffer to articles that match some author
4231 (@code{gnus-summary-limit-to-author}).
4235 @kindex / u (Summary)
4237 @findex gnus-summary-limit-to-unread
4238 Limit the summary buffer to articles that are not marked as read
4239 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
4240 buffer to articles that are strictly unread. This means that ticked and
4241 dormant articles will also be excluded.
4244 @kindex / m (Summary)
4245 @findex gnus-summary-limit-to-marks
4246 Ask for a mark and then limit to all articles that have not been marked
4247 with that mark (@code{gnus-summary-limit-to-marks}).
4250 @kindex / t (Summary)
4251 @findex gnus-summary-limit-to-age
4252 Ask for a number and then limit the summary buffer to articles that are
4253 older than (or equal to) that number of days
4254 (@code{gnus-summary-limit-to-marks}). If given a prefix, limit to
4255 articles that are younger than that number of days.
4258 @kindex / n (Summary)
4259 @findex gnus-summary-limit-to-articles
4260 Limit the summary buffer to the current article
4261 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
4262 convention (@pxref{Process/Prefix}).
4265 @kindex / w (Summary)
4266 @findex gnus-summary-pop-limit
4267 Pop the previous limit off the stack and restore it
4268 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
4272 @kindex / v (Summary)
4273 @findex gnus-summary-limit-to-score
4274 Limit the summary buffer to articles that have a score at or above some
4275 score (@code{gnus-summary-limit-to-score}).
4279 @kindex M S (Summary)
4280 @kindex / E (Summary)
4281 @findex gnus-summary-limit-include-expunged
4282 Display all expunged articles
4283 (@code{gnus-summary-limit-include-expunged}).
4286 @kindex / D (Summary)
4287 @findex gnus-summary-limit-include-dormant
4288 Display all dormant articles (@code{gnus-summary-limit-include-dormant}).
4291 @kindex / d (Summary)
4292 @findex gnus-summary-limit-exclude-dormant
4293 Hide all dormant articles (@code{gnus-summary-limit-exclude-dormant}).
4296 @kindex / c (Summary)
4297 @findex gnus-summary-limit-exclude-childless-dormant
4298 Hide all dormant articles that have no children
4299 (@code{gnus-summary-limit-exclude-childless-dormant}).
4302 @kindex / C (Summary)
4303 @findex gnus-summary-limit-mark-excluded-as-read
4304 Mark all excluded unread articles as read
4305 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
4306 also mark excluded ticked and dormant articles as read.
4314 @cindex article threading
4316 Gnus threads articles by default. @dfn{To thread} is to put responses
4317 to articles directly after the articles they respond to---in a
4318 hierarchical fashion.
4321 * Customizing Threading:: Variables you can change to affect the threading.
4322 * Thread Commands:: Thread based commands in the summary buffer.
4326 @node Customizing Threading
4327 @subsection Customizing Threading
4328 @cindex customizing threading
4334 @item gnus-show-threads
4335 @vindex gnus-show-threads
4336 If this variable is @code{nil}, no threading will be done, and all of
4337 the rest of the variables here will have no effect. Turning threading
4338 off will speed group selection up a bit, but it is sure to make reading
4339 slower and more awkward.
4341 @item gnus-fetch-old-headers
4342 @vindex gnus-fetch-old-headers
4343 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4344 more old headers---headers to articles that are marked as read. If you
4345 would like to display as few summary lines as possible, but still
4346 connect as many loose threads as possible, you should set this variable
4347 to @code{some} or a number. If you set it to a number, no more than
4348 that number of extra old headers will be fetched. In either case,
4349 fetching old headers only works if the backend you are using carries
4350 overview files---this would normally be @code{nntp}, @code{nnspool} and
4351 @code{nnml}. Also remember that if the root of the thread has been
4352 expired by the server, there's not much Gnus can do about that.
4354 @item gnus-build-sparse-threads
4355 @vindex gnus-build-sparse-threads
4356 Fetching old headers can be slow. A low-rent similar effect can be
4357 gotten by setting this variable to @code{some}. Gnus will then look at
4358 the complete @code{References} headers of all articles and try to string
4359 articles that belong in the same thread together. This will leave
4360 @dfn{gaps} in the threading display where Gnus guesses that an article
4361 is missing from the thread. (These gaps appear like normal summary
4362 lines. If you select a gap, Gnus will try to fetch the article in
4363 question.) If this variable is @code{t}, Gnus will display all these
4364 ``gaps'' without regard for whether they are useful for completing the
4365 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
4366 off sparse leaf nodes that don't lead anywhere. This variable is
4367 @code{nil} by default.
4369 @item gnus-summary-gather-subject-limit
4370 @vindex gnus-summary-gather-subject-limit
4371 Loose threads are gathered by comparing subjects of articles. If this
4372 variable is @code{nil}, Gnus requires an exact match between the
4373 subjects of the loose threads before gathering them into one big
4374 super-thread. This might be too strict a requirement, what with the
4375 presence of stupid newsreaders that chop off long subjects lines. If
4376 you think so, set this variable to, say, 20 to require that only the
4377 first 20 characters of the subjects have to match. If you set this
4378 variable to a really low number, you'll find that Gnus will gather
4379 everything in sight into one thread, which isn't very helpful.
4381 @cindex fuzzy article gathering
4382 If you set this variable to the special value @code{fuzzy}, Gnus will
4383 use a fuzzy string comparison algorithm on the subjects.
4385 @item gnus-simplify-subject-fuzzy-regexp
4386 @vindex gnus-simplify-subject-fuzzy-regexp
4387 This can either be a regular expression or list of regular expressions
4388 that match strings that will be removed from subjects if fuzzy subject
4389 simplification is used.
4391 @item gnus-simplify-ignored-prefixes
4392 @vindex gnus-simplify-ignored-prefixes
4393 If you set @code{gnus-summary-gather-subject-limit} to something as low
4394 as 10, you might consider setting this variable to something sensible:
4396 @c Written by Michael Ernst <mernst@cs.rice.edu>
4398 (setq gnus-simplify-ignored-prefixes
4404 "wanted" "followup" "summary\\( of\\)?"
4405 "help" "query" "problem" "question"
4406 "answer" "reference" "announce"
4407 "How can I" "How to" "Comparison of"
4412 (mapconcat 'identity
4413 '("for" "for reference" "with" "about")
4415 "\\)?\\]?:?[ \t]*"))
4418 All words that match this regexp will be removed before comparing two
4421 @item gnus-summary-gather-exclude-subject
4422 @vindex gnus-summary-gather-exclude-subject
4423 Since loose thread gathering is done on subjects only, that might lead
4424 to many false hits, especially with certain common subjects like
4425 @samp{} and @samp{(none)}. To make the situation slightly better,
4426 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4427 what subjects should be excluded from the gathering process. The
4428 default is @samp{^ *$\\|^(none)$}.
4430 @item gnus-summary-thread-gathering-function
4431 @vindex gnus-summary-thread-gathering-function
4432 Gnus gathers threads by looking at @code{Subject} headers. This means
4433 that totally unrelated articles may end up in the same ``thread'', which
4434 is confusing. An alternate approach is to look at all the
4435 @code{Message-ID}s in all the @code{References} headers to find matches.
4436 This will ensure that no gathered threads ever includes unrelated
4437 articles, but it's also means that people who have posted with broken
4438 newsreaders won't be gathered properly. The choice is yours---plague or
4442 @item gnus-gather-threads-by-subject
4443 @findex gnus-gather-threads-by-subject
4444 This function is the default gathering function and looks at
4445 @code{Subject}s exclusively.
4447 @item gnus-gather-threads-by-references
4448 @findex gnus-gather-threads-by-references
4449 This function looks at @code{References} headers exclusively.
4452 If you want to test gathering by @code{References}, you could say
4456 (setq gnus-summary-thread-gathering-function
4457 'gnus-gather-threads-by-references)
4460 @item gnus-summary-make-false-root
4461 @vindex gnus-summary-make-false-root
4462 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4463 and create a dummy root at the top. (Wait a minute. Root at the top?
4464 Yup.) Loose subtrees occur when the real root has expired, or you've
4465 read or killed the root in a previous session.
4467 When there is no real root of a thread, Gnus will have to fudge
4468 something. This variable says what fudging method Gnus should use.
4469 There are four possible values:
4471 @cindex adopting articles
4476 Gnus will make the first of the orphaned articles the parent. This
4477 parent will adopt all the other articles. The adopted articles will be
4478 marked as such by pointy brackets (@samp{<>}) instead of the standard
4479 square brackets (@samp{[]}). This is the default method.
4482 @vindex gnus-summary-dummy-line-format
4483 Gnus will create a dummy summary line that will pretend to be the
4484 parent. This dummy line does not correspond to any real article, so
4485 selecting it will just select the first real article after the dummy
4486 article. @code{gnus-summary-dummy-line-format} is used to specify the
4487 format of the dummy roots. It accepts only one format spec: @samp{S},
4488 which is the subject of the article. @xref{Formatting Variables}.
4491 Gnus won't actually make any article the parent, but simply leave the
4492 subject field of all orphans except the first empty. (Actually, it will
4493 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4497 Don't make any article parent at all. Just gather the threads and
4498 display them after one another.
4501 Don't gather loose threads.
4504 @item gnus-thread-hide-subtree
4505 @vindex gnus-thread-hide-subtree
4506 If non-@code{nil}, all threads will be hidden when the summary buffer is
4509 @item gnus-thread-expunge-below
4510 @vindex gnus-thread-expunge-below
4511 All threads that have a total score (as defined by
4512 @code{gnus-thread-score-function}) less than this number will be
4513 expunged. This variable is @code{nil} by default, which means that no
4514 threads are expunged.
4516 @item gnus-thread-hide-killed
4517 @vindex gnus-thread-hide-killed
4518 if you kill a thread and this variable is non-@code{nil}, the subtree
4521 @item gnus-thread-ignore-subject
4522 @vindex gnus-thread-ignore-subject
4523 Sometimes somebody changes the subject in the middle of a thread. If
4524 this variable is non-@code{nil}, the subject change is ignored. If it
4525 is @code{nil}, which is the default, a change in the subject will result
4528 @item gnus-thread-indent-level
4529 @vindex gnus-thread-indent-level
4530 This is a number that says how much each sub-thread should be indented.
4533 @item gnus-parse-headers-hook
4534 @vindex gnus-parse-headers-hook
4535 Hook run before parsing any headers. The default value is
4536 @code{(gnus-decode-rfc1522)}, which means that QPized headers will be
4537 slightly decoded in a hackish way. This is likely to change in the
4538 future when Gnus becomes @sc{MIME}ified.
4543 @node Thread Commands
4544 @subsection Thread Commands
4545 @cindex thread commands
4551 @kindex T k (Summary)
4552 @kindex M-C-k (Summary)
4553 @findex gnus-summary-kill-thread
4554 Mark all articles in the current (sub-)thread as read
4555 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
4556 remove all marks instead. If the prefix argument is negative, tick
4561 @kindex T l (Summary)
4562 @kindex M-C-l (Summary)
4563 @findex gnus-summary-lower-thread
4564 Lower the score of the current (sub-)thread
4565 (@code{gnus-summary-lower-thread}).
4568 @kindex T i (Summary)
4569 @findex gnus-summary-raise-thread
4570 Increase the score of the current (sub-)thread
4571 (@code{gnus-summary-raise-thread}).
4574 @kindex T # (Summary)
4575 @findex gnus-uu-mark-thread
4576 Set the process mark on the current (sub-)thread
4577 (@code{gnus-uu-mark-thread}).
4580 @kindex T M-# (Summary)
4581 @findex gnus-uu-unmark-thread
4582 Remove the process mark from the current (sub-)thread
4583 (@code{gnus-uu-unmark-thread}).
4586 @kindex T T (Summary)
4587 @findex gnus-summary-toggle-threads
4588 Toggle threading (@code{gnus-summary-toggle-threads}).
4591 @kindex T s (Summary)
4592 @findex gnus-summary-show-thread
4593 Expose the (sub-)thread hidden under the current article, if any
4594 (@code{gnus-summary-show-thread}).
4597 @kindex T h (Summary)
4598 @findex gnus-summary-hide-thread
4599 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
4602 @kindex T S (Summary)
4603 @findex gnus-summary-show-all-threads
4604 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
4607 @kindex T H (Summary)
4608 @findex gnus-summary-hide-all-threads
4609 Hide all threads (@code{gnus-summary-hide-all-threads}).
4612 @kindex T t (Summary)
4613 @findex gnus-summary-rethread-current
4614 Re-thread the thread the current article is part of
4615 (@code{gnus-summary-rethread-current}). This works even when the
4616 summary buffer is otherwise unthreaded.
4619 @kindex T ^ (Summary)
4620 @findex gnus-summary-reparent-thread
4621 Make the current article the child of the marked (or previous) article
4622 (@code{gnus-summary-reparent-thread}.
4626 The following commands are thread movement commands. They all
4627 understand the numeric prefix.
4632 @kindex T n (Summary)
4633 @findex gnus-summary-next-thread
4634 Go to the next thread (@code{gnus-summary-next-thread}).
4637 @kindex T p (Summary)
4638 @findex gnus-summary-prev-thread
4639 Go to the previous thread (@code{gnus-summary-prev-thread}).
4642 @kindex T d (Summary)
4643 @findex gnus-summary-down-thread
4644 Descend the thread (@code{gnus-summary-down-thread}).
4647 @kindex T u (Summary)
4648 @findex gnus-summary-up-thread
4649 Ascend the thread (@code{gnus-summary-up-thread}).
4652 @kindex T o (Summary)
4653 @findex gnus-summary-top-thread
4654 Go to the top of the thread (@code{gnus-summary-top-thread}).
4657 @vindex gnus-thread-operation-ignore-subject
4658 If you ignore subject while threading, you'll naturally end up with
4659 threads that have several different subjects in them. If you then issue
4660 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
4661 wish to kill the entire thread, but just those parts of the thread that
4662 have the same subject as the current article. If you like this idea,
4663 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If is
4664 is non-@code{nil} (which it is by default), subjects will be ignored
4665 when doing thread commands. If this variable is @code{nil}, articles in
4666 the same thread with different subjects will not be included in the
4667 operation in question. If this variable is @code{fuzzy}, only articles
4668 that have subjects that are fuzzily equal will be included.
4674 @findex gnus-thread-sort-by-total-score
4675 @findex gnus-thread-sort-by-date
4676 @findex gnus-thread-sort-by-score
4677 @findex gnus-thread-sort-by-subject
4678 @findex gnus-thread-sort-by-author
4679 @findex gnus-thread-sort-by-number
4680 @vindex gnus-thread-sort-functions
4681 If you are using a threaded summary display, you can sort the threads by
4682 setting @code{gnus-thread-sort-functions}, which is a list of functions.
4683 By default, sorting is done on article numbers. Ready-made sorting
4684 predicate functions include @code{gnus-thread-sort-by-number},
4685 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
4686 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
4687 @code{gnus-thread-sort-by-total-score}.
4689 Each function takes two threads and return non-@code{nil} if the first
4690 thread should be sorted before the other. Note that sorting really is
4691 normally done by looking only at the roots of each thread. If you use
4692 more than one function, the primary sort key should be the last function
4693 in the list. You should probably always include
4694 @code{gnus-thread-sort-by-number} in the list of sorting
4695 functions---preferably first. This will ensure that threads that are
4696 equal with respect to the other sort criteria will be displayed in
4697 ascending article order.
4699 If you would like to sort by score, then by subject, and finally by
4700 number, you could do something like:
4703 (setq gnus-thread-sort-functions
4704 '(gnus-thread-sort-by-number
4705 gnus-thread-sort-by-subject
4706 gnus-thread-sort-by-score))
4709 The threads that have highest score will be displayed first in the
4710 summary buffer. When threads have the same score, they will be sorted
4711 alphabetically. The threads that have the same score and the same
4712 subject will be sorted by number, which is (normally) the sequence in
4713 which the articles arrived.
4715 If you want to sort by score and then reverse arrival order, you could
4719 (setq gnus-thread-sort-functions
4721 (not (gnus-thread-sort-by-number t1 t2)))
4722 gnus-thread-sort-by-score))
4725 @vindex gnus-thread-score-function
4726 The function in the @code{gnus-thread-score-function} variable (default
4727 @code{+}) is used for calculating the total score of a thread. Useful
4728 functions might be @code{max}, @code{min}, or squared means, or whatever
4731 @findex gnus-article-sort-functions
4732 @findex gnus-article-sort-by-date
4733 @findex gnus-article-sort-by-score
4734 @findex gnus-article-sort-by-subject
4735 @findex gnus-article-sort-by-author
4736 @findex gnus-article-sort-by-number
4737 If you are using an unthreaded display for some strange reason or other,
4738 you have to fiddle with the @code{gnus-article-sort-functions} variable.
4739 It is very similar to the @code{gnus-thread-sort-functions}, except that
4740 is uses slightly different functions for article comparison. Available
4741 sorting predicate functions are @code{gnus-article-sort-by-number},
4742 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
4743 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
4745 If you want to sort an unthreaded summary display by subject, you could
4749 (setq gnus-article-sort-functions
4750 '(gnus-article-sort-by-number
4751 gnus-article-sort-by-subject))
4756 @node Asynchronous Fetching
4757 @section Asynchronous Article Fetching
4758 @cindex asynchronous article fetching
4759 @cindex article pre-fetch
4762 If you read your news from an @sc{nntp} server that's far away, the
4763 network latencies may make reading articles a chore. You have to wait
4764 for a while after pressing @kbd{n} to go to the next article before the
4765 article appears. Why can't Gnus just go ahead and fetch the article
4766 while you are reading the previous one? Why not, indeed.
4768 First, some caveats. There are some pitfalls to using asynchronous
4769 article fetching, especially the way Gnus does it.
4771 Let's say you are reading article 1, which is short, and article 2 is
4772 quite long, and you are not interested in reading that. Gnus does not
4773 know this, so it goes ahead and fetches article 2. You decide to read
4774 article 3, but since Gnus is in the process of fetching article 2, the
4775 connection is blocked.
4777 To avoid these situations, Gnus will open two (count 'em two)
4778 connections to the server. Some people may think this isn't a very nice
4779 thing to do, but I don't see any real alternatives. Setting up that
4780 extra connection takes some time, so Gnus startup will be slower.
4782 Gnus will fetch more articles than you will read. This will mean that
4783 the link between your machine and the @sc{nntp} server will become more
4784 loaded than if you didn't use article pre-fetch. The server itself will
4785 also become more loaded---both with the extra article requests, and the
4788 Ok, so now you know that you shouldn't really use this thing... unless
4791 @vindex gnus-asynchronous
4792 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
4793 happen automatically.
4795 @vindex gnus-use-article-prefetch
4796 You can control how many articles that are to be pre-fetched by setting
4797 @code{gnus-use-article-prefetch}. This is 30 by default, which means
4798 that when you read an article in the group, the backend will pre-fetch
4799 the next 30 articles. If this variable is @code{t}, the backend will
4800 pre-fetch all the articles that it can without bound. If it is
4801 @code{nil}, no pre-fetching will be made.
4803 @vindex gnus-async-prefetch-article-p
4804 @findex gnus-async-read-p
4805 There are probably some articles that you don't want to pre-fetch---read
4806 articles, for instance. Which articles to pre-fetch is controlled by
4807 the @code{gnus-async-prefetch-article-p} variable. This function should
4808 return non-@code{nil} when the article in question is to be
4809 pre-fetched. The default is @code{gnus-async-read-p}, which returns
4810 @code{nil} on read articles. The function is called with an article
4811 data structure as the only parameter.
4813 If, for instance, you wish to pre-fetch only unread articles that are
4814 shorter than 100 lines, you could say something like:
4817 (defun my-async-short-unread-p (data)
4818 "Return non-nil for short, unread articles."
4819 (and (gnus-data-unread-p data)
4820 (< (mail-header-lines (gnus-data-header data))
4823 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
4826 These functions will be called many, many times, so they should
4827 preferrably be short and sweet to avoid slowing down Gnus too much.
4828 It's also probably a good idea to byte-compile things like this.
4830 @vindex gnus-prefetched-article-deletion-strategy
4831 Articles have to be removed from the asynch buffer sooner or later. The
4832 @code{gnus-prefetched-article-deletion-strategy} says when to remove
4833 articles. This is a list that may contain the following elements:
4837 Remove articles when they are read.
4840 Remove articles when exiting the group.
4843 The default value is @code{(read exit)}.
4845 @vindex gnus-use-header-prefetch
4846 If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
4847 from the next group.
4850 @node Article Caching
4851 @section Article Caching
4852 @cindex article caching
4855 If you have an @emph{extremely} slow @sc{nntp} connection, you may
4856 consider turning article caching on. Each article will then be stored
4857 locally under your home directory. As you may surmise, this could
4858 potentially use @emph{huge} amounts of disk space, as well as eat up all
4859 your inodes so fast it will make your head swim. In vodka.
4861 Used carefully, though, it could be just an easier way to save articles.
4863 @vindex gnus-use-long-file-name
4864 @vindex gnus-cache-directory
4865 @vindex gnus-use-cache
4866 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
4867 all articles that are ticked or marked as dormant will then be copied
4868 over to your local cache (@code{gnus-cache-directory}). Whether this
4869 cache is flat or hierarchal is controlled by the
4870 @code{gnus-use-long-file-name} variable, as usual.
4872 When re-select a ticked or dormant article, it will be fetched from the
4873 cache instead of from the server. As articles in your cache will never
4874 expire, this might serve as a method of saving articles while still
4875 keeping them where they belong. Just mark all articles you want to save
4876 as dormant, and don't worry.
4878 When an article is marked as read, is it removed from the cache.
4880 @vindex gnus-cache-remove-articles
4881 @vindex gnus-cache-enter-articles
4882 The entering/removal of articles from the cache is controlled by the
4883 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
4884 variables. Both are lists of symbols. The first is @code{(ticked
4885 dormant)} by default, meaning that ticked and dormant articles will be
4886 put in the cache. The latter is @code{(read)} by default, meaning that
4887 articles that are marked as read are removed from the cache. Possibly
4888 symbols in these two lists are @code{ticked}, @code{dormant},
4889 @code{unread} and @code{read}.
4891 @findex gnus-jog-cache
4892 So where does the massive article-fetching and storing come into the
4893 picture? The @code{gnus-jog-cache} command will go through all
4894 subscribed newsgroups, request all unread articles, and store them in
4895 the cache. You should only ever, ever ever ever, use this command if 1)
4896 your connection to the @sc{nntp} server is really, really, really slow
4897 and 2) you have a really, really, really huge disk. Seriously.
4899 @vindex gnus-uncacheable-groups
4900 It is likely that you do not want caching on some groups. For instance,
4901 if your @code{nnml} mail is located under your home directory, it makes no
4902 sense to cache it somewhere else under your home directory. Unless you
4903 feel that it's neat to use twice as much space. To limit the caching,
4904 you could set the @code{gnus-uncacheable-groups} regexp to
4905 @samp{^nnml}, for instance. This variable is @code{nil} by
4908 @findex gnus-cache-generate-nov-databases
4909 @findex gnus-cache-generate-active
4910 @vindex gnus-cache-active-file
4911 The cache stores information on what articles it contains in its active
4912 file (@code{gnus-cache-active-file}). If this file (or any other parts
4913 of the cache) becomes all messed up for some reason or other, Gnus
4914 offers two functions that will try to set things right. @kbd{M-x
4915 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
4916 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
4920 @node Persistent Articles
4921 @section Persistent Articles
4922 @cindex persistent articles
4924 Closely related to article caching, we have @dfn{persistent articles}.
4925 In fact, it's just a different way of looking at caching, and much more
4926 useful in my opinion.
4928 Say you're reading a newsgroup, and you happen on to some valuable gem
4929 that you want to keep and treasure forever. You'd normally just save it
4930 (using one of the many saving commands) in some file. The problem with
4931 that is that it's just, well, yucky. Ideally you'd prefer just having
4932 the article remain in the group where you found it forever; untouched by
4933 the expiry going on at the news server.
4935 This is what a @dfn{persistent article} is---an article that just won't
4936 be deleted. It's implemented using the normal cache functions, but
4937 you use two explicit commands for managing persistent articles:
4943 @findex gnus-cache-enter-article
4944 Make the current article persistent (@code{gnus-cache-enter-article}).
4947 @kindex M-* (Summary)
4948 @findex gnus-cache-remove-article
4949 Remove the current article from the persistent articles
4950 (@code{gnus-cache-remove-article}). This will normally delete the
4954 Both these commands understand the process/prefix convention.
4956 To avoid having all ticked articles (and stuff) entered into the cache,
4957 you should set @code{gnus-use-cache} to @code{passive} if you're just
4958 interested in persistent articles:
4961 (setq gnus-use-cache 'passive)
4965 @node Article Backlog
4966 @section Article Backlog
4968 @cindex article backlog
4970 If you have a slow connection, but the idea of using caching seems
4971 unappealing to you (and it is, really), you can help the situation some
4972 by switching on the @dfn{backlog}. This is where Gnus will buffer
4973 already read articles so that it doesn't have to re-fetch articles
4974 you've already read. This only helps if you are in the habit of
4975 re-selecting articles you've recently read, of course. If you never do
4976 that, turning the backlog on will slow Gnus down a little bit, and
4977 increase memory usage some.
4979 @vindex gnus-keep-backlog
4980 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
4981 at most @var{n} old articles in a buffer for later re-fetching. If this
4982 variable is non-@code{nil} and is not a number, Gnus will store
4983 @emph{all} read articles, which means that your Emacs will grow without
4984 bound before exploding and taking your machine down with you. I put
4985 that in there just to keep y'all on your toes.
4987 This variable is @code{nil} by default.
4990 @node Saving Articles
4991 @section Saving Articles
4992 @cindex saving articles
4994 Gnus can save articles in a number of ways. Below is the documentation
4995 for saving articles in a fairly straight-forward fashion (i.e., little
4996 processing of the article is done before it is saved). For a different
4997 approach (uudecoding, unsharing) you should use @code{gnus-uu}
4998 (@pxref{Decoding Articles}).
5000 @vindex gnus-save-all-headers
5001 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5002 unwanted headers before saving the article.
5004 @vindex gnus-saved-headers
5005 If the preceding variable is @code{nil}, all headers that match the
5006 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5007 deleted before saving.
5013 @kindex O o (Summary)
5015 @findex gnus-summary-save-article
5016 Save the current article using the default article saver
5017 (@code{gnus-summary-save-article}).
5020 @kindex O m (Summary)
5021 @findex gnus-summary-save-article-mail
5022 Save the current article in mail format
5023 (@code{gnus-summary-save-article-mail}).
5026 @kindex O r (Summary)
5027 @findex gnus-summary-save-article-rmail
5028 Save the current article in rmail format
5029 (@code{gnus-summary-save-article-rmail}).
5032 @kindex O f (Summary)
5033 @findex gnus-summary-save-article-file
5034 Save the current article in plain file format
5035 (@code{gnus-summary-save-article-file}).
5038 @kindex O F (Summary)
5039 @findex gnus-summary-write-article-file
5040 Write the current article in plain file format, overwriting any previous
5041 file contents (@code{gnus-summary-write-article-file}).
5044 @kindex O b (Summary)
5045 @findex gnus-summary-save-article-body-file
5046 Save the current article body in plain file format
5047 (@code{gnus-summary-save-article-body-file}).
5050 @kindex O h (Summary)
5051 @findex gnus-summary-save-article-folder
5052 Save the current article in mh folder format
5053 (@code{gnus-summary-save-article-folder}).
5056 @kindex O v (Summary)
5057 @findex gnus-summary-save-article-vm
5058 Save the current article in a VM folder
5059 (@code{gnus-summary-save-article-vm}).
5062 @kindex O p (Summary)
5063 @findex gnus-summary-pipe-output
5064 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
5065 the current article to a process (@code{gnus-summary-pipe-output}).
5068 @vindex gnus-prompt-before-saving
5069 All these commands use the process/prefix convention
5070 (@pxref{Process/Prefix}). If you save bunches of articles using these
5071 functions, you might get tired of being prompted for files to save each
5072 and every article in. The prompting action is controlled by
5073 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5074 default, giving you that excessive prompting action you know and
5075 loathe. If you set this variable to @code{t} instead, you'll be prompted
5076 just once for each series of articles you save. If you like to really
5077 have Gnus do all your thinking for you, you can even set this variable
5078 to @code{nil}, which means that you will never be prompted for files to
5079 save articles in. Gnus will simply save all the articles in the default
5083 @vindex gnus-default-article-saver
5084 You can customize the @code{gnus-default-article-saver} variable to make
5085 Gnus do what you want it to. You can use any of the four ready-made
5086 functions below, or you can create your own.
5090 @item gnus-summary-save-in-rmail
5091 @findex gnus-summary-save-in-rmail
5092 @vindex gnus-rmail-save-name
5093 @findex gnus-plain-save-name
5094 This is the default format, @dfn{babyl}. Uses the function in the
5095 @code{gnus-rmail-save-name} variable to get a file name to save the
5096 article in. The default is @code{gnus-plain-save-name}.
5098 @item gnus-summary-save-in-mail
5099 @findex gnus-summary-save-in-mail
5100 @vindex gnus-mail-save-name
5101 Save in a Unix mail (mbox) file. Uses the function in the
5102 @code{gnus-mail-save-name} variable to get a file name to save the
5103 article in. The default is @code{gnus-plain-save-name}.
5105 @item gnus-summary-save-in-file
5106 @findex gnus-summary-save-in-file
5107 @vindex gnus-file-save-name
5108 @findex gnus-numeric-save-name
5109 Append the article straight to an ordinary file. Uses the function in
5110 the @code{gnus-file-save-name} variable to get a file name to save the
5111 article in. The default is @code{gnus-numeric-save-name}.
5113 @item gnus-summary-save-body-in-file
5114 @findex gnus-summary-save-body-in-file
5115 Append the article body to an ordinary file. Uses the function in the
5116 @code{gnus-file-save-name} variable to get a file name to save the
5117 article in. The default is @code{gnus-numeric-save-name}.
5119 @item gnus-summary-save-in-folder
5120 @findex gnus-summary-save-in-folder
5121 @findex gnus-folder-save-name
5122 @findex gnus-Folder-save-name
5123 @vindex gnus-folder-save-name
5126 Save the article to an MH folder using @code{rcvstore} from the MH
5127 library. Uses the function in the @code{gnus-folder-save-name} variable
5128 to get a file name to save the article in. The default is
5129 @code{gnus-folder-save-name}, but you can also use
5130 @code{gnus-Folder-save-name}. The former creates capitalized names, and
5131 the latter does not.
5133 @item gnus-summary-save-in-vm
5134 @findex gnus-summary-save-in-vm
5135 Save the article in a VM folder. You have to have the VM mail
5136 reader to use this setting.
5139 @vindex gnus-article-save-directory
5140 All of these functions, except for the last one, will save the article
5141 in the @code{gnus-article-save-directory}, which is initialized from the
5142 @code{SAVEDIR} environment variable. This is @file{~/News/} by
5145 As you can see above, the functions use different functions to find a
5146 suitable name of a file to save the article in. Below is a list of
5147 available functions that generate names:
5151 @item gnus-Numeric-save-name
5152 @findex gnus-Numeric-save-name
5153 File names like @file{~/News/Alt.andrea-dworkin/45}.
5155 @item gnus-numeric-save-name
5156 @findex gnus-numeric-save-name
5157 File names like @file{~/News/alt.andrea-dworkin/45}.
5159 @item gnus-Plain-save-name
5160 @findex gnus-Plain-save-name
5161 File names like @file{~/News/Alt.andrea-dworkin}.
5163 @item gnus-plain-save-name
5164 @findex gnus-plain-save-name
5165 File names like @file{~/News/alt.andrea-dworkin}.
5168 @vindex gnus-split-methods
5169 You can have Gnus suggest where to save articles by plonking a regexp into
5170 the @code{gnus-split-methods} alist. For instance, if you would like to
5171 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5172 related to VM in @code{vm-stuff}, you could set this variable to something
5176 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5177 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5178 (my-choosing-function "../other-dir/my-stuff")
5179 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5182 We see that this is a list where each element is a list that has two
5183 elements---the @dfn{match} and the @dfn{file}. The match can either be
5184 a string (in which case it is used as a regexp to match on the article
5185 head); it can be a symbol (which will be called as a function with the
5186 group name as a parameter); or it can be a list (which will be
5187 @code{eval}ed). If any of these actions have a non-@code{nil} result,
5188 the @dfn{file} will be used as a default prompt. In addition, the
5189 result of the operation itself will be used if the function or form
5190 called returns a string or a list of strings.
5192 You basically end up with a list of file names that might be used when
5193 saving the current article. (All ``matches'' will be used.) You will
5194 then be prompted for what you really want to use as a name, with file
5195 name completion over the results from applying this variable.
5197 This variable is @code{((gnus-article-archive-name))} by default, which
5198 means that Gnus will look at the articles it saves for an
5199 @code{Archive-name} line and use that as a suggestion for the file
5202 @vindex gnus-use-long-file-name
5203 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
5204 @code{nil}, all the preceding functions will replace all periods
5205 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5206 the functions will generate hierarchies of directories instead of having
5207 all the files in the toplevel directory
5208 (@file{~/News/alt/andrea-dworkin} instead of
5209 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
5210 on most systems. However, for historical reasons, this is @code{nil} on
5211 Xenix and usg-unix-v machines by default.
5213 This function also affects kill and score file names. If this variable
5214 is a list, and the list contains the element @code{not-score}, long file
5215 names will not be used for score files, if it contains the element
5216 @code{not-save}, long file names will not be used for saving, and if it
5217 contains the element @code{not-kill}, long file names will not be used
5220 If you'd like to save articles in a hierarchy that looks something like
5224 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5225 (setq gnus-default-article-save 'gnus-summary-save-in-file) ; no encoding
5228 Then just save with @kbd{o}. You'd then read this hierarchy with
5229 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5230 the toplevel directory as the argument (@file{~/News/}). Then just walk
5231 around to the groups/directories with @code{nneething}.
5234 @node Decoding Articles
5235 @section Decoding Articles
5236 @cindex decoding articles
5238 Sometime users post articles (or series of articles) that have been
5239 encoded in some way or other. Gnus can decode them for you.
5242 * Uuencoded Articles:: Uudecode articles.
5243 * Shared Articles:: Unshar articles.
5244 * PostScript Files:: Split PostScript.
5245 * Decoding Variables:: Variables for a happy decoding.
5246 * Viewing Files:: You want to look at the result of the decoding?
5249 All these functions use the process/prefix convention
5250 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5251 the extension that a ``single article'' means ``a single series''. Gnus
5252 can find out by itself what articles belong to a series, decode all the
5253 articles and unpack/view/save the resulting file(s).
5255 Gnus guesses what articles are in the series according to the following
5256 simplish rule: The subjects must be (nearly) identical, except for the
5257 last two numbers of the line. (Spaces are largely ignored, however.)
5259 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5260 will find all the articles that match the regexp @samp{^cat.gif
5261 ([0-9]+/[0-9]+).*$}.
5263 Subjects that are nonstandard, like @samp{cat.gif (2/3) Part 6 of a
5264 series}, will not be properly recognized by any of the automatic viewing
5265 commands, and you have to mark the articles manually with @kbd{#}.
5268 @node Uuencoded Articles
5269 @subsection Uuencoded Articles
5271 @cindex uuencoded articles
5276 @kindex X u (Summary)
5277 @findex gnus-uu-decode-uu
5278 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5281 @kindex X U (Summary)
5282 @findex gnus-uu-decode-uu-and-save
5283 Uudecodes and saves the current series
5284 (@code{gnus-uu-decode-uu-and-save}).
5287 @kindex X v u (Summary)
5288 @findex gnus-uu-decode-uu-view
5289 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5292 @kindex X v U (Summary)
5293 @findex gnus-uu-decode-uu-and-save-view
5294 Uudecodes, views and saves the current series
5295 (@code{gnus-uu-decode-uu-and-save-view}).
5298 Remember that these all react to the presence of articles marked with
5299 the process mark. If, for instance, you'd like to decode and save an
5300 entire newsgroup, you'd typically do @kbd{M P a}
5301 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5302 (@code{gnus-uu-decode-uu-and-save}).
5304 All this is very much different from how @code{gnus-uu} worked with
5305 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5306 the sun. This version of @code{gnus-uu} generally assumes that you mark
5307 articles in some way (@pxref{Setting Process Marks}) and then press
5310 @vindex gnus-uu-notify-files
5311 Note: When trying to decode articles that have names matching
5312 @code{gnus-uu-notify-files}, which is hard-coded to
5313 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5314 automatically post an article on @samp{comp.unix.wizards} saying that
5315 you have just viewed the file in question. This feature can't be turned
5319 @node Shared Articles
5320 @subsection Shared Articles
5322 @cindex shared articles
5327 @kindex X s (Summary)
5328 @findex gnus-uu-decode-unshar
5329 Unshars the current series (@code{gnus-uu-decode-unshar}).
5332 @kindex X S (Summary)
5333 @findex gnus-uu-decode-unshar-and-save
5334 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5337 @kindex X v s (Summary)
5338 @findex gnus-uu-decode-unshar-view
5339 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5342 @kindex X v S (Summary)
5343 @findex gnus-uu-decode-unshar-and-save-view
5344 Unshars, views and saves the current series
5345 (@code{gnus-uu-decode-unshar-and-save-view}).
5349 @node PostScript Files
5350 @subsection PostScript Files
5356 @kindex X p (Summary)
5357 @findex gnus-uu-decode-postscript
5358 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5361 @kindex X P (Summary)
5362 @findex gnus-uu-decode-postscript-and-save
5363 Unpack and save the current PostScript series
5364 (@code{gnus-uu-decode-postscript-and-save}).
5367 @kindex X v p (Summary)
5368 @findex gnus-uu-decode-postscript-view
5369 View the current PostScript series
5370 (@code{gnus-uu-decode-postscript-view}).
5373 @kindex X v P (Summary)
5374 @findex gnus-uu-decode-postscript-and-save-view
5375 View and save the current PostScript series
5376 (@code{gnus-uu-decode-postscript-and-save-view}).
5380 @node Decoding Variables
5381 @subsection Decoding Variables
5383 Adjective, not verb.
5386 * Rule Variables:: Variables that say how a file is to be viewed.
5387 * Other Decode Variables:: Other decode variables.
5388 * Uuencoding and Posting:: Variables for customizing uuencoding.
5392 @node Rule Variables
5393 @subsubsection Rule Variables
5394 @cindex rule variables
5396 Gnus uses @dfn{rule variables} to decide how to view a file. All these
5397 variables are on the form
5400 (list '(regexp1 command2)
5407 @item gnus-uu-user-view-rules
5408 @vindex gnus-uu-user-view-rules
5410 This variable is consulted first when viewing files. If you wish to use,
5411 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5414 (setq gnus-uu-user-view-rules
5415 (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5418 @item gnus-uu-user-view-rules-end
5419 @vindex gnus-uu-user-view-rules-end
5420 This variable is consulted if Gnus couldn't make any matches from the
5421 user and default view rules.
5423 @item gnus-uu-user-archive-rules
5424 @vindex gnus-uu-user-archive-rules
5425 This variable can be used to say what commands should be used to unpack
5430 @node Other Decode Variables
5431 @subsubsection Other Decode Variables
5434 @vindex gnus-uu-grabbed-file-functions
5436 @item gnus-uu-grabbed-file-functions
5437 All functions in this list will be called right each file has been
5438 successfully decoded---so that you can move or view files right away,
5439 and don't have to wait for all files to be decoded before you can do
5440 anything. Ready-made functions you can put in this list are:
5444 @item gnus-uu-grab-view
5445 @findex gnus-uu-grab-view
5448 @item gnus-uu-grab-move
5449 @findex gnus-uu-grab-move
5450 Move the file (if you're using a saving function.)
5453 @item gnus-uu-be-dangerous
5454 @vindex gnus-uu-be-dangerous
5455 Specifies what to do if unusual situations arise during decoding. If
5456 @code{nil}, be as conservative as possible. If @code{t}, ignore things
5457 that didn't work, and overwrite existing files. Otherwise, ask each
5460 @item gnus-uu-ignore-files-by-name
5461 @vindex gnus-uu-ignore-files-by-name
5462 Files with name matching this regular expression won't be viewed.
5464 @item gnus-uu-ignore-files-by-type
5465 @vindex gnus-uu-ignore-files-by-type
5466 Files with a @sc{mime} type matching this variable won't be viewed.
5467 Note that Gnus tries to guess what type the file is based on the name.
5468 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5471 @item gnus-uu-tmp-dir
5472 @vindex gnus-uu-tmp-dir
5473 Where @code{gnus-uu} does its work.
5475 @item gnus-uu-do-not-unpack-archives
5476 @vindex gnus-uu-do-not-unpack-archives
5477 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5478 looking for files to display.
5480 @item gnus-uu-view-and-save
5481 @vindex gnus-uu-view-and-save
5482 Non-@code{nil} means that the user will always be asked to save a file
5485 @item gnus-uu-ignore-default-view-rules
5486 @vindex gnus-uu-ignore-default-view-rules
5487 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5490 @item gnus-uu-ignore-default-archive-rules
5491 @vindex gnus-uu-ignore-default-archive-rules
5492 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5495 @item gnus-uu-kill-carriage-return
5496 @vindex gnus-uu-kill-carriage-return
5497 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5500 @item gnus-uu-unmark-articles-not-decoded
5501 @vindex gnus-uu-unmark-articles-not-decoded
5502 Non-@code{nil} means that @code{gnus-uu} will mark articles that were
5503 unsuccessfully decoded as unread.
5505 @item gnus-uu-correct-stripped-uucode
5506 @vindex gnus-uu-correct-stripped-uucode
5507 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5508 uuencoded files that have had trailing spaces deleted.
5510 @item gnus-uu-view-with-metamail
5511 @vindex gnus-uu-view-with-metamail
5513 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5514 commands defined by the rule variables and just fudge a @sc{mime}
5515 content type based on the file name. The result will be fed to
5516 @code{metamail} for viewing.
5518 @item gnus-uu-save-in-digest
5519 @vindex gnus-uu-save-in-digest
5520 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5521 decoding, will save in digests. If this variable is @code{nil},
5522 @code{gnus-uu} will just save everything in a file without any
5523 embellishments. The digesting almost conforms to RFC1153---no easy way
5524 to specify any meaningful volume and issue numbers were found, so I
5525 simply dropped them.
5530 @node Uuencoding and Posting
5531 @subsubsection Uuencoding and Posting
5535 @item gnus-uu-post-include-before-composing
5536 @vindex gnus-uu-post-include-before-composing
5537 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5538 before you compose the article. If this variable is @code{t}, you can
5539 either include an encoded file with @kbd{C-c C-i} or have one included
5540 for you when you post the article.
5542 @item gnus-uu-post-length
5543 @vindex gnus-uu-post-length
5544 Maximum length of an article. The encoded file will be split into how
5545 many articles it takes to post the entire file.
5547 @item gnus-uu-post-threaded
5548 @vindex gnus-uu-post-threaded
5549 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
5550 thread. This may not be smart, as no other decoder I have seen are able
5551 to follow threads when collecting uuencoded articles. (Well, I have
5552 seen one package that does that---@code{gnus-uu}, but somehow, I don't
5553 think that counts...) Default is @code{nil}.
5555 @item gnus-uu-post-separate-description
5556 @vindex gnus-uu-post-separate-description
5557 Non-@code{nil} means that the description will be posted in a separate
5558 article. The first article will typically be numbered (0/x). If this
5559 variable is @code{nil}, the description the user enters will be included
5560 at the beginning of the first article, which will be numbered (1/x).
5561 Default is @code{t}.
5567 @subsection Viewing Files
5568 @cindex viewing files
5569 @cindex pseudo-articles
5571 After decoding, if the file is some sort of archive, Gnus will attempt
5572 to unpack the archive and see if any of the files in the archive can be
5573 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
5574 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
5575 uncompress and de-tar the main file, and then view the two pictures.
5576 This unpacking process is recursive, so if the archive contains archives
5577 of archives, it'll all be unpacked.
5579 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
5580 extracted file into the summary buffer. If you go to these
5581 ``articles'', you will be prompted for a command to run (usually Gnus
5582 will make a suggestion), and then the command will be run.
5584 @vindex gnus-view-pseudo-asynchronously
5585 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
5586 until the viewing is done before proceeding.
5588 @vindex gnus-view-pseudos
5589 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
5590 the pseudo-articles into the summary buffer, but view them
5591 immediately. If this variable is @code{not-confirm}, the user won't even
5592 be asked for a confirmation before viewing is done.
5594 @vindex gnus-view-pseudos-separately
5595 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
5596 pseudo-article will be created for each file to be viewed. If
5597 @code{nil}, all files that use the same viewing command will be given as
5598 a list of parameters to that command.
5600 @vindex gnus-insert-pseudo-articles
5601 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
5602 pseudo-articles when decoding. It is @code{t} by default.
5604 So; there you are, reading your @emph{pseudo-articles} in your
5605 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
5606 Why isn't anything real anymore? How did we get here?
5609 @node Article Treatment
5610 @section Article Treatment
5612 Reading through this huge manual, you may have quite forgotten that the
5613 object of newsreaders are to actually, like, read what people have
5614 written. Reading articles. Unfortunately, people are quite bad at
5615 writing, so there are tons of functions and variables to make reading
5616 these articles easier.
5619 * Article Highlighting:: You want to make the article look like fruit salad.
5620 * Article Fontisizing:: Making emphasized text look niced.
5621 * Article Hiding:: You also want to make certain info go away.
5622 * Article Washing:: Lots of way-neat functions to make life better.
5623 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
5624 * Article Date:: Grumble, UT!
5625 * Article Signature:: What is a signature?
5629 @node Article Highlighting
5630 @subsection Article Highlighting
5633 Not only do you want your article buffer to look like fruit salad, but
5634 you want it to look like technicolor fruit salad.
5639 @kindex W H a (Summary)
5640 @findex gnus-article-highlight
5641 Highlight the current article (@code{gnus-article-highlight}).
5644 @kindex W H h (Summary)
5645 @findex gnus-article-highlight-headers
5646 @vindex gnus-header-face-alist
5647 Highlight the headers (@code{gnus-article-highlight-headers}). The
5648 highlighting will be done according to the @code{gnus-header-face-alist}
5649 variable, which is a list where each element has the form @var{(regexp
5650 name content)}. @var{regexp} is a regular expression for matching the
5651 header, @var{name} is the face used for highlighting the header name and
5652 @var{content} is the face for highlighting the header value. The first
5653 match made will be used. Note that @var{regexp} shouldn't have @samp{^}
5654 prepended---Gnus will add one.
5657 @kindex W H c (Summary)
5658 @findex gnus-article-highlight-citation
5659 Highlight cited text (@code{gnus-article-highlight-citation}).
5661 Some variables to customize the citation highlights:
5664 @vindex gnus-cite-parse-max-size
5666 @item gnus-cite-parse-max-size
5667 If the article size if bigger than this variable (which is 25000 by
5668 default), no citation highlighting will be performed.
5670 @item gnus-cite-prefix-regexp
5671 @vindex gnus-cite-prefix-regexp
5672 Regexp matching the longest possible citation prefix on a line.
5674 @item gnus-cite-max-prefix
5675 @vindex gnus-cite-max-prefix
5676 Maximum possible length for a citation prefix (default 20).
5678 @item gnus-cite-face-list
5679 @vindex gnus-cite-face-list
5680 List of faces used for highlighting citations. When there are citations
5681 from multiple articles in the same message, Gnus will try to give each
5682 citation from each article its own face. This should make it easier to
5685 @item gnus-supercite-regexp
5686 @vindex gnus-supercite-regexp
5687 Regexp matching normal Supercite attribution lines.
5689 @item gnus-supercite-secondary-regexp
5690 @vindex gnus-supercite-secondary-regexp
5691 Regexp matching mangled Supercite attribution lines.
5693 @item gnus-cite-minimum-match-count
5694 @vindex gnus-cite-minimum-match-count
5695 Minimum number of identical prefixes we have to see before we believe
5696 that it's a citation.
5698 @item gnus-cite-attribution-prefix
5699 @vindex gnus-cite-attribution-prefix
5700 Regexp matching the beginning of an attribution line.
5702 @item gnus-cite-attribution-suffix
5703 @vindex gnus-cite-attribution-suffix
5704 Regexp matching the end of an attribution line.
5706 @item gnus-cite-attribution-face
5707 @vindex gnus-cite-attribution-face
5708 Face used for attribution lines. It is merged with the face for the
5709 cited text belonging to the attribution.
5715 @kindex W H s (Summary)
5716 @vindex gnus-signature-separator
5717 @vindex gnus-signature-face
5718 @findex gnus-article-highlight-signature
5719 Highlight the signature (@code{gnus-article-highlight-signature}).
5720 Everything after @code{gnus-signature-separator} (@pxref{Article
5721 Signature}) in an article will be considered a signature and will be
5722 highlighted with @code{gnus-signature-face}, which is @code{italic} by
5728 @node Article Fontisizing
5729 @subsection Article Fontisizing
5731 @cindex article emphasis
5733 @findex gnus-article-emphasize
5734 @kindex W e (Summary)
5735 People commonly add emphasis to words in news articles by writing things
5736 like @samp{_this_} or @samp{*this*}. Gnus can make this look nicer by
5737 running the article through the @kbd{W e}
5738 (@code{gnus-article-emphasize}) command.
5740 @vindex gnus-article-emphasis
5741 How the emphasis is computed is controlled by the
5742 @code{gnus-article-emphasis} variable. This is an alist where the first
5743 element is a regular expression to be matched. The second is a number
5744 that says what regular expression grouping used to find the entire
5745 emphasized word. The third is a number that says what regexp grouping
5746 should be displayed and highlighted. (The text between these two
5747 groupings will be hidden.) The fourth is the face used for
5751 (setq gnus-article-emphasis
5752 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
5753 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
5756 @vindex gnus-emphasis-underline
5757 @vindex gnus-emphasis-bold
5758 @vindex gnus-emphasis-italic
5759 @vindex gnus-emphasis-underline-bold
5760 @vindex gnus-emphasis-underline-italic
5761 @vindex gnus-emphasis-bold-italic
5762 @vindex gnus-emphasis-underline-bold-italic
5763 By default, there are seven rules, and they use the following faces:
5764 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
5765 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
5766 @code{gnus-emphasis-underline-italic},
5767 @code{gnus-emphasis-undeline-bold}, and
5768 @code{gnus-emphasis-underline-bold-italic}.
5770 If you want to change these faces, you can either use @kbd{M-x
5771 customize}, or you can use @code{copy-face}. For instance, if you want
5772 to make @code{gnus-emphasis-italic} use a red face instead, you could
5776 (copy-face 'red 'gnus-emphasis-italic)
5780 @node Article Hiding
5781 @subsection Article Hiding
5782 @cindex article hiding
5784 Or rather, hiding certain things in each article. There usually is much
5785 too much cruft in most articles.
5790 @kindex W W a (Summary)
5791 @findex gnus-article-hide
5792 Do maximum hiding on the summary buffer (@kbd{gnus-article-hide}).
5795 @kindex W W h (Summary)
5796 @findex gnus-article-hide-headers
5797 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
5801 @kindex W W b (Summary)
5802 @findex gnus-article-hide-boring-headers
5803 Hide headers that aren't particularly interesting
5804 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
5807 @kindex W W s (Summary)
5808 @findex gnus-article-hide-signature
5809 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
5813 @kindex W W p (Summary)
5814 @findex gnus-article-hide-pgp
5815 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).
5818 @kindex W W P (Summary)
5819 @findex gnus-article-hide-pem
5820 Hide @sc{pem} (privacy enhanced messages) gruft
5821 (@code{gnus-article-hide-pem}).
5824 @kindex W W c (Summary)
5825 @findex gnus-article-hide-citation
5826 Hide citation (@code{gnus-article-hide-citation}). Some variables for
5827 customizing the hiding:
5831 @item gnus-cite-hide-percentage
5832 @vindex gnus-cite-hide-percentage
5833 If the cited text is of a bigger percentage than this variable (default
5834 50), hide the cited text.
5836 @item gnus-cite-hide-absolute
5837 @vindex gnus-cite-hide-absolute
5838 The cited text must be have at least this length (default 10) before it
5841 @item gnus-cited-text-button-line-format
5842 @vindex gnus-cited-text-button-line-format
5843 Gnus adds buttons show where the cited text has been hidden, and to
5844 allow toggle hiding the text. The format of the variable is specified
5845 by this format-like variable (@pxref{Formatting Variables}). These
5850 Start point of the hidden text.
5852 End point of the hidden text.
5854 Length of the hidden text.
5857 @item gnus-cited-lines-visible
5858 @vindex gnus-cited-lines-visible
5859 The number of lines at the beginning of the cited text to leave shown.
5864 @kindex W W C (Summary)
5865 @findex gnus-article-hide-citation-in-followups
5866 Hide cited text in articles that aren't roots
5867 (@code{gnus-article-hide-citation-in-followups}). This isn't very
5868 useful as an interactive command, but might be a handy function to stick
5869 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}).
5873 All these ``hiding'' commands are toggles, but if you give a negative
5874 prefix to these commands, they will show what they have previously
5875 hidden. If you give a positive prefix, they will always hide.
5877 Also @pxref{Article Highlighting} for further variables for
5878 citation customization.
5881 @node Article Washing
5882 @subsection Article Washing
5884 @cindex article washing
5886 We call this ``article washing'' for a really good reason. Namely, the
5887 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
5889 @dfn{Washing} is defined by us as ``changing something from something to
5890 something else'', but normally results in something looking better.
5896 @kindex W l (Summary)
5897 @findex gnus-summary-stop-page-breaking
5898 Remove page breaks from the current article
5899 (@code{gnus-summary-stop-page-breaking}).
5902 @kindex W r (Summary)
5903 @findex gnus-summary-caesar-message
5904 Do a Caesar rotate (rot13) on the article buffer
5905 (@code{gnus-summary-caesar-message}).
5908 @kindex W t (Summary)
5909 @findex gnus-summary-toggle-header
5910 Toggle whether to display all headers in the article buffer
5911 (@code{gnus-summary-toggle-header}).
5914 @kindex W v (Summary)
5915 @findex gnus-summary-verbose-header
5916 Toggle whether to display all headers in the article buffer permanently
5917 (@code{gnus-summary-verbose-header}).
5920 @kindex W m (Summary)
5921 @findex gnus-summary-toggle-mime
5922 Toggle whether to run the article through @sc{mime} before displaying
5923 (@code{gnus-summary-toggle-mime}).
5926 @kindex W o (Summary)
5927 @findex gnus-article-treat-overstrike
5928 Treat overstrike (@code{gnus-article-treat-overstrike}).
5931 @kindex W w (Summary)
5932 @findex gnus-article-fill-cited-article
5933 Do word wrap (@code{gnus-article-fill-cited-article}). If you use this
5934 function in @code{gnus-article-display-hook}, it should be run fairly
5935 late and certainly after any highlighting.
5937 You can give the command a numerical prefix to specify the width to use
5941 @kindex W c (Summary)
5942 @findex gnus-article-remove-cr
5943 Remove CR (@code{gnus-article-remove-cr}).
5946 @kindex W q (Summary)
5947 @findex gnus-article-de-quoted-unreadable
5948 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
5951 @kindex W f (Summary)
5953 @findex gnus-article-display-x-face
5954 @findex gnus-article-x-face-command
5955 @vindex gnus-article-x-face-command
5956 @vindex gnus-article-x-face-too-ugly
5957 Look for and display any X-Face headers
5958 (@code{gnus-article-display-x-face}). The command executed by this
5959 function is given by the @code{gnus-article-x-face-command} variable.
5960 If this variable is a string, this string will be executed in a
5961 sub-shell. If it is a function, this function will be called with the
5962 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
5963 is a regexp) matches the @code{From} header, the face will not be shown.
5964 The default action under Emacs is to fork off an @code{xv} to view the
5965 face; under XEmacs the default action is to display the face before the
5966 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
5967 support---that will make display somewhat faster. If there's no native
5968 X-Face support, Gnus will try to convert the @code{X-Face} header using
5969 external programs from the @code{pbmplus} package and friends.) If you
5970 want to have this function in the display hook, it should probably come
5974 @kindex W b (Summary)
5975 @findex gnus-article-add-buttons
5976 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
5979 @kindex W B (Summary)
5980 @findex gnus-article-add-buttons-to-head
5981 Add clickable buttons to the article headers
5982 (@code{gnus-article-add-buttons-to-head}).
5985 @kindex W E l (Summary)
5986 @findex gnus-article-strip-leading-blank-lines
5987 Remove all blank lines from the beginning of the article
5988 (@code{gnus-article-strip-leading-blank-lines}).
5991 @kindex W E m (Summary)
5992 @findex gnus-article-strip-multiple-blank-lines
5993 Replace all blank lines with empty lines and then all multiple empty
5994 lines with a single empty line.
5995 (@code{gnus-article-strip-multiple-blank-lines}).
5998 @kindex W E t (Summary)
5999 @findex gnus-article-remove-trailing-blank-lines
6000 Remove all blank lines at the end of the article
6001 (@code{gnus-article-remove-trailing-blank-lines}).
6004 @kindex W E a (Summary)
6005 @findex gnus-article-strip-blank-lines
6006 Do all the three commands above
6007 (@code{gnus-article-strip-blank-lines}).
6012 @node Article Buttons
6013 @subsection Article Buttons
6016 People often include references to other stuff in articles, and it would
6017 be nice if Gnus could just fetch whatever it is that people talk about
6018 with the minimum of fuzz.
6020 Gnus adds @dfn{buttons} to certain standard references by default:
6021 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
6022 two variables, one that handles article bodies and one that handles
6027 @item gnus-button-alist
6028 @vindex gnus-button-alist
6029 This is an alist where each entry has this form:
6032 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6038 All text that match this regular expression will be considered an
6039 external reference. Here's a typical regexp that match embedded URLs:
6040 @samp{<URL:\\([^\n\r>]*\\)>}.
6043 Gnus has to know which parts of the match is to be highlighted. This is
6044 a number that says what sub-expression of the regexp that is to be
6045 highlighted. If you want it all highlighted, you use 0 here.
6048 This form will be @code{eval}ed, and if the result is non-@code{nil},
6049 this is considered a match. This is useful if you want extra sifting to
6050 avoid false matches.
6053 This function will be called when you click on this button.
6056 As with @var{button-par}, this is a sub-expression number, but this one
6057 says which part of the match is to be sent as data to @var{function}.
6061 So the full entry for buttonizing URLs is then
6064 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6067 @item gnus-header-button-alist
6068 @vindex gnus-header-button-alist
6069 This is just like the other alist, except that it is applied to the
6070 article head only, and that each entry has an additional element that is
6071 used to say what headers to apply the buttonize coding to:
6074 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6077 @var{header} is a regular expression.
6079 @item gnus-button-url-regexp
6080 @vindex gnus-button-url-regexp
6081 A regular expression that matches embedded URLs. It is used in the
6082 default values of the variables above.
6084 @item gnus-article-button-face
6085 @vindex gnus-article-button-face
6086 Face used on buttons.
6088 @item gnus-article-mouse-face
6089 @vindex gnus-article-mouse-face
6090 Face is used when the mouse cursor is over a button.
6096 @subsection Article Date
6098 The date is most likely generated in some obscure timezone you've never
6099 heard of, so it's quite nice to be able to find out what the time was
6100 when the article was sent.
6105 @kindex W T u (Summary)
6106 @findex gnus-article-date-ut
6107 Display the date in UT (aka. GMT, aka ZULU)
6108 (@code{gnus-article-date-ut}).
6111 @kindex W T l (Summary)
6112 @findex gnus-article-date-local
6113 Display the date in the local timezone (@code{gnus-article-date-local}).
6116 @kindex W T s (Summary)
6117 @vindex gnus-article-time-format
6118 @findex gnus-article-date-user
6119 @findex format-time-string
6120 Display the date using a user-defined format
6121 (@code{gnus-article-date-user}). The format is specified by the
6122 @code{gnus-article-time-format} variable, and is a string that's passed
6123 to @code{format-time-string}. See the documentation of that variable
6124 for a list possible format specs.
6127 @kindex W T e (Summary)
6128 @findex gnus-article-date-lapsed
6129 Say how much time has (e)lapsed between the article was posted and now
6130 (@code{gnus-article-date-lapsed}).
6133 @kindex W T o (Summary)
6134 @findex gnus-article-date-original
6135 Display the original date (@code{gnus-article-date-original}). This can
6136 be useful if you normally use some other conversion function and is
6137 worried that it might be doing something totally wrong. Say, claiming
6138 that the article was posted in 1854. Although something like that is
6139 @emph{totally} impossible. Don't you trust me? *titter*
6144 @node Article Signature
6145 @subsection Article Signature
6147 @cindex article signature
6149 @vindex gnus-signature-separator
6150 Each article is divided into two parts---the head and the body. The
6151 body can be divided into a signature part and a text part. The variable
6152 that says what is to be considered a signature is
6153 @code{gnus-signature-separator}. This is normally the standard
6154 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
6155 non-standard signature separators, so this variable can also be a list
6156 of regular expressions to be tested, one by one. (Searches are done
6157 from the end of the body towards the beginning.) One likely value is:
6160 (setq gnus-signature-separator
6161 '("^-- $" ; The standard
6162 "^-- *$" ; A common mangling
6163 "^-------*$" ; Many people just use a looong
6164 ; line of dashes. Shame!
6165 "^ *--------*$" ; Double-shame!
6166 "^________*$" ; Underscores are also popular
6167 "^========*$")) ; Pervert!
6170 The more permissive you are, the more likely it is that you'll get false
6173 @vindex gnus-signature-limit
6174 @code{gnus-signature-limit} provides a limit to what is considered a
6179 If it is an integer, no signature may be longer (in characters) than
6182 If it is a floating point number, no signature may be longer (in lines)
6185 If it is a function, the function will be called without any parameters,
6186 and if it returns @code{nil}, there is no signature in the buffer.
6188 If it is a string, it will be used as a regexp. If it matches, the text
6189 in question is not a signature.
6192 This variable can also be a list where the elements may be of the types
6196 @node Article Commands
6197 @section Article Commands
6204 @kindex A P (Summary)
6205 @vindex gnus-ps-print-hook
6206 @findex gnus-summary-print-article
6207 Generate and print a PostScript image of the article buffer
6208 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
6209 run just before printing the buffer.
6214 @node Summary Sorting
6215 @section Summary Sorting
6216 @cindex summary sorting
6218 You can have the summary buffer sorted in various ways, even though I
6219 can't really see why you'd want that.
6224 @kindex C-c C-s C-n (Summary)
6225 @findex gnus-summary-sort-by-number
6226 Sort by article number (@code{gnus-summary-sort-by-number}).
6229 @kindex C-c C-s C-a (Summary)
6230 @findex gnus-summary-sort-by-author
6231 Sort by author (@code{gnus-summary-sort-by-author}).
6234 @kindex C-c C-s C-s (Summary)
6235 @findex gnus-summary-sort-by-subject
6236 Sort by subject (@code{gnus-summary-sort-by-subject}).
6239 @kindex C-c C-s C-d (Summary)
6240 @findex gnus-summary-sort-by-date
6241 Sort by date (@code{gnus-summary-sort-by-date}).
6244 @kindex C-c C-s C-l (Summary)
6245 @findex gnus-summary-sort-by-lines
6246 Sort by lines (@code{gnus-summary-sort-by-lines}).
6249 @kindex C-c C-s C-i (Summary)
6250 @findex gnus-summary-sort-by-score
6251 Sort by score (@code{gnus-summary-sort-by-score}).
6254 These functions will work both when you use threading and when you don't
6255 use threading. In the latter case, all summary lines will be sorted,
6256 line by line. In the former case, sorting will be done on a
6257 root-by-root basis, which might not be what you were looking for. To
6258 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6262 @node Finding the Parent
6263 @section Finding the Parent
6264 @cindex parent articles
6265 @cindex referring articles
6267 @findex gnus-summary-refer-parent-article
6269 If you'd like to read the parent of the current article, and it is not
6270 displayed in the summary buffer, you might still be able to. That is,
6271 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6272 and the @code{References} in the current article are not mangled, you
6273 can just press @kbd{^} or @kbd{A r}
6274 (@code{gnus-summary-refer-parent-article}). If everything goes well,
6275 you'll get the parent. If the parent is already displayed in the
6276 summary buffer, point will just move to this article.
6278 If given a positive numerical prefix, fetch that many articles back into
6279 the ancestry. If given a negative numerical prefix, fetch just that
6280 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6281 grandparent and the grandgrandparent of the current article. If you say
6282 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6285 @findex gnus-summary-refer-references
6286 @kindex A R (Summary)
6287 You can have Gnus fetch all articles mentioned in the @code{References}
6288 header of the article by pushing @kbd{A R}
6289 (@code{gnus-summary-refer-references}).
6291 @findex gnus-summary-refer-article
6292 @kindex M-^ (Summary)
6294 @cindex fetching by Message-ID
6295 You can also ask the @sc{nntp} server for an arbitrary article, no
6296 matter what group it belongs to. @kbd{M-^}
6297 (@code{gnus-summary-refer-article}) will ask you for a
6298 @code{Message-ID}, which is one of those long, hard-to-read thingies
6299 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
6300 have to get it all exactly right. No fuzzy searches, I'm afraid.
6302 @vindex gnus-refer-article-method
6303 If the group you are reading is located on a backend that does not
6304 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6305 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
6306 would, perhaps, be best if the @sc{nntp} server you consult is the same
6307 as the one that keeps the spool you are reading from updated, but that's
6308 not really necessary.
6310 Most of the mail backends support fetching by @code{Message-ID}, but do
6311 not do a particularly excellent job of it. That is, @code{nnmbox} and
6312 @code{nnbabyl} are able to locate articles from any groups, while
6313 @code{nnml} and @code{nnfolder} are only able to locate articles that
6314 have been posted to the current group. (Anything else would be too time
6315 consuming.) @code{nnmh} does not support this at all.
6318 @node Alternative Approaches
6319 @section Alternative Approaches
6321 Different people like to read news using different methods. This being
6322 Gnus, we offer a small selection of minor modes for the summary buffers.
6325 * Pick and Read:: First mark articles and then read them.
6326 * Binary Groups:: Auto-decode all articles.
6331 @subsection Pick and Read
6332 @cindex pick and read
6334 Some newsreaders (like @code{nn} and, uhm, @code{nn}) use a two-phased
6335 reading interface. The user first marks the articles she wants to read
6336 from a summary buffer. Then she starts reading the articles with just
6337 an article buffer displayed.
6339 @findex gnus-pick-mode
6340 @kindex M-x gnus-pick-mode
6341 Gnus provides a summary buffer minor mode that allows
6342 this---@code{gnus-pick-mode}. This basically means that a few process
6343 mark commands become one-keystroke commands to allow easy marking, and
6344 it makes one additional command for switching to the summary buffer
6347 Here are the available keystrokes when using pick mode:
6352 @findex gnus-summary-mark-as-processable
6353 Pick the article on the current line
6354 (@code{gnus-summary-mark-as-processable}). If given a numerical prefix,
6355 go to the article on that line and pick that article. (The line number
6356 is normally displayed on the beginning of the summary pick lines.)
6359 @kindex SPACE (Pick)
6360 @findex gnus-pick-next-page
6361 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
6362 at the end of the buffer, start reading the picked articles.
6366 @findex gnus-summary-unmark-as-processable
6367 Unpick the article (@code{gnus-summary-unmark-as-processable}).
6371 @findex gnus-summary-unmark-all-processable
6372 Unpick all articles (@code{gnus-summary-unmark-all-processable}).
6376 @findex gnus-uu-mark-thread
6377 Pick the thread (@code{gnus-uu-mark-thread}).
6381 @findex gnus-uu-unmark-thread
6382 Unpick the thread (@code{gnus-uu-unmark-thread}).
6386 @findex gnus-uu-mark-region
6387 Pick the region (@code{gnus-uu-mark-region}).
6391 @findex gnus-uu-unmark-region
6392 Unpick the region (@code{gnus-uu-unmark-region}).
6396 @findex gnus-uu-mark-by-regexp
6397 Pick articles that match a regexp (@code{gnus-uu-mark-by-regexp}).
6401 @findex gnus-uu-unmark-by-regexp
6402 Unpick articles that match a regexp (@code{gnus-uu-unmark-by-regexp}).
6406 @findex gnus-uu-mark-buffer
6407 Pick the buffer (@code{gnus-uu-mark-buffer}).
6411 @findex gnus-uu-unmark-buffer
6412 Unpick the buffer (@code{gnus-uu-unmark-buffer}).
6416 @findex gnus-pick-start-reading
6417 @vindex gnus-pick-display-summary
6418 Start reading the picked articles (@code{gnus-pick-start-reading}). If
6419 given a prefix, mark all unpicked articles as read first. If
6420 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6421 will still be visible when you are reading.
6425 If this sounds like a good idea to you, you could say:
6428 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6431 @vindex gnus-pick-mode-hook
6432 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6434 @vindex gnus-mark-unpicked-articles-as-read
6435 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6436 all unpicked articles as read. The default is @code{nil}.
6438 @vindex gnus-summary-pick-line-format
6439 The summary line format in pick mode is slightly different than the
6440 standard format. At the beginning of each line the line number is
6441 displayed. The pick mode line format is controlled by the
6442 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
6443 Variables}). It accepts the same format specs that
6444 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
6448 @subsection Binary Groups
6449 @cindex binary groups
6451 @findex gnus-binary-mode
6452 @kindex M-x gnus-binary-mode
6453 If you spend much time in binary groups, you may grow tired of hitting
6454 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
6455 is a minor mode for summary buffers that makes all ordinary Gnus article
6456 selection functions uudecode series of articles and display the result
6457 instead of just displaying the articles the normal way.
6460 @findex gnus-binary-show-article
6461 In fact, the only way to see the actual articles if you have turned this
6462 mode on is the @kbd{g} command (@code{gnus-binary-show-article}).
6464 @vindex gnus-binary-mode-hook
6465 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
6469 @section Tree Display
6472 @vindex gnus-use-trees
6473 If you don't like the normal Gnus summary display, you might try setting
6474 @code{gnus-use-trees} to @code{t}. This will create (by default) an
6475 additional @dfn{tree buffer}. You can execute all summary mode commands
6478 There are a few variables to customize the tree display, of course:
6481 @item gnus-tree-mode-hook
6482 @vindex gnus-tree-mode-hook
6483 A hook called in all tree mode buffers.
6485 @item gnus-tree-mode-line-format
6486 @vindex gnus-tree-mode-line-format
6487 A format string for the mode bar in the tree mode buffers. The default
6488 is @samp{Gnus: %%b [%A] %Z}. For a list of legal specs, @pxref{Summary
6491 @item gnus-selected-tree-face
6492 @vindex gnus-selected-tree-face
6493 Face used for highlighting the selected article in the tree buffer. The
6494 default is @code{modeline}.
6496 @item gnus-tree-line-format
6497 @vindex gnus-tree-line-format
6498 A format string for the tree nodes. The name is a bit of a misnomer,
6499 though---it doesn't define a line, but just the node. The default value
6500 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
6501 the name of the poster. It is vital that all nodes are of the same
6502 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
6508 The name of the poster.
6510 The @code{From} header.
6512 The number of the article.
6514 The opening bracket.
6516 The closing bracket.
6521 @xref{Formatting Variables}.
6523 Variables related to the display are:
6526 @item gnus-tree-brackets
6527 @vindex gnus-tree-brackets
6528 This is used for differentiating between ``real'' articles and
6529 ``sparse'' articles. The format is @var{((real-open . real-close)
6530 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
6531 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}))}.
6533 @item gnus-tree-parent-child-edges
6534 @vindex gnus-tree-parent-child-edges
6535 This is a list that contains the characters used for connecting parent
6536 nodes to their children. The default is @code{(?- ?\\ ?|)}.
6540 @item gnus-tree-minimize-window
6541 @vindex gnus-tree-minimize-window
6542 If this variable is non-@code{nil}, Gnus will try to keep the tree
6543 buffer as small as possible to allow more room for the other Gnus
6544 windows. If this variable is a number, the tree buffer will never be
6545 higher than that number. The default is @code{t}.
6547 @item gnus-generate-tree-function
6548 @vindex gnus-generate-tree-function
6549 @findex gnus-generate-horizontal-tree
6550 @findex gnus-generate-vertical-tree
6551 The function that actually generates the thread tree. Two predefined
6552 functions are available: @code{gnus-generate-horizontal-tree} and
6553 @code{gnus-generate-vertical-tree} (which is the default).
6557 Here's and example from a horizontal tree buffer:
6560 @{***@}-(***)-[odd]-[Gun]
6570 Here's the same thread displayed in a vertical tree buffer:
6574 |--------------------------\-----\-----\
6575 (***) [Bjo] [Gun] [Gun]
6577 [odd] [Jan] [odd] (***) [Jor]
6579 [Gun] [Eri] [Eri] [odd]
6585 @node Mail Group Commands
6586 @section Mail Group Commands
6587 @cindex mail group commands
6589 Some commands only make sense in mail groups. If these commands are
6590 illegal in the current group, they will raise a hell and let you know.
6592 All these commands (except the expiry and edit commands) use the
6593 process/prefix convention (@pxref{Process/Prefix}).
6598 @kindex B e (Summary)
6599 @findex gnus-summary-expire-articles
6600 Expire all expirable articles in the group
6601 (@code{gnus-summary-expire-articles}).
6604 @kindex B M-C-e (Summary)
6605 @findex gnus-summary-expire-articles-now
6606 Delete all the expirable articles in the group
6607 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
6608 articles that are eligible for expiry in the current group will
6609 disappear forever into that big @file{/dev/null} in the sky.
6612 @kindex B DEL (Summary)
6613 @findex gnus-summary-delete-article
6614 Delete the mail article. This is ``delete'' as in ``delete it from your
6615 disk forever and ever, never to return again.'' Use with caution.
6616 (@code{gnus-summary-delete-article}).
6619 @kindex B m (Summary)
6621 @findex gnus-summary-move-article
6622 Move the article from one mail group to another
6623 (@code{gnus-summary-move-article}).
6626 @kindex B c (Summary)
6628 @findex gnus-summary-copy-article
6629 Copy the article from one group (mail group or not) to a mail group
6630 (@code{gnus-summary-copy-article}).
6633 @kindex B C (Summary)
6634 @cindex crosspost mail
6635 @findex gnus-summary-crosspost-article
6636 Crosspost the current article to some other group
6637 (@code{gnus-summary-crosspost-article}). This will create a new copy of
6638 the article in the other group, and the Xref headers of the article will
6639 be properly updated.
6642 @kindex B i (Summary)
6643 @findex gnus-summary-import-article
6644 Import an arbitrary file into the current mail newsgroup
6645 (@code{gnus-summary-import-article}). You will be prompted for a file
6646 name, a @code{From} header and a @code{Subject} header.
6649 @kindex B r (Summary)
6650 @findex gnus-summary-respool-article
6651 Respool the mail article (@code{gnus-summary-move-article}).
6652 @code{gnus-summary-respool-default-method} will be used as the default
6653 select method when respooling. This variable is @code{nil} by default,
6654 which means that the current group select method will be used instead.
6658 @kindex B w (Summary)
6660 @findex gnus-summary-edit-article
6661 @kindex C-c C-c (Article)
6662 Edit the current article (@code{gnus-summary-edit-article}). To finish
6663 editing and make the changes permanent, type @kbd{C-c C-c}
6664 (@kbd{gnus-summary-edit-article-done}).
6667 @kindex B q (Summary)
6668 @findex gnus-summary-respool-query
6669 If you want to re-spool an article, you might be curious as to what group
6670 the article will end up in before you do the re-spooling. This command
6671 will tell you (@code{gnus-summary-respool-query}).
6674 @kindex B p (Summary)
6675 @findex gnus-summary-article-posted-p
6676 Some people have a tendency to send you "courtesy" copies when they
6677 follow up to articles you have posted. These usually have a
6678 @code{Newsgroups} header in them, but not always. This command
6679 (@code{gnus-summary-article-posted-p}) will try to fetch the current
6680 article from your news server (or rather, from
6681 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
6682 report back whether it found the article or not. Even if it says that
6683 it didn't find the article, it may have been posted anyway---mail
6684 propagation is much faster than news propagation, and the news copy may
6685 just not have arrived yet.
6689 @vindex gnus-move-split-methods
6690 @cindex moving articles
6691 If you move (or copy) articles regularly, you might wish to have Gnus
6692 suggest where to put the articles. @code{gnus-move-split-methods} is a
6693 variable that uses the same syntax as @code{gnus-split-methods}
6694 (@pxref{Saving Articles}). You may customize that variable to create
6695 suggestions you find reasonable.
6698 (setq gnus-move-split-methods
6699 '(("^From:.*Lars Magne" "nnml:junk")
6700 ("^Subject:.*gnus" "nnfolder:important")
6701 (".*" "nnml:misc")))
6705 @node Various Summary Stuff
6706 @section Various Summary Stuff
6709 * Summary Group Information:: Information oriented commands.
6710 * Searching for Articles:: Multiple article commands.
6711 * Summary Generation Commands:: (Re)generating the summary buffer.
6712 * Really Various Summary Commands:: Those pesky non-conformant commands.
6716 @vindex gnus-summary-mode-hook
6717 @item gnus-summary-mode-hook
6718 This hook is called when creating a summary mode buffer.
6720 @vindex gnus-summary-generate-hook
6721 @item gnus-summary-generate-hook
6722 This is called as the last thing before doing the threading and the
6723 generation of the summary buffer. It's quite convenient for customizing
6724 the threading variables based on what data the newsgroup has. This hook
6725 is called from the summary buffer after most summary buffer variables
6728 @vindex gnus-summary-prepare-hook
6729 @item gnus-summary-prepare-hook
6730 Is is called after the summary buffer has been generated. You might use
6731 it to, for instance, highlight lines or modify the look of the buffer in
6732 some other ungodly manner. I don't care.
6737 @node Summary Group Information
6738 @subsection Summary Group Information
6743 @kindex H f (Summary)
6744 @findex gnus-summary-fetch-faq
6745 @vindex gnus-group-faq-directory
6746 Try to fetch the FAQ (list of frequently asked questions) for the
6747 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
6748 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
6749 on a remote machine. This variable can also be a list of directories.
6750 In that case, giving a prefix to this command will allow you to choose
6751 between the various sites. @code{ange-ftp} probably will be used for
6755 @kindex H d (Summary)
6756 @findex gnus-summary-describe-group
6757 Give a brief description of the current group
6758 (@code{gnus-summary-describe-group}). If given a prefix, force
6759 rereading the description from the server.
6762 @kindex H h (Summary)
6763 @findex gnus-summary-describe-briefly
6764 Give an extremely brief description of the most important summary
6765 keystrokes (@code{gnus-summary-describe-briefly}).
6768 @kindex H i (Summary)
6769 @findex gnus-info-find-node
6770 Go to the Gnus info node (@code{gnus-info-find-node}).
6774 @node Searching for Articles
6775 @subsection Searching for Articles
6780 @kindex M-s (Summary)
6781 @findex gnus-summary-search-article-forward
6782 Search through all subsequent articles for a regexp
6783 (@code{gnus-summary-search-article-forward}).
6786 @kindex M-r (Summary)
6787 @findex gnus-summary-search-article-backward
6788 Search through all previous articles for a regexp
6789 (@code{gnus-summary-search-article-backward}).
6793 @findex gnus-summary-execute-command
6794 This command will prompt you for a header field, a regular expression to
6795 match on this field, and a command to be executed if the match is made
6796 (@code{gnus-summary-execute-command}).
6799 @kindex M-& (Summary)
6800 @findex gnus-summary-universal-argument
6801 Perform any operation on all articles that have been marked with
6802 the process mark (@code{gnus-summary-universal-argument}).
6805 @node Summary Generation Commands
6806 @subsection Summary Generation Commands
6811 @kindex Y g (Summary)
6812 @findex gnus-summary-prepare
6813 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
6816 @kindex Y c (Summary)
6817 @findex gnus-summary-insert-cached-articles
6818 Pull all cached articles (for the current group) into the summary buffer
6819 (@code{gnus-summary-insert-cached-articles}).
6824 @node Really Various Summary Commands
6825 @subsection Really Various Summary Commands
6830 @kindex C-d (Summary)
6831 @findex gnus-summary-enter-digest-group
6832 If the current article is a collection of other articles (for instance,
6833 a digest), you might use this command to enter a group based on the that
6834 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
6835 guess what article type is currently displayed unless you give a prefix
6836 to this command, which forces a ``digest'' interpretation. Basically,
6837 whenever you see a message that is a collection of other messages on
6838 some format, you @kbd{C-d} and read these messages in a more convenient
6842 @kindex M-C-d (Summary)
6843 @findex gnus-summary-read-document
6844 This command is very similar to the one above, but lets you gather
6845 several documents into one biiig group
6846 (@code{gnus-summary-read-document}). It does this by opening several
6847 @code{nndoc} groups for each document, and then opening an
6848 @code{nnvirtual} group on top of these @code{nndoc} groups. This
6849 command understands the process/prefix convention
6850 (@pxref{Process/Prefix}).
6853 @kindex C-t (Summary)
6854 @findex gnus-summary-toggle-truncation
6855 Toggle truncation of summary lines
6856 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
6857 line centering function in the summary buffer, so it's not a good idea
6858 to have truncation switched off while reading articles.
6862 @findex gnus-summary-expand-window
6863 Expand the summary buffer window (@code{gnus-summary-expand-window}).
6864 If given a prefix, force an @code{article} window configuration.
6869 @node Exiting the Summary Buffer
6870 @section Exiting the Summary Buffer
6871 @cindex summary exit
6872 @cindex exiting groups
6874 Exiting from the summary buffer will normally update all info on the
6875 group and return you to the group buffer.
6881 @kindex Z Z (Summary)
6883 @findex gnus-summary-exit
6884 @vindex gnus-summary-exit-hook
6885 @vindex gnus-summary-prepare-exit-hook
6886 Exit the current group and update all information on the group
6887 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
6888 called before doing much of the exiting, and calls
6889 @code{gnus-summary-expire-articles} by default.
6890 @code{gnus-summary-exit-hook} is called after finishing the exiting
6891 process. @code{gnus-group-no-more-groups-hook} is run when returning to
6892 group mode having no more (unread) groups.
6896 @kindex Z E (Summary)
6898 @findex gnus-summary-exit-no-update
6899 Exit the current group without updating any information on the group
6900 (@code{gnus-summary-exit-no-update}).
6904 @kindex Z c (Summary)
6906 @findex gnus-summary-catchup-and-exit
6907 Mark all unticked articles in the group as read and then exit
6908 (@code{gnus-summary-catchup-and-exit}).
6911 @kindex Z C (Summary)
6912 @findex gnus-summary-catchup-all-and-exit
6913 Mark all articles, even the ticked ones, as read and then exit
6914 (@code{gnus-summary-catchup-all-and-exit}).
6917 @kindex Z n (Summary)
6918 @findex gnus-summary-catchup-and-goto-next-group
6919 Mark all articles as read and go to the next group
6920 (@code{gnus-summary-catchup-and-goto-next-group}).
6923 @kindex Z R (Summary)
6924 @findex gnus-summary-reselect-current-group
6925 Exit this group, and then enter it again
6926 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
6927 all articles, both read and unread.
6931 @kindex Z G (Summary)
6932 @kindex M-g (Summary)
6933 @findex gnus-summary-rescan-group
6934 Exit the group, check for new articles in the group, and select the
6935 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
6936 articles, both read and unread.
6939 @kindex Z N (Summary)
6940 @findex gnus-summary-next-group
6941 Exit the group and go to the next group
6942 (@code{gnus-summary-next-group}).
6945 @kindex Z P (Summary)
6946 @findex gnus-summary-prev-group
6947 Exit the group and go to the previous group
6948 (@code{gnus-summary-prev-group}).
6951 @kindex Z s (Summary)
6952 @findex gnus-summary-save-newsrc
6953 Save the current number of read/marked articles in the dribble buffer
6954 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
6955 given a prefix, also save the @file{.newsrc} file(s). Using this
6956 command will make exit without updating (the @kbd{Q} command) worthless.
6959 @vindex gnus-exit-group-hook
6960 @code{gnus-exit-group-hook} is called when you exit the current
6963 @findex gnus-summary-wake-up-the-dead
6964 @findex gnus-dead-summary-mode
6965 @vindex gnus-kill-summary-on-exit
6966 If you're in the habit of exiting groups, and then changing your mind
6967 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
6968 If you do that, Gnus won't kill the summary buffer when you exit it.
6969 (Quelle surprise!) Instead it will change the name of the buffer to
6970 something like @samp{*Dead Summary ... *} and install a minor mode
6971 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
6972 buffer, you'll find that all keys are mapped to a function called
6973 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
6974 summary buffer will result in a live, normal summary buffer.
6976 There will never be more than one dead summary buffer at any one time.
6978 @vindex gnus-use-cross-reference
6979 The data on the current group will be updated (which articles you have
6980 read, which articles you have replied to, etc.) when you exit the
6981 summary buffer. If the @code{gnus-use-cross-reference} variable is
6982 @code{t} (which is the default), articles that are cross-referenced to
6983 this group and are marked as read, will also be marked as read in the
6984 other subscribed groups they were cross-posted to. If this variable is
6985 neither @code{nil} nor @code{t}, the article will be marked as read in
6986 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
6989 @node Crosspost Handling
6990 @section Crosspost Handling
6994 Marking cross-posted articles as read ensures that you'll never have to
6995 read the same article more than once. Unless, of course, somebody has
6996 posted it to several groups separately. Posting the same article to
6997 several groups (not cross-posting) is called @dfn{spamming}, and you are
6998 by law required to send nasty-grams to anyone who perpetrates such a
6999 heinous crime. You may want to try NoCeM handling to filter out spam
7002 Remember: Cross-posting is kinda ok, but posting the same article
7003 separately to several groups is not. Massive cross-posting (aka.
7004 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7005 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7006 excessive crossposting (@pxref{Summary Mail Commands}).
7008 @cindex cross-posting
7011 One thing that may cause Gnus to not do the cross-posting thing
7012 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7013 (which is very nice, because it speeds things up considerably) which
7014 does not include the @code{Xref} header in its @sc{nov} lines. This is
7015 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
7016 even with @sc{xover} by registering the @code{Xref} lines of all
7017 articles you actually read, but if you kill the articles, or just mark
7018 them as read without reading them, Gnus will not get a chance to snoop
7019 the @code{Xref} lines out of these articles, and will be unable to use
7020 the cross reference mechanism.
7022 @cindex LIST overview.fmt
7023 @cindex overview.fmt
7024 To check whether your @sc{nntp} server includes the @code{Xref} header
7025 in its overview files, try @samp{telnet your.nntp.server nntp},
7026 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7027 overview.fmt}. This may not work, but if it does, and the last line you
7028 get does not read @samp{Xref:full}, then you should shout and whine at
7029 your news admin until she includes the @code{Xref} header in the
7032 @vindex gnus-nov-is-evil
7033 If you want Gnus to get the @code{Xref}s right all the time, you have to
7034 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7039 For an alternative approach, @pxref{Duplicate Suppression}.
7042 @node Duplicate Suppression
7043 @section Duplicate Suppression
7045 By default, Gnus tries to make sure that you don't have to read the same
7046 article more than once by utilizing the crossposting mechanism
7047 (@pxref{Crosspost Handling}). However, that simple and efficient
7048 approach may not work satisfactorily for some users for various
7053 The @sc{nntp} server may fail to generate the @code{Xref} header. This
7054 is evil and not very common.
7057 The @sc{nntp} server may fail to include the @code{Xref} header in the
7058 @file{.overview} data bases. This is evil and all too common, alas.
7061 You may be reading the same group (or several related groups) from
7062 different @sc{nntp} servers.
7065 You may be getting mail that duplicates articles posted to groups.
7068 I'm sure there are other situations that @code{Xref} handling fails as
7069 well, but these four are the most common situations.
7071 If, and only if, @code{Xref} handling fails for you, then you may
7072 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
7073 will remember the @code{Message-ID}s of all articles you have read or
7074 otherwise marked as read, and then, as if by magic, mark them as read
7075 all subsequent times you see them---in @emph{all} groups. Using this
7076 mechanism is quite likely to be somewhat inefficient, but not overly
7077 so. It's certainly preferable to reading the same articles more than
7080 Duplicate suppression is not a very subtle instrument. It's more like a
7081 sledge hammer than anything else. It works in a very simple
7082 fashion---if you have marked an article as read, it adds this Message-ID
7083 to a cache. The next time it sees this Message-ID, it will mark the
7084 article as read the the @samp{M} mark. It doesn't care what group it
7088 @item gnus-suppress-duplicates
7089 @vindex gnus-suppress-duplicates
7090 If non-@code{nil}, suppress duplicates.
7092 @item gnus-save-duplicate-list
7093 @vindex gnus-save-duplicate-list
7094 If non-@code{nil}, save the list of duplicates to a file. This will
7095 make startup and shutdown take longer, so the default is @code{nil}.
7096 However, this means that only duplicate articles that is read in a
7097 single Gnus session are suppressed.
7099 @item gnus-duplicate-list-length
7100 @vindex gnus-duplicate-list-length
7101 This variables says how many @code{Message-ID}s to keep in the duplicate
7102 suppression list. The default is 10000.
7104 @item gnus-duplicate-file
7105 @vindex gnus-duplicate-file
7106 The name of the file to store the duplicate suppression list. The
7107 default is @file{~/News/suppression}.
7110 If you have a tendency to stop and start Gnus often, setting
7111 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
7112 you leave Gnus running for weeks on end, you may have it @code{nil}. On
7113 the other hand, saving the list makes startup and shutdown much slower,
7114 so that means that if you stop and start Gnus often, you should set
7115 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
7116 to you to figure out, I think.
7119 @node The Article Buffer
7120 @chapter The Article Buffer
7121 @cindex article buffer
7123 The articles are displayed in the article buffer, of which there is only
7124 one. All the summary buffers share the same article buffer unless you
7125 tell Gnus otherwise.
7128 * Hiding Headers:: Deciding what headers should be displayed.
7129 * Using MIME:: Pushing articles through @sc{mime} before reading them.
7130 * Customizing Articles:: Tailoring the look of the articles.
7131 * Article Keymap:: Keystrokes available in the article buffer.
7132 * Misc Article:: Other stuff.
7136 @node Hiding Headers
7137 @section Hiding Headers
7138 @cindex hiding headers
7139 @cindex deleting headers
7141 The top section of each article is the @dfn{head}. (The rest is the
7142 @dfn{body}, but you may have guessed that already.)
7144 @vindex gnus-show-all-headers
7145 There is a lot of useful information in the head: the name of the person
7146 who wrote the article, the date it was written and the subject of the
7147 article. That's well and nice, but there's also lots of information
7148 most people do not want to see---what systems the article has passed
7149 through before reaching you, the @code{Message-ID}, the
7150 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7151 of some of those lines. If you want to keep all those lines in the
7152 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7154 Gnus provides you with two variables for sifting headers:
7158 @item gnus-visible-headers
7159 @vindex gnus-visible-headers
7160 If this variable is non-@code{nil}, it should be a regular expression
7161 that says what headers you wish to keep in the article buffer. All
7162 headers that do not match this variable will be hidden.
7164 For instance, if you only want to see the name of the person who wrote
7165 the article and the subject, you'd say:
7168 (setq gnus-visible-headers "^From:\\|^Subject:")
7171 This variable can also be a list of regexps to match headers that are to
7174 @item gnus-ignored-headers
7175 @vindex gnus-ignored-headers
7176 This variable is the reverse of @code{gnus-visible-headers}. If this
7177 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7178 should be a regular expression that matches all lines that you want to
7179 hide. All lines that do not match this variable will remain visible.
7181 For instance, if you just want to get rid of the @code{References} line
7182 and the @code{Xref} line, you might say:
7185 (setq gnus-ignored-headers "^References:\\|^Xref:")
7188 This variable can also be a list of regexps to match headers that are to
7191 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7192 variable will have no effect.
7196 @vindex gnus-sorted-header-list
7197 Gnus can also sort the headers for you. (It does this by default.) You
7198 can control the sorting by setting the @code{gnus-sorted-header-list}
7199 variable. It is a list of regular expressions that says in what order
7200 the headers are to be displayed.
7202 For instance, if you want the name of the author of the article first,
7203 and then the subject, you might say something like:
7206 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7209 Any headers that are to remain visible, but are not listed in this
7210 variable, will be displayed in random order after all the headers that
7211 are listed in this variable.
7213 @findex gnus-article-hide-boring-headers
7214 @vindex gnus-article-display-hook
7215 @vindex gnus-boring-article-headers
7216 You can hide further boring headers by entering
7217 @code{gnus-article-hide-boring-headers} into
7218 @code{gnus-article-display-hook}. What this function does depends on
7219 the @code{gnus-boring-article-headers} variable. It's a list, but this
7220 list doesn't actually contain header names. Instead is lists various
7221 @dfn{boring conditions} that Gnus can check and remove from sight.
7223 These conditions are:
7226 Remove all empty headers.
7228 Remove the @code{Newsgroups} header if it only contains the current group
7231 Remove the @code{Followup-To} header if it is identical to the
7232 @code{Newsgroups} header.
7234 Remove the @code{Reply-To} header if it lists the same address as the
7237 Remove the @code{Date} header if the article is less than three days
7241 To include the four first elements, you could say something like;
7244 (setq gnus-boring-article-headers
7245 '(empty newsgroups followup-to reply-to))
7248 This is also the default value for this variable.
7252 @section Using @sc{mime}
7255 Mime is a standard for waving your hands through the air, aimlessly,
7256 while people stand around yawning.
7258 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7259 while all newsreaders die of fear.
7261 @sc{mime} may specify what character set the article uses, the encoding
7262 of the characters, and it also makes it possible to embed pictures and
7263 other naughty stuff in innocent-looking articles.
7265 @vindex gnus-show-mime
7266 @vindex gnus-show-mime-method
7267 @vindex gnus-strict-mime
7268 @findex metamail-buffer
7269 Gnus handles @sc{mime} by pushing the articles through
7270 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7271 default. Set @code{gnus-show-mime} to @code{t} if you want to use
7272 @sc{mime} all the time. However, if @code{gnus-strict-mime} is
7273 non-@code{nil}, the @sc{mime} method will only be used if there are
7274 @sc{mime} headers in the article. If you have @code{gnus-show-mime}
7275 set, then you'll see some unfortunate display glitches in the article
7276 buffer. These can't be avoided.
7278 It might be best to just use the toggling functions from the summary
7279 buffer to avoid getting nasty surprises. (For instance, you enter the
7280 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7281 decoded the sound file in the article and some horrible sing-a-long song
7282 comes streaming out out your speakers, and you can't find the volume
7283 button, because there isn't one, and people are starting to look at you,
7284 and you try to stop the program, but you can't, and you can't find the
7285 program to control the volume, and everybody else in the room suddenly
7286 decides to look at you disdainfully, and you'll feel rather stupid.)
7288 Any similarity to real events and people is purely coincidental. Ahem.
7291 @node Customizing Articles
7292 @section Customizing Articles
7293 @cindex article customization
7295 @vindex gnus-article-display-hook
7296 The @code{gnus-article-display-hook} is called after the article has
7297 been inserted into the article buffer. It is meant to handle all
7298 treatment of the article before it is displayed.
7300 @findex gnus-article-maybe-highlight
7301 By default this hook just contains @code{gnus-article-hide-headers},
7302 @code{gnus-article-treat-overstrike}, and
7303 @code{gnus-article-maybe-highlight}, but there are thousands, nay
7304 millions, of functions you can put in this hook. For an overview of
7305 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7306 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7307 Date}. Note that the order of functions in this hook might affect
7308 things, so you may have to fiddle a bit to get the desired results.
7310 You can, of course, write your own functions. The functions are called
7311 from the article buffer, and you can do anything you like, pretty much.
7312 There is no information that you have to keep in the buffer---you can
7313 change everything. However, you shouldn't delete any headers. Instead
7314 make them invisible if you want to make them go away.
7317 @node Article Keymap
7318 @section Article Keymap
7320 Most of the keystrokes in the summary buffer can also be used in the
7321 article buffer. They should behave as if you typed them in the summary
7322 buffer, which means that you don't actually have to have a summary
7323 buffer displayed while reading. You can do it all from the article
7326 A few additional keystrokes are available:
7331 @kindex SPACE (Article)
7332 @findex gnus-article-next-page
7333 Scroll forwards one page (@code{gnus-article-next-page}).
7336 @kindex DEL (Article)
7337 @findex gnus-article-prev-page
7338 Scroll backwards one page (@code{gnus-article-prev-page}).
7341 @kindex C-c ^ (Article)
7342 @findex gnus-article-refer-article
7343 If point is in the neighborhood of a @code{Message-ID} and you press
7344 @kbd{r}, Gnus will try to get that article from the server
7345 (@code{gnus-article-refer-article}).
7348 @kindex C-c C-m (Article)
7349 @findex gnus-article-mail
7350 Send a reply to the address near point (@code{gnus-article-mail}). If
7351 given a prefix, include the mail.
7355 @findex gnus-article-show-summary
7356 Reconfigure the buffers so that the summary buffer becomes visible
7357 (@code{gnus-article-show-summary}).
7361 @findex gnus-article-describe-briefly
7362 Give a very brief description of the available keystrokes
7363 (@code{gnus-article-describe-briefly}).
7366 @kindex TAB (Article)
7367 @findex gnus-article-next-button
7368 Go to the next button, if any (@code{gnus-article-next-button}. This
7369 only makes sense if you have buttonizing turned on.
7372 @kindex M-TAB (Article)
7373 @findex gnus-article-prev-button
7374 Go to the previous button, if any (@code{gnus-article-prev-button}.
7380 @section Misc Article
7384 @item gnus-single-article-buffer
7385 @vindex gnus-single-article-buffer
7386 If non-@code{nil}, use the same article buffer for all the groups.
7387 (This is the default.) If @code{nil}, each group will have its own
7390 @vindex gnus-article-prepare-hook
7391 @item gnus-article-prepare-hook
7392 This hook is called right after the article has been inserted into the
7393 article buffer. It is mainly intended for functions that do something
7394 depending on the contents; it should probably not be used for changing
7395 the contents of the article buffer.
7397 @vindex gnus-article-display-hook
7398 @item gnus-article-display-hook
7399 This hook is called as the last thing when displaying an article, and is
7400 intended for modifying the contents of the buffer, doing highlights,
7401 hiding headers, and the like.
7403 @item gnus-article-mode-hook
7404 @vindex gnus-article-mode-hook
7405 Hook called in article mode buffers.
7407 @item gnus-article-mode-syntax-table
7408 @vindex gnus-article-mode-syntax-table
7409 Syntax table used in article buffers. It is initialized from
7410 @code{text-mode-syntax-table}.
7412 @vindex gnus-article-mode-line-format
7413 @item gnus-article-mode-line-format
7414 This variable is a format string along the same lines as
7415 @code{gnus-summary-mode-line-format}. It accepts the same
7416 format specifications as that variable, with one extension:
7420 The @dfn{wash status} of the article. This is a short string with one
7421 character for each possible article wash operation that may have been
7425 @vindex gnus-break-pages
7427 @item gnus-break-pages
7428 Controls whether @dfn{page breaking} is to take place. If this variable
7429 is non-@code{nil}, the articles will be divided into pages whenever a
7430 page delimiter appears in the article. If this variable is @code{nil},
7431 paging will not be done.
7433 @item gnus-page-delimiter
7434 @vindex gnus-page-delimiter
7435 This is the delimiter mentioned above. By default, it is @samp{^L}
7440 @node Composing Messages
7441 @chapter Composing Messages
7446 @kindex C-c C-c (Post)
7447 All commands for posting and mailing will put you in a message buffer
7448 where you can edit the article all you like, before you send the article
7449 by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The Message
7450 Manual}. If you are in a foreign news group, and you wish to post the
7451 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
7452 to make Gnus try to post using the foreign server.
7455 * Mail:: Mailing and replying.
7456 * Post:: Posting and following up.
7457 * Posting Server:: What server should you post via?
7458 * Mail and Post:: Mailing and posting at the same time.
7459 * Archived Messages:: Where Gnus stores the messages you've sent.
7460 @c * Posting Styles:: An easier way to configure some key elements.
7461 @c * Drafts:: Postponing messages and rejected messages.
7462 @c * Rejected Articles:: What happens if the server doesn't like your article?
7465 Also see @pxref{Canceling and Superseding} for information on how to
7466 remove articles you shouldn't have posted.
7472 Variables for customizing outgoing mail:
7475 @item gnus-uu-digest-headers
7476 @vindex gnus-uu-digest-headers
7477 List of regexps to match headers included in digested messages. The
7478 headers will be included in the sequence they are matched.
7486 Variables for composing news articles:
7489 @item gnus-sent-message-ids-file
7490 @vindex gnus-sent-message-ids-file
7491 Gnus will keep a @code{Message-ID} history file of all the mails it has
7492 sent. If it discovers that it has already sent a mail, it will ask the
7493 user whether to re-send the mail. (This is primarily useful when
7494 dealing with @sc{soup} packets and the like where one is apt to sent the
7495 same packet multiple times.) This variable says what the name of this
7496 history file is. It is @file{~/News/Sent-Message-IDs} by default. Set
7497 this variable to @code{nil} if you don't want Gnus to keep a history
7500 @item gnus-sent-message-ids-length
7501 @vindex gnus-sent-message-ids-length
7502 This variable says how many @code{Message-ID}s to keep in the history
7503 file. It is 1000 by default.
7508 @node Posting Server
7509 @section Posting Server
7511 When you press those magical @kbd{C-c C-c} keys to ship off your latest
7512 (extremely intelligent, of course) article, where does it go?
7514 Thank you for asking. I hate you.
7516 @vindex gnus-post-method
7518 It can be quite complicated. Normally, Gnus will use the same native
7519 server. However. If your native server doesn't allow posting, just
7520 reading, you probably want to use some other server to post your
7521 (extremely intelligent and fabulously interesting) articles. You can
7522 then set the @code{gnus-post-method} to some other method:
7525 (setq gnus-post-method '(nnspool ""))
7528 Now, if you've done this, and then this server rejects your article, or
7529 this server is down, what do you do then? To override this variable you
7530 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
7531 the ``current'' server for posting.
7533 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
7534 Gnus will prompt you for what method to use for posting.
7536 You can also set @code{gnus-post-method} to a list of select methods.
7537 If that's the case, Gnus will always prompt you for what method to use
7542 @section Mail and Post
7544 Here's a list of variables that are relevant to both mailing and
7548 @item gnus-mailing-list-groups
7549 @findex gnus-mailing-list-groups
7550 @cindex mailing lists
7552 If your news server offers groups that are really mailing lists that are
7553 gatewayed to the @sc{nntp} server, you can read those groups without
7554 problems, but you can't post/followup to them without some difficulty.
7555 One solution is to add a @code{to-address} to the group parameters
7556 (@pxref{Group Parameters}). An easier thing to do is set the
7557 @code{gnus-mailing-list-groups} to a regexp that match the groups that
7558 really are mailing lists. Then, at least, followups to the mailing
7559 lists will work most of the time. Posting to these groups (@kbd{a}) is
7560 still a pain, though.
7564 You may want to do spell-checking on messages that you send out. Or, if
7565 you don't want to spell-check by hand, you could add automatic
7566 spell-checking via the @code{ispell} package:
7569 @findex ispell-message
7571 (add-hook 'message-send-hook 'ispell-message)
7575 @node Archived Messages
7576 @section Archived Messages
7577 @cindex archived messages
7578 @cindex sent messages
7580 Gnus provides a few different methods for storing the mail you send.
7581 The default method is to use the @dfn{archive virtual server} to store
7582 the mail. If you want to disable this completely, the
7583 @code{gnus-message-archive-group} variable should be @code{nil}, which
7586 @vindex gnus-message-archive-method
7587 @code{gnus-message-archive-method} says what virtual server Gnus is to
7588 use to store sent messages. The default is:
7592 (nnfolder-directory "~/Mail/archive/"))
7595 You can, however, use any mail select method (@code{nnml},
7596 @code{nnmbox}, etc.). @code{nnfolder} is a quite likeable select method
7597 for doing this sort of thing, though. If you don't like the default
7598 directory chosen, you could say something like:
7601 (setq gnus-message-archive-method
7602 '(nnfolder "archive"
7603 (nnfolder-inhibit-expiry t)
7604 (nnfolder-active-file "~/News/sent-mail/active")
7605 (nnfolder-directory "~/News/sent-mail/")))
7608 @vindex gnus-message-archive-group
7610 Gnus will insert @code{Gcc} headers in all outgoing messages that point
7611 to one or more group(s) on that server. Which group to use is
7612 determined by the @code{gnus-message-archive-group} variable.
7614 This variable can be:
7618 Messages will be saved in that group.
7619 @item a list of strings
7620 Messages will be saved in all those groups.
7621 @item an alist of regexps, functions and forms
7622 When a key ``matches'', the result is used.
7624 No message archiving will take place. This is the default.
7629 Just saving to a single group called @samp{MisK}:
7631 (setq gnus-message-archive-group "MisK")
7634 Saving to two groups, @samp{MisK} and @samp{safe}:
7636 (setq gnus-message-archive-group '("MisK" "safe"))
7639 Save to different groups based on what group you are in:
7641 (setq gnus-message-archive-group
7642 '(("^alt" "sent-to-alt")
7643 ("mail" "sent-to-mail")
7644 (".*" "sent-to-misc")))
7649 (setq gnus-message-archive-group
7650 '((if (message-news-p)
7655 How about storing all news messages in one file, but storing all mail
7656 messages in one file per month:
7659 (setq gnus-message-archive-group
7660 '((if (message-news-p)
7662 (concat "mail." (format-time-string
7663 "%Y-%m" (current-time))))))
7666 Now, when you send a message off, it will be stored in the appropriate
7667 group. (If you want to disable storing for just one particular message,
7668 you can just remove the @code{Gcc} header that has been inserted.) The
7669 archive group will appear in the group buffer the next time you start
7670 Gnus, or the next time you press @kbd{F} in the group buffer. You can
7671 enter it and read the articles in it just like you'd read any other
7672 group. If the group gets really big and annoying, you can simply rename
7673 if (using @kbd{G r} in the group buffer) to something
7674 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
7675 continue to be stored in the old (now empty) group.
7677 That's the default method of archiving sent mail. Gnus also a different
7678 way for the people who don't like the default method. In that case you
7679 should set @code{gnus-message-archive-group} to @code{nil}; this will
7682 XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
7683 use a different value for @code{gnus-message-archive-group} there.
7686 @item gnus-outgoing-message-group
7687 @vindex gnus-outgoing-message-group
7688 All outgoing messages will be put in this group. If you want to store
7689 all your outgoing mail and articles in the group @samp{nnml:archive},
7690 you set this variable to that value. This variable can also be a list of
7693 If you want to have greater control over what group to put each
7694 message in, you can set this variable to a function that checks the
7695 current newsgroup name and then returns a suitable group name (or list
7700 @c @node Posting Styles
7701 @c @section Posting Styles
7702 @c @cindex posting styles
7705 @c All them variables, they make my head swim.
7707 @c So what if you want a different @code{Organization} and signature based
7708 @c on what groups you post to? And you post both from your home machine
7709 @c and your work machine, and you want different @code{From} lines, and so
7712 @c @vindex gnus-posting-styles
7713 @c One way to do stuff like that is to write clever hooks that change the
7714 @c variables you need to have changed. That's a bit boring, so somebody
7715 @c came up with the bright idea of letting the user specify these things in
7716 @c a handy alist. Here's an example of a @code{gnus-posting-styles}
7721 @c (signature . "Peace and happiness")
7722 @c (organization . "What me?"))
7724 @c (signature . "Death to everybody"))
7725 @c ("comp.emacs.i-love-it"
7726 @c (organization . "Emacs is it")))
7729 @c As you might surmise from this example, this alist consists of several
7730 @c @dfn{styles}. Each style will be applicable if the first element
7731 @c ``matches'', in some form or other. The entire alist will be iterated
7732 @c over, from the beginning towards the end, and each match will be
7733 @c applied, which means that attributes in later styles that match override
7734 @c the same attributes in earlier matching styles. So
7735 @c @samp{comp.programming.literate} will have the @samp{Death to everybody}
7736 @c signature and the @samp{What me?} @code{Organization} header.
7738 @c The first element in each style is called the @code{match}. If it's a
7739 @c string, then Gnus will try to regexp match it against the group name.
7740 @c If it's a function symbol, that function will be called with no
7741 @c arguments. If it's a variable symbol, then the variable will be
7742 @c referenced. If it's a list, then that list will be @code{eval}ed. In
7743 @c any case, if this returns a non-@code{nil} value, then the style is said
7746 @c Each style may contain a arbitrary amount of @dfn{attributes}. Each
7747 @c attribute consists of a @var{(name . value)} pair. The attribute name
7748 @c can be one of @code{signature}, @code{organization} or @code{from}. The
7749 @c attribute name can also be a string. In that case, this will be used as
7750 @c a header name, and the value will be inserted in the headers of the
7753 @c The attribute value can be a string (used verbatim), a function (the
7754 @c return value will be used), a variable (its value will be used) or a
7755 @c list (it will be @code{eval}ed and the return value will be used).
7757 @c So here's a new example:
7760 @c (setq gnus-posting-styles
7762 @c (signature . "~/.signature")
7763 @c (from . "user@@foo (user)")
7764 @c ("X-Home-Page" . (getenv "WWW_HOME"))
7765 @c (organization . "People's Front Against MWM"))
7767 @c (signature . my-funny-signature-randomizer))
7768 @c ((equal (system-name) "gnarly")
7769 @c (signature . my-quote-randomizer))
7770 @c (posting-from-work-p
7771 @c (signature . "~/.work-signature")
7772 @c (from . "user@@bar.foo (user)")
7773 @c (organization . "Important Work, Inc"))
7775 @c (signature . "~/.mail-signature"))))
7782 @c If you are writing a message (mail or news) and suddenly remember that
7783 @c you have a steak in the oven (or some pesto in the food processor, you
7784 @c craazy vegetarians), you'll probably wish there was a method to save the
7785 @c message you are writing so that you can continue editing it some other
7786 @c day, and send it when you feel its finished.
7788 @c Well, don't worry about it. Whenever you start composing a message of
7789 @c some sort using the Gnus mail and post commands, the buffer you get will
7790 @c automatically associate to an article in a special @dfn{draft} group.
7791 @c If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
7792 @c article will be saved there. (Auto-save files also go to the draft
7796 @c @vindex gnus-draft-group-directory
7797 @c The draft group is a special group (which is implemented as an
7798 @c @code{nndraft} group, if you absolutely have to know) called
7799 @c @samp{nndraft:drafts}. The variable @code{gnus-draft-group-directory}
7800 @c controls both the name of the group and the location---the leaf element
7801 @c in the path will be used as the name of the group. What makes this
7802 @c group special is that you can't tick any articles in it or mark any
7803 @c articles as read---all articles in the group are permanently unread.
7805 @c If the group doesn't exist, it will be created and you'll be subscribed
7808 @c @findex gnus-dissociate-buffer-from-draft
7809 @c @kindex C-c M-d (Mail)
7810 @c @kindex C-c M-d (Post)
7811 @c @findex gnus-associate-buffer-with-draft
7812 @c @kindex C-c C-d (Mail)
7813 @c @kindex C-c C-d (Post)
7814 @c If you're writing some super-secret message that you later want to
7815 @c encode with PGP before sending, you may wish to turn the auto-saving
7816 @c (and association with the draft group) off. You never know who might be
7817 @c interested in reading all your extremely valuable and terribly horrible
7818 @c and interesting secrets. The @kbd{C-c M-d}
7819 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
7820 @c If you change your mind and want to turn the auto-saving back on again,
7821 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
7823 @c @vindex gnus-use-draft
7824 @c To leave association with the draft group off by default, set
7825 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
7827 @c @findex gnus-summary-send-draft
7828 @c @kindex S D c (Summary)
7829 @c When you want to continue editing the article, you simply enter the
7830 @c draft group and push @kbd{S D c} (@code{gnus-summary-send-draft}) to do
7831 @c that. You will be placed in a buffer where you left off.
7833 @c Rejected articles will also be put in this draft group (@pxref{Rejected
7836 @c @findex gnus-summary-send-all-drafts
7837 @c If you have lots of rejected messages you want to post (or mail) without
7838 @c doing further editing, you can use the @kbd{S D a} command
7839 @c (@code{gnus-summary-send-all-drafts}). This command understands the
7840 @c process/prefix convention (@pxref{Process/Prefix}).
7843 @c @node Rejected Articles
7844 @c @section Rejected Articles
7845 @c @cindex rejected articles
7847 @c Sometimes a news server will reject an article. Perhaps the server
7848 @c doesn't like your face. Perhaps it just feels miserable. Perhaps
7849 @c @emph{there be demons}. Perhaps you have included too much cited text.
7850 @c Perhaps the disk is full. Perhaps the server is down.
7852 @c These situations are, of course, totally beyond the control of Gnus.
7853 @c (Gnus, of course, loves the way you look, always feels great, has angels
7854 @c fluttering around inside of it, doesn't care about how much cited text
7855 @c you include, never runs full and never goes down.) So Gnus saves these
7856 @c articles until some later time when the server feels better.
7858 @c The rejected articles will automatically be put in a special draft group
7859 @c (@pxref{Drafts}). When the server comes back up again, you'd then
7860 @c typically enter that group and send all the articles off.
7863 @node Select Methods
7864 @chapter Select Methods
7865 @cindex foreign groups
7866 @cindex select methods
7868 A @dfn{foreign group} is a group that is not read by the usual (or
7869 default) means. It could be, for instance, a group from a different
7870 @sc{nntp} server, it could be a virtual group, or it could be your own
7871 personal mail group.
7873 A foreign group (or any group, really) is specified by a @dfn{name} and
7874 a @dfn{select method}. To take the latter first, a select method is a
7875 list where the first element says what backend to use (e.g. @code{nntp},
7876 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
7877 name}. There may be additional elements in the select method, where the
7878 value may have special meaning for the backend in question.
7880 One could say that a select method defines a @dfn{virtual server}---so
7881 we do just that (@pxref{The Server Buffer}).
7883 The @dfn{name} of the group is the name the backend will recognize the
7886 For instance, the group @samp{soc.motss} on the @sc{nntp} server
7887 @samp{some.where.edu} will have the name @samp{soc.motss} and select
7888 method @code{(nntp "some.where.edu")}. Gnus will call this group
7889 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
7890 backend just knows this group as @samp{soc.motss}.
7892 The different methods all have their peculiarities, of course.
7895 * The Server Buffer:: Making and editing virtual servers.
7896 * Getting News:: Reading USENET news with Gnus.
7897 * Getting Mail:: Reading your personal mail with Gnus.
7898 * Other Sources:: Reading directories, files, SOUP packets.
7899 * Combined Groups:: Combining groups into one group.
7903 @node The Server Buffer
7904 @section The Server Buffer
7906 Traditionally, a @dfn{server} is a machine or a piece of software that
7907 one connects to, and then requests information from. Gnus does not
7908 connect directly to any real servers, but does all transactions through
7909 one backend or other. But that's just putting one layer more between
7910 the actual media and Gnus, so we might just as well say that each
7911 backend represents a virtual server.
7913 For instance, the @code{nntp} backend may be used to connect to several
7914 different actual @sc{nntp} servers, or, perhaps, to many different ports
7915 on the same actual @sc{nntp} server. You tell Gnus which backend to
7916 use, and what parameters to set by specifying a @dfn{select method}.
7918 These select methods specifications can sometimes become quite
7919 complicated---say, for instance, that you want to read from the
7920 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
7921 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
7922 Anyways, if you had to specify that for each group that used this
7923 server, that would be too much work, so Gnus offers a way of naming
7924 select methods, which is what you do in the server buffer.
7926 To enter the server buffer, user the @kbd{^}
7927 (@code{gnus-group-enter-server-mode}) command in the group buffer.
7930 * Server Buffer Format:: You can customize the look of this buffer.
7931 * Server Commands:: Commands to manipulate servers.
7932 * Example Methods:: Examples server specifications.
7933 * Creating a Virtual Server:: An example session.
7934 * Servers and Methods:: You can use server names as select methods.
7935 * Unavailable Servers:: Some servers you try to contact may be down.
7938 @vindex gnus-server-mode-hook
7939 @code{gnus-server-mode-hook} is run when creating the server buffer.
7942 @node Server Buffer Format
7943 @subsection Server Buffer Format
7944 @cindex server buffer format
7946 @vindex gnus-server-line-format
7947 You can change the look of the server buffer lines by changing the
7948 @code{gnus-server-line-format} variable. This is a @code{format}-like
7949 variable, with some simple extensions:
7954 How the news is fetched---the backend name.
7957 The name of this server.
7960 Where the news is to be fetched from---the address.
7963 The opened/closed/denied status of the server.
7966 @vindex gnus-server-mode-line-format
7967 The mode line can also be customized by using the
7968 @code{gnus-server-mode-line-format} variable. The following specs are
7979 Also @pxref{Formatting Variables}.
7982 @node Server Commands
7983 @subsection Server Commands
7984 @cindex server commands
7990 @findex gnus-server-add-server
7991 Add a new server (@code{gnus-server-add-server}).
7995 @findex gnus-server-edit-server
7996 Edit a server (@code{gnus-server-edit-server}).
7999 @kindex SPACE (Server)
8000 @findex gnus-server-read-server
8001 Browse the current server (@code{gnus-server-read-server}).
8005 @findex gnus-server-exit
8006 Return to the group buffer (@code{gnus-server-exit}).
8010 @findex gnus-server-kill-server
8011 Kill the current server (@code{gnus-server-kill-server}).
8015 @findex gnus-server-yank-server
8016 Yank the previously killed server (@code{gnus-server-yank-server}).
8020 @findex gnus-server-copy-server
8021 Copy the current server (@code{gnus-server-copy-server}).
8025 @findex gnus-server-list-servers
8026 List all servers (@code{gnus-server-list-servers}).
8030 @findex gnus-server-scan-server
8031 Request that the server scan its sources for new articles
8032 (@code{gnus-server-scan-server}). This is mainly sensible with mail
8037 @findex gnus-server-regenerate-server
8038 Request that the server regenerate all its data structures
8039 (@code{gnus-server-regenerate-server}). This can be useful if you have
8040 a mail backend that has gotten out of synch.
8045 @node Example Methods
8046 @subsection Example Methods
8048 Most select methods are pretty simple and self-explanatory:
8051 (nntp "news.funet.fi")
8054 Reading directly from the spool is even simpler:
8060 As you can see, the first element in a select method is the name of the
8061 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8064 After these two elements, there may be a arbitrary number of
8065 @var{(variable form)} pairs.
8067 To go back to the first example---imagine that you want to read from
8068 port 15 from that machine. This is what the select method should
8072 (nntp "news.funet.fi" (nntp-port-number 15))
8075 You should read the documentation to each backend to find out what
8076 variables are relevant, but here's an @code{nnmh} example.
8078 @code{nnmh} is a mail backend that reads a spool-like structure. Say
8079 you have two structures that you wish to access: One is your private
8080 mail spool, and the other is a public one. Here's the possible spec for
8084 (nnmh "private" (nnmh-directory "~/private/mail/"))
8087 (This server is then called @samp{private}, but you may have guessed
8090 Here's the method for a public spool:
8094 (nnmh-directory "/usr/information/spool/")
8095 (nnmh-get-new-mail nil))
8098 If you are behind a firewall and only have access to the @sc{nntp}
8099 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8100 on the firewall machine and telnet from there to the @sc{nntp} server.
8101 Doing this can be rather fiddly, but your virtual server definition
8102 should probably look something like this:
8106 (nntp-address "the.firewall.machine")
8107 (nntp-open-connection-function nntp-open-rlogin)
8108 (nntp-end-of-line "\n")
8109 (nntp-rlogin-parameters
8110 ("telnet" "the.real.nntp.host" "nntp")))
8115 @node Creating a Virtual Server
8116 @subsection Creating a Virtual Server
8118 If you're saving lots of articles in the cache by using persistent
8119 articles, you may want to create a virtual server to read the cache.
8121 First you need to add a new server. The @kbd{a} command does that. It
8122 would probably be best to use @code{nnspool} to read the cache. You
8123 could also use @code{nnml} or @code{nnmh}, though.
8125 Type @kbd{a nnspool RET cache RET}.
8127 You should now have a brand new @code{nnspool} virtual server called
8128 @samp{cache}. You now need to edit it to have the right definitions.
8129 Type @kbd{e} to edit the server. You'll be entered into a buffer that
8130 will contain the following:
8140 (nnspool-spool-directory "~/News/cache/")
8141 (nnspool-nov-directory "~/News/cache/")
8142 (nnspool-active-file "~/News/cache/active"))
8145 Type @kbd{C-c C-c} to return to the server buffer. If you now press
8146 @kbd{RET} over this virtual server, you should be entered into a browse
8147 buffer, and you should be able to enter any of the groups displayed.
8150 @node Servers and Methods
8151 @subsection Servers and Methods
8153 Wherever you would normally use a select method
8154 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8155 when browsing a foreign server) you can use a virtual server name
8156 instead. This could potentially save lots of typing. And it's nice all
8160 @node Unavailable Servers
8161 @subsection Unavailable Servers
8163 If a server seems to be unreachable, Gnus will mark that server as
8164 @code{denied}. That means that any subsequent attempt to make contact
8165 with that server will just be ignored. ``It can't be opened,'' Gnus
8166 will tell you, without making the least effort to see whether that is
8167 actually the case or not.
8169 That might seem quite naughty, but it does make sense most of the time.
8170 Let's say you have 10 groups subscribed to the server
8171 @samp{nepholococcygia.com}. This server is located somewhere quite far
8172 away from you, the machine is quite, so it takes 1 minute just to find
8173 out that it refuses connection from you today. If Gnus were to attempt
8174 to do that 10 times, you'd be quite annoyed, so Gnus won't attempt to do
8175 that. Once it has gotten a single ``connection refused'', it will
8176 regard that server as ``down''.
8178 So, what happens if the machine was only feeling unwell temporarily?
8179 How do you test to see whether the machine has come up again?
8181 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8182 with the following commands:
8188 @findex gnus-server-open-server
8189 Try to establish connection to the server on the current line
8190 (@code{gnus-server-open-server}).
8194 @findex gnus-server-close-server
8195 Close the connection (if any) to the server
8196 (@code{gnus-server-close-server}).
8200 @findex gnus-server-deny-server
8201 Mark the current server as unreachable
8202 (@code{gnus-server-deny-server}).
8205 @kindex M-o (Server)
8206 @findex gnus-server-open-all-servers
8207 Open the connections to all servers in the buffer
8208 (@code{gnus-server-open-all-servers}).
8211 @kindex M-c (Server)
8212 @findex gnus-server-close-all-servers
8213 Close the connections to all servers in the buffer
8214 (@code{gnus-server-close-all-servers}).
8218 @findex gnus-server-remove-denials
8219 Remove all marks to whether Gnus was denied connection from all servers
8220 (@code{gnus-server-remove-denials}).
8226 @section Getting News
8227 @cindex reading news
8228 @cindex news backends
8230 A newsreader is normally used for reading news. Gnus currently provides
8231 only two methods of getting news---it can read from an @sc{nntp} server,
8232 or it can read from a local spool.
8235 * NNTP:: Reading news from an @sc{nntp} server.
8236 * News Spool:: Reading news from the local spool.
8241 @subsection @sc{nntp}
8244 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8245 You just specify @code{nntp} as method and the address of the @sc{nntp}
8246 server as the, uhm, address.
8248 If the @sc{nntp} server is located at a non-standard port, setting the
8249 third element of the select method to this port number should allow you
8250 to connect to the right port. You'll have to edit the group info for
8251 that (@pxref{Foreign Groups}).
8253 The name of the foreign group can be the same as a native group. In
8254 fact, you can subscribe to the same group from as many different servers
8255 you feel like. There will be no name collisions.
8257 The following variables can be used to create a virtual @code{nntp}
8262 @item nntp-server-opened-hook
8263 @vindex nntp-server-opened-hook
8264 @cindex @sc{mode reader}
8266 @cindex authentification
8267 @cindex nntp authentification
8268 @findex nntp-send-authinfo
8269 @findex nntp-send-mode-reader
8270 @code{nntp-server-opened-hook} is run after a connection has been made.
8271 It can be used to send commands to the @sc{nntp} server after it has
8272 been contacted. By default is sends the command @code{MODE READER} to
8273 the server with the @code{nntp-send-mode-reader} function.
8275 @item nntp-authinfo-function
8276 @vindex nntp-authinfo-function
8277 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8278 server. Available functions include:
8281 @item nntp-send-authinfo
8282 @findex nntp-send-authinfo
8283 This function will used you current login name as the user name and will
8284 prompt you for the password. This is the default.
8286 @item nntp-send-nosy-authinfo
8287 @findex nntp-send-nosy-authinfo
8288 This function will prompt you for both user name and password.
8290 @item nntp-send-authinfo-from-file
8291 @findex nntp-send-authinfo-from-file
8292 This function will use your current login name as the user name and will
8293 read the @sc{nntp} password from @file{~/.nntp-authinfo}.
8296 @item nntp-server-action-alist
8297 @vindex nntp-server-action-alist
8298 This is an list of regexps to match on server types and actions to be
8299 taken when matches are made. For instance, if you want Gnus to beep
8300 every time you connect to innd, you could say something like:
8303 (setq nntp-server-action-alist
8307 You probably don't want to do that, though.
8309 The default value is
8312 '(("nntpd 1\\.5\\.11t"
8313 (remove-hook 'nntp-server-opened-hook nntp-send-mode-reader)))
8316 This ensures that Gnus doesn't send the @code{MODE READER} command to
8317 nntpd 1.5.11t, since that command chokes that server, I've been told.
8319 @item nntp-maximum-request
8320 @vindex nntp-maximum-request
8321 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
8322 will collect headers by sending a series of @code{head} commands. To
8323 speed things up, the backend sends lots of these commands without
8324 waiting for reply, and then reads all the replies. This is controlled
8325 by the @code{nntp-maximum-request} variable, and is 400 by default. If
8326 your network is buggy, you should set this to 1.
8328 @item nntp-connection-timeout
8329 @vindex nntp-connection-timeout
8330 If you have lots of foreign @code{nntp} groups that you connect to
8331 regularly, you're sure to have problems with @sc{nntp} servers not
8332 responding properly, or being too loaded to reply within reasonable
8333 time. This is can lead to awkward problems, which can be helped
8334 somewhat by setting @code{nntp-connection-timeout}. This is an integer
8335 that says how many seconds the @code{nntp} backend should wait for a
8336 connection before giving up. If it is @code{nil}, which is the default,
8337 no timeouts are done.
8339 @item nntp-command-timeout
8340 @vindex nntp-command-timeout
8341 @cindex PPP connections
8342 @cindex dynamic IP addresses
8343 If you're running Gnus on a machine that has a dynamically assigned
8344 address, Gnus may become confused. If the address of your machine
8345 changes after connecting to the @sc{nntp} server, Gnus will simply sit
8346 waiting forever for replies from the server. To help with this
8347 unfortunate problem, you can set this command to a number. Gnus will
8348 then, if it sits waiting longer than that number of seconds for a reply
8349 from the server, shut down the connection, start a new one, and resend
8350 the command. This should hopefully be transparent to the user. A
8351 likely number is 30 seconds.
8353 @item nntp-retry-on-break
8354 @vindex nntp-retry-on-break
8355 If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
8356 hangs. This will have much the same effect as the command timeout
8359 @item nntp-server-hook
8360 @vindex nntp-server-hook
8361 This hook is run as the last step when connecting to an @sc{nntp}
8364 @findex nntp-open-rlogin
8365 @findex nntp-open-network-stream
8366 @item nntp-open-connection-function
8367 @vindex nntp-open-connection-function
8368 This function is used to connect to the remote system. Two pre-made
8369 functions are @code{nntp-open-network-stream}, which is the default, and
8370 simply connects to some port or other on the remote system. The other
8371 is @code{nntp-open-rlogin}, which does an rlogin on the remote system,
8372 and then does a telnet to the @sc{nntp} server available there.
8374 @item nntp-rlogin-parameters
8375 @vindex nntp-rlogin-parameters
8376 If you use @code{nntp-open-rlogin} as the
8377 @code{nntp-open-connection-function}, this list will be used as the
8378 parameter list given to @code{rsh}.
8380 @item nntp-end-of-line
8381 @vindex nntp-end-of-line
8382 String to use as end-of-line markers when talking to the @sc{nntp}
8383 server. This is @samp{\r\n} by default, but should be @samp{\n} when
8384 using @code{rlogin} to talk to the server.
8386 @item nntp-rlogin-user-name
8387 @vindex nntp-rlogin-user-name
8388 User name on the remote system when using the @code{rlogin} connect
8392 @vindex nntp-address
8393 The address of the remote system running the @sc{nntp} server.
8395 @item nntp-port-number
8396 @vindex nntp-port-number
8397 Port number to connect to when using the @code{nntp-open-network-stream}
8400 @item nntp-buggy-select
8401 @vindex nntp-buggy-select
8402 Set this to non-@code{nil} if your select routine is buggy.
8404 @item nntp-nov-is-evil
8405 @vindex nntp-nov-is-evil
8406 If the @sc{nntp} server does not support @sc{nov}, you could set this
8407 variable to @code{t}, but @code{nntp} usually checks whether @sc{nov}
8408 can be used automatically.
8410 @item nntp-xover-commands
8411 @vindex nntp-xover-commands
8414 List of strings that are used as commands to fetch @sc{nov} lines from a
8415 server. The default value of this variable is @code{("XOVER"
8419 @vindex nntp-nov-gap
8420 @code{nntp} normally sends just one big request for @sc{nov} lines to
8421 the server. The server responds with one huge list of lines. However,
8422 if you have read articles 2-5000 in the group, and only want to read
8423 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
8424 lines that you do not want, and will not use. This variable says how
8425 big a gap between two consecutive articles is allowed to be before the
8426 @code{XOVER} request is split into several request. Note that if your
8427 network is fast, setting this variable to a really small number means
8428 that fetching will probably be slower. If this variable is @code{nil},
8429 @code{nntp} will never split requests.
8431 @item nntp-prepare-server-hook
8432 @vindex nntp-prepare-server-hook
8433 A hook run before attempting to connect to an @sc{nntp} server.
8435 @item nntp-warn-about-losing-connection
8436 @vindex nntp-warn-about-losing-connection
8437 If this variable is non-@code{nil}, some noise will be made when a
8438 server closes connection.
8444 @subsection News Spool
8448 Subscribing to a foreign group from the local spool is extremely easy,
8449 and might be useful, for instance, to speed up reading groups that
8450 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
8453 Anyways, you just specify @code{nnspool} as the method and @samp{} (or
8454 anything else) as the address.
8456 If you have access to a local spool, you should probably use that as the
8457 native select method (@pxref{Finding the News}). It is normally faster
8458 than using an @code{nntp} select method, but might not be. It depends.
8459 You just have to try to find out what's best at your site.
8463 @item nnspool-inews-program
8464 @vindex nnspool-inews-program
8465 Program used to post an article.
8467 @item nnspool-inews-switches
8468 @vindex nnspool-inews-switches
8469 Parameters given to the inews program when posting an article.
8471 @item nnspool-spool-directory
8472 @vindex nnspool-spool-directory
8473 Where @code{nnspool} looks for the articles. This is normally
8474 @file{/usr/spool/news/}.
8476 @item nnspool-nov-directory
8477 @vindex nnspool-nov-directory
8478 Where @code{nnspool} will look for @sc{nov} files. This is normally
8479 @file{/usr/spool/news/over.view/}.
8481 @item nnspool-lib-dir
8482 @vindex nnspool-lib-dir
8483 Where the news lib dir is (@file{/usr/lib/news/} by default).
8485 @item nnspool-active-file
8486 @vindex nnspool-active-file
8487 The path of the active file.
8489 @item nnspool-newsgroups-file
8490 @vindex nnspool-newsgroups-file
8491 The path of the group descriptions file.
8493 @item nnspool-history-file
8494 @vindex nnspool-history-file
8495 The path of the news history file.
8497 @item nnspool-active-times-file
8498 @vindex nnspool-active-times-file
8499 The path of the active date file.
8501 @item nnspool-nov-is-evil
8502 @vindex nnspool-nov-is-evil
8503 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
8506 @item nnspool-sift-nov-with-sed
8507 @vindex nnspool-sift-nov-with-sed
8509 If non-@code{nil}, which is the default, use @code{sed} to get the
8510 relevant portion from the overview file. If nil, @code{nnspool} will
8511 load the entire file into a buffer and process it there.
8517 @section Getting Mail
8518 @cindex reading mail
8521 Reading mail with a newsreader---isn't that just plain WeIrD? But of
8525 * Getting Started Reading Mail:: A simple cookbook example.
8526 * Splitting Mail:: How to create mail groups.
8527 * Mail Backend Variables:: Variables for customizing mail handling.
8528 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
8529 * Mail and Procmail:: Reading mail groups that procmail create.
8530 * Incorporating Old Mail:: What about the old mail you have?
8531 * Expiring Mail:: Getting rid of unwanted mail.
8532 * Washing Mail:: Removing gruft from the mail you get.
8533 * Duplicates:: Dealing with duplicated mail.
8534 * Not Reading Mail:: Using mail backends for reading other files.
8535 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
8539 @node Getting Started Reading Mail
8540 @subsection Getting Started Reading Mail
8542 It's quite easy to use Gnus to read your new mail. You just plonk the
8543 mail backend of your choice into @code{gnus-secondary-select-methods},
8544 and things will happen automatically.
8546 For instance, if you want to use @code{nnml} (which is a one file per
8547 mail backend), you could put the following in your @file{.gnus} file:
8550 (setq gnus-secondary-select-methods
8551 '((nnml "private")))
8554 Now, the next time you start Gnus, this backend will be queried for new
8555 articles, and it will move all the messages in your spool file to its
8556 directory, which is @code{~/Mail/} by default. The new group that will
8557 be created (@samp{mail.misc}) will be subscribed, and you can read it
8558 like any other group.
8560 You will probably want to split the mail into several groups, though:
8563 (setq nnmail-split-methods
8564 '(("junk" "^From:.*Lars Ingebrigtsen")
8565 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
8569 This will result in three new @code{nnml} mail groups being created:
8570 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
8571 mail that doesn't fit into the first two groups will be placed in the
8574 This should be sufficient for reading mail with Gnus. You might want to
8575 give the other sections in this part of the manual a perusal, though,
8576 especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
8579 @node Splitting Mail
8580 @subsection Splitting Mail
8581 @cindex splitting mail
8582 @cindex mail splitting
8584 @vindex nnmail-split-methods
8585 The @code{nnmail-split-methods} variable says how the incoming mail is
8586 to be split into groups.
8589 (setq nnmail-split-methods
8590 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
8591 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
8595 This variable is a list of lists, where the first element of each of
8596 these lists is the name of the mail group (they do not have to be called
8597 something beginning with @samp{mail}, by the way), and the second
8598 element is a regular expression used on the header of each mail to
8599 determine if it belongs in this mail group.
8601 If the first element is the special symbol @code{junk}, then messages
8602 that match the regexp will disappear into the aether. Use with
8605 The second element can also be a function. In that case, it will be
8606 called narrowed to the headers with the first element of the rule as the
8607 argument. It should return a non-@code{nil} value if it thinks that the
8608 mail belongs in that group.
8610 The last of these groups should always be a general one, and the regular
8611 expression should @emph{always} be @samp{} so that it matches any mails
8612 that haven't been matched by any of the other regexps. (These rules are
8613 processed from the beginning of the alist toward the end. The first
8614 rule to make a match will "win", unless you have crossposting enabled.
8615 In that case, all matching rules will "win".)
8617 If you like to tinker with this yourself, you can set this variable to a
8618 function of your choice. This function will be called without any
8619 arguments in a buffer narrowed to the headers of an incoming mail
8620 message. The function should return a list of groups names that it
8621 thinks should carry this mail message.
8623 Note that the mail backends are free to maul the poor, innocent
8624 incoming headers all they want to. They all add @code{Lines} headers;
8625 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
8626 @code{From<SPACE>} line to something else.
8628 @vindex nnmail-crosspost
8629 The mail backends all support cross-posting. If several regexps match,
8630 the mail will be ``cross-posted'' to all those groups.
8631 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
8632 that no articles are crossposted to the general (@samp{}) group.
8634 @vindex nnmail-crosspost-link-function
8637 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
8638 the crossposted articles. However, not all files systems support hard
8639 links. If that's the case for you, set
8640 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
8641 variable is @code{add-name-to-file} by default.)
8643 @kindex M-x nnmail-split-history
8644 @kindex nnmail-split-history
8645 If you wish to see where the previous mail split put the messages, you
8646 can use the @kbd{M-x nnmail-split-history} command.
8648 Gnus gives you all the opportunity you could possibly want for shooting
8649 yourself in the foot. Let's say you create a group that will contain
8650 all the mail you get from your boss. And then you accidentally
8651 unsubscribe from the group. Gnus will still put all the mail from your
8652 boss in the unsubscribed group, and so, when your boss mails you ``Have
8653 that report ready by Monday or you're fired!'', you'll never see it and,
8654 come Tuesday, you'll still believe that you're gainfully employed while
8655 you really should be out collecting empty bottles to save up for next
8659 @node Mail Backend Variables
8660 @subsection Mail Backend Variables
8662 These variables are (for the most part) pertinent to all the various
8666 @vindex nnmail-read-incoming-hook
8667 @item nnmail-read-incoming-hook
8668 The mail backends all call this hook after reading new mail. You can
8669 use this hook to notify any mail watch programs, if you want to.
8671 @vindex nnmail-spool-file
8672 @item nnmail-spool-file
8676 @vindex nnmail-pop-password
8677 @vindex nnmail-pop-password-required
8678 The backends will look for new mail in this file. If this variable is
8679 @code{nil}, the mail backends will never attempt to fetch mail by
8680 themselves. If you are using a POP mail server and your name is
8681 @samp{larsi}, you should set this variable to @samp{po:larsi}. If
8682 your name is not @samp{larsi}, you should probably modify that
8683 slightly, but you may have guessed that already, you smart & handsome
8684 devil! You can also set this variable to @code{pop}, and Gnus will try
8685 to figure out the POP mail string by itself. In any case, Gnus will
8686 call @code{movemail} which will contact the POP server named in the
8687 @code{MAILHOST} environment variable. If the POP server needs a
8688 password, you can either set @code{nnmail-pop-password-required} to
8689 @code{t} and be prompted for the password, or set
8690 @code{nnmail-pop-password} to the password itself.
8692 @code{nnmail-spool-file} can also be a list of mailboxes.
8694 Your Emacs has to have been configured with @samp{--with-pop} before
8695 compilation. This is the default, but some installations have it
8698 When you use a mail backend, Gnus will slurp all your mail from your
8699 inbox and plonk it down in your home directory. Gnus doesn't move any
8700 mail if you're not using a mail backend---you have to do a lot of magic
8701 invocations first. At the time when you have finished drawing the
8702 pentagram, lightened the candles, and sacrificed the goat, you really
8703 shouldn't be too surprised when Gnus moves your mail.
8705 @vindex nnmail-use-procmail
8706 @vindex nnmail-procmail-suffix
8707 @item nnmail-use-procmail
8708 If non-@code{nil}, the mail backends will look in
8709 @code{nnmail-procmail-directory} for incoming mail. All the files in
8710 that directory that have names ending in @code{nnmail-procmail-suffix}
8711 will be considered incoming mailboxes, and will be searched for new
8714 @vindex nnmail-crash-box
8715 @item nnmail-crash-box
8716 When the mail backends read a spool file, it is first moved to this
8717 file, which is @file{~/.gnus-crash-box} by default. If this file
8718 already exists, it will always be read (and incorporated) before any
8721 @vindex nnmail-prepare-incoming-hook
8722 @item nnmail-prepare-incoming-hook
8723 This is run in a buffer that holds all the new incoming mail, and can be
8724 used for, well, anything, really.
8726 @vindex nnmail-split-hook
8727 @item nnmail-split-hook
8728 @findex article-decode-rfc1522
8729 @findex RFC1522 decoding
8730 Hook run in the buffer where the mail headers of each message is kept
8731 just before the splitting based on these headers is done. The hook is
8732 free to modify the buffer contents in any way it sees fit---the buffer
8733 is discarded after the splitting has been done, and no changes performed
8734 in the buffer will show up in any files. @code{gnus-article-decode-rfc1522}
8735 is one likely function to add to this hook.
8737 @vindex nnmail-pre-get-new-mail-hook
8738 @vindex nnmail-post-get-new-mail-hook
8739 @item nnmail-pre-get-new-mail-hook
8740 @itemx nnmail-post-get-new-mail-hook
8741 These are two useful hooks executed when treating new incoming
8742 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
8743 starting to handle the new mail) and
8744 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
8745 is done). Here's and example of using these two hooks to change the
8746 default file modes the new mail files get:
8749 (add-hook 'gnus-pre-get-new-mail-hook
8750 (lambda () (set-default-file-modes 511)))
8752 (add-hook 'gnus-post-get-new-mail-hook
8753 (lambda () (set-default-file-modes 551)))
8756 @item nnmail-tmp-directory
8757 @vindex nnmail-tmp-directory
8758 This variable says where to move the incoming mail to while processing
8759 it. This is usually done in the same directory that the mail backend
8760 inhabits (i.e., @file{~/Mail/}), but if this variable is non-@code{nil},
8761 it will be used instead.
8763 @item nnmail-movemail-program
8764 @vindex nnmail-movemail-program
8765 This program is executed to move mail from the user's inbox to her home
8766 directory. The default is @samp{movemail}.
8768 This can also be a function. In that case, the function will be called
8769 with two parameters -- the name of the inbox, and the file to be moved
8772 @item nnmail-delete-incoming
8773 @vindex nnmail-delete-incoming
8774 @cindex incoming mail files
8775 @cindex deleting incoming files
8776 If non-@code{nil}, the mail backends will delete the temporary incoming
8777 file after splitting mail into the proper groups. This is @code{t} by
8780 @c This is @code{nil} by
8781 @c default for reasons of security.
8783 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
8784 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
8785 lost mail, I think, but that's not the point. (Except certain versions
8786 of Red Gnus.)) By not deleting the Incoming* files, one can be sure to
8787 not lose mail -- if Gnus totally whacks out, one can always recover what
8790 Delete the @file{Incoming*} files at will.
8792 @item nnmail-use-long-file-names
8793 @vindex nnmail-use-long-file-names
8794 If non-@code{nil}, the mail backends will use long file and directory
8795 names. Groups like @samp{mail.misc} will end up in directories like
8796 @file{mail.misc/}. If it is @code{nil}, the same group will end up in
8799 @item nnmail-delete-file-function
8800 @vindex nnmail-delete-file-function
8802 Function called to delete files. It is @code{delete-file} by default.
8807 @node Fancy Mail Splitting
8808 @subsection Fancy Mail Splitting
8809 @cindex mail splitting
8810 @cindex fancy mail splitting
8812 @vindex nnmail-split-fancy
8813 @findex nnmail-split-fancy
8814 If the rather simple, standard method for specifying how to split mail
8815 doesn't allow you to do what you want, you can set
8816 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
8817 play with the @code{nnmail-split-fancy} variable.
8819 Let's look at an example value of this variable first:
8822 ;; Messages from the mailer daemon are not crossposted to any of
8823 ;; the ordinary groups. Warnings are put in a separate group
8824 ;; from real errors.
8825 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
8827 ;; Non-error messages are crossposted to all relevant
8828 ;; groups, but we don't crosspost between the group for the
8829 ;; (ding) list and the group for other (ding) related mail.
8830 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
8831 ("subject" "ding" "ding.misc"))
8832 ;; Other mailing lists...
8833 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
8834 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
8836 (any "larsi@@ifi\\.uio\\.no" "people.Lars Magne Ingebrigtsen"))
8837 ;; Unmatched mail goes to the catch all group.
8841 This variable has the format of a @dfn{split}. A split is a (possibly)
8842 recursive structure where each split may contain other splits. Here are
8843 the five possible split syntaxes:
8848 @samp{group}: If the split is a string, that will be taken as a group name.
8851 @var{(FIELD VALUE SPLIT)}: If the split is a list, and the first
8852 element is a string, then that means that if header FIELD (a regexp)
8853 contains VALUE (also a regexp), then store the message as specified by
8857 @var{(| SPLIT...)}: If the split is a list, and the first element is
8858 @code{|} (vertical bar), then process each SPLIT until one of them
8859 matches. A SPLIT is said to match if it will cause the mail message to
8860 be stored in one or more groups.
8863 @var{(& SPLIT...)}: If the split is a list, and the first element is
8864 @code{&}, then process all SPLITs in the list.
8867 @code{junk}: If the split is the symbol @code{junk}, then don't save
8868 this message anywhere.
8871 @var{(: function arg1 arg2 ...)}: If the split is a list, and the first
8872 element is @code{:}, then the second element will be called as a
8873 function with @var{args} given as arguments. The function should return
8878 In these splits, @var{FIELD} must match a complete field name.
8879 @var{VALUE} must match a complete word according to the fundamental mode
8880 syntax table. You can use @code{.*} in the regexps to match partial
8881 field names or words. In other words, all @var{VALUE}'s are wrapped in
8882 @samp{\<} and @samp{\>} pairs.
8884 @vindex nnmail-split-abbrev-alist
8885 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
8886 are expanded as specified by the variable
8887 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
8888 the car of the cells contains the key, and the cdr contains a string.
8890 @vindex nnmail-split-fancy-syntax-table
8891 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
8892 when all this splitting is performed.
8894 If you want to have Gnus create groups dynamically based on some
8895 information in the headers, you can say things like:
8898 (any "debian-\(\\w*\\)@@lists.debian.org" "mail.debian.\\1")
8901 That is, do @code{replace-match}-like substitions in the group names.
8904 @node Mail and Procmail
8905 @subsection Mail and Procmail
8910 Many people use @code{procmail} (or some other mail filter program or
8911 external delivery agent---@code{slocal}, @code{elm}, etc) to split
8912 incoming mail into groups. If you do that, you should set
8913 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
8914 backends never ever try to fetch mail by themselves.
8916 This also means that you probably don't want to set
8917 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
8920 When a mail backend is queried for what groups it carries, it replies
8921 with the contents of that variable, along with any groups it has figured
8922 out that it carries by other means. None of the backends (except
8923 @code{nnmh}) actually go out to the disk and check what groups actually
8924 exist. (It's not trivial to distinguish between what the user thinks is
8925 a basis for a newsgroup and what is just a plain old file or directory.)
8927 This means that you have to tell Gnus (and the backends) what groups
8930 Let's take the @code{nnmh} backend as an example.
8932 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
8933 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
8935 Go to the group buffer and type @kbd{G m}. When prompted, answer
8936 @samp{foo} for the name and @samp{nnmh} for the method. Repeat
8937 twice for the two other groups, @samp{bar} and @samp{mail.baz}. Be sure
8938 to include all your mail groups.
8940 That's it. You are now set to read your mail. An active file for this
8941 method will be created automatically.
8943 @vindex nnmail-procmail-suffix
8944 @vindex nnmail-procmail-directory
8945 If you use @code{nnfolder} or any other backend that store more than a
8946 single article in each file, you should never have procmail add mails to
8947 the file that Gnus sees. Instead, procmail should put all incoming mail
8948 in @code{nnmail-procmail-directory}. To arrive at the file name to put
8949 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
8950 name. The mail backends will read the mail from these files.
8952 @vindex nnmail-resplit-incoming
8953 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
8954 put in the @code{mail.misc}, as one would expect. However, if you want
8955 Gnus to split the mail the normal way, you could set
8956 @code{nnmail-resplit-incoming} to @code{t}.
8958 @vindex nnmail-keep-last-article
8959 If you use @code{procmail} to split things directory into an @code{nnmh}
8960 directory (which you shouldn't do), you should set
8961 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
8962 ever expiring the final article in a mail newsgroup. This is quite,
8965 Here's an example setup: The incoming spools are located in
8966 @file{~/incoming/} and have @samp{""} as suffixes (i. e., the incoming
8967 spool files have the same names as the equivalent groups). The
8968 @code{nnfolder} backend is to be used as the mail interface, and the
8969 @code{nnfolder} directory is @file{~/fMail/}.
8972 (setq nnfolder-directory "~/fMail/")
8973 (setq nnmail-spool-file 'procmail)
8974 (setq nnmail-procmail-directory "~/incoming/")
8975 (setq gnus-secondary-select-methods '((nnfolder "")))
8976 (setq nnmail-procmail-suffix "")
8980 @node Incorporating Old Mail
8981 @subsection Incorporating Old Mail
8983 Most people have lots of old mail stored in various file formats. If
8984 you have set up Gnus to read mail using one of the spiffy Gnus mail
8985 backends, you'll probably wish to have that old mail incorporated into
8988 Doing so can be quite easy.
8990 To take an example: You're reading mail using @code{nnml}
8991 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
8992 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
8993 file filled with important, but old, mail. You want to move it into
8994 your @code{nnml} groups.
9000 Go to the group buffer.
9003 Type `G f' and give the path of the mbox file when prompted to create an
9004 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9007 Type `SPACE' to enter the newly created group.
9010 Type `M P b' to process-mark all articles in this group (@pxref{Setting
9014 Type `B r' to respool all the process-marked articles, and answer
9015 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9018 All the mail messages in the mbox file will now also be spread out over
9019 all your @code{nnml} groups. Try entering them and check whether things
9020 have gone without a glitch. If things look ok, you may consider
9021 deleting the mbox file, but I wouldn't do that unless I was absolutely
9022 sure that all the mail has ended up where it should be.
9024 Respooling is also a handy thing to do if you're switching from one mail
9025 backend to another. Just respool all the mail in the old mail groups
9026 using the new mail backend.
9030 @subsection Expiring Mail
9031 @cindex article expiry
9033 Traditional mail readers have a tendency to remove mail articles when
9034 you mark them as read, in some way. Gnus takes a fundamentally
9035 different approach to mail reading.
9037 Gnus basically considers mail just to be news that has been received in
9038 a rather peculiar manner. It does not think that it has the power to
9039 actually change the mail, or delete any mail messages. If you enter a
9040 mail group, and mark articles as ``read'', or kill them in some other
9041 fashion, the mail articles will still exist on the system. I repeat:
9042 Gnus will not delete your old, read mail. Unless you ask it to, of
9045 To make Gnus get rid of your unwanted mail, you have to mark the
9046 articles as @dfn{expirable}. This does not mean that the articles will
9047 disappear right away, however. In general, a mail article will be
9048 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9049 more than one week old. If you do not mark an article as expirable, it
9050 will remain on your system until hell freezes over. This bears
9051 repeating one more time, with some spurious capitalizations: IF you do
9052 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9054 @vindex gnus-auto-expirable-newsgroups
9055 You do not have to mark articles as expirable by hand. Groups that
9056 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9057 have all articles that you read marked as expirable automatically. All
9058 articles that are marked as expirable have an @samp{E} in the first
9059 column in the summary buffer.
9061 Note that making a group auto-expirable don't mean that all read
9062 articles are expired---only the articles that are marked as expirable
9063 will be expired. Also note the using the @kbd{d} command won't make
9064 groups expirable---only semi-automatic marking of articles as read will
9065 mark the articles as expirable in auto-expirable groups.
9067 Let's say you subscribe to a couple of mailing lists, and you want the
9068 articles you have read to disappear after a while:
9071 (setq gnus-auto-expirable-newsgroups
9072 "mail.nonsense-list\\|mail.nice-list")
9075 Another way to have auto-expiry happen is to have the element
9076 @code{auto-expire} in the group parameters of the group.
9078 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9079 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
9080 doesn't really mix very well.
9082 @vindex nnmail-expiry-wait
9083 The @code{nnmail-expiry-wait} variable supplies the default time an
9084 expirable article has to live. The default is seven days.
9086 Gnus also supplies a function that lets you fine-tune how long articles
9087 are to live, based on what group they are in. Let's say you want to
9088 have one month expiry period in the @samp{mail.private} group, a one day
9089 expiry period in the @samp{mail.junk} group, and a six day expiry period
9092 @vindex nnmail-expiry-wait-function
9094 (setq nnmail-expiry-wait-function
9096 (cond ((string= group "mail.private")
9098 ((string= group "mail.junk")
9100 ((string= group "important")
9106 The group names that this function is fed are ``unadorned'' group
9107 names---no @samp{nnml:} prefixes and the like.
9109 The @code{nnmail-expiry-wait} variable and
9110 @code{nnmail-expiry-wait-function} function can be either a number (not
9111 necessarily an integer) or the symbols @code{immediate} or
9114 You can also use the @code{expiry-wait} group parameter to selectively
9115 change the expiry period (@pxref{Group Parameters}).
9117 @vindex nnmail-keep-last-article
9118 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9119 expire the final article in a mail newsgroup. This is to make life
9120 easier for procmail users.
9122 @vindex gnus-total-expirable-newsgroups
9123 By the way, that line up there about Gnus never expiring non-expirable
9124 articles is a lie. If you put @code{total-expire} in the group
9125 parameters, articles will not be marked as expirable, but all read
9126 articles will be put through the expiry process. Use with extreme
9127 caution. Even more dangerous is the
9128 @code{gnus-total-expirable-newsgroups} variable. All groups that match
9129 this regexp will have all read articles put through the expiry process,
9130 which means that @emph{all} old mail articles in the groups in question
9131 will be deleted after a while. Use with extreme caution, and don't come
9132 crying to me when you discover that the regexp you used matched the
9133 wrong group and all your important mail has disappeared. Be a
9134 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
9137 Most people make most of their mail groups total-expirable, though.
9141 @subsection Washing Mail
9142 @cindex mail washing
9143 @cindex list server brain damage
9144 @cindex incoming mail treatment
9146 Mailers and list servers are notorious for doing all sorts of really,
9147 really stupid things with mail. ``Hey, RFC822 doesn't explicitly
9148 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
9149 end of all lines passing through our server, so let's do that!!!!1!''
9150 Yes, but RFC822 wasn't designed to be read by morons. Things that were
9151 considered to be self-evident were not discussed. So. Here we are.
9153 Case in point: The German version of Microsoft Exchange adds @samp{AW:
9154 } to the subjects of replies instead of @samp{Re: }. I could pretend to
9155 be shocked and dismayed by this, but I haven't got the energy. It is to
9158 Gnus provides a plethora of functions for washing articles while
9159 displaying them, but it might be nicer to do the filtering before
9160 storing the mail to disc. For that purpose, we have three hooks and
9161 various functions that can be put in these hooks.
9164 @item nnmail-prepare-incoming-hook
9165 @vindex nnmail-prepare-incoming-hook
9166 This hook is called before doing anything with the mail and is meant for
9167 grand, sweeping gestures. Functions to be used include:
9170 @item nnheader-ms-strip-cr
9171 @findex nnheader-ms-strip-cr
9172 Remove trailing carriage returns from each line. This is default on
9173 Emacs running on MS machines.
9177 @item nnmail-prepare-incoming-header-hook
9178 @vindex nnmail-prepare-incoming-header-hook
9179 This hook is called narrowed to each header. It can be used when
9180 cleaning up the headers. Functions that can be used include:
9183 @item nnmail-remove-leading-whitespace
9184 @findex nnmail-remove-leading-whitespace
9185 Clear leading white space that ``helpful'' listservs have added to the
9186 headers too make them look nice. Aaah.
9188 @item nnmail-remove-list-identifiers
9189 @findex nnmail-remove-list-identifiers
9190 Some list servers add an identifier---for example, @samp{(idm)}---to the
9191 beginning of all @code{Subject} headers. I'm sure that's nice for
9192 people who use stone age mail readers. This function will remove
9193 strings that match the @code{nnmail-list-identifiers} regexp, which can
9194 also be a list of regexp.
9196 For instance, if you want to remove the @samp{(idm)} and the
9197 @samp{nagnagnag} identifiers:
9200 (setq nnmail-list-identifiers
9201 '("(idm)" "nagnagnag"))
9204 @item nnmail-remove-tabs
9205 @findex nnmail-remove-tabs
9206 Translate all @samp{TAB} characters into @samp{SPACE} characters.
9210 @item nnmail-prepare-incoming-message-hook
9211 @vindex nnmail-prepare-incoming-message-hook
9212 This hook is called narrowed to each message. Functions to be used
9216 @item article-de-quoted-unreadable
9217 @findex article-de-quoted-unreadable
9218 Decode Quoted Readable encoding.
9225 @subsection Duplicates
9227 @vindex nnmail-treat-duplicates
9228 @vindex nnmail-message-id-cache-length
9229 @vindex nnmail-message-id-cache-file
9230 @cindex duplicate mails
9231 If you are a member of a couple of mailing list, you will sometime
9232 receive two copies of the same mail. This can be quite annoying, so
9233 @code{nnmail} checks for and treats any duplicates it might find. To do
9234 this, it keeps a cache of old @code{Message-ID}s---
9235 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
9236 default. The approximate maximum number of @code{Message-ID}s stored
9237 there is controlled by the @code{nnmail-message-id-cache-length}
9238 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
9239 stored.) If all this sounds scary to you, you can set
9240 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
9241 default), and @code{nnmail} won't delete duplicate mails. Instead it
9242 will generate a brand new @code{Message-ID} for the mail and insert a
9243 warning into the head of the mail saying that it thinks that this is a
9244 duplicate of a different message.
9246 This variable can also be a function. If that's the case, the function
9247 will be called from a buffer narrowed to the message in question with
9248 the @code{Message-ID} as a parameter. The function must return either
9249 @code{nil}, @code{warn}, or @code{delete}.
9251 You can turn this feature off completely by setting the variable to
9254 If you want all the duplicate mails to be put into a special
9255 @dfn{duplicates} group, you could do that using the normal mail split
9259 (setq nnmail-split-fancy
9260 '(| ;; Messages duplicates go to a separate group.
9261 ("gnus-warning" "duplication of message" "duplicate")
9262 ;; Message from daemons, postmaster, and the like to another.
9263 (any mail "mail.misc")
9270 (setq nnmail-split-methods
9271 '(("duplicates" "^Gnus-Warning:")
9276 Here's a neat feature: If you know that the recipient reads her mail
9277 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
9278 @code{delete}, you can send her as many insults as you like, just by
9279 using a @code{Message-ID} of a mail that you know that she's already
9280 received. Think of all the fun! She'll never see any of it! Whee!
9283 @node Not Reading Mail
9284 @subsection Not Reading Mail
9286 If you start using any of the mail backends, they have the annoying
9287 habit of assuming that you want to read mail with them. This might not
9288 be unreasonable, but it might not be what you want.
9290 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
9291 will ever attempt to read incoming mail, which should help.
9293 @vindex nnbabyl-get-new-mail
9294 @vindex nnmbox-get-new-mail
9295 @vindex nnml-get-new-mail
9296 @vindex nnmh-get-new-mail
9297 @vindex nnfolder-get-new-mail
9298 This might be too much, if, for instance, you are reading mail quite
9299 happily with @code{nnml} and just want to peek at some old @sc{rmail}
9300 file you have stashed away with @code{nnbabyl}. All backends have
9301 variables called backend-@code{get-new-mail}. If you want to disable
9302 the @code{nnbabyl} mail reading, you edit the virtual server for the
9303 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
9305 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
9306 narrowed to the article to be saved before saving it when reading
9310 @node Choosing a Mail Backend
9311 @subsection Choosing a Mail Backend
9313 Gnus will read the mail spool when you activate a mail group. The mail
9314 file is first copied to your home directory. What happens after that
9315 depends on what format you want to store your mail in.
9318 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
9319 * Rmail Babyl:: Emacs programs use the rmail babyl format.
9320 * Mail Spool:: Store your mail in a private spool?
9321 * MH Spool:: An mhspool-like backend.
9322 * Mail Folders:: Having one file for each group.
9327 @subsubsection Unix Mail Box
9329 @cindex unix mail box
9331 @vindex nnmbox-active-file
9332 @vindex nnmbox-mbox-file
9333 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
9334 mail. @code{nnmbox} will add extra headers to each mail article to say
9335 which group it belongs in.
9337 Virtual server settings:
9340 @item nnmbox-mbox-file
9341 @vindex nnmbox-mbox-file
9342 The name of the mail box in the user's home directory.
9344 @item nnmbox-active-file
9345 @vindex nnmbox-active-file
9346 The name of the active file for the mail box.
9348 @item nnmbox-get-new-mail
9349 @vindex nnmbox-get-new-mail
9350 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
9356 @subsubsection Rmail Babyl
9360 @vindex nnbabyl-active-file
9361 @vindex nnbabyl-mbox-file
9362 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
9363 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
9364 article to say which group it belongs in.
9366 Virtual server settings:
9369 @item nnbabyl-mbox-file
9370 @vindex nnbabyl-mbox-file
9371 The name of the rmail mbox file.
9373 @item nnbabyl-active-file
9374 @vindex nnbabyl-active-file
9375 The name of the active file for the rmail box.
9377 @item nnbabyl-get-new-mail
9378 @vindex nnbabyl-get-new-mail
9379 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
9384 @subsubsection Mail Spool
9386 @cindex mail @sc{nov} spool
9388 The @dfn{nnml} spool mail format isn't compatible with any other known
9389 format. It should be used with some caution.
9391 @vindex nnml-directory
9392 If you use this backend, Gnus will split all incoming mail into files;
9393 one file for each mail, and put the articles into the correct
9394 directories under the directory specified by the @code{nnml-directory}
9395 variable. The default value is @file{~/Mail/}.
9397 You do not have to create any directories beforehand; Gnus will take
9400 If you have a strict limit as to how many files you are allowed to store
9401 in your account, you should not use this backend. As each mail gets its
9402 own file, you might very well occupy thousands of inodes within a few
9403 weeks. If this is no problem for you, and it isn't a problem for you
9404 having your friendly systems administrator walking around, madly,
9405 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
9406 know that this is probably the fastest format to use. You do not have
9407 to trudge through a big mbox file just to read your new mail.
9409 @code{nnml} is probably the slowest backend when it comes to article
9410 splitting. It has to create lots of files, and it also generates
9411 @sc{nov} databases for the incoming mails. This makes is the fastest
9412 backend when it comes to reading mail.
9414 Virtual server settings:
9417 @item nnml-directory
9418 @vindex nnml-directory
9419 All @code{nnml} directories will be placed under this directory.
9421 @item nnml-active-file
9422 @vindex nnml-active-file
9423 The active file for the @code{nnml} server.
9425 @item nnml-newsgroups-file
9426 @vindex nnml-newsgroups-file
9427 The @code{nnml} group descriptions file. @xref{Newsgroups File
9430 @item nnml-get-new-mail
9431 @vindex nnml-get-new-mail
9432 If non-@code{nil}, @code{nnml} will read incoming mail.
9434 @item nnml-nov-is-evil
9435 @vindex nnml-nov-is-evil
9436 If non-@code{nil}, this backend will ignore any @sc{nov} files.
9438 @item nnml-nov-file-name
9439 @vindex nnml-nov-file-name
9440 The name of the @sc{nov} files. The default is @file{.overview}.
9442 @item nnml-prepare-save-mail-hook
9443 @vindex nnml-prepare-save-mail-hook
9444 Hook run narrowed to an article before saving.
9448 @findex nnml-generate-nov-databases
9449 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
9450 you can do a complete update by typing @kbd{M-x
9451 nnml-generate-nov-databases}. This command will trawl through the
9452 entire @code{nnml} hierarchy, looking at each and every article, so it
9453 might take a while to complete. A better interface to this
9454 functionality can be found in the server buffer (@pxref{Server
9459 @subsubsection MH Spool
9461 @cindex mh-e mail spool
9463 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
9464 @sc{nov} databases and it doesn't keep an active file. This makes
9465 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
9466 makes it easier to write procmail scripts for.
9468 Virtual server settings:
9471 @item nnmh-directory
9472 @vindex nnmh-directory
9473 All @code{nnmh} directories will be located under this directory.
9475 @item nnmh-get-new-mail
9476 @vindex nnmh-get-new-mail
9477 If non-@code{nil}, @code{nnmh} will read incoming mail.
9480 @vindex nnmh-be-safe
9481 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
9482 sure that the articles in the folder are actually what Gnus thinks they
9483 are. It will check date stamps and stat everything in sight, so
9484 setting this to @code{t} will mean a serious slow-down. If you never
9485 use anything but Gnus to read the @code{nnmh} articles, you do not have
9486 to set this variable to @code{t}.
9491 @subsubsection Mail Folders
9493 @cindex mbox folders
9494 @cindex mail folders
9496 @code{nnfolder} is a backend for storing each mail group in a separate
9497 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
9498 will add extra headers to keep track of article numbers and arrival
9501 Virtual server settings:
9504 @item nnfolder-directory
9505 @vindex nnfolder-directory
9506 All the @code{nnfolder} mail boxes will be stored under this directory.
9508 @item nnfolder-active-file
9509 @vindex nnfolder-active-file
9510 The name of the active file.
9512 @item nnfolder-newsgroups-file
9513 @vindex nnfolder-newsgroups-file
9514 The name of the group descriptions file. @xref{Newsgroups File Format}.
9516 @item nnfolder-get-new-mail
9517 @vindex nnfolder-get-new-mail
9518 If non-@code{nil}, @code{nnfolder} will read incoming mail.
9521 @findex nnfolder-generate-active-file
9522 @kindex M-x nnfolder-generate-active-file
9523 If you have lots of @code{nnfolder}-like files you'd like to read with
9524 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
9525 command to make @code{nnfolder} aware of all likely files in
9526 @code{nnfolder-directory}.
9530 @section Other Sources
9532 Gnus can do more than just read news or mail. The methods described
9533 below allow Gnus to view directories and files as if they were
9537 * Directory Groups:: You can read a directory as if it was a newsgroup.
9538 * Anything Groups:: Dired? Who needs dired?
9539 * Document Groups:: Single files can be the basis of a group.
9540 * SOUP:: Reading @sc{SOUP} packets ``offline''.
9541 * Web Searches:: Creating groups from articles that match a string.
9542 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
9546 @node Directory Groups
9547 @subsection Directory Groups
9549 @cindex directory groups
9551 If you have a directory that has lots of articles in separate files in
9552 it, you might treat it as a newsgroup. The files have to have numerical
9555 This might be an opportune moment to mention @code{ange-ftp}, that most
9556 wonderful of all wonderful Emacs packages. When I wrote @code{nndir}, I
9557 didn't think much about it---a backend to read directories. Big deal.
9559 @code{ange-ftp} changes that picture dramatically. For instance, if you
9560 enter the @code{ange-ftp} file name
9561 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the the directory name,
9562 @code{ange-ftp} will actually allow you to read this directory over at
9563 @samp{sina} as a newsgroup. Distributed news ahoy!
9565 @code{nndir} will use @sc{nov} files if they are present.
9567 @code{nndir} is a ``read-only'' backend---you can't delete or expire
9568 articles with this method. You can use @code{nnmh} or @code{nnml} for
9569 whatever you use @code{nndir} for, so you could switch to any of those
9570 methods if you feel the need to have a non-read-only @code{nndir}.
9573 @node Anything Groups
9574 @subsection Anything Groups
9577 From the @code{nndir} backend (which reads a single spool-like
9578 directory), it's just a hop and a skip to @code{nneething}, which
9579 pretends that any arbitrary directory is a newsgroup. Strange, but
9582 When @code{nneething} is presented with a directory, it will scan this
9583 directory and assign article numbers to each file. When you enter such
9584 a group, @code{nneething} must create ``headers'' that Gnus can use.
9585 After all, Gnus is a newsreader, in case you're
9586 forgetting. @code{nneething} does this in a two-step process. First, it
9587 snoops each file in question. If the file looks like an article (i.e.,
9588 the first few lines look like headers), it will use this as the head.
9589 If this is just some arbitrary file without a head (e.g. a C source
9590 file), @code{nneething} will cobble up a header out of thin air. It
9591 will use file ownership, name and date and do whatever it can with these
9594 All this should happen automatically for you, and you will be presented
9595 with something that looks very much like a newsgroup. Totally like a
9596 newsgroup, to be precise. If you select an article, it will be displayed
9597 in the article buffer, just as usual.
9599 If you select a line that represents a directory, Gnus will pop you into
9600 a new summary buffer for this @code{nneething} group. And so on. You can
9601 traverse the entire disk this way, if you feel like, but remember that
9602 Gnus is not dired, really, and does not intend to be, either.
9604 There are two overall modes to this action---ephemeral or solid. When
9605 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
9606 will not store information on what files you have read, and what files
9607 are new, and so on. If you create a solid @code{nneething} group the
9608 normal way with @kbd{G m}, Gnus will store a mapping table between
9609 article numbers and file names, and you can treat this group like any
9610 other groups. When you activate a solid @code{nneething} group, you will
9611 be told how many unread articles it contains, etc., etc.
9616 @item nneething-map-file-directory
9617 @vindex nneething-map-file-directory
9618 All the mapping files for solid @code{nneething} groups will be stored
9619 in this directory, which defaults to @file{~/.nneething/}.
9621 @item nneething-exclude-files
9622 @vindex nneething-exclude-files
9623 All files that match this regexp will be ignored. Nice to use to exclude
9624 auto-save files and the like, which is what it does by default.
9626 @item nneething-map-file
9627 @vindex nneething-map-file
9628 Name of the map files.
9632 @node Document Groups
9633 @subsection Document Groups
9635 @cindex documentation group
9638 @code{nndoc} is a cute little thing that will let you read a single file
9639 as a newsgroup. Several files types are supported:
9646 The babyl (rmail) mail box.
9651 The standard Unix mbox file.
9653 @cindex MMDF mail box
9655 The MMDF mail box format.
9658 Several news articles appended into a file.
9661 @cindex rnews batch files
9662 The rnews batch transport format.
9663 @cindex forwarded messages
9672 @cindex RFC 1153 digest
9673 @cindex RFC 341 digest
9674 MIME (RFC 1341) digest format.
9676 @item standard-digest
9677 The standard (RFC 1153) digest format.
9680 Non-standard digest format---matches most things, but does it badly.
9683 You can also use the special ``file type'' @code{guess}, which means
9684 that @code{nndoc} will try to guess what file type it is looking at.
9685 @code{digest} means that @code{nndoc} should guess what digest type the
9688 @code{nndoc} will not try to change the file or insert any extra headers into
9689 it---it will simply, like, let you use the file as the basis for a
9690 group. And that's it.
9692 If you have some old archived articles that you want to insert into your
9693 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
9694 that. Say you have an old @file{RMAIL} file with mail that you now want
9695 to split into your new @code{nnml} groups. You look at that file using
9696 @code{nndoc} (using the @kbd{G f} command in the group buffer
9697 (@pxref{Foreign Groups})), set the process mark on all the articles in
9698 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
9699 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
9700 file is now also stored in lots of @code{nnml} directories, and you can
9701 delete that pesky @file{RMAIL} file. If you have the guts!
9703 Virtual server variables:
9706 @item nndoc-article-type
9707 @vindex nndoc-article-type
9708 This should be one of @code{mbox}, @code{babyl}, @code{digest},
9709 @code{mmdf}, @code{forward}, @code{news}, @code{rnews},
9710 @code{mime-digest}, @code{clari-briefs}, or @code{guess}.
9712 @item nndoc-post-type
9713 @vindex nndoc-post-type
9714 This variable says whether Gnus is to consider the group a news group or
9715 a mail group. There are two legal values: @code{mail} (the default)
9720 * Document Server Internals:: How to add your own document types.
9724 @node Document Server Internals
9725 @subsubsection Document Server Internals
9727 Adding new document types to be recognized by @code{nndoc} isn't
9728 difficult. You just have to whip up a definition of what the document
9729 looks like, write a predicate function to recognize that document type,
9730 and then hook into @code{nndoc}.
9732 First, here's an example document type definition:
9736 (article-begin . "^\^A\^A\^A\^A\n")
9737 (body-end . "^\^A\^A\^A\^A\n"))
9740 The definition is simply a unique @dfn{name} followed by a series of
9741 regexp pseudo-variable settings. Below are the possible
9742 variables---don't be daunted by the number of variables; most document
9743 types can be defined with very few settings:
9747 If present, @code{nndoc} will skip past all text until it finds
9748 something that match this regexp. All text before this will be
9752 This setting has to be present in all document type definitions. It
9753 says what the beginning of each article looks like.
9755 @item head-begin-function
9756 If present, this should be a function that moves point to the head of
9759 @item nndoc-head-begin
9760 If present, this should be a regexp that matches the head of the
9763 @item nndoc-head-end
9764 This should match the end of the head of the article. It defaults to
9765 @samp{^$}---the empty line.
9767 @item body-begin-function
9768 If present, this function should move point to the beginning of the body
9772 This should match the beginning of the body of the article. It defaults
9775 @item body-end-function
9776 If present, this function should move point to the end of the body of
9780 If present, this should match the end of the body of the article.
9782 @item nndoc-file-end
9783 If present, this should match the end of the file. All text after this
9784 regexp will be totally ignored.
9788 So, using these variables @code{nndoc} is able to dissect a document
9789 file into a series of articles, each with a head and a body. However, a
9790 few more variables are needed since not all document types are all that
9791 news-like---variables needed to transform the head or the body into
9792 something that's palatable for Gnus:
9795 @item prepare-body-function
9796 If present, this function will be called when requesting an article. It
9797 will be called with point at the start of the body, and is useful if the
9798 document has encoded some parts of its contents.
9800 @item article-transform-function
9801 If present, this function is called when requesting an article. It's
9802 meant to be used how more wide-ranging transformation of both head and
9803 body of the article.
9805 @item generate-head-function
9806 If present, this function is called to generate a head that Gnus can
9807 understand. It is called with the article number as a parameter, and is
9808 expected to generate a nice head for the article in question. It is
9809 called when requesting the headers of all articles.
9813 Let's look at the most complicated example I can come up with---standard
9818 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
9819 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
9820 (prepare-body-function . nndoc-unquote-dashes)
9821 (body-end-function . nndoc-digest-body-end)
9823 (body-begin . "^ ?\n")
9824 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
9825 (subtype digest guess))
9828 We see that all text before a 70-width line of dashes is ignored; all
9829 text after a line that starts with that @samp{^End of} is also ignored;
9830 each article begins with a 30-width line of dashes; the line separating
9831 the head from the body may contain a single space; and that the body is
9832 run through @code{nndoc-unquote-dashes} before being delivered.
9834 To hook your own document definition into @code{nndoc}, use the
9835 @code{nndoc-add-type} function. It takes two parameters---the first is
9836 the definition itself and the second (optional) parameter says where in
9837 the document type definition alist to put this definition. The alist is
9838 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for each
9839 type. So @code{nndoc-mmdf-type-p} is called to see whether a document
9840 is of @code{mmdf} type, and so on. These type predicates should return
9841 @code{nil} if the document is not of the correct type; @code{t} if it is
9842 of the correct type; and a number if the document might be of the
9843 correct type. A high number means high probability; a low number means
9844 low probability with @samp{0} being the lowest legal number.
9852 In the PC world people often talk about ``offline'' newsreaders. These
9853 are thingies that are combined reader/news transport monstrosities.
9854 With built-in modem programs. Yecchh!
9856 Of course, us Unix Weenie types of human beans use things like
9857 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
9858 transport things like Ghod intended. And then we just use normal
9861 However, it can sometimes be convenient to do something a that's a bit
9862 easier on the brain if you have a very slow modem, and you're not really
9863 that interested in doing things properly.
9865 A file format called @sc{soup} has been developed for transporting news
9866 and mail from servers to home machines and back again. It can be a bit
9869 First some terminology:
9874 This is the machine that is connected to the outside world and where you
9875 get news and/or mail from.
9878 This is the machine that you want to do the actual reading and responding
9879 on. It is typically not connected to the rest of the world in any way.
9882 Something that contains messages and/or commands. There are two kinds
9886 @item message packets
9887 These are packets made at the server, and typically contains lots of
9888 messages for you to read. These are called @file{SoupoutX.tgz} by
9889 default, where @var{X} is a number.
9891 @item response packets
9892 These are packets made at the home machine, and typically contains
9893 replies that you've written. These are called @file{SoupinX.tgz} by
9894 default, where @var{X} is a number.
9904 You log in on the server and create a @sc{soup} packet. You can either
9905 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
9906 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
9907 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
9910 You transfer the packet home. Rail, boat, car or modem will do fine.
9913 You put the packet in your home directory.
9916 You fire up Gnus on your home machine using the @code{nnsoup} backend as
9917 the native or secondary server.
9920 You read articles and mail and answer and followup to the things you
9921 want (@pxref{SOUP Replies}).
9924 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
9928 You transfer this packet to the server.
9931 You use Gnus to mail this packet out with the @kbd{G s s} command.
9934 You then repeat until you die.
9938 So you basically have a bipartite system---you use @code{nnsoup} for
9939 reading and Gnus for packing/sending these @sc{soup} packets.
9942 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
9943 * SOUP Groups:: A backend for reading @sc{soup} packets.
9944 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
9949 @subsubsection SOUP Commands
9951 These are commands for creating and manipulating @sc{soup} packets.
9955 @kindex G s b (Group)
9956 @findex gnus-group-brew-soup
9957 Pack all unread articles in the current group
9958 (@code{gnus-group-brew-soup}). This command understands the
9959 process/prefix convention.
9962 @kindex G s w (Group)
9963 @findex gnus-soup-save-areas
9964 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
9967 @kindex G s s (Group)
9968 @findex gnus-soup-send-replies
9969 Send all replies from the replies packet
9970 (@code{gnus-soup-send-replies}).
9973 @kindex G s p (Group)
9974 @findex gnus-soup-pack-packet
9975 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
9978 @kindex G s r (Group)
9979 @findex nnsoup-pack-replies
9980 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
9983 @kindex O s (Summary)
9984 @findex gnus-soup-add-article
9985 This summary-mode command adds the current article to a @sc{soup} packet
9986 (@code{gnus-soup-add-article}). It understands the process/prefix
9987 convention (@pxref{Process/Prefix}).
9992 There are a few variables to customize where Gnus will put all these
9997 @item gnus-soup-directory
9998 @vindex gnus-soup-directory
9999 Directory where Gnus will save intermediate files while composing
10000 @sc{soup} packets. The default is @file{~/SoupBrew/}.
10002 @item gnus-soup-replies-directory
10003 @vindex gnus-soup-replies-directory
10004 This is what Gnus will use as a temporary directory while sending our
10005 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
10007 @item gnus-soup-prefix-file
10008 @vindex gnus-soup-prefix-file
10009 Name of the file where Gnus stores the last used prefix. The default is
10010 @samp{gnus-prefix}.
10012 @item gnus-soup-packer
10013 @vindex gnus-soup-packer
10014 A format string command for packing a @sc{soup} packet. The default is
10015 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
10017 @item gnus-soup-unpacker
10018 @vindex gnus-soup-unpacker
10019 Format string command for unpacking a @sc{soup} packet. The default is
10020 @samp{gunzip -c %s | tar xvf -}.
10022 @item gnus-soup-packet-directory
10023 @vindex gnus-soup-packet-directory
10024 Where Gnus will look for reply packets. The default is @file{~/}.
10026 @item gnus-soup-packet-regexp
10027 @vindex gnus-soup-packet-regexp
10028 Regular expression matching @sc{soup} reply packets in
10029 @code{gnus-soup-packet-directory}.
10035 @subsubsection @sc{soup} Groups
10038 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
10039 read incoming packets, unpack them, and put them in a directory where
10040 you can read them at leisure.
10042 These are the variables you can use to customize its behavior:
10046 @item nnsoup-tmp-directory
10047 @vindex nnsoup-tmp-directory
10048 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10049 directory. (@file{/tmp/} by default.)
10051 @item nnsoup-directory
10052 @vindex nnsoup-directory
10053 @code{nnsoup} then moves each message and index file to this directory.
10054 The default is @file{~/SOUP/}.
10056 @item nnsoup-replies-directory
10057 @vindex nnsoup-replies-directory
10058 All replies will stored in this directory before being packed into a
10059 reply packet. The default is @file{~/SOUP/replies/"}.
10061 @item nnsoup-replies-format-type
10062 @vindex nnsoup-replies-format-type
10063 The @sc{soup} format of the replies packets. The default is @samp{?n}
10064 (rnews), and I don't think you should touch that variable. I probably
10065 shouldn't even have documented it. Drats! Too late!
10067 @item nnsoup-replies-index-type
10068 @vindex nnsoup-replies-index-type
10069 The index type of the replies packet. The is @samp{?n}, which means
10070 ``none''. Don't fiddle with this one either!
10072 @item nnsoup-active-file
10073 @vindex nnsoup-active-file
10074 Where @code{nnsoup} stores lots of information. This is not an ``active
10075 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
10076 this file or mess it up in any way, you're dead. The default is
10077 @file{~/SOUP/active}.
10079 @item nnsoup-packer
10080 @vindex nnsoup-packer
10081 Format string command for packing a reply @sc{soup} packet. The default
10082 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
10084 @item nnsoup-unpacker
10085 @vindex nnsoup-unpacker
10086 Format string command for unpacking incoming @sc{soup} packets. The
10087 default is @samp{gunzip -c %s | tar xvf -}.
10089 @item nnsoup-packet-directory
10090 @vindex nnsoup-packet-directory
10091 Where @code{nnsoup} will look for incoming packets. The default is
10094 @item nnsoup-packet-regexp
10095 @vindex nnsoup-packet-regexp
10096 Regular expression matching incoming @sc{soup} packets. The default is
10103 @subsubsection SOUP Replies
10105 Just using @code{nnsoup} won't mean that your postings and mailings end
10106 up in @sc{soup} reply packets automagically. You have to work a bit
10107 more for that to happen.
10109 @findex nnsoup-set-variables
10110 The @code{nnsoup-set-variables} command will set the appropriate
10111 variables to ensure that all your followups and replies end up in the
10114 In specific, this is what it does:
10117 (setq message-send-news-function 'nnsoup-request-post)
10118 (setq message-send-mail-function 'nnsoup-request-mail)
10121 And that's it, really. If you only want news to go into the @sc{soup}
10122 system you just use the first line. If you only want mail to be
10123 @sc{soup}ed you use the second.
10127 @subsection Web Searches
10131 @cindex InReference
10132 @cindex Usenet searches
10133 @cindex searching the Usenet
10135 It's, like, too neat to search the Usenet for articles that match a
10136 string, but it, like, totally @emph{sucks}, like, totally, to use one of
10137 those, like, Web browsers, and you, like, have to, rilly, like, look at
10138 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
10139 searches without having to use a browser.
10141 The @code{nnweb} backend allows an easy interface to the mighty search
10142 engine. You create an @code{nnweb} group, enter a search pattern, and
10143 then enter the group and read the articles like you would any normal
10144 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
10145 Groups}) will do this in an easy-to-use fashion.
10147 @code{nnweb} groups don't really lend themselves to being solid
10148 groups---they have a very fleeting idea of article numbers. In fact,
10149 each time you enter an @code{nnweb} group (not even changing the search
10150 pattern), you are likely to get the articles ordered in a different
10151 manner. Not even using duplicate suppression (@code{Duplicate
10152 Suppression}) will help, since @code{nnweb} doesn't even know the
10153 @code{Message-ID} of the articles before reading them using some search
10154 engines (DejaNews, for instance). The only possible way to keep track
10155 of which articles you've read is by scoring on the @code{Date}
10156 header---mark all articles that were posted before the last date you
10157 read the group as read.
10159 If the search engine changes its output substantially, @code{nnweb}
10160 won't be able to parse it and will fail. One could hardly fault the Web
10161 providers if they were to do this---their @emph{raison d'être} is to
10162 make money off of advertisements, not to provide services to the
10163 community. Since @code{nnweb} washes the ads off all the articles, one
10164 might think that the providers might be somewhat miffed. We'll see.
10166 You must have the @code{url} and @code{w3} package installed to be able
10167 to use @code{nnweb}.
10169 Virtual server variables:
10174 What search engine type is being used. The currently supported types
10175 are @code{dejanews}, @code{altavista} and @code{reference}.
10178 @vindex nnweb-search
10179 The search string to feed to the search engine.
10181 @item nnweb-max-hits
10182 @vindex nnweb-max-hits
10183 Advisory maximum number of hits per search to display. The default is
10186 @item nnweb-type-definition
10187 @vindex nnweb-type-definition
10188 Type-to-definition alist. This alist says what @code{nnweb} should do
10189 with the various search engine types. The following elements must be
10194 Function to decode the article and provide something that Gnus
10198 Function to create an article number to message header and URL alist.
10201 Function to send the search string to the search engine.
10204 The address the aforementioned function should send the search string
10208 Format string URL to fetch an article by @code{Message-ID}.
10215 @node Mail-To-News Gateways
10216 @subsection Mail-To-News Gateways
10217 @cindex mail-to-news gateways
10220 If your local @code{nntp} server doesn't allow posting, for some reason
10221 or other, you can post using one of the numerous mail-to-news gateways.
10222 The @code{nngateway} backend provides the interface.
10224 Note that you can't read anything from this backend---it can only be
10230 @item nngateway-address
10231 @vindex nngateway-address
10232 This is the address of the mail-to-news gateway.
10234 @item nngateway-header-transformation
10235 @vindex nngateway-header-transformation
10236 News headers have often have to be transformed in some odd way or other
10237 for the mail-to-news gateway to accept it. This variable says what
10238 transformation should be called, and defaults to
10239 @code{nngateway-simple-header-transformation}. The function is called
10240 narrowed to the headers to be transformed and with one parameter---the
10243 This default function just inserts a new @code{To} header based on the
10244 @code{Newsgroups} header and the gateway address---an article with this
10245 @code{Newsgroups} header:
10248 Newsgroups: alt.religion.emacs
10251 will get this @code{From} header inserted:
10254 To: alt-religion-emacs@@GATEWAY
10259 So, to use this, simply say something like:
10262 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
10266 @node Combined Groups
10267 @section Combined Groups
10269 Gnus allows combining a mixture of all the other group types into bigger
10273 * Virtual Groups:: Combining articles from many groups.
10274 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
10278 @node Virtual Groups
10279 @subsection Virtual Groups
10281 @cindex virtual groups
10283 An @dfn{nnvirtual group} is really nothing more than a collection of
10286 For instance, if you are tired of reading many small group, you can
10287 put them all in one big group, and then grow tired of reading one
10288 big, unwieldy group. The joys of computing!
10290 You specify @code{nnvirtual} as the method. The address should be a
10291 regexp to match component groups.
10293 All marks in the virtual group will stick to the articles in the
10294 component groups. So if you tick an article in a virtual group, the
10295 article will also be ticked in the component group from whence it came.
10296 (And vice versa---marks from the component groups will also be shown in
10297 the virtual group.)
10299 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
10300 newsgroups into one, big, happy newsgroup:
10303 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
10306 The component groups can be native or foreign; everything should work
10307 smoothly, but if your computer explodes, it was probably my fault.
10309 Collecting the same group from several servers might actually be a good
10310 idea if users have set the Distribution header to limit distribution.
10311 If you would like to read @samp{soc.motss} both from a server in Japan
10312 and a server in Norway, you could use the following as the group regexp:
10315 "^nntp+some.server.jp:soc.motss$\\|^nntp+some.server.no:soc.motss$"
10318 This should work kinda smoothly---all articles from both groups should
10319 end up in this one, and there should be no duplicates. Threading (and
10320 the rest) will still work as usual, but there might be problems with the
10321 sequence of articles. Sorting on date might be an option here
10322 (@pxref{Selecting a Group}.
10324 One limitation, however---all groups that are included in a virtual
10325 group has to be alive (i.e., subscribed or unsubscribed). Killed or
10326 zombie groups can't be component groups for @code{nnvirtual} groups.
10328 @vindex nnvirtual-always-rescan
10329 If the @code{nnvirtual-always-rescan} is non-@code{nil},
10330 @code{nnvirtual} will always scan groups for unread articles when
10331 entering a virtual group. If this variable is @code{nil} (which is the
10332 default) and you read articles in a component group after the virtual
10333 group has been activated, the read articles from the component group
10334 will show up when you enter the virtual group. You'll also see this
10335 effect if you have two virtual groups that contain the same component
10336 group. If that's the case, you should set this variable to @code{t}.
10337 Or you can just tap @code{M-g} on the virtual group every time before
10338 you enter it---it'll have much the same effect.
10341 @node Kibozed Groups
10342 @subsection Kibozed Groups
10346 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
10347 the news feed''. @code{nnkiboze} is a backend that will do this for
10348 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
10349 with useless requests! Oh happiness!
10351 @kindex G k (Group)
10352 To create a kibozed group, use the @kbd{G k} command in the group
10355 The address field of the @code{nnkiboze} method is, as with
10356 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
10357 @code{nnkiboze} group. There most similarities between @code{nnkiboze}
10358 and @code{nnvirtual} ends.
10360 In addition to this regexp detailing component groups, an @code{nnkiboze} group
10361 must have a score file to say what articles that are to be included in
10362 the group (@pxref{Scoring}).
10364 @kindex M-x nnkiboze-generate-groups
10365 @findex nnkiboze-generate-groups
10366 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
10367 @code{nnkiboze} groups you want to have. This command will take time. Lots of
10368 time. Oodles and oodles of time. Gnus has to fetch the headers from
10369 all the articles in all the components groups and run them through the
10370 scoring process to determine if there are any articles in the groups
10371 that are to be part of the @code{nnkiboze} groups.
10373 Please limit the number of component groups by using restrictive
10374 regexps. Otherwise your sysadmin may become annoyed with you, and the
10375 @sc{nntp} site may throw you off and never let you back in again.
10376 Stranger things have happened.
10378 @code{nnkiboze} component groups do not have to be alive---they can be dead,
10379 and they can be foreign. No restrictions.
10381 @vindex nnkiboze-directory
10382 The generation of an @code{nnkiboze} group means writing two files in
10383 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
10384 contains the @sc{nov} header lines for all the articles in the group,
10385 and the other is an additional @file{.newsrc} file to store information
10386 on what groups that have been searched through to find component
10389 Articles that are marked as read in the @code{nnkiboze} group will have their
10390 @sc{nov} lines removed from the @sc{nov} file.
10397 Other people use @dfn{kill files}, but we here at Gnus Towers like
10398 scoring better than killing, so we'd rather switch than fight. They do
10399 something completely different as well, so sit up straight and pay
10402 @vindex gnus-summary-mark-below
10403 All articles have a default score (@code{gnus-summary-default-score}),
10404 which is 0 by default. This score may be raised or lowered either
10405 interactively or by score files. Articles that have a score lower than
10406 @code{gnus-summary-mark-below} are marked as read.
10408 Gnus will read any @dfn{score files} that apply to the current group
10409 before generating the summary buffer.
10411 There are several commands in the summary buffer that insert score
10412 entries based on the current article. You can, for instance, ask Gnus to
10413 lower or increase the score of all articles with a certain subject.
10415 There are two sorts of scoring entries: Permanent and temporary.
10416 Temporary score entries are self-expiring entries. Any entries that are
10417 temporary and have not been used for, say, a week, will be removed
10418 silently to help keep the sizes of the score files down.
10421 * Summary Score Commands:: Adding score entries for the current group.
10422 * Group Score Commands:: General score commands.
10423 * Score Variables:: Customize your scoring. (My, what terminology).
10424 * Score File Format:: What a score file may contain.
10425 * Score File Editing:: You can edit score files by hand as well.
10426 * Adaptive Scoring:: Big Sister Gnus knows what you read.
10427 * Home Score File:: How to say where new score entries are to go.
10428 * Followups To Yourself:: Having Gnus notice when people answer you.
10429 * Scoring Tips:: How to score effectively.
10430 * Reverse Scoring:: That problem child of old is not problem.
10431 * Global Score Files:: Earth-spanning, ear-splitting score files.
10432 * Kill Files:: They are still here, but they can be ignored.
10433 * Converting Kill Files:: Translating kill files to score files.
10434 * GroupLens:: Getting predictions on what you like to read.
10435 * Advanced Scoring:: Using logical expressions to build score rules.
10436 * Score Decays:: It can be useful to let scores wither away.
10440 @node Summary Score Commands
10441 @section Summary Score Commands
10442 @cindex score commands
10444 The score commands that alter score entries do not actually modify real
10445 score files. That would be too inefficient. Gnus maintains a cache of
10446 previously loaded score files, one of which is considered the
10447 @dfn{current score file alist}. The score commands simply insert
10448 entries into this list, and upon group exit, this list is saved.
10450 The current score file is by default the group's local score file, even
10451 if no such score file actually exists. To insert score commands into
10452 some other score file (e.g. @file{all.SCORE}), you must first make this
10453 score file the current one.
10455 General score commands that don't actually change the score file:
10460 @kindex V s (Summary)
10461 @findex gnus-summary-set-score
10462 Set the score of the current article (@code{gnus-summary-set-score}).
10465 @kindex V S (Summary)
10466 @findex gnus-summary-current-score
10467 Display the score of the current article
10468 (@code{gnus-summary-current-score}).
10471 @kindex V t (Summary)
10472 @findex gnus-score-find-trace
10473 Display all score rules that have been used on the current article
10474 (@code{gnus-score-find-trace}).
10477 @kindex V R (Summary)
10478 @findex gnus-summary-rescore
10479 Run the current summary through the scoring process
10480 (@code{gnus-summary-rescore}). This might be useful if you're playing
10481 around with your score files behind Gnus' back and want to see the
10482 effect you're having.
10485 @kindex V a (Summary)
10486 @findex gnus-summary-score-entry
10487 Add a new score entry, and allow specifying all elements
10488 (@code{gnus-summary-score-entry}).
10491 @kindex V c (Summary)
10492 @findex gnus-score-change-score-file
10493 Make a different score file the current
10494 (@code{gnus-score-change-score-file}).
10497 @kindex V e (Summary)
10498 @findex gnus-score-edit-current-scores
10499 Edit the current score file (@code{gnus-score-edit-current-scores}).
10500 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
10504 @kindex V f (Summary)
10505 @findex gnus-score-edit-file
10506 Edit a score file and make this score file the current one
10507 (@code{gnus-score-edit-file}).
10510 @kindex V F (Summary)
10511 @findex gnus-score-flush-cache
10512 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
10513 after editing score files.
10516 @kindex V C (Summary)
10517 @findex gnus-score-customize
10518 Customize a score file in a visually pleasing manner
10519 (@code{gnus-score-customize}).
10522 @kindex I C-i (Summary)
10523 @findex gnus-summary-raise-score
10524 Increase the score of the current article
10525 (@code{gnus-summary-raise-score}).
10528 @kindex L C-l (Summary)
10529 @findex gnus-summary-lower-score
10530 Lower the score of the current article
10531 (@code{gnus-summary-lower-score}).
10534 The rest of these commands modify the local score file.
10539 @kindex V m (Summary)
10540 @findex gnus-score-set-mark-below
10541 Prompt for a score, and mark all articles with a score below this as
10542 read (@code{gnus-score-set-mark-below}).
10545 @kindex V x (Summary)
10546 @findex gnus-score-set-expunge-below
10547 Prompt for a score, and add a score rule to the current score file to
10548 expunge all articles below this score
10549 (@code{gnus-score-set-expunge-below}).
10552 The keystrokes for actually making score entries follow a very regular
10553 pattern, so there's no need to list all the commands. (Hundreds of
10558 The first key is either @kbd{I} (upper case i) for increasing the score
10559 or @kbd{L} for lowering the score.
10561 The second key says what header you want to score on. The following
10562 keys are available:
10566 Score on the author name.
10569 Score on the subject line.
10572 Score on the Xref line---i.e., the cross-posting line.
10575 Score on thread---the References line.
10581 Score on the number of lines.
10584 Score on the Message-ID.
10587 Score on followups.
10597 The third key is the match type. Which match types are legal depends on
10598 what headers you are scoring on.
10610 Substring matching.
10642 Greater than number.
10647 The fourth and final key says whether this is a temporary (i.e., expiring)
10648 score entry, or a permanent (i.e., non-expiring) score entry, or whether
10649 it is to be done immediately, without adding to the score file.
10653 Temporary score entry.
10656 Permanent score entry.
10659 Immediately scoring.
10664 So, let's say you want to increase the score on the current author with
10665 exact matching permanently: @kbd{I a e p}. If you want to lower the
10666 score based on the subject line, using substring matching, and make a
10667 temporary score entry: @kbd{L s s t}. Pretty easy.
10669 To make things a bit more complicated, there are shortcuts. If you use
10670 a capital letter on either the second or third keys, Gnus will use
10671 defaults for the remaining one or two keystrokes. The defaults are
10672 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
10673 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
10675 @vindex gnus-score-mimic-keymap
10676 The @code{gnus-score-mimic-keymap} says whether these commands will
10677 pretend they are keymaps or not.
10680 @node Group Score Commands
10681 @section Group Score Commands
10682 @cindex group score commands
10684 There aren't many of these as yet, I'm afraid.
10689 @kindex W f (Group)
10690 @findex gnus-score-flush-cache
10691 Gnus maintains a cache of score alists to avoid having to reload them
10692 all the time. This command will flush the cache
10693 (@code{gnus-score-flush-cache}).
10698 @node Score Variables
10699 @section Score Variables
10700 @cindex score variables
10704 @item gnus-use-scoring
10705 @vindex gnus-use-scoring
10706 If @code{nil}, Gnus will not check for score files, and will not, in
10707 general, do any score-related work. This is @code{t} by default.
10709 @item gnus-kill-killed
10710 @vindex gnus-kill-killed
10711 If this variable is @code{nil}, Gnus will never apply score files to
10712 articles that have already been through the kill process. While this
10713 may save you lots of time, it also means that if you apply a kill file
10714 to a group, and then change the kill file and want to run it over you
10715 group again to kill more articles, it won't work. You have to set this
10716 variable to @code{t} to do that. (It is @code{t} by default.)
10718 @item gnus-kill-files-directory
10719 @vindex gnus-kill-files-directory
10720 All kill and score files will be stored in this directory, which is
10721 initialized from the @code{SAVEDIR} environment variable by default.
10722 This is @file{~/News/} by default.
10724 @item gnus-score-file-suffix
10725 @vindex gnus-score-file-suffix
10726 Suffix to add to the group name to arrive at the score file name
10727 (@samp{SCORE} by default.)
10729 @item gnus-score-uncacheable-files
10730 @vindex gnus-score-uncacheable-files
10731 @cindex score cache
10732 All score files are normally cached to avoid excessive re-loading of
10733 score files. However, if this might make you Emacs grow big and
10734 bloated, so this regexp can be used to weed out score files that are
10735 unlikely to be needed again. It would be a bad idea to deny caching of
10736 @file{all.SCORE}, while it might be a good idea to not cache
10737 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
10738 variable is @samp{ADAPT$} by default, so no adaptive score files will
10741 @item gnus-save-score
10742 @vindex gnus-save-score
10743 If you have really complicated score files, and do lots of batch
10744 scoring, then you might set this variable to @code{t}. This will make
10745 Gnus save the scores into the @file{.newsrc.eld} file.
10747 @item gnus-score-interactive-default-score
10748 @vindex gnus-score-interactive-default-score
10749 Score used by all the interactive raise/lower commands to raise/lower
10750 score with. Default is 1000, which may seem excessive, but this is to
10751 ensure that the adaptive scoring scheme gets enough room to play with.
10752 We don't want the small changes from the adaptive scoring to overwrite
10753 manually entered data.
10755 @item gnus-summary-default-score
10756 @vindex gnus-summary-default-score
10757 Default score of an article, which is 0 by default.
10759 @item gnus-summary-expunge-below
10760 @vindex gnus-summary-expunge-below
10761 Don't display the summary lines of articles that have scores lower than
10762 this variable. This is @code{nil} by default, which means that no
10763 articles will be hidden.
10765 @item gnus-score-over-mark
10766 @vindex gnus-score-over-mark
10767 Mark (in the third column) used for articles with a score over the
10768 default. Default is @samp{+}.
10770 @item gnus-score-below-mark
10771 @vindex gnus-score-below-mark
10772 Mark (in the third column) used for articles with a score below the
10773 default. Default is @samp{-}.
10775 @item gnus-score-find-score-files-function
10776 @vindex gnus-score-find-score-files-function
10777 Function used to find score files for the current group. This function
10778 is called with the name of the group as the argument.
10780 Predefined functions available are:
10783 @item gnus-score-find-single
10784 @findex gnus-score-find-single
10785 Only apply the group's own score file.
10787 @item gnus-score-find-bnews
10788 @findex gnus-score-find-bnews
10789 Apply all score files that match, using bnews syntax. This is the
10790 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
10791 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
10792 @file{gnu.all.SCORE} would all apply. In short, the instances of
10793 @samp{all} in the score file names are translated into @samp{.*}, and
10794 then a regexp match is done.
10796 This means that if you have some score entries that you want to apply to
10797 all groups, then you put those entries in the @file{all.SCORE} file.
10799 The score files are applied in a semi-random order, although Gnus will
10800 try to apply the more general score files before the more specific score
10801 files. It does this by looking at the number of elements in the score
10802 file names---discarding the @samp{all} elements.
10804 @item gnus-score-find-hierarchical
10805 @findex gnus-score-find-hierarchical
10806 Apply all score files from all the parent groups. This means that you
10807 can't have score files like @file{all.SCORE}, but you can have
10808 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
10811 This variable can also be a list of functions. In that case, all these
10812 functions will be called, and all the returned lists of score files will
10813 be applied. These functions can also return lists of score alists
10814 directly. In that case, the functions that return these non-file score
10815 alists should probably be placed before the ``real'' score file
10816 functions, to ensure that the last score file returned is the local
10819 @item gnus-score-expiry-days
10820 @vindex gnus-score-expiry-days
10821 This variable says how many days should pass before an unused score file
10822 entry is expired. If this variable is @code{nil}, no score file entries
10823 are expired. It's 7 by default.
10825 @item gnus-update-score-entry-dates
10826 @vindex gnus-update-score-entry-dates
10827 If this variable is non-@code{nil}, matching score entries will have
10828 their dates updated. (This is how Gnus controls expiry---all
10829 non-matching entries will become too old while matching entries will
10830 stay fresh and young.) However, if you set this variable to @code{nil},
10831 even matching entries will grow old and will have to face that oh-so
10834 @item gnus-score-after-write-file-function
10835 @vindex gnus-score-after-write-file-function
10836 Function called with the name of the score file just written.
10841 @node Score File Format
10842 @section Score File Format
10843 @cindex score file format
10845 A score file is an @code{emacs-lisp} file that normally contains just a
10846 single form. Casual users are not expected to edit these files;
10847 everything can be changed from the summary buffer.
10849 Anyway, if you'd like to dig into it yourself, here's an example:
10853 ("Lars Ingebrigtsen" -10000)
10855 ("larsi\\|lmi" -50000 nil R))
10857 ("Ding is Badd" nil 728373))
10859 ("alt.politics" -1000 728372 s))
10864 (mark-and-expunge -10)
10868 (files "/hom/larsi/News/gnu.SCORE")
10869 (exclude-files "all.SCORE")
10870 (local (gnus-newsgroup-auto-expire t)
10871 (gnus-summary-make-false-root 'empty))
10875 This example demonstrates absolutely everything about a score file.
10877 Even though this looks much like lisp code, nothing here is actually
10878 @code{eval}ed. The lisp reader is used to read this form, though, so it
10879 has to be legal syntactically, if not semantically.
10881 Six keys are supported by this alist:
10886 If the key is a string, it is the name of the header to perform the
10887 match on. Scoring can only be performed on these eight headers:
10888 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
10889 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
10890 these headers, there are three strings to tell Gnus to fetch the entire
10891 article and do the match on larger parts of the article: @code{Body}
10892 will perform the match on the body of the article, @code{Head} will
10893 perform the match on the head of the article, and @code{All} will
10894 perform the match on the entire article. Note that using any of these
10895 last three keys will slow down group entry @emph{considerably}. The
10896 final ``header'' you can score on is @code{Followup}. These score
10897 entries will result in new score entries being added for all follow-ups
10898 to articles that matches these score entries.
10900 Following this key is a arbitrary number of score entries, where each
10901 score entry has one to four elements.
10905 The first element is the @dfn{match element}. On most headers this will
10906 be a string, but on the Lines and Chars headers, this must be an
10910 If the second element is present, it should be a number---the @dfn{score
10911 element}. This number should be an integer in the neginf to posinf
10912 interval. This number is added to the score of the article if the match
10913 is successful. If this element is not present, the
10914 @code{gnus-score-interactive-default-score} number will be used
10915 instead. This is 1000 by default.
10918 If the third element is present, it should be a number---the @dfn{date
10919 element}. This date says when the last time this score entry matched,
10920 which provides a mechanism for expiring the score entries. It this
10921 element is not present, the score entry is permanent. The date is
10922 represented by the number of days since December 31, 1 ce.
10925 If the fourth element is present, it should be a symbol---the @dfn{type
10926 element}. This element specifies what function should be used to see
10927 whether this score entry matches the article. What match types that can
10928 be used depends on what header you wish to perform the match on.
10931 @item From, Subject, References, Xref, Message-ID
10932 For most header types, there are the @code{r} and @code{R} (regexp), as
10933 well as @code{s} and @code{S} (substring) types, and @code{e} and
10934 @code{E} (exact match), and @code{w} (word match) types. If this
10935 element is not present, Gnus will assume that substring matching should
10936 be used. @code{R}, @code{S}, and @code{E} differ from the others in
10937 that the matches will be done in a case-sensitive manner. All these
10938 one-letter types are really just abbreviations for the @code{regexp},
10939 @code{string}, @code{exact}, and @code{word} types, which you can use
10940 instead, if you feel like.
10943 These two headers use different match types: @code{<}, @code{>},
10944 @code{=}, @code{>=} and @code{<=}. When matching on @code{Lines}, be
10945 careful because some backends (like @code{nndir}) do not generate
10946 @code{Lines} header, so every article ends up being marked as having 0
10947 lines. This can lead to strange results if you happen to lower score of
10948 the articles with few lines.
10951 For the Date header we have three kinda silly match types:
10952 @code{before}, @code{at} and @code{after}. I can't really imagine this
10953 ever being useful, but, like, it would feel kinda silly not to provide
10954 this function. Just in case. You never know. Better safe than sorry.
10955 Once burnt, twice shy. Don't judge a book by its cover. Never not have
10956 sex on a first date. (I have been told that at least one person, and I
10957 quote, ``found this function indispensable'', however.)
10961 A more useful match type is @code{regexp}. With it, you can match the
10962 date string using a regular expression. The date is normalized to
10963 ISO8601 compact format first---@samp{YYYYMMDDTHHMMSS}. If you want to
10964 match all articles that have been posted on April 1st in every year, you
10965 could use @samp{....0401.........} as a match string, for instance.
10966 (Note that the date is kept in its original time zone, so this will
10967 match articles that were posted when it was April 1st where the article
10968 was posted from. Time zones are such wholesome fun for the whole
10971 @item Head, Body, All
10972 These three match keys use the same match types as the @code{From} (etc)
10976 This match key is somewhat special, in that it will match the
10977 @code{From} header, and affect the score of not only the matching
10978 articles, but also all followups to the matching articles. This allows
10979 you e.g. increase the score of followups to your own articles, or
10980 decrease the score of followups to the articles of some known
10981 trouble-maker. Uses the same match types as the @code{From} header
10985 This match key works along the same lines as the @code{Followup} match
10986 key. If you say that you want to score on a (sub-)thread that is
10987 started by an article with a @code{Message-ID} @var{X}, then you add a
10988 @samp{thread} match. This will add a new @samp{thread} match for each
10989 article that has @var{X} in its @code{References} header. (These new
10990 @samp{thread} matches will use the @code{Message-ID}s of these matching
10991 articles.) This will ensure that you can raise/lower the score of an
10992 entire thread, even though some articles in the thread may not have
10993 complete @code{References} headers. Note that using this may lead to
10994 undeterministic scores of the articles in the thread.
10999 The value of this entry should be a number. Any articles with a score
11000 lower than this number will be marked as read.
11003 The value of this entry should be a number. Any articles with a score
11004 lower than this number will be removed from the summary buffer.
11006 @item mark-and-expunge
11007 The value of this entry should be a number. Any articles with a score
11008 lower than this number will be marked as read and removed from the
11011 @item thread-mark-and-expunge
11012 The value of this entry should be a number. All articles that belong to
11013 a thread that has a total score below this number will be marked as read
11014 and removed from the summary buffer. @code{gnus-thread-score-function}
11015 says how to compute the total score for a thread.
11018 The value of this entry should be any number of file names. These files
11019 are assumed to be score files as well, and will be loaded the same way
11022 @item exclude-files
11023 The clue of this entry should be any number of files. These files will
11024 not be loaded, even though they would normally be so, for some reason or
11028 The value of this entry will be @code{eval}el. This element will be
11029 ignored when handling global score files.
11032 Read-only score files will not be updated or saved. Global score files
11033 should feature this atom (@pxref{Global Score Files}).
11036 The value of this entry should be a number. Articles that do not have
11037 parents will get this number added to their scores. Imagine you follow
11038 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
11039 will only follow a few of the threads, also want to see any new threads.
11041 You can do this with the following two score file entries:
11045 (mark-and-expunge -100)
11048 When you enter the group the first time, you will only see the new
11049 threads. You then raise the score of the threads that you find
11050 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
11051 rest. Next time you enter the group, you will see new articles in the
11052 interesting threads, plus any new threads.
11054 I.e.---the orphan score atom is for high-volume groups where there
11055 exist a few interesting threads which can't be found automatically by
11056 ordinary scoring rules.
11059 This entry controls the adaptive scoring. If it is @code{t}, the
11060 default adaptive scoring rules will be used. If it is @code{ignore}, no
11061 adaptive scoring will be performed on this group. If it is a list, this
11062 list will be used as the adaptive scoring rules. If it isn't present,
11063 or is something other than @code{t} or @code{ignore}, the default
11064 adaptive scoring rules will be used. If you want to use adaptive
11065 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
11066 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
11067 not want adaptive scoring. If you only want adaptive scoring in a few
11068 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
11069 insert @code{(adapt t)} in the score files of the groups where you want
11073 All adaptive score entries will go to the file named by this entry. It
11074 will also be applied when entering the group. This atom might be handy
11075 if you want to adapt on several groups at once, using the same adaptive
11076 file for a number of groups.
11079 @cindex local variables
11080 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
11081 Each @var{var} will be made buffer-local to the current summary buffer,
11082 and set to the value specified. This is a convenient, if somewhat
11083 strange, way of setting variables in some groups if you don't like hooks
11088 @node Score File Editing
11089 @section Score File Editing
11091 You normally enter all scoring commands from the summary buffer, but you
11092 might feel the urge to edit them by hand as well, so we've supplied you
11093 with a mode for that.
11095 It's simply a slightly customized @code{emacs-lisp} mode, with these
11096 additional commands:
11101 @kindex C-c C-c (Score)
11102 @findex gnus-score-edit-done
11103 Save the changes you have made and return to the summary buffer
11104 (@code{gnus-score-edit-done}).
11107 @kindex C-c C-d (Score)
11108 @findex gnus-score-edit-insert-date
11109 Insert the current date in numerical format
11110 (@code{gnus-score-edit-insert-date}). This is really the day number, if
11111 you were wondering.
11114 @kindex C-c C-p (Score)
11115 @findex gnus-score-pretty-print
11116 The adaptive score files are saved in an unformatted fashion. If you
11117 intend to read one of these files, you want to @dfn{pretty print} it
11118 first. This command (@code{gnus-score-pretty-print}) does that for
11123 Type @kbd{M-x gnus-score-mode} to use this mode.
11125 @vindex gnus-score-mode-hook
11126 @code{gnus-score-menu-hook} is run in score mode buffers.
11128 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
11129 e} to begin editing score files.
11132 @node Adaptive Scoring
11133 @section Adaptive Scoring
11134 @cindex adaptive scoring
11136 If all this scoring is getting you down, Gnus has a way of making it all
11137 happen automatically---as if by magic. Or rather, as if by artificial
11138 stupidity, to be precise.
11140 @vindex gnus-use-adaptive-scoring
11141 When you read an article, or mark an article as read, or kill an
11142 article, you leave marks behind. On exit from the group, Gnus can sniff
11143 these marks and add score elements depending on what marks it finds.
11144 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
11145 @code{t} or @code{(line)}. If you want score adaptively on separate
11146 words appearing in the subjects, you should set this variable to
11147 @code{(word)}. If you want to use both adaptive methods, set this
11148 variable to @code{(word line)}.
11150 @vindex gnus-default-adaptive-score-alist
11151 To give you complete control over the scoring process, you can customize
11152 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
11153 might look something like this:
11156 (defvar gnus-default-adaptive-score-alist
11157 '((gnus-unread-mark)
11158 (gnus-ticked-mark (from 4))
11159 (gnus-dormant-mark (from 5))
11160 (gnus-del-mark (from -4) (subject -1))
11161 (gnus-read-mark (from 4) (subject 2))
11162 (gnus-expirable-mark (from -1) (subject -1))
11163 (gnus-killed-mark (from -1) (subject -3))
11164 (gnus-kill-file-mark)
11165 (gnus-ancient-mark)
11166 (gnus-low-score-mark)
11167 (gnus-catchup-mark (from -1) (subject -1))))
11170 As you see, each element in this alist has a mark as a key (either a
11171 variable name or a ``real'' mark---a character). Following this key is
11172 a arbitrary number of header/score pairs. If there are no header/score
11173 pairs following the key, no adaptive scoring will be done on articles
11174 that have that key as the article mark. For instance, articles with
11175 @code{gnus-unread-mark} in the example above will not get adaptive score
11178 Each article can have only one mark, so just a single of these rules
11179 will be applied to each article.
11181 To take @code{gnus-del-mark} as an example---this alist says that all
11182 articles that have that mark (i.e., are marked with @samp{D}) will have a
11183 score entry added to lower based on the @code{From} header by -4, and
11184 lowered by @code{Subject} by -1. Change this to fit your prejudices.
11186 If you have marked 10 articles with the same subject with
11187 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
11188 That means that that subject will get a score of ten times -1, which
11189 should be, unless I'm much mistaken, -10.
11191 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
11192 the read articles will be marked with the @samp{E} mark. This'll
11193 probably make adaptive scoring slightly impossible, so auto-expiring and
11194 adaptive scoring doesn't really mix very well.
11196 The headers you can score on are @code{from}, @code{subject},
11197 @code{message-id}, @code{references}, @code{xref}, @code{lines},
11198 @code{chars} and @code{date}. In addition, you can score on
11199 @code{followup}, which will create an adaptive score entry that matches
11200 on the @code{References} header using the @code{Message-ID} of the
11201 current article, thereby matching the following thread.
11203 You can also score on @code{thread}, which will try to score all
11204 articles that appear in a thread. @code{thread} matches uses a
11205 @code{Message-ID} to match on the @code{References} header of the
11206 article. If the match is made, the @code{Message-ID} of the article is
11207 added to the @code{thread} rule. (Think about it. I'd recommend two
11208 aspirins afterwards.)
11210 If you use this scheme, you should set the score file atom @code{mark}
11211 to something small---like -300, perhaps, to avoid having small random
11212 changes result in articles getting marked as read.
11214 After using adaptive scoring for a week or so, Gnus should start to
11215 become properly trained and enhance the authors you like best, and kill
11216 the authors you like least, without you having to say so explicitly.
11218 You can control what groups the adaptive scoring is to be performed on
11219 by using the score files (@pxref{Score File Format}). This will also
11220 let you use different rules in different groups.
11222 @vindex gnus-adaptive-file-suffix
11223 The adaptive score entries will be put into a file where the name is the
11224 group name with @code{gnus-adaptive-file-suffix} appended. The default
11227 @vindex gnus-score-exact-adapt-limit
11228 When doing adaptive scoring, substring or fuzzy matching would probably
11229 give you the best results in most cases. However, if the header one
11230 matches is short, the possibility for false positives is great, so if
11231 the length of the match is less than
11232 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
11233 this variable is @code{nil}, exact matching will always be used to avoid
11236 @vindex gnus-default-adaptive-word-score-alist
11237 As mentioned above, you can adapt either on individual words or entire
11238 headers. If you adapt on words, the
11239 @code{gnus-default-adaptive-word-score-alist} variable says what score
11240 each instance of a word should add given a mark.
11243 (setq gnus-default-adaptive-word-score-alist
11244 `((,gnus-read-mark . 30)
11245 (,gnus-catchup-mark . -10)
11246 (,gnus-killed-mark . -20)
11247 (,gnus-del-mark . -15)))
11250 This is the default value. If you have adaption on words enabled, every
11251 word that appears in subjects of articles that are marked with
11252 @code{gnus-read-mark} will result in a score rule that increase the
11253 score with 30 points.
11255 @vindex gnus-default-ignored-adaptive-words
11256 @vindex gnus-ignored-adaptive-words
11257 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
11258 will be ignored. If you wish to add more words to be ignored, use the
11259 @code{gnus-ignored-adaptive-words} list instead.
11261 @vindex gnus-adaptive-word-syntax-table
11262 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
11263 syntax table in effect. It is similar to the standard syntax table, but
11264 it considers numbers to be non-word-constituent characters.
11266 After using this scheme for a while, it might be nice to write a
11267 @code{gnus-psychoanalyze-user} command to go through the rules and see
11268 what words you like and what words you don't like. Or perhaps not.
11270 Note that the adaptive word scoring thing is highly experimental and is
11271 likely to change in the future. Initial impressions seem to indicate
11272 that it's totally useless as it stands. Some more work (involving more
11273 rigorous statistical methods) will have to be done to make this useful.
11276 @node Home Score File
11277 @section Home Score File
11279 The score file where new score file entries will go is called the
11280 @dfn{home score file}. This is normally (and by default) the score file
11281 for the group itself. For instance, the home score file for
11282 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
11284 However, this may not be what you want. It is often convenient to share
11285 a common home score file among many groups---all @samp{emacs} groups
11286 could perhaps use the same home score file.
11288 @vindex gnus-home-score-file
11289 The variable that controls this is @code{gnus-home-score-file}. It can
11294 A string. Then this file will be used as the home score file for all
11298 A function. The result of this function will be used as the home score
11299 file. The function will be called with the name of the group as the
11303 A list. The elements in this list can be:
11307 @var{(regexp file-name)}. If the @var{regexp} matches the group name,
11308 the @var{file-name} will will be used as the home score file.
11311 A function. If the function returns non-nil, the result will be used as
11312 the home score file.
11315 A string. Use the string as the home score file.
11318 The list will be traversed from the beginning towards the end looking
11323 So, if you want to use just a single score file, you could say:
11326 (setq gnus-home-score-file
11327 "my-total-score-file.SCORE")
11330 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
11331 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
11334 (setq gnus-home-score-file
11335 'gnus-hierarchial-home-score-file)
11338 This is a ready-made function provided for your convenience.
11340 If you want to have one score file for the @samp{emacs} groups and
11341 another for the @samp{comp} groups, while letting all other groups use
11342 their own home score files:
11345 (setq gnus-home-score-file
11346 ;; All groups that match the regexp "\\.emacs"
11347 '("\\.emacs" "emacs.SCORE")
11348 ;; All the comp groups in one score file
11349 ("^comp" "comp.SCORE"))
11352 @vindex gnus-home-adapt-file
11353 @code{gnus-home-adapt-file} works exactly the same way as
11354 @code{gnus-home-score-file}, but says what the home adaptive score file
11355 is instead. All new adaptive file entries will go into the file
11356 specified by this variable, and the same syntax is allowed.
11358 In addition to using @code{gnus-home-score-file} and
11359 @code{gnus-home-adapt-file}, you can also use group parameters
11360 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
11361 Parameters}) to achieve much the same. Group and topic parameters take
11362 precedence over this variable.
11365 @node Followups To Yourself
11366 @section Followups To Yourself
11368 Gnus offers two commands for picking out the @code{Message-ID} header in
11369 the current buffer. Gnus will then add a score rule that scores using
11370 this @code{Message-ID} on the @code{References} header of other
11371 articles. This will, in effect, increase the score of all articles that
11372 respond to the article in the current buffer. Quite useful if you want
11373 to easily note when people answer what you've said.
11377 @item gnus-score-followup-article
11378 @findex gnus-score-followup-article
11379 This will add a score to articles that directly follow up your own
11382 @item gnus-score-followup-thread
11383 @findex gnus-score-followup-thread
11384 This will add a score to all articles that appear in a thread ``below''
11388 @vindex message-sent-hook
11389 These two functions are both primarily meant to be used in hooks like
11390 @code{message-sent-hook}.
11392 If you look closely at your own @code{Message-ID}, you'll notice that
11393 the first two or three characters are always the same. Here's two of
11397 <x6u3u47icf.fsf@@eyesore.no>
11398 <x6sp9o7ibw.fsf@@eyesore.no>
11401 So ``my'' ident on this machine is @samp{x6}. This can be
11402 exploited---the following rule will raise the score on all followups to
11407 ("<x6[0-9a-z]+\\.fsf@.*eyesore.no>" 1000 nil r))
11410 Whether it's the first two or first three characters that are ``yours''
11411 is system-dependent.
11415 @section Scoring Tips
11416 @cindex scoring tips
11422 @cindex scoring crossposts
11423 If you want to lower the score of crossposts, the line to match on is
11424 the @code{Xref} header.
11426 ("xref" (" talk.politics.misc:" -1000))
11429 @item Multiple crossposts
11430 If you want to lower the score of articles that have been crossposted to
11431 more than, say, 3 groups:
11433 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
11436 @item Matching on the body
11437 This is generally not a very good idea---it takes a very long time.
11438 Gnus actually has to fetch each individual article from the server. But
11439 you might want to anyway, I guess. Even though there are three match
11440 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
11441 and stick with it in each score file. If you use any two, each article
11442 will be fetched @emph{twice}. If you want to match a bit on the
11443 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
11446 @item Marking as read
11447 You will probably want to mark articles that has a score below a certain
11448 number as read. This is most easily achieved by putting the following
11449 in your @file{all.SCORE} file:
11453 You may also consider doing something similar with @code{expunge}.
11455 @item Negated character classes
11456 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
11457 That will match newlines, which might lead to, well, The Unknown. Say
11458 @code{[^abcd\n]*} instead.
11462 @node Reverse Scoring
11463 @section Reverse Scoring
11464 @cindex reverse scoring
11466 If you want to keep just articles that have @samp{Sex with Emacs} in the
11467 subject header, and expunge all other articles, you could put something
11468 like this in your score file:
11472 ("Sex with Emacs" 2))
11477 So, you raise all articles that match @samp{Sex with Emacs} and mark the
11478 rest as read, and expunge them to boot.
11481 @node Global Score Files
11482 @section Global Score Files
11483 @cindex global score files
11485 Sure, other newsreaders have ``global kill files''. These are usually
11486 nothing more than a single kill file that applies to all groups, stored
11487 in the user's home directory. Bah! Puny, weak newsreaders!
11489 What I'm talking about here are Global Score Files. Score files from
11490 all over the world, from users everywhere, uniting all nations in one
11491 big, happy score file union! Ange-score! New and untested!
11493 @vindex gnus-global-score-files
11494 All you have to do to use other people's score files is to set the
11495 @code{gnus-global-score-files} variable. One entry for each score file,
11496 or each score file directory. Gnus will decide by itself what score
11497 files are applicable to which group.
11499 Say you want to use the score file
11500 @file{/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE} and
11501 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
11504 (setq gnus-global-score-files
11505 '("/ftp@@ftp.ifi.uio.no:/pub/larsi/ding/score/soc.motss.SCORE"
11506 "/ftp@@ftp.some-where:/pub/score/"))
11509 @findex gnus-score-search-global-directories
11510 Simple, eh? Directory names must end with a @samp{/}. These
11511 directories are typically scanned only once during each Gnus session.
11512 If you feel the need to manually re-scan the remote directories, you can
11513 use the @code{gnus-score-search-global-directories} command.
11515 Note that, at present, using this option will slow down group entry
11516 somewhat. (That is---a lot.)
11518 If you want to start maintaining score files for other people to use,
11519 just put your score file up for anonymous ftp and announce it to the
11520 world. Become a retro-moderator! Participate in the retro-moderator
11521 wars sure to ensue, where retro-moderators battle it out for the
11522 sympathy of the people, luring them to use their score files on false
11523 premises! Yay! The net is saved!
11525 Here are some tips for the would-be retro-moderator, off the top of my
11531 Articles that are heavily crossposted are probably junk.
11533 To lower a single inappropriate article, lower by @code{Message-ID}.
11535 Particularly brilliant authors can be raised on a permanent basis.
11537 Authors that repeatedly post off-charter for the group can safely be
11538 lowered out of existence.
11540 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
11541 articles completely.
11544 Use expiring score entries to keep the size of the file down. You
11545 should probably have a long expiry period, though, as some sites keep
11546 old articles for a long time.
11549 ... I wonder whether other newsreaders will support global score files
11550 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
11551 Wave, xrn and 1stReader are bound to implement scoring. Should we start
11552 holding our breath yet?
11556 @section Kill Files
11559 Gnus still supports those pesky old kill files. In fact, the kill file
11560 entries can now be expiring, which is something I wrote before Daniel
11561 Quinlan thought of doing score files, so I've left the code in there.
11563 In short, kill processing is a lot slower (and I do mean @emph{a lot})
11564 than score processing, so it might be a good idea to rewrite your kill
11565 files into score files.
11567 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
11568 forms into this file, which means that you can use kill files as some
11569 sort of primitive hook function to be run on group entry, even though
11570 that isn't a very good idea.
11572 Normal kill files look like this:
11575 (gnus-kill "From" "Lars Ingebrigtsen")
11576 (gnus-kill "Subject" "ding")
11580 This will mark every article written by me as read, and remove them from
11581 the summary buffer. Very useful, you'll agree.
11583 Other programs use a totally different kill file syntax. If Gnus
11584 encounters what looks like a @code{rn} kill file, it will take a stab at
11587 Two summary functions for editing a GNUS kill file:
11592 @kindex M-k (Summary)
11593 @findex gnus-summary-edit-local-kill
11594 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
11597 @kindex M-K (Summary)
11598 @findex gnus-summary-edit-global-kill
11599 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
11602 Two group mode functions for editing the kill files:
11607 @kindex M-k (Group)
11608 @findex gnus-group-edit-local-kill
11609 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
11612 @kindex M-K (Group)
11613 @findex gnus-group-edit-global-kill
11614 Edit the general kill file (@code{gnus-group-edit-global-kill}).
11617 Kill file variables:
11620 @item gnus-kill-file-name
11621 @vindex gnus-kill-file-name
11622 A kill file for the group @samp{soc.motss} is normally called
11623 @file{soc.motss.KILL}. The suffix appended to the group name to get
11624 this file name is detailed by the @code{gnus-kill-file-name} variable.
11625 The ``global'' kill file (not in the score file sense of ``global'', of
11626 course) is called just @file{KILL}.
11628 @vindex gnus-kill-save-kill-file
11629 @item gnus-kill-save-kill-file
11630 If this variable is non-@code{nil}, Gnus will save the
11631 kill file after processing, which is necessary if you use expiring
11634 @item gnus-apply-kill-hook
11635 @vindex gnus-apply-kill-hook
11636 @findex gnus-apply-kill-file-unless-scored
11637 @findex gnus-apply-kill-file
11638 A hook called to apply kill files to a group. It is
11639 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
11640 kill file if you have a score file for the same group, you can set this
11641 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
11642 kill files to be processed, you should set this variable to @code{nil}.
11644 @item gnus-kill-file-mode-hook
11645 @vindex gnus-kill-file-mode-hook
11646 A hook called in kill-file mode buffers.
11651 @node Converting Kill Files
11652 @section Converting Kill Files
11654 @cindex converting kill files
11656 If you have loads of old kill files, you may want to convert them into
11657 score files. If they are ``regular'', you can use
11658 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
11661 The kill to score conversion package isn't included in Gnus by default.
11662 You can fetch it from
11663 @file{http://www.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
11665 If your old kill files are very complex---if they contain more
11666 non-@code{gnus-kill} forms than not, you'll have to convert them by
11667 hand. Or just let them be as they are. Gnus will still use them as
11675 GroupLens is a collaborative filtering system that helps you work
11676 together with other people to find the quality news articles out of the
11677 huge volume of news articles generated every day.
11679 To accomplish this the GroupLens system combines your opinions about
11680 articles you have already read with the opinions of others who have done
11681 likewise and gives you a personalized prediction for each unread news
11682 article. Think of GroupLens as a matchmaker. GroupLens watches how you
11683 rate articles, and finds other people that rate articles the same way.
11684 Once it has found for you some people you agree with it tells you, in
11685 the form of a prediction, what they thought of the article. You can use
11686 this prediction to help you decide whether or not you want to read the
11690 * Using GroupLens:: How to make Gnus use GroupLens.
11691 * Rating Articles:: Letting GroupLens know how you rate articles.
11692 * Displaying Predictions:: Displaying predictions given by GroupLens.
11693 * GroupLens Variables:: Customizing GroupLens.
11697 @node Using GroupLens
11698 @subsection Using GroupLens
11700 To use GroupLens you must register a pseudonym with your local Better
11702 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
11703 better bit in town is at the moment.
11705 Once you have registered you'll need to set a couple of variables.
11709 @item gnus-use-grouplens
11710 @vindex gnus-use-grouplens
11711 Setting this variable to a non-@code{nil} value will make Gnus hook into
11712 all the relevant GroupLens functions.
11714 @item grouplens-pseudonym
11715 @vindex grouplens-pseudonym
11716 This variable should be set to the pseudonym you got when registering
11717 with the Better Bit Bureau.
11719 @item grouplens-newsgroups
11720 @vindex grouplens-newsgroups
11721 A list of groups that you want to get GroupLens predictions for.
11725 Thats the minimum of what you need to get up and running with GroupLens.
11726 Once you've registered, GroupLens will start giving you scores for
11727 articles based on the average of what other people think. But, to get
11728 the real benefit of GroupLens you need to start rating articles
11729 yourself. Then the scores GroupLens gives you will be personalized for
11730 you, based on how the people you usually agree with have already rated.
11733 @node Rating Articles
11734 @subsection Rating Articles
11736 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
11737 Where 1 means something like this article is a waste of bandwidth and 5
11738 means that the article was really good. The basic question to ask
11739 yourself is, "on a scale from 1 to 5 would I like to see more articles
11742 There are four ways to enter a rating for an article in GroupLens.
11747 @kindex r (GroupLens)
11748 @findex bbb-summary-rate-article
11749 This function will prompt you for a rating on a scale of one to five.
11752 @kindex k (GroupLens)
11753 @findex grouplens-score-thread
11754 This function will prompt you for a rating, and rate all the articles in
11755 the thread. This is really useful for some of those long running giant
11756 threads in rec.humor.
11760 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
11761 the score of the article you're reading.
11766 @kindex n (GroupLens)
11767 @findex grouplens-next-unread-article
11768 Rate the article and go to the next unread article.
11771 @kindex , (GroupLens)
11772 @findex grouplens-best-unread-article
11773 Rate the article and go to the next unread article with the highest score.
11777 If you want to give the current article a score of 4 and then go to the
11778 next article, just type @kbd{4 n}.
11781 @node Displaying Predictions
11782 @subsection Displaying Predictions
11784 GroupLens makes a prediction for you about how much you will like a
11785 news article. The predictions from GroupLens are on a scale from 1 to
11786 5, where 1 is the worst and 5 is the best. You can use the predictions
11787 from GroupLens in one of three ways controlled by the variable
11788 @code{gnus-grouplens-override-scoring}.
11790 @vindex gnus-grouplens-override-scoring
11791 There are three ways to display predictions in grouplens. You may
11792 choose to have the GroupLens scores contribute to, or override the
11793 regular gnus scoring mechanism. override is the default; however, some
11794 people prefer to see the Gnus scores plus the grouplens scores. To get
11795 the separate scoring behavior you need to set
11796 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
11797 GroupLens predictions combined with the grouplens scores set it to
11798 @code{'override} and to combine the scores set
11799 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
11800 the combine option you will also want to set the values for
11801 @code{grouplens-prediction-offset} and
11802 @code{grouplens-score-scale-factor}.
11804 @vindex grouplens-prediction-display
11805 In either case, GroupLens gives you a few choices for how you would like
11806 to see your predictions displayed. The display of predictions is
11807 controlled by the @code{grouplens-prediction-display} variable.
11809 The following are legal values for that variable.
11812 @item prediction-spot
11813 The higher the prediction, the further to the right an @samp{*} is
11816 @item confidence-interval
11817 A numeric confidence interval.
11819 @item prediction-bar
11820 The higher the prediction, the longer the bar.
11822 @item confidence-bar
11823 Numerical confidence.
11825 @item confidence-spot
11826 The spot gets bigger with more confidence.
11828 @item prediction-num
11829 Plain-old numeric value.
11831 @item confidence-plus-minus
11832 Prediction +/i confidence.
11837 @node GroupLens Variables
11838 @subsection GroupLens Variables
11842 @item gnus-summary-grouplens-line-format
11843 The summary line format used in summary buffers that are GroupLens
11844 enhanced. It accepts the same specs as the normal summary line format
11845 (@pxref{Summary Buffer Lines}). The default is
11846 @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%) %s\n}.
11848 @item grouplens-bbb-host
11849 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
11852 @item grouplens-bbb-port
11853 Port of the host running the bbbd server. The default is 9000.
11855 @item grouplens-score-offset
11856 Offset the prediction by this value. In other words, subtract the
11857 prediction value by this number to arrive at the effective score. The
11860 @item grouplens-score-scale-factor
11861 This variable allows the user to magnify the effect of GroupLens scores.
11862 The scale factor is applied after the offset. The default is 1.
11867 @node Advanced Scoring
11868 @section Advanced Scoring
11870 Scoring on Subjects and From headers is nice enough, but what if you're
11871 really interested in what a person has to say only when she's talking
11872 about a particular subject? Or what about if you really don't want to
11873 read what person A has to say when she's following up to person B, but
11874 want to read what she says when she's following up to person C?
11876 By using advanced scoring rules you may create arbitrarily complex
11880 * Advanced Scoring Syntax:: A definition.
11881 * Advanced Scoring Examples:: What they look like.
11882 * Advanced Scoring Tips:: Getting the most out of it.
11886 @node Advanced Scoring Syntax
11887 @subsection Advanced Scoring Syntax
11889 Ordinary scoring rules have a string as the first element in the rule.
11890 Advanced scoring rules have a list as the first element. The second
11891 element is the score to be applied if the first element evaluated to a
11892 non-@code{nil} value.
11894 These lists may consist of three logical operators, one redirection
11895 operator, and various match operators.
11902 This logical operator will evaluate each of its arguments until it finds
11903 one that evaluates to @code{false}, and then it'll stop. If all arguments
11904 evaluate to @code{true} values, then this operator will return
11909 This logical operator will evaluate each of its arguments until it finds
11910 one that evaluates to @code{true}. If no arguments are @code{true},
11911 then this operator will return @code{false}.
11916 This logical operator only takes a single argument. It returns the
11917 inverse of the value of its argument.
11921 There is an @dfn{indirection operator} that will make its arguments
11922 apply to the ancestors of the current article being scored. For
11923 instance, @code{1-} will make score rules apply to the parent of the
11924 current article. @code{2-} will make score fules apply to the
11925 grandparent of the current article. Alternatively, you can write
11926 @code{^^}, where the number of @code{^}s (carets) say how far back into
11927 the ancestry you want to go.
11929 Finally, we have the match operators. These are the ones that do the
11930 real work. Match operators are header name strings followed by a match
11931 and a match type. A typical match operator looks like @samp{("from"
11932 "Lars Ingebrigtsen" s)}. The header names are the same as when using
11933 simple scoring, and the match types are also the same.
11936 @node Advanced Scoring Examples
11937 @subsection Advanced Scoring Examples
11939 Let's say you want to increase the score of articles written by Lars
11940 when he's talking about Gnus:
11944 ("from" "Lars Ingebrigtsen")
11945 ("subject" "Gnus"))
11951 When he writes long articles, he sometimes has something nice to say:
11955 ("from" "Lars Ingebrigtsen")
11962 However, when he responds to things written by Reig Eigil Logge, you
11963 really don't want to read what he's written:
11967 ("from" "Lars Ingebrigtsen")
11968 (1- ("from" "Reig Eigir Logge")))
11972 Everybody that follows up Redmondo when he writes about disappearing
11973 socks should have their scores raised, but only when they talk about
11974 white socks. However, when Lars talks about socks, it's usually not
11981 ("from" "redmondo@@.*no" r)
11982 ("body" "disappearing.*socks" t)))
11983 (! ("from" "Lars Ingebrigtsen"))
11984 ("body" "white.*socks"))
11988 The possibilities are endless.
11991 @node Advanced Scoring Tips
11992 @subsection Advanced Scoring Tips
11994 The @code{&} and @code{|} logical operators do short-circuit logic.
11995 That is, they stop processing their arguments when it's clear what the
11996 result of the operation will be. For instance, if one of the arguments
11997 of an @code{&} evaluates to @code{false}, there's no point in evaluating
11998 the rest of the arguments. This means that you should put slow matches
11999 (@samp{body}, @code{header}) last and quick matches (@samp{from},
12000 @samp{subject}) first.
12002 The indirection arguments (@code{1-} and so on) will make their
12003 arguments work on previous generations of the thread. If you say
12014 Then that means "score on the from header of the grandparent of the
12015 current article". An indirection is quite fast, but it's better to say:
12021 ("subject" "Gnus")))
12028 (1- ("from" "Lars"))
12029 (1- ("subject" "Gnus")))
12034 @section Score Decays
12035 @cindex score decays
12038 You may find that your scores have a tendency to grow without
12039 bounds, especially if you're using adaptive scoring. If scores get too
12040 big, they lose all meaning---they simply max out and it's difficult to
12041 use them in any sensible way.
12043 @vindex gnus-decay-scores
12044 @findex gnus-decay-score
12045 @vindex gnus-score-decay-function
12046 Gnus provides a mechanism for decaying scores to help with this problem.
12047 When score files are loaded and @code{gnus-decay-scores} is
12048 non-@code{nil}, Gnus will run the score files through the decaying
12049 mechanism thereby lowering the scores of all non-permanent score rules.
12050 The decay itself if performed by the @code{gnus-score-decay-function}
12051 function, which is @code{gnus-decay-score} by default. Here's the
12052 definition of that function:
12055 (defun gnus-decay-score (score)
12058 (* (if (< score 0) 1 -1)
12060 (max gnus-score-decay-constant
12062 gnus-score-decay-scale)))))))
12065 @vindex gnus-score-decay-scale
12066 @vindex gnus-score-decay-constant
12067 @code{gnus-score-decay-constant} is 3 by default and
12068 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
12072 Scores between -3 and 3 will be set to 0 when this function is called.
12075 Scores with magnitudes between 3 and 60 will be shrunk by 3.
12078 Scores with magnitudes greater than 60 will be shrunk by 5% of the
12082 If you don't like this decay function, write your own. It is called
12083 with the score to be decayed as its only parameter, and it should return
12084 the new score, which should be an integer.
12086 Gnus will try to decay scores once a day. If you haven't run Gnus for
12087 four days, Gnus will decay the scores four times, for instance.
12094 * Process/Prefix:: A convention used by many treatment commands.
12095 * Interactive:: Making Gnus ask you many questions.
12096 * Formatting Variables:: You can specify what buffers should look like.
12097 * Windows Configuration:: Configuring the Gnus buffer windows.
12098 * Compilation:: How to speed Gnus up.
12099 * Mode Lines:: Displaying information in the mode lines.
12100 * Highlighting and Menus:: Making buffers look all nice and cozy.
12101 * Buttons:: Get tendonitis in ten easy steps!
12102 * Daemons:: Gnus can do things behind your back.
12103 * NoCeM:: How to avoid spam and other fatty foods.
12104 * Picons:: How to display pictures of what your reading.
12105 * Undo:: Some actions can be undone.
12106 * Moderation:: What to do if you're a moderator.
12107 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
12108 * Various Various:: Things that are really various.
12112 @node Process/Prefix
12113 @section Process/Prefix
12114 @cindex process/prefix convention
12116 Many functions, among them functions for moving, decoding and saving
12117 articles, use what is known as the @dfn{Process/Prefix convention}.
12119 This is a method for figuring out what articles that the user wants the
12120 command to be performed on.
12124 If the numeric prefix is N, perform the operation on the next N
12125 articles, starting with the current one. If the numeric prefix is
12126 negative, perform the operation on the previous N articles, starting
12127 with the current one.
12129 @vindex transient-mark-mode
12130 If @code{transient-mark-mode} in non-@code{nil} and the region is
12131 active, all articles in the region will be worked upon.
12133 If there is no numeric prefix, but some articles are marked with the
12134 process mark, perform the operation on the articles that are marked with
12137 If there is neither a numeric prefix nor any articles marked with the
12138 process mark, just perform the operation on the current article.
12140 Quite simple, really, but it needs to be made clear so that surprises
12143 Commands that react to the process mark will push the current list of
12144 process marked articles onto a stack and will then clear all process
12145 marked articles. You can restore the previous configuration with the
12146 @kbd{M P y} command (@pxref{Setting Process Marks}).
12148 @vindex gnus-summary-goto-unread
12149 One thing that seems to shock & horrify lots of people is that, for
12150 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
12151 Since each @kbd{d} (which marks the current article as read) by default
12152 goes to the next unread article after marking, this means that @kbd{3 d}
12153 will mark the next three unread articles as read, no matter what the
12154 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
12155 @code{nil} for a more straightforward action.
12159 @section Interactive
12160 @cindex interaction
12164 @item gnus-novice-user
12165 @vindex gnus-novice-user
12166 If this variable is non-@code{nil}, you are either a newcomer to the
12167 World of Usenet, or you are very cautious, which is a nice thing to be,
12168 really. You will be given questions of the type ``Are you sure you want
12169 to do this?'' before doing anything dangerous. This is @code{t} by
12172 @item gnus-expert-user
12173 @vindex gnus-expert-user
12174 If this variable is non-@code{nil}, you will never ever be asked any
12175 questions by Gnus. It will simply assume you know what you're doing, no
12176 matter how strange.
12178 @item gnus-interactive-catchup
12179 @vindex gnus-interactive-catchup
12180 Require confirmation before catching up a group if non-@code{nil}. It
12181 is @code{t} by default.
12183 @item gnus-interactive-exit
12184 @vindex gnus-interactive-exit
12185 Require confirmation before exiting Gnus. This variable is @code{t} by
12190 @node Formatting Variables
12191 @section Formatting Variables
12192 @cindex formatting variables
12194 Throughout this manual you've probably noticed lots of variables that
12195 are called things like @code{gnus-group-line-format} and
12196 @code{gnus-summary-mode-line-format}. These control how Gnus is to
12197 output lines in the various buffers. There's quite a lot of them.
12198 Fortunately, they all use the same syntax, so there's not that much to
12201 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
12202 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
12203 lots of percentages everywhere.
12206 * Formatting Basics:: A formatting variable is basically a format string.
12207 * Advanced Formatting:: Modifying output in various ways.
12208 * User-Defined Specs:: Having Gnus call your own functions.
12209 * Formatting Fonts:: Making the formatting look colorful and nice.
12212 Currently Gnus uses the following formatting variables:
12213 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
12214 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
12215 @code{gnus-group-mode-line-format},
12216 @code{gnus-summary-mode-line-format},
12217 @code{gnus-article-mode-line-format},
12218 @code{gnus-server-mode-line-format}, and
12219 @code{gnus-summary-pick-line-format}.
12221 All these format variables can also be arbitrary elisp forms. In that
12222 case, they will be @code{eval}ed to insert the required lines.
12224 @kindex M-x gnus-update-format
12225 @findex gnus-update-format
12226 Gnus includes a command to help you while creating your own format
12227 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
12228 update the spec in question and pop you to a buffer where you can
12229 examine the resulting lisp code to be run to generate the line.
12233 @node Formatting Basics
12234 @subsection Formatting Basics
12236 Each @samp{%} element will be replaced by some string or other when the
12237 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
12238 spec, and pad with spaces to get a 5-character field''.
12240 As with normal C and Emacs Lisp formatting strings, the numerical
12241 modifier between the @samp{%} and the formatting type character will
12242 @dfn{pad} the output so that it is always at least that long.
12243 @samp{%5y} will make the field always (at least) five characters wide by
12244 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
12247 You may also wish to limit the length of the field to protect against
12248 particularly wide values. For that you can say @samp{%4,6y}, which
12249 means that the field will never be more than 6 characters wide and never
12250 less than 4 characters wide.
12253 @node Advanced Formatting
12254 @subsection Advanced Formatting
12256 It is frequently useful to post-process the fields in some way.
12257 Padding, limiting, cutting off parts and suppressing certain values can
12258 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
12259 look like @samp{%~(cut 3)~(ignore "0")y}.
12261 These are the legal modifiers:
12266 Pad the field to the left with spaces until it reaches the required
12270 Pad the field to the right with spaces until it reaches the required
12275 Cut off characters from the left until it reaches the specified length.
12278 Cut off characters from the right until it reaches the specified
12283 Cut off the specified number of characters from the left.
12286 Cut off the specified number of characters from the right.
12289 Return an empty string if the field is equal to the specified value.
12292 Use the specified form as the field value when the @samp{@@} spec is
12296 Let's take an example. The @samp{%o} spec in the summary mode lines
12297 will return a date in compact ISO8601 format---@samp{19960809T230410}.
12298 This is quite a mouthful, so we want to shave off the century number and
12299 the time, leaving us with a six-character date. That would be
12300 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
12301 maxing, and we need the padding to ensure that the date is never less
12302 than 6 characters to make it look nice in columns.)
12304 Ignoring is done first; then cutting; then maxing; and then as the very
12305 last operation, padding.
12307 If you use lots of these advanced thingies, you'll find that Gnus gets
12308 quite slow. This can be helped enormously by running @kbd{M-x
12309 gnus-compile} when you are satisfied with the look of your lines.
12310 @xref{Compilation}.
12313 @node User-Defined Specs
12314 @subsection User-Defined Specs
12316 All the specs allow for inserting user defined specifiers---@samp{u}.
12317 The next character in the format string should be a letter. Gnus
12318 will call the function @code{gnus-user-format-function-}@samp{X}, where
12319 @samp{X} is the letter following @samp{%u}. The function will be passed
12320 a single parameter---what the parameter means depends on what buffer
12321 it's being called from. The function should return a string, which will
12322 be inserted into the buffer just like information from any other
12323 specifier. This function may also be called with dummy values, so it
12324 should protect against that.
12326 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
12327 much the same without defining new functions. Here's an example:
12328 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
12329 given here will be evaluated to yield the current line number, and then
12333 @node Formatting Fonts
12334 @subsection Formatting Fonts
12336 There are specs for highlighting, and these are shared by all the format
12337 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
12338 the special @code{mouse-face} property set, which means that it will be
12339 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
12342 Text inside the @samp{%[} and @samp{%]} specifiers will have their
12343 normal faces set using @code{gnus-face-0}, which is @code{bold} by
12344 default. If you say @samp{%1[} instead, you'll get @code{gnus-face-1}
12345 instead, and so on. Create as many faces as you wish. The same goes
12346 for the @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
12347 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
12349 Here's an alternative recipe for the group buffer:
12352 ;; Create three face types.
12353 (setq gnus-face-1 'bold)
12354 (setq gnus-face-3 'italic)
12356 ;; We want the article count to be in
12357 ;; a bold and green face. So we create
12358 ;; a new face called `my-green-bold'.
12359 (copy-face 'bold 'my-green-bold)
12361 (set-face-foreground 'my-green-bold "ForestGreen")
12362 (setq gnus-face-2 'my-green-bold)
12364 ;; Set the new & fancy format.
12365 (setq gnus-group-line-format
12366 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
12369 I'm sure you'll be able to use this scheme to create totally unreadable
12370 and extremely vulgar displays. Have fun!
12372 Note that the @samp{%(} specs (and friends) do not make any sense on the
12373 mode-line variables.
12376 @node Windows Configuration
12377 @section Windows Configuration
12378 @cindex windows configuration
12380 No, there's nothing here about X, so be quiet.
12382 @vindex gnus-use-full-window
12383 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
12384 other windows and occupy the entire Emacs screen by itself. It is
12385 @code{t} by default.
12387 @vindex gnus-buffer-configuration
12388 @code{gnus-buffer-configuration} describes how much space each Gnus
12389 buffer should be given. Here's an excerpt of this variable:
12392 ((group (vertical 1.0 (group 1.0 point)
12393 (if gnus-carpal (group-carpal 4))))
12394 (article (vertical 1.0 (summary 0.25 point)
12398 This is an alist. The @dfn{key} is a symbol that names some action or
12399 other. For instance, when displaying the group buffer, the window
12400 configuration function will use @code{group} as the key. A full list of
12401 possible names is listed below.
12403 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
12404 should occupy. To take the @code{article} split as an example -
12407 (article (vertical 1.0 (summary 0.25 point)
12411 This @dfn{split} says that the summary buffer should occupy 25% of upper
12412 half of the screen, and that it is placed over the article buffer. As
12413 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
12414 reaching for that calculator there). However, the special number
12415 @code{1.0} is used to signal that this buffer should soak up all the
12416 rest of the space available after the rest of the buffers have taken
12417 whatever they need. There should be only one buffer with the @code{1.0}
12418 size spec per split.
12420 Point will be put in the buffer that has the optional third element
12423 Here's a more complicated example:
12426 (article (vertical 1.0 (group 4)
12427 (summary 0.25 point)
12428 (if gnus-carpal (summary-carpal 4))
12432 If the size spec is an integer instead of a floating point number,
12433 then that number will be used to say how many lines a buffer should
12434 occupy, not a percentage.
12436 If the @dfn{split} looks like something that can be @code{eval}ed (to be
12437 precise---if the @code{car} of the split is a function or a subr), this
12438 split will be @code{eval}ed. If the result is non-@code{nil}, it will
12439 be used as a split. This means that there will be three buffers if
12440 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
12443 Not complicated enough for you? Well, try this on for size:
12446 (article (horizontal 1.0
12451 (summary 0.25 point)
12456 Whoops. Two buffers with the mystery 100% tag. And what's that
12457 @code{horizontal} thingie?
12459 If the first element in one of the split is @code{horizontal}, Gnus will
12460 split the window horizontally, giving you two windows side-by-side.
12461 Inside each of these strips you may carry on all you like in the normal
12462 fashion. The number following @code{horizontal} says what percentage of
12463 the screen is to be given to this strip.
12465 For each split, there @emph{must} be one element that has the 100% tag.
12466 The splitting is never accurate, and this buffer will eat any leftover
12467 lines from the splits.
12469 To be slightly more formal, here's a definition of what a legal split
12473 split = frame | horizontal | vertical | buffer | form
12474 frame = "(frame " size *split ")"
12475 horizontal = "(horizontal " size *split ")"
12476 vertical = "(vertical " size *split ")"
12477 buffer = "(" buffer-name " " size *[ "point" ] ")"
12478 size = number | frame-params
12479 buffer-name = group | article | summary ...
12482 The limitations are that the @code{frame} split can only appear as the
12483 top-level split. @var{form} should be an Emacs Lisp form that should
12484 return a valid split. We see that each split is fully recursive, and
12485 may contain any number of @code{vertical} and @code{horizontal} splits.
12487 @vindex gnus-window-min-width
12488 @vindex gnus-window-min-height
12489 @cindex window height
12490 @cindex window width
12491 Finding the right sizes can be a bit complicated. No window may be less
12492 than @code{gnus-window-min-height} (default 1) characters high, and all
12493 windows must be at least @code{gnus-window-min-width} (default 1)
12494 characters wide. Gnus will try to enforce this before applying the
12495 splits. If you want to use the normal Emacs window width/height limit,
12496 you can just set these two variables to @code{nil}.
12498 If you're not familiar with Emacs terminology, @code{horizontal} and
12499 @code{vertical} splits may work the opposite way of what you'd expect.
12500 Windows inside a @code{horizontal} split are shown side-by-side, and
12501 windows within a @code{vertical} split are shown above each other.
12503 @findex gnus-configure-frame
12504 If you want to experiment with window placement, a good tip is to call
12505 @code{gnus-configure-frame} directly with a split. This is the function
12506 that does all the real work when splitting buffers. Below is a pretty
12507 nonsensical configuration with 5 windows; two for the group buffer and
12508 three for the article buffer. (I said it was nonsensical.) If you
12509 @code{eval} the statement below, you can get an idea of how that would
12510 look straight away, without going through the normal Gnus channels.
12511 Play with it until you're satisfied, and then use
12512 @code{gnus-add-configuration} to add your new creation to the buffer
12513 configuration list.
12516 (gnus-configure-frame
12520 (article 0.3 point))
12528 You might want to have several frames as well. No prob---just use the
12529 @code{frame} split:
12532 (gnus-configure-frame
12535 (summary 0.25 point)
12537 (vertical ((height . 5) (width . 15)
12538 (user-position . t)
12539 (left . -1) (top . 1))
12544 This split will result in the familiar summary/article window
12545 configuration in the first (or ``main'') frame, while a small additional
12546 frame will be created where picons will be shown. As you can see,
12547 instead of the normal @code{1.0} top-level spec, each additional split
12548 should have a frame parameter alist as the size spec.
12549 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
12552 Here's a list of all possible keys for
12553 @code{gnus-buffer-configuration}:
12555 @code{group}, @code{summary}, @code{article}, @code{server},
12556 @code{browse}, @code{message}, @code{pick}, @code{info},
12557 @code{summary-faq}, @code{edit-group}, @code{edit-server},
12558 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
12559 @code{reply-yank}, @code{mail-bounce}, @code{draft},
12560 @code{pipe}, @code{bug}, @code{compose-bounce}.
12562 Note that the @code{message} key is used for both
12563 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
12564 it is desirable to distinguish between the two, something like this
12568 (message (horizontal 1.0
12569 (vertical 1.0 (message 1.0 point))
12571 (if (buffer-live-p gnus-summary-buffer)
12576 @findex gnus-add-configuration
12577 Since the @code{gnus-buffer-configuration} variable is so long and
12578 complicated, there's a function you can use to ease changing the config
12579 of a single setting: @code{gnus-add-configuration}. If, for instance,
12580 you want to change the @code{article} setting, you could say:
12583 (gnus-add-configuration
12584 '(article (vertical 1.0
12586 (summary .25 point)
12590 You'd typically stick these @code{gnus-add-configuration} calls in your
12591 @file{.gnus.el} file or in some startup hook---they should be run after
12592 Gnus has been loaded.
12594 @vindex gnus-always-force-window-configuration
12595 If all windows mentioned in the configuration are already visible, Gnus
12596 won't change the window configuration. If you always want to force the
12597 ``right'' window configuration, you can set
12598 @code{gnus-always-force-window-configuration} to non-@code{nil}.
12602 @section Compilation
12603 @cindex compilation
12604 @cindex byte-compilation
12606 @findex gnus-compile
12608 Remember all those line format specification variables?
12609 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
12610 on. Now, Gnus will of course heed whatever these variables are, but,
12611 unfortunately, changing them will mean a quite significant slow-down.
12612 (The default values of these variables have byte-compiled functions
12613 associated with them, while the user-generated versions do not, of
12616 To help with this, you can run @kbd{M-x gnus-compile} after you've
12617 fiddled around with the variables and feel that you're (kind of)
12618 satisfied. This will result in the new specs being byte-compiled, and
12619 you'll get top speed again. Gnus will save these compiled specs in the
12620 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
12621 this function, though---you should compile them yourself by sticking
12622 them into the @code{.gnus.el} file and byte-compiling that file.)
12626 @section Mode Lines
12629 @vindex gnus-updated-mode-lines
12630 @code{gnus-updated-mode-lines} says what buffers should keep their mode
12631 lines updated. It is a list of symbols. Supported symbols include
12632 @code{group}, @code{article}, @code{summary}, @code{server},
12633 @code{browse}, and @code{tree}. If the corresponding symbol is present,
12634 Gnus will keep that mode line updated with information that may be
12635 pertinent. If this variable is @code{nil}, screen refresh may be
12638 @cindex display-time
12640 @vindex gnus-mode-non-string-length
12641 By default, Gnus displays information on the current article in the mode
12642 lines of the summary and article buffers. The information Gnus wishes
12643 to display (e.g. the subject of the article) is often longer than the
12644 mode lines, and therefore have to be cut off at some point. The
12645 @code{gnus-mode-non-string-length} variable says how long the other
12646 elements on the line is (i.e., the non-info part). If you put
12647 additional elements on the mode line (e.g. a clock), you should modify
12650 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
12652 (add-hook 'display-time-hook
12653 (lambda () (setq gnus-mode-non-string-length
12655 (if line-number-mode 5 0)
12656 (if column-number-mode 4 0)
12657 (length display-time-string)))))
12660 If this variable is @code{nil} (which is the default), the mode line
12661 strings won't be chopped off, and they won't be padded either.
12662 Note that the default is unlikely to be desirable, as even the
12663 percentage complete in the buffer may be crowded off the mode line;
12664 the user should configure this variable appropriately for their
12668 @node Highlighting and Menus
12669 @section Highlighting and Menus
12671 @cindex highlighting
12674 @vindex gnus-visual
12675 The @code{gnus-visual} variable controls most of the prettifying Gnus
12676 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
12677 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
12680 This variable can be a list of visual properties that are enabled. The
12681 following elements are legal, and are all included by default:
12684 @item group-highlight
12685 Do highlights in the group buffer.
12686 @item summary-highlight
12687 Do highlights in the summary buffer.
12688 @item article-highlight
12689 Do highlights in the article buffer.
12691 Turn on highlighting in all buffers.
12693 Create menus in the group buffer.
12695 Create menus in the summary buffers.
12697 Create menus in the article buffer.
12699 Create menus in the browse buffer.
12701 Create menus in the server buffer.
12703 Create menus in the score buffers.
12705 Create menus in all buffers.
12708 So if you only want highlighting in the article buffer and menus in all
12709 buffers, you could say something like:
12712 (setq gnus-visual '(article-highlight menu))
12715 If you want only highlighting and no menus whatsoever, you'd say:
12718 (setq gnus-visual '(highlight))
12721 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
12722 in all Gnus buffers.
12724 Other general variables that influence the look of all buffers include:
12727 @item gnus-mouse-face
12728 @vindex gnus-mouse-face
12729 This is the face (i.e., font) used for mouse highlighting in Gnus. No
12730 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
12734 There are hooks associated with the creation of all the different menus:
12738 @item gnus-article-menu-hook
12739 @vindex gnus-article-menu-hook
12740 Hook called after creating the article mode menu.
12742 @item gnus-group-menu-hook
12743 @vindex gnus-group-menu-hook
12744 Hook called after creating the group mode menu.
12746 @item gnus-summary-menu-hook
12747 @vindex gnus-summary-menu-hook
12748 Hook called after creating the summary mode menu.
12750 @item gnus-server-menu-hook
12751 @vindex gnus-server-menu-hook
12752 Hook called after creating the server mode menu.
12754 @item gnus-browse-menu-hook
12755 @vindex gnus-browse-menu-hook
12756 Hook called after creating the browse mode menu.
12758 @item gnus-score-menu-hook
12759 @vindex gnus-score-menu-hook
12760 Hook called after creating the score mode menu.
12771 Those new-fangled @dfn{mouse} contraptions is very popular with the
12772 young, hep kids who don't want to learn the proper way to do things
12773 these days. Why, I remember way back in the summer of '89, when I was
12774 using Emacs on a Tops 20 system. Three hundred users on one single
12775 machine, and every user was running Simula compilers. Bah!
12779 @vindex gnus-carpal
12780 Well, you can make Gnus display bufferfuls of buttons you can click to
12781 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
12782 really. Tell the chiropractor I sent you.
12787 @item gnus-carpal-mode-hook
12788 @vindex gnus-carpal-mode-hook
12789 Hook run in all carpal mode buffers.
12791 @item gnus-carpal-button-face
12792 @vindex gnus-carpal-button-face
12793 Face used on buttons.
12795 @item gnus-carpal-header-face
12796 @vindex gnus-carpal-header-face
12797 Face used on carpal buffer headers.
12799 @item gnus-carpal-group-buffer-buttons
12800 @vindex gnus-carpal-group-buffer-buttons
12801 Buttons in the group buffer.
12803 @item gnus-carpal-summary-buffer-buttons
12804 @vindex gnus-carpal-summary-buffer-buttons
12805 Buttons in the summary buffer.
12807 @item gnus-carpal-server-buffer-buttons
12808 @vindex gnus-carpal-server-buffer-buttons
12809 Buttons in the server buffer.
12811 @item gnus-carpal-browse-buffer-buttons
12812 @vindex gnus-carpal-browse-buffer-buttons
12813 Buttons in the browse buffer.
12816 All the @code{buttons} variables are lists. The elements in these list
12817 is either a cons cell where the car contains a text to be displayed and
12818 the cdr contains a function symbol, or a simple string.
12826 Gnus, being larger than any program ever written (allegedly), does lots
12827 of strange stuff that you may wish to have done while you're not
12828 present. For instance, you may want it to check for new mail once in a
12829 while. Or you may want it to close down all connections to all servers
12830 when you leave Emacs idle. And stuff like that.
12832 Gnus will let you do stuff like that by defining various
12833 @dfn{handlers}. Each handler consists of three elements: A
12834 @var{function}, a @var{time}, and an @var{idle} parameter.
12836 Here's an example of a handler that closes connections when Emacs has
12837 been idle for thirty minutes:
12840 (gnus-demon-close-connections nil 30)
12843 Here's a handler that scans for PGP headers every hour when Emacs is
12847 (gnus-demon-scan-pgp 60 t)
12850 This @var{time} parameter and than @var{idle} parameter works together
12851 in a strange, but wonderful fashion. Basically, if @var{idle} is
12852 @code{nil}, then the function will be called every @var{time} minutes.
12854 If @var{idle} is @code{t}, then the function will be called after
12855 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
12856 the function will never be called. But once Emacs goes idle, the
12857 function will be called every @var{time} minutes.
12859 If @var{idle} is a number and @var{time} is a number, the function will
12860 be called every @var{time} minutes only when Emacs has been idle for
12861 @var{idle} minutes.
12863 If @var{idle} is a number and @var{time} is @code{nil}, the function
12864 will be called once every time Emacs has been idle for @var{idle}
12867 And if @var{time} is a string, it should look like @samp{07:31}, and
12868 the function will then be called once every day somewhere near that
12869 time. Modified by the @var{idle} parameter, of course.
12871 @vindex gnus-demon-timestep
12872 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
12873 seconds. This is 60 by default. If you change that variable,
12874 all the timings in the handlers will be affected.)
12876 @vindex gnus-use-demon
12877 To set the whole thing in motion, though, you have to set
12878 @code{gnus-use-demon} to @code{t}.
12880 So, if you want to add a handler, you could put something like this in
12881 your @file{.gnus} file:
12883 @findex gnus-demon-add-handler
12885 (gnus-demon-add-handler 'gnus-demon-close-connections nil 30)
12888 @findex gnus-demon-add-nocem
12889 @findex gnus-demon-add-scanmail
12890 @findex gnus-demon-add-rescan
12891 @findex gnus-demon-add-disconnection
12892 Some ready-made functions to do this has been created:
12893 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
12894 @code{gnus-demon-add-rescan}, and @code{gnus-demon-add-scanmail}. Just
12895 put those functions in your @file{.gnus} if you want those abilities.
12897 @findex gnus-demon-init
12898 @findex gnus-demon-cancel
12899 @vindex gnus-demon-handlers
12900 If you add handlers to @code{gnus-demon-handlers} directly, you should
12901 run @code{gnus-demon-init} to make the changes take hold. To cancel all
12902 daemons, you can use the @code{gnus-demon-cancel} function.
12904 Note that adding daemons can be pretty naughty if you overdo it. Adding
12905 functions that scan all news and mail from all servers every two seconds
12906 is a sure-fire way of getting booted off any respectable system. So
12915 @dfn{Spamming} is posting the same article lots and lots of times.
12916 Spamming is bad. Spamming is evil.
12918 Spamming is usually canceled within a day or so by various anti-spamming
12919 agencies. These agencies usually also send out @dfn{NoCeM} messages.
12920 NoCeM is pronounced ``no see-'em'', and means what the name
12921 implies---these are messages that make the offending articles, like, go
12924 What use are these NoCeM messages if the articles are canceled anyway?
12925 Some sites do not honor cancel messages and some sites just honor cancels
12926 from a select few people. Then you may wish to make use of the NoCeM
12927 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
12929 Gnus can read and parse the messages in this group automatically, and
12930 this will make spam disappear.
12932 There are some variables to customize, of course:
12935 @item gnus-use-nocem
12936 @vindex gnus-use-nocem
12937 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
12940 @item gnus-nocem-groups
12941 @vindex gnus-nocem-groups
12942 Gnus will look for NoCeM messages in the groups in this list. The
12943 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
12944 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
12946 @item gnus-nocem-issuers
12947 @vindex gnus-nocem-issuers
12948 There are many people issuing NoCeM messages. This list says what
12949 people you want to listen to. The default is @code{("Automoose-1"
12950 "clewis@@ferret.ocunix.on.ca;" "jem@@xpat.com;" "red@@redpoll.mrfs.oh.us
12951 (Richard E. Depew)")}; fine, upstanding citizens all of them.
12953 Known despammers that you can put in this list include:
12956 @item clewis@@ferret.ocunix.on.ca;
12957 @cindex Chris Lewis
12958 Chris Lewis---Major Canadian despammer who has probably canceled more
12959 usenet abuse than anybody else.
12962 @cindex CancelMoose[tm]
12963 The CancelMoose[tm] on autopilot. The CancelMoose[tm] is reputed to be
12964 Norwegian, and was the person(s) who invented NoCeM.
12966 @item jem@@xpat.com;
12968 John Milburn---despammer located in Korea who is getting very busy these
12971 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
12972 Richard E. Depew---lone American despammer. He mostly cancels binary
12973 postings to non-binary groups and removes spews (regurgitated articles).
12976 You do not have to heed NoCeM messages from all these people---just the
12977 ones you want to listen to.
12979 @item gnus-nocem-verifyer
12980 @vindex gnus-nocem-verifyer
12982 This should be a function for verifying that the NoCeM issuer is who she
12983 says she is. The default is @code{mc-verify}, which is a Mailcrypt
12984 function. If this is too slow and you don't care for verification
12985 (which may be dangerous), you can set this variable to @code{nil}.
12987 @item gnus-nocem-directory
12988 @vindex gnus-nocem-directory
12989 This is where Gnus will store its NoCeM cache files. The default is
12990 @file{~/News/NoCeM/}.
12992 @item gnus-nocem-expiry-wait
12993 @vindex gnus-nocem-expiry-wait
12994 The number of days before removing old NoCeM entries from the cache.
12995 The default is 15. If you make it shorter Gnus will be faster, but you
12996 might then see old spam.
13004 So... You want to slow down your news reader even more! This is a
13005 good way to do so. Its also a great way to impress people staring
13006 over your shoulder as you read news.
13009 * Picon Basics:: What are picons and How do I get them.
13010 * Picon Requirements:: Don't go further if you aren't using XEmacs.
13011 * Easy Picons:: Displaying Picons---the easy way.
13012 * Hard Picons:: The way you should do it. You'll learn something.
13013 * Picon Configuration:: Other variables you can trash/tweak/munge/play with.
13018 @subsection Picon Basics
13020 What are Picons? To quote directly from the Picons Web site:
13023 @dfn{Picons} is short for ``personal icons''. They're small,
13024 constrained images used to represent users and domains on the net,
13025 organized into databases so that the appropriate image for a given
13026 e-mail address can be found. Besides users and domains, there are picon
13027 databases for Usenet newsgroups and weather forecasts. The picons are
13028 in either monochrome @code{XBM} format or color @code{XPM} and
13029 @code{GIF} formats.
13032 For instructions on obtaining and installing the picons databases, point
13033 your Web browser at
13034 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.
13036 @vindex gnus-picons-database
13037 Gnus expects picons to be installed into a location pointed to by
13038 @code{gnus-picons-database}.
13041 @node Picon Requirements
13042 @subsection Picon Requirements
13044 To use have Gnus display Picons for you, you must be running XEmacs
13045 19.13 or greater since all other versions of Emacs aren't yet able to
13048 Additionally, you must have @code{xpm} support compiled into XEmacs.
13050 @vindex gnus-picons-convert-x-face
13051 If you want to display faces from @code{X-Face} headers, you must have
13052 the @code{netpbm} utilities installed, or munge the
13053 @code{gnus-picons-convert-x-face} variable to use something else.
13057 @subsection Easy Picons
13059 To enable displaying picons, simply put the following line in your
13060 @file{~/.gnus} file and start Gnus.
13063 (setq gnus-use-picons t)
13064 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13065 (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
13066 (add-hook 'gnus-article-display-hook 'gnus-picons-article-display-x-face)
13071 @subsection Hard Picons
13073 Gnus can display picons for you as you enter and leave groups and
13074 articles. It knows how to interact with three sections of the picons
13075 database. Namely, it can display the picons newsgroup pictures,
13076 author's face picture(s), and the authors domain. To enable this
13077 feature, you need to first decide where to display them.
13081 @item gnus-picons-display-where
13082 @vindex gnus-picons-display-where
13083 Where the picon images should be displayed. It is @code{picons} by
13084 default (which by default maps to the buffer @samp{*Picons*}). Other
13085 valid places could be @code{article}, @code{summary}, or
13086 @samp{*scratch*} for all I care. Just make sure that you've made the
13087 buffer visible using the standard Gnus window configuration
13088 routines---@pxref{Windows Configuration}.
13092 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
13093 window configuration for you to include the @code{picons} buffer.
13095 Now that you've made that decision, you need to add the following
13096 functions to the appropriate hooks so these pictures will get
13097 displayed at the right time.
13099 @vindex gnus-article-display-hook
13100 @vindex gnus-picons-display-where
13102 @item gnus-article-display-picons
13103 @findex gnus-article-display-picons
13104 Looks up and display the picons for the author and the author's domain
13105 in the @code{gnus-picons-display-where} buffer. Should be added to
13106 the @code{gnus-article-display-hook}.
13108 @item gnus-group-display-picons
13109 @findex gnus-article-display-picons
13110 Displays picons representing the current group. This function should
13111 be added to the @code{gnus-summary-prepare-hook} or to the
13112 @code{gnus-article-display-hook} if @code{gnus-picons-display-where}
13113 is set to @code{article}.
13115 @item gnus-picons-article-display-x-face
13116 @findex gnus-article-display-picons
13117 Decodes and displays the X-Face header if present. This function
13118 should be added to @code{gnus-article-display-hook}.
13122 Note: You must append them to the hook, so make sure to specify 't'
13123 to the append flag of @code{add-hook}:
13126 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13130 @node Picon Configuration
13131 @subsection Picon Configuration
13133 The following variables offer further control over how things are
13134 done, where things are located, and other useless stuff you really
13135 don't need to worry about.
13138 @item gnus-picons-database
13139 @vindex gnus-picons-database
13140 The location of the picons database. Should point to a directory
13141 containing the @file{news}, @file{domains}, @file{users} (and so on)
13142 subdirectories. Defaults to @file{/usr/local/faces}.
13144 @item gnus-picons-news-directory
13145 @vindex gnus-picons-news-directory
13146 Sub-directory of the faces database containing the icons for
13149 @item gnus-picons-user-directories
13150 @vindex gnus-picons-user-directories
13151 List of subdirectories to search in @code{gnus-picons-database} for user
13152 faces. @code{("local" "users" "usenix" "misc/MISC")} is the default.
13154 @item gnus-picons-domain-directories
13155 @vindex gnus-picons-domain-directories
13156 List of subdirectories to search in @code{gnus-picons-database} for
13157 domain name faces. Defaults to @code{("domains")}. Some people may
13158 want to add @samp{unknown} to this list.
13160 @item gnus-picons-convert-x-face
13161 @vindex gnus-picons-convert-x-face
13162 The command to use to convert the @code{X-Face} header to an X bitmap
13163 (@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48,
13164 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
13165 gnus-picons-x-face-file-name)}
13167 @item gnus-picons-x-face-file-name
13168 @vindex gnus-picons-x-face-file-name
13169 Names a temporary file to store the @code{X-Face} bitmap in. Defaults
13170 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
13172 @item gnus-picons-buffer
13173 @vindex gnus-picons-buffer
13174 The name of the buffer that @code{picons} points to. Defaults to
13175 @samp{*Icon Buffer*}.
13184 It is very useful to be able to undo actions one has done. In normal
13185 Emacs buffers, it's easy enough---you just push the @code{undo} button.
13186 In Gnus buffers, however, it isn't that simple.
13188 The things Gnus displays in its buffer is of no value whatsoever to
13189 Gnus---it's all just data that is designed to look nice to the user.
13190 Killing a group in the group buffer with @kbd{C-k} makes the line
13191 disappear, but that's just a side-effect of the real action---the
13192 removal of the group in question from the internal Gnus structures.
13193 Undoing something like that can't be done by the normal Emacs
13194 @code{undo} function.
13196 Gnus tries to remedy this somewhat by keeping track of what the user
13197 does and coming up with actions that would reverse the actions the user
13198 takes. When the user then presses the @code{undo} key, Gnus will run
13199 the code to reverse the previous action, or the previous actions.
13200 However, not all actions are easily reversible, so Gnus currently offers
13201 a few key functions to be undoable. These include killing groups,
13202 yanking groups, and changing the list of read articles of groups.
13203 That's it, really. More functions may be added in the future, but each
13204 added function means an increase in data to be stored, so Gnus will
13205 never be totally undoable.
13207 @findex gnus-undo-mode
13208 @vindex gnus-use-undo
13210 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
13211 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
13212 default. The @kbd{M-C-_} key performs the @code{gnus-undo} command
13213 command, which should feel kinda like the normal Emacs @code{undo}
13218 @section Moderation
13221 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
13222 It is not included in the standard Gnus package. Write a mail to
13223 @samp{larsi@@ifi.uio.no} and state what group you moderate, and you'll
13226 The moderation package is implemented as a minor mode for summary
13230 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
13233 in your @file{.gnus.el} file.
13235 If you are the moderation of @samp{rec.zoofle}, this is how it's
13240 You split your incoming mail by matching on
13241 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
13242 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
13245 You enter that group once in a while and post articles using the @kbd{e}
13246 (edit-and-post) or @kbd{s} (just send unedited) commands.
13249 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
13250 articles that weren't approved by you, you can cancel them with the
13254 To use moderation mode in these two groups, say:
13257 (setq gnus-moderated-list
13258 "^nnml:rec.zoofle$\\|^rec.zoofle$")
13262 @node XEmacs Enhancements
13263 @section XEmacs Enhancements
13266 XEmacs is able to display pictures and stuff, so Gnus has taken
13267 advantage of that. Relevant variables include:
13270 @item gnus-xmas-glyph-directory
13271 @vindex gnus-xmas-glyph-directory
13272 This is where Gnus will look for pictures. Gnus will normally
13273 auto-detect this directory, but you may set it manually if you have an
13274 unusual directory structure.
13276 @item gnus-xmas-logo-color-alist
13277 @vindex gnus-xmas-logo-color-alist
13278 This is an alist where the key is a type symbol and the values are the
13279 foreground and background color of the splash page glyph.
13281 @item gnus-xmas-logo-color-style
13282 @vindex gnus-xmas-logo-color-style
13283 This is the key used to look up the color in the alist described above.
13284 Legal values include @code{flame}, @code{pine}, @code{moss},
13285 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
13286 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
13288 @item gnus-use-toolbar
13289 @vindex gnus-use-toolbar
13290 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
13291 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
13292 @code{right-toolbar}, or @code{left-toolbar}.
13294 @item gnus-group-toolbar
13295 @vindex gnus-group-toolbar
13296 The toolbar in the group buffer.
13298 @item gnus-summary-toolbar
13299 @vindex gnus-summary-toolbar
13300 The toolbar in the summary buffer.
13302 @item gnus-summary-mail-toolbar
13303 @vindex gnus-summary-mail-toolbar
13304 The toolbar in the summary buffer of mail groups.
13306 @item gnus-xmas-modeline-glyph
13307 @vindex gnus-xmas-modeline-glyph
13308 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
13314 @node Various Various
13315 @section Various Various
13321 @item gnus-directory
13322 @vindex gnus-directory
13323 All Gnus directories will be initialized from this variable, which
13324 defaults to the @samp{SAVEDIR} environment variable, or @file{~/News/}
13325 if that variable isn't set.
13327 @item gnus-default-directory
13328 @vindex gnus-default-directory
13329 Not related to the above variable at all---this variable says what the
13330 default directory of all Gnus buffers should be. If you issue commands
13331 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
13332 default directory. If this variable is @code{nil} (which is the
13333 default), the default directory will be the default directory of the
13334 buffer you were in when you started Gnus.
13337 @vindex gnus-verbose
13338 This variable is an integer between zero and ten. The higher the value,
13339 the more messages will be displayed. If this variable is zero, Gnus
13340 will never flash any messages, if it is seven (which is the default),
13341 most important messages will be shown, and if it is ten, Gnus won't ever
13342 shut up, but will flash so many messages it will make your head swim.
13344 @item gnus-verbose-backends
13345 @vindex gnus-verbose-backends
13346 This variable works the same way as @code{gnus-verbose}, but it applies
13347 to the Gnus backends instead of Gnus proper.
13349 @item nnheader-max-head-length
13350 @vindex nnheader-max-head-length
13351 When the backends read straight heads of articles, they all try to read
13352 as little as possible. This variable (default 4096) specifies
13353 the absolute max length the backends will try to read before giving up
13354 on finding a separator line between the head and the body. If this
13355 variable is @code{nil}, there is no upper read bound. If it is
13356 @code{t}, the backends won't try to read the articles piece by piece,
13357 but read the entire articles. This makes sense with some versions of
13360 @item nnheader-head-chop-length
13361 @vindex nnheader-head-chop-length
13362 This variable says how big a piece of each article to read when doing
13363 the operation described above.
13365 @item nnheader-file-name-translation-alist
13366 @vindex nnheader-file-name-translation-alist
13368 @cindex illegal characters in file names
13369 @cindex characters in file names
13370 This is an alist that says how to translate characters in file names.
13371 For instance, if @samp{:} is illegal as a file character in file names
13372 on your system (you OS/2 user you), you could say something like:
13375 (setq nnheader-file-name-translation-alist
13379 In fact, this is the default value for this variable on OS/2 and MS
13380 Windows (phooey) systems.
13382 @item gnus-hidden-properties
13383 @vindex gnus-hidden-properties
13384 This is a list of properties to use to hide ``invisible'' text. It is
13385 @code{(invisible t intangible t)} by default on most systems, which
13386 makes invisible text invisible and intangible.
13388 @item gnus-parse-headers-hook
13389 @vindex gnus-parse-headers-hook
13390 A hook called before parsing headers. It can be used, for instance, to
13391 gather statistics on the headers fetched, or perhaps you'd like to prune
13392 some headers. I don't see why you'd want that, though.
13394 @item gnus-shell-command-separator
13395 @vindex gnus-shell-command-separator
13396 String used to separate to shell commands. The default is @samp{;}.
13405 Well, that's the manual---you can get on with your life now. Keep in
13406 touch. Say hello to your cats from me.
13408 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
13410 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
13416 Not because of victories @*
13419 but for the common sunshine,@*
13421 the largess of the spring.
13425 but for the day's work done@*
13426 as well as I was able;@*
13427 not for a seat upon the dais@*
13428 but at the common table.@*
13433 @chapter Appendices
13436 * History:: How Gnus got where it is today.
13437 * Terminology:: We use really difficult, like, words here.
13438 * Customization:: Tailoring Gnus to your needs.
13439 * Troubleshooting:: What you might try if things do not work.
13440 * A Programmers Guide to Gnus:: Rilly, rilly technical stuff.
13441 * Emacs for Heathens:: A short introduction to Emacsian terms.
13442 * Frequently Asked Questions:: A question-and-answer session.
13450 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
13451 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
13453 If you want to investigate the person responsible for this outrage, you
13454 can point your (feh!) web browser to
13455 @file{http://www.ifi.uio.no/~larsi/}. This is also the primary
13456 distribution point for the new and spiffy versions of Gnus, and is known
13457 as The Site That Destroys Newsrcs And Drives People Mad.
13459 During the first extended alpha period of development, the new Gnus was
13460 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
13461 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
13462 (Besides, the ``Gnus'' in this abbreviation should probably be
13463 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
13464 appropriate name, don't you think?)
13466 In any case, after spending all that energy on coming up with a new and
13467 spunky name, we decided that the name was @emph{too} spunky, so we
13468 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
13469 ``@sc{gnus}''. New vs. old.
13471 The first ``proper'' release of Gnus 5 was done in November 1995 when it
13472 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
13473 plus 15 Gnus 5.0 releases).
13475 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
13476 releases)) was released under the name ``Gnus 5.2'' (40 releases).
13478 On July 28th 1996 work on Red Gnus was begun, and it was released on
13479 January 25th 1997 (after 84 releases) as ``Gnus 5.4''.
13481 If you happen upon a version of Gnus that has a name that is prefixed --
13482 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
13483 don't panic. Don't let it know that you're frightened. Back away.
13484 Slowly. Whatever you do, don't run. Walk away, calmly, until you're
13485 out of its reach. Find a proper released version of Gnus and snuggle up
13489 * Why?:: What's the point of Gnus?
13490 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
13491 * Conformity:: Gnus tries to conform to all standards.
13492 * Emacsen:: Gnus can be run on a few modern Emacsen.
13493 * Contributors:: Oodles of people.
13494 * New Features:: Pointers to some of the new stuff in Gnus.
13495 * Newest Features:: Features so new that they haven't been written yet.
13502 What's the point of Gnus?
13504 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
13505 newsreader, that lets you do anything you can think of. That was my
13506 original motivation, but while working on Gnus, it has become clear to
13507 me that this generation of newsreaders really belong in the stone age.
13508 Newsreaders haven't developed much since the infancy of the net. If the
13509 volume continues to rise with the current rate of increase, all current
13510 newsreaders will be pretty much useless. How do you deal with
13511 newsgroups that have thousands of new articles each day? How do you
13512 keep track of millions of people who post?
13514 Gnus offers no real solutions to these questions, but I would very much
13515 like to see Gnus being used as a testing ground for new methods of
13516 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
13517 to separate the newsreader from the backends, Gnus now offers a simple
13518 interface for anybody who wants to write new backends for fetching mail
13519 and news from different sources. I have added hooks for customizations
13520 everywhere I could imagine useful. By doing so, I'm inviting every one
13521 of you to explore and invent.
13523 May Gnus never be complete. @kbd{C-u 100 M-x hail-emacs}.
13526 @node Compatibility
13527 @subsection Compatibility
13529 @cindex compatibility
13530 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
13531 bindings have been kept. More key bindings have been added, of course,
13532 but only in one or two obscure cases have old bindings been changed.
13537 @center In a cloud bones of steel.
13541 All commands have kept their names. Some internal functions have changed
13544 The @code{gnus-uu} package has changed drastically. @pxref{Decoding
13547 One major compatibility question is the presence of several summary
13548 buffers. All variables that are relevant while reading a group are
13549 buffer-local to the summary buffer they belong in. Although many
13550 important variables have their values copied into their global
13551 counterparts whenever a command is executed in the summary buffer, this
13552 change might lead to incorrect values being used unless you are careful.
13554 All code that relies on knowledge of @sc{gnus} internals will probably
13555 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
13556 changing it in any way, as a matter of fact) is strictly verboten. Gnus
13557 maintains a hash table that points to the entries in this alist (which
13558 speeds up many functions), and changing the alist directly will lead to
13562 @cindex highlighting
13563 Old hilit19 code does not work at all. In fact, you should probably
13564 remove all hilit code from all Gnus hooks
13565 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
13566 Gnus provides various integrated functions for highlighting. These are
13567 faster and more accurate. To make life easier for everybody, Gnus will
13568 by default remove all hilit calls from all hilit hooks. Uncleanliness!
13571 Packages like @code{expire-kill} will no longer work. As a matter of
13572 fact, you should probably remove all old @sc{gnus} packages (and other
13573 code) when you start using Gnus. More likely than not, Gnus already
13574 does what you have written code to make @sc{gnus} do. (Snicker.)
13576 Even though old methods of doing things are still supported, only the
13577 new methods are documented in this manual. If you detect a new method of
13578 doing something while reading this manual, that does not mean you have
13579 to stop doing it the old way.
13581 Gnus understands all @sc{gnus} startup files.
13583 @kindex M-x gnus-bug
13585 @cindex reporting bugs
13587 Overall, a casual user who hasn't written much code that depends on
13588 @sc{gnus} internals should suffer no problems. If problems occur,
13589 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
13593 @subsection Conformity
13595 No rebels without a clue here, ma'am. We conform to all standards known
13596 to (wo)man. Except for those standards and/or conventions we disagree
13603 There are no known breaches of this standard.
13607 There are no known breaches of this standard, either.
13609 @item Good Net-Keeping Seal of Approval
13610 @cindex Good Net-Keeping Seal of Approval
13611 Gnus has been through the Seal process and failed. I think it'll pass
13612 the next inspection.
13614 @item Son-of-RFC 1036
13615 @cindex Son-of-RFC 1036
13616 We do have some breaches to this one.
13621 Gnus does no MIME handling, and this standard-to-be seems to think that
13622 MIME is the bees' knees, so we have major breakage here.
13625 This is considered to be a ``vanity header'', while I consider it to be
13626 consumer information. After seeing so many badly formatted articles
13627 coming from @code{tin} and @code{Netscape} I know not to use either of
13628 those for posting articles. I would not have known that if it wasn't
13629 for the @code{X-Newsreader} header.
13634 If you ever notice Gnus acting non-compliantly with regards to the texts
13635 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
13640 @subsection Emacsen
13646 Gnus should work on :
13651 Emacs 19.32 and up.
13654 XEmacs 19.14 and up.
13657 Mule versions based on Emacs 19.32 and up.
13661 Gnus will absolutely not work on any Emacsen older than that. Not
13662 reliably, at least.
13664 There are some vague differences between Gnus on the various
13665 platforms---XEmacs features more graphics (a logo and a toolbar)---but
13666 other than that, things should look pretty much the same under all
13671 @subsection Contributors
13672 @cindex contributors
13674 The new Gnus version couldn't have been done without the help of all the
13675 people on the (ding) mailing list. Every day for over a year I have
13676 gotten billions of nice bug reports from them, filling me with joy,
13677 every single one of them. Smooches. The people on the list have been
13678 tried beyond endurance, what with my ``oh, that's a neat idea <type
13679 type>, yup, I'll release it right away <ship off> no wait, that doesn't
13680 work at all <type type>, yup, I'll ship that one off right away <ship
13681 off> no, wait, that absolutely does not work'' policy for releases.
13682 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
13683 ``worser''? ``much worser''? ``worsest''?)
13685 I would like to take this opportunity to thank the Academy for... oops,
13691 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
13694 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
13695 well as numerous other things).
13698 Luis Fernandes---design and graphics.
13701 Erik Naggum---help, ideas, support, code and stuff.
13704 Wes Hardaker---@file{gnus-picon.el} and the manual section on
13705 @dfn{picons} (@pxref{Picons}).
13708 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
13709 (@pxref{GroupLens}).
13712 Sudish Joseph---innumerable bug fixes.
13715 Ilja Weis---@file{gnus-topic.el}.
13718 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
13721 Vladimir Alexiev---the refcard and reference booklets.
13724 Felix Lee & Jamie Zawinsky---I stole some pieces from the XGnus
13725 distribution by Felix Lee and JWZ.
13728 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
13731 Peter Mutsaers---orphan article scoring code.
13734 Ken Raeburn---POP mail support.
13737 Hallvard B Furuseth---various bits and pieces, especially dealing with
13741 Brian Edmonds---@file{gnus-bbdb.el}.
13744 David Moore---rewrite of @file{nnvirtual.el} and many other things.
13747 Ricardo Nassif, Mark Borges, and Jost Krieger---proof-reading.
13750 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
13753 François Pinard---many, many interesting and thorough bug reports.
13757 The following people have contributed many patches and suggestions:
13766 Jason L. Tibbitts, III,
13770 Also thanks to the following for patches and stuff:
13782 Massimo Campostrini,
13786 Geoffrey T. Dairiki,
13800 Hisashige Kenji, @c Hisashige
13802 François Felix Ingrand,
13803 Ishikawa Ichiro, @c Ishikawa
13809 Peter Skov Knudsen,
13810 Shuhei Kobayashi, @c Kobayashi
13811 Thor Kristoffersen,
13823 Morioka Tomohiko, @c Morioka
13824 Erik Toubro Nielsen,
13830 Masaharu Onishi, @c Onishi
13835 John McClary Prevost,
13842 Randal L. Schwartz,
13860 Katsumi Yamaoka. @c Yamaoka
13862 For a full overview of what each person has done, the ChangeLogs
13863 included in the Gnus alpha distributions should give ample reading
13864 (550kB and counting).
13866 Apologies to everybody that I've forgotten, of which there are many, I'm
13869 Gee, that's quite a list of people. I guess that must mean that there
13870 actually are people who are using Gnus. Who'd'a thunk it!
13874 @subsection New Features
13875 @cindex new features
13878 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
13879 * September Gnus:: The Thing Formally Known As Gnus 5.3/5.3.
13880 * Red Gnus:: Third time best---Gnus 5.4/5.5.
13883 These lists are, of course, just @emph{short} overviews of the
13884 @emph{most} important new features. No, really. There are tons more.
13885 Yes, we have feeping creaturism in full effect.
13889 @subsubsection (ding) Gnus
13891 New features in Gnus 5.0/5.1:
13896 The look of all buffers can be changed by setting format-like variables
13897 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
13900 Local spool and several @sc{nntp} servers can be used at once
13901 (@pxref{Select Methods}).
13904 You can combine groups into virtual groups (@pxref{Virtual Groups}).
13907 You can read a number of different mail formats (@pxref{Getting Mail}).
13908 All the mail backends implement a convenient mail expiry scheme
13909 (@pxref{Expiring Mail}).
13912 Gnus can use various strategies for gathering threads that have lost
13913 their roots (thereby gathering loose sub-threads into one thread) or it
13914 can go back and retrieve enough headers to build a complete thread
13915 (@pxref{Customizing Threading}).
13918 Killed groups can be displayed in the group buffer, and you can read
13919 them as well (@pxref{Listing Groups}).
13922 Gnus can do partial group updates---you do not have to retrieve the
13923 entire active file just to check for new articles in a few groups
13924 (@pxref{The Active File}).
13927 Gnus implements a sliding scale of subscribedness to groups
13928 (@pxref{Group Levels}).
13931 You can score articles according to any number of criteria
13932 (@pxref{Scoring}). You can even get Gnus to find out how to score
13933 articles for you (@pxref{Adaptive Scoring}).
13936 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
13937 manner, so it should be difficult to lose much data on what you have
13938 read if your machine should go down (@pxref{Auto Save}).
13941 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
13942 the @file{.emacs} file.
13945 You can set the process mark on both groups and articles and perform
13946 operations on all the marked items (@pxref{Process/Prefix}).
13949 You can grep through a subset of groups and create a group from the
13950 results (@pxref{Kibozed Groups}).
13953 You can list subsets of groups according to, well, anything
13954 (@pxref{Listing Groups}).
13957 You can browse foreign servers and subscribe to groups from those
13958 servers (@pxref{Browse Foreign Server}).
13961 Gnus can fetch articles asynchronously on a second connection to the
13962 server (@pxref{Asynchronous Fetching}).
13965 You can cache articles locally (@pxref{Article Caching}).
13968 The uudecode functions have been expanded and generalized
13969 (@pxref{Decoding Articles}).
13972 You can still post uuencoded articles, which was a little-known feature
13973 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
13976 Fetching parents (and other articles) now actually works without
13977 glitches (@pxref{Finding the Parent}).
13980 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
13983 Digests (and other files) can be used as the basis for groups
13984 (@pxref{Document Groups}).
13987 Articles can be highlighted and customized (@pxref{Customizing
13991 URLs and other external references can be buttonized (@pxref{Article
13995 You can do lots of strange stuff with the Gnus window & frame
13996 configuration (@pxref{Windows Configuration}).
13999 You can click on buttons instead of using the keyboard
14005 @node September Gnus
14006 @subsubsection September Gnus
14008 New features in Gnus 5.2/5.3:
14013 A new message composition mode is used. All old customization variables
14014 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
14018 Gnus is now able to generate @dfn{sparse} threads---threads where
14019 missing articles are represented by empty nodes (@pxref{Customizing
14023 (setq gnus-build-sparse-threads 'some)
14027 Outgoing articles are stored on a special archive server
14028 (@pxref{Archived Messages}).
14031 Partial thread regeneration now happens when articles are
14035 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
14038 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
14041 A @code{trn}-line tree buffer can be displayed (@pxref{Tree Display}).
14044 (setq gnus-use-trees t)
14048 An @code{nn}-like pick-and-read minor mode is available for the summary
14049 buffers (@pxref{Pick and Read}).
14052 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
14056 In binary groups you can use a special binary minor mode (@pxref{Binary
14060 Groups can be grouped in a folding topic hierarchy (@pxref{Group
14064 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
14068 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
14071 Groups can now have a score, and bubbling based on entry frequency
14072 is possible (@pxref{Group Score}).
14075 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
14079 Groups can be process-marked, and commands can be performed on
14080 groups of groups (@pxref{Marking Groups}).
14083 Caching is possible in virtual groups.
14086 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
14087 news batches, ClariNet briefs collections, and just about everything
14088 else (@pxref{Document Groups}).
14091 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
14095 The Gnus cache is much faster.
14098 Groups can be sorted according to many criteria (@pxref{Sorting
14102 New group parameters have been introduced to set list-address and
14103 expiry times (@pxref{Group Parameters}).
14106 All formatting specs allow specifying faces to be used
14107 (@pxref{Formatting Fonts}).
14110 There are several more commands for setting/removing/acting on process
14111 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
14114 The summary buffer can be limited to show parts of the available
14115 articles based on a wide range of criteria. These commands have been
14116 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
14119 Articles can be made persistent with the @kbd{*} command
14120 (@pxref{Persistent Articles}).
14123 All functions for hiding article elements are now toggles.
14126 Article headers can be buttonized (@pxref{Article Washing}).
14129 (add-hook 'gnus-article-display-hook
14130 'gnus-article-add-buttons-to-head)
14134 All mail backends support fetching articles by @code{Message-ID}.
14137 Duplicate mail can now be treated properly (@pxref{Duplicates}).
14140 All summary mode commands are available directly from the article
14141 buffer (@pxref{Article Keymap}).
14144 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
14148 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
14151 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
14154 (setq gnus-use-nocem t)
14158 Groups can be made permanently visible (@pxref{Listing Groups}).
14161 (setq gnus-permanently-visible-groups "^nnml:")
14165 Many new hooks have been introduced to make customizing easier.
14168 Gnus respects the @code{Mail-Copies-To} header.
14171 Threads can be gathered by looking at the @code{References} header
14172 (@pxref{Customizing Threading}).
14175 (setq gnus-summary-thread-gathering-function
14176 'gnus-gather-threads-by-references)
14180 Read articles can be stored in a special backlog buffer to avoid
14181 refetching (@pxref{Article Backlog}).
14184 (setq gnus-keep-backlog 50)
14188 A clean copy of the current article is always stored in a separate
14189 buffer to allow easier treatment.
14192 Gnus can suggest where to save articles (@pxref{Saving Articles}).
14195 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
14199 (setq gnus-prompt-before-saving t)
14203 @code{gnus-uu} can view decoded files asynchronously while fetching
14204 articles (@pxref{Other Decode Variables}).
14207 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
14211 Filling in the article buffer now works properly on cited text
14212 (@pxref{Article Washing}).
14215 Hiding cited text adds buttons to toggle hiding, and how much
14216 cited text to hide is now customizable (@pxref{Article Hiding}).
14219 (setq gnus-cited-lines-visible 2)
14223 Boring headers can be hidden (@pxref{Article Hiding}).
14226 (add-hook 'gnus-article-display-hook
14227 'gnus-article-hide-boring-headers t)
14231 Default scoring values can now be set from the menu bar.
14234 Further syntax checking of outgoing articles have been added.
14240 @subsubsection Red Gnus
14242 New features in Gnus 5.4/5.5:
14247 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
14250 Article prefetching functionality has been moved up into
14251 Gnus (@pxref{Asynchronous Fetching}).
14254 Scoring can now be performed with logical operators like @code{and},
14255 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
14259 Article washing status can be displayed in the
14260 article mode line (@pxref{Misc Article}).
14263 @file{gnus.el} has been split into many smaller files.
14266 Suppression of duplicate articles based on Message-ID can be done
14267 (@pxref{Duplicate Suppression}).
14270 (setq gnus-suppress-duplicates t)
14274 New variables for specifying what score and adapt files are to be
14275 considered home score and adapt files (@pxref{Home Score File}).
14278 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
14279 Server Internals}).
14282 Groups can inherit group parameters from parent topics (@pxref{Topic
14286 Article editing has been revamped and is now actually usable.
14289 Signatures can be recognized in more intelligent fashions
14290 (@pxref{Article Signature}).
14293 Summary pick mode has been made to look more @code{nn}-like. Line
14294 numbers are displayed and the @kbd{.} command can be used to pick
14295 articles (@code{Pick and Read}).
14298 Commands for moving the @file{.newsrc.eld} from one server to
14299 another have been added (@pxref{Changing Servers}).
14302 A way to specify that ``uninteresting'' fields be suppressed when
14303 generating lines in buffers (@pxref{Advanced Formatting}).
14306 Several commands in the group buffer can be undone with @kbd{M-C-_}
14310 Scoring can be done on words using the new score type @code{w}
14311 (@pxref{Score File Format}).
14314 Adaptive scoring can be done on a Subject word-by-word basis
14315 (@pxref{Adaptive Scoring}).
14318 (setq gnus-use-adaptive-scoring '(word))
14322 Scores can be decayed (@pxref{Score Decays}).
14325 (setq gnus-decay-scores t)
14329 Scoring can be performed using a regexp on the Date header. The Date is
14330 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
14333 A new command has been added to remove all data on articles from
14334 the native server (@pxref{Changing Servers}).
14337 A new command for reading collections of documents
14338 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
14339 (@pxref{Really Various Summary Commands}).
14342 Process mark sets can be pushed and popped (@pxref{Setting Process
14346 A new mail-to-news backend makes it possible to post even when the NNTP
14347 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
14350 A new backend for reading searches from Web search engines
14351 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
14352 (@pxref{Web Searches}).
14355 Groups inside topics can now be sorted using the standard sorting
14356 functions, and each topic can be sorted independently (@pxref{Topic
14360 Subsets of the groups can be sorted independently (@code{Sorting
14364 Cached articles can be pulled into the groups (@pxref{Summary Generation
14368 Score files are now applied in a more reliable order (@pxref{Score
14372 Reports on where mail messages end up can be generated (@pxref{Splitting
14376 More hooks and functions have been added to remove junk from incoming
14377 mail before saving the mail (@pxref{Washing Mail}).
14380 Emphasized text can be properly fontisized:
14383 (add-hook 'gnus-article-display-hook 'gnus-article-emphasize)
14389 @node Newest Features
14390 @subsection Newest Features
14393 Also known as the @dfn{todo list}. Sure to be implemented before the
14396 Be afraid. Be very afraid.
14400 Native @sc{mime} support is something that should be done.
14402 Really do unbinhexing.
14405 And much, much, much more. There is more to come than has already been
14406 implemented. (But that's always true, isn't it?)
14408 @file{<URL:http://www.ifi.uio.no/~larsi/rgnus/todo>} is where the actual
14409 up-to-the-second todo list is located, so if you're really curious, you
14410 could point your Web browser over that-a-way.
14415 @section The Manual
14419 This manual was generated from a TeXinfo file and then run through
14420 either @code{texi2dvi}
14422 or my own home-brewed TeXinfo to \LaTeX\ transformer,
14423 and then run through @code{latex} and @code{dvips}
14425 to get what you hold in your hands now.
14427 The following conventions have been used:
14432 This is a @samp{string}
14435 This is a @kbd{keystroke}
14438 This is a @file{file}
14441 This is a @code{symbol}
14445 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
14449 (setq flargnoze "yes")
14452 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
14455 (setq flumphel 'yes)
14458 @samp{yes} and @code{yes} are two @emph{very} different things---don't
14459 ever get them confused.
14463 Of course, everything in this manual is of vital interest, so you should
14464 read it all. Several times. However, if you feel like skimming the
14465 manual, look for that gnu head you should see in the margin over
14466 there---it means that what's being discussed is of more importance than
14467 the rest of the stuff. (On the other hand, if everything is infinitely
14468 important, how can anything be more important than that? Just one more
14469 of the mysteries of this world, I guess.)
14476 @section Terminology
14478 @cindex terminology
14483 This is what you are supposed to use this thing for---reading news.
14484 News is generally fetched from a nearby @sc{nntp} server, and is
14485 generally publicly available to everybody. If you post news, the entire
14486 world is likely to read just what you have written, and they'll all
14487 snigger mischievously. Behind your back.
14491 Everything that's delivered to you personally is mail. Some news/mail
14492 readers (like Gnus) blur the distinction between mail and news, but
14493 there is a difference. Mail is private. News is public. Mailing is
14494 not posting, and replying is not following up.
14498 Send a mail to the person who has written what you are reading.
14502 Post an article to the current newsgroup responding to the article you
14507 Gnus gets fed articles from a number of backends, both news and mail
14508 backends. Gnus does not handle the underlying media, so to speak---this
14509 is all done by the backends.
14513 Gnus will always use one method (and backend) as the @dfn{native}, or
14514 default, way of getting news.
14518 You can also have any number of foreign groups active at the same time.
14519 These are groups that use different backends for getting news.
14523 Secondary backends are somewhere half-way between being native and being
14524 foreign, but they mostly act like they are native.
14528 A message that has been posted as news.
14531 @cindex mail message
14532 A message that has been mailed.
14536 A mail message or news article
14540 The top part of a message, where administrative information (etc.) is
14545 The rest of an article. Everything that is not in the head is in the
14550 A line from the head of an article.
14554 A collection of such lines, or a collection of heads. Or even a
14555 collection of @sc{nov} lines.
14559 When Gnus enters a group, it asks the backend for the headers of all
14560 unread articles in the group. Most servers support the News OverView
14561 format, which is more compact and much faster to read and parse than the
14562 normal @sc{head} format.
14566 Each group is subscribed at some @dfn{level} or other (1-9). The ones
14567 that have a lower level are ``more'' subscribed than the groups with a
14568 higher level. In fact, groups on levels 1-5 are considered
14569 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
14570 are @dfn{killed}. Commands for listing groups and scanning for new
14571 articles will all use the numeric prefix as @dfn{working level}.
14573 @item killed groups
14574 @cindex killed groups
14575 No information on killed groups is stored or updated, which makes killed
14576 groups much easier to handle than subscribed groups.
14578 @item zombie groups
14579 @cindex zombie groups
14580 Just like killed groups, only slightly less dead.
14583 @cindex active file
14584 The news server has to keep track of what articles it carries, and what
14585 groups exist. All this information in stored in the active file, which
14586 is rather large, as you might surmise.
14589 @cindex bogus groups
14590 A group that exists in the @file{.newsrc} file, but isn't known to the
14591 server (i.e., it isn't in the active file), is a @emph{bogus group}.
14592 This means that the group probably doesn't exist (any more).
14596 A machine than one can connect to and get news (or mail) from.
14598 @item select method
14599 @cindex select method
14600 A structure that specifies the backend, the server and the virtual
14603 @item virtual server
14604 @cindex virtual server
14605 A named select method. Since a select methods defines all there is to
14606 know about connecting to a (physical) server, taking the things as a
14607 whole is a virtual server.
14611 Taking a buffer and running it through a filter of some sort. The
14612 result will (more often than not) be cleaner and more pleasing than the
14615 @item ephemeral groups
14616 @cindex ephemeral groups
14617 Most groups store data on what articles you have read. @dfn{Ephemeral}
14618 groups are groups that will have no data stored---when you exit the
14619 group, it'll disappear into the aether.
14622 @cindex solid groups
14623 This is the opposite of ephemeral groups. All groups listed in the
14624 group buffer are solid groups.
14626 @item sparse articles
14627 @cindex sparse articles
14628 These are article placeholders shown in the summary buffer when
14629 @code{gnus-build-sparse-threads} has been switched on.
14634 @node Customization
14635 @section Customization
14636 @cindex general customization
14638 All variables are properly documented elsewhere in this manual. This
14639 section is designed to give general pointers on how to customize Gnus
14640 for some quite common situations.
14643 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
14644 * Slow Terminal Connection:: You run a remote Emacs.
14645 * Little Disk Space:: You feel that having large setup files is icky.
14646 * Slow Machine:: You feel like buying a faster machine.
14650 @node Slow/Expensive Connection
14651 @subsection Slow/Expensive @sc{nntp} Connection
14653 If you run Emacs on a machine locally, and get your news from a machine
14654 over some very thin strings, you want to cut down on the amount of data
14655 Gnus has to get from the @sc{nntp} server.
14659 @item gnus-read-active-file
14660 Set this to @code{nil}, which will inhibit Gnus from requesting the
14661 entire active file from the server. This file is often v. large. You
14662 also have to set @code{gnus-check-new-newsgroups} and
14663 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
14664 doesn't suddenly decide to fetch the active file anyway.
14666 @item gnus-nov-is-evil
14667 This one has to be @code{nil}. If not, grabbing article headers from
14668 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
14669 support @sc{xover}; Gnus will detect this by itself.
14673 @node Slow Terminal Connection
14674 @subsection Slow Terminal Connection
14676 Let's say you use your home computer for dialing up the system that
14677 runs Emacs and Gnus. If your modem is slow, you want to reduce the
14678 amount of data that is sent over the wires as much as possible.
14682 @item gnus-auto-center-summary
14683 Set this to @code{nil} to inhibit Gnus from re-centering the summary
14684 buffer all the time. If it is @code{vertical}, do only vertical
14685 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
14686 horizontal and vertical recentering.
14688 @item gnus-visible-headers
14689 Cut down on the headers that are included in the articles to the
14690 minimum. You can, in fact, make do without them altogether---most of the
14691 useful data is in the summary buffer, anyway. Set this variable to
14692 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
14694 @item gnus-article-display-hook
14695 Set this hook to all the available hiding commands:
14697 (setq gnus-article-display-hook
14698 '(gnus-article-hide-headers gnus-article-hide-signature
14699 gnus-article-hide-citation))
14702 @item gnus-use-full-window
14703 By setting this to @code{nil}, you can make all the windows smaller.
14704 While this doesn't really cut down much generally, it means that you
14705 have to see smaller portions of articles before deciding that you didn't
14706 want to read them anyway.
14708 @item gnus-thread-hide-subtree
14709 If this is non-@code{nil}, all threads in the summary buffer will be
14712 @item gnus-updated-mode-lines
14713 If this is @code{nil}, Gnus will not put information in the buffer mode
14714 lines, which might save some time.
14718 @node Little Disk Space
14719 @subsection Little Disk Space
14722 The startup files can get rather large, so you may want to cut their
14723 sizes a bit if you are running out of space.
14727 @item gnus-save-newsrc-file
14728 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
14729 only save @file{.newsrc.eld}. This means that you will not be able to
14730 use any other newsreaders than Gnus. This variable is @code{t} by
14733 @item gnus-save-killed-list
14734 If this is @code{nil}, Gnus will not save the list of dead groups. You
14735 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
14736 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
14737 variable to @code{nil}. This variable is @code{t} by default.
14743 @subsection Slow Machine
14744 @cindex slow machine
14746 If you have a slow machine, or are just really impatient, there are a
14747 few things you can do to make Gnus run faster.
14749 Set@code{gnus-check-new-newsgroups} and
14750 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
14752 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
14753 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
14754 summary buffer faster.
14756 Set @code{gnus-article-display-hook} to @code{nil} to make article
14757 processing a bit faster.
14760 @node Troubleshooting
14761 @section Troubleshooting
14762 @cindex troubleshooting
14764 Gnus works @emph{so} well straight out of the box---I can't imagine any
14772 Make sure your computer is switched on.
14775 Make sure that you really load the current Gnus version. If you have
14776 been running @sc{gnus}, you need to exit Emacs and start it up again before
14780 Try doing an @kbd{M-x gnus-version}. If you get something that looks
14781 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded. If,
14782 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
14783 flee}, you have some old @file{.el} files lying around. Delete these.
14786 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
14790 @vindex max-lisp-eval-depth
14791 Gnus works on many recursive structures, and in some extreme (and very
14792 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
14793 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
14794 something like that.
14797 If all else fails, report the problem as a bug.
14800 @cindex reporting bugs
14802 @kindex M-x gnus-bug
14804 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
14805 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
14806 me the backtrace. I will fix bugs, but I can only fix them if you send
14807 me a precise description as to how to reproduce the bug.
14809 You really can never be too detailed in a bug report. Always use the
14810 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
14811 a 10Kb mail each time you use it, and even if you have sent me your
14812 environment 500 times before. I don't care. I want the full info each
14815 It is also important to remember that I have no memory whatsoever. If
14816 you send a bug report, and I send you a reply, and then you send back
14817 just ``No, it's not! Moron!'', I will have no idea what you are
14818 insulting me about. Always over-explain everything. It's much easier
14819 for all of us---if I don't have all the information I need, I will just
14820 mail you and ask for more info, and everything takes more time.
14822 If the problem you're seeing is very visual, and you can't quite explain
14823 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
14824 it somewhere it can be reached, and include the URL of the picture in
14827 If you just need help, you are better off asking on
14828 @samp{gnu.emacs.gnus}. I'm not very helpful.
14830 @cindex gnu.emacs.gnus
14831 @cindex ding mailing list
14832 You can also ask on the ding mailing list---@samp{ding@@ifi.uio.no}.
14833 Write to @samp{ding-request@@ifi.uio.no} to subscribe.
14836 @node A Programmers Guide to Gnus
14837 @section A Programmer@'s Guide to Gnus
14839 It is my hope that other people will figure out smart stuff that Gnus
14840 can do, and that other people will write those smart things as well. To
14841 facilitate that I thought it would be a good idea to describe the inner
14842 workings of Gnus. And some of the not-so-inner workings, while I'm at
14845 You can never expect the internals of a program not to change, but I
14846 will be defining (in some details) the interface between Gnus and its
14847 backends (this is written in stone), the format of the score files
14848 (ditto), data structures (some are less likely to change than others)
14849 and general method of operations.
14852 * Backend Interface:: How Gnus communicates with the servers.
14853 * Score File Syntax:: A BNF definition of the score file standard.
14854 * Headers:: How Gnus stores headers internally.
14855 * Ranges:: A handy format for storing mucho numbers.
14856 * Group Info:: The group info format.
14857 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
14858 * Various File Formats:: Formats of files that Gnus use.
14862 @node Backend Interface
14863 @subsection Backend Interface
14865 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
14866 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
14867 server is a @dfn{backend} and some @dfn{backend variables}. As examples
14868 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
14869 examples of the latter we have @code{nntp-port-number} and
14870 @code{nnmbox-directory}.
14872 When Gnus asks for information from a backend---say @code{nntp}---on
14873 something, it will normally include a virtual server name in the
14874 function parameters. (If not, the backend should use the ``current''
14875 virtual server.) For instance, @code{nntp-request-list} takes a virtual
14876 server as its only (optional) parameter. If this virtual server hasn't
14877 been opened, the function should fail.
14879 Note that a virtual server name has no relation to some physical server
14880 name. Take this example:
14884 (nntp-address "ifi.uio.no")
14885 (nntp-port-number 4324))
14888 Here the virtual server name is @samp{odd-one} while the name of
14889 the physical server is @samp{ifi.uio.no}.
14891 The backends should be able to switch between several virtual servers.
14892 The standard backends implement this by keeping an alist of virtual
14893 server environments that it pulls down/pushes up when needed.
14895 There are two groups of interface functions: @dfn{required functions},
14896 which must be present, and @dfn{optional functions}, which Gnus will
14897 always check whether are present before attempting to call.
14899 All these functions are expected to return data in the buffer
14900 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
14901 unfortunately named, but we'll have to live with it. When I talk about
14902 @dfn{resulting data}, I always refer to the data in that buffer. When I
14903 talk about @dfn{return value}, I talk about the function value returned by
14904 the function call. Functions that fail should return @code{nil} as the
14907 Some backends could be said to be @dfn{server-forming} backends, and
14908 some might be said to not be. The latter are backends that generally
14909 only operate on one group at a time, and have no concept of ``server''
14910 -- they have a group, and they deliver info on that group and nothing
14913 In the examples and definitions I will refer to the imaginary backend
14916 @cindex @code{nnchoke}
14919 * Required Backend Functions:: Functions that must be implemented.
14920 * Optional Backend Functions:: Functions that need not be implemented.
14921 * Error Messaging:: How to get messages and report errors.
14922 * Writing New Backends:: Extending old backends.
14923 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
14924 * Mail-like Backends:: Some tips on mail backends.
14928 @node Required Backend Functions
14929 @subsubsection Required Backend Functions
14933 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
14935 @var{articles} is either a range of article numbers or a list of
14936 @code{Message-ID}s. Current backends do not fully support either---only
14937 sequences (lists) of article numbers, and most backends do not support
14938 retrieval of @code{Message-ID}s. But they should try for both.
14940 The result data should either be HEADs or NOV lines, and the result
14941 value should either be @code{headers} or @code{nov} to reflect this.
14942 This might later be expanded to @code{various}, which will be a mixture
14943 of HEADs and NOV lines, but this is currently not supported by Gnus.
14945 If @var{fetch-old} is non-@code{nil} it says to try to fetch "extra
14946 headers, in some meaning of the word. This is generally done by
14947 fetching (at most) @var{fetch-old} extra headers less than the smallest
14948 article number in @code{articles}, and fill in the gaps as well. The
14949 presence of this parameter can be ignored if the backend finds it
14950 cumbersome to follow the request. If this is non-@code{nil} and not a
14951 number, do maximum fetches.
14953 Here's an example HEAD:
14956 221 1056 Article retrieved.
14957 Path: ifi.uio.no!sturles
14958 From: sturles@@ifi.uio.no (Sturle Sunde)
14959 Newsgroups: ifi.discussion
14960 Subject: Re: Something very droll
14961 Date: 27 Oct 1994 14:02:57 +0100
14962 Organization: Dept. of Informatics, University of Oslo, Norway
14964 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
14965 References: <38jdmq$4qu@@visbur.ifi.uio.no>
14966 NNTP-Posting-Host: holmenkollen.ifi.uio.no
14970 So a @code{headers} return value would imply that there's a number of
14971 these in the data buffer.
14973 Here's a BNF definition of such a buffer:
14977 head = error / valid-head
14978 error-message = [ "4" / "5" ] 2number " " <error message> eol
14979 valid-head = valid-message *header "." eol
14980 valid-message = "221 " <number> " Article retrieved." eol
14981 header = <text> eol
14984 If the return value is @code{nov}, the data buffer should contain
14985 @dfn{network overview database} lines. These are basically fields
14989 nov-buffer = *nov-line
14990 nov-line = 8*9 [ field <TAB> ] eol
14991 field = <text except TAB>
14994 For a closer explanation what should be in those fields,
14998 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
15000 @var{server} is here the virtual server name. @var{definitions} is a
15001 list of @code{(VARIABLE VALUE)} pairs that defines this virtual server.
15003 If the server can't be opened, no error should be signaled. The backend
15004 may then choose to refuse further attempts at connecting to this
15005 server. In fact, it should do so.
15007 If the server is opened already, this function should return a
15008 non-@code{nil} value. There should be no data returned.
15011 @item (nnchoke-close-server &optional SERVER)
15013 Close connection to @var{server} and free all resources connected
15014 to it. Return @code{nil} if the server couldn't be closed for some
15017 There should be no data returned.
15020 @item (nnchoke-request-close)
15022 Close connection to all servers and free all resources that the backend
15023 have reserved. All buffers that have been created by that backend
15024 should be killed. (Not the @code{nntp-server-buffer}, though.) This
15025 function is generally only called when Gnus is shutting down.
15027 There should be no data returned.
15030 @item (nnchoke-server-opened &optional SERVER)
15032 If @var{server} is the current virtual server, and the connection to the
15033 physical server is alive, then this function should return a
15034 non-@code{nil} vlue. This function should under no circumstances
15035 attempt to reconnect to a server that is has lost connection to.
15037 There should be no data returned.
15040 @item (nnchoke-status-message &optional SERVER)
15042 This function should return the last error message from @var{server}.
15044 There should be no data returned.
15047 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
15049 The result data from this function should be the article specified by
15050 @var{article}. This might either be a @code{Message-ID} or a number.
15051 It is optional whether to implement retrieval by @code{Message-ID}, but
15052 it would be nice if that were possible.
15054 If @var{to-buffer} is non-@code{nil}, the result data should be returned
15055 in this buffer instead of the normal data buffer. This is to make it
15056 possible to avoid copying large amounts of data from one buffer to
15057 another, and Gnus mainly request articles to be inserted directly into
15058 its article buffer.
15060 If it is at all possible, this function should return a cons cell where
15061 the car is the group name the article was fetched from, and the cdr is
15062 the article number. This will enable Gnus to find out what the real
15063 group and article numbers are when fetching articles by
15064 @code{Message-ID}. If this isn't possible, @code{t} should be returned
15065 on successful article retrievement.
15068 @item (nnchoke-request-group GROUP &optional SERVER FAST)
15070 Get data on @var{group}. This function also has the side effect of
15071 making @var{group} the current group.
15073 If @var{FAST}, don't bother to return useful data, just make @var{group}
15076 Here's an example of some result data and a definition of the same:
15079 211 56 1000 1059 ifi.discussion
15082 The first number is the status, which should be 211. Next is the
15083 total number of articles in the group, the lowest article number, the
15084 highest article number, and finally the group name. Note that the total
15085 number of articles may be less than one might think while just
15086 considering the highest and lowest article numbers, but some articles
15087 may have been canceled. Gnus just discards the total-number, so
15088 whether one should take the bother to generate it properly (if that is a
15089 problem) is left as an exercise to the reader.
15092 group-status = [ error / info ] eol
15093 error = [ "4" / "5" ] 2<number> " " <Error message>
15094 info = "211 " 3* [ <number> " " ] <string>
15098 @item (nnchoke-close-group GROUP &optional SERVER)
15100 Close @var{group} and free any resources connected to it. This will be
15101 a no-op on most backends.
15103 There should be no data returned.
15106 @item (nnchoke-request-list &optional SERVER)
15108 Return a list of all groups available on @var{server}. And that means
15111 Here's an example from a server that only carries two groups:
15114 ifi.test 0000002200 0000002000 y
15115 ifi.discussion 3324 3300 n
15118 On each line we have a group name, then the highest article number in
15119 that group, the lowest article number, and finally a flag.
15122 active-file = *active-line
15123 active-line = name " " <number> " " <number> " " flags eol
15125 flags = "n" / "y" / "m" / "x" / "j" / "=" name
15128 The flag says whether the group is read-only (@samp{n}), is moderated
15129 (@samp{m}), is dead (@samp{x}), is aliased to some other group
15130 (@samp{=other-group} or none of the above (@samp{y}).
15133 @item (nnchoke-request-post &optional SERVER)
15135 This function should post the current buffer. It might return whether
15136 the posting was successful or not, but that's not required. If, for
15137 instance, the posting is done asynchronously, it has generally not been
15138 completed by the time this function concludes. In that case, this
15139 function should set up some kind of sentinel to beep the user loud and
15140 clear if the posting could not be completed.
15142 There should be no result data from this function.
15147 @node Optional Backend Functions
15148 @subsubsection Optional Backend Functions
15152 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
15154 @var{groups} is a list of groups, and this function should request data
15155 on all those groups. How it does it is of no concern to Gnus, but it
15156 should attempt to do this in a speedy fashion.
15158 The return value of this function can be either @code{active} or
15159 @code{group}, which says what the format of the result data is. The
15160 former is in the same format as the data from
15161 @code{nnchoke-request-list}, while the latter is a buffer full of lines
15162 in the same format as @code{nnchoke-request-group} gives.
15165 group-buffer = *active-line / *group-status
15169 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
15171 A Gnus group info (@pxref{Group Info}) is handed to the backend for
15172 alterations. This comes in handy if the backend really carries all the
15173 information (as is the case with virtual an imap groups). This function
15174 should destructively alter the info to suit its needs, and should return
15175 the (altered) group info.
15177 There should be no result data from this function.
15180 @item (nnchoke-request-type GROUP &optional ARTICLE)
15182 When the user issues commands for ``sending news'' (@kbd{F} in the
15183 summary buffer, for instance), Gnus has to know whether the article the
15184 user is following up is news or mail. This function should return
15185 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
15186 is mail and @code{unknown} if the type can't be decided. (The
15187 @var{article} parameter is necessary in @code{nnvirtual} groups which
15188 might very well combine mail groups and news groups.) Both @var{group}
15189 and @var{article} may be @code{nil}.
15191 There should be no result data from this function.
15194 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
15196 If the user tries to set a mark that the backend doesn't like, this
15197 function may change the mark. Gnus will use whatever this function
15198 returns as the mark for @var{article} instead of the original
15199 @var{mark}. If the backend doesn't care, it must return the original
15200 @var{mark}, and not @code{nil} or any other type of garbage.
15202 The only use for this that I can see is what @code{nnvirtual} does with
15203 it---if a component group is auto-expirable, marking an article as read
15204 in the virtual group should result in the article being marked as
15207 There should be no result data from this function.
15210 @item (nnchoke-request-scan &optional GROUP SERVER)
15212 This function may be called at any time (by Gnus or anything else) to
15213 request that the backend check for incoming articles, in one way or
15214 another. A mail backend will typically read the spool file or query the
15215 POP server when this function is invoked. The @var{group} doesn't have
15216 to be heeded---if the backend decides that it is too much work just
15217 scanning for a single group, it may do a total scan of all groups. It
15218 would be nice, however, to keep things local if that's practical.
15220 There should be no result data from this function.
15223 @item (nnchoke-request-group-description GROUP &optional SERVER)
15225 The result data from this function should be a description of
15229 description-line = name <TAB> description eol
15231 description = <text>
15234 @item (nnchoke-request-list-newsgroups &optional SERVER)
15236 The result data from this function should be the description of all
15237 groups available on the server.
15240 description-buffer = *description-line
15244 @item (nnchoke-request-newgroups DATE &optional SERVER)
15246 The result data from this function should be all groups that were
15247 created after @samp{date}, which is in normal human-readable date
15248 format. The data should be in the active buffer format.
15251 @item (nnchoke-request-create-group GROUP &optional SERVER)
15253 This function should create an empty group with name @var{group}.
15255 There should be no return data.
15258 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
15260 This function should run the expiry process on all articles in the
15261 @var{articles} range (which is currently a simple list of article
15262 numbers.) It is left up to the backend to decide how old articles
15263 should be before they are removed by this function. If @var{force} is
15264 non-@code{nil}, all @var{articles} should be deleted, no matter how new
15267 This function should return a list of articles that it did not/was not
15270 There should be no result data returned.
15273 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
15276 This function should move @var{article} (which is a number) from
15277 @var{group} by calling @var{accept-form}.
15279 This function should ready the article in question for moving by
15280 removing any header lines it has added to the article, and generally
15281 should ``tidy up'' the article. Then it should @code{eval}
15282 @var{accept-form} in the buffer where the ``tidy'' article is. This
15283 will do the actual copying. If this @code{eval} returns a
15284 non-@code{nil} value, the article should be removed.
15286 If @var{last} is @code{nil}, that means that there is a high likelihood
15287 that there will be more requests issued shortly, so that allows some
15290 The function should return a cons where the car is the group name and
15291 the cdr is the article number that the article was entered as.
15293 There should be no data returned.
15296 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
15298 This function takes the current buffer and inserts it into @var{group}.
15299 If @var{last} in @code{nil}, that means that there will be more calls to
15300 this function in short order.
15302 The function should return a cons where the car is the group name and
15303 the cdr is the article number that the article was entered as.
15305 There should be no data returned.
15308 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
15310 This function should remove @var{article} (which is a number) from
15311 @var{group} and insert @var{buffer} there instead.
15313 There should be no data returned.
15316 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
15318 This function should delete @var{group}. If @var{force}, it should
15319 really delete all the articles in the group, and then delete the group
15320 itself. (If there is such a thing as ``the group itself''.)
15322 There should be no data returned.
15325 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
15327 This function should rename @var{group} into @var{new-name}. All
15328 articles that are in @var{group} should move to @var{new-name}.
15330 There should be no data returned.
15335 @node Error Messaging
15336 @subsubsection Error Messaging
15338 @findex nnheader-report
15339 @findex nnheader-get-report
15340 The backends should use the function @code{nnheader-report} to report
15341 error conditions---they should not raise errors when they aren't able to
15342 perform a request. The first argument to this function is the backend
15343 symbol, and the rest are interpreted as arguments to @code{format} if
15344 there are many of them, or just a string if there is one of them.
15345 This function always returns @code{nil}.
15348 (nnheader-report 'nnchoke "You did something totally bogus")
15350 (nnheader-report 'nnchoke "Could not request group %s" group)
15353 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
15354 @code{nil} back from a server, and this function returns the most
15355 recently reported message for the backend in question. This function
15356 takes one argument---the server symbol.
15358 Internally, these function access @var{backend}@code{-status-string}, so
15359 the @code{nnchoke} backend will have its error message stored in
15360 @code{nnchoke-status-string}.
15363 @node Writing New Backends
15364 @subsubsection Writing New Backends
15366 Many backends are quite similar. @code{nnml} is just like
15367 @code{nnspool}, but it allows you to edit the articles on the server.
15368 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
15369 and it doesn't maintain overview databases. @code{nndir} is just like
15370 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
15373 It would make sense if it were possible to ``inherit'' functions from
15374 backends when writing new backends. And, indeed, you can do that if you
15375 want to. (You don't have to if you don't want to, of course.)
15377 All the backends declare their public variables and functions by using a
15378 package called @code{nnoo}.
15380 To inherit functions from other backends (and allow other backends to
15381 inherit functions from the current backend), you should use the
15388 This macro declares the first parameter to be a child of the subsequent
15389 parameters. For instance:
15392 (nnoo-declare nndir
15396 @code{nndir} has here declared that it intends to inherit functions from
15397 both @code{nnml} and @code{nnmh}.
15400 This macro is equivalent to @code{defvar}, but registers the variable as
15401 a public server variable. Most state-oriented variables should be
15402 declared with @code{defvoo} instead of @code{defvar}.
15404 In addition to the normal @code{defvar} parameters, it takes a list of
15405 variables in the parent backends to map the variable to when executing
15406 a function in those backends.
15409 (defvoo nndir-directory nil
15410 "Where nndir will look for groups."
15411 nnml-current-directory nnmh-current-directory)
15414 This means that @code{nnml-current-directory} will be set to
15415 @code{nndir-directory} when an @code{nnml} function is called on behalf
15416 of @code{nndir}. (The same with @code{nnmh}.)
15418 @item nnoo-define-basics
15419 This macro defines some common functions that almost all backends should
15423 (nnoo-define-basics nndir)
15427 This macro is just like @code{defun} and takes the same parameters. In
15428 addition to doing the normal @code{defun} things, it registers the
15429 function as being public so that other backends can inherit it.
15431 @item nnoo-map-functions
15432 This macro allows mapping of functions from the current backend to
15433 functions from the parent backends.
15436 (nnoo-map-functions nndir
15437 (nnml-retrieve-headers 0 nndir-current-group 0 0)
15438 (nnmh-request-article 0 nndir-current-group 0 0))
15441 This means that when @code{nndir-retrieve-headers} is called, the first,
15442 third, and fourth parameters will be passed on to
15443 @code{nnml-retrieve-headers}, while the second parameter is set to the
15444 value of @code{nndir-current-group}.
15447 This macro allows importing functions from backends. It should be the
15448 last thing in the source file, since it will only define functions that
15449 haven't already been defined.
15455 nnmh-request-newgroups)
15459 This means that calls to @code{nndir-request-list} should just be passed
15460 on to @code{nnmh-request-list}, while all public functions from
15461 @code{nnml} that haven't been defined in @code{nndir} yet should be
15466 Below is a slightly shortened version of the @code{nndir} backend.
15469 ;;; nndir.el --- single directory newsgroup access for Gnus
15470 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
15474 (require 'nnheader)
15478 (eval-when-compile (require 'cl))
15480 (nnoo-declare nndir
15483 (defvoo nndir-directory nil
15484 "Where nndir will look for groups."
15485 nnml-current-directory nnmh-current-directory)
15487 (defvoo nndir-nov-is-evil nil
15488 "*Non-nil means that nndir will never retrieve NOV headers."
15491 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
15492 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
15493 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
15495 (defvoo nndir-status-string "" nil nnmh-status-string)
15496 (defconst nndir-version "nndir 1.0")
15498 ;;; Interface functions.
15500 (nnoo-define-basics nndir)
15502 (deffoo nndir-open-server (server &optional defs)
15503 (setq nndir-directory
15504 (or (cadr (assq 'nndir-directory defs))
15506 (unless (assq 'nndir-directory defs)
15507 (push `(nndir-directory ,server) defs))
15508 (push `(nndir-current-group
15509 ,(file-name-nondirectory (directory-file-name nndir-directory)))
15511 (push `(nndir-top-directory
15512 ,(file-name-directory (directory-file-name nndir-directory)))
15514 (nnoo-change-server 'nndir server defs))
15516 (nnoo-map-functions nndir
15517 (nnml-retrieve-headers 0 nndir-current-group 0 0)
15518 (nnmh-request-article 0 nndir-current-group 0 0)
15519 (nnmh-request-group nndir-current-group 0 0)
15520 (nnmh-close-group nndir-current-group 0))
15524 nnmh-status-message
15526 nnmh-request-newgroups))
15532 @node Hooking New Backends Into Gnus
15533 @subsubsection Hooking New Backends Into Gnus
15535 @vindex gnus-valid-select-methods
15536 Having Gnus start using your new backend is rather easy---you just
15537 declare it with the @code{gnus-declare-backend} functions. This will
15538 enter the backend into the @code{gnus-valid-select-methods} variable.
15540 @code{gnus-declare-backend} takes two parameters---the backend name and
15541 an arbitrary number of @dfn{abilities}.
15546 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
15549 The abilities can be:
15553 This is a mailish backend---followups should (probably) go via mail.
15555 This is a newsish backend---followups should (probably) go via news.
15557 This backend supports both mail and news.
15559 This is neither a post or mail backend---it's something completely
15562 It supports respooling---or rather, it is able to modify its source
15563 articles and groups.
15565 The name of the server should be in the virtual server name. This is
15566 true for almost all backends.
15567 @item prompt-address
15568 The user should be prompted for an address when doing commands like
15569 @kbd{B} in the group buffer. This is true for backends like
15570 @code{nntp}, but not @code{nnmbox}, for instance.
15574 @node Mail-like Backends
15575 @subsubsection Mail-like Backends
15577 One of the things that separate the mail backends from the rest of the
15578 backends is the heavy dependence by the mail backends on common
15579 functions in @file{nnmail.el}. For instance, here's the definition of
15580 @code{nnml-request-scan}:
15583 (deffoo nnml-request-scan (&optional group server)
15584 (setq nnml-article-file-alist nil)
15585 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
15588 It simply just calls @code{nnmail-get-new-mail} will a few parameters,
15589 and @code{nnmail} takes care of all the moving and splitting of the
15592 This function takes four parameters.
15596 This should be a symbol to designate which backend is responsible for
15599 @item exit-function
15600 This function should be called after the splitting has been performed.
15602 @item temp-directory
15603 Where the temporary files should be stored.
15606 This optional argument should be a group name if the splitting is to be
15607 performed for one group only.
15610 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
15611 save each article. @var{backend}@code{-active-number} will be called to
15612 find the article number assigned to this article.
15614 The function also uses the following variables:
15615 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
15616 this backend); and @var{backend}@code{-group-alist} and
15617 @var{backend}@code{-active-file} to generate the new active file.
15618 @var{backend}@code{-group-alist} should be a group-active alist, like
15622 (("a-group" (1 . 10))
15623 ("some-group" (34 . 39)))
15627 @node Score File Syntax
15628 @subsection Score File Syntax
15630 Score files are meant to be easily parsable, but yet extremely
15631 mallable. It was decided that something that had the same read syntax
15632 as an Emacs Lisp list would fit that spec.
15634 Here's a typical score file:
15638 ("win95" -10000 nil s)
15645 BNF definition of a score file:
15648 score-file = "" / "(" *element ")"
15649 element = rule / atom
15650 rule = string-rule / number-rule / date-rule
15651 string-rule = "(" quote string-header quote space *string-match ")"
15652 number-rule = "(" quote number-header quote space *number-match ")"
15653 date-rule = "(" quote date-header quote space *date-match ")"
15655 string-header = "subject" / "from" / "references" / "message-id" /
15656 "xref" / "body" / "head" / "all" / "followup"
15657 number-header = "lines" / "chars"
15658 date-header = "date"
15659 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
15660 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
15661 score = "nil" / <integer>
15662 date = "nil" / <natural number>
15663 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
15664 "r" / "regex" / "R" / "Regex" /
15665 "e" / "exact" / "E" / "Exact" /
15666 "f" / "fuzzy" / "F" / "Fuzzy"
15667 number-match = "(" <integer> [ "" / [ space score [ "" /
15668 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
15669 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
15670 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
15671 space date [ "" / [ space date-match-t ] ] ] ] ")"
15672 date-match-t = "nil" / "at" / "before" / "after"
15673 atom = "(" [ required-atom / optional-atom ] ")"
15674 required-atom = mark / expunge / mark-and-expunge / files /
15675 exclude-files / read-only / touched
15676 optional-atom = adapt / local / eval
15677 mark = "mark" space nil-or-number
15678 nil-or-number = "nil" / <integer>
15679 expunge = "expunge" space nil-or-number
15680 mark-and-expunge = "mark-and-expunge" space nil-or-number
15681 files = "files" *[ space <string> ]
15682 exclude-files = "exclude-files" *[ space <string> ]
15683 read-only = "read-only" [ space "nil" / space "t" ]
15684 adapt = "adapt" [ space "nil" / space "t" / space adapt-rule ]
15685 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
15686 local = "local" *[ space "(" <string> space <form> ")" ]
15687 eval = "eval" space <form>
15688 space = *[ " " / <TAB> / <NEWLINE> ]
15691 Any unrecognized elements in a score file should be ignored, but not
15694 As you can see, white space is needed, but the type and amount of white
15695 space is irrelevant. This means that formatting of the score file is
15696 left up to the programmer---if it's simpler to just spew it all out on
15697 one looong line, then that's ok.
15699 The meaning of the various atoms are explained elsewhere in this
15704 @subsection Headers
15706 Gnus uses internally a format for storing article headers that
15707 corresponds to the @sc{nov} format in a mysterious fashion. One could
15708 almost suspect that the author looked at the @sc{nov} specification and
15709 just shamelessly @emph{stole} the entire thing, and one would be right.
15711 @dfn{Header} is a severely overloaded term. ``Header'' is used in
15712 RFC1036 to talk about lines in the head of an article (e.g.,
15713 @code{From}). It is used by many people as a synonym for
15714 ``head''---``the header and the body''. (That should be avoided, in my
15715 opinion.) And Gnus uses a format internally that it calls ``header'',
15716 which is what I'm talking about here. This is a 9-element vector,
15717 basically, with each header (ouch) having one slot.
15719 These slots are, in order: @code{number}, @code{subject}, @code{from},
15720 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
15721 @code{xref}. There are macros for accessing and setting these
15722 slots---they all have predictable names beginning with
15723 @code{mail-header-} and @code{mail-header-set-}, respectively.
15725 The @code{xref} slot is really a @code{misc} slot. Any extra info will
15732 @sc{gnus} introduced a concept that I found so useful that I've started
15733 using it a lot and have elaborated on it greatly.
15735 The question is simple: If you have a large amount of objects that are
15736 identified by numbers (say, articles, to take a @emph{wild} example)
15737 that you want to qualify as being ``included'', a normal sequence isn't
15738 very useful. (A 200,000 length sequence is a bit long-winded.)
15740 The solution is as simple as the question: You just collapse the
15744 (1 2 3 4 5 6 10 11 12)
15747 is transformed into
15750 ((1 . 6) (10 . 12))
15753 To avoid having those nasty @samp{(13 . 13)} elements to denote a
15754 lonesome object, a @samp{13} is a valid element:
15757 ((1 . 6) 7 (10 . 12))
15760 This means that comparing two ranges to find out whether they are equal
15761 is slightly tricky:
15764 ((1 . 5) 7 8 (10 . 12))
15770 ((1 . 5) (7 . 8) (10 . 12))
15773 are equal. In fact, any non-descending list is a range:
15779 is a perfectly valid range, although a pretty long-winded one. This is
15786 and is equal to the previous range.
15788 Here's a BNF definition of ranges. Of course, one must remember the
15789 semantic requirement that the numbers are non-descending. (Any number
15790 of repetition of the same number is allowed, but apt to disappear in
15794 range = simple-range / normal-range
15795 simple-range = "(" number " . " number ")"
15796 normal-range = "(" start-contents ")"
15797 contents = "" / simple-range *[ " " contents ] /
15798 number *[ " " contents ]
15801 Gnus currently uses ranges to keep track of read articles and article
15802 marks. I plan on implementing a number of range operators in C if The
15803 Powers That Be are willing to let me. (I haven't asked yet, because I
15804 need to do some more thinking on what operators I need to make life
15805 totally range-based without ever having to convert back to normal
15810 @subsection Group Info
15812 Gnus stores all permanent info on groups in a @dfn{group info} list.
15813 This list is from three to six elements (or more) long and exhaustively
15814 describes the group.
15816 Here are two example group infos; one is a very simple group while the
15817 second is a more complex one:
15820 ("no.group" 5 (1 . 54324))
15822 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
15823 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
15825 (auto-expire (to-address "ding@@ifi.uio.no")))
15828 The first element is the @dfn{group name}---as Gnus knows the group,
15829 anyway. The second element is the @dfn{subscription level}, which
15830 normally is a small integer. The third element is a list of ranges of
15831 read articles. The fourth element is a list of lists of article marks
15832 of various kinds. The fifth element is the select method (or virtual
15833 server, if you like). The sixth element is a list of @dfn{group
15834 parameters}, which is what this section is about.
15836 Any of the last three elements may be missing if they are not required.
15837 In fact, the vast majority of groups will normally only have the first
15838 three elements, which saves quite a lot of cons cells.
15840 Here's a BNF definition of the group info format:
15843 info = "(" group space level space read
15844 [ "" / [ space marks-list [ "" / [ space method [ "" /
15845 space parameters ] ] ] ] ] ")"
15846 group = quote <string> quote
15847 level = <integer in the range of 1 to inf>
15849 marks-lists = nil / "(" *marks ")"
15850 marks = "(" <string> range ")"
15851 method = "(" <string> *elisp-forms ")"
15852 parameters = "(" *elisp-forms ")"
15855 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
15856 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
15860 @node Emacs/XEmacs Code
15861 @subsection Emacs/XEmacs Code
15865 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
15866 platforms must be the primary one. I chose Emacs. Not because I don't
15867 like XEmacs or Mule, but because it comes first alphabetically.
15869 This means that Gnus will byte-compile under Emacs with nary a warning,
15870 while XEmacs will pump out gigabytes of warnings while byte-compiling.
15871 As I use byte-compilation warnings to help me root out trivial errors in
15872 Gnus, that's very useful.
15874 I've also consistently used Emacs function interfaces, but have used
15875 Gnusey aliases for the functions. To take an example: Emacs defines a
15876 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
15877 function. I then define a function called @code{gnus-run-at-time} that
15878 takes the same parameters as the Emacs @code{run-at-time}. When running
15879 Gnus under Emacs, the former function is just an alias for the latter.
15880 However, when running under XEmacs, the former is an alias for the
15881 following function:
15884 (defun gnus-xmas-run-at-time (time repeat function &rest args)
15888 (,function ,@@args))
15892 This sort of thing has been done for bunches of functions. Gnus does
15893 not redefine any native Emacs functions while running under XEmacs---it
15894 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
15897 Of course, I could have chosen XEmacs as my native platform and done
15898 mapping functions the other way around. But I didn't. The performance
15899 hit these indirections impose on Gnus under XEmacs should be slight.
15902 @node Various File Formats
15903 @subsection Various File Formats
15906 * Active File Format:: Information on articles and groups available.
15907 * Newsgroups File Format:: Group descriptions.
15911 @node Active File Format
15912 @subsubsection Active File Format
15914 The active file lists all groups that are available on the server in
15915 question. It also lists the highest and lowest current article numbers
15918 Here's an excerpt from a typical active file:
15921 soc.motss 296030 293865 y
15922 alt.binaries.pictures.fractals 3922 3913 n
15923 comp.sources.unix 1605 1593 m
15924 comp.binaries.ibm.pc 5097 5089 y
15925 no.general 1000 900 y
15928 Here's a pseudo-BNF definition of this file:
15931 active = *group-line
15932 group-line = group space high-number space low-number space flag <NEWLINE>
15933 group = <non-white-space string>
15935 high-number = <non-negative integer>
15936 low-number = <positive integer>
15937 flag = "y" / "n" / "m" / "j" / "x" / "=" group
15941 @node Newsgroups File Format
15942 @subsubsection Newsgroups File Format
15944 The newsgroups file lists groups along with their descriptions. Not all
15945 groups on the server have to be listed, and not all groups in the file
15946 have to exist on the server. The file is meant purely as information to
15949 The format is quite simple; a group name, a tab, and the description.
15950 Here's the definition:
15954 line = group tab description <NEWLINE>
15955 group = <non-white-space string>
15957 description = <string>
15961 @node Emacs for Heathens
15962 @section Emacs for Heathens
15964 Believe it or not, but some people who use Gnus haven't really used
15965 Emacs much before they embarked on their journey on the Gnus Love Boat.
15966 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
15967 region'', and ``set @code{gnus-flargblossen} to an alist where the key
15968 is a regexp that is used for matching on the group name'' are magical
15969 phrases with little or no meaning, then this appendix is for you. If
15970 you are already familiar with Emacs, just ignore this and go fondle your
15974 * Keystrokes:: Entering text and executing commands.
15975 * Emacs Lisp:: The built-in Emacs programming language.
15980 @subsection Keystrokes
15984 Q: What is an experienced Emacs user?
15987 A: A person who wishes that the terminal had pedals.
15990 Yes, when you use Emacs, you are apt to use the control key, the shift
15991 key and the meta key a lot. This is very annoying to some people
15992 (notably @code{vi}le users), and the rest of us just love the hell out
15993 of it. Just give up and submit. Emacs really does stand for
15994 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
15995 may have heard from other disreputable sources (like the Emacs author).
15997 The shift key is normally located near your pinky fingers, and are
15998 normally used to get capital letters and stuff. You probably use it all
15999 the time. The control key is normally marked ``CTRL'' or something like
16000 that. The meta key is, funnily enough, never marked as such on any
16001 keyboards. The one I'm currently at has a key that's marked ``Alt'',
16002 which is the meta key on this keyboard. It's usually located somewhere
16003 to the left hand side of the keyboard, usually on the bottom row.
16005 Now, us Emacs people doesn't say ``press the meta-control-m key'',
16006 because that's just too inconvenient. We say ``press the @kbd{M-C-m}
16007 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
16008 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
16009 down the control key, and hold it down while you press @kbd{k}''.
16010 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
16011 the control key and then press @kbd{k}''. Simple, ay?
16013 This is somewhat complicated by the fact that not all keyboards have a
16014 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
16015 means ``press escape, release escape, press @kbd{k}''. That's much more
16016 work than if you have a meta key, so if that's the case, I respectfully
16017 suggest you get a real keyboard with a meta key. You can't live without
16023 @subsection Emacs Lisp
16025 Emacs is the King of Editors because it's really a Lisp interpreter.
16026 Each and every key you tap runs some Emacs Lisp code snippet, and since
16027 Emacs Lisp is an interpreted language, that means that you can configure
16028 any key to run any arbitrary code. You just, like, do it.
16030 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
16031 functions. (These are byte-compiled for speed, but it's still
16032 interpreted.) If you decide that you don't like the way Gnus does
16033 certain things, it's trivial to have it do something a different way.
16034 (Well, at least if you know how to write Lisp code.) However, that's
16035 beyond the scope of this manual, so we are simply going to talk about
16036 some common constructs that you normally use in your @file{.emacs} file
16039 If you want to set the variable @code{gnus-florgbnize} to four (4), you
16040 write the following:
16043 (setq gnus-florgbnize 4)
16046 This function (really ``special form'') @code{setq} is the one that can
16047 set a variable to some value. This is really all you need to know. Now
16048 you can go and fill your @code{.emacs} file with lots of these to change
16051 If you have put that thing in your @code{.emacs} file, it will be read
16052 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
16053 start Emacs. If you want to change the variable right away, simply say
16054 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
16055 previous ``form'', which here is a simple @code{setq} statement.
16057 Go ahead---just try it, if you're located at your Emacs. After you
16058 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
16059 is the return value of the form you @code{eval}ed.
16063 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
16067 (setq gnus-read-active-file 'some)
16070 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
16071 @samp{nntp.ifi.uio.no}'', that means:
16074 (setq gnus-nntp-server "nntp.ifi.uio.no")
16077 So be careful not to mix up strings (the latter) with symbols (the
16078 former). The manual is unambiguous, but it can be confusing.
16081 @include gnus-faq.texi