1 \input texinfo @c -*-texinfo-*-
4 @settitle Gnus 5.4.44 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.44 Manual
292 @author by Lars Magne Ingebrigtsen
295 @vskip 0pt plus 1filll
296 Copyright @copyright{} 1995,96,97 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.44.
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. This function will be called
645 with the name of the new group as the only parameter.
647 Some handy pre-fab functions are:
651 @item gnus-subscribe-zombies
652 @vindex gnus-subscribe-zombies
653 Make all new groups zombies. This is the default. You can browse the
654 zombies later (with @kbd{A z}) and either kill them all off properly
655 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
657 @item gnus-subscribe-randomly
658 @vindex gnus-subscribe-randomly
659 Subscribe all new groups randomly.
661 @item gnus-subscribe-alphabetically
662 @vindex gnus-subscribe-alphabetically
663 Subscribe all new groups alphabetically.
665 @item gnus-subscribe-hierarchically
666 @vindex gnus-subscribe-hierarchically
667 Subscribe all new groups hierarchically. The difference between this
668 function and @code{gnus-subscribe-alphabetically} is slight.
669 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
670 alphabetical fashion, while this function will enter groups into it's
671 hierarchy. So if you want to have the @samp{rec} hierarchy before the
672 @samp{comp} hierarchy, this function will not mess that configuration
673 up. Or something like that.
675 @item gnus-subscribe-interactively
676 @vindex gnus-subscribe-interactively
677 Subscribe new groups interactively. This means that Gnus will ask
678 you about @strong{all} new groups.
680 @item gnus-subscribe-killed
681 @vindex gnus-subscribe-killed
686 @vindex gnus-subscribe-hierarchical-interactive
687 A closely related variable is
688 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
689 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
690 hierarchical fashion whether to subscribe to new groups or not. Gnus
691 will ask you for each sub-hierarchy whether you want to descend the
694 One common mistake is to set the variable a few paragraphs above to
695 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
696 will not work. This is ga-ga. So don't do it.
699 @node Filtering New Groups
700 @subsection Filtering New Groups
702 A nice and portable way to control which new newsgroups should be
703 subscribed (or ignored) is to put an @dfn{options} line at the start of
704 the @file{.newsrc} file. Here's an example:
707 options -n !alt.all !rec.all sci.all
710 @vindex gnus-subscribe-options-newsgroup-method
711 This line obviously belongs to a serious-minded intellectual scientific
712 person (or she may just be plain old boring), because it says that all
713 groups that have names beginning with @samp{alt} and @samp{rec} should
714 be ignored, and all groups with names beginning with @samp{sci} should
715 be subscribed. Gnus will not use the normal subscription method for
716 subscribing these groups.
717 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
718 variable defaults to @code{gnus-subscribe-alphabetically}.
720 @vindex gnus-options-not-subscribe
721 @vindex gnus-options-subscribe
722 If you don't want to mess with your @file{.newsrc} file, you can just
723 set the two variables @code{gnus-options-subscribe} and
724 @code{gnus-options-not-subscribe}. These two variables do exactly the
725 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
726 and if the the new group matches the former, it will be unconditionally
727 subscribed, and if it matches the latter, it will be ignored.
729 @vindex gnus-auto-subscribed-groups
730 Yet another variable that meddles here is
731 @code{gnus-auto-subscribed-groups}. It works exactly like
732 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
733 thought it would be nice to have two of these. This variable is more
734 meant for setting some ground rules, while the other variable is used
735 more for user fiddling. By default this variable makes all new groups
736 that come from mail backends (@code{nnml}, @code{nnbabyl},
737 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you
738 don't like that, just set this variable to @code{nil}.
740 New groups that match this regexp are subscribed using
741 @code{gnus-subscribe-options-newsgroup-method}.
744 @node Changing Servers
745 @section Changing Servers
746 @cindex changing servers
748 Sometimes it is necessary to move from one @sc{nntp} server to another.
749 This happens very rarely, but perhaps you change jobs, or one server is
750 very flaky and you want to use another.
752 Changing the server is pretty easy, right? You just change
753 @code{gnus-select-method} to point to the new server?
757 Article numbers are not (in any way) kept synchronized between different
758 @sc{nntp} servers, and the only way Gnus keeps track of what articles
759 you have read is by keeping track of article numbers. So when you
760 change @code{gnus-select-method}, your @file{.newsrc} file becomes
763 Gnus provides a few functions to attempt to translate a @file{.newsrc}
764 file from one server to another. They all have one thing in
765 common---they take a looong time to run. You don't want to use these
766 functions more than absolutely necessary.
768 @kindex M-x gnus-change-server
769 @findex gnus-change-server
770 If you have access to both servers, Gnus can request the headers for all
771 the articles you have read and compare @code{Message-ID}s and map the
772 article numbers of the read articles and article marks. The @kbd{M-x
773 gnus-change-server} command will do this for all your native groups. It
774 will prompt for the method you want to move to.
776 @kindex M-x gnus-group-move-group-to-server
777 @findex gnus-group-move-group-to-server
778 You can also move individual groups with the @kbd{M-x
779 gnus-group-move-group-to-server} command. This is useful if you want to
780 move a (foreign) group from one server to another.
782 @kindex M-x gnus-group-clear-data-on-native-groups
783 @findex gnus-group-clear-data-on-native-groups
784 If you don't have access to both the old and new server, all your marks
785 and read ranges have become worthless. You can use the @kbd{M-x
786 gnus-group-clear-data-on-native-groups} command to clear out all data
787 that you have on your native groups. Use with caution.
791 @section Startup Files
792 @cindex startup files
797 Now, you all know about the @file{.newsrc} file. All subscription
798 information is traditionally stored in this file.
800 Things got a bit more complicated with @sc{gnus}. In addition to
801 keeping the @file{.newsrc} file updated, it also used a file called
802 @file{.newsrc.el} for storing all the information that didn't fit into
803 the @file{.newsrc} file. (Actually, it also duplicated everything in
804 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
805 files was the most recently saved, which enabled people to swap between
806 @sc{gnus} and other newsreaders.
808 That was kinda silly, so Gnus went one better: In addition to the
809 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
810 @file{.newsrc.eld}. It will read whichever of these files that are most
811 recent, but it will never write a @file{.newsrc.el} file.
813 @vindex gnus-save-newsrc-file
814 You can turn off writing the @file{.newsrc} file by setting
815 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
816 the file and save some space, as well as making exit from Gnus faster.
817 However, this will make it impossible to use other newsreaders than
818 Gnus. But hey, who would want to, right?
820 @vindex gnus-save-killed-list
821 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
822 will not save the list of killed groups to the startup file. This will
823 save both time (when starting and quitting) and space (on disk). It
824 will also mean that Gnus has no record of what groups are new or old,
825 so the automatic new groups subscription methods become meaningless.
826 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
827 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
828 Groups}). This variable can also be a regular expression. If that's
829 the case, remove all groups that do not match this regexp before
830 saving. This can be useful in certain obscure situations that involve
831 several servers where not all servers support @code{ask-server}.
833 @vindex gnus-startup-file
834 The @code{gnus-startup-file} variable says where the startup files are.
835 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
836 file being whatever that one is with a @samp{.eld} appended.
838 @vindex gnus-save-newsrc-hook
839 @vindex gnus-save-quick-newsrc-hook
840 @vindex gnus-save-standard-newsrc-hook
841 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
842 files, while @code{gnus-save-quick-newsrc-hook} is called just before
843 saving the @file{.newsrc.eld} file, and
844 @code{gnus-save-standard-newsrc-hook} is called just before saving the
845 @file{.newsrc} file. The latter two are commonly used to turn version
846 control on or off. Version control is on by default when saving the
847 startup files. If you want to turn backup creation off, say something like:
850 (defun turn-off-backup ()
851 (set (make-local-variable 'backup-inhibited) t))
853 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
854 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
857 @vindex gnus-init-file
858 When Gnus starts, it will read the @code{gnus-site-init-file}
859 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
860 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
861 and can be used to avoid cluttering your @file{~/.emacs} and
862 @file{site-init} files with Gnus stuff. Gnus will also check for files
863 with the same names as these, but with @file{.elc} and @file{.el}
864 suffixes. In other words, if you have set @code{gnus-init-file} to
865 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
866 and finally @file{~/.gnus} (in this order).
875 Whenever you do something that changes the Gnus data (reading articles,
876 catching up, killing/subscribing groups), the change is added to a
877 special @dfn{dribble buffer}. This buffer is auto-saved the normal
878 Emacs way. If your Emacs should crash before you have saved the
879 @file{.newsrc} files, all changes you have made can be recovered from
882 If Gnus detects this file at startup, it will ask the user whether to
883 read it. The auto save file is deleted whenever the real startup file is
886 @vindex gnus-use-dribble-file
887 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
888 maintain a dribble buffer. The default is @code{t}.
890 @vindex gnus-dribble-directory
891 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
892 this variable is @code{nil}, which it is by default, Gnus will dribble
893 into the directory where the @file{.newsrc} file is located. (This is
894 normally the user's home directory.) The dribble file will get the same
895 file permissions as the @code{.newsrc} file.
898 @node The Active File
899 @section The Active File
901 @cindex ignored groups
903 When Gnus starts, or indeed whenever it tries to determine whether new
904 articles have arrived, it reads the active file. This is a very large
905 file that lists all the active groups and articles on the server.
907 @vindex gnus-ignored-newsgroups
908 Before examining the active file, Gnus deletes all lines that match the
909 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
910 any groups with bogus names, but you can use this variable to make Gnus
911 ignore hierarchies you aren't ever interested in. However, this is not
912 recommended. In fact, it's highly discouraged. Instead, @pxref{New
913 Groups} for an overview of other variables that can be used instead.
916 @c @code{nil} by default, and will slow down active file handling somewhat
917 @c if you set it to anything else.
919 @vindex gnus-read-active-file
921 The active file can be rather Huge, so if you have a slow network, you
922 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
923 reading the active file. This variable is @code{t} by default.
925 Gnus will try to make do by getting information just on the groups that
926 you actually subscribe to.
928 Note that if you subscribe to lots and lots of groups, setting this
929 variable to @code{nil} will probably make Gnus slower, not faster. At
930 present, having this variable @code{nil} will slow Gnus down
931 considerably, unless you read news over a 2400 baud modem.
933 This variable can also have the value @code{some}. Gnus will then
934 attempt to read active info only on the subscribed groups. On some
935 servers this is quite fast (on sparkling, brand new INN servers that
936 support the @code{LIST ACTIVE group} command), on others this isn't fast
937 at all. In any case, @code{some} should be faster than @code{nil}, and
938 is certainly faster than @code{t} over slow lines.
940 If this variable is @code{nil}, Gnus will ask for group info in total
941 lock-step, which isn't very fast. If it is @code{some} and you use an
942 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
943 read all the replies in one swoop. This will normally result in better
944 performance, but if the server does not support the aforementioned
945 @code{LIST ACTIVE group} command, this isn't very nice to the server.
947 In any case, if you use @code{some} or @code{nil}, you should definitely
948 kill all groups that you aren't interested in to speed things up.
950 Note that this variable also affects active file retrieval from
951 secondary select methods.
954 @node Startup Variables
955 @section Startup Variables
960 @vindex gnus-load-hook
961 A hook that is run while Gnus is being loaded. Note that this hook will
962 normally be run just once in each Emacs session, no matter how many
963 times you start Gnus.
965 @item gnus-startup-hook
966 @vindex gnus-startup-hook
967 A hook that is run after starting up Gnus successfully.
969 @item gnus-started-hook
970 @vindex gnus-started-hook
971 A hook that is run as the very last thing after starting up Gnus
974 @item gnus-check-bogus-newsgroups
975 @vindex gnus-check-bogus-newsgroups
976 If non-@code{nil}, Gnus will check for and delete all bogus groups at
977 startup. A @dfn{bogus group} is a group that you have in your
978 @file{.newsrc} file, but doesn't exist on the news server. Checking for
979 bogus groups can take quite a while, so to save time and resources it's
980 best to leave this option off, and do the checking for bogus groups once
981 in a while from the group buffer instead (@pxref{Group Maintenance}).
983 @item gnus-inhibit-startup-message
984 @vindex gnus-inhibit-startup-message
985 If non-@code{nil}, the startup message won't be displayed. That way,
986 your boss might not notice as easily that you are reading news instead
987 of doing your job. Note that this variable is used before
988 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
990 @item gnus-no-groups-message
991 @vindex gnus-no-groups-message
992 Message displayed by Gnus when no groups are available.
994 @item gnus-play-startup-jingle
995 @vindex gnus-play-startup-jingle
996 If non-@code{nil}, play the Gnus jingle at startup.
998 @item gnus-startup-jingle
999 @vindex gnus-startup-jingle
1000 Jingle to be played if the above variable is non-@code{nil}. The
1001 default is @samp{Tuxedomoon.Jingle4.au}.
1006 @node The Group Buffer
1007 @chapter The Group Buffer
1008 @cindex group buffer
1010 The @dfn{group buffer} lists all (or parts) of the available groups. It
1011 is the first buffer shown when Gnus starts, and will never be killed as
1012 long as Gnus is active.
1015 * Group Buffer Format:: Information listed and how you can change it.
1016 * Group Maneuvering:: Commands for moving in the group buffer.
1017 * Selecting a Group:: Actually reading news.
1018 * Group Data:: Changing the info for a group.
1019 * Subscription Commands:: Unsubscribing, killing, subscribing.
1020 * Group Levels:: Levels? What are those, then?
1021 * Group Score:: A mechanism for finding out what groups you like.
1022 * Marking Groups:: You can mark groups for later processing.
1023 * Foreign Groups:: Creating and editing groups.
1024 * Group Parameters:: Each group may have different parameters set.
1025 * Listing Groups:: Gnus can list various subsets of the groups.
1026 * Sorting Groups:: Re-arrange the group order.
1027 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1028 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1029 * Exiting Gnus:: Stop reading news and get some work done.
1030 * Group Topics:: A folding group mode divided into topics.
1031 * Misc Group Stuff:: Other stuff that you can to do.
1035 @node Group Buffer Format
1036 @section Group Buffer Format
1039 * Group Line Specification:: Deciding how the group buffer is to look.
1040 * Group Modeline Specification:: The group buffer modeline.
1041 * Group Highlighting:: Having nice colors in the group buffer.
1045 @node Group Line Specification
1046 @subsection Group Line Specification
1047 @cindex group buffer format
1049 The default format of the group buffer is nice and dull, but you can
1050 make it as exciting and ugly as you feel like.
1052 Here's a couple of example group lines:
1055 25: news.announce.newusers
1056 * 0: alt.fan.andrea-dworkin
1061 You can see that there are 25 unread articles in
1062 @samp{news.announce.newusers}. There are no unread articles, but some
1063 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1064 asterisk at the beginning of the line?)
1066 @vindex gnus-group-line-format
1067 You can change that format to whatever you want by fiddling with the
1068 @code{gnus-group-line-format} variable. This variable works along the
1069 lines of a @code{format} specification, which is pretty much the same as
1070 a @code{printf} specifications, for those of you who use (feh!) C.
1071 @xref{Formatting Variables}.
1073 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1075 There should always be a colon on the line; the cursor always moves to
1076 the colon after performing an operation. Nothing else is required---not
1077 even the group name. All displayed text is just window dressing, and is
1078 never examined by Gnus. Gnus stores all real information it needs using
1081 (Note that if you make a really strange, wonderful, spreadsheet-like
1082 layout, everybody will believe you are hard at work with the accounting
1083 instead of wasting time reading news.)
1085 Here's a list of all available format characters:
1090 An asterisk if the group only has marked articles.
1093 Whether the group is subscribed.
1096 Level of subscribedness.
1099 Number of unread articles.
1102 Number of dormant articles.
1105 Number of ticked articles.
1108 Number of read articles.
1111 Estimated total number of articles. (This is really @var{max-number}
1112 minus @var{min-number} plus 1.)
1115 Number of unread, unticked, non-dormant articles.
1118 Number of ticked and dormant articles.
1127 Newsgroup description.
1130 @samp{m} if moderated.
1133 @samp{(m)} if moderated.
1142 A string that looks like @samp{<%s:%n>} if a foreign select method is
1146 Indentation based on the level of the topic (@pxref{Group Topics}).
1149 @vindex gnus-group-uncollapsed-levels
1150 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1151 variable says how many levels to leave at the end of the group name.
1152 The default is 1---this will mean that group names like
1153 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1156 @vindex gnus-new-mail-mark
1158 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1162 A string that says when you last read the group (@pxref{Group
1166 User defined specifier. The next character in the format string should
1167 be a letter. @sc{gnus} will call the function
1168 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1169 following @samp{%u}. The function will be passed a single dummy
1170 parameter as argument. The function should return a string, which will
1171 be inserted into the buffer just like information from any other
1176 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1177 if no info is available---for instance, if it is a non-activated foreign
1178 group, or a bogus native group.
1181 @node Group Modeline Specification
1182 @subsection Group Modeline Specification
1183 @cindex group modeline
1185 @vindex gnus-group-mode-line-format
1186 The mode line can be changed by setting
1187 @code{gnus-group-mode-line-format} (@pxref{Formatting Variables}). It
1188 doesn't understand that many format specifiers:
1192 The native news server.
1194 The native select method.
1198 @node Group Highlighting
1199 @subsection Group Highlighting
1200 @cindex highlighting
1201 @cindex group highlighting
1203 @vindex gnus-group-highlight
1204 Highlighting in the group buffer is controlled by the
1205 @code{gnus-group-highlight} variable. This is an alist with elements
1206 that look like @var{(form . face)}. If @var{form} evaluates to
1207 something non-@code{nil}, the @var{face} will be used on the line.
1209 Here's an example value for this variable that might look nice if the
1213 (setq gnus-group-highlight
1215 ,(custom-face-lookup "Red" nil nil t nil nil))
1216 ((and (< level 3) (zerop unread)) .
1217 ,(custom-face-lookup "SeaGreen" nil nil t nil nil))
1219 ,(custom-face-lookup "SpringGreen" nil nil t nil nil))
1221 ,(custom-face-lookup "SteelBlue" nil nil t nil nil))
1223 ,(custom-face-lookup "SkyBlue" nil nil t nil nil))))
1226 Variables that are dynamically bound when the forms are evaluated
1233 The number of unread articles in the group.
1237 Whether the group is a mail group.
1239 The level of the group.
1241 The score of the group.
1243 The number of ticked articles in the group.
1245 The total number of articles in the group. Or rather, MAX-NUMBER minus
1248 When using the topic minor mode, this variable is bound to the current
1249 topic being inserted.
1252 When the forms are @code{eval}ed, point is at the beginning of the line
1253 of the group in question, so you can use many of the normal Gnus
1254 functions for snarfing info on the group.
1256 @vindex gnus-group-update-hook
1257 @findex gnus-group-highlight-line
1258 @code{gnus-group-update-hook} is called when a group line is changed.
1259 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1260 calls @code{gnus-group-highlight-line} by default.
1263 @node Group Maneuvering
1264 @section Group Maneuvering
1265 @cindex group movement
1267 All movement commands understand the numeric prefix and will behave as
1268 expected, hopefully.
1274 @findex gnus-group-next-unread-group
1275 Go to the next group that has unread articles
1276 (@code{gnus-group-next-unread-group}).
1282 @findex gnus-group-prev-unread-group
1283 Go to the previous group that has unread articles
1284 (@code{gnus-group-prev-unread-group}).
1288 @findex gnus-group-next-group
1289 Go to the next group (@code{gnus-group-next-group}).
1293 @findex gnus-group-prev-group
1294 Go to the previous group (@code{gnus-group-prev-group}).
1298 @findex gnus-group-next-unread-group-same-level
1299 Go to the next unread group on the same (or lower) level
1300 (@code{gnus-group-next-unread-group-same-level}).
1304 @findex gnus-group-prev-unread-group-same-level
1305 Go to the previous unread group on the same (or lower) level
1306 (@code{gnus-group-prev-unread-group-same-level}).
1309 Three commands for jumping to groups:
1315 @findex gnus-group-jump-to-group
1316 Jump to a group (and make it visible if it isn't already)
1317 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
1322 @findex gnus-group-best-unread-group
1323 Jump to the unread group with the lowest level
1324 (@code{gnus-group-best-unread-group}).
1328 @findex gnus-group-first-unread-group
1329 Jump to the first group with unread articles
1330 (@code{gnus-group-first-unread-group}).
1333 @vindex gnus-group-goto-unread
1334 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1335 commands will move to the next group, not the next unread group. Even
1336 the commands that say they move to the next unread group. The default
1340 @node Selecting a Group
1341 @section Selecting a Group
1342 @cindex group selection
1347 @kindex SPACE (Group)
1348 @findex gnus-group-read-group
1349 Select the current group, switch to the summary buffer and display the
1350 first unread article (@code{gnus-group-read-group}). If there are no
1351 unread articles in the group, or if you give a non-numerical prefix to
1352 this command, Gnus will offer to fetch all the old articles in this
1353 group from the server. If you give a numerical prefix @var{N}, @var{N}
1354 determines the number of articles Gnus will fetch. If @var{N} is
1355 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1356 negative, Gnus fetches the @var{abs(N)} oldest articles.
1360 @findex gnus-group-select-group
1361 Select the current group and switch to the summary buffer
1362 (@code{gnus-group-select-group}). Takes the same arguments as
1363 @code{gnus-group-read-group}---the only difference is that this command
1364 does not display the first unread article automatically upon group
1368 @kindex M-RET (Group)
1369 @findex gnus-group-quick-select-group
1370 This does the same as the command above, but tries to do it with the
1371 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
1372 scoring/killing will be performed, there will be no highlights and no
1373 expunging. This might be useful if you're in a real hurry and have to
1374 enter some humongous group. If you give a 0 prefix to this command
1375 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer.
1376 This might be useful if you want to toggle threading before entering the
1380 @kindex M-SPACE (Group)
1381 @findex gnus-group-visible-select-group
1382 This is yet one more command that does the same as the @kbd{RET}
1383 command, but this one does it without expunging and hiding dormants
1384 (@code{gnus-group-visible-select-group}).
1387 @kindex M-C-RET (Group)
1388 @findex gnus-group-select-group-ephemerally
1389 Finally, this command selects the current group ephemerally without
1390 doing any processing of its contents
1391 (@code{gnus-group-select-group-ephemerally}). Even threading has been
1392 turned off. Everything you do in the group after selecting it in this
1393 manner will have no permanent effects.
1397 @vindex gnus-large-newsgroup
1398 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1399 to be a big group. This is 200 by default. If the group has more
1400 (unread and/or ticked) articles than this, Gnus will query the user
1401 before entering the group. The user can then specify how many articles
1402 should be fetched from the server. If the user specifies a negative
1403 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
1404 is positive, the @code{n} articles that have arrived most recently will
1407 @vindex gnus-select-group-hook
1408 @vindex gnus-auto-select-first
1409 @code{gnus-auto-select-first} control whether any articles are selected
1410 automatically when entering a group with the @kbd{SPACE} command.
1415 Don't select any articles when entering the group. Just display the
1416 full summary buffer.
1419 Select the first unread article when entering the group.
1422 Select the most high-scored article in the group when entering the
1426 If you want to prevent automatic selection in some group (say, in a
1427 binary group with Huge articles) you can set this variable to @code{nil}
1428 in @code{gnus-select-group-hook}, which is called when a group is
1432 @node Subscription Commands
1433 @section Subscription Commands
1434 @cindex subscription
1442 @findex gnus-group-unsubscribe-current-group
1443 Toggle subscription to the current group
1444 (@code{gnus-group-unsubscribe-current-group}).
1450 @findex gnus-group-unsubscribe-group
1451 Prompt for a group to subscribe, and then subscribe it. If it was
1452 subscribed already, unsubscribe it instead
1453 (@code{gnus-group-unsubscribe-group}).
1459 @findex gnus-group-kill-group
1460 Kill the current group (@code{gnus-group-kill-group}).
1466 @findex gnus-group-yank-group
1467 Yank the last killed group (@code{gnus-group-yank-group}).
1470 @kindex C-x C-t (Group)
1471 @findex gnus-group-transpose-groups
1472 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
1473 really a subscription command, but you can use it instead of a
1474 kill-and-yank sequence sometimes.
1480 @findex gnus-group-kill-region
1481 Kill all groups in the region (@code{gnus-group-kill-region}).
1485 @findex gnus-group-kill-all-zombies
1486 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1489 @kindex S C-k (Group)
1490 @findex gnus-group-kill-level
1491 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1492 These groups can't be yanked back after killing, so this command should
1493 be used with some caution. The only time where this command comes in
1494 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1495 groups that you want to get rid off. @kbd{S C-k} on level 7 will
1496 kill off all unsubscribed groups that do not have message numbers in the
1497 @file{.newsrc} file.
1501 Also @pxref{Group Levels}.
1511 @findex gnus-group-catchup-current
1512 @vindex gnus-group-catchup-group-hook
1513 Mark all unticked articles in this group as read
1514 (@code{gnus-group-catchup-current}).
1515 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1520 @findex gnus-group-catchup-current-all
1521 Mark all articles in this group, even the ticked ones, as read
1522 (@code{gnus-group-catchup-current-all}).
1526 @findex gnus-group-clear-data
1527 Clear the data from the current group---nix out marks and the list of
1528 read articles (@code{gnus-group-clear-data}).
1530 @item M-x gnus-group-clear-data-on-native-groups
1531 @kindex M-x gnus-group-clear-data-on-native-groups
1532 @findex gnus-group-clear-data-on-native-groups
1533 If you have switched from one @sc{nntp} server to another, all your marks
1534 and read ranges have become worthless. You can use this command to
1535 clear out all data that you have on your native groups. Use with
1542 @section Group Levels
1546 All groups have a level of @dfn{subscribedness}. For instance, if a
1547 group is on level 2, it is more subscribed than a group on level 5. You
1548 can ask Gnus to just list groups on a given level or lower
1549 (@pxref{Listing Groups}), or to just check for new articles in groups on
1550 a given level or lower (@pxref{Scanning New Messages}).
1552 Remember: The higher the level of the group, the less important it is.
1558 @findex gnus-group-set-current-level
1559 Set the level of the current group. If a numeric prefix is given, the
1560 next @var{n} groups will have their levels set. The user will be
1561 prompted for a level.
1564 @vindex gnus-level-killed
1565 @vindex gnus-level-zombie
1566 @vindex gnus-level-unsubscribed
1567 @vindex gnus-level-subscribed
1568 Gnus considers groups on between levels 1 and
1569 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1570 @code{gnus-level-subscribed} (exclusive) and
1571 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1572 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1573 (default 8) and @code{gnus-level-killed} to be killed (default 9),
1574 completely dead. Gnus treats subscribed and unsubscribed groups exactly
1575 the same, but zombie and killed groups have no information on what
1576 articles you have read, etc, stored. This distinction between dead and
1577 living groups isn't done because it is nice or clever, it is done purely
1578 for reasons of efficiency.
1580 It is recommended that you keep all your mail groups (if any) on quite
1581 low levels (e.g. 1 or 2).
1583 If you want to play with the level variables, you should show some care.
1584 Set them once, and don't touch them ever again. Better yet, don't touch
1585 them at all unless you know exactly what you're doing.
1587 @vindex gnus-level-default-unsubscribed
1588 @vindex gnus-level-default-subscribed
1589 Two closely related variables are @code{gnus-level-default-subscribed}
1590 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1591 which are the levels that new groups will be put on if they are
1592 (un)subscribed. These two variables should, of course, be inside the
1593 relevant legal ranges.
1595 @vindex gnus-keep-same-level
1596 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1597 will only move to groups that are of the same level (or lower). In
1598 particular, going from the last article in one group to the next group
1599 will go to the next group of the same level (or lower). This might be
1600 handy if you want to read the most important groups before you read the
1603 @vindex gnus-group-default-list-level
1604 All groups with a level less than or equal to
1605 @code{gnus-group-default-list-level} will be listed in the group buffer
1608 @vindex gnus-group-list-inactive-groups
1609 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1610 groups will be listed along with the unread groups. This variable is
1611 @code{t} by default. If it is @code{nil}, inactive groups won't be
1614 @vindex gnus-group-use-permanent-levels
1615 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1616 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1617 use this level as the ``work'' level.
1619 @vindex gnus-activate-level
1620 Gnus will normally just activate groups that are on level
1621 @code{gnus-activate-level} or less. If you don't want to activate
1622 unsubscribed groups, for instance, you might set this variable to
1623 5. The default is 6.
1627 @section Group Score
1630 You would normally keep important groups on high levels, but that scheme
1631 is somewhat restrictive. Don't you wish you could have Gnus sort the
1632 group buffer according to how often you read groups, perhaps? Within
1635 This is what @dfn{group score} is for. You can assign a score to each
1636 group. You can then sort the group buffer based on this score.
1637 Alternatively, you can sort on score and then level. (Taken together,
1638 the level and the score is called the @dfn{rank} of the group. A group
1639 that is on level 4 and has a score of 1 has a higher rank than a group
1640 on level 5 that has a score of 300. (The level is the most significant
1641 part and the score is the least significant part.))
1643 @findex gnus-summary-bubble-group
1644 If you want groups you read often to get higher scores than groups you
1645 read seldom you can add the @code{gnus-summary-bubble-group} function to
1646 the @code{gnus-summary-exit-hook} hook. This will result (after
1647 sorting) in a bubbling sort of action. If you want to see that in
1648 action after each summary exit, you can add
1649 @code{gnus-group-sort-groups-by-rank} or
1650 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1651 slow things down somewhat.
1654 @node Marking Groups
1655 @section Marking Groups
1656 @cindex marking groups
1658 If you want to perform some command on several groups, and they appear
1659 subsequently in the group buffer, you would normally just give a
1660 numerical prefix to the command. Most group commands will then do your
1661 bidding on those groups.
1663 However, if the groups are not in sequential order, you can still
1664 perform a command on several groups. You simply mark the groups first
1665 with the process mark and then execute the command.
1673 @findex gnus-group-mark-group
1674 Set the mark on the current group (@code{gnus-group-mark-group}).
1680 @findex gnus-group-unmark-group
1681 Remove the mark from the current group
1682 (@code{gnus-group-unmark-group}).
1686 @findex gnus-group-unmark-all-groups
1687 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1691 @findex gnus-group-mark-region
1692 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1696 @findex gnus-group-mark-buffer
1697 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1701 @findex gnus-group-mark-regexp
1702 Mark all groups that match some regular expression
1703 (@code{gnus-group-mark-regexp}).
1706 Also @pxref{Process/Prefix}.
1708 @findex gnus-group-universal-argument
1709 If you want to execute some command on all groups that have been marked
1710 with the process mark, you can use the @kbd{M-&}
1711 (@code{gnus-group-universal-argument}) command. It will prompt you for
1712 the command to be executed.
1715 @node Foreign Groups
1716 @section Foreign Groups
1717 @cindex foreign groups
1719 Below are some group mode commands for making and editing general foreign
1720 groups, as well as commands to ease the creation of a few
1721 special-purpose groups. All these commands insert the newly created
1722 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1729 @findex gnus-group-make-group
1730 @cindex making groups
1731 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
1732 for a name, a method and possibly an @dfn{address}. For an easier way
1733 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1737 @findex gnus-group-rename-group
1738 @cindex renaming groups
1739 Rename the current group to something else
1740 (@code{gnus-group-rename-group}). This is legal only on some
1741 groups---mail groups mostly. This command might very well be quite slow
1747 @findex gnus-group-customize
1748 Customize the group parameters (@code{gnus-group-customize}).
1752 @findex gnus-group-edit-group-method
1753 @cindex renaming groups
1754 Enter a buffer where you can edit the select method of the current
1755 group (@code{gnus-group-edit-group-method}).
1759 @findex gnus-group-edit-group-parameters
1760 Enter a buffer where you can edit the group parameters
1761 (@code{gnus-group-edit-group-parameters}).
1765 @findex gnus-group-edit-group
1766 Enter a buffer where you can edit the group info
1767 (@code{gnus-group-edit-group}).
1771 @findex gnus-group-make-directory-group
1773 Make a directory group (@pxref{Directory Groups}). You will be prompted
1774 for a directory name (@code{gnus-group-make-directory-group}).
1779 @findex gnus-group-make-help-group
1780 Make the Gnus help group (@code{gnus-group-make-help-group}).
1784 @cindex (ding) archive
1785 @cindex archive group
1786 @findex gnus-group-make-archive-group
1787 @vindex gnus-group-archive-directory
1788 @vindex gnus-group-recent-archive-directory
1789 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
1790 default a group pointing to the most recent articles will be created
1791 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1792 group will be created from @code{gnus-group-archive-directory}.
1796 @findex gnus-group-make-kiboze-group
1798 Make a kiboze group. You will be prompted for a name, for a regexp to
1799 match groups to be ``included'' in the kiboze group, and a series of
1800 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1801 @xref{Kibozed Groups}.
1805 @findex gnus-group-enter-directory
1807 Read an arbitrary directory as if with were a newsgroup with the
1808 @code{nneething} backend (@code{gnus-group-enter-directory}).
1809 @xref{Anything Groups}.
1813 @findex gnus-group-make-doc-group
1814 @cindex ClariNet Briefs
1816 Make a group based on some file or other
1817 (@code{gnus-group-make-doc-group}). If you give a prefix to this
1818 command, you will be prompted for a file name and a file type.
1819 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1820 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1821 @code{rfc934}, @code{rfc822-forward}, and @code{forward}. If you run
1822 this command without a prefix, Gnus will guess at the file type.
1823 @xref{Document Groups}.
1827 @findex gnus-group-make-web-group
1832 Make an ephemeral group based on a web search
1833 (@code{gnus-group-make-web-group}). If you give a prefix to this
1834 command, make a solid group instead. You will be prompted for the
1835 search engine type and the search string. Legal search engine types
1836 include @code{dejanews}, @code{altavista} and @code{reference}.
1837 @xref{Web Searches}.
1840 @kindex G DEL (Group)
1841 @findex gnus-group-delete-group
1842 This function will delete the current group
1843 (@code{gnus-group-delete-group}). If given a prefix, this function will
1844 actually delete all the articles in the group, and forcibly remove the
1845 group itself from the face of the Earth. Use a prefix only if you are
1846 absolutely sure of what you are doing.
1850 @findex gnus-group-make-empty-virtual
1851 Make a new, fresh, empty @code{nnvirtual} group
1852 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
1856 @findex gnus-group-add-to-virtual
1857 Add the current group to an @code{nnvirtual} group
1858 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
1861 @xref{Select Methods} for more information on the various select
1864 @vindex gnus-activate-foreign-newsgroups
1865 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1866 Gnus will check all foreign groups with this level or lower at startup.
1867 This might take quite a while, especially if you subscribe to lots of
1868 groups from different @sc{nntp} servers.
1871 @node Group Parameters
1872 @section Group Parameters
1873 @cindex group parameters
1875 The group parameters store information local to a particular group:
1880 If the group parameter list contains an element that looks like
1881 @code{(to-address . "some@@where.com")}, that address will be used by
1882 the backend when doing followups and posts. This is primarily useful in
1883 mail groups that represent closed mailing lists---mailing lists where
1884 it's expected that everybody that writes to the mailing list is
1885 subscribed to it. Since using this parameter ensures that the mail only
1886 goes to the mailing list itself, it means that members won't receive two
1887 copies of your followups.
1889 Using @code{to-address} will actually work whether the group is foreign
1890 or not. Let's say there's a group on the server that is called
1891 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
1892 the articles from a mail-to-news gateway. Posting directly to this
1893 group is therefore impossible---you have to send mail to the mailing
1894 list address instead.
1898 If the group parameter list has an element that looks like
1899 @code{(to-list . "some@@where.com")}, that address will be used when
1900 doing a @kbd{a} in any group. It is totally ignored when doing a
1901 followup---except that if it is present in a news group, you'll get mail
1902 group semantics when doing @kbd{f}.
1904 If you do an @kbd{a} command in a mail group and you don't have a
1905 @code{to-list} group parameter, one will be added automatically upon
1906 sending the message.
1908 @item broken-reply-to
1909 @cindex broken-reply-to
1910 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
1911 headers in this group are to be ignored. This can be useful if you're
1912 reading a mailing list group where the listserv has inserted
1913 @code{Reply-To} headers that point back to the listserv itself. This is
1914 broken behavior. So there!
1918 Elements like @code{(to-group . "some.group.name")} means that all
1919 posts in that group will be sent to @code{some.group.name}.
1923 If this symbol is present in the group parameter list, Gnus will treat
1924 all responses as if they were responses to news articles. This can be
1925 useful if you have a mail group that's really a mirror of a news group.
1929 If this symbol is present in the group parameter list and set to
1930 @code{t}, new composed messages will be @code{Gcc}'d to the current
1931 group. If it is present and set to @code{none}, no @code{Gcc:} header
1932 will be generated, if it is present and a string, this string will be
1933 inserted literally as a @code{gcc} header (this symbol takes precedence over
1934 any default @code{Gcc} rules as described later).
1938 If the group parameter has an element that looks like @code{(auto-expire
1939 . t)}, , all articles that are read will be marked as expirable. For an
1940 alternative approach, @pxref{Expiring Mail}.
1943 @cindex total-expire
1944 If the group parameter has an element that looks like
1945 @code{(total-expire . t)}, all read articles will be put through the
1946 expiry process, even if they are not marked as expirable. Use with
1951 @vindex nnmail-expiry-wait-function
1952 If the group parameter has an element that looks like @code{(expiry-wait
1953 . 10)}, this value will override any @code{nnmail-expiry-wait} and
1954 @code{nnmail-expiry-wait-function} when expiring expirable messages.
1955 The value can either be a number of days (not necessarily an integer) or
1956 the symbols @code{never} or @code{immediate}.
1959 @cindex score file group parameter
1960 Elements that look like @code{(score-file . "file")} will make
1961 @file{file} into the current score file for the group in question. This
1962 means that all score commands you issue will end up in that file.
1965 @cindex adapt file group parameter
1966 Elements that look like @code{(adapt-file . "file")} will make
1967 @file{file} into the current adaptive file for the group in question.
1968 All adaptive score entries will be put into this file.
1971 When unsubscribing to a mailing list you should never send the
1972 unsubscription notice to the mailing list itself. Instead, you'd send
1973 messages to the administrative address. This parameter allows you to
1974 put the admin address somewhere convenient.
1977 Elements that look like @code{(display . MODE)} says which articles to
1978 display on entering the group. Legal values are:
1982 Display all articles, both read and unread.
1985 Display the default visible articles, which normally includes unread and
1990 Elements that look like @code{(comment . "This is a comment")}
1991 are arbitrary comments on the group. They are currently ignored by
1992 Gnus, but provide a place for you to store information on particular
1995 @item @var{(variable form)}
1996 You can use the group parameters to set variables local to the group you
1997 are entering. If you want to turn threading off in @samp{news.answers},
1998 you could put @code{(gnus-show-threads nil)} in the group parameters of
1999 that group. @code{gnus-show-threads} will be made into a local variable
2000 in the summary buffer you enter, and the form @code{nil} will be
2001 @code{eval}ed there.
2003 This can also be used as a group-specific hook function, if you'd like.
2004 If you want to hear a beep when you enter a group, you could put
2005 something like @code{(dummy-variable (ding))} in the parameters of that
2006 group. @code{dummy-variable} will be set to the result of the
2007 @code{(ding)} form, but who cares?
2011 Use the @kbd{G p} command to edit group parameters of a group.
2013 Also @pxref{Topic Parameters}.
2015 Here's an example group parameter list:
2018 ((to-address . "ding@@gnus.org")
2023 @node Listing Groups
2024 @section Listing Groups
2025 @cindex group listing
2027 These commands all list various slices of the groups that are available.
2035 @findex gnus-group-list-groups
2036 List all groups that have unread articles
2037 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
2038 command will list only groups of level ARG and lower. By default, it
2039 only lists groups of level five (i. e.,
2040 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2047 @findex gnus-group-list-all-groups
2048 List all groups, whether they have unread articles or not
2049 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
2050 this command will list only groups of level ARG and lower. By default,
2051 it lists groups of level seven or lower (i.e., just subscribed and
2052 unsubscribed groups).
2056 @findex gnus-group-list-level
2057 List all unread groups on a specific level
2058 (@code{gnus-group-list-level}). If given a prefix, also list the groups
2059 with no unread articles.
2063 @findex gnus-group-list-killed
2064 List all killed groups (@code{gnus-group-list-killed}). If given a
2065 prefix argument, really list all groups that are available, but aren't
2066 currently (un)subscribed. This could entail reading the active file
2071 @findex gnus-group-list-zombies
2072 List all zombie groups (@code{gnus-group-list-zombies}).
2076 @findex gnus-group-list-matching
2077 List all unread, subscribed groups with names that match a regexp
2078 (@code{gnus-group-list-matching}).
2082 @findex gnus-group-list-all-matching
2083 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2087 @findex gnus-group-list-active
2088 List absolutely all groups that are in the active file(s) of the
2089 server(s) you are connected to (@code{gnus-group-list-active}). This
2090 might very well take quite a while. It might actually be a better idea
2091 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2092 thing to match on. Also note that this command may list group that
2093 don't exist (yet)---these will be listed as if they are killed groups.
2094 Take the output with some grains of salt.
2098 @findex gnus-group-apropos
2099 List all groups that have names that match a regexp
2100 (@code{gnus-group-apropos}).
2104 @findex gnus-group-description-apropos
2105 List all groups that have names or descriptions that match a regexp
2106 (@code{gnus-group-description-apropos}).
2110 @vindex gnus-permanently-visible-groups
2111 @cindex visible group parameter
2112 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2113 always be shown, whether they have unread articles or not. You can also
2114 add the @code{visible} element to the group parameters in question to
2115 get the same effect.
2117 @vindex gnus-list-groups-with-ticked-articles
2118 Groups that have just ticked articles in it are normally listed in the
2119 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
2120 @code{nil}, these groups will be treated just like totally empty
2121 groups. It is @code{t} by default.
2124 @node Sorting Groups
2125 @section Sorting Groups
2126 @cindex sorting groups
2128 @kindex C-c C-s (Group)
2129 @findex gnus-group-sort-groups
2130 @vindex gnus-group-sort-function
2131 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2132 group buffer according to the function(s) given by the
2133 @code{gnus-group-sort-function} variable. Available sorting functions
2138 @item gnus-group-sort-by-alphabet
2139 @findex gnus-group-sort-by-alphabet
2140 Sort the group names alphabetically. This is the default.
2142 @item gnus-group-sort-by-real-name
2143 @findex gnus-group-sort-by-real-name
2144 Sort the group alphabetically on the real (unprefixed) group names.
2146 @item gnus-group-sort-by-level
2147 @findex gnus-group-sort-by-level
2148 Sort by group level.
2150 @item gnus-group-sort-by-score
2151 @findex gnus-group-sort-by-score
2152 Sort by group score.
2154 @item gnus-group-sort-by-rank
2155 @findex gnus-group-sort-by-rank
2156 Sort by group score and then the group level. The level and the score
2157 are, when taken together, the group's @dfn{rank}.
2159 @item gnus-group-sort-by-unread
2160 @findex gnus-group-sort-by-unread
2161 Sort by number of unread articles.
2163 @item gnus-group-sort-by-method
2164 @findex gnus-group-sort-by-method
2165 Sort alphabetically on the select method.
2170 @code{gnus-group-sort-function} can also be a list of sorting
2171 functions. In that case, the most significant sort key function must be
2175 There are also a number of commands for sorting directly according to
2176 some sorting criteria:
2180 @kindex G S a (Group)
2181 @findex gnus-group-sort-groups-by-alphabet
2182 Sort the group buffer alphabetically by group name
2183 (@code{gnus-group-sort-groups-by-alphabet}).
2186 @kindex G S u (Group)
2187 @findex gnus-group-sort-groups-by-unread
2188 Sort the group buffer by the number of unread articles
2189 (@code{gnus-group-sort-groups-by-unread}).
2192 @kindex G S l (Group)
2193 @findex gnus-group-sort-groups-by-level
2194 Sort the group buffer by group level
2195 (@code{gnus-group-sort-groups-by-level}).
2198 @kindex G S v (Group)
2199 @findex gnus-group-sort-groups-by-score
2200 Sort the group buffer by group score
2201 (@code{gnus-group-sort-groups-by-score}).
2204 @kindex G S r (Group)
2205 @findex gnus-group-sort-groups-by-rank
2206 Sort the group buffer by group rank
2207 (@code{gnus-group-sort-groups-by-rank}).
2210 @kindex G S m (Group)
2211 @findex gnus-group-sort-groups-by-method
2212 Sort the group buffer alphabetically by backend name
2213 (@code{gnus-group-sort-groups-by-method}).
2217 When given a prefix, all these commands will sort in reverse order.
2219 You can also sort a subset of the groups:
2223 @kindex G P a (Group)
2224 @findex gnus-group-sort-selected-groups-by-alphabet
2225 Sort the process/prefixed groups in the group buffer alphabetically by
2226 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2229 @kindex G P u (Group)
2230 @findex gnus-group-sort-selected-groups-by-unread
2231 Sort the process/prefixed groups in the group buffer by the number of
2232 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2235 @kindex G P l (Group)
2236 @findex gnus-group-sort-selected-groups-by-level
2237 Sort the process/prefixed groups in the group buffer by group level
2238 (@code{gnus-group-sort-selected-groups-by-level}).
2241 @kindex G P v (Group)
2242 @findex gnus-group-sort-selected-groups-by-score
2243 Sort the process/prefixed groups in the group buffer by group score
2244 (@code{gnus-group-sort-selected-groups-by-score}).
2247 @kindex G P r (Group)
2248 @findex gnus-group-sort-selected-groups-by-rank
2249 Sort the process/prefixed groups in the group buffer by group rank
2250 (@code{gnus-group-sort-selected-groups-by-rank}).
2253 @kindex G P m (Group)
2254 @findex gnus-group-sort-selected-groups-by-method
2255 Sort the process/prefixed groups in the group buffer alphabetically by
2256 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2262 @node Group Maintenance
2263 @section Group Maintenance
2264 @cindex bogus groups
2269 @findex gnus-group-check-bogus-groups
2270 Find bogus groups and delete them
2271 (@code{gnus-group-check-bogus-groups}).
2275 @findex gnus-find-new-newsgroups
2276 Find new groups and process them (@code{gnus-find-new-newsgroups}). If
2277 given a prefix, use the @code{ask-server} method to query the server for
2281 @kindex C-c C-x (Group)
2282 @findex gnus-group-expire-articles
2283 Run all expirable articles in the current group through the expiry
2284 process (if any) (@code{gnus-group-expire-articles}).
2287 @kindex C-c M-C-x (Group)
2288 @findex gnus-group-expire-all-groups
2289 Run all articles in all groups through the expiry process
2290 (@code{gnus-group-expire-all-groups}).
2295 @node Browse Foreign Server
2296 @section Browse Foreign Server
2297 @cindex foreign servers
2298 @cindex browsing servers
2303 @findex gnus-group-browse-foreign-server
2304 You will be queried for a select method and a server name. Gnus will
2305 then attempt to contact this server and let you browse the groups there
2306 (@code{gnus-group-browse-foreign-server}).
2309 @findex gnus-browse-mode
2310 A new buffer with a list of available groups will appear. This buffer
2311 will be use the @code{gnus-browse-mode}. This buffer looks a bit (well,
2312 a lot) like a normal group buffer.
2314 Here's a list of keystrokes available in the browse mode:
2319 @findex gnus-group-next-group
2320 Go to the next group (@code{gnus-group-next-group}).
2324 @findex gnus-group-prev-group
2325 Go to the previous group (@code{gnus-group-prev-group}).
2328 @kindex SPACE (Browse)
2329 @findex gnus-browse-read-group
2330 Enter the current group and display the first article
2331 (@code{gnus-browse-read-group}).
2334 @kindex RET (Browse)
2335 @findex gnus-browse-select-group
2336 Enter the current group (@code{gnus-browse-select-group}).
2340 @findex gnus-browse-unsubscribe-current-group
2341 Unsubscribe to the current group, or, as will be the case here,
2342 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2348 @findex gnus-browse-exit
2349 Exit browse mode (@code{gnus-browse-exit}).
2353 @findex gnus-browse-describe-briefly
2354 Describe browse mode briefly (well, there's not much to describe, is
2355 there) (@code{gnus-browse-describe-briefly}).
2360 @section Exiting Gnus
2361 @cindex exiting Gnus
2363 Yes, Gnus is ex(c)iting.
2368 @findex gnus-group-suspend
2369 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
2370 but it kills all buffers except the Group buffer. I'm not sure why this
2371 is a gain, but then who am I to judge?
2375 @findex gnus-group-exit
2376 Quit Gnus (@code{gnus-group-exit}).
2380 @findex gnus-group-quit
2381 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2382 The dribble file will be saved, though (@pxref{Auto Save}).
2385 @vindex gnus-exit-gnus-hook
2386 @vindex gnus-suspend-gnus-hook
2387 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2388 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2389 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2394 If you wish to completely unload Gnus and all its adherents, you can use
2395 the @code{gnus-unload} command. This command is also very handy when
2396 trying to customize meta-variables.
2401 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2402 numbly heavy and herself fall into a hazy trance as the boy sitting
2403 behind her drew repeated lines with his pencil across the back of her
2409 @section Group Topics
2412 If you read lots and lots of groups, it might be convenient to group
2413 them hierarchically according to topics. You put your Emacs groups over
2414 here, your sex groups over there, and the rest (what, two groups or so?)
2415 you put in some misc section that you never bother with anyway. You can
2416 even group the Emacs sex groups as a sub-topic to either the Emacs
2417 groups or the sex groups---or both! Go wild!
2425 2: alt.religion.emacs
2428 0: comp.talk.emacs.recovery
2430 8: comp.binaries.fractals
2431 13: comp.sources.unix
2434 @findex gnus-topic-mode
2436 To get this @emph{fab} functionality you simply turn on (ooh!) the
2437 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
2438 is a toggling command.)
2440 Go ahead, just try it. I'll still be here when you get back. La de
2441 dum... Nice tune, that... la la la... What, you're back? Yes, and now
2442 press @kbd{l}. There. All your groups are now listed under
2443 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
2446 If you want this permanently enabled, you should add that minor mode to
2447 the hook for the group mode:
2450 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2454 * Topic Variables:: How to customize the topics the Lisp Way.
2455 * Topic Commands:: Interactive E-Z commands.
2456 * Topic Sorting:: Sorting each topic individually.
2457 * Topic Topology:: A map of the world.
2458 * Topic Parameters:: Parameters that apply to all groups in a topic.
2462 @node Topic Variables
2463 @subsection Topic Variables
2464 @cindex topic variables
2466 Now, if you select a topic, if will fold/unfold that topic, which is
2467 really neat, I think.
2469 @vindex gnus-topic-line-format
2470 The topic lines themselves are created according to the
2471 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2484 Number of groups in the topic.
2486 Number of unread articles in the topic.
2488 Number of unread articles in the topic and all its subtopics.
2491 @vindex gnus-topic-indent-level
2492 Each sub-topic (and the groups in the sub-topics) will be indented with
2493 @code{gnus-topic-indent-level} times the topic level number of spaces.
2496 @vindex gnus-topic-mode-hook
2497 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2499 @vindex gnus-topic-display-empty-topics
2500 The @code{gnus-topic-display-empty-topics} says whether to display even
2501 topics that have no unread articles in them. The default is @code{t}.
2504 @node Topic Commands
2505 @subsection Topic Commands
2506 @cindex topic commands
2508 When the topic minor mode is turned on, a new @kbd{T} submap will be
2509 available. In addition, a few of the standard keys change their
2510 definitions slightly.
2516 @findex gnus-topic-create-topic
2517 Prompt for a new topic name and create it
2518 (@code{gnus-topic-create-topic}).
2522 @findex gnus-topic-move-group
2523 Move the current group to some other topic
2524 (@code{gnus-topic-move-group}). This command uses the process/prefix
2525 convention (@pxref{Process/Prefix}).
2529 @findex gnus-topic-copy-group
2530 Copy the current group to some other topic
2531 (@code{gnus-topic-copy-group}). This command uses the process/prefix
2532 convention (@pxref{Process/Prefix}).
2536 @findex gnus-topic-remove-group
2537 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2538 This command uses the process/prefix convention
2539 (@pxref{Process/Prefix}).
2543 @findex gnus-topic-move-matching
2544 Move all groups that match some regular expression to a topic
2545 (@code{gnus-topic-move-matching}).
2549 @findex gnus-topic-copy-matching
2550 Copy all groups that match some regular expression to a topic
2551 (@code{gnus-topic-copy-matching}).
2555 @findex gnus-topic-mark-topic
2556 Mark all groups in the current topic with the process mark
2557 (@code{gnus-topic-mark-topic}).
2560 @kindex T M-# (Topic)
2561 @findex gnus-topic-unmark-topic
2562 Remove the process mark from all groups in the current topic
2563 (@code{gnus-topic-unmark-topic}).
2567 @findex gnus-topic-select-group
2569 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2570 When you perform this command on a group, you'll enter the group, as
2571 usual. When done on a topic line, the topic will be folded (if it was
2572 visible) or unfolded (if it was folded already). So it's basically a
2573 toggling command on topics. In addition, if you give a numerical
2574 prefix, group on that level (and lower) will be displayed.
2577 @kindex T TAB (Topic)
2578 @findex gnus-topic-indent
2579 ``Indent'' the current topic so that it becomes a sub-topic of the
2580 previous topic (@code{gnus-topic-indent}). If given a prefix,
2581 ``un-indent'' the topic instead.
2585 @findex gnus-topic-kill-group
2586 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
2587 topic will be removed along with the topic.
2591 @findex gnus-topic-yank-group
2592 Yank the previously killed group or topic
2593 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
2598 @findex gnus-topic-rename
2599 Rename a topic (@code{gnus-topic-rename}).
2602 @kindex T DEL (Topic)
2603 @findex gnus-topic-delete
2604 Delete an empty topic (@code{gnus-topic-delete}).
2608 @findex gnus-topic-list-active
2609 List all groups that Gnus knows about in a topics-ified way
2610 (@code{gnus-topic-list-active}).
2614 @findex gnus-topic-edit-parameters
2615 @cindex group parameters
2616 @cindex topic parameters
2618 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2619 @xref{Topic Parameters}.
2625 @subsection Topic Sorting
2626 @cindex topic sorting
2628 You can sort the groups in each topic individually with the following
2634 @kindex T S a (Topic)
2635 @findex gnus-topic-sort-groups-by-alphabet
2636 Sort the current topic alphabetically by group name
2637 (@code{gnus-topic-sort-groups-by-alphabet}).
2640 @kindex T S u (Topic)
2641 @findex gnus-topic-sort-groups-by-unread
2642 Sort the current topic by the number of unread articles
2643 (@code{gnus-topic-sort-groups-by-unread}).
2646 @kindex T S l (Topic)
2647 @findex gnus-topic-sort-groups-by-level
2648 Sort the current topic by group level
2649 (@code{gnus-topic-sort-groups-by-level}).
2652 @kindex T S v (Topic)
2653 @findex gnus-topic-sort-groups-by-score
2654 Sort the current topic by group score
2655 (@code{gnus-topic-sort-groups-by-score}).
2658 @kindex T S r (Topic)
2659 @findex gnus-topic-sort-groups-by-rank
2660 Sort the current topic by group rank
2661 (@code{gnus-topic-sort-groups-by-rank}).
2664 @kindex T S m (Topic)
2665 @findex gnus-topic-sort-groups-by-method
2666 Sort the current topic alphabetically by backend name
2667 (@code{gnus-topic-sort-groups-by-method}).
2671 @xref{Sorting Groups} for more information about group sorting.
2674 @node Topic Topology
2675 @subsection Topic Topology
2676 @cindex topic topology
2679 So, let's have a look at an example group buffer:
2685 2: alt.religion.emacs
2688 0: comp.talk.emacs.recovery
2690 8: comp.binaries.fractals
2691 13: comp.sources.unix
2694 So, here we have one top-level topic (@samp{Gnus}), two topics under
2695 that, and one sub-topic under one of the sub-topics. (There is always
2696 just one (1) top-level topic). This topology can be expressed as
2701 (("Emacs -- I wuw it!" visible)
2702 (("Naughty Emacs" visible)))
2706 @vindex gnus-topic-topology
2707 This is in fact how the variable @code{gnus-topic-topology} would look
2708 for the display above. That variable is saved in the @file{.newsrc.eld}
2709 file, and shouldn't be messed with manually---unless you really want
2710 to. Since this variable is read from the @file{.newsrc.eld} file,
2711 setting it in any other startup files will have no effect.
2713 This topology shows what topics are sub-topics of what topics (right),
2714 and which topics are visible. Two settings are currently
2715 allowed---@code{visible} and @code{invisible}.
2718 @node Topic Parameters
2719 @subsection Topic Parameters
2720 @cindex topic parameters
2722 All groups in a topic will inherit group parameters from the parent (and
2723 ancestor) topic parameters. All legal group parameters are legal topic
2724 parameters (@pxref{Group Parameters}).
2726 Group parameters (of course) override topic parameters, and topic
2727 parameters in sub-topics override topic parameters in super-topics. You
2728 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
2729 verb, although you may feel free to disagree with me here.)
2735 2: alt.religion.emacs
2739 0: comp.talk.emacs.recovery
2741 8: comp.binaries.fractals
2742 13: comp.sources.unix
2746 The @samp{Emacs} topic has the topic parameter @code{(score-file
2747 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2748 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2749 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
2750 @samp{alt.religion.emacs} has the group parameter @code{(score-file
2751 . "religion.SCORE")}.
2753 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2754 will get the @file{relief.SCORE} home score file. If you enter the same
2755 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2756 score file. If you enter the group @samp{alt.religion.emacs}, you'll
2757 get the @file{religion.SCORE} home score file.
2759 This seems rather simple and self-evident, doesn't it? Well, yes. But
2760 there are some problems, especially with the @code{total-expiry}
2761 parameter. Say you have a mail group in two topics; one with
2762 @code{total-expiry} and one without. What happens when you do @kbd{M-x
2763 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
2764 of these topics you mean to expire articles from, so anything may
2765 happen. In fact, I hereby declare that it is @dfn{undefined} what
2766 happens. You just have to be careful if you do stuff like that.
2769 @node Misc Group Stuff
2770 @section Misc Group Stuff
2773 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2774 * Group Information:: Information and help on groups and Gnus.
2775 * Group Timestamp:: Making Gnus keep track of when you last read a group.
2776 * File Commands:: Reading and writing the Gnus files.
2783 @findex gnus-group-enter-server-mode
2784 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2785 @xref{The Server Buffer}.
2789 @findex gnus-group-post-news
2790 Post an article to a group (@code{gnus-group-post-news}). The current
2791 group name will be used as the default.
2795 @findex gnus-group-mail
2796 Mail a message somewhere (@code{gnus-group-mail}).
2800 Variables for the group buffer:
2804 @item gnus-group-mode-hook
2805 @vindex gnus-group-mode-hook
2806 @code{gnus-group-mode-hook} is called after the group buffer has been
2809 @item gnus-group-prepare-hook
2810 @vindex gnus-group-prepare-hook
2811 @code{gnus-group-prepare-hook} is called after the group buffer is
2812 generated. It may be used to modify the buffer in some strange,
2815 @item gnus-permanently-visible-groups
2816 @vindex gnus-permanently-visible-groups
2817 Groups matching this regexp will always be listed in the group buffer,
2818 whether they are empty or not.
2823 @node Scanning New Messages
2824 @subsection Scanning New Messages
2825 @cindex new messages
2826 @cindex scanning new news
2832 @findex gnus-group-get-new-news
2833 Check the server(s) for new articles. If the numerical prefix is used,
2834 this command will check only groups of level @var{arg} and lower
2835 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
2836 command will force a total rereading of the active file(s) from the
2841 @findex gnus-group-get-new-news-this-group
2842 @vindex gnus-goto-next-group-when-activating
2843 Check whether new articles have arrived in the current group
2844 (@code{gnus-group-get-new-news-this-group}).
2845 @code{gnus-goto-next-group-when-activating} says whether this command is
2846 to move point to the next group or not. It is @code{t} by default.
2848 @findex gnus-activate-all-groups
2849 @cindex activating groups
2851 @kindex C-c M-g (Group)
2852 Activate absolutely all groups (@code{gnus-activate-all-groups}).
2857 @findex gnus-group-restart
2858 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
2859 file(s), closes the connection to all servers, clears up all run-time
2860 Gnus variables, and then starts Gnus all over again.
2864 @vindex gnus-get-new-news-hook
2865 @code{gnus-get-new-news-hook} is run just before checking for new news.
2867 @vindex gnus-after-getting-new-news-hook
2868 @code{gnus-after-getting-new-news-hook} is run after checking for new
2872 @node Group Information
2873 @subsection Group Information
2874 @cindex group information
2875 @cindex information on groups
2882 @findex gnus-group-fetch-faq
2883 @vindex gnus-group-faq-directory
2886 Try to fetch the FAQ for the current group
2887 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
2888 @code{gnus-group-faq-directory}, which is usually a directory on a
2889 remote machine. This variable can also be a list of directories. In
2890 that case, giving a prefix to this command will allow you to choose
2891 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
2892 for fetching the file.
2894 If fetching from the first site is unsuccessful, Gnus will attempt to go
2895 through @code{gnus-group-faq-directory} and try to open them one by one.
2900 @kindex C-c C-d (Group)
2901 @cindex describing groups
2902 @cindex group description
2903 @findex gnus-group-describe-group
2904 Describe the current group (@code{gnus-group-describe-group}). If given
2905 a prefix, force Gnus to re-read the description from the server.
2909 @findex gnus-group-describe-all-groups
2910 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
2911 prefix, force Gnus to re-read the description file from the server.
2918 @findex gnus-version
2919 Display current Gnus version numbers (@code{gnus-version}).
2923 @findex gnus-group-describe-briefly
2924 Give a very short help message (@code{gnus-group-describe-briefly}).
2927 @kindex C-c C-i (Group)
2930 @findex gnus-info-find-node
2931 Go to the Gnus info node (@code{gnus-info-find-node}).
2935 @node Group Timestamp
2936 @subsection Group Timestamp
2938 @cindex group timestamps
2940 It can be convenient to let Gnus keep track of when you last read a
2941 group. To set the ball rolling, you should add
2942 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
2945 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
2948 After doing this, each time you enter a group, it'll be recorded.
2950 This information can be displayed in various ways---the easiest is to
2951 use the @samp{%d} spec in the group line format:
2954 (setq gnus-group-line-format
2955 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
2958 This will result in lines looking like:
2961 * 0: mail.ding 19961002T012943
2962 0: custom 19961002T012713
2965 As you can see, the date is displayed in compact ISO 8601 format. This
2966 may be a bit too much, so to just display the date, you could say
2970 (setq gnus-group-line-format
2971 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
2976 @subsection File Commands
2977 @cindex file commands
2983 @findex gnus-group-read-init-file
2984 @vindex gnus-init-file
2985 @cindex reading init file
2986 Re-read the init file (@code{gnus-init-file}, which defaults to
2987 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
2991 @findex gnus-group-save-newsrc
2992 @cindex saving .newsrc
2993 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
2994 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
2995 file(s) whether Gnus thinks it is necessary or not.
2998 @c @kindex Z (Group)
2999 @c @findex gnus-group-clear-dribble
3000 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3005 @node The Summary Buffer
3006 @chapter The Summary Buffer
3007 @cindex summary buffer
3009 A line for each article is displayed in the summary buffer. You can
3010 move around, read articles, post articles and reply to articles.
3012 The most common way to a summary buffer is to select a group from the
3013 group buffer (@pxref{Selecting a Group}).
3015 You can have as many summary buffers open as you wish.
3018 * Summary Buffer Format:: Deciding how the summary buffer is to look.
3019 * Summary Maneuvering:: Moving around the summary buffer.
3020 * Choosing Articles:: Reading articles.
3021 * Paging the Article:: Scrolling the current article.
3022 * Reply Followup and Post:: Posting articles.
3023 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
3024 * Marking Articles:: Marking articles as read, expirable, etc.
3025 * Limiting:: You can limit the summary buffer.
3026 * Threading:: How threads are made.
3027 * Sorting:: How articles and threads are sorted.
3028 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
3029 * Article Caching:: You may store articles in a cache.
3030 * Persistent Articles:: Making articles expiry-resistant.
3031 * Article Backlog:: Having already read articles hang around.
3032 * Saving Articles:: Ways of customizing article saving.
3033 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
3034 * Article Treatment:: The article buffer can be mangled at will.
3035 * Article Commands:: Doing various things with the article buffer.
3036 * Summary Sorting:: Sorting the summary buffer in various ways.
3037 * Finding the Parent:: No child support? Get the parent.
3038 * Alternative Approaches:: Reading using non-default summaries.
3039 * Tree Display:: A more visual display of threads.
3040 * Mail Group Commands:: Some commands can only be used in mail groups.
3041 * Various Summary Stuff:: What didn't fit anywhere else.
3042 * Exiting the Summary Buffer:: Returning to the Group buffer.
3043 * Crosspost Handling:: How crossposted articles are dealt with.
3044 * Duplicate Suppression:: An alternative when crosspost handling fails.
3048 @node Summary Buffer Format
3049 @section Summary Buffer Format
3050 @cindex summary buffer format
3053 * Summary Buffer Lines:: You can specify how summary lines should look.
3054 * Summary Buffer Mode Line:: You can say how the mode line should look.
3055 * Summary Highlighting:: Making the summary buffer all pretty and nice.
3058 @findex mail-extract-address-components
3059 @findex gnus-extract-address-components
3060 @vindex gnus-extract-address-components
3061 Gnus will use the value of the @code{gnus-extract-address-components}
3062 variable as a function for getting the name and address parts of a
3063 @code{From} header. Two pre-defined function exist:
3064 @code{gnus-extract-address-components}, which is the default, quite
3065 fast, and too simplistic solution; and
3066 @code{mail-extract-address-components}, which works very nicely, but is
3067 slower. The default function will return the wrong answer in 5% of the
3068 cases. If this is unacceptable to you, use the other function instead.
3070 @vindex gnus-summary-same-subject
3071 @code{gnus-summary-same-subject} is a string indicating that the current
3072 article has the same subject as the previous. This string will be used
3073 with those specs that require it. The default is @samp{}.
3076 @node Summary Buffer Lines
3077 @subsection Summary Buffer Lines
3079 @vindex gnus-summary-line-format
3080 You can change the format of the lines in the summary buffer by changing
3081 the @code{gnus-summary-line-format} variable. It works along the same
3082 lines a a normal @code{format} string, with some extensions
3083 (@pxref{Formatting Variables}).
3085 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3087 The following format specification characters are understood:
3095 Subject if the article is the root or the previous article had a
3096 different subject, @code{gnus-summary-same-subject} otherwise.
3097 (@code{gnus-summary-same-subject} defaults to @samp{}.)
3099 Full @code{From} header.
3101 The name (from the @code{From} header).
3103 The name (from the @code{From} header). This differs from the @code{n}
3104 spec in that it uses the function designated by the
3105 @code{gnus-extract-address-components} variable, which is slower, but
3106 may be more thorough.
3108 The address (from the @code{From} header). This works the same way as
3111 Number of lines in the article.
3113 Number of characters in the article.
3115 Indentation based on thread level (@pxref{Customizing Threading}).
3117 Nothing if the article is a root and lots of spaces if it isn't (it
3118 pushes everything after it off the screen).
3120 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3121 for adopted articles (@pxref{Customizing Threading}).
3123 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3124 for adopted articles.
3126 One space for each thread level.
3128 Twenty minus thread level spaces.
3136 @vindex gnus-summary-zcore-fuzz
3137 Zcore, @samp{+} if above the default level and @samp{-} if below the
3138 default level. If the difference between
3139 @code{gnus-summary-default-level} and the score is less than
3140 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3148 The @code{Date} in @code{DD-MMM} format.
3150 The @code{Date} in @code{YYYYMMDDTHHMMSS} format.
3156 Number of articles in the current sub-thread. Using this spec will slow
3157 down summary buffer generation somewhat.
3159 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3160 article has any children.
3164 User defined specifier. The next character in the format string should
3165 be a letter. @sc{gnus} will call the function
3166 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3167 following @samp{%u}. The function will be passed the current header as
3168 argument. The function should return a string, which will be inserted
3169 into the summary just like information from any other summary specifier.
3172 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3173 have to be handled with care. For reasons of efficiency, Gnus will
3174 compute what column these characters will end up in, and ``hard-code''
3175 that. This means that it is illegal to have these specs after a
3176 variable-length spec. Well, you might not be arrested, but your summary
3177 buffer will look strange, which is bad enough.
3179 The smart choice is to have these specs as far to the left as possible.
3180 (Isn't that the case with everything, though? But I digress.)
3182 This restriction may disappear in later versions of Gnus.
3185 @node Summary Buffer Mode Line
3186 @subsection Summary Buffer Mode Line
3188 @vindex gnus-summary-mode-line-format
3189 You can also change the format of the summary mode bar. Set
3190 @code{gnus-summary-mode-line-format} to whatever you like. The default
3191 is @samp{Gnus: %%b [%A] %Z}.
3193 Here are the elements you can play with:
3199 Unprefixed group name.
3201 Current article number.
3205 Number of unread articles in this group.
3207 Number of unselected articles in this group.
3209 A string with the number of unread and unselected articles represented
3210 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3211 articles, and just as @samp{<%U more>} if there are just unread articles
3212 and no unselected ones.
3214 Shortish group name. For instance, @samp{rec.arts.anime} will be
3215 shortened to @samp{r.a.anime}.
3217 Subject of the current article.
3221 Name of the current score file.
3223 Number of dormant articles.
3225 Number of ticked articles.
3227 Number of articles that have been marked as read in this session.
3229 Number of articles expunged by the score files.
3233 @node Summary Highlighting
3234 @subsection Summary Highlighting
3238 @item gnus-visual-mark-article-hook
3239 @vindex gnus-visual-mark-article-hook
3240 This hook is run after selecting an article. It is meant to be used for
3241 highlighting the article in some way. It is not run if
3242 @code{gnus-visual} is @code{nil}.
3244 @item gnus-summary-update-hook
3245 @vindex gnus-summary-update-hook
3246 This hook is called when a summary line is changed. It is not run if
3247 @code{gnus-visual} is @code{nil}.
3249 @item gnus-summary-selected-face
3250 @vindex gnus-summary-selected-face
3251 This is the face (or @dfn{font} as some people call it) that is used to
3252 highlight the current article in the summary buffer.
3254 @item gnus-summary-highlight
3255 @vindex gnus-summary-highlight
3256 Summary lines are highlighted according to this variable, which is a
3257 list where the elements are on the format @var{(FORM . FACE)}. If you
3258 would, for instance, like ticked articles to be italic and high-scored
3259 articles to be bold, you could set this variable to something like
3261 (((eq mark gnus-ticked-mark) . italic)
3262 ((> score default) . bold))
3264 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3265 @var{FACE} will be applied to the line.
3269 @node Summary Maneuvering
3270 @section Summary Maneuvering
3271 @cindex summary movement
3273 All the straight movement commands understand the numeric prefix and
3274 behave pretty much as you'd expect.
3276 None of these commands select articles.
3281 @kindex M-n (Summary)
3282 @kindex G M-n (Summary)
3283 @findex gnus-summary-next-unread-subject
3284 Go to the next summary line of an unread article
3285 (@code{gnus-summary-next-unread-subject}).
3289 @kindex M-p (Summary)
3290 @kindex G M-p (Summary)
3291 @findex gnus-summary-prev-unread-subject
3292 Go to the previous summary line of an unread article
3293 (@code{gnus-summary-prev-unread-subject}).
3298 @kindex G j (Summary)
3299 @findex gnus-summary-goto-article
3300 Ask for an article number and then go to that article
3301 (@code{gnus-summary-goto-article}).
3304 @kindex G g (Summary)
3305 @findex gnus-summary-goto-subject
3306 Ask for an article number and then go the summary line of that article
3307 without displaying the article (@code{gnus-summary-goto-subject}).
3310 If Gnus asks you to press a key to confirm going to the next group, you
3311 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3312 buffer, searching for the next group to read without actually returning
3313 to the group buffer.
3315 Variables related to summary movement:
3319 @vindex gnus-auto-select-next
3320 @item gnus-auto-select-next
3321 If you issue one of the movement commands (like @kbd{n}) and there are
3322 no more unread articles after the current one, Gnus will offer to go to
3323 the next group. If this variable is @code{t} and the next group is
3324 empty, Gnus will exit summary mode and return to the group buffer. If
3325 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3326 next group, no matter whether it has any unread articles or not. As a
3327 special case, if this variable is @code{quietly}, Gnus will select the
3328 next group without asking for confirmation. If this variable is
3329 @code{almost-quietly}, the same will happen only if you are located on
3330 the last article in the group. Finally, if this variable is
3331 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3332 without confirmation. Also @pxref{Group Levels}.
3334 @item gnus-auto-select-same
3335 @vindex gnus-auto-select-same
3336 If non-@code{nil}, all the movement commands will try to go to the next
3337 article with the same subject as the current. (@dfn{Same} here might
3338 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
3339 for details (@pxref{Customizing Threading}).) This variable is not
3340 particularly useful if you use a threaded display.
3342 @item gnus-summary-check-current
3343 @vindex gnus-summary-check-current
3344 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3345 to the next (or previous) article if the current article is unread.
3346 Instead, they will choose the current article.
3348 @item gnus-auto-center-summary
3349 @vindex gnus-auto-center-summary
3350 If non-@code{nil}, Gnus will keep the point in the summary buffer
3351 centered at all times. This makes things quite tidy, but if you have a
3352 slow network connection, or simply do not like this un-Emacsism, you can
3353 set this variable to @code{nil} to get the normal Emacs scrolling
3354 action. This will also inhibit horizontal re-centering of the summary
3355 buffer, which might make it more inconvenient to read extremely long
3361 @node Choosing Articles
3362 @section Choosing Articles
3363 @cindex selecting articles
3366 * Choosing Commands:: Commands for choosing articles.
3367 * Choosing Variables:: Variables that influence these commands.
3371 @node Choosing Commands
3372 @subsection Choosing Commands
3374 None of the following movement commands understand the numeric prefix,
3375 and they all select and display an article.
3379 @kindex SPACE (Summary)
3380 @findex gnus-summary-next-page
3381 Select the current article, or, if that one's read already, the next
3382 unread article (@code{gnus-summary-next-page}).
3387 @kindex G n (Summary)
3388 @findex gnus-summary-next-unread-article
3389 Go to next unread article (@code{gnus-summary-next-unread-article}).
3394 @findex gnus-summary-prev-unread-article
3395 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3400 @kindex G N (Summary)
3401 @findex gnus-summary-next-article
3402 Go to the next article (@code{gnus-summary-next-article}).
3407 @kindex G P (Summary)
3408 @findex gnus-summary-prev-article
3409 Go to the previous article (@code{gnus-summary-prev-article}).
3412 @kindex G C-n (Summary)
3413 @findex gnus-summary-next-same-subject
3414 Go to the next article with the same subject
3415 (@code{gnus-summary-next-same-subject}).
3418 @kindex G C-p (Summary)
3419 @findex gnus-summary-prev-same-subject
3420 Go to the previous article with the same subject
3421 (@code{gnus-summary-prev-same-subject}).
3425 @kindex G f (Summary)
3427 @findex gnus-summary-first-unread-article
3428 Go to the first unread article
3429 (@code{gnus-summary-first-unread-article}).
3433 @kindex G b (Summary)
3435 @findex gnus-summary-best-unread-article
3436 Go to the article with the highest score
3437 (@code{gnus-summary-best-unread-article}).
3442 @kindex G l (Summary)
3443 @findex gnus-summary-goto-last-article
3444 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3447 @kindex G p (Summary)
3448 @findex gnus-summary-pop-article
3449 Pop an article off the summary history and go to this article
3450 (@code{gnus-summary-pop-article}). This command differs from the
3451 command above in that you can pop as many previous articles off the
3452 history as you like.
3456 @node Choosing Variables
3457 @subsection Choosing Variables
3459 Some variables that are relevant for moving and selecting articles:
3462 @item gnus-auto-extend-newsgroup
3463 @vindex gnus-auto-extend-newsgroup
3464 All the movement commands will try to go to the previous (or next)
3465 article, even if that article isn't displayed in the Summary buffer if
3466 this variable is non-@code{nil}. Gnus will then fetch the article from
3467 the server and display it in the article buffer.
3469 @item gnus-select-article-hook
3470 @vindex gnus-select-article-hook
3471 This hook is called whenever an article is selected. By default it
3472 exposes any threads hidden under the selected article.
3474 @item gnus-mark-article-hook
3475 @vindex gnus-mark-article-hook
3476 @findex gnus-summary-mark-unread-as-read
3477 @findex gnus-summary-mark-read-and-unread-as-read
3478 @findex gnus-unread-mark
3479 This hook is called whenever an article is selected. It is intended to
3480 be used for marking articles as read. The default value is
3481 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3482 mark of almost any article you read to @code{gnus-unread-mark}. The
3483 only articles not affected by this function are ticked, dormant, and
3484 expirable articles. If you'd instead like to just have unread articles
3485 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3486 instead. It will leave marks like @code{gnus-low-score-mark},
3487 @code{gnus-del-mark} (and so on) alone.
3492 @node Paging the Article
3493 @section Scrolling the Article
3494 @cindex article scrolling
3499 @kindex SPACE (Summary)
3500 @findex gnus-summary-next-page
3501 Pressing @kbd{SPACE} will scroll the current article forward one page,
3502 or, if you have come to the end of the current article, will choose the
3503 next article (@code{gnus-summary-next-page}).
3506 @kindex DEL (Summary)
3507 @findex gnus-summary-prev-page
3508 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3511 @kindex RET (Summary)
3512 @findex gnus-summary-scroll-up
3513 Scroll the current article one line forward
3514 (@code{gnus-summary-scroll-up}).
3518 @kindex A g (Summary)
3520 @findex gnus-summary-show-article
3521 (Re)fetch the current article (@code{gnus-summary-show-article}). If
3522 given a prefix, fetch the current article, but don't run any of the
3523 article treatment functions. This will give you a ``raw'' article, just
3524 the way it came from the server.
3529 @kindex A < (Summary)
3530 @findex gnus-summary-beginning-of-article
3531 Scroll to the beginning of the article
3532 (@code{gnus-summary-beginning-of-article}).
3537 @kindex A > (Summary)
3538 @findex gnus-summary-end-of-article
3539 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3543 @kindex A s (Summary)
3545 @findex gnus-summary-isearch-article
3546 Perform an isearch in the article buffer
3547 (@code{gnus-summary-isearch-article}).
3552 @node Reply Followup and Post
3553 @section Reply, Followup and Post
3556 * Summary Mail Commands:: Sending mail.
3557 * Summary Post Commands:: Sending news.
3561 @node Summary Mail Commands
3562 @subsection Summary Mail Commands
3564 @cindex composing mail
3566 Commands for composing a mail message:
3572 @kindex S r (Summary)
3574 @findex gnus-summary-reply
3575 Mail a reply to the author of the current article
3576 (@code{gnus-summary-reply}).
3581 @kindex S R (Summary)
3582 @findex gnus-summary-reply-with-original
3583 Mail a reply to the author of the current article and include the
3584 original message (@code{gnus-summary-reply-with-original}). This
3585 command uses the process/prefix convention.
3588 @kindex S w (Summary)
3589 @findex gnus-summary-wide-reply
3590 Mail a wide reply to the author of the current article
3591 (@code{gnus-summary-wide-reply}).
3594 @kindex S W (Summary)
3595 @findex gnus-summary-wide-reply-with-original
3596 Mail a wide reply to the current article and include the original
3597 message (@code{gnus-summary-reply-with-original}). This command uses
3598 the process/prefix convention.
3601 @kindex S o m (Summary)
3602 @findex gnus-summary-mail-forward
3603 Forward the current article to some other person
3604 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
3605 headers of the forwarded article.
3610 @kindex S m (Summary)
3611 @findex gnus-summary-mail-other-window
3612 Send a mail to some other person
3613 (@code{gnus-summary-mail-other-window}).
3616 @kindex S D b (Summary)
3617 @findex gnus-summary-resend-bounced-mail
3618 @cindex bouncing mail
3619 If you have sent a mail, but the mail was bounced back to you for some
3620 reason (wrong address, transient failure), you can use this command to
3621 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
3622 will be popped into a mail buffer where you can edit the headers before
3623 sending the mail off again. If you give a prefix to this command, and
3624 the bounced mail is a reply to some other mail, Gnus will try to fetch
3625 that mail and display it for easy perusal of its headers. This might
3626 very well fail, though.
3629 @kindex S D r (Summary)
3630 @findex gnus-summary-resend-message
3631 Not to be confused with the previous command,
3632 @code{gnus-summary-resend-message} will prompt you for an address to
3633 send the current message off to, and then send it to that place. The
3634 headers of the message won't be altered---but lots of headers that say
3635 @code{Resent-To}, @code{Resent-From} and so on will be added. This
3636 means that you actually send a mail to someone that has a @code{To}
3637 header that (probably) points to yourself. This will confuse people.
3638 So, natcherly you'll only do that if you're really eVIl.
3640 This command is mainly used if you have several accounts and want to
3641 ship a mail to a different account of yours. (If you're both
3642 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3643 to the @code{root} account, you may want to resend it to
3644 @code{postmaster}. Ordnung muß sein!
3646 This command understands the process/prefix convention
3647 (@pxref{Process/Prefix}).
3650 @kindex S O m (Summary)
3651 @findex gnus-uu-digest-mail-forward
3652 Digest the current series and forward the result using mail
3653 (@code{gnus-uu-digest-mail-forward}). This command uses the
3654 process/prefix convention (@pxref{Process/Prefix}).
3657 @kindex S M-c (Summary)
3658 @findex gnus-summary-mail-crosspost-complaint
3659 @cindex crossposting
3660 @cindex excessive crossposting
3661 Send a complaint about excessive crossposting to the author of the
3662 current article (@code{gnus-summary-mail-crosspost-complaint}).
3664 @findex gnus-crosspost-complaint
3665 This command is provided as a way to fight back agains the current
3666 crossposting pandemic that's sweeping Usenet. It will compose a reply
3667 using the @code{gnus-crosspost-complaint} variable as a preamble. This
3668 command understands the process/prefix convention
3669 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3674 @node Summary Post Commands
3675 @subsection Summary Post Commands
3677 @cindex composing news
3679 Commands for posting a news article:
3685 @kindex S p (Summary)
3686 @findex gnus-summary-post-news
3687 Post an article to the current group
3688 (@code{gnus-summary-post-news}).
3693 @kindex S f (Summary)
3694 @findex gnus-summary-followup
3695 Post a followup to the current article (@code{gnus-summary-followup}).
3699 @kindex S F (Summary)
3701 @findex gnus-summary-followup-with-original
3702 Post a followup to the current article and include the original message
3703 (@code{gnus-summary-followup-with-original}). This command uses the
3704 process/prefix convention.
3707 @kindex S n (Summary)
3708 @findex gnus-summary-followup-to-mail
3709 Post a followup to the current article via news, even if you got the
3710 message through mail (@code{gnus-summary-followup-to-mail}).
3713 @kindex S n (Summary)
3714 @findex gnus-summary-followup-to-mail
3715 Post a followup to the current article via news, even if you got the
3716 message through mail and include the original message
3717 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
3718 the process/prefix convention.
3721 @kindex S o p (Summary)
3722 @findex gnus-summary-post-forward
3723 Forward the current article to a newsgroup
3724 (@code{gnus-summary-post-forward}). If given a prefix, include the full
3725 headers of the forwarded article.
3728 @kindex S O p (Summary)
3729 @findex gnus-uu-digest-post-forward
3730 Digest the current series and forward the result to a newsgroup
3731 (@code{gnus-uu-digest-mail-forward}).
3734 @kindex S u (Summary)
3735 @findex gnus-uu-post-news
3736 Uuencode a file, split it into parts, and post it as a series
3737 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
3741 @node Canceling and Superseding
3742 @section Canceling Articles
3743 @cindex canceling articles
3744 @cindex superseding articles
3746 Have you ever written something, and then decided that you really,
3747 really, really wish you hadn't posted that?
3749 Well, you can't cancel mail, but you can cancel posts.
3751 @findex gnus-summary-cancel-article
3753 Find the article you wish to cancel (you can only cancel your own
3754 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
3755 c} (@code{gnus-summary-cancel-article}). Your article will be
3756 canceled---machines all over the world will be deleting your article.
3758 Be aware, however, that not all sites honor cancels, so your article may
3759 live on here and there, while most sites will delete the article in
3762 If you discover that you have made some mistakes and want to do some
3763 corrections, you can post a @dfn{superseding} article that will replace
3764 your original article.
3766 @findex gnus-summary-supersede-article
3768 Go to the original article and press @kbd{S s}
3769 (@code{gnus-summary-supersede-article}). You will be put in a buffer
3770 where you can edit the article all you want before sending it off the
3773 The same goes for superseding as for canceling, only more so: Some
3774 sites do not honor superseding. On those sites, it will appear that you
3775 have posted almost the same article twice.
3777 If you have just posted the article, and change your mind right away,
3778 there is a trick you can use to cancel/supersede the article without
3779 waiting for the article to appear on your site first. You simply return
3780 to the post buffer (which is called @code{*sent ...*}). There you will
3781 find the article you just posted, with all the headers intact. Change
3782 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3783 header by substituting one of those words for the word
3784 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
3785 you would do normally. The previous article will be
3786 canceled/superseded.
3788 Just remember, kids: There is no 'c' in 'supersede'.
3791 @node Marking Articles
3792 @section Marking Articles
3793 @cindex article marking
3794 @cindex article ticking
3797 There are several marks you can set on an article.
3799 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3800 neologism ohoy!) of the article. Alphabetic marks generally mean
3801 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
3803 In addition, you also have marks that do not affect readedness.
3806 * Unread Articles:: Marks for unread articles.
3807 * Read Articles:: Marks for read articles.
3808 * Other Marks:: Marks that do not affect readedness.
3812 There's a plethora of commands for manipulating these marks:
3816 * Setting Marks:: How to set and remove marks.
3817 * Setting Process Marks:: How to mark articles for later processing.
3821 @node Unread Articles
3822 @subsection Unread Articles
3824 The following marks mark articles as (kinda) unread, in one form or
3829 @vindex gnus-ticked-mark
3830 Marked as ticked (@code{gnus-ticked-mark}).
3832 @dfn{Ticked articles} are articles that will remain visible always. If
3833 you see an article that you find interesting, or you want to put off
3834 reading it, or replying to it, until sometime later, you'd typically
3835 tick it. However, articles can be expired, so if you want to keep an
3836 article forever, you'll have to make it persistent (@pxref{Persistent
3840 @vindex gnus-dormant-mark
3841 Marked as dormant (@code{gnus-dormant-mark}).
3843 @dfn{Dormant articles} will only appear in the summary buffer if there
3844 are followups to it.
3847 @vindex gnus-unread-mark
3848 Markes as unread (@code{gnus-unread-mark}).
3850 @dfn{Unread articles} are articles that haven't been read at all yet.
3855 @subsection Read Articles
3856 @cindex expirable mark
3858 All the following marks mark articles as read.
3863 @vindex gnus-del-mark
3864 These are articles that the user has marked as read with the @kbd{d}
3865 command manually, more or less (@code{gnus-del-mark}).
3868 @vindex gnus-read-mark
3869 Articles that have actually been read (@code{gnus-read-mark}).
3872 @vindex gnus-ancient-mark
3873 Articles that were marked as read in previous sessions and are now
3874 @dfn{old} (@code{gnus-ancient-mark}).
3877 @vindex gnus-killed-mark
3878 Marked as killed (@code{gnus-killed-mark}).
3881 @vindex gnus-kill-file-mark
3882 Marked as killed by kill files (@code{gnus-kill-file-mark}).
3885 @vindex gnus-low-score-mark
3886 Marked as read by having a too low score (@code{gnus-low-score-mark}).
3889 @vindex gnus-catchup-mark
3890 Marked as read by a catchup (@code{gnus-catchup-mark}).
3893 @vindex gnus-canceled-mark
3894 Canceled article (@code{gnus-canceled-mark})
3897 @vindex gnus-souped-mark
3898 @sc{SOUP}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
3901 @vindex gnus-sparse-mark
3902 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
3906 @vindex gnus-duplicate-mark
3907 Article marked as read by duplicate suppression
3908 (@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}.
3912 All these marks just mean that the article is marked as read, really.
3913 They are interpreted differently when doing adaptive scoring, though.
3915 One more special mark, though:
3919 @vindex gnus-expirable-mark
3920 Marked as expirable (@code{gnus-expirable-mark}).
3922 Marking articles as @dfn{expirable} (or have them marked as such
3923 automatically) doesn't make much sense in normal groups---a user doesn't
3924 control the expiring of news articles, but in mail groups, for instance,
3925 articles that are marked as @dfn{expirable} can be deleted by Gnus at
3931 @subsection Other Marks
3932 @cindex process mark
3935 There are some marks that have nothing to do with whether the article is
3941 You can set a bookmark in the current article. Say you are reading a
3942 long thesis on cats' urinary tracts, and have to go home for dinner
3943 before you've finished reading the thesis. You can then set a bookmark
3944 in the article, and Gnus will jump to this bookmark the next time it
3945 encounters the article. @xref{Setting Marks}
3948 @vindex gnus-replied-mark
3949 All articles that you have replied to or made a followup to (i.e., have
3950 answered) will be marked with an @samp{A} in the second column
3951 (@code{gnus-replied-mark}).
3954 @vindex gnus-cached-mark
3955 Articles that are stored in the article cache will be marked with an
3956 @samp{*} in the second column (@code{gnus-cached-mark}).
3959 @vindex gnus-saved-mark
3960 Articles that are ``saved'' (in some manner or other; not necessarily
3961 religiously) are marked with an @samp{S} in the second column
3962 (@code{gnus-saved-mark}.
3965 @vindex gnus-not-empty-thread-mark
3966 @vindex gnus-empty-thread-mark
3967 It the @samp{%e} spec is used, the presence of threads or not will be
3968 marked with @code{gnus-not-empty-thread-mark} and
3969 @code{gnus-empty-thread-mark} in the third column, respectively.
3972 @vindex gnus-process-mark
3973 Finally we have the @dfn{process mark} (@code{gnus-process-mark}. A
3974 variety of commands react to the presence of the process mark. For
3975 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
3976 all articles that have been marked with the process mark. Articles
3977 marked with the process mark have a @samp{#} in the second column.
3981 You might have noticed that most of these ``non-readedness'' marks
3982 appear in the second column by default. So if you have a cached, saved,
3983 replied article that you have process-marked, what will that look like?
3985 Nothing much. The precedence rules go as follows: process -> cache ->
3986 replied -> saved. So if the article is in the cache and is replied,
3987 you'll only see the cache mark and not the replied mark.
3991 @subsection Setting Marks
3992 @cindex setting marks
3994 All the marking commands understand the numeric prefix.
4000 @kindex M t (Summary)
4001 @findex gnus-summary-tick-article-forward
4002 Tick the current article (@code{gnus-summary-tick-article-forward}).
4007 @kindex M ? (Summary)
4008 @findex gnus-summary-mark-as-dormant
4009 Mark the current article as dormant
4010 (@code{gnus-summary-mark-as-dormant}).
4014 @kindex M d (Summary)
4016 @findex gnus-summary-mark-as-read-forward
4017 Mark the current article as read
4018 (@code{gnus-summary-mark-as-read-forward}).
4022 @findex gnus-summary-mark-as-read-backward
4023 Mark the current article as read and move point to the previous line
4024 (@code{gnus-summary-mark-as-read-backward}).
4029 @kindex M k (Summary)
4030 @findex gnus-summary-kill-same-subject-and-select
4031 Mark all articles that have the same subject as the current one as read,
4032 and then select the next unread article
4033 (@code{gnus-summary-kill-same-subject-and-select}).
4037 @kindex M K (Summary)
4038 @kindex C-k (Summary)
4039 @findex gnus-summary-kill-same-subject
4040 Mark all articles that have the same subject as the current one as read
4041 (@code{gnus-summary-kill-same-subject}).
4044 @kindex M C (Summary)
4045 @findex gnus-summary-catchup
4046 Mark all unread articles as read (@code{gnus-summary-catchup}).
4049 @kindex M C-c (Summary)
4050 @findex gnus-summary-catchup-all
4051 Mark all articles in the group as read---even the ticked and dormant
4052 articles (@code{gnus-summary-catchup-all}).
4055 @kindex M H (Summary)
4056 @findex gnus-summary-catchup-to-here
4057 Catchup the current group to point
4058 (@code{gnus-summary-catchup-to-here}).
4061 @kindex C-w (Summary)
4062 @findex gnus-summary-mark-region-as-read
4063 Mark all articles between point and mark as read
4064 (@code{gnus-summary-mark-region-as-read}).
4067 @kindex M V k (Summary)
4068 @findex gnus-summary-kill-below
4069 Kill all articles with scores below the default score (or below the
4070 numeric prefix) (@code{gnus-summary-kill-below}).
4074 @kindex M c (Summary)
4075 @kindex M-u (Summary)
4076 @findex gnus-summary-clear-mark-forward
4077 Clear all readedness-marks from the current article
4078 (@code{gnus-summary-clear-mark-forward}).
4082 @kindex M e (Summary)
4084 @findex gnus-summary-mark-as-expirable
4085 Mark the current article as expirable
4086 (@code{gnus-summary-mark-as-expirable}).
4089 @kindex M b (Summary)
4090 @findex gnus-summary-set-bookmark
4091 Set a bookmark in the current article
4092 (@code{gnus-summary-set-bookmark}).
4095 @kindex M B (Summary)
4096 @findex gnus-summary-remove-bookmark
4097 Remove the bookmark from the current article
4098 (@code{gnus-summary-remove-bookmark}).
4101 @kindex M V c (Summary)
4102 @findex gnus-summary-clear-above
4103 Clear all marks from articles with scores over the default score (or
4104 over the numeric prefix) (@code{gnus-summary-clear-above}).
4107 @kindex M V u (Summary)
4108 @findex gnus-summary-tick-above
4109 Tick all articles with scores over the default score (or over the
4110 numeric prefix) (@code{gnus-summary-tick-above}).
4113 @kindex M V m (Summary)
4114 @findex gnus-summary-mark-above
4115 Prompt for a mark, and mark all articles with scores over the default
4116 score (or over the numeric prefix) with this mark
4117 (@code{gnus-summary-clear-above}).
4120 @vindex gnus-summary-goto-unread
4121 The @code{gnus-summary-goto-unread} variable controls what action should
4122 be taken after setting a mark. If non-@code{nil}, point will move to
4123 the next/previous unread article. If @code{nil}, point will just move
4124 one line up or down. As a special case, if this variable is
4125 @code{never}, all the marking commands as well as other commands (like
4126 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4127 The default is @code{t}.
4130 @node Setting Process Marks
4131 @subsection Setting Process Marks
4132 @cindex setting process marks
4139 @kindex M P p (Summary)
4140 @findex gnus-summary-mark-as-processable
4141 Mark the current article with the process mark
4142 (@code{gnus-summary-mark-as-processable}).
4143 @findex gnus-summary-unmark-as-processable
4147 @kindex M P u (Summary)
4148 @kindex M-# (Summary)
4149 Remove the process mark, if any, from the current article
4150 (@code{gnus-summary-unmark-as-processable}).
4153 @kindex M P U (Summary)
4154 @findex gnus-summary-unmark-all-processable
4155 Remove the process mark from all articles
4156 (@code{gnus-summary-unmark-all-processable}).
4159 @kindex M P i (Summary)
4160 @findex gnus-uu-invert-processable
4161 Invert the list of process marked articles
4162 (@code{gnus-uu-invert-processable}).
4165 @kindex M P R (Summary)
4166 @findex gnus-uu-mark-by-regexp
4167 Mark articles by a regular expression (@code{gnus-uu-mark-by-regexp}).
4170 @kindex M P r (Summary)
4171 @findex gnus-uu-mark-region
4172 Mark articles in region (@code{gnus-uu-mark-region}).
4175 @kindex M P t (Summary)
4176 @findex gnus-uu-mark-thread
4177 Mark all articles in the current (sub)thread
4178 (@code{gnus-uu-mark-thread}).
4181 @kindex M P T (Summary)
4182 @findex gnus-uu-unmark-thread
4183 Unmark all articles in the current (sub)thread
4184 (@code{gnus-uu-unmark-thread}).
4187 @kindex M P v (Summary)
4188 @findex gnus-uu-mark-over
4189 Mark all articles that have a score above the prefix argument
4190 (@code{gnus-uu-mark-over}).
4193 @kindex M P s (Summary)
4194 @findex gnus-uu-mark-series
4195 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4198 @kindex M P S (Summary)
4199 @findex gnus-uu-mark-sparse
4200 Mark all series that have already had some articles marked
4201 (@code{gnus-uu-mark-sparse}).
4204 @kindex M P a (Summary)
4205 @findex gnus-uu-mark-all
4206 Mark all articles in series order (@code{gnus-uu-mark-series}).
4209 @kindex M P b (Summary)
4210 @findex gnus-uu-mark-buffer
4211 Mark all articles in the buffer in the order they appear
4212 (@code{gnus-uu-mark-buffer}).
4215 @kindex M P k (Summary)
4216 @findex gnus-summary-kill-process-mark
4217 Push the current process mark set onto the stack and unmark all articles
4218 (@code{gnus-summary-kill-process-mark}).
4221 @kindex M P y (Summary)
4222 @findex gnus-summary-yank-process-mark
4223 Pop the previous process mark set from the stack and restore it
4224 (@code{gnus-summary-yank-process-mark}).
4227 @kindex M P w (Summary)
4228 @findex gnus-summary-save-process-mark
4229 Push the current process mark set onto the stack
4230 (@code{gnus-summary-save-process-mark}).
4239 It can be convenient to limit the summary buffer to just show some
4240 subset of the articles currently in the group. The effect most limit
4241 commands have is to remove a few (or many) articles from the summary
4248 @kindex / / (Summary)
4249 @findex gnus-summary-limit-to-subject
4250 Limit the summary buffer to articles that match some subject
4251 (@code{gnus-summary-limit-to-subject}).
4254 @kindex / a (Summary)
4255 @findex gnus-summary-limit-to-author
4256 Limit the summary buffer to articles that match some author
4257 (@code{gnus-summary-limit-to-author}).
4261 @kindex / u (Summary)
4263 @findex gnus-summary-limit-to-unread
4264 Limit the summary buffer to articles that are not marked as read
4265 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
4266 buffer to articles that are strictly unread. This means that ticked and
4267 dormant articles will also be excluded.
4270 @kindex / m (Summary)
4271 @findex gnus-summary-limit-to-marks
4272 Ask for a mark and then limit to all articles that have not been marked
4273 with that mark (@code{gnus-summary-limit-to-marks}).
4276 @kindex / t (Summary)
4277 @findex gnus-summary-limit-to-age
4278 Ask for a number and then limit the summary buffer to articles that are
4279 older than (or equal to) that number of days
4280 (@code{gnus-summary-limit-to-marks}). If given a prefix, limit to
4281 articles that are younger than that number of days.
4284 @kindex / n (Summary)
4285 @findex gnus-summary-limit-to-articles
4286 Limit the summary buffer to the current article
4287 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
4288 convention (@pxref{Process/Prefix}).
4291 @kindex / w (Summary)
4292 @findex gnus-summary-pop-limit
4293 Pop the previous limit off the stack and restore it
4294 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
4298 @kindex / v (Summary)
4299 @findex gnus-summary-limit-to-score
4300 Limit the summary buffer to articles that have a score at or above some
4301 score (@code{gnus-summary-limit-to-score}).
4305 @kindex M S (Summary)
4306 @kindex / E (Summary)
4307 @findex gnus-summary-limit-include-expunged
4308 Display all expunged articles
4309 (@code{gnus-summary-limit-include-expunged}).
4312 @kindex / D (Summary)
4313 @findex gnus-summary-limit-include-dormant
4314 Display all dormant articles (@code{gnus-summary-limit-include-dormant}).
4317 @kindex / d (Summary)
4318 @findex gnus-summary-limit-exclude-dormant
4319 Hide all dormant articles (@code{gnus-summary-limit-exclude-dormant}).
4322 @kindex / c (Summary)
4323 @findex gnus-summary-limit-exclude-childless-dormant
4324 Hide all dormant articles that have no children
4325 (@code{gnus-summary-limit-exclude-childless-dormant}).
4328 @kindex / C (Summary)
4329 @findex gnus-summary-limit-mark-excluded-as-read
4330 Mark all excluded unread articles as read
4331 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
4332 also mark excluded ticked and dormant articles as read.
4340 @cindex article threading
4342 Gnus threads articles by default. @dfn{To thread} is to put responses
4343 to articles directly after the articles they respond to---in a
4344 hierarchical fashion.
4347 * Customizing Threading:: Variables you can change to affect the threading.
4348 * Thread Commands:: Thread based commands in the summary buffer.
4352 @node Customizing Threading
4353 @subsection Customizing Threading
4354 @cindex customizing threading
4360 @item gnus-show-threads
4361 @vindex gnus-show-threads
4362 If this variable is @code{nil}, no threading will be done, and all of
4363 the rest of the variables here will have no effect. Turning threading
4364 off will speed group selection up a bit, but it is sure to make reading
4365 slower and more awkward.
4367 @item gnus-fetch-old-headers
4368 @vindex gnus-fetch-old-headers
4369 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4370 more old headers---headers to articles that are marked as read. If you
4371 would like to display as few summary lines as possible, but still
4372 connect as many loose threads as possible, you should set this variable
4373 to @code{some} or a number. If you set it to a number, no more than
4374 that number of extra old headers will be fetched. In either case,
4375 fetching old headers only works if the backend you are using carries
4376 overview files---this would normally be @code{nntp}, @code{nnspool} and
4377 @code{nnml}. Also remember that if the root of the thread has been
4378 expired by the server, there's not much Gnus can do about that.
4380 @item gnus-build-sparse-threads
4381 @vindex gnus-build-sparse-threads
4382 Fetching old headers can be slow. A low-rent similar effect can be
4383 gotten by setting this variable to @code{some}. Gnus will then look at
4384 the complete @code{References} headers of all articles and try to string
4385 articles that belong in the same thread together. This will leave
4386 @dfn{gaps} in the threading display where Gnus guesses that an article
4387 is missing from the thread. (These gaps appear like normal summary
4388 lines. If you select a gap, Gnus will try to fetch the article in
4389 question.) If this variable is @code{t}, Gnus will display all these
4390 ``gaps'' without regard for whether they are useful for completing the
4391 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
4392 off sparse leaf nodes that don't lead anywhere. This variable is
4393 @code{nil} by default.
4395 @item gnus-summary-gather-subject-limit
4396 @vindex gnus-summary-gather-subject-limit
4397 Loose threads are gathered by comparing subjects of articles. If this
4398 variable is @code{nil}, Gnus requires an exact match between the
4399 subjects of the loose threads before gathering them into one big
4400 super-thread. This might be too strict a requirement, what with the
4401 presence of stupid newsreaders that chop off long subjects lines. If
4402 you think so, set this variable to, say, 20 to require that only the
4403 first 20 characters of the subjects have to match. If you set this
4404 variable to a really low number, you'll find that Gnus will gather
4405 everything in sight into one thread, which isn't very helpful.
4407 @cindex fuzzy article gathering
4408 If you set this variable to the special value @code{fuzzy}, Gnus will
4409 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4412 @item gnus-simplify-subject-fuzzy-regexp
4413 @vindex gnus-simplify-subject-fuzzy-regexp
4414 This can either be a regular expression or list of regular expressions
4415 that match strings that will be removed from subjects if fuzzy subject
4416 simplification is used.
4418 @item gnus-simplify-ignored-prefixes
4419 @vindex gnus-simplify-ignored-prefixes
4420 If you set @code{gnus-summary-gather-subject-limit} to something as low
4421 as 10, you might consider setting this variable to something sensible:
4423 @c Written by Michael Ernst <mernst@cs.rice.edu>
4425 (setq gnus-simplify-ignored-prefixes
4431 "wanted" "followup" "summary\\( of\\)?"
4432 "help" "query" "problem" "question"
4433 "answer" "reference" "announce"
4434 "How can I" "How to" "Comparison of"
4439 (mapconcat 'identity
4440 '("for" "for reference" "with" "about")
4442 "\\)?\\]?:?[ \t]*"))
4445 All words that match this regexp will be removed before comparing two
4448 @item gnus-summary-gather-exclude-subject
4449 @vindex gnus-summary-gather-exclude-subject
4450 Since loose thread gathering is done on subjects only, that might lead
4451 to many false hits, especially with certain common subjects like
4452 @samp{} and @samp{(none)}. To make the situation slightly better,
4453 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4454 what subjects should be excluded from the gathering process. The
4455 default is @samp{^ *$\\|^(none)$}.
4457 @item gnus-summary-thread-gathering-function
4458 @vindex gnus-summary-thread-gathering-function
4459 Gnus gathers threads by looking at @code{Subject} headers. This means
4460 that totally unrelated articles may end up in the same ``thread'', which
4461 is confusing. An alternate approach is to look at all the
4462 @code{Message-ID}s in all the @code{References} headers to find matches.
4463 This will ensure that no gathered threads ever includes unrelated
4464 articles, but it's also means that people who have posted with broken
4465 newsreaders won't be gathered properly. The choice is yours---plague or
4469 @item gnus-gather-threads-by-subject
4470 @findex gnus-gather-threads-by-subject
4471 This function is the default gathering function and looks at
4472 @code{Subject}s exclusively.
4474 @item gnus-gather-threads-by-references
4475 @findex gnus-gather-threads-by-references
4476 This function looks at @code{References} headers exclusively.
4479 If you want to test gathering by @code{References}, you could say
4483 (setq gnus-summary-thread-gathering-function
4484 'gnus-gather-threads-by-references)
4487 @item gnus-summary-make-false-root
4488 @vindex gnus-summary-make-false-root
4489 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4490 and create a dummy root at the top. (Wait a minute. Root at the top?
4491 Yup.) Loose subtrees occur when the real root has expired, or you've
4492 read or killed the root in a previous session.
4494 When there is no real root of a thread, Gnus will have to fudge
4495 something. This variable says what fudging method Gnus should use.
4496 There are four possible values:
4498 @cindex adopting articles
4503 Gnus will make the first of the orphaned articles the parent. This
4504 parent will adopt all the other articles. The adopted articles will be
4505 marked as such by pointy brackets (@samp{<>}) instead of the standard
4506 square brackets (@samp{[]}). This is the default method.
4509 @vindex gnus-summary-dummy-line-format
4510 Gnus will create a dummy summary line that will pretend to be the
4511 parent. This dummy line does not correspond to any real article, so
4512 selecting it will just select the first real article after the dummy
4513 article. @code{gnus-summary-dummy-line-format} is used to specify the
4514 format of the dummy roots. It accepts only one format spec: @samp{S},
4515 which is the subject of the article. @xref{Formatting Variables}.
4518 Gnus won't actually make any article the parent, but simply leave the
4519 subject field of all orphans except the first empty. (Actually, it will
4520 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4524 Don't make any article parent at all. Just gather the threads and
4525 display them after one another.
4528 Don't gather loose threads.
4531 @item gnus-thread-hide-subtree
4532 @vindex gnus-thread-hide-subtree
4533 If non-@code{nil}, all threads will be hidden when the summary buffer is
4536 @item gnus-thread-expunge-below
4537 @vindex gnus-thread-expunge-below
4538 All threads that have a total score (as defined by
4539 @code{gnus-thread-score-function}) less than this number will be
4540 expunged. This variable is @code{nil} by default, which means that no
4541 threads are expunged.
4543 @item gnus-thread-hide-killed
4544 @vindex gnus-thread-hide-killed
4545 if you kill a thread and this variable is non-@code{nil}, the subtree
4548 @item gnus-thread-ignore-subject
4549 @vindex gnus-thread-ignore-subject
4550 Sometimes somebody changes the subject in the middle of a thread. If
4551 this variable is non-@code{nil}, the subject change is ignored. If it
4552 is @code{nil}, which is the default, a change in the subject will result
4555 @item gnus-thread-indent-level
4556 @vindex gnus-thread-indent-level
4557 This is a number that says how much each sub-thread should be indented.
4560 @item gnus-parse-headers-hook
4561 @vindex gnus-parse-headers-hook
4562 Hook run before parsing any headers. The default value is
4563 @code{(gnus-decode-rfc1522)}, which means that QPized headers will be
4564 slightly decoded in a hackish way. This is likely to change in the
4565 future when Gnus becomes @sc{MIME}ified.
4570 @node Thread Commands
4571 @subsection Thread Commands
4572 @cindex thread commands
4578 @kindex T k (Summary)
4579 @kindex M-C-k (Summary)
4580 @findex gnus-summary-kill-thread
4581 Mark all articles in the current (sub-)thread as read
4582 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
4583 remove all marks instead. If the prefix argument is negative, tick
4588 @kindex T l (Summary)
4589 @kindex M-C-l (Summary)
4590 @findex gnus-summary-lower-thread
4591 Lower the score of the current (sub-)thread
4592 (@code{gnus-summary-lower-thread}).
4595 @kindex T i (Summary)
4596 @findex gnus-summary-raise-thread
4597 Increase the score of the current (sub-)thread
4598 (@code{gnus-summary-raise-thread}).
4601 @kindex T # (Summary)
4602 @findex gnus-uu-mark-thread
4603 Set the process mark on the current (sub-)thread
4604 (@code{gnus-uu-mark-thread}).
4607 @kindex T M-# (Summary)
4608 @findex gnus-uu-unmark-thread
4609 Remove the process mark from the current (sub-)thread
4610 (@code{gnus-uu-unmark-thread}).
4613 @kindex T T (Summary)
4614 @findex gnus-summary-toggle-threads
4615 Toggle threading (@code{gnus-summary-toggle-threads}).
4618 @kindex T s (Summary)
4619 @findex gnus-summary-show-thread
4620 Expose the (sub-)thread hidden under the current article, if any
4621 (@code{gnus-summary-show-thread}).
4624 @kindex T h (Summary)
4625 @findex gnus-summary-hide-thread
4626 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
4629 @kindex T S (Summary)
4630 @findex gnus-summary-show-all-threads
4631 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
4634 @kindex T H (Summary)
4635 @findex gnus-summary-hide-all-threads
4636 Hide all threads (@code{gnus-summary-hide-all-threads}).
4639 @kindex T t (Summary)
4640 @findex gnus-summary-rethread-current
4641 Re-thread the thread the current article is part of
4642 (@code{gnus-summary-rethread-current}). This works even when the
4643 summary buffer is otherwise unthreaded.
4646 @kindex T ^ (Summary)
4647 @findex gnus-summary-reparent-thread
4648 Make the current article the child of the marked (or previous) article
4649 (@code{gnus-summary-reparent-thread}.
4653 The following commands are thread movement commands. They all
4654 understand the numeric prefix.
4659 @kindex T n (Summary)
4660 @findex gnus-summary-next-thread
4661 Go to the next thread (@code{gnus-summary-next-thread}).
4664 @kindex T p (Summary)
4665 @findex gnus-summary-prev-thread
4666 Go to the previous thread (@code{gnus-summary-prev-thread}).
4669 @kindex T d (Summary)
4670 @findex gnus-summary-down-thread
4671 Descend the thread (@code{gnus-summary-down-thread}).
4674 @kindex T u (Summary)
4675 @findex gnus-summary-up-thread
4676 Ascend the thread (@code{gnus-summary-up-thread}).
4679 @kindex T o (Summary)
4680 @findex gnus-summary-top-thread
4681 Go to the top of the thread (@code{gnus-summary-top-thread}).
4684 @vindex gnus-thread-operation-ignore-subject
4685 If you ignore subject while threading, you'll naturally end up with
4686 threads that have several different subjects in them. If you then issue
4687 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
4688 wish to kill the entire thread, but just those parts of the thread that
4689 have the same subject as the current article. If you like this idea,
4690 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If is
4691 is non-@code{nil} (which it is by default), subjects will be ignored
4692 when doing thread commands. If this variable is @code{nil}, articles in
4693 the same thread with different subjects will not be included in the
4694 operation in question. If this variable is @code{fuzzy}, only articles
4695 that have subjects that are fuzzily equal will be included (@pxref{Fuzzy
4702 @findex gnus-thread-sort-by-total-score
4703 @findex gnus-thread-sort-by-date
4704 @findex gnus-thread-sort-by-score
4705 @findex gnus-thread-sort-by-subject
4706 @findex gnus-thread-sort-by-author
4707 @findex gnus-thread-sort-by-number
4708 @vindex gnus-thread-sort-functions
4709 If you are using a threaded summary display, you can sort the threads by
4710 setting @code{gnus-thread-sort-functions}, which is a list of functions.
4711 By default, sorting is done on article numbers. Ready-made sorting
4712 predicate functions include @code{gnus-thread-sort-by-number},
4713 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
4714 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
4715 @code{gnus-thread-sort-by-total-score}.
4717 Each function takes two threads and return non-@code{nil} if the first
4718 thread should be sorted before the other. Note that sorting really is
4719 normally done by looking only at the roots of each thread. If you use
4720 more than one function, the primary sort key should be the last function
4721 in the list. You should probably always include
4722 @code{gnus-thread-sort-by-number} in the list of sorting
4723 functions---preferably first. This will ensure that threads that are
4724 equal with respect to the other sort criteria will be displayed in
4725 ascending article order.
4727 If you would like to sort by score, then by subject, and finally by
4728 number, you could do something like:
4731 (setq gnus-thread-sort-functions
4732 '(gnus-thread-sort-by-number
4733 gnus-thread-sort-by-subject
4734 gnus-thread-sort-by-total-score))
4737 The threads that have highest score will be displayed first in the
4738 summary buffer. When threads have the same score, they will be sorted
4739 alphabetically. The threads that have the same score and the same
4740 subject will be sorted by number, which is (normally) the sequence in
4741 which the articles arrived.
4743 If you want to sort by score and then reverse arrival order, you could
4747 (setq gnus-thread-sort-functions
4749 (not (gnus-thread-sort-by-number t1 t2)))
4750 gnus-thread-sort-by-score))
4753 @vindex gnus-thread-score-function
4754 The function in the @code{gnus-thread-score-function} variable (default
4755 @code{+}) is used for calculating the total score of a thread. Useful
4756 functions might be @code{max}, @code{min}, or squared means, or whatever
4759 @findex gnus-article-sort-functions
4760 @findex gnus-article-sort-by-date
4761 @findex gnus-article-sort-by-score
4762 @findex gnus-article-sort-by-subject
4763 @findex gnus-article-sort-by-author
4764 @findex gnus-article-sort-by-number
4765 If you are using an unthreaded display for some strange reason or other,
4766 you have to fiddle with the @code{gnus-article-sort-functions} variable.
4767 It is very similar to the @code{gnus-thread-sort-functions}, except that
4768 is uses slightly different functions for article comparison. Available
4769 sorting predicate functions are @code{gnus-article-sort-by-number},
4770 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
4771 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
4773 If you want to sort an unthreaded summary display by subject, you could
4777 (setq gnus-article-sort-functions
4778 '(gnus-article-sort-by-number
4779 gnus-article-sort-by-subject))
4784 @node Asynchronous Fetching
4785 @section Asynchronous Article Fetching
4786 @cindex asynchronous article fetching
4787 @cindex article pre-fetch
4790 If you read your news from an @sc{nntp} server that's far away, the
4791 network latencies may make reading articles a chore. You have to wait
4792 for a while after pressing @kbd{n} to go to the next article before the
4793 article appears. Why can't Gnus just go ahead and fetch the article
4794 while you are reading the previous one? Why not, indeed.
4796 First, some caveats. There are some pitfalls to using asynchronous
4797 article fetching, especially the way Gnus does it.
4799 Let's say you are reading article 1, which is short, and article 2 is
4800 quite long, and you are not interested in reading that. Gnus does not
4801 know this, so it goes ahead and fetches article 2. You decide to read
4802 article 3, but since Gnus is in the process of fetching article 2, the
4803 connection is blocked.
4805 To avoid these situations, Gnus will open two (count 'em two)
4806 connections to the server. Some people may think this isn't a very nice
4807 thing to do, but I don't see any real alternatives. Setting up that
4808 extra connection takes some time, so Gnus startup will be slower.
4810 Gnus will fetch more articles than you will read. This will mean that
4811 the link between your machine and the @sc{nntp} server will become more
4812 loaded than if you didn't use article pre-fetch. The server itself will
4813 also become more loaded---both with the extra article requests, and the
4816 Ok, so now you know that you shouldn't really use this thing... unless
4819 @vindex gnus-asynchronous
4820 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
4821 happen automatically.
4823 @vindex gnus-use-article-prefetch
4824 You can control how many articles that are to be pre-fetched by setting
4825 @code{gnus-use-article-prefetch}. This is 30 by default, which means
4826 that when you read an article in the group, the backend will pre-fetch
4827 the next 30 articles. If this variable is @code{t}, the backend will
4828 pre-fetch all the articles that it can without bound. If it is
4829 @code{nil}, no pre-fetching will be made.
4831 @vindex gnus-async-prefetch-article-p
4832 @findex gnus-async-read-p
4833 There are probably some articles that you don't want to pre-fetch---read
4834 articles, for instance. Which articles to pre-fetch is controlled by
4835 the @code{gnus-async-prefetch-article-p} variable. This function should
4836 return non-@code{nil} when the article in question is to be
4837 pre-fetched. The default is @code{gnus-async-read-p}, which returns
4838 @code{nil} on read articles. The function is called with an article
4839 data structure as the only parameter.
4841 If, for instance, you wish to pre-fetch only unread articles that are
4842 shorter than 100 lines, you could say something like:
4845 (defun my-async-short-unread-p (data)
4846 "Return non-nil for short, unread articles."
4847 (and (gnus-data-unread-p data)
4848 (< (mail-header-lines (gnus-data-header data))
4851 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
4854 These functions will be called many, many times, so they should
4855 preferrably be short and sweet to avoid slowing down Gnus too much.
4856 It's also probably a good idea to byte-compile things like this.
4858 @vindex gnus-prefetched-article-deletion-strategy
4859 Articles have to be removed from the asynch buffer sooner or later. The
4860 @code{gnus-prefetched-article-deletion-strategy} says when to remove
4861 articles. This is a list that may contain the following elements:
4865 Remove articles when they are read.
4868 Remove articles when exiting the group.
4871 The default value is @code{(read exit)}.
4873 @vindex gnus-use-header-prefetch
4874 If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
4875 from the next group.
4878 @node Article Caching
4879 @section Article Caching
4880 @cindex article caching
4883 If you have an @emph{extremely} slow @sc{nntp} connection, you may
4884 consider turning article caching on. Each article will then be stored
4885 locally under your home directory. As you may surmise, this could
4886 potentially use @emph{huge} amounts of disk space, as well as eat up all
4887 your inodes so fast it will make your head swim. In vodka.
4889 Used carefully, though, it could be just an easier way to save articles.
4891 @vindex gnus-use-long-file-name
4892 @vindex gnus-cache-directory
4893 @vindex gnus-use-cache
4894 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
4895 all articles that are ticked or marked as dormant will then be copied
4896 over to your local cache (@code{gnus-cache-directory}). Whether this
4897 cache is flat or hierarchal is controlled by the
4898 @code{gnus-use-long-file-name} variable, as usual.
4900 When re-select a ticked or dormant article, it will be fetched from the
4901 cache instead of from the server. As articles in your cache will never
4902 expire, this might serve as a method of saving articles while still
4903 keeping them where they belong. Just mark all articles you want to save
4904 as dormant, and don't worry.
4906 When an article is marked as read, is it removed from the cache.
4908 @vindex gnus-cache-remove-articles
4909 @vindex gnus-cache-enter-articles
4910 The entering/removal of articles from the cache is controlled by the
4911 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
4912 variables. Both are lists of symbols. The first is @code{(ticked
4913 dormant)} by default, meaning that ticked and dormant articles will be
4914 put in the cache. The latter is @code{(read)} by default, meaning that
4915 articles that are marked as read are removed from the cache. Possibly
4916 symbols in these two lists are @code{ticked}, @code{dormant},
4917 @code{unread} and @code{read}.
4919 @findex gnus-jog-cache
4920 So where does the massive article-fetching and storing come into the
4921 picture? The @code{gnus-jog-cache} command will go through all
4922 subscribed newsgroups, request all unread articles, and store them in
4923 the cache. You should only ever, ever ever ever, use this command if 1)
4924 your connection to the @sc{nntp} server is really, really, really slow
4925 and 2) you have a really, really, really huge disk. Seriously.
4927 @vindex gnus-uncacheable-groups
4928 It is likely that you do not want caching on some groups. For instance,
4929 if your @code{nnml} mail is located under your home directory, it makes no
4930 sense to cache it somewhere else under your home directory. Unless you
4931 feel that it's neat to use twice as much space. To limit the caching,
4932 you could set the @code{gnus-uncacheable-groups} regexp to
4933 @samp{^nnml}, for instance. This variable is @code{nil} by
4936 @findex gnus-cache-generate-nov-databases
4937 @findex gnus-cache-generate-active
4938 @vindex gnus-cache-active-file
4939 The cache stores information on what articles it contains in its active
4940 file (@code{gnus-cache-active-file}). If this file (or any other parts
4941 of the cache) becomes all messed up for some reason or other, Gnus
4942 offers two functions that will try to set things right. @kbd{M-x
4943 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
4944 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
4948 @node Persistent Articles
4949 @section Persistent Articles
4950 @cindex persistent articles
4952 Closely related to article caching, we have @dfn{persistent articles}.
4953 In fact, it's just a different way of looking at caching, and much more
4954 useful in my opinion.
4956 Say you're reading a newsgroup, and you happen on to some valuable gem
4957 that you want to keep and treasure forever. You'd normally just save it
4958 (using one of the many saving commands) in some file. The problem with
4959 that is that it's just, well, yucky. Ideally you'd prefer just having
4960 the article remain in the group where you found it forever; untouched by
4961 the expiry going on at the news server.
4963 This is what a @dfn{persistent article} is---an article that just won't
4964 be deleted. It's implemented using the normal cache functions, but
4965 you use two explicit commands for managing persistent articles:
4971 @findex gnus-cache-enter-article
4972 Make the current article persistent (@code{gnus-cache-enter-article}).
4975 @kindex M-* (Summary)
4976 @findex gnus-cache-remove-article
4977 Remove the current article from the persistent articles
4978 (@code{gnus-cache-remove-article}). This will normally delete the
4982 Both these commands understand the process/prefix convention.
4984 To avoid having all ticked articles (and stuff) entered into the cache,
4985 you should set @code{gnus-use-cache} to @code{passive} if you're just
4986 interested in persistent articles:
4989 (setq gnus-use-cache 'passive)
4993 @node Article Backlog
4994 @section Article Backlog
4996 @cindex article backlog
4998 If you have a slow connection, but the idea of using caching seems
4999 unappealing to you (and it is, really), you can help the situation some
5000 by switching on the @dfn{backlog}. This is where Gnus will buffer
5001 already read articles so that it doesn't have to re-fetch articles
5002 you've already read. This only helps if you are in the habit of
5003 re-selecting articles you've recently read, of course. If you never do
5004 that, turning the backlog on will slow Gnus down a little bit, and
5005 increase memory usage some.
5007 @vindex gnus-keep-backlog
5008 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5009 at most @var{n} old articles in a buffer for later re-fetching. If this
5010 variable is non-@code{nil} and is not a number, Gnus will store
5011 @emph{all} read articles, which means that your Emacs will grow without
5012 bound before exploding and taking your machine down with you. I put
5013 that in there just to keep y'all on your toes.
5015 This variable is @code{nil} by default.
5018 @node Saving Articles
5019 @section Saving Articles
5020 @cindex saving articles
5022 Gnus can save articles in a number of ways. Below is the documentation
5023 for saving articles in a fairly straight-forward fashion (i.e., little
5024 processing of the article is done before it is saved). For a different
5025 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5026 (@pxref{Decoding Articles}).
5028 @vindex gnus-save-all-headers
5029 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5030 unwanted headers before saving the article.
5032 @vindex gnus-saved-headers
5033 If the preceding variable is @code{nil}, all headers that match the
5034 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5035 deleted before saving.
5041 @kindex O o (Summary)
5043 @findex gnus-summary-save-article
5044 Save the current article using the default article saver
5045 (@code{gnus-summary-save-article}).
5048 @kindex O m (Summary)
5049 @findex gnus-summary-save-article-mail
5050 Save the current article in mail format
5051 (@code{gnus-summary-save-article-mail}).
5054 @kindex O r (Summary)
5055 @findex gnus-summary-save-article-rmail
5056 Save the current article in rmail format
5057 (@code{gnus-summary-save-article-rmail}).
5060 @kindex O f (Summary)
5061 @findex gnus-summary-save-article-file
5062 Save the current article in plain file format
5063 (@code{gnus-summary-save-article-file}).
5066 @kindex O F (Summary)
5067 @findex gnus-summary-write-article-file
5068 Write the current article in plain file format, overwriting any previous
5069 file contents (@code{gnus-summary-write-article-file}).
5072 @kindex O b (Summary)
5073 @findex gnus-summary-save-article-body-file
5074 Save the current article body in plain file format
5075 (@code{gnus-summary-save-article-body-file}).
5078 @kindex O h (Summary)
5079 @findex gnus-summary-save-article-folder
5080 Save the current article in mh folder format
5081 (@code{gnus-summary-save-article-folder}).
5084 @kindex O v (Summary)
5085 @findex gnus-summary-save-article-vm
5086 Save the current article in a VM folder
5087 (@code{gnus-summary-save-article-vm}).
5090 @kindex O p (Summary)
5091 @findex gnus-summary-pipe-output
5092 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
5093 the current article to a process (@code{gnus-summary-pipe-output}).
5096 @vindex gnus-prompt-before-saving
5097 All these commands use the process/prefix convention
5098 (@pxref{Process/Prefix}). If you save bunches of articles using these
5099 functions, you might get tired of being prompted for files to save each
5100 and every article in. The prompting action is controlled by
5101 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5102 default, giving you that excessive prompting action you know and
5103 loathe. If you set this variable to @code{t} instead, you'll be prompted
5104 just once for each series of articles you save. If you like to really
5105 have Gnus do all your thinking for you, you can even set this variable
5106 to @code{nil}, which means that you will never be prompted for files to
5107 save articles in. Gnus will simply save all the articles in the default
5111 @vindex gnus-default-article-saver
5112 You can customize the @code{gnus-default-article-saver} variable to make
5113 Gnus do what you want it to. You can use any of the four ready-made
5114 functions below, or you can create your own.
5118 @item gnus-summary-save-in-rmail
5119 @findex gnus-summary-save-in-rmail
5120 @vindex gnus-rmail-save-name
5121 @findex gnus-plain-save-name
5122 This is the default format, @dfn{babyl}. Uses the function in the
5123 @code{gnus-rmail-save-name} variable to get a file name to save the
5124 article in. The default is @code{gnus-plain-save-name}.
5126 @item gnus-summary-save-in-mail
5127 @findex gnus-summary-save-in-mail
5128 @vindex gnus-mail-save-name
5129 Save in a Unix mail (mbox) file. Uses the function in the
5130 @code{gnus-mail-save-name} variable to get a file name to save the
5131 article in. The default is @code{gnus-plain-save-name}.
5133 @item gnus-summary-save-in-file
5134 @findex gnus-summary-save-in-file
5135 @vindex gnus-file-save-name
5136 @findex gnus-numeric-save-name
5137 Append the article straight to an ordinary file. Uses the function in
5138 the @code{gnus-file-save-name} variable to get a file name to save the
5139 article in. The default is @code{gnus-numeric-save-name}.
5141 @item gnus-summary-save-body-in-file
5142 @findex gnus-summary-save-body-in-file
5143 Append the article body to an ordinary file. Uses the function in the
5144 @code{gnus-file-save-name} variable to get a file name to save the
5145 article in. The default is @code{gnus-numeric-save-name}.
5147 @item gnus-summary-save-in-folder
5148 @findex gnus-summary-save-in-folder
5149 @findex gnus-folder-save-name
5150 @findex gnus-Folder-save-name
5151 @vindex gnus-folder-save-name
5154 Save the article to an MH folder using @code{rcvstore} from the MH
5155 library. Uses the function in the @code{gnus-folder-save-name} variable
5156 to get a file name to save the article in. The default is
5157 @code{gnus-folder-save-name}, but you can also use
5158 @code{gnus-Folder-save-name}. The former creates capitalized names, and
5159 the latter does not.
5161 @item gnus-summary-save-in-vm
5162 @findex gnus-summary-save-in-vm
5163 Save the article in a VM folder. You have to have the VM mail
5164 reader to use this setting.
5167 @vindex gnus-article-save-directory
5168 All of these functions, except for the last one, will save the article
5169 in the @code{gnus-article-save-directory}, which is initialized from the
5170 @code{SAVEDIR} environment variable. This is @file{~/News/} by
5173 As you can see above, the functions use different functions to find a
5174 suitable name of a file to save the article in. Below is a list of
5175 available functions that generate names:
5179 @item gnus-Numeric-save-name
5180 @findex gnus-Numeric-save-name
5181 File names like @file{~/News/Alt.andrea-dworkin/45}.
5183 @item gnus-numeric-save-name
5184 @findex gnus-numeric-save-name
5185 File names like @file{~/News/alt.andrea-dworkin/45}.
5187 @item gnus-Plain-save-name
5188 @findex gnus-Plain-save-name
5189 File names like @file{~/News/Alt.andrea-dworkin}.
5191 @item gnus-plain-save-name
5192 @findex gnus-plain-save-name
5193 File names like @file{~/News/alt.andrea-dworkin}.
5196 @vindex gnus-split-methods
5197 You can have Gnus suggest where to save articles by plonking a regexp into
5198 the @code{gnus-split-methods} alist. For instance, if you would like to
5199 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5200 related to VM in @code{vm-stuff}, you could set this variable to something
5204 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5205 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5206 (my-choosing-function "../other-dir/my-stuff")
5207 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5210 We see that this is a list where each element is a list that has two
5211 elements---the @dfn{match} and the @dfn{file}. The match can either be
5212 a string (in which case it is used as a regexp to match on the article
5213 head); it can be a symbol (which will be called as a function with the
5214 group name as a parameter); or it can be a list (which will be
5215 @code{eval}ed). If any of these actions have a non-@code{nil} result,
5216 the @dfn{file} will be used as a default prompt. In addition, the
5217 result of the operation itself will be used if the function or form
5218 called returns a string or a list of strings.
5220 You basically end up with a list of file names that might be used when
5221 saving the current article. (All ``matches'' will be used.) You will
5222 then be prompted for what you really want to use as a name, with file
5223 name completion over the results from applying this variable.
5225 This variable is @code{((gnus-article-archive-name))} by default, which
5226 means that Gnus will look at the articles it saves for an
5227 @code{Archive-name} line and use that as a suggestion for the file
5230 @vindex gnus-use-long-file-name
5231 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
5232 @code{nil}, all the preceding functions will replace all periods
5233 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5234 the functions will generate hierarchies of directories instead of having
5235 all the files in the toplevel directory
5236 (@file{~/News/alt/andrea-dworkin} instead of
5237 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
5238 on most systems. However, for historical reasons, this is @code{nil} on
5239 Xenix and usg-unix-v machines by default.
5241 This function also affects kill and score file names. If this variable
5242 is a list, and the list contains the element @code{not-score}, long file
5243 names will not be used for score files, if it contains the element
5244 @code{not-save}, long file names will not be used for saving, and if it
5245 contains the element @code{not-kill}, long file names will not be used
5248 If you'd like to save articles in a hierarchy that looks something like
5252 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5253 (setq gnus-default-article-save 'gnus-summary-save-in-file) ; no encoding
5256 Then just save with @kbd{o}. You'd then read this hierarchy with
5257 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5258 the toplevel directory as the argument (@file{~/News/}). Then just walk
5259 around to the groups/directories with @code{nneething}.
5262 @node Decoding Articles
5263 @section Decoding Articles
5264 @cindex decoding articles
5266 Sometime users post articles (or series of articles) that have been
5267 encoded in some way or other. Gnus can decode them for you.
5270 * Uuencoded Articles:: Uudecode articles.
5271 * Shared Articles:: Unshar articles.
5272 * PostScript Files:: Split PostScript.
5273 * Decoding Variables:: Variables for a happy decoding.
5274 * Viewing Files:: You want to look at the result of the decoding?
5277 All these functions use the process/prefix convention
5278 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5279 the extension that a ``single article'' means ``a single series''. Gnus
5280 can find out by itself what articles belong to a series, decode all the
5281 articles and unpack/view/save the resulting file(s).
5283 Gnus guesses what articles are in the series according to the following
5284 simplish rule: The subjects must be (nearly) identical, except for the
5285 last two numbers of the line. (Spaces are largely ignored, however.)
5287 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5288 will find all the articles that match the regexp @samp{^cat.gif
5289 ([0-9]+/[0-9]+).*$}.
5291 Subjects that are nonstandard, like @samp{cat.gif (2/3) Part 6 of a
5292 series}, will not be properly recognized by any of the automatic viewing
5293 commands, and you have to mark the articles manually with @kbd{#}.
5296 @node Uuencoded Articles
5297 @subsection Uuencoded Articles
5299 @cindex uuencoded articles
5304 @kindex X u (Summary)
5305 @findex gnus-uu-decode-uu
5306 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5309 @kindex X U (Summary)
5310 @findex gnus-uu-decode-uu-and-save
5311 Uudecodes and saves the current series
5312 (@code{gnus-uu-decode-uu-and-save}).
5315 @kindex X v u (Summary)
5316 @findex gnus-uu-decode-uu-view
5317 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5320 @kindex X v U (Summary)
5321 @findex gnus-uu-decode-uu-and-save-view
5322 Uudecodes, views and saves the current series
5323 (@code{gnus-uu-decode-uu-and-save-view}).
5326 Remember that these all react to the presence of articles marked with
5327 the process mark. If, for instance, you'd like to decode and save an
5328 entire newsgroup, you'd typically do @kbd{M P a}
5329 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5330 (@code{gnus-uu-decode-uu-and-save}).
5332 All this is very much different from how @code{gnus-uu} worked with
5333 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5334 the sun. This version of @code{gnus-uu} generally assumes that you mark
5335 articles in some way (@pxref{Setting Process Marks}) and then press
5338 @vindex gnus-uu-notify-files
5339 Note: When trying to decode articles that have names matching
5340 @code{gnus-uu-notify-files}, which is hard-coded to
5341 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5342 automatically post an article on @samp{comp.unix.wizards} saying that
5343 you have just viewed the file in question. This feature can't be turned
5347 @node Shared Articles
5348 @subsection Shared Articles
5350 @cindex shared articles
5355 @kindex X s (Summary)
5356 @findex gnus-uu-decode-unshar
5357 Unshars the current series (@code{gnus-uu-decode-unshar}).
5360 @kindex X S (Summary)
5361 @findex gnus-uu-decode-unshar-and-save
5362 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5365 @kindex X v s (Summary)
5366 @findex gnus-uu-decode-unshar-view
5367 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5370 @kindex X v S (Summary)
5371 @findex gnus-uu-decode-unshar-and-save-view
5372 Unshars, views and saves the current series
5373 (@code{gnus-uu-decode-unshar-and-save-view}).
5377 @node PostScript Files
5378 @subsection PostScript Files
5384 @kindex X p (Summary)
5385 @findex gnus-uu-decode-postscript
5386 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5389 @kindex X P (Summary)
5390 @findex gnus-uu-decode-postscript-and-save
5391 Unpack and save the current PostScript series
5392 (@code{gnus-uu-decode-postscript-and-save}).
5395 @kindex X v p (Summary)
5396 @findex gnus-uu-decode-postscript-view
5397 View the current PostScript series
5398 (@code{gnus-uu-decode-postscript-view}).
5401 @kindex X v P (Summary)
5402 @findex gnus-uu-decode-postscript-and-save-view
5403 View and save the current PostScript series
5404 (@code{gnus-uu-decode-postscript-and-save-view}).
5408 @node Decoding Variables
5409 @subsection Decoding Variables
5411 Adjective, not verb.
5414 * Rule Variables:: Variables that say how a file is to be viewed.
5415 * Other Decode Variables:: Other decode variables.
5416 * Uuencoding and Posting:: Variables for customizing uuencoding.
5420 @node Rule Variables
5421 @subsubsection Rule Variables
5422 @cindex rule variables
5424 Gnus uses @dfn{rule variables} to decide how to view a file. All these
5425 variables are on the form
5428 (list '(regexp1 command2)
5435 @item gnus-uu-user-view-rules
5436 @vindex gnus-uu-user-view-rules
5438 This variable is consulted first when viewing files. If you wish to use,
5439 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5442 (setq gnus-uu-user-view-rules
5443 (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5446 @item gnus-uu-user-view-rules-end
5447 @vindex gnus-uu-user-view-rules-end
5448 This variable is consulted if Gnus couldn't make any matches from the
5449 user and default view rules.
5451 @item gnus-uu-user-archive-rules
5452 @vindex gnus-uu-user-archive-rules
5453 This variable can be used to say what commands should be used to unpack
5458 @node Other Decode Variables
5459 @subsubsection Other Decode Variables
5462 @vindex gnus-uu-grabbed-file-functions
5464 @item gnus-uu-grabbed-file-functions
5465 All functions in this list will be called right each file has been
5466 successfully decoded---so that you can move or view files right away,
5467 and don't have to wait for all files to be decoded before you can do
5468 anything. Ready-made functions you can put in this list are:
5472 @item gnus-uu-grab-view
5473 @findex gnus-uu-grab-view
5476 @item gnus-uu-grab-move
5477 @findex gnus-uu-grab-move
5478 Move the file (if you're using a saving function.)
5481 @item gnus-uu-be-dangerous
5482 @vindex gnus-uu-be-dangerous
5483 Specifies what to do if unusual situations arise during decoding. If
5484 @code{nil}, be as conservative as possible. If @code{t}, ignore things
5485 that didn't work, and overwrite existing files. Otherwise, ask each
5488 @item gnus-uu-ignore-files-by-name
5489 @vindex gnus-uu-ignore-files-by-name
5490 Files with name matching this regular expression won't be viewed.
5492 @item gnus-uu-ignore-files-by-type
5493 @vindex gnus-uu-ignore-files-by-type
5494 Files with a @sc{mime} type matching this variable won't be viewed.
5495 Note that Gnus tries to guess what type the file is based on the name.
5496 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5499 @item gnus-uu-tmp-dir
5500 @vindex gnus-uu-tmp-dir
5501 Where @code{gnus-uu} does its work.
5503 @item gnus-uu-do-not-unpack-archives
5504 @vindex gnus-uu-do-not-unpack-archives
5505 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5506 looking for files to display.
5508 @item gnus-uu-view-and-save
5509 @vindex gnus-uu-view-and-save
5510 Non-@code{nil} means that the user will always be asked to save a file
5513 @item gnus-uu-ignore-default-view-rules
5514 @vindex gnus-uu-ignore-default-view-rules
5515 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5518 @item gnus-uu-ignore-default-archive-rules
5519 @vindex gnus-uu-ignore-default-archive-rules
5520 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5523 @item gnus-uu-kill-carriage-return
5524 @vindex gnus-uu-kill-carriage-return
5525 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5528 @item gnus-uu-unmark-articles-not-decoded
5529 @vindex gnus-uu-unmark-articles-not-decoded
5530 Non-@code{nil} means that @code{gnus-uu} will mark articles that were
5531 unsuccessfully decoded as unread.
5533 @item gnus-uu-correct-stripped-uucode
5534 @vindex gnus-uu-correct-stripped-uucode
5535 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5536 uuencoded files that have had trailing spaces deleted.
5538 @item gnus-uu-view-with-metamail
5539 @vindex gnus-uu-view-with-metamail
5541 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5542 commands defined by the rule variables and just fudge a @sc{mime}
5543 content type based on the file name. The result will be fed to
5544 @code{metamail} for viewing.
5546 @item gnus-uu-save-in-digest
5547 @vindex gnus-uu-save-in-digest
5548 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5549 decoding, will save in digests. If this variable is @code{nil},
5550 @code{gnus-uu} will just save everything in a file without any
5551 embellishments. The digesting almost conforms to RFC1153---no easy way
5552 to specify any meaningful volume and issue numbers were found, so I
5553 simply dropped them.
5558 @node Uuencoding and Posting
5559 @subsubsection Uuencoding and Posting
5563 @item gnus-uu-post-include-before-composing
5564 @vindex gnus-uu-post-include-before-composing
5565 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5566 before you compose the article. If this variable is @code{t}, you can
5567 either include an encoded file with @kbd{C-c C-i} or have one included
5568 for you when you post the article.
5570 @item gnus-uu-post-length
5571 @vindex gnus-uu-post-length
5572 Maximum length of an article. The encoded file will be split into how
5573 many articles it takes to post the entire file.
5575 @item gnus-uu-post-threaded
5576 @vindex gnus-uu-post-threaded
5577 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
5578 thread. This may not be smart, as no other decoder I have seen are able
5579 to follow threads when collecting uuencoded articles. (Well, I have
5580 seen one package that does that---@code{gnus-uu}, but somehow, I don't
5581 think that counts...) Default is @code{nil}.
5583 @item gnus-uu-post-separate-description
5584 @vindex gnus-uu-post-separate-description
5585 Non-@code{nil} means that the description will be posted in a separate
5586 article. The first article will typically be numbered (0/x). If this
5587 variable is @code{nil}, the description the user enters will be included
5588 at the beginning of the first article, which will be numbered (1/x).
5589 Default is @code{t}.
5595 @subsection Viewing Files
5596 @cindex viewing files
5597 @cindex pseudo-articles
5599 After decoding, if the file is some sort of archive, Gnus will attempt
5600 to unpack the archive and see if any of the files in the archive can be
5601 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
5602 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
5603 uncompress and de-tar the main file, and then view the two pictures.
5604 This unpacking process is recursive, so if the archive contains archives
5605 of archives, it'll all be unpacked.
5607 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
5608 extracted file into the summary buffer. If you go to these
5609 ``articles'', you will be prompted for a command to run (usually Gnus
5610 will make a suggestion), and then the command will be run.
5612 @vindex gnus-view-pseudo-asynchronously
5613 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
5614 until the viewing is done before proceeding.
5616 @vindex gnus-view-pseudos
5617 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
5618 the pseudo-articles into the summary buffer, but view them
5619 immediately. If this variable is @code{not-confirm}, the user won't even
5620 be asked for a confirmation before viewing is done.
5622 @vindex gnus-view-pseudos-separately
5623 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
5624 pseudo-article will be created for each file to be viewed. If
5625 @code{nil}, all files that use the same viewing command will be given as
5626 a list of parameters to that command.
5628 @vindex gnus-insert-pseudo-articles
5629 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
5630 pseudo-articles when decoding. It is @code{t} by default.
5632 So; there you are, reading your @emph{pseudo-articles} in your
5633 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
5634 Why isn't anything real anymore? How did we get here?
5637 @node Article Treatment
5638 @section Article Treatment
5640 Reading through this huge manual, you may have quite forgotten that the
5641 object of newsreaders are to actually, like, read what people have
5642 written. Reading articles. Unfortunately, people are quite bad at
5643 writing, so there are tons of functions and variables to make reading
5644 these articles easier.
5647 * Article Highlighting:: You want to make the article look like fruit salad.
5648 * Article Fontisizing:: Making emphasized text look niced.
5649 * Article Hiding:: You also want to make certain info go away.
5650 * Article Washing:: Lots of way-neat functions to make life better.
5651 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
5652 * Article Date:: Grumble, UT!
5653 * Article Signature:: What is a signature?
5657 @node Article Highlighting
5658 @subsection Article Highlighting
5661 Not only do you want your article buffer to look like fruit salad, but
5662 you want it to look like technicolor fruit salad.
5667 @kindex W H a (Summary)
5668 @findex gnus-article-highlight
5669 Highlight the current article (@code{gnus-article-highlight}).
5672 @kindex W H h (Summary)
5673 @findex gnus-article-highlight-headers
5674 @vindex gnus-header-face-alist
5675 Highlight the headers (@code{gnus-article-highlight-headers}). The
5676 highlighting will be done according to the @code{gnus-header-face-alist}
5677 variable, which is a list where each element has the form @var{(regexp
5678 name content)}. @var{regexp} is a regular expression for matching the
5679 header, @var{name} is the face used for highlighting the header name and
5680 @var{content} is the face for highlighting the header value. The first
5681 match made will be used. Note that @var{regexp} shouldn't have @samp{^}
5682 prepended---Gnus will add one.
5685 @kindex W H c (Summary)
5686 @findex gnus-article-highlight-citation
5687 Highlight cited text (@code{gnus-article-highlight-citation}).
5689 Some variables to customize the citation highlights:
5692 @vindex gnus-cite-parse-max-size
5694 @item gnus-cite-parse-max-size
5695 If the article size if bigger than this variable (which is 25000 by
5696 default), no citation highlighting will be performed.
5698 @item gnus-cite-prefix-regexp
5699 @vindex gnus-cite-prefix-regexp
5700 Regexp matching the longest possible citation prefix on a line.
5702 @item gnus-cite-max-prefix
5703 @vindex gnus-cite-max-prefix
5704 Maximum possible length for a citation prefix (default 20).
5706 @item gnus-cite-face-list
5707 @vindex gnus-cite-face-list
5708 List of faces used for highlighting citations. When there are citations
5709 from multiple articles in the same message, Gnus will try to give each
5710 citation from each article its own face. This should make it easier to
5713 @item gnus-supercite-regexp
5714 @vindex gnus-supercite-regexp
5715 Regexp matching normal Supercite attribution lines.
5717 @item gnus-supercite-secondary-regexp
5718 @vindex gnus-supercite-secondary-regexp
5719 Regexp matching mangled Supercite attribution lines.
5721 @item gnus-cite-minimum-match-count
5722 @vindex gnus-cite-minimum-match-count
5723 Minimum number of identical prefixes we have to see before we believe
5724 that it's a citation.
5726 @item gnus-cite-attribution-prefix
5727 @vindex gnus-cite-attribution-prefix
5728 Regexp matching the beginning of an attribution line.
5730 @item gnus-cite-attribution-suffix
5731 @vindex gnus-cite-attribution-suffix
5732 Regexp matching the end of an attribution line.
5734 @item gnus-cite-attribution-face
5735 @vindex gnus-cite-attribution-face
5736 Face used for attribution lines. It is merged with the face for the
5737 cited text belonging to the attribution.
5743 @kindex W H s (Summary)
5744 @vindex gnus-signature-separator
5745 @vindex gnus-signature-face
5746 @findex gnus-article-highlight-signature
5747 Highlight the signature (@code{gnus-article-highlight-signature}).
5748 Everything after @code{gnus-signature-separator} (@pxref{Article
5749 Signature}) in an article will be considered a signature and will be
5750 highlighted with @code{gnus-signature-face}, which is @code{italic} by
5756 @node Article Fontisizing
5757 @subsection Article Fontisizing
5759 @cindex article emphasis
5761 @findex gnus-article-emphasize
5762 @kindex W e (Summary)
5763 People commonly add emphasis to words in news articles by writing things
5764 like @samp{_this_} or @samp{*this*}. Gnus can make this look nicer by
5765 running the article through the @kbd{W e}
5766 (@code{gnus-article-emphasize}) command.
5768 @vindex gnus-article-emphasis
5769 How the emphasis is computed is controlled by the
5770 @code{gnus-article-emphasis} variable. This is an alist where the first
5771 element is a regular expression to be matched. The second is a number
5772 that says what regular expression grouping used to find the entire
5773 emphasized word. The third is a number that says what regexp grouping
5774 should be displayed and highlighted. (The text between these two
5775 groupings will be hidden.) The fourth is the face used for
5779 (setq gnus-article-emphasis
5780 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
5781 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
5784 @vindex gnus-emphasis-underline
5785 @vindex gnus-emphasis-bold
5786 @vindex gnus-emphasis-italic
5787 @vindex gnus-emphasis-underline-bold
5788 @vindex gnus-emphasis-underline-italic
5789 @vindex gnus-emphasis-bold-italic
5790 @vindex gnus-emphasis-underline-bold-italic
5791 By default, there are seven rules, and they use the following faces:
5792 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
5793 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
5794 @code{gnus-emphasis-underline-italic},
5795 @code{gnus-emphasis-undeline-bold}, and
5796 @code{gnus-emphasis-underline-bold-italic}.
5798 If you want to change these faces, you can either use @kbd{M-x
5799 customize}, or you can use @code{copy-face}. For instance, if you want
5800 to make @code{gnus-emphasis-italic} use a red face instead, you could
5804 (copy-face 'red 'gnus-emphasis-italic)
5808 @node Article Hiding
5809 @subsection Article Hiding
5810 @cindex article hiding
5812 Or rather, hiding certain things in each article. There usually is much
5813 too much cruft in most articles.
5818 @kindex W W a (Summary)
5819 @findex gnus-article-hide
5820 Do maximum hiding on the summary buffer (@kbd{gnus-article-hide}).
5823 @kindex W W h (Summary)
5824 @findex gnus-article-hide-headers
5825 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
5829 @kindex W W b (Summary)
5830 @findex gnus-article-hide-boring-headers
5831 Hide headers that aren't particularly interesting
5832 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
5835 @kindex W W s (Summary)
5836 @findex gnus-article-hide-signature
5837 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
5841 @kindex W W p (Summary)
5842 @findex gnus-article-hide-pgp
5843 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}).
5846 @kindex W W P (Summary)
5847 @findex gnus-article-hide-pem
5848 Hide @sc{pem} (privacy enhanced messages) gruft
5849 (@code{gnus-article-hide-pem}).
5852 @kindex W W c (Summary)
5853 @findex gnus-article-hide-citation
5854 Hide citation (@code{gnus-article-hide-citation}). Some variables for
5855 customizing the hiding:
5859 @item gnus-cite-hide-percentage
5860 @vindex gnus-cite-hide-percentage
5861 If the cited text is of a bigger percentage than this variable (default
5862 50), hide the cited text.
5864 @item gnus-cite-hide-absolute
5865 @vindex gnus-cite-hide-absolute
5866 The cited text must be have at least this length (default 10) before it
5869 @item gnus-cited-text-button-line-format
5870 @vindex gnus-cited-text-button-line-format
5871 Gnus adds buttons show where the cited text has been hidden, and to
5872 allow toggle hiding the text. The format of the variable is specified
5873 by this format-like variable (@pxref{Formatting Variables}). These
5878 Start point of the hidden text.
5880 End point of the hidden text.
5882 Length of the hidden text.
5885 @item gnus-cited-lines-visible
5886 @vindex gnus-cited-lines-visible
5887 The number of lines at the beginning of the cited text to leave shown.
5892 @kindex W W C (Summary)
5893 @findex gnus-article-hide-citation-in-followups
5894 Hide cited text in articles that aren't roots
5895 (@code{gnus-article-hide-citation-in-followups}). This isn't very
5896 useful as an interactive command, but might be a handy function to stick
5897 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}).
5901 All these ``hiding'' commands are toggles, but if you give a negative
5902 prefix to these commands, they will show what they have previously
5903 hidden. If you give a positive prefix, they will always hide.
5905 Also @pxref{Article Highlighting} for further variables for
5906 citation customization.
5909 @node Article Washing
5910 @subsection Article Washing
5912 @cindex article washing
5914 We call this ``article washing'' for a really good reason. Namely, the
5915 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
5917 @dfn{Washing} is defined by us as ``changing something from something to
5918 something else'', but normally results in something looking better.
5924 @kindex W l (Summary)
5925 @findex gnus-summary-stop-page-breaking
5926 Remove page breaks from the current article
5927 (@code{gnus-summary-stop-page-breaking}).
5930 @kindex W r (Summary)
5931 @findex gnus-summary-caesar-message
5932 Do a Caesar rotate (rot13) on the article buffer
5933 (@code{gnus-summary-caesar-message}).
5936 @kindex W t (Summary)
5937 @findex gnus-summary-toggle-header
5938 Toggle whether to display all headers in the article buffer
5939 (@code{gnus-summary-toggle-header}).
5942 @kindex W v (Summary)
5943 @findex gnus-summary-verbose-header
5944 Toggle whether to display all headers in the article buffer permanently
5945 (@code{gnus-summary-verbose-header}).
5948 @kindex W m (Summary)
5949 @findex gnus-summary-toggle-mime
5950 Toggle whether to run the article through @sc{mime} before displaying
5951 (@code{gnus-summary-toggle-mime}).
5954 @kindex W o (Summary)
5955 @findex gnus-article-treat-overstrike
5956 Treat overstrike (@code{gnus-article-treat-overstrike}).
5959 @kindex W w (Summary)
5960 @findex gnus-article-fill-cited-article
5961 Do word wrap (@code{gnus-article-fill-cited-article}). If you use this
5962 function in @code{gnus-article-display-hook}, it should be run fairly
5963 late and certainly after any highlighting.
5965 You can give the command a numerical prefix to specify the width to use
5969 @kindex W c (Summary)
5970 @findex gnus-article-remove-cr
5971 Remove CR (@code{gnus-article-remove-cr}).
5974 @kindex W q (Summary)
5975 @findex gnus-article-de-quoted-unreadable
5976 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
5979 @kindex W f (Summary)
5981 @findex gnus-article-display-x-face
5982 @findex gnus-article-x-face-command
5983 @vindex gnus-article-x-face-command
5984 @vindex gnus-article-x-face-too-ugly
5985 Look for and display any X-Face headers
5986 (@code{gnus-article-display-x-face}). The command executed by this
5987 function is given by the @code{gnus-article-x-face-command} variable.
5988 If this variable is a string, this string will be executed in a
5989 sub-shell. If it is a function, this function will be called with the
5990 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
5991 is a regexp) matches the @code{From} header, the face will not be shown.
5992 The default action under Emacs is to fork off an @code{xv} to view the
5993 face; under XEmacs the default action is to display the face before the
5994 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
5995 support---that will make display somewhat faster. If there's no native
5996 X-Face support, Gnus will try to convert the @code{X-Face} header using
5997 external programs from the @code{pbmplus} package and friends.) If you
5998 want to have this function in the display hook, it should probably come
6002 @kindex W b (Summary)
6003 @findex gnus-article-add-buttons
6004 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6007 @kindex W B (Summary)
6008 @findex gnus-article-add-buttons-to-head
6009 Add clickable buttons to the article headers
6010 (@code{gnus-article-add-buttons-to-head}).
6013 @kindex W E l (Summary)
6014 @findex gnus-article-strip-leading-blank-lines
6015 Remove all blank lines from the beginning of the article
6016 (@code{gnus-article-strip-leading-blank-lines}).
6019 @kindex W E m (Summary)
6020 @findex gnus-article-strip-multiple-blank-lines
6021 Replace all blank lines with empty lines and then all multiple empty
6022 lines with a single empty line.
6023 (@code{gnus-article-strip-multiple-blank-lines}).
6026 @kindex W E t (Summary)
6027 @findex gnus-article-remove-trailing-blank-lines
6028 Remove all blank lines at the end of the article
6029 (@code{gnus-article-remove-trailing-blank-lines}).
6032 @kindex W E a (Summary)
6033 @findex gnus-article-strip-blank-lines
6034 Do all the three commands above
6035 (@code{gnus-article-strip-blank-lines}).
6038 @kindex W E s (Summary)
6039 @findex gnus-article-strip-leading-space
6040 Remove all white space from the beginning of all lines of the article
6041 body (@code{gnus-article-strip-leading-space}).
6046 @node Article Buttons
6047 @subsection Article Buttons
6050 People often include references to other stuff in articles, and it would
6051 be nice if Gnus could just fetch whatever it is that people talk about
6052 with the minimum of fuzz.
6054 Gnus adds @dfn{buttons} to certain standard references by default:
6055 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
6056 two variables, one that handles article bodies and one that handles
6061 @item gnus-button-alist
6062 @vindex gnus-button-alist
6063 This is an alist where each entry has this form:
6066 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6072 All text that match this regular expression will be considered an
6073 external reference. Here's a typical regexp that match embedded URLs:
6074 @samp{<URL:\\([^\n\r>]*\\)>}.
6077 Gnus has to know which parts of the match is to be highlighted. This is
6078 a number that says what sub-expression of the regexp that is to be
6079 highlighted. If you want it all highlighted, you use 0 here.
6082 This form will be @code{eval}ed, and if the result is non-@code{nil},
6083 this is considered a match. This is useful if you want extra sifting to
6084 avoid false matches.
6087 This function will be called when you click on this button.
6090 As with @var{button-par}, this is a sub-expression number, but this one
6091 says which part of the match is to be sent as data to @var{function}.
6095 So the full entry for buttonizing URLs is then
6098 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6101 @item gnus-header-button-alist
6102 @vindex gnus-header-button-alist
6103 This is just like the other alist, except that it is applied to the
6104 article head only, and that each entry has an additional element that is
6105 used to say what headers to apply the buttonize coding to:
6108 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6111 @var{header} is a regular expression.
6113 @item gnus-button-url-regexp
6114 @vindex gnus-button-url-regexp
6115 A regular expression that matches embedded URLs. It is used in the
6116 default values of the variables above.
6118 @item gnus-article-button-face
6119 @vindex gnus-article-button-face
6120 Face used on buttons.
6122 @item gnus-article-mouse-face
6123 @vindex gnus-article-mouse-face
6124 Face is used when the mouse cursor is over a button.
6130 @subsection Article Date
6132 The date is most likely generated in some obscure timezone you've never
6133 heard of, so it's quite nice to be able to find out what the time was
6134 when the article was sent.
6139 @kindex W T u (Summary)
6140 @findex gnus-article-date-ut
6141 Display the date in UT (aka. GMT, aka ZULU)
6142 (@code{gnus-article-date-ut}).
6145 @kindex W T l (Summary)
6146 @findex gnus-article-date-local
6147 Display the date in the local timezone (@code{gnus-article-date-local}).
6150 @kindex W T s (Summary)
6151 @vindex gnus-article-time-format
6152 @findex gnus-article-date-user
6153 @findex format-time-string
6154 Display the date using a user-defined format
6155 (@code{gnus-article-date-user}). The format is specified by the
6156 @code{gnus-article-time-format} variable, and is a string that's passed
6157 to @code{format-time-string}. See the documentation of that variable
6158 for a list possible format specs.
6161 @kindex W T e (Summary)
6162 @findex gnus-article-date-lapsed
6163 Say how much time has (e)lapsed between the article was posted and now
6164 (@code{gnus-article-date-lapsed}).
6167 @kindex W T o (Summary)
6168 @findex gnus-article-date-original
6169 Display the original date (@code{gnus-article-date-original}). This can
6170 be useful if you normally use some other conversion function and is
6171 worried that it might be doing something totally wrong. Say, claiming
6172 that the article was posted in 1854. Although something like that is
6173 @emph{totally} impossible. Don't you trust me? *titter*
6178 @node Article Signature
6179 @subsection Article Signature
6181 @cindex article signature
6183 @vindex gnus-signature-separator
6184 Each article is divided into two parts---the head and the body. The
6185 body can be divided into a signature part and a text part. The variable
6186 that says what is to be considered a signature is
6187 @code{gnus-signature-separator}. This is normally the standard
6188 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
6189 non-standard signature separators, so this variable can also be a list
6190 of regular expressions to be tested, one by one. (Searches are done
6191 from the end of the body towards the beginning.) One likely value is:
6194 (setq gnus-signature-separator
6195 '("^-- $" ; The standard
6196 "^-- *$" ; A common mangling
6197 "^-------*$" ; Many people just use a looong
6198 ; line of dashes. Shame!
6199 "^ *--------*$" ; Double-shame!
6200 "^________*$" ; Underscores are also popular
6201 "^========*$")) ; Pervert!
6204 The more permissive you are, the more likely it is that you'll get false
6207 @vindex gnus-signature-limit
6208 @code{gnus-signature-limit} provides a limit to what is considered a
6213 If it is an integer, no signature may be longer (in characters) than
6216 If it is a floating point number, no signature may be longer (in lines)
6219 If it is a function, the function will be called without any parameters,
6220 and if it returns @code{nil}, there is no signature in the buffer.
6222 If it is a string, it will be used as a regexp. If it matches, the text
6223 in question is not a signature.
6226 This variable can also be a list where the elements may be of the types
6230 @node Article Commands
6231 @section Article Commands
6238 @kindex A P (Summary)
6239 @vindex gnus-ps-print-hook
6240 @findex gnus-summary-print-article
6241 Generate and print a PostScript image of the article buffer
6242 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
6243 run just before printing the buffer.
6248 @node Summary Sorting
6249 @section Summary Sorting
6250 @cindex summary sorting
6252 You can have the summary buffer sorted in various ways, even though I
6253 can't really see why you'd want that.
6258 @kindex C-c C-s C-n (Summary)
6259 @findex gnus-summary-sort-by-number
6260 Sort by article number (@code{gnus-summary-sort-by-number}).
6263 @kindex C-c C-s C-a (Summary)
6264 @findex gnus-summary-sort-by-author
6265 Sort by author (@code{gnus-summary-sort-by-author}).
6268 @kindex C-c C-s C-s (Summary)
6269 @findex gnus-summary-sort-by-subject
6270 Sort by subject (@code{gnus-summary-sort-by-subject}).
6273 @kindex C-c C-s C-d (Summary)
6274 @findex gnus-summary-sort-by-date
6275 Sort by date (@code{gnus-summary-sort-by-date}).
6278 @kindex C-c C-s C-l (Summary)
6279 @findex gnus-summary-sort-by-lines
6280 Sort by lines (@code{gnus-summary-sort-by-lines}).
6283 @kindex C-c C-s C-i (Summary)
6284 @findex gnus-summary-sort-by-score
6285 Sort by score (@code{gnus-summary-sort-by-score}).
6288 These functions will work both when you use threading and when you don't
6289 use threading. In the latter case, all summary lines will be sorted,
6290 line by line. In the former case, sorting will be done on a
6291 root-by-root basis, which might not be what you were looking for. To
6292 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6296 @node Finding the Parent
6297 @section Finding the Parent
6298 @cindex parent articles
6299 @cindex referring articles
6301 @findex gnus-summary-refer-parent-article
6303 If you'd like to read the parent of the current article, and it is not
6304 displayed in the summary buffer, you might still be able to. That is,
6305 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6306 and the @code{References} in the current article are not mangled, you
6307 can just press @kbd{^} or @kbd{A r}
6308 (@code{gnus-summary-refer-parent-article}). If everything goes well,
6309 you'll get the parent. If the parent is already displayed in the
6310 summary buffer, point will just move to this article.
6312 If given a positive numerical prefix, fetch that many articles back into
6313 the ancestry. If given a negative numerical prefix, fetch just that
6314 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6315 grandparent and the grandgrandparent of the current article. If you say
6316 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6319 @findex gnus-summary-refer-references
6320 @kindex A R (Summary)
6321 You can have Gnus fetch all articles mentioned in the @code{References}
6322 header of the article by pushing @kbd{A R}
6323 (@code{gnus-summary-refer-references}).
6325 @findex gnus-summary-refer-article
6326 @kindex M-^ (Summary)
6328 @cindex fetching by Message-ID
6329 You can also ask the @sc{nntp} server for an arbitrary article, no
6330 matter what group it belongs to. @kbd{M-^}
6331 (@code{gnus-summary-refer-article}) will ask you for a
6332 @code{Message-ID}, which is one of those long, hard-to-read thingies
6333 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
6334 have to get it all exactly right. No fuzzy searches, I'm afraid.
6336 The current select method will be used when fetching by
6337 @code{Message-ID} from non-news select method, but you can override this
6338 by giving this command a prefix.
6340 @vindex gnus-refer-article-method
6341 If the group you are reading is located on a backend that does not
6342 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6343 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
6344 would, perhaps, be best if the @sc{nntp} server you consult is the same
6345 as the one that keeps the spool you are reading from updated, but that's
6346 not really necessary.
6348 Most of the mail backends support fetching by @code{Message-ID}, but do
6349 not do a particularly excellent job of it. That is, @code{nnmbox} and
6350 @code{nnbabyl} are able to locate articles from any groups, while
6351 @code{nnml} and @code{nnfolder} are only able to locate articles that
6352 have been posted to the current group. (Anything else would be too time
6353 consuming.) @code{nnmh} does not support this at all.
6356 @node Alternative Approaches
6357 @section Alternative Approaches
6359 Different people like to read news using different methods. This being
6360 Gnus, we offer a small selection of minor modes for the summary buffers.
6363 * Pick and Read:: First mark articles and then read them.
6364 * Binary Groups:: Auto-decode all articles.
6369 @subsection Pick and Read
6370 @cindex pick and read
6372 Some newsreaders (like @code{nn} and, uhm, @code{nn}) use a two-phased
6373 reading interface. The user first marks the articles she wants to read
6374 from a summary buffer. Then she starts reading the articles with just
6375 an article buffer displayed.
6377 @findex gnus-pick-mode
6378 @kindex M-x gnus-pick-mode
6379 Gnus provides a summary buffer minor mode that allows
6380 this---@code{gnus-pick-mode}. This basically means that a few process
6381 mark commands become one-keystroke commands to allow easy marking, and
6382 it makes one additional command for switching to the summary buffer
6385 Here are the available keystrokes when using pick mode:
6390 @findex gnus-summary-mark-as-processable
6391 Pick the article on the current line
6392 (@code{gnus-summary-mark-as-processable}). If given a numerical prefix,
6393 go to the article on that line and pick that article. (The line number
6394 is normally displayed on the beginning of the summary pick lines.)
6397 @kindex SPACE (Pick)
6398 @findex gnus-pick-next-page
6399 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
6400 at the end of the buffer, start reading the picked articles.
6404 @findex gnus-summary-unmark-as-processable
6405 Unpick the article (@code{gnus-summary-unmark-as-processable}).
6409 @findex gnus-summary-unmark-all-processable
6410 Unpick all articles (@code{gnus-summary-unmark-all-processable}).
6414 @findex gnus-uu-mark-thread
6415 Pick the thread (@code{gnus-uu-mark-thread}).
6419 @findex gnus-uu-unmark-thread
6420 Unpick the thread (@code{gnus-uu-unmark-thread}).
6424 @findex gnus-uu-mark-region
6425 Pick the region (@code{gnus-uu-mark-region}).
6429 @findex gnus-uu-unmark-region
6430 Unpick the region (@code{gnus-uu-unmark-region}).
6434 @findex gnus-uu-mark-by-regexp
6435 Pick articles that match a regexp (@code{gnus-uu-mark-by-regexp}).
6439 @findex gnus-uu-unmark-by-regexp
6440 Unpick articles that match a regexp (@code{gnus-uu-unmark-by-regexp}).
6444 @findex gnus-uu-mark-buffer
6445 Pick the buffer (@code{gnus-uu-mark-buffer}).
6449 @findex gnus-uu-unmark-buffer
6450 Unpick the buffer (@code{gnus-uu-unmark-buffer}).
6454 @findex gnus-pick-start-reading
6455 @vindex gnus-pick-display-summary
6456 Start reading the picked articles (@code{gnus-pick-start-reading}). If
6457 given a prefix, mark all unpicked articles as read first. If
6458 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6459 will still be visible when you are reading.
6463 If this sounds like a good idea to you, you could say:
6466 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6469 @vindex gnus-pick-mode-hook
6470 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6472 @vindex gnus-mark-unpicked-articles-as-read
6473 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6474 all unpicked articles as read. The default is @code{nil}.
6476 @vindex gnus-summary-pick-line-format
6477 The summary line format in pick mode is slightly different than the
6478 standard format. At the beginning of each line the line number is
6479 displayed. The pick mode line format is controlled by the
6480 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
6481 Variables}). It accepts the same format specs that
6482 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
6486 @subsection Binary Groups
6487 @cindex binary groups
6489 @findex gnus-binary-mode
6490 @kindex M-x gnus-binary-mode
6491 If you spend much time in binary groups, you may grow tired of hitting
6492 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
6493 is a minor mode for summary buffers that makes all ordinary Gnus article
6494 selection functions uudecode series of articles and display the result
6495 instead of just displaying the articles the normal way.
6498 @findex gnus-binary-show-article
6499 In fact, the only way to see the actual articles if you have turned this
6500 mode on is the @kbd{g} command (@code{gnus-binary-show-article}).
6502 @vindex gnus-binary-mode-hook
6503 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
6507 @section Tree Display
6510 @vindex gnus-use-trees
6511 If you don't like the normal Gnus summary display, you might try setting
6512 @code{gnus-use-trees} to @code{t}. This will create (by default) an
6513 additional @dfn{tree buffer}. You can execute all summary mode commands
6516 There are a few variables to customize the tree display, of course:
6519 @item gnus-tree-mode-hook
6520 @vindex gnus-tree-mode-hook
6521 A hook called in all tree mode buffers.
6523 @item gnus-tree-mode-line-format
6524 @vindex gnus-tree-mode-line-format
6525 A format string for the mode bar in the tree mode buffers. The default
6526 is @samp{Gnus: %%b [%A] %Z}. For a list of legal specs, @pxref{Summary
6529 @item gnus-selected-tree-face
6530 @vindex gnus-selected-tree-face
6531 Face used for highlighting the selected article in the tree buffer. The
6532 default is @code{modeline}.
6534 @item gnus-tree-line-format
6535 @vindex gnus-tree-line-format
6536 A format string for the tree nodes. The name is a bit of a misnomer,
6537 though---it doesn't define a line, but just the node. The default value
6538 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
6539 the name of the poster. It is vital that all nodes are of the same
6540 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
6546 The name of the poster.
6548 The @code{From} header.
6550 The number of the article.
6552 The opening bracket.
6554 The closing bracket.
6559 @xref{Formatting Variables}.
6561 Variables related to the display are:
6564 @item gnus-tree-brackets
6565 @vindex gnus-tree-brackets
6566 This is used for differentiating between ``real'' articles and
6567 ``sparse'' articles. The format is @var{((real-open . real-close)
6568 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
6569 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}))}.
6571 @item gnus-tree-parent-child-edges
6572 @vindex gnus-tree-parent-child-edges
6573 This is a list that contains the characters used for connecting parent
6574 nodes to their children. The default is @code{(?- ?\\ ?|)}.
6578 @item gnus-tree-minimize-window
6579 @vindex gnus-tree-minimize-window
6580 If this variable is non-@code{nil}, Gnus will try to keep the tree
6581 buffer as small as possible to allow more room for the other Gnus
6582 windows. If this variable is a number, the tree buffer will never be
6583 higher than that number. The default is @code{t}. Note that if you
6584 have several windows displayed side-by-side in a frame and the tree
6585 buffer is one of these, minimizing the tree window will also resize all
6586 other windows that are displayed next to it.
6588 @item gnus-generate-tree-function
6589 @vindex gnus-generate-tree-function
6590 @findex gnus-generate-horizontal-tree
6591 @findex gnus-generate-vertical-tree
6592 The function that actually generates the thread tree. Two predefined
6593 functions are available: @code{gnus-generate-horizontal-tree} and
6594 @code{gnus-generate-vertical-tree} (which is the default).
6598 Here's and example from a horizontal tree buffer:
6601 @{***@}-(***)-[odd]-[Gun]
6611 Here's the same thread displayed in a vertical tree buffer:
6615 |--------------------------\-----\-----\
6616 (***) [Bjo] [Gun] [Gun]
6618 [odd] [Jan] [odd] (***) [Jor]
6620 [Gun] [Eri] [Eri] [odd]
6626 @node Mail Group Commands
6627 @section Mail Group Commands
6628 @cindex mail group commands
6630 Some commands only make sense in mail groups. If these commands are
6631 illegal in the current group, they will raise a hell and let you know.
6633 All these commands (except the expiry and edit commands) use the
6634 process/prefix convention (@pxref{Process/Prefix}).
6639 @kindex B e (Summary)
6640 @findex gnus-summary-expire-articles
6641 Expire all expirable articles in the group
6642 (@code{gnus-summary-expire-articles}).
6645 @kindex B M-C-e (Summary)
6646 @findex gnus-summary-expire-articles-now
6647 Delete all the expirable articles in the group
6648 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
6649 articles that are eligible for expiry in the current group will
6650 disappear forever into that big @file{/dev/null} in the sky.
6653 @kindex B DEL (Summary)
6654 @findex gnus-summary-delete-article
6655 Delete the mail article. This is ``delete'' as in ``delete it from your
6656 disk forever and ever, never to return again.'' Use with caution.
6657 (@code{gnus-summary-delete-article}).
6660 @kindex B m (Summary)
6662 @findex gnus-summary-move-article
6663 Move the article from one mail group to another
6664 (@code{gnus-summary-move-article}).
6667 @kindex B c (Summary)
6669 @findex gnus-summary-copy-article
6670 Copy the article from one group (mail group or not) to a mail group
6671 (@code{gnus-summary-copy-article}).
6674 @kindex B C (Summary)
6675 @cindex crosspost mail
6676 @findex gnus-summary-crosspost-article
6677 Crosspost the current article to some other group
6678 (@code{gnus-summary-crosspost-article}). This will create a new copy of
6679 the article in the other group, and the Xref headers of the article will
6680 be properly updated.
6683 @kindex B i (Summary)
6684 @findex gnus-summary-import-article
6685 Import an arbitrary file into the current mail newsgroup
6686 (@code{gnus-summary-import-article}). You will be prompted for a file
6687 name, a @code{From} header and a @code{Subject} header.
6690 @kindex B r (Summary)
6691 @findex gnus-summary-respool-article
6692 Respool the mail article (@code{gnus-summary-move-article}).
6693 @code{gnus-summary-respool-default-method} will be used as the default
6694 select method when respooling. This variable is @code{nil} by default,
6695 which means that the current group select method will be used instead.
6699 @kindex B w (Summary)
6701 @findex gnus-summary-edit-article
6702 @kindex C-c C-c (Article)
6703 Edit the current article (@code{gnus-summary-edit-article}). To finish
6704 editing and make the changes permanent, type @kbd{C-c C-c}
6705 (@kbd{gnus-summary-edit-article-done}).
6708 @kindex B q (Summary)
6709 @findex gnus-summary-respool-query
6710 If you want to re-spool an article, you might be curious as to what group
6711 the article will end up in before you do the re-spooling. This command
6712 will tell you (@code{gnus-summary-respool-query}).
6715 @kindex B p (Summary)
6716 @findex gnus-summary-article-posted-p
6717 Some people have a tendency to send you "courtesy" copies when they
6718 follow up to articles you have posted. These usually have a
6719 @code{Newsgroups} header in them, but not always. This command
6720 (@code{gnus-summary-article-posted-p}) will try to fetch the current
6721 article from your news server (or rather, from
6722 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
6723 report back whether it found the article or not. Even if it says that
6724 it didn't find the article, it may have been posted anyway---mail
6725 propagation is much faster than news propagation, and the news copy may
6726 just not have arrived yet.
6730 @vindex gnus-move-split-methods
6731 @cindex moving articles
6732 If you move (or copy) articles regularly, you might wish to have Gnus
6733 suggest where to put the articles. @code{gnus-move-split-methods} is a
6734 variable that uses the same syntax as @code{gnus-split-methods}
6735 (@pxref{Saving Articles}). You may customize that variable to create
6736 suggestions you find reasonable.
6739 (setq gnus-move-split-methods
6740 '(("^From:.*Lars Magne" "nnml:junk")
6741 ("^Subject:.*gnus" "nnfolder:important")
6742 (".*" "nnml:misc")))
6746 @node Various Summary Stuff
6747 @section Various Summary Stuff
6750 * Summary Group Information:: Information oriented commands.
6751 * Searching for Articles:: Multiple article commands.
6752 * Summary Generation Commands:: (Re)generating the summary buffer.
6753 * Really Various Summary Commands:: Those pesky non-conformant commands.
6757 @vindex gnus-summary-mode-hook
6758 @item gnus-summary-mode-hook
6759 This hook is called when creating a summary mode buffer.
6761 @vindex gnus-summary-generate-hook
6762 @item gnus-summary-generate-hook
6763 This is called as the last thing before doing the threading and the
6764 generation of the summary buffer. It's quite convenient for customizing
6765 the threading variables based on what data the newsgroup has. This hook
6766 is called from the summary buffer after most summary buffer variables
6769 @vindex gnus-summary-prepare-hook
6770 @item gnus-summary-prepare-hook
6771 Is is called after the summary buffer has been generated. You might use
6772 it to, for instance, highlight lines or modify the look of the buffer in
6773 some other ungodly manner. I don't care.
6775 @vindex gnus-summary-ignore-duplicates
6776 @item gnus-summary-ignore-duplicates
6777 When Gnus discovers two articles that have the same @code{Message-ID},
6778 it has to do something drastic. No articles are allowed to have the
6779 same @code{Message-ID}, but this may happen when reading mail from some
6780 sources. Gnus allows you to customize what happens with this variable.
6781 If it is @code{nil} (which is the default), Gnus will rename the
6782 @code{Message-ID} (for display purposes only) and display the article as
6783 any other article. If this variable is @code{t}, it won't display the
6784 article---it'll be as if it never existed.
6789 @node Summary Group Information
6790 @subsection Summary Group Information
6795 @kindex H f (Summary)
6796 @findex gnus-summary-fetch-faq
6797 @vindex gnus-group-faq-directory
6798 Try to fetch the FAQ (list of frequently asked questions) for the
6799 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
6800 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
6801 on a remote machine. This variable can also be a list of directories.
6802 In that case, giving a prefix to this command will allow you to choose
6803 between the various sites. @code{ange-ftp} probably will be used for
6807 @kindex H d (Summary)
6808 @findex gnus-summary-describe-group
6809 Give a brief description of the current group
6810 (@code{gnus-summary-describe-group}). If given a prefix, force
6811 rereading the description from the server.
6814 @kindex H h (Summary)
6815 @findex gnus-summary-describe-briefly
6816 Give an extremely brief description of the most important summary
6817 keystrokes (@code{gnus-summary-describe-briefly}).
6820 @kindex H i (Summary)
6821 @findex gnus-info-find-node
6822 Go to the Gnus info node (@code{gnus-info-find-node}).
6826 @node Searching for Articles
6827 @subsection Searching for Articles
6832 @kindex M-s (Summary)
6833 @findex gnus-summary-search-article-forward
6834 Search through all subsequent articles for a regexp
6835 (@code{gnus-summary-search-article-forward}).
6838 @kindex M-r (Summary)
6839 @findex gnus-summary-search-article-backward
6840 Search through all previous articles for a regexp
6841 (@code{gnus-summary-search-article-backward}).
6845 @findex gnus-summary-execute-command
6846 This command will prompt you for a header field, a regular expression to
6847 match on this field, and a command to be executed if the match is made
6848 (@code{gnus-summary-execute-command}).
6851 @kindex M-& (Summary)
6852 @findex gnus-summary-universal-argument
6853 Perform any operation on all articles that have been marked with
6854 the process mark (@code{gnus-summary-universal-argument}).
6857 @node Summary Generation Commands
6858 @subsection Summary Generation Commands
6863 @kindex Y g (Summary)
6864 @findex gnus-summary-prepare
6865 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
6868 @kindex Y c (Summary)
6869 @findex gnus-summary-insert-cached-articles
6870 Pull all cached articles (for the current group) into the summary buffer
6871 (@code{gnus-summary-insert-cached-articles}).
6876 @node Really Various Summary Commands
6877 @subsection Really Various Summary Commands
6882 @kindex C-d (Summary)
6883 @findex gnus-summary-enter-digest-group
6884 If the current article is a collection of other articles (for instance,
6885 a digest), you might use this command to enter a group based on the that
6886 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
6887 guess what article type is currently displayed unless you give a prefix
6888 to this command, which forces a ``digest'' interpretation. Basically,
6889 whenever you see a message that is a collection of other messages on
6890 some format, you @kbd{C-d} and read these messages in a more convenient
6894 @kindex M-C-d (Summary)
6895 @findex gnus-summary-read-document
6896 This command is very similar to the one above, but lets you gather
6897 several documents into one biiig group
6898 (@code{gnus-summary-read-document}). It does this by opening several
6899 @code{nndoc} groups for each document, and then opening an
6900 @code{nnvirtual} group on top of these @code{nndoc} groups. This
6901 command understands the process/prefix convention
6902 (@pxref{Process/Prefix}).
6905 @kindex C-t (Summary)
6906 @findex gnus-summary-toggle-truncation
6907 Toggle truncation of summary lines
6908 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
6909 line centering function in the summary buffer, so it's not a good idea
6910 to have truncation switched off while reading articles.
6914 @findex gnus-summary-expand-window
6915 Expand the summary buffer window (@code{gnus-summary-expand-window}).
6916 If given a prefix, force an @code{article} window configuration.
6921 @node Exiting the Summary Buffer
6922 @section Exiting the Summary Buffer
6923 @cindex summary exit
6924 @cindex exiting groups
6926 Exiting from the summary buffer will normally update all info on the
6927 group and return you to the group buffer.
6933 @kindex Z Z (Summary)
6935 @findex gnus-summary-exit
6936 @vindex gnus-summary-exit-hook
6937 @vindex gnus-summary-prepare-exit-hook
6938 Exit the current group and update all information on the group
6939 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
6940 called before doing much of the exiting, and calls
6941 @code{gnus-summary-expire-articles} by default.
6942 @code{gnus-summary-exit-hook} is called after finishing the exiting
6943 process. @code{gnus-group-no-more-groups-hook} is run when returning to
6944 group mode having no more (unread) groups.
6948 @kindex Z E (Summary)
6950 @findex gnus-summary-exit-no-update
6951 Exit the current group without updating any information on the group
6952 (@code{gnus-summary-exit-no-update}).
6956 @kindex Z c (Summary)
6958 @findex gnus-summary-catchup-and-exit
6959 Mark all unticked articles in the group as read and then exit
6960 (@code{gnus-summary-catchup-and-exit}).
6963 @kindex Z C (Summary)
6964 @findex gnus-summary-catchup-all-and-exit
6965 Mark all articles, even the ticked ones, as read and then exit
6966 (@code{gnus-summary-catchup-all-and-exit}).
6969 @kindex Z n (Summary)
6970 @findex gnus-summary-catchup-and-goto-next-group
6971 Mark all articles as read and go to the next group
6972 (@code{gnus-summary-catchup-and-goto-next-group}).
6975 @kindex Z R (Summary)
6976 @findex gnus-summary-reselect-current-group
6977 Exit this group, and then enter it again
6978 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
6979 all articles, both read and unread.
6983 @kindex Z G (Summary)
6984 @kindex M-g (Summary)
6985 @findex gnus-summary-rescan-group
6986 Exit the group, check for new articles in the group, and select the
6987 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
6988 articles, both read and unread.
6991 @kindex Z N (Summary)
6992 @findex gnus-summary-next-group
6993 Exit the group and go to the next group
6994 (@code{gnus-summary-next-group}).
6997 @kindex Z P (Summary)
6998 @findex gnus-summary-prev-group
6999 Exit the group and go to the previous group
7000 (@code{gnus-summary-prev-group}).
7003 @kindex Z s (Summary)
7004 @findex gnus-summary-save-newsrc
7005 Save the current number of read/marked articles in the dribble buffer
7006 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
7007 given a prefix, also save the @file{.newsrc} file(s). Using this
7008 command will make exit without updating (the @kbd{Q} command) worthless.
7011 @vindex gnus-exit-group-hook
7012 @code{gnus-exit-group-hook} is called when you exit the current
7015 @findex gnus-summary-wake-up-the-dead
7016 @findex gnus-dead-summary-mode
7017 @vindex gnus-kill-summary-on-exit
7018 If you're in the habit of exiting groups, and then changing your mind
7019 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
7020 If you do that, Gnus won't kill the summary buffer when you exit it.
7021 (Quelle surprise!) Instead it will change the name of the buffer to
7022 something like @samp{*Dead Summary ... *} and install a minor mode
7023 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
7024 buffer, you'll find that all keys are mapped to a function called
7025 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
7026 summary buffer will result in a live, normal summary buffer.
7028 There will never be more than one dead summary buffer at any one time.
7030 @vindex gnus-use-cross-reference
7031 The data on the current group will be updated (which articles you have
7032 read, which articles you have replied to, etc.) when you exit the
7033 summary buffer. If the @code{gnus-use-cross-reference} variable is
7034 @code{t} (which is the default), articles that are cross-referenced to
7035 this group and are marked as read, will also be marked as read in the
7036 other subscribed groups they were cross-posted to. If this variable is
7037 neither @code{nil} nor @code{t}, the article will be marked as read in
7038 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7041 @node Crosspost Handling
7042 @section Crosspost Handling
7046 Marking cross-posted articles as read ensures that you'll never have to
7047 read the same article more than once. Unless, of course, somebody has
7048 posted it to several groups separately. Posting the same article to
7049 several groups (not cross-posting) is called @dfn{spamming}, and you are
7050 by law required to send nasty-grams to anyone who perpetrates such a
7051 heinous crime. You may want to try NoCeM handling to filter out spam
7054 Remember: Cross-posting is kinda ok, but posting the same article
7055 separately to several groups is not. Massive cross-posting (aka.
7056 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7057 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7058 excessive crossposting (@pxref{Summary Mail Commands}).
7060 @cindex cross-posting
7063 One thing that may cause Gnus to not do the cross-posting thing
7064 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7065 (which is very nice, because it speeds things up considerably) which
7066 does not include the @code{Xref} header in its @sc{nov} lines. This is
7067 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
7068 even with @sc{xover} by registering the @code{Xref} lines of all
7069 articles you actually read, but if you kill the articles, or just mark
7070 them as read without reading them, Gnus will not get a chance to snoop
7071 the @code{Xref} lines out of these articles, and will be unable to use
7072 the cross reference mechanism.
7074 @cindex LIST overview.fmt
7075 @cindex overview.fmt
7076 To check whether your @sc{nntp} server includes the @code{Xref} header
7077 in its overview files, try @samp{telnet your.nntp.server nntp},
7078 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7079 overview.fmt}. This may not work, but if it does, and the last line you
7080 get does not read @samp{Xref:full}, then you should shout and whine at
7081 your news admin until she includes the @code{Xref} header in the
7084 @vindex gnus-nov-is-evil
7085 If you want Gnus to get the @code{Xref}s right all the time, you have to
7086 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7091 For an alternative approach, @pxref{Duplicate Suppression}.
7094 @node Duplicate Suppression
7095 @section Duplicate Suppression
7097 By default, Gnus tries to make sure that you don't have to read the same
7098 article more than once by utilizing the crossposting mechanism
7099 (@pxref{Crosspost Handling}). However, that simple and efficient
7100 approach may not work satisfactorily for some users for various
7105 The @sc{nntp} server may fail to generate the @code{Xref} header. This
7106 is evil and not very common.
7109 The @sc{nntp} server may fail to include the @code{Xref} header in the
7110 @file{.overview} data bases. This is evil and all too common, alas.
7113 You may be reading the same group (or several related groups) from
7114 different @sc{nntp} servers.
7117 You may be getting mail that duplicates articles posted to groups.
7120 I'm sure there are other situations that @code{Xref} handling fails as
7121 well, but these four are the most common situations.
7123 If, and only if, @code{Xref} handling fails for you, then you may
7124 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
7125 will remember the @code{Message-ID}s of all articles you have read or
7126 otherwise marked as read, and then, as if by magic, mark them as read
7127 all subsequent times you see them---in @emph{all} groups. Using this
7128 mechanism is quite likely to be somewhat inefficient, but not overly
7129 so. It's certainly preferable to reading the same articles more than
7132 Duplicate suppression is not a very subtle instrument. It's more like a
7133 sledge hammer than anything else. It works in a very simple
7134 fashion---if you have marked an article as read, it adds this Message-ID
7135 to a cache. The next time it sees this Message-ID, it will mark the
7136 article as read the the @samp{M} mark. It doesn't care what group it
7140 @item gnus-suppress-duplicates
7141 @vindex gnus-suppress-duplicates
7142 If non-@code{nil}, suppress duplicates.
7144 @item gnus-save-duplicate-list
7145 @vindex gnus-save-duplicate-list
7146 If non-@code{nil}, save the list of duplicates to a file. This will
7147 make startup and shutdown take longer, so the default is @code{nil}.
7148 However, this means that only duplicate articles that is read in a
7149 single Gnus session are suppressed.
7151 @item gnus-duplicate-list-length
7152 @vindex gnus-duplicate-list-length
7153 This variables says how many @code{Message-ID}s to keep in the duplicate
7154 suppression list. The default is 10000.
7156 @item gnus-duplicate-file
7157 @vindex gnus-duplicate-file
7158 The name of the file to store the duplicate suppression list. The
7159 default is @file{~/News/suppression}.
7162 If you have a tendency to stop and start Gnus often, setting
7163 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
7164 you leave Gnus running for weeks on end, you may have it @code{nil}. On
7165 the other hand, saving the list makes startup and shutdown much slower,
7166 so that means that if you stop and start Gnus often, you should set
7167 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
7168 to you to figure out, I think.
7171 @node The Article Buffer
7172 @chapter The Article Buffer
7173 @cindex article buffer
7175 The articles are displayed in the article buffer, of which there is only
7176 one. All the summary buffers share the same article buffer unless you
7177 tell Gnus otherwise.
7180 * Hiding Headers:: Deciding what headers should be displayed.
7181 * Using MIME:: Pushing articles through @sc{mime} before reading them.
7182 * Customizing Articles:: Tailoring the look of the articles.
7183 * Article Keymap:: Keystrokes available in the article buffer.
7184 * Misc Article:: Other stuff.
7188 @node Hiding Headers
7189 @section Hiding Headers
7190 @cindex hiding headers
7191 @cindex deleting headers
7193 The top section of each article is the @dfn{head}. (The rest is the
7194 @dfn{body}, but you may have guessed that already.)
7196 @vindex gnus-show-all-headers
7197 There is a lot of useful information in the head: the name of the person
7198 who wrote the article, the date it was written and the subject of the
7199 article. That's well and nice, but there's also lots of information
7200 most people do not want to see---what systems the article has passed
7201 through before reaching you, the @code{Message-ID}, the
7202 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7203 of some of those lines. If you want to keep all those lines in the
7204 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7206 Gnus provides you with two variables for sifting headers:
7210 @item gnus-visible-headers
7211 @vindex gnus-visible-headers
7212 If this variable is non-@code{nil}, it should be a regular expression
7213 that says what headers you wish to keep in the article buffer. All
7214 headers that do not match this variable will be hidden.
7216 For instance, if you only want to see the name of the person who wrote
7217 the article and the subject, you'd say:
7220 (setq gnus-visible-headers "^From:\\|^Subject:")
7223 This variable can also be a list of regexps to match headers that are to
7226 @item gnus-ignored-headers
7227 @vindex gnus-ignored-headers
7228 This variable is the reverse of @code{gnus-visible-headers}. If this
7229 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7230 should be a regular expression that matches all lines that you want to
7231 hide. All lines that do not match this variable will remain visible.
7233 For instance, if you just want to get rid of the @code{References} line
7234 and the @code{Xref} line, you might say:
7237 (setq gnus-ignored-headers "^References:\\|^Xref:")
7240 This variable can also be a list of regexps to match headers that are to
7243 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7244 variable will have no effect.
7248 @vindex gnus-sorted-header-list
7249 Gnus can also sort the headers for you. (It does this by default.) You
7250 can control the sorting by setting the @code{gnus-sorted-header-list}
7251 variable. It is a list of regular expressions that says in what order
7252 the headers are to be displayed.
7254 For instance, if you want the name of the author of the article first,
7255 and then the subject, you might say something like:
7258 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7261 Any headers that are to remain visible, but are not listed in this
7262 variable, will be displayed in random order after all the headers that
7263 are listed in this variable.
7265 @findex gnus-article-hide-boring-headers
7266 @vindex gnus-article-display-hook
7267 @vindex gnus-boring-article-headers
7268 You can hide further boring headers by entering
7269 @code{gnus-article-hide-boring-headers} into
7270 @code{gnus-article-display-hook}. What this function does depends on
7271 the @code{gnus-boring-article-headers} variable. It's a list, but this
7272 list doesn't actually contain header names. Instead is lists various
7273 @dfn{boring conditions} that Gnus can check and remove from sight.
7275 These conditions are:
7278 Remove all empty headers.
7280 Remove the @code{Newsgroups} header if it only contains the current group
7283 Remove the @code{Followup-To} header if it is identical to the
7284 @code{Newsgroups} header.
7286 Remove the @code{Reply-To} header if it lists the same address as the
7289 Remove the @code{Date} header if the article is less than three days
7293 To include the four first elements, you could say something like;
7296 (setq gnus-boring-article-headers
7297 '(empty newsgroups followup-to reply-to))
7300 This is also the default value for this variable.
7304 @section Using @sc{mime}
7307 Mime is a standard for waving your hands through the air, aimlessly,
7308 while people stand around yawning.
7310 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7311 while all newsreaders die of fear.
7313 @sc{mime} may specify what character set the article uses, the encoding
7314 of the characters, and it also makes it possible to embed pictures and
7315 other naughty stuff in innocent-looking articles.
7317 @vindex gnus-show-mime
7318 @vindex gnus-show-mime-method
7319 @vindex gnus-strict-mime
7320 @findex metamail-buffer
7321 Gnus handles @sc{mime} by pushing the articles through
7322 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7323 default. Set @code{gnus-show-mime} to @code{t} if you want to use
7324 @sc{mime} all the time. However, if @code{gnus-strict-mime} is
7325 non-@code{nil}, the @sc{mime} method will only be used if there are
7326 @sc{mime} headers in the article. If you have @code{gnus-show-mime}
7327 set, then you'll see some unfortunate display glitches in the article
7328 buffer. These can't be avoided.
7330 It might be best to just use the toggling functions from the summary
7331 buffer to avoid getting nasty surprises. (For instance, you enter the
7332 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7333 decoded the sound file in the article and some horrible sing-a-long song
7334 comes streaming out out your speakers, and you can't find the volume
7335 button, because there isn't one, and people are starting to look at you,
7336 and you try to stop the program, but you can't, and you can't find the
7337 program to control the volume, and everybody else in the room suddenly
7338 decides to look at you disdainfully, and you'll feel rather stupid.)
7340 Any similarity to real events and people is purely coincidental. Ahem.
7343 @node Customizing Articles
7344 @section Customizing Articles
7345 @cindex article customization
7347 @vindex gnus-article-display-hook
7348 The @code{gnus-article-display-hook} is called after the article has
7349 been inserted into the article buffer. It is meant to handle all
7350 treatment of the article before it is displayed.
7352 @findex gnus-article-maybe-highlight
7353 By default this hook just contains @code{gnus-article-hide-headers},
7354 @code{gnus-article-treat-overstrike}, and
7355 @code{gnus-article-maybe-highlight}, but there are thousands, nay
7356 millions, of functions you can put in this hook. For an overview of
7357 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7358 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7359 Date}. Note that the order of functions in this hook might affect
7360 things, so you may have to fiddle a bit to get the desired results.
7362 You can, of course, write your own functions. The functions are called
7363 from the article buffer, and you can do anything you like, pretty much.
7364 There is no information that you have to keep in the buffer---you can
7365 change everything. However, you shouldn't delete any headers. Instead
7366 make them invisible if you want to make them go away.
7369 @node Article Keymap
7370 @section Article Keymap
7372 Most of the keystrokes in the summary buffer can also be used in the
7373 article buffer. They should behave as if you typed them in the summary
7374 buffer, which means that you don't actually have to have a summary
7375 buffer displayed while reading. You can do it all from the article
7378 A few additional keystrokes are available:
7383 @kindex SPACE (Article)
7384 @findex gnus-article-next-page
7385 Scroll forwards one page (@code{gnus-article-next-page}).
7388 @kindex DEL (Article)
7389 @findex gnus-article-prev-page
7390 Scroll backwards one page (@code{gnus-article-prev-page}).
7393 @kindex C-c ^ (Article)
7394 @findex gnus-article-refer-article
7395 If point is in the neighborhood of a @code{Message-ID} and you press
7396 @kbd{r}, Gnus will try to get that article from the server
7397 (@code{gnus-article-refer-article}).
7400 @kindex C-c C-m (Article)
7401 @findex gnus-article-mail
7402 Send a reply to the address near point (@code{gnus-article-mail}). If
7403 given a prefix, include the mail.
7407 @findex gnus-article-show-summary
7408 Reconfigure the buffers so that the summary buffer becomes visible
7409 (@code{gnus-article-show-summary}).
7413 @findex gnus-article-describe-briefly
7414 Give a very brief description of the available keystrokes
7415 (@code{gnus-article-describe-briefly}).
7418 @kindex TAB (Article)
7419 @findex gnus-article-next-button
7420 Go to the next button, if any (@code{gnus-article-next-button}. This
7421 only makes sense if you have buttonizing turned on.
7424 @kindex M-TAB (Article)
7425 @findex gnus-article-prev-button
7426 Go to the previous button, if any (@code{gnus-article-prev-button}.
7432 @section Misc Article
7436 @item gnus-single-article-buffer
7437 @vindex gnus-single-article-buffer
7438 If non-@code{nil}, use the same article buffer for all the groups.
7439 (This is the default.) If @code{nil}, each group will have its own
7442 @vindex gnus-article-prepare-hook
7443 @item gnus-article-prepare-hook
7444 This hook is called right after the article has been inserted into the
7445 article buffer. It is mainly intended for functions that do something
7446 depending on the contents; it should probably not be used for changing
7447 the contents of the article buffer.
7449 @vindex gnus-article-display-hook
7450 @item gnus-article-display-hook
7451 This hook is called as the last thing when displaying an article, and is
7452 intended for modifying the contents of the buffer, doing highlights,
7453 hiding headers, and the like.
7455 @item gnus-article-mode-hook
7456 @vindex gnus-article-mode-hook
7457 Hook called in article mode buffers.
7459 @item gnus-article-mode-syntax-table
7460 @vindex gnus-article-mode-syntax-table
7461 Syntax table used in article buffers. It is initialized from
7462 @code{text-mode-syntax-table}.
7464 @vindex gnus-article-mode-line-format
7465 @item gnus-article-mode-line-format
7466 This variable is a format string along the same lines as
7467 @code{gnus-summary-mode-line-format}. It accepts the same
7468 format specifications as that variable, with one extension:
7472 The @dfn{wash status} of the article. This is a short string with one
7473 character for each possible article wash operation that may have been
7477 @vindex gnus-break-pages
7479 @item gnus-break-pages
7480 Controls whether @dfn{page breaking} is to take place. If this variable
7481 is non-@code{nil}, the articles will be divided into pages whenever a
7482 page delimiter appears in the article. If this variable is @code{nil},
7483 paging will not be done.
7485 @item gnus-page-delimiter
7486 @vindex gnus-page-delimiter
7487 This is the delimiter mentioned above. By default, it is @samp{^L}
7492 @node Composing Messages
7493 @chapter Composing Messages
7498 @kindex C-c C-c (Post)
7499 All commands for posting and mailing will put you in a message buffer
7500 where you can edit the article all you like, before you send the article
7501 by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The Message
7502 Manual}. If you are in a foreign news group, and you wish to post the
7503 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
7504 to make Gnus try to post using the foreign server.
7507 * Mail:: Mailing and replying.
7508 * Post:: Posting and following up.
7509 * Posting Server:: What server should you post via?
7510 * Mail and Post:: Mailing and posting at the same time.
7511 * Archived Messages:: Where Gnus stores the messages you've sent.
7512 @c * Posting Styles:: An easier way to configure some key elements.
7513 @c * Drafts:: Postponing messages and rejected messages.
7514 @c * Rejected Articles:: What happens if the server doesn't like your article?
7517 Also see @pxref{Canceling and Superseding} for information on how to
7518 remove articles you shouldn't have posted.
7524 Variables for customizing outgoing mail:
7527 @item gnus-uu-digest-headers
7528 @vindex gnus-uu-digest-headers
7529 List of regexps to match headers included in digested messages. The
7530 headers will be included in the sequence they are matched.
7532 @item gnus-add-to-list
7533 @vindex gnus-add-to-list
7534 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
7535 that have none when you do a @kbd{a}.
7543 Variables for composing news articles:
7546 @item gnus-sent-message-ids-file
7547 @vindex gnus-sent-message-ids-file
7548 Gnus will keep a @code{Message-ID} history file of all the mails it has
7549 sent. If it discovers that it has already sent a mail, it will ask the
7550 user whether to re-send the mail. (This is primarily useful when
7551 dealing with @sc{soup} packets and the like where one is apt to sent the
7552 same packet multiple times.) This variable says what the name of this
7553 history file is. It is @file{~/News/Sent-Message-IDs} by default. Set
7554 this variable to @code{nil} if you don't want Gnus to keep a history
7557 @item gnus-sent-message-ids-length
7558 @vindex gnus-sent-message-ids-length
7559 This variable says how many @code{Message-ID}s to keep in the history
7560 file. It is 1000 by default.
7565 @node Posting Server
7566 @section Posting Server
7568 When you press those magical @kbd{C-c C-c} keys to ship off your latest
7569 (extremely intelligent, of course) article, where does it go?
7571 Thank you for asking. I hate you.
7573 @vindex gnus-post-method
7575 It can be quite complicated. Normally, Gnus will use the same native
7576 server. However. If your native server doesn't allow posting, just
7577 reading, you probably want to use some other server to post your
7578 (extremely intelligent and fabulously interesting) articles. You can
7579 then set the @code{gnus-post-method} to some other method:
7582 (setq gnus-post-method '(nnspool ""))
7585 Now, if you've done this, and then this server rejects your article, or
7586 this server is down, what do you do then? To override this variable you
7587 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
7588 the ``current'' server for posting.
7590 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
7591 Gnus will prompt you for what method to use for posting.
7593 You can also set @code{gnus-post-method} to a list of select methods.
7594 If that's the case, Gnus will always prompt you for what method to use
7599 @section Mail and Post
7601 Here's a list of variables that are relevant to both mailing and
7605 @item gnus-mailing-list-groups
7606 @findex gnus-mailing-list-groups
7607 @cindex mailing lists
7609 If your news server offers groups that are really mailing lists that are
7610 gatewayed to the @sc{nntp} server, you can read those groups without
7611 problems, but you can't post/followup to them without some difficulty.
7612 One solution is to add a @code{to-address} to the group parameters
7613 (@pxref{Group Parameters}). An easier thing to do is set the
7614 @code{gnus-mailing-list-groups} to a regexp that match the groups that
7615 really are mailing lists. Then, at least, followups to the mailing
7616 lists will work most of the time. Posting to these groups (@kbd{a}) is
7617 still a pain, though.
7621 You may want to do spell-checking on messages that you send out. Or, if
7622 you don't want to spell-check by hand, you could add automatic
7623 spell-checking via the @code{ispell} package:
7626 @findex ispell-message
7628 (add-hook 'message-send-hook 'ispell-message)
7632 @node Archived Messages
7633 @section Archived Messages
7634 @cindex archived messages
7635 @cindex sent messages
7637 Gnus provides a few different methods for storing the mail and news you
7638 send. The default method is to use the @dfn{archive virtual server} to
7639 store the messages. If you want to disable this completely, the
7640 @code{gnus-message-archive-group} variable should be @code{nil}, which
7643 @vindex gnus-message-archive-method
7644 @code{gnus-message-archive-method} says what virtual server Gnus is to
7645 use to store sent messages. The default is:
7649 (nnfolder-directory "~/Mail/archive/"))
7652 You can, however, use any mail select method (@code{nnml},
7653 @code{nnmbox}, etc.). @code{nnfolder} is a quite likeable select method
7654 for doing this sort of thing, though. If you don't like the default
7655 directory chosen, you could say something like:
7658 (setq gnus-message-archive-method
7659 '(nnfolder "archive"
7660 (nnfolder-inhibit-expiry t)
7661 (nnfolder-active-file "~/News/sent-mail/active")
7662 (nnfolder-directory "~/News/sent-mail/")))
7665 @vindex gnus-message-archive-group
7667 Gnus will insert @code{Gcc} headers in all outgoing messages that point
7668 to one or more group(s) on that server. Which group to use is
7669 determined by the @code{gnus-message-archive-group} variable.
7671 This variable can be:
7675 Messages will be saved in that group.
7676 @item a list of strings
7677 Messages will be saved in all those groups.
7678 @item an alist of regexps, functions and forms
7679 When a key ``matches'', the result is used.
7681 No message archiving will take place. This is the default.
7686 Just saving to a single group called @samp{MisK}:
7688 (setq gnus-message-archive-group "MisK")
7691 Saving to two groups, @samp{MisK} and @samp{safe}:
7693 (setq gnus-message-archive-group '("MisK" "safe"))
7696 Save to different groups based on what group you are in:
7698 (setq gnus-message-archive-group
7699 '(("^alt" "sent-to-alt")
7700 ("mail" "sent-to-mail")
7701 (".*" "sent-to-misc")))
7706 (setq gnus-message-archive-group
7707 '((if (message-news-p)
7712 How about storing all news messages in one file, but storing all mail
7713 messages in one file per month:
7716 (setq gnus-message-archive-group
7717 '((if (message-news-p)
7719 (concat "mail." (format-time-string
7720 "%Y-%m" (current-time))))))
7723 Now, when you send a message off, it will be stored in the appropriate
7724 group. (If you want to disable storing for just one particular message,
7725 you can just remove the @code{Gcc} header that has been inserted.) The
7726 archive group will appear in the group buffer the next time you start
7727 Gnus, or the next time you press @kbd{F} in the group buffer. You can
7728 enter it and read the articles in it just like you'd read any other
7729 group. If the group gets really big and annoying, you can simply rename
7730 if (using @kbd{G r} in the group buffer) to something
7731 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
7732 continue to be stored in the old (now empty) group.
7734 That's the default method of archiving sent messages. Gnus also a
7735 different way for the people who don't like the default method. In that
7736 case you should set @code{gnus-message-archive-group} to @code{nil};
7737 this will disable archiving.
7739 XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
7740 use a different value for @code{gnus-message-archive-group} there.
7743 @item gnus-outgoing-message-group
7744 @vindex gnus-outgoing-message-group
7745 All outgoing messages will be put in this group. If you want to store
7746 all your outgoing mail and articles in the group @samp{nnml:archive},
7747 you set this variable to that value. This variable can also be a list of
7750 If you want to have greater control over what group to put each
7751 message in, you can set this variable to a function that checks the
7752 current newsgroup name and then returns a suitable group name (or list
7755 This variable can be used instead of @code{gnus-message-archive-group},
7756 but the latter is the preferred method.
7760 @c @node Posting Styles
7761 @c @section Posting Styles
7762 @c @cindex posting styles
7765 @c All them variables, they make my head swim.
7767 @c So what if you want a different @code{Organization} and signature based
7768 @c on what groups you post to? And you post both from your home machine
7769 @c and your work machine, and you want different @code{From} lines, and so
7772 @c @vindex gnus-posting-styles
7773 @c One way to do stuff like that is to write clever hooks that change the
7774 @c variables you need to have changed. That's a bit boring, so somebody
7775 @c came up with the bright idea of letting the user specify these things in
7776 @c a handy alist. Here's an example of a @code{gnus-posting-styles}
7781 @c (signature . "Peace and happiness")
7782 @c (organization . "What me?"))
7784 @c (signature . "Death to everybody"))
7785 @c ("comp.emacs.i-love-it"
7786 @c (organization . "Emacs is it")))
7789 @c As you might surmise from this example, this alist consists of several
7790 @c @dfn{styles}. Each style will be applicable if the first element
7791 @c ``matches'', in some form or other. The entire alist will be iterated
7792 @c over, from the beginning towards the end, and each match will be
7793 @c applied, which means that attributes in later styles that match override
7794 @c the same attributes in earlier matching styles. So
7795 @c @samp{comp.programming.literate} will have the @samp{Death to everybody}
7796 @c signature and the @samp{What me?} @code{Organization} header.
7798 @c The first element in each style is called the @code{match}. If it's a
7799 @c string, then Gnus will try to regexp match it against the group name.
7800 @c If it's a function symbol, that function will be called with no
7801 @c arguments. If it's a variable symbol, then the variable will be
7802 @c referenced. If it's a list, then that list will be @code{eval}ed. In
7803 @c any case, if this returns a non-@code{nil} value, then the style is said
7806 @c Each style may contain a arbitrary amount of @dfn{attributes}. Each
7807 @c attribute consists of a @var{(name . value)} pair. The attribute name
7808 @c can be one of @code{signature}, @code{organization} or @code{from}. The
7809 @c attribute name can also be a string. In that case, this will be used as
7810 @c a header name, and the value will be inserted in the headers of the
7813 @c The attribute value can be a string (used verbatim), a function (the
7814 @c return value will be used), a variable (its value will be used) or a
7815 @c list (it will be @code{eval}ed and the return value will be used).
7817 @c So here's a new example:
7820 @c (setq gnus-posting-styles
7822 @c (signature . "~/.signature")
7823 @c (from . "user@@foo (user)")
7824 @c ("X-Home-Page" . (getenv "WWW_HOME"))
7825 @c (organization . "People's Front Against MWM"))
7827 @c (signature . my-funny-signature-randomizer))
7828 @c ((equal (system-name) "gnarly")
7829 @c (signature . my-quote-randomizer))
7830 @c (posting-from-work-p
7831 @c (signature . "~/.work-signature")
7832 @c (from . "user@@bar.foo (user)")
7833 @c (organization . "Important Work, Inc"))
7835 @c (signature . "~/.mail-signature"))))
7842 @c If you are writing a message (mail or news) and suddenly remember that
7843 @c you have a steak in the oven (or some pesto in the food processor, you
7844 @c craazy vegetarians), you'll probably wish there was a method to save the
7845 @c message you are writing so that you can continue editing it some other
7846 @c day, and send it when you feel its finished.
7848 @c Well, don't worry about it. Whenever you start composing a message of
7849 @c some sort using the Gnus mail and post commands, the buffer you get will
7850 @c automatically associate to an article in a special @dfn{draft} group.
7851 @c If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
7852 @c article will be saved there. (Auto-save files also go to the draft
7856 @c @vindex gnus-draft-group-directory
7857 @c The draft group is a special group (which is implemented as an
7858 @c @code{nndraft} group, if you absolutely have to know) called
7859 @c @samp{nndraft:drafts}. The variable @code{gnus-draft-group-directory}
7860 @c controls both the name of the group and the location---the leaf element
7861 @c in the path will be used as the name of the group. What makes this
7862 @c group special is that you can't tick any articles in it or mark any
7863 @c articles as read---all articles in the group are permanently unread.
7865 @c If the group doesn't exist, it will be created and you'll be subscribed
7868 @c @findex gnus-dissociate-buffer-from-draft
7869 @c @kindex C-c M-d (Mail)
7870 @c @kindex C-c M-d (Post)
7871 @c @findex gnus-associate-buffer-with-draft
7872 @c @kindex C-c C-d (Mail)
7873 @c @kindex C-c C-d (Post)
7874 @c If you're writing some super-secret message that you later want to
7875 @c encode with PGP before sending, you may wish to turn the auto-saving
7876 @c (and association with the draft group) off. You never know who might be
7877 @c interested in reading all your extremely valuable and terribly horrible
7878 @c and interesting secrets. The @kbd{C-c M-d}
7879 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
7880 @c If you change your mind and want to turn the auto-saving back on again,
7881 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
7883 @c @vindex gnus-use-draft
7884 @c To leave association with the draft group off by default, set
7885 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
7887 @c @findex gnus-summary-send-draft
7888 @c @kindex S D c (Summary)
7889 @c When you want to continue editing the article, you simply enter the
7890 @c draft group and push @kbd{S D c} (@code{gnus-summary-send-draft}) to do
7891 @c that. You will be placed in a buffer where you left off.
7893 @c Rejected articles will also be put in this draft group (@pxref{Rejected
7896 @c @findex gnus-summary-send-all-drafts
7897 @c If you have lots of rejected messages you want to post (or mail) without
7898 @c doing further editing, you can use the @kbd{S D a} command
7899 @c (@code{gnus-summary-send-all-drafts}). This command understands the
7900 @c process/prefix convention (@pxref{Process/Prefix}).
7903 @c @node Rejected Articles
7904 @c @section Rejected Articles
7905 @c @cindex rejected articles
7907 @c Sometimes a news server will reject an article. Perhaps the server
7908 @c doesn't like your face. Perhaps it just feels miserable. Perhaps
7909 @c @emph{there be demons}. Perhaps you have included too much cited text.
7910 @c Perhaps the disk is full. Perhaps the server is down.
7912 @c These situations are, of course, totally beyond the control of Gnus.
7913 @c (Gnus, of course, loves the way you look, always feels great, has angels
7914 @c fluttering around inside of it, doesn't care about how much cited text
7915 @c you include, never runs full and never goes down.) So Gnus saves these
7916 @c articles until some later time when the server feels better.
7918 @c The rejected articles will automatically be put in a special draft group
7919 @c (@pxref{Drafts}). When the server comes back up again, you'd then
7920 @c typically enter that group and send all the articles off.
7923 @node Select Methods
7924 @chapter Select Methods
7925 @cindex foreign groups
7926 @cindex select methods
7928 A @dfn{foreign group} is a group that is not read by the usual (or
7929 default) means. It could be, for instance, a group from a different
7930 @sc{nntp} server, it could be a virtual group, or it could be your own
7931 personal mail group.
7933 A foreign group (or any group, really) is specified by a @dfn{name} and
7934 a @dfn{select method}. To take the latter first, a select method is a
7935 list where the first element says what backend to use (e.g. @code{nntp},
7936 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
7937 name}. There may be additional elements in the select method, where the
7938 value may have special meaning for the backend in question.
7940 One could say that a select method defines a @dfn{virtual server}---so
7941 we do just that (@pxref{The Server Buffer}).
7943 The @dfn{name} of the group is the name the backend will recognize the
7946 For instance, the group @samp{soc.motss} on the @sc{nntp} server
7947 @samp{some.where.edu} will have the name @samp{soc.motss} and select
7948 method @code{(nntp "some.where.edu")}. Gnus will call this group
7949 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
7950 backend just knows this group as @samp{soc.motss}.
7952 The different methods all have their peculiarities, of course.
7955 * The Server Buffer:: Making and editing virtual servers.
7956 * Getting News:: Reading USENET news with Gnus.
7957 * Getting Mail:: Reading your personal mail with Gnus.
7958 * Other Sources:: Reading directories, files, SOUP packets.
7959 * Combined Groups:: Combining groups into one group.
7963 @node The Server Buffer
7964 @section The Server Buffer
7966 Traditionally, a @dfn{server} is a machine or a piece of software that
7967 one connects to, and then requests information from. Gnus does not
7968 connect directly to any real servers, but does all transactions through
7969 one backend or other. But that's just putting one layer more between
7970 the actual media and Gnus, so we might just as well say that each
7971 backend represents a virtual server.
7973 For instance, the @code{nntp} backend may be used to connect to several
7974 different actual @sc{nntp} servers, or, perhaps, to many different ports
7975 on the same actual @sc{nntp} server. You tell Gnus which backend to
7976 use, and what parameters to set by specifying a @dfn{select method}.
7978 These select methods specifications can sometimes become quite
7979 complicated---say, for instance, that you want to read from the
7980 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
7981 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
7982 Anyways, if you had to specify that for each group that used this
7983 server, that would be too much work, so Gnus offers a way of naming
7984 select methods, which is what you do in the server buffer.
7986 To enter the server buffer, user the @kbd{^}
7987 (@code{gnus-group-enter-server-mode}) command in the group buffer.
7990 * Server Buffer Format:: You can customize the look of this buffer.
7991 * Server Commands:: Commands to manipulate servers.
7992 * Example Methods:: Examples server specifications.
7993 * Creating a Virtual Server:: An example session.
7994 * Server Variables:: Which variables to set.
7995 * Servers and Methods:: You can use server names as select methods.
7996 * Unavailable Servers:: Some servers you try to contact may be down.
7999 @vindex gnus-server-mode-hook
8000 @code{gnus-server-mode-hook} is run when creating the server buffer.
8003 @node Server Buffer Format
8004 @subsection Server Buffer Format
8005 @cindex server buffer format
8007 @vindex gnus-server-line-format
8008 You can change the look of the server buffer lines by changing the
8009 @code{gnus-server-line-format} variable. This is a @code{format}-like
8010 variable, with some simple extensions:
8015 How the news is fetched---the backend name.
8018 The name of this server.
8021 Where the news is to be fetched from---the address.
8024 The opened/closed/denied status of the server.
8027 @vindex gnus-server-mode-line-format
8028 The mode line can also be customized by using the
8029 @code{gnus-server-mode-line-format} variable. The following specs are
8040 Also @pxref{Formatting Variables}.
8043 @node Server Commands
8044 @subsection Server Commands
8045 @cindex server commands
8051 @findex gnus-server-add-server
8052 Add a new server (@code{gnus-server-add-server}).
8056 @findex gnus-server-edit-server
8057 Edit a server (@code{gnus-server-edit-server}).
8060 @kindex SPACE (Server)
8061 @findex gnus-server-read-server
8062 Browse the current server (@code{gnus-server-read-server}).
8066 @findex gnus-server-exit
8067 Return to the group buffer (@code{gnus-server-exit}).
8071 @findex gnus-server-kill-server
8072 Kill the current server (@code{gnus-server-kill-server}).
8076 @findex gnus-server-yank-server
8077 Yank the previously killed server (@code{gnus-server-yank-server}).
8081 @findex gnus-server-copy-server
8082 Copy the current server (@code{gnus-server-copy-server}).
8086 @findex gnus-server-list-servers
8087 List all servers (@code{gnus-server-list-servers}).
8091 @findex gnus-server-scan-server
8092 Request that the server scan its sources for new articles
8093 (@code{gnus-server-scan-server}). This is mainly sensible with mail
8098 @findex gnus-server-regenerate-server
8099 Request that the server regenerate all its data structures
8100 (@code{gnus-server-regenerate-server}). This can be useful if you have
8101 a mail backend that has gotten out of synch.
8106 @node Example Methods
8107 @subsection Example Methods
8109 Most select methods are pretty simple and self-explanatory:
8112 (nntp "news.funet.fi")
8115 Reading directly from the spool is even simpler:
8121 As you can see, the first element in a select method is the name of the
8122 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8125 After these two elements, there may be a arbitrary number of
8126 @var{(variable form)} pairs.
8128 To go back to the first example---imagine that you want to read from
8129 port 15 from that machine. This is what the select method should
8133 (nntp "news.funet.fi" (nntp-port-number 15))
8136 You should read the documentation to each backend to find out what
8137 variables are relevant, but here's an @code{nnmh} example.
8139 @code{nnmh} is a mail backend that reads a spool-like structure. Say
8140 you have two structures that you wish to access: One is your private
8141 mail spool, and the other is a public one. Here's the possible spec for
8145 (nnmh "private" (nnmh-directory "~/private/mail/"))
8148 (This server is then called @samp{private}, but you may have guessed
8151 Here's the method for a public spool:
8155 (nnmh-directory "/usr/information/spool/")
8156 (nnmh-get-new-mail nil))
8159 If you are behind a firewall and only have access to the @sc{nntp}
8160 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8161 on the firewall machine and telnet from there to the @sc{nntp} server.
8162 Doing this can be rather fiddly, but your virtual server definition
8163 should probably look something like this:
8167 (nntp-address "the.firewall.machine")
8168 (nntp-open-connection-function nntp-open-rlogin)
8169 (nntp-end-of-line "\n")
8170 (nntp-rlogin-parameters
8171 ("telnet" "the.real.nntp.host" "nntp")))
8176 @node Creating a Virtual Server
8177 @subsection Creating a Virtual Server
8179 If you're saving lots of articles in the cache by using persistent
8180 articles, you may want to create a virtual server to read the cache.
8182 First you need to add a new server. The @kbd{a} command does that. It
8183 would probably be best to use @code{nnspool} to read the cache. You
8184 could also use @code{nnml} or @code{nnmh}, though.
8186 Type @kbd{a nnspool RET cache RET}.
8188 You should now have a brand new @code{nnspool} virtual server called
8189 @samp{cache}. You now need to edit it to have the right definitions.
8190 Type @kbd{e} to edit the server. You'll be entered into a buffer that
8191 will contain the following:
8201 (nnspool-spool-directory "~/News/cache/")
8202 (nnspool-nov-directory "~/News/cache/")
8203 (nnspool-active-file "~/News/cache/active"))
8206 Type @kbd{C-c C-c} to return to the server buffer. If you now press
8207 @kbd{RET} over this virtual server, you should be entered into a browse
8208 buffer, and you should be able to enter any of the groups displayed.
8211 @node Server Variables
8212 @subsection Server Variables
8214 One sticky point when defining variables (both on backends and in Emacs
8215 in general) is that some variables are typically initialized from other
8216 variables when the definition of the variables is being loaded. If you
8217 change the "base" variable after the variables have been loaded, you
8218 won't change the "derived" variables.
8220 This typically affects directory and file variables. For instance,
8221 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
8222 directory variables are initialized from that variable, so
8223 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
8224 new virtual @code{nnml} server, it will @emph{not} suffice to set just
8225 @code{nnml-directory}---you have to explicitly set all the file
8226 variables to be what you want them to be. For a complete list of
8227 variables for each backend, see each backend's section later in this
8228 manual, but here's an example @code{nnml} definition:
8232 (nnml-directory "~/my-mail/")
8233 (nnml-active-file "~/my-mail/active")
8234 (nnml-newsgroups-file "~/my-mail/newsgroups"))
8238 @node Servers and Methods
8239 @subsection Servers and Methods
8241 Wherever you would normally use a select method
8242 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8243 when browsing a foreign server) you can use a virtual server name
8244 instead. This could potentially save lots of typing. And it's nice all
8248 @node Unavailable Servers
8249 @subsection Unavailable Servers
8251 If a server seems to be unreachable, Gnus will mark that server as
8252 @code{denied}. That means that any subsequent attempt to make contact
8253 with that server will just be ignored. ``It can't be opened,'' Gnus
8254 will tell you, without making the least effort to see whether that is
8255 actually the case or not.
8257 That might seem quite naughty, but it does make sense most of the time.
8258 Let's say you have 10 groups subscribed to the server
8259 @samp{nephelococcygia.com}. This server is located somewhere quite far
8260 away from you and the machine is quite slow, so it takes 1 minute just
8261 to find out that it refuses connection from you today. If Gnus were to
8262 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
8263 attempt to do that. Once it has gotten a single ``connection refused'',
8264 it will regard that server as ``down''.
8266 So, what happens if the machine was only feeling unwell temporarily?
8267 How do you test to see whether the machine has come up again?
8269 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8270 with the following commands:
8276 @findex gnus-server-open-server
8277 Try to establish connection to the server on the current line
8278 (@code{gnus-server-open-server}).
8282 @findex gnus-server-close-server
8283 Close the connection (if any) to the server
8284 (@code{gnus-server-close-server}).
8288 @findex gnus-server-deny-server
8289 Mark the current server as unreachable
8290 (@code{gnus-server-deny-server}).
8293 @kindex M-o (Server)
8294 @findex gnus-server-open-all-servers
8295 Open the connections to all servers in the buffer
8296 (@code{gnus-server-open-all-servers}).
8299 @kindex M-c (Server)
8300 @findex gnus-server-close-all-servers
8301 Close the connections to all servers in the buffer
8302 (@code{gnus-server-close-all-servers}).
8306 @findex gnus-server-remove-denials
8307 Remove all marks to whether Gnus was denied connection from all servers
8308 (@code{gnus-server-remove-denials}).
8314 @section Getting News
8315 @cindex reading news
8316 @cindex news backends
8318 A newsreader is normally used for reading news. Gnus currently provides
8319 only two methods of getting news---it can read from an @sc{nntp} server,
8320 or it can read from a local spool.
8323 * NNTP:: Reading news from an @sc{nntp} server.
8324 * News Spool:: Reading news from the local spool.
8329 @subsection @sc{nntp}
8332 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8333 You just specify @code{nntp} as method and the address of the @sc{nntp}
8334 server as the, uhm, address.
8336 If the @sc{nntp} server is located at a non-standard port, setting the
8337 third element of the select method to this port number should allow you
8338 to connect to the right port. You'll have to edit the group info for
8339 that (@pxref{Foreign Groups}).
8341 The name of the foreign group can be the same as a native group. In
8342 fact, you can subscribe to the same group from as many different servers
8343 you feel like. There will be no name collisions.
8345 The following variables can be used to create a virtual @code{nntp}
8350 @item nntp-server-opened-hook
8351 @vindex nntp-server-opened-hook
8352 @cindex @sc{mode reader}
8354 @cindex authentification
8355 @cindex nntp authentification
8356 @findex nntp-send-authinfo
8357 @findex nntp-send-mode-reader
8358 @code{nntp-server-opened-hook} is run after a connection has been made.
8359 It can be used to send commands to the @sc{nntp} server after it has
8360 been contacted. By default is sends the command @code{MODE READER} to
8361 the server with the @code{nntp-send-mode-reader} function.
8363 @item nntp-authinfo-function
8364 @vindex nntp-authinfo-function
8365 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8366 server. Available functions include:
8369 @item nntp-send-authinfo
8370 @findex nntp-send-authinfo
8371 This function will used you current login name as the user name and will
8372 prompt you for the password. This is the default.
8374 @item nntp-send-nosy-authinfo
8375 @findex nntp-send-nosy-authinfo
8376 This function will prompt you for both user name and password.
8378 @item nntp-send-authinfo-from-file
8379 @findex nntp-send-authinfo-from-file
8380 This function will use your current login name as the user name and will
8381 read the @sc{nntp} password from @file{~/.nntp-authinfo}.
8384 @item nntp-server-action-alist
8385 @vindex nntp-server-action-alist
8386 This is an list of regexps to match on server types and actions to be
8387 taken when matches are made. For instance, if you want Gnus to beep
8388 every time you connect to innd, you could say something like:
8391 (setq nntp-server-action-alist
8395 You probably don't want to do that, though.
8397 The default value is
8400 '(("nntpd 1\\.5\\.11t"
8401 (remove-hook 'nntp-server-opened-hook nntp-send-mode-reader)))
8404 This ensures that Gnus doesn't send the @code{MODE READER} command to
8405 nntpd 1.5.11t, since that command chokes that server, I've been told.
8407 @item nntp-maximum-request
8408 @vindex nntp-maximum-request
8409 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
8410 will collect headers by sending a series of @code{head} commands. To
8411 speed things up, the backend sends lots of these commands without
8412 waiting for reply, and then reads all the replies. This is controlled
8413 by the @code{nntp-maximum-request} variable, and is 400 by default. If
8414 your network is buggy, you should set this to 1.
8416 @item nntp-connection-timeout
8417 @vindex nntp-connection-timeout
8418 If you have lots of foreign @code{nntp} groups that you connect to
8419 regularly, you're sure to have problems with @sc{nntp} servers not
8420 responding properly, or being too loaded to reply within reasonable
8421 time. This is can lead to awkward problems, which can be helped
8422 somewhat by setting @code{nntp-connection-timeout}. This is an integer
8423 that says how many seconds the @code{nntp} backend should wait for a
8424 connection before giving up. If it is @code{nil}, which is the default,
8425 no timeouts are done.
8427 @item nntp-command-timeout
8428 @vindex nntp-command-timeout
8429 @cindex PPP connections
8430 @cindex dynamic IP addresses
8431 If you're running Gnus on a machine that has a dynamically assigned
8432 address, Gnus may become confused. If the address of your machine
8433 changes after connecting to the @sc{nntp} server, Gnus will simply sit
8434 waiting forever for replies from the server. To help with this
8435 unfortunate problem, you can set this command to a number. Gnus will
8436 then, if it sits waiting longer than that number of seconds for a reply
8437 from the server, shut down the connection, start a new one, and resend
8438 the command. This should hopefully be transparent to the user. A
8439 likely number is 30 seconds.
8441 @item nntp-retry-on-break
8442 @vindex nntp-retry-on-break
8443 If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
8444 hangs. This will have much the same effect as the command timeout
8447 @item nntp-server-hook
8448 @vindex nntp-server-hook
8449 This hook is run as the last step when connecting to an @sc{nntp}
8452 @findex nntp-open-rlogin
8453 @findex nntp-open-network-stream
8454 @item nntp-open-connection-function
8455 @vindex nntp-open-connection-function
8456 This function is used to connect to the remote system. Two pre-made
8457 functions are @code{nntp-open-network-stream}, which is the default, and
8458 simply connects to some port or other on the remote system. The other
8459 is @code{nntp-open-rlogin}, which does an rlogin on the remote system,
8460 and then does a telnet to the @sc{nntp} server available there.
8462 @item nntp-rlogin-parameters
8463 @vindex nntp-rlogin-parameters
8464 If you use @code{nntp-open-rlogin} as the
8465 @code{nntp-open-connection-function}, this list will be used as the
8466 parameter list given to @code{rsh}.
8468 @item nntp-end-of-line
8469 @vindex nntp-end-of-line
8470 String to use as end-of-line markers when talking to the @sc{nntp}
8471 server. This is @samp{\r\n} by default, but should be @samp{\n} when
8472 using @code{rlogin} to talk to the server.
8474 @item nntp-rlogin-user-name
8475 @vindex nntp-rlogin-user-name
8476 User name on the remote system when using the @code{rlogin} connect
8480 @vindex nntp-address
8481 The address of the remote system running the @sc{nntp} server.
8483 @item nntp-port-number
8484 @vindex nntp-port-number
8485 Port number to connect to when using the @code{nntp-open-network-stream}
8488 @item nntp-buggy-select
8489 @vindex nntp-buggy-select
8490 Set this to non-@code{nil} if your select routine is buggy.
8492 @item nntp-nov-is-evil
8493 @vindex nntp-nov-is-evil
8494 If the @sc{nntp} server does not support @sc{nov}, you could set this
8495 variable to @code{t}, but @code{nntp} usually checks whether @sc{nov}
8496 can be used automatically.
8498 @item nntp-xover-commands
8499 @vindex nntp-xover-commands
8502 List of strings that are used as commands to fetch @sc{nov} lines from a
8503 server. The default value of this variable is @code{("XOVER"
8507 @vindex nntp-nov-gap
8508 @code{nntp} normally sends just one big request for @sc{nov} lines to
8509 the server. The server responds with one huge list of lines. However,
8510 if you have read articles 2-5000 in the group, and only want to read
8511 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
8512 lines that you do not want, and will not use. This variable says how
8513 big a gap between two consecutive articles is allowed to be before the
8514 @code{XOVER} request is split into several request. Note that if your
8515 network is fast, setting this variable to a really small number means
8516 that fetching will probably be slower. If this variable is @code{nil},
8517 @code{nntp} will never split requests.
8519 @item nntp-prepare-server-hook
8520 @vindex nntp-prepare-server-hook
8521 A hook run before attempting to connect to an @sc{nntp} server.
8523 @item nntp-warn-about-losing-connection
8524 @vindex nntp-warn-about-losing-connection
8525 If this variable is non-@code{nil}, some noise will be made when a
8526 server closes connection.
8532 @subsection News Spool
8536 Subscribing to a foreign group from the local spool is extremely easy,
8537 and might be useful, for instance, to speed up reading groups that
8538 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
8541 Anyways, you just specify @code{nnspool} as the method and @samp{} (or
8542 anything else) as the address.
8544 If you have access to a local spool, you should probably use that as the
8545 native select method (@pxref{Finding the News}). It is normally faster
8546 than using an @code{nntp} select method, but might not be. It depends.
8547 You just have to try to find out what's best at your site.
8551 @item nnspool-inews-program
8552 @vindex nnspool-inews-program
8553 Program used to post an article.
8555 @item nnspool-inews-switches
8556 @vindex nnspool-inews-switches
8557 Parameters given to the inews program when posting an article.
8559 @item nnspool-spool-directory
8560 @vindex nnspool-spool-directory
8561 Where @code{nnspool} looks for the articles. This is normally
8562 @file{/usr/spool/news/}.
8564 @item nnspool-nov-directory
8565 @vindex nnspool-nov-directory
8566 Where @code{nnspool} will look for @sc{nov} files. This is normally
8567 @file{/usr/spool/news/over.view/}.
8569 @item nnspool-lib-dir
8570 @vindex nnspool-lib-dir
8571 Where the news lib dir is (@file{/usr/lib/news/} by default).
8573 @item nnspool-active-file
8574 @vindex nnspool-active-file
8575 The path of the active file.
8577 @item nnspool-newsgroups-file
8578 @vindex nnspool-newsgroups-file
8579 The path of the group descriptions file.
8581 @item nnspool-history-file
8582 @vindex nnspool-history-file
8583 The path of the news history file.
8585 @item nnspool-active-times-file
8586 @vindex nnspool-active-times-file
8587 The path of the active date file.
8589 @item nnspool-nov-is-evil
8590 @vindex nnspool-nov-is-evil
8591 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
8594 @item nnspool-sift-nov-with-sed
8595 @vindex nnspool-sift-nov-with-sed
8597 If non-@code{nil}, which is the default, use @code{sed} to get the
8598 relevant portion from the overview file. If nil, @code{nnspool} will
8599 load the entire file into a buffer and process it there.
8605 @section Getting Mail
8606 @cindex reading mail
8609 Reading mail with a newsreader---isn't that just plain WeIrD? But of
8613 * Getting Started Reading Mail:: A simple cookbook example.
8614 * Splitting Mail:: How to create mail groups.
8615 * Mail Backend Variables:: Variables for customizing mail handling.
8616 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
8617 * Mail and Procmail:: Reading mail groups that procmail create.
8618 * Incorporating Old Mail:: What about the old mail you have?
8619 * Expiring Mail:: Getting rid of unwanted mail.
8620 * Washing Mail:: Removing gruft from the mail you get.
8621 * Duplicates:: Dealing with duplicated mail.
8622 * Not Reading Mail:: Using mail backends for reading other files.
8623 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
8627 @node Getting Started Reading Mail
8628 @subsection Getting Started Reading Mail
8630 It's quite easy to use Gnus to read your new mail. You just plonk the
8631 mail backend of your choice into @code{gnus-secondary-select-methods},
8632 and things will happen automatically.
8634 For instance, if you want to use @code{nnml} (which is a one file per
8635 mail backend), you could put the following in your @file{.gnus} file:
8638 (setq gnus-secondary-select-methods
8639 '((nnml "private")))
8642 Now, the next time you start Gnus, this backend will be queried for new
8643 articles, and it will move all the messages in your spool file to its
8644 directory, which is @code{~/Mail/} by default. The new group that will
8645 be created (@samp{mail.misc}) will be subscribed, and you can read it
8646 like any other group.
8648 You will probably want to split the mail into several groups, though:
8651 (setq nnmail-split-methods
8652 '(("junk" "^From:.*Lars Ingebrigtsen")
8653 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
8657 This will result in three new @code{nnml} mail groups being created:
8658 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
8659 mail that doesn't fit into the first two groups will be placed in the
8662 This should be sufficient for reading mail with Gnus. You might want to
8663 give the other sections in this part of the manual a perusal, though,
8664 especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
8667 @node Splitting Mail
8668 @subsection Splitting Mail
8669 @cindex splitting mail
8670 @cindex mail splitting
8672 @vindex nnmail-split-methods
8673 The @code{nnmail-split-methods} variable says how the incoming mail is
8674 to be split into groups.
8677 (setq nnmail-split-methods
8678 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
8679 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
8683 This variable is a list of lists, where the first element of each of
8684 these lists is the name of the mail group (they do not have to be called
8685 something beginning with @samp{mail}, by the way), and the second
8686 element is a regular expression used on the header of each mail to
8687 determine if it belongs in this mail group.
8689 If the first element is the special symbol @code{junk}, then messages
8690 that match the regexp will disappear into the aether. Use with
8693 The second element can also be a function. In that case, it will be
8694 called narrowed to the headers with the first element of the rule as the
8695 argument. It should return a non-@code{nil} value if it thinks that the
8696 mail belongs in that group.
8698 The last of these groups should always be a general one, and the regular
8699 expression should @emph{always} be @samp{} so that it matches any mails
8700 that haven't been matched by any of the other regexps. (These rules are
8701 processed from the beginning of the alist toward the end. The first
8702 rule to make a match will "win", unless you have crossposting enabled.
8703 In that case, all matching rules will "win".)
8705 If you like to tinker with this yourself, you can set this variable to a
8706 function of your choice. This function will be called without any
8707 arguments in a buffer narrowed to the headers of an incoming mail
8708 message. The function should return a list of groups names that it
8709 thinks should carry this mail message.
8711 Note that the mail backends are free to maul the poor, innocent
8712 incoming headers all they want to. They all add @code{Lines} headers;
8713 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
8714 @code{From<SPACE>} line to something else.
8716 @vindex nnmail-crosspost
8717 The mail backends all support cross-posting. If several regexps match,
8718 the mail will be ``cross-posted'' to all those groups.
8719 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
8720 that no articles are crossposted to the general (@samp{}) group.
8722 @vindex nnmail-crosspost-link-function
8725 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
8726 the crossposted articles. However, not all files systems support hard
8727 links. If that's the case for you, set
8728 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
8729 variable is @code{add-name-to-file} by default.)
8731 @kindex M-x nnmail-split-history
8732 @kindex nnmail-split-history
8733 If you wish to see where the previous mail split put the messages, you
8734 can use the @kbd{M-x nnmail-split-history} command.
8736 Gnus gives you all the opportunity you could possibly want for shooting
8737 yourself in the foot. Let's say you create a group that will contain
8738 all the mail you get from your boss. And then you accidentally
8739 unsubscribe from the group. Gnus will still put all the mail from your
8740 boss in the unsubscribed group, and so, when your boss mails you ``Have
8741 that report ready by Monday or you're fired!'', you'll never see it and,
8742 come Tuesday, you'll still believe that you're gainfully employed while
8743 you really should be out collecting empty bottles to save up for next
8747 @node Mail Backend Variables
8748 @subsection Mail Backend Variables
8750 These variables are (for the most part) pertinent to all the various
8754 @vindex nnmail-read-incoming-hook
8755 @item nnmail-read-incoming-hook
8756 The mail backends all call this hook after reading new mail. You can
8757 use this hook to notify any mail watch programs, if you want to.
8759 @vindex nnmail-spool-file
8760 @item nnmail-spool-file
8764 @vindex nnmail-pop-password
8765 @vindex nnmail-pop-password-required
8766 The backends will look for new mail in this file. If this variable is
8767 @code{nil}, the mail backends will never attempt to fetch mail by
8768 themselves. If you are using a POP mail server and your name is
8769 @samp{larsi}, you should set this variable to @samp{po:larsi}. If
8770 your name is not @samp{larsi}, you should probably modify that
8771 slightly, but you may have guessed that already, you smart & handsome
8772 devil! You can also set this variable to @code{pop}, and Gnus will try
8773 to figure out the POP mail string by itself. In any case, Gnus will
8774 call @code{movemail} which will contact the POP server named in the
8775 @code{MAILHOST} environment variable. If the POP server needs a
8776 password, you can either set @code{nnmail-pop-password-required} to
8777 @code{t} and be prompted for the password, or set
8778 @code{nnmail-pop-password} to the password itself.
8780 @code{nnmail-spool-file} can also be a list of mailboxes.
8782 Your Emacs has to have been configured with @samp{--with-pop} before
8783 compilation. This is the default, but some installations have it
8786 When you use a mail backend, Gnus will slurp all your mail from your
8787 inbox and plonk it down in your home directory. Gnus doesn't move any
8788 mail if you're not using a mail backend---you have to do a lot of magic
8789 invocations first. At the time when you have finished drawing the
8790 pentagram, lightened the candles, and sacrificed the goat, you really
8791 shouldn't be too surprised when Gnus moves your mail.
8793 @vindex nnmail-use-procmail
8794 @vindex nnmail-procmail-suffix
8795 @item nnmail-use-procmail
8796 If non-@code{nil}, the mail backends will look in
8797 @code{nnmail-procmail-directory} for incoming mail. All the files in
8798 that directory that have names ending in @code{nnmail-procmail-suffix}
8799 will be considered incoming mailboxes, and will be searched for new
8802 @vindex nnmail-crash-box
8803 @item nnmail-crash-box
8804 When the mail backends read a spool file, it is first moved to this
8805 file, which is @file{~/.gnus-crash-box} by default. If this file
8806 already exists, it will always be read (and incorporated) before any
8809 @vindex nnmail-prepare-incoming-hook
8810 @item nnmail-prepare-incoming-hook
8811 This is run in a buffer that holds all the new incoming mail, and can be
8812 used for, well, anything, really.
8814 @vindex nnmail-split-hook
8815 @item nnmail-split-hook
8816 @findex article-decode-rfc1522
8817 @findex RFC1522 decoding
8818 Hook run in the buffer where the mail headers of each message is kept
8819 just before the splitting based on these headers is done. The hook is
8820 free to modify the buffer contents in any way it sees fit---the buffer
8821 is discarded after the splitting has been done, and no changes performed
8822 in the buffer will show up in any files. @code{gnus-article-decode-rfc1522}
8823 is one likely function to add to this hook.
8825 @vindex nnmail-pre-get-new-mail-hook
8826 @vindex nnmail-post-get-new-mail-hook
8827 @item nnmail-pre-get-new-mail-hook
8828 @itemx nnmail-post-get-new-mail-hook
8829 These are two useful hooks executed when treating new incoming
8830 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
8831 starting to handle the new mail) and
8832 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
8833 is done). Here's and example of using these two hooks to change the
8834 default file modes the new mail files get:
8837 (add-hook 'gnus-pre-get-new-mail-hook
8838 (lambda () (set-default-file-modes 511)))
8840 (add-hook 'gnus-post-get-new-mail-hook
8841 (lambda () (set-default-file-modes 551)))
8844 @item nnmail-tmp-directory
8845 @vindex nnmail-tmp-directory
8846 This variable says where to move the incoming mail to while processing
8847 it. This is usually done in the same directory that the mail backend
8848 inhabits (i.e., @file{~/Mail/}), but if this variable is non-@code{nil},
8849 it will be used instead.
8851 @item nnmail-movemail-program
8852 @vindex nnmail-movemail-program
8853 This program is executed to move mail from the user's inbox to her home
8854 directory. The default is @samp{movemail}.
8856 This can also be a function. In that case, the function will be called
8857 with two parameters -- the name of the inbox, and the file to be moved
8860 @item nnmail-delete-incoming
8861 @vindex nnmail-delete-incoming
8862 @cindex incoming mail files
8863 @cindex deleting incoming files
8864 If non-@code{nil}, the mail backends will delete the temporary incoming
8865 file after splitting mail into the proper groups. This is @code{t} by
8868 @c This is @code{nil} by
8869 @c default for reasons of security.
8871 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
8872 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
8873 lost mail, I think, but that's not the point. (Except certain versions
8874 of Red Gnus.)) By not deleting the Incoming* files, one can be sure to
8875 not lose mail -- if Gnus totally whacks out, one can always recover what
8878 Delete the @file{Incoming*} files at will.
8880 @item nnmail-use-long-file-names
8881 @vindex nnmail-use-long-file-names
8882 If non-@code{nil}, the mail backends will use long file and directory
8883 names. Groups like @samp{mail.misc} will end up in directories like
8884 @file{mail.misc/}. If it is @code{nil}, the same group will end up in
8887 @item nnmail-delete-file-function
8888 @vindex nnmail-delete-file-function
8890 Function called to delete files. It is @code{delete-file} by default.
8892 @item nnmail-cache-accepted-message-ids
8893 @vindex nnmail-cache-accepted-message-ids
8894 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
8895 the backend (via @code{Gcc}, for instance) into the mail duplication
8896 discovery cache. The default is @code{nil}.
8901 @node Fancy Mail Splitting
8902 @subsection Fancy Mail Splitting
8903 @cindex mail splitting
8904 @cindex fancy mail splitting
8906 @vindex nnmail-split-fancy
8907 @findex nnmail-split-fancy
8908 If the rather simple, standard method for specifying how to split mail
8909 doesn't allow you to do what you want, you can set
8910 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
8911 play with the @code{nnmail-split-fancy} variable.
8913 Let's look at an example value of this variable first:
8916 ;; Messages from the mailer daemon are not crossposted to any of
8917 ;; the ordinary groups. Warnings are put in a separate group
8918 ;; from real errors.
8919 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
8921 ;; Non-error messages are crossposted to all relevant
8922 ;; groups, but we don't crosspost between the group for the
8923 ;; (ding) list and the group for other (ding) related mail.
8924 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
8925 ("subject" "ding" "ding.misc"))
8926 ;; Other mailing lists...
8927 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
8928 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
8930 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
8931 ;; Unmatched mail goes to the catch all group.
8935 This variable has the format of a @dfn{split}. A split is a (possibly)
8936 recursive structure where each split may contain other splits. Here are
8937 the five possible split syntaxes:
8942 @samp{group}: If the split is a string, that will be taken as a group name.
8945 @var{(FIELD VALUE SPLIT)}: If the split is a list, and the first
8946 element is a string, then that means that if header FIELD (a regexp)
8947 contains VALUE (also a regexp), then store the message as specified by
8951 @var{(| SPLIT...)}: If the split is a list, and the first element is
8952 @code{|} (vertical bar), then process each SPLIT until one of them
8953 matches. A SPLIT is said to match if it will cause the mail message to
8954 be stored in one or more groups.
8957 @var{(& SPLIT...)}: If the split is a list, and the first element is
8958 @code{&}, then process all SPLITs in the list.
8961 @code{junk}: If the split is the symbol @code{junk}, then don't save
8962 this message anywhere.
8965 @var{(: function arg1 arg2 ...)}: If the split is a list, and the first
8966 element is @code{:}, then the second element will be called as a
8967 function with @var{args} given as arguments. The function should return
8972 In these splits, @var{FIELD} must match a complete field name.
8973 @var{VALUE} must match a complete word according to the fundamental mode
8974 syntax table. You can use @code{.*} in the regexps to match partial
8975 field names or words. In other words, all @var{VALUE}'s are wrapped in
8976 @samp{\<} and @samp{\>} pairs.
8978 @vindex nnmail-split-abbrev-alist
8979 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
8980 are expanded as specified by the variable
8981 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
8982 the car of the cells contains the key, and the cdr contains a string.
8984 @vindex nnmail-split-fancy-syntax-table
8985 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
8986 when all this splitting is performed.
8988 If you want to have Gnus create groups dynamically based on some
8989 information in the headers, you can say things like:
8992 (any "debian-\(\\w*\\)@@lists.debian.org" "mail.debian.\\1")
8995 That is, do @code{replace-match}-like substitions in the group names.
8998 @node Mail and Procmail
8999 @subsection Mail and Procmail
9004 Many people use @code{procmail} (or some other mail filter program or
9005 external delivery agent---@code{slocal}, @code{elm}, etc) to split
9006 incoming mail into groups. If you do that, you should set
9007 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
9008 backends never ever try to fetch mail by themselves.
9010 This also means that you probably don't want to set
9011 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
9014 When a mail backend is queried for what groups it carries, it replies
9015 with the contents of that variable, along with any groups it has figured
9016 out that it carries by other means. None of the backends (except
9017 @code{nnmh}) actually go out to the disk and check what groups actually
9018 exist. (It's not trivial to distinguish between what the user thinks is
9019 a basis for a newsgroup and what is just a plain old file or directory.)
9021 This means that you have to tell Gnus (and the backends) what groups
9024 Let's take the @code{nnmh} backend as an example.
9026 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
9027 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
9029 Go to the group buffer and type @kbd{G m}. When prompted, answer
9030 @samp{foo} for the name and @samp{nnmh} for the method. Repeat
9031 twice for the two other groups, @samp{bar} and @samp{mail.baz}. Be sure
9032 to include all your mail groups.
9034 That's it. You are now set to read your mail. An active file for this
9035 method will be created automatically.
9037 @vindex nnmail-procmail-suffix
9038 @vindex nnmail-procmail-directory
9039 If you use @code{nnfolder} or any other backend that store more than a
9040 single article in each file, you should never have procmail add mails to
9041 the file that Gnus sees. Instead, procmail should put all incoming mail
9042 in @code{nnmail-procmail-directory}. To arrive at the file name to put
9043 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
9044 name. The mail backends will read the mail from these files.
9046 @vindex nnmail-resplit-incoming
9047 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
9048 put in the @code{mail.misc}, as one would expect. However, if you want
9049 Gnus to split the mail the normal way, you could set
9050 @code{nnmail-resplit-incoming} to @code{t}.
9052 @vindex nnmail-keep-last-article
9053 If you use @code{procmail} to split things directory into an @code{nnmh}
9054 directory (which you shouldn't do), you should set
9055 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
9056 ever expiring the final article (i. e., the article with the highest
9057 article number) in a mail newsgroup. This is quite, quite important.
9059 Here's an example setup: The incoming spools are located in
9060 @file{~/incoming/} and have @samp{""} as suffixes (i. e., the incoming
9061 spool files have the same names as the equivalent groups). The
9062 @code{nnfolder} backend is to be used as the mail interface, and the
9063 @code{nnfolder} directory is @file{~/fMail/}.
9066 (setq nnfolder-directory "~/fMail/")
9067 (setq nnmail-spool-file 'procmail)
9068 (setq nnmail-procmail-directory "~/incoming/")
9069 (setq gnus-secondary-select-methods '((nnfolder "")))
9070 (setq nnmail-procmail-suffix "")
9074 @node Incorporating Old Mail
9075 @subsection Incorporating Old Mail
9077 Most people have lots of old mail stored in various file formats. If
9078 you have set up Gnus to read mail using one of the spiffy Gnus mail
9079 backends, you'll probably wish to have that old mail incorporated into
9082 Doing so can be quite easy.
9084 To take an example: You're reading mail using @code{nnml}
9085 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
9086 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
9087 file filled with important, but old, mail. You want to move it into
9088 your @code{nnml} groups.
9094 Go to the group buffer.
9097 Type `G f' and give the path of the mbox file when prompted to create an
9098 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9101 Type `SPACE' to enter the newly created group.
9104 Type `M P b' to process-mark all articles in this group (@pxref{Setting
9108 Type `B r' to respool all the process-marked articles, and answer
9109 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9112 All the mail messages in the mbox file will now also be spread out over
9113 all your @code{nnml} groups. Try entering them and check whether things
9114 have gone without a glitch. If things look ok, you may consider
9115 deleting the mbox file, but I wouldn't do that unless I was absolutely
9116 sure that all the mail has ended up where it should be.
9118 Respooling is also a handy thing to do if you're switching from one mail
9119 backend to another. Just respool all the mail in the old mail groups
9120 using the new mail backend.
9124 @subsection Expiring Mail
9125 @cindex article expiry
9127 Traditional mail readers have a tendency to remove mail articles when
9128 you mark them as read, in some way. Gnus takes a fundamentally
9129 different approach to mail reading.
9131 Gnus basically considers mail just to be news that has been received in
9132 a rather peculiar manner. It does not think that it has the power to
9133 actually change the mail, or delete any mail messages. If you enter a
9134 mail group, and mark articles as ``read'', or kill them in some other
9135 fashion, the mail articles will still exist on the system. I repeat:
9136 Gnus will not delete your old, read mail. Unless you ask it to, of
9139 To make Gnus get rid of your unwanted mail, you have to mark the
9140 articles as @dfn{expirable}. This does not mean that the articles will
9141 disappear right away, however. In general, a mail article will be
9142 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9143 more than one week old. If you do not mark an article as expirable, it
9144 will remain on your system until hell freezes over. This bears
9145 repeating one more time, with some spurious capitalizations: IF you do
9146 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9148 @vindex gnus-auto-expirable-newsgroups
9149 You do not have to mark articles as expirable by hand. Groups that
9150 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9151 have all articles that you read marked as expirable automatically. All
9152 articles that are marked as expirable have an @samp{E} in the first
9153 column in the summary buffer.
9155 Note that making a group auto-expirable don't mean that all read
9156 articles are expired---only the articles that are marked as expirable
9157 will be expired. Also note the using the @kbd{d} command won't make
9158 groups expirable---only semi-automatic marking of articles as read will
9159 mark the articles as expirable in auto-expirable groups.
9161 Let's say you subscribe to a couple of mailing lists, and you want the
9162 articles you have read to disappear after a while:
9165 (setq gnus-auto-expirable-newsgroups
9166 "mail.nonsense-list\\|mail.nice-list")
9169 Another way to have auto-expiry happen is to have the element
9170 @code{auto-expire} in the group parameters of the group.
9172 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9173 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
9174 doesn't really mix very well.
9176 @vindex nnmail-expiry-wait
9177 The @code{nnmail-expiry-wait} variable supplies the default time an
9178 expirable article has to live. Gnus starts counting days from when the
9179 message @emph{arrived}, not from when it was sent. The default is seven
9182 Gnus also supplies a function that lets you fine-tune how long articles
9183 are to live, based on what group they are in. Let's say you want to
9184 have one month expiry period in the @samp{mail.private} group, a one day
9185 expiry period in the @samp{mail.junk} group, and a six day expiry period
9188 @vindex nnmail-expiry-wait-function
9190 (setq nnmail-expiry-wait-function
9192 (cond ((string= group "mail.private")
9194 ((string= group "mail.junk")
9196 ((string= group "important")
9202 The group names that this function is fed are ``unadorned'' group
9203 names---no @samp{nnml:} prefixes and the like.
9205 The @code{nnmail-expiry-wait} variable and
9206 @code{nnmail-expiry-wait-function} function can be either a number (not
9207 necessarily an integer) or the symbols @code{immediate} or
9210 You can also use the @code{expiry-wait} group parameter to selectively
9211 change the expiry period (@pxref{Group Parameters}).
9213 @vindex nnmail-keep-last-article
9214 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9215 expire the final article in a mail newsgroup. This is to make life
9216 easier for procmail users.
9218 @vindex gnus-total-expirable-newsgroups
9219 By the way, that line up there about Gnus never expiring non-expirable
9220 articles is a lie. If you put @code{total-expire} in the group
9221 parameters, articles will not be marked as expirable, but all read
9222 articles will be put through the expiry process. Use with extreme
9223 caution. Even more dangerous is the
9224 @code{gnus-total-expirable-newsgroups} variable. All groups that match
9225 this regexp will have all read articles put through the expiry process,
9226 which means that @emph{all} old mail articles in the groups in question
9227 will be deleted after a while. Use with extreme caution, and don't come
9228 crying to me when you discover that the regexp you used matched the
9229 wrong group and all your important mail has disappeared. Be a
9230 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
9233 Most people make most of their mail groups total-expirable, though.
9237 @subsection Washing Mail
9238 @cindex mail washing
9239 @cindex list server brain damage
9240 @cindex incoming mail treatment
9242 Mailers and list servers are notorious for doing all sorts of really,
9243 really stupid things with mail. ``Hey, RFC822 doesn't explicitly
9244 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
9245 end of all lines passing through our server, so let's do that!!!!1!''
9246 Yes, but RFC822 wasn't designed to be read by morons. Things that were
9247 considered to be self-evident were not discussed. So. Here we are.
9249 Case in point: The German version of Microsoft Exchange adds @samp{AW:
9250 } to the subjects of replies instead of @samp{Re: }. I could pretend to
9251 be shocked and dismayed by this, but I haven't got the energy. It is to
9254 Gnus provides a plethora of functions for washing articles while
9255 displaying them, but it might be nicer to do the filtering before
9256 storing the mail to disc. For that purpose, we have three hooks and
9257 various functions that can be put in these hooks.
9260 @item nnmail-prepare-incoming-hook
9261 @vindex nnmail-prepare-incoming-hook
9262 This hook is called before doing anything with the mail and is meant for
9263 grand, sweeping gestures. Functions to be used include:
9266 @item nnheader-ms-strip-cr
9267 @findex nnheader-ms-strip-cr
9268 Remove trailing carriage returns from each line. This is default on
9269 Emacs running on MS machines.
9273 @item nnmail-prepare-incoming-header-hook
9274 @vindex nnmail-prepare-incoming-header-hook
9275 This hook is called narrowed to each header. It can be used when
9276 cleaning up the headers. Functions that can be used include:
9279 @item nnmail-remove-leading-whitespace
9280 @findex nnmail-remove-leading-whitespace
9281 Clear leading white space that ``helpful'' listservs have added to the
9282 headers too make them look nice. Aaah.
9284 @item nnmail-remove-list-identifiers
9285 @findex nnmail-remove-list-identifiers
9286 Some list servers add an identifier---for example, @samp{(idm)}---to the
9287 beginning of all @code{Subject} headers. I'm sure that's nice for
9288 people who use stone age mail readers. This function will remove
9289 strings that match the @code{nnmail-list-identifiers} regexp, which can
9290 also be a list of regexp.
9292 For instance, if you want to remove the @samp{(idm)} and the
9293 @samp{nagnagnag} identifiers:
9296 (setq nnmail-list-identifiers
9297 '("(idm)" "nagnagnag"))
9300 @item nnmail-remove-tabs
9301 @findex nnmail-remove-tabs
9302 Translate all @samp{TAB} characters into @samp{SPACE} characters.
9306 @item nnmail-prepare-incoming-message-hook
9307 @vindex nnmail-prepare-incoming-message-hook
9308 This hook is called narrowed to each message. Functions to be used
9312 @item article-de-quoted-unreadable
9313 @findex article-de-quoted-unreadable
9314 Decode Quoted Readable encoding.
9321 @subsection Duplicates
9323 @vindex nnmail-treat-duplicates
9324 @vindex nnmail-message-id-cache-length
9325 @vindex nnmail-message-id-cache-file
9326 @cindex duplicate mails
9327 If you are a member of a couple of mailing list, you will sometime
9328 receive two copies of the same mail. This can be quite annoying, so
9329 @code{nnmail} checks for and treats any duplicates it might find. To do
9330 this, it keeps a cache of old @code{Message-ID}s---
9331 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
9332 default. The approximate maximum number of @code{Message-ID}s stored
9333 there is controlled by the @code{nnmail-message-id-cache-length}
9334 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
9335 stored.) If all this sounds scary to you, you can set
9336 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
9337 default), and @code{nnmail} won't delete duplicate mails. Instead it
9338 will insert a warning into the head of the mail saying that it thinks
9339 that this is a duplicate of a different message.
9341 This variable can also be a function. If that's the case, the function
9342 will be called from a buffer narrowed to the message in question with
9343 the @code{Message-ID} as a parameter. The function must return either
9344 @code{nil}, @code{warn}, or @code{delete}.
9346 You can turn this feature off completely by setting the variable to
9349 If you want all the duplicate mails to be put into a special
9350 @dfn{duplicates} group, you could do that using the normal mail split
9354 (setq nnmail-split-fancy
9355 '(| ;; Messages duplicates go to a separate group.
9356 ("gnus-warning" "duplication of message" "duplicate")
9357 ;; Message from daemons, postmaster, and the like to another.
9358 (any mail "mail.misc")
9365 (setq nnmail-split-methods
9366 '(("duplicates" "^Gnus-Warning:")
9371 Here's a neat feature: If you know that the recipient reads her mail
9372 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
9373 @code{delete}, you can send her as many insults as you like, just by
9374 using a @code{Message-ID} of a mail that you know that she's already
9375 received. Think of all the fun! She'll never see any of it! Whee!
9378 @node Not Reading Mail
9379 @subsection Not Reading Mail
9381 If you start using any of the mail backends, they have the annoying
9382 habit of assuming that you want to read mail with them. This might not
9383 be unreasonable, but it might not be what you want.
9385 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
9386 will ever attempt to read incoming mail, which should help.
9388 @vindex nnbabyl-get-new-mail
9389 @vindex nnmbox-get-new-mail
9390 @vindex nnml-get-new-mail
9391 @vindex nnmh-get-new-mail
9392 @vindex nnfolder-get-new-mail
9393 This might be too much, if, for instance, you are reading mail quite
9394 happily with @code{nnml} and just want to peek at some old @sc{rmail}
9395 file you have stashed away with @code{nnbabyl}. All backends have
9396 variables called backend-@code{get-new-mail}. If you want to disable
9397 the @code{nnbabyl} mail reading, you edit the virtual server for the
9398 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
9400 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
9401 narrowed to the article to be saved before saving it when reading
9405 @node Choosing a Mail Backend
9406 @subsection Choosing a Mail Backend
9408 Gnus will read the mail spool when you activate a mail group. The mail
9409 file is first copied to your home directory. What happens after that
9410 depends on what format you want to store your mail in.
9413 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
9414 * Rmail Babyl:: Emacs programs use the rmail babyl format.
9415 * Mail Spool:: Store your mail in a private spool?
9416 * MH Spool:: An mhspool-like backend.
9417 * Mail Folders:: Having one file for each group.
9422 @subsubsection Unix Mail Box
9424 @cindex unix mail box
9426 @vindex nnmbox-active-file
9427 @vindex nnmbox-mbox-file
9428 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
9429 mail. @code{nnmbox} will add extra headers to each mail article to say
9430 which group it belongs in.
9432 Virtual server settings:
9435 @item nnmbox-mbox-file
9436 @vindex nnmbox-mbox-file
9437 The name of the mail box in the user's home directory.
9439 @item nnmbox-active-file
9440 @vindex nnmbox-active-file
9441 The name of the active file for the mail box.
9443 @item nnmbox-get-new-mail
9444 @vindex nnmbox-get-new-mail
9445 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
9451 @subsubsection Rmail Babyl
9455 @vindex nnbabyl-active-file
9456 @vindex nnbabyl-mbox-file
9457 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
9458 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
9459 article to say which group it belongs in.
9461 Virtual server settings:
9464 @item nnbabyl-mbox-file
9465 @vindex nnbabyl-mbox-file
9466 The name of the rmail mbox file.
9468 @item nnbabyl-active-file
9469 @vindex nnbabyl-active-file
9470 The name of the active file for the rmail box.
9472 @item nnbabyl-get-new-mail
9473 @vindex nnbabyl-get-new-mail
9474 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
9479 @subsubsection Mail Spool
9481 @cindex mail @sc{nov} spool
9483 The @dfn{nnml} spool mail format isn't compatible with any other known
9484 format. It should be used with some caution.
9486 @vindex nnml-directory
9487 If you use this backend, Gnus will split all incoming mail into files;
9488 one file for each mail, and put the articles into the correct
9489 directories under the directory specified by the @code{nnml-directory}
9490 variable. The default value is @file{~/Mail/}.
9492 You do not have to create any directories beforehand; Gnus will take
9495 If you have a strict limit as to how many files you are allowed to store
9496 in your account, you should not use this backend. As each mail gets its
9497 own file, you might very well occupy thousands of inodes within a few
9498 weeks. If this is no problem for you, and it isn't a problem for you
9499 having your friendly systems administrator walking around, madly,
9500 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
9501 know that this is probably the fastest format to use. You do not have
9502 to trudge through a big mbox file just to read your new mail.
9504 @code{nnml} is probably the slowest backend when it comes to article
9505 splitting. It has to create lots of files, and it also generates
9506 @sc{nov} databases for the incoming mails. This makes is the fastest
9507 backend when it comes to reading mail.
9509 Virtual server settings:
9512 @item nnml-directory
9513 @vindex nnml-directory
9514 All @code{nnml} directories will be placed under this directory.
9516 @item nnml-active-file
9517 @vindex nnml-active-file
9518 The active file for the @code{nnml} server.
9520 @item nnml-newsgroups-file
9521 @vindex nnml-newsgroups-file
9522 The @code{nnml} group descriptions file. @xref{Newsgroups File
9525 @item nnml-get-new-mail
9526 @vindex nnml-get-new-mail
9527 If non-@code{nil}, @code{nnml} will read incoming mail.
9529 @item nnml-nov-is-evil
9530 @vindex nnml-nov-is-evil
9531 If non-@code{nil}, this backend will ignore any @sc{nov} files.
9533 @item nnml-nov-file-name
9534 @vindex nnml-nov-file-name
9535 The name of the @sc{nov} files. The default is @file{.overview}.
9537 @item nnml-prepare-save-mail-hook
9538 @vindex nnml-prepare-save-mail-hook
9539 Hook run narrowed to an article before saving.
9543 @findex nnml-generate-nov-databases
9544 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
9545 you can do a complete update by typing @kbd{M-x
9546 nnml-generate-nov-databases}. This command will trawl through the
9547 entire @code{nnml} hierarchy, looking at each and every article, so it
9548 might take a while to complete. A better interface to this
9549 functionality can be found in the server buffer (@pxref{Server
9554 @subsubsection MH Spool
9556 @cindex mh-e mail spool
9558 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
9559 @sc{nov} databases and it doesn't keep an active file. This makes
9560 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
9561 makes it easier to write procmail scripts for.
9563 Virtual server settings:
9566 @item nnmh-directory
9567 @vindex nnmh-directory
9568 All @code{nnmh} directories will be located under this directory.
9570 @item nnmh-get-new-mail
9571 @vindex nnmh-get-new-mail
9572 If non-@code{nil}, @code{nnmh} will read incoming mail.
9575 @vindex nnmh-be-safe
9576 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
9577 sure that the articles in the folder are actually what Gnus thinks they
9578 are. It will check date stamps and stat everything in sight, so
9579 setting this to @code{t} will mean a serious slow-down. If you never
9580 use anything but Gnus to read the @code{nnmh} articles, you do not have
9581 to set this variable to @code{t}.
9586 @subsubsection Mail Folders
9588 @cindex mbox folders
9589 @cindex mail folders
9591 @code{nnfolder} is a backend for storing each mail group in a separate
9592 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
9593 will add extra headers to keep track of article numbers and arrival
9596 Virtual server settings:
9599 @item nnfolder-directory
9600 @vindex nnfolder-directory
9601 All the @code{nnfolder} mail boxes will be stored under this directory.
9603 @item nnfolder-active-file
9604 @vindex nnfolder-active-file
9605 The name of the active file.
9607 @item nnfolder-newsgroups-file
9608 @vindex nnfolder-newsgroups-file
9609 The name of the group descriptions file. @xref{Newsgroups File Format}.
9611 @item nnfolder-get-new-mail
9612 @vindex nnfolder-get-new-mail
9613 If non-@code{nil}, @code{nnfolder} will read incoming mail.
9616 @findex nnfolder-generate-active-file
9617 @kindex M-x nnfolder-generate-active-file
9618 If you have lots of @code{nnfolder}-like files you'd like to read with
9619 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
9620 command to make @code{nnfolder} aware of all likely files in
9621 @code{nnfolder-directory}.
9625 @section Other Sources
9627 Gnus can do more than just read news or mail. The methods described
9628 below allow Gnus to view directories and files as if they were
9632 * Directory Groups:: You can read a directory as if it was a newsgroup.
9633 * Anything Groups:: Dired? Who needs dired?
9634 * Document Groups:: Single files can be the basis of a group.
9635 * SOUP:: Reading @sc{SOUP} packets ``offline''.
9636 * Web Searches:: Creating groups from articles that match a string.
9637 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
9641 @node Directory Groups
9642 @subsection Directory Groups
9644 @cindex directory groups
9646 If you have a directory that has lots of articles in separate files in
9647 it, you might treat it as a newsgroup. The files have to have numerical
9650 This might be an opportune moment to mention @code{ange-ftp}, that most
9651 wonderful of all wonderful Emacs packages. When I wrote @code{nndir}, I
9652 didn't think much about it---a backend to read directories. Big deal.
9654 @code{ange-ftp} changes that picture dramatically. For instance, if you
9655 enter the @code{ange-ftp} file name
9656 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the the directory name,
9657 @code{ange-ftp} will actually allow you to read this directory over at
9658 @samp{sina} as a newsgroup. Distributed news ahoy!
9660 @code{nndir} will use @sc{nov} files if they are present.
9662 @code{nndir} is a ``read-only'' backend---you can't delete or expire
9663 articles with this method. You can use @code{nnmh} or @code{nnml} for
9664 whatever you use @code{nndir} for, so you could switch to any of those
9665 methods if you feel the need to have a non-read-only @code{nndir}.
9668 @node Anything Groups
9669 @subsection Anything Groups
9672 From the @code{nndir} backend (which reads a single spool-like
9673 directory), it's just a hop and a skip to @code{nneething}, which
9674 pretends that any arbitrary directory is a newsgroup. Strange, but
9677 When @code{nneething} is presented with a directory, it will scan this
9678 directory and assign article numbers to each file. When you enter such
9679 a group, @code{nneething} must create ``headers'' that Gnus can use.
9680 After all, Gnus is a newsreader, in case you're
9681 forgetting. @code{nneething} does this in a two-step process. First, it
9682 snoops each file in question. If the file looks like an article (i.e.,
9683 the first few lines look like headers), it will use this as the head.
9684 If this is just some arbitrary file without a head (e.g. a C source
9685 file), @code{nneething} will cobble up a header out of thin air. It
9686 will use file ownership, name and date and do whatever it can with these
9689 All this should happen automatically for you, and you will be presented
9690 with something that looks very much like a newsgroup. Totally like a
9691 newsgroup, to be precise. If you select an article, it will be displayed
9692 in the article buffer, just as usual.
9694 If you select a line that represents a directory, Gnus will pop you into
9695 a new summary buffer for this @code{nneething} group. And so on. You can
9696 traverse the entire disk this way, if you feel like, but remember that
9697 Gnus is not dired, really, and does not intend to be, either.
9699 There are two overall modes to this action---ephemeral or solid. When
9700 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
9701 will not store information on what files you have read, and what files
9702 are new, and so on. If you create a solid @code{nneething} group the
9703 normal way with @kbd{G m}, Gnus will store a mapping table between
9704 article numbers and file names, and you can treat this group like any
9705 other groups. When you activate a solid @code{nneething} group, you will
9706 be told how many unread articles it contains, etc., etc.
9711 @item nneething-map-file-directory
9712 @vindex nneething-map-file-directory
9713 All the mapping files for solid @code{nneething} groups will be stored
9714 in this directory, which defaults to @file{~/.nneething/}.
9716 @item nneething-exclude-files
9717 @vindex nneething-exclude-files
9718 All files that match this regexp will be ignored. Nice to use to exclude
9719 auto-save files and the like, which is what it does by default.
9721 @item nneething-map-file
9722 @vindex nneething-map-file
9723 Name of the map files.
9727 @node Document Groups
9728 @subsection Document Groups
9730 @cindex documentation group
9733 @code{nndoc} is a cute little thing that will let you read a single file
9734 as a newsgroup. Several files types are supported:
9741 The babyl (rmail) mail box.
9746 The standard Unix mbox file.
9748 @cindex MMDF mail box
9750 The MMDF mail box format.
9753 Several news articles appended into a file.
9756 @cindex rnews batch files
9757 The rnews batch transport format.
9758 @cindex forwarded messages
9767 @cindex RFC 1153 digest
9768 @cindex RFC 341 digest
9769 MIME (RFC 1341) digest format.
9771 @item standard-digest
9772 The standard (RFC 1153) digest format.
9775 Non-standard digest format---matches most things, but does it badly.
9778 You can also use the special ``file type'' @code{guess}, which means
9779 that @code{nndoc} will try to guess what file type it is looking at.
9780 @code{digest} means that @code{nndoc} should guess what digest type the
9783 @code{nndoc} will not try to change the file or insert any extra headers into
9784 it---it will simply, like, let you use the file as the basis for a
9785 group. And that's it.
9787 If you have some old archived articles that you want to insert into your
9788 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
9789 that. Say you have an old @file{RMAIL} file with mail that you now want
9790 to split into your new @code{nnml} groups. You look at that file using
9791 @code{nndoc} (using the @kbd{G f} command in the group buffer
9792 (@pxref{Foreign Groups})), set the process mark on all the articles in
9793 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
9794 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
9795 file is now also stored in lots of @code{nnml} directories, and you can
9796 delete that pesky @file{RMAIL} file. If you have the guts!
9798 Virtual server variables:
9801 @item nndoc-article-type
9802 @vindex nndoc-article-type
9803 This should be one of @code{mbox}, @code{babyl}, @code{digest},
9804 @code{mmdf}, @code{forward}, @code{rfc934}, @code{rfc822-forward},
9805 @code{news}, @code{rnews}, @code{mime-digest}, @code{clari-briefs}, or
9808 @item nndoc-post-type
9809 @vindex nndoc-post-type
9810 This variable says whether Gnus is to consider the group a news group or
9811 a mail group. There are two legal values: @code{mail} (the default)
9816 * Document Server Internals:: How to add your own document types.
9820 @node Document Server Internals
9821 @subsubsection Document Server Internals
9823 Adding new document types to be recognized by @code{nndoc} isn't
9824 difficult. You just have to whip up a definition of what the document
9825 looks like, write a predicate function to recognize that document type,
9826 and then hook into @code{nndoc}.
9828 First, here's an example document type definition:
9832 (article-begin . "^\^A\^A\^A\^A\n")
9833 (body-end . "^\^A\^A\^A\^A\n"))
9836 The definition is simply a unique @dfn{name} followed by a series of
9837 regexp pseudo-variable settings. Below are the possible
9838 variables---don't be daunted by the number of variables; most document
9839 types can be defined with very few settings:
9843 If present, @code{nndoc} will skip past all text until it finds
9844 something that match this regexp. All text before this will be
9848 This setting has to be present in all document type definitions. It
9849 says what the beginning of each article looks like.
9851 @item head-begin-function
9852 If present, this should be a function that moves point to the head of
9855 @item nndoc-head-begin
9856 If present, this should be a regexp that matches the head of the
9859 @item nndoc-head-end
9860 This should match the end of the head of the article. It defaults to
9861 @samp{^$}---the empty line.
9863 @item body-begin-function
9864 If present, this function should move point to the beginning of the body
9868 This should match the beginning of the body of the article. It defaults
9871 @item body-end-function
9872 If present, this function should move point to the end of the body of
9876 If present, this should match the end of the body of the article.
9878 @item nndoc-file-end
9879 If present, this should match the end of the file. All text after this
9880 regexp will be totally ignored.
9884 So, using these variables @code{nndoc} is able to dissect a document
9885 file into a series of articles, each with a head and a body. However, a
9886 few more variables are needed since not all document types are all that
9887 news-like---variables needed to transform the head or the body into
9888 something that's palatable for Gnus:
9891 @item prepare-body-function
9892 If present, this function will be called when requesting an article. It
9893 will be called with point at the start of the body, and is useful if the
9894 document has encoded some parts of its contents.
9896 @item article-transform-function
9897 If present, this function is called when requesting an article. It's
9898 meant to be used how more wide-ranging transformation of both head and
9899 body of the article.
9901 @item generate-head-function
9902 If present, this function is called to generate a head that Gnus can
9903 understand. It is called with the article number as a parameter, and is
9904 expected to generate a nice head for the article in question. It is
9905 called when requesting the headers of all articles.
9909 Let's look at the most complicated example I can come up with---standard
9914 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
9915 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
9916 (prepare-body-function . nndoc-unquote-dashes)
9917 (body-end-function . nndoc-digest-body-end)
9919 (body-begin . "^ ?\n")
9920 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
9921 (subtype digest guess))
9924 We see that all text before a 70-width line of dashes is ignored; all
9925 text after a line that starts with that @samp{^End of} is also ignored;
9926 each article begins with a 30-width line of dashes; the line separating
9927 the head from the body may contain a single space; and that the body is
9928 run through @code{nndoc-unquote-dashes} before being delivered.
9930 To hook your own document definition into @code{nndoc}, use the
9931 @code{nndoc-add-type} function. It takes two parameters---the first is
9932 the definition itself and the second (optional) parameter says where in
9933 the document type definition alist to put this definition. The alist is
9934 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for each
9935 type. So @code{nndoc-mmdf-type-p} is called to see whether a document
9936 is of @code{mmdf} type, and so on. These type predicates should return
9937 @code{nil} if the document is not of the correct type; @code{t} if it is
9938 of the correct type; and a number if the document might be of the
9939 correct type. A high number means high probability; a low number means
9940 low probability with @samp{0} being the lowest legal number.
9948 In the PC world people often talk about ``offline'' newsreaders. These
9949 are thingies that are combined reader/news transport monstrosities.
9950 With built-in modem programs. Yecchh!
9952 Of course, us Unix Weenie types of human beans use things like
9953 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
9954 transport things like Ghod intended. And then we just use normal
9957 However, it can sometimes be convenient to do something a that's a bit
9958 easier on the brain if you have a very slow modem, and you're not really
9959 that interested in doing things properly.
9961 A file format called @sc{soup} has been developed for transporting news
9962 and mail from servers to home machines and back again. It can be a bit
9965 First some terminology:
9970 This is the machine that is connected to the outside world and where you
9971 get news and/or mail from.
9974 This is the machine that you want to do the actual reading and responding
9975 on. It is typically not connected to the rest of the world in any way.
9978 Something that contains messages and/or commands. There are two kinds
9982 @item message packets
9983 These are packets made at the server, and typically contains lots of
9984 messages for you to read. These are called @file{SoupoutX.tgz} by
9985 default, where @var{X} is a number.
9987 @item response packets
9988 These are packets made at the home machine, and typically contains
9989 replies that you've written. These are called @file{SoupinX.tgz} by
9990 default, where @var{X} is a number.
10000 You log in on the server and create a @sc{soup} packet. You can either
10001 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
10002 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
10003 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
10006 You transfer the packet home. Rail, boat, car or modem will do fine.
10009 You put the packet in your home directory.
10012 You fire up Gnus on your home machine using the @code{nnsoup} backend as
10013 the native or secondary server.
10016 You read articles and mail and answer and followup to the things you
10017 want (@pxref{SOUP Replies}).
10020 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
10024 You transfer this packet to the server.
10027 You use Gnus to mail this packet out with the @kbd{G s s} command.
10030 You then repeat until you die.
10034 So you basically have a bipartite system---you use @code{nnsoup} for
10035 reading and Gnus for packing/sending these @sc{soup} packets.
10038 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
10039 * SOUP Groups:: A backend for reading @sc{soup} packets.
10040 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
10044 @node SOUP Commands
10045 @subsubsection SOUP Commands
10047 These are commands for creating and manipulating @sc{soup} packets.
10051 @kindex G s b (Group)
10052 @findex gnus-group-brew-soup
10053 Pack all unread articles in the current group
10054 (@code{gnus-group-brew-soup}). This command understands the
10055 process/prefix convention.
10058 @kindex G s w (Group)
10059 @findex gnus-soup-save-areas
10060 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
10063 @kindex G s s (Group)
10064 @findex gnus-soup-send-replies
10065 Send all replies from the replies packet
10066 (@code{gnus-soup-send-replies}).
10069 @kindex G s p (Group)
10070 @findex gnus-soup-pack-packet
10071 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
10074 @kindex G s r (Group)
10075 @findex nnsoup-pack-replies
10076 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
10079 @kindex O s (Summary)
10080 @findex gnus-soup-add-article
10081 This summary-mode command adds the current article to a @sc{soup} packet
10082 (@code{gnus-soup-add-article}). It understands the process/prefix
10083 convention (@pxref{Process/Prefix}).
10088 There are a few variables to customize where Gnus will put all these
10093 @item gnus-soup-directory
10094 @vindex gnus-soup-directory
10095 Directory where Gnus will save intermediate files while composing
10096 @sc{soup} packets. The default is @file{~/SoupBrew/}.
10098 @item gnus-soup-replies-directory
10099 @vindex gnus-soup-replies-directory
10100 This is what Gnus will use as a temporary directory while sending our
10101 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
10103 @item gnus-soup-prefix-file
10104 @vindex gnus-soup-prefix-file
10105 Name of the file where Gnus stores the last used prefix. The default is
10106 @samp{gnus-prefix}.
10108 @item gnus-soup-packer
10109 @vindex gnus-soup-packer
10110 A format string command for packing a @sc{soup} packet. The default is
10111 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
10113 @item gnus-soup-unpacker
10114 @vindex gnus-soup-unpacker
10115 Format string command for unpacking a @sc{soup} packet. The default is
10116 @samp{gunzip -c %s | tar xvf -}.
10118 @item gnus-soup-packet-directory
10119 @vindex gnus-soup-packet-directory
10120 Where Gnus will look for reply packets. The default is @file{~/}.
10122 @item gnus-soup-packet-regexp
10123 @vindex gnus-soup-packet-regexp
10124 Regular expression matching @sc{soup} reply packets in
10125 @code{gnus-soup-packet-directory}.
10131 @subsubsection @sc{soup} Groups
10134 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
10135 read incoming packets, unpack them, and put them in a directory where
10136 you can read them at leisure.
10138 These are the variables you can use to customize its behavior:
10142 @item nnsoup-tmp-directory
10143 @vindex nnsoup-tmp-directory
10144 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10145 directory. (@file{/tmp/} by default.)
10147 @item nnsoup-directory
10148 @vindex nnsoup-directory
10149 @code{nnsoup} then moves each message and index file to this directory.
10150 The default is @file{~/SOUP/}.
10152 @item nnsoup-replies-directory
10153 @vindex nnsoup-replies-directory
10154 All replies will stored in this directory before being packed into a
10155 reply packet. The default is @file{~/SOUP/replies/"}.
10157 @item nnsoup-replies-format-type
10158 @vindex nnsoup-replies-format-type
10159 The @sc{soup} format of the replies packets. The default is @samp{?n}
10160 (rnews), and I don't think you should touch that variable. I probably
10161 shouldn't even have documented it. Drats! Too late!
10163 @item nnsoup-replies-index-type
10164 @vindex nnsoup-replies-index-type
10165 The index type of the replies packet. The is @samp{?n}, which means
10166 ``none''. Don't fiddle with this one either!
10168 @item nnsoup-active-file
10169 @vindex nnsoup-active-file
10170 Where @code{nnsoup} stores lots of information. This is not an ``active
10171 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
10172 this file or mess it up in any way, you're dead. The default is
10173 @file{~/SOUP/active}.
10175 @item nnsoup-packer
10176 @vindex nnsoup-packer
10177 Format string command for packing a reply @sc{soup} packet. The default
10178 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
10180 @item nnsoup-unpacker
10181 @vindex nnsoup-unpacker
10182 Format string command for unpacking incoming @sc{soup} packets. The
10183 default is @samp{gunzip -c %s | tar xvf -}.
10185 @item nnsoup-packet-directory
10186 @vindex nnsoup-packet-directory
10187 Where @code{nnsoup} will look for incoming packets. The default is
10190 @item nnsoup-packet-regexp
10191 @vindex nnsoup-packet-regexp
10192 Regular expression matching incoming @sc{soup} packets. The default is
10199 @subsubsection SOUP Replies
10201 Just using @code{nnsoup} won't mean that your postings and mailings end
10202 up in @sc{soup} reply packets automagically. You have to work a bit
10203 more for that to happen.
10205 @findex nnsoup-set-variables
10206 The @code{nnsoup-set-variables} command will set the appropriate
10207 variables to ensure that all your followups and replies end up in the
10210 In specific, this is what it does:
10213 (setq message-send-news-function 'nnsoup-request-post)
10214 (setq message-send-mail-function 'nnsoup-request-mail)
10217 And that's it, really. If you only want news to go into the @sc{soup}
10218 system you just use the first line. If you only want mail to be
10219 @sc{soup}ed you use the second.
10223 @subsection Web Searches
10227 @cindex InReference
10228 @cindex Usenet searches
10229 @cindex searching the Usenet
10231 It's, like, too neat to search the Usenet for articles that match a
10232 string, but it, like, totally @emph{sucks}, like, totally, to use one of
10233 those, like, Web browsers, and you, like, have to, rilly, like, look at
10234 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
10235 searches without having to use a browser.
10237 The @code{nnweb} backend allows an easy interface to the mighty search
10238 engine. You create an @code{nnweb} group, enter a search pattern, and
10239 then enter the group and read the articles like you would any normal
10240 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
10241 Groups}) will do this in an easy-to-use fashion.
10243 @code{nnweb} groups don't really lend themselves to being solid
10244 groups---they have a very fleeting idea of article numbers. In fact,
10245 each time you enter an @code{nnweb} group (not even changing the search
10246 pattern), you are likely to get the articles ordered in a different
10247 manner. Not even using duplicate suppression (@code{Duplicate
10248 Suppression}) will help, since @code{nnweb} doesn't even know the
10249 @code{Message-ID} of the articles before reading them using some search
10250 engines (DejaNews, for instance). The only possible way to keep track
10251 of which articles you've read is by scoring on the @code{Date}
10252 header---mark all articles that were posted before the last date you
10253 read the group as read.
10255 If the search engine changes its output substantially, @code{nnweb}
10256 won't be able to parse it and will fail. One could hardly fault the Web
10257 providers if they were to do this---their @emph{raison d'être} is to
10258 make money off of advertisements, not to provide services to the
10259 community. Since @code{nnweb} washes the ads off all the articles, one
10260 might think that the providers might be somewhat miffed. We'll see.
10262 You must have the @code{url} and @code{w3} package installed to be able
10263 to use @code{nnweb}.
10265 Virtual server variables:
10270 What search engine type is being used. The currently supported types
10271 are @code{dejanews}, @code{altavista} and @code{reference}.
10274 @vindex nnweb-search
10275 The search string to feed to the search engine.
10277 @item nnweb-max-hits
10278 @vindex nnweb-max-hits
10279 Advisory maximum number of hits per search to display. The default is
10282 @item nnweb-type-definition
10283 @vindex nnweb-type-definition
10284 Type-to-definition alist. This alist says what @code{nnweb} should do
10285 with the various search engine types. The following elements must be
10290 Function to decode the article and provide something that Gnus
10294 Function to create an article number to message header and URL alist.
10297 Function to send the search string to the search engine.
10300 The address the aforementioned function should send the search string
10304 Format string URL to fetch an article by @code{Message-ID}.
10311 @node Mail-To-News Gateways
10312 @subsection Mail-To-News Gateways
10313 @cindex mail-to-news gateways
10316 If your local @code{nntp} server doesn't allow posting, for some reason
10317 or other, you can post using one of the numerous mail-to-news gateways.
10318 The @code{nngateway} backend provides the interface.
10320 Note that you can't read anything from this backend---it can only be
10326 @item nngateway-address
10327 @vindex nngateway-address
10328 This is the address of the mail-to-news gateway.
10330 @item nngateway-header-transformation
10331 @vindex nngateway-header-transformation
10332 News headers have often have to be transformed in some odd way or other
10333 for the mail-to-news gateway to accept it. This variable says what
10334 transformation should be called, and defaults to
10335 @code{nngateway-simple-header-transformation}. The function is called
10336 narrowed to the headers to be transformed and with one parameter---the
10339 This default function just inserts a new @code{To} header based on the
10340 @code{Newsgroups} header and the gateway address---an article with this
10341 @code{Newsgroups} header:
10344 Newsgroups: alt.religion.emacs
10347 will get this @code{From} header inserted:
10350 To: alt-religion-emacs@@GATEWAY
10355 So, to use this, simply say something like:
10358 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
10362 @node Combined Groups
10363 @section Combined Groups
10365 Gnus allows combining a mixture of all the other group types into bigger
10369 * Virtual Groups:: Combining articles from many groups.
10370 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
10374 @node Virtual Groups
10375 @subsection Virtual Groups
10377 @cindex virtual groups
10379 An @dfn{nnvirtual group} is really nothing more than a collection of
10382 For instance, if you are tired of reading many small group, you can
10383 put them all in one big group, and then grow tired of reading one
10384 big, unwieldy group. The joys of computing!
10386 You specify @code{nnvirtual} as the method. The address should be a
10387 regexp to match component groups.
10389 All marks in the virtual group will stick to the articles in the
10390 component groups. So if you tick an article in a virtual group, the
10391 article will also be ticked in the component group from whence it came.
10392 (And vice versa---marks from the component groups will also be shown in
10393 the virtual group.)
10395 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
10396 newsgroups into one, big, happy newsgroup:
10399 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
10402 The component groups can be native or foreign; everything should work
10403 smoothly, but if your computer explodes, it was probably my fault.
10405 Collecting the same group from several servers might actually be a good
10406 idea if users have set the Distribution header to limit distribution.
10407 If you would like to read @samp{soc.motss} both from a server in Japan
10408 and a server in Norway, you could use the following as the group regexp:
10411 "^nntp+some.server.jp:soc.motss$\\|^nntp+some.server.no:soc.motss$"
10414 This should work kinda smoothly---all articles from both groups should
10415 end up in this one, and there should be no duplicates. Threading (and
10416 the rest) will still work as usual, but there might be problems with the
10417 sequence of articles. Sorting on date might be an option here
10418 (@pxref{Selecting a Group}.
10420 One limitation, however---all groups that are included in a virtual
10421 group has to be alive (i.e., subscribed or unsubscribed). Killed or
10422 zombie groups can't be component groups for @code{nnvirtual} groups.
10424 @vindex nnvirtual-always-rescan
10425 If the @code{nnvirtual-always-rescan} is non-@code{nil},
10426 @code{nnvirtual} will always scan groups for unread articles when
10427 entering a virtual group. If this variable is @code{nil} (which is the
10428 default) and you read articles in a component group after the virtual
10429 group has been activated, the read articles from the component group
10430 will show up when you enter the virtual group. You'll also see this
10431 effect if you have two virtual groups that contain the same component
10432 group. If that's the case, you should set this variable to @code{t}.
10433 Or you can just tap @code{M-g} on the virtual group every time before
10434 you enter it---it'll have much the same effect.
10437 @node Kibozed Groups
10438 @subsection Kibozed Groups
10442 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
10443 the news feed''. @code{nnkiboze} is a backend that will do this for
10444 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
10445 with useless requests! Oh happiness!
10447 @kindex G k (Group)
10448 To create a kibozed group, use the @kbd{G k} command in the group
10451 The address field of the @code{nnkiboze} method is, as with
10452 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
10453 @code{nnkiboze} group. There most similarities between @code{nnkiboze}
10454 and @code{nnvirtual} ends.
10456 In addition to this regexp detailing component groups, an @code{nnkiboze} group
10457 must have a score file to say what articles that are to be included in
10458 the group (@pxref{Scoring}).
10460 @kindex M-x nnkiboze-generate-groups
10461 @findex nnkiboze-generate-groups
10462 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
10463 @code{nnkiboze} groups you want to have. This command will take time. Lots of
10464 time. Oodles and oodles of time. Gnus has to fetch the headers from
10465 all the articles in all the components groups and run them through the
10466 scoring process to determine if there are any articles in the groups
10467 that are to be part of the @code{nnkiboze} groups.
10469 Please limit the number of component groups by using restrictive
10470 regexps. Otherwise your sysadmin may become annoyed with you, and the
10471 @sc{nntp} site may throw you off and never let you back in again.
10472 Stranger things have happened.
10474 @code{nnkiboze} component groups do not have to be alive---they can be dead,
10475 and they can be foreign. No restrictions.
10477 @vindex nnkiboze-directory
10478 The generation of an @code{nnkiboze} group means writing two files in
10479 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
10480 contains the @sc{nov} header lines for all the articles in the group,
10481 and the other is an additional @file{.newsrc} file to store information
10482 on what groups that have been searched through to find component
10485 Articles that are marked as read in the @code{nnkiboze} group will have their
10486 @sc{nov} lines removed from the @sc{nov} file.
10493 Other people use @dfn{kill files}, but we here at Gnus Towers like
10494 scoring better than killing, so we'd rather switch than fight. They do
10495 something completely different as well, so sit up straight and pay
10498 @vindex gnus-summary-mark-below
10499 All articles have a default score (@code{gnus-summary-default-score}),
10500 which is 0 by default. This score may be raised or lowered either
10501 interactively or by score files. Articles that have a score lower than
10502 @code{gnus-summary-mark-below} are marked as read.
10504 Gnus will read any @dfn{score files} that apply to the current group
10505 before generating the summary buffer.
10507 There are several commands in the summary buffer that insert score
10508 entries based on the current article. You can, for instance, ask Gnus to
10509 lower or increase the score of all articles with a certain subject.
10511 There are two sorts of scoring entries: Permanent and temporary.
10512 Temporary score entries are self-expiring entries. Any entries that are
10513 temporary and have not been used for, say, a week, will be removed
10514 silently to help keep the sizes of the score files down.
10517 * Summary Score Commands:: Adding score entries for the current group.
10518 * Group Score Commands:: General score commands.
10519 * Score Variables:: Customize your scoring. (My, what terminology).
10520 * Score File Format:: What a score file may contain.
10521 * Score File Editing:: You can edit score files by hand as well.
10522 * Adaptive Scoring:: Big Sister Gnus knows what you read.
10523 * Home Score File:: How to say where new score entries are to go.
10524 * Followups To Yourself:: Having Gnus notice when people answer you.
10525 * Scoring Tips:: How to score effectively.
10526 * Reverse Scoring:: That problem child of old is not problem.
10527 * Global Score Files:: Earth-spanning, ear-splitting score files.
10528 * Kill Files:: They are still here, but they can be ignored.
10529 * Converting Kill Files:: Translating kill files to score files.
10530 * GroupLens:: Getting predictions on what you like to read.
10531 * Advanced Scoring:: Using logical expressions to build score rules.
10532 * Score Decays:: It can be useful to let scores wither away.
10536 @node Summary Score Commands
10537 @section Summary Score Commands
10538 @cindex score commands
10540 The score commands that alter score entries do not actually modify real
10541 score files. That would be too inefficient. Gnus maintains a cache of
10542 previously loaded score files, one of which is considered the
10543 @dfn{current score file alist}. The score commands simply insert
10544 entries into this list, and upon group exit, this list is saved.
10546 The current score file is by default the group's local score file, even
10547 if no such score file actually exists. To insert score commands into
10548 some other score file (e.g. @file{all.SCORE}), you must first make this
10549 score file the current one.
10551 General score commands that don't actually change the score file:
10556 @kindex V s (Summary)
10557 @findex gnus-summary-set-score
10558 Set the score of the current article (@code{gnus-summary-set-score}).
10561 @kindex V S (Summary)
10562 @findex gnus-summary-current-score
10563 Display the score of the current article
10564 (@code{gnus-summary-current-score}).
10567 @kindex V t (Summary)
10568 @findex gnus-score-find-trace
10569 Display all score rules that have been used on the current article
10570 (@code{gnus-score-find-trace}).
10573 @kindex V R (Summary)
10574 @findex gnus-summary-rescore
10575 Run the current summary through the scoring process
10576 (@code{gnus-summary-rescore}). This might be useful if you're playing
10577 around with your score files behind Gnus' back and want to see the
10578 effect you're having.
10581 @kindex V a (Summary)
10582 @findex gnus-summary-score-entry
10583 Add a new score entry, and allow specifying all elements
10584 (@code{gnus-summary-score-entry}).
10587 @kindex V c (Summary)
10588 @findex gnus-score-change-score-file
10589 Make a different score file the current
10590 (@code{gnus-score-change-score-file}).
10593 @kindex V e (Summary)
10594 @findex gnus-score-edit-current-scores
10595 Edit the current score file (@code{gnus-score-edit-current-scores}).
10596 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
10600 @kindex V f (Summary)
10601 @findex gnus-score-edit-file
10602 Edit a score file and make this score file the current one
10603 (@code{gnus-score-edit-file}).
10606 @kindex V F (Summary)
10607 @findex gnus-score-flush-cache
10608 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
10609 after editing score files.
10612 @kindex V C (Summary)
10613 @findex gnus-score-customize
10614 Customize a score file in a visually pleasing manner
10615 (@code{gnus-score-customize}).
10618 @kindex I C-i (Summary)
10619 @findex gnus-summary-raise-score
10620 Increase the score of the current article
10621 (@code{gnus-summary-raise-score}).
10624 @kindex L C-l (Summary)
10625 @findex gnus-summary-lower-score
10626 Lower the score of the current article
10627 (@code{gnus-summary-lower-score}).
10630 The rest of these commands modify the local score file.
10635 @kindex V m (Summary)
10636 @findex gnus-score-set-mark-below
10637 Prompt for a score, and mark all articles with a score below this as
10638 read (@code{gnus-score-set-mark-below}).
10641 @kindex V x (Summary)
10642 @findex gnus-score-set-expunge-below
10643 Prompt for a score, and add a score rule to the current score file to
10644 expunge all articles below this score
10645 (@code{gnus-score-set-expunge-below}).
10648 The keystrokes for actually making score entries follow a very regular
10649 pattern, so there's no need to list all the commands. (Hundreds of
10654 The first key is either @kbd{I} (upper case i) for increasing the score
10655 or @kbd{L} for lowering the score.
10657 The second key says what header you want to score on. The following
10658 keys are available:
10662 Score on the author name.
10665 Score on the subject line.
10668 Score on the Xref line---i.e., the cross-posting line.
10671 Score on thread---the References line.
10677 Score on the number of lines.
10680 Score on the Message-ID.
10683 Score on followups.
10693 The third key is the match type. Which match types are legal depends on
10694 what headers you are scoring on.
10706 Substring matching.
10709 Fuzzy matching (@pxref{Fuzzy Matching}).
10738 Greater than number.
10743 The fourth and final key says whether this is a temporary (i.e., expiring)
10744 score entry, or a permanent (i.e., non-expiring) score entry, or whether
10745 it is to be done immediately, without adding to the score file.
10749 Temporary score entry.
10752 Permanent score entry.
10755 Immediately scoring.
10760 So, let's say you want to increase the score on the current author with
10761 exact matching permanently: @kbd{I a e p}. If you want to lower the
10762 score based on the subject line, using substring matching, and make a
10763 temporary score entry: @kbd{L s s t}. Pretty easy.
10765 To make things a bit more complicated, there are shortcuts. If you use
10766 a capital letter on either the second or third keys, Gnus will use
10767 defaults for the remaining one or two keystrokes. The defaults are
10768 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
10769 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
10771 @vindex gnus-score-mimic-keymap
10772 The @code{gnus-score-mimic-keymap} says whether these commands will
10773 pretend they are keymaps or not.
10776 @node Group Score Commands
10777 @section Group Score Commands
10778 @cindex group score commands
10780 There aren't many of these as yet, I'm afraid.
10785 @kindex W f (Group)
10786 @findex gnus-score-flush-cache
10787 Gnus maintains a cache of score alists to avoid having to reload them
10788 all the time. This command will flush the cache
10789 (@code{gnus-score-flush-cache}).
10794 @node Score Variables
10795 @section Score Variables
10796 @cindex score variables
10800 @item gnus-use-scoring
10801 @vindex gnus-use-scoring
10802 If @code{nil}, Gnus will not check for score files, and will not, in
10803 general, do any score-related work. This is @code{t} by default.
10805 @item gnus-kill-killed
10806 @vindex gnus-kill-killed
10807 If this variable is @code{nil}, Gnus will never apply score files to
10808 articles that have already been through the kill process. While this
10809 may save you lots of time, it also means that if you apply a kill file
10810 to a group, and then change the kill file and want to run it over you
10811 group again to kill more articles, it won't work. You have to set this
10812 variable to @code{t} to do that. (It is @code{t} by default.)
10814 @item gnus-kill-files-directory
10815 @vindex gnus-kill-files-directory
10816 All kill and score files will be stored in this directory, which is
10817 initialized from the @code{SAVEDIR} environment variable by default.
10818 This is @file{~/News/} by default.
10820 @item gnus-score-file-suffix
10821 @vindex gnus-score-file-suffix
10822 Suffix to add to the group name to arrive at the score file name
10823 (@samp{SCORE} by default.)
10825 @item gnus-score-uncacheable-files
10826 @vindex gnus-score-uncacheable-files
10827 @cindex score cache
10828 All score files are normally cached to avoid excessive re-loading of
10829 score files. However, if this might make you Emacs grow big and
10830 bloated, so this regexp can be used to weed out score files that are
10831 unlikely to be needed again. It would be a bad idea to deny caching of
10832 @file{all.SCORE}, while it might be a good idea to not cache
10833 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
10834 variable is @samp{ADAPT$} by default, so no adaptive score files will
10837 @item gnus-save-score
10838 @vindex gnus-save-score
10839 If you have really complicated score files, and do lots of batch
10840 scoring, then you might set this variable to @code{t}. This will make
10841 Gnus save the scores into the @file{.newsrc.eld} file.
10843 @item gnus-score-interactive-default-score
10844 @vindex gnus-score-interactive-default-score
10845 Score used by all the interactive raise/lower commands to raise/lower
10846 score with. Default is 1000, which may seem excessive, but this is to
10847 ensure that the adaptive scoring scheme gets enough room to play with.
10848 We don't want the small changes from the adaptive scoring to overwrite
10849 manually entered data.
10851 @item gnus-summary-default-score
10852 @vindex gnus-summary-default-score
10853 Default score of an article, which is 0 by default.
10855 @item gnus-summary-expunge-below
10856 @vindex gnus-summary-expunge-below
10857 Don't display the summary lines of articles that have scores lower than
10858 this variable. This is @code{nil} by default, which means that no
10859 articles will be hidden.
10861 @item gnus-score-over-mark
10862 @vindex gnus-score-over-mark
10863 Mark (in the third column) used for articles with a score over the
10864 default. Default is @samp{+}.
10866 @item gnus-score-below-mark
10867 @vindex gnus-score-below-mark
10868 Mark (in the third column) used for articles with a score below the
10869 default. Default is @samp{-}.
10871 @item gnus-score-find-score-files-function
10872 @vindex gnus-score-find-score-files-function
10873 Function used to find score files for the current group. This function
10874 is called with the name of the group as the argument.
10876 Predefined functions available are:
10879 @item gnus-score-find-single
10880 @findex gnus-score-find-single
10881 Only apply the group's own score file.
10883 @item gnus-score-find-bnews
10884 @findex gnus-score-find-bnews
10885 Apply all score files that match, using bnews syntax. This is the
10886 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
10887 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
10888 @file{gnu.all.SCORE} would all apply. In short, the instances of
10889 @samp{all} in the score file names are translated into @samp{.*}, and
10890 then a regexp match is done.
10892 This means that if you have some score entries that you want to apply to
10893 all groups, then you put those entries in the @file{all.SCORE} file.
10895 The score files are applied in a semi-random order, although Gnus will
10896 try to apply the more general score files before the more specific score
10897 files. It does this by looking at the number of elements in the score
10898 file names---discarding the @samp{all} elements.
10900 @item gnus-score-find-hierarchical
10901 @findex gnus-score-find-hierarchical
10902 Apply all score files from all the parent groups. This means that you
10903 can't have score files like @file{all.SCORE}, but you can have
10904 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
10907 This variable can also be a list of functions. In that case, all these
10908 functions will be called, and all the returned lists of score files will
10909 be applied. These functions can also return lists of score alists
10910 directly. In that case, the functions that return these non-file score
10911 alists should probably be placed before the ``real'' score file
10912 functions, to ensure that the last score file returned is the local
10915 @item gnus-score-expiry-days
10916 @vindex gnus-score-expiry-days
10917 This variable says how many days should pass before an unused score file
10918 entry is expired. If this variable is @code{nil}, no score file entries
10919 are expired. It's 7 by default.
10921 @item gnus-update-score-entry-dates
10922 @vindex gnus-update-score-entry-dates
10923 If this variable is non-@code{nil}, matching score entries will have
10924 their dates updated. (This is how Gnus controls expiry---all
10925 non-matching entries will become too old while matching entries will
10926 stay fresh and young.) However, if you set this variable to @code{nil},
10927 even matching entries will grow old and will have to face that oh-so
10930 @item gnus-score-after-write-file-function
10931 @vindex gnus-score-after-write-file-function
10932 Function called with the name of the score file just written.
10937 @node Score File Format
10938 @section Score File Format
10939 @cindex score file format
10941 A score file is an @code{emacs-lisp} file that normally contains just a
10942 single form. Casual users are not expected to edit these files;
10943 everything can be changed from the summary buffer.
10945 Anyway, if you'd like to dig into it yourself, here's an example:
10949 ("Lars Ingebrigtsen" -10000)
10951 ("larsi\\|lmi" -50000 nil R))
10953 ("Ding is Badd" nil 728373))
10955 ("alt.politics" -1000 728372 s))
10960 (mark-and-expunge -10)
10964 (files "/hom/larsi/News/gnu.SCORE")
10965 (exclude-files "all.SCORE")
10966 (local (gnus-newsgroup-auto-expire t)
10967 (gnus-summary-make-false-root 'empty))
10971 This example demonstrates absolutely everything about a score file.
10973 Even though this looks much like lisp code, nothing here is actually
10974 @code{eval}ed. The lisp reader is used to read this form, though, so it
10975 has to be legal syntactically, if not semantically.
10977 Six keys are supported by this alist:
10982 If the key is a string, it is the name of the header to perform the
10983 match on. Scoring can only be performed on these eight headers:
10984 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
10985 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
10986 these headers, there are three strings to tell Gnus to fetch the entire
10987 article and do the match on larger parts of the article: @code{Body}
10988 will perform the match on the body of the article, @code{Head} will
10989 perform the match on the head of the article, and @code{All} will
10990 perform the match on the entire article. Note that using any of these
10991 last three keys will slow down group entry @emph{considerably}. The
10992 final ``header'' you can score on is @code{Followup}. These score
10993 entries will result in new score entries being added for all follow-ups
10994 to articles that matches these score entries.
10996 Following this key is a arbitrary number of score entries, where each
10997 score entry has one to four elements.
11001 The first element is the @dfn{match element}. On most headers this will
11002 be a string, but on the Lines and Chars headers, this must be an
11006 If the second element is present, it should be a number---the @dfn{score
11007 element}. This number should be an integer in the neginf to posinf
11008 interval. This number is added to the score of the article if the match
11009 is successful. If this element is not present, the
11010 @code{gnus-score-interactive-default-score} number will be used
11011 instead. This is 1000 by default.
11014 If the third element is present, it should be a number---the @dfn{date
11015 element}. This date says when the last time this score entry matched,
11016 which provides a mechanism for expiring the score entries. It this
11017 element is not present, the score entry is permanent. The date is
11018 represented by the number of days since December 31, 1 BCE.
11021 If the fourth element is present, it should be a symbol---the @dfn{type
11022 element}. This element specifies what function should be used to see
11023 whether this score entry matches the article. What match types that can
11024 be used depends on what header you wish to perform the match on.
11027 @item From, Subject, References, Xref, Message-ID
11028 For most header types, there are the @code{r} and @code{R} (regexp), as
11029 well as @code{s} and @code{S} (substring) types, and @code{e} and
11030 @code{E} (exact match), and @code{w} (word match) types. If this
11031 element is not present, Gnus will assume that substring matching should
11032 be used. @code{R}, @code{S}, and @code{E} differ from the others in
11033 that the matches will be done in a case-sensitive manner. All these
11034 one-letter types are really just abbreviations for the @code{regexp},
11035 @code{string}, @code{exact}, and @code{word} types, which you can use
11036 instead, if you feel like.
11039 These two headers use different match types: @code{<}, @code{>},
11040 @code{=}, @code{>=} and @code{<=}. When matching on @code{Lines}, be
11041 careful because some backends (like @code{nndir}) do not generate
11042 @code{Lines} header, so every article ends up being marked as having 0
11043 lines. This can lead to strange results if you happen to lower score of
11044 the articles with few lines.
11047 For the Date header we have three kinda silly match types:
11048 @code{before}, @code{at} and @code{after}. I can't really imagine this
11049 ever being useful, but, like, it would feel kinda silly not to provide
11050 this function. Just in case. You never know. Better safe than sorry.
11051 Once burnt, twice shy. Don't judge a book by its cover. Never not have
11052 sex on a first date. (I have been told that at least one person, and I
11053 quote, ``found this function indispensable'', however.)
11057 A more useful match type is @code{regexp}. With it, you can match the
11058 date string using a regular expression. The date is normalized to
11059 ISO8601 compact format first---@samp{YYYYMMDDTHHMMSS}. If you want to
11060 match all articles that have been posted on April 1st in every year, you
11061 could use @samp{....0401.........} as a match string, for instance.
11062 (Note that the date is kept in its original time zone, so this will
11063 match articles that were posted when it was April 1st where the article
11064 was posted from. Time zones are such wholesome fun for the whole
11067 @item Head, Body, All
11068 These three match keys use the same match types as the @code{From} (etc)
11072 This match key is somewhat special, in that it will match the
11073 @code{From} header, and affect the score of not only the matching
11074 articles, but also all followups to the matching articles. This allows
11075 you e.g. increase the score of followups to your own articles, or
11076 decrease the score of followups to the articles of some known
11077 trouble-maker. Uses the same match types as the @code{From} header
11081 This match key works along the same lines as the @code{Followup} match
11082 key. If you say that you want to score on a (sub-)thread that is
11083 started by an article with a @code{Message-ID} @var{X}, then you add a
11084 @samp{thread} match. This will add a new @samp{thread} match for each
11085 article that has @var{X} in its @code{References} header. (These new
11086 @samp{thread} matches will use the @code{Message-ID}s of these matching
11087 articles.) This will ensure that you can raise/lower the score of an
11088 entire thread, even though some articles in the thread may not have
11089 complete @code{References} headers. Note that using this may lead to
11090 undeterministic scores of the articles in the thread.
11095 The value of this entry should be a number. Any articles with a score
11096 lower than this number will be marked as read.
11099 The value of this entry should be a number. Any articles with a score
11100 lower than this number will be removed from the summary buffer.
11102 @item mark-and-expunge
11103 The value of this entry should be a number. Any articles with a score
11104 lower than this number will be marked as read and removed from the
11107 @item thread-mark-and-expunge
11108 The value of this entry should be a number. All articles that belong to
11109 a thread that has a total score below this number will be marked as read
11110 and removed from the summary buffer. @code{gnus-thread-score-function}
11111 says how to compute the total score for a thread.
11114 The value of this entry should be any number of file names. These files
11115 are assumed to be score files as well, and will be loaded the same way
11118 @item exclude-files
11119 The clue of this entry should be any number of files. These files will
11120 not be loaded, even though they would normally be so, for some reason or
11124 The value of this entry will be @code{eval}el. This element will be
11125 ignored when handling global score files.
11128 Read-only score files will not be updated or saved. Global score files
11129 should feature this atom (@pxref{Global Score Files}).
11132 The value of this entry should be a number. Articles that do not have
11133 parents will get this number added to their scores. Imagine you follow
11134 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
11135 will only follow a few of the threads, also want to see any new threads.
11137 You can do this with the following two score file entries:
11141 (mark-and-expunge -100)
11144 When you enter the group the first time, you will only see the new
11145 threads. You then raise the score of the threads that you find
11146 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
11147 rest. Next time you enter the group, you will see new articles in the
11148 interesting threads, plus any new threads.
11150 I.e.---the orphan score atom is for high-volume groups where there
11151 exist a few interesting threads which can't be found automatically by
11152 ordinary scoring rules.
11155 This entry controls the adaptive scoring. If it is @code{t}, the
11156 default adaptive scoring rules will be used. If it is @code{ignore}, no
11157 adaptive scoring will be performed on this group. If it is a list, this
11158 list will be used as the adaptive scoring rules. If it isn't present,
11159 or is something other than @code{t} or @code{ignore}, the default
11160 adaptive scoring rules will be used. If you want to use adaptive
11161 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
11162 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
11163 not want adaptive scoring. If you only want adaptive scoring in a few
11164 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
11165 insert @code{(adapt t)} in the score files of the groups where you want
11169 All adaptive score entries will go to the file named by this entry. It
11170 will also be applied when entering the group. This atom might be handy
11171 if you want to adapt on several groups at once, using the same adaptive
11172 file for a number of groups.
11175 @cindex local variables
11176 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
11177 Each @var{var} will be made buffer-local to the current summary buffer,
11178 and set to the value specified. This is a convenient, if somewhat
11179 strange, way of setting variables in some groups if you don't like hooks
11184 @node Score File Editing
11185 @section Score File Editing
11187 You normally enter all scoring commands from the summary buffer, but you
11188 might feel the urge to edit them by hand as well, so we've supplied you
11189 with a mode for that.
11191 It's simply a slightly customized @code{emacs-lisp} mode, with these
11192 additional commands:
11197 @kindex C-c C-c (Score)
11198 @findex gnus-score-edit-done
11199 Save the changes you have made and return to the summary buffer
11200 (@code{gnus-score-edit-done}).
11203 @kindex C-c C-d (Score)
11204 @findex gnus-score-edit-insert-date
11205 Insert the current date in numerical format
11206 (@code{gnus-score-edit-insert-date}). This is really the day number, if
11207 you were wondering.
11210 @kindex C-c C-p (Score)
11211 @findex gnus-score-pretty-print
11212 The adaptive score files are saved in an unformatted fashion. If you
11213 intend to read one of these files, you want to @dfn{pretty print} it
11214 first. This command (@code{gnus-score-pretty-print}) does that for
11219 Type @kbd{M-x gnus-score-mode} to use this mode.
11221 @vindex gnus-score-mode-hook
11222 @code{gnus-score-menu-hook} is run in score mode buffers.
11224 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
11225 e} to begin editing score files.
11228 @node Adaptive Scoring
11229 @section Adaptive Scoring
11230 @cindex adaptive scoring
11232 If all this scoring is getting you down, Gnus has a way of making it all
11233 happen automatically---as if by magic. Or rather, as if by artificial
11234 stupidity, to be precise.
11236 @vindex gnus-use-adaptive-scoring
11237 When you read an article, or mark an article as read, or kill an
11238 article, you leave marks behind. On exit from the group, Gnus can sniff
11239 these marks and add score elements depending on what marks it finds.
11240 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
11241 @code{t} or @code{(line)}. If you want score adaptively on separate
11242 words appearing in the subjects, you should set this variable to
11243 @code{(word)}. If you want to use both adaptive methods, set this
11244 variable to @code{(word line)}.
11246 @vindex gnus-default-adaptive-score-alist
11247 To give you complete control over the scoring process, you can customize
11248 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
11249 might look something like this:
11252 (defvar gnus-default-adaptive-score-alist
11253 '((gnus-unread-mark)
11254 (gnus-ticked-mark (from 4))
11255 (gnus-dormant-mark (from 5))
11256 (gnus-del-mark (from -4) (subject -1))
11257 (gnus-read-mark (from 4) (subject 2))
11258 (gnus-expirable-mark (from -1) (subject -1))
11259 (gnus-killed-mark (from -1) (subject -3))
11260 (gnus-kill-file-mark)
11261 (gnus-ancient-mark)
11262 (gnus-low-score-mark)
11263 (gnus-catchup-mark (from -1) (subject -1))))
11266 As you see, each element in this alist has a mark as a key (either a
11267 variable name or a ``real'' mark---a character). Following this key is
11268 a arbitrary number of header/score pairs. If there are no header/score
11269 pairs following the key, no adaptive scoring will be done on articles
11270 that have that key as the article mark. For instance, articles with
11271 @code{gnus-unread-mark} in the example above will not get adaptive score
11274 Each article can have only one mark, so just a single of these rules
11275 will be applied to each article.
11277 To take @code{gnus-del-mark} as an example---this alist says that all
11278 articles that have that mark (i.e., are marked with @samp{D}) will have a
11279 score entry added to lower based on the @code{From} header by -4, and
11280 lowered by @code{Subject} by -1. Change this to fit your prejudices.
11282 If you have marked 10 articles with the same subject with
11283 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
11284 That means that that subject will get a score of ten times -1, which
11285 should be, unless I'm much mistaken, -10.
11287 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
11288 the read articles will be marked with the @samp{E} mark. This'll
11289 probably make adaptive scoring slightly impossible, so auto-expiring and
11290 adaptive scoring doesn't really mix very well.
11292 The headers you can score on are @code{from}, @code{subject},
11293 @code{message-id}, @code{references}, @code{xref}, @code{lines},
11294 @code{chars} and @code{date}. In addition, you can score on
11295 @code{followup}, which will create an adaptive score entry that matches
11296 on the @code{References} header using the @code{Message-ID} of the
11297 current article, thereby matching the following thread.
11299 You can also score on @code{thread}, which will try to score all
11300 articles that appear in a thread. @code{thread} matches uses a
11301 @code{Message-ID} to match on the @code{References} header of the
11302 article. If the match is made, the @code{Message-ID} of the article is
11303 added to the @code{thread} rule. (Think about it. I'd recommend two
11304 aspirins afterwards.)
11306 If you use this scheme, you should set the score file atom @code{mark}
11307 to something small---like -300, perhaps, to avoid having small random
11308 changes result in articles getting marked as read.
11310 After using adaptive scoring for a week or so, Gnus should start to
11311 become properly trained and enhance the authors you like best, and kill
11312 the authors you like least, without you having to say so explicitly.
11314 You can control what groups the adaptive scoring is to be performed on
11315 by using the score files (@pxref{Score File Format}). This will also
11316 let you use different rules in different groups.
11318 @vindex gnus-adaptive-file-suffix
11319 The adaptive score entries will be put into a file where the name is the
11320 group name with @code{gnus-adaptive-file-suffix} appended. The default
11323 @vindex gnus-score-exact-adapt-limit
11324 When doing adaptive scoring, substring or fuzzy matching would probably
11325 give you the best results in most cases. However, if the header one
11326 matches is short, the possibility for false positives is great, so if
11327 the length of the match is less than
11328 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
11329 this variable is @code{nil}, exact matching will always be used to avoid
11332 @vindex gnus-default-adaptive-word-score-alist
11333 As mentioned above, you can adapt either on individual words or entire
11334 headers. If you adapt on words, the
11335 @code{gnus-default-adaptive-word-score-alist} variable says what score
11336 each instance of a word should add given a mark.
11339 (setq gnus-default-adaptive-word-score-alist
11340 `((,gnus-read-mark . 30)
11341 (,gnus-catchup-mark . -10)
11342 (,gnus-killed-mark . -20)
11343 (,gnus-del-mark . -15)))
11346 This is the default value. If you have adaption on words enabled, every
11347 word that appears in subjects of articles that are marked with
11348 @code{gnus-read-mark} will result in a score rule that increase the
11349 score with 30 points.
11351 @vindex gnus-default-ignored-adaptive-words
11352 @vindex gnus-ignored-adaptive-words
11353 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
11354 will be ignored. If you wish to add more words to be ignored, use the
11355 @code{gnus-ignored-adaptive-words} list instead.
11357 @vindex gnus-adaptive-word-syntax-table
11358 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
11359 syntax table in effect. It is similar to the standard syntax table, but
11360 it considers numbers to be non-word-constituent characters.
11362 After using this scheme for a while, it might be nice to write a
11363 @code{gnus-psychoanalyze-user} command to go through the rules and see
11364 what words you like and what words you don't like. Or perhaps not.
11366 Note that the adaptive word scoring thing is highly experimental and is
11367 likely to change in the future. Initial impressions seem to indicate
11368 that it's totally useless as it stands. Some more work (involving more
11369 rigorous statistical methods) will have to be done to make this useful.
11372 @node Home Score File
11373 @section Home Score File
11375 The score file where new score file entries will go is called the
11376 @dfn{home score file}. This is normally (and by default) the score file
11377 for the group itself. For instance, the home score file for
11378 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
11380 However, this may not be what you want. It is often convenient to share
11381 a common home score file among many groups---all @samp{emacs} groups
11382 could perhaps use the same home score file.
11384 @vindex gnus-home-score-file
11385 The variable that controls this is @code{gnus-home-score-file}. It can
11390 A string. Then this file will be used as the home score file for all
11394 A function. The result of this function will be used as the home score
11395 file. The function will be called with the name of the group as the
11399 A list. The elements in this list can be:
11403 @var{(regexp file-name)}. If the @var{regexp} matches the group name,
11404 the @var{file-name} will will be used as the home score file.
11407 A function. If the function returns non-nil, the result will be used as
11408 the home score file.
11411 A string. Use the string as the home score file.
11414 The list will be traversed from the beginning towards the end looking
11419 So, if you want to use just a single score file, you could say:
11422 (setq gnus-home-score-file
11423 "my-total-score-file.SCORE")
11426 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
11427 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
11430 (setq gnus-home-score-file
11431 'gnus-hierarchial-home-score-file)
11434 This is a ready-made function provided for your convenience.
11436 If you want to have one score file for the @samp{emacs} groups and
11437 another for the @samp{comp} groups, while letting all other groups use
11438 their own home score files:
11441 (setq gnus-home-score-file
11442 ;; All groups that match the regexp "\\.emacs"
11443 '("\\.emacs" "emacs.SCORE")
11444 ;; All the comp groups in one score file
11445 ("^comp" "comp.SCORE"))
11448 @vindex gnus-home-adapt-file
11449 @code{gnus-home-adapt-file} works exactly the same way as
11450 @code{gnus-home-score-file}, but says what the home adaptive score file
11451 is instead. All new adaptive file entries will go into the file
11452 specified by this variable, and the same syntax is allowed.
11454 In addition to using @code{gnus-home-score-file} and
11455 @code{gnus-home-adapt-file}, you can also use group parameters
11456 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
11457 Parameters}) to achieve much the same. Group and topic parameters take
11458 precedence over this variable.
11461 @node Followups To Yourself
11462 @section Followups To Yourself
11464 Gnus offers two commands for picking out the @code{Message-ID} header in
11465 the current buffer. Gnus will then add a score rule that scores using
11466 this @code{Message-ID} on the @code{References} header of other
11467 articles. This will, in effect, increase the score of all articles that
11468 respond to the article in the current buffer. Quite useful if you want
11469 to easily note when people answer what you've said.
11473 @item gnus-score-followup-article
11474 @findex gnus-score-followup-article
11475 This will add a score to articles that directly follow up your own
11478 @item gnus-score-followup-thread
11479 @findex gnus-score-followup-thread
11480 This will add a score to all articles that appear in a thread ``below''
11484 @vindex message-sent-hook
11485 These two functions are both primarily meant to be used in hooks like
11486 @code{message-sent-hook}.
11488 If you look closely at your own @code{Message-ID}, you'll notice that
11489 the first two or three characters are always the same. Here's two of
11493 <x6u3u47icf.fsf@@eyesore.no>
11494 <x6sp9o7ibw.fsf@@eyesore.no>
11497 So ``my'' ident on this machine is @samp{x6}. This can be
11498 exploited---the following rule will raise the score on all followups to
11503 ("<x6[0-9a-z]+\\.fsf@@.*eyesore.no>" 1000 nil r))
11506 Whether it's the first two or first three characters that are ``yours''
11507 is system-dependent.
11511 @section Scoring Tips
11512 @cindex scoring tips
11518 @cindex scoring crossposts
11519 If you want to lower the score of crossposts, the line to match on is
11520 the @code{Xref} header.
11522 ("xref" (" talk.politics.misc:" -1000))
11525 @item Multiple crossposts
11526 If you want to lower the score of articles that have been crossposted to
11527 more than, say, 3 groups:
11529 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
11532 @item Matching on the body
11533 This is generally not a very good idea---it takes a very long time.
11534 Gnus actually has to fetch each individual article from the server. But
11535 you might want to anyway, I guess. Even though there are three match
11536 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
11537 and stick with it in each score file. If you use any two, each article
11538 will be fetched @emph{twice}. If you want to match a bit on the
11539 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
11542 @item Marking as read
11543 You will probably want to mark articles that has a score below a certain
11544 number as read. This is most easily achieved by putting the following
11545 in your @file{all.SCORE} file:
11549 You may also consider doing something similar with @code{expunge}.
11551 @item Negated character classes
11552 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
11553 That will match newlines, which might lead to, well, The Unknown. Say
11554 @code{[^abcd\n]*} instead.
11558 @node Reverse Scoring
11559 @section Reverse Scoring
11560 @cindex reverse scoring
11562 If you want to keep just articles that have @samp{Sex with Emacs} in the
11563 subject header, and expunge all other articles, you could put something
11564 like this in your score file:
11568 ("Sex with Emacs" 2))
11573 So, you raise all articles that match @samp{Sex with Emacs} and mark the
11574 rest as read, and expunge them to boot.
11577 @node Global Score Files
11578 @section Global Score Files
11579 @cindex global score files
11581 Sure, other newsreaders have ``global kill files''. These are usually
11582 nothing more than a single kill file that applies to all groups, stored
11583 in the user's home directory. Bah! Puny, weak newsreaders!
11585 What I'm talking about here are Global Score Files. Score files from
11586 all over the world, from users everywhere, uniting all nations in one
11587 big, happy score file union! Ange-score! New and untested!
11589 @vindex gnus-global-score-files
11590 All you have to do to use other people's score files is to set the
11591 @code{gnus-global-score-files} variable. One entry for each score file,
11592 or each score file directory. Gnus will decide by itself what score
11593 files are applicable to which group.
11595 Say you want to use the score file
11596 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
11597 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
11600 (setq gnus-global-score-files
11601 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
11602 "/ftp@@ftp.some-where:/pub/score/"))
11605 @findex gnus-score-search-global-directories
11606 Simple, eh? Directory names must end with a @samp{/}. These
11607 directories are typically scanned only once during each Gnus session.
11608 If you feel the need to manually re-scan the remote directories, you can
11609 use the @code{gnus-score-search-global-directories} command.
11611 Note that, at present, using this option will slow down group entry
11612 somewhat. (That is---a lot.)
11614 If you want to start maintaining score files for other people to use,
11615 just put your score file up for anonymous ftp and announce it to the
11616 world. Become a retro-moderator! Participate in the retro-moderator
11617 wars sure to ensue, where retro-moderators battle it out for the
11618 sympathy of the people, luring them to use their score files on false
11619 premises! Yay! The net is saved!
11621 Here are some tips for the would-be retro-moderator, off the top of my
11627 Articles that are heavily crossposted are probably junk.
11629 To lower a single inappropriate article, lower by @code{Message-ID}.
11631 Particularly brilliant authors can be raised on a permanent basis.
11633 Authors that repeatedly post off-charter for the group can safely be
11634 lowered out of existence.
11636 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
11637 articles completely.
11640 Use expiring score entries to keep the size of the file down. You
11641 should probably have a long expiry period, though, as some sites keep
11642 old articles for a long time.
11645 ... I wonder whether other newsreaders will support global score files
11646 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
11647 Wave, xrn and 1stReader are bound to implement scoring. Should we start
11648 holding our breath yet?
11652 @section Kill Files
11655 Gnus still supports those pesky old kill files. In fact, the kill file
11656 entries can now be expiring, which is something I wrote before Daniel
11657 Quinlan thought of doing score files, so I've left the code in there.
11659 In short, kill processing is a lot slower (and I do mean @emph{a lot})
11660 than score processing, so it might be a good idea to rewrite your kill
11661 files into score files.
11663 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
11664 forms into this file, which means that you can use kill files as some
11665 sort of primitive hook function to be run on group entry, even though
11666 that isn't a very good idea.
11668 Normal kill files look like this:
11671 (gnus-kill "From" "Lars Ingebrigtsen")
11672 (gnus-kill "Subject" "ding")
11676 This will mark every article written by me as read, and remove them from
11677 the summary buffer. Very useful, you'll agree.
11679 Other programs use a totally different kill file syntax. If Gnus
11680 encounters what looks like a @code{rn} kill file, it will take a stab at
11683 Two summary functions for editing a GNUS kill file:
11688 @kindex M-k (Summary)
11689 @findex gnus-summary-edit-local-kill
11690 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
11693 @kindex M-K (Summary)
11694 @findex gnus-summary-edit-global-kill
11695 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
11698 Two group mode functions for editing the kill files:
11703 @kindex M-k (Group)
11704 @findex gnus-group-edit-local-kill
11705 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
11708 @kindex M-K (Group)
11709 @findex gnus-group-edit-global-kill
11710 Edit the general kill file (@code{gnus-group-edit-global-kill}).
11713 Kill file variables:
11716 @item gnus-kill-file-name
11717 @vindex gnus-kill-file-name
11718 A kill file for the group @samp{soc.motss} is normally called
11719 @file{soc.motss.KILL}. The suffix appended to the group name to get
11720 this file name is detailed by the @code{gnus-kill-file-name} variable.
11721 The ``global'' kill file (not in the score file sense of ``global'', of
11722 course) is called just @file{KILL}.
11724 @vindex gnus-kill-save-kill-file
11725 @item gnus-kill-save-kill-file
11726 If this variable is non-@code{nil}, Gnus will save the
11727 kill file after processing, which is necessary if you use expiring
11730 @item gnus-apply-kill-hook
11731 @vindex gnus-apply-kill-hook
11732 @findex gnus-apply-kill-file-unless-scored
11733 @findex gnus-apply-kill-file
11734 A hook called to apply kill files to a group. It is
11735 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
11736 kill file if you have a score file for the same group, you can set this
11737 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
11738 kill files to be processed, you should set this variable to @code{nil}.
11740 @item gnus-kill-file-mode-hook
11741 @vindex gnus-kill-file-mode-hook
11742 A hook called in kill-file mode buffers.
11747 @node Converting Kill Files
11748 @section Converting Kill Files
11750 @cindex converting kill files
11752 If you have loads of old kill files, you may want to convert them into
11753 score files. If they are ``regular'', you can use
11754 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
11757 The kill to score conversion package isn't included in Gnus by default.
11758 You can fetch it from
11759 @file{http://www.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
11761 If your old kill files are very complex---if they contain more
11762 non-@code{gnus-kill} forms than not, you'll have to convert them by
11763 hand. Or just let them be as they are. Gnus will still use them as
11771 GroupLens is a collaborative filtering system that helps you work
11772 together with other people to find the quality news articles out of the
11773 huge volume of news articles generated every day.
11775 To accomplish this the GroupLens system combines your opinions about
11776 articles you have already read with the opinions of others who have done
11777 likewise and gives you a personalized prediction for each unread news
11778 article. Think of GroupLens as a matchmaker. GroupLens watches how you
11779 rate articles, and finds other people that rate articles the same way.
11780 Once it has found for you some people you agree with it tells you, in
11781 the form of a prediction, what they thought of the article. You can use
11782 this prediction to help you decide whether or not you want to read the
11786 * Using GroupLens:: How to make Gnus use GroupLens.
11787 * Rating Articles:: Letting GroupLens know how you rate articles.
11788 * Displaying Predictions:: Displaying predictions given by GroupLens.
11789 * GroupLens Variables:: Customizing GroupLens.
11793 @node Using GroupLens
11794 @subsection Using GroupLens
11796 To use GroupLens you must register a pseudonym with your local Better
11798 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
11799 better bit in town is at the moment.
11801 Once you have registered you'll need to set a couple of variables.
11805 @item gnus-use-grouplens
11806 @vindex gnus-use-grouplens
11807 Setting this variable to a non-@code{nil} value will make Gnus hook into
11808 all the relevant GroupLens functions.
11810 @item grouplens-pseudonym
11811 @vindex grouplens-pseudonym
11812 This variable should be set to the pseudonym you got when registering
11813 with the Better Bit Bureau.
11815 @item grouplens-newsgroups
11816 @vindex grouplens-newsgroups
11817 A list of groups that you want to get GroupLens predictions for.
11821 Thats the minimum of what you need to get up and running with GroupLens.
11822 Once you've registered, GroupLens will start giving you scores for
11823 articles based on the average of what other people think. But, to get
11824 the real benefit of GroupLens you need to start rating articles
11825 yourself. Then the scores GroupLens gives you will be personalized for
11826 you, based on how the people you usually agree with have already rated.
11829 @node Rating Articles
11830 @subsection Rating Articles
11832 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
11833 Where 1 means something like this article is a waste of bandwidth and 5
11834 means that the article was really good. The basic question to ask
11835 yourself is, "on a scale from 1 to 5 would I like to see more articles
11838 There are four ways to enter a rating for an article in GroupLens.
11843 @kindex r (GroupLens)
11844 @findex bbb-summary-rate-article
11845 This function will prompt you for a rating on a scale of one to five.
11848 @kindex k (GroupLens)
11849 @findex grouplens-score-thread
11850 This function will prompt you for a rating, and rate all the articles in
11851 the thread. This is really useful for some of those long running giant
11852 threads in rec.humor.
11856 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
11857 the score of the article you're reading.
11862 @kindex n (GroupLens)
11863 @findex grouplens-next-unread-article
11864 Rate the article and go to the next unread article.
11867 @kindex , (GroupLens)
11868 @findex grouplens-best-unread-article
11869 Rate the article and go to the next unread article with the highest score.
11873 If you want to give the current article a score of 4 and then go to the
11874 next article, just type @kbd{4 n}.
11877 @node Displaying Predictions
11878 @subsection Displaying Predictions
11880 GroupLens makes a prediction for you about how much you will like a
11881 news article. The predictions from GroupLens are on a scale from 1 to
11882 5, where 1 is the worst and 5 is the best. You can use the predictions
11883 from GroupLens in one of three ways controlled by the variable
11884 @code{gnus-grouplens-override-scoring}.
11886 @vindex gnus-grouplens-override-scoring
11887 There are three ways to display predictions in grouplens. You may
11888 choose to have the GroupLens scores contribute to, or override the
11889 regular gnus scoring mechanism. override is the default; however, some
11890 people prefer to see the Gnus scores plus the grouplens scores. To get
11891 the separate scoring behavior you need to set
11892 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
11893 GroupLens predictions combined with the grouplens scores set it to
11894 @code{'override} and to combine the scores set
11895 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
11896 the combine option you will also want to set the values for
11897 @code{grouplens-prediction-offset} and
11898 @code{grouplens-score-scale-factor}.
11900 @vindex grouplens-prediction-display
11901 In either case, GroupLens gives you a few choices for how you would like
11902 to see your predictions displayed. The display of predictions is
11903 controlled by the @code{grouplens-prediction-display} variable.
11905 The following are legal values for that variable.
11908 @item prediction-spot
11909 The higher the prediction, the further to the right an @samp{*} is
11912 @item confidence-interval
11913 A numeric confidence interval.
11915 @item prediction-bar
11916 The higher the prediction, the longer the bar.
11918 @item confidence-bar
11919 Numerical confidence.
11921 @item confidence-spot
11922 The spot gets bigger with more confidence.
11924 @item prediction-num
11925 Plain-old numeric value.
11927 @item confidence-plus-minus
11928 Prediction +/i confidence.
11933 @node GroupLens Variables
11934 @subsection GroupLens Variables
11938 @item gnus-summary-grouplens-line-format
11939 The summary line format used in summary buffers that are GroupLens
11940 enhanced. It accepts the same specs as the normal summary line format
11941 (@pxref{Summary Buffer Lines}). The default is
11942 @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%) %s\n}.
11944 @item grouplens-bbb-host
11945 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
11948 @item grouplens-bbb-port
11949 Port of the host running the bbbd server. The default is 9000.
11951 @item grouplens-score-offset
11952 Offset the prediction by this value. In other words, subtract the
11953 prediction value by this number to arrive at the effective score. The
11956 @item grouplens-score-scale-factor
11957 This variable allows the user to magnify the effect of GroupLens scores.
11958 The scale factor is applied after the offset. The default is 1.
11963 @node Advanced Scoring
11964 @section Advanced Scoring
11966 Scoring on Subjects and From headers is nice enough, but what if you're
11967 really interested in what a person has to say only when she's talking
11968 about a particular subject? Or what about if you really don't want to
11969 read what person A has to say when she's following up to person B, but
11970 want to read what she says when she's following up to person C?
11972 By using advanced scoring rules you may create arbitrarily complex
11976 * Advanced Scoring Syntax:: A definition.
11977 * Advanced Scoring Examples:: What they look like.
11978 * Advanced Scoring Tips:: Getting the most out of it.
11982 @node Advanced Scoring Syntax
11983 @subsection Advanced Scoring Syntax
11985 Ordinary scoring rules have a string as the first element in the rule.
11986 Advanced scoring rules have a list as the first element. The second
11987 element is the score to be applied if the first element evaluated to a
11988 non-@code{nil} value.
11990 These lists may consist of three logical operators, one redirection
11991 operator, and various match operators.
11998 This logical operator will evaluate each of its arguments until it finds
11999 one that evaluates to @code{false}, and then it'll stop. If all arguments
12000 evaluate to @code{true} values, then this operator will return
12005 This logical operator will evaluate each of its arguments until it finds
12006 one that evaluates to @code{true}. If no arguments are @code{true},
12007 then this operator will return @code{false}.
12012 This logical operator only takes a single argument. It returns the
12013 inverse of the value of its argument.
12017 There is an @dfn{indirection operator} that will make its arguments
12018 apply to the ancestors of the current article being scored. For
12019 instance, @code{1-} will make score rules apply to the parent of the
12020 current article. @code{2-} will make score fules apply to the
12021 grandparent of the current article. Alternatively, you can write
12022 @code{^^}, where the number of @code{^}s (carets) say how far back into
12023 the ancestry you want to go.
12025 Finally, we have the match operators. These are the ones that do the
12026 real work. Match operators are header name strings followed by a match
12027 and a match type. A typical match operator looks like @samp{("from"
12028 "Lars Ingebrigtsen" s)}. The header names are the same as when using
12029 simple scoring, and the match types are also the same.
12032 @node Advanced Scoring Examples
12033 @subsection Advanced Scoring Examples
12035 Let's say you want to increase the score of articles written by Lars
12036 when he's talking about Gnus:
12040 ("from" "Lars Ingebrigtsen")
12041 ("subject" "Gnus"))
12047 When he writes long articles, he sometimes has something nice to say:
12051 ("from" "Lars Ingebrigtsen")
12058 However, when he responds to things written by Reig Eigil Logge, you
12059 really don't want to read what he's written:
12063 ("from" "Lars Ingebrigtsen")
12064 (1- ("from" "Reig Eigir Logge")))
12068 Everybody that follows up Redmondo when he writes about disappearing
12069 socks should have their scores raised, but only when they talk about
12070 white socks. However, when Lars talks about socks, it's usually not
12077 ("from" "redmondo@@.*no" r)
12078 ("body" "disappearing.*socks" t)))
12079 (! ("from" "Lars Ingebrigtsen"))
12080 ("body" "white.*socks"))
12084 The possibilities are endless.
12087 @node Advanced Scoring Tips
12088 @subsection Advanced Scoring Tips
12090 The @code{&} and @code{|} logical operators do short-circuit logic.
12091 That is, they stop processing their arguments when it's clear what the
12092 result of the operation will be. For instance, if one of the arguments
12093 of an @code{&} evaluates to @code{false}, there's no point in evaluating
12094 the rest of the arguments. This means that you should put slow matches
12095 (@samp{body}, @code{header}) last and quick matches (@samp{from},
12096 @samp{subject}) first.
12098 The indirection arguments (@code{1-} and so on) will make their
12099 arguments work on previous generations of the thread. If you say
12110 Then that means "score on the from header of the grandparent of the
12111 current article". An indirection is quite fast, but it's better to say:
12117 ("subject" "Gnus")))
12124 (1- ("from" "Lars"))
12125 (1- ("subject" "Gnus")))
12130 @section Score Decays
12131 @cindex score decays
12134 You may find that your scores have a tendency to grow without
12135 bounds, especially if you're using adaptive scoring. If scores get too
12136 big, they lose all meaning---they simply max out and it's difficult to
12137 use them in any sensible way.
12139 @vindex gnus-decay-scores
12140 @findex gnus-decay-score
12141 @vindex gnus-score-decay-function
12142 Gnus provides a mechanism for decaying scores to help with this problem.
12143 When score files are loaded and @code{gnus-decay-scores} is
12144 non-@code{nil}, Gnus will run the score files through the decaying
12145 mechanism thereby lowering the scores of all non-permanent score rules.
12146 The decay itself if performed by the @code{gnus-score-decay-function}
12147 function, which is @code{gnus-decay-score} by default. Here's the
12148 definition of that function:
12151 (defun gnus-decay-score (score)
12154 (* (if (< score 0) 1 -1)
12156 (max gnus-score-decay-constant
12158 gnus-score-decay-scale)))))))
12161 @vindex gnus-score-decay-scale
12162 @vindex gnus-score-decay-constant
12163 @code{gnus-score-decay-constant} is 3 by default and
12164 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
12168 Scores between -3 and 3 will be set to 0 when this function is called.
12171 Scores with magnitudes between 3 and 60 will be shrunk by 3.
12174 Scores with magnitudes greater than 60 will be shrunk by 5% of the
12178 If you don't like this decay function, write your own. It is called
12179 with the score to be decayed as its only parameter, and it should return
12180 the new score, which should be an integer.
12182 Gnus will try to decay scores once a day. If you haven't run Gnus for
12183 four days, Gnus will decay the scores four times, for instance.
12190 * Process/Prefix:: A convention used by many treatment commands.
12191 * Interactive:: Making Gnus ask you many questions.
12192 * Formatting Variables:: You can specify what buffers should look like.
12193 * Windows Configuration:: Configuring the Gnus buffer windows.
12194 * Compilation:: How to speed Gnus up.
12195 * Mode Lines:: Displaying information in the mode lines.
12196 * Highlighting and Menus:: Making buffers look all nice and cozy.
12197 * Buttons:: Get tendonitis in ten easy steps!
12198 * Daemons:: Gnus can do things behind your back.
12199 * NoCeM:: How to avoid spam and other fatty foods.
12200 * Picons:: How to display pictures of what your reading.
12201 * Undo:: Some actions can be undone.
12202 * Moderation:: What to do if you're a moderator.
12203 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
12204 * Fuzzy Matching:: What's the big fuzz?
12205 * Thwarting Email Spam:: A how-to on avoiding unsolited commercial email.
12206 * Various Various:: Things that are really various.
12210 @node Process/Prefix
12211 @section Process/Prefix
12212 @cindex process/prefix convention
12214 Many functions, among them functions for moving, decoding and saving
12215 articles, use what is known as the @dfn{Process/Prefix convention}.
12217 This is a method for figuring out what articles that the user wants the
12218 command to be performed on.
12222 If the numeric prefix is N, perform the operation on the next N
12223 articles, starting with the current one. If the numeric prefix is
12224 negative, perform the operation on the previous N articles, starting
12225 with the current one.
12227 @vindex transient-mark-mode
12228 If @code{transient-mark-mode} in non-@code{nil} and the region is
12229 active, all articles in the region will be worked upon.
12231 If there is no numeric prefix, but some articles are marked with the
12232 process mark, perform the operation on the articles that are marked with
12235 If there is neither a numeric prefix nor any articles marked with the
12236 process mark, just perform the operation on the current article.
12238 Quite simple, really, but it needs to be made clear so that surprises
12241 Commands that react to the process mark will push the current list of
12242 process marked articles onto a stack and will then clear all process
12243 marked articles. You can restore the previous configuration with the
12244 @kbd{M P y} command (@pxref{Setting Process Marks}).
12246 @vindex gnus-summary-goto-unread
12247 One thing that seems to shock & horrify lots of people is that, for
12248 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
12249 Since each @kbd{d} (which marks the current article as read) by default
12250 goes to the next unread article after marking, this means that @kbd{3 d}
12251 will mark the next three unread articles as read, no matter what the
12252 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
12253 @code{nil} for a more straightforward action.
12257 @section Interactive
12258 @cindex interaction
12262 @item gnus-novice-user
12263 @vindex gnus-novice-user
12264 If this variable is non-@code{nil}, you are either a newcomer to the
12265 World of Usenet, or you are very cautious, which is a nice thing to be,
12266 really. You will be given questions of the type ``Are you sure you want
12267 to do this?'' before doing anything dangerous. This is @code{t} by
12270 @item gnus-expert-user
12271 @vindex gnus-expert-user
12272 If this variable is non-@code{nil}, you will never ever be asked any
12273 questions by Gnus. It will simply assume you know what you're doing, no
12274 matter how strange.
12276 @item gnus-interactive-catchup
12277 @vindex gnus-interactive-catchup
12278 Require confirmation before catching up a group if non-@code{nil}. It
12279 is @code{t} by default.
12281 @item gnus-interactive-exit
12282 @vindex gnus-interactive-exit
12283 Require confirmation before exiting Gnus. This variable is @code{t} by
12288 @node Formatting Variables
12289 @section Formatting Variables
12290 @cindex formatting variables
12292 Throughout this manual you've probably noticed lots of variables that
12293 are called things like @code{gnus-group-line-format} and
12294 @code{gnus-summary-mode-line-format}. These control how Gnus is to
12295 output lines in the various buffers. There's quite a lot of them.
12296 Fortunately, they all use the same syntax, so there's not that much to
12299 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
12300 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
12301 lots of percentages everywhere.
12304 * Formatting Basics:: A formatting variable is basically a format string.
12305 * Advanced Formatting:: Modifying output in various ways.
12306 * User-Defined Specs:: Having Gnus call your own functions.
12307 * Formatting Fonts:: Making the formatting look colorful and nice.
12310 Currently Gnus uses the following formatting variables:
12311 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
12312 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
12313 @code{gnus-group-mode-line-format},
12314 @code{gnus-summary-mode-line-format},
12315 @code{gnus-article-mode-line-format},
12316 @code{gnus-server-mode-line-format}, and
12317 @code{gnus-summary-pick-line-format}.
12319 All these format variables can also be arbitrary elisp forms. In that
12320 case, they will be @code{eval}ed to insert the required lines.
12322 @kindex M-x gnus-update-format
12323 @findex gnus-update-format
12324 Gnus includes a command to help you while creating your own format
12325 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
12326 update the spec in question and pop you to a buffer where you can
12327 examine the resulting lisp code to be run to generate the line.
12331 @node Formatting Basics
12332 @subsection Formatting Basics
12334 Each @samp{%} element will be replaced by some string or other when the
12335 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
12336 spec, and pad with spaces to get a 5-character field''.
12338 As with normal C and Emacs Lisp formatting strings, the numerical
12339 modifier between the @samp{%} and the formatting type character will
12340 @dfn{pad} the output so that it is always at least that long.
12341 @samp{%5y} will make the field always (at least) five characters wide by
12342 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
12345 You may also wish to limit the length of the field to protect against
12346 particularly wide values. For that you can say @samp{%4,6y}, which
12347 means that the field will never be more than 6 characters wide and never
12348 less than 4 characters wide.
12351 @node Advanced Formatting
12352 @subsection Advanced Formatting
12354 It is frequently useful to post-process the fields in some way.
12355 Padding, limiting, cutting off parts and suppressing certain values can
12356 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
12357 look like @samp{%~(cut 3)~(ignore "0")y}.
12359 These are the legal modifiers:
12364 Pad the field to the left with spaces until it reaches the required
12368 Pad the field to the right with spaces until it reaches the required
12373 Cut off characters from the left until it reaches the specified length.
12376 Cut off characters from the right until it reaches the specified
12381 Cut off the specified number of characters from the left.
12384 Cut off the specified number of characters from the right.
12387 Return an empty string if the field is equal to the specified value.
12390 Use the specified form as the field value when the @samp{@@} spec is
12394 Let's take an example. The @samp{%o} spec in the summary mode lines
12395 will return a date in compact ISO8601 format---@samp{19960809T230410}.
12396 This is quite a mouthful, so we want to shave off the century number and
12397 the time, leaving us with a six-character date. That would be
12398 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
12399 maxing, and we need the padding to ensure that the date is never less
12400 than 6 characters to make it look nice in columns.)
12402 Ignoring is done first; then cutting; then maxing; and then as the very
12403 last operation, padding.
12405 If you use lots of these advanced thingies, you'll find that Gnus gets
12406 quite slow. This can be helped enormously by running @kbd{M-x
12407 gnus-compile} when you are satisfied with the look of your lines.
12408 @xref{Compilation}.
12411 @node User-Defined Specs
12412 @subsection User-Defined Specs
12414 All the specs allow for inserting user defined specifiers---@samp{u}.
12415 The next character in the format string should be a letter. Gnus
12416 will call the function @code{gnus-user-format-function-}@samp{X}, where
12417 @samp{X} is the letter following @samp{%u}. The function will be passed
12418 a single parameter---what the parameter means depends on what buffer
12419 it's being called from. The function should return a string, which will
12420 be inserted into the buffer just like information from any other
12421 specifier. This function may also be called with dummy values, so it
12422 should protect against that.
12424 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
12425 much the same without defining new functions. Here's an example:
12426 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
12427 given here will be evaluated to yield the current line number, and then
12431 @node Formatting Fonts
12432 @subsection Formatting Fonts
12434 There are specs for highlighting, and these are shared by all the format
12435 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
12436 the special @code{mouse-face} property set, which means that it will be
12437 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
12440 Text inside the @samp{%[} and @samp{%]} specifiers will have their
12441 normal faces set using @code{gnus-face-0}, which is @code{bold} by
12442 default. If you say @samp{%1[} instead, you'll get @code{gnus-face-1}
12443 instead, and so on. Create as many faces as you wish. The same goes
12444 for the @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
12445 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
12447 Here's an alternative recipe for the group buffer:
12450 ;; Create three face types.
12451 (setq gnus-face-1 'bold)
12452 (setq gnus-face-3 'italic)
12454 ;; We want the article count to be in
12455 ;; a bold and green face. So we create
12456 ;; a new face called `my-green-bold'.
12457 (copy-face 'bold 'my-green-bold)
12459 (set-face-foreground 'my-green-bold "ForestGreen")
12460 (setq gnus-face-2 'my-green-bold)
12462 ;; Set the new & fancy format.
12463 (setq gnus-group-line-format
12464 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
12467 I'm sure you'll be able to use this scheme to create totally unreadable
12468 and extremely vulgar displays. Have fun!
12470 Note that the @samp{%(} specs (and friends) do not make any sense on the
12471 mode-line variables.
12474 @node Windows Configuration
12475 @section Windows Configuration
12476 @cindex windows configuration
12478 No, there's nothing here about X, so be quiet.
12480 @vindex gnus-use-full-window
12481 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
12482 other windows and occupy the entire Emacs screen by itself. It is
12483 @code{t} by default.
12485 @vindex gnus-buffer-configuration
12486 @code{gnus-buffer-configuration} describes how much space each Gnus
12487 buffer should be given. Here's an excerpt of this variable:
12490 ((group (vertical 1.0 (group 1.0 point)
12491 (if gnus-carpal (group-carpal 4))))
12492 (article (vertical 1.0 (summary 0.25 point)
12496 This is an alist. The @dfn{key} is a symbol that names some action or
12497 other. For instance, when displaying the group buffer, the window
12498 configuration function will use @code{group} as the key. A full list of
12499 possible names is listed below.
12501 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
12502 should occupy. To take the @code{article} split as an example -
12505 (article (vertical 1.0 (summary 0.25 point)
12509 This @dfn{split} says that the summary buffer should occupy 25% of upper
12510 half of the screen, and that it is placed over the article buffer. As
12511 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
12512 reaching for that calculator there). However, the special number
12513 @code{1.0} is used to signal that this buffer should soak up all the
12514 rest of the space available after the rest of the buffers have taken
12515 whatever they need. There should be only one buffer with the @code{1.0}
12516 size spec per split.
12518 Point will be put in the buffer that has the optional third element
12521 Here's a more complicated example:
12524 (article (vertical 1.0 (group 4)
12525 (summary 0.25 point)
12526 (if gnus-carpal (summary-carpal 4))
12530 If the size spec is an integer instead of a floating point number,
12531 then that number will be used to say how many lines a buffer should
12532 occupy, not a percentage.
12534 If the @dfn{split} looks like something that can be @code{eval}ed (to be
12535 precise---if the @code{car} of the split is a function or a subr), this
12536 split will be @code{eval}ed. If the result is non-@code{nil}, it will
12537 be used as a split. This means that there will be three buffers if
12538 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
12541 Not complicated enough for you? Well, try this on for size:
12544 (article (horizontal 1.0
12549 (summary 0.25 point)
12554 Whoops. Two buffers with the mystery 100% tag. And what's that
12555 @code{horizontal} thingie?
12557 If the first element in one of the split is @code{horizontal}, Gnus will
12558 split the window horizontally, giving you two windows side-by-side.
12559 Inside each of these strips you may carry on all you like in the normal
12560 fashion. The number following @code{horizontal} says what percentage of
12561 the screen is to be given to this strip.
12563 For each split, there @emph{must} be one element that has the 100% tag.
12564 The splitting is never accurate, and this buffer will eat any leftover
12565 lines from the splits.
12567 To be slightly more formal, here's a definition of what a legal split
12571 split = frame | horizontal | vertical | buffer | form
12572 frame = "(frame " size *split ")"
12573 horizontal = "(horizontal " size *split ")"
12574 vertical = "(vertical " size *split ")"
12575 buffer = "(" buffer-name " " size *[ "point" ] ")"
12576 size = number | frame-params
12577 buffer-name = group | article | summary ...
12580 The limitations are that the @code{frame} split can only appear as the
12581 top-level split. @var{form} should be an Emacs Lisp form that should
12582 return a valid split. We see that each split is fully recursive, and
12583 may contain any number of @code{vertical} and @code{horizontal} splits.
12585 @vindex gnus-window-min-width
12586 @vindex gnus-window-min-height
12587 @cindex window height
12588 @cindex window width
12589 Finding the right sizes can be a bit complicated. No window may be less
12590 than @code{gnus-window-min-height} (default 1) characters high, and all
12591 windows must be at least @code{gnus-window-min-width} (default 1)
12592 characters wide. Gnus will try to enforce this before applying the
12593 splits. If you want to use the normal Emacs window width/height limit,
12594 you can just set these two variables to @code{nil}.
12596 If you're not familiar with Emacs terminology, @code{horizontal} and
12597 @code{vertical} splits may work the opposite way of what you'd expect.
12598 Windows inside a @code{horizontal} split are shown side-by-side, and
12599 windows within a @code{vertical} split are shown above each other.
12601 @findex gnus-configure-frame
12602 If you want to experiment with window placement, a good tip is to call
12603 @code{gnus-configure-frame} directly with a split. This is the function
12604 that does all the real work when splitting buffers. Below is a pretty
12605 nonsensical configuration with 5 windows; two for the group buffer and
12606 three for the article buffer. (I said it was nonsensical.) If you
12607 @code{eval} the statement below, you can get an idea of how that would
12608 look straight away, without going through the normal Gnus channels.
12609 Play with it until you're satisfied, and then use
12610 @code{gnus-add-configuration} to add your new creation to the buffer
12611 configuration list.
12614 (gnus-configure-frame
12618 (article 0.3 point))
12626 You might want to have several frames as well. No prob---just use the
12627 @code{frame} split:
12630 (gnus-configure-frame
12633 (summary 0.25 point)
12635 (vertical ((height . 5) (width . 15)
12636 (user-position . t)
12637 (left . -1) (top . 1))
12642 This split will result in the familiar summary/article window
12643 configuration in the first (or ``main'') frame, while a small additional
12644 frame will be created where picons will be shown. As you can see,
12645 instead of the normal @code{1.0} top-level spec, each additional split
12646 should have a frame parameter alist as the size spec.
12647 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
12650 Here's a list of all possible keys for
12651 @code{gnus-buffer-configuration}:
12653 @code{group}, @code{summary}, @code{article}, @code{server},
12654 @code{browse}, @code{message}, @code{pick}, @code{info},
12655 @code{summary-faq}, @code{edit-group}, @code{edit-server},
12656 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
12657 @code{reply-yank}, @code{mail-bounce}, @code{draft}, @code{pipe},
12658 @code{bug}, @code{compose-bounce}.
12660 Note that the @code{message} key is used for both
12661 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
12662 it is desirable to distinguish between the two, something like this
12666 (message (horizontal 1.0
12667 (vertical 1.0 (message 1.0 point))
12669 (if (buffer-live-p gnus-summary-buffer)
12674 @findex gnus-add-configuration
12675 Since the @code{gnus-buffer-configuration} variable is so long and
12676 complicated, there's a function you can use to ease changing the config
12677 of a single setting: @code{gnus-add-configuration}. If, for instance,
12678 you want to change the @code{article} setting, you could say:
12681 (gnus-add-configuration
12682 '(article (vertical 1.0
12684 (summary .25 point)
12688 You'd typically stick these @code{gnus-add-configuration} calls in your
12689 @file{.gnus.el} file or in some startup hook---they should be run after
12690 Gnus has been loaded.
12692 @vindex gnus-always-force-window-configuration
12693 If all windows mentioned in the configuration are already visible, Gnus
12694 won't change the window configuration. If you always want to force the
12695 ``right'' window configuration, you can set
12696 @code{gnus-always-force-window-configuration} to non-@code{nil}.
12700 @section Compilation
12701 @cindex compilation
12702 @cindex byte-compilation
12704 @findex gnus-compile
12706 Remember all those line format specification variables?
12707 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
12708 on. Now, Gnus will of course heed whatever these variables are, but,
12709 unfortunately, changing them will mean a quite significant slow-down.
12710 (The default values of these variables have byte-compiled functions
12711 associated with them, while the user-generated versions do not, of
12714 To help with this, you can run @kbd{M-x gnus-compile} after you've
12715 fiddled around with the variables and feel that you're (kind of)
12716 satisfied. This will result in the new specs being byte-compiled, and
12717 you'll get top speed again. Gnus will save these compiled specs in the
12718 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
12719 this function, though---you should compile them yourself by sticking
12720 them into the @code{.gnus.el} file and byte-compiling that file.)
12724 @section Mode Lines
12727 @vindex gnus-updated-mode-lines
12728 @code{gnus-updated-mode-lines} says what buffers should keep their mode
12729 lines updated. It is a list of symbols. Supported symbols include
12730 @code{group}, @code{article}, @code{summary}, @code{server},
12731 @code{browse}, and @code{tree}. If the corresponding symbol is present,
12732 Gnus will keep that mode line updated with information that may be
12733 pertinent. If this variable is @code{nil}, screen refresh may be
12736 @cindex display-time
12738 @vindex gnus-mode-non-string-length
12739 By default, Gnus displays information on the current article in the mode
12740 lines of the summary and article buffers. The information Gnus wishes
12741 to display (e.g. the subject of the article) is often longer than the
12742 mode lines, and therefore have to be cut off at some point. The
12743 @code{gnus-mode-non-string-length} variable says how long the other
12744 elements on the line is (i.e., the non-info part). If you put
12745 additional elements on the mode line (e.g. a clock), you should modify
12748 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
12750 (add-hook 'display-time-hook
12751 (lambda () (setq gnus-mode-non-string-length
12753 (if line-number-mode 5 0)
12754 (if column-number-mode 4 0)
12755 (length display-time-string)))))
12758 If this variable is @code{nil} (which is the default), the mode line
12759 strings won't be chopped off, and they won't be padded either.
12760 Note that the default is unlikely to be desirable, as even the
12761 percentage complete in the buffer may be crowded off the mode line;
12762 the user should configure this variable appropriately for their
12766 @node Highlighting and Menus
12767 @section Highlighting and Menus
12769 @cindex highlighting
12772 @vindex gnus-visual
12773 The @code{gnus-visual} variable controls most of the prettifying Gnus
12774 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
12775 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
12778 This variable can be a list of visual properties that are enabled. The
12779 following elements are legal, and are all included by default:
12782 @item group-highlight
12783 Do highlights in the group buffer.
12784 @item summary-highlight
12785 Do highlights in the summary buffer.
12786 @item article-highlight
12787 Do highlights in the article buffer.
12789 Turn on highlighting in all buffers.
12791 Create menus in the group buffer.
12793 Create menus in the summary buffers.
12795 Create menus in the article buffer.
12797 Create menus in the browse buffer.
12799 Create menus in the server buffer.
12801 Create menus in the score buffers.
12803 Create menus in all buffers.
12806 So if you only want highlighting in the article buffer and menus in all
12807 buffers, you could say something like:
12810 (setq gnus-visual '(article-highlight menu))
12813 If you want only highlighting and no menus whatsoever, you'd say:
12816 (setq gnus-visual '(highlight))
12819 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
12820 in all Gnus buffers.
12822 Other general variables that influence the look of all buffers include:
12825 @item gnus-mouse-face
12826 @vindex gnus-mouse-face
12827 This is the face (i.e., font) used for mouse highlighting in Gnus. No
12828 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
12832 There are hooks associated with the creation of all the different menus:
12836 @item gnus-article-menu-hook
12837 @vindex gnus-article-menu-hook
12838 Hook called after creating the article mode menu.
12840 @item gnus-group-menu-hook
12841 @vindex gnus-group-menu-hook
12842 Hook called after creating the group mode menu.
12844 @item gnus-summary-menu-hook
12845 @vindex gnus-summary-menu-hook
12846 Hook called after creating the summary mode menu.
12848 @item gnus-server-menu-hook
12849 @vindex gnus-server-menu-hook
12850 Hook called after creating the server mode menu.
12852 @item gnus-browse-menu-hook
12853 @vindex gnus-browse-menu-hook
12854 Hook called after creating the browse mode menu.
12856 @item gnus-score-menu-hook
12857 @vindex gnus-score-menu-hook
12858 Hook called after creating the score mode menu.
12869 Those new-fangled @dfn{mouse} contraptions is very popular with the
12870 young, hep kids who don't want to learn the proper way to do things
12871 these days. Why, I remember way back in the summer of '89, when I was
12872 using Emacs on a Tops 20 system. Three hundred users on one single
12873 machine, and every user was running Simula compilers. Bah!
12877 @vindex gnus-carpal
12878 Well, you can make Gnus display bufferfuls of buttons you can click to
12879 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
12880 really. Tell the chiropractor I sent you.
12885 @item gnus-carpal-mode-hook
12886 @vindex gnus-carpal-mode-hook
12887 Hook run in all carpal mode buffers.
12889 @item gnus-carpal-button-face
12890 @vindex gnus-carpal-button-face
12891 Face used on buttons.
12893 @item gnus-carpal-header-face
12894 @vindex gnus-carpal-header-face
12895 Face used on carpal buffer headers.
12897 @item gnus-carpal-group-buffer-buttons
12898 @vindex gnus-carpal-group-buffer-buttons
12899 Buttons in the group buffer.
12901 @item gnus-carpal-summary-buffer-buttons
12902 @vindex gnus-carpal-summary-buffer-buttons
12903 Buttons in the summary buffer.
12905 @item gnus-carpal-server-buffer-buttons
12906 @vindex gnus-carpal-server-buffer-buttons
12907 Buttons in the server buffer.
12909 @item gnus-carpal-browse-buffer-buttons
12910 @vindex gnus-carpal-browse-buffer-buttons
12911 Buttons in the browse buffer.
12914 All the @code{buttons} variables are lists. The elements in these list
12915 is either a cons cell where the car contains a text to be displayed and
12916 the cdr contains a function symbol, or a simple string.
12924 Gnus, being larger than any program ever written (allegedly), does lots
12925 of strange stuff that you may wish to have done while you're not
12926 present. For instance, you may want it to check for new mail once in a
12927 while. Or you may want it to close down all connections to all servers
12928 when you leave Emacs idle. And stuff like that.
12930 Gnus will let you do stuff like that by defining various
12931 @dfn{handlers}. Each handler consists of three elements: A
12932 @var{function}, a @var{time}, and an @var{idle} parameter.
12934 Here's an example of a handler that closes connections when Emacs has
12935 been idle for thirty minutes:
12938 (gnus-demon-close-connections nil 30)
12941 Here's a handler that scans for PGP headers every hour when Emacs is
12945 (gnus-demon-scan-pgp 60 t)
12948 This @var{time} parameter and than @var{idle} parameter works together
12949 in a strange, but wonderful fashion. Basically, if @var{idle} is
12950 @code{nil}, then the function will be called every @var{time} minutes.
12952 If @var{idle} is @code{t}, then the function will be called after
12953 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
12954 the function will never be called. But once Emacs goes idle, the
12955 function will be called every @var{time} minutes.
12957 If @var{idle} is a number and @var{time} is a number, the function will
12958 be called every @var{time} minutes only when Emacs has been idle for
12959 @var{idle} minutes.
12961 If @var{idle} is a number and @var{time} is @code{nil}, the function
12962 will be called once every time Emacs has been idle for @var{idle}
12965 And if @var{time} is a string, it should look like @samp{07:31}, and
12966 the function will then be called once every day somewhere near that
12967 time. Modified by the @var{idle} parameter, of course.
12969 @vindex gnus-demon-timestep
12970 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
12971 seconds. This is 60 by default. If you change that variable,
12972 all the timings in the handlers will be affected.)
12974 @vindex gnus-use-demon
12975 To set the whole thing in motion, though, you have to set
12976 @code{gnus-use-demon} to @code{t}.
12978 So, if you want to add a handler, you could put something like this in
12979 your @file{.gnus} file:
12981 @findex gnus-demon-add-handler
12983 (gnus-demon-add-handler 'gnus-demon-close-connections nil 30)
12986 @findex gnus-demon-add-nocem
12987 @findex gnus-demon-add-scanmail
12988 @findex gnus-demon-add-rescan
12989 @findex gnus-demon-add-disconnection
12990 Some ready-made functions to do this has been created:
12991 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
12992 @code{gnus-demon-add-rescan}, and @code{gnus-demon-add-scanmail}. Just
12993 put those functions in your @file{.gnus} if you want those abilities.
12995 @findex gnus-demon-init
12996 @findex gnus-demon-cancel
12997 @vindex gnus-demon-handlers
12998 If you add handlers to @code{gnus-demon-handlers} directly, you should
12999 run @code{gnus-demon-init} to make the changes take hold. To cancel all
13000 daemons, you can use the @code{gnus-demon-cancel} function.
13002 Note that adding daemons can be pretty naughty if you overdo it. Adding
13003 functions that scan all news and mail from all servers every two seconds
13004 is a sure-fire way of getting booted off any respectable system. So
13013 @dfn{Spamming} is posting the same article lots and lots of times.
13014 Spamming is bad. Spamming is evil.
13016 Spamming is usually canceled within a day or so by various anti-spamming
13017 agencies. These agencies usually also send out @dfn{NoCeM} messages.
13018 NoCeM is pronounced ``no see-'em'', and means what the name
13019 implies---these are messages that make the offending articles, like, go
13022 What use are these NoCeM messages if the articles are canceled anyway?
13023 Some sites do not honor cancel messages and some sites just honor cancels
13024 from a select few people. Then you may wish to make use of the NoCeM
13025 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
13027 Gnus can read and parse the messages in this group automatically, and
13028 this will make spam disappear.
13030 There are some variables to customize, of course:
13033 @item gnus-use-nocem
13034 @vindex gnus-use-nocem
13035 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
13038 @item gnus-nocem-groups
13039 @vindex gnus-nocem-groups
13040 Gnus will look for NoCeM messages in the groups in this list. The
13041 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
13042 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
13044 @item gnus-nocem-issuers
13045 @vindex gnus-nocem-issuers
13046 There are many people issuing NoCeM messages. This list says what
13047 people you want to listen to. The default is @code{("Automoose-1"
13048 "clewis@@ferret.ocunix.on.ca;" "jem@@xpat.com;" "red@@redpoll.mrfs.oh.us
13049 (Richard E. Depew)")}; fine, upstanding citizens all of them.
13051 Known despammers that you can put in this list include:
13054 @item clewis@@ferret.ocunix.on.ca;
13055 @cindex Chris Lewis
13056 Chris Lewis---Major Canadian despammer who has probably canceled more
13057 usenet abuse than anybody else.
13060 @cindex CancelMoose[tm]
13061 The CancelMoose[tm] on autopilot. The CancelMoose[tm] is reputed to be
13062 Norwegian, and was the person(s) who invented NoCeM.
13064 @item jem@@xpat.com;
13066 John Milburn---despammer located in Korea who is getting very busy these
13069 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
13070 Richard E. Depew---lone American despammer. He mostly cancels binary
13071 postings to non-binary groups and removes spews (regurgitated articles).
13074 You do not have to heed NoCeM messages from all these people---just the
13075 ones you want to listen to.
13077 @item gnus-nocem-verifyer
13078 @vindex gnus-nocem-verifyer
13080 This should be a function for verifying that the NoCeM issuer is who she
13081 says she is. The default is @code{mc-verify}, which is a Mailcrypt
13082 function. If this is too slow and you don't care for verification
13083 (which may be dangerous), you can set this variable to @code{nil}.
13085 If you want signed NoCeM messages to be verified and unsigned messages
13086 not to be verified (but used anyway), you could do something like:
13089 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
13091 (defun my-gnus-mc-verify ()
13099 This might be dangerous, though.
13101 @item gnus-nocem-directory
13102 @vindex gnus-nocem-directory
13103 This is where Gnus will store its NoCeM cache files. The default is
13104 @file{~/News/NoCeM/}.
13106 @item gnus-nocem-expiry-wait
13107 @vindex gnus-nocem-expiry-wait
13108 The number of days before removing old NoCeM entries from the cache.
13109 The default is 15. If you make it shorter Gnus will be faster, but you
13110 might then see old spam.
13118 So... You want to slow down your news reader even more! This is a
13119 good way to do so. Its also a great way to impress people staring
13120 over your shoulder as you read news.
13123 * Picon Basics:: What are picons and How do I get them.
13124 * Picon Requirements:: Don't go further if you aren't using XEmacs.
13125 * Easy Picons:: Displaying Picons---the easy way.
13126 * Hard Picons:: The way you should do it. You'll learn something.
13127 * Picon Configuration:: Other variables you can trash/tweak/munge/play with.
13132 @subsection Picon Basics
13134 What are Picons? To quote directly from the Picons Web site:
13137 @dfn{Picons} is short for ``personal icons''. They're small,
13138 constrained images used to represent users and domains on the net,
13139 organized into databases so that the appropriate image for a given
13140 e-mail address can be found. Besides users and domains, there are picon
13141 databases for Usenet newsgroups and weather forecasts. The picons are
13142 in either monochrome @code{XBM} format or color @code{XPM} and
13143 @code{GIF} formats.
13146 For instructions on obtaining and installing the picons databases, point
13147 your Web browser at
13148 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.
13150 @vindex gnus-picons-database
13151 Gnus expects picons to be installed into a location pointed to by
13152 @code{gnus-picons-database}.
13155 @node Picon Requirements
13156 @subsection Picon Requirements
13158 To use have Gnus display Picons for you, you must be running XEmacs
13159 19.13 or greater since all other versions of Emacs aren't yet able to
13162 Additionally, you must have @code{xpm} support compiled into XEmacs.
13164 @vindex gnus-picons-convert-x-face
13165 If you want to display faces from @code{X-Face} headers, you must have
13166 the @code{netpbm} utilities installed, or munge the
13167 @code{gnus-picons-convert-x-face} variable to use something else.
13171 @subsection Easy Picons
13173 To enable displaying picons, simply put the following line in your
13174 @file{~/.gnus} file and start Gnus.
13177 (setq gnus-use-picons t)
13178 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13179 (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
13180 (add-hook 'gnus-article-display-hook 'gnus-picons-article-display-x-face)
13185 @subsection Hard Picons
13187 Gnus can display picons for you as you enter and leave groups and
13188 articles. It knows how to interact with three sections of the picons
13189 database. Namely, it can display the picons newsgroup pictures,
13190 author's face picture(s), and the authors domain. To enable this
13191 feature, you need to first decide where to display them.
13195 @item gnus-picons-display-where
13196 @vindex gnus-picons-display-where
13197 Where the picon images should be displayed. It is @code{picons} by
13198 default (which by default maps to the buffer @samp{*Picons*}). Other
13199 valid places could be @code{article}, @code{summary}, or
13200 @samp{*scratch*} for all I care. Just make sure that you've made the
13201 buffer visible using the standard Gnus window configuration
13202 routines---@pxref{Windows Configuration}.
13206 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
13207 window configuration for you to include the @code{picons} buffer.
13209 Now that you've made that decision, you need to add the following
13210 functions to the appropriate hooks so these pictures will get
13211 displayed at the right time.
13213 @vindex gnus-article-display-hook
13214 @vindex gnus-picons-display-where
13216 @item gnus-article-display-picons
13217 @findex gnus-article-display-picons
13218 Looks up and display the picons for the author and the author's domain
13219 in the @code{gnus-picons-display-where} buffer. Should be added to
13220 the @code{gnus-article-display-hook}.
13222 @item gnus-group-display-picons
13223 @findex gnus-article-display-picons
13224 Displays picons representing the current group. This function should
13225 be added to the @code{gnus-summary-prepare-hook} or to the
13226 @code{gnus-article-display-hook} if @code{gnus-picons-display-where}
13227 is set to @code{article}.
13229 @item gnus-picons-article-display-x-face
13230 @findex gnus-article-display-picons
13231 Decodes and displays the X-Face header if present. This function
13232 should be added to @code{gnus-article-display-hook}.
13236 Note: You must append them to the hook, so make sure to specify 't'
13237 to the append flag of @code{add-hook}:
13240 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13244 @node Picon Configuration
13245 @subsection Picon Configuration
13247 The following variables offer further control over how things are
13248 done, where things are located, and other useless stuff you really
13249 don't need to worry about.
13252 @item gnus-picons-database
13253 @vindex gnus-picons-database
13254 The location of the picons database. Should point to a directory
13255 containing the @file{news}, @file{domains}, @file{users} (and so on)
13256 subdirectories. Defaults to @file{/usr/local/faces}.
13258 @item gnus-picons-news-directory
13259 @vindex gnus-picons-news-directory
13260 Sub-directory of the faces database containing the icons for
13263 @item gnus-picons-user-directories
13264 @vindex gnus-picons-user-directories
13265 List of subdirectories to search in @code{gnus-picons-database} for user
13266 faces. @code{("local" "users" "usenix" "misc/MISC")} is the default.
13268 @item gnus-picons-domain-directories
13269 @vindex gnus-picons-domain-directories
13270 List of subdirectories to search in @code{gnus-picons-database} for
13271 domain name faces. Defaults to @code{("domains")}. Some people may
13272 want to add @samp{unknown} to this list.
13274 @item gnus-picons-convert-x-face
13275 @vindex gnus-picons-convert-x-face
13276 The command to use to convert the @code{X-Face} header to an X bitmap
13277 (@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48,
13278 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
13279 gnus-picons-x-face-file-name)}
13281 @item gnus-picons-x-face-file-name
13282 @vindex gnus-picons-x-face-file-name
13283 Names a temporary file to store the @code{X-Face} bitmap in. Defaults
13284 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
13286 @item gnus-picons-buffer
13287 @vindex gnus-picons-buffer
13288 The name of the buffer that @code{picons} points to. Defaults to
13289 @samp{*Icon Buffer*}.
13298 It is very useful to be able to undo actions one has done. In normal
13299 Emacs buffers, it's easy enough---you just push the @code{undo} button.
13300 In Gnus buffers, however, it isn't that simple.
13302 The things Gnus displays in its buffer is of no value whatsoever to
13303 Gnus---it's all just data that is designed to look nice to the user.
13304 Killing a group in the group buffer with @kbd{C-k} makes the line
13305 disappear, but that's just a side-effect of the real action---the
13306 removal of the group in question from the internal Gnus structures.
13307 Undoing something like that can't be done by the normal Emacs
13308 @code{undo} function.
13310 Gnus tries to remedy this somewhat by keeping track of what the user
13311 does and coming up with actions that would reverse the actions the user
13312 takes. When the user then presses the @code{undo} key, Gnus will run
13313 the code to reverse the previous action, or the previous actions.
13314 However, not all actions are easily reversible, so Gnus currently offers
13315 a few key functions to be undoable. These include killing groups,
13316 yanking groups, and changing the list of read articles of groups.
13317 That's it, really. More functions may be added in the future, but each
13318 added function means an increase in data to be stored, so Gnus will
13319 never be totally undoable.
13321 @findex gnus-undo-mode
13322 @vindex gnus-use-undo
13324 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
13325 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
13326 default. The @kbd{M-C-_} key performs the @code{gnus-undo} command
13327 command, which should feel kinda like the normal Emacs @code{undo}
13332 @section Moderation
13335 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
13336 It is not included in the standard Gnus package. Write a mail to
13337 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
13340 The moderation package is implemented as a minor mode for summary
13344 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
13347 in your @file{.gnus.el} file.
13349 If you are the moderation of @samp{rec.zoofle}, this is how it's
13354 You split your incoming mail by matching on
13355 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
13356 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
13359 You enter that group once in a while and post articles using the @kbd{e}
13360 (edit-and-post) or @kbd{s} (just send unedited) commands.
13363 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
13364 articles that weren't approved by you, you can cancel them with the
13368 To use moderation mode in these two groups, say:
13371 (setq gnus-moderated-list
13372 "^nnml:rec.zoofle$\\|^rec.zoofle$")
13376 @node XEmacs Enhancements
13377 @section XEmacs Enhancements
13380 XEmacs is able to display pictures and stuff, so Gnus has taken
13381 advantage of that. Relevant variables include:
13384 @item gnus-xmas-glyph-directory
13385 @vindex gnus-xmas-glyph-directory
13386 This is where Gnus will look for pictures. Gnus will normally
13387 auto-detect this directory, but you may set it manually if you have an
13388 unusual directory structure.
13390 @item gnus-xmas-logo-color-alist
13391 @vindex gnus-xmas-logo-color-alist
13392 This is an alist where the key is a type symbol and the values are the
13393 foreground and background color of the splash page glyph.
13395 @item gnus-xmas-logo-color-style
13396 @vindex gnus-xmas-logo-color-style
13397 This is the key used to look up the color in the alist described above.
13398 Legal values include @code{flame}, @code{pine}, @code{moss},
13399 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
13400 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
13402 @item gnus-use-toolbar
13403 @vindex gnus-use-toolbar
13404 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
13405 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
13406 @code{right-toolbar}, or @code{left-toolbar}.
13408 @item gnus-group-toolbar
13409 @vindex gnus-group-toolbar
13410 The toolbar in the group buffer.
13412 @item gnus-summary-toolbar
13413 @vindex gnus-summary-toolbar
13414 The toolbar in the summary buffer.
13416 @item gnus-summary-mail-toolbar
13417 @vindex gnus-summary-mail-toolbar
13418 The toolbar in the summary buffer of mail groups.
13420 @item gnus-xmas-modeline-glyph
13421 @vindex gnus-xmas-modeline-glyph
13422 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
13428 @node Fuzzy Matching
13429 @section Fuzzy Matching
13430 @cindex fuzzy matching
13432 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
13433 things like scoring, thread gathering and thread comparison.
13435 As opposed to regular expression matching, fuzzy matching is very fuzzy.
13436 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
13437 means, and the implementation has changed over time.
13439 Basically, it tries to remove all noise from lines before comparing.
13440 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
13441 out of the strings before comparing the results. This often leads to
13442 adequate results---even when faced with strings generated by text
13443 manglers masquerading as newsreaders.
13446 @node Thwarting Email Spam
13447 @section Thwarting Email Spam
13451 @cindex unsolicited commercial email
13453 In these last days of the Usenet, commercial vultures are hanging about
13454 and grepping through news like crazy to find email addresses they can
13455 foist off their scams and products to. As a reaction to this, many
13456 people have started putting nonsense addresses into their @code{From}
13457 lines. I think this is counterproductive---it makes it difficult for
13458 people to send you legitimate mail in response to things you write, as
13459 well as making it difficult to see who wrote what. This rewriting may
13460 perhaps be a bigger menace than the unsolicited commercial email itself
13463 The biggest problem I have with email spam is that it comes in under
13464 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
13465 have 10 new emails. I say ``Golly gee! Happy is me!'' and selects the
13466 mail group, only to find two pyramid schemes, seven advertisements
13467 (``New! Miracle tonic for growing full, lustrouos hair on your toes!'')
13468 and one mail asking me to repent and find some god.
13472 The way to deal with this is having Gnus split out all spam into a
13473 @samp{spam} mail group (@pxref{Splitting Mail}).
13475 First, pick one (1) legal mail address that you can be reached at, and
13476 put it in your @code{From} header of all your news articles. (I've
13477 chosen @samp{larsi@@trym.ifi.uio.no}.)
13480 (setq message-default-news-headers
13481 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
13484 Then put the following split rule in @code{nnmail-split-fancy}
13485 (@pxref{Fancy Mail Splitting}):
13490 (to "larsi@@trym.ifi.uio.no"
13491 (| ("subject" "re:.*" "misc")
13492 ("references" ".*@@.*" "misc")
13498 This says that all mail to this address is suspect, but if it has a
13499 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
13500 header, it's probably ok. All the rest goes to the @samp{spam} group.
13501 (This idea probably comes from Tim Pierce.)
13503 In addition, many mail spammers talk directly to your @code{smtp} server
13504 and do not include your email address explicitly in the @code{To}
13505 header. Why they do this is unknown---perhaps it's to thwart this
13506 twarting scheme? In any case, this is trivial to deal with---you just
13507 put anything not addressed to you in the @samp{spam} group by ending
13508 your fancy split rule in this way:
13513 (to "larsi" "misc")
13517 In my experience, this will sort virtually everything into the right
13518 group. You still have to check the @samp{spam} group from time to time to
13519 check for legitimate mail, though. If you feel like being a good net
13520 citizen, you can even send off complaints to the proper authorities on
13521 each unsolicited commercial email---at your leisure.
13523 This works for me. It allows people an easy way to contact me (they can
13524 just press @kbd{r} in the usual way), and I'm not bothered at all with
13525 spam. It's a win-win situation. Forging @code{From} headers to point
13526 to non-existant domains is yucky, in my opinion.
13529 @node Various Various
13530 @section Various Various
13536 @item gnus-home-directory
13537 All Gnus path variables will be initialized from this variable, which
13538 defaults to @file{~/}.
13540 @item gnus-directory
13541 @vindex gnus-directory
13542 Most Gnus storage path variables will be initialized from this variable,
13543 which defaults to the @samp{SAVEDIR} environment variable, or
13544 @file{~/News/} if that variable isn't set.
13546 @item gnus-default-directory
13547 @vindex gnus-default-directory
13548 Not related to the above variable at all---this variable says what the
13549 default directory of all Gnus buffers should be. If you issue commands
13550 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
13551 default directory. If this variable is @code{nil} (which is the
13552 default), the default directory will be the default directory of the
13553 buffer you were in when you started Gnus.
13556 @vindex gnus-verbose
13557 This variable is an integer between zero and ten. The higher the value,
13558 the more messages will be displayed. If this variable is zero, Gnus
13559 will never flash any messages, if it is seven (which is the default),
13560 most important messages will be shown, and if it is ten, Gnus won't ever
13561 shut up, but will flash so many messages it will make your head swim.
13563 @item gnus-verbose-backends
13564 @vindex gnus-verbose-backends
13565 This variable works the same way as @code{gnus-verbose}, but it applies
13566 to the Gnus backends instead of Gnus proper.
13568 @item nnheader-max-head-length
13569 @vindex nnheader-max-head-length
13570 When the backends read straight heads of articles, they all try to read
13571 as little as possible. This variable (default 4096) specifies
13572 the absolute max length the backends will try to read before giving up
13573 on finding a separator line between the head and the body. If this
13574 variable is @code{nil}, there is no upper read bound. If it is
13575 @code{t}, the backends won't try to read the articles piece by piece,
13576 but read the entire articles. This makes sense with some versions of
13579 @item nnheader-head-chop-length
13580 @vindex nnheader-head-chop-length
13581 This variable says how big a piece of each article to read when doing
13582 the operation described above.
13584 @item nnheader-file-name-translation-alist
13585 @vindex nnheader-file-name-translation-alist
13587 @cindex illegal characters in file names
13588 @cindex characters in file names
13589 This is an alist that says how to translate characters in file names.
13590 For instance, if @samp{:} is illegal as a file character in file names
13591 on your system (you OS/2 user you), you could say something like:
13594 (setq nnheader-file-name-translation-alist
13598 In fact, this is the default value for this variable on OS/2 and MS
13599 Windows (phooey) systems.
13601 @item gnus-hidden-properties
13602 @vindex gnus-hidden-properties
13603 This is a list of properties to use to hide ``invisible'' text. It is
13604 @code{(invisible t intangible t)} by default on most systems, which
13605 makes invisible text invisible and intangible.
13607 @item gnus-parse-headers-hook
13608 @vindex gnus-parse-headers-hook
13609 A hook called before parsing headers. It can be used, for instance, to
13610 gather statistics on the headers fetched, or perhaps you'd like to prune
13611 some headers. I don't see why you'd want that, though.
13613 @item gnus-shell-command-separator
13614 @vindex gnus-shell-command-separator
13615 String used to separate to shell commands. The default is @samp{;}.
13624 Well, that's the manual---you can get on with your life now. Keep in
13625 touch. Say hello to your cats from me.
13627 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
13629 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
13635 Not because of victories @*
13638 but for the common sunshine,@*
13640 the largess of the spring.
13644 but for the day's work done@*
13645 as well as I was able;@*
13646 not for a seat upon the dais@*
13647 but at the common table.@*
13652 @chapter Appendices
13655 * History:: How Gnus got where it is today.
13656 * Terminology:: We use really difficult, like, words here.
13657 * Customization:: Tailoring Gnus to your needs.
13658 * Troubleshooting:: What you might try if things do not work.
13659 * A Programmers Guide to Gnus:: Rilly, rilly technical stuff.
13660 * Emacs for Heathens:: A short introduction to Emacsian terms.
13661 * Frequently Asked Questions:: A question-and-answer session.
13669 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
13670 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
13672 If you want to investigate the person responsible for this outrage, you
13673 can point your (feh!) web browser to
13674 @file{http://www.ifi.uio.no/~larsi/}. This is also the primary
13675 distribution point for the new and spiffy versions of Gnus, and is known
13676 as The Site That Destroys Newsrcs And Drives People Mad.
13678 During the first extended alpha period of development, the new Gnus was
13679 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
13680 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
13681 (Besides, the ``Gnus'' in this abbreviation should probably be
13682 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
13683 appropriate name, don't you think?)
13685 In any case, after spending all that energy on coming up with a new and
13686 spunky name, we decided that the name was @emph{too} spunky, so we
13687 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
13688 ``@sc{gnus}''. New vs. old.
13690 The first ``proper'' release of Gnus 5 was done in November 1995 when it
13691 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
13692 plus 15 Gnus 5.0 releases).
13694 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
13695 releases)) was released under the name ``Gnus 5.2'' (40 releases).
13697 On July 28th 1996 work on Red Gnus was begun, and it was released on
13698 January 25th 1997 (after 84 releases) as ``Gnus 5.4''.
13700 If you happen upon a version of Gnus that has a name that is prefixed --
13701 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
13702 don't panic. Don't let it know that you're frightened. Back away.
13703 Slowly. Whatever you do, don't run. Walk away, calmly, until you're
13704 out of its reach. Find a proper released version of Gnus and snuggle up
13708 * Why?:: What's the point of Gnus?
13709 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
13710 * Conformity:: Gnus tries to conform to all standards.
13711 * Emacsen:: Gnus can be run on a few modern Emacsen.
13712 * Contributors:: Oodles of people.
13713 * New Features:: Pointers to some of the new stuff in Gnus.
13714 * Newest Features:: Features so new that they haven't been written yet.
13721 What's the point of Gnus?
13723 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
13724 newsreader, that lets you do anything you can think of. That was my
13725 original motivation, but while working on Gnus, it has become clear to
13726 me that this generation of newsreaders really belong in the stone age.
13727 Newsreaders haven't developed much since the infancy of the net. If the
13728 volume continues to rise with the current rate of increase, all current
13729 newsreaders will be pretty much useless. How do you deal with
13730 newsgroups that have thousands of new articles each day? How do you
13731 keep track of millions of people who post?
13733 Gnus offers no real solutions to these questions, but I would very much
13734 like to see Gnus being used as a testing ground for new methods of
13735 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
13736 to separate the newsreader from the backends, Gnus now offers a simple
13737 interface for anybody who wants to write new backends for fetching mail
13738 and news from different sources. I have added hooks for customizations
13739 everywhere I could imagine useful. By doing so, I'm inviting every one
13740 of you to explore and invent.
13742 May Gnus never be complete. @kbd{C-u 100 M-x hail-emacs}.
13745 @node Compatibility
13746 @subsection Compatibility
13748 @cindex compatibility
13749 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
13750 bindings have been kept. More key bindings have been added, of course,
13751 but only in one or two obscure cases have old bindings been changed.
13756 @center In a cloud bones of steel.
13760 All commands have kept their names. Some internal functions have changed
13763 The @code{gnus-uu} package has changed drastically. @pxref{Decoding
13766 One major compatibility question is the presence of several summary
13767 buffers. All variables that are relevant while reading a group are
13768 buffer-local to the summary buffer they belong in. Although many
13769 important variables have their values copied into their global
13770 counterparts whenever a command is executed in the summary buffer, this
13771 change might lead to incorrect values being used unless you are careful.
13773 All code that relies on knowledge of @sc{gnus} internals will probably
13774 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
13775 changing it in any way, as a matter of fact) is strictly verboten. Gnus
13776 maintains a hash table that points to the entries in this alist (which
13777 speeds up many functions), and changing the alist directly will lead to
13781 @cindex highlighting
13782 Old hilit19 code does not work at all. In fact, you should probably
13783 remove all hilit code from all Gnus hooks
13784 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
13785 Gnus provides various integrated functions for highlighting. These are
13786 faster and more accurate. To make life easier for everybody, Gnus will
13787 by default remove all hilit calls from all hilit hooks. Uncleanliness!
13790 Packages like @code{expire-kill} will no longer work. As a matter of
13791 fact, you should probably remove all old @sc{gnus} packages (and other
13792 code) when you start using Gnus. More likely than not, Gnus already
13793 does what you have written code to make @sc{gnus} do. (Snicker.)
13795 Even though old methods of doing things are still supported, only the
13796 new methods are documented in this manual. If you detect a new method of
13797 doing something while reading this manual, that does not mean you have
13798 to stop doing it the old way.
13800 Gnus understands all @sc{gnus} startup files.
13802 @kindex M-x gnus-bug
13804 @cindex reporting bugs
13806 Overall, a casual user who hasn't written much code that depends on
13807 @sc{gnus} internals should suffer no problems. If problems occur,
13808 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
13812 @subsection Conformity
13814 No rebels without a clue here, ma'am. We conform to all standards known
13815 to (wo)man. Except for those standards and/or conventions we disagree
13822 There are no known breaches of this standard.
13826 There are no known breaches of this standard, either.
13828 @item Good Net-Keeping Seal of Approval
13829 @cindex Good Net-Keeping Seal of Approval
13830 Gnus has been through the Seal process and failed. I think it'll pass
13831 the next inspection.
13833 @item Son-of-RFC 1036
13834 @cindex Son-of-RFC 1036
13835 We do have some breaches to this one.
13840 Gnus does no MIME handling, and this standard-to-be seems to think that
13841 MIME is the bees' knees, so we have major breakage here.
13844 This is considered to be a ``vanity header'', while I consider it to be
13845 consumer information. After seeing so many badly formatted articles
13846 coming from @code{tin} and @code{Netscape} I know not to use either of
13847 those for posting articles. I would not have known that if it wasn't
13848 for the @code{X-Newsreader} header.
13853 If you ever notice Gnus acting non-compliantly with regards to the texts
13854 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
13859 @subsection Emacsen
13865 Gnus should work on :
13870 Emacs 19.32 and up.
13873 XEmacs 19.14 and up.
13876 Mule versions based on Emacs 19.32 and up.
13880 Gnus will absolutely not work on any Emacsen older than that. Not
13881 reliably, at least.
13883 There are some vague differences between Gnus on the various
13884 platforms---XEmacs features more graphics (a logo and a toolbar)---but
13885 other than that, things should look pretty much the same under all
13890 @subsection Contributors
13891 @cindex contributors
13893 The new Gnus version couldn't have been done without the help of all the
13894 people on the (ding) mailing list. Every day for over a year I have
13895 gotten billions of nice bug reports from them, filling me with joy,
13896 every single one of them. Smooches. The people on the list have been
13897 tried beyond endurance, what with my ``oh, that's a neat idea <type
13898 type>, yup, I'll release it right away <ship off> no wait, that doesn't
13899 work at all <type type>, yup, I'll ship that one off right away <ship
13900 off> no, wait, that absolutely does not work'' policy for releases.
13901 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
13902 ``worser''? ``much worser''? ``worsest''?)
13904 I would like to take this opportunity to thank the Academy for... oops,
13910 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
13913 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
13914 well as numerous other things).
13917 Luis Fernandes---design and graphics.
13920 Erik Naggum---help, ideas, support, code and stuff.
13923 Wes Hardaker---@file{gnus-picon.el} and the manual section on
13924 @dfn{picons} (@pxref{Picons}).
13927 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
13928 (@pxref{GroupLens}).
13931 Sudish Joseph---innumerable bug fixes.
13934 Ilja Weis---@file{gnus-topic.el}.
13937 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
13940 Vladimir Alexiev---the refcard and reference booklets.
13943 Felix Lee & Jamie Zawinsky---I stole some pieces from the XGnus
13944 distribution by Felix Lee and JWZ.
13947 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
13950 Peter Mutsaers---orphan article scoring code.
13953 Ken Raeburn---POP mail support.
13956 Hallvard B Furuseth---various bits and pieces, especially dealing with
13960 Brian Edmonds---@file{gnus-bbdb.el}.
13963 David Moore---rewrite of @file{nnvirtual.el} and many other things.
13966 Ricardo Nassif, Mark Borges, and Jost Krieger---proof-reading.
13969 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
13972 François Pinard---many, many interesting and thorough bug reports.
13976 The following people have contributed many patches and suggestions:
13985 Jason L. Tibbitts, III,
13989 Also thanks to the following for patches and stuff:
14004 Massimo Campostrini,
14008 Geoffrey T. Dairiki,
14013 Michael Welsh Duggan,
14023 Hisashige Kenji, @c Hisashige
14026 François Felix Ingrand,
14027 Ishikawa Ichiro, @c Ishikawa
14035 Peter Skov Knudsen,
14036 Shuhei Kobayashi, @c Kobayashi
14037 Thor Kristoffersen,
14052 Morioka Tomohiko, @c Morioka
14053 Erik Toubro Nielsen,
14059 Masaharu Onishi, @c Onishi
14064 John McClary Prevost,
14072 Philippe Schnoebelen,
14073 Randal L. Schwartz,
14092 Katsumi Yamaoka. @c Yamaoka
14094 For a full overview of what each person has done, the ChangeLogs
14095 included in the Gnus alpha distributions should give ample reading
14096 (550kB and counting).
14098 Apologies to everybody that I've forgotten, of which there are many, I'm
14101 Gee, that's quite a list of people. I guess that must mean that there
14102 actually are people who are using Gnus. Who'd'a thunk it!
14106 @subsection New Features
14107 @cindex new features
14110 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
14111 * September Gnus:: The Thing Formally Known As Gnus 5.3/5.3.
14112 * Red Gnus:: Third time best---Gnus 5.4/5.5.
14115 These lists are, of course, just @emph{short} overviews of the
14116 @emph{most} important new features. No, really. There are tons more.
14117 Yes, we have feeping creaturism in full effect.
14121 @subsubsection (ding) Gnus
14123 New features in Gnus 5.0/5.1:
14128 The look of all buffers can be changed by setting format-like variables
14129 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
14132 Local spool and several @sc{nntp} servers can be used at once
14133 (@pxref{Select Methods}).
14136 You can combine groups into virtual groups (@pxref{Virtual Groups}).
14139 You can read a number of different mail formats (@pxref{Getting Mail}).
14140 All the mail backends implement a convenient mail expiry scheme
14141 (@pxref{Expiring Mail}).
14144 Gnus can use various strategies for gathering threads that have lost
14145 their roots (thereby gathering loose sub-threads into one thread) or it
14146 can go back and retrieve enough headers to build a complete thread
14147 (@pxref{Customizing Threading}).
14150 Killed groups can be displayed in the group buffer, and you can read
14151 them as well (@pxref{Listing Groups}).
14154 Gnus can do partial group updates---you do not have to retrieve the
14155 entire active file just to check for new articles in a few groups
14156 (@pxref{The Active File}).
14159 Gnus implements a sliding scale of subscribedness to groups
14160 (@pxref{Group Levels}).
14163 You can score articles according to any number of criteria
14164 (@pxref{Scoring}). You can even get Gnus to find out how to score
14165 articles for you (@pxref{Adaptive Scoring}).
14168 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
14169 manner, so it should be difficult to lose much data on what you have
14170 read if your machine should go down (@pxref{Auto Save}).
14173 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
14174 the @file{.emacs} file.
14177 You can set the process mark on both groups and articles and perform
14178 operations on all the marked items (@pxref{Process/Prefix}).
14181 You can grep through a subset of groups and create a group from the
14182 results (@pxref{Kibozed Groups}).
14185 You can list subsets of groups according to, well, anything
14186 (@pxref{Listing Groups}).
14189 You can browse foreign servers and subscribe to groups from those
14190 servers (@pxref{Browse Foreign Server}).
14193 Gnus can fetch articles asynchronously on a second connection to the
14194 server (@pxref{Asynchronous Fetching}).
14197 You can cache articles locally (@pxref{Article Caching}).
14200 The uudecode functions have been expanded and generalized
14201 (@pxref{Decoding Articles}).
14204 You can still post uuencoded articles, which was a little-known feature
14205 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
14208 Fetching parents (and other articles) now actually works without
14209 glitches (@pxref{Finding the Parent}).
14212 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
14215 Digests (and other files) can be used as the basis for groups
14216 (@pxref{Document Groups}).
14219 Articles can be highlighted and customized (@pxref{Customizing
14223 URLs and other external references can be buttonized (@pxref{Article
14227 You can do lots of strange stuff with the Gnus window & frame
14228 configuration (@pxref{Windows Configuration}).
14231 You can click on buttons instead of using the keyboard
14237 @node September Gnus
14238 @subsubsection September Gnus
14240 New features in Gnus 5.2/5.3:
14245 A new message composition mode is used. All old customization variables
14246 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
14250 Gnus is now able to generate @dfn{sparse} threads---threads where
14251 missing articles are represented by empty nodes (@pxref{Customizing
14255 (setq gnus-build-sparse-threads 'some)
14259 Outgoing articles are stored on a special archive server
14260 (@pxref{Archived Messages}).
14263 Partial thread regeneration now happens when articles are
14267 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
14270 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
14273 A @code{trn}-line tree buffer can be displayed (@pxref{Tree Display}).
14276 (setq gnus-use-trees t)
14280 An @code{nn}-like pick-and-read minor mode is available for the summary
14281 buffers (@pxref{Pick and Read}).
14284 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
14288 In binary groups you can use a special binary minor mode (@pxref{Binary
14292 Groups can be grouped in a folding topic hierarchy (@pxref{Group
14296 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
14300 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
14303 Groups can now have a score, and bubbling based on entry frequency
14304 is possible (@pxref{Group Score}).
14307 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
14311 Groups can be process-marked, and commands can be performed on
14312 groups of groups (@pxref{Marking Groups}).
14315 Caching is possible in virtual groups.
14318 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
14319 news batches, ClariNet briefs collections, and just about everything
14320 else (@pxref{Document Groups}).
14323 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
14327 The Gnus cache is much faster.
14330 Groups can be sorted according to many criteria (@pxref{Sorting
14334 New group parameters have been introduced to set list-address and
14335 expiry times (@pxref{Group Parameters}).
14338 All formatting specs allow specifying faces to be used
14339 (@pxref{Formatting Fonts}).
14342 There are several more commands for setting/removing/acting on process
14343 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
14346 The summary buffer can be limited to show parts of the available
14347 articles based on a wide range of criteria. These commands have been
14348 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
14351 Articles can be made persistent with the @kbd{*} command
14352 (@pxref{Persistent Articles}).
14355 All functions for hiding article elements are now toggles.
14358 Article headers can be buttonized (@pxref{Article Washing}).
14361 (add-hook 'gnus-article-display-hook
14362 'gnus-article-add-buttons-to-head)
14366 All mail backends support fetching articles by @code{Message-ID}.
14369 Duplicate mail can now be treated properly (@pxref{Duplicates}).
14372 All summary mode commands are available directly from the article
14373 buffer (@pxref{Article Keymap}).
14376 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
14380 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
14383 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
14386 (setq gnus-use-nocem t)
14390 Groups can be made permanently visible (@pxref{Listing Groups}).
14393 (setq gnus-permanently-visible-groups "^nnml:")
14397 Many new hooks have been introduced to make customizing easier.
14400 Gnus respects the @code{Mail-Copies-To} header.
14403 Threads can be gathered by looking at the @code{References} header
14404 (@pxref{Customizing Threading}).
14407 (setq gnus-summary-thread-gathering-function
14408 'gnus-gather-threads-by-references)
14412 Read articles can be stored in a special backlog buffer to avoid
14413 refetching (@pxref{Article Backlog}).
14416 (setq gnus-keep-backlog 50)
14420 A clean copy of the current article is always stored in a separate
14421 buffer to allow easier treatment.
14424 Gnus can suggest where to save articles (@pxref{Saving Articles}).
14427 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
14431 (setq gnus-prompt-before-saving t)
14435 @code{gnus-uu} can view decoded files asynchronously while fetching
14436 articles (@pxref{Other Decode Variables}).
14439 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
14443 Filling in the article buffer now works properly on cited text
14444 (@pxref{Article Washing}).
14447 Hiding cited text adds buttons to toggle hiding, and how much
14448 cited text to hide is now customizable (@pxref{Article Hiding}).
14451 (setq gnus-cited-lines-visible 2)
14455 Boring headers can be hidden (@pxref{Article Hiding}).
14458 (add-hook 'gnus-article-display-hook
14459 'gnus-article-hide-boring-headers t)
14463 Default scoring values can now be set from the menu bar.
14466 Further syntax checking of outgoing articles have been added.
14472 @subsubsection Red Gnus
14474 New features in Gnus 5.4/5.5:
14479 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
14482 Article prefetching functionality has been moved up into
14483 Gnus (@pxref{Asynchronous Fetching}).
14486 Scoring can now be performed with logical operators like @code{and},
14487 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
14491 Article washing status can be displayed in the
14492 article mode line (@pxref{Misc Article}).
14495 @file{gnus.el} has been split into many smaller files.
14498 Suppression of duplicate articles based on Message-ID can be done
14499 (@pxref{Duplicate Suppression}).
14502 (setq gnus-suppress-duplicates t)
14506 New variables for specifying what score and adapt files are to be
14507 considered home score and adapt files (@pxref{Home Score File}).
14510 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
14511 Server Internals}).
14514 Groups can inherit group parameters from parent topics (@pxref{Topic
14518 Article editing has been revamped and is now actually usable.
14521 Signatures can be recognized in more intelligent fashions
14522 (@pxref{Article Signature}).
14525 Summary pick mode has been made to look more @code{nn}-like. Line
14526 numbers are displayed and the @kbd{.} command can be used to pick
14527 articles (@code{Pick and Read}).
14530 Commands for moving the @file{.newsrc.eld} from one server to
14531 another have been added (@pxref{Changing Servers}).
14534 A way to specify that ``uninteresting'' fields be suppressed when
14535 generating lines in buffers (@pxref{Advanced Formatting}).
14538 Several commands in the group buffer can be undone with @kbd{M-C-_}
14542 Scoring can be done on words using the new score type @code{w}
14543 (@pxref{Score File Format}).
14546 Adaptive scoring can be done on a Subject word-by-word basis
14547 (@pxref{Adaptive Scoring}).
14550 (setq gnus-use-adaptive-scoring '(word))
14554 Scores can be decayed (@pxref{Score Decays}).
14557 (setq gnus-decay-scores t)
14561 Scoring can be performed using a regexp on the Date header. The Date is
14562 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
14565 A new command has been added to remove all data on articles from
14566 the native server (@pxref{Changing Servers}).
14569 A new command for reading collections of documents
14570 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
14571 (@pxref{Really Various Summary Commands}).
14574 Process mark sets can be pushed and popped (@pxref{Setting Process
14578 A new mail-to-news backend makes it possible to post even when the NNTP
14579 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
14582 A new backend for reading searches from Web search engines
14583 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
14584 (@pxref{Web Searches}).
14587 Groups inside topics can now be sorted using the standard sorting
14588 functions, and each topic can be sorted independently (@pxref{Topic
14592 Subsets of the groups can be sorted independently (@code{Sorting
14596 Cached articles can be pulled into the groups (@pxref{Summary Generation
14600 Score files are now applied in a more reliable order (@pxref{Score
14604 Reports on where mail messages end up can be generated (@pxref{Splitting
14608 More hooks and functions have been added to remove junk from incoming
14609 mail before saving the mail (@pxref{Washing Mail}).
14612 Emphasized text can be properly fontisized:
14615 (add-hook 'gnus-article-display-hook 'gnus-article-emphasize)
14621 @node Newest Features
14622 @subsection Newest Features
14625 Also known as the @dfn{todo list}. Sure to be implemented before the
14628 Be afraid. Be very afraid.
14632 Native @sc{mime} support is something that should be done.
14634 Really do unbinhexing.
14637 And much, much, much more. There is more to come than has already been
14638 implemented. (But that's always true, isn't it?)
14640 @file{<URL:http://www.ifi.uio.no/~larsi/rgnus/todo>} is where the actual
14641 up-to-the-second todo list is located, so if you're really curious, you
14642 could point your Web browser over that-a-way.
14647 @section The Manual
14651 This manual was generated from a TeXinfo file and then run through
14652 either @code{texi2dvi}
14654 or my own home-brewed TeXinfo to \LaTeX\ transformer,
14655 and then run through @code{latex} and @code{dvips}
14657 to get what you hold in your hands now.
14659 The following conventions have been used:
14664 This is a @samp{string}
14667 This is a @kbd{keystroke}
14670 This is a @file{file}
14673 This is a @code{symbol}
14677 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
14681 (setq flargnoze "yes")
14684 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
14687 (setq flumphel 'yes)
14690 @samp{yes} and @code{yes} are two @emph{very} different things---don't
14691 ever get them confused.
14695 Of course, everything in this manual is of vital interest, so you should
14696 read it all. Several times. However, if you feel like skimming the
14697 manual, look for that gnu head you should see in the margin over
14698 there---it means that what's being discussed is of more importance than
14699 the rest of the stuff. (On the other hand, if everything is infinitely
14700 important, how can anything be more important than that? Just one more
14701 of the mysteries of this world, I guess.)
14708 @section Terminology
14710 @cindex terminology
14715 This is what you are supposed to use this thing for---reading news.
14716 News is generally fetched from a nearby @sc{nntp} server, and is
14717 generally publicly available to everybody. If you post news, the entire
14718 world is likely to read just what you have written, and they'll all
14719 snigger mischievously. Behind your back.
14723 Everything that's delivered to you personally is mail. Some news/mail
14724 readers (like Gnus) blur the distinction between mail and news, but
14725 there is a difference. Mail is private. News is public. Mailing is
14726 not posting, and replying is not following up.
14730 Send a mail to the person who has written what you are reading.
14734 Post an article to the current newsgroup responding to the article you
14739 Gnus gets fed articles from a number of backends, both news and mail
14740 backends. Gnus does not handle the underlying media, so to speak---this
14741 is all done by the backends.
14745 Gnus will always use one method (and backend) as the @dfn{native}, or
14746 default, way of getting news.
14750 You can also have any number of foreign groups active at the same time.
14751 These are groups that use different backends for getting news.
14755 Secondary backends are somewhere half-way between being native and being
14756 foreign, but they mostly act like they are native.
14760 A message that has been posted as news.
14763 @cindex mail message
14764 A message that has been mailed.
14768 A mail message or news article
14772 The top part of a message, where administrative information (etc.) is
14777 The rest of an article. Everything that is not in the head is in the
14782 A line from the head of an article.
14786 A collection of such lines, or a collection of heads. Or even a
14787 collection of @sc{nov} lines.
14791 When Gnus enters a group, it asks the backend for the headers of all
14792 unread articles in the group. Most servers support the News OverView
14793 format, which is more compact and much faster to read and parse than the
14794 normal @sc{head} format.
14798 Each group is subscribed at some @dfn{level} or other (1-9). The ones
14799 that have a lower level are ``more'' subscribed than the groups with a
14800 higher level. In fact, groups on levels 1-5 are considered
14801 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
14802 are @dfn{killed}. Commands for listing groups and scanning for new
14803 articles will all use the numeric prefix as @dfn{working level}.
14805 @item killed groups
14806 @cindex killed groups
14807 No information on killed groups is stored or updated, which makes killed
14808 groups much easier to handle than subscribed groups.
14810 @item zombie groups
14811 @cindex zombie groups
14812 Just like killed groups, only slightly less dead.
14815 @cindex active file
14816 The news server has to keep track of what articles it carries, and what
14817 groups exist. All this information in stored in the active file, which
14818 is rather large, as you might surmise.
14821 @cindex bogus groups
14822 A group that exists in the @file{.newsrc} file, but isn't known to the
14823 server (i.e., it isn't in the active file), is a @emph{bogus group}.
14824 This means that the group probably doesn't exist (any more).
14828 A machine than one can connect to and get news (or mail) from.
14830 @item select method
14831 @cindex select method
14832 A structure that specifies the backend, the server and the virtual
14835 @item virtual server
14836 @cindex virtual server
14837 A named select method. Since a select methods defines all there is to
14838 know about connecting to a (physical) server, taking the things as a
14839 whole is a virtual server.
14843 Taking a buffer and running it through a filter of some sort. The
14844 result will (more often than not) be cleaner and more pleasing than the
14847 @item ephemeral groups
14848 @cindex ephemeral groups
14849 Most groups store data on what articles you have read. @dfn{Ephemeral}
14850 groups are groups that will have no data stored---when you exit the
14851 group, it'll disappear into the aether.
14854 @cindex solid groups
14855 This is the opposite of ephemeral groups. All groups listed in the
14856 group buffer are solid groups.
14858 @item sparse articles
14859 @cindex sparse articles
14860 These are article placeholders shown in the summary buffer when
14861 @code{gnus-build-sparse-threads} has been switched on.
14866 @node Customization
14867 @section Customization
14868 @cindex general customization
14870 All variables are properly documented elsewhere in this manual. This
14871 section is designed to give general pointers on how to customize Gnus
14872 for some quite common situations.
14875 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
14876 * Slow Terminal Connection:: You run a remote Emacs.
14877 * Little Disk Space:: You feel that having large setup files is icky.
14878 * Slow Machine:: You feel like buying a faster machine.
14882 @node Slow/Expensive Connection
14883 @subsection Slow/Expensive @sc{nntp} Connection
14885 If you run Emacs on a machine locally, and get your news from a machine
14886 over some very thin strings, you want to cut down on the amount of data
14887 Gnus has to get from the @sc{nntp} server.
14891 @item gnus-read-active-file
14892 Set this to @code{nil}, which will inhibit Gnus from requesting the
14893 entire active file from the server. This file is often v. large. You
14894 also have to set @code{gnus-check-new-newsgroups} and
14895 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
14896 doesn't suddenly decide to fetch the active file anyway.
14898 @item gnus-nov-is-evil
14899 This one has to be @code{nil}. If not, grabbing article headers from
14900 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
14901 support @sc{xover}; Gnus will detect this by itself.
14905 @node Slow Terminal Connection
14906 @subsection Slow Terminal Connection
14908 Let's say you use your home computer for dialing up the system that
14909 runs Emacs and Gnus. If your modem is slow, you want to reduce the
14910 amount of data that is sent over the wires as much as possible.
14914 @item gnus-auto-center-summary
14915 Set this to @code{nil} to inhibit Gnus from re-centering the summary
14916 buffer all the time. If it is @code{vertical}, do only vertical
14917 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
14918 horizontal and vertical recentering.
14920 @item gnus-visible-headers
14921 Cut down on the headers that are included in the articles to the
14922 minimum. You can, in fact, make do without them altogether---most of the
14923 useful data is in the summary buffer, anyway. Set this variable to
14924 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
14926 @item gnus-article-display-hook
14927 Set this hook to all the available hiding commands:
14929 (setq gnus-article-display-hook
14930 '(gnus-article-hide-headers gnus-article-hide-signature
14931 gnus-article-hide-citation))
14934 @item gnus-use-full-window
14935 By setting this to @code{nil}, you can make all the windows smaller.
14936 While this doesn't really cut down much generally, it means that you
14937 have to see smaller portions of articles before deciding that you didn't
14938 want to read them anyway.
14940 @item gnus-thread-hide-subtree
14941 If this is non-@code{nil}, all threads in the summary buffer will be
14944 @item gnus-updated-mode-lines
14945 If this is @code{nil}, Gnus will not put information in the buffer mode
14946 lines, which might save some time.
14950 @node Little Disk Space
14951 @subsection Little Disk Space
14954 The startup files can get rather large, so you may want to cut their
14955 sizes a bit if you are running out of space.
14959 @item gnus-save-newsrc-file
14960 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
14961 only save @file{.newsrc.eld}. This means that you will not be able to
14962 use any other newsreaders than Gnus. This variable is @code{t} by
14965 @item gnus-save-killed-list
14966 If this is @code{nil}, Gnus will not save the list of dead groups. You
14967 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
14968 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
14969 variable to @code{nil}. This variable is @code{t} by default.
14975 @subsection Slow Machine
14976 @cindex slow machine
14978 If you have a slow machine, or are just really impatient, there are a
14979 few things you can do to make Gnus run faster.
14981 Set@code{gnus-check-new-newsgroups} and
14982 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
14984 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
14985 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
14986 summary buffer faster.
14988 Set @code{gnus-article-display-hook} to @code{nil} to make article
14989 processing a bit faster.
14992 @node Troubleshooting
14993 @section Troubleshooting
14994 @cindex troubleshooting
14996 Gnus works @emph{so} well straight out of the box---I can't imagine any
15004 Make sure your computer is switched on.
15007 Make sure that you really load the current Gnus version. If you have
15008 been running @sc{gnus}, you need to exit Emacs and start it up again before
15012 Try doing an @kbd{M-x gnus-version}. If you get something that looks
15013 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded. If,
15014 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
15015 flee}, you have some old @file{.el} files lying around. Delete these.
15018 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
15022 @vindex max-lisp-eval-depth
15023 Gnus works on many recursive structures, and in some extreme (and very
15024 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
15025 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
15026 something like that.
15029 If all else fails, report the problem as a bug.
15032 @cindex reporting bugs
15034 @kindex M-x gnus-bug
15036 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
15037 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
15038 me the backtrace. I will fix bugs, but I can only fix them if you send
15039 me a precise description as to how to reproduce the bug.
15041 You really can never be too detailed in a bug report. Always use the
15042 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
15043 a 10Kb mail each time you use it, and even if you have sent me your
15044 environment 500 times before. I don't care. I want the full info each
15047 It is also important to remember that I have no memory whatsoever. If
15048 you send a bug report, and I send you a reply, and then you send back
15049 just ``No, it's not! Moron!'', I will have no idea what you are
15050 insulting me about. Always over-explain everything. It's much easier
15051 for all of us---if I don't have all the information I need, I will just
15052 mail you and ask for more info, and everything takes more time.
15054 If the problem you're seeing is very visual, and you can't quite explain
15055 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
15056 it somewhere it can be reached, and include the URL of the picture in
15059 If you just need help, you are better off asking on
15060 @samp{gnu.emacs.gnus}. I'm not very helpful.
15062 @cindex gnu.emacs.gnus
15063 @cindex ding mailing list
15064 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
15065 Write to @samp{ding-request@@gnus.org} to subscribe.
15068 @node A Programmers Guide to Gnus
15069 @section A Programmer@'s Guide to Gnus
15071 It is my hope that other people will figure out smart stuff that Gnus
15072 can do, and that other people will write those smart things as well. To
15073 facilitate that I thought it would be a good idea to describe the inner
15074 workings of Gnus. And some of the not-so-inner workings, while I'm at
15077 You can never expect the internals of a program not to change, but I
15078 will be defining (in some details) the interface between Gnus and its
15079 backends (this is written in stone), the format of the score files
15080 (ditto), data structures (some are less likely to change than others)
15081 and general method of operations.
15084 * Gnus Utility Functions:: Common functions and variable to use.
15085 * Backend Interface:: How Gnus communicates with the servers.
15086 * Score File Syntax:: A BNF definition of the score file standard.
15087 * Headers:: How Gnus stores headers internally.
15088 * Ranges:: A handy format for storing mucho numbers.
15089 * Group Info:: The group info format.
15090 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
15091 * Various File Formats:: Formats of files that Gnus use.
15095 @node Gnus Utility Functions
15096 @subsection Gnus Utility Functions
15097 @cindex Gnus utility functions
15098 @cindex utility functions
15100 @cindex internal variables
15102 When writing small functions to be run from hooks (and stuff), it's
15103 vital to have access to the Gnus internal functions and variables.
15104 Below is a list of the most common ones.
15108 @item gnus-newsgroup-name
15109 @vindex gnus-newsgroup-name
15110 This variable holds the name of the current newsgroup.
15112 @item gnus-find-method-for-group
15113 @findex gnus-find-method-for-group
15114 A function that returns the select method for @var{group}.
15116 @item gnus-group-real-name
15117 @findex gnus-group-real-name
15118 Takes a full (prefixed) Gnus group name, and returns the unprefixed
15121 @item gnus-group-prefixed-name
15122 @findex gnus-group-prefixed-name
15123 Takes an unprefixed group name and a select method, and returns the full
15124 (prefixed) Gnus group name.
15126 @item gnus-get-info
15127 @findex gnus-get-info
15128 Return the group info list for @var{group}.
15130 @item gnus-add-current-to-buffer-list
15131 @findex gnus-add-current-to-buffer-list
15132 Add the current buffer to the list of buffers to be killed on Gnus
15135 @item gnus-continuum-version
15136 @findex gnus-continuum-version
15137 Take a Gnus version string as a parameter and returns a floating point
15138 number. Earlier versions will always get a lower number than later
15141 @item gnus-group-read-only-p
15142 @findex gnus-group-read-only-p
15143 Say whether @var{group} is read-only or not.
15145 @item gnus-news-group-p
15146 @findex gnus-news-group-p
15147 Say whether @var{group} came from a news backend.
15149 @item gnus-ephemeral-group-p
15150 @findex gnus-ephemeral-group-p
15151 Say whether @var{group} is ephemeral or not.
15153 @item gnus-server-to-method
15154 @findex gnus-server-to-method
15155 Return the select method corresponding to @var{server}.
15157 @item gnus-server-equal
15158 @findex gnus-server-equal
15159 Say whether two virtual servers are equal.
15161 @item gnus-group-native-p
15162 @findex gnus-group-native-p
15163 Say whether @var{group} is native or not.
15165 @item gnus-group-secondary-p
15166 @findex gnus-group-secondary-p
15167 Say whether @var{group} is secondary or not.
15169 @item gnus-group-foreign-p
15170 @findex gnus-group-foreign-p
15171 Say whether @var{group} is foreign or not.
15173 @item group-group-find-parameter
15174 @findex group-group-find-parameter
15175 Return the parameter list of @var{group}. If given a second parameter,
15176 return the value of that parameter for @var{group}.
15178 @item gnus-group-set-parameter
15179 @findex gnus-group-set-parameter
15180 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
15182 @item gnus-narrow-to-body
15183 @findex gnus-narrow-to-body
15184 Narrow the current buffer to the body of the article.
15186 @item gnus-check-backend-function
15187 @findex gnus-check-backend-function
15188 Takes two parameters, @var{function} and @var{group}. If the backend
15189 @var{group} comes from supports @var{function}, return non-@code{nil}.
15192 (gnus-check-backend-function "request-scan" "nnml:misc")
15196 @item gnus-read-method
15197 @findex gnus-read-method
15198 Prompt the user for a select method.
15203 @node Backend Interface
15204 @subsection Backend Interface
15206 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
15207 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
15208 server is a @dfn{backend} and some @dfn{backend variables}. As examples
15209 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
15210 examples of the latter we have @code{nntp-port-number} and
15211 @code{nnmbox-directory}.
15213 When Gnus asks for information from a backend---say @code{nntp}---on
15214 something, it will normally include a virtual server name in the
15215 function parameters. (If not, the backend should use the ``current''
15216 virtual server.) For instance, @code{nntp-request-list} takes a virtual
15217 server as its only (optional) parameter. If this virtual server hasn't
15218 been opened, the function should fail.
15220 Note that a virtual server name has no relation to some physical server
15221 name. Take this example:
15225 (nntp-address "ifi.uio.no")
15226 (nntp-port-number 4324))
15229 Here the virtual server name is @samp{odd-one} while the name of
15230 the physical server is @samp{ifi.uio.no}.
15232 The backends should be able to switch between several virtual servers.
15233 The standard backends implement this by keeping an alist of virtual
15234 server environments that it pulls down/pushes up when needed.
15236 There are two groups of interface functions: @dfn{required functions},
15237 which must be present, and @dfn{optional functions}, which Gnus will
15238 always check whether are present before attempting to call.
15240 All these functions are expected to return data in the buffer
15241 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
15242 unfortunately named, but we'll have to live with it. When I talk about
15243 @dfn{resulting data}, I always refer to the data in that buffer. When I
15244 talk about @dfn{return value}, I talk about the function value returned by
15245 the function call. Functions that fail should return @code{nil} as the
15248 Some backends could be said to be @dfn{server-forming} backends, and
15249 some might be said to not be. The latter are backends that generally
15250 only operate on one group at a time, and have no concept of ``server''
15251 -- they have a group, and they deliver info on that group and nothing
15254 In the examples and definitions I will refer to the imaginary backend
15257 @cindex @code{nnchoke}
15260 * Required Backend Functions:: Functions that must be implemented.
15261 * Optional Backend Functions:: Functions that need not be implemented.
15262 * Error Messaging:: How to get messages and report errors.
15263 * Writing New Backends:: Extending old backends.
15264 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
15265 * Mail-like Backends:: Some tips on mail backends.
15269 @node Required Backend Functions
15270 @subsubsection Required Backend Functions
15274 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
15276 @var{articles} is either a range of article numbers or a list of
15277 @code{Message-ID}s. Current backends do not fully support either---only
15278 sequences (lists) of article numbers, and most backends do not support
15279 retrieval of @code{Message-ID}s. But they should try for both.
15281 The result data should either be HEADs or NOV lines, and the result
15282 value should either be @code{headers} or @code{nov} to reflect this.
15283 This might later be expanded to @code{various}, which will be a mixture
15284 of HEADs and NOV lines, but this is currently not supported by Gnus.
15286 If @var{fetch-old} is non-@code{nil} it says to try to fetch "extra
15287 headers, in some meaning of the word. This is generally done by
15288 fetching (at most) @var{fetch-old} extra headers less than the smallest
15289 article number in @code{articles}, and fill in the gaps as well. The
15290 presence of this parameter can be ignored if the backend finds it
15291 cumbersome to follow the request. If this is non-@code{nil} and not a
15292 number, do maximum fetches.
15294 Here's an example HEAD:
15297 221 1056 Article retrieved.
15298 Path: ifi.uio.no!sturles
15299 From: sturles@@ifi.uio.no (Sturle Sunde)
15300 Newsgroups: ifi.discussion
15301 Subject: Re: Something very droll
15302 Date: 27 Oct 1994 14:02:57 +0100
15303 Organization: Dept. of Informatics, University of Oslo, Norway
15305 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
15306 References: <38jdmq$4qu@@visbur.ifi.uio.no>
15307 NNTP-Posting-Host: holmenkollen.ifi.uio.no
15311 So a @code{headers} return value would imply that there's a number of
15312 these in the data buffer.
15314 Here's a BNF definition of such a buffer:
15318 head = error / valid-head
15319 error-message = [ "4" / "5" ] 2number " " <error message> eol
15320 valid-head = valid-message *header "." eol
15321 valid-message = "221 " <number> " Article retrieved." eol
15322 header = <text> eol
15325 If the return value is @code{nov}, the data buffer should contain
15326 @dfn{network overview database} lines. These are basically fields
15330 nov-buffer = *nov-line
15331 nov-line = 8*9 [ field <TAB> ] eol
15332 field = <text except TAB>
15335 For a closer explanation what should be in those fields,
15339 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
15341 @var{server} is here the virtual server name. @var{definitions} is a
15342 list of @code{(VARIABLE VALUE)} pairs that defines this virtual server.
15344 If the server can't be opened, no error should be signaled. The backend
15345 may then choose to refuse further attempts at connecting to this
15346 server. In fact, it should do so.
15348 If the server is opened already, this function should return a
15349 non-@code{nil} value. There should be no data returned.
15352 @item (nnchoke-close-server &optional SERVER)
15354 Close connection to @var{server} and free all resources connected
15355 to it. Return @code{nil} if the server couldn't be closed for some
15358 There should be no data returned.
15361 @item (nnchoke-request-close)
15363 Close connection to all servers and free all resources that the backend
15364 have reserved. All buffers that have been created by that backend
15365 should be killed. (Not the @code{nntp-server-buffer}, though.) This
15366 function is generally only called when Gnus is shutting down.
15368 There should be no data returned.
15371 @item (nnchoke-server-opened &optional SERVER)
15373 If @var{server} is the current virtual server, and the connection to the
15374 physical server is alive, then this function should return a
15375 non-@code{nil} vlue. This function should under no circumstances
15376 attempt to reconnect to a server that is has lost connection to.
15378 There should be no data returned.
15381 @item (nnchoke-status-message &optional SERVER)
15383 This function should return the last error message from @var{server}.
15385 There should be no data returned.
15388 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
15390 The result data from this function should be the article specified by
15391 @var{article}. This might either be a @code{Message-ID} or a number.
15392 It is optional whether to implement retrieval by @code{Message-ID}, but
15393 it would be nice if that were possible.
15395 If @var{to-buffer} is non-@code{nil}, the result data should be returned
15396 in this buffer instead of the normal data buffer. This is to make it
15397 possible to avoid copying large amounts of data from one buffer to
15398 another, and Gnus mainly request articles to be inserted directly into
15399 its article buffer.
15401 If it is at all possible, this function should return a cons cell where
15402 the car is the group name the article was fetched from, and the cdr is
15403 the article number. This will enable Gnus to find out what the real
15404 group and article numbers are when fetching articles by
15405 @code{Message-ID}. If this isn't possible, @code{t} should be returned
15406 on successful article retrievement.
15409 @item (nnchoke-request-group GROUP &optional SERVER FAST)
15411 Get data on @var{group}. This function also has the side effect of
15412 making @var{group} the current group.
15414 If @var{FAST}, don't bother to return useful data, just make @var{group}
15417 Here's an example of some result data and a definition of the same:
15420 211 56 1000 1059 ifi.discussion
15423 The first number is the status, which should be 211. Next is the
15424 total number of articles in the group, the lowest article number, the
15425 highest article number, and finally the group name. Note that the total
15426 number of articles may be less than one might think while just
15427 considering the highest and lowest article numbers, but some articles
15428 may have been canceled. Gnus just discards the total-number, so
15429 whether one should take the bother to generate it properly (if that is a
15430 problem) is left as an exercise to the reader.
15433 group-status = [ error / info ] eol
15434 error = [ "4" / "5" ] 2<number> " " <Error message>
15435 info = "211 " 3* [ <number> " " ] <string>
15439 @item (nnchoke-close-group GROUP &optional SERVER)
15441 Close @var{group} and free any resources connected to it. This will be
15442 a no-op on most backends.
15444 There should be no data returned.
15447 @item (nnchoke-request-list &optional SERVER)
15449 Return a list of all groups available on @var{server}. And that means
15452 Here's an example from a server that only carries two groups:
15455 ifi.test 0000002200 0000002000 y
15456 ifi.discussion 3324 3300 n
15459 On each line we have a group name, then the highest article number in
15460 that group, the lowest article number, and finally a flag.
15463 active-file = *active-line
15464 active-line = name " " <number> " " <number> " " flags eol
15466 flags = "n" / "y" / "m" / "x" / "j" / "=" name
15469 The flag says whether the group is read-only (@samp{n}), is moderated
15470 (@samp{m}), is dead (@samp{x}), is aliased to some other group
15471 (@samp{=other-group} or none of the above (@samp{y}).
15474 @item (nnchoke-request-post &optional SERVER)
15476 This function should post the current buffer. It might return whether
15477 the posting was successful or not, but that's not required. If, for
15478 instance, the posting is done asynchronously, it has generally not been
15479 completed by the time this function concludes. In that case, this
15480 function should set up some kind of sentinel to beep the user loud and
15481 clear if the posting could not be completed.
15483 There should be no result data from this function.
15488 @node Optional Backend Functions
15489 @subsubsection Optional Backend Functions
15493 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
15495 @var{groups} is a list of groups, and this function should request data
15496 on all those groups. How it does it is of no concern to Gnus, but it
15497 should attempt to do this in a speedy fashion.
15499 The return value of this function can be either @code{active} or
15500 @code{group}, which says what the format of the result data is. The
15501 former is in the same format as the data from
15502 @code{nnchoke-request-list}, while the latter is a buffer full of lines
15503 in the same format as @code{nnchoke-request-group} gives.
15506 group-buffer = *active-line / *group-status
15510 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
15512 A Gnus group info (@pxref{Group Info}) is handed to the backend for
15513 alterations. This comes in handy if the backend really carries all the
15514 information (as is the case with virtual and imap groups). This
15515 function should destructively alter the info to suit its needs, and
15516 should return the (altered) group info.
15518 There should be no result data from this function.
15521 @item (nnchoke-request-type GROUP &optional ARTICLE)
15523 When the user issues commands for ``sending news'' (@kbd{F} in the
15524 summary buffer, for instance), Gnus has to know whether the article the
15525 user is following up is news or mail. This function should return
15526 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
15527 is mail and @code{unknown} if the type can't be decided. (The
15528 @var{article} parameter is necessary in @code{nnvirtual} groups which
15529 might very well combine mail groups and news groups.) Both @var{group}
15530 and @var{article} may be @code{nil}.
15532 There should be no result data from this function.
15535 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
15537 If the user tries to set a mark that the backend doesn't like, this
15538 function may change the mark. Gnus will use whatever this function
15539 returns as the mark for @var{article} instead of the original
15540 @var{mark}. If the backend doesn't care, it must return the original
15541 @var{mark}, and not @code{nil} or any other type of garbage.
15543 The only use for this that I can see is what @code{nnvirtual} does with
15544 it---if a component group is auto-expirable, marking an article as read
15545 in the virtual group should result in the article being marked as
15548 There should be no result data from this function.
15551 @item (nnchoke-request-scan &optional GROUP SERVER)
15553 This function may be called at any time (by Gnus or anything else) to
15554 request that the backend check for incoming articles, in one way or
15555 another. A mail backend will typically read the spool file or query the
15556 POP server when this function is invoked. The @var{group} doesn't have
15557 to be heeded---if the backend decides that it is too much work just
15558 scanning for a single group, it may do a total scan of all groups. It
15559 would be nice, however, to keep things local if that's practical.
15561 There should be no result data from this function.
15564 @item (nnchoke-request-group-description GROUP &optional SERVER)
15566 The result data from this function should be a description of
15570 description-line = name <TAB> description eol
15572 description = <text>
15575 @item (nnchoke-request-list-newsgroups &optional SERVER)
15577 The result data from this function should be the description of all
15578 groups available on the server.
15581 description-buffer = *description-line
15585 @item (nnchoke-request-newgroups DATE &optional SERVER)
15587 The result data from this function should be all groups that were
15588 created after @samp{date}, which is in normal human-readable date
15589 format. The data should be in the active buffer format.
15592 @item (nnchoke-request-create-group GROUP &optional SERVER)
15594 This function should create an empty group with name @var{group}.
15596 There should be no return data.
15599 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
15601 This function should run the expiry process on all articles in the
15602 @var{articles} range (which is currently a simple list of article
15603 numbers.) It is left up to the backend to decide how old articles
15604 should be before they are removed by this function. If @var{force} is
15605 non-@code{nil}, all @var{articles} should be deleted, no matter how new
15608 This function should return a list of articles that it did not/was not
15611 There should be no result data returned.
15614 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
15617 This function should move @var{article} (which is a number) from
15618 @var{group} by calling @var{accept-form}.
15620 This function should ready the article in question for moving by
15621 removing any header lines it has added to the article, and generally
15622 should ``tidy up'' the article. Then it should @code{eval}
15623 @var{accept-form} in the buffer where the ``tidy'' article is. This
15624 will do the actual copying. If this @code{eval} returns a
15625 non-@code{nil} value, the article should be removed.
15627 If @var{last} is @code{nil}, that means that there is a high likelihood
15628 that there will be more requests issued shortly, so that allows some
15631 The function should return a cons where the car is the group name and
15632 the cdr is the article number that the article was entered as.
15634 There should be no data returned.
15637 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
15639 This function takes the current buffer and inserts it into @var{group}.
15640 If @var{last} in @code{nil}, that means that there will be more calls to
15641 this function in short order.
15643 The function should return a cons where the car is the group name and
15644 the cdr is the article number that the article was entered as.
15646 There should be no data returned.
15649 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
15651 This function should remove @var{article} (which is a number) from
15652 @var{group} and insert @var{buffer} there instead.
15654 There should be no data returned.
15657 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
15659 This function should delete @var{group}. If @var{force}, it should
15660 really delete all the articles in the group, and then delete the group
15661 itself. (If there is such a thing as ``the group itself''.)
15663 There should be no data returned.
15666 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
15668 This function should rename @var{group} into @var{new-name}. All
15669 articles that are in @var{group} should move to @var{new-name}.
15671 There should be no data returned.
15676 @node Error Messaging
15677 @subsubsection Error Messaging
15679 @findex nnheader-report
15680 @findex nnheader-get-report
15681 The backends should use the function @code{nnheader-report} to report
15682 error conditions---they should not raise errors when they aren't able to
15683 perform a request. The first argument to this function is the backend
15684 symbol, and the rest are interpreted as arguments to @code{format} if
15685 there are many of them, or just a string if there is one of them.
15686 This function always returns @code{nil}.
15689 (nnheader-report 'nnchoke "You did something totally bogus")
15691 (nnheader-report 'nnchoke "Could not request group %s" group)
15694 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
15695 @code{nil} back from a server, and this function returns the most
15696 recently reported message for the backend in question. This function
15697 takes one argument---the server symbol.
15699 Internally, these function access @var{backend}@code{-status-string}, so
15700 the @code{nnchoke} backend will have its error message stored in
15701 @code{nnchoke-status-string}.
15704 @node Writing New Backends
15705 @subsubsection Writing New Backends
15707 Many backends are quite similar. @code{nnml} is just like
15708 @code{nnspool}, but it allows you to edit the articles on the server.
15709 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
15710 and it doesn't maintain overview databases. @code{nndir} is just like
15711 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
15714 It would make sense if it were possible to ``inherit'' functions from
15715 backends when writing new backends. And, indeed, you can do that if you
15716 want to. (You don't have to if you don't want to, of course.)
15718 All the backends declare their public variables and functions by using a
15719 package called @code{nnoo}.
15721 To inherit functions from other backends (and allow other backends to
15722 inherit functions from the current backend), you should use the
15729 This macro declares the first parameter to be a child of the subsequent
15730 parameters. For instance:
15733 (nnoo-declare nndir
15737 @code{nndir} has here declared that it intends to inherit functions from
15738 both @code{nnml} and @code{nnmh}.
15741 This macro is equivalent to @code{defvar}, but registers the variable as
15742 a public server variable. Most state-oriented variables should be
15743 declared with @code{defvoo} instead of @code{defvar}.
15745 In addition to the normal @code{defvar} parameters, it takes a list of
15746 variables in the parent backends to map the variable to when executing
15747 a function in those backends.
15750 (defvoo nndir-directory nil
15751 "Where nndir will look for groups."
15752 nnml-current-directory nnmh-current-directory)
15755 This means that @code{nnml-current-directory} will be set to
15756 @code{nndir-directory} when an @code{nnml} function is called on behalf
15757 of @code{nndir}. (The same with @code{nnmh}.)
15759 @item nnoo-define-basics
15760 This macro defines some common functions that almost all backends should
15764 (nnoo-define-basics nndir)
15768 This macro is just like @code{defun} and takes the same parameters. In
15769 addition to doing the normal @code{defun} things, it registers the
15770 function as being public so that other backends can inherit it.
15772 @item nnoo-map-functions
15773 This macro allows mapping of functions from the current backend to
15774 functions from the parent backends.
15777 (nnoo-map-functions nndir
15778 (nnml-retrieve-headers 0 nndir-current-group 0 0)
15779 (nnmh-request-article 0 nndir-current-group 0 0))
15782 This means that when @code{nndir-retrieve-headers} is called, the first,
15783 third, and fourth parameters will be passed on to
15784 @code{nnml-retrieve-headers}, while the second parameter is set to the
15785 value of @code{nndir-current-group}.
15788 This macro allows importing functions from backends. It should be the
15789 last thing in the source file, since it will only define functions that
15790 haven't already been defined.
15796 nnmh-request-newgroups)
15800 This means that calls to @code{nndir-request-list} should just be passed
15801 on to @code{nnmh-request-list}, while all public functions from
15802 @code{nnml} that haven't been defined in @code{nndir} yet should be
15807 Below is a slightly shortened version of the @code{nndir} backend.
15810 ;;; nndir.el --- single directory newsgroup access for Gnus
15811 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
15815 (require 'nnheader)
15819 (eval-when-compile (require 'cl))
15821 (nnoo-declare nndir
15824 (defvoo nndir-directory nil
15825 "Where nndir will look for groups."
15826 nnml-current-directory nnmh-current-directory)
15828 (defvoo nndir-nov-is-evil nil
15829 "*Non-nil means that nndir will never retrieve NOV headers."
15832 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
15833 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
15834 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
15836 (defvoo nndir-status-string "" nil nnmh-status-string)
15837 (defconst nndir-version "nndir 1.0")
15839 ;;; Interface functions.
15841 (nnoo-define-basics nndir)
15843 (deffoo nndir-open-server (server &optional defs)
15844 (setq nndir-directory
15845 (or (cadr (assq 'nndir-directory defs))
15847 (unless (assq 'nndir-directory defs)
15848 (push `(nndir-directory ,server) defs))
15849 (push `(nndir-current-group
15850 ,(file-name-nondirectory (directory-file-name nndir-directory)))
15852 (push `(nndir-top-directory
15853 ,(file-name-directory (directory-file-name nndir-directory)))
15855 (nnoo-change-server 'nndir server defs))
15857 (nnoo-map-functions nndir
15858 (nnml-retrieve-headers 0 nndir-current-group 0 0)
15859 (nnmh-request-article 0 nndir-current-group 0 0)
15860 (nnmh-request-group nndir-current-group 0 0)
15861 (nnmh-close-group nndir-current-group 0))
15865 nnmh-status-message
15867 nnmh-request-newgroups))
15873 @node Hooking New Backends Into Gnus
15874 @subsubsection Hooking New Backends Into Gnus
15876 @vindex gnus-valid-select-methods
15877 Having Gnus start using your new backend is rather easy---you just
15878 declare it with the @code{gnus-declare-backend} functions. This will
15879 enter the backend into the @code{gnus-valid-select-methods} variable.
15881 @code{gnus-declare-backend} takes two parameters---the backend name and
15882 an arbitrary number of @dfn{abilities}.
15887 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
15890 The abilities can be:
15894 This is a mailish backend---followups should (probably) go via mail.
15896 This is a newsish backend---followups should (probably) go via news.
15898 This backend supports both mail and news.
15900 This is neither a post or mail backend---it's something completely
15903 It supports respooling---or rather, it is able to modify its source
15904 articles and groups.
15906 The name of the server should be in the virtual server name. This is
15907 true for almost all backends.
15908 @item prompt-address
15909 The user should be prompted for an address when doing commands like
15910 @kbd{B} in the group buffer. This is true for backends like
15911 @code{nntp}, but not @code{nnmbox}, for instance.
15915 @node Mail-like Backends
15916 @subsubsection Mail-like Backends
15918 One of the things that separate the mail backends from the rest of the
15919 backends is the heavy dependence by the mail backends on common
15920 functions in @file{nnmail.el}. For instance, here's the definition of
15921 @code{nnml-request-scan}:
15924 (deffoo nnml-request-scan (&optional group server)
15925 (setq nnml-article-file-alist nil)
15926 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
15929 It simply just calls @code{nnmail-get-new-mail} will a few parameters,
15930 and @code{nnmail} takes care of all the moving and splitting of the
15933 This function takes four parameters.
15937 This should be a symbol to designate which backend is responsible for
15940 @item exit-function
15941 This function should be called after the splitting has been performed.
15943 @item temp-directory
15944 Where the temporary files should be stored.
15947 This optional argument should be a group name if the splitting is to be
15948 performed for one group only.
15951 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
15952 save each article. @var{backend}@code{-active-number} will be called to
15953 find the article number assigned to this article.
15955 The function also uses the following variables:
15956 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
15957 this backend); and @var{backend}@code{-group-alist} and
15958 @var{backend}@code{-active-file} to generate the new active file.
15959 @var{backend}@code{-group-alist} should be a group-active alist, like
15963 (("a-group" (1 . 10))
15964 ("some-group" (34 . 39)))
15968 @node Score File Syntax
15969 @subsection Score File Syntax
15971 Score files are meant to be easily parsable, but yet extremely
15972 mallable. It was decided that something that had the same read syntax
15973 as an Emacs Lisp list would fit that spec.
15975 Here's a typical score file:
15979 ("win95" -10000 nil s)
15986 BNF definition of a score file:
15989 score-file = "" / "(" *element ")"
15990 element = rule / atom
15991 rule = string-rule / number-rule / date-rule
15992 string-rule = "(" quote string-header quote space *string-match ")"
15993 number-rule = "(" quote number-header quote space *number-match ")"
15994 date-rule = "(" quote date-header quote space *date-match ")"
15996 string-header = "subject" / "from" / "references" / "message-id" /
15997 "xref" / "body" / "head" / "all" / "followup"
15998 number-header = "lines" / "chars"
15999 date-header = "date"
16000 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
16001 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
16002 score = "nil" / <integer>
16003 date = "nil" / <natural number>
16004 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
16005 "r" / "regex" / "R" / "Regex" /
16006 "e" / "exact" / "E" / "Exact" /
16007 "f" / "fuzzy" / "F" / "Fuzzy"
16008 number-match = "(" <integer> [ "" / [ space score [ "" /
16009 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
16010 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
16011 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
16012 space date [ "" / [ space date-match-t ] ] ] ] ")"
16013 date-match-t = "nil" / "at" / "before" / "after"
16014 atom = "(" [ required-atom / optional-atom ] ")"
16015 required-atom = mark / expunge / mark-and-expunge / files /
16016 exclude-files / read-only / touched
16017 optional-atom = adapt / local / eval
16018 mark = "mark" space nil-or-number
16019 nil-or-number = "nil" / <integer>
16020 expunge = "expunge" space nil-or-number
16021 mark-and-expunge = "mark-and-expunge" space nil-or-number
16022 files = "files" *[ space <string> ]
16023 exclude-files = "exclude-files" *[ space <string> ]
16024 read-only = "read-only" [ space "nil" / space "t" ]
16025 adapt = "adapt" [ space "nil" / space "t" / space adapt-rule ]
16026 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
16027 local = "local" *[ space "(" <string> space <form> ")" ]
16028 eval = "eval" space <form>
16029 space = *[ " " / <TAB> / <NEWLINE> ]
16032 Any unrecognized elements in a score file should be ignored, but not
16035 As you can see, white space is needed, but the type and amount of white
16036 space is irrelevant. This means that formatting of the score file is
16037 left up to the programmer---if it's simpler to just spew it all out on
16038 one looong line, then that's ok.
16040 The meaning of the various atoms are explained elsewhere in this
16045 @subsection Headers
16047 Gnus uses internally a format for storing article headers that
16048 corresponds to the @sc{nov} format in a mysterious fashion. One could
16049 almost suspect that the author looked at the @sc{nov} specification and
16050 just shamelessly @emph{stole} the entire thing, and one would be right.
16052 @dfn{Header} is a severely overloaded term. ``Header'' is used in
16053 RFC1036 to talk about lines in the head of an article (e.g.,
16054 @code{From}). It is used by many people as a synonym for
16055 ``head''---``the header and the body''. (That should be avoided, in my
16056 opinion.) And Gnus uses a format internally that it calls ``header'',
16057 which is what I'm talking about here. This is a 9-element vector,
16058 basically, with each header (ouch) having one slot.
16060 These slots are, in order: @code{number}, @code{subject}, @code{from},
16061 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
16062 @code{xref}. There are macros for accessing and setting these
16063 slots---they all have predictable names beginning with
16064 @code{mail-header-} and @code{mail-header-set-}, respectively.
16066 The @code{xref} slot is really a @code{misc} slot. Any extra info will
16073 @sc{gnus} introduced a concept that I found so useful that I've started
16074 using it a lot and have elaborated on it greatly.
16076 The question is simple: If you have a large amount of objects that are
16077 identified by numbers (say, articles, to take a @emph{wild} example)
16078 that you want to qualify as being ``included'', a normal sequence isn't
16079 very useful. (A 200,000 length sequence is a bit long-winded.)
16081 The solution is as simple as the question: You just collapse the
16085 (1 2 3 4 5 6 10 11 12)
16088 is transformed into
16091 ((1 . 6) (10 . 12))
16094 To avoid having those nasty @samp{(13 . 13)} elements to denote a
16095 lonesome object, a @samp{13} is a valid element:
16098 ((1 . 6) 7 (10 . 12))
16101 This means that comparing two ranges to find out whether they are equal
16102 is slightly tricky:
16105 ((1 . 5) 7 8 (10 . 12))
16111 ((1 . 5) (7 . 8) (10 . 12))
16114 are equal. In fact, any non-descending list is a range:
16120 is a perfectly valid range, although a pretty long-winded one. This is
16127 and is equal to the previous range.
16129 Here's a BNF definition of ranges. Of course, one must remember the
16130 semantic requirement that the numbers are non-descending. (Any number
16131 of repetition of the same number is allowed, but apt to disappear in
16135 range = simple-range / normal-range
16136 simple-range = "(" number " . " number ")"
16137 normal-range = "(" start-contents ")"
16138 contents = "" / simple-range *[ " " contents ] /
16139 number *[ " " contents ]
16142 Gnus currently uses ranges to keep track of read articles and article
16143 marks. I plan on implementing a number of range operators in C if The
16144 Powers That Be are willing to let me. (I haven't asked yet, because I
16145 need to do some more thinking on what operators I need to make life
16146 totally range-based without ever having to convert back to normal
16151 @subsection Group Info
16153 Gnus stores all permanent info on groups in a @dfn{group info} list.
16154 This list is from three to six elements (or more) long and exhaustively
16155 describes the group.
16157 Here are two example group infos; one is a very simple group while the
16158 second is a more complex one:
16161 ("no.group" 5 (1 . 54324))
16163 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
16164 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
16166 (auto-expire (to-address "ding@@gnus.org")))
16169 The first element is the @dfn{group name}---as Gnus knows the group,
16170 anyway. The second element is the @dfn{subscription level}, which
16171 normally is a small integer. The third element is a list of ranges of
16172 read articles. The fourth element is a list of lists of article marks
16173 of various kinds. The fifth element is the select method (or virtual
16174 server, if you like). The sixth element is a list of @dfn{group
16175 parameters}, which is what this section is about.
16177 Any of the last three elements may be missing if they are not required.
16178 In fact, the vast majority of groups will normally only have the first
16179 three elements, which saves quite a lot of cons cells.
16181 Here's a BNF definition of the group info format:
16184 info = "(" group space level space read
16185 [ "" / [ space marks-list [ "" / [ space method [ "" /
16186 space parameters ] ] ] ] ] ")"
16187 group = quote <string> quote
16188 level = <integer in the range of 1 to inf>
16190 marks-lists = nil / "(" *marks ")"
16191 marks = "(" <string> range ")"
16192 method = "(" <string> *elisp-forms ")"
16193 parameters = "(" *elisp-forms ")"
16196 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
16197 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
16200 If you have a Gnus info and want to access the elements, Gnus offers a
16201 series of macros for getting/setting these elements.
16204 @item gnus-info-group
16205 @itemx gnus-info-set-group
16206 @findex gnus-info-group
16207 @findex gnus-info-set-group
16208 Get/set the group name.
16210 @item gnus-info-rank
16211 @itemx gnus-info-set-rank
16212 @findex gnus-info-rank
16213 @findex gnus-info-set-rank
16214 Get/set the group rank.
16216 @item gnus-info-level
16217 @itemx gnus-info-set-level
16218 @findex gnus-info-level
16219 @findex gnus-info-set-level
16220 Get/set the group level.
16222 @item gnus-info-score
16223 @itemx gnus-info-set-score
16224 @findex gnus-info-score
16225 @findex gnus-info-set-score
16226 Get/set the group score.
16228 @item gnus-info-read
16229 @itemx gnus-info-set-read
16230 @findex gnus-info-read
16231 @findex gnus-info-set-read
16232 Get/set the ranges of read articles.
16234 @item gnus-info-marks
16235 @itemx gnus-info-set-marks
16236 @findex gnus-info-marks
16237 @findex gnus-info-set-marks
16238 Get/set the lists of ranges of marked articles.
16240 @item gnus-info-method
16241 @itemx gnus-info-set-method
16242 @findex gnus-info-method
16243 @findex gnus-info-set-method
16244 Get/set the group select method.
16246 @item gnus-info-params
16247 @itemx gnus-info-set-params
16248 @findex gnus-info-params
16249 @findex gnus-info-set-params
16250 Get/set the group parameters.
16253 All the getter functions take one parameter---the info list. The setter
16254 functions take two parameters---the info list and the new value.
16256 The last three elements in the group info aren't mandatory, so it may be
16257 necessary to extend the group info before setting the element. If this
16258 is necessary, you can just pass on a non-@code{nil} third parameter to
16259 the three final setter functions to have this happen automatically.
16262 @node Emacs/XEmacs Code
16263 @subsection Emacs/XEmacs Code
16267 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
16268 platforms must be the primary one. I chose Emacs. Not because I don't
16269 like XEmacs or Mule, but because it comes first alphabetically.
16271 This means that Gnus will byte-compile under Emacs with nary a warning,
16272 while XEmacs will pump out gigabytes of warnings while byte-compiling.
16273 As I use byte-compilation warnings to help me root out trivial errors in
16274 Gnus, that's very useful.
16276 I've also consistently used Emacs function interfaces, but have used
16277 Gnusey aliases for the functions. To take an example: Emacs defines a
16278 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
16279 function. I then define a function called @code{gnus-run-at-time} that
16280 takes the same parameters as the Emacs @code{run-at-time}. When running
16281 Gnus under Emacs, the former function is just an alias for the latter.
16282 However, when running under XEmacs, the former is an alias for the
16283 following function:
16286 (defun gnus-xmas-run-at-time (time repeat function &rest args)
16290 (,function ,@@args))
16294 This sort of thing has been done for bunches of functions. Gnus does
16295 not redefine any native Emacs functions while running under XEmacs---it
16296 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
16299 In the cases when the XEmacs function interface was obviously
16300 cleaner, I used it instead. For example @code{gnus-region-active-p}
16301 is an alias for @code{region-active-p} in XEmacs, whereas in Emacs
16304 Of course, I could have chosen XEmacs as my native platform and done
16305 mapping functions the other way around. But I didn't. The performance
16306 hit these indirections impose on Gnus under XEmacs should be slight.
16309 @node Various File Formats
16310 @subsection Various File Formats
16313 * Active File Format:: Information on articles and groups available.
16314 * Newsgroups File Format:: Group descriptions.
16318 @node Active File Format
16319 @subsubsection Active File Format
16321 The active file lists all groups that are available on the server in
16322 question. It also lists the highest and lowest current article numbers
16325 Here's an excerpt from a typical active file:
16328 soc.motss 296030 293865 y
16329 alt.binaries.pictures.fractals 3922 3913 n
16330 comp.sources.unix 1605 1593 m
16331 comp.binaries.ibm.pc 5097 5089 y
16332 no.general 1000 900 y
16335 Here's a pseudo-BNF definition of this file:
16338 active = *group-line
16339 group-line = group space high-number space low-number space flag <NEWLINE>
16340 group = <non-white-space string>
16342 high-number = <non-negative integer>
16343 low-number = <positive integer>
16344 flag = "y" / "n" / "m" / "j" / "x" / "=" group
16348 @node Newsgroups File Format
16349 @subsubsection Newsgroups File Format
16351 The newsgroups file lists groups along with their descriptions. Not all
16352 groups on the server have to be listed, and not all groups in the file
16353 have to exist on the server. The file is meant purely as information to
16356 The format is quite simple; a group name, a tab, and the description.
16357 Here's the definition:
16361 line = group tab description <NEWLINE>
16362 group = <non-white-space string>
16364 description = <string>
16368 @node Emacs for Heathens
16369 @section Emacs for Heathens
16371 Believe it or not, but some people who use Gnus haven't really used
16372 Emacs much before they embarked on their journey on the Gnus Love Boat.
16373 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
16374 region'', and ``set @code{gnus-flargblossen} to an alist where the key
16375 is a regexp that is used for matching on the group name'' are magical
16376 phrases with little or no meaning, then this appendix is for you. If
16377 you are already familiar with Emacs, just ignore this and go fondle your
16381 * Keystrokes:: Entering text and executing commands.
16382 * Emacs Lisp:: The built-in Emacs programming language.
16387 @subsection Keystrokes
16391 Q: What is an experienced Emacs user?
16394 A: A person who wishes that the terminal had pedals.
16397 Yes, when you use Emacs, you are apt to use the control key, the shift
16398 key and the meta key a lot. This is very annoying to some people
16399 (notably @code{vi}le users), and the rest of us just love the hell out
16400 of it. Just give up and submit. Emacs really does stand for
16401 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
16402 may have heard from other disreputable sources (like the Emacs author).
16404 The shift key is normally located near your pinky fingers, and are
16405 normally used to get capital letters and stuff. You probably use it all
16406 the time. The control key is normally marked ``CTRL'' or something like
16407 that. The meta key is, funnily enough, never marked as such on any
16408 keyboards. The one I'm currently at has a key that's marked ``Alt'',
16409 which is the meta key on this keyboard. It's usually located somewhere
16410 to the left hand side of the keyboard, usually on the bottom row.
16412 Now, us Emacs people doesn't say ``press the meta-control-m key'',
16413 because that's just too inconvenient. We say ``press the @kbd{M-C-m}
16414 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
16415 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
16416 down the control key, and hold it down while you press @kbd{k}''.
16417 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
16418 the control key and then press @kbd{k}''. Simple, ay?
16420 This is somewhat complicated by the fact that not all keyboards have a
16421 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
16422 means ``press escape, release escape, press @kbd{k}''. That's much more
16423 work than if you have a meta key, so if that's the case, I respectfully
16424 suggest you get a real keyboard with a meta key. You can't live without
16430 @subsection Emacs Lisp
16432 Emacs is the King of Editors because it's really a Lisp interpreter.
16433 Each and every key you tap runs some Emacs Lisp code snippet, and since
16434 Emacs Lisp is an interpreted language, that means that you can configure
16435 any key to run any arbitrary code. You just, like, do it.
16437 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
16438 functions. (These are byte-compiled for speed, but it's still
16439 interpreted.) If you decide that you don't like the way Gnus does
16440 certain things, it's trivial to have it do something a different way.
16441 (Well, at least if you know how to write Lisp code.) However, that's
16442 beyond the scope of this manual, so we are simply going to talk about
16443 some common constructs that you normally use in your @file{.emacs} file
16446 If you want to set the variable @code{gnus-florgbnize} to four (4), you
16447 write the following:
16450 (setq gnus-florgbnize 4)
16453 This function (really ``special form'') @code{setq} is the one that can
16454 set a variable to some value. This is really all you need to know. Now
16455 you can go and fill your @code{.emacs} file with lots of these to change
16458 If you have put that thing in your @code{.emacs} file, it will be read
16459 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
16460 start Emacs. If you want to change the variable right away, simply say
16461 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
16462 previous ``form'', which here is a simple @code{setq} statement.
16464 Go ahead---just try it, if you're located at your Emacs. After you
16465 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
16466 is the return value of the form you @code{eval}ed.
16470 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
16474 (setq gnus-read-active-file 'some)
16477 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
16478 @samp{nntp.ifi.uio.no}'', that means:
16481 (setq gnus-nntp-server "nntp.ifi.uio.no")
16484 So be careful not to mix up strings (the latter) with symbols (the
16485 former). The manual is unambiguous, but it can be confusing.
16488 @include gnus-faq.texi