1 \input texinfo @c -*-texinfo-*-
4 @settitle Semi-gnus 6.0.07 Manual
9 @c * Gnus: (gnus). The newsreader Gnus.
14 @setchapternewpage odd
18 \documentclass[twoside,a4paper,openright,11pt]{book}
19 \usepackage[latin1]{inputenc}
20 \usepackage{pagestyle}
28 \newcommand{\gnuschaptername}{}
29 \newcommand{\gnussectionname}{}
31 \newcommand{\gnusbackslash}{/}
33 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
34 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
36 \newcommand{\gnuskindex}[1]{\index{#1}}
37 \newcommand{\gnusindex}[1]{\index{#1}}
39 \newcommand{\gnustt}[1]{{\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}}
40 \newcommand{\gnuscode}[1]{\gnustt{#1}}
41 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}''}
42 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
43 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
44 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
45 \newcommand{\gnusdfn}[1]{\textit{#1}}
46 \newcommand{\gnusi}[1]{\textit{#1}}
47 \newcommand{\gnusstrong}[1]{\textbf{#1}}
48 \newcommand{\gnusemph}[1]{\textit{#1}}
49 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
50 \newcommand{\gnussc}[1]{\textsc{#1}}
51 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
52 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
54 \newcommand{\gnusbullet}{{${\bullet}$}}
55 \newcommand{\gnusdollar}{\$}
56 \newcommand{\gnusampersand}{\&}
57 \newcommand{\gnuspercent}{\%}
58 \newcommand{\gnushash}{\#}
59 \newcommand{\gnushat}{\symbol{"5E}}
60 \newcommand{\gnusunderline}{\symbol{"5F}}
61 \newcommand{\gnusnot}{$\neg$}
62 \newcommand{\gnustilde}{\symbol{"7E}}
63 \newcommand{\gnusless}{{$<$}}
64 \newcommand{\gnusgreater}{{$>$}}
65 \newcommand{\gnusbraceleft}{{$>$}}
66 \newcommand{\gnusbraceright}{{$>$}}
68 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
69 \newcommand{\gnusinteresting}{
70 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
73 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
75 \newcommand{\gnuspagechapter}[1]{
82 \newcommand{\gnuschapter}[2]{
84 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
86 \renewcommand{\gnussectionname}{}
87 \renewcommand{\gnuschaptername}{#2}
90 \begin{picture}(500,500)(0,0)
91 \put(480,350){\makebox(0,0)[tr]{#1}}
92 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
97 \newcommand{\gnusfigure}[3]{
99 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
106 \newcommand{\gnusicon}[1]{
107 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=tmp/#1-up.ps,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=tmp/#1-up.ps,height=1cm}}}
110 \newcommand{\gnuspicon}[1]{
111 \margindex{\epsfig{figure=#1,width=2cm}}
114 \newcommand{\gnusxface}[2]{
115 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
118 \newcommand{\gnussmiley}[2]{
119 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
122 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
124 \newcommand{\gnussection}[1]{
125 \renewcommand{\gnussectionname}{#1}
129 \newenvironment{codelist}%
134 \newenvironment{kbdlist}%
140 \newenvironment{dfnlist}%
145 \newenvironment{stronglist}%
150 \newenvironment{samplist}%
155 \newenvironment{varlist}%
160 \newenvironment{emphlist}%
165 \newlength\gnusheadtextwidth
166 \setlength{\gnusheadtextwidth}{\headtextwidth}
167 \addtolength{\gnusheadtextwidth}{1cm}
169 \newpagestyle{gnuspreamble}%
174 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
178 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
187 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
189 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
194 \newpagestyle{gnusindex}%
199 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
203 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
211 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
213 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
223 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
227 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
235 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
237 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
242 \pagenumbering{roman}
243 \pagestyle{gnuspreamble}
253 %\addtolength{\oddsidemargin}{-5cm}
254 %\addtolength{\evensidemargin}{-5cm}
256 \addtolength{\textheight}{2cm}
258 \gnustitle{\gnustitlename}\\
261 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
264 \gnusauthor{by Lars Magne Ingebrigtsen}
271 \thispagestyle{empty}
273 Copyright \copyright{} 1995,96,97 Free Software Foundation, Inc.
275 Permission is granted to make and distribute verbatim copies of
276 this manual provided the copyright notice and this permission notice
277 are preserved on all copies.
279 Permission is granted to copy and distribute modified versions of this
280 manual under the conditions for verbatim copying, provided that the
281 entire resulting derived work is distributed under the terms of a
282 permission notice identical to this one.
284 Permission is granted to copy and distribute translations of this manual
285 into another language, under the above conditions for modified versions.
294 This file documents gnus, the GNU Emacs newsreader.
296 Copyright (C) 1995,96 Free Software Foundation, Inc.
298 Permission is granted to make and distribute verbatim copies of
299 this manual provided the copyright notice and this permission notice
300 are preserved on all copies.
303 Permission is granted to process this file through Tex and print the
304 results, provided the printed document carries copying permission
305 notice identical to this one except for the removal of this paragraph
306 (this paragraph not being relevant to the printed manual).
309 Permission is granted to copy and distribute modified versions of this
310 manual under the conditions for verbatim copying, provided also that the
311 entire resulting derived work is distributed under the terms of a
312 permission notice identical to this one.
314 Permission is granted to copy and distribute translations of this manual
315 into another language, under the above conditions for modified versions.
321 @title Semi-gnus 6.0.07 Manual
323 @author by Lars Magne Ingebrigtsen
326 @vskip 0pt plus 1filll
327 Copyright @copyright{} 1995,96,97 Free Software Foundation, Inc.
329 Permission is granted to make and distribute verbatim copies of
330 this manual provided the copyright notice and this permission notice
331 are preserved on all copies.
333 Permission is granted to copy and distribute modified versions of this
334 manual under the conditions for verbatim copying, provided that the
335 entire resulting derived work is distributed under the terms of a
336 permission notice identical to this one.
338 Permission is granted to copy and distribute translations of this manual
339 into another language, under the above conditions for modified versions.
348 @top The gnus Newsreader
352 You can read news (and mail) from within Emacs by using gnus. The news
353 can be gotten by any nefarious means you can think of---@sc{nntp}, local
354 spool or your mbox file. All at the same time, if you want to push your
357 Semi-gnus provides MIME features based on SEMI API. So Semi-gnus
358 supports your right to read strange messages including big images or
359 other various kinds of formats. Semi-gnus also supports
360 internationalization/localization and multiscript features based on MULE
361 API. So Semi-gnus does not discriminate various language communities.
362 Oh, if you are a Klingon, please wait Unicode Next Generation.
364 This manual corresponds to Semi-gnus 6.0.07.
375 Gnus is the advanced, self-documenting, customizable, extensible
376 unreal-time newsreader for GNU Emacs.
378 Oops. That sounds oddly familiar, so let's start over again to avoid
379 being accused of plagiarism:
381 Gnus is a message-reading laboratory. It will let you look at just
382 about anything as if it were a newsgroup. You can read mail with it,
383 you can browse directories with it, you can @code{ftp} with it---you can
384 even read news with it!
386 Gnus tries to empower people who read news the same way Emacs empowers
387 people who edit text. Gnus sets no limits to what the user should be
388 allowed to do. Users are encouraged to extend gnus to make it behave
389 like they want it to behave. A program should not control people;
390 people should be empowered to do what they want by using (or abusing)
397 * Starting Up:: Finding news can be a pain.
398 * The Group Buffer:: Selecting, subscribing and killing groups.
399 * The Summary Buffer:: Reading, saving and posting articles.
400 * The Article Buffer:: Displaying and handling articles.
401 * Composing Messages:: Information on sending mail and news.
402 * Select Methods:: Gnus reads all messages from various select methods.
403 * Scoring:: Assigning values to articles.
404 * Various:: General purpose settings.
405 * The End:: Farewell and goodbye.
406 * Appendices:: Terminology, Emacs intro, FAQ, History, Internals.
407 * Index:: Variable, function and concept index.
408 * Key Index:: Key Index.
412 @chapter Starting gnus
417 If your system administrator has set things up properly, starting gnus
418 and reading news is extremely easy---you just type @kbd{M-x gnus} in
421 @findex gnus-other-frame
422 @kindex M-x gnus-other-frame
423 If you want to start gnus in a different frame, you can use the command
424 @kbd{M-x gnus-other-frame} instead.
426 If things do not go smoothly at startup, you have to twiddle some
427 variables in your @file{~/.gnus} file. This file is similar to
428 @file{~/.emacs}, but is read when gnus starts.
430 If you puzzle at any terms used in this manual, please refer to the
431 terminology section (@pxref{Terminology}).
434 * Finding the News:: Choosing a method for getting news.
435 * The First Time:: What does gnus do the first time you start it?
436 * The Server is Down:: How can I read my mail then?
437 * Slave Gnusae:: You can have more than one gnus active at a time.
438 * Fetching a Group:: Starting gnus just to read a group.
439 * New Groups:: What is gnus supposed to do with new groups?
440 * Startup Files:: Those pesky startup files---@file{.newsrc}.
441 * Auto Save:: Recovering from a crash.
442 * The Active File:: Reading the active file over a slow line Takes Time.
443 * Changing Servers:: You may want to move from one server to another.
444 * Startup Variables:: Other variables you might change.
448 @node Finding the News
449 @section Finding the News
452 @vindex gnus-select-method
454 The @code{gnus-select-method} variable says where gnus should look for
455 news. This variable should be a list where the first element says
456 @dfn{how} and the second element says @dfn{where}. This method is your
457 native method. All groups not fetched with this method are foreign
460 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
461 you want to get your daily dosage of news from, you'd say:
464 (setq gnus-select-method '(nntp "news.somewhere.edu"))
467 If you want to read directly from the local spool, say:
470 (setq gnus-select-method '(nnspool ""))
473 If you can use a local spool, you probably should, as it will almost
474 certainly be much faster.
476 @vindex gnus-nntpserver-file
478 @cindex @sc{nntp} server
479 If this variable is not set, gnus will take a look at the
480 @code{NNTPSERVER} environment variable. If that variable isn't set,
481 gnus will see whether @code{gnus-nntpserver-file}
482 (@file{/etc/nntpserver} by default) has any opinions on the matter. If
483 that fails as well, gnus will try to use the machine running Emacs as an
484 @sc{nntp} server. That's a long shot, though.
486 @vindex gnus-nntp-server
487 If @code{gnus-nntp-server} is set, this variable will override
488 @code{gnus-select-method}. You should therefore set
489 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
491 @vindex gnus-secondary-servers
492 You can also make gnus prompt you interactively for the name of an
493 @sc{nntp} server. If you give a non-numerical prefix to @code{gnus}
494 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
495 in the @code{gnus-secondary-servers} list (if any). You can also just
496 type in the name of any server you feel like visiting.
498 @findex gnus-group-browse-foreign-server
500 However, if you use one @sc{nntp} server regularly and are just
501 interested in a couple of groups from a different server, you would be
502 better served by using the @kbd{B} command in the group buffer. It will
503 let you have a look at what groups are available, and you can subscribe
504 to any of the groups you want to. This also makes @file{.newsrc}
505 maintenance much tidier. @xref{Foreign Groups}.
507 @vindex gnus-secondary-select-methods
509 A slightly different approach to foreign groups is to set the
510 @code{gnus-secondary-select-methods} variable. The select methods
511 listed in this variable are in many ways just as native as the
512 @code{gnus-select-method} server. They will also be queried for active
513 files during startup (if that's required), and new newsgroups that
514 appear on these servers will be subscribed (or not) just as native
517 For instance, if you use the @code{nnmbox} backend to read your mail, you
518 would typically set this variable to
521 (setq gnus-secondary-select-methods '((nnmbox "")))
526 @section The First Time
527 @cindex first time usage
529 If no startup files exist, gnus will try to determine what groups should
530 be subscribed by default.
532 @vindex gnus-default-subscribed-newsgroups
533 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
534 will subscribe you to just those groups in that list, leaving the rest
535 killed. Your system administrator should have set this variable to
538 Since she hasn't, gnus will just subscribe you to a few arbitrarily
539 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
540 here as @dfn{whatever Lars thinks you should read}.)
542 You'll also be subscribed to the gnus documentation group, which should
543 help you with most common problems.
545 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
546 use the normal functions for handling new groups, and not do anything
550 @node The Server is Down
551 @section The Server is Down
552 @cindex server errors
554 If the default server is down, gnus will understandably have some
555 problems starting. However, if you have some mail groups in addition to
556 the news groups, you may want to start gnus anyway.
558 Gnus, being the trusting sort of program, will ask whether to proceed
559 without a native select method if that server can't be contacted. This
560 will happen whether the server doesn't actually exist (i.e., you have
561 given the wrong address) or the server has just momentarily taken ill
562 for some reason or other. If you decide to continue and have no foreign
563 groups, you'll find it difficult to actually do anything in the group
564 buffer. But, hey, that's your problem. Blllrph!
566 @findex gnus-no-server
567 @kindex M-x gnus-no-server
569 If you know that the server is definitely down, or you just want to read
570 your mail without bothering with the server at all, you can use the
571 @code{gnus-no-server} command to start gnus. That might come in handy
572 if you're in a hurry as well. This command will not attempt to contact
573 your primary server---instead, it will just activate all groups on level
574 1 and 2. (You should preferably keep no native groups on those two
579 @section Slave Gnusae
582 You might want to run more than one Emacs with more than one gnus at the
583 same time. If you are using different @file{.newsrc} files (e.g., if
584 you are using the two different gnusae to read from two different
585 servers), that is no problem whatsoever. You just do it.
587 The problem appears when you want to run two Gnusae that use the same
590 To work around that problem some, we here at the Think-Tank at the gnus
591 Towers have come up with a new concept: @dfn{Masters} and @dfn{slaves}.
592 (We have applied for a patent on this concept, and have taken out a
593 copyright on those words. If you wish to use those words in conjunction
594 with each other, you have to send $1 per usage instance to me. Usage of
595 the patent (@dfn{Master/Slave Relationships In Computer Applications})
596 will be much more expensive, of course.)
598 Anyways, you start one gnus up the normal way with @kbd{M-x gnus} (or
599 however you do it). Each subsequent slave gnusae should be started with
600 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
601 files, but instead save @dfn{slave files} that contain information only
602 on what groups have been read in the slave session. When a master gnus
603 starts, it will read (and delete) these slave files, incorporating all
604 information from them. (The slave files will be read in the sequence
605 they were created, so the latest changes will have precedence.)
607 Information from the slave files has, of course, precedence over the
608 information in the normal (i.e., master) @code{.newsrc} file.
611 @node Fetching a Group
612 @section Fetching a Group
613 @cindex fetching a group
615 @findex gnus-fetch-group
616 It is sometimes convenient to be able to just say ``I want to read this
617 group and I don't care whether gnus has been started or not''. This is
618 perhaps more useful for people who write code than for users, but the
619 command @code{gnus-fetch-group} provides this functionality in any case.
620 It takes the group name as a parameter.
628 @vindex gnus-check-new-newsgroups
629 If you are satisfied that you really never want to see any new groups,
630 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
631 also save you some time at startup. Even if this variable is
632 @code{nil}, you can always subscribe to the new groups just by pressing
633 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
634 is @code{ask-server} by default. If you set this variable to
635 @code{always}, then gnus will query the backends for new groups even
636 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
639 * Checking New Groups:: Determining what groups are new.
640 * Subscription Methods:: What gnus should do with new groups.
641 * Filtering New Groups:: Making gnus ignore certain new groups.
645 @node Checking New Groups
646 @subsection Checking New Groups
648 Gnus normally determines whether a group is new or not by comparing the
649 list of groups from the active file(s) with the lists of subscribed and
650 dead groups. This isn't a particularly fast method. If
651 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
652 server for new groups since the last time. This is both faster and
653 cheaper. This also means that you can get rid of the list of killed
654 groups altogether, so you may set @code{gnus-save-killed-list} to
655 @code{nil}, which will save time both at startup, at exit, and all over.
656 Saves disk space, too. Why isn't this the default, then?
657 Unfortunately, not all servers support this command.
659 I bet I know what you're thinking now: How do I find out whether my
660 server supports @code{ask-server}? No? Good, because I don't have a
661 fail-safe answer. I would suggest just setting this variable to
662 @code{ask-server} and see whether any new groups appear within the next
663 few days. If any do, then it works. If none do, then it doesn't work.
664 I could write a function to make gnus guess whether the server supports
665 @code{ask-server}, but it would just be a guess. So I won't. You could
666 @code{telnet} to the server and say @code{HELP} and see whether it lists
667 @samp{NEWGROUPS} among the commands it understands. If it does, then it
668 might work. (But there are servers that lists @samp{NEWGROUPS} without
669 supporting the function properly.)
671 This variable can also be a list of select methods. If so, gnus will
672 issue an @code{ask-server} command to each of the select methods, and
673 subscribe them (or not) using the normal methods. This might be handy
674 if you are monitoring a few servers for new groups. A side effect is
675 that startup will take much longer, so you can meditate while waiting.
676 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
679 @node Subscription Methods
680 @subsection Subscription Methods
682 @vindex gnus-subscribe-newsgroup-method
683 What gnus does when it encounters a new group is determined by the
684 @code{gnus-subscribe-newsgroup-method} variable.
686 This variable should contain a function. This function will be called
687 with the name of the new group as the only parameter.
689 Some handy pre-fab functions are:
693 @item gnus-subscribe-zombies
694 @vindex gnus-subscribe-zombies
695 Make all new groups zombies. This is the default. You can browse the
696 zombies later (with @kbd{A z}) and either kill them all off properly
697 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
699 @item gnus-subscribe-randomly
700 @vindex gnus-subscribe-randomly
701 Subscribe all new groups in arbitrary order. This really means that all
702 new groups will be added at ``the top'' of the group buffer.
704 @item gnus-subscribe-alphabetically
705 @vindex gnus-subscribe-alphabetically
706 Subscribe all new groups in alphabetical order.
708 @item gnus-subscribe-hierarchically
709 @vindex gnus-subscribe-hierarchically
710 Subscribe all new groups hierarchically. The difference between this
711 function and @code{gnus-subscribe-alphabetically} is slight.
712 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
713 alphabetical fashion, while this function will enter groups into it's
714 hierarchy. So if you want to have the @samp{rec} hierarchy before the
715 @samp{comp} hierarchy, this function will not mess that configuration
716 up. Or something like that.
718 @item gnus-subscribe-interactively
719 @vindex gnus-subscribe-interactively
720 Subscribe new groups interactively. This means that gnus will ask you
721 about @strong{all} new groups. The groups you choose to subscribe to
722 will be subscribed hierarchically.
724 @item gnus-subscribe-killed
725 @vindex gnus-subscribe-killed
730 @vindex gnus-subscribe-hierarchical-interactive
731 A closely related variable is
732 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
733 mouthful.) If this variable is non-@code{nil}, gnus will ask you in a
734 hierarchical fashion whether to subscribe to new groups or not. Gnus
735 will ask you for each sub-hierarchy whether you want to descend the
738 One common mistake is to set the variable a few paragraphs above
739 (@code{gnus-subscribe-newsgroup-method}) to
740 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
741 will not work. This is ga-ga. So don't do it.
744 @node Filtering New Groups
745 @subsection Filtering New Groups
747 A nice and portable way to control which new newsgroups should be
748 subscribed (or ignored) is to put an @dfn{options} line at the start of
749 the @file{.newsrc} file. Here's an example:
752 options -n !alt.all !rec.all sci.all
755 @vindex gnus-subscribe-options-newsgroup-method
756 This line obviously belongs to a serious-minded intellectual scientific
757 person (or she may just be plain old boring), because it says that all
758 groups that have names beginning with @samp{alt} and @samp{rec} should
759 be ignored, and all groups with names beginning with @samp{sci} should
760 be subscribed. Gnus will not use the normal subscription method for
761 subscribing these groups.
762 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
763 variable defaults to @code{gnus-subscribe-alphabetically}.
765 @vindex gnus-options-not-subscribe
766 @vindex gnus-options-subscribe
767 If you don't want to mess with your @file{.newsrc} file, you can just
768 set the two variables @code{gnus-options-subscribe} and
769 @code{gnus-options-not-subscribe}. These two variables do exactly the
770 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
771 and if the new group matches the former, it will be unconditionally
772 subscribed, and if it matches the latter, it will be ignored.
774 @vindex gnus-auto-subscribed-groups
775 Yet another variable that meddles here is
776 @code{gnus-auto-subscribed-groups}. It works exactly like
777 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
778 thought it would be nice to have two of these. This variable is more
779 meant for setting some ground rules, while the other variable is used
780 more for user fiddling. By default this variable makes all new groups
781 that come from mail backends (@code{nnml}, @code{nnbabyl},
782 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you
783 don't like that, just set this variable to @code{nil}.
785 New groups that match this regexp are subscribed using
786 @code{gnus-subscribe-options-newsgroup-method}.
789 @node Changing Servers
790 @section Changing Servers
791 @cindex changing servers
793 Sometimes it is necessary to move from one @sc{nntp} server to another.
794 This happens very rarely, but perhaps you change jobs, or one server is
795 very flaky and you want to use another.
797 Changing the server is pretty easy, right? You just change
798 @code{gnus-select-method} to point to the new server?
802 Article numbers are not (in any way) kept synchronized between different
803 @sc{nntp} servers, and the only way Gnus keeps track of what articles
804 you have read is by keeping track of article numbers. So when you
805 change @code{gnus-select-method}, your @file{.newsrc} file becomes
808 Gnus provides a few functions to attempt to translate a @file{.newsrc}
809 file from one server to another. They all have one thing in
810 common---they take a looong time to run. You don't want to use these
811 functions more than absolutely necessary.
813 @kindex M-x gnus-change-server
814 @findex gnus-change-server
815 If you have access to both servers, Gnus can request the headers for all
816 the articles you have read and compare @code{Message-ID}s and map the
817 article numbers of the read articles and article marks. The @kbd{M-x
818 gnus-change-server} command will do this for all your native groups. It
819 will prompt for the method you want to move to.
821 @kindex M-x gnus-group-move-group-to-server
822 @findex gnus-group-move-group-to-server
823 You can also move individual groups with the @kbd{M-x
824 gnus-group-move-group-to-server} command. This is useful if you want to
825 move a (foreign) group from one server to another.
827 @kindex M-x gnus-group-clear-data-on-native-groups
828 @findex gnus-group-clear-data-on-native-groups
829 If you don't have access to both the old and new server, all your marks
830 and read ranges have become worthless. You can use the @kbd{M-x
831 gnus-group-clear-data-on-native-groups} command to clear out all data
832 that you have on your native groups. Use with caution.
836 @section Startup Files
837 @cindex startup files
842 Now, you all know about the @file{.newsrc} file. All subscription
843 information is traditionally stored in this file.
845 Things got a bit more complicated with @sc{GNUS}. In addition to
846 keeping the @file{.newsrc} file updated, it also used a file called
847 @file{.newsrc.el} for storing all the information that didn't fit into
848 the @file{.newsrc} file. (Actually, it also duplicated everything in
849 the @file{.newsrc} file.) @sc{GNUS} would read whichever one of these
850 files was the most recently saved, which enabled people to swap between
851 @sc{gnus} and other newsreaders.
853 That was kinda silly, so Gnus went one better: In addition to the
854 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
855 @file{.newsrc.eld}. It will read whichever of these files that are most
856 recent, but it will never write a @file{.newsrc.el} file. You should
857 never delete the @file{.newsrc.eld} file---it contains much information
858 not stored in the @file{.newsrc} file.
860 In addition, gnus does not change anything. Hail comrade Lars!
862 @vindex gnus-save-newsrc-file
863 You can turn off writing the @file{.newsrc} file by setting
864 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
865 the file and save some space, as well as exiting from gnus faster.
866 However, this will make it impossible to use other newsreaders than
867 gnus. But hey, who would want to, right?
869 @vindex gnus-save-killed-list
870 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
871 will not save the list of killed groups to the startup file. This will
872 save both time (when starting and quitting) and space (on disk). It
873 will also mean that Gnus has no record of what groups are new or old,
874 so the automatic new groups subscription methods become meaningless.
875 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
876 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
877 Groups}). This variable can also be a regular expression. If that's
878 the case, remove all groups that do not match this regexp before
879 saving. This can be useful in certain obscure situations that involve
880 several servers where not all servers support @code{ask-server}.
882 @vindex gnus-startup-file
883 The @code{gnus-startup-file} variable says where the startup files are.
884 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
885 file being whatever that one is, with a @samp{.eld} appended.
887 @vindex gnus-save-newsrc-hook
888 @vindex gnus-save-quick-newsrc-hook
889 @vindex gnus-save-standard-newsrc-hook
890 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
891 files, while @code{gnus-save-quick-newsrc-hook} is called just before
892 saving the @file{.newsrc.eld} file, and
893 @code{gnus-save-standard-newsrc-hook} is called just before saving the
894 @file{.newsrc} file. The latter two are commonly used to turn version
895 control on or off. Version control is on by default when saving the
896 startup files. If you want to turn backup creation off, say something like:
899 (defun turn-off-backup ()
900 (set (make-local-variable 'backup-inhibited) t))
902 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
903 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
906 @vindex gnus-init-file
907 When gnus starts, it will read the @code{gnus-site-init-file}
908 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
909 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
910 and can be used to avoid cluttering your @file{~/.emacs} and
911 @file{site-init} files with gnus stuff. Gnus will also check for files
912 with the same names as these, but with @file{.elc} and @file{.el}
913 suffixes. In other words, if you have set @code{gnus-init-file} to
914 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
915 and finally @file{~/.gnus} (in this order).
924 Whenever you do something that changes the gnus data (reading articles,
925 catching up, killing/subscribing groups), the change is added to a
926 special @dfn{dribble buffer}. This buffer is auto-saved the normal
927 Emacs way. If your Emacs should crash before you have saved the
928 @file{.newsrc} files, all changes you have made can be recovered from
931 If gnus detects this file at startup, it will ask the user whether to
932 read it. The auto save file is deleted whenever the real startup file
935 @vindex gnus-use-dribble-file
936 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
937 maintain a dribble buffer. The default is @code{t}.
939 @vindex gnus-dribble-directory
940 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
941 this variable is @code{nil}, which it is by default, gnus will dribble
942 into the directory where the @file{.newsrc} file is located. (This is
943 normally the user's home directory.) The dribble file will get the same
944 file permissions as the @code{.newsrc} file.
946 @vindex gnus-always-read-dribble-file
947 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
948 read the dribble file on startup without querying the user.
951 @node The Active File
952 @section The Active File
954 @cindex ignored groups
956 When gnus starts, or indeed whenever it tries to determine whether new
957 articles have arrived, it reads the active file. This is a very large
958 file that lists all the active groups and articles on the server.
960 @vindex gnus-ignored-newsgroups
961 Before examining the active file, gnus deletes all lines that match the
962 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
963 any groups with bogus names, but you can use this variable to make gnus
964 ignore hierarchies you aren't ever interested in. However, this is not
965 recommended. In fact, it's highly discouraged. Instead, @pxref{New
966 Groups} for an overview of other variables that can be used instead.
969 @c @code{nil} by default, and will slow down active file handling somewhat
970 @c if you set it to anything else.
972 @vindex gnus-read-active-file
974 The active file can be rather Huge, so if you have a slow network, you
975 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
976 reading the active file. This variable is @code{some} by default.
978 Gnus will try to make do by getting information just on the groups that
979 you actually subscribe to.
981 Note that if you subscribe to lots and lots of groups, setting this
982 variable to @code{nil} will probably make gnus slower, not faster. At
983 present, having this variable @code{nil} will slow gnus down
984 considerably, unless you read news over a 2400 baud modem.
986 This variable can also have the value @code{some}. Gnus will then
987 attempt to read active info only on the subscribed groups. On some
988 servers this is quite fast (on sparkling, brand new INN servers that
989 support the @code{LIST ACTIVE group} command), on others this isn't fast
990 at all. In any case, @code{some} should be faster than @code{nil}, and
991 is certainly faster than @code{t} over slow lines.
993 If this variable is @code{nil}, gnus will ask for group info in total
994 lock-step, which isn't very fast. If it is @code{some} and you use an
995 @sc{nntp} server, gnus will pump out commands as fast as it can, and
996 read all the replies in one swoop. This will normally result in better
997 performance, but if the server does not support the aforementioned
998 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1000 In any case, if you use @code{some} or @code{nil}, you should definitely
1001 kill all groups that you aren't interested in to speed things up.
1003 Note that this variable also affects active file retrieval from
1004 secondary select methods.
1007 @node Startup Variables
1008 @section Startup Variables
1012 @item gnus-load-hook
1013 @vindex gnus-load-hook
1014 A hook run while gnus is being loaded. Note that this hook will
1015 normally be run just once in each Emacs session, no matter how many
1016 times you start gnus.
1018 @item gnus-before-startup-hook
1019 @vindex gnus-before-startup-hook
1020 A hook run after starting up gnus successfully.
1022 @item gnus-startup-hook
1023 @vindex gnus-startup-hook
1024 A hook run as the very last thing after starting up gnus
1026 @item gnus-started-hook
1027 @vindex gnus-started-hook
1028 A hook that is run as the very last thing after starting up gnus
1031 @item gnus-started-hook
1032 @vindex gnus-started-hook
1033 A hook that is run after reading the @file{.newsrc} file(s), but before
1034 generating the group buffer.
1036 @item gnus-check-bogus-newsgroups
1037 @vindex gnus-check-bogus-newsgroups
1038 If non-@code{nil}, gnus will check for and delete all bogus groups at
1039 startup. A @dfn{bogus group} is a group that you have in your
1040 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1041 bogus groups can take quite a while, so to save time and resources it's
1042 best to leave this option off, and do the checking for bogus groups once
1043 in a while from the group buffer instead (@pxref{Group Maintenance}).
1045 @item gnus-inhibit-startup-message
1046 @vindex gnus-inhibit-startup-message
1047 If non-@code{nil}, the startup message won't be displayed. That way,
1048 your boss might not notice as easily that you are reading news instead
1049 of doing your job. Note that this variable is used before
1050 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1052 @item gnus-no-groups-message
1053 @vindex gnus-no-groups-message
1054 Message displayed by gnus when no groups are available.
1056 @item gnus-play-startup-jingle
1057 @vindex gnus-play-startup-jingle
1058 If non-@code{nil}, play the gnus jingle at startup.
1060 @item gnus-startup-jingle
1061 @vindex gnus-startup-jingle
1062 Jingle to be played if the above variable is non-@code{nil}. The
1063 default is @samp{Tuxedomoon.Jingle4.au}.
1068 @node The Group Buffer
1069 @chapter The Group Buffer
1070 @cindex group buffer
1072 The @dfn{group buffer} lists all (or parts) of the available groups. It
1073 is the first buffer shown when gnus starts, and will never be killed as
1074 long as gnus is active.
1078 \gnusfigure{The Group Buffer}{320}{
1079 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1080 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1081 \put(120,38){\vector(1,2){10}}
1082 \put(40,60){\makebox(0,0)[r]{Mode line}}
1083 \put(40,58){\vector(1,0){30}}
1084 \put(200,28){\makebox(0,0)[t]{Native select method}}
1085 \put(200,26){\vector(-1,2){15}}
1091 * Group Buffer Format:: Information listed and how you can change it.
1092 * Group Maneuvering:: Commands for moving in the group buffer.
1093 * Selecting a Group:: Actually reading news.
1094 * Group Data:: Changing the info for a group.
1095 * Subscription Commands:: Unsubscribing, killing, subscribing.
1096 * Group Levels:: Levels? What are those, then?
1097 * Group Score:: A mechanism for finding out what groups you like.
1098 * Marking Groups:: You can mark groups for later processing.
1099 * Foreign Groups:: Creating and editing groups.
1100 * Group Parameters:: Each group may have different parameters set.
1101 * Listing Groups:: Gnus can list various subsets of the groups.
1102 * Sorting Groups:: Re-arrange the group order.
1103 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1104 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1105 * Exiting Gnus:: Stop reading news and get some work done.
1106 * Group Topics:: A folding group mode divided into topics.
1107 * Misc Group Stuff:: Other stuff that you can to do.
1111 @node Group Buffer Format
1112 @section Group Buffer Format
1115 * Group Line Specification:: Deciding how the group buffer is to look.
1116 * Group Modeline Specification:: The group buffer modeline.
1117 * Group Highlighting:: Having nice colors in the group buffer.
1121 @node Group Line Specification
1122 @subsection Group Line Specification
1123 @cindex group buffer format
1125 The default format of the group buffer is nice and dull, but you can
1126 make it as exciting and ugly as you feel like.
1128 Here's a couple of example group lines:
1131 25: news.announce.newusers
1132 * 0: alt.fan.andrea-dworkin
1137 You can see that there are 25 unread articles in
1138 @samp{news.announce.newusers}. There are no unread articles, but some
1139 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1140 asterisk at the beginning of the line?).
1142 @vindex gnus-group-line-format
1143 You can change that format to whatever you want by fiddling with the
1144 @code{gnus-group-line-format} variable. This variable works along the
1145 lines of a @code{format} specification, which is pretty much the same as
1146 a @code{printf} specifications, for those of you who use (feh!) C.
1147 @xref{Formatting Variables}.
1149 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1151 There should always be a colon on the line; the cursor always moves to
1152 the colon after performing an operation. Nothing else is required---not
1153 even the group name. All displayed text is just window dressing, and is
1154 never examined by gnus. Gnus stores all real information it needs using
1157 (Note that if you make a really strange, wonderful, spreadsheet-like
1158 layout, everybody will believe you are hard at work with the accounting
1159 instead of wasting time reading news.)
1161 Here's a list of all available format characters:
1166 An asterisk if the group only has marked articles.
1169 Whether the group is subscribed.
1172 Level of subscribedness.
1175 Number of unread articles.
1178 Number of dormant articles.
1181 Number of ticked articles.
1184 Number of read articles.
1187 Estimated total number of articles. (This is really @var{max-number}
1188 minus @var{min-number} plus 1.)
1191 Number of unread, unticked, non-dormant articles.
1194 Number of ticked and dormant articles.
1203 Newsgroup description.
1206 @samp{m} if moderated.
1209 @samp{(m)} if moderated.
1218 A string that looks like @samp{<%s:%n>} if a foreign select method is
1222 Indentation based on the level of the topic (@pxref{Group Topics}).
1225 @vindex gnus-group-uncollapsed-levels
1226 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1227 variable says how many levels to leave at the end of the group name.
1228 The default is 1---this will mean that group names like
1229 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1232 @vindex gnus-new-mail-mark
1234 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1238 A string that says when you last read the group (@pxref{Group
1242 User defined specifier. The next character in the format string should
1243 be a letter. Gnus will call the function
1244 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1245 following @samp{%u}. The function will be passed a single dummy
1246 parameter as argument. The function should return a string, which will
1247 be inserted into the buffer just like information from any other
1252 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1253 if no info is available---for instance, if it is a non-activated foreign
1254 group, or a bogus native group.
1257 @node Group Modeline Specification
1258 @subsection Group Modeline Specification
1259 @cindex group modeline
1261 @vindex gnus-group-mode-line-format
1262 The mode line can be changed by setting
1263 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1264 doesn't understand that many format specifiers:
1268 The native news server.
1270 The native select method.
1274 @node Group Highlighting
1275 @subsection Group Highlighting
1276 @cindex highlighting
1277 @cindex group highlighting
1279 @vindex gnus-group-highlight
1280 Highlighting in the group buffer is controlled by the
1281 @code{gnus-group-highlight} variable. This is an alist with elements
1282 that look like @var{(form . face)}. If @var{form} evaluates to
1283 something non-@code{nil}, the @var{face} will be used on the line.
1285 Here's an example value for this variable that might look nice if the
1289 (face-spec-set 'my-group-face-1
1290 '((t (:foreground "Red" :bold t))))
1291 (face-spec-set 'my-group-face-2
1292 '((t (:foreground "SeaGreen" :bold t))))
1293 (face-spec-set 'my-group-face-3
1294 '((t (:foreground "SpringGreen" :bold t))))
1295 (face-spec-set 'my-group-face-4
1296 '((t (:foreground "SteelBlue" :bold t))))
1297 (face-spec-set 'my-group-face-5
1298 '((t (:foreground "SkyBlue" :bold t))))
1300 (setq gnus-group-highlight
1301 '(((> unread 200) . my-group-face-1)
1302 ((and (< level 3) (zerop unread)) . my-group-face-2)
1303 ((< level 3) . my-group-face-3)
1304 ((zerop unread) . my-group-face-4)
1305 (t . my-group-face-5)))
1308 Also @pxref{Faces and Fonts}.
1310 Variables that are dynamically bound when the forms are evaluated
1317 The number of unread articles in the group.
1321 Whether the group is a mail group.
1323 The level of the group.
1325 The score of the group.
1327 The number of ticked articles in the group.
1329 The total number of articles in the group. Or rather, MAX-NUMBER minus
1330 MIN-NUMBER plus one.
1332 When using the topic minor mode, this variable is bound to the current
1333 topic being inserted.
1336 When the forms are @code{eval}ed, point is at the beginning of the line
1337 of the group in question, so you can use many of the normal gnus
1338 functions for snarfing info on the group.
1340 @vindex gnus-group-update-hook
1341 @findex gnus-group-highlight-line
1342 @code{gnus-group-update-hook} is called when a group line is changed.
1343 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1344 calls @code{gnus-group-highlight-line} by default.
1347 @node Group Maneuvering
1348 @section Group Maneuvering
1349 @cindex group movement
1351 All movement commands understand the numeric prefix and will behave as
1352 expected, hopefully.
1358 @findex gnus-group-next-unread-group
1359 Go to the next group that has unread articles
1360 (@code{gnus-group-next-unread-group}).
1366 @findex gnus-group-prev-unread-group
1367 Go to the previous group that has unread articles
1368 (@code{gnus-group-prev-unread-group}).
1372 @findex gnus-group-next-group
1373 Go to the next group (@code{gnus-group-next-group}).
1377 @findex gnus-group-prev-group
1378 Go to the previous group (@code{gnus-group-prev-group}).
1382 @findex gnus-group-next-unread-group-same-level
1383 Go to the next unread group on the same (or lower) level
1384 (@code{gnus-group-next-unread-group-same-level}).
1388 @findex gnus-group-prev-unread-group-same-level
1389 Go to the previous unread group on the same (or lower) level
1390 (@code{gnus-group-prev-unread-group-same-level}).
1393 Three commands for jumping to groups:
1399 @findex gnus-group-jump-to-group
1400 Jump to a group (and make it visible if it isn't already)
1401 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
1406 @findex gnus-group-best-unread-group
1407 Jump to the unread group with the lowest level
1408 (@code{gnus-group-best-unread-group}).
1412 @findex gnus-group-first-unread-group
1413 Jump to the first group with unread articles
1414 (@code{gnus-group-first-unread-group}).
1417 @vindex gnus-group-goto-unread
1418 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1419 commands will move to the next group, not the next unread group. Even
1420 the commands that say they move to the next unread group. The default
1424 @node Selecting a Group
1425 @section Selecting a Group
1426 @cindex group selection
1431 @kindex SPACE (Group)
1432 @findex gnus-group-read-group
1433 Select the current group, switch to the summary buffer and display the
1434 first unread article (@code{gnus-group-read-group}). If there are no
1435 unread articles in the group, or if you give a non-numerical prefix to
1436 this command, gnus will offer to fetch all the old articles in this
1437 group from the server. If you give a numerical prefix @var{N}, @var{N}
1438 determines the number of articles gnus will fetch. If @var{N} is
1439 positive, gnus fetches the @var{N} newest articles, if @var{N} is
1440 negative, gnus fetches the @var{abs(N)} oldest articles.
1444 @findex gnus-group-select-group
1445 Select the current group and switch to the summary buffer
1446 (@code{gnus-group-select-group}). Takes the same arguments as
1447 @code{gnus-group-read-group}---the only difference is that this command
1448 does not display the first unread article automatically upon group
1452 @kindex M-RET (Group)
1453 @findex gnus-group-quick-select-group
1454 This does the same as the command above, but tries to do it with the
1455 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
1456 scoring/killing will be performed, there will be no highlights and no
1457 expunging. This might be useful if you're in a real hurry and have to
1458 enter some humongous group. If you give a 0 prefix to this command
1459 (i.e., @kbd{0 M-RET}), gnus won't even generate the summary buffer,
1460 which is useful if you want to toggle threading before generating the
1461 summary buffer (@pxref{Summary Generation Commands}).
1464 @kindex M-SPACE (Group)
1465 @findex gnus-group-visible-select-group
1466 This is yet one more command that does the same as the @kbd{RET}
1467 command, but this one does it without expunging and hiding dormants
1468 (@code{gnus-group-visible-select-group}).
1471 @kindex M-C-RET (Group)
1472 @findex gnus-group-select-group-ephemerally
1473 Finally, this command selects the current group ephemerally without
1474 doing any processing of its contents
1475 (@code{gnus-group-select-group-ephemerally}). Even threading has been
1476 turned off. Everything you do in the group after selecting it in this
1477 manner will have no permanent effects.
1481 @vindex gnus-large-newsgroup
1482 The @code{gnus-large-newsgroup} variable says what gnus should consider
1483 to be a big group. This is 200 by default. If the group has more
1484 (unread and/or ticked) articles than this, gnus will query the user
1485 before entering the group. The user can then specify how many articles
1486 should be fetched from the server. If the user specifies a negative
1487 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
1488 is positive, the @code{n} articles that have arrived most recently will
1491 @vindex gnus-select-group-hook
1492 @vindex gnus-auto-select-first
1493 @code{gnus-auto-select-first} control whether any articles are selected
1494 automatically when entering a group with the @kbd{SPACE} command.
1499 Don't select any articles when entering the group. Just display the
1500 full summary buffer.
1503 Select the first unread article when entering the group.
1506 Select the highest scored article in the group when entering the
1510 If you want to prevent automatic selection in some group (say, in a
1511 binary group with Huge articles) you can set this variable to @code{nil}
1512 in @code{gnus-select-group-hook}, which is called when a group is
1516 @node Subscription Commands
1517 @section Subscription Commands
1518 @cindex subscription
1526 @findex gnus-group-unsubscribe-current-group
1527 @c @icon{gnus-group-unsubscribe}
1528 Toggle subscription to the current group
1529 (@code{gnus-group-unsubscribe-current-group}).
1535 @findex gnus-group-unsubscribe-group
1536 Prompt for a group to subscribe, and then subscribe it. If it was
1537 subscribed already, unsubscribe it instead
1538 (@code{gnus-group-unsubscribe-group}).
1544 @findex gnus-group-kill-group
1545 @c @icon{gnus-group-kill-group}
1546 Kill the current group (@code{gnus-group-kill-group}).
1552 @findex gnus-group-yank-group
1553 Yank the last killed group (@code{gnus-group-yank-group}).
1556 @kindex C-x C-t (Group)
1557 @findex gnus-group-transpose-groups
1558 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
1559 really a subscription command, but you can use it instead of a
1560 kill-and-yank sequence sometimes.
1566 @findex gnus-group-kill-region
1567 Kill all groups in the region (@code{gnus-group-kill-region}).
1571 @findex gnus-group-kill-all-zombies
1572 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1575 @kindex S C-k (Group)
1576 @findex gnus-group-kill-level
1577 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1578 These groups can't be yanked back after killing, so this command should
1579 be used with some caution. The only time where this command comes in
1580 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1581 groups that you want to get rid off. @kbd{S C-k} on level 7 will
1582 kill off all unsubscribed groups that do not have message numbers in the
1583 @file{.newsrc} file.
1587 Also @pxref{Group Levels}.
1597 @findex gnus-group-catchup-current
1598 @vindex gnus-group-catchup-group-hook
1599 @c @icon{gnus-group-catchup-current}
1600 Mark all unticked articles in this group as read
1601 (@code{gnus-group-catchup-current}).
1602 @code{gnus-group-catchup-group-hook} is called when catching up a group
1603 from the group buffer.
1607 @findex gnus-group-catchup-current-all
1608 Mark all articles in this group, even the ticked ones, as read
1609 (@code{gnus-group-catchup-current-all}).
1613 @findex gnus-group-clear-data
1614 Clear the data from the current group---nix out marks and the list of
1615 read articles (@code{gnus-group-clear-data}).
1617 @item M-x gnus-group-clear-data-on-native-groups
1618 @kindex M-x gnus-group-clear-data-on-native-groups
1619 @findex gnus-group-clear-data-on-native-groups
1620 If you have switched from one @sc{nntp} server to another, all your marks
1621 and read ranges have become worthless. You can use this command to
1622 clear out all data that you have on your native groups. Use with
1629 @section Group Levels
1633 All groups have a level of @dfn{subscribedness}. For instance, if a
1634 group is on level 2, it is more subscribed than a group on level 5. You
1635 can ask gnus to just list groups on a given level or lower
1636 (@pxref{Listing Groups}), or to just check for new articles in groups on
1637 a given level or lower (@pxref{Scanning New Messages}).
1639 Remember: The higher the level of the group, the less important it is.
1645 @findex gnus-group-set-current-level
1646 Set the level of the current group. If a numeric prefix is given, the
1647 next @var{n} groups will have their levels set. The user will be
1648 prompted for a level.
1651 @vindex gnus-level-killed
1652 @vindex gnus-level-zombie
1653 @vindex gnus-level-unsubscribed
1654 @vindex gnus-level-subscribed
1655 Gnus considers groups from levels 1 to
1656 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1657 @code{gnus-level-subscribed} (exclusive) and
1658 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1659 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1660 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1661 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
1662 same, but zombie and killed groups have no information on what articles
1663 you have read, etc, stored. This distinction between dead and living
1664 groups isn't done because it is nice or clever, it is done purely for
1665 reasons of efficiency.
1667 It is recommended that you keep all your mail groups (if any) on quite
1668 low levels (e.g. 1 or 2).
1670 If you want to play with the level variables, you should show some care.
1671 Set them once, and don't touch them ever again. Better yet, don't touch
1672 them at all unless you know exactly what you're doing.
1674 @vindex gnus-level-default-unsubscribed
1675 @vindex gnus-level-default-subscribed
1676 Two closely related variables are @code{gnus-level-default-subscribed}
1677 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1678 which are the levels that new groups will be put on if they are
1679 (un)subscribed. These two variables should, of course, be inside the
1680 relevant valid ranges.
1682 @vindex gnus-keep-same-level
1683 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1684 will only move to groups of the same level (or lower). In
1685 particular, going from the last article in one group to the next group
1686 will go to the next group of the same level (or lower). This might be
1687 handy if you want to read the most important groups before you read the
1690 @vindex gnus-group-default-list-level
1691 All groups with a level less than or equal to
1692 @code{gnus-group-default-list-level} will be listed in the group buffer
1695 @vindex gnus-group-list-inactive-groups
1696 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1697 groups will be listed along with the unread groups. This variable is
1698 @code{t} by default. If it is @code{nil}, inactive groups won't be
1701 @vindex gnus-group-use-permanent-levels
1702 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1703 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1704 use this level as the ``work'' level.
1706 @vindex gnus-activate-level
1707 Gnus will normally just activate (i. e., query the server about) groups
1708 on level @code{gnus-activate-level} or less. If you don't want to
1709 activate unsubscribed groups, for instance, you might set this variable
1710 to 5. The default is 6.
1714 @section Group Score
1719 You would normally keep important groups on high levels, but that scheme
1720 is somewhat restrictive. Don't you wish you could have Gnus sort the
1721 group buffer according to how often you read groups, perhaps? Within
1724 This is what @dfn{group score} is for. You can assign a score to each
1725 group. You can then sort the group buffer based on this score.
1726 Alternatively, you can sort on score and then level. (Taken together,
1727 the level and the score is called the @dfn{rank} of the group. A group
1728 that is on level 4 and has a score of 1 has a higher rank than a group
1729 on level 5 that has a score of 300. (The level is the most significant
1730 part and the score is the least significant part.))
1732 @findex gnus-summary-bubble-group
1733 If you want groups you read often to get higher scores than groups you
1734 read seldom you can add the @code{gnus-summary-bubble-group} function to
1735 the @code{gnus-summary-exit-hook} hook. This will result (after
1736 sorting) in a bubbling sort of action. If you want to see that in
1737 action after each summary exit, you can add
1738 @code{gnus-group-sort-groups-by-rank} or
1739 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1740 slow things down somewhat.
1743 @node Marking Groups
1744 @section Marking Groups
1745 @cindex marking groups
1747 If you want to perform some command on several groups, and they appear
1748 subsequently in the group buffer, you would normally just give a
1749 numerical prefix to the command. Most group commands will then do your
1750 bidding on those groups.
1752 However, if the groups are not in sequential order, you can still
1753 perform a command on several groups. You simply mark the groups first
1754 with the process mark and then execute the command.
1762 @findex gnus-group-mark-group
1763 Set the mark on the current group (@code{gnus-group-mark-group}).
1769 @findex gnus-group-unmark-group
1770 Remove the mark from the current group
1771 (@code{gnus-group-unmark-group}).
1775 @findex gnus-group-unmark-all-groups
1776 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1780 @findex gnus-group-mark-region
1781 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1785 @findex gnus-group-mark-buffer
1786 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1790 @findex gnus-group-mark-regexp
1791 Mark all groups that match some regular expression
1792 (@code{gnus-group-mark-regexp}).
1795 Also @pxref{Process/Prefix}.
1797 @findex gnus-group-universal-argument
1798 If you want to execute some command on all groups that have been marked
1799 with the process mark, you can use the @kbd{M-&}
1800 (@code{gnus-group-universal-argument}) command. It will prompt you for
1801 the command to be executed.
1804 @node Foreign Groups
1805 @section Foreign Groups
1806 @cindex foreign groups
1808 Below are some group mode commands for making and editing general foreign
1809 groups, as well as commands to ease the creation of a few
1810 special-purpose groups. All these commands insert the newly created
1811 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1818 @findex gnus-group-make-group
1819 @cindex making groups
1820 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
1821 for a name, a method and possibly an @dfn{address}. For an easier way
1822 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1826 @findex gnus-group-rename-group
1827 @cindex renaming groups
1828 Rename the current group to something else
1829 (@code{gnus-group-rename-group}). This is valid only on some
1830 groups---mail groups mostly. This command might very well be quite slow
1836 @findex gnus-group-customize
1837 Customize the group parameters (@code{gnus-group-customize}).
1841 @findex gnus-group-edit-group-method
1842 @cindex renaming groups
1843 Enter a buffer where you can edit the select method of the current
1844 group (@code{gnus-group-edit-group-method}).
1848 @findex gnus-group-edit-group-parameters
1849 Enter a buffer where you can edit the group parameters
1850 (@code{gnus-group-edit-group-parameters}).
1854 @findex gnus-group-edit-group
1855 Enter a buffer where you can edit the group info
1856 (@code{gnus-group-edit-group}).
1860 @findex gnus-group-make-directory-group
1862 Make a directory group (@pxref{Directory Groups}). You will be prompted
1863 for a directory name (@code{gnus-group-make-directory-group}).
1868 @findex gnus-group-make-help-group
1869 Make the gnus help group (@code{gnus-group-make-help-group}).
1873 @cindex (ding) archive
1874 @cindex archive group
1875 @findex gnus-group-make-archive-group
1876 @vindex gnus-group-archive-directory
1877 @vindex gnus-group-recent-archive-directory
1878 Make a gnus archive group (@code{gnus-group-make-archive-group}). By
1879 default a group pointing to the most recent articles will be created
1880 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1881 group will be created from @code{gnus-group-archive-directory}.
1885 @findex gnus-group-make-kiboze-group
1887 Make a kiboze group. You will be prompted for a name, for a regexp to
1888 match groups to be ``included'' in the kiboze group, and a series of
1889 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1890 @xref{Kibozed Groups}.
1894 @findex gnus-group-enter-directory
1896 Read an arbitrary directory as if it were a newsgroup with the
1897 @code{nneething} backend (@code{gnus-group-enter-directory}).
1898 @xref{Anything Groups}.
1902 @findex gnus-group-make-doc-group
1903 @cindex ClariNet Briefs
1905 Make a group based on some file or other
1906 (@code{gnus-group-make-doc-group}). If you give a prefix to this
1907 command, you will be prompted for a file name and a file type.
1908 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1909 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1910 @code{rfc934}, @code{rfc822-forward}, and @code{forward}. If you run
1911 this command without a prefix, gnus will guess at the file type.
1912 @xref{Document Groups}.
1916 @vindex gnus-useful-groups
1917 @findex gnus-group-make-useful-group
1918 Create one of the groups mentioned in @code{gnus-useful-groups}
1919 (@code{gnus-group-make-useful-group}).
1923 @findex gnus-group-make-web-group
1928 Make an ephemeral group based on a web search
1929 (@code{gnus-group-make-web-group}). If you give a prefix to this
1930 command, make a solid group instead. You will be prompted for the
1931 search engine type and the search string. Valid search engine types
1932 include @code{dejanews}, @code{altavista} and @code{reference}.
1933 @xref{Web Searches}.
1935 If you use the @code{dejanews} search engine, you can limit the search
1936 to a particular group by using a match string like
1937 @samp{~g alt.sysadmin.recovery shaving}.
1940 @kindex G DEL (Group)
1941 @findex gnus-group-delete-group
1942 This function will delete the current group
1943 (@code{gnus-group-delete-group}). If given a prefix, this function will
1944 actually delete all the articles in the group, and forcibly remove the
1945 group itself from the face of the Earth. Use a prefix only if you are
1946 absolutely sure of what you are doing. This command can't be used on
1947 read-only groups (like @code{nntp} group), though.
1951 @findex gnus-group-make-empty-virtual
1952 Make a new, fresh, empty @code{nnvirtual} group
1953 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
1957 @findex gnus-group-add-to-virtual
1958 Add the current group to an @code{nnvirtual} group
1959 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
1962 @xref{Select Methods} for more information on the various select
1965 @vindex gnus-activate-foreign-newsgroups
1966 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1967 gnus will check all foreign groups with this level or lower at startup.
1968 This might take quite a while, especially if you subscribe to lots of
1969 groups from different @sc{nntp} servers. Also @pxref{Group Levels};
1970 @code{gnus-activate-level} also affects activation of foreign
1974 @node Group Parameters
1975 @section Group Parameters
1976 @cindex group parameters
1978 The group parameters store information local to a particular group.
1979 Here's an example group parameter list:
1982 ((to-address . "ding@@gnus.org")
1986 We see that each element consists of a ``dotted pair''---the thing
1987 before the dot is the key, while the thing after the dot is the value.
1988 All the parameters have this form @emph{except} local variable specs,
1989 which are not dotted pairs, but proper lists.
1991 The following group parameters can be used:
1996 Address used by when doing followups and new posts.
1999 (to-address . "some@@where.com")
2002 This is primarily useful in mail groups that represent closed mailing
2003 lists---mailing lists where it's expected that everybody that writes to
2004 the mailing list is subscribed to it. Since using this parameter
2005 ensures that the mail only goes to the mailing list itself, it means
2006 that members won't receive two copies of your followups.
2008 Using @code{to-address} will actually work whether the group is foreign
2009 or not. Let's say there's a group on the server that is called
2010 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2011 the articles from a mail-to-news gateway. Posting directly to this
2012 group is therefore impossible---you have to send mail to the mailing
2013 list address instead.
2017 Address used when doing a @kbd{a} in that group.
2020 (to-list . "some@@where.com")
2023 It is totally ignored
2024 when doing a followup---except that if it is present in a news group,
2025 you'll get mail group semantics when doing @kbd{f}.
2027 If you do an @kbd{a} command in a mail group and you have neither a
2028 @code{to-list} group parameter nor a @code{to-address} group parameter,
2029 then a @code{to-list} group parameter will be added automatically upon
2030 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2031 @vindex gnus-add-to-list
2033 If you do an @kbd{a} command in a mail group and you don't have a
2034 @code{to-list} group parameter, one will be added automatically upon
2035 sending the message.
2039 If the group parameter list has the element @code{(visible . t)},
2040 that group will always be visible in the Group buffer, regardless
2041 of whether it has any unread articles.
2043 @item broken-reply-to
2044 @cindex broken-reply-to
2045 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2046 headers in this group are to be ignored. This can be useful if you're
2047 reading a mailing list group where the listserv has inserted
2048 @code{Reply-To} headers that point back to the listserv itself. This is
2049 broken behavior. So there!
2053 Elements like @code{(to-group . "some.group.name")} means that all
2054 posts in that group will be sent to @code{some.group.name}.
2058 If you have @code{(newsgroup . t)} in the group parameter list, gnus
2059 will treat all responses as if they were responses to news articles.
2060 This can be useful if you have a mail group that's really a mirror of a
2065 If @code{(gcc-self . t)} is present in the group parameter list, newly
2066 composed messages will be @code{Gcc}'d to the current group. If
2067 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2068 generated, if @code{(gcc-self . "string")} is present, this string will
2069 be inserted literally as a @code{gcc} header. This parameter takes
2070 precedence over any default @code{Gcc} rules as described later
2071 (@pxref{Archived Messages}).
2075 If the group parameter has an element that looks like @code{(auto-expire
2076 . t)}, all articles read will be marked as expirable. For an
2077 alternative approach, @pxref{Expiring Mail}.
2080 @cindex total-expire
2081 If the group parameter has an element that looks like
2082 @code{(total-expire . t)}, all read articles will be put through the
2083 expiry process, even if they are not marked as expirable. Use with
2084 caution. Unread, ticked and dormant articles are not eligible for
2089 @vindex nnmail-expiry-wait-function
2090 If the group parameter has an element that looks like @code{(expiry-wait
2091 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2092 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2093 The value can either be a number of days (not necessarily an integer) or
2094 the symbols @code{never} or @code{immediate}.
2097 @cindex score file group parameter
2098 Elements that look like @code{(score-file . "file")} will make
2099 @file{file} into the current score file for the group in question. All
2100 interactive score entries will be put into this file.
2103 @cindex adapt file group parameter
2104 Elements that look like @code{(adapt-file . "file")} will make
2105 @file{file} into the current adaptive file for the group in question.
2106 All adaptive score entries will be put into this file.
2109 When unsubscribing from a mailing list you should never send the
2110 unsubscription notice to the mailing list itself. Instead, you'd send
2111 messages to the administrative address. This parameter allows you to
2112 put the admin address somewhere convenient.
2115 Elements that look like @code{(display . MODE)} say which articles to
2116 display on entering the group. Valid values are:
2120 Display all articles, both read and unread.
2123 Display the default visible articles, which normally includes unread and
2128 Elements that look like @code{(comment . "This is a comment")} are
2129 arbitrary comments on the group. They are currently ignored by gnus,
2130 but provide a place for you to store information on particular groups.
2133 Elements that look like @code{(charset . iso-8859-1)} will make
2134 @code{iso-8859-1} the default charset; that is, the charset that will be
2135 used for all articles that do not specify a charset.
2137 @item @var{(variable form)}
2138 You can use the group parameters to set variables local to the group you
2139 are entering. If you want to turn threading off in @samp{news.answers},
2140 you could put @code{(gnus-show-threads nil)} in the group parameters of
2141 that group. @code{gnus-show-threads} will be made into a local variable
2142 in the summary buffer you enter, and the form @code{nil} will be
2143 @code{eval}ed there.
2145 This can also be used as a group-specific hook function, if you'd like.
2146 If you want to hear a beep when you enter a group, you could put
2147 something like @code{(dummy-variable (ding))} in the parameters of that
2148 group. @code{dummy-variable} will be set to the result of the
2149 @code{(ding)} form, but who cares?
2153 Use the @kbd{G p} command to edit group parameters of a group. You
2154 might also be interested in reading about topic parameters (@pxref{Topic
2158 @node Listing Groups
2159 @section Listing Groups
2160 @cindex group listing
2162 These commands all list various slices of the groups available.
2170 @findex gnus-group-list-groups
2171 List all groups that have unread articles
2172 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
2173 command will list only groups of level ARG and lower. By default, it
2174 only lists groups of level five (i. e.,
2175 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2182 @findex gnus-group-list-all-groups
2183 List all groups, whether they have unread articles or not
2184 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
2185 this command will list only groups of level ARG and lower. By default,
2186 it lists groups of level seven or lower (i.e., just subscribed and
2187 unsubscribed groups).
2191 @findex gnus-group-list-level
2192 List all unread groups on a specific level
2193 (@code{gnus-group-list-level}). If given a prefix, also list the groups
2194 with no unread articles.
2198 @findex gnus-group-list-killed
2199 List all killed groups (@code{gnus-group-list-killed}). If given a
2200 prefix argument, really list all groups that are available, but aren't
2201 currently (un)subscribed. This could entail reading the active file
2206 @findex gnus-group-list-zombies
2207 List all zombie groups (@code{gnus-group-list-zombies}).
2211 @findex gnus-group-list-matching
2212 List all unread, subscribed groups with names that match a regexp
2213 (@code{gnus-group-list-matching}).
2217 @findex gnus-group-list-all-matching
2218 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2222 @findex gnus-group-list-active
2223 List absolutely all groups in the active file(s) of the
2224 server(s) you are connected to (@code{gnus-group-list-active}). This
2225 might very well take quite a while. It might actually be a better idea
2226 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2227 thing to match on. Also note that this command may list groups that
2228 don't exist (yet)---these will be listed as if they were killed groups.
2229 Take the output with some grains of salt.
2233 @findex gnus-group-apropos
2234 List all groups that have names that match a regexp
2235 (@code{gnus-group-apropos}).
2239 @findex gnus-group-description-apropos
2240 List all groups that have names or descriptions that match a regexp
2241 (@code{gnus-group-description-apropos}).
2245 @vindex gnus-permanently-visible-groups
2246 @cindex visible group parameter
2247 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2248 always be shown, whether they have unread articles or not. You can also
2249 add the @code{visible} element to the group parameters in question to
2250 get the same effect.
2252 @vindex gnus-list-groups-with-ticked-articles
2253 Groups that have just ticked articles in it are normally listed in the
2254 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
2255 @code{nil}, these groups will be treated just like totally empty
2256 groups. It is @code{t} by default.
2259 @node Sorting Groups
2260 @section Sorting Groups
2261 @cindex sorting groups
2263 @kindex C-c C-s (Group)
2264 @findex gnus-group-sort-groups
2265 @vindex gnus-group-sort-function
2266 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2267 group buffer according to the function(s) given by the
2268 @code{gnus-group-sort-function} variable. Available sorting functions
2273 @item gnus-group-sort-by-alphabet
2274 @findex gnus-group-sort-by-alphabet
2275 Sort the group names alphabetically. This is the default.
2277 @item gnus-group-sort-by-real-name
2278 @findex gnus-group-sort-by-real-name
2279 Sort the group alphabetically on the real (unprefixed) group names.
2281 @item gnus-group-sort-by-level
2282 @findex gnus-group-sort-by-level
2283 Sort by group level.
2285 @item gnus-group-sort-by-score
2286 @findex gnus-group-sort-by-score
2287 Sort by group score. @xref{Group Score}.
2289 @item gnus-group-sort-by-rank
2290 @findex gnus-group-sort-by-rank
2291 Sort by group score and then the group level. The level and the score
2292 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
2294 @item gnus-group-sort-by-unread
2295 @findex gnus-group-sort-by-unread
2296 Sort by number of unread articles.
2298 @item gnus-group-sort-by-method
2299 @findex gnus-group-sort-by-method
2300 Sort alphabetically on the select method.
2305 @code{gnus-group-sort-function} can also be a list of sorting
2306 functions. In that case, the most significant sort key function must be
2310 There are also a number of commands for sorting directly according to
2311 some sorting criteria:
2315 @kindex G S a (Group)
2316 @findex gnus-group-sort-groups-by-alphabet
2317 Sort the group buffer alphabetically by group name
2318 (@code{gnus-group-sort-groups-by-alphabet}).
2321 @kindex G S u (Group)
2322 @findex gnus-group-sort-groups-by-unread
2323 Sort the group buffer by the number of unread articles
2324 (@code{gnus-group-sort-groups-by-unread}).
2327 @kindex G S l (Group)
2328 @findex gnus-group-sort-groups-by-level
2329 Sort the group buffer by group level
2330 (@code{gnus-group-sort-groups-by-level}).
2333 @kindex G S v (Group)
2334 @findex gnus-group-sort-groups-by-score
2335 Sort the group buffer by group score
2336 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
2339 @kindex G S r (Group)
2340 @findex gnus-group-sort-groups-by-rank
2341 Sort the group buffer by group rank
2342 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
2345 @kindex G S m (Group)
2346 @findex gnus-group-sort-groups-by-method
2347 Sort the group buffer alphabetically by backend name
2348 (@code{gnus-group-sort-groups-by-method}).
2352 When given a prefix, all these commands will sort in reverse order.
2354 You can also sort a subset of the groups:
2358 @kindex G P a (Group)
2359 @findex gnus-group-sort-selected-groups-by-alphabet
2360 Sort the process/prefixed groups in the group buffer alphabetically by
2361 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2364 @kindex G P u (Group)
2365 @findex gnus-group-sort-selected-groups-by-unread
2366 Sort the process/prefixed groups in the group buffer by the number of
2367 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2370 @kindex G P l (Group)
2371 @findex gnus-group-sort-selected-groups-by-level
2372 Sort the process/prefixed groups in the group buffer by group level
2373 (@code{gnus-group-sort-selected-groups-by-level}).
2376 @kindex G P v (Group)
2377 @findex gnus-group-sort-selected-groups-by-score
2378 Sort the process/prefixed groups in the group buffer by group score
2379 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
2382 @kindex G P r (Group)
2383 @findex gnus-group-sort-selected-groups-by-rank
2384 Sort the process/prefixed groups in the group buffer by group rank
2385 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
2388 @kindex G P m (Group)
2389 @findex gnus-group-sort-selected-groups-by-method
2390 Sort the process/prefixed groups in the group buffer alphabetically by
2391 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2397 @node Group Maintenance
2398 @section Group Maintenance
2399 @cindex bogus groups
2404 @findex gnus-group-check-bogus-groups
2405 Find bogus groups and delete them
2406 (@code{gnus-group-check-bogus-groups}).
2410 @findex gnus-group-find-new-groups
2411 Find new groups and process them (@code{gnus-group-find-new-groups}).
2412 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
2413 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
2414 to query the server for new groups, and subscribe the new groups as
2418 @kindex C-c C-x (Group)
2419 @findex gnus-group-expire-articles
2420 Run all expirable articles in the current group through the expiry
2421 process (if any) (@code{gnus-group-expire-articles}).
2424 @kindex C-c M-C-x (Group)
2425 @findex gnus-group-expire-all-groups
2426 Run all articles in all groups through the expiry process
2427 (@code{gnus-group-expire-all-groups}).
2432 @node Browse Foreign Server
2433 @section Browse Foreign Server
2434 @cindex foreign servers
2435 @cindex browsing servers
2440 @findex gnus-group-browse-foreign-server
2441 You will be queried for a select method and a server name. Gnus will
2442 then attempt to contact this server and let you browse the groups there
2443 (@code{gnus-group-browse-foreign-server}).
2446 @findex gnus-browse-mode
2447 A new buffer with a list of available groups will appear. This buffer
2448 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
2449 a lot) like a normal group buffer.
2451 Here's a list of keystrokes available in the browse mode:
2456 @findex gnus-group-next-group
2457 Go to the next group (@code{gnus-group-next-group}).
2461 @findex gnus-group-prev-group
2462 Go to the previous group (@code{gnus-group-prev-group}).
2465 @kindex SPACE (Browse)
2466 @findex gnus-browse-read-group
2467 Enter the current group and display the first article
2468 (@code{gnus-browse-read-group}).
2471 @kindex RET (Browse)
2472 @findex gnus-browse-select-group
2473 Enter the current group (@code{gnus-browse-select-group}).
2477 @findex gnus-browse-unsubscribe-current-group
2478 Unsubscribe to the current group, or, as will be the case here,
2479 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2485 @findex gnus-browse-exit
2486 Exit browse mode (@code{gnus-browse-exit}).
2490 @findex gnus-browse-describe-briefly
2491 Describe browse mode briefly (well, there's not much to describe, is
2492 there) (@code{gnus-browse-describe-briefly}).
2497 @section Exiting gnus
2498 @cindex exiting gnus
2500 Yes, gnus is ex(c)iting.
2505 @findex gnus-group-suspend
2506 Suspend gnus (@code{gnus-group-suspend}). This doesn't really exit
2507 gnus, but it kills all buffers except the Group buffer. I'm not sure
2508 why this is a gain, but then who am I to judge?
2512 @findex gnus-group-exit
2513 @c @icon{gnus-group-exit}
2514 Quit gnus (@code{gnus-group-exit}).
2518 @findex gnus-group-quit
2519 Quit gnus without saving the @file{.newsrc} files
2520 (@code{gnus-group-quit}). The dribble file will be saved, though
2521 (@pxref{Auto Save}).
2524 @vindex gnus-exit-gnus-hook
2525 @vindex gnus-suspend-gnus-hook
2526 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
2527 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
2528 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2533 If you wish to completely unload gnus and all its adherents, you can use
2534 the @code{gnus-unload} command. This command is also very handy when
2535 trying to customize meta-variables.
2540 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2541 numbly heavy and herself fall into a hazy trance as the boy sitting
2542 behind her drew repeated lines with his pencil across the back of her
2548 @section Group Topics
2551 If you read lots and lots of groups, it might be convenient to group
2552 them hierarchically according to topics. You put your Emacs groups over
2553 here, your sex groups over there, and the rest (what, two groups or so?)
2554 you put in some misc section that you never bother with anyway. You can
2555 even group the Emacs sex groups as a sub-topic to either the Emacs
2556 groups or the sex groups---or both! Go wild!
2560 \gnusfigure{Group Topics}{400}{
2561 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2572 2: alt.religion.emacs
2575 0: comp.talk.emacs.recovery
2577 8: comp.binaries.fractals
2578 13: comp.sources.unix
2581 @findex gnus-topic-mode
2583 To get this @emph{fab} functionality you simply turn on (ooh!) the
2584 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
2585 is a toggling command.)
2587 Go ahead, just try it. I'll still be here when you get back. La de
2588 dum... Nice tune, that... la la la... What, you're back? Yes, and now
2589 press @kbd{l}. There. All your groups are now listed under
2590 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
2593 If you want this permanently enabled, you should add that minor mode to
2594 the hook for the group mode:
2597 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2601 * Topic Variables:: How to customize the topics the Lisp Way.
2602 * Topic Commands:: Interactive E-Z commands.
2603 * Topic Sorting:: Sorting each topic individually.
2604 * Topic Topology:: A map of the world.
2605 * Topic Parameters:: Parameters that apply to all groups in a topic.
2609 @node Topic Variables
2610 @subsection Topic Variables
2611 @cindex topic variables
2613 Now, if you select a topic, it will fold/unfold that topic, which is
2614 really neat, I think.
2616 @vindex gnus-topic-line-format
2617 The topic lines themselves are created according to the
2618 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2631 Number of groups in the topic.
2633 Number of unread articles in the topic.
2635 Number of unread articles in the topic and all its subtopics.
2638 @vindex gnus-topic-indent-level
2639 Each sub-topic (and the groups in the sub-topics) will be indented with
2640 @code{gnus-topic-indent-level} times the topic level number of spaces.
2643 @vindex gnus-topic-mode-hook
2644 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2646 @vindex gnus-topic-display-empty-topics
2647 The @code{gnus-topic-display-empty-topics} says whether to display even
2648 topics that have no unread articles in them. The default is @code{t}.
2651 @node Topic Commands
2652 @subsection Topic Commands
2653 @cindex topic commands
2655 When the topic minor mode is turned on, a new @kbd{T} submap will be
2656 available. In addition, a few of the standard keys change their
2657 definitions slightly.
2663 @findex gnus-topic-create-topic
2664 Prompt for a new topic name and create it
2665 (@code{gnus-topic-create-topic}).
2669 @findex gnus-topic-move-group
2670 Move the current group to some other topic
2671 (@code{gnus-topic-move-group}). This command uses the process/prefix
2672 convention (@pxref{Process/Prefix}).
2676 @findex gnus-topic-copy-group
2677 Copy the current group to some other topic
2678 (@code{gnus-topic-copy-group}). This command uses the process/prefix
2679 convention (@pxref{Process/Prefix}).
2683 @findex gnus-topic-remove-group
2684 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2685 This command is mainly useful if you have the same group in several
2686 topics and wish to remove it from one of the topics. You may also
2687 remove a group from all topics, but in that case, Gnus will add it to
2688 the root topic the next time you start Gnus. In fact, all new groups
2689 (which, naturally, don't belong to any topic) will show up in the root
2692 This command uses the process/prefix convention
2693 (@pxref{Process/Prefix}).
2697 @findex gnus-topic-move-matching
2698 Move all groups that match some regular expression to a topic
2699 (@code{gnus-topic-move-matching}).
2703 @findex gnus-topic-copy-matching
2704 Copy all groups that match some regular expression to a topic
2705 (@code{gnus-topic-copy-matching}).
2709 @findex gnus-topic-toggle-display-empty-topics
2710 Toggle hiding empty topics
2711 (@code{gnus-topic-toggle-display-empty-topics}).
2715 @findex gnus-topic-mark-topic
2716 Mark all groups in the current topic with the process mark
2717 (@code{gnus-topic-mark-topic}).
2720 @kindex T M-# (Topic)
2721 @findex gnus-topic-unmark-topic
2722 Remove the process mark from all groups in the current topic
2723 (@code{gnus-topic-unmark-topic}).
2727 @findex gnus-topic-select-group
2729 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2730 When you perform this command on a group, you'll enter the group, as
2731 usual. When done on a topic line, the topic will be folded (if it was
2732 visible) or unfolded (if it was folded already). So it's basically a
2733 toggling command on topics. In addition, if you give a numerical
2734 prefix, group on that level (and lower) will be displayed.
2738 @kindex T TAB (Topic)
2740 @findex gnus-topic-indent
2741 ``Indent'' the current topic so that it becomes a sub-topic of the
2742 previous topic (@code{gnus-topic-indent}). If given a prefix,
2743 ``un-indent'' the topic instead.
2746 @kindex M-TAB (Topic)
2747 @findex gnus-topic-unindent
2748 ``Un-indent'' the current topic so that it becomes a sub-topic of the
2749 parent of its current parent (@code{gnus-topic-unindent}).
2753 @findex gnus-topic-kill-group
2754 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
2755 topic will be removed along with the topic.
2759 @findex gnus-topic-yank-group
2760 Yank the previously killed group or topic
2761 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
2766 @findex gnus-topic-rename
2767 Rename a topic (@code{gnus-topic-rename}).
2770 @kindex T DEL (Topic)
2771 @findex gnus-topic-delete
2772 Delete an empty topic (@code{gnus-topic-delete}).
2776 @findex gnus-topic-list-active
2777 List all groups that gnus knows about in a topics-ified way
2778 (@code{gnus-topic-list-active}).
2782 @findex gnus-topic-edit-parameters
2783 @cindex group parameters
2784 @cindex topic parameters
2786 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2787 @xref{Topic Parameters}.
2793 @subsection Topic Sorting
2794 @cindex topic sorting
2796 You can sort the groups in each topic individually with the following
2802 @kindex T S a (Topic)
2803 @findex gnus-topic-sort-groups-by-alphabet
2804 Sort the current topic alphabetically by group name
2805 (@code{gnus-topic-sort-groups-by-alphabet}).
2808 @kindex T S u (Topic)
2809 @findex gnus-topic-sort-groups-by-unread
2810 Sort the current topic by the number of unread articles
2811 (@code{gnus-topic-sort-groups-by-unread}).
2814 @kindex T S l (Topic)
2815 @findex gnus-topic-sort-groups-by-level
2816 Sort the current topic by group level
2817 (@code{gnus-topic-sort-groups-by-level}).
2820 @kindex T S v (Topic)
2821 @findex gnus-topic-sort-groups-by-score
2822 Sort the current topic by group score
2823 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
2826 @kindex T S r (Topic)
2827 @findex gnus-topic-sort-groups-by-rank
2828 Sort the current topic by group rank
2829 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
2832 @kindex T S m (Topic)
2833 @findex gnus-topic-sort-groups-by-method
2834 Sort the current topic alphabetically by backend name
2835 (@code{gnus-topic-sort-groups-by-method}).
2839 @xref{Sorting Groups} for more information about group sorting.
2842 @node Topic Topology
2843 @subsection Topic Topology
2844 @cindex topic topology
2847 So, let's have a look at an example group buffer:
2853 2: alt.religion.emacs
2856 0: comp.talk.emacs.recovery
2858 8: comp.binaries.fractals
2859 13: comp.sources.unix
2862 So, here we have one top-level topic (@samp{Gnus}), two topics under
2863 that, and one sub-topic under one of the sub-topics. (There is always
2864 just one (1) top-level topic). This topology can be expressed as
2869 (("Emacs -- I wuw it!" visible)
2870 (("Naughty Emacs" visible)))
2874 @vindex gnus-topic-topology
2875 This is in fact how the variable @code{gnus-topic-topology} would look
2876 for the display above. That variable is saved in the @file{.newsrc.eld}
2877 file, and shouldn't be messed with manually---unless you really want
2878 to. Since this variable is read from the @file{.newsrc.eld} file,
2879 setting it in any other startup files will have no effect.
2881 This topology shows what topics are sub-topics of what topics (right),
2882 and which topics are visible. Two settings are currently
2883 allowed---@code{visible} and @code{invisible}.
2886 @node Topic Parameters
2887 @subsection Topic Parameters
2888 @cindex topic parameters
2890 All groups in a topic will inherit group parameters from the parent (and
2891 ancestor) topic parameters. All valid group parameters are valid topic
2892 parameters (@pxref{Group Parameters}).
2894 Group parameters (of course) override topic parameters, and topic
2895 parameters in sub-topics override topic parameters in super-topics. You
2896 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
2897 verb, although you may feel free to disagree with me here.)
2903 2: alt.religion.emacs
2907 0: comp.talk.emacs.recovery
2909 8: comp.binaries.fractals
2910 13: comp.sources.unix
2914 The @samp{Emacs} topic has the topic parameter @code{(score-file
2915 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2916 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2917 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
2918 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
2919 . "religion.SCORE")}.
2921 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2922 will get the @file{relief.SCORE} home score file. If you enter the same
2923 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2924 score file. If you enter the group @samp{alt.religion.emacs}, you'll
2925 get the @file{religion.SCORE} home score file.
2927 This seems rather simple and self-evident, doesn't it? Well, yes. But
2928 there are some problems, especially with the @code{total-expiry}
2929 parameter. Say you have a mail group in two topics; one with
2930 @code{total-expiry} and one without. What happens when you do @kbd{M-x
2931 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
2932 of these topics you mean to expire articles from, so anything may
2933 happen. In fact, I hereby declare that it is @dfn{undefined} what
2934 happens. You just have to be careful if you do stuff like that.
2937 @node Misc Group Stuff
2938 @section Misc Group Stuff
2941 * Scanning New Messages:: Asking gnus to see whether new messages have arrived.
2942 * Group Information:: Information and help on groups and gnus.
2943 * Group Timestamp:: Making gnus keep track of when you last read a group.
2944 * File Commands:: Reading and writing the gnus files.
2951 @findex gnus-group-enter-server-mode
2952 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2953 @xref{The Server Buffer}.
2957 @findex gnus-group-post-news
2958 Post an article to a group (@code{gnus-group-post-news}). If given a
2959 prefix, the current group name will be used as the default.
2963 @findex gnus-group-mail
2964 Mail a message somewhere (@code{gnus-group-mail}).
2968 Variables for the group buffer:
2972 @item gnus-group-mode-hook
2973 @vindex gnus-group-mode-hook
2974 is called after the group buffer has been
2977 @item gnus-group-prepare-hook
2978 @vindex gnus-group-prepare-hook
2979 is called after the group buffer is
2980 generated. It may be used to modify the buffer in some strange,
2983 @item gnus-group-prepared-hook
2984 @vindex gnus-group-prepare-hook
2985 is called as the very last thing after the group buffer has been
2986 generated. It may be used to move point around, for instance.
2988 @item gnus-permanently-visible-groups
2989 @vindex gnus-permanently-visible-groups
2990 Groups matching this regexp will always be listed in the group buffer,
2991 whether they are empty or not.
2996 @node Scanning New Messages
2997 @subsection Scanning New Messages
2998 @cindex new messages
2999 @cindex scanning new news
3005 @findex gnus-group-get-new-news
3006 @c @icon{gnus-group-get-new-news}
3007 Check the server(s) for new articles. If the numerical prefix is used,
3008 this command will check only groups of level @var{arg} and lower
3009 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
3010 command will force a total re-reading of the active file(s) from the
3015 @findex gnus-group-get-new-news-this-group
3016 @vindex gnus-goto-next-group-when-activating
3017 @c @icon{gnus-group-get-new-news-this-group}
3018 Check whether new articles have arrived in the current group
3019 (@code{gnus-group-get-new-news-this-group}).
3020 @code{gnus-goto-next-group-when-activating} says whether this command is
3021 to move point to the next group or not. It is @code{t} by default.
3023 @findex gnus-activate-all-groups
3024 @cindex activating groups
3026 @kindex C-c M-g (Group)
3027 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3032 @findex gnus-group-restart
3033 Restart gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
3034 file(s), closes the connection to all servers, clears up all run-time
3035 gnus variables, and then starts gnus all over again.
3039 @vindex gnus-get-new-news-hook
3040 @code{gnus-get-new-news-hook} is run just before checking for new news.
3042 @vindex gnus-after-getting-new-news-hook
3043 @code{gnus-after-getting-new-news-hook} is run after checking for new
3047 @node Group Information
3048 @subsection Group Information
3049 @cindex group information
3050 @cindex information on groups
3057 @findex gnus-group-fetch-faq
3058 @vindex gnus-group-faq-directory
3061 Try to fetch the FAQ for the current group
3062 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
3063 @code{gnus-group-faq-directory}, which is usually a directory on a
3064 remote machine. This variable can also be a list of directories. In
3065 that case, giving a prefix to this command will allow you to choose
3066 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
3067 for fetching the file.
3069 If fetching from the first site is unsuccessful, gnus will attempt to go
3070 through @code{gnus-group-faq-directory} and try to open them one by one.
3074 @c @icon{gnus-group-describe-group}
3076 @kindex C-c C-d (Group)
3077 @cindex describing groups
3078 @cindex group description
3079 @findex gnus-group-describe-group
3080 Describe the current group (@code{gnus-group-describe-group}). If given
3081 a prefix, force Gnus to re-read the description from the server.
3085 @findex gnus-group-describe-all-groups
3086 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
3087 prefix, force gnus to re-read the description file from the server.
3094 @findex gnus-version
3095 Display current gnus version numbers (@code{gnus-version}).
3099 @findex gnus-group-describe-briefly
3100 Give a very short help message (@code{gnus-group-describe-briefly}).
3103 @kindex C-c C-i (Group)
3106 @findex gnus-info-find-node
3107 Go to the gnus info node (@code{gnus-info-find-node}).
3111 @node Group Timestamp
3112 @subsection Group Timestamp
3114 @cindex group timestamps
3116 It can be convenient to let gnus keep track of when you last read a
3117 group. To set the ball rolling, you should add
3118 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3121 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3124 After doing this, each time you enter a group, it'll be recorded.
3126 This information can be displayed in various ways---the easiest is to
3127 use the @samp{%d} spec in the group line format:
3130 (setq gnus-group-line-format
3131 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3134 This will result in lines looking like:
3137 * 0: mail.ding 19961002T012943
3138 0: custom 19961002T012713
3141 As you can see, the date is displayed in compact ISO 8601 format. This
3142 may be a bit too much, so to just display the date, you could say
3146 (setq gnus-group-line-format
3147 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3152 @subsection File Commands
3153 @cindex file commands
3159 @findex gnus-group-read-init-file
3160 @vindex gnus-init-file
3161 @cindex reading init file
3162 Re-read the init file (@code{gnus-init-file}, which defaults to
3163 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3167 @findex gnus-group-save-newsrc
3168 @cindex saving .newsrc
3169 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3170 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
3171 file(s) whether Gnus thinks it is necessary or not.
3174 @c @kindex Z (Group)
3175 @c @findex gnus-group-clear-dribble
3176 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3181 @node The Summary Buffer
3182 @chapter The Summary Buffer
3183 @cindex summary buffer
3185 A line for each article is displayed in the summary buffer. You can
3186 move around, read articles, post articles and reply to articles.
3188 The most common way to a summary buffer is to select a group from the
3189 group buffer (@pxref{Selecting a Group}).
3191 You can have as many summary buffers open as you wish.
3194 * Summary Buffer Format:: Deciding how the summary buffer is to look.
3195 * Summary Maneuvering:: Moving around the summary buffer.
3196 * Choosing Articles:: Reading articles.
3197 * Paging the Article:: Scrolling the current article.
3198 * Reply Followup and Post:: Posting articles.
3199 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
3200 * Marking Articles:: Marking articles as read, expirable, etc.
3201 * Limiting:: You can limit the summary buffer.
3202 * Threading:: How threads are made.
3203 * Sorting:: How articles and threads are sorted.
3204 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
3205 * Article Caching:: You may store articles in a cache.
3206 * Persistent Articles:: Making articles expiry-resistant.
3207 * Article Backlog:: Having already read articles hang around.
3208 * Saving Articles:: Ways of customizing article saving.
3209 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
3210 * Article Treatment:: The article buffer can be mangled at will.
3211 * MIME Commands:: Doing MIMEy things with the articles.
3212 * Article Commands:: Doing various things with the article buffer.
3213 * Summary Sorting:: Sorting the summary buffer in various ways.
3214 * Finding the Parent:: No child support? Get the parent.
3215 * Alternative Approaches:: Reading using non-default summaries.
3216 * Tree Display:: A more visual display of threads.
3217 * Mail Group Commands:: Some commands can only be used in mail groups.
3218 * Various Summary Stuff:: What didn't fit anywhere else.
3219 * Exiting the Summary Buffer:: Returning to the Group buffer.
3220 * Crosspost Handling:: How crossposted articles are dealt with.
3221 * Duplicate Suppression:: An alternative when crosspost handling fails.
3225 @node Summary Buffer Format
3226 @section Summary Buffer Format
3227 @cindex summary buffer format
3231 \gnusfigure{The Summary Buffer}{180}{
3232 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3233 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3239 * Summary Buffer Lines:: You can specify how summary lines should look.
3240 * Summary Buffer Mode Line:: You can say how the mode line should look.
3241 * Summary Highlighting:: Making the summary buffer all pretty and nice.
3244 @findex mail-extract-address-components
3245 @findex gnus-extract-address-components
3246 @vindex gnus-extract-address-components
3247 Gnus will use the value of the @code{gnus-extract-address-components}
3248 variable as a function for getting the name and address parts of a
3249 @code{From} header. Three pre-defined functions exist:
3250 @code{gnus-extract-address-components}, which is the default, quite
3251 fast, and too simplistic solution;
3252 @code{mail-extract-address-components}, which works nicely, but is
3253 slower; and @code{std11-extract-address-components}, which works very
3254 nicely, but is slower. The default function will return the wrong
3255 answer in 5% of the cases. If this is unacceptable to you, use the
3256 other function instead.
3258 @vindex gnus-summary-same-subject
3259 @code{gnus-summary-same-subject} is a string indicating that the current
3260 article has the same subject as the previous. This string will be used
3261 with those specs that require it. The default is @code{""}.
3264 @node Summary Buffer Lines
3265 @subsection Summary Buffer Lines
3267 @vindex gnus-summary-line-format
3268 You can change the format of the lines in the summary buffer by changing
3269 the @code{gnus-summary-line-format} variable. It works along the same
3270 lines as a normal @code{format} string, with some extensions
3271 (@pxref{Formatting Variables}).
3273 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3275 The following format specification characters are understood:
3283 Subject if the article is the root of the thread or the previous article
3284 had a different subject, @code{gnus-summary-same-subject} otherwise.
3285 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3287 Full @code{From} header.
3289 The name (from the @code{From} header).
3291 The name (from the @code{From} header). This differs from the @code{n}
3292 spec in that it uses the function designated by the
3293 @code{gnus-extract-address-components} variable, which is slower, but
3294 may be more thorough.
3296 The address (from the @code{From} header). This works the same way as
3299 Number of lines in the article.
3301 Number of characters in the article.
3303 Indentation based on thread level (@pxref{Customizing Threading}).
3305 Nothing if the article is a root and lots of spaces if it isn't (it
3306 pushes everything after it off the screen).
3308 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3309 for adopted articles (@pxref{Customizing Threading}).
3311 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3312 for adopted articles.
3314 One space for each thread level.
3316 Twenty minus thread level spaces.
3321 This misleadingly named specifier is the @dfn{secondary mark}. This
3322 mark will say whether the article has been replied to, has been cached,
3326 Score as a number (@pxref{Scoring}).
3328 @vindex gnus-summary-zcore-fuzz
3329 Zcore, @samp{+} if above the default level and @samp{-} if below the
3330 default level. If the difference between
3331 @code{gnus-summary-default-score} and the score is less than
3332 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3340 The @code{Date} in @code{DD-MMM} format.
3342 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3348 Number of articles in the current sub-thread. Using this spec will slow
3349 down summary buffer generation somewhat.
3351 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3352 article has any children.
3358 User defined specifier. The next character in the format string should
3359 be a letter. Gnus will call the function
3360 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3361 following @samp{%u}. The function will be passed the current header as
3362 argument. The function should return a string, which will be inserted
3363 into the summary just like information from any other summary specifier.
3366 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3367 have to be handled with care. For reasons of efficiency, gnus will
3368 compute what column these characters will end up in, and ``hard-code''
3369 that. This means that it is invalid to have these specs after a
3370 variable-length spec. Well, you might not be arrested, but your summary
3371 buffer will look strange, which is bad enough.
3373 The smart choice is to have these specs as far to the left as possible.
3374 (Isn't that the case with everything, though? But I digress.)
3376 This restriction may disappear in later versions of gnus.
3379 @node Summary Buffer Mode Line
3380 @subsection Summary Buffer Mode Line
3382 @vindex gnus-summary-mode-line-format
3383 You can also change the format of the summary mode bar (@pxref{Mode Line
3384 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
3385 like. The default is @samp{Gnus: %%b [%A] %Z}.
3387 Here are the elements you can play with:
3393 Unprefixed group name.
3395 Current article number.
3397 Current article score.
3401 Number of unread articles in this group.
3403 Number of unread articles in this group that aren't displayed in the
3406 A string with the number of unread and unselected articles represented
3407 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3408 articles, and just as @samp{<%U more>} if there are just unread articles
3409 and no unselected ones.
3411 Shortish group name. For instance, @samp{rec.arts.anime} will be
3412 shortened to @samp{r.a.anime}.
3414 Subject of the current article.
3416 User-defined spec (@pxref{User-Defined Specs}).
3418 Name of the current score file (@pxref{Scoring}).
3420 Number of dormant articles (@pxref{Unread Articles}).
3422 Number of ticked articles (@pxref{Unread Articles}).
3424 Number of articles that have been marked as read in this session.
3426 Number of articles expunged by the score files.
3430 @node Summary Highlighting
3431 @subsection Summary Highlighting
3435 @item gnus-visual-mark-article-hook
3436 @vindex gnus-visual-mark-article-hook
3437 This hook is run after selecting an article. It is meant to be used for
3438 highlighting the article in some way. It is not run if
3439 @code{gnus-visual} is @code{nil}.
3441 @item gnus-summary-update-hook
3442 @vindex gnus-summary-update-hook
3443 This hook is called when a summary line is changed. It is not run if
3444 @code{gnus-visual} is @code{nil}.
3446 @item gnus-summary-selected-face
3447 @vindex gnus-summary-selected-face
3448 This is the face (or @dfn{font} as some people call it) used to
3449 highlight the current article in the summary buffer.
3451 @item gnus-summary-highlight
3452 @vindex gnus-summary-highlight
3453 Summary lines are highlighted according to this variable, which is a
3454 list where the elements are of the format @var{(FORM . FACE)}. If you
3455 would, for instance, like ticked articles to be italic and high-scored
3456 articles to be bold, you could set this variable to something like
3458 (((eq mark gnus-ticked-mark) . italic)
3459 ((> score default) . bold))
3461 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3462 @var{FACE} will be applied to the line.
3466 @node Summary Maneuvering
3467 @section Summary Maneuvering
3468 @cindex summary movement
3470 All the straight movement commands understand the numeric prefix and
3471 behave pretty much as you'd expect.
3473 None of these commands select articles.
3478 @kindex M-n (Summary)
3479 @kindex G M-n (Summary)
3480 @findex gnus-summary-next-unread-subject
3481 Go to the next summary line of an unread article
3482 (@code{gnus-summary-next-unread-subject}).
3486 @kindex M-p (Summary)
3487 @kindex G M-p (Summary)
3488 @findex gnus-summary-prev-unread-subject
3489 Go to the previous summary line of an unread article
3490 (@code{gnus-summary-prev-unread-subject}).
3495 @kindex G j (Summary)
3496 @findex gnus-summary-goto-article
3497 Ask for an article number or @code{Message-ID}, and then go to that
3498 article (@code{gnus-summary-goto-article}).
3501 @kindex G g (Summary)
3502 @findex gnus-summary-goto-subject
3503 Ask for an article number and then go to the summary line of that article
3504 without displaying the article (@code{gnus-summary-goto-subject}).
3507 If gnus asks you to press a key to confirm going to the next group, you
3508 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3509 buffer, searching for the next group to read without actually returning
3510 to the group buffer.
3512 Variables related to summary movement:
3516 @vindex gnus-auto-select-next
3517 @item gnus-auto-select-next
3518 If you issue one of the movement commands (like @kbd{n}) and there are
3519 no more unread articles after the current one, gnus will offer to go to
3520 the next group. If this variable is @code{t} and the next group is
3521 empty, gnus will exit summary mode and return to the group buffer. If
3522 this variable is neither @code{t} nor @code{nil}, gnus will select the
3523 next group, no matter whether it has any unread articles or not. As a
3524 special case, if this variable is @code{quietly}, gnus will select the
3525 next group without asking for confirmation. If this variable is
3526 @code{almost-quietly}, the same will happen only if you are located on
3527 the last article in the group. Finally, if this variable is
3528 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3529 without confirmation. Also @pxref{Group Levels}.
3531 @item gnus-auto-select-same
3532 @vindex gnus-auto-select-same
3533 If non-@code{nil}, all the movement commands will try to go to the next
3534 article with the same subject as the current. (@dfn{Same} here might
3535 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
3536 for details (@pxref{Customizing Threading}).) If there are no more
3537 articles with the same subject, go to the first unread article.
3539 This variable is not particularly useful if you use a threaded display.
3541 @item gnus-summary-check-current
3542 @vindex gnus-summary-check-current
3543 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3544 to the next (or previous) article if the current article is unread.
3545 Instead, they will choose the current article.
3547 @item gnus-auto-center-summary
3548 @vindex gnus-auto-center-summary
3549 If non-@code{nil}, gnus will keep the point in the summary buffer
3550 centered at all times. This makes things quite tidy, but if you have a
3551 slow network connection, or simply do not like this un-Emacsism, you can
3552 set this variable to @code{nil} to get the normal Emacs scrolling
3553 action. This will also inhibit horizontal re-centering of the summary
3554 buffer, which might make it more inconvenient to read extremely long
3560 @node Choosing Articles
3561 @section Choosing Articles
3562 @cindex selecting articles
3565 * Choosing Commands:: Commands for choosing articles.
3566 * Choosing Variables:: Variables that influence these commands.
3570 @node Choosing Commands
3571 @subsection Choosing Commands
3573 None of the following movement commands understand the numeric prefix,
3574 and they all select and display an article.
3578 @kindex SPACE (Summary)
3579 @findex gnus-summary-next-page
3580 Select the current article, or, if that one's read already, the next
3581 unread article (@code{gnus-summary-next-page}).
3586 @kindex G n (Summary)
3587 @findex gnus-summary-next-unread-article
3588 @c @icon{gnus-summary-next-unread}
3589 Go to next unread article (@code{gnus-summary-next-unread-article}).
3594 @findex gnus-summary-prev-unread-article
3595 @c @icon{gnus-summary-prev-unread}
3596 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3601 @kindex G N (Summary)
3602 @findex gnus-summary-next-article
3603 Go to the next article (@code{gnus-summary-next-article}).
3608 @kindex G P (Summary)
3609 @findex gnus-summary-prev-article
3610 Go to the previous article (@code{gnus-summary-prev-article}).
3613 @kindex G C-n (Summary)
3614 @findex gnus-summary-next-same-subject
3615 Go to the next article with the same subject
3616 (@code{gnus-summary-next-same-subject}).
3619 @kindex G C-p (Summary)
3620 @findex gnus-summary-prev-same-subject
3621 Go to the previous article with the same subject
3622 (@code{gnus-summary-prev-same-subject}).
3626 @kindex G f (Summary)
3628 @findex gnus-summary-first-unread-article
3629 Go to the first unread article
3630 (@code{gnus-summary-first-unread-article}).
3634 @kindex G b (Summary)
3636 @findex gnus-summary-best-unread-article
3637 Go to the article with the highest score
3638 (@code{gnus-summary-best-unread-article}).
3643 @kindex G l (Summary)
3644 @findex gnus-summary-goto-last-article
3645 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3648 @kindex G o (Summary)
3649 @findex gnus-summary-pop-article
3651 @cindex article history
3652 Pop an article off the summary history and go to this article
3653 (@code{gnus-summary-pop-article}). This command differs from the
3654 command above in that you can pop as many previous articles off the
3655 history as you like, while @kbd{l} toggles the two last read articles.
3656 For a somewhat related issue (if you use these commands a lot),
3657 @pxref{Article Backlog}.
3661 @node Choosing Variables
3662 @subsection Choosing Variables
3664 Some variables relevant for moving and selecting articles:
3667 @item gnus-auto-extend-newsgroup
3668 @vindex gnus-auto-extend-newsgroup
3669 All the movement commands will try to go to the previous (or next)
3670 article, even if that article isn't displayed in the Summary buffer if
3671 this variable is non-@code{nil}. Gnus will then fetch the article from
3672 the server and display it in the article buffer.
3674 @item gnus-select-article-hook
3675 @vindex gnus-select-article-hook
3676 This hook is called whenever an article is selected. By default it
3677 exposes any threads hidden under the selected article.
3679 @item gnus-mark-article-hook
3680 @vindex gnus-mark-article-hook
3681 @findex gnus-summary-mark-unread-as-read
3682 @findex gnus-summary-mark-read-and-unread-as-read
3683 @findex gnus-unread-mark
3684 This hook is called whenever an article is selected. It is intended to
3685 be used for marking articles as read. The default value is
3686 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3687 mark of almost any article you read to @code{gnus-unread-mark}. The
3688 only articles not affected by this function are ticked, dormant, and
3689 expirable articles. If you'd instead like to just have unread articles
3690 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3691 instead. It will leave marks like @code{gnus-low-score-mark},
3692 @code{gnus-del-mark} (and so on) alone.
3697 @node Paging the Article
3698 @section Scrolling the Article
3699 @cindex article scrolling
3704 @kindex SPACE (Summary)
3705 @findex gnus-summary-next-page
3706 Pressing @kbd{SPACE} will scroll the current article forward one page,
3707 or, if you have come to the end of the current article, will choose the
3708 next article (@code{gnus-summary-next-page}).
3711 @kindex DEL (Summary)
3712 @findex gnus-summary-prev-page
3713 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3716 @kindex RET (Summary)
3717 @findex gnus-summary-scroll-up
3718 Scroll the current article one line forward
3719 (@code{gnus-summary-scroll-up}).
3722 @kindex M-RET (Summary)
3723 @findex gnus-summary-scroll-down
3724 Scroll the current article one line backward
3725 (@code{gnus-summary-scroll-down}).
3729 @kindex A g (Summary)
3731 @findex gnus-summary-show-article
3732 (Re)fetch the current article (@code{gnus-summary-show-article}). If
3733 given a prefix, fetch the current article, but don't run any of the
3734 article treatment functions. This will give you a ``raw'' article, just
3735 the way it came from the server.
3740 @kindex A < (Summary)
3741 @findex gnus-summary-beginning-of-article
3742 Scroll to the beginning of the article
3743 (@code{gnus-summary-beginning-of-article}).
3748 @kindex A > (Summary)
3749 @findex gnus-summary-end-of-article
3750 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3754 @kindex A s (Summary)
3756 @findex gnus-summary-isearch-article
3757 Perform an isearch in the article buffer
3758 (@code{gnus-summary-isearch-article}).
3762 @findex gnus-summary-select-article-buffer
3763 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3768 @node Reply Followup and Post
3769 @section Reply, Followup and Post
3772 * Summary Mail Commands:: Sending mail.
3773 * Summary Post Commands:: Sending news.
3777 @node Summary Mail Commands
3778 @subsection Summary Mail Commands
3780 @cindex composing mail
3782 Commands for composing a mail message:
3788 @kindex S r (Summary)
3790 @findex gnus-summary-reply
3791 @c @icon{gnus-summary-mail-reply}
3792 @c @icon{gnus-summary-reply}
3793 Mail a reply to the author of the current article
3794 (@code{gnus-summary-reply}).
3799 @kindex S R (Summary)
3800 @findex gnus-summary-reply-with-original
3801 @c @icon{gnus-summary-reply-with-original}
3802 Mail a reply to the author of the current article and include the
3803 original message (@code{gnus-summary-reply-with-original}). This
3804 command uses the process/prefix convention.
3807 @kindex S w (Summary)
3808 @findex gnus-summary-wide-reply
3809 Mail a wide reply to the author of the current article
3810 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
3811 goes out to all people listed in the @code{To}, @code{From} (or
3812 @code{Reply-to}) and @code{Cc} headers.
3815 @kindex S W (Summary)
3816 @findex gnus-summary-wide-reply-with-original
3817 Mail a wide reply to the current article and include the original
3818 message (@code{gnus-summary-reply-with-original}). This command uses
3819 the process/prefix convention.
3822 @kindex S o m (Summary)
3823 @findex gnus-summary-mail-forward
3824 @c @icon{gnus-summary-mail-forward}
3825 Forward the current article to some other person
3826 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
3827 headers of the forwarded article.
3832 @kindex S m (Summary)
3833 @findex gnus-summary-mail-other-window
3834 @c @icon{gnus-summary-mail-originate}
3835 Send a mail to some other person
3836 (@code{gnus-summary-mail-other-window}).
3839 @kindex S D b (Summary)
3840 @findex gnus-summary-resend-bounced-mail
3841 @cindex bouncing mail
3842 If you have sent a mail, but the mail was bounced back to you for some
3843 reason (wrong address, transient failure), you can use this command to
3844 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
3845 will be popped into a mail buffer where you can edit the headers before
3846 sending the mail off again. If you give a prefix to this command, and
3847 the bounced mail is a reply to some other mail, gnus will try to fetch
3848 that mail and display it for easy perusal of its headers. This might
3849 very well fail, though.
3852 @kindex S D r (Summary)
3853 @findex gnus-summary-resend-message
3854 Not to be confused with the previous command,
3855 @code{gnus-summary-resend-message} will prompt you for an address to
3856 send the current message off to, and then send it to that place. The
3857 headers of the message won't be altered---but lots of headers that say
3858 @code{Resent-To}, @code{Resent-From} and so on will be added. This
3859 means that you actually send a mail to someone that has a @code{To}
3860 header that (probably) points to yourself. This will confuse people.
3861 So, natcherly you'll only do that if you're really eVIl.
3863 This command is mainly used if you have several accounts and want to
3864 ship a mail to a different account of yours. (If you're both
3865 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3866 to the @code{root} account, you may want to resend it to
3867 @code{postmaster}. Ordnung mu
\e,A_
\e(B sein!
3869 This command understands the process/prefix convention
3870 (@pxref{Process/Prefix}).
3873 @kindex S O m (Summary)
3874 @findex gnus-uu-digest-mail-forward
3875 Digest the current series (@pxref{Decoding Articles}) and forward the
3876 result using mail (@code{gnus-uu-digest-mail-forward}). This command
3877 uses the process/prefix convention (@pxref{Process/Prefix}).
3880 @kindex S M-c (Summary)
3881 @findex gnus-summary-mail-crosspost-complaint
3882 @cindex crossposting
3883 @cindex excessive crossposting
3884 Send a complaint about excessive crossposting to the author of the
3885 current article (@code{gnus-summary-mail-crosspost-complaint}).
3887 @findex gnus-crosspost-complaint
3888 This command is provided as a way to fight back against the current
3889 crossposting pandemic that's sweeping Usenet. It will compose a reply
3890 using the @code{gnus-crosspost-complaint} variable as a preamble. This
3891 command understands the process/prefix convention
3892 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3896 Also @pxref{(message)Header Commands} for more information.
3899 @node Summary Post Commands
3900 @subsection Summary Post Commands
3902 @cindex composing news
3904 Commands for posting a news article:
3910 @kindex S p (Summary)
3911 @findex gnus-summary-post-news
3912 @c @icon{gnus-summary-post-news}
3913 Post an article to the current group
3914 (@code{gnus-summary-post-news}).
3919 @kindex S f (Summary)
3920 @findex gnus-summary-followup
3921 @c @icon{gnus-summary-followup}
3922 Post a followup to the current article (@code{gnus-summary-followup}).
3926 @kindex S F (Summary)
3928 @c @icon{gnus-summary-followup-with-original}
3929 @findex gnus-summary-followup-with-original
3930 Post a followup to the current article and include the original message
3931 (@code{gnus-summary-followup-with-original}). This command uses the
3932 process/prefix convention.
3935 @kindex S n (Summary)
3936 @findex gnus-summary-followup-to-mail
3937 Post a followup to the current article via news, even if you got the
3938 message through mail (@code{gnus-summary-followup-to-mail}).
3941 @kindex S N (Summary)
3942 @findex gnus-summary-followup-to-mail-with-original
3943 Post a followup to the current article via news, even if you got the
3944 message through mail and include the original message
3945 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
3946 the process/prefix convention.
3949 @kindex S o p (Summary)
3950 @findex gnus-summary-post-forward
3951 Forward the current article to a newsgroup
3952 (@code{gnus-summary-post-forward}). If given a prefix, include the full
3953 headers of the forwarded article.
3956 @kindex S O p (Summary)
3957 @findex gnus-uu-digest-post-forward
3959 @cindex making digests
3960 Digest the current series and forward the result to a newsgroup
3961 (@code{gnus-uu-digest-mail-forward}). This command uses the
3962 process/prefix convention.
3965 @kindex S u (Summary)
3966 @findex gnus-uu-post-news
3967 @c @icon{gnus-uu-post-news}
3968 Uuencode a file, split it into parts, and post it as a series
3969 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
3972 Also @pxref{(message)Header Commands} for more information.
3975 @node Canceling and Superseding
3976 @section Canceling Articles
3977 @cindex canceling articles
3978 @cindex superseding articles
3980 Have you ever written something, and then decided that you really,
3981 really, really wish you hadn't posted that?
3983 Well, you can't cancel mail, but you can cancel posts.
3985 @findex gnus-summary-cancel-article
3987 @c @icon{gnus-summary-cancel-article}
3988 Find the article you wish to cancel (you can only cancel your own
3989 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
3990 c} (@code{gnus-summary-cancel-article}). Your article will be
3991 canceled---machines all over the world will be deleting your article.
3992 This command uses the process/prefix convention (@pxref{Process/Prefix}).
3994 Be aware, however, that not all sites honor cancels, so your article may
3995 live on here and there, while most sites will delete the article in
3998 Gnus will use the ``current'' select method when canceling. If you
3999 want to use the standard posting method, use the @samp{a} symbolic
4000 prefix (@pxref{Symbolic Prefixes}).
4002 If you discover that you have made some mistakes and want to do some
4003 corrections, you can post a @dfn{superseding} article that will replace
4004 your original article.
4006 @findex gnus-summary-supersede-article
4008 Go to the original article and press @kbd{S s}
4009 (@code{gnus-summary-supersede-article}). You will be put in a buffer
4010 where you can edit the article all you want before sending it off the
4013 The same goes for superseding as for canceling, only more so: Some
4014 sites do not honor superseding. On those sites, it will appear that you
4015 have posted almost the same article twice.
4017 If you have just posted the article, and change your mind right away,
4018 there is a trick you can use to cancel/supersede the article without
4019 waiting for the article to appear on your site first. You simply return
4020 to the post buffer (which is called @code{*sent ...*}). There you will
4021 find the article you just posted, with all the headers intact. Change
4022 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4023 header by substituting one of those words for the word
4024 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
4025 you would do normally. The previous article will be
4026 canceled/superseded.
4028 Just remember, kids: There is no `c' in `supersede'.
4031 @node Marking Articles
4032 @section Marking Articles
4033 @cindex article marking
4034 @cindex article ticking
4037 There are several marks you can set on an article.
4039 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4040 neologism ohoy!) of the article. Alphabetic marks generally mean
4041 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4043 In addition, you also have marks that do not affect readedness.
4046 * Unread Articles:: Marks for unread articles.
4047 * Read Articles:: Marks for read articles.
4048 * Other Marks:: Marks that do not affect readedness.
4052 There's a plethora of commands for manipulating these marks:
4056 * Setting Marks:: How to set and remove marks.
4057 * Setting Process Marks:: How to mark articles for later processing.
4061 @node Unread Articles
4062 @subsection Unread Articles
4064 The following marks mark articles as (kinda) unread, in one form or
4069 @vindex gnus-ticked-mark
4070 Marked as ticked (@code{gnus-ticked-mark}).
4072 @dfn{Ticked articles} are articles that will remain visible always. If
4073 you see an article that you find interesting, or you want to put off
4074 reading it, or replying to it, until sometime later, you'd typically
4075 tick it. However, articles can be expired, so if you want to keep an
4076 article forever, you'll have to make it persistent (@pxref{Persistent
4080 @vindex gnus-dormant-mark
4081 Marked as dormant (@code{gnus-dormant-mark}).
4083 @dfn{Dormant articles} will only appear in the summary buffer if there
4084 are followups to it. If you want to see them even if they don't have
4085 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4088 @vindex gnus-unread-mark
4089 Marked as unread (@code{gnus-unread-mark}).
4091 @dfn{Unread articles} are articles that haven't been read at all yet.
4096 @subsection Read Articles
4097 @cindex expirable mark
4099 All the following marks mark articles as read.
4104 @vindex gnus-del-mark
4105 These are articles that the user has marked as read with the @kbd{d}
4106 command manually, more or less (@code{gnus-del-mark}).
4109 @vindex gnus-read-mark
4110 Articles that have actually been read (@code{gnus-read-mark}).
4113 @vindex gnus-ancient-mark
4114 Articles that were marked as read in previous sessions and are now
4115 @dfn{old} (@code{gnus-ancient-mark}).
4118 @vindex gnus-killed-mark
4119 Marked as killed (@code{gnus-killed-mark}).
4122 @vindex gnus-kill-file-mark
4123 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4126 @vindex gnus-low-score-mark
4127 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4130 @vindex gnus-catchup-mark
4131 Marked as read by a catchup (@code{gnus-catchup-mark}).
4134 @vindex gnus-canceled-mark
4135 Canceled article (@code{gnus-canceled-mark})
4138 @vindex gnus-souped-mark
4139 @sc{SOUP}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
4142 @vindex gnus-sparse-mark
4143 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
4147 @vindex gnus-duplicate-mark
4148 Article marked as read by duplicate suppression
4149 (@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}.
4153 All these marks just mean that the article is marked as read, really.
4154 They are interpreted differently when doing adaptive scoring, though.
4156 One more special mark, though:
4160 @vindex gnus-expirable-mark
4161 Marked as expirable (@code{gnus-expirable-mark}).
4163 Marking articles as @dfn{expirable} (or have them marked as such
4164 automatically) doesn't make much sense in normal groups---a user doesn't
4165 control expiring of news articles, but in mail groups, for instance,
4166 articles marked as @dfn{expirable} can be deleted by gnus at any time.
4171 @subsection Other Marks
4172 @cindex process mark
4175 There are some marks that have nothing to do with whether the article is
4181 You can set a bookmark in the current article. Say you are reading a
4182 long thesis on cats' urinary tracts, and have to go home for dinner
4183 before you've finished reading the thesis. You can then set a bookmark
4184 in the article, and gnus will jump to this bookmark the next time it
4185 encounters the article. @xref{Setting Marks}
4188 @vindex gnus-replied-mark
4189 All articles that you have replied to or made a followup to (i.e., have
4190 answered) will be marked with an @samp{A} in the second column
4191 (@code{gnus-replied-mark}).
4194 @vindex gnus-cached-mark
4195 Articles stored in the article cache will be marked with an @samp{*} in
4196 the second column (@code{gnus-cached-mark}). @xref{Article Caching}
4199 @vindex gnus-saved-mark
4200 Articles ``saved'' (in some manner or other; not necessarily
4201 religiously) are marked with an @samp{S} in the second column
4202 (@code{gnus-saved-mark}).
4205 @vindex gnus-not-empty-thread-mark
4206 @vindex gnus-empty-thread-mark
4207 If the @samp{%e} spec is used, the presence of threads or not will be
4208 marked with @code{gnus-not-empty-thread-mark} and
4209 @code{gnus-empty-thread-mark} in the third column, respectively.
4212 @vindex gnus-process-mark
4213 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
4214 variety of commands react to the presence of the process mark. For
4215 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4216 all articles that have been marked with the process mark. Articles
4217 marked with the process mark have a @samp{#} in the second column.
4221 You might have noticed that most of these ``non-readedness'' marks
4222 appear in the second column by default. So if you have a cached, saved,
4223 replied article that you have process-marked, what will that look like?
4225 Nothing much. The precedence rules go as follows: process -> cache ->
4226 replied -> saved. So if the article is in the cache and is replied,
4227 you'll only see the cache mark and not the replied mark.
4231 @subsection Setting Marks
4232 @cindex setting marks
4234 All the marking commands understand the numeric prefix.
4239 @kindex M c (Summary)
4240 @kindex M-u (Summary)
4241 @findex gnus-summary-clear-mark-forward
4242 @cindex mark as unread
4243 Clear all readedness-marks from the current article
4244 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
4250 @kindex M t (Summary)
4251 @findex gnus-summary-tick-article-forward
4252 Tick the current article (@code{gnus-summary-tick-article-forward}).
4253 @xref{Article Caching}
4258 @kindex M ? (Summary)
4259 @findex gnus-summary-mark-as-dormant
4260 Mark the current article as dormant
4261 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}
4265 @kindex M d (Summary)
4267 @findex gnus-summary-mark-as-read-forward
4268 Mark the current article as read
4269 (@code{gnus-summary-mark-as-read-forward}).
4273 @findex gnus-summary-mark-as-read-backward
4274 Mark the current article as read and move point to the previous line
4275 (@code{gnus-summary-mark-as-read-backward}).
4280 @kindex M k (Summary)
4281 @findex gnus-summary-kill-same-subject-and-select
4282 Mark all articles that have the same subject as the current one as read,
4283 and then select the next unread article
4284 (@code{gnus-summary-kill-same-subject-and-select}).
4288 @kindex M K (Summary)
4289 @kindex C-k (Summary)
4290 @findex gnus-summary-kill-same-subject
4291 Mark all articles that have the same subject as the current one as read
4292 (@code{gnus-summary-kill-same-subject}).
4295 @kindex M C (Summary)
4296 @findex gnus-summary-catchup
4297 @c @icon{gnus-summary-catchup}
4298 Mark all unread articles as read (@code{gnus-summary-catchup}).
4301 @kindex M C-c (Summary)
4302 @findex gnus-summary-catchup-all
4303 Mark all articles in the group as read---even the ticked and dormant
4304 articles (@code{gnus-summary-catchup-all}).
4307 @kindex M H (Summary)
4308 @findex gnus-summary-catchup-to-here
4309 Catchup the current group to point
4310 (@code{gnus-summary-catchup-to-here}).
4313 @kindex C-w (Summary)
4314 @findex gnus-summary-mark-region-as-read
4315 Mark all articles between point and mark as read
4316 (@code{gnus-summary-mark-region-as-read}).
4319 @kindex M V k (Summary)
4320 @findex gnus-summary-kill-below
4321 Kill all articles with scores below the default score (or below the
4322 numeric prefix) (@code{gnus-summary-kill-below}).
4326 @kindex M e (Summary)
4328 @findex gnus-summary-mark-as-expirable
4329 Mark the current article as expirable
4330 (@code{gnus-summary-mark-as-expirable}).
4333 @kindex M b (Summary)
4334 @findex gnus-summary-set-bookmark
4335 Set a bookmark in the current article
4336 (@code{gnus-summary-set-bookmark}).
4339 @kindex M B (Summary)
4340 @findex gnus-summary-remove-bookmark
4341 Remove the bookmark from the current article
4342 (@code{gnus-summary-remove-bookmark}).
4345 @kindex M V c (Summary)
4346 @findex gnus-summary-clear-above
4347 Clear all marks from articles with scores over the default score (or
4348 over the numeric prefix) (@code{gnus-summary-clear-above}).
4351 @kindex M V u (Summary)
4352 @findex gnus-summary-tick-above
4353 Tick all articles with scores over the default score (or over the
4354 numeric prefix) (@code{gnus-summary-tick-above}).
4357 @kindex M V m (Summary)
4358 @findex gnus-summary-mark-above
4359 Prompt for a mark, and mark all articles with scores over the default
4360 score (or over the numeric prefix) with this mark
4361 (@code{gnus-summary-clear-above}).
4364 @vindex gnus-summary-goto-unread
4365 The @code{gnus-summary-goto-unread} variable controls what action should
4366 be taken after setting a mark. If non-@code{nil}, point will move to
4367 the next/previous unread article. If @code{nil}, point will just move
4368 one line up or down. As a special case, if this variable is
4369 @code{never}, all the marking commands as well as other commands (like
4370 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4371 The default is @code{t}.
4374 @node Setting Process Marks
4375 @subsection Setting Process Marks
4376 @cindex setting process marks
4383 @kindex M P p (Summary)
4384 @findex gnus-summary-mark-as-processable
4385 Mark the current article with the process mark
4386 (@code{gnus-summary-mark-as-processable}).
4387 @findex gnus-summary-unmark-as-processable
4391 @kindex M P u (Summary)
4392 @kindex M-# (Summary)
4393 Remove the process mark, if any, from the current article
4394 (@code{gnus-summary-unmark-as-processable}).
4397 @kindex M P U (Summary)
4398 @findex gnus-summary-unmark-all-processable
4399 Remove the process mark from all articles
4400 (@code{gnus-summary-unmark-all-processable}).
4403 @kindex M P i (Summary)
4404 @findex gnus-uu-invert-processable
4405 Invert the list of process marked articles
4406 (@code{gnus-uu-invert-processable}).
4409 @kindex M P R (Summary)
4410 @findex gnus-uu-mark-by-regexp
4411 Mark articles that have a @code{Subject} header that matches a regular
4412 expression (@code{gnus-uu-mark-by-regexp}).
4415 @kindex M P r (Summary)
4416 @findex gnus-uu-mark-region
4417 Mark articles in region (@code{gnus-uu-mark-region}).
4420 @kindex M P t (Summary)
4421 @findex gnus-uu-mark-thread
4422 Mark all articles in the current (sub)thread
4423 (@code{gnus-uu-mark-thread}).
4426 @kindex M P T (Summary)
4427 @findex gnus-uu-unmark-thread
4428 Unmark all articles in the current (sub)thread
4429 (@code{gnus-uu-unmark-thread}).
4432 @kindex M P v (Summary)
4433 @findex gnus-uu-mark-over
4434 Mark all articles that have a score above the prefix argument
4435 (@code{gnus-uu-mark-over}).
4438 @kindex M P s (Summary)
4439 @findex gnus-uu-mark-series
4440 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4443 @kindex M P S (Summary)
4444 @findex gnus-uu-mark-sparse
4445 Mark all series that have already had some articles marked
4446 (@code{gnus-uu-mark-sparse}).
4449 @kindex M P a (Summary)
4450 @findex gnus-uu-mark-all
4451 Mark all articles in series order (@code{gnus-uu-mark-series}).
4454 @kindex M P b (Summary)
4455 @findex gnus-uu-mark-buffer
4456 Mark all articles in the buffer in the order they appear
4457 (@code{gnus-uu-mark-buffer}).
4460 @kindex M P k (Summary)
4461 @findex gnus-summary-kill-process-mark
4462 Push the current process mark set onto the stack and unmark all articles
4463 (@code{gnus-summary-kill-process-mark}).
4466 @kindex M P y (Summary)
4467 @findex gnus-summary-yank-process-mark
4468 Pop the previous process mark set from the stack and restore it
4469 (@code{gnus-summary-yank-process-mark}).
4472 @kindex M P w (Summary)
4473 @findex gnus-summary-save-process-mark
4474 Push the current process mark set onto the stack
4475 (@code{gnus-summary-save-process-mark}).
4484 It can be convenient to limit the summary buffer to just show some
4485 subset of the articles currently in the group. The effect most limit
4486 commands have is to remove a few (or many) articles from the summary
4489 All limiting commands work on subsets of the articles already fetched
4490 from the servers. None of these commands query the server for
4491 additional articles.
4497 @kindex / / (Summary)
4498 @findex gnus-summary-limit-to-subject
4499 Limit the summary buffer to articles that match some subject
4500 (@code{gnus-summary-limit-to-subject}).
4503 @kindex / a (Summary)
4504 @findex gnus-summary-limit-to-author
4505 Limit the summary buffer to articles that match some author
4506 (@code{gnus-summary-limit-to-author}).
4510 @kindex / u (Summary)
4512 @findex gnus-summary-limit-to-unread
4513 Limit the summary buffer to articles not marked as read
4514 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
4515 buffer to articles strictly unread. This means that ticked and
4516 dormant articles will also be excluded.
4519 @kindex / m (Summary)
4520 @findex gnus-summary-limit-to-marks
4521 Ask for a mark and then limit to all articles that have been marked
4522 with that mark (@code{gnus-summary-limit-to-marks}).
4525 @kindex / t (Summary)
4526 @findex gnus-summary-limit-to-age
4527 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4528 (@code{gnus-summary-limit-to-marks}). If given a prefix, limit to
4529 articles younger than that number of days.
4532 @kindex / n (Summary)
4533 @findex gnus-summary-limit-to-articles
4534 Limit the summary buffer to the current article
4535 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
4536 convention (@pxref{Process/Prefix}).
4539 @kindex / w (Summary)
4540 @findex gnus-summary-pop-limit
4541 Pop the previous limit off the stack and restore it
4542 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
4546 @kindex / v (Summary)
4547 @findex gnus-summary-limit-to-score
4548 Limit the summary buffer to articles that have a score at or above some
4549 score (@code{gnus-summary-limit-to-score}).
4553 @kindex M S (Summary)
4554 @kindex / E (Summary)
4555 @findex gnus-summary-limit-include-expunged
4556 Include all expunged articles in the limit
4557 (@code{gnus-summary-limit-include-expunged}).
4560 @kindex / D (Summary)
4561 @findex gnus-summary-limit-include-dormant
4562 Include all dormant articles in the limit
4563 (@code{gnus-summary-limit-include-dormant}).
4566 @kindex / * (Summary)
4567 @findex gnus-summary-limit-include-cached
4568 Include all cached articles in the limit
4569 (@code{gnus-summary-limit-include-cached}).
4572 @kindex / d (Summary)
4573 @findex gnus-summary-limit-exclude-dormant
4574 Exclude all dormant articles from the limit
4575 (@code{gnus-summary-limit-exclude-dormant}).
4578 @kindex / T (Summary)
4579 @findex gnus-summary-limit-include-thread
4580 Include all the articles in the current thread in the limit.
4583 @kindex / c (Summary)
4584 @findex gnus-summary-limit-exclude-childless-dormant
4585 Exclude all dormant articles that have no children from the limit
4586 (@code{gnus-summary-limit-exclude-childless-dormant}).
4589 @kindex / C (Summary)
4590 @findex gnus-summary-limit-mark-excluded-as-read
4591 Mark all excluded unread articles as read
4592 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
4593 also mark excluded ticked and dormant articles as read.
4601 @cindex article threading
4603 Gnus threads articles by default. @dfn{To thread} is to put responses
4604 to articles directly after the articles they respond to---in a
4605 hierarchical fashion.
4607 Threading is done by looking at the @code{References} headers of the
4608 articles. In a perfect world, this would be enough to build pretty
4609 trees, but unfortunately, the @code{References} header is often broken
4610 or simply missing. Weird news propagation excarcerbates the problem,
4611 so one has to employ other heuristics to get pleasing results. A
4612 plethora of approaches exists, as detailed in horrible detail in
4613 @pxref{Customizing Threading}.
4615 First, a quick overview of the concepts:
4619 The top-most article in a thread; the first article in the thread.
4622 A tree-like article structure.
4625 A small(er) section of this tree-like structure.
4628 Threads often lose their roots due to article expiry, or due to the root
4629 already having been read in a previous session, and not displayed in the
4630 summary buffer. We then typically have many sub-threads that really
4631 belong to one thread, but are without connecting roots. These are
4632 called loose threads.
4634 @item thread gathering
4635 An attempt to gather loose threads into bigger threads.
4637 @item sparse threads
4638 A thread where the missing articles have been ``guessed'' at, and are
4639 displayed as empty lines in the summary buffer.
4645 * Customizing Threading:: Variables you can change to affect the threading.
4646 * Thread Commands:: Thread based commands in the summary buffer.
4650 @node Customizing Threading
4651 @subsection Customizing Threading
4652 @cindex customizing threading
4655 * Loose Threads:: How gnus gathers loose threads into bigger threads.
4656 * Filling In Threads:: Making the threads displayed look fuller.
4657 * More Threading:: Even more variables for fiddling with threads.
4658 * Low-Level Threading:: You thought it was over... but you were wrong!
4663 @subsubsection Loose Threads
4666 @cindex loose threads
4669 @item gnus-summary-make-false-root
4670 @vindex gnus-summary-make-false-root
4671 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
4672 and create a dummy root at the top. (Wait a minute. Root at the top?
4673 Yup.) Loose subtrees occur when the real root has expired, or you've
4674 read or killed the root in a previous session.
4676 When there is no real root of a thread, gnus will have to fudge
4677 something. This variable says what fudging method gnus should use.
4678 There are four possible values:
4682 \gnusfigure{The Summary Buffer}{390}{
4683 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4684 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4685 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4686 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4691 @cindex adopting articles
4696 Gnus will make the first of the orphaned articles the parent. This
4697 parent will adopt all the other articles. The adopted articles will be
4698 marked as such by pointy brackets (@samp{<>}) instead of the standard
4699 square brackets (@samp{[]}). This is the default method.
4702 @vindex gnus-summary-dummy-line-format
4703 Gnus will create a dummy summary line that will pretend to be the
4704 parent. This dummy line does not correspond to any real article, so
4705 selecting it will just select the first real article after the dummy
4706 article. @code{gnus-summary-dummy-line-format} is used to specify the
4707 format of the dummy roots. It accepts only one format spec: @samp{S},
4708 which is the subject of the article. @xref{Formatting Variables}.
4711 Gnus won't actually make any article the parent, but simply leave the
4712 subject field of all orphans except the first empty. (Actually, it will
4713 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4717 Don't make any article parent at all. Just gather the threads and
4718 display them after one another.
4721 Don't gather loose threads.
4724 @item gnus-summary-gather-subject-limit
4725 @vindex gnus-summary-gather-subject-limit
4726 Loose threads are gathered by comparing subjects of articles. If this
4727 variable is @code{nil}, gnus requires an exact match between the
4728 subjects of the loose threads before gathering them into one big
4729 super-thread. This might be too strict a requirement, what with the
4730 presence of stupid newsreaders that chop off long subject lines. If
4731 you think so, set this variable to, say, 20 to require that only the
4732 first 20 characters of the subjects have to match. If you set this
4733 variable to a really low number, you'll find that gnus will gather
4734 everything in sight into one thread, which isn't very helpful.
4736 @cindex fuzzy article gathering
4737 If you set this variable to the special value @code{fuzzy}, gnus will
4738 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4741 @item gnus-simplify-subject-fuzzy-regexp
4742 @vindex gnus-simplify-subject-fuzzy-regexp
4743 This can either be a regular expression or list of regular expressions
4744 that match strings that will be removed from subjects if fuzzy subject
4745 simplification is used.
4747 @item gnus-simplify-ignored-prefixes
4748 @vindex gnus-simplify-ignored-prefixes
4749 If you set @code{gnus-summary-gather-subject-limit} to something as low
4750 as 10, you might consider setting this variable to something sensible:
4752 @c Written by Michael Ernst <mernst@cs.rice.edu>
4754 (setq gnus-simplify-ignored-prefixes
4760 "wanted" "followup" "summary\\( of\\)?"
4761 "help" "query" "problem" "question"
4762 "answer" "reference" "announce"
4763 "How can I" "How to" "Comparison of"
4768 (mapconcat 'identity
4769 '("for" "for reference" "with" "about")
4771 "\\)?\\]?:?[ \t]*"))
4774 All words that match this regexp will be removed before comparing two
4777 @item gnus-simplify-subject-functions
4778 @vindex gnus-simplify-subject-functions
4779 If non-@code{nil}, this variable overrides
4780 @code{gnus-summary-gather-subject-limit}. This variable should be a
4781 list of functions to apply to the @code{Subject} string iteratively to
4782 arrive at the simplified version of the string.
4784 Useful functions to put in this list include:
4787 @item gnus-simplify-subject-re
4788 @findex gnus-simplify-subject-re
4789 Strip the leading @samp{Re:}.
4791 @item gnus-simplify-subject-fuzzy
4792 @findex gnus-simplify-subject-fuzzy
4795 @item gnus-simplify-whitespace
4796 @findex gnus-simplify-whitespace
4797 Remove excessive whitespace.
4800 You may also write your own functions, of course.
4803 @item gnus-summary-gather-exclude-subject
4804 @vindex gnus-summary-gather-exclude-subject
4805 Since loose thread gathering is done on subjects only, that might lead
4806 to many false hits, especially with certain common subjects like
4807 @samp{} and @samp{(none)}. To make the situation slightly better,
4808 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4809 what subjects should be excluded from the gathering process.@*
4810 The default is @samp{^ *$\\|^(none)$}.
4812 @item gnus-summary-thread-gathering-function
4813 @vindex gnus-summary-thread-gathering-function
4814 Gnus gathers threads by looking at @code{Subject} headers. This means
4815 that totally unrelated articles may end up in the same ``thread'', which
4816 is confusing. An alternate approach is to look at all the
4817 @code{Message-ID}s in all the @code{References} headers to find matches.
4818 This will ensure that no gathered threads ever include unrelated
4819 articles, but it also means that people who have posted with broken
4820 newsreaders won't be gathered properly. The choice is yours---plague or
4824 @item gnus-gather-threads-by-subject
4825 @findex gnus-gather-threads-by-subject
4826 This function is the default gathering function and looks at
4827 @code{Subject}s exclusively.
4829 @item gnus-gather-threads-by-references
4830 @findex gnus-gather-threads-by-references
4831 This function looks at @code{References} headers exclusively.
4834 If you want to test gathering by @code{References}, you could say
4838 (setq gnus-summary-thread-gathering-function
4839 'gnus-gather-threads-by-references)
4845 @node Filling In Threads
4846 @subsubsection Filling In Threads
4849 @item gnus-fetch-old-headers
4850 @vindex gnus-fetch-old-headers
4851 If non-@code{nil}, gnus will attempt to build old threads by fetching
4852 more old headers---headers to articles marked as read. If you would
4853 like to display as few summary lines as possible, but still connect as
4854 many loose threads as possible, you should set this variable to
4855 @code{some} or a number. If you set it to a number, no more than that
4856 number of extra old headers will be fetched. In either case, fetching
4857 old headers only works if the backend you are using carries overview
4858 files---this would normally be @code{nntp}, @code{nnspool} and
4859 @code{nnml}. Also remember that if the root of the thread has been
4860 expired by the server, there's not much gnus can do about that.
4862 This variable can also be set to @code{invisible}. This won't have any
4863 visible effects, but is useful if you use the @kbd{A T} command a lot
4864 (@pxref{Finding the Parent}).
4866 @item gnus-build-sparse-threads
4867 @vindex gnus-build-sparse-threads
4868 Fetching old headers can be slow. A low-rent similar effect can be
4869 gotten by setting this variable to @code{some}. Gnus will then look at
4870 the complete @code{References} headers of all articles and try to string
4871 together articles that belong in the same thread. This will leave
4872 @dfn{gaps} in the threading display where gnus guesses that an article
4873 is missing from the thread. (These gaps appear like normal summary
4874 lines. If you select a gap, gnus will try to fetch the article in
4875 question.) If this variable is @code{t}, gnus will display all these
4876 ``gaps'' without regard for whether they are useful for completing the
4877 thread or not. Finally, if this variable is @code{more}, gnus won't cut
4878 off sparse leaf nodes that don't lead anywhere. This variable is
4879 @code{nil} by default.
4884 @node More Threading
4885 @subsubsection More Threading
4888 @item gnus-show-threads
4889 @vindex gnus-show-threads
4890 If this variable is @code{nil}, no threading will be done, and all of
4891 the rest of the variables here will have no effect. Turning threading
4892 off will speed group selection up a bit, but it is sure to make reading
4893 slower and more awkward.
4895 @item gnus-thread-hide-subtree
4896 @vindex gnus-thread-hide-subtree
4897 If non-@code{nil}, all threads will be hidden when the summary buffer is
4900 @item gnus-thread-expunge-below
4901 @vindex gnus-thread-expunge-below
4902 All threads that have a total score (as defined by
4903 @code{gnus-thread-score-function}) less than this number will be
4904 expunged. This variable is @code{nil} by default, which means that no
4905 threads are expunged.
4907 @item gnus-thread-hide-killed
4908 @vindex gnus-thread-hide-killed
4909 if you kill a thread and this variable is non-@code{nil}, the subtree
4912 @item gnus-thread-ignore-subject
4913 @vindex gnus-thread-ignore-subject
4914 Sometimes somebody changes the subject in the middle of a thread. If
4915 this variable is non-@code{nil}, the subject change is ignored. If it
4916 is @code{nil}, which is the default, a change in the subject will result
4919 @item gnus-thread-indent-level
4920 @vindex gnus-thread-indent-level
4921 This is a number that says how much each sub-thread should be indented.
4927 @node Low-Level Threading
4928 @subsubsection Low-Level Threading
4932 @item gnus-parse-headers-hook
4933 @vindex gnus-parse-headers-hook
4934 Hook run before parsing any headers. The default value is
4935 @code{(gnus-set-summary-default-charset)}, which sets up local value of
4936 @code{default-mime-charset} in summary buffer based on variable
4937 @code{gnus-newsgroup-default-charset-alist}.
4939 @item gnus-alter-header-function
4940 @vindex gnus-alter-header-function
4941 If non-@code{nil}, this function will be called to allow alteration of
4942 article header structures. The function is called with one parameter,
4943 the article header vector, which it may alter in any way. For instance,
4944 if you have a mail-to-news gateway which alters the @code{Message-ID}s
4945 in systematic ways (by adding prefixes and such), you can use this
4946 variable to un-scramble the @code{Message-ID}s so that they are more
4947 meaningful. Here's one example:
4950 (setq gnus-alter-header-function 'my-alter-message-id)
4952 (defun my-alter-message-id (header)
4953 (let ((id (mail-header-id header)))
4955 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
4957 (concat (match-string 1 id) "@@" (match-string 2 id))
4964 @node Thread Commands
4965 @subsection Thread Commands
4966 @cindex thread commands
4972 @kindex T k (Summary)
4973 @kindex M-C-k (Summary)
4974 @findex gnus-summary-kill-thread
4975 Mark all articles in the current (sub-)thread as read
4976 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
4977 remove all marks instead. If the prefix argument is negative, tick
4982 @kindex T l (Summary)
4983 @kindex M-C-l (Summary)
4984 @findex gnus-summary-lower-thread
4985 Lower the score of the current (sub-)thread
4986 (@code{gnus-summary-lower-thread}).
4989 @kindex T i (Summary)
4990 @findex gnus-summary-raise-thread
4991 Increase the score of the current (sub-)thread
4992 (@code{gnus-summary-raise-thread}).
4995 @kindex T # (Summary)
4996 @findex gnus-uu-mark-thread
4997 Set the process mark on the current (sub-)thread
4998 (@code{gnus-uu-mark-thread}).
5001 @kindex T M-# (Summary)
5002 @findex gnus-uu-unmark-thread
5003 Remove the process mark from the current (sub-)thread
5004 (@code{gnus-uu-unmark-thread}).
5007 @kindex T T (Summary)
5008 @findex gnus-summary-toggle-threads
5009 Toggle threading (@code{gnus-summary-toggle-threads}).
5012 @kindex T s (Summary)
5013 @findex gnus-summary-show-thread
5014 Expose the (sub-)thread hidden under the current article, if any
5015 (@code{gnus-summary-show-thread}).
5018 @kindex T h (Summary)
5019 @findex gnus-summary-hide-thread
5020 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5023 @kindex T S (Summary)
5024 @findex gnus-summary-show-all-threads
5025 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5028 @kindex T H (Summary)
5029 @findex gnus-summary-hide-all-threads
5030 Hide all threads (@code{gnus-summary-hide-all-threads}).
5033 @kindex T t (Summary)
5034 @findex gnus-summary-rethread-current
5035 Re-thread the current article's thread
5036 (@code{gnus-summary-rethread-current}). This works even when the
5037 summary buffer is otherwise unthreaded.
5040 @kindex T ^ (Summary)
5041 @findex gnus-summary-reparent-thread
5042 Make the current article the child of the marked (or previous) article
5043 (@code{gnus-summary-reparent-thread}).
5047 The following commands are thread movement commands. They all
5048 understand the numeric prefix.
5053 @kindex T n (Summary)
5054 @findex gnus-summary-next-thread
5055 Go to the next thread (@code{gnus-summary-next-thread}).
5058 @kindex T p (Summary)
5059 @findex gnus-summary-prev-thread
5060 Go to the previous thread (@code{gnus-summary-prev-thread}).
5063 @kindex T d (Summary)
5064 @findex gnus-summary-down-thread
5065 Descend the thread (@code{gnus-summary-down-thread}).
5068 @kindex T u (Summary)
5069 @findex gnus-summary-up-thread
5070 Ascend the thread (@code{gnus-summary-up-thread}).
5073 @kindex T o (Summary)
5074 @findex gnus-summary-top-thread
5075 Go to the top of the thread (@code{gnus-summary-top-thread}).
5078 @vindex gnus-thread-operation-ignore-subject
5079 If you ignore subject while threading, you'll naturally end up with
5080 threads that have several different subjects in them. If you then issue
5081 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5082 wish to kill the entire thread, but just those parts of the thread that
5083 have the same subject as the current article. If you like this idea,
5084 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
5085 is non-@code{nil} (which it is by default), subjects will be ignored
5086 when doing thread commands. If this variable is @code{nil}, articles in
5087 the same thread with different subjects will not be included in the
5088 operation in question. If this variable is @code{fuzzy}, only articles
5089 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5096 @findex gnus-thread-sort-by-total-score
5097 @findex gnus-thread-sort-by-date
5098 @findex gnus-thread-sort-by-score
5099 @findex gnus-thread-sort-by-subject
5100 @findex gnus-thread-sort-by-author
5101 @findex gnus-thread-sort-by-number
5102 @vindex gnus-thread-sort-functions
5103 If you are using a threaded summary display, you can sort the threads by
5104 setting @code{gnus-thread-sort-functions}, which is a list of functions.
5105 By default, sorting is done on article numbers. Ready-made sorting
5106 predicate functions include @code{gnus-thread-sort-by-number},
5107 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5108 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5109 @code{gnus-thread-sort-by-total-score}.
5111 Each function takes two threads and returns non-@code{nil} if the first
5112 thread should be sorted before the other. Note that sorting really is
5113 normally done by looking only at the roots of each thread. If you use
5114 more than one function, the primary sort key should be the last function
5115 in the list. You should probably always include
5116 @code{gnus-thread-sort-by-number} in the list of sorting
5117 functions---preferably first. This will ensure that threads that are
5118 equal with respect to the other sort criteria will be displayed in
5119 ascending article order.
5121 If you would like to sort by score, then by subject, and finally by
5122 number, you could do something like:
5125 (setq gnus-thread-sort-functions
5126 '(gnus-thread-sort-by-number
5127 gnus-thread-sort-by-subject
5128 gnus-thread-sort-by-total-score))
5131 The threads that have highest score will be displayed first in the
5132 summary buffer. When threads have the same score, they will be sorted
5133 alphabetically. The threads that have the same score and the same
5134 subject will be sorted by number, which is (normally) the sequence in
5135 which the articles arrived.
5137 If you want to sort by score and then reverse arrival order, you could
5141 (setq gnus-thread-sort-functions
5143 (not (gnus-thread-sort-by-number t1 t2)))
5144 gnus-thread-sort-by-score))
5147 @vindex gnus-thread-score-function
5148 The function in the @code{gnus-thread-score-function} variable (default
5149 @code{+}) is used for calculating the total score of a thread. Useful
5150 functions might be @code{max}, @code{min}, or squared means, or whatever
5153 @findex gnus-article-sort-functions
5154 @findex gnus-article-sort-by-date
5155 @findex gnus-article-sort-by-score
5156 @findex gnus-article-sort-by-subject
5157 @findex gnus-article-sort-by-author
5158 @findex gnus-article-sort-by-number
5159 If you are using an unthreaded display for some strange reason or other,
5160 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5161 It is very similar to the @code{gnus-thread-sort-functions}, except that
5162 it uses slightly different functions for article comparison. Available
5163 sorting predicate functions are @code{gnus-article-sort-by-number},
5164 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5165 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5167 If you want to sort an unthreaded summary display by subject, you could
5171 (setq gnus-article-sort-functions
5172 '(gnus-article-sort-by-number
5173 gnus-article-sort-by-subject))
5178 @node Asynchronous Fetching
5179 @section Asynchronous Article Fetching
5180 @cindex asynchronous article fetching
5181 @cindex article pre-fetch
5184 If you read your news from an @sc{nntp} server that's far away, the
5185 network latencies may make reading articles a chore. You have to wait
5186 for a while after pressing @kbd{n} to go to the next article before the
5187 article appears. Why can't gnus just go ahead and fetch the article
5188 while you are reading the previous one? Why not, indeed.
5190 First, some caveats. There are some pitfalls to using asynchronous
5191 article fetching, especially the way gnus does it.
5193 Let's say you are reading article 1, which is short, and article 2 is
5194 quite long, and you are not interested in reading that. Gnus does not
5195 know this, so it goes ahead and fetches article 2. You decide to read
5196 article 3, but since gnus is in the process of fetching article 2, the
5197 connection is blocked.
5199 To avoid these situations, gnus will open two (count 'em two)
5200 connections to the server. Some people may think this isn't a very nice
5201 thing to do, but I don't see any real alternatives. Setting up that
5202 extra connection takes some time, so gnus startup will be slower.
5204 Gnus will fetch more articles than you will read. This will mean that
5205 the link between your machine and the @sc{nntp} server will become more
5206 loaded than if you didn't use article pre-fetch. The server itself will
5207 also become more loaded---both with the extra article requests, and the
5210 Ok, so now you know that you shouldn't really use this thing... unless
5213 @vindex gnus-asynchronous
5214 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
5215 happen automatically.
5217 @vindex gnus-use-article-prefetch
5218 You can control how many articles are to be pre-fetched by setting
5219 @code{gnus-use-article-prefetch}. This is 30 by default, which means
5220 that when you read an article in the group, the backend will pre-fetch
5221 the next 30 articles. If this variable is @code{t}, the backend will
5222 pre-fetch all the articles it can without bound. If it is
5223 @code{nil}, no pre-fetching will be done.
5225 @vindex gnus-async-prefetch-article-p
5226 @findex gnus-async-read-p
5227 There are probably some articles that you don't want to pre-fetch---read
5228 articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should
5229 return non-@code{nil} when the article in question is to be
5230 pre-fetched. The default is @code{gnus-async-read-p}, which returns
5231 @code{nil} on read articles. The function is called with an article
5232 data structure as the only parameter.
5234 If, for instance, you wish to pre-fetch only unread articles shorter
5235 than 100 lines, you could say something like:
5238 (defun my-async-short-unread-p (data)
5239 "Return non-nil for short, unread articles."
5240 (and (gnus-data-unread-p data)
5241 (< (mail-header-lines (gnus-data-header data))
5244 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5247 These functions will be called many, many times, so they should
5248 preferably be short and sweet to avoid slowing down gnus too much. It's
5249 probably a good idea to byte-compile things like this.
5251 @vindex gnus-prefetched-article-deletion-strategy
5252 Articles have to be removed from the asynch buffer sooner or later. The
5253 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5254 articles. This is a list that may contain the following elements:
5258 Remove articles when they are read.
5261 Remove articles when exiting the group.
5264 The default value is @code{(read exit)}.
5266 @c @vindex gnus-use-header-prefetch
5267 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5268 @c from the next group.
5271 @node Article Caching
5272 @section Article Caching
5273 @cindex article caching
5276 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5277 consider turning article caching on. Each article will then be stored
5278 locally under your home directory. As you may surmise, this could
5279 potentially use @emph{huge} amounts of disk space, as well as eat up all
5280 your inodes so fast it will make your head swim. In vodka.
5282 Used carefully, though, it could be just an easier way to save articles.
5284 @vindex gnus-use-long-file-name
5285 @vindex gnus-cache-directory
5286 @vindex gnus-use-cache
5287 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
5288 all articles ticked or marked as dormant will then be copied
5289 over to your local cache (@code{gnus-cache-directory}). Whether this
5290 cache is flat or hierarchal is controlled by the
5291 @code{gnus-use-long-file-name} variable, as usual.
5293 When re-selecting a ticked or dormant article, it will be fetched from the
5294 cache instead of from the server. As articles in your cache will never
5295 expire, this might serve as a method of saving articles while still
5296 keeping them where they belong. Just mark all articles you want to save
5297 as dormant, and don't worry.
5299 When an article is marked as read, is it removed from the cache.
5301 @vindex gnus-cache-remove-articles
5302 @vindex gnus-cache-enter-articles
5303 The entering/removal of articles from the cache is controlled by the
5304 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5305 variables. Both are lists of symbols. The first is @code{(ticked
5306 dormant)} by default, meaning that ticked and dormant articles will be
5307 put in the cache. The latter is @code{(read)} by default, meaning that
5308 articles marked as read are removed from the cache. Possibly
5309 symbols in these two lists are @code{ticked}, @code{dormant},
5310 @code{unread} and @code{read}.
5312 @findex gnus-jog-cache
5313 So where does the massive article-fetching and storing come into the
5314 picture? The @code{gnus-jog-cache} command will go through all
5315 subscribed newsgroups, request all unread articles, score them, and
5316 store them in the cache. You should only ever, ever ever ever, use this
5317 command if 1) your connection to the @sc{nntp} server is really, really,
5318 really slow and 2) you have a really, really, really huge disk.
5319 Seriously. One way to cut down on the number of articles downloaded is
5320 to score unwanted articles down and have them marked as read. They will
5321 not then be downloaded by this command.
5323 @vindex gnus-uncacheable-groups
5324 @vindex gnus-cacheable-groups
5325 It is likely that you do not want caching on all groups. For instance,
5326 if your @code{nnml} mail is located under your home directory, it makes no
5327 sense to cache it somewhere else under your home directory. Unless you
5328 feel that it's neat to use twice as much space.
5330 To limit the caching, you could set @code{gnus-cacheable-groups} to a
5331 regexp of groups to cache, @samp{^nntp} for instance, or set the
5332 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
5333 Both variables are @code{nil} by default. If a group matches both
5334 variables, the group is not cached.
5336 @findex gnus-cache-generate-nov-databases
5337 @findex gnus-cache-generate-active
5338 @vindex gnus-cache-active-file
5339 The cache stores information on what articles it contains in its active
5340 file (@code{gnus-cache-active-file}). If this file (or any other parts
5341 of the cache) becomes all messed up for some reason or other, gnus
5342 offers two functions that will try to set things right. @kbd{M-x
5343 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5344 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5348 @node Persistent Articles
5349 @section Persistent Articles
5350 @cindex persistent articles
5352 Closely related to article caching, we have @dfn{persistent articles}.
5353 In fact, it's just a different way of looking at caching, and much more
5354 useful in my opinion.
5356 Say you're reading a newsgroup, and you happen on to some valuable gem
5357 that you want to keep and treasure forever. You'd normally just save it
5358 (using one of the many saving commands) in some file. The problem with
5359 that is that it's just, well, yucky. Ideally you'd prefer just having
5360 the article remain in the group where you found it forever; untouched by
5361 the expiry going on at the news server.
5363 This is what a @dfn{persistent article} is---an article that just won't
5364 be deleted. It's implemented using the normal cache functions, but
5365 you use two explicit commands for managing persistent articles:
5371 @findex gnus-cache-enter-article
5372 Make the current article persistent (@code{gnus-cache-enter-article}).
5375 @kindex M-* (Summary)
5376 @findex gnus-cache-remove-article
5377 Remove the current article from the persistent articles
5378 (@code{gnus-cache-remove-article}). This will normally delete the
5382 Both these commands understand the process/prefix convention.
5384 To avoid having all ticked articles (and stuff) entered into the cache,
5385 you should set @code{gnus-use-cache} to @code{passive} if you're just
5386 interested in persistent articles:
5389 (setq gnus-use-cache 'passive)
5393 @node Article Backlog
5394 @section Article Backlog
5396 @cindex article backlog
5398 If you have a slow connection, but the idea of using caching seems
5399 unappealing to you (and it is, really), you can help the situation some
5400 by switching on the @dfn{backlog}. This is where gnus will buffer
5401 already read articles so that it doesn't have to re-fetch articles
5402 you've already read. This only helps if you are in the habit of
5403 re-selecting articles you've recently read, of course. If you never do
5404 that, turning the backlog on will slow gnus down a little bit, and
5405 increase memory usage some.
5407 @vindex gnus-keep-backlog
5408 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
5409 at most @var{n} old articles in a buffer for later re-fetching. If this
5410 variable is non-@code{nil} and is not a number, gnus will store
5411 @emph{all} read articles, which means that your Emacs will grow without
5412 bound before exploding and taking your machine down with you. I put
5413 that in there just to keep y'all on your toes.
5415 This variable is @code{nil} by default.
5418 @node Saving Articles
5419 @section Saving Articles
5420 @cindex saving articles
5422 Gnus can save articles in a number of ways. Below is the documentation
5423 for saving articles in a fairly straight-forward fashion (i.e., little
5424 processing of the article is done before it is saved). For a different
5425 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5426 (@pxref{Decoding Articles}).
5428 @vindex gnus-save-all-headers
5429 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
5430 unwanted headers before saving the article.
5432 @vindex gnus-saved-headers
5433 If the preceding variable is @code{nil}, all headers that match the
5434 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5435 deleted before saving.
5441 @kindex O o (Summary)
5443 @findex gnus-summary-save-article
5444 @c @icon{gnus-summary-save-article}
5445 Save the current article using the default article saver
5446 (@code{gnus-summary-save-article}).
5449 @kindex O m (Summary)
5450 @findex gnus-summary-save-article-mail
5451 Save the current article in mail format
5452 (@code{gnus-summary-save-article-mail}).
5455 @kindex O r (Summary)
5456 @findex gnus-summary-save-article-rmail
5457 Save the current article in rmail format
5458 (@code{gnus-summary-save-article-rmail}).
5461 @kindex O f (Summary)
5462 @findex gnus-summary-save-article-file
5463 @c @icon{gnus-summary-save-article-file}
5464 Save the current article in plain file format
5465 (@code{gnus-summary-save-article-file}).
5468 @kindex O F (Summary)
5469 @findex gnus-summary-write-article-file
5470 Write the current article in plain file format, overwriting any previous
5471 file contents (@code{gnus-summary-write-article-file}).
5474 @kindex O b (Summary)
5475 @findex gnus-summary-save-article-body-file
5476 Save the current article body in plain file format
5477 (@code{gnus-summary-save-article-body-file}).
5480 @kindex O h (Summary)
5481 @findex gnus-summary-save-article-folder
5482 Save the current article in mh folder format
5483 (@code{gnus-summary-save-article-folder}).
5486 @kindex O v (Summary)
5487 @findex gnus-summary-save-article-vm
5488 Save the current article in a VM folder
5489 (@code{gnus-summary-save-article-vm}).
5492 @kindex O p (Summary)
5493 @findex gnus-summary-pipe-output
5494 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
5495 the current article to a process (@code{gnus-summary-pipe-output}).
5498 @vindex gnus-prompt-before-saving
5499 All these commands use the process/prefix convention
5500 (@pxref{Process/Prefix}). If you save bunches of articles using these
5501 functions, you might get tired of being prompted for files to save each
5502 and every article in. The prompting action is controlled by
5503 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5504 default, giving you that excessive prompting action you know and
5505 loathe. If you set this variable to @code{t} instead, you'll be prompted
5506 just once for each series of articles you save. If you like to really
5507 have Gnus do all your thinking for you, you can even set this variable
5508 to @code{nil}, which means that you will never be prompted for files to
5509 save articles in. Gnus will simply save all the articles in the default
5513 @vindex gnus-default-article-saver
5514 You can customize the @code{gnus-default-article-saver} variable to make
5515 gnus do what you want it to. You can use any of the four ready-made
5516 functions below, or you can create your own.
5520 @item gnus-summary-save-in-rmail
5521 @findex gnus-summary-save-in-rmail
5522 @vindex gnus-rmail-save-name
5523 @findex gnus-plain-save-name
5524 This is the default format, @dfn{babyl}. Uses the function in the
5525 @code{gnus-rmail-save-name} variable to get a file name to save the
5526 article in. The default is @code{gnus-plain-save-name}.
5528 @item gnus-summary-save-in-mail
5529 @findex gnus-summary-save-in-mail
5530 @vindex gnus-mail-save-name
5531 Save in a Unix mail (mbox) file. Uses the function in the
5532 @code{gnus-mail-save-name} variable to get a file name to save the
5533 article in. The default is @code{gnus-plain-save-name}.
5535 @item gnus-summary-save-in-file
5536 @findex gnus-summary-save-in-file
5537 @vindex gnus-file-save-name
5538 @findex gnus-numeric-save-name
5539 Append the article straight to an ordinary file. Uses the function in
5540 the @code{gnus-file-save-name} variable to get a file name to save the
5541 article in. The default is @code{gnus-numeric-save-name}.
5543 @item gnus-summary-save-body-in-file
5544 @findex gnus-summary-save-body-in-file
5545 Append the article body to an ordinary file. Uses the function in the
5546 @code{gnus-file-save-name} variable to get a file name to save the
5547 article in. The default is @code{gnus-numeric-save-name}.
5549 @item gnus-summary-save-in-folder
5550 @findex gnus-summary-save-in-folder
5551 @findex gnus-folder-save-name
5552 @findex gnus-Folder-save-name
5553 @vindex gnus-folder-save-name
5556 Save the article to an MH folder using @code{rcvstore} from the MH
5557 library. Uses the function in the @code{gnus-folder-save-name} variable
5558 to get a file name to save the article in. The default is
5559 @code{gnus-folder-save-name}, but you can also use
5560 @code{gnus-Folder-save-name}, which creates capitalized names.
5562 @item gnus-summary-save-in-vm
5563 @findex gnus-summary-save-in-vm
5564 Save the article in a VM folder. You have to have the VM mail
5565 reader to use this setting.
5568 @vindex gnus-article-save-directory
5569 All of these functions, except for the last one, will save the article
5570 in the @code{gnus-article-save-directory}, which is initialized from the
5571 @code{SAVEDIR} environment variable. This is @file{~/News/} by
5574 As you can see above, the functions use different functions to find a
5575 suitable name of a file to save the article in. Below is a list of
5576 available functions that generate names:
5580 @item gnus-Numeric-save-name
5581 @findex gnus-Numeric-save-name
5582 File names like @file{~/News/Alt.andrea-dworkin/45}.
5584 @item gnus-numeric-save-name
5585 @findex gnus-numeric-save-name
5586 File names like @file{~/News/alt.andrea-dworkin/45}.
5588 @item gnus-Plain-save-name
5589 @findex gnus-Plain-save-name
5590 File names like @file{~/News/Alt.andrea-dworkin}.
5592 @item gnus-plain-save-name
5593 @findex gnus-plain-save-name
5594 File names like @file{~/News/alt.andrea-dworkin}.
5597 @vindex gnus-split-methods
5598 You can have gnus suggest where to save articles by plonking a regexp
5599 into the @code{gnus-split-methods} alist. For instance, if you would
5600 like to save articles related to gnus in the file @file{gnus-stuff}, and
5601 articles related to VM in @code{vm-stuff}, you could set this variable
5605 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5606 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5607 (my-choosing-function "../other-dir/my-stuff")
5608 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5611 We see that this is a list where each element is a list that has two
5612 elements---the @dfn{match} and the @dfn{file}. The match can either be
5613 a string (in which case it is used as a regexp to match on the article
5614 head); it can be a symbol (which will be called as a function with the
5615 group name as a parameter); or it can be a list (which will be
5616 @code{eval}ed). If any of these actions have a non-@code{nil} result,
5617 the @dfn{file} will be used as a default prompt. In addition, the
5618 result of the operation itself will be used if the function or form
5619 called returns a string or a list of strings.
5621 You basically end up with a list of file names that might be used when
5622 saving the current article. (All ``matches'' will be used.) You will
5623 then be prompted for what you really want to use as a name, with file
5624 name completion over the results from applying this variable.
5626 This variable is @code{((gnus-article-archive-name))} by default, which
5627 means that gnus will look at the articles it saves for an
5628 @code{Archive-name} line and use that as a suggestion for the file name.
5630 Here's an example function to clean up file names somewhat. If you have
5631 lots of mail groups called things like
5632 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5633 these group names before creating the file name to save to. The
5634 following will do just that:
5637 (defun my-save-name (group)
5638 (when (string-match "^nnml:mail." group)
5639 (substring group (match-end 0))))
5641 (setq gnus-split-methods
5642 '((gnus-article-archive-name)
5647 @vindex gnus-use-long-file-name
5648 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
5649 @code{nil}, all the preceding functions will replace all periods
5650 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5651 the functions will generate hierarchies of directories instead of having
5652 all the files in the top level directory
5653 (@file{~/News/alt/andrea-dworkin} instead of
5654 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
5655 on most systems. However, for historical reasons, this is @code{nil} on
5656 Xenix and usg-unix-v machines by default.
5658 This function also affects kill and score file names. If this variable
5659 is a list, and the list contains the element @code{not-score}, long file
5660 names will not be used for score files, if it contains the element
5661 @code{not-save}, long file names will not be used for saving, and if it
5662 contains the element @code{not-kill}, long file names will not be used
5665 If you'd like to save articles in a hierarchy that looks something like
5669 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5670 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5673 Then just save with @kbd{o}. You'd then read this hierarchy with
5674 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5675 the top level directory as the argument (@file{~/News/}). Then just walk
5676 around to the groups/directories with @code{nneething}.
5679 @node Decoding Articles
5680 @section Decoding Articles
5681 @cindex decoding articles
5683 Sometime users post articles (or series of articles) that have been
5684 encoded in some way or other. Gnus can decode them for you.
5687 * Uuencoded Articles:: Uudecode articles.
5688 * Shell Archives:: Unshar articles.
5689 * PostScript Files:: Split PostScript.
5690 * Other Files:: Plain save and binhex.
5691 * Decoding Variables:: Variables for a happy decoding.
5692 * Viewing Files:: You want to look at the result of the decoding?
5696 @cindex article series
5697 All these functions use the process/prefix convention
5698 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5699 the extension that a ``single article'' means ``a single series''. Gnus
5700 can find out by itself what articles belong to a series, decode all the
5701 articles and unpack/view/save the resulting file(s).
5703 Gnus guesses what articles are in the series according to the following
5704 simplish rule: The subjects must be (nearly) identical, except for the
5705 last two numbers of the line. (Spaces are largely ignored, however.)
5707 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
5708 will find all the articles that match the regexp @samp{^cat.gif
5709 ([0-9]+/[0-9]+).*$}.
5711 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5712 series}, will not be properly recognized by any of the automatic viewing
5713 commands, and you have to mark the articles manually with @kbd{#}.
5716 @node Uuencoded Articles
5717 @subsection Uuencoded Articles
5719 @cindex uuencoded articles
5724 @kindex X u (Summary)
5725 @findex gnus-uu-decode-uu
5726 @c @icon{gnus-uu-decode-uu}
5727 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5730 @kindex X U (Summary)
5731 @findex gnus-uu-decode-uu-and-save
5732 Uudecodes and saves the current series
5733 (@code{gnus-uu-decode-uu-and-save}).
5736 @kindex X v u (Summary)
5737 @findex gnus-uu-decode-uu-view
5738 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5741 @kindex X v U (Summary)
5742 @findex gnus-uu-decode-uu-and-save-view
5743 Uudecodes, views and saves the current series
5744 (@code{gnus-uu-decode-uu-and-save-view}).
5748 Remember that these all react to the presence of articles marked with
5749 the process mark. If, for instance, you'd like to decode and save an
5750 entire newsgroup, you'd typically do @kbd{M P a}
5751 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5752 (@code{gnus-uu-decode-uu-and-save}).
5754 All this is very much different from how @code{gnus-uu} worked with
5755 @sc{GNUS 4.1}, where you had explicit keystrokes for everything under
5756 the sun. This version of @code{gnus-uu} generally assumes that you mark
5757 articles in some way (@pxref{Setting Process Marks}) and then press
5760 @vindex gnus-uu-notify-files
5761 Note: When trying to decode articles that have names matching
5762 @code{gnus-uu-notify-files}, which is hard-coded to
5763 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5764 automatically post an article on @samp{comp.unix.wizards} saying that
5765 you have just viewed the file in question. This feature can't be turned
5769 @node Shell Archives
5770 @subsection Shell Archives
5772 @cindex shell archives
5773 @cindex shared articles
5775 Shell archives (``shar files'') used to be a popular way to distribute
5776 sources, but it isn't used all that much today. In any case, we have
5777 some commands to deal with these:
5782 @kindex X s (Summary)
5783 @findex gnus-uu-decode-unshar
5784 Unshars the current series (@code{gnus-uu-decode-unshar}).
5787 @kindex X S (Summary)
5788 @findex gnus-uu-decode-unshar-and-save
5789 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5792 @kindex X v s (Summary)
5793 @findex gnus-uu-decode-unshar-view
5794 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5797 @kindex X v S (Summary)
5798 @findex gnus-uu-decode-unshar-and-save-view
5799 Unshars, views and saves the current series
5800 (@code{gnus-uu-decode-unshar-and-save-view}).
5804 @node PostScript Files
5805 @subsection PostScript Files
5811 @kindex X p (Summary)
5812 @findex gnus-uu-decode-postscript
5813 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5816 @kindex X P (Summary)
5817 @findex gnus-uu-decode-postscript-and-save
5818 Unpack and save the current PostScript series
5819 (@code{gnus-uu-decode-postscript-and-save}).
5822 @kindex X v p (Summary)
5823 @findex gnus-uu-decode-postscript-view
5824 View the current PostScript series
5825 (@code{gnus-uu-decode-postscript-view}).
5828 @kindex X v P (Summary)
5829 @findex gnus-uu-decode-postscript-and-save-view
5830 View and save the current PostScript series
5831 (@code{gnus-uu-decode-postscript-and-save-view}).
5836 @subsection Other Files
5840 @kindex X o (Summary)
5841 @findex gnus-uu-decode-save
5842 Save the current series
5843 (@code{gnus-uu-decode-save}).
5846 @kindex X b (Summary)
5847 @findex gnus-uu-decode-binhex
5848 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
5849 doesn't really work yet.
5853 @node Decoding Variables
5854 @subsection Decoding Variables
5856 Adjective, not verb.
5859 * Rule Variables:: Variables that say how a file is to be viewed.
5860 * Other Decode Variables:: Other decode variables.
5861 * Uuencoding and Posting:: Variables for customizing uuencoding.
5865 @node Rule Variables
5866 @subsubsection Rule Variables
5867 @cindex rule variables
5869 Gnus uses @dfn{rule variables} to decide how to view a file. All these
5870 variables are of the form
5873 (list '(regexp1 command2)
5880 @item gnus-uu-user-view-rules
5881 @vindex gnus-uu-user-view-rules
5883 This variable is consulted first when viewing files. If you wish to use,
5884 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5887 (setq gnus-uu-user-view-rules
5888 (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5891 @item gnus-uu-user-view-rules-end
5892 @vindex gnus-uu-user-view-rules-end
5893 This variable is consulted if gnus couldn't make any matches from the
5894 user and default view rules.
5896 @item gnus-uu-user-archive-rules
5897 @vindex gnus-uu-user-archive-rules
5898 This variable can be used to say what commands should be used to unpack
5903 @node Other Decode Variables
5904 @subsubsection Other Decode Variables
5907 @vindex gnus-uu-grabbed-file-functions
5909 @item gnus-uu-grabbed-file-functions
5910 All functions in this list will be called right after each file has been
5911 successfully decoded---so that you can move or view files right away,
5912 and don't have to wait for all files to be decoded before you can do
5913 anything. Ready-made functions you can put in this list are:
5917 @item gnus-uu-grab-view
5918 @findex gnus-uu-grab-view
5921 @item gnus-uu-grab-move
5922 @findex gnus-uu-grab-move
5923 Move the file (if you're using a saving function.)
5926 @item gnus-uu-be-dangerous
5927 @vindex gnus-uu-be-dangerous
5928 Specifies what to do if unusual situations arise during decoding. If
5929 @code{nil}, be as conservative as possible. If @code{t}, ignore things
5930 that didn't work, and overwrite existing files. Otherwise, ask each
5933 @item gnus-uu-ignore-files-by-name
5934 @vindex gnus-uu-ignore-files-by-name
5935 Files with name matching this regular expression won't be viewed.
5937 @item gnus-uu-ignore-files-by-type
5938 @vindex gnus-uu-ignore-files-by-type
5939 Files with a @sc{mime} type matching this variable won't be viewed.
5940 Note that Gnus tries to guess what type the file is based on the name.
5941 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5944 @item gnus-uu-tmp-dir
5945 @vindex gnus-uu-tmp-dir
5946 Where @code{gnus-uu} does its work.
5948 @item gnus-uu-do-not-unpack-archives
5949 @vindex gnus-uu-do-not-unpack-archives
5950 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5951 looking for files to display.
5953 @item gnus-uu-view-and-save
5954 @vindex gnus-uu-view-and-save
5955 Non-@code{nil} means that the user will always be asked to save a file
5958 @item gnus-uu-ignore-default-view-rules
5959 @vindex gnus-uu-ignore-default-view-rules
5960 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5963 @item gnus-uu-ignore-default-archive-rules
5964 @vindex gnus-uu-ignore-default-archive-rules
5965 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5968 @item gnus-uu-kill-carriage-return
5969 @vindex gnus-uu-kill-carriage-return
5970 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5973 @item gnus-uu-unmark-articles-not-decoded
5974 @vindex gnus-uu-unmark-articles-not-decoded
5975 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
5976 decoded articles as unread.
5978 @item gnus-uu-correct-stripped-uucode
5979 @vindex gnus-uu-correct-stripped-uucode
5980 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5981 uuencoded files that have had trailing spaces deleted.
5983 @item gnus-uu-pre-uudecode-hook
5984 @vindex gnus-uu-pre-uudecode-hook
5985 Hook run before sending a message to @code{uudecode}.
5987 @item gnus-uu-view-with-metamail
5988 @vindex gnus-uu-view-with-metamail
5990 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5991 commands defined by the rule variables and just fudge a @sc{mime}
5992 content type based on the file name. The result will be fed to
5993 @code{metamail} for viewing.
5995 @item gnus-uu-save-in-digest
5996 @vindex gnus-uu-save-in-digest
5997 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5998 decoding, will save in digests. If this variable is @code{nil},
5999 @code{gnus-uu} will just save everything in a file without any
6000 embellishments. The digesting almost conforms to RFC1153---no easy way
6001 to specify any meaningful volume and issue numbers were found, so I
6002 simply dropped them.
6007 @node Uuencoding and Posting
6008 @subsubsection Uuencoding and Posting
6012 @item gnus-uu-post-include-before-composing
6013 @vindex gnus-uu-post-include-before-composing
6014 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6015 before you compose the article. If this variable is @code{t}, you can
6016 either include an encoded file with @kbd{C-c C-i} or have one included
6017 for you when you post the article.
6019 @item gnus-uu-post-length
6020 @vindex gnus-uu-post-length
6021 Maximum length of an article. The encoded file will be split into how
6022 many articles it takes to post the entire file.
6024 @item gnus-uu-post-threaded
6025 @vindex gnus-uu-post-threaded
6026 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6027 thread. This may not be smart, as no other decoder I have seen is able
6028 to follow threads when collecting uuencoded articles. (Well, I have
6029 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6030 think that counts...) Default is @code{nil}.
6032 @item gnus-uu-post-separate-description
6033 @vindex gnus-uu-post-separate-description
6034 Non-@code{nil} means that the description will be posted in a separate
6035 article. The first article will typically be numbered (0/x). If this
6036 variable is @code{nil}, the description the user enters will be included
6037 at the beginning of the first article, which will be numbered (1/x).
6038 Default is @code{t}.
6044 @subsection Viewing Files
6045 @cindex viewing files
6046 @cindex pseudo-articles
6048 After decoding, if the file is some sort of archive, gnus will attempt
6049 to unpack the archive and see if any of the files in the archive can be
6050 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
6051 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
6052 uncompress and de-tar the main file, and then view the two pictures.
6053 This unpacking process is recursive, so if the archive contains archives
6054 of archives, it'll all be unpacked.
6056 Finally, gnus will normally insert a @dfn{pseudo-article} for each
6057 extracted file into the summary buffer. If you go to these
6058 ``articles'', you will be prompted for a command to run (usually Gnus
6059 will make a suggestion), and then the command will be run.
6061 @vindex gnus-view-pseudo-asynchronously
6062 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6063 until the viewing is done before proceeding.
6065 @vindex gnus-view-pseudos
6066 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6067 the pseudo-articles into the summary buffer, but view them
6068 immediately. If this variable is @code{not-confirm}, the user won't even
6069 be asked for a confirmation before viewing is done.
6071 @vindex gnus-view-pseudos-separately
6072 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6073 pseudo-article will be created for each file to be viewed. If
6074 @code{nil}, all files that use the same viewing command will be given as
6075 a list of parameters to that command.
6077 @vindex gnus-insert-pseudo-articles
6078 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6079 pseudo-articles when decoding. It is @code{t} by default.
6081 So; there you are, reading your @emph{pseudo-articles} in your
6082 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6083 Why isn't anything real anymore? How did we get here?
6086 @node Article Treatment
6087 @section Article Treatment
6089 Reading through this huge manual, you may have quite forgotten that the
6090 object of newsreaders is to actually, like, read what people have
6091 written. Reading articles. Unfortunately, people are quite bad at
6092 writing, so there are tons of functions and variables to make reading
6093 these articles easier.
6096 * Article Highlighting:: You want to make the article look like fruit salad.
6097 * Article Fontisizing:: Making emphasized text look nice.
6098 * Article Hiding:: You also want to make certain info go away.
6099 * Article Washing:: Lots of way-neat functions to make life better.
6100 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
6101 * Article Date:: Grumble, UT!
6102 * Article Signature:: What is a signature?
6106 @node Article Highlighting
6107 @subsection Article Highlighting
6108 @cindex highlighting
6110 Not only do you want your article buffer to look like fruit salad, but
6111 you want it to look like technicolor fruit salad.
6116 @kindex W H a (Summary)
6117 @findex gnus-article-highlight
6118 @findex gnus-article-maybe-highlight
6119 Do much highlighting of the current article
6120 (@code{gnus-article-highlight}). This function highlights header, cited
6121 text, the signature, and adds buttons to the body and the head.
6123 Most users would prefer using @code{gnus-article-maybe-highlight} in
6124 @code{gnus-article-display-hook} (@pxref{Customizing Articles}) instead.
6125 This is a bit less agressive---it highlights only the headers, the
6126 signature and adds buttons.
6129 @kindex W H h (Summary)
6130 @findex gnus-article-highlight-headers
6131 @vindex gnus-header-face-alist
6132 Highlight the headers (@code{gnus-article-highlight-headers}). The
6133 highlighting will be done according to the @code{gnus-header-face-alist}
6134 variable, which is a list where each element has the form @var{(regexp
6135 name content)}. @var{regexp} is a regular expression for matching the
6136 header, @var{name} is the face used for highlighting the header name
6137 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6138 the header value. The first match made will be used. Note that
6139 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6142 @kindex W H c (Summary)
6143 @findex gnus-article-highlight-citation
6144 Highlight cited text (@code{gnus-article-highlight-citation}).
6146 Some variables to customize the citation highlights:
6149 @vindex gnus-cite-parse-max-size
6151 @item gnus-cite-parse-max-size
6152 If the article size if bigger than this variable (which is 25000 by
6153 default), no citation highlighting will be performed.
6155 @item gnus-cite-prefix-regexp
6156 @vindex gnus-cite-prefix-regexp
6157 Regexp matching the longest possible citation prefix on a line.
6159 @item gnus-cite-max-prefix
6160 @vindex gnus-cite-max-prefix
6161 Maximum possible length for a citation prefix (default 20).
6163 @item gnus-cite-face-list
6164 @vindex gnus-cite-face-list
6165 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6166 When there are citations from multiple articles in the same message,
6167 gnus will try to give each citation from each article its own face.
6168 This should make it easier to see who wrote what.
6170 @item gnus-supercite-regexp
6171 @vindex gnus-supercite-regexp
6172 Regexp matching normal Supercite attribution lines.
6174 @item gnus-supercite-secondary-regexp
6175 @vindex gnus-supercite-secondary-regexp
6176 Regexp matching mangled Supercite attribution lines.
6178 @item gnus-cite-minimum-match-count
6179 @vindex gnus-cite-minimum-match-count
6180 Minimum number of identical prefixes we have to see before we believe
6181 that it's a citation.
6183 @item gnus-cite-attribution-prefix
6184 @vindex gnus-cite-attribution-prefix
6185 Regexp matching the beginning of an attribution line.
6187 @item gnus-cite-attribution-suffix
6188 @vindex gnus-cite-attribution-suffix
6189 Regexp matching the end of an attribution line.
6191 @item gnus-cite-attribution-face
6192 @vindex gnus-cite-attribution-face
6193 Face used for attribution lines. It is merged with the face for the
6194 cited text belonging to the attribution.
6200 @kindex W H s (Summary)
6201 @vindex gnus-signature-separator
6202 @vindex gnus-signature-face
6203 @findex gnus-article-highlight-signature
6204 Highlight the signature (@code{gnus-article-highlight-signature}).
6205 Everything after @code{gnus-signature-separator} (@pxref{Article
6206 Signature}) in an article will be considered a signature and will be
6207 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6212 @xref{Customizing Articles} for how to highlight articles automatically.
6215 @node Article Fontisizing
6216 @subsection Article Fontisizing
6218 @cindex article emphasis
6220 @findex gnus-article-emphasize
6221 @kindex W e (Summary)
6222 People commonly add emphasis to words in news articles by writing things
6223 like @samp{_this_} or @samp{*this*}. Gnus can make this look nicer by
6224 running the article through the @kbd{W e}
6225 (@code{gnus-article-emphasize}) command.
6227 @vindex gnus-emphasis-alist
6228 How the emphasis is computed is controlled by the
6229 @code{gnus-emphasis-alist} variable. This is an alist where the first
6230 element is a regular expression to be matched. The second is a number
6231 that says what regular expression grouping is used to find the entire
6232 emphasized word. The third is a number that says what regexp grouping
6233 should be displayed and highlighted. (The text between these two
6234 groupings will be hidden.) The fourth is the face used for
6238 (setq gnus-article-emphasis
6239 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6240 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6243 @vindex gnus-emphasis-underline
6244 @vindex gnus-emphasis-bold
6245 @vindex gnus-emphasis-italic
6246 @vindex gnus-emphasis-underline-bold
6247 @vindex gnus-emphasis-underline-italic
6248 @vindex gnus-emphasis-bold-italic
6249 @vindex gnus-emphasis-underline-bold-italic
6250 By default, there are seven rules, and they use the following faces:
6251 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6252 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6253 @code{gnus-emphasis-underline-italic},
6254 @code{gnus-emphasis-underline-bold}, and
6255 @code{gnus-emphasis-underline-bold-italic}.
6257 If you want to change these faces, you can either use @kbd{M-x
6258 customize}, or you can use @code{copy-face}. For instance, if you want
6259 to make @code{gnus-emphasis-italic} use a red face instead, you could
6263 (copy-face 'red 'gnus-emphasis-italic)
6266 @xref{Customizing Articles} for how to fontize articles automatically.
6269 @node Article Hiding
6270 @subsection Article Hiding
6271 @cindex article hiding
6273 Or rather, hiding certain things in each article. There usually is much
6274 too much cruft in most articles.
6279 @kindex W W a (Summary)
6280 @findex gnus-article-hide
6281 Do quite a lot of hiding on the article buffer
6282 (@kbd{gnus-article-hide}). In particular, this function will hide
6283 headers, PGP, cited text and the signature.
6286 @kindex W W h (Summary)
6287 @findex gnus-article-hide-headers
6288 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
6292 @kindex W W b (Summary)
6293 @findex gnus-article-hide-boring-headers
6294 Hide headers that aren't particularly interesting
6295 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
6298 @kindex W W s (Summary)
6299 @findex gnus-article-hide-signature
6300 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
6304 @kindex W W p (Summary)
6305 @findex gnus-article-hide-pgp
6306 @vindex gnus-article-hide-pgp-hook
6307 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). The
6308 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6309 signature has been hidden.
6312 @kindex W W P (Summary)
6313 @findex gnus-article-hide-pem
6314 Hide @sc{pem} (privacy enhanced messages) cruft
6315 (@code{gnus-article-hide-pem}).
6318 @kindex W W c (Summary)
6319 @findex gnus-article-hide-citation
6320 Hide citation (@code{gnus-article-hide-citation}). Some variables for
6321 customizing the hiding:
6325 @item gnus-cited-opened-text-button-line-format
6326 @itemx gnus-cited-closed-text-button-line-format
6327 @vindex gnus-cited-closed-text-button-line-format
6328 @vindex gnus-cited-opened-text-button-line-format
6329 Gnus adds buttons to show where the cited text has been hidden, and to
6330 allow toggle hiding the text. The format of the variable is specified
6331 by these format-like variable (@pxref{Formatting Variables}). These
6336 Starting point of the hidden text.
6338 Ending point of the hidden text.
6340 Number of characters in the hidden region.
6342 Number of lines of hidden text.
6345 @item gnus-cited-lines-visible
6346 @vindex gnus-cited-lines-visible
6347 The number of lines at the beginning of the cited text to leave shown.
6352 @kindex W W C-c (Summary)
6353 @findex gnus-article-hide-citation-maybe
6355 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
6356 following two variables:
6359 @item gnus-cite-hide-percentage
6360 @vindex gnus-cite-hide-percentage
6361 If the cited text is of a bigger percentage than this variable (default
6362 50), hide the cited text.
6364 @item gnus-cite-hide-absolute
6365 @vindex gnus-cite-hide-absolute
6366 The cited text must have at least this length (default 10) before it
6371 @kindex W W C (Summary)
6372 @findex gnus-article-hide-citation-in-followups
6373 Hide cited text in articles that aren't roots
6374 (@code{gnus-article-hide-citation-in-followups}). This isn't very
6375 useful as an interactive command, but might be a handy function to stick
6376 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}).
6380 All these ``hiding'' commands are toggles, but if you give a negative
6381 prefix to these commands, they will show what they have previously
6382 hidden. If you give a positive prefix, they will always hide.
6384 Also @pxref{Article Highlighting} for further variables for
6385 citation customization.
6387 @xref{Customizing Articles} for how to hide article elements
6391 @node Article Washing
6392 @subsection Article Washing
6394 @cindex article washing
6396 We call this ``article washing'' for a really good reason. Namely, the
6397 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6399 @dfn{Washing} is defined by us as ``changing something from something to
6400 something else'', but normally results in something looking better.
6406 @kindex W l (Summary)
6407 @findex gnus-summary-stop-page-breaking
6408 Remove page breaks from the current article
6409 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article} for page
6413 @kindex W r (Summary)
6414 @findex gnus-summary-caesar-message
6415 @c @icon{gnus-summary-caesar-message}
6416 Do a Caesar rotate (rot13) on the article buffer
6417 (@code{gnus-summary-caesar-message}).
6418 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6419 (Typically offensive jokes and such.)
6421 It's commonly called ``rot13'' because each letter is rotated 13
6422 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6423 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
6424 is rumored to have employed this form of, uh, somewhat weak encryption.
6427 @kindex W t (Summary)
6428 @findex gnus-summary-toggle-header
6429 Toggle whether to display all headers in the article buffer
6430 (@code{gnus-summary-toggle-header}).
6433 @kindex W v (Summary)
6434 @findex gnus-summary-verbose-header
6435 Toggle whether to display all headers in the article buffer permanently
6436 (@code{gnus-summary-verbose-header}).
6439 @kindex W m (Summary)
6440 @findex gnus-summary-toggle-mime
6441 Toggle whether to display the article as @sc{mime} message
6442 (@code{gnus-summary-toggle-mime}).
6445 @kindex W o (Summary)
6446 @findex gnus-article-treat-overstrike
6447 Treat overstrike (@code{gnus-article-treat-overstrike}).
6450 @kindex W d (Summary)
6451 @findex gnus-article-treat-dumbquotes
6452 Treat M******** sm*rtq**t*s (@code{gnus-article-treat-dumbquotes}).
6455 @kindex W w (Summary)
6456 @findex gnus-article-fill-cited-article
6457 Do word wrap (@code{gnus-article-fill-cited-article}). If you use this
6458 function in @code{gnus-article-display-hook}, it should be run fairly
6459 late and certainly after any highlighting.
6461 You can give the command a numerical prefix to specify the width to use
6465 @kindex W c (Summary)
6466 @findex gnus-article-remove-cr
6467 Remove CR (i. e., @samp{^M}s on the end of the lines)
6468 (@code{gnus-article-remove-cr}).
6471 @kindex W f (Summary)
6473 @findex gnus-article-display-x-face
6474 @findex gnus-article-x-face-command
6475 @vindex gnus-article-x-face-command
6476 @vindex gnus-article-x-face-too-ugly
6482 Look for and display any X-Face headers
6483 (@code{gnus-article-display-x-face}). The command executed by this
6484 function is given by the @code{gnus-article-x-face-command} variable.
6485 If this variable is a string, this string will be executed in a
6486 sub-shell. If it is a function, this function will be called with the
6487 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
6488 is a regexp) matches the @code{From} header, the face will not be shown.
6489 The default action under Emacs is to fork off an @code{xv} to view the
6490 face; under XEmacs the default action is to display the face before the
6491 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
6492 support---that will make display somewhat faster. If there's no native
6493 X-Face support, Gnus will try to convert the @code{X-Face} header using
6494 external programs from the @code{pbmplus} package and friends.) If you
6495 want to have this function in the display hook, it should probably come
6499 @kindex W b (Summary)
6500 @findex gnus-article-add-buttons
6501 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6502 @xref{Article Buttons}
6505 @kindex W B (Summary)
6506 @findex gnus-article-add-buttons-to-head
6507 Add clickable buttons to the article headers
6508 (@code{gnus-article-add-buttons-to-head}).
6511 @kindex W E l (Summary)
6512 @findex gnus-article-strip-leading-blank-lines
6513 Remove all blank lines from the beginning of the article
6514 (@code{gnus-article-strip-leading-blank-lines}).
6517 @kindex W E m (Summary)
6518 @findex gnus-article-strip-multiple-blank-lines
6519 Replace all blank lines with empty lines and then all multiple empty
6520 lines with a single empty line.
6521 (@code{gnus-article-strip-multiple-blank-lines}).
6524 @kindex W E t (Summary)
6525 @findex gnus-article-remove-trailing-blank-lines
6526 Remove all blank lines at the end of the article
6527 (@code{gnus-article-remove-trailing-blank-lines}).
6530 @kindex W E a (Summary)
6531 @findex gnus-article-strip-blank-lines
6532 Do all the three commands above
6533 (@code{gnus-article-strip-blank-lines}).
6536 @kindex W E A (Summary)
6537 @findex gnus-article-strip-all-blank-lines
6538 Remove all blank lines
6539 (@code{gnus-article-strip-all-blank-lines}).
6542 @kindex W E s (Summary)
6543 @findex gnus-article-strip-leading-space
6544 Remove all white space from the beginning of all lines of the article
6545 body (@code{gnus-article-strip-leading-space}).
6549 @xref{Customizing Articles} for how to wash articles automatically.
6552 @node Article Buttons
6553 @subsection Article Buttons
6556 People often include references to other stuff in articles, and it would
6557 be nice if Gnus could just fetch whatever it is that people talk about
6558 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6559 button on these references.
6561 Gnus adds @dfn{buttons} to certain standard references by default:
6562 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
6563 two variables, one that handles article bodies and one that handles
6568 @item gnus-button-alist
6569 @vindex gnus-button-alist
6570 This is an alist where each entry has this form:
6573 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6579 All text that match this regular expression will be considered an
6580 external reference. Here's a typical regexp that matches embedded URLs:
6581 @samp{<URL:\\([^\n\r>]*\\)>}.
6584 Gnus has to know which parts of the matches is to be highlighted. This
6585 is a number that says what sub-expression of the regexp is to be
6586 highlighted. If you want it all highlighted, you use 0 here.
6589 This form will be @code{eval}ed, and if the result is non-@code{nil},
6590 this is considered a match. This is useful if you want extra sifting to
6591 avoid false matches.
6594 This function will be called when you click on this button.
6597 As with @var{button-par}, this is a sub-expression number, but this one
6598 says which part of the match is to be sent as data to @var{function}.
6602 So the full entry for buttonizing URLs is then
6605 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6608 @item gnus-header-button-alist
6609 @vindex gnus-header-button-alist
6610 This is just like the other alist, except that it is applied to the
6611 article head only, and that each entry has an additional element that is
6612 used to say what headers to apply the buttonize coding to:
6615 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6618 @var{HEADER} is a regular expression.
6620 @item gnus-button-url-regexp
6621 @vindex gnus-button-url-regexp
6622 A regular expression that matches embedded URLs. It is used in the
6623 default values of the variables above.
6625 @item gnus-article-button-face
6626 @vindex gnus-article-button-face
6627 Face used on buttons.
6629 @item gnus-article-mouse-face
6630 @vindex gnus-article-mouse-face
6631 Face used when the mouse cursor is over a button.
6635 @xref{Customizing Articles} for how to buttonize articles automatically.
6639 @subsection Article Date
6641 The date is most likely generated in some obscure timezone you've never
6642 heard of, so it's quite nice to be able to find out what the time was
6643 when the article was sent.
6648 @kindex W T u (Summary)
6649 @findex gnus-article-date-ut
6650 Display the date in UT (aka. GMT, aka ZULU)
6651 (@code{gnus-article-date-ut}).
6654 @kindex W T i (Summary)
6655 @findex gnus-article-date-iso8601
6657 Display the date in international format, aka. ISO 8601
6658 (@code{gnus-article-date-iso8601}).
6661 @kindex W T l (Summary)
6662 @findex gnus-article-date-local
6663 Display the date in the local timezone (@code{gnus-article-date-local}).
6666 @kindex W T s (Summary)
6667 @vindex gnus-article-time-format
6668 @findex gnus-article-date-user
6669 @findex format-time-string
6670 Display the date using a user-defined format
6671 (@code{gnus-article-date-user}). The format is specified by the
6672 @code{gnus-article-time-format} variable, and is a string that's passed
6673 to @code{format-time-string}. See the documentation of that variable
6674 for a list of possible format specs.
6677 @kindex W T e (Summary)
6678 @findex gnus-article-date-lapsed
6679 @findex gnus-start-date-timer
6680 @findex gnus-stop-date-timer
6681 Say how much time has elapsed between the article was posted and now
6682 (@code{gnus-article-date-lapsed}). If you want to have this line
6683 updated continually, you can put
6686 (gnus-start-date-timer)
6689 in your @file{.gnus.el} file, or you can run it off of some hook. If
6690 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
6694 @kindex W T o (Summary)
6695 @findex gnus-article-date-original
6696 Display the original date (@code{gnus-article-date-original}). This can
6697 be useful if you normally use some other conversion function and are
6698 worried that it might be doing something totally wrong. Say, claiming
6699 that the article was posted in 1854. Although something like that is
6700 @emph{totally} impossible. Don't you trust me? *titter*
6704 @xref{Customizing Articles} for how to display the date in your
6705 preferred format automatically.
6708 @node Article Signature
6709 @subsection Article Signature
6711 @cindex article signature
6713 @vindex gnus-signature-separator
6714 Each article is divided into two parts---the head and the body. The
6715 body can be divided into a signature part and a text part. The variable
6716 that says what is to be considered a signature is
6717 @code{gnus-signature-separator}. This is normally the standard
6718 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
6719 non-standard signature separators, so this variable can also be a list
6720 of regular expressions to be tested, one by one. (Searches are done
6721 from the end of the body towards the beginning.) One likely value is:
6724 (setq gnus-signature-separator
6725 '("^-- $" ; The standard
6726 "^-- *$" ; A common mangling
6727 "^-------*$" ; Many people just use a looong
6728 ; line of dashes. Shame!
6729 "^ *--------*$" ; Double-shame!
6730 "^________*$" ; Underscores are also popular
6731 "^========*$")) ; Pervert!
6734 The more permissive you are, the more likely it is that you'll get false
6737 @vindex gnus-signature-limit
6738 @code{gnus-signature-limit} provides a limit to what is considered a
6743 If it is an integer, no signature may be longer (in characters) than
6746 If it is a floating point number, no signature may be longer (in lines)
6749 If it is a function, the function will be called without any parameters,
6750 and if it returns @code{nil}, there is no signature in the buffer.
6752 If it is a string, it will be used as a regexp. If it matches, the text
6753 in question is not a signature.
6756 This variable can also be a list where the elements may be of the types
6757 listed above. Here's an example:
6760 (setq gnus-signature-limit
6761 '(200.0 "^---*Forwarded article"))
6764 This means that if there are more than 200 lines after the signature
6765 separator, or the text after the signature separator is matched by
6766 the regular expression @samp{^---*Forwarded article}, then it isn't a
6767 signature after all.
6771 @section MIME Commands
6772 @cindex MIME decoding
6776 @kindex W M w (Summary)
6777 Decode RFC2047-encoded words in the article headers
6778 (@code{gnus-article-decode-mime-words}).
6781 @kindex W M c (Summary)
6782 Decode encoded article bodies as well as charsets
6783 (@code{gnus-article-decode-charset}).
6785 This command looks in the @code{Content-Type} header to determine the
6786 charset. If there is no such header in the article, you can give it a
6787 prefix, which will prompt for the charset to decode as. In regional
6788 groups where people post using some common encoding (but do not include
6789 MIME headers), you can set the @code{charset} group/topic parameter to
6790 the required charset (@pxref{Group Parameters}).
6795 @node Article Commands
6796 @section Article Commands
6803 @kindex A P (Summary)
6804 @vindex gnus-ps-print-hook
6805 @findex gnus-summary-print-article
6806 Generate and print a PostScript image of the article buffer
6807 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
6808 run just before printing the buffer.
6813 @node Summary Sorting
6814 @section Summary Sorting
6815 @cindex summary sorting
6817 You can have the summary buffer sorted in various ways, even though I
6818 can't really see why you'd want that.
6823 @kindex C-c C-s C-n (Summary)
6824 @findex gnus-summary-sort-by-number
6825 Sort by article number (@code{gnus-summary-sort-by-number}).
6828 @kindex C-c C-s C-a (Summary)
6829 @findex gnus-summary-sort-by-author
6830 Sort by author (@code{gnus-summary-sort-by-author}).
6833 @kindex C-c C-s C-s (Summary)
6834 @findex gnus-summary-sort-by-subject
6835 Sort by subject (@code{gnus-summary-sort-by-subject}).
6838 @kindex C-c C-s C-d (Summary)
6839 @findex gnus-summary-sort-by-date
6840 Sort by date (@code{gnus-summary-sort-by-date}).
6843 @kindex C-c C-s C-l (Summary)
6844 @findex gnus-summary-sort-by-lines
6845 Sort by lines (@code{gnus-summary-sort-by-lines}).
6848 @kindex C-c C-s C-i (Summary)
6849 @findex gnus-summary-sort-by-score
6850 Sort by score (@code{gnus-summary-sort-by-score}).
6853 These functions will work both when you use threading and when you don't
6854 use threading. In the latter case, all summary lines will be sorted,
6855 line by line. In the former case, sorting will be done on a
6856 root-by-root basis, which might not be what you were looking for. To
6857 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6861 @node Finding the Parent
6862 @section Finding the Parent
6863 @cindex parent articles
6864 @cindex referring articles
6869 @findex gnus-summary-refer-parent-article
6870 If you'd like to read the parent of the current article, and it is not
6871 displayed in the summary buffer, you might still be able to. That is,
6872 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6873 and the @code{References} in the current article are not mangled, you
6874 can just press @kbd{^} or @kbd{A r}
6875 (@code{gnus-summary-refer-parent-article}). If everything goes well,
6876 you'll get the parent. If the parent is already displayed in the
6877 summary buffer, point will just move to this article.
6879 If given a positive numerical prefix, fetch that many articles back into
6880 the ancestry. If given a negative numerical prefix, fetch just that
6881 ancestor. So if you say @kbd{3 ^}, gnus will fetch the parent, the
6882 grandparent and the grandgrandparent of the current article. If you say
6883 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
6887 @findex gnus-summary-refer-references
6888 @kindex A R (Summary)
6889 Fetch all articles mentioned in the @code{References} header of the
6890 article (@code{gnus-summary-refer-references}).
6893 @findex gnus-summary-refer-thread
6894 @kindex A T (Summary)
6895 Display the full thread where the current article appears
6896 (@code{gnus-summary-refer-thread}). This command has to fetch all the
6897 headers in the current group to work, so it usually takes a while. If
6898 you do it often, you may consider setting @code{gnus-fetch-old-headers}
6899 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
6900 visible effects normally, but it'll make this command work a whole lot
6901 faster. Of course, it'll make group entry somewhat slow.
6903 @vindex gnus-refer-thread-limit
6904 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
6905 articles before the first displayed in the current group) headers to
6906 fetch when doing this command. The default is 200. If @code{t}, all
6907 the available headers will be fetched. This variable can be overridden
6908 by giving the @kbd{A T} command a numerical prefix.
6911 @findex gnus-summary-refer-article
6912 @kindex M-^ (Summary)
6914 @cindex fetching by Message-ID
6915 You can also ask the @sc{nntp} server for an arbitrary article, no
6916 matter what group it belongs to. @kbd{M-^}
6917 (@code{gnus-summary-refer-article}) will ask you for a
6918 @code{Message-ID}, which is one of those long, hard-to-read thingies
6919 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
6920 have to get it all exactly right. No fuzzy searches, I'm afraid.
6923 The current select method will be used when fetching by
6924 @code{Message-ID} from non-news select method, but you can override this
6925 by giving this command a prefix.
6927 @vindex gnus-refer-article-method
6928 If the group you are reading is located on a backend that does not
6929 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6930 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
6931 would, perhaps, be best if the @sc{nntp} server you consult is the one
6932 updating the spool you are reading from, but that's not really
6935 Most of the mail backends support fetching by @code{Message-ID}, but do
6936 not do a particularly excellent job at it. That is, @code{nnmbox} and
6937 @code{nnbabyl} are able to locate articles from any groups, while
6938 @code{nnml} and @code{nnfolder} are only able to locate articles that
6939 have been posted to the current group. (Anything else would be too time
6940 consuming.) @code{nnmh} does not support this at all.
6943 @node Alternative Approaches
6944 @section Alternative Approaches
6946 Different people like to read news using different methods. This being
6947 gnus, we offer a small selection of minor modes for the summary buffers.
6950 * Pick and Read:: First mark articles and then read them.
6951 * Binary Groups:: Auto-decode all articles.
6956 @subsection Pick and Read
6957 @cindex pick and read
6959 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
6960 a two-phased reading interface. The user first marks in a summary
6961 buffer the articles she wants to read. Then she starts reading the
6962 articles with just an article buffer displayed.
6964 @findex gnus-pick-mode
6965 @kindex M-x gnus-pick-mode
6966 Gnus provides a summary buffer minor mode that allows
6967 this---@code{gnus-pick-mode}. This basically means that a few process
6968 mark commands become one-keystroke commands to allow easy marking, and
6969 it provides one additional command for switching to the summary buffer.
6971 Here are the available keystrokes when using pick mode:
6976 @findex gnus-pick-article-or-thread
6977 Pick the article or thread on the current line
6978 (@code{gnus-pick-article-or-thread}). If the variable
6979 @code{gnus-thread-hide-subtree} is true, then this key selects the
6980 entire thread when used at the first article of the thread. Otherwise,
6981 it selects just the article. If given a numerical prefix, go to that
6982 thread or article and pick it. (The line number is normally displayed
6983 at the beginning of the summary pick lines.)
6986 @kindex SPACE (Pick)
6987 @findex gnus-pick-next-page
6988 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
6989 at the end of the buffer, start reading the picked articles.
6993 @findex gnus-pick-unmark-article-or-thread.
6994 Unpick the thread or article
6995 (@code{gnus-pick-unmark-article-or-thread}). If the variable
6996 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
6997 thread if used at the first article of the thread. Otherwise it unpicks
6998 just the article. You can give this key a numerical prefix to unpick
6999 the thread or article at that line.
7003 @findex gnus-pick-start-reading
7004 @vindex gnus-pick-display-summary
7005 Start reading the picked articles (@code{gnus-pick-start-reading}). If
7006 given a prefix, mark all unpicked articles as read first. If
7007 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
7008 will still be visible when you are reading.
7012 All the normal summary mode commands are still available in the
7013 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
7014 which is mapped to the same function
7015 @code{gnus-summary-tick-article-forward}.
7017 If this sounds like a good idea to you, you could say:
7020 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
7023 @vindex gnus-pick-mode-hook
7024 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
7026 @vindex gnus-mark-unpicked-articles-as-read
7027 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
7028 all unpicked articles as read. The default is @code{nil}.
7030 @vindex gnus-summary-pick-line-format
7031 The summary line format in pick mode is slightly different from the
7032 standard format. At the beginning of each line the line number is
7033 displayed. The pick mode line format is controlled by the
7034 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
7035 Variables}). It accepts the same format specs that
7036 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
7040 @subsection Binary Groups
7041 @cindex binary groups
7043 @findex gnus-binary-mode
7044 @kindex M-x gnus-binary-mode
7045 If you spend much time in binary groups, you may grow tired of hitting
7046 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
7047 is a minor mode for summary buffers that makes all ordinary Gnus article
7048 selection functions uudecode series of articles and display the result
7049 instead of just displaying the articles the normal way.
7052 @findex gnus-binary-show-article
7053 The only way, in fact, to see the actual articles is the @kbd{g}
7054 command, when you have turned on this mode
7055 (@code{gnus-binary-show-article}).
7057 @vindex gnus-binary-mode-hook
7058 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
7062 @section Tree Display
7065 @vindex gnus-use-trees
7066 If you don't like the normal gnus summary display, you might try setting
7067 @code{gnus-use-trees} to @code{t}. This will create (by default) an
7068 additional @dfn{tree buffer}. You can execute all summary mode commands
7071 There are a few variables to customize the tree display, of course:
7074 @item gnus-tree-mode-hook
7075 @vindex gnus-tree-mode-hook
7076 A hook called in all tree mode buffers.
7078 @item gnus-tree-mode-line-format
7079 @vindex gnus-tree-mode-line-format
7080 A format string for the mode bar in the tree mode buffers (@pxref{Mode
7081 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
7082 of valid specs, @pxref{Summary Buffer Mode Line}.
7084 @item gnus-selected-tree-face
7085 @vindex gnus-selected-tree-face
7086 Face used for highlighting the selected article in the tree buffer. The
7087 default is @code{modeline}.
7089 @item gnus-tree-line-format
7090 @vindex gnus-tree-line-format
7091 A format string for the tree nodes. The name is a bit of a misnomer,
7092 though---it doesn't define a line, but just the node. The default value
7093 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
7094 the name of the poster. It is vital that all nodes are of the same
7095 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
7101 The name of the poster.
7103 The @code{From} header.
7105 The number of the article.
7107 The opening bracket.
7109 The closing bracket.
7114 @xref{Formatting Variables}.
7116 Variables related to the display are:
7119 @item gnus-tree-brackets
7120 @vindex gnus-tree-brackets
7121 This is used for differentiating between ``real'' articles and
7122 ``sparse'' articles. The format is @var{((real-open . real-close)
7123 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
7124 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7126 @item gnus-tree-parent-child-edges
7127 @vindex gnus-tree-parent-child-edges
7128 This is a list that contains the characters used for connecting parent
7129 nodes to their children. The default is @code{(?- ?\\ ?|)}.
7133 @item gnus-tree-minimize-window
7134 @vindex gnus-tree-minimize-window
7135 If this variable is non-@code{nil}, gnus will try to keep the tree
7136 buffer as small as possible to allow more room for the other gnus
7137 windows. If this variable is a number, the tree buffer will never be
7138 higher than that number. The default is @code{t}. Note that if you
7139 have several windows displayed side-by-side in a frame and the tree
7140 buffer is one of these, minimizing the tree window will also resize all
7141 other windows displayed next to it.
7143 @item gnus-generate-tree-function
7144 @vindex gnus-generate-tree-function
7145 @findex gnus-generate-horizontal-tree
7146 @findex gnus-generate-vertical-tree
7147 The function that actually generates the thread tree. Two predefined
7148 functions are available: @code{gnus-generate-horizontal-tree} and
7149 @code{gnus-generate-vertical-tree} (which is the default).
7153 Here's an example from a horizontal tree buffer:
7156 @{***@}-(***)-[odd]-[Gun]
7166 Here's the same thread displayed in a vertical tree buffer:
7170 |--------------------------\-----\-----\
7171 (***) [Bjo] [Gun] [Gun]
7173 [odd] [Jan] [odd] (***) [Jor]
7175 [Gun] [Eri] [Eri] [odd]
7180 If you're using horizontal trees, it might be nice to display the trees
7181 side-by-side with the summary buffer. You could add something like the
7182 following to your @file{.gnus.el} file:
7185 (setq gnus-use-trees t
7186 gnus-generate-tree-function 'gnus-generate-horizontal-tree
7187 gnus-tree-minimize-window nil)
7188 (gnus-add-configuration
7192 (summary 0.75 point)
7197 @xref{Windows Configuration}.
7200 @node Mail Group Commands
7201 @section Mail Group Commands
7202 @cindex mail group commands
7204 Some commands only make sense in mail groups. If these commands are
7205 invalid in the current group, they will raise a hell and let you know.
7207 All these commands (except the expiry and edit commands) use the
7208 process/prefix convention (@pxref{Process/Prefix}).
7213 @kindex B e (Summary)
7214 @findex gnus-summary-expire-articles
7215 Expire all expirable articles in the group
7216 (@code{gnus-summary-expire-articles}).
7219 @kindex B M-C-e (Summary)
7220 @findex gnus-summary-expire-articles-now
7221 Delete all the expirable articles in the group
7222 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
7223 articles eligible for expiry in the current group will
7224 disappear forever into that big @file{/dev/null} in the sky.
7227 @kindex B DEL (Summary)
7228 @findex gnus-summary-delete-article
7229 @c @icon{gnus-summary-mail-delete}
7230 Delete the mail article. This is ``delete'' as in ``delete it from your
7231 disk forever and ever, never to return again.'' Use with caution.
7232 (@code{gnus-summary-delete-article}).
7235 @kindex B m (Summary)
7237 @findex gnus-summary-move-article
7238 Move the article from one mail group to another
7239 (@code{gnus-summary-move-article}).
7242 @kindex B c (Summary)
7244 @findex gnus-summary-copy-article
7245 @c @icon{gnus-summary-mail-copy}
7246 Copy the article from one group (mail group or not) to a mail group
7247 (@code{gnus-summary-copy-article}).
7250 @kindex B B (Summary)
7251 @cindex crosspost mail
7252 @findex gnus-summary-crosspost-article
7253 Crosspost the current article to some other group
7254 (@code{gnus-summary-crosspost-article}). This will create a new copy of
7255 the article in the other group, and the Xref headers of the article will
7256 be properly updated.
7259 @kindex B i (Summary)
7260 @findex gnus-summary-import-article
7261 Import an arbitrary file into the current mail newsgroup
7262 (@code{gnus-summary-import-article}). You will be prompted for a file
7263 name, a @code{From} header and a @code{Subject} header.
7266 @kindex B r (Summary)
7267 @findex gnus-summary-respool-article
7268 Respool the mail article (@code{gnus-summary-respool-article}).
7269 @code{gnus-summary-respool-default-method} will be used as the default
7270 select method when respooling. This variable is @code{nil} by default,
7271 which means that the current group select method will be used instead.
7275 @kindex B w (Summary)
7277 @findex gnus-summary-edit-article
7278 @kindex C-c C-c (Article)
7279 Edit the current article (@code{gnus-summary-edit-article}). To finish
7280 editing and make the changes permanent, type @kbd{C-c C-c}
7281 (@kbd{gnus-summary-edit-article-done}). If you give a prefix to the
7282 @kbd{C-c C-c} command, gnus won't re-highlight the article.
7285 @kindex B q (Summary)
7286 @findex gnus-summary-respool-query
7287 If you want to re-spool an article, you might be curious as to what group
7288 the article will end up in before you do the re-spooling. This command
7289 will tell you (@code{gnus-summary-respool-query}).
7292 @kindex B t (Summary)
7293 @findex gnus-summary-respool-trace
7294 Similarly, this command will display all fancy splitting patterns used
7295 when repooling, if any (@code{gnus-summary-respool-trace}).
7298 @kindex B p (Summary)
7299 @findex gnus-summary-article-posted-p
7300 Some people have a tendency to send you "courtesy" copies when they
7301 follow up to articles you have posted. These usually have a
7302 @code{Newsgroups} header in them, but not always. This command
7303 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7304 article from your news server (or rather, from
7305 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7306 report back whether it found the article or not. Even if it says that
7307 it didn't find the article, it may have been posted anyway---mail
7308 propagation is much faster than news propagation, and the news copy may
7309 just not have arrived yet.
7313 @vindex gnus-move-split-methods
7314 @cindex moving articles
7315 If you move (or copy) articles regularly, you might wish to have gnus
7316 suggest where to put the articles. @code{gnus-move-split-methods} is a
7317 variable that uses the same syntax as @code{gnus-split-methods}
7318 (@pxref{Saving Articles}). You may customize that variable to create
7319 suggestions you find reasonable.
7322 (setq gnus-move-split-methods
7323 '(("^From:.*Lars Magne" "nnml:junk")
7324 ("^Subject:.*gnus" "nnfolder:important")
7325 (".*" "nnml:misc")))
7329 @node Various Summary Stuff
7330 @section Various Summary Stuff
7333 * Summary Group Information:: Information oriented commands.
7334 * Searching for Articles:: Multiple article commands.
7335 * Summary Generation Commands:: (Re)generating the summary buffer.
7336 * Really Various Summary Commands:: Those pesky non-conformant commands.
7340 @vindex gnus-summary-mode-hook
7341 @item gnus-summary-mode-hook
7342 This hook is called when creating a summary mode buffer.
7344 @vindex gnus-summary-generate-hook
7345 @item gnus-summary-generate-hook
7346 This is called as the last thing before doing the threading and the
7347 generation of the summary buffer. It's quite convenient for customizing
7348 the threading variables based on what data the newsgroup has. This hook
7349 is called from the summary buffer after most summary buffer variables
7352 @vindex gnus-summary-prepare-hook
7353 @item gnus-summary-prepare-hook
7354 It is called after the summary buffer has been generated. You might use
7355 it to, for instance, highlight lines or modify the look of the buffer in
7356 some other ungodly manner. I don't care.
7358 @vindex gnus-summary-ignore-duplicates
7359 @item gnus-summary-ignore-duplicates
7360 When gnus discovers two articles that have the same @code{Message-ID},
7361 it has to do something drastic. No articles are allowed to have the
7362 same @code{Message-ID}, but this may happen when reading mail from some
7363 sources. Gnus allows you to customize what happens with this variable.
7364 If it is @code{nil} (which is the default), gnus will rename the
7365 @code{Message-ID} (for display purposes only) and display the article as
7366 any other article. If this variable is @code{t}, it won't display the
7367 article---it'll be as if it never existed.
7372 @node Summary Group Information
7373 @subsection Summary Group Information
7378 @kindex H f (Summary)
7379 @findex gnus-summary-fetch-faq
7380 @vindex gnus-group-faq-directory
7381 Try to fetch the FAQ (list of frequently asked questions) for the
7382 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
7383 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7384 on a remote machine. This variable can also be a list of directories.
7385 In that case, giving a prefix to this command will allow you to choose
7386 between the various sites. @code{ange-ftp} or @code{efs} will probably
7387 be used for fetching the file.
7390 @kindex H d (Summary)
7391 @findex gnus-summary-describe-group
7392 Give a brief description of the current group
7393 (@code{gnus-summary-describe-group}). If given a prefix, force
7394 rereading the description from the server.
7397 @kindex H h (Summary)
7398 @findex gnus-summary-describe-briefly
7399 Give an extremely brief description of the most important summary
7400 keystrokes (@code{gnus-summary-describe-briefly}).
7403 @kindex H i (Summary)
7404 @findex gnus-info-find-node
7405 Go to the gnus info node (@code{gnus-info-find-node}).
7409 @node Searching for Articles
7410 @subsection Searching for Articles
7415 @kindex M-s (Summary)
7416 @findex gnus-summary-search-article-forward
7417 Search through all subsequent articles for a regexp
7418 (@code{gnus-summary-search-article-forward}).
7421 @kindex M-r (Summary)
7422 @findex gnus-summary-search-article-backward
7423 Search through all previous articles for a regexp
7424 (@code{gnus-summary-search-article-backward}).
7428 @findex gnus-summary-execute-command
7429 This command will prompt you for a header field, a regular expression to
7430 match on this field, and a command to be executed if the match is made
7431 (@code{gnus-summary-execute-command}). If given a prefix, search
7435 @kindex M-& (Summary)
7436 @findex gnus-summary-universal-argument
7437 Perform any operation on all articles that have been marked with
7438 the process mark (@code{gnus-summary-universal-argument}).
7441 @node Summary Generation Commands
7442 @subsection Summary Generation Commands
7447 @kindex Y g (Summary)
7448 @findex gnus-summary-prepare
7449 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7452 @kindex Y c (Summary)
7453 @findex gnus-summary-insert-cached-articles
7454 Pull all cached articles (for the current group) into the summary buffer
7455 (@code{gnus-summary-insert-cached-articles}).
7460 @node Really Various Summary Commands
7461 @subsection Really Various Summary Commands
7466 @kindex C-d (Summary)
7467 @findex gnus-summary-enter-digest-group
7468 If the current article is a collection of other articles (for instance,
7469 a digest), you might use this command to enter a group based on the that
7470 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
7471 guess what article type is currently displayed unless you give a prefix
7472 to this command, which forces a ``digest'' interpretation. Basically,
7473 whenever you see a message that is a collection of other messages of
7474 some format, you @kbd{C-d} and read these messages in a more convenient
7478 @kindex M-C-d (Summary)
7479 @findex gnus-summary-read-document
7480 This command is very similar to the one above, but lets you gather
7481 several documents into one biiig group
7482 (@code{gnus-summary-read-document}). It does this by opening several
7483 @code{nndoc} groups for each document, and then opening an
7484 @code{nnvirtual} group on top of these @code{nndoc} groups. This
7485 command understands the process/prefix convention
7486 (@pxref{Process/Prefix}).
7489 @kindex C-t (Summary)
7490 @findex gnus-summary-toggle-truncation
7491 Toggle truncation of summary lines
7492 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
7493 line centering function in the summary buffer, so it's not a good idea
7494 to have truncation switched off while reading articles.
7498 @findex gnus-summary-expand-window
7499 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7500 If given a prefix, force an @code{article} window configuration.
7503 @kindex M-C-e (Summary)
7504 @findex gnus-summary-edit-parameters
7505 Edit the group parameters (@pxref{Group Parameters}) of the current
7506 group (@code{gnus-summary-edit-parameters}).
7511 @node Exiting the Summary Buffer
7512 @section Exiting the Summary Buffer
7513 @cindex summary exit
7514 @cindex exiting groups
7516 Exiting from the summary buffer will normally update all info on the
7517 group and return you to the group buffer.
7523 @kindex Z Z (Summary)
7525 @findex gnus-summary-exit
7526 @vindex gnus-summary-exit-hook
7527 @vindex gnus-summary-prepare-exit-hook
7528 @c @icon{gnus-summary-exit}
7529 Exit the current group and update all information on the group
7530 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7531 called before doing much of the exiting, which calls
7532 @code{gnus-summary-expire-articles} by default.
7533 @code{gnus-summary-exit-hook} is called after finishing the exit
7534 process. @code{gnus-group-no-more-groups-hook} is run when returning to
7535 group mode having no more (unread) groups.
7539 @kindex Z E (Summary)
7541 @findex gnus-summary-exit-no-update
7542 Exit the current group without updating any information on the group
7543 (@code{gnus-summary-exit-no-update}).
7547 @kindex Z c (Summary)
7549 @findex gnus-summary-catchup-and-exit
7550 @c @icon{gnus-summary-catchup-and-exit}
7551 Mark all unticked articles in the group as read and then exit
7552 (@code{gnus-summary-catchup-and-exit}).
7555 @kindex Z C (Summary)
7556 @findex gnus-summary-catchup-all-and-exit
7557 Mark all articles, even the ticked ones, as read and then exit
7558 (@code{gnus-summary-catchup-all-and-exit}).
7561 @kindex Z n (Summary)
7562 @findex gnus-summary-catchup-and-goto-next-group
7563 Mark all articles as read and go to the next group
7564 (@code{gnus-summary-catchup-and-goto-next-group}).
7567 @kindex Z R (Summary)
7568 @findex gnus-summary-reselect-current-group
7569 Exit this group, and then enter it again
7570 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
7571 all articles, both read and unread.
7575 @kindex Z G (Summary)
7576 @kindex M-g (Summary)
7577 @findex gnus-summary-rescan-group
7578 @c @icon{gnus-summary-mail-get}
7579 Exit the group, check for new articles in the group, and select the
7580 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
7581 articles, both read and unread.
7584 @kindex Z N (Summary)
7585 @findex gnus-summary-next-group
7586 Exit the group and go to the next group
7587 (@code{gnus-summary-next-group}).
7590 @kindex Z P (Summary)
7591 @findex gnus-summary-prev-group
7592 Exit the group and go to the previous group
7593 (@code{gnus-summary-prev-group}).
7596 @kindex Z s (Summary)
7597 @findex gnus-summary-save-newsrc
7598 Save the current number of read/marked articles in the dribble buffer
7599 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
7600 given a prefix, also save the @file{.newsrc} file(s). Using this
7601 command will make exit without updating (the @kbd{Q} command) worthless.
7604 @vindex gnus-exit-group-hook
7605 @code{gnus-exit-group-hook} is called when you exit the current
7608 @findex gnus-summary-wake-up-the-dead
7609 @findex gnus-dead-summary-mode
7610 @vindex gnus-kill-summary-on-exit
7611 If you're in the habit of exiting groups, and then changing your mind
7612 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
7613 If you do that, gnus won't kill the summary buffer when you exit it.
7614 (Quelle surprise!) Instead it will change the name of the buffer to
7615 something like @samp{*Dead Summary ... *} and install a minor mode
7616 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
7617 buffer, you'll find that all keys are mapped to a function called
7618 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
7619 summary buffer will result in a live, normal summary buffer.
7621 There will never be more than one dead summary buffer at any one time.
7623 @vindex gnus-use-cross-reference
7624 The data on the current group will be updated (which articles you have
7625 read, which articles you have replied to, etc.) when you exit the
7626 summary buffer. If the @code{gnus-use-cross-reference} variable is
7627 @code{t} (which is the default), articles that are cross-referenced to
7628 this group and are marked as read, will also be marked as read in the
7629 other subscribed groups they were cross-posted to. If this variable is
7630 neither @code{nil} nor @code{t}, the article will be marked as read in
7631 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7634 @node Crosspost Handling
7635 @section Crosspost Handling
7639 Marking cross-posted articles as read ensures that you'll never have to
7640 read the same article more than once. Unless, of course, somebody has
7641 posted it to several groups separately. Posting the same article to
7642 several groups (not cross-posting) is called @dfn{spamming}, and you are
7643 by law required to send nasty-grams to anyone who perpetrates such a
7644 heinous crime. You may want to try NoCeM handling to filter out spam
7647 Remember: Cross-posting is kinda ok, but posting the same article
7648 separately to several groups is not. Massive cross-posting (aka.
7649 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7650 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7651 excessive crossposting (@pxref{Summary Mail Commands}).
7653 @cindex cross-posting
7656 One thing that may cause Gnus to not do the cross-posting thing
7657 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7658 (which is very nice, because it speeds things up considerably) which
7659 does not include the @code{Xref} header in its @sc{nov} lines. This is
7660 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
7661 even with @sc{xover} by registering the @code{Xref} lines of all
7662 articles you actually read, but if you kill the articles, or just mark
7663 them as read without reading them, Gnus will not get a chance to snoop
7664 the @code{Xref} lines out of these articles, and will be unable to use
7665 the cross reference mechanism.
7667 @cindex LIST overview.fmt
7668 @cindex overview.fmt
7669 To check whether your @sc{nntp} server includes the @code{Xref} header
7670 in its overview files, try @samp{telnet your.nntp.server nntp},
7671 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7672 overview.fmt}. This may not work, but if it does, and the last line you
7673 get does not read @samp{Xref:full}, then you should shout and whine at
7674 your news admin until she includes the @code{Xref} header in the
7677 @vindex gnus-nov-is-evil
7678 If you want Gnus to get the @code{Xref}s right all the time, you have to
7679 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7684 For an alternative approach, @pxref{Duplicate Suppression}.
7687 @node Duplicate Suppression
7688 @section Duplicate Suppression
7690 By default, gnus tries to make sure that you don't have to read the same
7691 article more than once by utilizing the crossposting mechanism
7692 (@pxref{Crosspost Handling}). However, that simple and efficient
7693 approach may not work satisfactory for some users for various reasons.
7697 The @sc{nntp} server may fail to generate the @code{Xref} header. This
7698 is evil and not very common.
7701 The @sc{nntp} server may fail to include the @code{Xref} header in the
7702 @file{.overview} data bases. This is evil and all too common, alas.
7705 You may be reading the same group (or several related groups) from
7706 different @sc{nntp} servers.
7709 You may be getting mail that duplicates articles posted to groups.
7712 I'm sure there are other situations where @code{Xref} handling fails as
7713 well, but these four are the most common situations.
7715 If, and only if, @code{Xref} handling fails for you, then you may
7716 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
7717 will remember the @code{Message-ID}s of all articles you have read or
7718 otherwise marked as read, and then, as if by magic, mark them as read
7719 all subsequent times you see them---in @emph{all} groups. Using this
7720 mechanism is quite likely to be somewhat inefficient, but not overly
7721 so. It's certainly preferable to reading the same articles more than
7724 Duplicate suppression is not a very subtle instrument. It's more like a
7725 sledge hammer than anything else. It works in a very simple
7726 fashion---if you have marked an article as read, it adds this Message-ID
7727 to a cache. The next time it sees this Message-ID, it will mark the
7728 article as read with the @samp{M} mark. It doesn't care what group it
7732 @item gnus-suppress-duplicates
7733 @vindex gnus-suppress-duplicates
7734 If non-@code{nil}, suppress duplicates.
7736 @item gnus-save-duplicate-list
7737 @vindex gnus-save-duplicate-list
7738 If non-@code{nil}, save the list of duplicates to a file. This will
7739 make startup and shutdown take longer, so the default is @code{nil}.
7740 However, this means that only duplicate articles read in a single gnus
7741 session are suppressed.
7743 @item gnus-duplicate-list-length
7744 @vindex gnus-duplicate-list-length
7745 This variable says how many @code{Message-ID}s to keep in the duplicate
7746 suppression list. The default is 10000.
7748 @item gnus-duplicate-file
7749 @vindex gnus-duplicate-file
7750 The name of the file to store the duplicate suppression list in. The
7751 default is @file{~/News/suppression}.
7754 If you have a tendency to stop and start gnus often, setting
7755 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
7756 you leave gnus running for weeks on end, you may have it @code{nil}. On
7757 the other hand, saving the list makes startup and shutdown much slower,
7758 so that means that if you stop and start gnus often, you should set
7759 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
7760 to you to figure out, I think.
7763 @node The Article Buffer
7764 @chapter The Article Buffer
7765 @cindex article buffer
7767 The articles are displayed in the article buffer, of which there is only
7768 one. All the summary buffers share the same article buffer unless you
7769 tell gnus otherwise.
7772 * Hiding Headers:: Deciding what headers should be displayed.
7773 * Using MIME:: Pushing to mime articles as @sc{mime} messages.
7774 * Customizing Articles:: Tailoring the look of the articles.
7775 * Article Keymap:: Keystrokes available in the article buffer.
7776 * Misc Article:: Other stuff.
7780 @node Hiding Headers
7781 @section Hiding Headers
7782 @cindex hiding headers
7783 @cindex deleting headers
7785 The top section of each article is the @dfn{head}. (The rest is the
7786 @dfn{body}, but you may have guessed that already.)
7788 @vindex gnus-show-all-headers
7789 There is a lot of useful information in the head: the name of the person
7790 who wrote the article, the date it was written and the subject of the
7791 article. That's well and nice, but there's also lots of information
7792 most people do not want to see---what systems the article has passed
7793 through before reaching you, the @code{Message-ID}, the
7794 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7795 of some of those lines. If you want to keep all those lines in the
7796 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7798 Gnus provides you with two variables for sifting headers:
7802 @item gnus-visible-headers
7803 @vindex gnus-visible-headers
7804 If this variable is non-@code{nil}, it should be a regular expression
7805 that says what headers you wish to keep in the article buffer. All
7806 headers that do not match this variable will be hidden.
7808 For instance, if you only want to see the name of the person who wrote
7809 the article and the subject, you'd say:
7812 (setq gnus-visible-headers "^From:\\|^Subject:")
7815 This variable can also be a list of regexps to match headers to
7818 @item gnus-ignored-headers
7819 @vindex gnus-ignored-headers
7820 This variable is the reverse of @code{gnus-visible-headers}. If this
7821 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7822 should be a regular expression that matches all lines that you want to
7823 hide. All lines that do not match this variable will remain visible.
7825 For instance, if you just want to get rid of the @code{References} field
7826 and the @code{Xref} field, you might say:
7829 (setq gnus-ignored-headers "^References:\\|^Xref:")
7832 This variable can also be a list of regexps to match headers to
7835 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7836 variable will have no effect.
7840 @vindex gnus-sorted-header-list
7841 Gnus can also sort the headers for you. (It does this by default.) You
7842 can control the sorting by setting the @code{gnus-sorted-header-list}
7843 variable. It is a list of regular expressions that says in what order
7844 the headers are to be displayed.
7846 For instance, if you want the name of the author of the article first,
7847 and then the subject, you might say something like:
7850 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7853 Any headers that are to remain visible, but are not listed in this
7854 variable, will be displayed in random order after all the headers listed
7857 @findex gnus-article-hide-boring-headers
7858 @vindex gnus-article-display-hook
7859 @vindex gnus-boring-article-headers
7860 You can hide further boring headers by entering
7861 @code{gnus-article-hide-boring-headers} into
7862 @code{gnus-article-display-hook}. What this function does depends on
7863 the @code{gnus-boring-article-headers} variable. It's a list, but this
7864 list doesn't actually contain header names. Instead is lists various
7865 @dfn{boring conditions} that gnus can check and remove from sight.
7867 These conditions are:
7870 Remove all empty headers.
7872 Remove the @code{Followup-To} header if it is identical to the
7873 @code{Newsgroups} header.
7875 Remove the @code{Reply-To} header if it lists the same address as the
7878 Remove the @code{Newsgroups} header if it only contains the current group
7881 Remove the @code{Date} header if the article is less than three days
7884 Remove the @code{To} header if it is very long.
7886 Remove all @code{To} headers if there are more than one.
7889 To include the four three elements, you could say something like;
7892 (setq gnus-boring-article-headers
7893 '(empty followup-to reply-to))
7896 This is also the default value for this variable.
7900 @section Using @sc{mime}
7903 Mime is a standard for waving your hands through the air, aimlessly,
7904 while people stand around yawning.
7906 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7907 while all newsreaders die of fear.
7909 @sc{mime} may specify what character set the article uses, the encoding
7910 of the characters, and it also makes it possible to embed pictures and
7911 other naughty stuff in innocent-looking articles.
7913 @vindex gnus-show-mime
7914 @vindex gnus-article-display-method-for-mime
7915 @vindex gnus-strict-mime
7916 @findex gnus-article-display-mime-message
7917 Gnus handles @sc{mime} by pushing the articles through
7918 @code{gnus-article-display-method-for-mime}, which is
7919 @code{gnus-article-display-mime-message} by default. This function
7920 calls the SEMI MIME-View program to actually do the work. For more
7921 information on SEMI MIME-View, see its manual page (however it is not
7922 existed yet, sorry).
7924 Set @code{gnus-show-mime} to @code{t} if you want to use
7925 @sc{mime} all the time. However, if @code{gnus-strict-mime} is
7926 non-@code{nil}, the @sc{mime} method will only be used if there are
7927 @sc{mime} headers in the article. If you have @code{gnus-show-mime}
7928 set, then you'll see some unfortunate display glitches in the article
7929 buffer. These can't be avoided.
7931 In GNUS or Gnus, it might be best to just use the toggling functions
7932 from the summary buffer to avoid getting nasty surprises. (For instance,
7933 you enter the group @samp{alt.sing-a-long} and, before you know it,
7934 @sc{mime} has decoded the sound file in the article and some horrible
7935 sing-a-long song comes screaming out your speakers, and you can't find
7936 the volume button, because there isn't one, and people are starting to
7937 look at you, and you try to stop the program, but you can't, and you
7938 can't find the program to control the volume, and everybody else in the
7939 room suddenly decides to look at you disdainfully, and you'll feel
7942 Any similarity to real events and people is purely coincidental. Ahem.
7944 To avoid such kind of situation, gnus stops to use
7945 @code{metamail-buffer}. So now, you can set @code{gnus-show-mime} to
7946 non-@code{nil} every-time, then you can push button in the article
7947 buffer when there are nobody else.
7950 @node Customizing Articles
7951 @section Customizing Articles
7952 @cindex article customization
7954 @vindex gnus-article-display-hook
7955 The @code{gnus-article-display-hook} is called after the article has
7956 been inserted into the article buffer. It is meant to handle all
7957 treatment of the article before it is displayed.
7959 @findex gnus-article-maybe-highlight
7960 @findex gnus-article-maybe-hide-headers
7961 By default this hook just contains
7962 @code{gnus-article-maybe-hide-headers},
7963 @code{gnus-hide-boring-headers}, @code{gnus-article-treat-overstrike},
7964 and @code{gnus-article-maybe-highlight} (and under XEmacs,
7965 @code{gnus-article-display-x-face}), but there are thousands, nay
7966 millions, of functions you can put in this hook. For an overview of
7967 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7968 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7969 Date}. Note that the order of functions in this hook might affect
7970 things, so you may have to fiddle a bit to get the desired results.
7972 You can, of course, write your own functions. The functions are called
7973 from the article buffer, and you can do anything you like, pretty much.
7974 There is no information that you have to keep in the buffer---you can
7975 change everything. However, you shouldn't delete any headers. Instead
7976 make them invisible if you want to make them go away.
7979 @node Article Keymap
7980 @section Article Keymap
7982 Most of the keystrokes in the summary buffer can also be used in the
7983 article buffer. They should behave as if you typed them in the summary
7984 buffer, which means that you don't actually have to have a summary
7985 buffer displayed while reading. You can do it all from the article
7988 A few additional keystrokes are available:
7993 @kindex SPACE (Article)
7994 @findex gnus-article-next-page
7995 Scroll forwards one page (@code{gnus-article-next-page}).
7998 @kindex DEL (Article)
7999 @findex gnus-article-prev-page
8000 Scroll backwards one page (@code{gnus-article-prev-page}).
8003 @kindex C-c ^ (Article)
8004 @findex gnus-article-refer-article
8005 If point is in the neighborhood of a @code{Message-ID} and you press
8006 @kbd{C-c ^}, Gnus will try to get that article from the server
8007 (@code{gnus-article-refer-article}).
8010 @kindex C-c C-m (Article)
8011 @findex gnus-article-mail
8012 Send a reply to the address near point (@code{gnus-article-mail}). If
8013 given a prefix, include the mail.
8017 @findex gnus-article-show-summary
8018 Reconfigure the buffers so that the summary buffer becomes visible
8019 (@code{gnus-article-show-summary}).
8023 @findex gnus-article-describe-briefly
8024 Give a very brief description of the available keystrokes
8025 (@code{gnus-article-describe-briefly}).
8028 @kindex TAB (Article)
8029 @findex gnus-article-next-button
8030 Go to the next button, if any (@code{gnus-article-next-button}). This
8031 only makes sense if you have buttonizing turned on.
8034 @kindex M-TAB (Article)
8035 @findex gnus-article-prev-button
8036 Go to the previous button, if any (@code{gnus-article-prev-button}).
8042 @section Misc Article
8046 @item gnus-single-article-buffer
8047 @vindex gnus-single-article-buffer
8048 If non-@code{nil}, use the same article buffer for all the groups.
8049 (This is the default.) If @code{nil}, each group will have its own
8052 @vindex gnus-article-prepare-hook
8053 @item gnus-article-prepare-hook
8054 This hook is called right after the article has been inserted into the
8055 article buffer. It is mainly intended for functions that do something
8056 depending on the contents; it should probably not be used for changing
8057 the contents of the article buffer.
8059 @vindex gnus-article-display-hook
8060 @item gnus-article-display-hook
8061 This hook is called as the last thing when displaying an article, and is
8062 intended for modifying the contents of the buffer, doing highlights,
8063 hiding headers, and the like.
8065 @item gnus-article-mode-hook
8066 @vindex gnus-article-mode-hook
8067 Hook called in article mode buffers.
8069 @item gnus-article-mode-syntax-table
8070 @vindex gnus-article-mode-syntax-table
8071 Syntax table used in article buffers. It is initialized from
8072 @code{text-mode-syntax-table}.
8074 @vindex gnus-article-mode-line-format
8075 @item gnus-article-mode-line-format
8076 This variable is a format string along the same lines as
8077 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
8078 accepts the same format specifications as that variable, with one
8083 The @dfn{wash status} of the article. This is a short string with one
8084 character for each possible article wash operation that may have been
8088 @vindex gnus-break-pages
8090 @item gnus-break-pages
8091 Controls whether @dfn{page breaking} is to take place. If this variable
8092 is non-@code{nil}, the articles will be divided into pages whenever a
8093 page delimiter appears in the article. If this variable is @code{nil},
8094 paging will not be done.
8096 @item gnus-page-delimiter
8097 @vindex gnus-page-delimiter
8098 This is the delimiter mentioned above. By default, it is @samp{^L}
8103 @node Composing Messages
8104 @chapter Composing Messages
8105 @cindex composing messages
8108 @cindex sending mail
8113 @kindex C-c C-c (Post)
8114 All commands for posting and mailing will put you in a message buffer
8115 where you can edit the article all you like, before you send the article
8116 by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The Message
8117 Manual}. If you are in a foreign news group, and you wish to post the
8118 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
8119 to make gnus try to post using the foreign server.
8122 * Mail:: Mailing and replying.
8123 * Post:: Posting and following up.
8124 * Posting Server:: What server should you post via?
8125 * Mail and Post:: Mailing and posting at the same time.
8126 * Archived Messages:: Where gnus stores the messages you've sent.
8127 * Posting Styles:: An easier way to specify who you are.
8128 * Drafts:: Postponing messages and rejected messages.
8129 * Rejected Articles:: What happens if the server doesn't like your article?
8132 Also see @pxref{Canceling and Superseding} for information on how to
8133 remove articles you shouldn't have posted.
8139 Variables for customizing outgoing mail:
8142 @item gnus-uu-digest-headers
8143 @vindex gnus-uu-digest-headers
8144 List of regexps to match headers included in digested messages. The
8145 headers will be included in the sequence they are matched.
8147 @item gnus-add-to-list
8148 @vindex gnus-add-to-list
8149 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8150 that have none when you do a @kbd{a}.
8158 Variables for composing news articles:
8161 @item gnus-sent-message-ids-file
8162 @vindex gnus-sent-message-ids-file
8163 Gnus will keep a @code{Message-ID} history file of all the mails it has
8164 sent. If it discovers that it has already sent a mail, it will ask the
8165 user whether to re-send the mail. (This is primarily useful when
8166 dealing with @sc{soup} packets and the like where one is apt to send the
8167 same packet multiple times.) This variable says what the name of this
8168 history file is. It is @file{~/News/Sent-Message-IDs} by default. Set
8169 this variable to @code{nil} if you don't want gnus to keep a history
8172 @item gnus-sent-message-ids-length
8173 @vindex gnus-sent-message-ids-length
8174 This variable says how many @code{Message-ID}s to keep in the history
8175 file. It is 1000 by default.
8180 @node Posting Server
8181 @section Posting Server
8183 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8184 (extremely intelligent, of course) article, where does it go?
8186 Thank you for asking. I hate you.
8188 @vindex gnus-post-method
8190 It can be quite complicated. Normally, gnus will use the same native
8191 server. However. If your native server doesn't allow posting, just
8192 reading, you probably want to use some other server to post your
8193 (extremely intelligent and fabulously interesting) articles. You can
8194 then set the @code{gnus-post-method} to some other method:
8197 (setq gnus-post-method '(nnspool ""))
8200 Now, if you've done this, and then this server rejects your article, or
8201 this server is down, what do you do then? To override this variable you
8202 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8203 the ``current'' server for posting.
8205 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8206 gnus will prompt you for what method to use for posting.
8208 You can also set @code{gnus-post-method} to a list of select methods.
8209 If that's the case, gnus will always prompt you for what method to use
8212 Finally, if you want to always post using the same select method as
8213 you're reading from (which might be convenient if you're reading lots of
8214 groups from different private servers), you can set this variable to
8219 @section Mail and Post
8221 Here's a list of variables relevant to both mailing and
8225 @item gnus-mailing-list-groups
8226 @findex gnus-mailing-list-groups
8227 @cindex mailing lists
8229 If your news server offers groups that are really mailing lists
8230 gatewayed to the @sc{nntp} server, you can read those groups without
8231 problems, but you can't post/followup to them without some difficulty.
8232 One solution is to add a @code{to-address} to the group parameters
8233 (@pxref{Group Parameters}). An easier thing to do is set the
8234 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8235 really are mailing lists. Then, at least, followups to the mailing
8236 lists will work most of the time. Posting to these groups (@kbd{a}) is
8237 still a pain, though.
8241 You may want to do spell-checking on messages that you send out. Or, if
8242 you don't want to spell-check by hand, you could add automatic
8243 spell-checking via the @code{ispell} package:
8246 @findex ispell-message
8248 (add-hook 'message-send-hook 'ispell-message)
8252 @node Archived Messages
8253 @section Archived Messages
8254 @cindex archived messages
8255 @cindex sent messages
8257 Gnus provides a few different methods for storing the mail and news you
8258 send. The default method is to use the @dfn{archive virtual server} to
8259 store the messages. If you want to disable this completely, the
8260 @code{gnus-message-archive-group} variable should be @code{nil}, which
8263 @vindex gnus-message-archive-method
8264 @code{gnus-message-archive-method} says what virtual server gnus is to
8265 use to store sent messages. The default is:
8269 (nnfolder-directory "~/Mail/archive")
8270 (nnfolder-active-file "~/Mail/archive/active")
8271 (nnfolder-get-new-mail nil)
8272 (nnfolder-inhibit-expiry t))
8275 You can, however, use any mail select method (@code{nnml},
8276 @code{nnmbox}, etc.). @code{nnfolder} is a quite likeable select method
8277 for doing this sort of thing, though. If you don't like the default
8278 directory chosen, you could say something like:
8281 (setq gnus-message-archive-method
8282 '(nnfolder "archive"
8283 (nnfolder-inhibit-expiry t)
8284 (nnfolder-active-file "~/News/sent-mail/active")
8285 (nnfolder-directory "~/News/sent-mail/")))
8288 @vindex gnus-message-archive-group
8290 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8291 to one or more group(s) on that server. Which group to use is
8292 determined by the @code{gnus-message-archive-group} variable.
8294 This variable can be used to do the following:
8298 Messages will be saved in that group.
8299 @item a list of strings
8300 Messages will be saved in all those groups.
8301 @item an alist of regexps, functions and forms
8302 When a key ``matches'', the result is used.
8304 No message archiving will take place. This is the default.
8309 Just saving to a single group called @samp{MisK}:
8311 (setq gnus-message-archive-group "MisK")
8314 Saving to two groups, @samp{MisK} and @samp{safe}:
8316 (setq gnus-message-archive-group '("MisK" "safe"))
8319 Save to different groups based on what group you are in:
8321 (setq gnus-message-archive-group
8322 '(("^alt" "sent-to-alt")
8323 ("mail" "sent-to-mail")
8324 (".*" "sent-to-misc")))
8329 (setq gnus-message-archive-group
8330 '((if (message-news-p)
8335 How about storing all news messages in one file, but storing all mail
8336 messages in one file per month:
8339 (setq gnus-message-archive-group
8340 '((if (message-news-p)
8342 (concat "mail." (format-time-string
8343 "%Y-%m" (current-time))))))
8346 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8347 use a different value for @code{gnus-message-archive-group} there.)
8349 Now, when you send a message off, it will be stored in the appropriate
8350 group. (If you want to disable storing for just one particular message,
8351 you can just remove the @code{Gcc} header that has been inserted.) The
8352 archive group will appear in the group buffer the next time you start
8353 gnus, or the next time you press @kbd{F} in the group buffer. You can
8354 enter it and read the articles in it just like you'd read any other
8355 group. If the group gets really big and annoying, you can simply rename
8356 if (using @kbd{G r} in the group buffer) to something
8357 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
8358 continue to be stored in the old (now empty) group.
8360 That's the default method of archiving sent messages. Gnus offers a
8361 different way for the people who don't like the default method. In that
8362 case you should set @code{gnus-message-archive-group} to @code{nil};
8363 this will disable archiving.
8366 @item gnus-outgoing-message-group
8367 @vindex gnus-outgoing-message-group
8368 All outgoing messages will be put in this group. If you want to store
8369 all your outgoing mail and articles in the group @samp{nnml:archive},
8370 you set this variable to that value. This variable can also be a list of
8373 If you want to have greater control over what group to put each
8374 message in, you can set this variable to a function that checks the
8375 current newsgroup name and then returns a suitable group name (or list
8378 This variable can be used instead of @code{gnus-message-archive-group},
8379 but the latter is the preferred method.
8383 @node Posting Styles
8384 @section Posting Styles
8385 @cindex posting styles
8388 All them variables, they make my head swim.
8390 So what if you want a different @code{Organization} and signature based
8391 on what groups you post to? And you post both from your home machine
8392 and your work machine, and you want different @code{From} lines, and so
8395 @vindex gnus-posting-styles
8396 One way to do stuff like that is to write clever hooks that change the
8397 variables you need to have changed. That's a bit boring, so somebody
8398 came up with the bright idea of letting the user specify these things in
8399 a handy alist. Here's an example of a @code{gnus-posting-styles}
8404 (signature "Peace and happiness")
8405 (organization "What me?"))
8407 (signature "Death to everybody"))
8408 ("comp.emacs.i-love-it"
8409 (organization "Emacs is it")))
8412 As you might surmise from this example, this alist consists of several
8413 @dfn{styles}. Each style will be applicable if the first element
8414 ``matches'', in some form or other. The entire alist will be iterated
8415 over, from the beginning towards the end, and each match will be
8416 applied, which means that attributes in later styles that match override
8417 the same attributes in earlier matching styles. So
8418 @samp{comp.programming.literate} will have the @samp{Death to everybody}
8419 signature and the @samp{What me?} @code{Organization} header.
8421 The first element in each style is called the @code{match}. If it's a
8422 string, then Gnus will try to regexp match it against the group name.
8423 If it's a function symbol, that function will be called with no
8424 arguments. If it's a variable symbol, then the variable will be
8425 referenced. If it's a list, then that list will be @code{eval}ed. In
8426 any case, if this returns a non-@code{nil} value, then the style is said
8429 Each style may contain a arbitrary amount of @dfn{attributes}. Each
8430 attribute consists of a @var{(name . value)} pair. The attribute name
8431 can be one of @code{signature}, @code{signature-file},
8432 @code{organization}, @code{address}, @code{name} or @code{body}. The
8433 attribute name can also be a string. In that case, this will be used as
8434 a header name, and the value will be inserted in the headers of the
8437 The attribute value can be a string (used verbatim), a function (the
8438 return value will be used), a variable (its value will be used) or a
8439 list (it will be @code{eval}ed and the return value will be used).
8441 If you wish to check whether the message you are about to compose is
8442 meant to be a news article or a mail message, you can check the values
8443 of the two dynamically bound variables @code{message-this-is-news} and
8444 @code{message-this-is-mail}.
8446 @vindex message-this-is-mail
8447 @vindex message-this-is-news
8449 So here's a new example:
8452 (setq gnus-posting-styles
8454 (signature-file "~/.signature")
8456 ("X-Home-Page" (getenv "WWW_HOME"))
8457 (organization "People's Front Against MWM"))
8459 (signature my-funny-signature-randomizer))
8460 ((equal (system-name) "gnarly")
8461 (signature my-quote-randomizer))
8462 (message-this-is-new
8463 (signature my-news-signature))
8464 (posting-from-work-p
8465 (signature-file "~/.work-signature")
8466 (address "user@@bar.foo")
8467 (body "You are fired.\n\nSincerely, your boss.")
8468 (organization "Important Work, Inc"))
8470 (signature-file "~/.mail-signature"))))
8478 If you are writing a message (mail or news) and suddenly remember that
8479 you have a steak in the oven (or some pesto in the food processor, you
8480 craaazy vegetarians), you'll probably wish there was a method to save
8481 the message you are writing so that you can continue editing it some
8482 other day, and send it when you feel its finished.
8484 Well, don't worry about it. Whenever you start composing a message of
8485 some sort using the gnus mail and post commands, the buffer you get will
8486 automatically associate to an article in a special @dfn{draft} group.
8487 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
8488 article will be saved there. (Auto-save files also go to the draft
8492 @vindex nndraft-directory
8493 The draft group is a special group (which is implemented as an
8494 @code{nndraft} group, if you absolutely have to know) called
8495 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
8496 @code{nndraft} is to store its files. What makes this group special is
8497 that you can't tick any articles in it or mark any articles as
8498 read---all articles in the group are permanently unread.
8500 If the group doesn't exist, it will be created and you'll be subscribed
8501 to it. The only way to make it disappear from the Group buffer is to
8504 @c @findex gnus-dissociate-buffer-from-draft
8505 @c @kindex C-c M-d (Mail)
8506 @c @kindex C-c M-d (Post)
8507 @c @findex gnus-associate-buffer-with-draft
8508 @c @kindex C-c C-d (Mail)
8509 @c @kindex C-c C-d (Post)
8510 @c If you're writing some super-secret message that you later want to
8511 @c encode with PGP before sending, you may wish to turn the auto-saving
8512 @c (and association with the draft group) off. You never know who might be
8513 @c interested in reading all your extremely valuable and terribly horrible
8514 @c and interesting secrets. The @kbd{C-c M-d}
8515 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
8516 @c If you change your mind and want to turn the auto-saving back on again,
8517 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
8519 @c @vindex gnus-use-draft
8520 @c To leave association with the draft group off by default, set
8521 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
8523 @findex gnus-draft-edit-message
8525 When you want to continue editing the article, you simply enter the
8526 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
8527 that. You will be placed in a buffer where you left off.
8529 Rejected articles will also be put in this draft group (@pxref{Rejected
8532 @findex gnus-draft-send-all-messages
8533 @findex gnus-draft-send-message
8534 If you have lots of rejected messages you want to post (or mail) without
8535 doing further editing, you can use the @kbd{D s} command
8536 (@code{gnus-draft-send-message}). This command understands the
8537 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
8538 command (@code{gnus-draft-send-all-messages}) will ship off all messages
8541 If you have some messages that you wish not to send, you can use the
8542 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
8543 as unsendable. This is a toggling command.
8546 @node Rejected Articles
8547 @section Rejected Articles
8548 @cindex rejected articles
8550 Sometimes a news server will reject an article. Perhaps the server
8551 doesn't like your face. Perhaps it just feels miserable. Perhaps
8552 @emph{there be demons}. Perhaps you have included too much cited text.
8553 Perhaps the disk is full. Perhaps the server is down.
8555 These situations are, of course, totally beyond the control of gnus.
8556 (Gnus, of course, loves the way you look, always feels great, has angels
8557 fluttering around inside of it, doesn't care about how much cited text
8558 you include, never runs full and never goes down.) So gnus saves these
8559 articles until some later time when the server feels better.
8561 The rejected articles will automatically be put in a special draft group
8562 (@pxref{Drafts}). When the server comes back up again, you'd then
8563 typically enter that group and send all the articles off.
8566 @node Select Methods
8567 @chapter Select Methods
8568 @cindex foreign groups
8569 @cindex select methods
8571 A @dfn{foreign group} is a group not read by the usual (or
8572 default) means. It could be, for instance, a group from a different
8573 @sc{nntp} server, it could be a virtual group, or it could be your own
8574 personal mail group.
8576 A foreign group (or any group, really) is specified by a @dfn{name} and
8577 a @dfn{select method}. To take the latter first, a select method is a
8578 list where the first element says what backend to use (e.g. @code{nntp},
8579 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
8580 name}. There may be additional elements in the select method, where the
8581 value may have special meaning for the backend in question.
8583 One could say that a select method defines a @dfn{virtual server}---so
8584 we do just that (@pxref{The Server Buffer}).
8586 The @dfn{name} of the group is the name the backend will recognize the
8589 For instance, the group @samp{soc.motss} on the @sc{nntp} server
8590 @samp{some.where.edu} will have the name @samp{soc.motss} and select
8591 method @code{(nntp "some.where.edu")}. Gnus will call this group
8592 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
8593 backend just knows this group as @samp{soc.motss}.
8595 The different methods all have their peculiarities, of course.
8598 * The Server Buffer:: Making and editing virtual servers.
8599 * Getting News:: Reading USENET news with Gnus.
8600 * Getting Mail:: Reading your personal mail with Gnus.
8601 * Other Sources:: Reading directories, files, SOUP packets.
8602 * Combined Groups:: Combining groups into one group.
8603 * Gnus Unplugged:: Reading news and mail offline.
8607 @node The Server Buffer
8608 @section The Server Buffer
8610 Traditionally, a @dfn{server} is a machine or a piece of software that
8611 one connects to, and then requests information from. Gnus does not
8612 connect directly to any real servers, but does all transactions through
8613 one backend or other. But that's just putting one layer more between
8614 the actual media and Gnus, so we might just as well say that each
8615 backend represents a virtual server.
8617 For instance, the @code{nntp} backend may be used to connect to several
8618 different actual @sc{nntp} servers, or, perhaps, to many different ports
8619 on the same actual @sc{nntp} server. You tell Gnus which backend to
8620 use, and what parameters to set by specifying a @dfn{select method}.
8622 These select method specifications can sometimes become quite
8623 complicated---say, for instance, that you want to read from the
8624 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
8625 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
8626 Anyways, if you had to specify that for each group that used this
8627 server, that would be too much work, so Gnus offers a way of naming
8628 select methods, which is what you do in the server buffer.
8630 To enter the server buffer, use the @kbd{^}
8631 (@code{gnus-group-enter-server-mode}) command in the group buffer.
8634 * Server Buffer Format:: You can customize the look of this buffer.
8635 * Server Commands:: Commands to manipulate servers.
8636 * Example Methods:: Examples server specifications.
8637 * Creating a Virtual Server:: An example session.
8638 * Server Variables:: Which variables to set.
8639 * Servers and Methods:: You can use server names as select methods.
8640 * Unavailable Servers:: Some servers you try to contact may be down.
8643 @vindex gnus-server-mode-hook
8644 @code{gnus-server-mode-hook} is run when creating the server buffer.
8647 @node Server Buffer Format
8648 @subsection Server Buffer Format
8649 @cindex server buffer format
8651 @vindex gnus-server-line-format
8652 You can change the look of the server buffer lines by changing the
8653 @code{gnus-server-line-format} variable. This is a @code{format}-like
8654 variable, with some simple extensions:
8659 How the news is fetched---the backend name.
8662 The name of this server.
8665 Where the news is to be fetched from---the address.
8668 The opened/closed/denied status of the server.
8671 @vindex gnus-server-mode-line-format
8672 The mode line can also be customized by using the
8673 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
8674 Formatting}). The following specs are understood:
8684 Also @pxref{Formatting Variables}.
8687 @node Server Commands
8688 @subsection Server Commands
8689 @cindex server commands
8695 @findex gnus-server-add-server
8696 Add a new server (@code{gnus-server-add-server}).
8700 @findex gnus-server-edit-server
8701 Edit a server (@code{gnus-server-edit-server}).
8704 @kindex SPACE (Server)
8705 @findex gnus-server-read-server
8706 Browse the current server (@code{gnus-server-read-server}).
8710 @findex gnus-server-exit
8711 Return to the group buffer (@code{gnus-server-exit}).
8715 @findex gnus-server-kill-server
8716 Kill the current server (@code{gnus-server-kill-server}).
8720 @findex gnus-server-yank-server
8721 Yank the previously killed server (@code{gnus-server-yank-server}).
8725 @findex gnus-server-copy-server
8726 Copy the current server (@code{gnus-server-copy-server}).
8730 @findex gnus-server-list-servers
8731 List all servers (@code{gnus-server-list-servers}).
8735 @findex gnus-server-scan-server
8736 Request that the server scan its sources for new articles
8737 (@code{gnus-server-scan-server}). This is mainly sensible with mail
8742 @findex gnus-server-regenerate-server
8743 Request that the server regenerate all its data structures
8744 (@code{gnus-server-regenerate-server}). This can be useful if you have
8745 a mail backend that has gotten out of synch.
8750 @node Example Methods
8751 @subsection Example Methods
8753 Most select methods are pretty simple and self-explanatory:
8756 (nntp "news.funet.fi")
8759 Reading directly from the spool is even simpler:
8765 As you can see, the first element in a select method is the name of the
8766 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8769 After these two elements, there may be an arbitrary number of
8770 @var{(variable form)} pairs.
8772 To go back to the first example---imagine that you want to read from
8773 port 15 on that machine. This is what the select method should
8777 (nntp "news.funet.fi" (nntp-port-number 15))
8780 You should read the documentation to each backend to find out what
8781 variables are relevant, but here's an @code{nnmh} example:
8783 @code{nnmh} is a mail backend that reads a spool-like structure. Say
8784 you have two structures that you wish to access: One is your private
8785 mail spool, and the other is a public one. Here's the possible spec for
8789 (nnmh "private" (nnmh-directory "~/private/mail/"))
8792 (This server is then called @samp{private}, but you may have guessed
8795 Here's the method for a public spool:
8799 (nnmh-directory "/usr/information/spool/")
8800 (nnmh-get-new-mail nil))
8803 If you are behind a firewall and only have access to the @sc{nntp}
8804 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8805 on the firewall machine and telnet from there to the @sc{nntp} server.
8806 Doing this can be rather fiddly, but your virtual server definition
8807 should probably look something like this:
8811 (nntp-address "the.firewall.machine")
8812 (nntp-open-connection-function nntp-open-rlogin)
8813 (nntp-end-of-line "\n")
8814 (nntp-rlogin-parameters
8815 ("telnet" "the.real.nntp.host" "nntp")))
8818 If you want to use the wonderful @code{ssh} program to provide a
8819 compressed connection over the modem line, you could create a virtual
8820 server that would look something like this:
8824 (nntp-address "copper.uio.no")
8825 (nntp-rlogin-program "ssh")
8826 (nntp-open-connection-function nntp-open-rlogin)
8827 (nntp-end-of-line "\n")
8828 (nntp-rlogin-parameters
8829 ("telnet" "news.uio.no" "nntp")))
8832 This means that you have to have set up @code{ssh-agent} correctly to
8833 provide automatic authorization, of course. And to get a compressed
8834 connection, you have to have the @samp{Compression} option in the
8835 @code{ssh} @file{config} file.
8838 @node Creating a Virtual Server
8839 @subsection Creating a Virtual Server
8841 If you're saving lots of articles in the cache by using persistent
8842 articles, you may want to create a virtual server to read the cache.
8844 First you need to add a new server. The @kbd{a} command does that. It
8845 would probably be best to use @code{nnspool} to read the cache. You
8846 could also use @code{nnml} or @code{nnmh}, though.
8848 Type @kbd{a nnspool RET cache RET}.
8850 You should now have a brand new @code{nnspool} virtual server called
8851 @samp{cache}. You now need to edit it to have the right definitions.
8852 Type @kbd{e} to edit the server. You'll be entered into a buffer that
8853 will contain the following:
8863 (nnspool-spool-directory "~/News/cache/")
8864 (nnspool-nov-directory "~/News/cache/")
8865 (nnspool-active-file "~/News/cache/active"))
8868 Type @kbd{C-c C-c} to return to the server buffer. If you now press
8869 @kbd{RET} over this virtual server, you should be entered into a browse
8870 buffer, and you should be able to enter any of the groups displayed.
8873 @node Server Variables
8874 @subsection Server Variables
8876 One sticky point when defining variables (both on backends and in Emacs
8877 in general) is that some variables are typically initialized from other
8878 variables when the definition of the variables is being loaded. If you
8879 change the "base" variable after the variables have been loaded, you
8880 won't change the "derived" variables.
8882 This typically affects directory and file variables. For instance,
8883 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
8884 directory variables are initialized from that variable, so
8885 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
8886 new virtual @code{nnml} server, it will @emph{not} suffice to set just
8887 @code{nnml-directory}---you have to explicitly set all the file
8888 variables to be what you want them to be. For a complete list of
8889 variables for each backend, see each backend's section later in this
8890 manual, but here's an example @code{nnml} definition:
8894 (nnml-directory "~/my-mail/")
8895 (nnml-active-file "~/my-mail/active")
8896 (nnml-newsgroups-file "~/my-mail/newsgroups"))
8900 @node Servers and Methods
8901 @subsection Servers and Methods
8903 Wherever you would normally use a select method
8904 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8905 when browsing a foreign server) you can use a virtual server name
8906 instead. This could potentially save lots of typing. And it's nice all
8910 @node Unavailable Servers
8911 @subsection Unavailable Servers
8913 If a server seems to be unreachable, Gnus will mark that server as
8914 @code{denied}. That means that any subsequent attempt to make contact
8915 with that server will just be ignored. ``It can't be opened,'' Gnus
8916 will tell you, without making the least effort to see whether that is
8917 actually the case or not.
8919 That might seem quite naughty, but it does make sense most of the time.
8920 Let's say you have 10 groups subscribed to on server
8921 @samp{nephelococcygia.com}. This server is located somewhere quite far
8922 away from you and the machine is quite slow, so it takes 1 minute just
8923 to find out that it refuses connection to you today. If Gnus were to
8924 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
8925 attempt to do that. Once it has gotten a single ``connection refused'',
8926 it will regard that server as ``down''.
8928 So, what happens if the machine was only feeling unwell temporarily?
8929 How do you test to see whether the machine has come up again?
8931 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8932 with the following commands:
8938 @findex gnus-server-open-server
8939 Try to establish connection to the server on the current line
8940 (@code{gnus-server-open-server}).
8944 @findex gnus-server-close-server
8945 Close the connection (if any) to the server
8946 (@code{gnus-server-close-server}).
8950 @findex gnus-server-deny-server
8951 Mark the current server as unreachable
8952 (@code{gnus-server-deny-server}).
8955 @kindex M-o (Server)
8956 @findex gnus-server-open-all-servers
8957 Open the connections to all servers in the buffer
8958 (@code{gnus-server-open-all-servers}).
8961 @kindex M-c (Server)
8962 @findex gnus-server-close-all-servers
8963 Close the connections to all servers in the buffer
8964 (@code{gnus-server-close-all-servers}).
8968 @findex gnus-server-remove-denials
8969 Remove all marks to whether Gnus was denied connection from any servers
8970 (@code{gnus-server-remove-denials}).
8976 @section Getting News
8977 @cindex reading news
8978 @cindex news backends
8980 A newsreader is normally used for reading news. Gnus currently provides
8981 only two methods of getting news---it can read from an @sc{nntp} server,
8982 or it can read from a local spool.
8985 * NNTP:: Reading news from an @sc{nntp} server.
8986 * News Spool:: Reading news from the local spool.
8991 @subsection @sc{nntp}
8994 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8995 You just specify @code{nntp} as method and the address of the @sc{nntp}
8996 server as the, uhm, address.
8998 If the @sc{nntp} server is located at a non-standard port, setting the
8999 third element of the select method to this port number should allow you
9000 to connect to the right port. You'll have to edit the group info for
9001 that (@pxref{Foreign Groups}).
9003 The name of the foreign group can be the same as a native group. In
9004 fact, you can subscribe to the same group from as many different servers
9005 you feel like. There will be no name collisions.
9007 The following variables can be used to create a virtual @code{nntp}
9012 @item nntp-server-opened-hook
9013 @vindex nntp-server-opened-hook
9014 @cindex @sc{mode reader}
9016 @cindex authentification
9017 @cindex nntp authentification
9018 @findex nntp-send-authinfo
9019 @findex nntp-send-mode-reader
9020 is run after a connection has been made. It can be used to send
9021 commands to the @sc{nntp} server after it has been contacted. By
9022 default it sends the command @code{MODE READER} to the server with the
9023 @code{nntp-send-mode-reader} function. This function should always be
9024 present in this hook.
9026 @item nntp-authinfo-function
9027 @vindex nntp-authinfo-function
9028 @findex nntp-send-authinfo
9029 @vindex nntp-authinfo-file
9030 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
9031 server. The default function is @code{nntp-send-authinfo}, which looks
9032 through your @file{~/.authinfo} (or whatever you've set the
9033 @code{nntp-authinfo-file} variable to) for applicable entries. If none
9034 are found, it will prompt you for a login name and a password. The
9035 format of the @file{~/.authinfo} file is (almost) the same as the
9036 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
9037 manual page, but here are the salient facts:
9041 The file contains one or more line, each of which define one server.
9044 Each line may contain an arbitrary number of token/value pairs. The
9045 valid tokens include @samp{machine}, @samp{login}, @samp{password},
9046 @samp{default} and @samp{force}. (The latter is not a valid
9047 @file{.netrc}/@code{ftp} token, which is the only way the
9048 @file{.authinfo} file format deviates from the @file{.netrc} file
9053 Here's an example file:
9056 machine news.uio.no login larsi password geheimnis
9057 machine nntp.ifi.uio.no login larsi force yes
9060 The token/value pairs may appear in any order; @samp{machine} doesn't
9061 have to be first, for instance.
9063 In this example, both login name and password have been supplied for the
9064 former server, while the latter has only the login name listed, and the
9065 user will be prompted for the password. The latter also has the
9066 @samp{force} tag, which means that the authinfo will be sent to the
9067 @var{nntp} server upon connection; the default (i.e., when there is not
9068 @samp{force} tag) is to not send authinfo to the @var{nntp} server
9069 until the @var{nntp} server asks for it.
9071 You can also add @samp{default} lines that will apply to all servers
9072 that don't have matching @samp{machine} lines.
9078 This will force sending @samp{AUTHINFO} commands to all servers not
9079 previously mentioned.
9081 Remember to not leave the @file{~/.authinfo} file world-readable.
9083 @item nntp-server-action-alist
9084 @vindex nntp-server-action-alist
9085 This is a list of regexps to match on server types and actions to be
9086 taken when matches are made. For instance, if you want Gnus to beep
9087 every time you connect to innd, you could say something like:
9090 (setq nntp-server-action-alist
9094 You probably don't want to do that, though.
9096 The default value is
9099 '(("nntpd 1\\.5\\.11t"
9100 (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
9103 This ensures that Gnus doesn't send the @code{MODE READER} command to
9104 nntpd 1.5.11t, since that command chokes that server, I've been told.
9106 @item nntp-maximum-request
9107 @vindex nntp-maximum-request
9108 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
9109 will collect headers by sending a series of @code{head} commands. To
9110 speed things up, the backend sends lots of these commands without
9111 waiting for reply, and then reads all the replies. This is controlled
9112 by the @code{nntp-maximum-request} variable, and is 400 by default. If
9113 your network is buggy, you should set this to 1.
9115 @item nntp-connection-timeout
9116 @vindex nntp-connection-timeout
9117 If you have lots of foreign @code{nntp} groups that you connect to
9118 regularly, you're sure to have problems with @sc{nntp} servers not
9119 responding properly, or being too loaded to reply within reasonable
9120 time. This is can lead to awkward problems, which can be helped
9121 somewhat by setting @code{nntp-connection-timeout}. This is an integer
9122 that says how many seconds the @code{nntp} backend should wait for a
9123 connection before giving up. If it is @code{nil}, which is the default,
9124 no timeouts are done.
9126 @c @item nntp-command-timeout
9127 @c @vindex nntp-command-timeout
9128 @c @cindex PPP connections
9129 @c @cindex dynamic IP addresses
9130 @c If you're running Gnus on a machine that has a dynamically assigned
9131 @c address, Gnus may become confused. If the address of your machine
9132 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
9133 @c waiting forever for replies from the server. To help with this
9134 @c unfortunate problem, you can set this command to a number. Gnus will
9135 @c then, if it sits waiting for a reply from the server longer than that
9136 @c number of seconds, shut down the connection, start a new one, and resend
9137 @c the command. This should hopefully be transparent to the user. A
9138 @c likely number is 30 seconds.
9140 @c @item nntp-retry-on-break
9141 @c @vindex nntp-retry-on-break
9142 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
9143 @c hangs. This will have much the same effect as the command timeout
9146 @item nntp-server-hook
9147 @vindex nntp-server-hook
9148 This hook is run as the last step when connecting to an @sc{nntp}
9151 @findex nntp-open-rlogin
9152 @findex nntp-open-telnet
9153 @findex nntp-open-network-stream
9154 @item nntp-open-connection-function
9155 @vindex nntp-open-connection-function
9156 This function is used to connect to the remote system. Four pre-made
9157 functions are supplied:
9160 @item nntp-open-network-stream
9161 This is the default, and simply connects to some port or other on the
9164 @item nntp-open-rlogin
9165 Does an @samp{rlogin} on the
9166 remote system, and then does a @samp{telnet} to the @sc{nntp} server
9169 @code{nntp-open-rlogin}-related variables:
9173 @item nntp-rlogin-program
9174 @vindex nntp-rlogin-program
9175 Program used to log in on remote machines. The default is @samp{rsh},
9176 but @samp{ssh} is a popular alternative.
9178 @item nntp-rlogin-parameters
9179 @vindex nntp-rlogin-parameters
9180 This list will be used as the parameter list given to @code{rsh}.
9182 @item nntp-rlogin-user-name
9183 @vindex nntp-rlogin-user-name
9184 User name on the remote system.
9188 @item nntp-open-telnet
9189 Does a @samp{telnet} to the remote system and then another @samp{telnet}
9190 to get to the @sc{nntp} server.
9192 @code{nntp-open-telnet}-related variables:
9195 @item nntp-telnet-command
9196 @vindex nntp-telnet-command
9197 Command used to start @code{telnet}.
9199 @item nntp-telnet-switches
9200 @vindex nntp-telnet-switches
9201 List of strings to be used as the switches to the @code{telnet} command.
9203 @item nntp-telnet-user-name
9204 @vindex nntp-telnet-user-name
9205 User name for log in on the remote system.
9207 @item nntp-telnet-passwd
9208 @vindex nntp-telnet-passwd
9209 Password to use when logging in.
9211 @item nntp-telnet-parameters
9212 @vindex nntp-telnet-parameters
9213 A list of strings executed as a command after logging in
9216 @item nntp-telnet-shell-prompt
9217 @vindex nntp-telnet-shell-prompt
9218 Regexp matching the shell prompt on the remote machine. The default is
9219 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9221 @item nntp-open-telnet-envuser
9222 @vindex nntp-open-telnet-envuser
9223 If non-@code{nil}, the @code{telnet} session (client and server both)
9224 will support the @code{ENVIRON} option and not prompt for login name.
9225 This works for Solaris @code{telnet}, for instance.
9229 @findex nntp-open-ssl-stream
9230 @item nntp-open-ssl-stream
9231 Opens a connection to a server over a @dfn{secure} channel. To use this
9232 you must have SSLay installed
9233 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
9234 @file{ssl.el} (from the W3 distributeion, for instance). You then
9235 define a server as follows:
9238 ;; Type `C-c C-c' after you've finished editing.
9240 ;; "snews" is port 563 and is predefined in our /etc/services
9242 (nntp "snews.bar.com"
9243 (nntp-open-connection-function nntp-open-ssl-stream)
9244 (nntp-port-number "snews")
9245 (nntp-address "snews.bar.com"))
9250 @item nntp-end-of-line
9251 @vindex nntp-end-of-line
9252 String to use as end-of-line marker when talking to the @sc{nntp}
9253 server. This is @samp{\r\n} by default, but should be @samp{\n} when
9254 using @code{rlogin} to talk to the server.
9256 @item nntp-rlogin-user-name
9257 @vindex nntp-rlogin-user-name
9258 User name on the remote system when using the @code{rlogin} connect
9262 @vindex nntp-address
9263 The address of the remote system running the @sc{nntp} server.
9265 @item nntp-port-number
9266 @vindex nntp-port-number
9267 Port number to connect to when using the @code{nntp-open-network-stream}
9270 @item nntp-buggy-select
9271 @vindex nntp-buggy-select
9272 Set this to non-@code{nil} if your select routine is buggy.
9274 @item nntp-nov-is-evil
9275 @vindex nntp-nov-is-evil
9276 If the @sc{nntp} server does not support @sc{nov}, you could set this
9277 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9280 @item nntp-xover-commands
9281 @vindex nntp-xover-commands
9284 List of strings used as commands to fetch @sc{nov} lines from a
9285 server. The default value of this variable is @code{("XOVER"
9289 @vindex nntp-nov-gap
9290 @code{nntp} normally sends just one big request for @sc{nov} lines to
9291 the server. The server responds with one huge list of lines. However,
9292 if you have read articles 2-5000 in the group, and only want to read
9293 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9294 lines that you will not need. This variable says how
9295 big a gap between two consecutive articles is allowed to be before the
9296 @code{XOVER} request is split into several request. Note that if your
9297 network is fast, setting this variable to a really small number means
9298 that fetching will probably be slower. If this variable is @code{nil},
9299 @code{nntp} will never split requests. The default is 5.
9301 @item nntp-prepare-server-hook
9302 @vindex nntp-prepare-server-hook
9303 A hook run before attempting to connect to an @sc{nntp} server.
9305 @item nntp-warn-about-losing-connection
9306 @vindex nntp-warn-about-losing-connection
9307 If this variable is non-@code{nil}, some noise will be made when a
9308 server closes connection.
9310 @item nntp-record-commands
9311 @vindex nntp-record-commands
9312 If non-@code{nil}, @code{nntp} will log all commands it sends to the
9313 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
9314 buffer. This is useful if you are debugging a Gnus/@sc{nntp} connection
9315 that doesn't seem to work.
9321 @subsection News Spool
9325 Subscribing to a foreign group from the local spool is extremely easy,
9326 and might be useful, for instance, to speed up reading groups that
9327 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9330 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9331 anything else) as the address.
9333 If you have access to a local spool, you should probably use that as the
9334 native select method (@pxref{Finding the News}). It is normally faster
9335 than using an @code{nntp} select method, but might not be. It depends.
9336 You just have to try to find out what's best at your site.
9340 @item nnspool-inews-program
9341 @vindex nnspool-inews-program
9342 Program used to post an article.
9344 @item nnspool-inews-switches
9345 @vindex nnspool-inews-switches
9346 Parameters given to the inews program when posting an article.
9348 @item nnspool-spool-directory
9349 @vindex nnspool-spool-directory
9350 Where @code{nnspool} looks for the articles. This is normally
9351 @file{/usr/spool/news/}.
9353 @item nnspool-nov-directory
9354 @vindex nnspool-nov-directory
9355 Where @code{nnspool} will look for @sc{nov} files. This is normally
9356 @file{/usr/spool/news/over.view/}.
9358 @item nnspool-lib-dir
9359 @vindex nnspool-lib-dir
9360 Where the news lib dir is (@file{/usr/lib/news/} by default).
9362 @item nnspool-active-file
9363 @vindex nnspool-active-file
9364 The path to the active file.
9366 @item nnspool-newsgroups-file
9367 @vindex nnspool-newsgroups-file
9368 The path to the group descriptions file.
9370 @item nnspool-history-file
9371 @vindex nnspool-history-file
9372 The path to the news history file.
9374 @item nnspool-active-times-file
9375 @vindex nnspool-active-times-file
9376 The path to the active date file.
9378 @item nnspool-nov-is-evil
9379 @vindex nnspool-nov-is-evil
9380 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9383 @item nnspool-sift-nov-with-sed
9384 @vindex nnspool-sift-nov-with-sed
9386 If non-@code{nil}, which is the default, use @code{sed} to get the
9387 relevant portion from the overview file. If nil, @code{nnspool} will
9388 load the entire file into a buffer and process it there.
9394 @section Getting Mail
9395 @cindex reading mail
9398 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9402 * Getting Started Reading Mail:: A simple cookbook example.
9403 * Splitting Mail:: How to create mail groups.
9404 * Mail Backend Variables:: Variables for customizing mail handling.
9405 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
9406 * Mail and Procmail:: Reading mail groups that procmail create.
9407 * Incorporating Old Mail:: What about the old mail you have?
9408 * Expiring Mail:: Getting rid of unwanted mail.
9409 * Washing Mail:: Removing gruft from the mail you get.
9410 * Duplicates:: Dealing with duplicated mail.
9411 * Not Reading Mail:: Using mail backends for reading other files.
9412 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
9416 @node Getting Started Reading Mail
9417 @subsection Getting Started Reading Mail
9419 It's quite easy to use Gnus to read your new mail. You just plonk the
9420 mail backend of your choice into @code{gnus-secondary-select-methods},
9421 and things will happen automatically.
9423 For instance, if you want to use @code{nnml} (which is a "one file per
9424 mail" backend), you could put the following in your @file{.gnus} file:
9427 (setq gnus-secondary-select-methods
9428 '((nnml "private")))
9431 Now, the next time you start Gnus, this backend will be queried for new
9432 articles, and it will move all the messages in your spool file to its
9433 directory, which is @code{~/Mail/} by default. The new group that will
9434 be created (@samp{mail.misc}) will be subscribed, and you can read it
9435 like any other group.
9437 You will probably want to split the mail into several groups, though:
9440 (setq nnmail-split-methods
9441 '(("junk" "^From:.*Lars Ingebrigtsen")
9442 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
9446 This will result in three new @code{nnml} mail groups being created:
9447 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
9448 mail that doesn't fit into the first two groups will be placed in the
9451 This should be sufficient for reading mail with Gnus. You might want to
9452 give the other sections in this part of the manual a perusal, though.
9453 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
9456 @node Splitting Mail
9457 @subsection Splitting Mail
9458 @cindex splitting mail
9459 @cindex mail splitting
9461 @vindex nnmail-split-methods
9462 The @code{nnmail-split-methods} variable says how the incoming mail is
9463 to be split into groups.
9466 (setq nnmail-split-methods
9467 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
9468 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
9472 This variable is a list of lists, where the first element of each of
9473 these lists is the name of the mail group (they do not have to be called
9474 something beginning with @samp{mail}, by the way), and the second
9475 element is a regular expression used on the header of each mail to
9476 determine if it belongs in this mail group. The first string may
9477 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
9478 insert sub-expressions from the matched text. For instance:
9481 ("list.\\1" "From:.*\\(.*\\)-list@@majordomo.com")
9484 The second element can also be a function. In that case, it will be
9485 called narrowed to the headers with the first element of the rule as the
9486 argument. It should return a non-@code{nil} value if it thinks that the
9487 mail belongs in that group.
9489 The last of these groups should always be a general one, and the regular
9490 expression should @emph{always} be @samp{} so that it matches any mails
9491 that haven't been matched by any of the other regexps. (These rules are
9492 processed from the beginning of the alist toward the end. The first
9493 rule to make a match will "win", unless you have crossposting enabled.
9494 In that case, all matching rules will "win".)
9496 If you like to tinker with this yourself, you can set this variable to a
9497 function of your choice. This function will be called without any
9498 arguments in a buffer narrowed to the headers of an incoming mail
9499 message. The function should return a list of group names that it
9500 thinks should carry this mail message.
9502 Note that the mail backends are free to maul the poor, innocent,
9503 incoming headers all they want to. They all add @code{Lines} headers;
9504 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
9505 @code{From<SPACE>} line to something else.
9507 @vindex nnmail-crosspost
9508 The mail backends all support cross-posting. If several regexps match,
9509 the mail will be ``cross-posted'' to all those groups.
9510 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
9511 that no articles are crossposted to the general (@samp{}) group.
9513 @vindex nnmail-crosspost-link-function
9516 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
9517 the crossposted articles. However, not all file systems support hard
9518 links. If that's the case for you, set
9519 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
9520 variable is @code{add-name-to-file} by default.)
9522 @kindex M-x nnmail-split-history
9523 @kindex nnmail-split-history
9524 If you wish to see where the previous mail split put the messages, you
9525 can use the @kbd{M-x nnmail-split-history} command.
9527 Gnus gives you all the opportunity you could possibly want for shooting
9528 yourself in the foot. Let's say you create a group that will contain
9529 all the mail you get from your boss. And then you accidentally
9530 unsubscribe from the group. Gnus will still put all the mail from your
9531 boss in the unsubscribed group, and so, when your boss mails you ``Have
9532 that report ready by Monday or you're fired!'', you'll never see it and,
9533 come Tuesday, you'll still believe that you're gainfully employed while
9534 you really should be out collecting empty bottles to save up for next
9538 @node Mail Backend Variables
9539 @subsection Mail Backend Variables
9541 These variables are (for the most part) pertinent to all the various
9545 @vindex nnmail-read-incoming-hook
9546 @item nnmail-read-incoming-hook
9547 The mail backends all call this hook after reading new mail. You can
9548 use this hook to notify any mail watch programs, if you want to.
9550 @vindex nnmail-spool-file
9551 @item nnmail-spool-file
9555 @vindex nnmail-pop-password
9556 @vindex nnmail-pop-password-required
9557 The backends will look for new mail in this file. If this variable is
9558 @code{nil}, the mail backends will never attempt to fetch mail by
9559 themselves. If you are using a POP mail server and your name is
9560 @samp{larsi}, you should set this variable to @samp{po:larsi}. If
9561 your name is not @samp{larsi}, you should probably modify that
9562 slightly, but you may have guessed that already, you smart & handsome
9563 devil! You can also set this variable to @code{pop}, and Gnus will try
9564 to figure out the POP mail string by itself. In any case, Gnus will
9565 call @code{movemail} which will contact the POP server named in the
9566 @code{MAILHOST} environment variable. If the POP server needs a
9567 password, you can either set @code{nnmail-pop-password-required} to
9568 @code{t} and be prompted for the password, or set
9569 @code{nnmail-pop-password} to the password itself.
9571 @code{nnmail-spool-file} can also be a list of mailboxes.
9573 Your Emacs has to have been configured with @samp{--with-pop} before
9574 compilation. This is the default, but some installations have it
9577 When you use a mail backend, Gnus will slurp all your mail from your
9578 inbox and plonk it down in your home directory. Gnus doesn't move any
9579 mail if you're not using a mail backend---you have to do a lot of magic
9580 invocations first. At the time when you have finished drawing the
9581 pentagram, lightened the candles, and sacrificed the goat, you really
9582 shouldn't be too surprised when Gnus moves your mail.
9584 @vindex nnmail-use-procmail
9585 @vindex nnmail-procmail-suffix
9586 @item nnmail-use-procmail
9587 If non-@code{nil}, the mail backends will look in
9588 @code{nnmail-procmail-directory} for incoming mail. All the files in
9589 that directory that have names ending in @code{nnmail-procmail-suffix}
9590 will be considered incoming mailboxes, and will be searched for new
9593 @vindex nnmail-crash-box
9594 @item nnmail-crash-box
9595 When a mail backend reads a spool file, mail is first moved to this
9596 file, which is @file{~/.gnus-crash-box} by default. If this file
9597 already exists, it will always be read (and incorporated) before any
9600 @vindex nnmail-prepare-incoming-hook
9601 @item nnmail-prepare-incoming-hook
9602 This is run in a buffer that holds all the new incoming mail, and can be
9603 used for, well, anything, really.
9605 @vindex nnmail-split-hook
9606 @item nnmail-split-hook
9607 @findex article-decode-rfc1522
9608 @findex RFC1522 decoding
9609 Hook run in the buffer where the mail headers of each message is kept
9610 just before the splitting based on these headers is done. The hook is
9611 free to modify the buffer contents in any way it sees fit---the buffer
9612 is discarded after the splitting has been done, and no changes performed
9613 in the buffer will show up in any files. @code{gnus-article-decode-rfc1522}
9614 is one likely function to add to this hook.
9616 @vindex nnmail-pre-get-new-mail-hook
9617 @vindex nnmail-post-get-new-mail-hook
9618 @item nnmail-pre-get-new-mail-hook
9619 @itemx nnmail-post-get-new-mail-hook
9620 These are two useful hooks executed when treating new incoming
9621 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
9622 starting to handle the new mail) and
9623 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
9624 is done). Here's and example of using these two hooks to change the
9625 default file modes the new mail files get:
9628 (add-hook 'gnus-pre-get-new-mail-hook
9629 (lambda () (set-default-file-modes 511)))
9631 (add-hook 'gnus-post-get-new-mail-hook
9632 (lambda () (set-default-file-modes 551)))
9635 @item nnmail-tmp-directory
9636 @vindex nnmail-tmp-directory
9637 This variable says where to move incoming mail to -- while processing
9638 it. This is usually done in the same directory that the mail backend
9639 inhabits (e.g., @file{~/Mail/}), but if this variable is non-@code{nil},
9640 it will be used instead.
9642 @item nnmail-movemail-program
9643 @vindex nnmail-movemail-program
9644 This program is executed to move mail from the user's inbox to her home
9645 directory. The default is @samp{movemail}.
9647 This can also be a function. In that case, the function will be called
9648 with two parameters -- the name of the inbox, and the file to be moved
9651 @item nnmail-delete-incoming
9652 @vindex nnmail-delete-incoming
9653 @cindex incoming mail files
9654 @cindex deleting incoming files
9655 If non-@code{nil}, the mail backends will delete the temporary incoming
9656 file after splitting mail into the proper groups. This is @code{t} by
9659 @c This is @code{nil} by
9660 @c default for reasons of security.
9662 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
9663 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
9664 lost mail, I think, but that's not the point. (Except certain versions
9665 of Red Gnus.)) By not deleting the Incoming* files, one can be sure not
9666 to lose mail -- if Gnus totally whacks out, one can always recover what
9669 You may delete the @file{Incoming*} files at will.
9671 @item nnmail-use-long-file-names
9672 @vindex nnmail-use-long-file-names
9673 If non-@code{nil}, the mail backends will use long file and directory
9674 names. Groups like @samp{mail.misc} will end up in directories
9675 (assuming use of @code{nnml} backend) or files (assuming use of
9676 @code{nnfolder} backend) like @file{mail.misc}. If it is @code{nil},
9677 the same group will end up in @file{mail/misc}.
9679 @item nnmail-delete-file-function
9680 @vindex nnmail-delete-file-function
9682 Function called to delete files. It is @code{delete-file} by default.
9684 @item nnmail-cache-accepted-message-ids
9685 @vindex nnmail-cache-accepted-message-ids
9686 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
9687 the backend (via @code{Gcc}, for instance) into the mail duplication
9688 discovery cache. The default is @code{nil}.
9693 @node Fancy Mail Splitting
9694 @subsection Fancy Mail Splitting
9695 @cindex mail splitting
9696 @cindex fancy mail splitting
9698 @vindex nnmail-split-fancy
9699 @findex nnmail-split-fancy
9700 If the rather simple, standard method for specifying how to split mail
9701 doesn't allow you to do what you want, you can set
9702 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
9703 play with the @code{nnmail-split-fancy} variable.
9705 Let's look at an example value of this variable first:
9708 ;; Messages from the mailer daemon are not crossposted to any of
9709 ;; the ordinary groups. Warnings are put in a separate group
9710 ;; from real errors.
9711 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
9713 ;; Non-error messages are crossposted to all relevant
9714 ;; groups, but we don't crosspost between the group for the
9715 ;; (ding) list and the group for other (ding) related mail.
9716 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
9717 ("subject" "ding" "ding.misc"))
9718 ;; Other mailing lists...
9719 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
9720 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
9722 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
9723 ;; Unmatched mail goes to the catch all group.
9727 This variable has the format of a @dfn{split}. A split is a (possibly)
9728 recursive structure where each split may contain other splits. Here are
9729 the five possible split syntaxes:
9734 @samp{group}: If the split is a string, that will be taken as a group
9735 name. Normal regexp match expansion will be done. See below for
9739 @var{(FIELD VALUE SPLIT)}: If the split is a list, the first element of
9740 which is a string, then store the message as specified by SPLIT, if
9741 header FIELD (a regexp) contains VALUE (also a regexp).
9744 @var{(| SPLIT...)}: If the split is a list, and the first element is
9745 @code{|} (vertical bar), then process each SPLIT until one of them
9746 matches. A SPLIT is said to match if it will cause the mail message to
9747 be stored in one or more groups.
9750 @var{(& SPLIT...)}: If the split is a list, and the first element is
9751 @code{&}, then process all SPLITs in the list.
9754 @code{junk}: If the split is the symbol @code{junk}, then don't save
9755 this message. Use with extreme caution.
9758 @var{(: function arg1 arg2 ...)}: If the split is a list, and the first
9759 element is @code{:}, then the second element will be called as a
9760 function with @var{args} given as arguments. The function should return
9764 @code{nil}: If the split is @code{nil}, it is ignored.
9768 In these splits, @var{FIELD} must match a complete field name.
9769 @var{VALUE} must match a complete word according to the fundamental mode
9770 syntax table. You can use @code{.*} in the regexps to match partial
9771 field names or words. In other words, all @var{VALUE}'s are wrapped in
9772 @samp{\<} and @samp{\>} pairs.
9774 @vindex nnmail-split-abbrev-alist
9775 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
9776 are expanded as specified by the variable
9777 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
9778 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
9781 @vindex nnmail-split-fancy-syntax-table
9782 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
9783 when all this splitting is performed.
9785 If you want to have Gnus create groups dynamically based on some
9786 information in the headers (i.e., do @code{replace-match}-like
9787 substitutions in the group names), you can say things like:
9790 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
9793 If the string contains the element @samp{\&}, then the previously
9794 matched string will be substituted. Similarly, the elements @samp{\\1}
9795 up to @samp{\\9} will be substituted with the text matched by the
9796 groupings 1 through 9.
9799 @node Mail and Procmail
9800 @subsection Mail and Procmail
9805 Many people use @code{procmail} (or some other mail filter program or
9806 external delivery agent---@code{slocal}, @code{elm}, etc) to split
9807 incoming mail into groups. If you do that, you should set
9808 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
9809 backends never ever try to fetch mail by themselves.
9811 If you have a combined @code{procmail}/POP/mailbox setup, you can do
9812 something like the following:
9814 @vindex nnmail-use-procmail
9816 (setq nnmail-use-procmail t)
9817 (setq nnmail-spool-file
9818 '("/usr/spool/mail/my-name" "po:my-name"))
9821 This also means that you probably don't want to set
9822 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
9825 When a mail backend is queried for what groups it carries, it replies
9826 with the contents of that variable, along with any groups it has figured
9827 out that it carries by other means. None of the backends, except
9828 @code{nnmh}, actually go out to the disk and check what groups actually
9829 exist. (It's not trivial to distinguish between what the user thinks is
9830 a basis for a newsgroup and what is just a plain old file or directory.)
9832 This means that you have to tell Gnus (and the backends) by hand what
9835 Let's take the @code{nnmh} backend as an example:
9837 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
9838 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
9840 Go to the group buffer and type @kbd{G m}. When prompted, answer
9841 @samp{foo} for the name and @samp{nnmh} for the method. Repeat
9842 twice for the two other groups, @samp{bar} and @samp{mail.baz}. Be sure
9843 to include all your mail groups.
9845 That's it. You are now set to read your mail. An active file for this
9846 method will be created automatically.
9848 @vindex nnmail-procmail-suffix
9849 @vindex nnmail-procmail-directory
9850 If you use @code{nnfolder} or any other backend that store more than a
9851 single article in each file, you should never have procmail add mails to
9852 the file that Gnus sees. Instead, procmail should put all incoming mail
9853 in @code{nnmail-procmail-directory}. To arrive at the file name to put
9854 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
9855 name. The mail backends will read the mail from these files.
9857 @vindex nnmail-resplit-incoming
9858 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
9859 put in the @code{mail.misc}, as one would expect. However, if you want
9860 Gnus to split the mail the normal way, you could set
9861 @code{nnmail-resplit-incoming} to @code{t}.
9863 @vindex nnmail-keep-last-article
9864 If you use @code{procmail} to split things directly into an @code{nnmh}
9865 directory (which you shouldn't do), you should set
9866 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
9867 ever expiring the final article (i.e., the article with the highest
9868 article number) in a mail newsgroup. This is quite, quite important.
9870 Here's an example setup: The incoming spools are located in
9871 @file{~/incoming/} and have @samp{""} as suffixes (i.e., the incoming
9872 spool files have the same names as the equivalent groups). The
9873 @code{nnfolder} backend is to be used as the mail interface, and the
9874 @code{nnfolder} directory is @file{~/fMail/}.
9877 (setq nnfolder-directory "~/fMail/")
9878 (setq nnmail-spool-file 'procmail)
9879 (setq nnmail-procmail-directory "~/incoming/")
9880 (setq gnus-secondary-select-methods '((nnfolder "")))
9881 (setq nnmail-procmail-suffix "")
9885 @node Incorporating Old Mail
9886 @subsection Incorporating Old Mail
9888 Most people have lots of old mail stored in various file formats. If
9889 you have set up Gnus to read mail using one of the spiffy Gnus mail
9890 backends, you'll probably wish to have that old mail incorporated into
9893 Doing so can be quite easy.
9895 To take an example: You're reading mail using @code{nnml}
9896 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
9897 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
9898 file filled with important, but old, mail. You want to move it into
9899 your @code{nnml} groups.
9905 Go to the group buffer.
9908 Type `G f' and give the path to the mbox file when prompted to create an
9909 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9912 Type `SPACE' to enter the newly created group.
9915 Type `M P b' to process-mark all articles in this group's buffer
9916 (@pxref{Setting Process Marks}).
9919 Type `B r' to respool all the process-marked articles, and answer
9920 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9923 All the mail messages in the mbox file will now also be spread out over
9924 all your @code{nnml} groups. Try entering them and check whether things
9925 have gone without a glitch. If things look ok, you may consider
9926 deleting the mbox file, but I wouldn't do that unless I was absolutely
9927 sure that all the mail has ended up where it should be.
9929 Respooling is also a handy thing to do if you're switching from one mail
9930 backend to another. Just respool all the mail in the old mail groups
9931 using the new mail backend.
9935 @subsection Expiring Mail
9936 @cindex article expiry
9938 Traditional mail readers have a tendency to remove mail articles when
9939 you mark them as read, in some way. Gnus takes a fundamentally
9940 different approach to mail reading.
9942 Gnus basically considers mail just to be news that has been received in
9943 a rather peculiar manner. It does not think that it has the power to
9944 actually change the mail, or delete any mail messages. If you enter a
9945 mail group, and mark articles as ``read'', or kill them in some other
9946 fashion, the mail articles will still exist on the system. I repeat:
9947 Gnus will not delete your old, read mail. Unless you ask it to, of
9950 To make Gnus get rid of your unwanted mail, you have to mark the
9951 articles as @dfn{expirable}. This does not mean that the articles will
9952 disappear right away, however. In general, a mail article will be
9953 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9954 more than one week old. If you do not mark an article as expirable, it
9955 will remain on your system until hell freezes over. This bears
9956 repeating one more time, with some spurious capitalizations: IF you do
9957 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9959 @vindex gnus-auto-expirable-newsgroups
9960 You do not have to mark articles as expirable by hand. Groups that
9961 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9962 have all articles that you read marked as expirable automatically. All
9963 articles marked as expirable have an @samp{E} in the first
9964 column in the summary buffer.
9966 By default, if you have auto expiry switched on, Gnus will mark all the
9967 articles you read as expirable, no matter if they were read or unread
9968 before. To avoid having articles marked as read marked as expirable
9969 automatically, you can put something like the following in your
9972 @vindex gnus-mark-article-hook
9974 (remove-hook 'gnus-mark-article-hook
9975 'gnus-summary-mark-read-and-unread-as-read)
9976 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
9979 Note that making a group auto-expirable doesn't mean that all read
9980 articles are expired---only the articles marked as expirable
9981 will be expired. Also note that using the @kbd{d} command won't make
9982 groups expirable---only semi-automatic marking of articles as read will
9983 mark the articles as expirable in auto-expirable groups.
9985 Let's say you subscribe to a couple of mailing lists, and you want the
9986 articles you have read to disappear after a while:
9989 (setq gnus-auto-expirable-newsgroups
9990 "mail.nonsense-list\\|mail.nice-list")
9993 Another way to have auto-expiry happen is to have the element
9994 @code{auto-expire} in the group parameters of the group.
9996 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9997 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
9998 don't really mix very well.
10000 @vindex nnmail-expiry-wait
10001 The @code{nnmail-expiry-wait} variable supplies the default time an
10002 expirable article has to live. Gnus starts counting days from when the
10003 message @emph{arrived}, not from when it was sent. The default is seven
10006 Gnus also supplies a function that lets you fine-tune how long articles
10007 are to live, based on what group they are in. Let's say you want to
10008 have one month expiry period in the @samp{mail.private} group, a one day
10009 expiry period in the @samp{mail.junk} group, and a six day expiry period
10012 @vindex nnmail-expiry-wait-function
10014 (setq nnmail-expiry-wait-function
10016 (cond ((string= group "mail.private")
10018 ((string= group "mail.junk")
10020 ((string= group "important")
10026 The group names this function is fed are ``unadorned'' group
10027 names---no @samp{nnml:} prefixes and the like.
10029 The @code{nnmail-expiry-wait} variable and
10030 @code{nnmail-expiry-wait-function} function can either be a number (not
10031 necessarily an integer) or one of the symbols @code{immediate} or
10034 You can also use the @code{expiry-wait} group parameter to selectively
10035 change the expiry period (@pxref{Group Parameters}).
10037 @vindex nnmail-keep-last-article
10038 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
10039 expire the final article in a mail newsgroup. This is to make life
10040 easier for procmail users.
10042 @vindex gnus-total-expirable-newsgroups
10043 By the way: That line up there, about Gnus never expiring non-expirable
10044 articles, is a lie. If you put @code{total-expire} in the group
10045 parameters, articles will not be marked as expirable, but all read
10046 articles will be put through the expiry process. Use with extreme
10047 caution. Even more dangerous is the
10048 @code{gnus-total-expirable-newsgroups} variable. All groups that match
10049 this regexp will have all read articles put through the expiry process,
10050 which means that @emph{all} old mail articles in the groups in question
10051 will be deleted after a while. Use with extreme caution, and don't come
10052 crying to me when you discover that the regexp you used matched the
10053 wrong group and all your important mail has disappeared. Be a
10054 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
10057 Most people make most of their mail groups total-expirable, though.
10061 @subsection Washing Mail
10062 @cindex mail washing
10063 @cindex list server brain damage
10064 @cindex incoming mail treatment
10066 Mailers and list servers are notorious for doing all sorts of really,
10067 really stupid things with mail. ``Hey, RFC822 doesn't explicitly
10068 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
10069 end of all lines passing through our server, so let's do that!!!!1!''
10070 Yes, but RFC822 wasn't designed to be read by morons. Things that were
10071 considered to be self-evident were not discussed. So. Here we are.
10073 Case in point: The German version of Microsoft Exchange adds @samp{AW:
10074 } to the subjects of replies instead of @samp{Re: }. I could pretend to
10075 be shocked and dismayed by this, but I haven't got the energy. It is to
10078 Gnus provides a plethora of functions for washing articles while
10079 displaying them, but it might be nicer to do the filtering before
10080 storing the mail to disc. For that purpose, we have three hooks and
10081 various functions that can be put in these hooks.
10084 @item nnmail-prepare-incoming-hook
10085 @vindex nnmail-prepare-incoming-hook
10086 This hook is called before doing anything with the mail and is meant for
10087 grand, sweeping gestures. Functions to be used include:
10090 @item nnheader-ms-strip-cr
10091 @findex nnheader-ms-strip-cr
10092 Remove trailing carriage returns from each line. This is default on
10093 Emacs running on MS machines.
10097 @item nnmail-prepare-incoming-header-hook
10098 @vindex nnmail-prepare-incoming-header-hook
10099 This hook is called narrowed to each header. It can be used when
10100 cleaning up the headers. Functions that can be used include:
10103 @item nnmail-remove-leading-whitespace
10104 @findex nnmail-remove-leading-whitespace
10105 Clear leading white space that ``helpful'' listservs have added to the
10106 headers to make them look nice. Aaah.
10108 @item nnmail-remove-list-identifiers
10109 @findex nnmail-remove-list-identifiers
10110 Some list servers add an identifier---for example, @samp{(idm)}---to the
10111 beginning of all @code{Subject} headers. I'm sure that's nice for
10112 people who use stone age mail readers. This function will remove
10113 strings that match the @code{nnmail-list-identifiers} regexp, which can
10114 also be a list of regexp.
10116 For instance, if you want to remove the @samp{(idm)} and the
10117 @samp{nagnagnag} identifiers:
10120 (setq nnmail-list-identifiers
10121 '("(idm)" "nagnagnag"))
10124 @item nnmail-remove-tabs
10125 @findex nnmail-remove-tabs
10126 Translate all @samp{TAB} characters into @samp{SPACE} characters.
10130 @item nnmail-prepare-incoming-message-hook
10131 @vindex nnmail-prepare-incoming-message-hook
10132 This hook is called narrowed to each message. Functions to be used
10136 @item article-de-quoted-unreadable
10137 @findex article-de-quoted-unreadable
10138 Decode Quoted Readable encoding.
10145 @subsection Duplicates
10147 @vindex nnmail-treat-duplicates
10148 @vindex nnmail-message-id-cache-length
10149 @vindex nnmail-message-id-cache-file
10150 @cindex duplicate mails
10151 If you are a member of a couple of mailing lists, you will sometimes
10152 receive two copies of the same mail. This can be quite annoying, so
10153 @code{nnmail} checks for and treats any duplicates it might find. To do
10154 this, it keeps a cache of old @code{Message-ID}s---
10155 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
10156 default. The approximate maximum number of @code{Message-ID}s stored
10157 there is controlled by the @code{nnmail-message-id-cache-length}
10158 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
10159 stored.) If all this sounds scary to you, you can set
10160 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
10161 default), and @code{nnmail} won't delete duplicate mails. Instead it
10162 will insert a warning into the head of the mail saying that it thinks
10163 that this is a duplicate of a different message.
10165 This variable can also be a function. If that's the case, the function
10166 will be called from a buffer narrowed to the message in question with
10167 the @code{Message-ID} as a parameter. The function must return either
10168 @code{nil}, @code{warn}, or @code{delete}.
10170 You can turn this feature off completely by setting the variable to
10173 If you want all the duplicate mails to be put into a special
10174 @dfn{duplicates} group, you could do that using the normal mail split
10178 (setq nnmail-split-fancy
10179 '(| ;; Messages duplicates go to a separate group.
10180 ("gnus-warning" "duplication of message" "duplicate")
10181 ;; Message from daemons, postmaster, and the like to another.
10182 (any mail "mail.misc")
10189 (setq nnmail-split-methods
10190 '(("duplicates" "^Gnus-Warning:")
10195 Here's a neat feature: If you know that the recipient reads her mail
10196 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
10197 @code{delete}, you can send her as many insults as you like, just by
10198 using a @code{Message-ID} of a mail that you know that she's already
10199 received. Think of all the fun! She'll never see any of it! Whee!
10202 @node Not Reading Mail
10203 @subsection Not Reading Mail
10205 If you start using any of the mail backends, they have the annoying
10206 habit of assuming that you want to read mail with them. This might not
10207 be unreasonable, but it might not be what you want.
10209 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
10210 will ever attempt to read incoming mail, which should help.
10212 @vindex nnbabyl-get-new-mail
10213 @vindex nnmbox-get-new-mail
10214 @vindex nnml-get-new-mail
10215 @vindex nnmh-get-new-mail
10216 @vindex nnfolder-get-new-mail
10217 This might be too much, if, for instance, you are reading mail quite
10218 happily with @code{nnml} and just want to peek at some old @sc{rmail}
10219 file you have stashed away with @code{nnbabyl}. All backends have
10220 variables called backend-@code{get-new-mail}. If you want to disable
10221 the @code{nnbabyl} mail reading, you edit the virtual server for the
10222 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
10224 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
10225 narrowed to the article to be saved before saving it when reading
10229 @node Choosing a Mail Backend
10230 @subsection Choosing a Mail Backend
10232 Gnus will read the mail spool when you activate a mail group. The mail
10233 file is first copied to your home directory. What happens after that
10234 depends on what format you want to store your mail in.
10237 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
10238 * Rmail Babyl:: Emacs programs use the rmail babyl format.
10239 * Mail Spool:: Store your mail in a private spool?
10240 * MH Spool:: An mhspool-like backend.
10241 * Mail Folders:: Having one file for each group.
10245 @node Unix Mail Box
10246 @subsubsection Unix Mail Box
10248 @cindex unix mail box
10250 @vindex nnmbox-active-file
10251 @vindex nnmbox-mbox-file
10252 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
10253 mail. @code{nnmbox} will add extra headers to each mail article to say
10254 which group it belongs in.
10256 Virtual server settings:
10259 @item nnmbox-mbox-file
10260 @vindex nnmbox-mbox-file
10261 The name of the mail box in the user's home directory.
10263 @item nnmbox-active-file
10264 @vindex nnmbox-active-file
10265 The name of the active file for the mail box.
10267 @item nnmbox-get-new-mail
10268 @vindex nnmbox-get-new-mail
10269 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
10275 @subsubsection Rmail Babyl
10279 @vindex nnbabyl-active-file
10280 @vindex nnbabyl-mbox-file
10281 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
10282 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
10283 article to say which group it belongs in.
10285 Virtual server settings:
10288 @item nnbabyl-mbox-file
10289 @vindex nnbabyl-mbox-file
10290 The name of the rmail mbox file.
10292 @item nnbabyl-active-file
10293 @vindex nnbabyl-active-file
10294 The name of the active file for the rmail box.
10296 @item nnbabyl-get-new-mail
10297 @vindex nnbabyl-get-new-mail
10298 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
10303 @subsubsection Mail Spool
10305 @cindex mail @sc{nov} spool
10307 The @dfn{nnml} spool mail format isn't compatible with any other known
10308 format. It should be used with some caution.
10310 @vindex nnml-directory
10311 If you use this backend, Gnus will split all incoming mail into files,
10312 one file for each mail, and put the articles into the corresponding
10313 directories under the directory specified by the @code{nnml-directory}
10314 variable. The default value is @file{~/Mail/}.
10316 You do not have to create any directories beforehand; Gnus will take
10319 If you have a strict limit as to how many files you are allowed to store
10320 in your account, you should not use this backend. As each mail gets its
10321 own file, you might very well occupy thousands of inodes within a few
10322 weeks. If this is no problem for you, and it isn't a problem for you
10323 having your friendly systems administrator walking around, madly,
10324 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
10325 know that this is probably the fastest format to use. You do not have
10326 to trudge through a big mbox file just to read your new mail.
10328 @code{nnml} is probably the slowest backend when it comes to article
10329 splitting. It has to create lots of files, and it also generates
10330 @sc{nov} databases for the incoming mails. This makes it the fastest
10331 backend when it comes to reading mail.
10333 Virtual server settings:
10336 @item nnml-directory
10337 @vindex nnml-directory
10338 All @code{nnml} directories will be placed under this directory.
10340 @item nnml-active-file
10341 @vindex nnml-active-file
10342 The active file for the @code{nnml} server.
10344 @item nnml-newsgroups-file
10345 @vindex nnml-newsgroups-file
10346 The @code{nnml} group descriptions file. @xref{Newsgroups File
10349 @item nnml-get-new-mail
10350 @vindex nnml-get-new-mail
10351 If non-@code{nil}, @code{nnml} will read incoming mail.
10353 @item nnml-nov-is-evil
10354 @vindex nnml-nov-is-evil
10355 If non-@code{nil}, this backend will ignore any @sc{nov} files.
10357 @item nnml-nov-file-name
10358 @vindex nnml-nov-file-name
10359 The name of the @sc{nov} files. The default is @file{.overview}.
10361 @item nnml-prepare-save-mail-hook
10362 @vindex nnml-prepare-save-mail-hook
10363 Hook run narrowed to an article before saving.
10367 @findex nnml-generate-nov-databases
10368 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
10369 you can do a complete update by typing @kbd{M-x
10370 nnml-generate-nov-databases}. This command will trawl through the
10371 entire @code{nnml} hierarchy, looking at each and every article, so it
10372 might take a while to complete. A better interface to this
10373 functionality can be found in the server buffer (@pxref{Server
10378 @subsubsection MH Spool
10380 @cindex mh-e mail spool
10382 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
10383 @sc{nov} databases and it doesn't keep an active file. This makes
10384 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
10385 makes it easier to write procmail scripts for.
10387 Virtual server settings:
10390 @item nnmh-directory
10391 @vindex nnmh-directory
10392 All @code{nnmh} directories will be located under this directory.
10394 @item nnmh-get-new-mail
10395 @vindex nnmh-get-new-mail
10396 If non-@code{nil}, @code{nnmh} will read incoming mail.
10399 @vindex nnmh-be-safe
10400 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
10401 sure that the articles in the folder are actually what Gnus thinks they
10402 are. It will check date stamps and stat everything in sight, so
10403 setting this to @code{t} will mean a serious slow-down. If you never
10404 use anything but Gnus to read the @code{nnmh} articles, you do not have
10405 to set this variable to @code{t}.
10410 @subsubsection Mail Folders
10412 @cindex mbox folders
10413 @cindex mail folders
10415 @code{nnfolder} is a backend for storing each mail group in a separate
10416 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
10417 will add extra headers to keep track of article numbers and arrival
10420 Virtual server settings:
10423 @item nnfolder-directory
10424 @vindex nnfolder-directory
10425 All the @code{nnfolder} mail boxes will be stored under this directory.
10427 @item nnfolder-active-file
10428 @vindex nnfolder-active-file
10429 The name of the active file.
10431 @item nnfolder-newsgroups-file
10432 @vindex nnfolder-newsgroups-file
10433 The name of the group descriptions file. @xref{Newsgroups File Format}.
10435 @item nnfolder-get-new-mail
10436 @vindex nnfolder-get-new-mail
10437 If non-@code{nil}, @code{nnfolder} will read incoming mail.
10439 @item nnfolder-save-buffer-hook
10440 @vindex nnfolder-save-buffer-hook
10441 @cindex backup files
10442 Hook run before saving the folders. Note that Emacs does the normal
10443 backup renaming of files even with the @code{nnfolder} buffers. If you
10444 wish to switch this off, you could say something like the following in
10445 your @file{.emacs} file:
10448 (defun turn-off-backup ()
10449 (set (make-local-variable 'backup-inhibited) t))
10451 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
10454 @item nnfolder-delete-mail-hook
10455 @vindex nnfolder-delete-mail-hook
10456 Hook run in a buffer narrowed to the message that is to be deleted.
10457 This function can be used to copy the message to somewhere else, or to
10458 extract some information from it before removing it.
10463 @findex nnfolder-generate-active-file
10464 @kindex M-x nnfolder-generate-active-file
10465 If you have lots of @code{nnfolder}-like files you'd like to read with
10466 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
10467 command to make @code{nnfolder} aware of all likely files in
10468 @code{nnfolder-directory}.
10471 @node Other Sources
10472 @section Other Sources
10474 Gnus can do more than just read news or mail. The methods described
10475 below allow Gnus to view directories and files as if they were
10479 * Directory Groups:: You can read a directory as if it was a newsgroup.
10480 * Anything Groups:: Dired? Who needs dired?
10481 * Document Groups:: Single files can be the basis of a group.
10482 * SOUP:: Reading @sc{SOUP} packets ``offline''.
10483 * Web Searches:: Creating groups from articles that match a string.
10484 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
10488 @node Directory Groups
10489 @subsection Directory Groups
10491 @cindex directory groups
10493 If you have a directory that has lots of articles in separate files in
10494 it, you might treat it as a newsgroup. The files have to have numerical
10497 This might be an opportune moment to mention @code{ange-ftp} (and its
10498 successor @code{efs}), that most wonderful of all wonderful Emacs
10499 packages. When I wrote @code{nndir}, I didn't think much about it---a
10500 backend to read directories. Big deal.
10502 @code{ange-ftp} changes that picture dramatically. For instance, if you
10503 enter the @code{ange-ftp} file name
10504 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
10505 @code{ange-ftp} or @code{efs} will actually allow you to read this
10506 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
10508 @code{nndir} will use @sc{nov} files if they are present.
10510 @code{nndir} is a ``read-only'' backend---you can't delete or expire
10511 articles with this method. You can use @code{nnmh} or @code{nnml} for
10512 whatever you use @code{nndir} for, so you could switch to any of those
10513 methods if you feel the need to have a non-read-only @code{nndir}.
10516 @node Anything Groups
10517 @subsection Anything Groups
10520 From the @code{nndir} backend (which reads a single spool-like
10521 directory), it's just a hop and a skip to @code{nneething}, which
10522 pretends that any arbitrary directory is a newsgroup. Strange, but
10525 When @code{nneething} is presented with a directory, it will scan this
10526 directory and assign article numbers to each file. When you enter such
10527 a group, @code{nneething} must create ``headers'' that Gnus can use.
10528 After all, Gnus is a newsreader, in case you're
10529 forgetting. @code{nneething} does this in a two-step process. First, it
10530 snoops each file in question. If the file looks like an article (i.e.,
10531 the first few lines look like headers), it will use this as the head.
10532 If this is just some arbitrary file without a head (e.g. a C source
10533 file), @code{nneething} will cobble up a header out of thin air. It
10534 will use file ownership, name and date and do whatever it can with these
10537 All this should happen automatically for you, and you will be presented
10538 with something that looks very much like a newsgroup. Totally like a
10539 newsgroup, to be precise. If you select an article, it will be displayed
10540 in the article buffer, just as usual.
10542 If you select a line that represents a directory, Gnus will pop you into
10543 a new summary buffer for this @code{nneething} group. And so on. You can
10544 traverse the entire disk this way, if you feel like, but remember that
10545 Gnus is not dired, really, and does not intend to be, either.
10547 There are two overall modes to this action---ephemeral or solid. When
10548 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
10549 will not store information on what files you have read, and what files
10550 are new, and so on. If you create a solid @code{nneething} group the
10551 normal way with @kbd{G m}, Gnus will store a mapping table between
10552 article numbers and file names, and you can treat this group like any
10553 other groups. When you activate a solid @code{nneething} group, you will
10554 be told how many unread articles it contains, etc., etc.
10559 @item nneething-map-file-directory
10560 @vindex nneething-map-file-directory
10561 All the mapping files for solid @code{nneething} groups will be stored
10562 in this directory, which defaults to @file{~/.nneething/}.
10564 @item nneething-exclude-files
10565 @vindex nneething-exclude-files
10566 All files that match this regexp will be ignored. Nice to use to exclude
10567 auto-save files and the like, which is what it does by default.
10569 @item nneething-map-file
10570 @vindex nneething-map-file
10571 Name of the map files.
10575 @node Document Groups
10576 @subsection Document Groups
10578 @cindex documentation group
10581 @code{nndoc} is a cute little thing that will let you read a single file
10582 as a newsgroup. Several files types are supported:
10589 The babyl (rmail) mail box.
10594 The standard Unix mbox file.
10596 @cindex MMDF mail box
10598 The MMDF mail box format.
10601 Several news articles appended into a file.
10604 @cindex rnews batch files
10605 The rnews batch transport format.
10606 @cindex forwarded messages
10609 Forwarded articles.
10612 MIME multipart messages, besides digests.
10616 @cindex MIME digest
10617 @cindex 1153 digest
10618 @cindex RFC 1153 digest
10619 @cindex RFC 341 digest
10620 MIME (RFC 1341) digest format.
10622 @item standard-digest
10623 The standard (RFC 1153) digest format.
10626 Non-standard digest format---matches most things, but does it badly.
10629 You can also use the special ``file type'' @code{guess}, which means
10630 that @code{nndoc} will try to guess what file type it is looking at.
10631 @code{digest} means that @code{nndoc} should guess what digest type the
10634 @code{nndoc} will not try to change the file or insert any extra headers into
10635 it---it will simply, like, let you use the file as the basis for a
10636 group. And that's it.
10638 If you have some old archived articles that you want to insert into your
10639 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
10640 that. Say you have an old @file{RMAIL} file with mail that you now want
10641 to split into your new @code{nnml} groups. You look at that file using
10642 @code{nndoc} (using the @kbd{G f} command in the group buffer
10643 (@pxref{Foreign Groups})), set the process mark on all the articles in
10644 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
10645 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
10646 file is now also stored in lots of @code{nnml} directories, and you can
10647 delete that pesky @file{RMAIL} file. If you have the guts!
10649 Virtual server variables:
10652 @item nndoc-article-type
10653 @vindex nndoc-article-type
10654 This should be one of @code{mbox}, @code{babyl}, @code{digest},
10655 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
10656 @code{rfc822-forward}, @code{mime-parts}, @code{mime-digest},
10657 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs} or
10660 @item nndoc-post-type
10661 @vindex nndoc-post-type
10662 This variable says whether Gnus is to consider the group a news group or
10663 a mail group. There are two valid values: @code{mail} (the default)
10668 * Document Server Internals:: How to add your own document types.
10672 @node Document Server Internals
10673 @subsubsection Document Server Internals
10675 Adding new document types to be recognized by @code{nndoc} isn't
10676 difficult. You just have to whip up a definition of what the document
10677 looks like, write a predicate function to recognize that document type,
10678 and then hook into @code{nndoc}.
10680 First, here's an example document type definition:
10684 (article-begin . "^\^A\^A\^A\^A\n")
10685 (body-end . "^\^A\^A\^A\^A\n"))
10688 The definition is simply a unique @dfn{name} followed by a series of
10689 regexp pseudo-variable settings. Below are the possible
10690 variables---don't be daunted by the number of variables; most document
10691 types can be defined with very few settings:
10694 @item first-article
10695 If present, @code{nndoc} will skip past all text until it finds
10696 something that match this regexp. All text before this will be
10699 @item article-begin
10700 This setting has to be present in all document type definitions. It
10701 says what the beginning of each article looks like.
10703 @item head-begin-function
10704 If present, this should be a function that moves point to the head of
10707 @item nndoc-head-begin
10708 If present, this should be a regexp that matches the head of the
10711 @item nndoc-head-end
10712 This should match the end of the head of the article. It defaults to
10713 @samp{^$}---the empty line.
10715 @item body-begin-function
10716 If present, this function should move point to the beginning of the body
10720 This should match the beginning of the body of the article. It defaults
10723 @item body-end-function
10724 If present, this function should move point to the end of the body of
10728 If present, this should match the end of the body of the article.
10731 If present, this should match the end of the file. All text after this
10732 regexp will be totally ignored.
10736 So, using these variables @code{nndoc} is able to dissect a document
10737 file into a series of articles, each with a head and a body. However, a
10738 few more variables are needed since not all document types are all that
10739 news-like---variables needed to transform the head or the body into
10740 something that's palatable for Gnus:
10743 @item prepare-body-function
10744 If present, this function will be called when requesting an article. It
10745 will be called with point at the start of the body, and is useful if the
10746 document has encoded some parts of its contents.
10748 @item article-transform-function
10749 If present, this function is called when requesting an article. It's
10750 meant to be used for more wide-ranging transformation of both head and
10751 body of the article.
10753 @item generate-head-function
10754 If present, this function is called to generate a head that Gnus can
10755 understand. It is called with the article number as a parameter, and is
10756 expected to generate a nice head for the article in question. It is
10757 called when requesting the headers of all articles.
10761 Let's look at the most complicated example I can come up with---standard
10766 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
10767 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
10768 (prepare-body-function . nndoc-unquote-dashes)
10769 (body-end-function . nndoc-digest-body-end)
10770 (head-end . "^ ?$")
10771 (body-begin . "^ ?\n")
10772 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
10773 (subtype digest guess))
10776 We see that all text before a 70-width line of dashes is ignored; all
10777 text after a line that starts with that @samp{^End of} is also ignored;
10778 each article begins with a 30-width line of dashes; the line separating
10779 the head from the body may contain a single space; and that the body is
10780 run through @code{nndoc-unquote-dashes} before being delivered.
10782 To hook your own document definition into @code{nndoc}, use the
10783 @code{nndoc-add-type} function. It takes two parameters---the first is
10784 the definition itself and the second (optional) parameter says where in
10785 the document type definition alist to put this definition. The alist is
10786 traversed sequentially, and @code{nndoc-TYPE-type-p} is called for a given type @code{TYPE}. So @code{nndoc-mmdf-type-p} is called to see whether a document
10787 is of @code{mmdf} type, and so on. These type predicates should return
10788 @code{nil} if the document is not of the correct type; @code{t} if it is
10789 of the correct type; and a number if the document might be of the
10790 correct type. A high number means high probability; a low number means
10791 low probability with @samp{0} being the lowest valid number.
10799 In the PC world people often talk about ``offline'' newsreaders. These
10800 are thingies that are combined reader/news transport monstrosities.
10801 With built-in modem programs. Yecchh!
10803 Of course, us Unix Weenie types of human beans use things like
10804 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
10805 transport things like Ghod intended. And then we just use normal
10808 However, it can sometimes be convenient to do something a that's a bit
10809 easier on the brain if you have a very slow modem, and you're not really
10810 that interested in doing things properly.
10812 A file format called @sc{soup} has been developed for transporting news
10813 and mail from servers to home machines and back again. It can be a bit
10816 First some terminology:
10821 This is the machine that is connected to the outside world and where you
10822 get news and/or mail from.
10825 This is the machine that you want to do the actual reading and responding
10826 on. It is typically not connected to the rest of the world in any way.
10829 Something that contains messages and/or commands. There are two kinds
10833 @item message packets
10834 These are packets made at the server, and typically contain lots of
10835 messages for you to read. These are called @file{SoupoutX.tgz} by
10836 default, where @var{X} is a number.
10838 @item response packets
10839 These are packets made at the home machine, and typically contains
10840 replies that you've written. These are called @file{SoupinX.tgz} by
10841 default, where @var{X} is a number.
10851 You log in on the server and create a @sc{soup} packet. You can either
10852 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
10853 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
10854 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
10857 You transfer the packet home. Rail, boat, car or modem will do fine.
10860 You put the packet in your home directory.
10863 You fire up Gnus on your home machine using the @code{nnsoup} backend as
10864 the native or secondary server.
10867 You read articles and mail and answer and followup to the things you
10868 want (@pxref{SOUP Replies}).
10871 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
10875 You transfer this packet to the server.
10878 You use Gnus to mail this packet out with the @kbd{G s s} command.
10881 You then repeat until you die.
10885 So you basically have a bipartite system---you use @code{nnsoup} for
10886 reading and Gnus for packing/sending these @sc{soup} packets.
10889 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
10890 * SOUP Groups:: A backend for reading @sc{soup} packets.
10891 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
10895 @node SOUP Commands
10896 @subsubsection SOUP Commands
10898 These are commands for creating and manipulating @sc{soup} packets.
10902 @kindex G s b (Group)
10903 @findex gnus-group-brew-soup
10904 Pack all unread articles in the current group
10905 (@code{gnus-group-brew-soup}). This command understands the
10906 process/prefix convention.
10909 @kindex G s w (Group)
10910 @findex gnus-soup-save-areas
10911 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
10914 @kindex G s s (Group)
10915 @findex gnus-soup-send-replies
10916 Send all replies from the replies packet
10917 (@code{gnus-soup-send-replies}).
10920 @kindex G s p (Group)
10921 @findex gnus-soup-pack-packet
10922 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
10925 @kindex G s r (Group)
10926 @findex nnsoup-pack-replies
10927 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
10930 @kindex O s (Summary)
10931 @findex gnus-soup-add-article
10932 This summary-mode command adds the current article to a @sc{soup} packet
10933 (@code{gnus-soup-add-article}). It understands the process/prefix
10934 convention (@pxref{Process/Prefix}).
10939 There are a few variables to customize where Gnus will put all these
10944 @item gnus-soup-directory
10945 @vindex gnus-soup-directory
10946 Directory where Gnus will save intermediate files while composing
10947 @sc{soup} packets. The default is @file{~/SoupBrew/}.
10949 @item gnus-soup-replies-directory
10950 @vindex gnus-soup-replies-directory
10951 This is what Gnus will use as a temporary directory while sending our
10952 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
10954 @item gnus-soup-prefix-file
10955 @vindex gnus-soup-prefix-file
10956 Name of the file where Gnus stores the last used prefix. The default is
10957 @samp{gnus-prefix}.
10959 @item gnus-soup-packer
10960 @vindex gnus-soup-packer
10961 A format string command for packing a @sc{soup} packet. The default is
10962 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
10964 @item gnus-soup-unpacker
10965 @vindex gnus-soup-unpacker
10966 Format string command for unpacking a @sc{soup} packet. The default is
10967 @samp{gunzip -c %s | tar xvf -}.
10969 @item gnus-soup-packet-directory
10970 @vindex gnus-soup-packet-directory
10971 Where Gnus will look for reply packets. The default is @file{~/}.
10973 @item gnus-soup-packet-regexp
10974 @vindex gnus-soup-packet-regexp
10975 Regular expression matching @sc{soup} reply packets in
10976 @code{gnus-soup-packet-directory}.
10982 @subsubsection @sc{soup} Groups
10985 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
10986 read incoming packets, unpack them, and put them in a directory where
10987 you can read them at leisure.
10989 These are the variables you can use to customize its behavior:
10993 @item nnsoup-tmp-directory
10994 @vindex nnsoup-tmp-directory
10995 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10996 directory. (@file{/tmp/} by default.)
10998 @item nnsoup-directory
10999 @vindex nnsoup-directory
11000 @code{nnsoup} then moves each message and index file to this directory.
11001 The default is @file{~/SOUP/}.
11003 @item nnsoup-replies-directory
11004 @vindex nnsoup-replies-directory
11005 All replies will be stored in this directory before being packed into a
11006 reply packet. The default is @file{~/SOUP/replies/"}.
11008 @item nnsoup-replies-format-type
11009 @vindex nnsoup-replies-format-type
11010 The @sc{soup} format of the replies packets. The default is @samp{?n}
11011 (rnews), and I don't think you should touch that variable. I probably
11012 shouldn't even have documented it. Drats! Too late!
11014 @item nnsoup-replies-index-type
11015 @vindex nnsoup-replies-index-type
11016 The index type of the replies packet. The default is @samp{?n}, which
11017 means ``none''. Don't fiddle with this one either!
11019 @item nnsoup-active-file
11020 @vindex nnsoup-active-file
11021 Where @code{nnsoup} stores lots of information. This is not an ``active
11022 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
11023 this file or mess it up in any way, you're dead. The default is
11024 @file{~/SOUP/active}.
11026 @item nnsoup-packer
11027 @vindex nnsoup-packer
11028 Format string command for packing a reply @sc{soup} packet. The default
11029 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
11031 @item nnsoup-unpacker
11032 @vindex nnsoup-unpacker
11033 Format string command for unpacking incoming @sc{soup} packets. The
11034 default is @samp{gunzip -c %s | tar xvf -}.
11036 @item nnsoup-packet-directory
11037 @vindex nnsoup-packet-directory
11038 Where @code{nnsoup} will look for incoming packets. The default is
11041 @item nnsoup-packet-regexp
11042 @vindex nnsoup-packet-regexp
11043 Regular expression matching incoming @sc{soup} packets. The default is
11046 @item nnsoup-always-save
11047 @vindex nnsoup-always-save
11048 If non-@code{nil}, save the replies buffer after each posted message.
11054 @subsubsection SOUP Replies
11056 Just using @code{nnsoup} won't mean that your postings and mailings end
11057 up in @sc{soup} reply packets automagically. You have to work a bit
11058 more for that to happen.
11060 @findex nnsoup-set-variables
11061 The @code{nnsoup-set-variables} command will set the appropriate
11062 variables to ensure that all your followups and replies end up in the
11065 In specific, this is what it does:
11068 (setq message-send-news-function 'nnsoup-request-post)
11069 (setq message-send-mail-function 'nnsoup-request-mail)
11072 And that's it, really. If you only want news to go into the @sc{soup}
11073 system you just use the first line. If you only want mail to be
11074 @sc{soup}ed you use the second.
11078 @subsection Web Searches
11082 @cindex InReference
11083 @cindex Usenet searches
11084 @cindex searching the Usenet
11086 It's, like, too neat to search the Usenet for articles that match a
11087 string, but it, like, totally @emph{sucks}, like, totally, to use one of
11088 those, like, Web browsers, and you, like, have to, rilly, like, look at
11089 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
11090 searches without having to use a browser.
11092 The @code{nnweb} backend allows an easy interface to the mighty search
11093 engine. You create an @code{nnweb} group, enter a search pattern, and
11094 then enter the group and read the articles like you would any normal
11095 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
11096 Groups}) will do this in an easy-to-use fashion.
11098 @code{nnweb} groups don't really lend themselves to being solid
11099 groups---they have a very fleeting idea of article numbers. In fact,
11100 each time you enter an @code{nnweb} group (not even changing the search
11101 pattern), you are likely to get the articles ordered in a different
11102 manner. Not even using duplicate suppression (@pxref{Duplicate
11103 Suppression}) will help, since @code{nnweb} doesn't even know the
11104 @code{Message-ID} of the articles before reading them using some search
11105 engines (DejaNews, for instance). The only possible way to keep track
11106 of which articles you've read is by scoring on the @code{Date}
11107 header---mark all articles posted before the last date you read the
11110 If the search engine changes its output substantially, @code{nnweb}
11111 won't be able to parse it and will fail. One could hardly fault the Web
11112 providers if they were to do this---their @emph{raison d'
\e,Aj
\e(Btre} is to
11113 make money off of advertisements, not to provide services to the
11114 community. Since @code{nnweb} washes the ads off all the articles, one
11115 might think that the providers might be somewhat miffed. We'll see.
11117 You must have the @code{url} and @code{w3} package installed to be able
11118 to use @code{nnweb}.
11120 Virtual server variables:
11125 What search engine type is being used. The currently supported types
11126 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
11130 @vindex nnweb-search
11131 The search string to feed to the search engine.
11133 @item nnweb-max-hits
11134 @vindex nnweb-max-hits
11135 Advisory maximum number of hits per search to display. The default is
11138 @item nnweb-type-definition
11139 @vindex nnweb-type-definition
11140 Type-to-definition alist. This alist says what @code{nnweb} should do
11141 with the various search engine types. The following elements must be
11146 Function to decode the article and provide something that Gnus
11150 Function to create an article number to message header and URL alist.
11153 Function to send the search string to the search engine.
11156 The address the aforementioned function should send the search string
11160 Format string URL to fetch an article by @code{Message-ID}.
11167 @node Mail-To-News Gateways
11168 @subsection Mail-To-News Gateways
11169 @cindex mail-to-news gateways
11172 If your local @code{nntp} server doesn't allow posting, for some reason
11173 or other, you can post using one of the numerous mail-to-news gateways.
11174 The @code{nngateway} backend provides the interface.
11176 Note that you can't read anything from this backend---it can only be
11182 @item nngateway-address
11183 @vindex nngateway-address
11184 This is the address of the mail-to-news gateway.
11186 @item nngateway-header-transformation
11187 @vindex nngateway-header-transformation
11188 News headers often have to be transformed in some odd way or other
11189 for the mail-to-news gateway to accept it. This variable says what
11190 transformation should be called, and defaults to
11191 @code{nngateway-simple-header-transformation}. The function is called
11192 narrowed to the headers to be transformed and with one parameter---the
11195 This default function just inserts a new @code{To} header based on the
11196 @code{Newsgroups} header and the gateway address.
11197 For instance, an article with this @code{Newsgroups} header:
11200 Newsgroups: alt.religion.emacs
11203 will get this @code{From} header inserted:
11206 To: alt-religion-emacs@@GATEWAY
11209 The following pre-defined functions exist:
11211 @findex nngateway-simple-header-transformation
11214 @item nngateway-simple-header-transformation
11215 Creates a @code{To} header that looks like
11216 @var{newsgroup}@@@code{nngateway-address}.
11218 @findex nngateway-mail2news-header-transformation
11220 @item nngateway-mail2news-header-transformation
11221 Creates a @code{To} header that looks like
11222 @code{nngateway-address}.
11227 (setq gnus-post-method
11228 '(nngateway "mail2news@@replay.com"
11229 (nngateway-header-transformation
11230 nngateway-mail2news-header-transformation)))
11238 So, to use this, simply say something like:
11241 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
11245 @node Combined Groups
11246 @section Combined Groups
11248 Gnus allows combining a mixture of all the other group types into bigger
11252 * Virtual Groups:: Combining articles from many groups.
11253 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
11257 @node Virtual Groups
11258 @subsection Virtual Groups
11260 @cindex virtual groups
11261 @cindex merging groups
11263 An @dfn{nnvirtual group} is really nothing more than a collection of
11266 For instance, if you are tired of reading many small groups, you can
11267 put them all in one big group, and then grow tired of reading one
11268 big, unwieldy group. The joys of computing!
11270 You specify @code{nnvirtual} as the method. The address should be a
11271 regexp to match component groups.
11273 All marks in the virtual group will stick to the articles in the
11274 component groups. So if you tick an article in a virtual group, the
11275 article will also be ticked in the component group from whence it came.
11276 (And vice versa---marks from the component groups will also be shown in
11277 the virtual group.)
11279 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
11280 newsgroups into one, big, happy newsgroup:
11283 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
11286 The component groups can be native or foreign; everything should work
11287 smoothly, but if your computer explodes, it was probably my fault.
11289 Collecting the same group from several servers might actually be a good
11290 idea if users have set the Distribution header to limit distribution.
11291 If you would like to read @samp{soc.motss} both from a server in Japan
11292 and a server in Norway, you could use the following as the group regexp:
11295 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
11298 (Remember, though, that if you're creating the group with @kbd{G m}, you
11299 shouldn't double the backslashes, and you should leave off the quote
11300 characters at the beginning and the end of the string.)
11302 This should work kinda smoothly---all articles from both groups should
11303 end up in this one, and there should be no duplicates. Threading (and
11304 the rest) will still work as usual, but there might be problems with the
11305 sequence of articles. Sorting on date might be an option here
11306 (@pxref{Selecting a Group}).
11308 One limitation, however---all groups included in a virtual
11309 group have to be alive (i.e., subscribed or unsubscribed). Killed or
11310 zombie groups can't be component groups for @code{nnvirtual} groups.
11312 @vindex nnvirtual-always-rescan
11313 If the @code{nnvirtual-always-rescan} is non-@code{nil},
11314 @code{nnvirtual} will always scan groups for unread articles when
11315 entering a virtual group. If this variable is @code{nil} (which is the
11316 default) and you read articles in a component group after the virtual
11317 group has been activated, the read articles from the component group
11318 will show up when you enter the virtual group. You'll also see this
11319 effect if you have two virtual groups that have a component group in
11320 common. If that's the case, you should set this variable to @code{t}.
11321 Or you can just tap @code{M-g} on the virtual group every time before
11322 you enter it---it'll have much the same effect.
11324 @code{nnvirtual} can have both mail and news groups as component groups.
11325 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
11326 has to ask the backend of the component group the article comes from
11327 whether it is a news or mail backend. However, when you do a @kbd{^},
11328 there is typically no sure way for the component backend to know this,
11329 and in that case @code{nnvirtual} tells Gnus that the article came from a
11330 not-news backend. (Just to be on the safe side.)
11332 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
11333 line from the article you respond to in these cases.
11337 @node Kibozed Groups
11338 @subsection Kibozed Groups
11342 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
11343 the news feed''. @code{nnkiboze} is a backend that will do this for
11344 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
11345 with useless requests! Oh happiness!
11347 @kindex G k (Group)
11348 To create a kibozed group, use the @kbd{G k} command in the group
11351 The address field of the @code{nnkiboze} method is, as with
11352 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
11353 @code{nnkiboze} group. That's where most similarities between @code{nnkiboze}
11354 and @code{nnvirtual} end.
11356 In addition to this regexp detailing component groups, an @code{nnkiboze} group
11357 must have a score file to say what articles are to be included in
11358 the group (@pxref{Scoring}).
11360 @kindex M-x nnkiboze-generate-groups
11361 @findex nnkiboze-generate-groups
11362 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
11363 @code{nnkiboze} groups you want to have. This command will take time. Lots of
11364 time. Oodles and oodles of time. Gnus has to fetch the headers from
11365 all the articles in all the component groups and run them through the
11366 scoring process to determine if there are any articles in the groups
11367 that are to be part of the @code{nnkiboze} groups.
11369 Please limit the number of component groups by using restrictive
11370 regexps. Otherwise your sysadmin may become annoyed with you, and the
11371 @sc{nntp} site may throw you off and never let you back in again.
11372 Stranger things have happened.
11374 @code{nnkiboze} component groups do not have to be alive---they can be dead,
11375 and they can be foreign. No restrictions.
11377 @vindex nnkiboze-directory
11378 The generation of an @code{nnkiboze} group means writing two files in
11379 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
11380 contains the @sc{nov} header lines for all the articles in the group,
11381 and the other is an additional @file{.newsrc} file to store information
11382 on what groups have been searched through to find component articles.
11384 Articles marked as read in the @code{nnkiboze} group will have
11385 their @sc{nov} lines removed from the @sc{nov} file.
11388 @node Gnus Unplugged
11389 @section Gnus Unplugged
11394 @cindex Gnus Unplugged
11396 In olden times (ca. February '88), people used to run their newsreaders
11397 on big machines with permanent connections to the net. News transport
11398 was dealt with by news servers, and all the newsreaders had to do was to
11399 read news. Believe it or not.
11401 Nowadays most people read news and mail at home, and use some sort of
11402 modem to connect to the net. To avoid running up huge phone bills, it
11403 would be nice to have a way to slurp down all the news and mail, hang up
11404 the phone, read for several hours, and then upload any responses you
11405 have to make. And then you repeat the procedure.
11407 Of course, you can use news servers for doing this as well. I've used
11408 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
11409 for some years, but doing that's a bore. Moving the news server
11410 functionality up to the newsreader makes sense if you're the only person
11411 reading news on a machine.
11413 Using Gnus as an ``offline'' newsreader is quite simple.
11417 First, set up Gnus as you would do if you were running it on a machine
11418 that has full connection to the net. Go ahead. I'll still be waiting
11422 Then, put the following magical incantation at the end of your
11423 @file{.gnus.el} file:
11430 That's it. Gnus is now an ``offline'' newsreader.
11432 Of course, to use it as such, you have to learn a few new commands.
11435 * Agent Basics:: How it all is supposed to work.
11436 * Agent Categories:: How to tell the Gnus Agent what to download.
11437 * Agent Commands:: New commands for all the buffers.
11438 * Agent Expiry:: How to make old articles go away.
11439 * Outgoing Messages:: What happens when you post/mail something?
11440 * Agent Variables:: Customizing is fun.
11441 * Example Setup:: An example @file{.gnus.el} file for offline people.
11442 * Batching Agents:: How to fetch news from a @code{cron} job.
11447 @subsection Agent Basics
11449 First, let's get some terminology out of the way.
11451 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
11452 connection to the net (and notified the Agent that this is the case).
11453 When the connection to the net is up again (and Gnus knows this), the
11454 Agent is @dfn{plugged}.
11456 The @dfn{local} machine is the one you're running on, and which isn't
11457 connected to the net continuously.
11459 @dfn{Downloading} means fetching things from the net to your local
11460 machine. @dfn{Uploading} is doing the opposite.
11462 Let's take a typical Gnus session using the Agent.
11467 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
11468 Agent in a disconnected state. You can read all the news that you have
11469 already fetched while in this mode.
11472 You then decide to see whether any new news has arrived. You connect
11473 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
11474 to make Gnus become @dfn{plugged}.
11477 You can then read the new news immediately, or you can download the news
11478 onto your local machine. If you want to do the latter, you press @kbd{J
11479 s} to fetch all the eligible articles in all the groups. (To let Gnus
11480 know which articles you want to download, @pxref{Agent Categories}.)
11483 After fetching the articles, you press @kbd{J j} to make Gnus become
11484 unplugged again, and you shut down the PPP thing (or whatever). And
11485 then you read the news offline.
11488 And then you go to step 2.
11491 Here are some things you should do the first time (or so) that you use
11497 Decide which servers should be covered by the Agent. If you have a mail
11498 backend, it would probably be nonsensical to have it covered by the
11499 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
11500 @kbd{J a} the server (or servers) that you wish to have covered by the
11501 Agent (@pxref{Server Agent Commands}). This will typically be only the
11502 primary select method, which is listed on the bottom in the buffer.
11505 Decide on download policy. @xref{Agent Categories}
11512 @node Agent Categories
11513 @subsection Agent Categories
11515 One of the main reasons to integrate the news transport layer into the
11516 newsreader is to allow greater control over what articles to download.
11517 There's not much point in downloading huge amounts of articles, just to
11518 find out that you're not interested in reading any of them. It's better
11519 to be somewhat more conservative in choosing what to download, and then
11520 mark the articles for downloading manually if it should turn out that
11521 you're interested in the articles anyway.
11523 The main way to control what is to be downloaded is to create a
11524 @dfn{category} and then assign some (or all) groups to this category.
11525 Gnus has its own buffer for creating and managing categories.
11528 * Category Syntax:: What a category looks like.
11529 * The Category Buffer:: A buffer for maintaining categories.
11530 * Category Variables:: Customize'r'Us.
11534 @node Category Syntax
11535 @subsubsection Category Syntax
11537 A category consists of two things.
11541 A predicate which (generally) gives a rough outline of which articles
11542 are eligible for downloading; and
11545 a score rule which (generally) gives you a finer granularity when
11546 deciding what articles to download. (Note that this @dfn{download
11547 score} is wholly unrelated to normal scores.)
11550 A predicate consists of predicates with logical operators sprinkled in
11553 Perhaps some examples are in order.
11555 Here's a simple predicate. (It's the default predicate, in fact, used
11556 for all groups that don't belong to any other category.)
11562 Quite simple, eh? This predicate is true if and only if the article is
11563 short (for some value of ``short'').
11565 Here's a more complex predicate:
11574 This means that an article should be downloaded if it has a high score,
11575 or if the score is not low and the article is not long. You get the
11578 The available logical operators are @code{or}, @code{and} and
11579 @code{not}. (If you prefer, you can use the more ``C''-ish operators
11580 @samp{|}, @code{&} and @code{!} instead.)
11582 The following predicates are pre-defined, but if none of these fit what
11583 you want to do, you can write your own.
11587 True iff the article is shorter than @code{gnus-agent-short-article}
11588 lines; default 100.
11591 True iff the article is longer than @code{gnus-agent-long-article}
11592 lines; default 200.
11595 True iff the article has a download score less than
11596 @code{gnus-agent-low-score}; default 0.
11599 True iff the article has a download score greater than
11600 @code{gnus-agent-high-score}; default 0.
11603 True iff the Gnus Agent guesses that the article is spam. The
11604 heuristics may change over time, but at present it just computes a
11605 checksum and sees whether articles match.
11614 If you want to create your own predicate function, here's what you have
11615 to know: The functions are called with no parameters, but the
11616 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
11619 Now, the syntax of the download score is the same as the syntax of
11620 normal score files, except that all elements that require actually
11621 seeing the article itself are verboten. This means that only the
11622 following headers can be scored on: @code{From}, @code{Subject},
11623 @code{Date}, @code{Xref}, @code{Lines}, @code{Chars}, @code{Message-ID},
11624 and @code{References}.
11627 @node The Category Buffer
11628 @subsubsection The Category Buffer
11630 You'd normally do all category maintenance from the category buffer.
11631 When you enter it for the first time (with the @kbd{J c} command from
11632 the group buffer), you'll only see the @code{default} category.
11634 The following commands are available in this buffer:
11638 @kindex q (Category)
11639 @findex gnus-category-exit
11640 Return to the group buffer (@code{gnus-category-exit}).
11643 @kindex k (Category)
11644 @findex gnus-category-kill
11645 Kill the current category (@code{gnus-category-kill}).
11648 @kindex c (Category)
11649 @findex gnus-category-copy
11650 Copy the current category (@code{gnus-category-copy}).
11653 @kindex a (Category)
11654 @findex gnus-category-add
11655 Add a new category (@code{gnus-category-add}).
11658 @kindex p (Category)
11659 @findex gnus-category-edit-predicate
11660 Edit the predicate of the current category
11661 (@code{gnus-category-edit-predicate}).
11664 @kindex g (Category)
11665 @findex gnus-category-edit-groups
11666 Edit the list of groups belonging to the current category
11667 (@code{gnus-category-edit-groups}).
11670 @kindex s (Category)
11671 @findex gnus-category-edit-score
11672 Edit the download score rule of the current category
11673 (@code{gnus-category-edit-score}).
11676 @kindex l (Category)
11677 @findex gnus-category-list
11678 List all the categories (@code{gnus-category-list}).
11682 @node Category Variables
11683 @subsubsection Category Variables
11686 @item gnus-category-mode-hook
11687 @vindex gnus-category-mode-hook
11688 Hook run in category buffers.
11690 @item gnus-category-line-format
11691 @vindex gnus-category-line-format
11692 Format of the lines in the category buffer (@pxref{Formatting
11693 Variables}). Valid elements are:
11697 The name of the category.
11700 The number of groups in the category.
11703 @item gnus-category-mode-line-format
11704 @vindex gnus-category-mode-line-format
11705 Format of the category mode line (@pxref{Mode Line Formatting}).
11707 @item gnus-agent-short-article
11708 @vindex gnus-agent-short-article
11709 Articles that have fewer lines than this are short. Default 100.
11711 @item gnus-agent-long-article
11712 @vindex gnus-agent-long-article
11713 Articles that have more lines than this are long. Default 200.
11715 @item gnus-agent-low-score
11716 @vindex gnus-agent-low-score
11717 Articles that have a score lower than this have a low score. Default
11720 @item gnus-agent-high-score
11721 @vindex gnus-agent-high-score
11722 Articles that have a score higher than this have a high score. Default
11728 @node Agent Commands
11729 @subsection Agent Commands
11731 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
11732 (@code{gnus-agent-toggle-plugged} command works in all modes, and
11733 toggles the plugged/unplugged state of the Gnus Agent.
11737 * Group Agent Commands::
11738 * Summary Agent Commands::
11739 * Server Agent Commands::
11742 You can run a complete batch fetch from the command line with the
11743 following incantation:
11745 @cindex gnus-agent-batch-fetch
11747 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
11752 @node Group Agent Commands
11753 @subsubsection Group Agent Commands
11757 @kindex J u (Agent Group)
11758 @findex gnus-agent-fetch-groups
11759 Fetch all eligible articles in the current group
11760 (@code{gnus-agent-fetch-groups}).
11763 @kindex J c (Agent Group)
11764 @findex gnus-enter-category-buffer
11765 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
11768 @kindex J s (Agent Group)
11769 @findex gnus-agent-fetch-session
11770 Fetch all eligible articles in all groups
11771 (@code{gnus-agent-fetch-session}).
11774 @kindex J S (Agent Group)
11775 @findex gnus-group-send-drafts
11776 Send all sendable messages in the draft group
11777 (@code{gnus-agent-fetch-session}). @xref{Drafts}
11780 @kindex J a (Agent Group)
11781 @findex gnus-agent-add-group
11782 Add the current group to an Agent category
11783 (@code{gnus-agent-add-group}).
11788 @node Summary Agent Commands
11789 @subsubsection Summary Agent Commands
11793 @kindex J # (Agent Summary)
11794 @findex gnus-agent-mark-article
11795 Mark the article for downloading (@code{gnus-agent-mark-article}).
11798 @kindex J M-# (Agent Summary)
11799 @findex gnus-agent-unmark-article
11800 Remove the downloading mark from the article
11801 (@code{gnus-agent-unmark-article}).
11804 @kindex @@ (Agent Summary)
11805 @findex gnus-agent-toggle-mark
11806 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
11809 @kindex J c (Agent Summary)
11810 @findex gnus-agent-catchup
11811 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
11816 @node Server Agent Commands
11817 @subsubsection Server Agent Commands
11821 @kindex J a (Agent Server)
11822 @findex gnus-agent-add-server
11823 Add the current server to the list of servers covered by the Gnus Agent
11824 (@code{gnus-agent-add-server}).
11827 @kindex J r (Agent Server)
11828 @findex gnus-agent-remove-server
11829 Remove the current server from the list of servers covered by the Gnus
11830 Agent (@code{gnus-agent-remove-server}).
11836 @subsection Agent Expiry
11838 @vindex gnus-agent-expiry-days
11839 @findex gnus-agent-expiry
11840 @kindex M-x gnus-agent-expiry
11841 @cindex Agent expiry
11842 @cindex Gnus Agent expiry
11845 @code{nnagent} doesn't handle expiry. Instead, there's a special
11846 @code{gnus-agent-expiry} command that will expire all read articles that
11847 are older than @code{gnus-agent-expiry-days} days. It can be run
11848 whenever you feel that you're running out of space. It's not
11849 particularly fast or efficient, and it's not a particularly good idea to
11850 interrupt it (with @kbd{C-g} or anything else) once you've started it.
11852 @vindex gnus-agent-expire-all
11853 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
11854 expire all articles---unread, read, ticked and dormant. If @code{nil}
11855 (which is the default), only read articles are eligible for expiry, and
11856 unread, ticked and dormant articles will be kept indefinitely.
11859 @node Outgoing Messages
11860 @subsection Outgoing Messages
11862 When Gnus is unplugged, all outgoing messages (both mail and news) are
11863 stored in the draft groups (@pxref{Drafts}). You can view them there
11864 after posting, and edit them at will.
11866 When Gnus is plugged again, you can send the messages either from the
11867 draft group with the special commands available there, or you can use
11868 the @kbd{J S} command in the group buffer to send all the sendable
11869 messages in the draft group.
11873 @node Agent Variables
11874 @subsection Agent Variables
11877 @item gnus-agent-directory
11878 @vindex gnus-agent-directory
11879 Where the Gnus Agent will store its files. The default is
11880 @file{~/News/agent/}.
11882 @item gnus-agent-handle-level
11883 @vindex gnus-agent-handle-level
11884 Groups on levels (@pxref{Group Levels}) higher than this variable will
11885 be ignored by the Agent. The default is @code{gnus-level-subscribed},
11886 which means that only subscribed group will be considered by the Agent
11889 @item gnus-agent-plugged-hook
11890 @vindex gnus-agent-plugged-hook
11891 Hook run when connecting to the network.
11893 @item gnus-agent-unplugged-hook
11894 @vindex gnus-agent-unplugged-hook
11895 Hook run when disconnecting from the network.
11900 @node Example Setup
11901 @subsection Example Setup
11903 If you don't want to read this manual, and you have a fairly standard
11904 setup, you may be able to use something like the following as your
11905 @file{.gnus.el} file to get started.
11908 ;;; Define how Gnus is to fetch news. We do this over NNTP
11909 ;;; from your ISP's server.
11910 (setq gnus-select-method '(nntp "nntp.your-isp.com"))
11912 ;;; Define how Gnus is to read your mail. We read mail from
11913 ;;; your ISP's POP server.
11914 (setenv "MAILHOST" "pop.your-isp.com")
11915 (setq nnmail-spool-file "po:username")
11917 ;;; Say how Gnus is to store the mail. We use nnml groups.
11918 (setq gnus-secondary-select-methods '((nnml "")))
11920 ;;; Make Gnus into an offline newsreader.
11924 That should be it, basically. Put that in your @file{~/.gnus.el} file,
11925 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
11928 If this is the first time you've run Gnus, you will be subscribed
11929 automatically to a few default newsgroups. You'll probably want to
11930 subscribe to more groups, and to do that, you have to query the
11931 @sc{nntp} server for a complete list of groups with the @kbd{A A}
11932 command. This usually takes quite a while, but you only have to do it
11935 After reading and parsing a while, you'll be presented with a list of
11936 groups. Subscribe to the ones you want to read with the @kbd{u}
11937 command. @kbd{l} to make all the killed groups disappear after you've
11938 subscribe to all the groups you want to read. (@kbd{A k} will bring
11939 back all the killed groups.)
11941 You can now read the groups at once, or you can download the articles
11942 with the @kbd{J s} command. And then read the rest of this manual to
11943 find out which of the other gazillion things you want to customize.
11946 @node Batching Agents
11947 @subsection Batching Agents
11949 Having the Gnus Agent fetch articles (and post whatever messages you've
11950 written) is quite easy once you've gotten things set up properly. The
11951 following shell script will do everything that is necessary:
11955 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
11964 Other people use @dfn{kill files}, but we here at Gnus Towers like
11965 scoring better than killing, so we'd rather switch than fight. They do
11966 something completely different as well, so sit up straight and pay
11969 @vindex gnus-summary-mark-below
11970 All articles have a default score (@code{gnus-summary-default-score}),
11971 which is 0 by default. This score may be raised or lowered either
11972 interactively or by score files. Articles that have a score lower than
11973 @code{gnus-summary-mark-below} are marked as read.
11975 Gnus will read any @dfn{score files} that apply to the current group
11976 before generating the summary buffer.
11978 There are several commands in the summary buffer that insert score
11979 entries based on the current article. You can, for instance, ask Gnus to
11980 lower or increase the score of all articles with a certain subject.
11982 There are two sorts of scoring entries: Permanent and temporary.
11983 Temporary score entries are self-expiring entries. Any entries that are
11984 temporary and have not been used for, say, a week, will be removed
11985 silently to help keep the sizes of the score files down.
11988 * Summary Score Commands:: Adding score entries for the current group.
11989 * Group Score Commands:: General score commands.
11990 * Score Variables:: Customize your scoring. (My, what terminology).
11991 * Score File Format:: What a score file may contain.
11992 * Score File Editing:: You can edit score files by hand as well.
11993 * Adaptive Scoring:: Big Sister Gnus knows what you read.
11994 * Home Score File:: How to say where new score entries are to go.
11995 * Followups To Yourself:: Having Gnus notice when people answer you.
11996 * Scoring Tips:: How to score effectively.
11997 * Reverse Scoring:: That problem child of old is not problem.
11998 * Global Score Files:: Earth-spanning, ear-splitting score files.
11999 * Kill Files:: They are still here, but they can be ignored.
12000 * Converting Kill Files:: Translating kill files to score files.
12001 * GroupLens:: Getting predictions on what you like to read.
12002 * Advanced Scoring:: Using logical expressions to build score rules.
12003 * Score Decays:: It can be useful to let scores wither away.
12007 @node Summary Score Commands
12008 @section Summary Score Commands
12009 @cindex score commands
12011 The score commands that alter score entries do not actually modify real
12012 score files. That would be too inefficient. Gnus maintains a cache of
12013 previously loaded score files, one of which is considered the
12014 @dfn{current score file alist}. The score commands simply insert
12015 entries into this list, and upon group exit, this list is saved.
12017 The current score file is by default the group's local score file, even
12018 if no such score file actually exists. To insert score commands into
12019 some other score file (e.g. @file{all.SCORE}), you must first make this
12020 score file the current one.
12022 General score commands that don't actually change the score file:
12027 @kindex V s (Summary)
12028 @findex gnus-summary-set-score
12029 Set the score of the current article (@code{gnus-summary-set-score}).
12032 @kindex V S (Summary)
12033 @findex gnus-summary-current-score
12034 Display the score of the current article
12035 (@code{gnus-summary-current-score}).
12038 @kindex V t (Summary)
12039 @findex gnus-score-find-trace
12040 Display all score rules that have been used on the current article
12041 (@code{gnus-score-find-trace}).
12044 @kindex V R (Summary)
12045 @findex gnus-summary-rescore
12046 Run the current summary through the scoring process
12047 (@code{gnus-summary-rescore}). This might be useful if you're playing
12048 around with your score files behind Gnus' back and want to see the
12049 effect you're having.
12052 @kindex V c (Summary)
12053 @findex gnus-score-change-score-file
12054 Make a different score file the current
12055 (@code{gnus-score-change-score-file}).
12058 @kindex V e (Summary)
12059 @findex gnus-score-edit-current-scores
12060 Edit the current score file (@code{gnus-score-edit-current-scores}).
12061 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
12065 @kindex V f (Summary)
12066 @findex gnus-score-edit-file
12067 Edit a score file and make this score file the current one
12068 (@code{gnus-score-edit-file}).
12071 @kindex V F (Summary)
12072 @findex gnus-score-flush-cache
12073 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
12074 after editing score files.
12077 @kindex V C (Summary)
12078 @findex gnus-score-customize
12079 Customize a score file in a visually pleasing manner
12080 (@code{gnus-score-customize}).
12084 The rest of these commands modify the local score file.
12089 @kindex V m (Summary)
12090 @findex gnus-score-set-mark-below
12091 Prompt for a score, and mark all articles with a score below this as
12092 read (@code{gnus-score-set-mark-below}).
12095 @kindex V x (Summary)
12096 @findex gnus-score-set-expunge-below
12097 Prompt for a score, and add a score rule to the current score file to
12098 expunge all articles below this score
12099 (@code{gnus-score-set-expunge-below}).
12102 The keystrokes for actually making score entries follow a very regular
12103 pattern, so there's no need to list all the commands. (Hundreds of
12106 @findex gnus-summary-increase-score
12107 @findex gnus-summary-lower-score
12111 The first key is either @kbd{I} (upper case i) for increasing the score
12112 or @kbd{L} for lowering the score.
12114 The second key says what header you want to score on. The following
12115 keys are available:
12119 Score on the author name.
12122 Score on the subject line.
12125 Score on the Xref line---i.e., the cross-posting line.
12128 Score on the References line.
12134 Score on the number of lines.
12137 Score on the Message-ID.
12140 Score on followups.
12154 The third key is the match type. Which match types are valid depends on
12155 what headers you are scoring on.
12167 Substring matching.
12170 Fuzzy matching (@pxref{Fuzzy Matching}).
12199 Greater than number.
12204 The fourth and final key says whether this is a temporary (i.e., expiring)
12205 score entry, or a permanent (i.e., non-expiring) score entry, or whether
12206 it is to be done immediately, without adding to the score file.
12210 Temporary score entry.
12213 Permanent score entry.
12216 Immediately scoring.
12221 So, let's say you want to increase the score on the current author with
12222 exact matching permanently: @kbd{I a e p}. If you want to lower the
12223 score based on the subject line, using substring matching, and make a
12224 temporary score entry: @kbd{L s s t}. Pretty easy.
12226 To make things a bit more complicated, there are shortcuts. If you use
12227 a capital letter on either the second or third keys, Gnus will use
12228 defaults for the remaining one or two keystrokes. The defaults are
12229 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
12230 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
12232 These functions take both the numerical prefix and the symbolic prefix
12233 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
12234 (or increase) the score of the article. A symbolic prefix of @code{a}
12235 says to use the @file{all.SCORE} file for the command instead of the
12236 current score file.
12238 @vindex gnus-score-mimic-keymap
12239 The @code{gnus-score-mimic-keymap} says whether these commands will
12240 pretend they are keymaps or not.
12243 @node Group Score Commands
12244 @section Group Score Commands
12245 @cindex group score commands
12247 There aren't many of these as yet, I'm afraid.
12252 @kindex W f (Group)
12253 @findex gnus-score-flush-cache
12254 Gnus maintains a cache of score alists to avoid having to reload them
12255 all the time. This command will flush the cache
12256 (@code{gnus-score-flush-cache}).
12260 You can do scoring from the command line by saying something like:
12262 @findex gnus-batch-score
12263 @cindex batch scoring
12265 $ emacs -batch -l ~/.emacs -l gnus -f gnus-batch-score
12269 @node Score Variables
12270 @section Score Variables
12271 @cindex score variables
12275 @item gnus-use-scoring
12276 @vindex gnus-use-scoring
12277 If @code{nil}, Gnus will not check for score files, and will not, in
12278 general, do any score-related work. This is @code{t} by default.
12280 @item gnus-kill-killed
12281 @vindex gnus-kill-killed
12282 If this variable is @code{nil}, Gnus will never apply score files to
12283 articles that have already been through the kill process. While this
12284 may save you lots of time, it also means that if you apply a kill file
12285 to a group, and then change the kill file and want to run it over you
12286 group again to kill more articles, it won't work. You have to set this
12287 variable to @code{t} to do that. (It is @code{t} by default.)
12289 @item gnus-kill-files-directory
12290 @vindex gnus-kill-files-directory
12291 All kill and score files will be stored in this directory, which is
12292 initialized from the @code{SAVEDIR} environment variable by default.
12293 This is @file{~/News/} by default.
12295 @item gnus-score-file-suffix
12296 @vindex gnus-score-file-suffix
12297 Suffix to add to the group name to arrive at the score file name
12298 (@samp{SCORE} by default.)
12300 @item gnus-score-uncacheable-files
12301 @vindex gnus-score-uncacheable-files
12302 @cindex score cache
12303 All score files are normally cached to avoid excessive re-loading of
12304 score files. However, if this might make you Emacs grow big and
12305 bloated, so this regexp can be used to weed out score files unlikely to be needed again. It would be a bad idea to deny caching of
12306 @file{all.SCORE}, while it might be a good idea to not cache
12307 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
12308 variable is @samp{ADAPT$} by default, so no adaptive score files will
12311 @item gnus-save-score
12312 @vindex gnus-save-score
12313 If you have really complicated score files, and do lots of batch
12314 scoring, then you might set this variable to @code{t}. This will make
12315 Gnus save the scores into the @file{.newsrc.eld} file.
12317 @item gnus-score-interactive-default-score
12318 @vindex gnus-score-interactive-default-score
12319 Score used by all the interactive raise/lower commands to raise/lower
12320 score with. Default is 1000, which may seem excessive, but this is to
12321 ensure that the adaptive scoring scheme gets enough room to play with.
12322 We don't want the small changes from the adaptive scoring to overwrite
12323 manually entered data.
12325 @item gnus-summary-default-score
12326 @vindex gnus-summary-default-score
12327 Default score of an article, which is 0 by default.
12329 @item gnus-summary-expunge-below
12330 @vindex gnus-summary-expunge-below
12331 Don't display the summary lines of articles that have scores lower than
12332 this variable. This is @code{nil} by default, which means that no
12333 articles will be hidden. This variable is local to the summary buffers,
12334 and has to be set from @code{gnus-summary-mode-hook}.
12336 @item gnus-score-over-mark
12337 @vindex gnus-score-over-mark
12338 Mark (in the third column) used for articles with a score over the
12339 default. Default is @samp{+}.
12341 @item gnus-score-below-mark
12342 @vindex gnus-score-below-mark
12343 Mark (in the third column) used for articles with a score below the
12344 default. Default is @samp{-}.
12346 @item gnus-score-find-score-files-function
12347 @vindex gnus-score-find-score-files-function
12348 Function used to find score files for the current group. This function
12349 is called with the name of the group as the argument.
12351 Predefined functions available are:
12354 @item gnus-score-find-single
12355 @findex gnus-score-find-single
12356 Only apply the group's own score file.
12358 @item gnus-score-find-bnews
12359 @findex gnus-score-find-bnews
12360 Apply all score files that match, using bnews syntax. This is the
12361 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
12362 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
12363 @file{gnu.all.SCORE} would all apply. In short, the instances of
12364 @samp{all} in the score file names are translated into @samp{.*}, and
12365 then a regexp match is done.
12367 This means that if you have some score entries that you want to apply to
12368 all groups, then you put those entries in the @file{all.SCORE} file.
12370 The score files are applied in a semi-random order, although Gnus will
12371 try to apply the more general score files before the more specific score
12372 files. It does this by looking at the number of elements in the score
12373 file names---discarding the @samp{all} elements.
12375 @item gnus-score-find-hierarchical
12376 @findex gnus-score-find-hierarchical
12377 Apply all score files from all the parent groups. This means that you
12378 can't have score files like @file{all.SCORE}, but you can have
12379 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
12382 This variable can also be a list of functions. In that case, all these
12383 functions will be called, and all the returned lists of score files will
12384 be applied. These functions can also return lists of score alists
12385 directly. In that case, the functions that return these non-file score
12386 alists should probably be placed before the ``real'' score file
12387 functions, to ensure that the last score file returned is the local
12390 @item gnus-score-expiry-days
12391 @vindex gnus-score-expiry-days
12392 This variable says how many days should pass before an unused score file
12393 entry is expired. If this variable is @code{nil}, no score file entries
12394 are expired. It's 7 by default.
12396 @item gnus-update-score-entry-dates
12397 @vindex gnus-update-score-entry-dates
12398 If this variable is non-@code{nil}, matching score entries will have
12399 their dates updated. (This is how Gnus controls expiry---all
12400 non-matching entries will become too old while matching entries will
12401 stay fresh and young.) However, if you set this variable to @code{nil},
12402 even matching entries will grow old and will have to face that oh-so
12405 @item gnus-score-after-write-file-function
12406 @vindex gnus-score-after-write-file-function
12407 Function called with the name of the score file just written.
12409 @item gnus-score-thread-simplify
12410 @vindex gnus-score-thread-simplify
12411 If this variable is non-@code{nil}, article subjects will be simplified
12412 for subject scoring purposes in the same manner as with
12413 threading---according to the current value of
12414 gnus-simplify-subject-functions. If the scoring entry uses
12415 @code{substring} or @code{exact} matching, the match will also be
12416 simplified in this manner.
12421 @node Score File Format
12422 @section Score File Format
12423 @cindex score file format
12425 A score file is an @code{emacs-lisp} file that normally contains just a
12426 single form. Casual users are not expected to edit these files;
12427 everything can be changed from the summary buffer.
12429 Anyway, if you'd like to dig into it yourself, here's an example:
12433 ("Lars Ingebrigtsen" -10000)
12435 ("larsi\\|lmi" -50000 nil R))
12437 ("Ding is Badd" nil 728373))
12439 ("alt.politics" -1000 728372 s))
12444 (mark-and-expunge -10)
12448 (files "/hom/larsi/News/gnu.SCORE")
12449 (exclude-files "all.SCORE")
12450 (local (gnus-newsgroup-auto-expire t)
12451 (gnus-summary-make-false-root empty))
12455 This example demonstrates most score file elements. For a different
12456 approach, see @pxref{Advanced Scoring}.
12458 Even though this looks much like lisp code, nothing here is actually
12459 @code{eval}ed. The lisp reader is used to read this form, though, so it
12460 has to be valid syntactically, if not semantically.
12462 Six keys are supported by this alist:
12467 If the key is a string, it is the name of the header to perform the
12468 match on. Scoring can only be performed on these eight headers:
12469 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
12470 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
12471 these headers, there are three strings to tell Gnus to fetch the entire
12472 article and do the match on larger parts of the article: @code{Body}
12473 will perform the match on the body of the article, @code{Head} will
12474 perform the match on the head of the article, and @code{All} will
12475 perform the match on the entire article. Note that using any of these
12476 last three keys will slow down group entry @emph{considerably}. The
12477 final ``header'' you can score on is @code{Followup}. These score
12478 entries will result in new score entries being added for all follow-ups
12479 to articles that matches these score entries.
12481 Following this key is a arbitrary number of score entries, where each
12482 score entry has one to four elements.
12486 The first element is the @dfn{match element}. On most headers this will
12487 be a string, but on the Lines and Chars headers, this must be an
12491 If the second element is present, it should be a number---the @dfn{score
12492 element}. This number should be an integer in the neginf to posinf
12493 interval. This number is added to the score of the article if the match
12494 is successful. If this element is not present, the
12495 @code{gnus-score-interactive-default-score} number will be used
12496 instead. This is 1000 by default.
12499 If the third element is present, it should be a number---the @dfn{date
12500 element}. This date says when the last time this score entry matched,
12501 which provides a mechanism for expiring the score entries. It this
12502 element is not present, the score entry is permanent. The date is
12503 represented by the number of days since December 31, 1 BCE.
12506 If the fourth element is present, it should be a symbol---the @dfn{type
12507 element}. This element specifies what function should be used to see
12508 whether this score entry matches the article. What match types that can
12509 be used depends on what header you wish to perform the match on.
12512 @item From, Subject, References, Xref, Message-ID
12513 For most header types, there are the @code{r} and @code{R} (regexp), as
12514 well as @code{s} and @code{S} (substring) types, and @code{e} and
12515 @code{E} (exact match), and @code{w} (word match) types. If this
12516 element is not present, Gnus will assume that substring matching should
12517 be used. @code{R}, @code{S}, and @code{E} differ from the others in
12518 that the matches will be done in a case-sensitive manner. All these
12519 one-letter types are really just abbreviations for the @code{regexp},
12520 @code{string}, @code{exact}, and @code{word} types, which you can use
12521 instead, if you feel like.
12524 These two headers use different match types: @code{<}, @code{>},
12525 @code{=}, @code{>=} and @code{<=}.
12527 These predicates are true if
12530 (PREDICATE HEADER MATCH)
12533 evaluates to non-@code{nil}. For instance, the advanced match
12534 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
12541 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
12542 the match, we get the score added if the article has less than 4 lines.
12543 (It's easy to get confused and think it's the other way around. But
12544 it's not. I think.)
12546 When matching on @code{Lines}, be careful because some backends (like
12547 @code{nndir}) do not generate @code{Lines} header, so every article ends
12548 up being marked as having 0 lines. This can lead to strange results if
12549 you happen to lower score of the articles with few lines.
12552 For the Date header we have three kinda silly match types:
12553 @code{before}, @code{at} and @code{after}. I can't really imagine this
12554 ever being useful, but, like, it would feel kinda silly not to provide
12555 this function. Just in case. You never know. Better safe than sorry.
12556 Once burnt, twice shy. Don't judge a book by its cover. Never not have
12557 sex on a first date. (I have been told that at least one person, and I
12558 quote, ``found this function indispensable'', however.)
12562 A more useful match type is @code{regexp}. With it, you can match the
12563 date string using a regular expression. The date is normalized to
12564 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
12565 you want to match all articles that have been posted on April 1st in
12566 every year, you could use @samp{....0401.........} as a match string,
12567 for instance. (Note that the date is kept in its original time zone, so
12568 this will match articles that were posted when it was April 1st where
12569 the article was posted from. Time zones are such wholesome fun for the
12572 @item Head, Body, All
12573 These three match keys use the same match types as the @code{From} (etc)
12577 This match key is somewhat special, in that it will match the
12578 @code{From} header, and affect the score of not only the matching
12579 articles, but also all followups to the matching articles. This allows
12580 you e.g. increase the score of followups to your own articles, or
12581 decrease the score of followups to the articles of some known
12582 trouble-maker. Uses the same match types as the @code{From} header
12583 uses. (Using this match key will lead to creation of @file{ADAPT}
12587 This match key works along the same lines as the @code{Followup} match
12588 key. If you say that you want to score on a (sub-)thread started by an article with a @code{Message-ID} @var{X}, then you add a
12589 @samp{thread} match. This will add a new @samp{thread} match for each
12590 article that has @var{X} in its @code{References} header. (These new
12591 @samp{thread} matches will use the @code{Message-ID}s of these matching
12592 articles.) This will ensure that you can raise/lower the score of an
12593 entire thread, even though some articles in the thread may not have
12594 complete @code{References} headers. Note that using this may lead to
12595 undeterministic scores of the articles in the thread. (Using this match
12596 key will lead to creation of @file{ADAPT} files.)
12600 @cindex Score File Atoms
12602 The value of this entry should be a number. Any articles with a score
12603 lower than this number will be marked as read.
12606 The value of this entry should be a number. Any articles with a score
12607 lower than this number will be removed from the summary buffer.
12609 @item mark-and-expunge
12610 The value of this entry should be a number. Any articles with a score
12611 lower than this number will be marked as read and removed from the
12614 @item thread-mark-and-expunge
12615 The value of this entry should be a number. All articles that belong to
12616 a thread that has a total score below this number will be marked as read
12617 and removed from the summary buffer. @code{gnus-thread-score-function}
12618 says how to compute the total score for a thread.
12621 The value of this entry should be any number of file names. These files
12622 are assumed to be score files as well, and will be loaded the same way
12625 @item exclude-files
12626 The clue of this entry should be any number of files. These files will
12627 not be loaded, even though they would normally be so, for some reason or
12631 The value of this entry will be @code{eval}el. This element will be
12632 ignored when handling global score files.
12635 Read-only score files will not be updated or saved. Global score files
12636 should feature this atom (@pxref{Global Score Files}). (Note:
12637 @dfn{Global} here really means @dfn{global}; not your personal
12638 apply-to-all-groups score files.)
12641 The value of this entry should be a number. Articles that do not have
12642 parents will get this number added to their scores. Imagine you follow
12643 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
12644 will only follow a few of the threads, also want to see any new threads.
12646 You can do this with the following two score file entries:
12650 (mark-and-expunge -100)
12653 When you enter the group the first time, you will only see the new
12654 threads. You then raise the score of the threads that you find
12655 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
12656 rest. Next time you enter the group, you will see new articles in the
12657 interesting threads, plus any new threads.
12659 I.e.---the orphan score atom is for high-volume groups where there
12660 exist a few interesting threads which can't be found automatically by
12661 ordinary scoring rules.
12664 This entry controls the adaptive scoring. If it is @code{t}, the
12665 default adaptive scoring rules will be used. If it is @code{ignore}, no
12666 adaptive scoring will be performed on this group. If it is a list, this
12667 list will be used as the adaptive scoring rules. If it isn't present,
12668 or is something other than @code{t} or @code{ignore}, the default
12669 adaptive scoring rules will be used. If you want to use adaptive
12670 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
12671 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
12672 not want adaptive scoring. If you only want adaptive scoring in a few
12673 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
12674 insert @code{(adapt t)} in the score files of the groups where you want
12678 All adaptive score entries will go to the file named by this entry. It
12679 will also be applied when entering the group. This atom might be handy
12680 if you want to adapt on several groups at once, using the same adaptive
12681 file for a number of groups.
12684 @cindex local variables
12685 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
12686 Each @var{var} will be made buffer-local to the current summary buffer,
12687 and set to the value specified. This is a convenient, if somewhat
12688 strange, way of setting variables in some groups if you don't like hooks
12689 much. Note that the @var{value} won't be evaluated.
12693 @node Score File Editing
12694 @section Score File Editing
12696 You normally enter all scoring commands from the summary buffer, but you
12697 might feel the urge to edit them by hand as well, so we've supplied you
12698 with a mode for that.
12700 It's simply a slightly customized @code{emacs-lisp} mode, with these
12701 additional commands:
12706 @kindex C-c C-c (Score)
12707 @findex gnus-score-edit-done
12708 Save the changes you have made and return to the summary buffer
12709 (@code{gnus-score-edit-done}).
12712 @kindex C-c C-d (Score)
12713 @findex gnus-score-edit-insert-date
12714 Insert the current date in numerical format
12715 (@code{gnus-score-edit-insert-date}). This is really the day number, if
12716 you were wondering.
12719 @kindex C-c C-p (Score)
12720 @findex gnus-score-pretty-print
12721 The adaptive score files are saved in an unformatted fashion. If you
12722 intend to read one of these files, you want to @dfn{pretty print} it
12723 first. This command (@code{gnus-score-pretty-print}) does that for
12728 Type @kbd{M-x gnus-score-mode} to use this mode.
12730 @vindex gnus-score-mode-hook
12731 @code{gnus-score-menu-hook} is run in score mode buffers.
12733 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
12734 e} to begin editing score files.
12737 @node Adaptive Scoring
12738 @section Adaptive Scoring
12739 @cindex adaptive scoring
12741 If all this scoring is getting you down, Gnus has a way of making it all
12742 happen automatically---as if by magic. Or rather, as if by artificial
12743 stupidity, to be precise.
12745 @vindex gnus-use-adaptive-scoring
12746 When you read an article, or mark an article as read, or kill an
12747 article, you leave marks behind. On exit from the group, Gnus can sniff
12748 these marks and add score elements depending on what marks it finds.
12749 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
12750 @code{t} or @code{(line)}. If you want score adaptively on separate
12751 words appearing in the subjects, you should set this variable to
12752 @code{(word)}. If you want to use both adaptive methods, set this
12753 variable to @code{(word line)}.
12755 @vindex gnus-default-adaptive-score-alist
12756 To give you complete control over the scoring process, you can customize
12757 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
12758 might look something like this:
12761 (defvar gnus-default-adaptive-score-alist
12762 '((gnus-unread-mark)
12763 (gnus-ticked-mark (from 4))
12764 (gnus-dormant-mark (from 5))
12765 (gnus-del-mark (from -4) (subject -1))
12766 (gnus-read-mark (from 4) (subject 2))
12767 (gnus-expirable-mark (from -1) (subject -1))
12768 (gnus-killed-mark (from -1) (subject -3))
12769 (gnus-kill-file-mark)
12770 (gnus-ancient-mark)
12771 (gnus-low-score-mark)
12772 (gnus-catchup-mark (from -1) (subject -1))))
12775 As you see, each element in this alist has a mark as a key (either a
12776 variable name or a ``real'' mark---a character). Following this key is
12777 a arbitrary number of header/score pairs. If there are no header/score
12778 pairs following the key, no adaptive scoring will be done on articles
12779 that have that key as the article mark. For instance, articles with
12780 @code{gnus-unread-mark} in the example above will not get adaptive score
12783 Each article can have only one mark, so just a single of these rules
12784 will be applied to each article.
12786 To take @code{gnus-del-mark} as an example---this alist says that all
12787 articles that have that mark (i.e., are marked with @samp{D}) will have a
12788 score entry added to lower based on the @code{From} header by -4, and
12789 lowered by @code{Subject} by -1. Change this to fit your prejudices.
12791 If you have marked 10 articles with the same subject with
12792 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
12793 That means that that subject will get a score of ten times -1, which
12794 should be, unless I'm much mistaken, -10.
12796 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
12797 the read articles will be marked with the @samp{E} mark. This'll
12798 probably make adaptive scoring slightly impossible, so auto-expiring and
12799 adaptive scoring doesn't really mix very well.
12801 The headers you can score on are @code{from}, @code{subject},
12802 @code{message-id}, @code{references}, @code{xref}, @code{lines},
12803 @code{chars} and @code{date}. In addition, you can score on
12804 @code{followup}, which will create an adaptive score entry that matches
12805 on the @code{References} header using the @code{Message-ID} of the
12806 current article, thereby matching the following thread.
12808 You can also score on @code{thread}, which will try to score all
12809 articles that appear in a thread. @code{thread} matches uses a
12810 @code{Message-ID} to match on the @code{References} header of the
12811 article. If the match is made, the @code{Message-ID} of the article is
12812 added to the @code{thread} rule. (Think about it. I'd recommend two
12813 aspirins afterwards.)
12815 If you use this scheme, you should set the score file atom @code{mark}
12816 to something small---like -300, perhaps, to avoid having small random
12817 changes result in articles getting marked as read.
12819 After using adaptive scoring for a week or so, Gnus should start to
12820 become properly trained and enhance the authors you like best, and kill
12821 the authors you like least, without you having to say so explicitly.
12823 You can control what groups the adaptive scoring is to be performed on
12824 by using the score files (@pxref{Score File Format}). This will also
12825 let you use different rules in different groups.
12827 @vindex gnus-adaptive-file-suffix
12828 The adaptive score entries will be put into a file where the name is the
12829 group name with @code{gnus-adaptive-file-suffix} appended. The default
12832 @vindex gnus-score-exact-adapt-limit
12833 When doing adaptive scoring, substring or fuzzy matching would probably
12834 give you the best results in most cases. However, if the header one
12835 matches is short, the possibility for false positives is great, so if
12836 the length of the match is less than
12837 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
12838 this variable is @code{nil}, exact matching will always be used to avoid
12841 @vindex gnus-default-adaptive-word-score-alist
12842 As mentioned above, you can adapt either on individual words or entire
12843 headers. If you adapt on words, the
12844 @code{gnus-default-adaptive-word-score-alist} variable says what score
12845 each instance of a word should add given a mark.
12848 (setq gnus-default-adaptive-word-score-alist
12849 `((,gnus-read-mark . 30)
12850 (,gnus-catchup-mark . -10)
12851 (,gnus-killed-mark . -20)
12852 (,gnus-del-mark . -15)))
12855 This is the default value. If you have adaption on words enabled, every
12856 word that appears in subjects of articles marked with
12857 @code{gnus-read-mark} will result in a score rule that increase the
12858 score with 30 points.
12860 @vindex gnus-default-ignored-adaptive-words
12861 @vindex gnus-ignored-adaptive-words
12862 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
12863 will be ignored. If you wish to add more words to be ignored, use the
12864 @code{gnus-ignored-adaptive-words} list instead.
12866 @vindex gnus-adaptive-word-syntax-table
12867 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
12868 syntax table in effect. It is similar to the standard syntax table, but
12869 it considers numbers to be non-word-constituent characters.
12871 @vindex gnus-adaptive-word-minimum
12872 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
12873 word scoring process will never bring down the score of an article to
12874 below this number. The default is @code{nil}.
12876 After using this scheme for a while, it might be nice to write a
12877 @code{gnus-psychoanalyze-user} command to go through the rules and see
12878 what words you like and what words you don't like. Or perhaps not.
12880 Note that the adaptive word scoring thing is highly experimental and is
12881 likely to change in the future. Initial impressions seem to indicate
12882 that it's totally useless as it stands. Some more work (involving more
12883 rigorous statistical methods) will have to be done to make this useful.
12886 @node Home Score File
12887 @section Home Score File
12889 The score file where new score file entries will go is called the
12890 @dfn{home score file}. This is normally (and by default) the score file
12891 for the group itself. For instance, the home score file for
12892 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
12894 However, this may not be what you want. It is often convenient to share
12895 a common home score file among many groups---all @samp{emacs} groups
12896 could perhaps use the same home score file.
12898 @vindex gnus-home-score-file
12899 The variable that controls this is @code{gnus-home-score-file}. It can
12904 A string. Then this file will be used as the home score file for all
12908 A function. The result of this function will be used as the home score
12909 file. The function will be called with the name of the group as the
12913 A list. The elements in this list can be:
12917 @var{(regexp file-name)}. If the @var{regexp} matches the group name,
12918 the @var{file-name} will will be used as the home score file.
12921 A function. If the function returns non-nil, the result will be used as
12922 the home score file.
12925 A string. Use the string as the home score file.
12928 The list will be traversed from the beginning towards the end looking
12933 So, if you want to use just a single score file, you could say:
12936 (setq gnus-home-score-file
12937 "my-total-score-file.SCORE")
12940 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
12941 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
12943 @findex gnus-hierarchial-home-score-file
12945 (setq gnus-home-score-file
12946 'gnus-hierarchial-home-score-file)
12949 This is a ready-made function provided for your convenience.
12950 Other functions include
12953 @item gnus-current-home-score-file
12954 @findex gnus-current-home-score-file
12955 Return the ``current'' regular score file. This will make scoring
12956 commands add entry to the ``innermost'' matching score file.
12960 If you want to have one score file for the @samp{emacs} groups and
12961 another for the @samp{comp} groups, while letting all other groups use
12962 their own home score files:
12965 (setq gnus-home-score-file
12966 ;; All groups that match the regexp "\\.emacs"
12967 '(("\\.emacs" "emacs.SCORE")
12968 ;; All the comp groups in one score file
12969 ("^comp" "comp.SCORE")))
12972 @vindex gnus-home-adapt-file
12973 @code{gnus-home-adapt-file} works exactly the same way as
12974 @code{gnus-home-score-file}, but says what the home adaptive score file
12975 is instead. All new adaptive file entries will go into the file
12976 specified by this variable, and the same syntax is allowed.
12978 In addition to using @code{gnus-home-score-file} and
12979 @code{gnus-home-adapt-file}, you can also use group parameters
12980 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
12981 Parameters}) to achieve much the same. Group and topic parameters take
12982 precedence over this variable.
12985 @node Followups To Yourself
12986 @section Followups To Yourself
12988 Gnus offers two commands for picking out the @code{Message-ID} header in
12989 the current buffer. Gnus will then add a score rule that scores using
12990 this @code{Message-ID} on the @code{References} header of other
12991 articles. This will, in effect, increase the score of all articles that
12992 respond to the article in the current buffer. Quite useful if you want
12993 to easily note when people answer what you've said.
12997 @item gnus-score-followup-article
12998 @findex gnus-score-followup-article
12999 This will add a score to articles that directly follow up your own
13002 @item gnus-score-followup-thread
13003 @findex gnus-score-followup-thread
13004 This will add a score to all articles that appear in a thread ``below''
13008 @vindex message-sent-hook
13009 These two functions are both primarily meant to be used in hooks like
13010 @code{message-sent-hook}.
13012 If you look closely at your own @code{Message-ID}, you'll notice that
13013 the first two or three characters are always the same. Here's two of
13017 <x6u3u47icf.fsf@@eyesore.no>
13018 <x6sp9o7ibw.fsf@@eyesore.no>
13021 So ``my'' ident on this machine is @samp{x6}. This can be
13022 exploited---the following rule will raise the score on all followups to
13027 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
13031 Whether it's the first two or first three characters that are ``yours''
13032 is system-dependent.
13036 @section Scoring Tips
13037 @cindex scoring tips
13043 @cindex scoring crossposts
13044 If you want to lower the score of crossposts, the line to match on is
13045 the @code{Xref} header.
13047 ("xref" (" talk.politics.misc:" -1000))
13050 @item Multiple crossposts
13051 If you want to lower the score of articles that have been crossposted to
13052 more than, say, 3 groups:
13054 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
13057 @item Matching on the body
13058 This is generally not a very good idea---it takes a very long time.
13059 Gnus actually has to fetch each individual article from the server. But
13060 you might want to anyway, I guess. Even though there are three match
13061 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
13062 and stick with it in each score file. If you use any two, each article
13063 will be fetched @emph{twice}. If you want to match a bit on the
13064 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
13067 @item Marking as read
13068 You will probably want to mark articles that has a score below a certain
13069 number as read. This is most easily achieved by putting the following
13070 in your @file{all.SCORE} file:
13074 You may also consider doing something similar with @code{expunge}.
13076 @item Negated character classes
13077 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
13078 That will match newlines, which might lead to, well, The Unknown. Say
13079 @code{[^abcd\n]*} instead.
13083 @node Reverse Scoring
13084 @section Reverse Scoring
13085 @cindex reverse scoring
13087 If you want to keep just articles that have @samp{Sex with Emacs} in the
13088 subject header, and expunge all other articles, you could put something
13089 like this in your score file:
13093 ("Sex with Emacs" 2))
13098 So, you raise all articles that match @samp{Sex with Emacs} and mark the
13099 rest as read, and expunge them to boot.
13102 @node Global Score Files
13103 @section Global Score Files
13104 @cindex global score files
13106 Sure, other newsreaders have ``global kill files''. These are usually
13107 nothing more than a single kill file that applies to all groups, stored
13108 in the user's home directory. Bah! Puny, weak newsreaders!
13110 What I'm talking about here are Global Score Files. Score files from
13111 all over the world, from users everywhere, uniting all nations in one
13112 big, happy score file union! Ange-score! New and untested!
13114 @vindex gnus-global-score-files
13115 All you have to do to use other people's score files is to set the
13116 @code{gnus-global-score-files} variable. One entry for each score file,
13117 or each score file directory. Gnus will decide by itself what score
13118 files are applicable to which group.
13120 Say you want to use the score file
13121 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
13122 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
13125 (setq gnus-global-score-files
13126 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
13127 "/ftp@@ftp.some-where:/pub/score/"))
13130 @findex gnus-score-search-global-directories
13131 Simple, eh? Directory names must end with a @samp{/}. These
13132 directories are typically scanned only once during each Gnus session.
13133 If you feel the need to manually re-scan the remote directories, you can
13134 use the @code{gnus-score-search-global-directories} command.
13136 Note that, at present, using this option will slow down group entry
13137 somewhat. (That is---a lot.)
13139 If you want to start maintaining score files for other people to use,
13140 just put your score file up for anonymous ftp and announce it to the
13141 world. Become a retro-moderator! Participate in the retro-moderator
13142 wars sure to ensue, where retro-moderators battle it out for the
13143 sympathy of the people, luring them to use their score files on false
13144 premises! Yay! The net is saved!
13146 Here are some tips for the would-be retro-moderator, off the top of my
13152 Articles heavily crossposted are probably junk.
13154 To lower a single inappropriate article, lower by @code{Message-ID}.
13156 Particularly brilliant authors can be raised on a permanent basis.
13158 Authors that repeatedly post off-charter for the group can safely be
13159 lowered out of existence.
13161 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
13162 articles completely.
13165 Use expiring score entries to keep the size of the file down. You
13166 should probably have a long expiry period, though, as some sites keep
13167 old articles for a long time.
13170 ... I wonder whether other newsreaders will support global score files
13171 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
13172 Wave, xrn and 1stReader are bound to implement scoring. Should we start
13173 holding our breath yet?
13177 @section Kill Files
13180 Gnus still supports those pesky old kill files. In fact, the kill file
13181 entries can now be expiring, which is something I wrote before Daniel
13182 Quinlan thought of doing score files, so I've left the code in there.
13184 In short, kill processing is a lot slower (and I do mean @emph{a lot})
13185 than score processing, so it might be a good idea to rewrite your kill
13186 files into score files.
13188 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
13189 forms into this file, which means that you can use kill files as some
13190 sort of primitive hook function to be run on group entry, even though
13191 that isn't a very good idea.
13193 Normal kill files look like this:
13196 (gnus-kill "From" "Lars Ingebrigtsen")
13197 (gnus-kill "Subject" "ding")
13201 This will mark every article written by me as read, and remove the
13202 marked articles from the summary buffer. Very useful, you'll agree.
13204 Other programs use a totally different kill file syntax. If Gnus
13205 encounters what looks like a @code{rn} kill file, it will take a stab at
13208 Two summary functions for editing a GNUS kill file:
13213 @kindex M-k (Summary)
13214 @findex gnus-summary-edit-local-kill
13215 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
13218 @kindex M-K (Summary)
13219 @findex gnus-summary-edit-global-kill
13220 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
13223 Two group mode functions for editing the kill files:
13228 @kindex M-k (Group)
13229 @findex gnus-group-edit-local-kill
13230 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
13233 @kindex M-K (Group)
13234 @findex gnus-group-edit-global-kill
13235 Edit the general kill file (@code{gnus-group-edit-global-kill}).
13238 Kill file variables:
13241 @item gnus-kill-file-name
13242 @vindex gnus-kill-file-name
13243 A kill file for the group @samp{soc.motss} is normally called
13244 @file{soc.motss.KILL}. The suffix appended to the group name to get
13245 this file name is detailed by the @code{gnus-kill-file-name} variable.
13246 The ``global'' kill file (not in the score file sense of ``global'', of
13247 course) is just called @file{KILL}.
13249 @vindex gnus-kill-save-kill-file
13250 @item gnus-kill-save-kill-file
13251 If this variable is non-@code{nil}, Gnus will save the
13252 kill file after processing, which is necessary if you use expiring
13255 @item gnus-apply-kill-hook
13256 @vindex gnus-apply-kill-hook
13257 @findex gnus-apply-kill-file-unless-scored
13258 @findex gnus-apply-kill-file
13259 A hook called to apply kill files to a group. It is
13260 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
13261 kill file if you have a score file for the same group, you can set this
13262 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
13263 kill files to be processed, you should set this variable to @code{nil}.
13265 @item gnus-kill-file-mode-hook
13266 @vindex gnus-kill-file-mode-hook
13267 A hook called in kill-file mode buffers.
13272 @node Converting Kill Files
13273 @section Converting Kill Files
13275 @cindex converting kill files
13277 If you have loads of old kill files, you may want to convert them into
13278 score files. If they are ``regular'', you can use
13279 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
13282 The kill to score conversion package isn't included in Gnus by default.
13283 You can fetch it from
13284 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
13286 If your old kill files are very complex---if they contain more
13287 non-@code{gnus-kill} forms than not, you'll have to convert them by
13288 hand. Or just let them be as they are. Gnus will still use them as
13296 GroupLens is a collaborative filtering system that helps you work
13297 together with other people to find the quality news articles out of the
13298 huge volume of news articles generated every day.
13300 To accomplish this the GroupLens system combines your opinions about
13301 articles you have already read with the opinions of others who have done
13302 likewise and gives you a personalized prediction for each unread news
13303 article. Think of GroupLens as a matchmaker. GroupLens watches how you
13304 rate articles, and finds other people that rate articles the same way.
13305 Once it has found some people you agree with it tells you, in the form
13306 of a prediction, what they thought of the article. You can use this
13307 prediction to help you decide whether or not you want to read the
13311 * Using GroupLens:: How to make Gnus use GroupLens.
13312 * Rating Articles:: Letting GroupLens know how you rate articles.
13313 * Displaying Predictions:: Displaying predictions given by GroupLens.
13314 * GroupLens Variables:: Customizing GroupLens.
13318 @node Using GroupLens
13319 @subsection Using GroupLens
13321 To use GroupLens you must register a pseudonym with your local Better
13323 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
13324 better bit in town at the moment.
13326 Once you have registered you'll need to set a couple of variables.
13330 @item gnus-use-grouplens
13331 @vindex gnus-use-grouplens
13332 Setting this variable to a non-@code{nil} value will make Gnus hook into
13333 all the relevant GroupLens functions.
13335 @item grouplens-pseudonym
13336 @vindex grouplens-pseudonym
13337 This variable should be set to the pseudonym you got when registering
13338 with the Better Bit Bureau.
13340 @item grouplens-newsgroups
13341 @vindex grouplens-newsgroups
13342 A list of groups that you want to get GroupLens predictions for.
13346 That's the minimum of what you need to get up and running with GroupLens.
13347 Once you've registered, GroupLens will start giving you scores for
13348 articles based on the average of what other people think. But, to get
13349 the real benefit of GroupLens you need to start rating articles
13350 yourself. Then the scores GroupLens gives you will be personalized for
13351 you, based on how the people you usually agree with have already rated.
13354 @node Rating Articles
13355 @subsection Rating Articles
13357 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
13358 Where 1 means something like this article is a waste of bandwidth and 5
13359 means that the article was really good. The basic question to ask
13360 yourself is, "on a scale from 1 to 5 would I like to see more articles
13363 There are four ways to enter a rating for an article in GroupLens.
13368 @kindex r (GroupLens)
13369 @findex bbb-summary-rate-article
13370 This function will prompt you for a rating on a scale of one to five.
13373 @kindex k (GroupLens)
13374 @findex grouplens-score-thread
13375 This function will prompt you for a rating, and rate all the articles in
13376 the thread. This is really useful for some of those long running giant
13377 threads in rec.humor.
13381 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
13382 the score of the article you're reading.
13387 @kindex n (GroupLens)
13388 @findex grouplens-next-unread-article
13389 Rate the article and go to the next unread article.
13392 @kindex , (GroupLens)
13393 @findex grouplens-best-unread-article
13394 Rate the article and go to the next unread article with the highest score.
13398 If you want to give the current article a score of 4 and then go to the
13399 next article, just type @kbd{4 n}.
13402 @node Displaying Predictions
13403 @subsection Displaying Predictions
13405 GroupLens makes a prediction for you about how much you will like a
13406 news article. The predictions from GroupLens are on a scale from 1 to
13407 5, where 1 is the worst and 5 is the best. You can use the predictions
13408 from GroupLens in one of three ways controlled by the variable
13409 @code{gnus-grouplens-override-scoring}.
13411 @vindex gnus-grouplens-override-scoring
13412 There are three ways to display predictions in grouplens. You may
13413 choose to have the GroupLens scores contribute to, or override the
13414 regular gnus scoring mechanism. override is the default; however, some
13415 people prefer to see the Gnus scores plus the grouplens scores. To get
13416 the separate scoring behavior you need to set
13417 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
13418 GroupLens predictions combined with the grouplens scores set it to
13419 @code{'override} and to combine the scores set
13420 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
13421 the combine option you will also want to set the values for
13422 @code{grouplens-prediction-offset} and
13423 @code{grouplens-score-scale-factor}.
13425 @vindex grouplens-prediction-display
13426 In either case, GroupLens gives you a few choices for how you would like
13427 to see your predictions displayed. The display of predictions is
13428 controlled by the @code{grouplens-prediction-display} variable.
13430 The following are valid values for that variable.
13433 @item prediction-spot
13434 The higher the prediction, the further to the right an @samp{*} is
13437 @item confidence-interval
13438 A numeric confidence interval.
13440 @item prediction-bar
13441 The higher the prediction, the longer the bar.
13443 @item confidence-bar
13444 Numerical confidence.
13446 @item confidence-spot
13447 The spot gets bigger with more confidence.
13449 @item prediction-num
13450 Plain-old numeric value.
13452 @item confidence-plus-minus
13453 Prediction +/- confidence.
13458 @node GroupLens Variables
13459 @subsection GroupLens Variables
13463 @item gnus-summary-grouplens-line-format
13464 The summary line format used in GroupLens-enhanced summary buffers. It
13465 accepts the same specs as the normal summary line format (@pxref{Summary
13466 Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
13469 @item grouplens-bbb-host
13470 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
13473 @item grouplens-bbb-port
13474 Port of the host running the bbbd server. The default is 9000.
13476 @item grouplens-score-offset
13477 Offset the prediction by this value. In other words, subtract the
13478 prediction value by this number to arrive at the effective score. The
13481 @item grouplens-score-scale-factor
13482 This variable allows the user to magnify the effect of GroupLens scores.
13483 The scale factor is applied after the offset. The default is 1.
13488 @node Advanced Scoring
13489 @section Advanced Scoring
13491 Scoring on Subjects and From headers is nice enough, but what if you're
13492 really interested in what a person has to say only when she's talking
13493 about a particular subject? Or what if you really don't want to
13494 read what person A has to say when she's following up to person B, but
13495 want to read what she says when she's following up to person C?
13497 By using advanced scoring rules you may create arbitrarily complex
13501 * Advanced Scoring Syntax:: A definition.
13502 * Advanced Scoring Examples:: What they look like.
13503 * Advanced Scoring Tips:: Getting the most out of it.
13507 @node Advanced Scoring Syntax
13508 @subsection Advanced Scoring Syntax
13510 Ordinary scoring rules have a string as the first element in the rule.
13511 Advanced scoring rules have a list as the first element. The second
13512 element is the score to be applied if the first element evaluated to a
13513 non-@code{nil} value.
13515 These lists may consist of three logical operators, one redirection
13516 operator, and various match operators.
13523 This logical operator will evaluate each of its arguments until it finds
13524 one that evaluates to @code{false}, and then it'll stop. If all arguments
13525 evaluate to @code{true} values, then this operator will return
13530 This logical operator will evaluate each of its arguments until it finds
13531 one that evaluates to @code{true}. If no arguments are @code{true},
13532 then this operator will return @code{false}.
13537 This logical operator only takes a single argument. It returns the
13538 logical negation of the value of its argument.
13542 There is an @dfn{indirection operator} that will make its arguments
13543 apply to the ancestors of the current article being scored. For
13544 instance, @code{1-} will make score rules apply to the parent of the
13545 current article. @code{2-} will make score rules apply to the
13546 grandparent of the current article. Alternatively, you can write
13547 @code{^^}, where the number of @code{^}s (carets) says how far back into
13548 the ancestry you want to go.
13550 Finally, we have the match operators. These are the ones that do the
13551 real work. Match operators are header name strings followed by a match
13552 and a match type. A typical match operator looks like @samp{("from"
13553 "Lars Ingebrigtsen" s)}. The header names are the same as when using
13554 simple scoring, and the match types are also the same.
13557 @node Advanced Scoring Examples
13558 @subsection Advanced Scoring Examples
13560 Let's say you want to increase the score of articles written by Lars
13561 when he's talking about Gnus:
13565 ("from" "Lars Ingebrigtsen")
13566 ("subject" "Gnus"))
13572 When he writes long articles, he sometimes has something nice to say:
13576 ("from" "Lars Ingebrigtsen")
13583 However, when he responds to things written by Reig Eigil Logge, you
13584 really don't want to read what he's written:
13588 ("from" "Lars Ingebrigtsen")
13589 (1- ("from" "Reig Eigir Logge")))
13593 Everybody that follows up Redmondo when he writes about disappearing
13594 socks should have their scores raised, but only when they talk about
13595 white socks. However, when Lars talks about socks, it's usually not
13602 ("from" "redmondo@@.*no" r)
13603 ("body" "disappearing.*socks" t)))
13604 (! ("from" "Lars Ingebrigtsen"))
13605 ("body" "white.*socks"))
13609 The possibilities are endless.
13612 @node Advanced Scoring Tips
13613 @subsection Advanced Scoring Tips
13615 The @code{&} and @code{|} logical operators do short-circuit logic.
13616 That is, they stop processing their arguments when it's clear what the
13617 result of the operation will be. For instance, if one of the arguments
13618 of an @code{&} evaluates to @code{false}, there's no point in evaluating
13619 the rest of the arguments. This means that you should put slow matches
13620 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
13621 @samp{subject}) first.
13623 The indirection arguments (@code{1-} and so on) will make their
13624 arguments work on previous generations of the thread. If you say
13635 Then that means "score on the from header of the grandparent of the
13636 current article". An indirection is quite fast, but it's better to say:
13642 ("subject" "Gnus")))
13649 (1- ("from" "Lars"))
13650 (1- ("subject" "Gnus")))
13655 @section Score Decays
13656 @cindex score decays
13659 You may find that your scores have a tendency to grow without
13660 bounds, especially if you're using adaptive scoring. If scores get too
13661 big, they lose all meaning---they simply max out and it's difficult to
13662 use them in any sensible way.
13664 @vindex gnus-decay-scores
13665 @findex gnus-decay-score
13666 @vindex gnus-decay-score-function
13667 Gnus provides a mechanism for decaying scores to help with this problem.
13668 When score files are loaded and @code{gnus-decay-scores} is
13669 non-@code{nil}, Gnus will run the score files through the decaying
13670 mechanism thereby lowering the scores of all non-permanent score rules.
13671 The decay itself if performed by the @code{gnus-decay-score-function}
13672 function, which is @code{gnus-decay-score} by default. Here's the
13673 definition of that function:
13676 (defun gnus-decay-score (score)
13678 This is done according to `gnus-score-decay-constant'
13679 and `gnus-score-decay-scale'."
13682 (* (if (< score 0) 1 -1)
13684 (max gnus-score-decay-constant
13686 gnus-score-decay-scale)))))))
13689 @vindex gnus-score-decay-scale
13690 @vindex gnus-score-decay-constant
13691 @code{gnus-score-decay-constant} is 3 by default and
13692 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
13696 Scores between -3 and 3 will be set to 0 when this function is called.
13699 Scores with magnitudes between 3 and 60 will be shrunk by 3.
13702 Scores with magnitudes greater than 60 will be shrunk by 5% of the
13706 If you don't like this decay function, write your own. It is called
13707 with the score to be decayed as its only parameter, and it should return
13708 the new score, which should be an integer.
13710 Gnus will try to decay scores once a day. If you haven't run Gnus for
13711 four days, Gnus will decay the scores four times, for instance.
13718 * Process/Prefix:: A convention used by many treatment commands.
13719 * Interactive:: Making Gnus ask you many questions.
13720 * Symbolic Prefixes:: How to supply some Gnus functions with options.
13721 * Formatting Variables:: You can specify what buffers should look like.
13722 * Windows Configuration:: Configuring the Gnus buffer windows.
13723 * Faces and Fonts:: How to change how faces look.
13724 * Compilation:: How to speed Gnus up.
13725 * Mode Lines:: Displaying information in the mode lines.
13726 * Highlighting and Menus:: Making buffers look all nice and cozy.
13727 * Buttons:: Get tendonitis in ten easy steps!
13728 * Daemons:: Gnus can do things behind your back.
13729 * NoCeM:: How to avoid spam and other fatty foods.
13730 * Undo:: Some actions can be undone.
13731 * Moderation:: What to do if you're a moderator.
13732 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
13733 * Fuzzy Matching:: What's the big fuzz?
13734 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
13735 * Various Various:: Things that are really various.
13739 @node Process/Prefix
13740 @section Process/Prefix
13741 @cindex process/prefix convention
13743 Many functions, among them functions for moving, decoding and saving
13744 articles, use what is known as the @dfn{Process/Prefix convention}.
13746 This is a method for figuring out what articles the user wants the
13747 command to be performed on.
13751 If the numeric prefix is N, perform the operation on the next N
13752 articles, starting with the current one. If the numeric prefix is
13753 negative, perform the operation on the previous N articles, starting
13754 with the current one.
13756 @vindex transient-mark-mode
13757 If @code{transient-mark-mode} in non-@code{nil} and the region is
13758 active, all articles in the region will be worked upon.
13760 If there is no numeric prefix, but some articles are marked with the
13761 process mark, perform the operation on the articles marked with
13764 If there is neither a numeric prefix nor any articles marked with the
13765 process mark, just perform the operation on the current article.
13767 Quite simple, really, but it needs to be made clear so that surprises
13770 Commands that react to the process mark will push the current list of
13771 process marked articles onto a stack and will then clear all process
13772 marked articles. You can restore the previous configuration with the
13773 @kbd{M P y} command (@pxref{Setting Process Marks}).
13775 @vindex gnus-summary-goto-unread
13776 One thing that seems to shock & horrify lots of people is that, for
13777 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
13778 Since each @kbd{d} (which marks the current article as read) by default
13779 goes to the next unread article after marking, this means that @kbd{3 d}
13780 will mark the next three unread articles as read, no matter what the
13781 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
13782 @code{nil} for a more straightforward action.
13786 @section Interactive
13787 @cindex interaction
13791 @item gnus-novice-user
13792 @vindex gnus-novice-user
13793 If this variable is non-@code{nil}, you are either a newcomer to the
13794 World of Usenet, or you are very cautious, which is a nice thing to be,
13795 really. You will be given questions of the type ``Are you sure you want
13796 to do this?'' before doing anything dangerous. This is @code{t} by
13799 @item gnus-expert-user
13800 @vindex gnus-expert-user
13801 If this variable is non-@code{nil}, you will seldom be asked any
13802 questions by Gnus. It will simply assume you know what you're doing, no
13803 matter how strange.
13805 @item gnus-interactive-catchup
13806 @vindex gnus-interactive-catchup
13807 Require confirmation before catching up a group if non-@code{nil}. It
13808 is @code{t} by default.
13810 @item gnus-interactive-exit
13811 @vindex gnus-interactive-exit
13812 Require confirmation before exiting Gnus. This variable is @code{t} by
13817 @node Symbolic Prefixes
13818 @section Symbolic Prefixes
13819 @cindex symbolic prefixes
13821 Quite a lot of Emacs commands react to the (numeric) prefix. For
13822 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
13823 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
13824 rule of 900 to the current article.
13826 This is all nice and well, but what if you want to give a command some
13827 additional information? Well, what most commands do is interpret the
13828 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
13829 doesn't want a backup file to be created when saving the current buffer,
13830 for instance. But what if you want to save without making a backup
13831 file, and you want Emacs to flash lights and play a nice tune at the
13832 same time? You can't, and you're probably perfectly happy that way.
13834 @kindex M-i (Summary)
13835 @findex gnus-symbolic-argument
13836 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
13837 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
13838 character typed in is the value. You can stack as many @kbd{M-i}
13839 prefixes as you want. @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
13840 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b M-C-u} means
13841 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
13842 @code{b}''. You get the drift.
13844 Typing in symbolic prefixes to commands that don't accept them doesn't
13845 hurt, but it doesn't do any good either. Currently not many Gnus
13846 functions make use of the symbolic prefix.
13848 If you're interested in how Gnus implements this, @pxref{Extended
13852 @node Formatting Variables
13853 @section Formatting Variables
13854 @cindex formatting variables
13856 Throughout this manual you've probably noticed lots of variables called
13857 things like @code{gnus-group-line-format} and
13858 @code{gnus-summary-mode-line-format}. These control how Gnus is to
13859 output lines in the various buffers. There's quite a lot of them.
13860 Fortunately, they all use the same syntax, so there's not that much to
13863 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
13864 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
13865 lots of percentages everywhere.
13868 * Formatting Basics:: A formatting variable is basically a format string.
13869 * Mode Line Formatting:: Some rules about mode line formatting variables.
13870 * Advanced Formatting:: Modifying output in various ways.
13871 * User-Defined Specs:: Having Gnus call your own functions.
13872 * Formatting Fonts:: Making the formatting look colorful and nice.
13875 Currently Gnus uses the following formatting variables:
13876 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
13877 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
13878 @code{gnus-group-mode-line-format},
13879 @code{gnus-summary-mode-line-format},
13880 @code{gnus-article-mode-line-format},
13881 @code{gnus-server-mode-line-format}, and
13882 @code{gnus-summary-pick-line-format}.
13884 All these format variables can also be arbitrary elisp forms. In that
13885 case, they will be @code{eval}ed to insert the required lines.
13887 @kindex M-x gnus-update-format
13888 @findex gnus-update-format
13889 Gnus includes a command to help you while creating your own format
13890 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
13891 update the spec in question and pop you to a buffer where you can
13892 examine the resulting lisp code to be run to generate the line.
13896 @node Formatting Basics
13897 @subsection Formatting Basics
13899 Each @samp{%} element will be replaced by some string or other when the
13900 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
13901 spec, and pad with spaces to get a 5-character field''.
13903 As with normal C and Emacs Lisp formatting strings, the numerical
13904 modifier between the @samp{%} and the formatting type character will
13905 @dfn{pad} the output so that it is always at least that long.
13906 @samp{%5y} will make the field always (at least) five characters wide by
13907 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
13910 You may also wish to limit the length of the field to protect against
13911 particularly wide values. For that you can say @samp{%4,6y}, which
13912 means that the field will never be more than 6 characters wide and never
13913 less than 4 characters wide.
13916 @node Mode Line Formatting
13917 @subsection Mode Line Formatting
13919 Mode line formatting variables (e.g.,
13920 @code{gnus-summary-mode-line-format}) follow the same rules as other,
13921 buffer line oriented formatting variables (@pxref{Formatting Basics})
13922 with the following two differences:
13927 There must be no newline (@samp{\n}) at the end.
13930 The special @samp{%%b} spec can be used to display the buffer name.
13931 Well, it's no spec at all, really---@samp{%%} is just a way to quote
13932 @samp{%} to allow it to pass through the formatting machinery unmangled,
13933 so that Emacs receives @samp{%b}, which is something the Emacs mode line
13934 display interprets to mean ``show the buffer name''. For a full list of
13935 mode line specs Emacs understands, see the documentation of the
13936 @code{mode-line-format} variable.
13941 @node Advanced Formatting
13942 @subsection Advanced Formatting
13944 It is frequently useful to post-process the fields in some way.
13945 Padding, limiting, cutting off parts and suppressing certain values can
13946 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
13947 look like @samp{%~(cut 3)~(ignore "0")y}.
13949 These are the valid modifiers:
13954 Pad the field to the left with spaces until it reaches the required
13958 Pad the field to the right with spaces until it reaches the required
13963 Cut off characters from the left until it reaches the specified length.
13966 Cut off characters from the right until it reaches the specified
13971 Cut off the specified number of characters from the left.
13974 Cut off the specified number of characters from the right.
13977 Return an empty string if the field is equal to the specified value.
13980 Use the specified form as the field value when the @samp{@@} spec is
13984 Let's take an example. The @samp{%o} spec in the summary mode lines
13985 will return a date in compact ISO8601 format---@samp{19960809T230410}.
13986 This is quite a mouthful, so we want to shave off the century number and
13987 the time, leaving us with a six-character date. That would be
13988 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
13989 maxing, and we need the padding to ensure that the date is never less
13990 than 6 characters to make it look nice in columns.)
13992 Ignoring is done first; then cutting; then maxing; and then as the very
13993 last operation, padding.
13995 If you use lots of these advanced thingies, you'll find that Gnus gets
13996 quite slow. This can be helped enormously by running @kbd{M-x
13997 gnus-compile} when you are satisfied with the look of your lines.
13998 @xref{Compilation}.
14001 @node User-Defined Specs
14002 @subsection User-Defined Specs
14004 All the specs allow for inserting user defined specifiers---@samp{u}.
14005 The next character in the format string should be a letter. Gnus
14006 will call the function @code{gnus-user-format-function-}@samp{X}, where
14007 @samp{X} is the letter following @samp{%u}. The function will be passed
14008 a single parameter---what the parameter means depends on what buffer
14009 it's being called from. The function should return a string, which will
14010 be inserted into the buffer just like information from any other
14011 specifier. This function may also be called with dummy values, so it
14012 should protect against that.
14014 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
14015 much the same without defining new functions. Here's an example:
14016 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
14017 given here will be evaluated to yield the current line number, and then
14021 @node Formatting Fonts
14022 @subsection Formatting Fonts
14024 There are specs for highlighting, and these are shared by all the format
14025 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
14026 the special @code{mouse-face} property set, which means that it will be
14027 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
14030 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
14031 normal faces set using @code{gnus-face-0}, which is @code{bold} by
14032 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
14033 and so on. Create as many faces as you wish. The same goes for the
14034 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
14035 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
14037 Here's an alternative recipe for the group buffer:
14040 ;; Create three face types.
14041 (setq gnus-face-1 'bold)
14042 (setq gnus-face-3 'italic)
14044 ;; We want the article count to be in
14045 ;; a bold and green face. So we create
14046 ;; a new face called `my-green-bold'.
14047 (copy-face 'bold 'my-green-bold)
14049 (set-face-foreground 'my-green-bold "ForestGreen")
14050 (setq gnus-face-2 'my-green-bold)
14052 ;; Set the new & fancy format.
14053 (setq gnus-group-line-format
14054 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
14057 I'm sure you'll be able to use this scheme to create totally unreadable
14058 and extremely vulgar displays. Have fun!
14060 Note that the @samp{%(} specs (and friends) do not make any sense on the
14061 mode-line variables.
14064 @node Windows Configuration
14065 @section Windows Configuration
14066 @cindex windows configuration
14068 No, there's nothing here about X, so be quiet.
14070 @vindex gnus-use-full-window
14071 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
14072 other windows and occupy the entire Emacs screen by itself. It is
14073 @code{t} by default.
14075 @vindex gnus-buffer-configuration
14076 @code{gnus-buffer-configuration} describes how much space each Gnus
14077 buffer should be given. Here's an excerpt of this variable:
14080 ((group (vertical 1.0 (group 1.0 point)
14081 (if gnus-carpal (group-carpal 4))))
14082 (article (vertical 1.0 (summary 0.25 point)
14086 This is an alist. The @dfn{key} is a symbol that names some action or
14087 other. For instance, when displaying the group buffer, the window
14088 configuration function will use @code{group} as the key. A full list of
14089 possible names is listed below.
14091 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
14092 should occupy. To take the @code{article} split as an example -
14095 (article (vertical 1.0 (summary 0.25 point)
14099 This @dfn{split} says that the summary buffer should occupy 25% of upper
14100 half of the screen, and that it is placed over the article buffer. As
14101 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
14102 reaching for that calculator there). However, the special number
14103 @code{1.0} is used to signal that this buffer should soak up all the
14104 rest of the space available after the rest of the buffers have taken
14105 whatever they need. There should be only one buffer with the @code{1.0}
14106 size spec per split.
14108 Point will be put in the buffer that has the optional third element
14109 @code{point}. In a @code{frame} split, the last subsplit having a leaf
14110 split where the tag @code{frame-focus} is a member (i.e. is the third or
14111 fourth element in the list, depending on whether the @code{point} tag is
14112 present) gets focus.
14114 Here's a more complicated example:
14117 (article (vertical 1.0 (group 4)
14118 (summary 0.25 point)
14119 (if gnus-carpal (summary-carpal 4))
14123 If the size spec is an integer instead of a floating point number,
14124 then that number will be used to say how many lines a buffer should
14125 occupy, not a percentage.
14127 If the @dfn{split} looks like something that can be @code{eval}ed (to be
14128 precise---if the @code{car} of the split is a function or a subr), this
14129 split will be @code{eval}ed. If the result is non-@code{nil}, it will
14130 be used as a split. This means that there will be three buffers if
14131 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
14134 Not complicated enough for you? Well, try this on for size:
14137 (article (horizontal 1.0
14142 (summary 0.25 point)
14147 Whoops. Two buffers with the mystery 100% tag. And what's that
14148 @code{horizontal} thingie?
14150 If the first element in one of the split is @code{horizontal}, Gnus will
14151 split the window horizontally, giving you two windows side-by-side.
14152 Inside each of these strips you may carry on all you like in the normal
14153 fashion. The number following @code{horizontal} says what percentage of
14154 the screen is to be given to this strip.
14156 For each split, there @emph{must} be one element that has the 100% tag.
14157 The splitting is never accurate, and this buffer will eat any leftover
14158 lines from the splits.
14160 To be slightly more formal, here's a definition of what a valid split
14164 split = frame | horizontal | vertical | buffer | form
14165 frame = "(frame " size *split ")"
14166 horizontal = "(horizontal " size *split ")"
14167 vertical = "(vertical " size *split ")"
14168 buffer = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
14169 size = number | frame-params
14170 buffer-name = group | article | summary ...
14173 The limitations are that the @code{frame} split can only appear as the
14174 top-level split. @var{form} should be an Emacs Lisp form that should
14175 return a valid split. We see that each split is fully recursive, and
14176 may contain any number of @code{vertical} and @code{horizontal} splits.
14178 @vindex gnus-window-min-width
14179 @vindex gnus-window-min-height
14180 @cindex window height
14181 @cindex window width
14182 Finding the right sizes can be a bit complicated. No window may be less
14183 than @code{gnus-window-min-height} (default 1) characters high, and all
14184 windows must be at least @code{gnus-window-min-width} (default 1)
14185 characters wide. Gnus will try to enforce this before applying the
14186 splits. If you want to use the normal Emacs window width/height limit,
14187 you can just set these two variables to @code{nil}.
14189 If you're not familiar with Emacs terminology, @code{horizontal} and
14190 @code{vertical} splits may work the opposite way of what you'd expect.
14191 Windows inside a @code{horizontal} split are shown side-by-side, and
14192 windows within a @code{vertical} split are shown above each other.
14194 @findex gnus-configure-frame
14195 If you want to experiment with window placement, a good tip is to call
14196 @code{gnus-configure-frame} directly with a split. This is the function
14197 that does all the real work when splitting buffers. Below is a pretty
14198 nonsensical configuration with 5 windows; two for the group buffer and
14199 three for the article buffer. (I said it was nonsensical.) If you
14200 @code{eval} the statement below, you can get an idea of how that would
14201 look straight away, without going through the normal Gnus channels.
14202 Play with it until you're satisfied, and then use
14203 @code{gnus-add-configuration} to add your new creation to the buffer
14204 configuration list.
14207 (gnus-configure-frame
14211 (article 0.3 point))
14219 You might want to have several frames as well. No prob---just use the
14220 @code{frame} split:
14223 (gnus-configure-frame
14226 (summary 0.25 point frame-focus)
14228 (vertical ((height . 5) (width . 15)
14229 (user-position . t)
14230 (left . -1) (top . 1))
14235 This split will result in the familiar summary/article window
14236 configuration in the first (or ``main'') frame, while a small additional
14237 frame will be created where picons will be shown. As you can see,
14238 instead of the normal @code{1.0} top-level spec, each additional split
14239 should have a frame parameter alist as the size spec.
14240 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
14241 Reference Manual}. Under XEmacs, a frame property list will be
14242 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
14245 Here's a list of all possible keys for
14246 @code{gnus-buffer-configuration}:
14248 @code{group}, @code{summary}, @code{article}, @code{server},
14249 @code{browse}, @code{message}, @code{pick}, @code{info},
14250 @code{summary-faq}, @code{edit-group}, @code{edit-server},
14251 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
14252 @code{reply-yank}, @code{mail-bounce}, @code{draft}, @code{pipe},
14253 @code{bug}, @code{compose-bounce}, and @code{score-trace}.
14255 Note that the @code{message} key is used for both
14256 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
14257 it is desirable to distinguish between the two, something like this
14261 (message (horizontal 1.0
14262 (vertical 1.0 (message 1.0 point))
14264 (if (buffer-live-p gnus-summary-buffer)
14269 @findex gnus-add-configuration
14270 Since the @code{gnus-buffer-configuration} variable is so long and
14271 complicated, there's a function you can use to ease changing the config
14272 of a single setting: @code{gnus-add-configuration}. If, for instance,
14273 you want to change the @code{article} setting, you could say:
14276 (gnus-add-configuration
14277 '(article (vertical 1.0
14279 (summary .25 point)
14283 You'd typically stick these @code{gnus-add-configuration} calls in your
14284 @file{.gnus.el} file or in some startup hook---they should be run after
14285 Gnus has been loaded.
14287 @vindex gnus-always-force-window-configuration
14288 If all windows mentioned in the configuration are already visible, Gnus
14289 won't change the window configuration. If you always want to force the
14290 ``right'' window configuration, you can set
14291 @code{gnus-always-force-window-configuration} to non-@code{nil}.
14294 @node Faces and Fonts
14295 @section Faces and Fonts
14300 Fiddling with fonts and faces used to be very difficult, but these days
14301 it is very simple. You simply say @kbd{M-x customize-face}, pick out
14302 the face you want to alter, and alter it via the standard Customize
14307 @section Compilation
14308 @cindex compilation
14309 @cindex byte-compilation
14311 @findex gnus-compile
14313 Remember all those line format specification variables?
14314 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
14315 on. Now, Gnus will of course heed whatever these variables are, but,
14316 unfortunately, changing them will mean a quite significant slow-down.
14317 (The default values of these variables have byte-compiled functions
14318 associated with them, while the user-generated versions do not, of
14321 To help with this, you can run @kbd{M-x gnus-compile} after you've
14322 fiddled around with the variables and feel that you're (kind of)
14323 satisfied. This will result in the new specs being byte-compiled, and
14324 you'll get top speed again. Gnus will save these compiled specs in the
14325 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
14326 this function, though---you should compile them yourself by sticking
14327 them into the @code{.gnus.el} file and byte-compiling that file.)
14331 @section Mode Lines
14334 @vindex gnus-updated-mode-lines
14335 @code{gnus-updated-mode-lines} says what buffers should keep their mode
14336 lines updated. It is a list of symbols. Supported symbols include
14337 @code{group}, @code{article}, @code{summary}, @code{server},
14338 @code{browse}, and @code{tree}. If the corresponding symbol is present,
14339 Gnus will keep that mode line updated with information that may be
14340 pertinent. If this variable is @code{nil}, screen refresh may be
14343 @cindex display-time
14345 @vindex gnus-mode-non-string-length
14346 By default, Gnus displays information on the current article in the mode
14347 lines of the summary and article buffers. The information Gnus wishes
14348 to display (e.g. the subject of the article) is often longer than the
14349 mode lines, and therefore have to be cut off at some point. The
14350 @code{gnus-mode-non-string-length} variable says how long the other
14351 elements on the line is (i.e., the non-info part). If you put
14352 additional elements on the mode line (e.g. a clock), you should modify
14355 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
14357 (add-hook 'display-time-hook
14358 (lambda () (setq gnus-mode-non-string-length
14360 (if line-number-mode 5 0)
14361 (if column-number-mode 4 0)
14362 (length display-time-string)))))
14365 If this variable is @code{nil} (which is the default), the mode line
14366 strings won't be chopped off, and they won't be padded either. Note
14367 that the default is unlikely to be desirable, as even the percentage
14368 complete in the buffer may be crowded off the mode line; the user should
14369 configure this variable appropriately for her configuration.
14372 @node Highlighting and Menus
14373 @section Highlighting and Menus
14375 @cindex highlighting
14378 @vindex gnus-visual
14379 The @code{gnus-visual} variable controls most of the Gnus-prettifying
14380 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
14381 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
14384 This variable can be a list of visual properties that are enabled. The
14385 following elements are valid, and are all included by default:
14388 @item group-highlight
14389 Do highlights in the group buffer.
14390 @item summary-highlight
14391 Do highlights in the summary buffer.
14392 @item article-highlight
14393 Do highlights according to @code{gnus-article-display-hook} in the
14396 Turn on highlighting in all buffers.
14398 Create menus in the group buffer.
14400 Create menus in the summary buffers.
14402 Create menus in the article buffer.
14404 Create menus in the browse buffer.
14406 Create menus in the server buffer.
14408 Create menus in the score buffers.
14410 Create menus in all buffers.
14413 So if you only want highlighting in the article buffer and menus in all
14414 buffers, you could say something like:
14417 (setq gnus-visual '(article-highlight menu))
14420 If you want highlighting only and no menus whatsoever, you'd say:
14423 (setq gnus-visual '(highlight))
14426 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
14427 in all Gnus buffers.
14429 Other general variables that influence the look of all buffers include:
14432 @item gnus-mouse-face
14433 @vindex gnus-mouse-face
14434 This is the face (i.e., font) used for mouse highlighting in Gnus. No
14435 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
14439 There are hooks associated with the creation of all the different menus:
14443 @item gnus-article-menu-hook
14444 @vindex gnus-article-menu-hook
14445 Hook called after creating the article mode menu.
14447 @item gnus-group-menu-hook
14448 @vindex gnus-group-menu-hook
14449 Hook called after creating the group mode menu.
14451 @item gnus-summary-menu-hook
14452 @vindex gnus-summary-menu-hook
14453 Hook called after creating the summary mode menu.
14455 @item gnus-server-menu-hook
14456 @vindex gnus-server-menu-hook
14457 Hook called after creating the server mode menu.
14459 @item gnus-browse-menu-hook
14460 @vindex gnus-browse-menu-hook
14461 Hook called after creating the browse mode menu.
14463 @item gnus-score-menu-hook
14464 @vindex gnus-score-menu-hook
14465 Hook called after creating the score mode menu.
14476 Those new-fangled @dfn{mouse} contraptions is very popular with the
14477 young, hep kids who don't want to learn the proper way to do things
14478 these days. Why, I remember way back in the summer of '89, when I was
14479 using Emacs on a Tops 20 system. Three hundred users on one single
14480 machine, and every user was running Simula compilers. Bah!
14484 @vindex gnus-carpal
14485 Well, you can make Gnus display bufferfuls of buttons you can click to
14486 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
14487 really. Tell the chiropractor I sent you.
14492 @item gnus-carpal-mode-hook
14493 @vindex gnus-carpal-mode-hook
14494 Hook run in all carpal mode buffers.
14496 @item gnus-carpal-button-face
14497 @vindex gnus-carpal-button-face
14498 Face used on buttons.
14500 @item gnus-carpal-header-face
14501 @vindex gnus-carpal-header-face
14502 Face used on carpal buffer headers.
14504 @item gnus-carpal-group-buffer-buttons
14505 @vindex gnus-carpal-group-buffer-buttons
14506 Buttons in the group buffer.
14508 @item gnus-carpal-summary-buffer-buttons
14509 @vindex gnus-carpal-summary-buffer-buttons
14510 Buttons in the summary buffer.
14512 @item gnus-carpal-server-buffer-buttons
14513 @vindex gnus-carpal-server-buffer-buttons
14514 Buttons in the server buffer.
14516 @item gnus-carpal-browse-buffer-buttons
14517 @vindex gnus-carpal-browse-buffer-buttons
14518 Buttons in the browse buffer.
14521 All the @code{buttons} variables are lists. The elements in these list
14522 are either cons cells where the @code{car} contains a text to be displayed and
14523 the @code{cdr} contains a function symbol, or a simple string.
14531 Gnus, being larger than any program ever written (allegedly), does lots
14532 of strange stuff that you may wish to have done while you're not
14533 present. For instance, you may want it to check for new mail once in a
14534 while. Or you may want it to close down all connections to all servers
14535 when you leave Emacs idle. And stuff like that.
14537 Gnus will let you do stuff like that by defining various
14538 @dfn{handlers}. Each handler consists of three elements: A
14539 @var{function}, a @var{time}, and an @var{idle} parameter.
14541 Here's an example of a handler that closes connections when Emacs has
14542 been idle for thirty minutes:
14545 (gnus-demon-close-connections nil 30)
14548 Here's a handler that scans for PGP headers every hour when Emacs is
14552 (gnus-demon-scan-pgp 60 t)
14555 This @var{time} parameter and than @var{idle} parameter work together
14556 in a strange, but wonderful fashion. Basically, if @var{idle} is
14557 @code{nil}, then the function will be called every @var{time} minutes.
14559 If @var{idle} is @code{t}, then the function will be called after
14560 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
14561 the function will never be called. But once Emacs goes idle, the
14562 function will be called every @var{time} minutes.
14564 If @var{idle} is a number and @var{time} is a number, the function will
14565 be called every @var{time} minutes only when Emacs has been idle for
14566 @var{idle} minutes.
14568 If @var{idle} is a number and @var{time} is @code{nil}, the function
14569 will be called once every time Emacs has been idle for @var{idle}
14572 And if @var{time} is a string, it should look like @samp{07:31}, and
14573 the function will then be called once every day somewhere near that
14574 time. Modified by the @var{idle} parameter, of course.
14576 @vindex gnus-demon-timestep
14577 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
14578 seconds. This is 60 by default. If you change that variable,
14579 all the timings in the handlers will be affected.)
14581 @vindex gnus-use-demon
14582 To set the whole thing in motion, though, you have to set
14583 @code{gnus-use-demon} to @code{t}.
14585 So, if you want to add a handler, you could put something like this in
14586 your @file{.gnus} file:
14588 @findex gnus-demon-add-handler
14590 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
14593 @findex gnus-demon-add-nocem
14594 @findex gnus-demon-add-scanmail
14595 @findex gnus-demon-add-rescan
14596 @findex gnus-demon-add-scan-timestamps
14597 @findex gnus-demon-add-disconnection
14598 Some ready-made functions to do this have been created:
14599 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
14600 @code{gnus-demon-add-nntp-close-connection},
14601 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
14602 @code{gnus-demon-add-scanmail}. Just put those functions in your
14603 @file{.gnus} if you want those abilities.
14605 @findex gnus-demon-init
14606 @findex gnus-demon-cancel
14607 @vindex gnus-demon-handlers
14608 If you add handlers to @code{gnus-demon-handlers} directly, you should
14609 run @code{gnus-demon-init} to make the changes take hold. To cancel all
14610 daemons, you can use the @code{gnus-demon-cancel} function.
14612 Note that adding daemons can be pretty naughty if you over do it. Adding
14613 functions that scan all news and mail from all servers every two seconds
14614 is a sure-fire way of getting booted off any respectable system. So
14623 @dfn{Spamming} is posting the same article lots and lots of times.
14624 Spamming is bad. Spamming is evil.
14626 Spamming is usually canceled within a day or so by various anti-spamming
14627 agencies. These agencies usually also send out @dfn{NoCeM} messages.
14628 NoCeM is pronounced ``no see-'em'', and means what the name
14629 implies---these are messages that make the offending articles, like, go
14632 What use are these NoCeM messages if the articles are canceled anyway?
14633 Some sites do not honor cancel messages and some sites just honor cancels
14634 from a select few people. Then you may wish to make use of the NoCeM
14635 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
14637 Gnus can read and parse the messages in this group automatically, and
14638 this will make spam disappear.
14640 There are some variables to customize, of course:
14643 @item gnus-use-nocem
14644 @vindex gnus-use-nocem
14645 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
14648 @item gnus-nocem-groups
14649 @vindex gnus-nocem-groups
14650 Gnus will look for NoCeM messages in the groups in this list. The
14651 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
14652 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
14654 @item gnus-nocem-issuers
14655 @vindex gnus-nocem-issuers
14656 There are many people issuing NoCeM messages. This list says what
14657 people you want to listen to. The default is @code{("Automoose-1"
14658 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
14659 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
14660 (Richard E. Depew)")}; fine, upstanding citizens all of them.
14662 Known despammers that you can put in this list include:
14665 @item clewis@@ferret.ocunix.on.ca;
14666 @cindex Chris Lewis
14667 Chris Lewis---Major Canadian despammer who has probably canceled more
14668 usenet abuse than anybody else.
14671 @cindex CancelMoose[tm]
14672 The CancelMoose[tm] on autopilot. The CancelMoose[tm] is reputed to be
14673 Norwegian, and was the person(s) who invented NoCeM.
14675 @item jem@@xpat.com;
14677 John Milburn---despammer located in Korea who is getting very busy these
14680 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
14681 Richard E. Depew---lone American despammer. He mostly cancels binary
14682 postings to non-binary groups and removes spews (regurgitated articles).
14685 You do not have to heed NoCeM messages from all these people---just the
14686 ones you want to listen to. You also don't have to accept all NoCeM
14687 messages from the people you like. Each NoCeM message has a @dfn{type}
14688 header that gives the message a (more or less, usually less) rigorous
14689 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
14690 @samp{binary}, and @samp{troll}. To specify this, you have to use
14691 @var{(issuer conditions ...)} elements in the list. Each condition is
14692 either a string (which is a regexp that matches types you want to use)
14693 or a list on the form @code{(not STRING)}, where @var{string} is a
14694 regexp that matches types you don't want to use.
14696 For instance, if you want all NoCeM messages from Chris Lewis except his
14697 @samp{troll} messages, you'd say:
14700 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
14703 On the other hand, if you just want nothing but his @samp{spam} and
14704 @samp{spew} messages, you'd say:
14707 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
14710 The specs are applied left-to-right.
14713 @item gnus-nocem-verifyer
14714 @vindex gnus-nocem-verifyer
14716 This should be a function for verifying that the NoCeM issuer is who she
14717 says she is. The default is @code{mc-verify}, which is a Mailcrypt
14718 function. If this is too slow and you don't care for verification
14719 (which may be dangerous), you can set this variable to @code{nil}.
14721 If you want signed NoCeM messages to be verified and unsigned messages
14722 not to be verified (but used anyway), you could do something like:
14725 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
14727 (defun my-gnus-mc-verify ()
14735 This might be dangerous, though.
14737 @item gnus-nocem-directory
14738 @vindex gnus-nocem-directory
14739 This is where Gnus will store its NoCeM cache files. The default is
14740 @file{~/News/NoCeM/}.
14742 @item gnus-nocem-expiry-wait
14743 @vindex gnus-nocem-expiry-wait
14744 The number of days before removing old NoCeM entries from the cache.
14745 The default is 15. If you make it shorter Gnus will be faster, but you
14746 might then see old spam.
14750 Using NoCeM could potentially be a memory hog. If you have many living
14751 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
14752 big. If this is a problem, you should kill off all (or most) of your
14753 unsubscribed groups (@pxref{Subscription Commands}).
14760 It is very useful to be able to undo actions one has done. In normal
14761 Emacs buffers, it's easy enough---you just push the @code{undo} button.
14762 In Gnus buffers, however, it isn't that simple.
14764 The things Gnus displays in its buffer is of no value whatsoever to
14765 Gnus---it's all just data designed to look nice to the user.
14766 Killing a group in the group buffer with @kbd{C-k} makes the line
14767 disappear, but that's just a side-effect of the real action---the
14768 removal of the group in question from the internal Gnus structures.
14769 Undoing something like that can't be done by the normal Emacs
14770 @code{undo} function.
14772 Gnus tries to remedy this somewhat by keeping track of what the user
14773 does and coming up with actions that would reverse the actions the user
14774 takes. When the user then presses the @code{undo} key, Gnus will run
14775 the code to reverse the previous action, or the previous actions.
14776 However, not all actions are easily reversible, so Gnus currently offers
14777 a few key functions to be undoable. These include killing groups,
14778 yanking groups, and changing the list of read articles of groups.
14779 That's it, really. More functions may be added in the future, but each
14780 added function means an increase in data to be stored, so Gnus will
14781 never be totally undoable.
14783 @findex gnus-undo-mode
14784 @vindex gnus-use-undo
14786 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
14787 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
14788 default. The @kbd{M-C-_} key performs the @code{gnus-undo} command
14789 command, which should feel kinda like the normal Emacs @code{undo}
14794 @section Moderation
14797 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
14798 It is not included in the standard Gnus package. Write a mail to
14799 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
14802 The moderation package is implemented as a minor mode for summary
14806 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
14809 in your @file{.gnus.el} file.
14811 If you are the moderator of @samp{rec.zoofle}, this is how it's
14816 You split your incoming mail by matching on
14817 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
14818 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
14821 You enter that group once in a while and post articles using the @kbd{e}
14822 (edit-and-post) or @kbd{s} (just send unedited) commands.
14825 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
14826 articles that weren't approved by you, you can cancel them with the
14830 To use moderation mode in these two groups, say:
14833 (setq gnus-moderated-list
14834 "^nnml:rec.zoofle$\\|^rec.zoofle$")
14838 @node XEmacs Enhancements
14839 @section XEmacs Enhancements
14842 XEmacs is able to display pictures and stuff, so Gnus has taken
14846 * Picons:: How to display pictures of what your reading.
14847 * Smileys:: Show all those happy faces the way they were meant to be shown.
14848 * Toolbar:: Click'n'drool.
14849 * XVarious:: Other XEmacsy Gnusey variables.
14862 So... You want to slow down your news reader even more! This is a
14863 good way to do so. Its also a great way to impress people staring
14864 over your shoulder as you read news.
14867 * Picon Basics:: What are picons and How do I get them.
14868 * Picon Requirements:: Don't go further if you aren't using XEmacs.
14869 * Easy Picons:: Displaying Picons---the easy way.
14870 * Hard Picons:: The way you should do it. You'll learn something.
14871 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
14876 @subsubsection Picon Basics
14878 What are Picons? To quote directly from the Picons Web site:
14887 @dfn{Picons} is short for ``personal icons''. They're small,
14888 constrained images used to represent users and domains on the net,
14889 organized into databases so that the appropriate image for a given
14890 e-mail address can be found. Besides users and domains, there are picon
14891 databases for Usenet newsgroups and weather forecasts. The picons are
14892 in either monochrome @code{XBM} format or color @code{XPM} and
14893 @code{GIF} formats.
14896 @vindex gnus-picons-piconsearch-url
14897 If you have a permanent connection to the Internet you can use Steve
14898 Kinzler's Picons Search engine by setting
14899 @code{gnus-picons-piconsearch-url} to the string @*
14900 @file{http://www.cs.indiana.edu/picons/search.html}.
14902 @vindex gnus-picons-database
14903 Otherwise you need a local copy of his database. For instructions on
14904 obtaining and installing the picons databases, point your Web browser at @*
14905 @file{http://www.cs.indiana.edu/picons/ftp/index.html}. Gnus expects
14906 picons to be installed into a location pointed to by
14907 @code{gnus-picons-database}.
14910 @node Picon Requirements
14911 @subsubsection Picon Requirements
14913 To have Gnus display Picons for you, you must be running XEmacs
14914 19.13 or greater since all other versions of Emacs aren't yet able to
14917 Additionally, you must have @code{x} support compiled into XEmacs. To
14918 display color picons which are much nicer than the black & white one,
14919 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
14921 @vindex gnus-picons-convert-x-face
14922 If you want to display faces from @code{X-Face} headers, you should have
14923 the @code{xface} support compiled into XEmacs. Otherwise you must have
14924 the @code{netpbm} utilities installed, or munge the
14925 @code{gnus-picons-convert-x-face} variable to use something else.
14929 @subsubsection Easy Picons
14931 To enable displaying picons, simply put the following line in your
14932 @file{~/.gnus} file and start Gnus.
14935 (setq gnus-use-picons t)
14936 (add-hook 'gnus-article-display-hook
14937 'gnus-article-display-picons t)
14938 (add-hook 'gnus-article-display-hook
14939 'gnus-picons-article-display-x-face)
14942 and make sure @code{gnus-picons-database} points to the directory
14943 containing the Picons databases.
14945 Alternatively if you want to use the web piconsearch engine add this:
14948 (setq gnus-picons-piconsearch-url
14949 "http://www.cs.indiana.edu:800/piconsearch")
14954 @subsubsection Hard Picons
14962 Gnus can display picons for you as you enter and leave groups and
14963 articles. It knows how to interact with three sections of the picons
14964 database. Namely, it can display the picons newsgroup pictures,
14965 author's face picture(s), and the authors domain. To enable this
14966 feature, you need to select where to get the picons from, and where to
14971 @item gnus-picons-database
14972 @vindex gnus-picons-database
14973 The location of the picons database. Should point to a directory
14974 containing the @file{news}, @file{domains}, @file{users} (and so on)
14975 subdirectories. This is only useful if
14976 @code{gnus-picons-piconsearch-url} is @code{nil}. Defaults to
14977 @file{/usr/local/faces/}.
14979 @item gnus-picons-piconsearch-url
14980 @vindex gnus-picons-piconsearch-url
14981 The URL for the web picons search engine. The only currently known
14982 engine is @file{http://www.cs.indiana.edu:800/piconsearch}. To
14983 workaround network delays, icons will be fetched in the background. If
14984 this is @code{nil} 'the default), then picons are fetched from local
14985 database indicated by @code{gnus-picons-database}.
14987 @item gnus-picons-display-where
14988 @vindex gnus-picons-display-where
14989 Where the picon images should be displayed. It is @code{picons} by
14990 default (which by default maps to the buffer @samp{*Picons*}). Other
14991 valid places could be @code{article}, @code{summary}, or
14992 @samp{*scratch*} for all I care. Just make sure that you've made the
14993 buffer visible using the standard Gnus window configuration
14994 routines---@pxref{Windows Configuration}.
14996 @item gnus-picons-group-excluded-groups
14997 @vindex gnus-picons-group-excluded-groups
14998 Groups that are matched by this regexp won't have their group icons
15003 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
15004 window configuration for you to include the @code{picons} buffer.
15006 Now that you've made those decision, you need to add the following
15007 functions to the appropriate hooks so these pictures will get displayed
15010 @vindex gnus-article-display-hook
15011 @vindex gnus-picons-display-where
15013 @item gnus-article-display-picons
15014 @findex gnus-article-display-picons
15015 Looks up and displays the picons for the author and the author's domain
15016 in the @code{gnus-picons-display-where} buffer. Should be added to the
15017 @code{gnus-article-display-hook}.
15019 @item gnus-picons-article-display-x-face
15020 @findex gnus-article-display-picons
15021 Decodes and displays the X-Face header if present. This function
15022 should be added to @code{gnus-article-display-hook}.
15026 Note: You must append them to the hook, so make sure to specify 't'
15027 for the append flag of @code{add-hook}:
15030 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
15034 @node Picon Useless Configuration
15035 @subsubsection Picon Useless Configuration
15043 The following variables offer further control over how things are
15044 done, where things are located, and other useless stuff you really
15045 don't need to worry about.
15049 @item gnus-picons-news-directories
15050 @vindex gnus-picons-news-directories
15051 List of subdirectories to search in @code{gnus-picons-database} for
15052 newsgroups faces. @code{("news")} is the default.
15054 @item gnus-picons-user-directories
15055 @vindex gnus-picons-user-directories
15056 List of subdirectories to search in @code{gnus-picons-database} for user
15057 faces. @code{("local" "users" "usenix" "misc")} is the default.
15059 @item gnus-picons-domain-directories
15060 @vindex gnus-picons-domain-directories
15061 List of subdirectories to search in @code{gnus-picons-database} for
15062 domain name faces. Defaults to @code{("domains")}. Some people may
15063 want to add @samp{"unknown"} to this list.
15065 @item gnus-picons-convert-x-face
15066 @vindex gnus-picons-convert-x-face
15067 If you don't have @code{xface} support builtin XEmacs, this is the
15068 command to use to convert the @code{X-Face} header to an X bitmap
15069 (@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48,
15070 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
15071 gnus-picons-x-face-file-name)}
15073 @item gnus-picons-x-face-file-name
15074 @vindex gnus-picons-x-face-file-name
15075 Names a temporary file to store the @code{X-Face} bitmap in. Defaults
15076 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
15078 @item gnus-picons-has-modeline-p
15079 @vindex gnus-picons-has-modeline-p
15080 If you have set @code{gnus-picons-display-where} to @code{picons}, your
15081 XEmacs frame will become really cluttered. To alleviate this a bit you
15082 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
15083 remove the mode line from the Picons buffer. This is only useful if
15084 @code{gnus-picons-display-where} is @code{picons}.
15086 @item gnus-picons-refresh-before-display
15087 @vindex gnus-picons-refresh-before-display
15088 If non-nil, display the article buffer before computing the picons.
15089 Defaults to @code{nil}.
15091 @item gnus-picons-display-as-address
15092 @vindex gnus-picons-display-as-address
15093 If @code{t} display textual email addresses along with pictures.
15094 Defaults to @code{t}.
15096 @item gnus-picons-file-suffixes
15097 @vindex gnus-picons-file-suffixes
15098 Ordered list of suffixes on picon file names to try. Defaults to
15099 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
15101 @item gnus-picons-display-article-move-p
15102 @vindex gnus-picons-display-article-move-p
15103 Whether to move point to first empty line when displaying picons. This
15104 has only an effect if `gnus-picons-display-where' has value `article'.
15106 @item gnus-picons-clear-cache-on-shutdown
15107 @vindex gnus-picons-clear-cache-on-shutdown
15108 Whether to clear the picons cache when exiting gnus. Gnus caches every
15109 picons it finds while it is running. This saves some time in the search
15110 process but eats some memory. If this variable is set to @code{nil},
15111 Gnus will never clear the cache itself; you will have to manually call
15112 @code{gnus-picons-clear-cache} to clear it. Otherwise the cache will be
15113 cleared every time you exit Gnus. Defaults to @code{t}.
15124 @subsection Smileys
15129 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
15134 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
15135 currently the only package that uses Smiley, it is documented here.
15137 In short---to use Smiley in Gnus, put the following in your
15138 @file{.gnus.el} file:
15141 (add-hook 'gnus-article-display-hook 'gnus-smiley-display t)
15144 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
15145 the like---to pictures and displays those instead of the text smiley
15146 faces. The conversion is controlled by a list of regexps that matches
15147 text and maps that to file names.
15149 @vindex smiley-nosey-regexp-alist
15150 @vindex smiley-deformed-regexp-alist
15151 Smiley supplies two example conversion alists by default:
15152 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
15153 and so on), and @code{smiley-nosey-regexp-alist} (which matches
15154 @samp{:-)}, @samp{:-(} and so on).
15156 The alist used is specified by the @code{smiley-regexp-alist} variable,
15157 which defaults to the value of @code{smiley-deformed-regexp-alist}.
15159 The first item in each element is the regexp to be matched; the second
15160 element is the regexp match group that is to be replaced by the picture;
15161 and the third element is the name of the file to be displayed.
15163 The following variables customize where Smiley will look for these
15164 files, as well as the color to be used and stuff:
15168 @item smiley-data-directory
15169 @vindex smiley-data-directory
15170 Where Smiley will look for smiley faces files.
15172 @item smiley-flesh-color
15173 @vindex smiley-flesh-color
15174 Skin color. The default is @samp{yellow}, which is really racist.
15176 @item smiley-features-color
15177 @vindex smiley-features-color
15178 Color of the features of the face. The default is @samp{black}.
15180 @item smiley-tongue-color
15181 @vindex smiley-tongue-color
15182 Color of the tongue. The default is @samp{red}.
15184 @item smiley-circle-color
15185 @vindex smiley-circle-color
15186 Color of the circle around the face. The default is @samp{black}.
15188 @item smiley-mouse-face
15189 @vindex smiley-mouse-face
15190 Face used for mouse highlighting over the smiley face.
15196 @subsection Toolbar
15206 @item gnus-use-toolbar
15207 @vindex gnus-use-toolbar
15208 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
15209 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
15210 @code{right-toolbar}, or @code{left-toolbar}.
15212 @item gnus-group-toolbar
15213 @vindex gnus-group-toolbar
15214 The toolbar in the group buffer.
15216 @item gnus-summary-toolbar
15217 @vindex gnus-summary-toolbar
15218 The toolbar in the summary buffer.
15220 @item gnus-summary-mail-toolbar
15221 @vindex gnus-summary-mail-toolbar
15222 The toolbar in the summary buffer of mail groups.
15228 @subsection Various XEmacs Variables
15231 @item gnus-xmas-glyph-directory
15232 @vindex gnus-xmas-glyph-directory
15233 This is where Gnus will look for pictures. Gnus will normally
15234 auto-detect this directory, but you may set it manually if you have an
15235 unusual directory structure.
15237 @item gnus-xmas-logo-color-alist
15238 @vindex gnus-xmas-logo-color-alist
15239 This is an alist where the key is a type symbol and the values are the
15240 foreground and background color of the splash page glyph.
15242 @item gnus-xmas-logo-color-style
15243 @vindex gnus-xmas-logo-color-style
15244 This is the key used to look up the color in the alist described above.
15245 Valid values include @code{flame}, @code{pine}, @code{moss},
15246 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
15247 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
15249 @item gnus-xmas-modeline-glyph
15250 @vindex gnus-xmas-modeline-glyph
15251 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
15265 @node Fuzzy Matching
15266 @section Fuzzy Matching
15267 @cindex fuzzy matching
15269 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
15270 things like scoring, thread gathering and thread comparison.
15272 As opposed to regular expression matching, fuzzy matching is very fuzzy.
15273 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
15274 means, and the implementation has changed over time.
15276 Basically, it tries to remove all noise from lines before comparing.
15277 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
15278 out of the strings before comparing the results. This often leads to
15279 adequate results---even when faced with strings generated by text
15280 manglers masquerading as newsreaders.
15283 @node Thwarting Email Spam
15284 @section Thwarting Email Spam
15288 @cindex unsolicited commercial email
15290 In these last days of the Usenet, commercial vultures are hanging about
15291 and grepping through news like crazy to find email addresses they can
15292 foist off their scams and products to. As a reaction to this, many
15293 people have started putting nonsense addresses into their @code{From}
15294 lines. I think this is counterproductive---it makes it difficult for
15295 people to send you legitimate mail in response to things you write, as
15296 well as making it difficult to see who wrote what. This rewriting may
15297 perhaps be a bigger menace than the unsolicited commercial email itself
15300 The biggest problem I have with email spam is that it comes in under
15301 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
15302 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
15303 mail group, only to find two pyramid schemes, seven advertisements
15304 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
15305 and one mail asking me to repent and find some god.
15309 The way to deal with this is having Gnus split out all spam into a
15310 @samp{spam} mail group (@pxref{Splitting Mail}).
15312 First, pick one (1) valid mail address that you can be reached at, and
15313 put it in your @code{From} header of all your news articles. (I've
15314 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
15315 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
15316 sysadm whether your sendmail installation accepts keywords in the local
15317 part of the mail address.)
15320 (setq message-default-news-headers
15321 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
15324 Then put the following split rule in @code{nnmail-split-fancy}
15325 (@pxref{Fancy Mail Splitting}):
15330 (to "larsi@@trym.ifi.uio.no"
15331 (| ("subject" "re:.*" "misc")
15332 ("references" ".*@@.*" "misc")
15338 This says that all mail to this address is suspect, but if it has a
15339 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
15340 header, it's probably ok. All the rest goes to the @samp{spam} group.
15341 (This idea probably comes from Tim Pierce.)
15343 In addition, many mail spammers talk directly to your @code{smtp} server
15344 and do not include your email address explicitly in the @code{To}
15345 header. Why they do this is unknown---perhaps it's to thwart this
15346 thwarting scheme? In any case, this is trivial to deal with---you just
15347 put anything not addressed to you in the @samp{spam} group by ending
15348 your fancy split rule in this way:
15353 (to "larsi" "misc")
15357 In my experience, this will sort virtually everything into the right
15358 group. You still have to check the @samp{spam} group from time to time to
15359 check for legitimate mail, though. If you feel like being a good net
15360 citizen, you can even send off complaints to the proper authorities on
15361 each unsolicited commercial email---at your leisure.
15363 If you are also a lazy net citizen, you will probably prefer complaining
15364 automatically with the @file{gnus-junk.el} package, available FOR FREE
15365 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
15366 Since most e-mail spam is sent automatically, this may reconcile the
15367 cosmic balance somewhat.
15369 This works for me. It allows people an easy way to contact me (they can
15370 just press @kbd{r} in the usual way), and I'm not bothered at all with
15371 spam. It's a win-win situation. Forging @code{From} headers to point
15372 to non-existent domains is yucky, in my opinion.
15375 @node Various Various
15376 @section Various Various
15382 @item gnus-home-directory
15383 All Gnus path variables will be initialized from this variable, which
15384 defaults to @file{~/}.
15386 @item gnus-directory
15387 @vindex gnus-directory
15388 Most Gnus storage path variables will be initialized from this variable,
15389 which defaults to the @samp{SAVEDIR} environment variable, or
15390 @file{~/News/} if that variable isn't set.
15392 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
15393 This means that other directory variables that are initialized from this
15394 variable won't be set properly if you set this variable in
15395 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
15397 @item gnus-default-directory
15398 @vindex gnus-default-directory
15399 Not related to the above variable at all---this variable says what the
15400 default directory of all Gnus buffers should be. If you issue commands
15401 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
15402 default directory. If this variable is @code{nil} (which is the
15403 default), the default directory will be the default directory of the
15404 buffer you were in when you started Gnus.
15407 @vindex gnus-verbose
15408 This variable is an integer between zero and ten. The higher the value,
15409 the more messages will be displayed. If this variable is zero, Gnus
15410 will never flash any messages, if it is seven (which is the default),
15411 most important messages will be shown, and if it is ten, Gnus won't ever
15412 shut up, but will flash so many messages it will make your head swim.
15414 @item gnus-verbose-backends
15415 @vindex gnus-verbose-backends
15416 This variable works the same way as @code{gnus-verbose}, but it applies
15417 to the Gnus backends instead of Gnus proper.
15419 @item nnheader-max-head-length
15420 @vindex nnheader-max-head-length
15421 When the backends read straight heads of articles, they all try to read
15422 as little as possible. This variable (default 4096) specifies
15423 the absolute max length the backends will try to read before giving up
15424 on finding a separator line between the head and the body. If this
15425 variable is @code{nil}, there is no upper read bound. If it is
15426 @code{t}, the backends won't try to read the articles piece by piece,
15427 but read the entire articles. This makes sense with some versions of
15428 @code{ange-ftp} or @code{efs}.
15430 @item nnheader-head-chop-length
15431 @vindex nnheader-head-chop-length
15432 This variable (default 2048) says how big a piece of each article to
15433 read when doing the operation described above.
15435 @item nnheader-file-name-translation-alist
15436 @vindex nnheader-file-name-translation-alist
15438 @cindex invalid characters in file names
15439 @cindex characters in file names
15440 This is an alist that says how to translate characters in file names.
15441 For instance, if @samp{:} is invalid as a file character in file names
15442 on your system (you OS/2 user you), you could say something like:
15445 (setq nnheader-file-name-translation-alist
15449 In fact, this is the default value for this variable on OS/2 and MS
15450 Windows (phooey) systems.
15452 @item gnus-hidden-properties
15453 @vindex gnus-hidden-properties
15454 This is a list of properties to use to hide ``invisible'' text. It is
15455 @code{(invisible t intangible t)} by default on most systems, which
15456 makes invisible text invisible and intangible.
15458 @item gnus-parse-headers-hook
15459 @vindex gnus-parse-headers-hook
15460 A hook called before parsing headers. It can be used, for instance, to
15461 gather statistics on the headers fetched, or perhaps you'd like to prune
15462 some headers. I don't see why you'd want that, though.
15464 @item gnus-shell-command-separator
15465 @vindex gnus-shell-command-separator
15466 String used to separate two shell commands. The default is @samp{;}.
15475 Well, that's the manual---you can get on with your life now. Keep in
15476 touch. Say hello to your cats from me.
15478 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
15480 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
15486 Not because of victories @*
15489 but for the common sunshine,@*
15491 the largess of the spring.
15495 but for the day's work done@*
15496 as well as I was able;@*
15497 not for a seat upon the dais@*
15498 but at the common table.@*
15503 @chapter Appendices
15506 * History:: How Gnus got where it is today.
15507 * Terminology:: We use really difficult, like, words here.
15508 * Customization:: Tailoring Gnus to your needs.
15509 * Troubleshooting:: What you might try if things do not work.
15510 * A Programmers Guide to Gnus:: Rilly, rilly technical stuff.
15511 * Emacs for Heathens:: A short introduction to Emacsian terms.
15512 * Frequently Asked Questions:: A question-and-answer session.
15520 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
15521 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
15523 If you want to investigate the person responsible for this outrage, you
15524 can point your (feh!) web browser to
15525 @file{http://www.stud.ifi.uio.no/~larsi/}. This is also the primary
15526 distribution point for the new and spiffy versions of Gnus, and is known
15527 as The Site That Destroys Newsrcs And Drives People Mad.
15529 During the first extended alpha period of development, the new Gnus was
15530 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
15531 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
15532 (Besides, the ``Gnus'' in this abbreviation should probably be
15533 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
15534 appropriate name, don't you think?)
15536 In any case, after spending all that energy on coming up with a new and
15537 spunky name, we decided that the name was @emph{too} spunky, so we
15538 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
15539 ``@sc{gnus}''. New vs. old.
15541 The first ``proper'' release of Gnus 5 was done in November 1995 when it
15542 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
15543 plus 15 Gnus 5.0 releases).
15545 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
15546 releases)) was released under the name ``Gnus 5.2'' (40 releases).
15548 On July 28th 1996 work on Red Gnus was begun, and it was released on
15549 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
15551 On September 13th 1997, Quassia Gnus was started and lasted 37
15552 releases. If was released as ``Gnus 5.6 on March 8th 1998.
15554 If you happen upon a version of Gnus that has a prefixed name --
15555 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
15556 don't panic. Don't let it know that you're frightened. Back away.
15557 Slowly. Whatever you do, don't run. Walk away, calmly, until you're
15558 out of its reach. Find a proper released version of Gnus and snuggle up
15562 * Why?:: What's the point of Gnus?
15563 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
15564 * Conformity:: Gnus tries to conform to all standards.
15565 * Emacsen:: Gnus can be run on a few modern Emacsen.
15566 * Contributors:: Oodles of people.
15567 * New Features:: Pointers to some of the new stuff in Gnus.
15568 * Newest Features:: Features so new that they haven't been written yet.
15575 What's the point of Gnus?
15577 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
15578 newsreader, that lets you do anything you can think of. That was my
15579 original motivation, but while working on Gnus, it has become clear to
15580 me that this generation of newsreaders really belong in the stone age.
15581 Newsreaders haven't developed much since the infancy of the net. If the
15582 volume continues to rise with the current rate of increase, all current
15583 newsreaders will be pretty much useless. How do you deal with
15584 newsgroups that have thousands of new articles each day? How do you
15585 keep track of millions of people who post?
15587 Gnus offers no real solutions to these questions, but I would very much
15588 like to see Gnus being used as a testing ground for new methods of
15589 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
15590 to separate the newsreader from the backends, Gnus now offers a simple
15591 interface for anybody who wants to write new backends for fetching mail
15592 and news from different sources. I have added hooks for customizations
15593 everywhere I could imagine it being useful. By doing so, I'm inviting
15594 every one of you to explore and invent.
15596 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
15597 @kbd{C-u 100 M-x all-hail-xemacs}.
15600 @node Compatibility
15601 @subsection Compatibility
15603 @cindex compatibility
15604 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
15605 bindings have been kept. More key bindings have been added, of course,
15606 but only in one or two obscure cases have old bindings been changed.
15611 @center In a cloud bones of steel.
15615 All commands have kept their names. Some internal functions have changed
15618 The @code{gnus-uu} package has changed drastically. @xref{Decoding
15621 One major compatibility question is the presence of several summary
15622 buffers. All variables relevant while reading a group are
15623 buffer-local to the summary buffer they belong in. Although many
15624 important variables have their values copied into their global
15625 counterparts whenever a command is executed in the summary buffer, this
15626 change might lead to incorrect values being used unless you are careful.
15628 All code that relies on knowledge of @sc{gnus} internals will probably
15629 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
15630 changing it in any way, as a matter of fact) is strictly verboten. Gnus
15631 maintains a hash table that points to the entries in this alist (which
15632 speeds up many functions), and changing the alist directly will lead to
15636 @cindex highlighting
15637 Old hilit19 code does not work at all. In fact, you should probably
15638 remove all hilit code from all Gnus hooks
15639 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
15640 Gnus provides various integrated functions for highlighting. These are
15641 faster and more accurate. To make life easier for everybody, Gnus will
15642 by default remove all hilit calls from all hilit hooks. Uncleanliness!
15645 Packages like @code{expire-kill} will no longer work. As a matter of
15646 fact, you should probably remove all old @sc{gnus} packages (and other
15647 code) when you start using Gnus. More likely than not, Gnus already
15648 does what you have written code to make @sc{gnus} do. (Snicker.)
15650 Even though old methods of doing things are still supported, only the
15651 new methods are documented in this manual. If you detect a new method of
15652 doing something while reading this manual, that does not mean you have
15653 to stop doing it the old way.
15655 Gnus understands all @sc{gnus} startup files.
15657 @kindex M-x gnus-bug
15659 @cindex reporting bugs
15661 Overall, a casual user who hasn't written much code that depends on
15662 @sc{gnus} internals should suffer no problems. If problems occur,
15663 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
15665 @vindex gnus-bug-create-help-buffer
15666 If you are in the habit of sending bug reports @emph{very} often, you
15667 may find the helpful help buffer annoying after a while. If so, set
15668 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
15673 @subsection Conformity
15675 No rebels without a clue here, ma'am. We conform to all standards known
15676 to (wo)man. Except for those standards and/or conventions we disagree
15683 There are no known breaches of this standard.
15687 There are no known breaches of this standard, either.
15689 @item Son-of-RFC 1036
15690 @cindex Son-of-RFC 1036
15691 We do have some breaches to this one.
15696 Gnus does no MIME handling, and this standard-to-be seems to think that
15697 MIME is the bees' knees, so we have major breakage here.
15700 This is considered to be a ``vanity header'', while I consider it to be
15701 consumer information. After seeing so many badly formatted articles
15702 coming from @code{tin} and @code{Netscape} I know not to use either of
15703 those for posting articles. I would not have known that if it wasn't
15704 for the @code{X-Newsreader} header.
15709 If you ever notice Gnus acting non-compliant with regards to the texts
15710 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
15715 @subsection Emacsen
15721 Gnus should work on :
15726 Emacs 19.32 and up.
15729 XEmacs 19.14 and up.
15732 Mule versions based on Emacs 19.32 and up.
15736 Gnus will absolutely not work on any Emacsen older than that. Not
15737 reliably, at least.
15739 There are some vague differences between Gnus on the various
15740 platforms---XEmacs features more graphics (a logo and a toolbar)---but
15741 other than that, things should look pretty much the same under all
15746 @subsection Contributors
15747 @cindex contributors
15749 The new Gnus version couldn't have been done without the help of all the
15750 people on the (ding) mailing list. Every day for over a year I have
15751 gotten billions of nice bug reports from them, filling me with joy,
15752 every single one of them. Smooches. The people on the list have been
15753 tried beyond endurance, what with my ``oh, that's a neat idea <type
15754 type>, yup, I'll release it right away <ship off> no wait, that doesn't
15755 work at all <type type>, yup, I'll ship that one off right away <ship
15756 off> no, wait, that absolutely does not work'' policy for releases.
15757 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
15758 ``worser''? ``much worser''? ``worsest''?)
15760 I would like to take this opportunity to thank the Academy for... oops,
15766 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
15769 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
15770 well as numerous other things).
15773 Luis Fernandes---design and graphics.
15776 Erik Naggum---help, ideas, support, code and stuff.
15779 Wes Hardaker---@file{gnus-picon.el} and the manual section on
15780 @dfn{picons} (@pxref{Picons}).
15783 Kim-Minh Kaplan---further work on the picon code.
15786 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
15787 (@pxref{GroupLens}).
15790 Sudish Joseph---innumerable bug fixes.
15793 Ilja Weis---@file{gnus-topic.el}.
15796 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
15799 Vladimir Alexiev---the refcard and reference booklets.
15802 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
15803 distribution by Felix Lee and JWZ.
15806 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
15809 Peter Mutsaers---orphan article scoring code.
15812 Ken Raeburn---POP mail support.
15815 Hallvard B Furuseth---various bits and pieces, especially dealing with
15819 Brian Edmonds---@file{gnus-bbdb.el}.
15822 David Moore---rewrite of @file{nnvirtual.el} and many other things.
15825 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
15828 Fran
\e,Ag
\e(Bois Pinard---many, many interesting and thorough bug reports, as
15829 well as autoconf support.
15833 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
15834 Borges, and Jost Krieger proof-reading parts of the manual.
15836 The following people have contributed many patches and suggestions:
15841 David K
\e,Ae
\e(Bgedal,
15845 Jason L. Tibbitts, III,
15849 Also thanks to the following for patches and stuff:
15871 Massimo Campostrini,
15879 Geoffrey T. Dairiki,
15885 Michael Welsh Duggan,
15888 Enami Tsugutomo, @c Enami
15892 Nelson Jose dos Santos Ferreira,
15898 Arne Georg Gleditsch,
15900 Michelangelo Grigni,
15903 Kenichi Handa, @c Handa
15905 Yoshiki Hayashi, @c ?
15907 Hisashige Kenji, @c Hisashige
15912 Fran
\e,Ag
\e(Bois Felix Ingrand,
15913 Ishikawa Ichiro, @c Ishikawa
15915 Iwamuro Motonori, @c Iwamuro
15924 Peter Skov Knudsen,
15925 Shuhei Kobayashi, @c Kobayashi
15926 Koseki Yoshinori, @c Koseki
15927 Thor Kristoffersen,
15930 Seokchan Lee, @c Lee
15947 Morioka Tomohiko, @c Morioka
15948 Erik Toubro Nielsen,
15955 Masaharu Onishi, @c Onishi
15959 Jens-Ulrik Holger Petersen,
15962 John McClary Prevost,
15968 Lars Balker Rasmussen,
15973 Christian von Roques,
15975 Wolfgang Rupprecht,
15981 Philippe Schnoebelen,
15983 Randal L. Schwartz,
16012 Katsumi Yamaoka, @c Yamaoka
16014 Shenghuo Zhu. @c Zhu
16016 For a full overview of what each person has done, the ChangeLogs
16017 included in the Gnus alpha distributions should give ample reading
16018 (550kB and counting).
16020 Apologies to everybody that I've forgotten, of which there are many, I'm
16023 Gee, that's quite a list of people. I guess that must mean that there
16024 actually are people who are using Gnus. Who'd'a thunk it!
16028 @subsection New Features
16029 @cindex new features
16032 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
16033 * September Gnus:: The Thing Formally Known As Gnus 5.3/5.3.
16034 * Red Gnus:: Third time best---Gnus 5.4/5.5.
16035 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
16038 These lists are, of course, just @emph{short} overviews of the
16039 @emph{most} important new features. No, really. There are tons more.
16040 Yes, we have feeping creaturism in full effect.
16044 @subsubsection (ding) Gnus
16046 New features in Gnus 5.0/5.1:
16051 The look of all buffers can be changed by setting format-like variables
16052 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
16055 Local spool and several @sc{nntp} servers can be used at once
16056 (@pxref{Select Methods}).
16059 You can combine groups into virtual groups (@pxref{Virtual Groups}).
16062 You can read a number of different mail formats (@pxref{Getting Mail}).
16063 All the mail backends implement a convenient mail expiry scheme
16064 (@pxref{Expiring Mail}).
16067 Gnus can use various strategies for gathering threads that have lost
16068 their roots (thereby gathering loose sub-threads into one thread) or it
16069 can go back and retrieve enough headers to build a complete thread
16070 (@pxref{Customizing Threading}).
16073 Killed groups can be displayed in the group buffer, and you can read
16074 them as well (@pxref{Listing Groups}).
16077 Gnus can do partial group updates---you do not have to retrieve the
16078 entire active file just to check for new articles in a few groups
16079 (@pxref{The Active File}).
16082 Gnus implements a sliding scale of subscribedness to groups
16083 (@pxref{Group Levels}).
16086 You can score articles according to any number of criteria
16087 (@pxref{Scoring}). You can even get Gnus to find out how to score
16088 articles for you (@pxref{Adaptive Scoring}).
16091 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
16092 manner, so it should be difficult to lose much data on what you have
16093 read if your machine should go down (@pxref{Auto Save}).
16096 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
16097 the @file{.emacs} file.
16100 You can set the process mark on both groups and articles and perform
16101 operations on all the marked items (@pxref{Process/Prefix}).
16104 You can grep through a subset of groups and create a group from the
16105 results (@pxref{Kibozed Groups}).
16108 You can list subsets of groups according to, well, anything
16109 (@pxref{Listing Groups}).
16112 You can browse foreign servers and subscribe to groups from those
16113 servers (@pxref{Browse Foreign Server}).
16116 Gnus can fetch articles, asynchronously, on a second connection to the
16117 server (@pxref{Asynchronous Fetching}).
16120 You can cache articles locally (@pxref{Article Caching}).
16123 The uudecode functions have been expanded and generalized
16124 (@pxref{Decoding Articles}).
16127 You can still post uuencoded articles, which was a little-known feature
16128 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
16131 Fetching parents (and other articles) now actually works without
16132 glitches (@pxref{Finding the Parent}).
16135 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
16138 Digests (and other files) can be used as the basis for groups
16139 (@pxref{Document Groups}).
16142 Articles can be highlighted and customized (@pxref{Customizing
16146 URLs and other external references can be buttonized (@pxref{Article
16150 You can do lots of strange stuff with the Gnus window & frame
16151 configuration (@pxref{Windows Configuration}).
16154 You can click on buttons instead of using the keyboard
16160 @node September Gnus
16161 @subsubsection September Gnus
16165 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
16169 New features in Gnus 5.2/5.3:
16174 A new message composition mode is used. All old customization variables
16175 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
16179 Gnus is now able to generate @dfn{sparse} threads---threads where
16180 missing articles are represented by empty nodes (@pxref{Customizing
16184 (setq gnus-build-sparse-threads 'some)
16188 Outgoing articles are stored on a special archive server
16189 (@pxref{Archived Messages}).
16192 Partial thread regeneration now happens when articles are
16196 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
16199 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
16202 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
16205 (setq gnus-use-trees t)
16209 An @code{nn}-like pick-and-read minor mode is available for the summary
16210 buffers (@pxref{Pick and Read}).
16213 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
16217 In binary groups you can use a special binary minor mode (@pxref{Binary
16221 Groups can be grouped in a folding topic hierarchy (@pxref{Group
16225 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
16229 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
16232 Groups can now have a score, and bubbling based on entry frequency
16233 is possible (@pxref{Group Score}).
16236 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
16240 Groups can be process-marked, and commands can be performed on
16241 groups of groups (@pxref{Marking Groups}).
16244 Caching is possible in virtual groups.
16247 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
16248 news batches, ClariNet briefs collections, and just about everything
16249 else (@pxref{Document Groups}).
16252 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
16256 The Gnus cache is much faster.
16259 Groups can be sorted according to many criteria (@pxref{Sorting
16263 New group parameters have been introduced to set list-addresses and
16264 expiry times (@pxref{Group Parameters}).
16267 All formatting specs allow specifying faces to be used
16268 (@pxref{Formatting Fonts}).
16271 There are several more commands for setting/removing/acting on process
16272 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
16275 The summary buffer can be limited to show parts of the available
16276 articles based on a wide range of criteria. These commands have been
16277 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
16280 Articles can be made persistent with the @kbd{*} command
16281 (@pxref{Persistent Articles}).
16284 All functions for hiding article elements are now toggles.
16287 Article headers can be buttonized (@pxref{Article Washing}).
16290 (add-hook 'gnus-article-display-hook
16291 'gnus-article-add-buttons-to-head)
16295 All mail backends support fetching articles by @code{Message-ID}.
16298 Duplicate mail can now be treated properly (@pxref{Duplicates}).
16301 All summary mode commands are available directly from the article
16302 buffer (@pxref{Article Keymap}).
16305 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
16309 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
16312 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
16317 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
16320 (setq gnus-use-nocem t)
16324 Groups can be made permanently visible (@pxref{Listing Groups}).
16327 (setq gnus-permanently-visible-groups "^nnml:")
16331 Many new hooks have been introduced to make customizing easier.
16334 Gnus respects the @code{Mail-Copies-To} header.
16337 Threads can be gathered by looking at the @code{References} header
16338 (@pxref{Customizing Threading}).
16341 (setq gnus-summary-thread-gathering-function
16342 'gnus-gather-threads-by-references)
16346 Read articles can be stored in a special backlog buffer to avoid
16347 refetching (@pxref{Article Backlog}).
16350 (setq gnus-keep-backlog 50)
16354 A clean copy of the current article is always stored in a separate
16355 buffer to allow easier treatment.
16358 Gnus can suggest where to save articles (@pxref{Saving Articles}).
16361 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
16365 (setq gnus-prompt-before-saving t)
16369 @code{gnus-uu} can view decoded files asynchronously while fetching
16370 articles (@pxref{Other Decode Variables}).
16373 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
16377 Filling in the article buffer now works properly on cited text
16378 (@pxref{Article Washing}).
16381 Hiding cited text adds buttons to toggle hiding, and how much
16382 cited text to hide is now customizable (@pxref{Article Hiding}).
16385 (setq gnus-cited-lines-visible 2)
16389 Boring headers can be hidden (@pxref{Article Hiding}).
16392 (add-hook 'gnus-article-display-hook
16393 'gnus-article-hide-boring-headers t)
16397 Default scoring values can now be set from the menu bar.
16400 Further syntax checking of outgoing articles have been added.
16406 @subsubsection Red Gnus
16408 New features in Gnus 5.4/5.5:
16412 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
16419 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
16422 Article prefetching functionality has been moved up into
16423 Gnus (@pxref{Asynchronous Fetching}).
16426 Scoring can now be performed with logical operators like @code{and},
16427 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
16431 Article washing status can be displayed in the
16432 article mode line (@pxref{Misc Article}).
16435 @file{gnus.el} has been split into many smaller files.
16438 Suppression of duplicate articles based on Message-ID can be done
16439 (@pxref{Duplicate Suppression}).
16442 (setq gnus-suppress-duplicates t)
16446 New variables for specifying what score and adapt files are to be
16447 considered home score and adapt files (@pxref{Home Score File}) have
16451 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
16452 Server Internals}).
16455 Groups can inherit group parameters from parent topics (@pxref{Topic
16459 Article editing has been revamped and is now actually usable.
16462 Signatures can be recognized in more intelligent fashions
16463 (@pxref{Article Signature}).
16466 Summary pick mode has been made to look more @code{nn}-like. Line
16467 numbers are displayed and the @kbd{.} command can be used to pick
16468 articles (@code{Pick and Read}).
16471 Commands for moving the @file{.newsrc.eld} from one server to
16472 another have been added (@pxref{Changing Servers}).
16475 There's a way now to specify that ``uninteresting'' fields be suppressed
16476 when generating lines in buffers (@pxref{Advanced Formatting}).
16479 Several commands in the group buffer can be undone with @kbd{M-C-_}
16483 Scoring can be done on words using the new score type @code{w}
16484 (@pxref{Score File Format}).
16487 Adaptive scoring can be done on a Subject word-by-word basis
16488 (@pxref{Adaptive Scoring}).
16491 (setq gnus-use-adaptive-scoring '(word))
16495 Scores can be decayed (@pxref{Score Decays}).
16498 (setq gnus-decay-scores t)
16502 Scoring can be performed using a regexp on the Date header. The Date is
16503 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
16506 A new command has been added to remove all data on articles from
16507 the native server (@pxref{Changing Servers}).
16510 A new command for reading collections of documents
16511 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
16512 (@pxref{Really Various Summary Commands}).
16515 Process mark sets can be pushed and popped (@pxref{Setting Process
16519 A new mail-to-news backend makes it possible to post even when the NNTP
16520 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
16523 A new backend for reading searches from Web search engines
16524 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
16525 (@pxref{Web Searches}).
16528 Groups inside topics can now be sorted using the standard sorting
16529 functions, and each topic can be sorted independently (@pxref{Topic
16533 Subsets of the groups can be sorted independently (@code{Sorting
16537 Cached articles can be pulled into the groups (@pxref{Summary Generation
16541 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
16546 Score files are now applied in a more reliable order (@pxref{Score
16550 Reports on where mail messages end up can be generated (@pxref{Splitting
16554 More hooks and functions have been added to remove junk from incoming
16555 mail before saving the mail (@pxref{Washing Mail}).
16558 Emphasized text can be properly fontisized:
16561 (add-hook 'gnus-article-display-hook
16562 'gnus-article-emphasize)
16569 @subsubsection Quassia Gnus
16571 New features in Gnus 5.6:
16576 New functionality for using Gnus as an offline newsreader has been
16577 added. A plethora of new commands and modes have been added. See
16578 @pxref{Gnus Unplugged} for the full story.
16581 The @code{nndraft} backend has returned, but works differently than
16582 before. All Message buffers are now also articles in the @code{nndraft}
16583 group, which is created automatically.
16586 @code{gnus-alter-header-function} can now be used to alter header
16590 @code{gnus-summary-goto-article} now accept Message-ID's.
16593 A new Message command for deleting text in the body of a message
16594 outside the region: @kbd{C-c C-v}.
16597 You can now post to component group in @code{nnvirtual} groups with
16601 @code{nntp-rlogin-program}---new variable to ease customization.
16604 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
16605 re-highlighting of the article buffer.
16608 New element in @code{gnus-boring-article-headers}---@code{long-to}.
16611 @kbd{M-i} symbolic prefix command. See the section "Symbolic
16612 Prefixes" in the Gnus manual for details.
16615 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
16616 @kbd{a} to add the score rule to the "all.SCORE" file.
16619 @code{gnus-simplify-subject-functions} variable to allow greater
16620 control over simplification.
16623 @kbd{A T}---new command for fetching the current thread.
16626 @kbd{/ T}---new command for including the current thread in the
16630 @kbd{M-RET} is a new Message command for breaking cited text.
16633 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
16636 The @code{custom-face-lookup} function has been removed.
16637 If you used this function in your initialization files, you must
16638 rewrite them to use @code{face-spec-set} instead.
16641 Canceling now uses the current select method. Symbolic prefix
16642 @kbd{a} forces normal posting method.
16645 New command to translate M******** sm*rtq**t*s into proper
16649 For easier debugging of @code{nntp}, you can set
16650 @code{nntp-record-commands} to a non-@code{nil} value.
16653 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
16654 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
16657 A command for editing group parameters from the summary buffer
16661 A history of where mails have been split is available.
16664 A new article date command has been added---@code{article-date-iso8601}.
16667 Subjects can be simplified when threading by setting
16668 @code{gnus-score-thread-simplify}.
16671 A new function for citing in Message has been
16672 added---@code{message-cite-original-without-signature}.
16675 @code{article-strip-all-blank-lines}---new article command.
16678 A new Message command to kill to the end of the article has
16682 A minimum adaptive score can be specified by using the
16683 @code{gnus-adaptive-word-minimum} variable.
16686 The "lapsed date" article header can be kept continually
16687 updated by the @code{gnus-start-date-timer} command.
16690 Web listserv archives can be read with the @code{nnlistserv} backend.
16693 Old dejanews archives can now be read by @code{nnweb}.
16698 @node Newest Features
16699 @subsection Newest Features
16702 Also known as the @dfn{todo list}. Sure to be implemented before the
16705 Be afraid. Be very afraid.
16707 (That a feature appears in this list doesn't necessarily mean that I've
16708 decided to actually implement it. It just means that I think it sounds
16711 (Yes, this is the actual, up-to-the-second todo list.)
16716 Native @sc{mime} support is something that should be done.
16719 Really do unbinhexing.
16722 I would like the zombie-page to contain an URL to the source of the
16723 latest version of gnus or some explanation on where to find it.
16726 A way to continue editing the latest Message composition.
16729 http://www.sonicnet.com/feature/ari3/
16732 facep is not declared.
16735 Include a section in the manual on why the number of articles
16736 isn't the same in the group buffer and on the SPC prompt.
16739 Interacting with rmail fcc isn't easy.
16744 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
16745 <URL:http://www.eit.com/software/hypermail/hypermail.html>
16746 <URL:http://homer.ncm.com/>
16747 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
16748 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
16749 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
16750 http://www.miranova.com/gnus-list/
16755 @samp{^-- } is made into - in LaTeX.
16758 gnus-kill is much slower than it was in GNUS 4.1.3.
16761 when expunging articles on low score, the sparse nodes keep hanging on?
16763 starting the first time seems to hang Gnus on some systems. Does
16764 NEWGROUPS answer too fast?
16766 nndir doesn't read gzipped files.
16768 FAQ doesn't have an up node?
16770 when moving mail from a procmail spool to the crash-box,
16771 the crash-box is only appropriate to one specific group.
16773 `t' `t' makes X-Faces disappear.
16775 nnmh-be-safe means that crossposted articles will
16776 be marked as unread.
16778 Orphan score entries don't show on "V t" score trace
16780 when clearing out data, the cache data should also be reset.
16782 rewrite gnus-summary-limit-children to be non-recursive
16783 to avoid exceeding lisp nesting on huge groups.
16785 expunged articles are counted when computing scores.
16787 implement gnus-batch-brew-soup
16789 ticked articles aren't easy to read in pick mode -- `n' and
16790 stuff just skips past them. Read articles are the same.
16792 topics that contain just groups with ticked
16793 articles aren't displayed.
16795 nndoc should always allocate unique Message-IDs.
16797 If there are mail groups the first time you use Gnus, Gnus'll
16798 make the mail groups killed.
16800 no "no news is good news" when using topics.
16802 when doing crosspost marking, the cache has to be consulted
16803 and articles have to be removed.
16805 nnweb should fetch complete articles when they are split into several
16808 scoring on head immediate doesn't work.
16810 finding short score file names takes forever.
16812 canceling articles in foreign groups.
16814 nntp-open-rlogin no longer works.
16816 C-u C-x C-s (Summary) switches to the group buffer.
16818 move nnmail-split-history out to the backends.
16820 nnweb doesn't work properly.
16822 using a virtual server name as `gnus-select-method' doesn't work?
16824 when killing/yanking a group from one topic to another in a slave, the
16825 master will yank it first to one topic and then add it to another.
16829 warn user about `=' redirection of a group in the active file?
16831 really unbinhex binhex files.
16833 take over the XEmacs menubar and offer a toggle between the XEmacs
16834 bar and the Gnus bar.
16837 push active file and NOV file parsing down into C code.
16838 `(canonize-message-id id)'
16839 `(mail-parent-message-id references n)'
16840 `(parse-news-nov-line &optional dependency-hashtb)'
16841 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
16842 `(parse-news-active-region beg end hashtb)'
16847 nnml .overview directory with splits.
16851 postponed commands.
16853 the selected article show have its Subject displayed in its summary line.
16855 when entering groups, get the real number of unread articles from
16858 sort after gathering threads -- make false roots have the
16859 headers of the oldest orphan with a 0 article number?
16861 nndoc groups should inherit the score files of their parents? Also
16862 inherit copy prompts and save files.
16864 command to start up Gnus (if not running) and enter a mail mode buffer.
16866 allow editing the group description from the group buffer
16867 for backends that support that.
16869 gnus-hide,show-all-topics
16871 groups and sub-topics should be allowed to mingle inside each topic,
16872 and not just list all subtopics at the end.
16874 a command to remove all read articles that are not needed to connect
16875 threads -- `gnus-summary-limit-to-sparse-unread'?
16877 a variable to turn off limiting/cutting of threads in the tree buffer.
16879 a variable to limit how many files are uudecoded.
16881 add zombie groups to a special "New Groups" topic.
16883 server mode command: close/open all connections
16885 put a file date in gnus-score-alist and check whether the file
16886 has been changed before using it.
16888 on exit from a digest group, go to the next article in the parent group.
16890 hide (sub)threads with low score.
16892 when expiring, remove all marks from expired articles.
16894 gnus-summary-limit-to-body
16896 a regexp alist that says what level groups are to be subscribed
16897 on. Eg. -- `(("nnml:" . 1))'.
16899 easier interface to nnkiboze to create ephemeral groups that
16900 contain groups that match a regexp.
16902 allow newlines in <URL:> urls, but remove them before using
16905 If there is no From line, the mail backends should fudge one from the
16908 fuzzy simplifying should strip all non-alpha-numerical info
16909 from subject lines.
16911 gnus-soup-brew-soup-with-high-scores.
16913 nntp-ping-before-connect
16915 command to check whether NOV is evil. "list overview.fmt".
16917 when entering a group, Gnus should look through the score
16918 files very early for `local' atoms and set those local variables.
16920 message annotations.
16922 topics are always yanked before groups, and that's not good.
16924 (set-extent-property extent 'help-echo "String to display in minibuf")
16925 to display help in the minibuffer on buttons under XEmacs.
16927 allow group line format spec to say how many articles there
16932 support qmail maildir spools
16934 `run-with-idle-timer' in gnus-demon.
16936 stop using invisible text properties and start using overlays instead
16938 C-c C-f C-e to add an Expires header.
16940 go from one group to the next; everything is expunged; go to the
16941 next group instead of going to the group buffer.
16943 gnus-renumber-cache -- to renumber the cache using "low" numbers.
16945 record topic changes in the dribble buffer.
16947 `nnfolder-generate-active-file' should look at the folders it
16948 finds and generate proper active ranges.
16950 nneething-look-in-files-for-article-heads variable to control
16951 whether nneething should sniff all files in the directories.
16953 gnus-fetch-article -- start Gnus, enter group, display article
16955 gnus-dont-move-articles-to-same-group variable when respooling.
16957 when messages are crossposted between several auto-expirable groups,
16958 articles aren't properly marked as expirable.
16960 nneething should allow deletion/moving.
16962 TAB on the last button should go to the first button.
16964 if the car of an element in `mail-split-methods' is a function,
16965 and the function returns non-nil, use that as the name of the group(s) to
16968 command for listing all score files that have been applied.
16970 a command in the article buffer to return to `summary' config.
16972 `gnus-always-post-using-current-server' -- variable to override
16973 `C-c C-c' when posting.
16975 nnmail-group-spool-alist -- says where each group should use
16978 when an article is crossposted to an auto-expirable group, the article
16979 should be marker as expirable.
16981 article mode command/menu for "send region as URL to browser".
16983 on errors, jump to info nodes that explain the error. For instance,
16984 on invalid From headers, or on error messages from the nntp server.
16986 when gathering threads, make the article that has no "Re: " the parent.
16987 Also consult Date headers.
16989 a token in splits to call shrink-window-if-larger-than-buffer
16991 `1 0 A M' to do matches on the active hashtb.
16993 duplicates -- command to remove Gnus-Warning header, use the read
16994 Message-ID, delete the "original".
16996 when replying to several messages at once, put the "other" message-ids
16997 into a See-Also header.
16999 support setext: URL:http://www.bsdi.com/setext/
17001 support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
17003 when browsing a foreign server, the groups that are already subscribed
17004 should be listed as such and not as "K".
17006 generate font names dynamically.
17008 score file mode auto-alist.
17010 allow nndoc to change/add/delete things from documents. Implement
17011 methods for each format for adding an article to the document.
17013 `gnus-fetch-old-headers' `all' value to incorporate
17014 absolutely all headers there is.
17016 function like `|', but concatenate all marked articles
17017 and pipe them to the process.
17019 cache the list of killed (or active) groups in a separate file. Update
17020 the file whenever we read the active file or the list
17021 of killed groups in the .eld file reaches a certain length.
17023 function for starting to edit a file to put into
17024 the current mail group.
17026 score-find-trace should display the total score of the article.
17028 "ghettozie" -- score on Xref header and nix it out after using it
17029 to avoid marking as read in other groups it has been crossposted to.
17031 look at procmail splitting. The backends should create
17032 the groups automatically if a spool file exists for that group.
17034 function for backends to register themselves with Gnus.
17036 when replying to several process-marked articles,
17037 have all the From end up in Cc headers? Variable to toggle.
17039 command to delete a crossposted mail article from all
17040 groups it has been mailed to.
17042 `B c' and `B m' should be crosspost aware.
17044 hide-pgp should also hide PGP public key blocks.
17046 Command in the group buffer to respool process-marked groups.
17048 `gnus-summary-find-matching' should accept
17049 pseudo-"headers" like "body", "head" and "all"
17051 When buttifying <URL: > things, all white space (including
17052 newlines) should be ignored.
17054 Process-marking all groups in a topic should process-mark
17055 groups in subtopics as well.
17057 Add non-native groups to the list of killed groups when killing them.
17059 nntp-suggest-kewl-config to probe the nntp server and suggest
17062 add edit and forward secondary marks.
17064 nnml shouldn't visit its .overview files.
17066 allow customizing sorting within gathered threads.
17068 `B q' shouldn't select the current article.
17070 nnmbox should support a newsgroups file for descriptions.
17072 allow fetching mail from several pop servers.
17074 Be able to specify whether the saving commands save the original
17075 or the formatted article.
17077 a command to reparent with the child process-marked (cf. `T ^'.).
17079 I think the possibility to send a password with nntp-open-rlogin
17080 should be a feature in Red Gnus.
17082 The `Z n' command should be possible to execute from a mouse click.
17084 more limiting functions -- date, etc.
17086 be able to limit on a random header; on body; using reverse matches.
17088 a group parameter (`absofucking-total-expiry') that will make Gnus expire
17089 even unread articles.
17091 a command to print the article buffer as postscript.
17093 variable to disable password fetching when opening by nntp-open-telnet.
17095 manual: more example servers -- nntp with rlogin, telnet
17097 checking for bogus groups should clean topic alists as well.
17099 canceling articles in foreign groups.
17101 article number in folded topics isn't properly updated by
17104 Movement in the group buffer to the next unread group should go to the
17105 next closed topic with unread messages if no group can be found.
17107 Extensive info pages generated on the fly with help everywhere --
17108 in the "*Gnus edit*" buffers, for instance.
17110 Topic movement commands -- like thread movement. Up, down, forward, next.
17112 a way to tick/mark as read Gcc'd articles.
17114 a way to say that all groups within a specific topic comes
17115 from a particular server? Hm.
17117 `gnus-article-fill-if-long-lines' -- a function to fill
17118 the article buffer if there are any looong lines there.
17120 `T h' should jump to the parent topic and fold it.
17122 a command to create an ephemeral nndoc group out of a file,
17123 and then splitting it/moving it to some other group/backend.
17125 a group parameter for nnkiboze groups that says that
17126 all kibozed articles should be entered into the cache.
17128 It should also probably be possible to delimit what
17129 `gnus-jog-cache' does -- for instance, work on just some groups, or on
17130 some levels, and entering just articles that have a score higher than
17133 nnfolder should append to the folder instead of re-writing
17134 the entire folder to disk when accepting new messages.
17136 allow all backends to do the proper thing with .gz files.
17138 a backend for reading collections of babyl files nnbabylfolder?
17140 a command for making the native groups into foreign groups.
17142 server mode command for clearing read marks from all groups
17145 when following up multiple articles, include all To, Cc, etc headers
17148 a command for deciding what the total score of the current
17149 thread is. Also a way to highlight based on this.
17151 command to show and edit group scores
17153 a gnus-tree-minimize-horizontal to minimize tree buffers
17156 command to generate nnml overview file for one group.
17158 `C-u C-u a' -- prompt for many crossposted groups.
17160 keep track of which mail groups have received new articles (in this session).
17161 Be able to generate a report and perhaps do some marking in the group
17164 gnus-build-sparse-threads to a number -- build only sparse threads
17165 that are of that length.
17167 have nnmh respect mh's unseen sequence in .mh_profile.
17169 cache the newsgroups descriptions locally.
17171 asynchronous posting under nntp.
17173 be able to control word adaptive scoring from the score files.
17175 a variable to make `C-c C-c' post using the "current" select method.
17177 `limit-exclude-low-scored-articles'.
17179 if `gnus-summary-show-thread' is a number, hide threads that have
17180 a score lower than this number.
17182 split newsgroup subscription variable up into "order" and "method".
17184 buttonize ange-ftp file names.
17186 a command to make a duplicate copy of the current article
17187 so that each copy can be edited separately.
17189 nnweb should allow fetching from the local nntp server.
17191 record the sorting done in the summary buffer so that
17192 it can be repeated when limiting/regenerating the buffer.
17194 nnml-generate-nov-databses should generate for
17197 when the user does commands in the group buffer, check
17198 the modification time of the .newsrc.eld file and use
17199 ask-user-about-supersession-threat. Also warn when trying
17200 to save .newsrc.eld and it has changed.
17202 M-g on a topic will display all groups with 0 articles in
17205 command to remove all topic stuff.
17207 allow exploding incoming digests when reading incoming mail
17208 and splitting the resulting digests.
17210 nnsoup shouldn't set the `message-' variables.
17212 command to nix out all nnoo state information.
17214 nnmail-process-alist that calls functions if group names
17215 matches an alist -- before saving.
17217 use buffer-invisibility-spec everywhere for hiding text.
17219 variable to activate each group before entering them
17220 to get the (new) number of articles. `gnus-activate-before-entering'.
17222 command to fetch a Message-ID from any buffer, even
17223 starting Gnus first if necessary.
17225 when posting and checking whether a group exists or not, just
17226 ask the nntp server instead of relying on the active hashtb.
17228 buttonize the output of `C-c C-a' in an apropos-like way.
17230 `G p' should understand process/prefix, and allow editing
17231 of several groups at once.
17233 command to create an ephemeral nnvirtual group that
17234 matches some regexp(s).
17236 nndoc should understand "Content-Type: message/rfc822" forwarded messages.
17238 it should be possible to score "thread" on the From header.
17240 hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
17242 `B i' should display the article at once in the summary buffer.
17244 remove the "*" mark at once when unticking an article.
17246 `M-s' should highlight the matching text.
17248 when checking for duplicated mails, use Resent-Message-ID if present.
17250 killing and yanking groups in topics should be better. If killing one copy
17251 of a group that exists in multiple topics, only that copy should
17252 be removed. Yanking should insert the copy, and yanking topics
17253 should be possible to be interspersed with the other yankings.
17255 command for enter a group just to read the cached articles. A way to say
17256 "ignore the nntp connection; just read from the cache."
17258 `X u' should decode base64 articles.
17260 a way to hide all "inner" cited text, leaving just the most
17261 recently cited text.
17263 nnvirtual should be asynchronous.
17265 after editing an article, gnus-original-article-buffer should
17268 there should probably be a way to make Gnus not connect to the
17269 server and just read the articles in the server
17271 allow a `set-default' (or something) to change the default
17272 value of nnoo variables.
17274 a command to import group infos from a .newsrc.eld file.
17276 groups from secondary servers have the entire select method
17277 listed in each group info.
17279 a command for just switching from the summary buffer to the group
17282 a way to specify that some incoming mail washing functions
17283 should only be applied to some groups.
17285 Message `C-f C-t' should ask the user whether to heed
17286 mail-copies-to: never.
17288 new group parameter -- `post-to-server' that says to post
17289 using the current server. Also a variable to do the same.
17291 the slave dribble files should autosave to the slave file names.
17293 a group parameter that says what articles to display on group entry, based
17296 a way to visually distinguish slave Gnusae from masters. (Whip instead
17299 Use DJ Bernstein "From " quoting/dequoting, where applicable.
17301 Why is hide-citation-maybe and hide-citation different? Also
17304 group user-defined meta-parameters.
17308 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
17310 I like the option for trying to retrieve the FAQ for a group and I was
17311 thinking it would be great if for those newsgroups that had archives
17312 you could also try to read the archive for that group. Part of the
17313 problem is that archives are spread all over the net, unlike FAQs.
17314 What would be best I suppose is to find the one closest to your site.
17316 In any case, there is a list of general news group archives at @*
17317 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
17324 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
17325 (add-hook 'gnus-select-group-hook
17327 (gnus-group-add-parameter group
17328 (cons 'gnus-group-date-last-entered (list (current-time-string))))))
17330 (defun gnus-user-format-function-d (headers)
17331 "Return the date the group was last read."
17332 (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
17337 tanken var at n
\e,Ae
\e(Br du bruker `gnus-startup-file' som prefix (FOO) til ilete
17338 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den v
\e,Af
\e(Bre en
17339 liste hvor du bruker hvert element i listen som FOO, istedet. da kunne man
17340 hatt forskjellige serveres startup-filer forskjellige steder.
17344 LMI> Well, nnbabyl could alter the group info to heed labels like
17345 LMI> answered and read, I guess.
17347 It could also keep them updated (the same for the Status: header of
17350 They could be used like this:
17354 `M l <name> RET' add label <name> to current message.
17355 `M u <name> RET' remove label <name> from current message.
17356 `/ l <expr> RET' limit summary buffer according to <expr>.
17358 <expr> would be a boolean expression on the labels, e.g.
17360 `/ l bug & !fixed RET'
17363 would show all the messages which are labeled `bug' but not labeled
17366 One could also imagine the labels being used for highlighting, or
17367 affect the summary line format.
17371 Sender: abraham@@dina.kvl.dk
17373 I'd like a gnus-find-file which work like find file, except that it
17374 would recognize things that looks like messages or folders:
17376 - If it is a directory containing numbered files, create an nndir
17379 - For other directories, create a nneething summary buffer.
17381 - For files matching "\\`From ", create a nndoc/mbox summary.
17383 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
17385 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
17387 - For other files, just find them normally.
17389 I'd like `nneething' to use this function, so it would work on a
17390 directory potentially containing mboxes or babyl files.
17393 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
17394 tell him what you are doing.
17397 Currently, I get prompted:
17401 decend into sci.something ?
17405 The problem above is that since there is really only one subsection of
17406 science, shouldn't it prompt you for only descending sci.something? If
17407 there was a sci.somethingelse group or section, then it should prompt
17408 for sci? first the sci.something? then sci.somethingelse?...
17411 Ja, det burde v
\e,Af
\e(Bre en m
\e,Ae
\e(Bte
\e,Ae
\e(B si slikt. Kanskje en ny variabel?
17412 `gnus-use-few-score-files'? S
\e,Ae
\e(B kunne score-regler legges til den
17413 "mest" lokale score-fila. F. eks. ville no-gruppene betjenes av
17414 "no.all.SCORE", osv.
17417 What i want is for Gnus to treat any sequence or combination of the following
17418 as a single spoiler warning and hide it all, replacing it with a "Next Page"
17424 more than n blank lines
17426 more than m identical lines
17427 (which should be replaced with button to show them)
17429 any whitespace surrounding any of the above
17433 Well, we could allow a new value to `gnus-thread-ignore-subject' --
17434 `spaces', or something. (We could even default to that.) And then
17435 subjects that differ in white space only could be considered the
17436 "same" subject for threading purposes.
17439 Modes to preprocess the contents (e.g. jka-compr) use the second form
17440 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
17441 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
17442 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
17445 Under XEmacs -- do funny article marks:
17448 soup - bowl of soup
17449 score below - dim light bulb
17450 score over - bright light bulb
17453 Yes. I think the algorithm is as follows:
17458 show-list-of-articles-in-group
17459 if (key-pressed == SPACE)
17460 if (no-more-articles-in-group-to-select)
17461 if (articles-selected)
17462 start-reading-selected-articles;
17463 junk-unread-articles;
17468 else if (key-pressed = '.')
17469 if (consolidated-menus) # same as hide-thread in Gnus
17470 select-thread-under-cursor;
17472 select-article-under-cursor;
17476 if (key-pressed == SPACE)
17477 if (more-pages-in-article)
17479 else if (more-selected-articles-to-read)
17486 My precise need here would have been to limit files to Incoming*.
17487 One could think of some `nneething-only-files' variable, but I guess
17488 it would have been unacceptable if one was using many unrelated such
17491 A more useful approach would be to, in response to the `G D' prompt, be
17492 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
17493 the top-level directory only (in case directories would be matched by
17494 the wildcard expression).
17497 It would be nice if it also handled
17499 <URL:news://sunsite.auc.dk/>
17501 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
17506 Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
17507 really well. Each menu is 'named' by a symbol that would be on a
17508 gnus-*-menus (where * would be whatever, but at least group, summary, and
17509 article versions) variable.
17511 So for gnus-summary-menus, I would set to '(sort mark dispose ...)
17513 A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
17514 the main menubar. This approach works really well for Emacs-W3 and VM.
17518 nndoc should take care to create unique Message-IDs for all its
17521 gnus-score-followup-article only works when you have a summary buffer
17522 active. Make it work when posting from the group buffer as well.
17523 (message-sent-hook).
17525 rewrite gnus-demon to use run-with-idle-timers.
17528 * Enhancements to Gnus:
17532 * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
17533 straight to the server buffer, without opening any connections to
17536 * gnus-server-read-server-newsrc--produces a buffer very similar to
17537 the group buffer, but with only groups from that server listed;
17538 quitting this buffer returns to the server buffer.
17541 add a command to check the integrity of an nnfolder folder --
17542 go through the article numbers and see that there are no duplicates,
17546 `unsmileyfy-buffer' to undo smileification.
17549 a command to give all relevant info on an article, including all
17553 when doing `-request-accept-article', the backends should do
17554 the nnmail duplicate checking.
17557 allow `message-signature-file' to be a function to return the
17558 value of the signature file.
17561 In addition, I would love it if I could configure message-tab so that it
17562 could call `bbdb-complete-name' in other headers. So, some sort of
17565 (setq message-tab-alist
17566 '((message-header-regexp message-expand-group)
17567 ("^\\(To\\|[cC]c\\|[bB]cc\\)" bbdb-complete-name)))
17569 then you could run the relevant function to complete the information in
17573 cache the newsgroups file locally to avoid reloading it all the time.
17576 a command to import a buffer into a group.
17579 nnweb should allow fetching by Message-ID from servers.
17582 point in the article buffer doesn't always go to the
17583 beginning of the buffer when selecting new articles.
17586 a command to process mark all unread articles.
17589 `gnus-gather-threads-by-references-and-subject' -- first
17590 do gathering by references, and then go through the dummy roots and
17591 do more gathering by subject.
17594 gnus-uu-mark-in-numerical-order -- process mark articles in
17595 article numerical order.
17598 (gnus-thread-total-score
17599 (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
17603 sorting by score is wrong when using sparse threads.
17606 a command to fetch an arbitrary article -- without having to be
17607 in the summary buffer.
17610 a new nncvs backend. Each group would show an article, using
17611 version branches as threading, checkin date as the date, etc.
17614 http://www.dejanews.com/forms/dnsetfilter_exp.html ?
17615 This filter allows one to construct advance queries on the Dejanews
17616 database such as specifying start and end dates, subject, author,
17617 and/or newsgroup name.
17620 new Date header scoring type -- older, newer
17623 use the summary toolbar in the article buffer.
17626 a command to fetch all articles that are less than X days old.
17629 in pick mode, `q' should save the list of selected articles in the
17630 group info. The next time the group is selected, these articles
17631 will automatically get the process mark.
17634 Isn't it possible to (also?) allow M-^ to automatically try the
17635 default server if it fails on the current server? (controlled by a
17636 user variable, (nil, t, 'ask)).
17639 make it possible to cancel articles using the select method for the
17643 `gnus-summary-select-article-on-entry' or something. It'll default
17644 to t and will select whatever article decided by `gnus-auto-select-first'.
17647 a new variable to control which selection commands should be unselecting.
17648 `first', `best', `next', `prev', `next-unread', `prev-unread' are
17652 be able to select groups that have no articles in them
17653 to be able to post in them (using the current select method).
17656 be able to post via DejaNews.
17659 `x' should retain any sortings that have been performed.
17662 allow the user to specify the precedence of the secondary marks. Also
17663 allow them to be displayed separately.
17666 gnus-summary-save-in-pipe should concatenate the results from
17667 the processes when doing a process marked pipe.
17670 a new match type, like Followup, but which adds Thread matches on all
17671 articles that match a certain From header.
17674 a function that can be read from kill-emacs-query-functions to offer
17675 saving living summary buffers.
17678 a function for selecting a particular group which will contain
17679 the articles listed in a list of article numbers/id's.
17682 a battery of character translation functions to translate common
17683 Mac, MS (etc) characters into ISO 8859-1.
17686 (defun article-fix-m$word ()
17687 "Fix M$Word smartquotes in an article."
17690 (let ((buffer-read-only nil))
17691 (goto-char (point-min))
17692 (while (search-forward "\221" nil t)
17693 (replace-match "`" t t))
17694 (goto-char (point-min))
17695 (while (search-forward "\222" nil t)
17696 (replace-match "'" t t))
17697 (goto-char (point-min))
17698 (while (search-forward "\223" nil t)
17699 (replace-match "\"" t t))
17700 (goto-char (point-min))
17701 (while (search-forward "\224" nil t)
17702 (replace-match "\"" t t)))))
17707 (add-hook 'gnus-exit-query-functions
17709 (if (and (file-exists-p nnmail-spool-file)
17710 (> (nnheader-file-size nnmail-spool-file) 0))
17711 (yes-or-no-p "New mail has arrived. Quit Gnus anyways? ")
17712 (y-or-n-p "Are you sure you want to quit Gnus? "))))
17716 allow message-default-headers to be a function.
17719 new Date score match types -- < > = (etc) that take floating point
17720 numbers and match on the age of the article.
17724 > > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
17725 > > > under xemacs-19.14, it's creating a new frame, but is erasing the
17726 > > > buffer in the frame that it was called from =:-O
17728 > > Hm. How do you start up Gnus? From the toolbar or with
17729 > > `M-x gnus-other-frame'?
17731 > I normally start it up from the toolbar; at
17732 > least that's the way I've caught it doing the
17737 all commands that react to the process mark should push
17738 the current process mark set onto the stack.
17741 gnus-article-hide-pgp
17742 Selv ville jeg nok ha valgt islette den dersom teksten matcher
17744 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
17746 og det er maks hundre tegn mellom match-end og ----linja. Men -det-
17747 er min type heuristikk og langt fra alles.
17750 `gnus-subscribe-sorted' -- insert new groups where they would have been
17751 sorted to if `gnus-group-sort-function' were run.
17754 gnus-(group,summary)-highlight should respect any `face' text props set
17758 use run-with-idle-timer for gnus-demon instead of the
17759 home-brewed stuff for better reliability.
17762 add a way to select which NoCeM type to apply -- spam, troll, etc.
17765 nndraft-request-group should tally autosave files.
17768 implement nntp-retry-on-break and nntp-command-timeout.
17771 gnus-article-highlight-limit that says when not to highlight (long)
17775 (nnoo-set SERVER VARIABLE VALUE)
17781 interrupitng agent fetching of articles should save articles.
17784 command to open a digest group, and copy all the articles there to the
17788 a variable to disable article body highlights if there's more than
17789 X characters in the body.
17792 handle 480/381 authinfo requests separately.
17795 include the texi/dir file in the distribution.
17798 format spec to "tab" to a position.
17801 Move all prompting to the new `M-n' default style.
17804 command to display all dormant articles.
17807 gnus-auto-select-next makeover -- list of things it should do.
17810 a score match type that adds scores matching on From if From has replied
17811 to something someone else has said.
17814 Read Netscape discussion groups:
17815 snews://secnews.netscape.com/netscape.communicator.unix
17818 One command to edit the original version if an article, and one to edit
17819 the displayed version.
17822 @kbd{T v} -- make all process-marked articles the children of the
17826 Switch from initial text to the new default text mechanism.
17829 How about making it possible to expire local articles? Will it be
17830 possible to make various constraints on when an article can be
17831 expired, e.g. (read), (age > 14 days), or the more interesting (read
17835 New limit command---limit to articles that have a certain string
17836 in the head or body.
17839 Allow breaking lengthy NNTP commands.
17842 gnus-article-highlight-limit, to disable highlighting in big articles.
17845 Editing an article should put the article to be edited
17846 in a special, unique buffer.
17849 A command to send a mail to the admin-address group param.
17852 A Date scoring type that will match if the article
17853 is less than a certain number of days old.
17856 New spec: %~(tab 56) to put point on column 56
17859 Allow Gnus Agent scoring to use normal score files.
17862 Rething the Agent active file thing. `M-g' doesn't update the active
17863 file, for instance.
17866 With dummy roots, `^' and then selecing the first article
17867 in any other dummy thread will make gnus highlight the
17868 dummy root instead of the first article.
17871 Propagate all group properties (marks, article numbers, etc) up to the
17872 topics for displaying.
17875 `n' in the group buffer with topics should go to the next group
17876 with unread articles, even if that group is hidden in a topic.
17879 gnus-posting-styles doesn't work in drafts.
17882 gnus-summary-limit-include-cached is slow when there are
17883 many articles in the cache, since it regenerates big parts of the
17884 summary buffer for each article.
17887 Implement gnus-batch-brew-soup.
17890 Group parameters and summary commands for un/subscribing to mailing
17894 Introduce nnmail-home-directory.
17897 gnus-fetch-group and friends should exit Gnus when the user
17901 Solve the halting problem.
17910 @section The Manual
17914 This manual was generated from a TeXinfo file and then run through
17915 either @code{texi2dvi}
17917 or my own home-brewed TeXinfo to \LaTeX\ transformer,
17918 and then run through @code{latex} and @code{dvips}
17920 to get what you hold in your hands now.
17922 The following conventions have been used:
17927 This is a @samp{string}
17930 This is a @kbd{keystroke}
17933 This is a @file{file}
17936 This is a @code{symbol}
17940 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
17944 (setq flargnoze "yes")
17947 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
17950 (setq flumphel 'yes)
17953 @samp{yes} and @code{yes} are two @emph{very} different things---don't
17954 ever get them confused.
17958 Of course, everything in this manual is of vital interest, so you should
17959 read it all. Several times. However, if you feel like skimming the
17960 manual, look for that gnu head you should see in the margin over
17961 there---it means that what's being discussed is of more importance than
17962 the rest of the stuff. (On the other hand, if everything is infinitely
17963 important, how can anything be more important than that? Just one more
17964 of the mysteries of this world, I guess.)
17972 @section Terminology
17974 @cindex terminology
17979 This is what you are supposed to use this thing for---reading news.
17980 News is generally fetched from a nearby @sc{nntp} server, and is
17981 generally publicly available to everybody. If you post news, the entire
17982 world is likely to read just what you have written, and they'll all
17983 snigger mischievously. Behind your back.
17987 Everything that's delivered to you personally is mail. Some news/mail
17988 readers (like Gnus) blur the distinction between mail and news, but
17989 there is a difference. Mail is private. News is public. Mailing is
17990 not posting, and replying is not following up.
17994 Send a mail to the person who has written what you are reading.
17998 Post an article to the current newsgroup responding to the article you
18003 Gnus gets fed articles from a number of backends, both news and mail
18004 backends. Gnus does not handle the underlying media, so to speak---this
18005 is all done by the backends.
18009 Gnus will always use one method (and backend) as the @dfn{native}, or
18010 default, way of getting news.
18014 You can also have any number of foreign groups active at the same time.
18015 These are groups that use non-native non-secondary backends for getting
18020 Secondary backends are somewhere half-way between being native and being
18021 foreign, but they mostly act like they are native.
18025 A message that has been posted as news.
18028 @cindex mail message
18029 A message that has been mailed.
18033 A mail message or news article
18037 The top part of a message, where administrative information (etc.) is
18042 The rest of an article. Everything not in the head is in the
18047 A line from the head of an article.
18051 A collection of such lines, or a collection of heads. Or even a
18052 collection of @sc{nov} lines.
18056 When Gnus enters a group, it asks the backend for the headers of all
18057 unread articles in the group. Most servers support the News OverView
18058 format, which is more compact and much faster to read and parse than the
18059 normal @sc{head} format.
18063 Each group is subscribed at some @dfn{level} or other (1-9). The ones
18064 that have a lower level are ``more'' subscribed than the groups with a
18065 higher level. In fact, groups on levels 1-5 are considered
18066 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
18067 are @dfn{killed}. Commands for listing groups and scanning for new
18068 articles will all use the numeric prefix as @dfn{working level}.
18070 @item killed groups
18071 @cindex killed groups
18072 No information on killed groups is stored or updated, which makes killed
18073 groups much easier to handle than subscribed groups.
18075 @item zombie groups
18076 @cindex zombie groups
18077 Just like killed groups, only slightly less dead.
18080 @cindex active file
18081 The news server has to keep track of what articles it carries, and what
18082 groups exist. All this information in stored in the active file, which
18083 is rather large, as you might surmise.
18086 @cindex bogus groups
18087 A group that exists in the @file{.newsrc} file, but isn't known to the
18088 server (i.e., it isn't in the active file), is a @emph{bogus group}.
18089 This means that the group probably doesn't exist (any more).
18092 @cindex activating groups
18093 The act of asking the server for info on a group and computing the
18094 number of unread articles is called @dfn{activating the group}.
18095 Un-activated groups are listed with @samp{*} in the group buffer.
18099 A machine one can connect to and get news (or mail) from.
18101 @item select method
18102 @cindex select method
18103 A structure that specifies the backend, the server and the virtual
18106 @item virtual server
18107 @cindex virtual server
18108 A named select method. Since a select method defines all there is to
18109 know about connecting to a (physical) server, taking the thing as a
18110 whole is a virtual server.
18114 Taking a buffer and running it through a filter of some sort. The
18115 result will (more often than not) be cleaner and more pleasing than the
18118 @item ephemeral groups
18119 @cindex ephemeral groups
18120 Most groups store data on what articles you have read. @dfn{Ephemeral}
18121 groups are groups that will have no data stored---when you exit the
18122 group, it'll disappear into the aether.
18125 @cindex solid groups
18126 This is the opposite of ephemeral groups. All groups listed in the
18127 group buffer are solid groups.
18129 @item sparse articles
18130 @cindex sparse articles
18131 These are article placeholders shown in the summary buffer when
18132 @code{gnus-build-sparse-threads} has been switched on.
18136 To put responses to articles directly after the articles they respond
18137 to---in a hierarchical fashion.
18141 @cindex thread root
18142 The first article in a thread is the root. It is the ancestor of all
18143 articles in the thread.
18147 An article that has responses.
18151 An article that responds to a different article---its parent.
18155 A collection of messages in one file. The most common digest format is
18156 specified by RFC1153.
18162 @node Customization
18163 @section Customization
18164 @cindex general customization
18166 All variables are properly documented elsewhere in this manual. This
18167 section is designed to give general pointers on how to customize Gnus
18168 for some quite common situations.
18171 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
18172 * Slow Terminal Connection:: You run a remote Emacs.
18173 * Little Disk Space:: You feel that having large setup files is icky.
18174 * Slow Machine:: You feel like buying a faster machine.
18178 @node Slow/Expensive Connection
18179 @subsection Slow/Expensive @sc{nntp} Connection
18181 If you run Emacs on a machine locally, and get your news from a machine
18182 over some very thin strings, you want to cut down on the amount of data
18183 Gnus has to get from the @sc{nntp} server.
18187 @item gnus-read-active-file
18188 Set this to @code{nil}, which will inhibit Gnus from requesting the
18189 entire active file from the server. This file is often v. large. You
18190 also have to set @code{gnus-check-new-newsgroups} and
18191 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
18192 doesn't suddenly decide to fetch the active file anyway.
18194 @item gnus-nov-is-evil
18195 This one has to be @code{nil}. If not, grabbing article headers from
18196 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
18197 support @sc{xover}; Gnus will detect this by itself.
18201 @node Slow Terminal Connection
18202 @subsection Slow Terminal Connection
18204 Let's say you use your home computer for dialing up the system that runs
18205 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
18206 possible) the amount of data sent over the wires.
18210 @item gnus-auto-center-summary
18211 Set this to @code{nil} to inhibit Gnus from re-centering the summary
18212 buffer all the time. If it is @code{vertical}, do only vertical
18213 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
18214 horizontal and vertical recentering.
18216 @item gnus-visible-headers
18217 Cut down on the headers included in the articles to the
18218 minimum. You can, in fact, make do without them altogether---most of the
18219 useful data is in the summary buffer, anyway. Set this variable to
18220 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
18222 @item gnus-article-display-hook
18223 Set this hook to all the available hiding commands:
18225 (setq gnus-article-display-hook
18226 '(gnus-article-hide-headers
18227 gnus-article-hide-signature
18228 gnus-article-hide-citation))
18231 @item gnus-use-full-window
18232 By setting this to @code{nil}, you can make all the windows smaller.
18233 While this doesn't really cut down much generally, it means that you
18234 have to see smaller portions of articles before deciding that you didn't
18235 want to read them anyway.
18237 @item gnus-thread-hide-subtree
18238 If this is non-@code{nil}, all threads in the summary buffer will be
18241 @item gnus-updated-mode-lines
18242 If this is @code{nil}, Gnus will not put information in the buffer mode
18243 lines, which might save some time.
18247 @node Little Disk Space
18248 @subsection Little Disk Space
18251 The startup files can get rather large, so you may want to cut their
18252 sizes a bit if you are running out of space.
18256 @item gnus-save-newsrc-file
18257 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
18258 only save @file{.newsrc.eld}. This means that you will not be able to
18259 use any other newsreaders than Gnus. This variable is @code{t} by
18262 @item gnus-save-killed-list
18263 If this is @code{nil}, Gnus will not save the list of dead groups. You
18264 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
18265 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
18266 variable to @code{nil}. This variable is @code{t} by default.
18272 @subsection Slow Machine
18273 @cindex slow machine
18275 If you have a slow machine, or are just really impatient, there are a
18276 few things you can do to make Gnus run faster.
18278 Set @code{gnus-check-new-newsgroups} and
18279 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
18281 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
18282 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
18283 summary buffer faster.
18285 Set @code{gnus-article-display-hook} to @code{nil} to make article
18286 processing a bit faster.
18290 @node Troubleshooting
18291 @section Troubleshooting
18292 @cindex troubleshooting
18294 Gnus works @emph{so} well straight out of the box---I can't imagine any
18302 Make sure your computer is switched on.
18305 Make sure that you really load the current Gnus version. If you have
18306 been running @sc{gnus}, you need to exit Emacs and start it up again before
18310 Try doing an @kbd{M-x gnus-version}. If you get something that looks
18311 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded. If,
18312 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
18313 flee}, you have some old @file{.el} files lying around. Delete these.
18316 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
18320 @vindex max-lisp-eval-depth
18321 Gnus works on many recursive structures, and in some extreme (and very
18322 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
18323 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
18324 something like that.
18327 If all else fails, report the problem as a bug.
18330 @cindex reporting bugs
18332 @kindex M-x gnus-bug
18334 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
18335 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
18336 me the backtrace. I will fix bugs, but I can only fix them if you send
18337 me a precise description as to how to reproduce the bug.
18339 You really can never be too detailed in a bug report. Always use the
18340 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
18341 a 10Kb mail each time you use it, and even if you have sent me your
18342 environment 500 times before. I don't care. I want the full info each
18345 It is also important to remember that I have no memory whatsoever. If
18346 you send a bug report, and I send you a reply, and then you just send
18347 back ``No, it's not! Moron!'', I will have no idea what you are
18348 insulting me about. Always over-explain everything. It's much easier
18349 for all of us---if I don't have all the information I need, I will just
18350 mail you and ask for more info, and everything takes more time.
18352 If the problem you're seeing is very visual, and you can't quite explain
18353 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
18354 it somewhere it can be reached, and include the URL of the picture in
18357 If you just need help, you are better off asking on
18358 @samp{gnu.emacs.gnus}. I'm not very helpful.
18360 @cindex gnu.emacs.gnus
18361 @cindex ding mailing list
18362 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
18363 Write to @samp{ding-request@@gnus.org} to subscribe.
18367 @node A Programmers Guide to Gnus
18368 @section A Programmer@'s Guide to Gnus
18370 It is my hope that other people will figure out smart stuff that Gnus
18371 can do, and that other people will write those smart things as well. To
18372 facilitate that I thought it would be a good idea to describe the inner
18373 workings of Gnus. And some of the not-so-inner workings, while I'm at
18376 You can never expect the internals of a program not to change, but I
18377 will be defining (in some details) the interface between Gnus and its
18378 backends (this is written in stone), the format of the score files
18379 (ditto), data structures (some are less likely to change than others)
18380 and general methods of operation.
18383 * Gnus Utility Functions:: Common functions and variable to use.
18384 * Backend Interface:: How Gnus communicates with the servers.
18385 * Score File Syntax:: A BNF definition of the score file standard.
18386 * Headers:: How Gnus stores headers internally.
18387 * Ranges:: A handy format for storing mucho numbers.
18388 * Group Info:: The group info format.
18389 * Extended Interactive:: Symbolic prefixes and stuff.
18390 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
18391 * Various File Formats:: Formats of files that Gnus use.
18395 @node Gnus Utility Functions
18396 @subsection Gnus Utility Functions
18397 @cindex Gnus utility functions
18398 @cindex utility functions
18400 @cindex internal variables
18402 When writing small functions to be run from hooks (and stuff), it's
18403 vital to have access to the Gnus internal functions and variables.
18404 Below is a list of the most common ones.
18408 @item gnus-newsgroup-name
18409 @vindex gnus-newsgroup-name
18410 This variable holds the name of the current newsgroup.
18412 @item gnus-find-method-for-group
18413 @findex gnus-find-method-for-group
18414 A function that returns the select method for @var{group}.
18416 @item gnus-group-real-name
18417 @findex gnus-group-real-name
18418 Takes a full (prefixed) Gnus group name, and returns the unprefixed
18421 @item gnus-group-prefixed-name
18422 @findex gnus-group-prefixed-name
18423 Takes an unprefixed group name and a select method, and returns the full
18424 (prefixed) Gnus group name.
18426 @item gnus-get-info
18427 @findex gnus-get-info
18428 Returns the group info list for @var{group}.
18430 @item gnus-group-unread
18431 @findex gnus-group-unread
18432 The number of unread articles in @var{group}, or @code{t} if that is
18436 @findex gnus-active
18437 The active entry for @var{group}.
18439 @item gnus-set-active
18440 @findex gnus-set-active
18441 Set the active entry for @var{group}.
18443 @item gnus-add-current-to-buffer-list
18444 @findex gnus-add-current-to-buffer-list
18445 Adds the current buffer to the list of buffers to be killed on Gnus
18448 @item gnus-continuum-version
18449 @findex gnus-continuum-version
18450 Takes a Gnus version string as a parameter and returns a floating point
18451 number. Earlier versions will always get a lower number than later
18454 @item gnus-group-read-only-p
18455 @findex gnus-group-read-only-p
18456 Says whether @var{group} is read-only or not.
18458 @item gnus-news-group-p
18459 @findex gnus-news-group-p
18460 Says whether @var{group} came from a news backend.
18462 @item gnus-ephemeral-group-p
18463 @findex gnus-ephemeral-group-p
18464 Says whether @var{group} is ephemeral or not.
18466 @item gnus-server-to-method
18467 @findex gnus-server-to-method
18468 Returns the select method corresponding to @var{server}.
18470 @item gnus-server-equal
18471 @findex gnus-server-equal
18472 Says whether two virtual servers are equal.
18474 @item gnus-group-native-p
18475 @findex gnus-group-native-p
18476 Says whether @var{group} is native or not.
18478 @item gnus-group-secondary-p
18479 @findex gnus-group-secondary-p
18480 Says whether @var{group} is secondary or not.
18482 @item gnus-group-foreign-p
18483 @findex gnus-group-foreign-p
18484 Says whether @var{group} is foreign or not.
18486 @item group-group-find-parameter
18487 @findex group-group-find-parameter
18488 Returns the parameter list of @var{group}. If given a second parameter,
18489 returns the value of that parameter for @var{group}.
18491 @item gnus-group-set-parameter
18492 @findex gnus-group-set-parameter
18493 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
18495 @item gnus-narrow-to-body
18496 @findex gnus-narrow-to-body
18497 Narrows the current buffer to the body of the article.
18499 @item gnus-check-backend-function
18500 @findex gnus-check-backend-function
18501 Takes two parameters, @var{function} and @var{group}. If the backend
18502 @var{group} comes from supports @var{function}, return non-@code{nil}.
18505 (gnus-check-backend-function "request-scan" "nnml:misc")
18509 @item gnus-read-method
18510 @findex gnus-read-method
18511 Prompts the user for a select method.
18516 @node Backend Interface
18517 @subsection Backend Interface
18519 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
18520 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
18521 server is a @dfn{backend} and some @dfn{backend variables}. As examples
18522 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
18523 examples of the latter we have @code{nntp-port-number} and
18524 @code{nnmbox-directory}.
18526 When Gnus asks for information from a backend---say @code{nntp}---on
18527 something, it will normally include a virtual server name in the
18528 function parameters. (If not, the backend should use the ``current''
18529 virtual server.) For instance, @code{nntp-request-list} takes a virtual
18530 server as its only (optional) parameter. If this virtual server hasn't
18531 been opened, the function should fail.
18533 Note that a virtual server name has no relation to some physical server
18534 name. Take this example:
18538 (nntp-address "ifi.uio.no")
18539 (nntp-port-number 4324))
18542 Here the virtual server name is @samp{odd-one} while the name of
18543 the physical server is @samp{ifi.uio.no}.
18545 The backends should be able to switch between several virtual servers.
18546 The standard backends implement this by keeping an alist of virtual
18547 server environments that they pull down/push up when needed.
18549 There are two groups of interface functions: @dfn{required functions},
18550 which must be present, and @dfn{optional functions}, which Gnus will
18551 always check for presence before attempting to call 'em.
18553 All these functions are expected to return data in the buffer
18554 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
18555 unfortunately named, but we'll have to live with it. When I talk about
18556 @dfn{resulting data}, I always refer to the data in that buffer. When I
18557 talk about @dfn{return value}, I talk about the function value returned by
18558 the function call. Functions that fail should return @code{nil} as the
18561 Some backends could be said to be @dfn{server-forming} backends, and
18562 some might be said not to be. The latter are backends that generally
18563 only operate on one group at a time, and have no concept of ``server''
18564 -- they have a group, and they deliver info on that group and nothing
18567 In the examples and definitions I will refer to the imaginary backend
18570 @cindex @code{nnchoke}
18573 * Required Backend Functions:: Functions that must be implemented.
18574 * Optional Backend Functions:: Functions that need not be implemented.
18575 * Error Messaging:: How to get messages and report errors.
18576 * Writing New Backends:: Extending old backends.
18577 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
18578 * Mail-like Backends:: Some tips on mail backends.
18582 @node Required Backend Functions
18583 @subsubsection Required Backend Functions
18587 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
18589 @var{articles} is either a range of article numbers or a list of
18590 @code{Message-ID}s. Current backends do not fully support either---only
18591 sequences (lists) of article numbers, and most backends do not support
18592 retrieval of @code{Message-ID}s. But they should try for both.
18594 The result data should either be HEADs or NOV lines, and the result
18595 value should either be @code{headers} or @code{nov} to reflect this.
18596 This might later be expanded to @code{various}, which will be a mixture
18597 of HEADs and NOV lines, but this is currently not supported by Gnus.
18599 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
18600 headers", in some meaning of the word. This is generally done by
18601 fetching (at most) @var{fetch-old} extra headers less than the smallest
18602 article number in @code{articles}, and filling the gaps as well. The
18603 presence of this parameter can be ignored if the backend finds it
18604 cumbersome to follow the request. If this is non-@code{nil} and not a
18605 number, do maximum fetches.
18607 Here's an example HEAD:
18610 221 1056 Article retrieved.
18611 Path: ifi.uio.no!sturles
18612 From: sturles@@ifi.uio.no (Sturle Sunde)
18613 Newsgroups: ifi.discussion
18614 Subject: Re: Something very droll
18615 Date: 27 Oct 1994 14:02:57 +0100
18616 Organization: Dept. of Informatics, University of Oslo, Norway
18618 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
18619 References: <38jdmq$4qu@@visbur.ifi.uio.no>
18620 NNTP-Posting-Host: holmenkollen.ifi.uio.no
18624 So a @code{headers} return value would imply that there's a number of
18625 these in the data buffer.
18627 Here's a BNF definition of such a buffer:
18631 head = error / valid-head
18632 error-message = [ "4" / "5" ] 2number " " <error message> eol
18633 valid-head = valid-message *header "." eol
18634 valid-message = "221 " <number> " Article retrieved." eol
18635 header = <text> eol
18638 If the return value is @code{nov}, the data buffer should contain
18639 @dfn{network overview database} lines. These are basically fields
18643 nov-buffer = *nov-line
18644 nov-line = 8*9 [ field <TAB> ] eol
18645 field = <text except TAB>
18648 For a closer look at what should be in those fields,
18652 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
18654 @var{server} is here the virtual server name. @var{definitions} is a
18655 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
18657 If the server can't be opened, no error should be signaled. The backend
18658 may then choose to refuse further attempts at connecting to this
18659 server. In fact, it should do so.
18661 If the server is opened already, this function should return a
18662 non-@code{nil} value. There should be no data returned.
18665 @item (nnchoke-close-server &optional SERVER)
18667 Close connection to @var{server} and free all resources connected
18668 to it. Return @code{nil} if the server couldn't be closed for some
18671 There should be no data returned.
18674 @item (nnchoke-request-close)
18676 Close connection to all servers and free all resources that the backend
18677 have reserved. All buffers that have been created by that backend
18678 should be killed. (Not the @code{nntp-server-buffer}, though.) This
18679 function is generally only called when Gnus is shutting down.
18681 There should be no data returned.
18684 @item (nnchoke-server-opened &optional SERVER)
18686 If @var{server} is the current virtual server, and the connection to the
18687 physical server is alive, then this function should return a
18688 non-@code{nil} vlue. This function should under no circumstances
18689 attempt to reconnect to a server we have lost connection to.
18691 There should be no data returned.
18694 @item (nnchoke-status-message &optional SERVER)
18696 This function should return the last error message from @var{server}.
18698 There should be no data returned.
18701 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
18703 The result data from this function should be the article specified by
18704 @var{article}. This might either be a @code{Message-ID} or a number.
18705 It is optional whether to implement retrieval by @code{Message-ID}, but
18706 it would be nice if that were possible.
18708 If @var{to-buffer} is non-@code{nil}, the result data should be returned
18709 in this buffer instead of the normal data buffer. This is to make it
18710 possible to avoid copying large amounts of data from one buffer to
18711 another, while Gnus mainly requests articles to be inserted directly
18712 into its article buffer.
18714 If it is at all possible, this function should return a cons cell where
18715 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
18716 the article number. This will enable Gnus to find out what the real
18717 group and article numbers are when fetching articles by
18718 @code{Message-ID}. If this isn't possible, @code{t} should be returned
18719 on successful article retrieval.
18722 @item (nnchoke-request-group GROUP &optional SERVER FAST)
18724 Get data on @var{group}. This function also has the side effect of
18725 making @var{group} the current group.
18727 If @var{FAST}, don't bother to return useful data, just make @var{group}
18730 Here's an example of some result data and a definition of the same:
18733 211 56 1000 1059 ifi.discussion
18736 The first number is the status, which should be 211. Next is the
18737 total number of articles in the group, the lowest article number, the
18738 highest article number, and finally the group name. Note that the total
18739 number of articles may be less than one might think while just
18740 considering the highest and lowest article numbers, but some articles
18741 may have been canceled. Gnus just discards the total-number, so
18742 whether one should take the bother to generate it properly (if that is a
18743 problem) is left as an exercise to the reader.
18746 group-status = [ error / info ] eol
18747 error = [ "4" / "5" ] 2<number> " " <Error message>
18748 info = "211 " 3* [ <number> " " ] <string>
18752 @item (nnchoke-close-group GROUP &optional SERVER)
18754 Close @var{group} and free any resources connected to it. This will be
18755 a no-op on most backends.
18757 There should be no data returned.
18760 @item (nnchoke-request-list &optional SERVER)
18762 Return a list of all groups available on @var{server}. And that means
18765 Here's an example from a server that only carries two groups:
18768 ifi.test 0000002200 0000002000 y
18769 ifi.discussion 3324 3300 n
18772 On each line we have a group name, then the highest article number in
18773 that group, the lowest article number, and finally a flag.
18776 active-file = *active-line
18777 active-line = name " " <number> " " <number> " " flags eol
18779 flags = "n" / "y" / "m" / "x" / "j" / "=" name
18782 The flag says whether the group is read-only (@samp{n}), is moderated
18783 (@samp{m}), is dead (@samp{x}), is aliased to some other group
18784 (@samp{=other-group}) or none of the above (@samp{y}).
18787 @item (nnchoke-request-post &optional SERVER)
18789 This function should post the current buffer. It might return whether
18790 the posting was successful or not, but that's not required. If, for
18791 instance, the posting is done asynchronously, it has generally not been
18792 completed by the time this function concludes. In that case, this
18793 function should set up some kind of sentinel to beep the user loud and
18794 clear if the posting could not be completed.
18796 There should be no result data from this function.
18801 @node Optional Backend Functions
18802 @subsubsection Optional Backend Functions
18806 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
18808 @var{groups} is a list of groups, and this function should request data
18809 on all those groups. How it does it is of no concern to Gnus, but it
18810 should attempt to do this in a speedy fashion.
18812 The return value of this function can be either @code{active} or
18813 @code{group}, which says what the format of the result data is. The
18814 former is in the same format as the data from
18815 @code{nnchoke-request-list}, while the latter is a buffer full of lines
18816 in the same format as @code{nnchoke-request-group} gives.
18819 group-buffer = *active-line / *group-status
18823 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
18825 A Gnus group info (@pxref{Group Info}) is handed to the backend for
18826 alterations. This comes in handy if the backend really carries all the
18827 information (as is the case with virtual and imap groups). This
18828 function should destructively alter the info to suit its needs, and
18829 should return the (altered) group info.
18831 There should be no result data from this function.
18834 @item (nnchoke-request-type GROUP &optional ARTICLE)
18836 When the user issues commands for ``sending news'' (@kbd{F} in the
18837 summary buffer, for instance), Gnus has to know whether the article the
18838 user is following up on is news or mail. This function should return
18839 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
18840 is mail and @code{unknown} if the type can't be decided. (The
18841 @var{article} parameter is necessary in @code{nnvirtual} groups which
18842 might very well combine mail groups and news groups.) Both @var{group}
18843 and @var{article} may be @code{nil}.
18845 There should be no result data from this function.
18848 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
18850 If the user tries to set a mark that the backend doesn't like, this
18851 function may change the mark. Gnus will use whatever this function
18852 returns as the mark for @var{article} instead of the original
18853 @var{mark}. If the backend doesn't care, it must return the original
18854 @var{mark}, and not @code{nil} or any other type of garbage.
18856 The only use for this I can see is what @code{nnvirtual} does with
18857 it---if a component group is auto-expirable, marking an article as read
18858 in the virtual group should result in the article being marked as
18861 There should be no result data from this function.
18864 @item (nnchoke-request-scan &optional GROUP SERVER)
18866 This function may be called at any time (by Gnus or anything else) to
18867 request that the backend check for incoming articles, in one way or
18868 another. A mail backend will typically read the spool file or query the
18869 POP server when this function is invoked. The @var{group} doesn't have
18870 to be heeded---if the backend decides that it is too much work just
18871 scanning for a single group, it may do a total scan of all groups. It
18872 would be nice, however, to keep things local if that's practical.
18874 There should be no result data from this function.
18877 @item (nnchoke-request-group-description GROUP &optional SERVER)
18879 The result data from this function should be a description of
18883 description-line = name <TAB> description eol
18885 description = <text>
18888 @item (nnchoke-request-list-newsgroups &optional SERVER)
18890 The result data from this function should be the description of all
18891 groups available on the server.
18894 description-buffer = *description-line
18898 @item (nnchoke-request-newgroups DATE &optional SERVER)
18900 The result data from this function should be all groups that were
18901 created after @samp{date}, which is in normal human-readable date
18902 format. The data should be in the active buffer format.
18905 @item (nnchoke-request-create-group GROUP &optional SERVER)
18907 This function should create an empty group with name @var{group}.
18909 There should be no return data.
18912 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
18914 This function should run the expiry process on all articles in the
18915 @var{articles} range (which is currently a simple list of article
18916 numbers.) It is left up to the backend to decide how old articles
18917 should be before they are removed by this function. If @var{force} is
18918 non-@code{nil}, all @var{articles} should be deleted, no matter how new
18921 This function should return a list of articles that it did not/was not
18924 There should be no result data returned.
18927 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
18930 This function should move @var{article} (which is a number) from
18931 @var{group} by calling @var{accept-form}.
18933 This function should ready the article in question for moving by
18934 removing any header lines it has added to the article, and generally
18935 should ``tidy up'' the article. Then it should @code{eval}
18936 @var{accept-form} in the buffer where the ``tidy'' article is. This
18937 will do the actual copying. If this @code{eval} returns a
18938 non-@code{nil} value, the article should be removed.
18940 If @var{last} is @code{nil}, that means that there is a high likelihood
18941 that there will be more requests issued shortly, so that allows some
18944 The function should return a cons where the @code{car} is the group name and
18945 the @code{cdr} is the article number that the article was entered as.
18947 There should be no data returned.
18950 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
18952 This function takes the current buffer and inserts it into @var{group}.
18953 If @var{last} in @code{nil}, that means that there will be more calls to
18954 this function in short order.
18956 The function should return a cons where the @code{car} is the group name and
18957 the @code{cdr} is the article number that the article was entered as.
18959 There should be no data returned.
18962 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
18964 This function should remove @var{article} (which is a number) from
18965 @var{group} and insert @var{buffer} there instead.
18967 There should be no data returned.
18970 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
18972 This function should delete @var{group}. If @var{force}, it should
18973 really delete all the articles in the group, and then delete the group
18974 itself. (If there is such a thing as ``the group itself''.)
18976 There should be no data returned.
18979 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
18981 This function should rename @var{group} into @var{new-name}. All
18982 articles in @var{group} should move to @var{new-name}.
18984 There should be no data returned.
18989 @node Error Messaging
18990 @subsubsection Error Messaging
18992 @findex nnheader-report
18993 @findex nnheader-get-report
18994 The backends should use the function @code{nnheader-report} to report
18995 error conditions---they should not raise errors when they aren't able to
18996 perform a request. The first argument to this function is the backend
18997 symbol, and the rest are interpreted as arguments to @code{format} if
18998 there are multiple of them, or just a string if there is one of them.
18999 This function must always returns @code{nil}.
19002 (nnheader-report 'nnchoke "You did something totally bogus")
19004 (nnheader-report 'nnchoke "Could not request group %s" group)
19007 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
19008 @code{nil} back from a server, and this function returns the most
19009 recently reported message for the backend in question. This function
19010 takes one argument---the server symbol.
19012 Internally, these functions access @var{backend}@code{-status-string},
19013 so the @code{nnchoke} backend will have its error message stored in
19014 @code{nnchoke-status-string}.
19017 @node Writing New Backends
19018 @subsubsection Writing New Backends
19020 Many backends are quite similar. @code{nnml} is just like
19021 @code{nnspool}, but it allows you to edit the articles on the server.
19022 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
19023 and it doesn't maintain overview databases. @code{nndir} is just like
19024 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
19027 It would make sense if it were possible to ``inherit'' functions from
19028 backends when writing new backends. And, indeed, you can do that if you
19029 want to. (You don't have to if you don't want to, of course.)
19031 All the backends declare their public variables and functions by using a
19032 package called @code{nnoo}.
19034 To inherit functions from other backends (and allow other backends to
19035 inherit functions from the current backend), you should use the
19041 This macro declares the first parameter to be a child of the subsequent
19042 parameters. For instance:
19045 (nnoo-declare nndir
19049 @code{nndir} has declared here that it intends to inherit functions from
19050 both @code{nnml} and @code{nnmh}.
19053 This macro is equivalent to @code{defvar}, but registers the variable as
19054 a public server variable. Most state-oriented variables should be
19055 declared with @code{defvoo} instead of @code{defvar}.
19057 In addition to the normal @code{defvar} parameters, it takes a list of
19058 variables in the parent backends to map the variable to when executing
19059 a function in those backends.
19062 (defvoo nndir-directory nil
19063 "Where nndir will look for groups."
19064 nnml-current-directory nnmh-current-directory)
19067 This means that @code{nnml-current-directory} will be set to
19068 @code{nndir-directory} when an @code{nnml} function is called on behalf
19069 of @code{nndir}. (The same with @code{nnmh}.)
19071 @item nnoo-define-basics
19072 This macro defines some common functions that almost all backends should
19076 (nnoo-define-basics nndir)
19080 This macro is just like @code{defun} and takes the same parameters. In
19081 addition to doing the normal @code{defun} things, it registers the
19082 function as being public so that other backends can inherit it.
19084 @item nnoo-map-functions
19085 This macro allows mapping of functions from the current backend to
19086 functions from the parent backends.
19089 (nnoo-map-functions nndir
19090 (nnml-retrieve-headers 0 nndir-current-group 0 0)
19091 (nnmh-request-article 0 nndir-current-group 0 0))
19094 This means that when @code{nndir-retrieve-headers} is called, the first,
19095 third, and fourth parameters will be passed on to
19096 @code{nnml-retrieve-headers}, while the second parameter is set to the
19097 value of @code{nndir-current-group}.
19100 This macro allows importing functions from backends. It should be the
19101 last thing in the source file, since it will only define functions that
19102 haven't already been defined.
19108 nnmh-request-newgroups)
19112 This means that calls to @code{nndir-request-list} should just be passed
19113 on to @code{nnmh-request-list}, while all public functions from
19114 @code{nnml} that haven't been defined in @code{nndir} yet should be
19119 Below is a slightly shortened version of the @code{nndir} backend.
19122 ;;; nndir.el --- single directory newsgroup access for Gnus
19123 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
19127 (require 'nnheader)
19131 (eval-when-compile (require 'cl))
19133 (nnoo-declare nndir
19136 (defvoo nndir-directory nil
19137 "Where nndir will look for groups."
19138 nnml-current-directory nnmh-current-directory)
19140 (defvoo nndir-nov-is-evil nil
19141 "*Non-nil means that nndir will never retrieve NOV headers."
19144 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
19145 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
19146 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
19148 (defvoo nndir-status-string "" nil nnmh-status-string)
19149 (defconst nndir-version "nndir 1.0")
19151 ;;; Interface functions.
19153 (nnoo-define-basics nndir)
19155 (deffoo nndir-open-server (server &optional defs)
19156 (setq nndir-directory
19157 (or (cadr (assq 'nndir-directory defs))
19159 (unless (assq 'nndir-directory defs)
19160 (push `(nndir-directory ,server) defs))
19161 (push `(nndir-current-group
19162 ,(file-name-nondirectory (directory-file-name nndir-directory)))
19164 (push `(nndir-top-directory
19165 ,(file-name-directory (directory-file-name nndir-directory)))
19167 (nnoo-change-server 'nndir server defs))
19169 (nnoo-map-functions nndir
19170 (nnml-retrieve-headers 0 nndir-current-group 0 0)
19171 (nnmh-request-article 0 nndir-current-group 0 0)
19172 (nnmh-request-group nndir-current-group 0 0)
19173 (nnmh-close-group nndir-current-group 0))
19177 nnmh-status-message
19179 nnmh-request-newgroups))
19185 @node Hooking New Backends Into Gnus
19186 @subsubsection Hooking New Backends Into Gnus
19188 @vindex gnus-valid-select-methods
19189 Having Gnus start using your new backend is rather easy---you just
19190 declare it with the @code{gnus-declare-backend} functions. This will
19191 enter the backend into the @code{gnus-valid-select-methods} variable.
19193 @code{gnus-declare-backend} takes two parameters---the backend name and
19194 an arbitrary number of @dfn{abilities}.
19199 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
19202 The abilities can be:
19206 This is a mailish backend---followups should (probably) go via mail.
19208 This is a newsish backend---followups should (probably) go via news.
19210 This backend supports both mail and news.
19212 This is neither a post nor mail backend---it's something completely
19215 It supports respooling---or rather, it is able to modify its source
19216 articles and groups.
19218 The name of the server should be in the virtual server name. This is
19219 true for almost all backends.
19220 @item prompt-address
19221 The user should be prompted for an address when doing commands like
19222 @kbd{B} in the group buffer. This is true for backends like
19223 @code{nntp}, but not @code{nnmbox}, for instance.
19227 @node Mail-like Backends
19228 @subsubsection Mail-like Backends
19230 One of the things that separate the mail backends from the rest of the
19231 backends is the heavy dependence by the mail backends on common
19232 functions in @file{nnmail.el}. For instance, here's the definition of
19233 @code{nnml-request-scan}:
19236 (deffoo nnml-request-scan (&optional group server)
19237 (setq nnml-article-file-alist nil)
19238 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
19241 It simply calls @code{nnmail-get-new-mail} with a few parameters,
19242 and @code{nnmail} takes care of all the moving and splitting of the
19245 This function takes four parameters.
19249 This should be a symbol to designate which backend is responsible for
19252 @item exit-function
19253 This function should be called after the splitting has been performed.
19255 @item temp-directory
19256 Where the temporary files should be stored.
19259 This optional argument should be a group name if the splitting is to be
19260 performed for one group only.
19263 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
19264 save each article. @var{backend}@code{-active-number} will be called to
19265 find the article number assigned to this article.
19267 The function also uses the following variables:
19268 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
19269 this backend); and @var{backend}@code{-group-alist} and
19270 @var{backend}@code{-active-file} to generate the new active file.
19271 @var{backend}@code{-group-alist} should be a group-active alist, like
19275 (("a-group" (1 . 10))
19276 ("some-group" (34 . 39)))
19280 @node Score File Syntax
19281 @subsection Score File Syntax
19283 Score files are meant to be easily parseable, but yet extremely
19284 mallable. It was decided that something that had the same read syntax
19285 as an Emacs Lisp list would fit that spec.
19287 Here's a typical score file:
19291 ("win95" -10000 nil s)
19298 BNF definition of a score file:
19301 score-file = "" / "(" *element ")"
19302 element = rule / atom
19303 rule = string-rule / number-rule / date-rule
19304 string-rule = "(" quote string-header quote space *string-match ")"
19305 number-rule = "(" quote number-header quote space *number-match ")"
19306 date-rule = "(" quote date-header quote space *date-match ")"
19308 string-header = "subject" / "from" / "references" / "message-id" /
19309 "xref" / "body" / "head" / "all" / "followup"
19310 number-header = "lines" / "chars"
19311 date-header = "date"
19312 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
19313 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
19314 score = "nil" / <integer>
19315 date = "nil" / <natural number>
19316 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
19317 "r" / "regex" / "R" / "Regex" /
19318 "e" / "exact" / "E" / "Exact" /
19319 "f" / "fuzzy" / "F" / "Fuzzy"
19320 number-match = "(" <integer> [ "" / [ space score [ "" /
19321 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
19322 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
19323 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
19324 space date [ "" / [ space date-match-t ] ] ] ] ")"
19325 date-match-t = "nil" / "at" / "before" / "after"
19326 atom = "(" [ required-atom / optional-atom ] ")"
19327 required-atom = mark / expunge / mark-and-expunge / files /
19328 exclude-files / read-only / touched
19329 optional-atom = adapt / local / eval
19330 mark = "mark" space nil-or-number
19331 nil-or-number = "nil" / <integer>
19332 expunge = "expunge" space nil-or-number
19333 mark-and-expunge = "mark-and-expunge" space nil-or-number
19334 files = "files" *[ space <string> ]
19335 exclude-files = "exclude-files" *[ space <string> ]
19336 read-only = "read-only" [ space "nil" / space "t" ]
19337 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
19338 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
19339 local = "local" *[ space "(" <string> space <form> ")" ]
19340 eval = "eval" space <form>
19341 space = *[ " " / <TAB> / <NEWLINE> ]
19344 Any unrecognized elements in a score file should be ignored, but not
19347 As you can see, white space is needed, but the type and amount of white
19348 space is irrelevant. This means that formatting of the score file is
19349 left up to the programmer---if it's simpler to just spew it all out on
19350 one looong line, then that's ok.
19352 The meaning of the various atoms are explained elsewhere in this
19353 manual (@pxref{Score File Format}).
19357 @subsection Headers
19359 Internally Gnus uses a format for storing article headers that
19360 corresponds to the @sc{nov} format in a mysterious fashion. One could
19361 almost suspect that the author looked at the @sc{nov} specification and
19362 just shamelessly @emph{stole} the entire thing, and one would be right.
19364 @dfn{Header} is a severely overloaded term. ``Header'' is used in
19365 RFC1036 to talk about lines in the head of an article (e.g.,
19366 @code{From}). It is used by many people as a synonym for
19367 ``head''---``the header and the body''. (That should be avoided, in my
19368 opinion.) And Gnus uses a format internally that it calls ``header'',
19369 which is what I'm talking about here. This is a 9-element vector,
19370 basically, with each header (ouch) having one slot.
19372 These slots are, in order: @code{number}, @code{subject}, @code{from},
19373 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
19374 @code{xref}. There are macros for accessing and setting these
19375 slots---they all have predictable names beginning with
19376 @code{mail-header-} and @code{mail-header-set-}, respectively.
19378 The @code{xref} slot is really a @code{misc} slot. Any extra info will
19385 @sc{gnus} introduced a concept that I found so useful that I've started
19386 using it a lot and have elaborated on it greatly.
19388 The question is simple: If you have a large amount of objects that are
19389 identified by numbers (say, articles, to take a @emph{wild} example)
19390 that you want to qualify as being ``included'', a normal sequence isn't
19391 very useful. (A 200,000 length sequence is a bit long-winded.)
19393 The solution is as simple as the question: You just collapse the
19397 (1 2 3 4 5 6 10 11 12)
19400 is transformed into
19403 ((1 . 6) (10 . 12))
19406 To avoid having those nasty @samp{(13 . 13)} elements to denote a
19407 lonesome object, a @samp{13} is a valid element:
19410 ((1 . 6) 7 (10 . 12))
19413 This means that comparing two ranges to find out whether they are equal
19414 is slightly tricky:
19417 ((1 . 5) 7 8 (10 . 12))
19423 ((1 . 5) (7 . 8) (10 . 12))
19426 are equal. In fact, any non-descending list is a range:
19432 is a perfectly valid range, although a pretty long-winded one. This is
19439 and is equal to the previous range.
19441 Here's a BNF definition of ranges. Of course, one must remember the
19442 semantic requirement that the numbers are non-descending. (Any number
19443 of repetition of the same number is allowed, but apt to disappear in
19447 range = simple-range / normal-range
19448 simple-range = "(" number " . " number ")"
19449 normal-range = "(" start-contents ")"
19450 contents = "" / simple-range *[ " " contents ] /
19451 number *[ " " contents ]
19454 Gnus currently uses ranges to keep track of read articles and article
19455 marks. I plan on implementing a number of range operators in C if The
19456 Powers That Be are willing to let me. (I haven't asked yet, because I
19457 need to do some more thinking on what operators I need to make life
19458 totally range-based without ever having to convert back to normal
19463 @subsection Group Info
19465 Gnus stores all permanent info on groups in a @dfn{group info} list.
19466 This list is from three to six elements (or more) long and exhaustively
19467 describes the group.
19469 Here are two example group infos; one is a very simple group while the
19470 second is a more complex one:
19473 ("no.group" 5 (1 . 54324))
19475 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
19476 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
19478 ((auto-expire . t) (to-address . "ding@@gnus.org")))
19481 The first element is the @dfn{group name}---as Gnus knows the group,
19482 anyway. The second element is the @dfn{subscription level}, which
19483 normally is a small integer. (It can also be the @dfn{rank}, which is a
19484 cons cell where the @code{car} is the level and the @code{cdr} is the
19485 score.) The third element is a list of ranges of read articles. The
19486 fourth element is a list of lists of article marks of various kinds.
19487 The fifth element is the select method (or virtual server, if you like).
19488 The sixth element is a list of @dfn{group parameters}, which is what
19489 this section is about.
19491 Any of the last three elements may be missing if they are not required.
19492 In fact, the vast majority of groups will normally only have the first
19493 three elements, which saves quite a lot of cons cells.
19495 Here's a BNF definition of the group info format:
19498 info = "(" group space ralevel space read
19499 [ "" / [ space marks-list [ "" / [ space method [ "" /
19500 space parameters ] ] ] ] ] ")"
19501 group = quote <string> quote
19502 ralevel = rank / level
19503 level = <integer in the range of 1 to inf>
19504 rank = "(" level "." score ")"
19505 score = <integer in the range of 1 to inf>
19507 marks-lists = nil / "(" *marks ")"
19508 marks = "(" <string> range ")"
19509 method = "(" <string> *elisp-forms ")"
19510 parameters = "(" *elisp-forms ")"
19513 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
19514 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
19517 If you have a Gnus info and want to access the elements, Gnus offers a
19518 series of macros for getting/setting these elements.
19521 @item gnus-info-group
19522 @itemx gnus-info-set-group
19523 @findex gnus-info-group
19524 @findex gnus-info-set-group
19525 Get/set the group name.
19527 @item gnus-info-rank
19528 @itemx gnus-info-set-rank
19529 @findex gnus-info-rank
19530 @findex gnus-info-set-rank
19531 Get/set the group rank (@pxref{Group Score}).
19533 @item gnus-info-level
19534 @itemx gnus-info-set-level
19535 @findex gnus-info-level
19536 @findex gnus-info-set-level
19537 Get/set the group level.
19539 @item gnus-info-score
19540 @itemx gnus-info-set-score
19541 @findex gnus-info-score
19542 @findex gnus-info-set-score
19543 Get/set the group score (@pxref{Group Score}).
19545 @item gnus-info-read
19546 @itemx gnus-info-set-read
19547 @findex gnus-info-read
19548 @findex gnus-info-set-read
19549 Get/set the ranges of read articles.
19551 @item gnus-info-marks
19552 @itemx gnus-info-set-marks
19553 @findex gnus-info-marks
19554 @findex gnus-info-set-marks
19555 Get/set the lists of ranges of marked articles.
19557 @item gnus-info-method
19558 @itemx gnus-info-set-method
19559 @findex gnus-info-method
19560 @findex gnus-info-set-method
19561 Get/set the group select method.
19563 @item gnus-info-params
19564 @itemx gnus-info-set-params
19565 @findex gnus-info-params
19566 @findex gnus-info-set-params
19567 Get/set the group parameters.
19570 All the getter functions take one parameter---the info list. The setter
19571 functions take two parameters---the info list and the new value.
19573 The last three elements in the group info aren't mandatory, so it may be
19574 necessary to extend the group info before setting the element. If this
19575 is necessary, you can just pass on a non-@code{nil} third parameter to
19576 the three final setter functions to have this happen automatically.
19579 @node Extended Interactive
19580 @subsection Extended Interactive
19581 @cindex interactive
19582 @findex gnus-interactive
19584 Gnus extends the standard Emacs @code{interactive} specification
19585 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
19586 Prefixes}). Here's an example of how this is used:
19589 (defun gnus-summary-increase-score (&optional score symp)
19590 (interactive (gnus-interactive "P\ny"))
19595 The best thing to do would have been to implement
19596 @code{gnus-interactive} as a macro which would have returned an
19597 @code{interactive} form, but this isn't possible since Emacs checks
19598 whether a function is interactive or not by simply doing an @code{assq}
19599 on the lambda form. So, instead we have @code{gnus-interactive}
19600 function that takes a string and returns values that are usable to
19601 @code{interactive}.
19603 This function accepts (almost) all normal @code{interactive} specs, but
19608 @vindex gnus-current-prefix-symbol
19609 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
19613 @vindex gnus-current-prefix-symbols
19614 A list of the current symbolic prefixes---the
19615 @code{gnus-current-prefix-symbol} variable.
19618 The current article number---the @code{gnus-summary-article-number}
19622 The current article header---the @code{gnus-summary-article-header}
19626 The current group name---the @code{gnus-group-group-name}
19632 @node Emacs/XEmacs Code
19633 @subsection Emacs/XEmacs Code
19637 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
19638 platforms must be the primary one. I chose Emacs. Not because I don't
19639 like XEmacs or Mule, but because it comes first alphabetically.
19641 This means that Gnus will byte-compile under Emacs with nary a warning,
19642 while XEmacs will pump out gigabytes of warnings while byte-compiling.
19643 As I use byte-compilation warnings to help me root out trivial errors in
19644 Gnus, that's very useful.
19646 I've also consistently used Emacs function interfaces, but have used
19647 Gnusey aliases for the functions. To take an example: Emacs defines a
19648 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
19649 function. I then define a function called @code{gnus-run-at-time} that
19650 takes the same parameters as the Emacs @code{run-at-time}. When running
19651 Gnus under Emacs, the former function is just an alias for the latter.
19652 However, when running under XEmacs, the former is an alias for the
19653 following function:
19656 (defun gnus-xmas-run-at-time (time repeat function &rest args)
19660 (,function ,@@args))
19664 This sort of thing has been done for bunches of functions. Gnus does
19665 not redefine any native Emacs functions while running under XEmacs---it
19666 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
19669 In the cases where the XEmacs function interface was obviously cleaner,
19670 I used it instead. For example @code{gnus-region-active-p} is an alias
19671 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
19673 Of course, I could have chosen XEmacs as my native platform and done
19674 mapping functions the other way around. But I didn't. The performance
19675 hit these indirections impose on Gnus under XEmacs should be slight.
19678 @node Various File Formats
19679 @subsection Various File Formats
19682 * Active File Format:: Information on articles and groups available.
19683 * Newsgroups File Format:: Group descriptions.
19687 @node Active File Format
19688 @subsubsection Active File Format
19690 The active file lists all groups available on the server in
19691 question. It also lists the highest and lowest current article numbers
19694 Here's an excerpt from a typical active file:
19697 soc.motss 296030 293865 y
19698 alt.binaries.pictures.fractals 3922 3913 n
19699 comp.sources.unix 1605 1593 m
19700 comp.binaries.ibm.pc 5097 5089 y
19701 no.general 1000 900 y
19704 Here's a pseudo-BNF definition of this file:
19707 active = *group-line
19708 group-line = group space high-number space low-number space flag <NEWLINE>
19709 group = <non-white-space string>
19711 high-number = <non-negative integer>
19712 low-number = <positive integer>
19713 flag = "y" / "n" / "m" / "j" / "x" / "=" group
19716 For a full description of this file, see the manual pages for
19717 @samp{innd}, in particular @samp{active(5)}.
19720 @node Newsgroups File Format
19721 @subsubsection Newsgroups File Format
19723 The newsgroups file lists groups along with their descriptions. Not all
19724 groups on the server have to be listed, and not all groups in the file
19725 have to exist on the server. The file is meant purely as information to
19728 The format is quite simple; a group name, a tab, and the description.
19729 Here's the definition:
19733 line = group tab description <NEWLINE>
19734 group = <non-white-space string>
19736 description = <string>
19741 @node Emacs for Heathens
19742 @section Emacs for Heathens
19744 Believe it or not, but some people who use Gnus haven't really used
19745 Emacs much before they embarked on their journey on the Gnus Love Boat.
19746 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
19747 region'', and ``set @code{gnus-flargblossen} to an alist where the key
19748 is a regexp that is used for matching on the group name'' are magical
19749 phrases with little or no meaning, then this appendix is for you. If
19750 you are already familiar with Emacs, just ignore this and go fondle your
19754 * Keystrokes:: Entering text and executing commands.
19755 * Emacs Lisp:: The built-in Emacs programming language.
19760 @subsection Keystrokes
19764 Q: What is an experienced Emacs user?
19767 A: A person who wishes that the terminal had pedals.
19770 Yes, when you use Emacs, you are apt to use the control key, the shift
19771 key and the meta key a lot. This is very annoying to some people
19772 (notably @code{vi}le users), and the rest of us just love the hell out
19773 of it. Just give up and submit. Emacs really does stand for
19774 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
19775 may have heard from other disreputable sources (like the Emacs author).
19777 The shift keys are normally located near your pinky fingers, and are
19778 normally used to get capital letters and stuff. You probably use it all
19779 the time. The control key is normally marked ``CTRL'' or something like
19780 that. The meta key is, funnily enough, never marked as such on any
19781 keyboard. The one I'm currently at has a key that's marked ``Alt'',
19782 which is the meta key on this keyboard. It's usually located somewhere
19783 to the left hand side of the keyboard, usually on the bottom row.
19785 Now, us Emacs people don't say ``press the meta-control-m key'',
19786 because that's just too inconvenient. We say ``press the @kbd{M-C-m}
19787 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
19788 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
19789 down the control key, and hold it down while you press @kbd{k}''.
19790 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
19791 the control key and then press @kbd{k}''. Simple, ay?
19793 This is somewhat complicated by the fact that not all keyboards have a
19794 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
19795 means ``press escape, release escape, press @kbd{k}''. That's much more
19796 work than if you have a meta key, so if that's the case, I respectfully
19797 suggest you get a real keyboard with a meta key. You can't live without
19803 @subsection Emacs Lisp
19805 Emacs is the King of Editors because it's really a Lisp interpreter.
19806 Each and every key you tap runs some Emacs Lisp code snippet, and since
19807 Emacs Lisp is an interpreted language, that means that you can configure
19808 any key to run any arbitrary code. You just, like, do it.
19810 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
19811 functions. (These are byte-compiled for speed, but it's still
19812 interpreted.) If you decide that you don't like the way Gnus does
19813 certain things, it's trivial to have it do something a different way.
19814 (Well, at least if you know how to write Lisp code.) However, that's
19815 beyond the scope of this manual, so we are simply going to talk about
19816 some common constructs that you normally use in your @file{.emacs} file
19819 If you want to set the variable @code{gnus-florgbnize} to four (4), you
19820 write the following:
19823 (setq gnus-florgbnize 4)
19826 This function (really ``special form'') @code{setq} is the one that can
19827 set a variable to some value. This is really all you need to know. Now
19828 you can go and fill your @code{.emacs} file with lots of these to change
19831 If you have put that thing in your @code{.emacs} file, it will be read
19832 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
19833 start Emacs. If you want to change the variable right away, simply say
19834 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
19835 previous ``form'', which is a simple @code{setq} statement here.
19837 Go ahead---just try it, if you're located at your Emacs. After you
19838 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
19839 is the return value of the form you @code{eval}ed.
19843 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
19847 (setq gnus-read-active-file 'some)
19850 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
19851 @samp{nntp.ifi.uio.no}'', that means:
19854 (setq gnus-nntp-server "nntp.ifi.uio.no")
19857 So be careful not to mix up strings (the latter) with symbols (the
19858 former). The manual is unambiguous, but it can be confusing.
19861 @include gnus-faq.texi