1 @c \input texinfo @c -*-texinfo-*-
4 @settitle Pterodactyl Gnus 0.91 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}}}
53 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
55 \newcommand{\gnusbullet}{{${\bullet}$}}
56 \newcommand{\gnusdollar}{\$}
57 \newcommand{\gnusampersand}{\&}
58 \newcommand{\gnuspercent}{\%}
59 \newcommand{\gnushash}{\#}
60 \newcommand{\gnushat}{\symbol{"5E}}
61 \newcommand{\gnusunderline}{\symbol{"5F}}
62 \newcommand{\gnusnot}{$\neg$}
63 \newcommand{\gnustilde}{\symbol{"7E}}
64 \newcommand{\gnusless}{{$<$}}
65 \newcommand{\gnusgreater}{{$>$}}
66 \newcommand{\gnusbraceleft}{{$>$}}
67 \newcommand{\gnusbraceright}{{$>$}}
69 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
70 \newcommand{\gnusinteresting}{
71 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
74 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
76 \newcommand{\gnuspagechapter}[1]{
83 \newcommand{\gnuschapter}[2]{
85 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
87 \renewcommand{\gnussectionname}{}
88 \renewcommand{\gnuschaptername}{#2}
91 \begin{picture}(500,500)(0,0)
92 \put(480,350){\makebox(0,0)[tr]{#1}}
93 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
98 \newcommand{\gnusfigure}[3]{
100 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
107 \newcommand{\gnusicon}[1]{
108 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=tmp/#1-up.ps,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=tmp/#1-up.ps,height=1cm}}}
111 \newcommand{\gnuspicon}[1]{
112 \margindex{\epsfig{figure=#1,width=2cm}}
115 \newcommand{\gnusxface}[2]{
116 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
119 \newcommand{\gnussmiley}[2]{
120 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
123 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
125 \newcommand{\gnussection}[1]{
126 \renewcommand{\gnussectionname}{#1}
130 \newenvironment{codelist}%
135 \newenvironment{kbdlist}%
141 \newenvironment{dfnlist}%
146 \newenvironment{stronglist}%
151 \newenvironment{samplist}%
156 \newenvironment{varlist}%
161 \newenvironment{emphlist}%
166 \newlength\gnusheadtextwidth
167 \setlength{\gnusheadtextwidth}{\headtextwidth}
168 \addtolength{\gnusheadtextwidth}{1cm}
170 \newpagestyle{gnuspreamble}%
175 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
179 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
188 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
190 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
195 \newpagestyle{gnusindex}%
200 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
204 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
212 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
214 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
224 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
228 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
236 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
238 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
243 \pagenumbering{roman}
244 \pagestyle{gnuspreamble}
254 %\addtolength{\oddsidemargin}{-5cm}
255 %\addtolength{\evensidemargin}{-5cm}
257 \addtolength{\textheight}{2cm}
259 \gnustitle{\gnustitlename}\\
262 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
265 \gnusauthor{by Lars Magne Ingebrigtsen}
272 \thispagestyle{empty}
274 Copyright \copyright{} 1995,96,97,98,99 Free Software Foundation, Inc.
276 Permission is granted to make and distribute verbatim copies of
277 this manual provided the copyright notice and this permission notice
278 are preserved on all copies.
280 Permission is granted to copy and distribute modified versions of this
281 manual under the conditions for verbatim copying, provided that the
282 entire resulting derived work is distributed under the terms of a
283 permission notice identical to this one.
285 Permission is granted to copy and distribute translations of this manual
286 into another language, under the above conditions for modified versions.
295 This file documents Gnus, the GNU Emacs newsreader.
297 Copyright (C) 1995,96,97,98,99 Free Software Foundation, Inc.
299 Permission is granted to make and distribute verbatim copies of
300 this manual provided the copyright notice and this permission notice
301 are preserved on all copies.
304 Permission is granted to process this file through Tex and print the
305 results, provided the printed document carries copying permission
306 notice identical to this one except for the removal of this paragraph
307 (this paragraph not being relevant to the printed manual).
310 Permission is granted to copy and distribute modified versions of this
311 manual under the conditions for verbatim copying, provided also that the
312 entire resulting derived work is distributed under the terms of a
313 permission notice identical to this one.
315 Permission is granted to copy and distribute translations of this manual
316 into another language, under the above conditions for modified versions.
322 @title Pterodactyl Gnus 0.91 Manual
324 @author by Lars Magne Ingebrigtsen
327 @vskip 0pt plus 1filll
328 Copyright @copyright{} 1995,96,97,98,99 Free Software Foundation, Inc.
330 Permission is granted to make and distribute verbatim copies of
331 this manual provided the copyright notice and this permission notice
332 are preserved on all copies.
334 Permission is granted to copy and distribute modified versions of this
335 manual under the conditions for verbatim copying, provided that the
336 entire resulting derived work is distributed under the terms of a
337 permission notice identical to this one.
339 Permission is granted to copy and distribute translations of this manual
340 into another language, under the above conditions for modified versions.
349 @top The Gnus Newsreader
353 You can read news (and mail) from within Emacs by using Gnus. The news
354 can be gotten by any nefarious means you can think of---@sc{nntp}, local
355 spool or your mbox file. All at the same time, if you want to push your
358 This manual corresponds to Pterodactyl Gnus 0.91.
369 Gnus is the advanced, self-documenting, customizable, extensible
370 unreal-time newsreader for GNU Emacs.
372 Oops. That sounds oddly familiar, so let's start over again to avoid
373 being accused of plagiarism:
375 Gnus is a message-reading laboratory. It will let you look at just
376 about anything as if it were a newsgroup. You can read mail with it,
377 you can browse directories with it, you can @code{ftp} with it---you can
378 even read news with it!
380 Gnus tries to empower people who read news the same way Emacs empowers
381 people who edit text. Gnus sets no limits to what the user should be
382 allowed to do. Users are encouraged to extend Gnus to make it behave
383 like they want it to behave. A program should not control people;
384 people should be empowered to do what they want by using (or abusing)
391 * Starting Up:: Finding news can be a pain.
392 * The Group Buffer:: Selecting, subscribing and killing groups.
393 * The Summary Buffer:: Reading, saving and posting articles.
394 * The Article Buffer:: Displaying and handling articles.
395 * Composing Messages:: Information on sending mail and news.
396 * Select Methods:: Gnus reads all messages from various select methods.
397 * Scoring:: Assigning values to articles.
398 * Various:: General purpose settings.
399 * The End:: Farewell and goodbye.
400 * Appendices:: Terminology, Emacs intro, FAQ, History, Internals.
401 * Index:: Variable, function and concept index.
402 * Key Index:: Key Index.
406 @chapter Starting Gnus
411 If your system administrator has set things up properly, starting Gnus
412 and reading news is extremely easy---you just type @kbd{M-x gnus} in
415 @findex gnus-other-frame
416 @kindex M-x gnus-other-frame
417 If you want to start Gnus in a different frame, you can use the command
418 @kbd{M-x gnus-other-frame} instead.
420 If things do not go smoothly at startup, you have to twiddle some
421 variables in your @file{~/.gnus} file. This file is similar to
422 @file{~/.emacs}, but is read when gnus starts.
424 If you puzzle at any terms used in this manual, please refer to the
425 terminology section (@pxref{Terminology}).
428 * Finding the News:: Choosing a method for getting news.
429 * The First Time:: What does Gnus do the first time you start it?
430 * The Server is Down:: How can I read my mail then?
431 * Slave Gnusae:: You can have more than one Gnus active at a time.
432 * Fetching a Group:: Starting Gnus just to read a group.
433 * New Groups:: What is Gnus supposed to do with new groups?
434 * Startup Files:: Those pesky startup files---@file{.newsrc}.
435 * Auto Save:: Recovering from a crash.
436 * The Active File:: Reading the active file over a slow line Takes Time.
437 * Changing Servers:: You may want to move from one server to another.
438 * Startup Variables:: Other variables you might change.
442 @node Finding the News
443 @section Finding the News
446 @vindex gnus-select-method
448 The @code{gnus-select-method} variable says where Gnus should look for
449 news. This variable should be a list where the first element says
450 @dfn{how} and the second element says @dfn{where}. This method is your
451 native method. All groups not fetched with this method are
454 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
455 you want to get your daily dosage of news from, you'd say:
458 (setq gnus-select-method '(nntp "news.somewhere.edu"))
461 If you want to read directly from the local spool, say:
464 (setq gnus-select-method '(nnspool ""))
467 If you can use a local spool, you probably should, as it will almost
468 certainly be much faster.
470 @vindex gnus-nntpserver-file
472 @cindex @sc{nntp} server
473 If this variable is not set, Gnus will take a look at the
474 @code{NNTPSERVER} environment variable. If that variable isn't set,
475 Gnus will see whether @code{gnus-nntpserver-file}
476 (@file{/etc/nntpserver} by default) has any opinions on the matter. If
477 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server. That's a long shot, though.
479 @vindex gnus-nntp-server
480 If @code{gnus-nntp-server} is set, this variable will override
481 @code{gnus-select-method}. You should therefore set
482 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
484 @vindex gnus-secondary-servers
485 @vindex gnus-nntp-server
486 You can also make Gnus prompt you interactively for the name of an
487 @sc{nntp} server. If you give a non-numerical prefix to @code{gnus}
488 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
489 in the @code{gnus-secondary-servers} list (if any). You can also just
490 type in the name of any server you feel like visiting. (Note that this
491 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
492 gnus} later in the same Emacs session, Gnus will contact the same
495 @findex gnus-group-browse-foreign-server
497 However, if you use one @sc{nntp} server regularly and are just
498 interested in a couple of groups from a different server, you would be
499 better served by using the @kbd{B} command in the group buffer. It will
500 let you have a look at what groups are available, and you can subscribe
501 to any of the groups you want to. This also makes @file{.newsrc}
502 maintenance much tidier. @xref{Foreign Groups}.
504 @vindex gnus-secondary-select-methods
506 A slightly different approach to foreign groups is to set the
507 @code{gnus-secondary-select-methods} variable. The select methods
508 listed in this variable are in many ways just as native as the
509 @code{gnus-select-method} server. They will also be queried for active
510 files during startup (if that's required), and new newsgroups that
511 appear on these servers will be subscribed (or not) just as native
514 For instance, if you use the @code{nnmbox} backend to read your mail, you
515 would typically set this variable to
518 (setq gnus-secondary-select-methods '((nnmbox "")))
523 @section The First Time
524 @cindex first time usage
526 If no startup files exist, Gnus will try to determine what groups should
527 be subscribed by default.
529 @vindex gnus-default-subscribed-newsgroups
530 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
531 will subscribe you to just those groups in that list, leaving the rest
532 killed. Your system administrator should have set this variable to
535 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
536 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
537 here as @dfn{whatever Lars thinks you should read}.)
539 You'll also be subscribed to the Gnus documentation group, which should
540 help you with most common problems.
542 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
543 use the normal functions for handling new groups, and not do anything
547 @node The Server is Down
548 @section The Server is Down
549 @cindex server errors
551 If the default server is down, Gnus will understandably have some
552 problems starting. However, if you have some mail groups in addition to
553 the news groups, you may want to start Gnus anyway.
555 Gnus, being the trusting sort of program, will ask whether to proceed
556 without a native select method if that server can't be contacted. This
557 will happen whether the server doesn't actually exist (i.e., you have
558 given the wrong address) or the server has just momentarily taken ill
559 for some reason or other. If you decide to continue and have no foreign
560 groups, you'll find it difficult to actually do anything in the group
561 buffer. But, hey, that's your problem. Blllrph!
563 @findex gnus-no-server
564 @kindex M-x gnus-no-server
566 If you know that the server is definitely down, or you just want to read
567 your mail without bothering with the server at all, you can use the
568 @code{gnus-no-server} command to start Gnus. That might come in handy
569 if you're in a hurry as well. This command will not attempt to contact
570 your primary server---instead, it will just activate all groups on level
571 1 and 2. (You should preferably keep no native groups on those two
576 @section Slave Gnusae
579 You might want to run more than one Emacs with more than one Gnus at the
580 same time. If you are using different @file{.newsrc} files (e.g., if you
581 are using the two different Gnusae to read from two different servers),
582 that is no problem whatsoever. You just do it.
584 The problem appears when you want to run two Gnusae that use the same
587 To work around that problem some, we here at the Think-Tank at the Gnus
588 Towers have come up with a new concept: @dfn{Masters} and
589 @dfn{slaves}. (We have applied for a patent on this concept, and have
590 taken out a copyright on those words. If you wish to use those words in
591 conjunction with each other, you have to send $1 per usage instance to
592 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
593 Applications}) will be much more expensive, of course.)
595 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
596 however you do it). Each subsequent slave Gnusae should be started with
597 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
598 files, but instead save @dfn{slave files} that contain information only
599 on what groups have been read in the slave session. When a master Gnus
600 starts, it will read (and delete) these slave files, incorporating all
601 information from them. (The slave files will be read in the sequence
602 they were created, so the latest changes will have precedence.)
604 Information from the slave files has, of course, precedence over the
605 information in the normal (i.e., master) @code{.newsrc} file.
608 @node Fetching a Group
609 @section Fetching a Group
610 @cindex fetching a group
612 @findex gnus-fetch-group
613 It is sometimes convenient to be able to just say ``I want to read this
614 group and I don't care whether Gnus has been started or not''. This is
615 perhaps more useful for people who write code than for users, but the
616 command @code{gnus-fetch-group} provides this functionality in any case.
617 It takes the group name as a parameter.
625 @vindex gnus-check-new-newsgroups
626 If you are satisfied that you really never want to see any new groups,
627 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
628 also save you some time at startup. Even if this variable is
629 @code{nil}, you can always subscribe to the new groups just by pressing
630 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
631 is @code{ask-server} by default. If you set this variable to
632 @code{always}, then Gnus will query the backends for new groups even
633 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
636 * Checking New Groups:: Determining what groups are new.
637 * Subscription Methods:: What Gnus should do with new groups.
638 * Filtering New Groups:: Making Gnus ignore certain new groups.
642 @node Checking New Groups
643 @subsection Checking New Groups
645 Gnus normally determines whether a group is new or not by comparing the
646 list of groups from the active file(s) with the lists of subscribed and
647 dead groups. This isn't a particularly fast method. If
648 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
649 server for new groups since the last time. This is both faster and
650 cheaper. This also means that you can get rid of the list of killed
651 groups altogether, so you may set @code{gnus-save-killed-list} to
652 @code{nil}, which will save time both at startup, at exit, and all over.
653 Saves disk space, too. Why isn't this the default, then?
654 Unfortunately, not all servers support this command.
656 I bet I know what you're thinking now: How do I find out whether my
657 server supports @code{ask-server}? No? Good, because I don't have a
658 fail-safe answer. I would suggest just setting this variable to
659 @code{ask-server} and see whether any new groups appear within the next
660 few days. If any do, then it works. If none do, then it doesn't
661 work. I could write a function to make Gnus guess whether the server
662 supports @code{ask-server}, but it would just be a guess. So I won't.
663 You could @code{telnet} to the server and say @code{HELP} and see
664 whether it lists @samp{NEWGROUPS} among the commands it understands. If
665 it does, then it might work. (But there are servers that lists
666 @samp{NEWGROUPS} without supporting the function properly.)
668 This variable can also be a list of select methods. If so, Gnus will
669 issue an @code{ask-server} command to each of the select methods, and
670 subscribe them (or not) using the normal methods. This might be handy
671 if you are monitoring a few servers for new groups. A side effect is
672 that startup will take much longer, so you can meditate while waiting.
673 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
676 @node Subscription Methods
677 @subsection Subscription Methods
679 @vindex gnus-subscribe-newsgroup-method
680 What Gnus does when it encounters a new group is determined by the
681 @code{gnus-subscribe-newsgroup-method} variable.
683 This variable should contain a function. This function will be called
684 with the name of the new group as the only parameter.
686 Some handy pre-fab functions are:
690 @item gnus-subscribe-zombies
691 @vindex gnus-subscribe-zombies
692 Make all new groups zombies. This is the default. You can browse the
693 zombies later (with @kbd{A z}) and either kill them all off properly
694 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
696 @item gnus-subscribe-randomly
697 @vindex gnus-subscribe-randomly
698 Subscribe all new groups in arbitrary order. This really means that all
699 new groups will be added at ``the top'' of the group buffer.
701 @item gnus-subscribe-alphabetically
702 @vindex gnus-subscribe-alphabetically
703 Subscribe all new groups in alphabetical order.
705 @item gnus-subscribe-hierarchically
706 @vindex gnus-subscribe-hierarchically
707 Subscribe all new groups hierarchically. The difference between this
708 function and @code{gnus-subscribe-alphabetically} is slight.
709 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
710 alphabetical fashion, while this function will enter groups into its
711 hierarchy. So if you want to have the @samp{rec} hierarchy before the
712 @samp{comp} hierarchy, this function will not mess that configuration
713 up. Or something like that.
715 @item gnus-subscribe-interactively
716 @vindex gnus-subscribe-interactively
717 Subscribe new groups interactively. This means that Gnus will ask
718 you about @strong{all} new groups. The groups you choose to subscribe
719 to will be subscribed hierarchically.
721 @item gnus-subscribe-killed
722 @vindex gnus-subscribe-killed
727 @vindex gnus-subscribe-hierarchical-interactive
728 A closely related variable is
729 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
730 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
731 hierarchical fashion whether to subscribe to new groups or not. Gnus
732 will ask you for each sub-hierarchy whether you want to descend the
735 One common mistake is to set the variable a few paragraphs above
736 (@code{gnus-subscribe-newsgroup-method}) to
737 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
738 will not work. This is ga-ga. So don't do it.
741 @node Filtering New Groups
742 @subsection Filtering New Groups
744 A nice and portable way to control which new newsgroups should be
745 subscribed (or ignored) is to put an @dfn{options} line at the start of
746 the @file{.newsrc} file. Here's an example:
749 options -n !alt.all !rec.all sci.all
752 @vindex gnus-subscribe-options-newsgroup-method
753 This line obviously belongs to a serious-minded intellectual scientific
754 person (or she may just be plain old boring), because it says that all
755 groups that have names beginning with @samp{alt} and @samp{rec} should
756 be ignored, and all groups with names beginning with @samp{sci} should
757 be subscribed. Gnus will not use the normal subscription method for
758 subscribing these groups.
759 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
760 variable defaults to @code{gnus-subscribe-alphabetically}.
762 @vindex gnus-options-not-subscribe
763 @vindex gnus-options-subscribe
764 If you don't want to mess with your @file{.newsrc} file, you can just
765 set the two variables @code{gnus-options-subscribe} and
766 @code{gnus-options-not-subscribe}. These two variables do exactly the
767 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
768 and if the new group matches the former, it will be unconditionally
769 subscribed, and if it matches the latter, it will be ignored.
771 @vindex gnus-auto-subscribed-groups
772 Yet another variable that meddles here is
773 @code{gnus-auto-subscribed-groups}. It works exactly like
774 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
775 thought it would be nice to have two of these. This variable is more
776 meant for setting some ground rules, while the other variable is used
777 more for user fiddling. By default this variable makes all new groups
778 that come from mail backends (@code{nnml}, @code{nnbabyl},
779 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you
780 don't like that, just set this variable to @code{nil}.
782 New groups that match this regexp are subscribed using
783 @code{gnus-subscribe-options-newsgroup-method}.
786 @node Changing Servers
787 @section Changing Servers
788 @cindex changing servers
790 Sometimes it is necessary to move from one @sc{nntp} server to another.
791 This happens very rarely, but perhaps you change jobs, or one server is
792 very flaky and you want to use another.
794 Changing the server is pretty easy, right? You just change
795 @code{gnus-select-method} to point to the new server?
799 Article numbers are not (in any way) kept synchronized between different
800 @sc{nntp} servers, and the only way Gnus keeps track of what articles
801 you have read is by keeping track of article numbers. So when you
802 change @code{gnus-select-method}, your @file{.newsrc} file becomes
805 Gnus provides a few functions to attempt to translate a @file{.newsrc}
806 file from one server to another. They all have one thing in
807 common---they take a looong time to run. You don't want to use these
808 functions more than absolutely necessary.
810 @kindex M-x gnus-change-server
811 @findex gnus-change-server
812 If you have access to both servers, Gnus can request the headers for all
813 the articles you have read and compare @code{Message-ID}s and map the
814 article numbers of the read articles and article marks. The @kbd{M-x
815 gnus-change-server} command will do this for all your native groups. It
816 will prompt for the method you want to move to.
818 @kindex M-x gnus-group-move-group-to-server
819 @findex gnus-group-move-group-to-server
820 You can also move individual groups with the @kbd{M-x
821 gnus-group-move-group-to-server} command. This is useful if you want to
822 move a (foreign) group from one server to another.
824 @kindex M-x gnus-group-clear-data-on-native-groups
825 @findex gnus-group-clear-data-on-native-groups
826 If you don't have access to both the old and new server, all your marks
827 and read ranges have become worthless. You can use the @kbd{M-x
828 gnus-group-clear-data-on-native-groups} command to clear out all data
829 that you have on your native groups. Use with caution.
831 After changing servers, you @strong{must} move the cache hierarchy away,
832 since the cached articles will have wrong article numbers, which will
833 affect which articles Gnus thinks are read.
837 @section Startup Files
838 @cindex startup files
843 Now, you all know about the @file{.newsrc} file. All subscription
844 information is traditionally stored in this file.
846 Things got a bit more complicated with @sc{gnus}. In addition to
847 keeping the @file{.newsrc} file updated, it also used a file called
848 @file{.newsrc.el} for storing all the information that didn't fit into
849 the @file{.newsrc} file. (Actually, it also duplicated everything in
850 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
851 files was the most recently saved, which enabled people to swap between
852 @sc{gnus} and other newsreaders.
854 That was kinda silly, so Gnus went one better: In addition to the
855 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
856 @file{.newsrc.eld}. It will read whichever of these files that are most
857 recent, but it will never write a @file{.newsrc.el} file. You should
858 never delete the @file{.newsrc.eld} file---it contains much information
859 not stored in the @file{.newsrc} file.
861 @vindex gnus-save-newsrc-file
862 @vindex gnus-read-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? Similarly, setting
868 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
869 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
870 convenient if you have a tendency to use Netscape once in a while.
872 @vindex gnus-save-killed-list
873 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
874 will not save the list of killed groups to the startup file. This will
875 save both time (when starting and quitting) and space (on disk). It
876 will also mean that Gnus has no record of what groups are new or old,
877 so the automatic new groups subscription methods become meaningless.
878 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
879 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
880 Groups}). This variable can also be a regular expression. If that's
881 the case, remove all groups that do not match this regexp before
882 saving. This can be useful in certain obscure situations that involve
883 several servers where not all servers support @code{ask-server}.
885 @vindex gnus-startup-file
886 The @code{gnus-startup-file} variable says where the startup files are.
887 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
888 file being whatever that one is, with a @samp{.eld} appended.
890 @vindex gnus-save-newsrc-hook
891 @vindex gnus-save-quick-newsrc-hook
892 @vindex gnus-save-standard-newsrc-hook
893 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
894 files, while @code{gnus-save-quick-newsrc-hook} is called just before
895 saving the @file{.newsrc.eld} file, and
896 @code{gnus-save-standard-newsrc-hook} is called just before saving the
897 @file{.newsrc} file. The latter two are commonly used to turn version
898 control on or off. Version control is on by default when saving the
899 startup files. If you want to turn backup creation off, say something like:
902 (defun turn-off-backup ()
903 (set (make-local-variable 'backup-inhibited) t))
905 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
906 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
909 @vindex gnus-init-file
910 When Gnus starts, it will read the @code{gnus-site-init-file}
911 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
912 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
913 and can be used to avoid cluttering your @file{~/.emacs} and
914 @file{site-init} files with Gnus stuff. Gnus will also check for files
915 with the same names as these, but with @file{.elc} and @file{.el}
916 suffixes. In other words, if you have set @code{gnus-init-file} to
917 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
918 and finally @file{~/.gnus} (in this order).
927 Whenever you do something that changes the Gnus data (reading articles,
928 catching up, killing/subscribing groups), the change is added to a
929 special @dfn{dribble buffer}. This buffer is auto-saved the normal
930 Emacs way. If your Emacs should crash before you have saved the
931 @file{.newsrc} files, all changes you have made can be recovered from
934 If Gnus detects this file at startup, it will ask the user whether to
935 read it. The auto save file is deleted whenever the real startup file is
938 @vindex gnus-use-dribble-file
939 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
940 maintain a dribble buffer. The default is @code{t}.
942 @vindex gnus-dribble-directory
943 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
944 this variable is @code{nil}, which it is by default, Gnus will dribble
945 into the directory where the @file{.newsrc} file is located. (This is
946 normally the user's home directory.) The dribble file will get the same
947 file permissions as the @code{.newsrc} file.
949 @vindex gnus-always-read-dribble-file
950 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
951 read the dribble file on startup without querying the user.
954 @node The Active File
955 @section The Active File
957 @cindex ignored groups
959 When Gnus starts, or indeed whenever it tries to determine whether new
960 articles have arrived, it reads the active file. This is a very large
961 file that lists all the active groups and articles on the server.
963 @vindex gnus-ignored-newsgroups
964 Before examining the active file, Gnus deletes all lines that match the
965 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
966 any groups with bogus names, but you can use this variable to make Gnus
967 ignore hierarchies you aren't ever interested in. However, this is not
968 recommended. In fact, it's highly discouraged. Instead, @pxref{New
969 Groups} for an overview of other variables that can be used instead.
972 @c @code{nil} by default, and will slow down active file handling somewhat
973 @c if you set it to anything else.
975 @vindex gnus-read-active-file
977 The active file can be rather Huge, so if you have a slow network, you
978 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
979 reading the active file. This variable is @code{some} by default.
981 Gnus will try to make do by getting information just on the groups that
982 you actually subscribe to.
984 Note that if you subscribe to lots and lots of groups, setting this
985 variable to @code{nil} will probably make Gnus slower, not faster. At
986 present, having this variable @code{nil} will slow Gnus down
987 considerably, unless you read news over a 2400 baud modem.
989 This variable can also have the value @code{some}. Gnus will then
990 attempt to read active info only on the subscribed groups. On some
991 servers this is quite fast (on sparkling, brand new INN servers that
992 support the @code{LIST ACTIVE group} command), on others this isn't fast
993 at all. In any case, @code{some} should be faster than @code{nil}, and
994 is certainly faster than @code{t} over slow lines.
996 Some news servers (Leafnode and old versions of INN, for instance) do
997 not support the @code{LIST ACTIVE group}. For these servers, @code{nil}
998 is probably the most effficient value for this variable.
1000 If this variable is @code{nil}, Gnus will ask for group info in total
1001 lock-step, which isn't very fast. If it is @code{some} and you use an
1002 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
1003 read all the replies in one swoop. This will normally result in better
1004 performance, but if the server does not support the aforementioned
1005 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1007 If you think that starting up Gnus takes too long, try all the three
1008 different values for this variable and see what works best for you.
1010 In any case, if you use @code{some} or @code{nil}, you should definitely
1011 kill all groups that you aren't interested in to speed things up.
1013 Note that this variable also affects active file retrieval from
1014 secondary select methods.
1017 @node Startup Variables
1018 @section Startup Variables
1022 @item gnus-load-hook
1023 @vindex gnus-load-hook
1024 A hook run while Gnus is being loaded. Note that this hook will
1025 normally be run just once in each Emacs session, no matter how many
1026 times you start Gnus.
1028 @item gnus-before-startup-hook
1029 @vindex gnus-before-startup-hook
1030 A hook run after starting up Gnus successfully.
1032 @item gnus-startup-hook
1033 @vindex gnus-startup-hook
1034 A hook run as the very last thing after starting up Gnus
1036 @item gnus-started-hook
1037 @vindex gnus-started-hook
1038 A hook that is run as the very last thing after starting up Gnus
1041 @item gnus-setup-news-hook
1042 @vindex gnus-setup-news-hook
1043 A hook that is run after reading the @file{.newsrc} file(s), but before
1044 generating the group buffer.
1046 @item gnus-check-bogus-newsgroups
1047 @vindex gnus-check-bogus-newsgroups
1048 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1049 startup. A @dfn{bogus group} is a group that you have in your
1050 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1051 bogus groups can take quite a while, so to save time and resources it's
1052 best to leave this option off, and do the checking for bogus groups once
1053 in a while from the group buffer instead (@pxref{Group Maintenance}).
1055 @item gnus-inhibit-startup-message
1056 @vindex gnus-inhibit-startup-message
1057 If non-@code{nil}, the startup message won't be displayed. That way,
1058 your boss might not notice as easily that you are reading news instead
1059 of doing your job. Note that this variable is used before
1060 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1062 @item gnus-no-groups-message
1063 @vindex gnus-no-groups-message
1064 Message displayed by Gnus when no groups are available.
1066 @item gnus-play-startup-jingle
1067 @vindex gnus-play-startup-jingle
1068 If non-@code{nil}, play the Gnus jingle at startup.
1070 @item gnus-startup-jingle
1071 @vindex gnus-startup-jingle
1072 Jingle to be played if the above variable is non-@code{nil}. The
1073 default is @samp{Tuxedomoon.Jingle4.au}.
1078 @node The Group Buffer
1079 @chapter The Group Buffer
1080 @cindex group buffer
1082 The @dfn{group buffer} lists all (or parts) of the available groups. It
1083 is the first buffer shown when Gnus starts, and will never be killed as
1084 long as Gnus is active.
1088 \gnusfigure{The Group Buffer}{320}{
1089 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1090 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1091 \put(120,38){\vector(1,2){10}}
1092 \put(40,60){\makebox(0,0)[r]{Mode line}}
1093 \put(40,58){\vector(1,0){30}}
1094 \put(200,28){\makebox(0,0)[t]{Native select method}}
1095 \put(200,26){\vector(-1,2){15}}
1101 * Group Buffer Format:: Information listed and how you can change it.
1102 * Group Maneuvering:: Commands for moving in the group buffer.
1103 * Selecting a Group:: Actually reading news.
1104 * Group Data:: Changing the info for a group.
1105 * Subscription Commands:: Unsubscribing, killing, subscribing.
1106 * Group Levels:: Levels? What are those, then?
1107 * Group Score:: A mechanism for finding out what groups you like.
1108 * Marking Groups:: You can mark groups for later processing.
1109 * Foreign Groups:: Creating and editing groups.
1110 * Group Parameters:: Each group may have different parameters set.
1111 * Listing Groups:: Gnus can list various subsets of the groups.
1112 * Sorting Groups:: Re-arrange the group order.
1113 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1114 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1115 * Exiting Gnus:: Stop reading news and get some work done.
1116 * Group Topics:: A folding group mode divided into topics.
1117 * Misc Group Stuff:: Other stuff that you can to do.
1121 @node Group Buffer Format
1122 @section Group Buffer Format
1125 * Group Line Specification:: Deciding how the group buffer is to look.
1126 * Group Modeline Specification:: The group buffer modeline.
1127 * Group Highlighting:: Having nice colors in the group buffer.
1131 @node Group Line Specification
1132 @subsection Group Line Specification
1133 @cindex group buffer format
1135 The default format of the group buffer is nice and dull, but you can
1136 make it as exciting and ugly as you feel like.
1138 Here's a couple of example group lines:
1141 25: news.announce.newusers
1142 * 0: alt.fan.andrea-dworkin
1147 You can see that there are 25 unread articles in
1148 @samp{news.announce.newusers}. There are no unread articles, but some
1149 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1150 asterisk at the beginning of the line?).
1152 @vindex gnus-group-line-format
1153 You can change that format to whatever you want by fiddling with the
1154 @code{gnus-group-line-format} variable. This variable works along the
1155 lines of a @code{format} specification, which is pretty much the same as
1156 a @code{printf} specifications, for those of you who use (feh!) C.
1157 @xref{Formatting Variables}.
1159 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1161 There should always be a colon on the line; the cursor always moves to
1162 the colon after performing an operation. Nothing else is required---not
1163 even the group name. All displayed text is just window dressing, and is
1164 never examined by Gnus. Gnus stores all real information it needs using
1167 (Note that if you make a really strange, wonderful, spreadsheet-like
1168 layout, everybody will believe you are hard at work with the accounting
1169 instead of wasting time reading news.)
1171 Here's a list of all available format characters:
1176 An asterisk if the group only has marked articles.
1179 Whether the group is subscribed.
1182 Level of subscribedness.
1185 Number of unread articles.
1188 Number of dormant articles.
1191 Number of ticked articles.
1194 Number of read articles.
1197 Estimated total number of articles. (This is really @var{max-number}
1198 minus @var{min-number} plus 1.)
1201 Number of unread, unticked, non-dormant articles.
1204 Number of ticked and dormant articles.
1213 Newsgroup description.
1216 @samp{m} if moderated.
1219 @samp{(m)} if moderated.
1228 A string that looks like @samp{<%s:%n>} if a foreign select method is
1232 Indentation based on the level of the topic (@pxref{Group Topics}).
1235 @vindex gnus-group-uncollapsed-levels
1236 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1237 variable says how many levels to leave at the end of the group name.
1238 The default is 1---this will mean that group names like
1239 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1242 @vindex gnus-new-mail-mark
1244 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1248 A string that says when you last read the group (@pxref{Group
1252 User defined specifier. The next character in the format string should
1253 be a letter. Gnus will call the function
1254 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1255 following @samp{%u}. The function will be passed a single dummy
1256 parameter as argument. The function should return a string, which will
1257 be inserted into the buffer just like information from any other
1262 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1263 if no info is available---for instance, if it is a non-activated foreign
1264 group, or a bogus native group.
1267 @node Group Modeline Specification
1268 @subsection Group Modeline Specification
1269 @cindex group modeline
1271 @vindex gnus-group-mode-line-format
1272 The mode line can be changed by setting
1273 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1274 doesn't understand that many format specifiers:
1278 The native news server.
1280 The native select method.
1284 @node Group Highlighting
1285 @subsection Group Highlighting
1286 @cindex highlighting
1287 @cindex group highlighting
1289 @vindex gnus-group-highlight
1290 Highlighting in the group buffer is controlled by the
1291 @code{gnus-group-highlight} variable. This is an alist with elements
1292 that look like @var{(form . face)}. If @var{form} evaluates to
1293 something non-@code{nil}, the @var{face} will be used on the line.
1295 Here's an example value for this variable that might look nice if the
1299 (face-spec-set 'my-group-face-1
1300 '((t (:foreground "Red" :bold t))))
1301 (face-spec-set 'my-group-face-2
1302 '((t (:foreground "SeaGreen" :bold t))))
1303 (face-spec-set 'my-group-face-3
1304 '((t (:foreground "SpringGreen" :bold t))))
1305 (face-spec-set 'my-group-face-4
1306 '((t (:foreground "SteelBlue" :bold t))))
1307 (face-spec-set 'my-group-face-5
1308 '((t (:foreground "SkyBlue" :bold t))))
1310 (setq gnus-group-highlight
1311 '(((> unread 200) . my-group-face-1)
1312 ((and (< level 3) (zerop unread)) . my-group-face-2)
1313 ((< level 3) . my-group-face-3)
1314 ((zerop unread) . my-group-face-4)
1315 (t . my-group-face-5)))
1318 Also @pxref{Faces and Fonts}.
1320 Variables that are dynamically bound when the forms are evaluated
1327 The number of unread articles in the group.
1331 Whether the group is a mail group.
1333 The level of the group.
1335 The score of the group.
1337 The number of ticked articles in the group.
1339 The total number of articles in the group. Or rather, MAX-NUMBER minus
1340 MIN-NUMBER plus one.
1342 When using the topic minor mode, this variable is bound to the current
1343 topic being inserted.
1346 When the forms are @code{eval}ed, point is at the beginning of the line
1347 of the group in question, so you can use many of the normal Gnus
1348 functions for snarfing info on the group.
1350 @vindex gnus-group-update-hook
1351 @findex gnus-group-highlight-line
1352 @code{gnus-group-update-hook} is called when a group line is changed.
1353 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1354 calls @code{gnus-group-highlight-line} by default.
1357 @node Group Maneuvering
1358 @section Group Maneuvering
1359 @cindex group movement
1361 All movement commands understand the numeric prefix and will behave as
1362 expected, hopefully.
1368 @findex gnus-group-next-unread-group
1369 Go to the next group that has unread articles
1370 (@code{gnus-group-next-unread-group}).
1376 @findex gnus-group-prev-unread-group
1377 Go to the previous group that has unread articles
1378 (@code{gnus-group-prev-unread-group}).
1382 @findex gnus-group-next-group
1383 Go to the next group (@code{gnus-group-next-group}).
1387 @findex gnus-group-prev-group
1388 Go to the previous group (@code{gnus-group-prev-group}).
1392 @findex gnus-group-next-unread-group-same-level
1393 Go to the next unread group on the same (or lower) level
1394 (@code{gnus-group-next-unread-group-same-level}).
1398 @findex gnus-group-prev-unread-group-same-level
1399 Go to the previous unread group on the same (or lower) level
1400 (@code{gnus-group-prev-unread-group-same-level}).
1403 Three commands for jumping to groups:
1409 @findex gnus-group-jump-to-group
1410 Jump to a group (and make it visible if it isn't already)
1411 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
1416 @findex gnus-group-best-unread-group
1417 Jump to the unread group with the lowest level
1418 (@code{gnus-group-best-unread-group}).
1422 @findex gnus-group-first-unread-group
1423 Jump to the first group with unread articles
1424 (@code{gnus-group-first-unread-group}).
1427 @vindex gnus-group-goto-unread
1428 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1429 commands will move to the next group, not the next unread group. Even
1430 the commands that say they move to the next unread group. The default
1434 @node Selecting a Group
1435 @section Selecting a Group
1436 @cindex group selection
1441 @kindex SPACE (Group)
1442 @findex gnus-group-read-group
1443 Select the current group, switch to the summary buffer and display the
1444 first unread article (@code{gnus-group-read-group}). If there are no
1445 unread articles in the group, or if you give a non-numerical prefix to
1446 this command, Gnus will offer to fetch all the old articles in this
1447 group from the server. If you give a numerical prefix @var{N}, @var{N}
1448 determines the number of articles Gnus will fetch. If @var{N} is
1449 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1450 negative, Gnus fetches the @var{abs(N)} oldest articles.
1454 @findex gnus-group-select-group
1455 Select the current group and switch to the summary buffer
1456 (@code{gnus-group-select-group}). Takes the same arguments as
1457 @code{gnus-group-read-group}---the only difference is that this command
1458 does not display the first unread article automatically upon group
1462 @kindex M-RET (Group)
1463 @findex gnus-group-quick-select-group
1464 This does the same as the command above, but tries to do it with the
1465 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
1466 scoring/killing will be performed, there will be no highlights and no
1467 expunging. This might be useful if you're in a real hurry and have to
1468 enter some humongous group. If you give a 0 prefix to this command
1469 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1470 which is useful if you want to toggle threading before generating the
1471 summary buffer (@pxref{Summary Generation Commands}).
1474 @kindex M-SPACE (Group)
1475 @findex gnus-group-visible-select-group
1476 This is yet one more command that does the same as the @kbd{RET}
1477 command, but this one does it without expunging and hiding dormants
1478 (@code{gnus-group-visible-select-group}).
1481 @kindex M-C-RET (Group)
1482 @findex gnus-group-select-group-ephemerally
1483 Finally, this command selects the current group ephemerally without
1484 doing any processing of its contents
1485 (@code{gnus-group-select-group-ephemerally}). Even threading has been
1486 turned off. Everything you do in the group after selecting it in this
1487 manner will have no permanent effects.
1491 @vindex gnus-large-newsgroup
1492 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1493 to be a big group. This is 200 by default. If the group has more
1494 (unread and/or ticked) articles than this, Gnus will query the user
1495 before entering the group. The user can then specify how many articles
1496 should be fetched from the server. If the user specifies a negative
1497 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
1498 is positive, the @code{n} articles that have arrived most recently will
1501 @vindex gnus-select-group-hook
1502 @vindex gnus-auto-select-first
1503 @code{gnus-auto-select-first} control whether any articles are selected
1504 automatically when entering a group with the @kbd{SPACE} command.
1509 Don't select any articles when entering the group. Just display the
1510 full summary buffer.
1513 Select the first unread article when entering the group.
1516 Select the highest scored article in the group when entering the
1521 This variable can also be a function. In that case, that function will
1522 be called to place point on a subject line, and/or select some article.
1523 Useful functions include:
1526 @item gnus-summary-first-unread-subject
1527 Place point on the subject line of the first unread article, but
1528 don't select the article.
1530 @item gnus-summary-first-unread-article
1531 Select the first unread article.
1533 @item gnus-summary-best-unread-article
1534 Select the highest-scored unread article.
1538 If you want to prevent automatic selection in some group (say, in a
1539 binary group with Huge articles) you can set this variable to @code{nil}
1540 in @code{gnus-select-group-hook}, which is called when a group is
1544 @node Subscription Commands
1545 @section Subscription Commands
1546 @cindex subscription
1554 @findex gnus-group-unsubscribe-current-group
1555 @c @icon{gnus-group-unsubscribe}
1556 Toggle subscription to the current group
1557 (@code{gnus-group-unsubscribe-current-group}).
1563 @findex gnus-group-unsubscribe-group
1564 Prompt for a group to subscribe, and then subscribe it. If it was
1565 subscribed already, unsubscribe it instead
1566 (@code{gnus-group-unsubscribe-group}).
1572 @findex gnus-group-kill-group
1573 @c @icon{gnus-group-kill-group}
1574 Kill the current group (@code{gnus-group-kill-group}).
1580 @findex gnus-group-yank-group
1581 Yank the last killed group (@code{gnus-group-yank-group}).
1584 @kindex C-x C-t (Group)
1585 @findex gnus-group-transpose-groups
1586 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
1587 really a subscription command, but you can use it instead of a
1588 kill-and-yank sequence sometimes.
1594 @findex gnus-group-kill-region
1595 Kill all groups in the region (@code{gnus-group-kill-region}).
1599 @findex gnus-group-kill-all-zombies
1600 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1603 @kindex S C-k (Group)
1604 @findex gnus-group-kill-level
1605 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1606 These groups can't be yanked back after killing, so this command should
1607 be used with some caution. The only time where this command comes in
1608 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1609 groups that you want to get rid off. @kbd{S C-k} on level 7 will
1610 kill off all unsubscribed groups that do not have message numbers in the
1611 @file{.newsrc} file.
1615 Also @pxref{Group Levels}.
1625 @findex gnus-group-catchup-current
1626 @vindex gnus-group-catchup-group-hook
1627 @c @icon{gnus-group-catchup-current}
1628 Mark all unticked articles in this group as read
1629 (@code{gnus-group-catchup-current}).
1630 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1635 @findex gnus-group-catchup-current-all
1636 Mark all articles in this group, even the ticked ones, as read
1637 (@code{gnus-group-catchup-current-all}).
1641 @findex gnus-group-clear-data
1642 Clear the data from the current group---nix out marks and the list of
1643 read articles (@code{gnus-group-clear-data}).
1645 @item M-x gnus-group-clear-data-on-native-groups
1646 @kindex M-x gnus-group-clear-data-on-native-groups
1647 @findex gnus-group-clear-data-on-native-groups
1648 If you have switched from one @sc{nntp} server to another, all your marks
1649 and read ranges have become worthless. You can use this command to
1650 clear out all data that you have on your native groups. Use with
1657 @section Group Levels
1661 All groups have a level of @dfn{subscribedness}. For instance, if a
1662 group is on level 2, it is more subscribed than a group on level 5. You
1663 can ask Gnus to just list groups on a given level or lower
1664 (@pxref{Listing Groups}), or to just check for new articles in groups on
1665 a given level or lower (@pxref{Scanning New Messages}).
1667 Remember: The higher the level of the group, the less important it is.
1673 @findex gnus-group-set-current-level
1674 Set the level of the current group. If a numeric prefix is given, the
1675 next @var{n} groups will have their levels set. The user will be
1676 prompted for a level.
1679 @vindex gnus-level-killed
1680 @vindex gnus-level-zombie
1681 @vindex gnus-level-unsubscribed
1682 @vindex gnus-level-subscribed
1683 Gnus considers groups from levels 1 to
1684 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1685 @code{gnus-level-subscribed} (exclusive) and
1686 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1687 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1688 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1689 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
1690 same, but zombie and killed groups have no information on what articles
1691 you have read, etc, stored. This distinction between dead and living
1692 groups isn't done because it is nice or clever, it is done purely for
1693 reasons of efficiency.
1695 It is recommended that you keep all your mail groups (if any) on quite
1696 low levels (e.g. 1 or 2).
1698 If you want to play with the level variables, you should show some care.
1699 Set them once, and don't touch them ever again. Better yet, don't touch
1700 them at all unless you know exactly what you're doing.
1702 @vindex gnus-level-default-unsubscribed
1703 @vindex gnus-level-default-subscribed
1704 Two closely related variables are @code{gnus-level-default-subscribed}
1705 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1706 which are the levels that new groups will be put on if they are
1707 (un)subscribed. These two variables should, of course, be inside the
1708 relevant valid ranges.
1710 @vindex gnus-keep-same-level
1711 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1712 will only move to groups of the same level (or lower). In
1713 particular, going from the last article in one group to the next group
1714 will go to the next group of the same level (or lower). This might be
1715 handy if you want to read the most important groups before you read the
1718 @vindex gnus-group-default-list-level
1719 All groups with a level less than or equal to
1720 @code{gnus-group-default-list-level} will be listed in the group buffer
1723 @vindex gnus-group-list-inactive-groups
1724 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1725 groups will be listed along with the unread groups. This variable is
1726 @code{t} by default. If it is @code{nil}, inactive groups won't be
1729 @vindex gnus-group-use-permanent-levels
1730 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1731 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1732 use this level as the ``work'' level.
1734 @vindex gnus-activate-level
1735 Gnus will normally just activate (i. e., query the server about) groups
1736 on level @code{gnus-activate-level} or less. If you don't want to
1737 activate unsubscribed groups, for instance, you might set this variable
1738 to 5. The default is 6.
1742 @section Group Score
1747 You would normally keep important groups on high levels, but that scheme
1748 is somewhat restrictive. Don't you wish you could have Gnus sort the
1749 group buffer according to how often you read groups, perhaps? Within
1752 This is what @dfn{group score} is for. You can have Gnus assign a score
1753 to each group through the mechanism described below. You can then sort
1754 the group buffer based on this score. Alternatively, you can sort on
1755 score and then level. (Taken together, the level and the score is
1756 called the @dfn{rank} of the group. A group that is on level 4 and has
1757 a score of 1 has a higher rank than a group on level 5 that has a score
1758 of 300. (The level is the most significant part and the score is the
1759 least significant part.))
1761 @findex gnus-summary-bubble-group
1762 If you want groups you read often to get higher scores than groups you
1763 read seldom you can add the @code{gnus-summary-bubble-group} function to
1764 the @code{gnus-summary-exit-hook} hook. This will result (after
1765 sorting) in a bubbling sort of action. If you want to see that in
1766 action after each summary exit, you can add
1767 @code{gnus-group-sort-groups-by-rank} or
1768 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1769 slow things down somewhat.
1772 @node Marking Groups
1773 @section Marking Groups
1774 @cindex marking groups
1776 If you want to perform some command on several groups, and they appear
1777 subsequently in the group buffer, you would normally just give a
1778 numerical prefix to the command. Most group commands will then do your
1779 bidding on those groups.
1781 However, if the groups are not in sequential order, you can still
1782 perform a command on several groups. You simply mark the groups first
1783 with the process mark and then execute the command.
1791 @findex gnus-group-mark-group
1792 Set the mark on the current group (@code{gnus-group-mark-group}).
1798 @findex gnus-group-unmark-group
1799 Remove the mark from the current group
1800 (@code{gnus-group-unmark-group}).
1804 @findex gnus-group-unmark-all-groups
1805 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1809 @findex gnus-group-mark-region
1810 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1814 @findex gnus-group-mark-buffer
1815 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1819 @findex gnus-group-mark-regexp
1820 Mark all groups that match some regular expression
1821 (@code{gnus-group-mark-regexp}).
1824 Also @pxref{Process/Prefix}.
1826 @findex gnus-group-universal-argument
1827 If you want to execute some command on all groups that have been marked
1828 with the process mark, you can use the @kbd{M-&}
1829 (@code{gnus-group-universal-argument}) command. It will prompt you for
1830 the command to be executed.
1833 @node Foreign Groups
1834 @section Foreign Groups
1835 @cindex foreign groups
1837 Below are some group mode commands for making and editing general foreign
1838 groups, as well as commands to ease the creation of a few
1839 special-purpose groups. All these commands insert the newly created
1840 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1847 @findex gnus-group-make-group
1848 @cindex making groups
1849 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
1850 for a name, a method and possibly an @dfn{address}. For an easier way
1851 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1855 @findex gnus-group-rename-group
1856 @cindex renaming groups
1857 Rename the current group to something else
1858 (@code{gnus-group-rename-group}). This is valid only on some
1859 groups---mail groups mostly. This command might very well be quite slow
1865 @findex gnus-group-customize
1866 Customize the group parameters (@code{gnus-group-customize}).
1870 @findex gnus-group-edit-group-method
1871 @cindex renaming groups
1872 Enter a buffer where you can edit the select method of the current
1873 group (@code{gnus-group-edit-group-method}).
1877 @findex gnus-group-edit-group-parameters
1878 Enter a buffer where you can edit the group parameters
1879 (@code{gnus-group-edit-group-parameters}).
1883 @findex gnus-group-edit-group
1884 Enter a buffer where you can edit the group info
1885 (@code{gnus-group-edit-group}).
1889 @findex gnus-group-make-directory-group
1891 Make a directory group (@pxref{Directory Groups}). You will be prompted
1892 for a directory name (@code{gnus-group-make-directory-group}).
1897 @findex gnus-group-make-help-group
1898 Make the Gnus help group (@code{gnus-group-make-help-group}).
1902 @cindex (ding) archive
1903 @cindex archive group
1904 @findex gnus-group-make-archive-group
1905 @vindex gnus-group-archive-directory
1906 @vindex gnus-group-recent-archive-directory
1907 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
1908 default a group pointing to the most recent articles will be created
1909 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1910 group will be created from @code{gnus-group-archive-directory}.
1914 @findex gnus-group-make-kiboze-group
1916 Make a kiboze group. You will be prompted for a name, for a regexp to
1917 match groups to be ``included'' in the kiboze group, and a series of
1918 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1919 @xref{Kibozed Groups}.
1923 @findex gnus-group-enter-directory
1925 Read an arbitrary directory as if it were a newsgroup with the
1926 @code{nneething} backend (@code{gnus-group-enter-directory}).
1927 @xref{Anything Groups}.
1931 @findex gnus-group-make-doc-group
1932 @cindex ClariNet Briefs
1934 Make a group based on some file or other
1935 (@code{gnus-group-make-doc-group}). If you give a prefix to this
1936 command, you will be prompted for a file name and a file type.
1937 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1938 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1939 @code{rfc934}, @code{rfc822-forward}, @code{nsmail} and @code{forward}.
1940 If you run this command without a prefix, Gnus will guess at the file
1941 type. @xref{Document Groups}.
1945 @vindex gnus-useful-groups
1946 @findex gnus-group-make-useful-group
1947 Create one of the groups mentioned in @code{gnus-useful-groups}
1948 (@code{gnus-group-make-useful-group}).
1952 @findex gnus-group-make-web-group
1957 Make an ephemeral group based on a web search
1958 (@code{gnus-group-make-web-group}). If you give a prefix to this
1959 command, make a solid group instead. You will be prompted for the
1960 search engine type and the search string. Valid search engine types
1961 include @code{dejanews}, @code{altavista} and @code{reference}.
1962 @xref{Web Searches}.
1964 If you use the @code{dejanews} search engine, you can limit the search
1965 to a particular group by using a match string like
1966 @samp{~g alt.sysadmin.recovery shaving}.
1969 @kindex G DEL (Group)
1970 @findex gnus-group-delete-group
1971 This function will delete the current group
1972 (@code{gnus-group-delete-group}). If given a prefix, this function will
1973 actually delete all the articles in the group, and forcibly remove the
1974 group itself from the face of the Earth. Use a prefix only if you are
1975 absolutely sure of what you are doing. This command can't be used on
1976 read-only groups (like @code{nntp} group), though.
1980 @findex gnus-group-make-empty-virtual
1981 Make a new, fresh, empty @code{nnvirtual} group
1982 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
1986 @findex gnus-group-add-to-virtual
1987 Add the current group to an @code{nnvirtual} group
1988 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
1991 @xref{Select Methods}, for more information on the various select
1994 @vindex gnus-activate-foreign-newsgroups
1995 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1996 Gnus will check all foreign groups with this level or lower at startup.
1997 This might take quite a while, especially if you subscribe to lots of
1998 groups from different @sc{nntp} servers. Also @pxref{Group Levels};
1999 @code{gnus-activate-level} also affects activation of foreign
2003 @node Group Parameters
2004 @section Group Parameters
2005 @cindex group parameters
2007 The group parameters store information local to a particular group.
2008 Here's an example group parameter list:
2011 ((to-address . "ding@@gnus.org")
2015 We see that each element consists of a "dotted pair"---the thing before
2016 the dot is the key, while the thing after the dot is the value. All the
2017 parameters have this form @emph{except} local variable specs, which are
2018 not dotted pairs, but proper lists.
2020 The following group parameters can be used:
2025 Address used by when doing followups and new posts.
2028 (to-address . "some@@where.com")
2031 This is primarily useful in mail groups that represent closed mailing
2032 lists---mailing lists where it's expected that everybody that writes to
2033 the mailing list is subscribed to it. Since using this parameter
2034 ensures that the mail only goes to the mailing list itself, it means
2035 that members won't receive two copies of your followups.
2037 Using @code{to-address} will actually work whether the group is foreign
2038 or not. Let's say there's a group on the server that is called
2039 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2040 the articles from a mail-to-news gateway. Posting directly to this
2041 group is therefore impossible---you have to send mail to the mailing
2042 list address instead.
2046 Address used when doing a @kbd{a} in that group.
2049 (to-list . "some@@where.com")
2052 It is totally ignored
2053 when doing a followup---except that if it is present in a news group,
2054 you'll get mail group semantics when doing @kbd{f}.
2056 If you do an @kbd{a} command in a mail group and you have neither a
2057 @code{to-list} group parameter nor a @code{to-address} group parameter,
2058 then a @code{to-list} group parameter will be added automatically upon
2059 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2060 @vindex gnus-add-to-list
2062 If you do an @kbd{a} command in a mail group and you don't have a
2063 @code{to-list} group parameter, one will be added automatically upon
2064 sending the message.
2068 If the group parameter list has the element @code{(visible . t)},
2069 that group will always be visible in the Group buffer, regardless
2070 of whether it has any unread articles.
2072 @item broken-reply-to
2073 @cindex broken-reply-to
2074 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2075 headers in this group are to be ignored. This can be useful if you're
2076 reading a mailing list group where the listserv has inserted
2077 @code{Reply-To} headers that point back to the listserv itself. This is
2078 broken behavior. So there!
2082 Elements like @code{(to-group . "some.group.name")} means that all
2083 posts in that group will be sent to @code{some.group.name}.
2087 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2088 will treat all responses as if they were responses to news articles.
2089 This can be useful if you have a mail group that's really a mirror of a
2094 If @code{(gcc-self . t)} is present in the group parameter list, newly
2095 composed messages will be @code{Gcc}'d to the current group. If
2096 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2097 generated, if @code{(gcc-self . "string")} is present, this string will
2098 be inserted literally as a @code{gcc} header. This parameter takes
2099 precedence over any default @code{Gcc} rules as described later
2100 (@pxref{Archived Messages}).
2104 If the group parameter has an element that looks like @code{(auto-expire
2105 . t)}, all articles read will be marked as expirable. For an
2106 alternative approach, @pxref{Expiring Mail}.
2109 @cindex total-expire
2110 If the group parameter has an element that looks like
2111 @code{(total-expire . t)}, all read articles will be put through the
2112 expiry process, even if they are not marked as expirable. Use with
2113 caution. Unread, ticked and dormant articles are not eligible for
2118 @vindex nnmail-expiry-wait-function
2119 If the group parameter has an element that looks like @code{(expiry-wait
2120 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2121 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2122 The value can either be a number of days (not necessarily an integer) or
2123 the symbols @code{never} or @code{immediate}.
2126 @cindex score file group parameter
2127 Elements that look like @code{(score-file . "file")} will make
2128 @file{file} into the current score file for the group in question. All
2129 interactive score entries will be put into this file.
2132 @cindex adapt file group parameter
2133 Elements that look like @code{(adapt-file . "file")} will make
2134 @file{file} into the current adaptive file for the group in question.
2135 All adaptive score entries will be put into this file.
2138 When unsubscribing from a mailing list you should never send the
2139 unsubscription notice to the mailing list itself. Instead, you'd send
2140 messages to the administrative address. This parameter allows you to
2141 put the admin address somewhere convenient.
2144 Elements that look like @code{(display . MODE)} say which articles to
2145 display on entering the group. Valid values are:
2149 Display all articles, both read and unread.
2152 Display the default visible articles, which normally includes unread and
2157 Elements that look like @code{(comment . "This is a comment")}
2158 are arbitrary comments on the group. They are currently ignored by
2159 Gnus, but provide a place for you to store information on particular
2163 Elements that look like @code{(charset . iso-8859-1)} will make
2164 @code{iso-8859-1} the default charset; that is, the charset that will be
2165 used for all articles that do not specify a charset.
2167 @item @var{(variable form)}
2168 You can use the group parameters to set variables local to the group you
2169 are entering. If you want to turn threading off in @samp{news.answers},
2170 you could put @code{(gnus-show-threads nil)} in the group parameters of
2171 that group. @code{gnus-show-threads} will be made into a local variable
2172 in the summary buffer you enter, and the form @code{nil} will be
2173 @code{eval}ed there.
2175 This can also be used as a group-specific hook function, if you'd like.
2176 If you want to hear a beep when you enter a group, you could put
2177 something like @code{(dummy-variable (ding))} in the parameters of that
2178 group. @code{dummy-variable} will be set to the result of the
2179 @code{(ding)} form, but who cares?
2182 You can store additional posting style information for this group only
2183 here (@pxref{Posting Styles}). The format is that of an entry in the
2184 @code{gnus-posting-styles} alist, except that there's no regexp matching
2185 the group name (of course). Style elements in this group parameter will
2186 take precedence over the ones found in @code{gnus-posting-styles}.
2188 For instance, if you want a funky name and signature in this group only,
2189 instead of hacking @code{gnus-posting-styles}, you could put something
2190 like this in the group parameters:
2195 (signature "Funky Signature"))
2200 Use the @kbd{G p} command to edit group parameters of a group. You
2201 might also be interested in reading about topic parameters (@pxref{Topic
2205 @node Listing Groups
2206 @section Listing Groups
2207 @cindex group listing
2209 These commands all list various slices of the groups available.
2217 @findex gnus-group-list-groups
2218 List all groups that have unread articles
2219 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
2220 command will list only groups of level ARG and lower. By default, it
2221 only lists groups of level five (i. e.,
2222 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2229 @findex gnus-group-list-all-groups
2230 List all groups, whether they have unread articles or not
2231 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
2232 this command will list only groups of level ARG and lower. By default,
2233 it lists groups of level seven or lower (i.e., just subscribed and
2234 unsubscribed groups).
2238 @findex gnus-group-list-level
2239 List all unread groups on a specific level
2240 (@code{gnus-group-list-level}). If given a prefix, also list the groups
2241 with no unread articles.
2245 @findex gnus-group-list-killed
2246 List all killed groups (@code{gnus-group-list-killed}). If given a
2247 prefix argument, really list all groups that are available, but aren't
2248 currently (un)subscribed. This could entail reading the active file
2253 @findex gnus-group-list-zombies
2254 List all zombie groups (@code{gnus-group-list-zombies}).
2258 @findex gnus-group-list-matching
2259 List all unread, subscribed groups with names that match a regexp
2260 (@code{gnus-group-list-matching}).
2264 @findex gnus-group-list-all-matching
2265 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2269 @findex gnus-group-list-active
2270 List absolutely all groups in the active file(s) of the
2271 server(s) you are connected to (@code{gnus-group-list-active}). This
2272 might very well take quite a while. It might actually be a better idea
2273 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2274 thing to match on. Also note that this command may list groups that
2275 don't exist (yet)---these will be listed as if they were killed groups.
2276 Take the output with some grains of salt.
2280 @findex gnus-group-apropos
2281 List all groups that have names that match a regexp
2282 (@code{gnus-group-apropos}).
2286 @findex gnus-group-description-apropos
2287 List all groups that have names or descriptions that match a regexp
2288 (@code{gnus-group-description-apropos}).
2292 @vindex gnus-permanently-visible-groups
2293 @cindex visible group parameter
2294 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2295 always be shown, whether they have unread articles or not. You can also
2296 add the @code{visible} element to the group parameters in question to
2297 get the same effect.
2299 @vindex gnus-list-groups-with-ticked-articles
2300 Groups that have just ticked articles in it are normally listed in the
2301 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
2302 @code{nil}, these groups will be treated just like totally empty
2303 groups. It is @code{t} by default.
2306 @node Sorting Groups
2307 @section Sorting Groups
2308 @cindex sorting groups
2310 @kindex C-c C-s (Group)
2311 @findex gnus-group-sort-groups
2312 @vindex gnus-group-sort-function
2313 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2314 group buffer according to the function(s) given by the
2315 @code{gnus-group-sort-function} variable. Available sorting functions
2320 @item gnus-group-sort-by-alphabet
2321 @findex gnus-group-sort-by-alphabet
2322 Sort the group names alphabetically. This is the default.
2324 @item gnus-group-sort-by-real-name
2325 @findex gnus-group-sort-by-real-name
2326 Sort the group alphabetically on the real (unprefixed) group names.
2328 @item gnus-group-sort-by-level
2329 @findex gnus-group-sort-by-level
2330 Sort by group level.
2332 @item gnus-group-sort-by-score
2333 @findex gnus-group-sort-by-score
2334 Sort by group score. @xref{Group Score}.
2336 @item gnus-group-sort-by-rank
2337 @findex gnus-group-sort-by-rank
2338 Sort by group score and then the group level. The level and the score
2339 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
2341 @item gnus-group-sort-by-unread
2342 @findex gnus-group-sort-by-unread
2343 Sort by number of unread articles.
2345 @item gnus-group-sort-by-method
2346 @findex gnus-group-sort-by-method
2347 Sort alphabetically on the select method.
2352 @code{gnus-group-sort-function} can also be a list of sorting
2353 functions. In that case, the most significant sort key function must be
2357 There are also a number of commands for sorting directly according to
2358 some sorting criteria:
2362 @kindex G S a (Group)
2363 @findex gnus-group-sort-groups-by-alphabet
2364 Sort the group buffer alphabetically by group name
2365 (@code{gnus-group-sort-groups-by-alphabet}).
2368 @kindex G S u (Group)
2369 @findex gnus-group-sort-groups-by-unread
2370 Sort the group buffer by the number of unread articles
2371 (@code{gnus-group-sort-groups-by-unread}).
2374 @kindex G S l (Group)
2375 @findex gnus-group-sort-groups-by-level
2376 Sort the group buffer by group level
2377 (@code{gnus-group-sort-groups-by-level}).
2380 @kindex G S v (Group)
2381 @findex gnus-group-sort-groups-by-score
2382 Sort the group buffer by group score
2383 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
2386 @kindex G S r (Group)
2387 @findex gnus-group-sort-groups-by-rank
2388 Sort the group buffer by group rank
2389 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
2392 @kindex G S m (Group)
2393 @findex gnus-group-sort-groups-by-method
2394 Sort the group buffer alphabetically by backend name
2395 (@code{gnus-group-sort-groups-by-method}).
2399 All the commands below obeys the process/prefix convention
2400 (@pxref{Process/Prefix}).
2402 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
2403 commands will sort in reverse order.
2405 You can also sort a subset of the groups:
2409 @kindex G P a (Group)
2410 @findex gnus-group-sort-selected-groups-by-alphabet
2411 Sort the groups alphabetically by group name
2412 (@code{gnus-group-sort-selected-groups-by-alphabet}).
2415 @kindex G P u (Group)
2416 @findex gnus-group-sort-selected-groups-by-unread
2417 Sort the groups by the number of unread articles
2418 (@code{gnus-group-sort-selected-groups-by-unread}).
2421 @kindex G P l (Group)
2422 @findex gnus-group-sort-selected-groups-by-level
2423 Sort the groups by group level
2424 (@code{gnus-group-sort-selected-groups-by-level}).
2427 @kindex G P v (Group)
2428 @findex gnus-group-sort-selected-groups-by-score
2429 Sort the groups by group score
2430 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
2433 @kindex G P r (Group)
2434 @findex gnus-group-sort-selected-groups-by-rank
2435 Sort the groups by group rank
2436 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
2439 @kindex G P m (Group)
2440 @findex gnus-group-sort-selected-groups-by-method
2441 Sort the groups alphabetically by backend name
2442 (@code{gnus-group-sort-selected-groups-by-method}).
2448 @node Group Maintenance
2449 @section Group Maintenance
2450 @cindex bogus groups
2455 @findex gnus-group-check-bogus-groups
2456 Find bogus groups and delete them
2457 (@code{gnus-group-check-bogus-groups}).
2461 @findex gnus-group-find-new-groups
2462 Find new groups and process them (@code{gnus-group-find-new-groups}).
2463 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
2464 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
2465 to query the server for new groups, and subscribe the new groups as
2469 @kindex C-c C-x (Group)
2470 @findex gnus-group-expire-articles
2471 Run all expirable articles in the current group through the expiry
2472 process (if any) (@code{gnus-group-expire-articles}).
2475 @kindex C-c M-C-x (Group)
2476 @findex gnus-group-expire-all-groups
2477 Run all articles in all groups through the expiry process
2478 (@code{gnus-group-expire-all-groups}).
2483 @node Browse Foreign Server
2484 @section Browse Foreign Server
2485 @cindex foreign servers
2486 @cindex browsing servers
2491 @findex gnus-group-browse-foreign-server
2492 You will be queried for a select method and a server name. Gnus will
2493 then attempt to contact this server and let you browse the groups there
2494 (@code{gnus-group-browse-foreign-server}).
2497 @findex gnus-browse-mode
2498 A new buffer with a list of available groups will appear. This buffer
2499 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
2500 a lot) like a normal group buffer.
2502 Here's a list of keystrokes available in the browse mode:
2507 @findex gnus-group-next-group
2508 Go to the next group (@code{gnus-group-next-group}).
2512 @findex gnus-group-prev-group
2513 Go to the previous group (@code{gnus-group-prev-group}).
2516 @kindex SPACE (Browse)
2517 @findex gnus-browse-read-group
2518 Enter the current group and display the first article
2519 (@code{gnus-browse-read-group}).
2522 @kindex RET (Browse)
2523 @findex gnus-browse-select-group
2524 Enter the current group (@code{gnus-browse-select-group}).
2528 @findex gnus-browse-unsubscribe-current-group
2529 Unsubscribe to the current group, or, as will be the case here,
2530 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2536 @findex gnus-browse-exit
2537 Exit browse mode (@code{gnus-browse-exit}).
2541 @findex gnus-browse-describe-briefly
2542 Describe browse mode briefly (well, there's not much to describe, is
2543 there) (@code{gnus-browse-describe-briefly}).
2548 @section Exiting Gnus
2549 @cindex exiting Gnus
2551 Yes, Gnus is ex(c)iting.
2556 @findex gnus-group-suspend
2557 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
2558 but it kills all buffers except the Group buffer. I'm not sure why this
2559 is a gain, but then who am I to judge?
2563 @findex gnus-group-exit
2564 @c @icon{gnus-group-exit}
2565 Quit Gnus (@code{gnus-group-exit}).
2569 @findex gnus-group-quit
2570 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2571 The dribble file will be saved, though (@pxref{Auto Save}).
2574 @vindex gnus-exit-gnus-hook
2575 @vindex gnus-suspend-gnus-hook
2576 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2577 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2578 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2583 If you wish to completely unload Gnus and all its adherents, you can use
2584 the @code{gnus-unload} command. This command is also very handy when
2585 trying to customize meta-variables.
2590 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2591 numbly heavy and herself fall into a hazy trance as the boy sitting
2592 behind her drew repeated lines with his pencil across the back of her
2598 @section Group Topics
2601 If you read lots and lots of groups, it might be convenient to group
2602 them hierarchically according to topics. You put your Emacs groups over
2603 here, your sex groups over there, and the rest (what, two groups or so?)
2604 you put in some misc section that you never bother with anyway. You can
2605 even group the Emacs sex groups as a sub-topic to either the Emacs
2606 groups or the sex groups---or both! Go wild!
2610 \gnusfigure{Group Topics}{400}{
2611 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2622 2: alt.religion.emacs
2625 0: comp.talk.emacs.recovery
2627 8: comp.binaries.fractals
2628 13: comp.sources.unix
2631 @findex gnus-topic-mode
2633 To get this @emph{fab} functionality you simply turn on (ooh!) the
2634 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
2635 is a toggling command.)
2637 Go ahead, just try it. I'll still be here when you get back. La de
2638 dum... Nice tune, that... la la la... What, you're back? Yes, and now
2639 press @kbd{l}. There. All your groups are now listed under
2640 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
2643 If you want this permanently enabled, you should add that minor mode to
2644 the hook for the group mode:
2647 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2651 * Topic Variables:: How to customize the topics the Lisp Way.
2652 * Topic Commands:: Interactive E-Z commands.
2653 * Topic Sorting:: Sorting each topic individually.
2654 * Topic Topology:: A map of the world.
2655 * Topic Parameters:: Parameters that apply to all groups in a topic.
2659 @node Topic Variables
2660 @subsection Topic Variables
2661 @cindex topic variables
2663 Now, if you select a topic, it will fold/unfold that topic, which is
2664 really neat, I think.
2666 @vindex gnus-topic-line-format
2667 The topic lines themselves are created according to the
2668 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2681 Number of groups in the topic.
2683 Number of unread articles in the topic.
2685 Number of unread articles in the topic and all its subtopics.
2688 @vindex gnus-topic-indent-level
2689 Each sub-topic (and the groups in the sub-topics) will be indented with
2690 @code{gnus-topic-indent-level} times the topic level number of spaces.
2693 @vindex gnus-topic-mode-hook
2694 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2696 @vindex gnus-topic-display-empty-topics
2697 The @code{gnus-topic-display-empty-topics} says whether to display even
2698 topics that have no unread articles in them. The default is @code{t}.
2701 @node Topic Commands
2702 @subsection Topic Commands
2703 @cindex topic commands
2705 When the topic minor mode is turned on, a new @kbd{T} submap will be
2706 available. In addition, a few of the standard keys change their
2707 definitions slightly.
2713 @findex gnus-topic-create-topic
2714 Prompt for a new topic name and create it
2715 (@code{gnus-topic-create-topic}).
2719 @findex gnus-topic-move-group
2720 Move the current group to some other topic
2721 (@code{gnus-topic-move-group}). This command uses the process/prefix
2722 convention (@pxref{Process/Prefix}).
2726 @findex gnus-topic-copy-group
2727 Copy the current group to some other topic
2728 (@code{gnus-topic-copy-group}). This command uses the process/prefix
2729 convention (@pxref{Process/Prefix}).
2733 @findex gnus-topic-remove-group
2734 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2735 This command is mainly useful if you have the same group in several
2736 topics and wish to remove it from one of the topics. You may also
2737 remove a group from all topics, but in that case, Gnus will add it to
2738 the root topic the next time you start Gnus. In fact, all new groups
2739 (which, naturally, don't belong to any topic) will show up in the root
2742 This command uses the process/prefix convention
2743 (@pxref{Process/Prefix}).
2747 @findex gnus-topic-move-matching
2748 Move all groups that match some regular expression to a topic
2749 (@code{gnus-topic-move-matching}).
2753 @findex gnus-topic-copy-matching
2754 Copy all groups that match some regular expression to a topic
2755 (@code{gnus-topic-copy-matching}).
2759 @findex gnus-topic-toggle-display-empty-topics
2760 Toggle hiding empty topics
2761 (@code{gnus-topic-toggle-display-empty-topics}).
2765 @findex gnus-topic-mark-topic
2766 Mark all groups in the current topic with the process mark
2767 (@code{gnus-topic-mark-topic}).
2770 @kindex T M-# (Topic)
2771 @findex gnus-topic-unmark-topic
2772 Remove the process mark from all groups in the current topic
2773 (@code{gnus-topic-unmark-topic}).
2777 @kindex T TAB (Topic)
2779 @findex gnus-topic-indent
2780 ``Indent'' the current topic so that it becomes a sub-topic of the
2781 previous topic (@code{gnus-topic-indent}). If given a prefix,
2782 ``un-indent'' the topic instead.
2785 @kindex M-TAB (Topic)
2786 @findex gnus-topic-unindent
2787 ``Un-indent'' the current topic so that it becomes a sub-topic of the
2788 parent of its current parent (@code{gnus-topic-unindent}).
2792 @findex gnus-topic-select-group
2794 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2795 When you perform this command on a group, you'll enter the group, as
2796 usual. When done on a topic line, the topic will be folded (if it was
2797 visible) or unfolded (if it was folded already). So it's basically a
2798 toggling command on topics. In addition, if you give a numerical
2799 prefix, group on that level (and lower) will be displayed.
2802 @kindex C-c C-x (Topic)
2803 @findex gnus-topic-expire-articles
2804 Run all expirable articles in the current group or topic through the expiry
2805 process (if any) (@code{gnus-topic-expire-articles}).
2809 @findex gnus-topic-kill-group
2810 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
2811 topic will be removed along with the topic.
2815 @findex gnus-topic-yank-group
2816 Yank the previously killed group or topic
2817 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
2822 @findex gnus-topic-rename
2823 Rename a topic (@code{gnus-topic-rename}).
2826 @kindex T DEL (Topic)
2827 @findex gnus-topic-delete
2828 Delete an empty topic (@code{gnus-topic-delete}).
2832 @findex gnus-topic-list-active
2833 List all groups that Gnus knows about in a topics-ified way
2834 (@code{gnus-topic-list-active}).
2838 @findex gnus-topic-edit-parameters
2839 @cindex group parameters
2840 @cindex topic parameters
2842 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2843 @xref{Topic Parameters}.
2849 @subsection Topic Sorting
2850 @cindex topic sorting
2852 You can sort the groups in each topic individually with the following
2858 @kindex T S a (Topic)
2859 @findex gnus-topic-sort-groups-by-alphabet
2860 Sort the current topic alphabetically by group name
2861 (@code{gnus-topic-sort-groups-by-alphabet}).
2864 @kindex T S u (Topic)
2865 @findex gnus-topic-sort-groups-by-unread
2866 Sort the current topic by the number of unread articles
2867 (@code{gnus-topic-sort-groups-by-unread}).
2870 @kindex T S l (Topic)
2871 @findex gnus-topic-sort-groups-by-level
2872 Sort the current topic by group level
2873 (@code{gnus-topic-sort-groups-by-level}).
2876 @kindex T S v (Topic)
2877 @findex gnus-topic-sort-groups-by-score
2878 Sort the current topic by group score
2879 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
2882 @kindex T S r (Topic)
2883 @findex gnus-topic-sort-groups-by-rank
2884 Sort the current topic by group rank
2885 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
2888 @kindex T S m (Topic)
2889 @findex gnus-topic-sort-groups-by-method
2890 Sort the current topic alphabetically by backend name
2891 (@code{gnus-topic-sort-groups-by-method}).
2895 @xref{Sorting Groups}, for more information about group sorting.
2898 @node Topic Topology
2899 @subsection Topic Topology
2900 @cindex topic topology
2903 So, let's have a look at an example group buffer:
2909 2: alt.religion.emacs
2912 0: comp.talk.emacs.recovery
2914 8: comp.binaries.fractals
2915 13: comp.sources.unix
2918 So, here we have one top-level topic (@samp{Gnus}), two topics under
2919 that, and one sub-topic under one of the sub-topics. (There is always
2920 just one (1) top-level topic). This topology can be expressed as
2925 (("Emacs -- I wuw it!" visible)
2926 (("Naughty Emacs" visible)))
2930 @vindex gnus-topic-topology
2931 This is in fact how the variable @code{gnus-topic-topology} would look
2932 for the display above. That variable is saved in the @file{.newsrc.eld}
2933 file, and shouldn't be messed with manually---unless you really want
2934 to. Since this variable is read from the @file{.newsrc.eld} file,
2935 setting it in any other startup files will have no effect.
2937 This topology shows what topics are sub-topics of what topics (right),
2938 and which topics are visible. Two settings are currently
2939 allowed---@code{visible} and @code{invisible}.
2942 @node Topic Parameters
2943 @subsection Topic Parameters
2944 @cindex topic parameters
2946 All groups in a topic will inherit group parameters from the parent (and
2947 ancestor) topic parameters. All valid group parameters are valid topic
2948 parameters (@pxref{Group Parameters}).
2950 Group parameters (of course) override topic parameters, and topic
2951 parameters in sub-topics override topic parameters in super-topics. You
2952 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
2953 verb, although you may feel free to disagree with me here.)
2959 2: alt.religion.emacs
2963 0: comp.talk.emacs.recovery
2965 8: comp.binaries.fractals
2966 13: comp.sources.unix
2970 The @samp{Emacs} topic has the topic parameter @code{(score-file
2971 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2972 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2973 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
2974 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
2975 . "religion.SCORE")}.
2977 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2978 will get the @file{relief.SCORE} home score file. If you enter the same
2979 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2980 score file. If you enter the group @samp{alt.religion.emacs}, you'll
2981 get the @file{religion.SCORE} home score file.
2983 This seems rather simple and self-evident, doesn't it? Well, yes. But
2984 there are some problems, especially with the @code{total-expiry}
2985 parameter. Say you have a mail group in two topics; one with
2986 @code{total-expiry} and one without. What happens when you do @kbd{M-x
2987 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
2988 of these topics you mean to expire articles from, so anything may
2989 happen. In fact, I hereby declare that it is @dfn{undefined} what
2990 happens. You just have to be careful if you do stuff like that.
2993 @node Misc Group Stuff
2994 @section Misc Group Stuff
2997 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2998 * Group Information:: Information and help on groups and Gnus.
2999 * Group Timestamp:: Making Gnus keep track of when you last read a group.
3000 * File Commands:: Reading and writing the Gnus files.
3007 @findex gnus-group-enter-server-mode
3008 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3009 @xref{The Server Buffer}.
3013 @findex gnus-group-post-news
3014 Post an article to a group (@code{gnus-group-post-news}). If given a
3015 prefix, the current group name will be used as the default.
3019 @findex gnus-group-mail
3020 Mail a message somewhere (@code{gnus-group-mail}).
3024 Variables for the group buffer:
3028 @item gnus-group-mode-hook
3029 @vindex gnus-group-mode-hook
3030 is called after the group buffer has been
3033 @item gnus-group-prepare-hook
3034 @vindex gnus-group-prepare-hook
3035 is called after the group buffer is
3036 generated. It may be used to modify the buffer in some strange,
3039 @item gnus-group-prepared-hook
3040 @vindex gnus-group-prepare-hook
3041 is called as the very last thing after the group buffer has been
3042 generated. It may be used to move point around, for instance.
3044 @item gnus-permanently-visible-groups
3045 @vindex gnus-permanently-visible-groups
3046 Groups matching this regexp will always be listed in the group buffer,
3047 whether they are empty or not.
3052 @node Scanning New Messages
3053 @subsection Scanning New Messages
3054 @cindex new messages
3055 @cindex scanning new news
3061 @findex gnus-group-get-new-news
3062 @c @icon{gnus-group-get-new-news}
3063 Check the server(s) for new articles. If the numerical prefix is used,
3064 this command will check only groups of level @var{arg} and lower
3065 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
3066 command will force a total re-reading of the active file(s) from the
3071 @findex gnus-group-get-new-news-this-group
3072 @vindex gnus-goto-next-group-when-activating
3073 @c @icon{gnus-group-get-new-news-this-group}
3074 Check whether new articles have arrived in the current group
3075 (@code{gnus-group-get-new-news-this-group}).
3076 @code{gnus-goto-next-group-when-activating} says whether this command is
3077 to move point to the next group or not. It is @code{t} by default.
3079 @findex gnus-activate-all-groups
3080 @cindex activating groups
3082 @kindex C-c M-g (Group)
3083 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3088 @findex gnus-group-restart
3089 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
3090 file(s), closes the connection to all servers, clears up all run-time
3091 Gnus variables, and then starts Gnus all over again.
3095 @vindex gnus-get-new-news-hook
3096 @code{gnus-get-new-news-hook} is run just before checking for new news.
3098 @vindex gnus-after-getting-new-news-hook
3099 @code{gnus-after-getting-new-news-hook} is run after checking for new
3103 @node Group Information
3104 @subsection Group Information
3105 @cindex group information
3106 @cindex information on groups
3113 @findex gnus-group-fetch-faq
3114 @vindex gnus-group-faq-directory
3117 Try to fetch the FAQ for the current group
3118 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
3119 @code{gnus-group-faq-directory}, which is usually a directory on a
3120 remote machine. This variable can also be a list of directories. In
3121 that case, giving a prefix to this command will allow you to choose
3122 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
3123 for fetching the file.
3125 If fetching from the first site is unsuccessful, Gnus will attempt to go
3126 through @code{gnus-group-faq-directory} and try to open them one by one.
3130 @c @icon{gnus-group-describe-group}
3132 @kindex C-c C-d (Group)
3133 @cindex describing groups
3134 @cindex group description
3135 @findex gnus-group-describe-group
3136 Describe the current group (@code{gnus-group-describe-group}). If given
3137 a prefix, force Gnus to re-read the description from the server.
3141 @findex gnus-group-describe-all-groups
3142 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
3143 prefix, force Gnus to re-read the description file from the server.
3150 @findex gnus-version
3151 Display current Gnus version numbers (@code{gnus-version}).
3155 @findex gnus-group-describe-briefly
3156 Give a very short help message (@code{gnus-group-describe-briefly}).
3159 @kindex C-c C-i (Group)
3162 @findex gnus-info-find-node
3163 Go to the Gnus info node (@code{gnus-info-find-node}).
3167 @node Group Timestamp
3168 @subsection Group Timestamp
3170 @cindex group timestamps
3172 It can be convenient to let Gnus keep track of when you last read a
3173 group. To set the ball rolling, you should add
3174 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3177 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3180 After doing this, each time you enter a group, it'll be recorded.
3182 This information can be displayed in various ways---the easiest is to
3183 use the @samp{%d} spec in the group line format:
3186 (setq gnus-group-line-format
3187 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3190 This will result in lines looking like:
3193 * 0: mail.ding 19961002T012943
3194 0: custom 19961002T012713
3197 As you can see, the date is displayed in compact ISO 8601 format. This
3198 may be a bit too much, so to just display the date, you could say
3202 (setq gnus-group-line-format
3203 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3208 @subsection File Commands
3209 @cindex file commands
3215 @findex gnus-group-read-init-file
3216 @vindex gnus-init-file
3217 @cindex reading init file
3218 Re-read the init file (@code{gnus-init-file}, which defaults to
3219 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3223 @findex gnus-group-save-newsrc
3224 @cindex saving .newsrc
3225 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3226 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
3227 file(s) whether Gnus thinks it is necessary or not.
3230 @c @kindex Z (Group)
3231 @c @findex gnus-group-clear-dribble
3232 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3237 @node The Summary Buffer
3238 @chapter The Summary Buffer
3239 @cindex summary buffer
3241 A line for each article is displayed in the summary buffer. You can
3242 move around, read articles, post articles and reply to articles.
3244 The most common way to a summary buffer is to select a group from the
3245 group buffer (@pxref{Selecting a Group}).
3247 You can have as many summary buffers open as you wish.
3250 * Summary Buffer Format:: Deciding how the summary buffer is to look.
3251 * Summary Maneuvering:: Moving around the summary buffer.
3252 * Choosing Articles:: Reading articles.
3253 * Paging the Article:: Scrolling the current article.
3254 * Reply Followup and Post:: Posting articles.
3255 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
3256 * Marking Articles:: Marking articles as read, expirable, etc.
3257 * Limiting:: You can limit the summary buffer.
3258 * Threading:: How threads are made.
3259 * Sorting:: How articles and threads are sorted.
3260 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
3261 * Article Caching:: You may store articles in a cache.
3262 * Persistent Articles:: Making articles expiry-resistant.
3263 * Article Backlog:: Having already read articles hang around.
3264 * Saving Articles:: Ways of customizing article saving.
3265 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
3266 * Article Treatment:: The article buffer can be mangled at will.
3267 * MIME Commands:: Doing MIMEy things with the articles.
3268 * Charsets:: Character set issues.
3269 * Article Commands:: Doing various things with the article buffer.
3270 * Summary Sorting:: Sorting the summary buffer in various ways.
3271 * Finding the Parent:: No child support? Get the parent.
3272 * Alternative Approaches:: Reading using non-default summaries.
3273 * Tree Display:: A more visual display of threads.
3274 * Mail Group Commands:: Some commands can only be used in mail groups.
3275 * Various Summary Stuff:: What didn't fit anywhere else.
3276 * Exiting the Summary Buffer:: Returning to the Group buffer.
3277 * Crosspost Handling:: How crossposted articles are dealt with.
3278 * Duplicate Suppression:: An alternative when crosspost handling fails.
3282 @node Summary Buffer Format
3283 @section Summary Buffer Format
3284 @cindex summary buffer format
3288 \gnusfigure{The Summary Buffer}{180}{
3289 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3290 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3296 * Summary Buffer Lines:: You can specify how summary lines should look.
3297 * To From Newsgroups:: How to not display your own name.
3298 * Summary Buffer Mode Line:: You can say how the mode line should look.
3299 * Summary Highlighting:: Making the summary buffer all pretty and nice.
3302 @findex mail-extract-address-components
3303 @findex gnus-extract-address-components
3304 @vindex gnus-extract-address-components
3305 Gnus will use the value of the @code{gnus-extract-address-components}
3306 variable as a function for getting the name and address parts of a
3307 @code{From} header. Two pre-defined functions exist:
3308 @code{gnus-extract-address-components}, which is the default, quite
3309 fast, and too simplistic solution; and
3310 @code{mail-extract-address-components}, which works very nicely, but is
3311 slower. The default function will return the wrong answer in 5% of the
3312 cases. If this is unacceptable to you, use the other function instead:
3315 (setq gnus-extract-address-components
3316 'mail-extract-address-components)
3319 @vindex gnus-summary-same-subject
3320 @code{gnus-summary-same-subject} is a string indicating that the current
3321 article has the same subject as the previous. This string will be used
3322 with those specs that require it. The default is @code{""}.
3325 @node Summary Buffer Lines
3326 @subsection Summary Buffer Lines
3328 @vindex gnus-summary-line-format
3329 You can change the format of the lines in the summary buffer by changing
3330 the @code{gnus-summary-line-format} variable. It works along the same
3331 lines as a normal @code{format} string, with some extensions
3332 (@pxref{Formatting Variables}).
3334 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3336 The following format specification characters are understood:
3344 Subject if the article is the root of the thread or the previous article
3345 had a different subject, @code{gnus-summary-same-subject} otherwise.
3346 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3348 Full @code{From} header.
3350 The name (from the @code{From} header).
3352 The name, code @code{To} header or the @code{Newsgroups} header
3353 (@pxref{To From Newsgroups}).
3355 The name (from the @code{From} header). This differs from the @code{n}
3356 spec in that it uses the function designated by the
3357 @code{gnus-extract-address-components} variable, which is slower, but
3358 may be more thorough.
3360 The address (from the @code{From} header). This works the same way as
3363 Number of lines in the article.
3365 Number of characters in the article.
3367 Indentation based on thread level (@pxref{Customizing Threading}).
3369 Nothing if the article is a root and lots of spaces if it isn't (it
3370 pushes everything after it off the screen).
3372 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3373 for adopted articles (@pxref{Customizing Threading}).
3375 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3376 for adopted articles.
3378 One space for each thread level.
3380 Twenty minus thread level spaces.
3385 This misleadingly named specifier is the @dfn{secondary mark}. This
3386 mark will say whether the article has been replied to, has been cached,
3390 Score as a number (@pxref{Scoring}).
3392 @vindex gnus-summary-zcore-fuzz
3393 Zcore, @samp{+} if above the default level and @samp{-} if below the
3394 default level. If the difference between
3395 @code{gnus-summary-default-score} and the score is less than
3396 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3404 The @code{Date} in @code{DD-MMM} format.
3406 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3412 Number of articles in the current sub-thread. Using this spec will slow
3413 down summary buffer generation somewhat.
3415 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3416 article has any children.
3422 User defined specifier. The next character in the format string should
3423 be a letter. Gnus will call the function
3424 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3425 following @samp{%u}. The function will be passed the current header as
3426 argument. The function should return a string, which will be inserted
3427 into the summary just like information from any other summary specifier.
3430 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3431 have to be handled with care. For reasons of efficiency, Gnus will
3432 compute what column these characters will end up in, and ``hard-code''
3433 that. This means that it is invalid to have these specs after a
3434 variable-length spec. Well, you might not be arrested, but your summary
3435 buffer will look strange, which is bad enough.
3437 The smart choice is to have these specs as far to the left as possible.
3438 (Isn't that the case with everything, though? But I digress.)
3440 This restriction may disappear in later versions of Gnus.
3443 @node To From Newsgroups
3444 @subsection To From Newsgroups
3448 In some groups (particularly in archive groups), the @code{From} header
3449 isn't very interesting, since all the articles there are written by
3450 you. To display the information in the @code{To} or @code{Newsgroups}
3451 headers instead, you need to decide three things: What information to
3452 gather; where to display it; and when to display it.
3456 @vindex gnus-extra-headers
3457 The reading of extra header information is controlled by the
3458 @code{gnus-extra-headers}. This is a list of header symbols. For
3462 (setq gnus-extra-headers
3463 '(To Newsgroups X-Newsreader))
3466 This will result in Gnus trying to obtain these three headers, and
3467 storing it in header structures for later easy retrieval.
3470 @findex gnus-extra-header
3471 The value of these extra headers can be accessed via the
3472 @code{gnus-extra-header} function. Here's a format line spec that will
3473 access the @code{X-Newsreader} header:
3476 "%~(form (gnus-extra-header 'X-Newsreader))@@"
3480 @vindex gnus-ignored-from-addresses
3481 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
3482 summary line spec returns the @code{To}, @code{Newsreader} or
3483 @code{From} header. If this regexp matches the contents of the
3484 @code{From} header, the value of the @code{To} or @code{Newsreader}
3485 headers are used instead.
3489 @vindex nnmail-extra-headers
3490 A related variable is @code{nnmail-extra-headers}, which controls when
3491 to include extra headers when generating overview (@sc{nov}) files. If
3492 you have old overview files, you should regenerate them after changing
3495 @vindex gnus-summary-line-format
3496 You also have to instruct Gnus to display the data by changing the
3497 @code{%n} spec to the @code{%f} spec in the
3498 @code{gnus-summary-line-format} variable.
3500 In summary, you'd typically do something like the following:
3503 (setq gnus-extra-headers
3505 (setq nnmail-extra-headers gnus-extra-headers)
3506 (setq gnus-summary-line-format
3507 "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n")
3508 (setq gnus-ignored-from-addresses
3512 Now, this is mostly useful for mail groups, where you have control over
3513 the @sc{nov} files that are created. However, if you can persuade your
3520 to the end of her @file{overview.fmt} file, then you can use that just
3521 as you would the extra headers from the mail groups.
3524 @node Summary Buffer Mode Line
3525 @subsection Summary Buffer Mode Line
3527 @vindex gnus-summary-mode-line-format
3528 You can also change the format of the summary mode bar (@pxref{Mode Line
3529 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
3530 like. The default is @samp{Gnus: %%b [%A] %Z}.
3532 Here are the elements you can play with:
3538 Unprefixed group name.
3540 Current article number.
3542 Current article score.
3546 Number of unread articles in this group.
3548 Number of unread articles in this group that aren't displayed in the
3551 A string with the number of unread and unselected articles represented
3552 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3553 articles, and just as @samp{<%U more>} if there are just unread articles
3554 and no unselected ones.
3556 Shortish group name. For instance, @samp{rec.arts.anime} will be
3557 shortened to @samp{r.a.anime}.
3559 Subject of the current article.
3561 User-defined spec (@pxref{User-Defined Specs}).
3563 Name of the current score file (@pxref{Scoring}).
3565 Number of dormant articles (@pxref{Unread Articles}).
3567 Number of ticked articles (@pxref{Unread Articles}).
3569 Number of articles that have been marked as read in this session.
3571 Number of articles expunged by the score files.
3575 @node Summary Highlighting
3576 @subsection Summary Highlighting
3580 @item gnus-visual-mark-article-hook
3581 @vindex gnus-visual-mark-article-hook
3582 This hook is run after selecting an article. It is meant to be used for
3583 highlighting the article in some way. It is not run if
3584 @code{gnus-visual} is @code{nil}.
3586 @item gnus-summary-update-hook
3587 @vindex gnus-summary-update-hook
3588 This hook is called when a summary line is changed. It is not run if
3589 @code{gnus-visual} is @code{nil}.
3591 @item gnus-summary-selected-face
3592 @vindex gnus-summary-selected-face
3593 This is the face (or @dfn{font} as some people call it) used to
3594 highlight the current article in the summary buffer.
3596 @item gnus-summary-highlight
3597 @vindex gnus-summary-highlight
3598 Summary lines are highlighted according to this variable, which is a
3599 list where the elements are of the format @var{(FORM . FACE)}. If you
3600 would, for instance, like ticked articles to be italic and high-scored
3601 articles to be bold, you could set this variable to something like
3603 (((eq mark gnus-ticked-mark) . italic)
3604 ((> score default) . bold))
3606 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3607 @var{FACE} will be applied to the line.
3611 @node Summary Maneuvering
3612 @section Summary Maneuvering
3613 @cindex summary movement
3615 All the straight movement commands understand the numeric prefix and
3616 behave pretty much as you'd expect.
3618 None of these commands select articles.
3623 @kindex M-n (Summary)
3624 @kindex G M-n (Summary)
3625 @findex gnus-summary-next-unread-subject
3626 Go to the next summary line of an unread article
3627 (@code{gnus-summary-next-unread-subject}).
3631 @kindex M-p (Summary)
3632 @kindex G M-p (Summary)
3633 @findex gnus-summary-prev-unread-subject
3634 Go to the previous summary line of an unread article
3635 (@code{gnus-summary-prev-unread-subject}).
3640 @kindex G j (Summary)
3641 @findex gnus-summary-goto-article
3642 Ask for an article number or @code{Message-ID}, and then go to that
3643 article (@code{gnus-summary-goto-article}).
3646 @kindex G g (Summary)
3647 @findex gnus-summary-goto-subject
3648 Ask for an article number and then go to the summary line of that article
3649 without displaying the article (@code{gnus-summary-goto-subject}).
3652 If Gnus asks you to press a key to confirm going to the next group, you
3653 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3654 buffer, searching for the next group to read without actually returning
3655 to the group buffer.
3657 Variables related to summary movement:
3661 @vindex gnus-auto-select-next
3662 @item gnus-auto-select-next
3663 If you issue one of the movement commands (like @kbd{n}) and there are
3664 no more unread articles after the current one, Gnus will offer to go to
3665 the next group. If this variable is @code{t} and the next group is
3666 empty, Gnus will exit summary mode and return to the group buffer. If
3667 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3668 next group, no matter whether it has any unread articles or not. As a
3669 special case, if this variable is @code{quietly}, Gnus will select the
3670 next group without asking for confirmation. If this variable is
3671 @code{almost-quietly}, the same will happen only if you are located on
3672 the last article in the group. Finally, if this variable is
3673 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3674 without confirmation. Also @pxref{Group Levels}.
3676 @item gnus-auto-select-same
3677 @vindex gnus-auto-select-same
3678 If non-@code{nil}, all the movement commands will try to go to the next
3679 article with the same subject as the current. (@dfn{Same} here might
3680 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
3681 for details (@pxref{Customizing Threading}).) If there are no more
3682 articles with the same subject, go to the first unread article.
3684 This variable is not particularly useful if you use a threaded display.
3686 @item gnus-summary-check-current
3687 @vindex gnus-summary-check-current
3688 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3689 to the next (or previous) article if the current article is unread.
3690 Instead, they will choose the current article.
3692 @item gnus-auto-center-summary
3693 @vindex gnus-auto-center-summary
3694 If non-@code{nil}, Gnus will keep the point in the summary buffer
3695 centered at all times. This makes things quite tidy, but if you have a
3696 slow network connection, or simply do not like this un-Emacsism, you can
3697 set this variable to @code{nil} to get the normal Emacs scrolling
3698 action. This will also inhibit horizontal re-centering of the summary
3699 buffer, which might make it more inconvenient to read extremely long
3702 This variable can also be a number. In that case, center the window at
3703 the given number of lines from the top.
3708 @node Choosing Articles
3709 @section Choosing Articles
3710 @cindex selecting articles
3713 * Choosing Commands:: Commands for choosing articles.
3714 * Choosing Variables:: Variables that influence these commands.
3718 @node Choosing Commands
3719 @subsection Choosing Commands
3721 None of the following movement commands understand the numeric prefix,
3722 and they all select and display an article.
3726 @kindex SPACE (Summary)
3727 @findex gnus-summary-next-page
3728 Select the current article, or, if that one's read already, the next
3729 unread article (@code{gnus-summary-next-page}).
3734 @kindex G n (Summary)
3735 @findex gnus-summary-next-unread-article
3736 @c @icon{gnus-summary-next-unread}
3737 Go to next unread article (@code{gnus-summary-next-unread-article}).
3742 @findex gnus-summary-prev-unread-article
3743 @c @icon{gnus-summary-prev-unread}
3744 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3749 @kindex G N (Summary)
3750 @findex gnus-summary-next-article
3751 Go to the next article (@code{gnus-summary-next-article}).
3756 @kindex G P (Summary)
3757 @findex gnus-summary-prev-article
3758 Go to the previous article (@code{gnus-summary-prev-article}).
3761 @kindex G C-n (Summary)
3762 @findex gnus-summary-next-same-subject
3763 Go to the next article with the same subject
3764 (@code{gnus-summary-next-same-subject}).
3767 @kindex G C-p (Summary)
3768 @findex gnus-summary-prev-same-subject
3769 Go to the previous article with the same subject
3770 (@code{gnus-summary-prev-same-subject}).
3774 @kindex G f (Summary)
3776 @findex gnus-summary-first-unread-article
3777 Go to the first unread article
3778 (@code{gnus-summary-first-unread-article}).
3782 @kindex G b (Summary)
3784 @findex gnus-summary-best-unread-article
3785 Go to the article with the highest score
3786 (@code{gnus-summary-best-unread-article}).
3791 @kindex G l (Summary)
3792 @findex gnus-summary-goto-last-article
3793 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3796 @kindex G o (Summary)
3797 @findex gnus-summary-pop-article
3799 @cindex article history
3800 Pop an article off the summary history and go to this article
3801 (@code{gnus-summary-pop-article}). This command differs from the
3802 command above in that you can pop as many previous articles off the
3803 history as you like, while @kbd{l} toggles the two last read articles.
3804 For a somewhat related issue (if you use these commands a lot),
3805 @pxref{Article Backlog}.
3809 @node Choosing Variables
3810 @subsection Choosing Variables
3812 Some variables relevant for moving and selecting articles:
3815 @item gnus-auto-extend-newsgroup
3816 @vindex gnus-auto-extend-newsgroup
3817 All the movement commands will try to go to the previous (or next)
3818 article, even if that article isn't displayed in the Summary buffer if
3819 this variable is non-@code{nil}. Gnus will then fetch the article from
3820 the server and display it in the article buffer.
3822 @item gnus-select-article-hook
3823 @vindex gnus-select-article-hook
3824 This hook is called whenever an article is selected. By default it
3825 exposes any threads hidden under the selected article.
3827 @item gnus-mark-article-hook
3828 @vindex gnus-mark-article-hook
3829 @findex gnus-summary-mark-unread-as-read
3830 @findex gnus-summary-mark-read-and-unread-as-read
3831 @findex gnus-unread-mark
3832 This hook is called whenever an article is selected. It is intended to
3833 be used for marking articles as read. The default value is
3834 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3835 mark of almost any article you read to @code{gnus-unread-mark}. The
3836 only articles not affected by this function are ticked, dormant, and
3837 expirable articles. If you'd instead like to just have unread articles
3838 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3839 instead. It will leave marks like @code{gnus-low-score-mark},
3840 @code{gnus-del-mark} (and so on) alone.
3845 @node Paging the Article
3846 @section Scrolling the Article
3847 @cindex article scrolling
3852 @kindex SPACE (Summary)
3853 @findex gnus-summary-next-page
3854 Pressing @kbd{SPACE} will scroll the current article forward one page,
3855 or, if you have come to the end of the current article, will choose the
3856 next article (@code{gnus-summary-next-page}).
3859 @kindex DEL (Summary)
3860 @findex gnus-summary-prev-page
3861 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3864 @kindex RET (Summary)
3865 @findex gnus-summary-scroll-up
3866 Scroll the current article one line forward
3867 (@code{gnus-summary-scroll-up}).
3870 @kindex M-RET (Summary)
3871 @findex gnus-summary-scroll-down
3872 Scroll the current article one line backward
3873 (@code{gnus-summary-scroll-down}).
3877 @kindex A g (Summary)
3879 @findex gnus-summary-show-article
3880 (Re)fetch the current article (@code{gnus-summary-show-article}). If
3881 given a prefix, fetch the current article, but don't run any of the
3882 article treatment functions. This will give you a ``raw'' article, just
3883 the way it came from the server.
3888 @kindex A < (Summary)
3889 @findex gnus-summary-beginning-of-article
3890 Scroll to the beginning of the article
3891 (@code{gnus-summary-beginning-of-article}).
3896 @kindex A > (Summary)
3897 @findex gnus-summary-end-of-article
3898 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3902 @kindex A s (Summary)
3904 @findex gnus-summary-isearch-article
3905 Perform an isearch in the article buffer
3906 (@code{gnus-summary-isearch-article}).
3910 @findex gnus-summary-select-article-buffer
3911 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3916 @node Reply Followup and Post
3917 @section Reply, Followup and Post
3920 * Summary Mail Commands:: Sending mail.
3921 * Summary Post Commands:: Sending news.
3925 @node Summary Mail Commands
3926 @subsection Summary Mail Commands
3928 @cindex composing mail
3930 Commands for composing a mail message:
3936 @kindex S r (Summary)
3938 @findex gnus-summary-reply
3939 @c @icon{gnus-summary-mail-reply}
3940 @c @icon{gnus-summary-reply}
3941 Mail a reply to the author of the current article
3942 (@code{gnus-summary-reply}).
3947 @kindex S R (Summary)
3948 @findex gnus-summary-reply-with-original
3949 @c @icon{gnus-summary-reply-with-original}
3950 Mail a reply to the author of the current article and include the
3951 original message (@code{gnus-summary-reply-with-original}). This
3952 command uses the process/prefix convention.
3955 @kindex S w (Summary)
3956 @findex gnus-summary-wide-reply
3957 Mail a wide reply to the author of the current article
3958 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
3959 goes out to all people listed in the @code{To}, @code{From} (or
3960 @code{Reply-to}) and @code{Cc} headers.
3963 @kindex S W (Summary)
3964 @findex gnus-summary-wide-reply-with-original
3965 Mail a wide reply to the current article and include the original
3966 message (@code{gnus-summary-wide-reply-with-original}). This command uses
3967 the process/prefix convention.
3970 @kindex S o m (Summary)
3971 @findex gnus-summary-mail-forward
3972 @c @icon{gnus-summary-mail-forward}
3973 Forward the current article to some other person
3974 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
3975 headers of the forwarded article.
3980 @kindex S m (Summary)
3981 @findex gnus-summary-mail-other-window
3982 @c @icon{gnus-summary-mail-originate}
3983 Send a mail to some other person
3984 (@code{gnus-summary-mail-other-window}).
3987 @kindex S D b (Summary)
3988 @findex gnus-summary-resend-bounced-mail
3989 @cindex bouncing mail
3990 If you have sent a mail, but the mail was bounced back to you for some
3991 reason (wrong address, transient failure), you can use this command to
3992 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
3993 will be popped into a mail buffer where you can edit the headers before
3994 sending the mail off again. If you give a prefix to this command, and
3995 the bounced mail is a reply to some other mail, Gnus will try to fetch
3996 that mail and display it for easy perusal of its headers. This might
3997 very well fail, though.
4000 @kindex S D r (Summary)
4001 @findex gnus-summary-resend-message
4002 Not to be confused with the previous command,
4003 @code{gnus-summary-resend-message} will prompt you for an address to
4004 send the current message off to, and then send it to that place. The
4005 headers of the message won't be altered---but lots of headers that say
4006 @code{Resent-To}, @code{Resent-From} and so on will be added. This
4007 means that you actually send a mail to someone that has a @code{To}
4008 header that (probably) points to yourself. This will confuse people.
4009 So, natcherly you'll only do that if you're really eVIl.
4011 This command is mainly used if you have several accounts and want to
4012 ship a mail to a different account of yours. (If you're both
4013 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4014 to the @code{root} account, you may want to resend it to
4015 @code{postmaster}. Ordnung muß sein!
4017 This command understands the process/prefix convention
4018 (@pxref{Process/Prefix}).
4021 @kindex S O m (Summary)
4022 @findex gnus-uu-digest-mail-forward
4023 Digest the current series (@pxref{Decoding Articles}) and forward the
4024 result using mail (@code{gnus-uu-digest-mail-forward}). This command
4025 uses the process/prefix convention (@pxref{Process/Prefix}).
4028 @kindex S M-c (Summary)
4029 @findex gnus-summary-mail-crosspost-complaint
4030 @cindex crossposting
4031 @cindex excessive crossposting
4032 Send a complaint about excessive crossposting to the author of the
4033 current article (@code{gnus-summary-mail-crosspost-complaint}).
4035 @findex gnus-crosspost-complaint
4036 This command is provided as a way to fight back against the current
4037 crossposting pandemic that's sweeping Usenet. It will compose a reply
4038 using the @code{gnus-crosspost-complaint} variable as a preamble. This
4039 command understands the process/prefix convention
4040 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4044 Also @pxref{(message)Header Commands} for more information.
4047 @node Summary Post Commands
4048 @subsection Summary Post Commands
4050 @cindex composing news
4052 Commands for posting a news article:
4058 @kindex S p (Summary)
4059 @findex gnus-summary-post-news
4060 @c @icon{gnus-summary-post-news}
4061 Post an article to the current group
4062 (@code{gnus-summary-post-news}).
4067 @kindex S f (Summary)
4068 @findex gnus-summary-followup
4069 @c @icon{gnus-summary-followup}
4070 Post a followup to the current article (@code{gnus-summary-followup}).
4074 @kindex S F (Summary)
4076 @c @icon{gnus-summary-followup-with-original}
4077 @findex gnus-summary-followup-with-original
4078 Post a followup to the current article and include the original message
4079 (@code{gnus-summary-followup-with-original}). This command uses the
4080 process/prefix convention.
4083 @kindex S n (Summary)
4084 @findex gnus-summary-followup-to-mail
4085 Post a followup to the current article via news, even if you got the
4086 message through mail (@code{gnus-summary-followup-to-mail}).
4089 @kindex S N (Summary)
4090 @findex gnus-summary-followup-to-mail-with-original
4091 Post a followup to the current article via news, even if you got the
4092 message through mail and include the original message
4093 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
4094 the process/prefix convention.
4097 @kindex S o p (Summary)
4098 @findex gnus-summary-post-forward
4099 Forward the current article to a newsgroup
4100 (@code{gnus-summary-post-forward}). If given a prefix, include the full
4101 headers of the forwarded article.
4104 @kindex S O p (Summary)
4105 @findex gnus-uu-digest-post-forward
4107 @cindex making digests
4108 Digest the current series and forward the result to a newsgroup
4109 (@code{gnus-uu-digest-mail-forward}). This command uses the
4110 process/prefix convention.
4113 @kindex S u (Summary)
4114 @findex gnus-uu-post-news
4115 @c @icon{gnus-uu-post-news}
4116 Uuencode a file, split it into parts, and post it as a series
4117 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
4120 Also @pxref{(message)Header Commands} for more information.
4123 @node Canceling and Superseding
4124 @section Canceling Articles
4125 @cindex canceling articles
4126 @cindex superseding articles
4128 Have you ever written something, and then decided that you really,
4129 really, really wish you hadn't posted that?
4131 Well, you can't cancel mail, but you can cancel posts.
4133 @findex gnus-summary-cancel-article
4135 @c @icon{gnus-summary-cancel-article}
4136 Find the article you wish to cancel (you can only cancel your own
4137 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
4138 c} (@code{gnus-summary-cancel-article}). Your article will be
4139 canceled---machines all over the world will be deleting your article.
4140 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4142 Be aware, however, that not all sites honor cancels, so your article may
4143 live on here and there, while most sites will delete the article in
4146 Gnus will use the ``current'' select method when canceling. If you
4147 want to use the standard posting method, use the @samp{a} symbolic
4148 prefix (@pxref{Symbolic Prefixes}).
4150 If you discover that you have made some mistakes and want to do some
4151 corrections, you can post a @dfn{superseding} article that will replace
4152 your original article.
4154 @findex gnus-summary-supersede-article
4156 Go to the original article and press @kbd{S s}
4157 (@code{gnus-summary-supersede-article}). You will be put in a buffer
4158 where you can edit the article all you want before sending it off the
4161 The same goes for superseding as for canceling, only more so: Some
4162 sites do not honor superseding. On those sites, it will appear that you
4163 have posted almost the same article twice.
4165 If you have just posted the article, and change your mind right away,
4166 there is a trick you can use to cancel/supersede the article without
4167 waiting for the article to appear on your site first. You simply return
4168 to the post buffer (which is called @code{*sent ...*}). There you will
4169 find the article you just posted, with all the headers intact. Change
4170 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4171 header by substituting one of those words for the word
4172 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
4173 you would do normally. The previous article will be
4174 canceled/superseded.
4176 Just remember, kids: There is no 'c' in 'supersede'.
4179 @node Marking Articles
4180 @section Marking Articles
4181 @cindex article marking
4182 @cindex article ticking
4185 There are several marks you can set on an article.
4187 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4188 neologism ohoy!) of the article. Alphabetic marks generally mean
4189 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4191 In addition, you also have marks that do not affect readedness.
4194 * Unread Articles:: Marks for unread articles.
4195 * Read Articles:: Marks for read articles.
4196 * Other Marks:: Marks that do not affect readedness.
4200 There's a plethora of commands for manipulating these marks:
4204 * Setting Marks:: How to set and remove marks.
4205 * Generic Marking Commands:: How to customize the marking.
4206 * Setting Process Marks:: How to mark articles for later processing.
4210 @node Unread Articles
4211 @subsection Unread Articles
4213 The following marks mark articles as (kinda) unread, in one form or
4218 @vindex gnus-ticked-mark
4219 Marked as ticked (@code{gnus-ticked-mark}).
4221 @dfn{Ticked articles} are articles that will remain visible always. If
4222 you see an article that you find interesting, or you want to put off
4223 reading it, or replying to it, until sometime later, you'd typically
4224 tick it. However, articles can be expired, so if you want to keep an
4225 article forever, you'll have to make it persistent (@pxref{Persistent
4229 @vindex gnus-dormant-mark
4230 Marked as dormant (@code{gnus-dormant-mark}).
4232 @dfn{Dormant articles} will only appear in the summary buffer if there
4233 are followups to it. If you want to see them even if they don't have
4234 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4237 @vindex gnus-unread-mark
4238 Marked as unread (@code{gnus-unread-mark}).
4240 @dfn{Unread articles} are articles that haven't been read at all yet.
4245 @subsection Read Articles
4246 @cindex expirable mark
4248 All the following marks mark articles as read.
4253 @vindex gnus-del-mark
4254 These are articles that the user has marked as read with the @kbd{d}
4255 command manually, more or less (@code{gnus-del-mark}).
4258 @vindex gnus-read-mark
4259 Articles that have actually been read (@code{gnus-read-mark}).
4262 @vindex gnus-ancient-mark
4263 Articles that were marked as read in previous sessions and are now
4264 @dfn{old} (@code{gnus-ancient-mark}).
4267 @vindex gnus-killed-mark
4268 Marked as killed (@code{gnus-killed-mark}).
4271 @vindex gnus-kill-file-mark
4272 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4275 @vindex gnus-low-score-mark
4276 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4279 @vindex gnus-catchup-mark
4280 Marked as read by a catchup (@code{gnus-catchup-mark}).
4283 @vindex gnus-canceled-mark
4284 Canceled article (@code{gnus-canceled-mark})
4287 @vindex gnus-souped-mark
4288 @sc{SOUP}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
4291 @vindex gnus-sparse-mark
4292 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
4296 @vindex gnus-duplicate-mark
4297 Article marked as read by duplicate suppression
4298 (@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}.
4302 All these marks just mean that the article is marked as read, really.
4303 They are interpreted differently when doing adaptive scoring, though.
4305 One more special mark, though:
4309 @vindex gnus-expirable-mark
4310 Marked as expirable (@code{gnus-expirable-mark}).
4312 Marking articles as @dfn{expirable} (or have them marked as such
4313 automatically) doesn't make much sense in normal groups---a user doesn't
4314 control expiring of news articles, but in mail groups, for instance,
4315 articles marked as @dfn{expirable} can be deleted by Gnus at
4321 @subsection Other Marks
4322 @cindex process mark
4325 There are some marks that have nothing to do with whether the article is
4331 You can set a bookmark in the current article. Say you are reading a
4332 long thesis on cats' urinary tracts, and have to go home for dinner
4333 before you've finished reading the thesis. You can then set a bookmark
4334 in the article, and Gnus will jump to this bookmark the next time it
4335 encounters the article. @xref{Setting Marks}.
4338 @vindex gnus-replied-mark
4339 All articles that you have replied to or made a followup to (i.e., have
4340 answered) will be marked with an @samp{A} in the second column
4341 (@code{gnus-replied-mark}).
4344 @vindex gnus-cached-mark
4345 Articles stored in the article cache will be marked with an @samp{*} in
4346 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
4349 @vindex gnus-saved-mark
4350 Articles ``saved'' (in some manner or other; not necessarily
4351 religiously) are marked with an @samp{S} in the second column
4352 (@code{gnus-saved-mark}).
4355 @vindex gnus-not-empty-thread-mark
4356 @vindex gnus-empty-thread-mark
4357 If the @samp{%e} spec is used, the presence of threads or not will be
4358 marked with @code{gnus-not-empty-thread-mark} and
4359 @code{gnus-empty-thread-mark} in the third column, respectively.
4362 @vindex gnus-process-mark
4363 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
4364 variety of commands react to the presence of the process mark. For
4365 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4366 all articles that have been marked with the process mark. Articles
4367 marked with the process mark have a @samp{#} in the second column.
4371 You might have noticed that most of these ``non-readedness'' marks
4372 appear in the second column by default. So if you have a cached, saved,
4373 replied article that you have process-marked, what will that look like?
4375 Nothing much. The precedence rules go as follows: process -> cache ->
4376 replied -> saved. So if the article is in the cache and is replied,
4377 you'll only see the cache mark and not the replied mark.
4381 @subsection Setting Marks
4382 @cindex setting marks
4384 All the marking commands understand the numeric prefix.
4389 @kindex M c (Summary)
4390 @kindex M-u (Summary)
4391 @findex gnus-summary-clear-mark-forward
4392 @cindex mark as unread
4393 Clear all readedness-marks from the current article
4394 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
4400 @kindex M t (Summary)
4401 @findex gnus-summary-tick-article-forward
4402 Tick the current article (@code{gnus-summary-tick-article-forward}).
4403 @xref{Article Caching}.
4408 @kindex M ? (Summary)
4409 @findex gnus-summary-mark-as-dormant
4410 Mark the current article as dormant
4411 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
4415 @kindex M d (Summary)
4417 @findex gnus-summary-mark-as-read-forward
4418 Mark the current article as read
4419 (@code{gnus-summary-mark-as-read-forward}).
4423 @findex gnus-summary-mark-as-read-backward
4424 Mark the current article as read and move point to the previous line
4425 (@code{gnus-summary-mark-as-read-backward}).
4430 @kindex M k (Summary)
4431 @findex gnus-summary-kill-same-subject-and-select
4432 Mark all articles that have the same subject as the current one as read,
4433 and then select the next unread article
4434 (@code{gnus-summary-kill-same-subject-and-select}).
4438 @kindex M K (Summary)
4439 @kindex C-k (Summary)
4440 @findex gnus-summary-kill-same-subject
4441 Mark all articles that have the same subject as the current one as read
4442 (@code{gnus-summary-kill-same-subject}).
4445 @kindex M C (Summary)
4446 @findex gnus-summary-catchup
4447 @c @icon{gnus-summary-catchup}
4448 Mark all unread articles as read (@code{gnus-summary-catchup}).
4451 @kindex M C-c (Summary)
4452 @findex gnus-summary-catchup-all
4453 Mark all articles in the group as read---even the ticked and dormant
4454 articles (@code{gnus-summary-catchup-all}).
4457 @kindex M H (Summary)
4458 @findex gnus-summary-catchup-to-here
4459 Catchup the current group to point
4460 (@code{gnus-summary-catchup-to-here}).
4463 @kindex C-w (Summary)
4464 @findex gnus-summary-mark-region-as-read
4465 Mark all articles between point and mark as read
4466 (@code{gnus-summary-mark-region-as-read}).
4469 @kindex M V k (Summary)
4470 @findex gnus-summary-kill-below
4471 Kill all articles with scores below the default score (or below the
4472 numeric prefix) (@code{gnus-summary-kill-below}).
4476 @kindex M e (Summary)
4478 @findex gnus-summary-mark-as-expirable
4479 Mark the current article as expirable
4480 (@code{gnus-summary-mark-as-expirable}).
4483 @kindex M b (Summary)
4484 @findex gnus-summary-set-bookmark
4485 Set a bookmark in the current article
4486 (@code{gnus-summary-set-bookmark}).
4489 @kindex M B (Summary)
4490 @findex gnus-summary-remove-bookmark
4491 Remove the bookmark from the current article
4492 (@code{gnus-summary-remove-bookmark}).
4495 @kindex M V c (Summary)
4496 @findex gnus-summary-clear-above
4497 Clear all marks from articles with scores over the default score (or
4498 over the numeric prefix) (@code{gnus-summary-clear-above}).
4501 @kindex M V u (Summary)
4502 @findex gnus-summary-tick-above
4503 Tick all articles with scores over the default score (or over the
4504 numeric prefix) (@code{gnus-summary-tick-above}).
4507 @kindex M V m (Summary)
4508 @findex gnus-summary-mark-above
4509 Prompt for a mark, and mark all articles with scores over the default
4510 score (or over the numeric prefix) with this mark
4511 (@code{gnus-summary-clear-above}).
4514 @vindex gnus-summary-goto-unread
4515 The @code{gnus-summary-goto-unread} variable controls what action should
4516 be taken after setting a mark. If non-@code{nil}, point will move to
4517 the next/previous unread article. If @code{nil}, point will just move
4518 one line up or down. As a special case, if this variable is
4519 @code{never}, all the marking commands as well as other commands (like
4520 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4521 The default is @code{t}.
4524 @node Generic Marking Commands
4525 @subsection Generic Marking Commands
4527 Some people would like the command that ticks an article (@kbd{!}) go to
4528 the next article. Others would like it to go to the next unread
4529 article. Yet others would like it to stay on the current article. And
4530 even though I haven't heard of anybody wanting it to go the the
4531 previous (unread) article, I'm sure there are people that want that as
4534 Multiply these five behaviours with five different marking commands, and
4535 you get a potentially complex set of variable to control what each
4538 To sidestep that mess, Gnus provides commands that do all these
4539 different things. They can be found on the @kbd{M M} map in the summary
4540 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
4541 to list in this manual.
4543 While you can use these commands directly, most users would prefer
4544 altering the summary mode keymap. For instance, if you would like the
4545 @kbd{!} command to go the the next article instead of the next unread
4546 article, you could say something like:
4549 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
4550 (defun my-alter-summary-map ()
4551 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
4557 (defun my-alter-summary-map ()
4558 (local-set-key "!" "MM!n"))
4562 @node Setting Process Marks
4563 @subsection Setting Process Marks
4564 @cindex setting process marks
4571 @kindex M P p (Summary)
4572 @findex gnus-summary-mark-as-processable
4573 Mark the current article with the process mark
4574 (@code{gnus-summary-mark-as-processable}).
4575 @findex gnus-summary-unmark-as-processable
4579 @kindex M P u (Summary)
4580 @kindex M-# (Summary)
4581 Remove the process mark, if any, from the current article
4582 (@code{gnus-summary-unmark-as-processable}).
4585 @kindex M P U (Summary)
4586 @findex gnus-summary-unmark-all-processable
4587 Remove the process mark from all articles
4588 (@code{gnus-summary-unmark-all-processable}).
4591 @kindex M P i (Summary)
4592 @findex gnus-uu-invert-processable
4593 Invert the list of process marked articles
4594 (@code{gnus-uu-invert-processable}).
4597 @kindex M P R (Summary)
4598 @findex gnus-uu-mark-by-regexp
4599 Mark articles that have a @code{Subject} header that matches a regular
4600 expression (@code{gnus-uu-mark-by-regexp}).
4603 @kindex M P r (Summary)
4604 @findex gnus-uu-mark-region
4605 Mark articles in region (@code{gnus-uu-mark-region}).
4608 @kindex M P t (Summary)
4609 @findex gnus-uu-mark-thread
4610 Mark all articles in the current (sub)thread
4611 (@code{gnus-uu-mark-thread}).
4614 @kindex M P T (Summary)
4615 @findex gnus-uu-unmark-thread
4616 Unmark all articles in the current (sub)thread
4617 (@code{gnus-uu-unmark-thread}).
4620 @kindex M P v (Summary)
4621 @findex gnus-uu-mark-over
4622 Mark all articles that have a score above the prefix argument
4623 (@code{gnus-uu-mark-over}).
4626 @kindex M P s (Summary)
4627 @findex gnus-uu-mark-series
4628 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4631 @kindex M P S (Summary)
4632 @findex gnus-uu-mark-sparse
4633 Mark all series that have already had some articles marked
4634 (@code{gnus-uu-mark-sparse}).
4637 @kindex M P a (Summary)
4638 @findex gnus-uu-mark-all
4639 Mark all articles in series order (@code{gnus-uu-mark-series}).
4642 @kindex M P b (Summary)
4643 @findex gnus-uu-mark-buffer
4644 Mark all articles in the buffer in the order they appear
4645 (@code{gnus-uu-mark-buffer}).
4648 @kindex M P k (Summary)
4649 @findex gnus-summary-kill-process-mark
4650 Push the current process mark set onto the stack and unmark all articles
4651 (@code{gnus-summary-kill-process-mark}).
4654 @kindex M P y (Summary)
4655 @findex gnus-summary-yank-process-mark
4656 Pop the previous process mark set from the stack and restore it
4657 (@code{gnus-summary-yank-process-mark}).
4660 @kindex M P w (Summary)
4661 @findex gnus-summary-save-process-mark
4662 Push the current process mark set onto the stack
4663 (@code{gnus-summary-save-process-mark}).
4672 It can be convenient to limit the summary buffer to just show some
4673 subset of the articles currently in the group. The effect most limit
4674 commands have is to remove a few (or many) articles from the summary
4677 All limiting commands work on subsets of the articles already fetched
4678 from the servers. None of these commands query the server for
4679 additional articles.
4685 @kindex / / (Summary)
4686 @findex gnus-summary-limit-to-subject
4687 Limit the summary buffer to articles that match some subject
4688 (@code{gnus-summary-limit-to-subject}).
4691 @kindex / a (Summary)
4692 @findex gnus-summary-limit-to-author
4693 Limit the summary buffer to articles that match some author
4694 (@code{gnus-summary-limit-to-author}).
4697 @kindex / x (Summary)
4698 @findex gnus-summary-limit-to-extra
4699 Limit the summary buffer to articles that match one of the ``extra''
4700 headers (@pxref{To From Newsgroups})
4701 (@code{gnus-summary-limit-to-author}).
4705 @kindex / u (Summary)
4707 @findex gnus-summary-limit-to-unread
4708 Limit the summary buffer to articles not marked as read
4709 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
4710 buffer to articles strictly unread. This means that ticked and
4711 dormant articles will also be excluded.
4714 @kindex / m (Summary)
4715 @findex gnus-summary-limit-to-marks
4716 Ask for a mark and then limit to all articles that have been marked
4717 with that mark (@code{gnus-summary-limit-to-marks}).
4720 @kindex / t (Summary)
4721 @findex gnus-summary-limit-to-age
4722 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4723 (@code{gnus-summary-limit-to-marks}). If given a prefix, limit to
4724 articles younger than that number of days.
4727 @kindex / n (Summary)
4728 @findex gnus-summary-limit-to-articles
4729 Limit the summary buffer to the current article
4730 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
4731 convention (@pxref{Process/Prefix}).
4734 @kindex / w (Summary)
4735 @findex gnus-summary-pop-limit
4736 Pop the previous limit off the stack and restore it
4737 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
4741 @kindex / v (Summary)
4742 @findex gnus-summary-limit-to-score
4743 Limit the summary buffer to articles that have a score at or above some
4744 score (@code{gnus-summary-limit-to-score}).
4748 @kindex M S (Summary)
4749 @kindex / E (Summary)
4750 @findex gnus-summary-limit-include-expunged
4751 Include all expunged articles in the limit
4752 (@code{gnus-summary-limit-include-expunged}).
4755 @kindex / D (Summary)
4756 @findex gnus-summary-limit-include-dormant
4757 Include all dormant articles in the limit
4758 (@code{gnus-summary-limit-include-dormant}).
4761 @kindex / * (Summary)
4762 @findex gnus-summary-limit-include-cached
4763 Include all cached articles in the limit
4764 (@code{gnus-summary-limit-include-cached}).
4767 @kindex / d (Summary)
4768 @findex gnus-summary-limit-exclude-dormant
4769 Exclude all dormant articles from the limit
4770 (@code{gnus-summary-limit-exclude-dormant}).
4773 @kindex / M (Summary)
4774 @findex gnus-summary-limit-exclude-marks
4775 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
4778 @kindex / T (Summary)
4779 @findex gnus-summary-limit-include-thread
4780 Include all the articles in the current thread in the limit.
4783 @kindex / c (Summary)
4784 @findex gnus-summary-limit-exclude-childless-dormant
4785 Exclude all dormant articles that have no children from the limit
4786 (@code{gnus-summary-limit-exclude-childless-dormant}).
4789 @kindex / C (Summary)
4790 @findex gnus-summary-limit-mark-excluded-as-read
4791 Mark all excluded unread articles as read
4792 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
4793 also mark excluded ticked and dormant articles as read.
4801 @cindex article threading
4803 Gnus threads articles by default. @dfn{To thread} is to put responses
4804 to articles directly after the articles they respond to---in a
4805 hierarchical fashion.
4807 Threading is done by looking at the @code{References} headers of the
4808 articles. In a perfect world, this would be enough to build pretty
4809 trees, but unfortunately, the @code{References} header is often broken
4810 or simply missing. Weird news propagation excarcerbates the problem,
4811 so one has to employ other heuristics to get pleasing results. A
4812 plethora of approaches exists, as detailed in horrible detail in
4813 @pxref{Customizing Threading}.
4815 First, a quick overview of the concepts:
4819 The top-most article in a thread; the first article in the thread.
4822 A tree-like article structure.
4825 A small(er) section of this tree-like structure.
4828 Threads often lose their roots due to article expiry, or due to the root
4829 already having been read in a previous session, and not displayed in the
4830 summary buffer. We then typically have many sub-threads that really
4831 belong to one thread, but are without connecting roots. These are
4832 called loose threads.
4834 @item thread gathering
4835 An attempt to gather loose threads into bigger threads.
4837 @item sparse threads
4838 A thread where the missing articles have been ``guessed'' at, and are
4839 displayed as empty lines in the summary buffer.
4845 * Customizing Threading:: Variables you can change to affect the threading.
4846 * Thread Commands:: Thread based commands in the summary buffer.
4850 @node Customizing Threading
4851 @subsection Customizing Threading
4852 @cindex customizing threading
4855 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
4856 * Filling In Threads:: Making the threads displayed look fuller.
4857 * More Threading:: Even more variables for fiddling with threads.
4858 * Low-Level Threading:: You thought it was over... but you were wrong!
4863 @subsubsection Loose Threads
4866 @cindex loose threads
4869 @item gnus-summary-make-false-root
4870 @vindex gnus-summary-make-false-root
4871 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4872 and create a dummy root at the top. (Wait a minute. Root at the top?
4873 Yup.) Loose subtrees occur when the real root has expired, or you've
4874 read or killed the root in a previous session.
4876 When there is no real root of a thread, Gnus will have to fudge
4877 something. This variable says what fudging method Gnus should use.
4878 There are four possible values:
4882 \gnusfigure{The Summary Buffer}{390}{
4883 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4884 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4885 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4886 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4891 @cindex adopting articles
4896 Gnus will make the first of the orphaned articles the parent. This
4897 parent will adopt all the other articles. The adopted articles will be
4898 marked as such by pointy brackets (@samp{<>}) instead of the standard
4899 square brackets (@samp{[]}). This is the default method.
4902 @vindex gnus-summary-dummy-line-format
4903 Gnus will create a dummy summary line that will pretend to be the
4904 parent. This dummy line does not correspond to any real article, so
4905 selecting it will just select the first real article after the dummy
4906 article. @code{gnus-summary-dummy-line-format} is used to specify the
4907 format of the dummy roots. It accepts only one format spec: @samp{S},
4908 which is the subject of the article. @xref{Formatting Variables}.
4911 Gnus won't actually make any article the parent, but simply leave the
4912 subject field of all orphans except the first empty. (Actually, it will
4913 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4917 Don't make any article parent at all. Just gather the threads and
4918 display them after one another.
4921 Don't gather loose threads.
4924 @item gnus-summary-gather-subject-limit
4925 @vindex gnus-summary-gather-subject-limit
4926 Loose threads are gathered by comparing subjects of articles. If this
4927 variable is @code{nil}, Gnus requires an exact match between the
4928 subjects of the loose threads before gathering them into one big
4929 super-thread. This might be too strict a requirement, what with the
4930 presence of stupid newsreaders that chop off long subject lines. If
4931 you think so, set this variable to, say, 20 to require that only the
4932 first 20 characters of the subjects have to match. If you set this
4933 variable to a really low number, you'll find that Gnus will gather
4934 everything in sight into one thread, which isn't very helpful.
4936 @cindex fuzzy article gathering
4937 If you set this variable to the special value @code{fuzzy}, Gnus will
4938 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4941 @item gnus-simplify-subject-fuzzy-regexp
4942 @vindex gnus-simplify-subject-fuzzy-regexp
4943 This can either be a regular expression or list of regular expressions
4944 that match strings that will be removed from subjects if fuzzy subject
4945 simplification is used.
4947 @item gnus-simplify-ignored-prefixes
4948 @vindex gnus-simplify-ignored-prefixes
4949 If you set @code{gnus-summary-gather-subject-limit} to something as low
4950 as 10, you might consider setting this variable to something sensible:
4952 @c Written by Michael Ernst <mernst@cs.rice.edu>
4954 (setq gnus-simplify-ignored-prefixes
4960 "wanted" "followup" "summary\\( of\\)?"
4961 "help" "query" "problem" "question"
4962 "answer" "reference" "announce"
4963 "How can I" "How to" "Comparison of"
4968 (mapconcat 'identity
4969 '("for" "for reference" "with" "about")
4971 "\\)?\\]?:?[ \t]*"))
4974 All words that match this regexp will be removed before comparing two
4977 @item gnus-simplify-subject-functions
4978 @vindex gnus-simplify-subject-functions
4979 If non-@code{nil}, this variable overrides
4980 @code{gnus-summary-gather-subject-limit}. This variable should be a
4981 list of functions to apply to the @code{Subject} string iteratively to
4982 arrive at the simplified version of the string.
4984 Useful functions to put in this list include:
4987 @item gnus-simplify-subject-re
4988 @findex gnus-simplify-subject-re
4989 Strip the leading @samp{Re:}.
4991 @item gnus-simplify-subject-fuzzy
4992 @findex gnus-simplify-subject-fuzzy
4995 @item gnus-simplify-whitespace
4996 @findex gnus-simplify-whitespace
4997 Remove excessive whitespace.
5000 You may also write your own functions, of course.
5003 @item gnus-summary-gather-exclude-subject
5004 @vindex gnus-summary-gather-exclude-subject
5005 Since loose thread gathering is done on subjects only, that might lead
5006 to many false hits, especially with certain common subjects like
5007 @samp{} and @samp{(none)}. To make the situation slightly better,
5008 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
5009 what subjects should be excluded from the gathering process.@*
5010 The default is @samp{^ *$\\|^(none)$}.
5012 @item gnus-summary-thread-gathering-function
5013 @vindex gnus-summary-thread-gathering-function
5014 Gnus gathers threads by looking at @code{Subject} headers. This means
5015 that totally unrelated articles may end up in the same ``thread'', which
5016 is confusing. An alternate approach is to look at all the
5017 @code{Message-ID}s in all the @code{References} headers to find matches.
5018 This will ensure that no gathered threads ever include unrelated
5019 articles, but it also means that people who have posted with broken
5020 newsreaders won't be gathered properly. The choice is yours---plague or
5024 @item gnus-gather-threads-by-subject
5025 @findex gnus-gather-threads-by-subject
5026 This function is the default gathering function and looks at
5027 @code{Subject}s exclusively.
5029 @item gnus-gather-threads-by-references
5030 @findex gnus-gather-threads-by-references
5031 This function looks at @code{References} headers exclusively.
5034 If you want to test gathering by @code{References}, you could say
5038 (setq gnus-summary-thread-gathering-function
5039 'gnus-gather-threads-by-references)
5045 @node Filling In Threads
5046 @subsubsection Filling In Threads
5049 @item gnus-fetch-old-headers
5050 @vindex gnus-fetch-old-headers
5051 If non-@code{nil}, Gnus will attempt to build old threads by fetching
5052 more old headers---headers to articles marked as read. If you
5053 would like to display as few summary lines as possible, but still
5054 connect as many loose threads as possible, you should set this variable
5055 to @code{some} or a number. If you set it to a number, no more than
5056 that number of extra old headers will be fetched. In either case,
5057 fetching old headers only works if the backend you are using carries
5058 overview files---this would normally be @code{nntp}, @code{nnspool} and
5059 @code{nnml}. Also remember that if the root of the thread has been
5060 expired by the server, there's not much Gnus can do about that.
5062 This variable can also be set to @code{invisible}. This won't have any
5063 visible effects, but is useful if you use the @kbd{A T} command a lot
5064 (@pxref{Finding the Parent}).
5066 @item gnus-build-sparse-threads
5067 @vindex gnus-build-sparse-threads
5068 Fetching old headers can be slow. A low-rent similar effect can be
5069 gotten by setting this variable to @code{some}. Gnus will then look at
5070 the complete @code{References} headers of all articles and try to string
5071 together articles that belong in the same thread. This will leave
5072 @dfn{gaps} in the threading display where Gnus guesses that an article
5073 is missing from the thread. (These gaps appear like normal summary
5074 lines. If you select a gap, Gnus will try to fetch the article in
5075 question.) If this variable is @code{t}, Gnus will display all these
5076 ``gaps'' without regard for whether they are useful for completing the
5077 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
5078 off sparse leaf nodes that don't lead anywhere. This variable is
5079 @code{nil} by default.
5084 @node More Threading
5085 @subsubsection More Threading
5088 @item gnus-show-threads
5089 @vindex gnus-show-threads
5090 If this variable is @code{nil}, no threading will be done, and all of
5091 the rest of the variables here will have no effect. Turning threading
5092 off will speed group selection up a bit, but it is sure to make reading
5093 slower and more awkward.
5095 @item gnus-thread-hide-subtree
5096 @vindex gnus-thread-hide-subtree
5097 If non-@code{nil}, all threads will be hidden when the summary buffer is
5100 @item gnus-thread-expunge-below
5101 @vindex gnus-thread-expunge-below
5102 All threads that have a total score (as defined by
5103 @code{gnus-thread-score-function}) less than this number will be
5104 expunged. This variable is @code{nil} by default, which means that no
5105 threads are expunged.
5107 @item gnus-thread-hide-killed
5108 @vindex gnus-thread-hide-killed
5109 if you kill a thread and this variable is non-@code{nil}, the subtree
5112 @item gnus-thread-ignore-subject
5113 @vindex gnus-thread-ignore-subject
5114 Sometimes somebody changes the subject in the middle of a thread. If
5115 this variable is non-@code{nil}, the subject change is ignored. If it
5116 is @code{nil}, which is the default, a change in the subject will result
5119 @item gnus-thread-indent-level
5120 @vindex gnus-thread-indent-level
5121 This is a number that says how much each sub-thread should be indented.
5127 @node Low-Level Threading
5128 @subsubsection Low-Level Threading
5132 @item gnus-parse-headers-hook
5133 @vindex gnus-parse-headers-hook
5134 Hook run before parsing any headers.
5136 @item gnus-alter-header-function
5137 @vindex gnus-alter-header-function
5138 If non-@code{nil}, this function will be called to allow alteration of
5139 article header structures. The function is called with one parameter,
5140 the article header vector, which it may alter in any way. For instance,
5141 if you have a mail-to-news gateway which alters the @code{Message-ID}s
5142 in systematic ways (by adding prefixes and such), you can use this
5143 variable to un-scramble the @code{Message-ID}s so that they are more
5144 meaningful. Here's one example:
5147 (setq gnus-alter-header-function 'my-alter-message-id)
5149 (defun my-alter-message-id (header)
5150 (let ((id (mail-header-id header)))
5152 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
5154 (concat (match-string 1 id) "@@" (match-string 2 id))
5161 @node Thread Commands
5162 @subsection Thread Commands
5163 @cindex thread commands
5169 @kindex T k (Summary)
5170 @kindex M-C-k (Summary)
5171 @findex gnus-summary-kill-thread
5172 Mark all articles in the current (sub-)thread as read
5173 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
5174 remove all marks instead. If the prefix argument is negative, tick
5179 @kindex T l (Summary)
5180 @kindex M-C-l (Summary)
5181 @findex gnus-summary-lower-thread
5182 Lower the score of the current (sub-)thread
5183 (@code{gnus-summary-lower-thread}).
5186 @kindex T i (Summary)
5187 @findex gnus-summary-raise-thread
5188 Increase the score of the current (sub-)thread
5189 (@code{gnus-summary-raise-thread}).
5192 @kindex T # (Summary)
5193 @findex gnus-uu-mark-thread
5194 Set the process mark on the current (sub-)thread
5195 (@code{gnus-uu-mark-thread}).
5198 @kindex T M-# (Summary)
5199 @findex gnus-uu-unmark-thread
5200 Remove the process mark from the current (sub-)thread
5201 (@code{gnus-uu-unmark-thread}).
5204 @kindex T T (Summary)
5205 @findex gnus-summary-toggle-threads
5206 Toggle threading (@code{gnus-summary-toggle-threads}).
5209 @kindex T s (Summary)
5210 @findex gnus-summary-show-thread
5211 Expose the (sub-)thread hidden under the current article, if any
5212 (@code{gnus-summary-show-thread}).
5215 @kindex T h (Summary)
5216 @findex gnus-summary-hide-thread
5217 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5220 @kindex T S (Summary)
5221 @findex gnus-summary-show-all-threads
5222 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5225 @kindex T H (Summary)
5226 @findex gnus-summary-hide-all-threads
5227 Hide all threads (@code{gnus-summary-hide-all-threads}).
5230 @kindex T t (Summary)
5231 @findex gnus-summary-rethread-current
5232 Re-thread the current article's thread
5233 (@code{gnus-summary-rethread-current}). This works even when the
5234 summary buffer is otherwise unthreaded.
5237 @kindex T ^ (Summary)
5238 @findex gnus-summary-reparent-thread
5239 Make the current article the child of the marked (or previous) article
5240 (@code{gnus-summary-reparent-thread}).
5244 The following commands are thread movement commands. They all
5245 understand the numeric prefix.
5250 @kindex T n (Summary)
5251 @findex gnus-summary-next-thread
5252 Go to the next thread (@code{gnus-summary-next-thread}).
5255 @kindex T p (Summary)
5256 @findex gnus-summary-prev-thread
5257 Go to the previous thread (@code{gnus-summary-prev-thread}).
5260 @kindex T d (Summary)
5261 @findex gnus-summary-down-thread
5262 Descend the thread (@code{gnus-summary-down-thread}).
5265 @kindex T u (Summary)
5266 @findex gnus-summary-up-thread
5267 Ascend the thread (@code{gnus-summary-up-thread}).
5270 @kindex T o (Summary)
5271 @findex gnus-summary-top-thread
5272 Go to the top of the thread (@code{gnus-summary-top-thread}).
5275 @vindex gnus-thread-operation-ignore-subject
5276 If you ignore subject while threading, you'll naturally end up with
5277 threads that have several different subjects in them. If you then issue
5278 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5279 wish to kill the entire thread, but just those parts of the thread that
5280 have the same subject as the current article. If you like this idea,
5281 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
5282 is non-@code{nil} (which it is by default), subjects will be ignored
5283 when doing thread commands. If this variable is @code{nil}, articles in
5284 the same thread with different subjects will not be included in the
5285 operation in question. If this variable is @code{fuzzy}, only articles
5286 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5293 @findex gnus-thread-sort-by-total-score
5294 @findex gnus-thread-sort-by-date
5295 @findex gnus-thread-sort-by-score
5296 @findex gnus-thread-sort-by-subject
5297 @findex gnus-thread-sort-by-author
5298 @findex gnus-thread-sort-by-number
5299 @vindex gnus-thread-sort-functions
5300 If you are using a threaded summary display, you can sort the threads by
5301 setting @code{gnus-thread-sort-functions}, which can be either a single
5302 function, a list of functions, or a list containing functions and
5303 @code{(not some-function)} elements.
5305 By default, sorting is done on article numbers. Ready-made sorting
5306 predicate functions include @code{gnus-thread-sort-by-number},
5307 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5308 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5309 @code{gnus-thread-sort-by-total-score}.
5311 Each function takes two threads and returns non-@code{nil} if the first
5312 thread should be sorted before the other. Note that sorting really is
5313 normally done by looking only at the roots of each thread.
5315 If you use more than one function, the primary sort key should be the
5316 last function in the list. You should probably always include
5317 @code{gnus-thread-sort-by-number} in the list of sorting
5318 functions---preferably first. This will ensure that threads that are
5319 equal with respect to the other sort criteria will be displayed in
5320 ascending article order.
5322 If you would like to sort by reverse score, then by subject, and finally
5323 by number, you could do something like:
5326 (setq gnus-thread-sort-functions
5327 '(gnus-thread-sort-by-number
5328 gnus-thread-sort-by-subject
5329 (not gnus-thread-sort-by-total-score)))
5332 The threads that have highest score will be displayed first in the
5333 summary buffer. When threads have the same score, they will be sorted
5334 alphabetically. The threads that have the same score and the same
5335 subject will be sorted by number, which is (normally) the sequence in
5336 which the articles arrived.
5338 If you want to sort by score and then reverse arrival order, you could
5342 (setq gnus-thread-sort-functions
5344 (not (gnus-thread-sort-by-number t1 t2)))
5345 gnus-thread-sort-by-score))
5348 @vindex gnus-thread-score-function
5349 The function in the @code{gnus-thread-score-function} variable (default
5350 @code{+}) is used for calculating the total score of a thread. Useful
5351 functions might be @code{max}, @code{min}, or squared means, or whatever
5354 @findex gnus-article-sort-functions
5355 @findex gnus-article-sort-by-date
5356 @findex gnus-article-sort-by-score
5357 @findex gnus-article-sort-by-subject
5358 @findex gnus-article-sort-by-author
5359 @findex gnus-article-sort-by-number
5360 If you are using an unthreaded display for some strange reason or other,
5361 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5362 It is very similar to the @code{gnus-thread-sort-functions}, except that
5363 it uses slightly different functions for article comparison. Available
5364 sorting predicate functions are @code{gnus-article-sort-by-number},
5365 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5366 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5368 If you want to sort an unthreaded summary display by subject, you could
5372 (setq gnus-article-sort-functions
5373 '(gnus-article-sort-by-number
5374 gnus-article-sort-by-subject))
5379 @node Asynchronous Fetching
5380 @section Asynchronous Article Fetching
5381 @cindex asynchronous article fetching
5382 @cindex article pre-fetch
5385 If you read your news from an @sc{nntp} server that's far away, the
5386 network latencies may make reading articles a chore. You have to wait
5387 for a while after pressing @kbd{n} to go to the next article before the
5388 article appears. Why can't Gnus just go ahead and fetch the article
5389 while you are reading the previous one? Why not, indeed.
5391 First, some caveats. There are some pitfalls to using asynchronous
5392 article fetching, especially the way Gnus does it.
5394 Let's say you are reading article 1, which is short, and article 2 is
5395 quite long, and you are not interested in reading that. Gnus does not
5396 know this, so it goes ahead and fetches article 2. You decide to read
5397 article 3, but since Gnus is in the process of fetching article 2, the
5398 connection is blocked.
5400 To avoid these situations, Gnus will open two (count 'em two)
5401 connections to the server. Some people may think this isn't a very nice
5402 thing to do, but I don't see any real alternatives. Setting up that
5403 extra connection takes some time, so Gnus startup will be slower.
5405 Gnus will fetch more articles than you will read. This will mean that
5406 the link between your machine and the @sc{nntp} server will become more
5407 loaded than if you didn't use article pre-fetch. The server itself will
5408 also become more loaded---both with the extra article requests, and the
5411 Ok, so now you know that you shouldn't really use this thing... unless
5414 @vindex gnus-asynchronous
5415 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
5416 happen automatically.
5418 @vindex gnus-use-article-prefetch
5419 You can control how many articles are to be pre-fetched by setting
5420 @code{gnus-use-article-prefetch}. This is 30 by default, which means
5421 that when you read an article in the group, the backend will pre-fetch
5422 the next 30 articles. If this variable is @code{t}, the backend will
5423 pre-fetch all the articles it can without bound. If it is
5424 @code{nil}, no pre-fetching will be done.
5426 @vindex gnus-async-prefetch-article-p
5427 @findex gnus-async-read-p
5428 There are probably some articles that you don't want to pre-fetch---read
5429 articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should
5430 return non-@code{nil} when the article in question is to be
5431 pre-fetched. The default is @code{gnus-async-read-p}, which returns
5432 @code{nil} on read articles. The function is called with an article
5433 data structure as the only parameter.
5435 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
5438 (defun my-async-short-unread-p (data)
5439 "Return non-nil for short, unread articles."
5440 (and (gnus-data-unread-p data)
5441 (< (mail-header-lines (gnus-data-header data))
5444 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5447 These functions will be called many, many times, so they should
5448 preferably be short and sweet to avoid slowing down Gnus too much.
5449 It's probably a good idea to byte-compile things like this.
5451 @vindex gnus-prefetched-article-deletion-strategy
5452 Articles have to be removed from the asynch buffer sooner or later. The
5453 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5454 articles. This is a list that may contain the following elements:
5458 Remove articles when they are read.
5461 Remove articles when exiting the group.
5464 The default value is @code{(read exit)}.
5466 @c @vindex gnus-use-header-prefetch
5467 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5468 @c from the next group.
5471 @node Article Caching
5472 @section Article Caching
5473 @cindex article caching
5476 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5477 consider turning article caching on. Each article will then be stored
5478 locally under your home directory. As you may surmise, this could
5479 potentially use @emph{huge} amounts of disk space, as well as eat up all
5480 your inodes so fast it will make your head swim. In vodka.
5482 Used carefully, though, it could be just an easier way to save articles.
5484 @vindex gnus-use-long-file-name
5485 @vindex gnus-cache-directory
5486 @vindex gnus-use-cache
5487 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
5488 all articles ticked or marked as dormant will then be copied
5489 over to your local cache (@code{gnus-cache-directory}). Whether this
5490 cache is flat or hierarchal is controlled by the
5491 @code{gnus-use-long-file-name} variable, as usual.
5493 When re-selecting a ticked or dormant article, it will be fetched from the
5494 cache instead of from the server. As articles in your cache will never
5495 expire, this might serve as a method of saving articles while still
5496 keeping them where they belong. Just mark all articles you want to save
5497 as dormant, and don't worry.
5499 When an article is marked as read, is it removed from the cache.
5501 @vindex gnus-cache-remove-articles
5502 @vindex gnus-cache-enter-articles
5503 The entering/removal of articles from the cache is controlled by the
5504 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5505 variables. Both are lists of symbols. The first is @code{(ticked
5506 dormant)} by default, meaning that ticked and dormant articles will be
5507 put in the cache. The latter is @code{(read)} by default, meaning that
5508 articles marked as read are removed from the cache. Possibly
5509 symbols in these two lists are @code{ticked}, @code{dormant},
5510 @code{unread} and @code{read}.
5512 @findex gnus-jog-cache
5513 So where does the massive article-fetching and storing come into the
5514 picture? The @code{gnus-jog-cache} command will go through all
5515 subscribed newsgroups, request all unread articles, score them, and
5516 store them in the cache. You should only ever, ever ever ever, use this
5517 command if 1) your connection to the @sc{nntp} server is really, really,
5518 really slow and 2) you have a really, really, really huge disk.
5519 Seriously. One way to cut down on the number of articles downloaded is
5520 to score unwanted articles down and have them marked as read. They will
5521 not then be downloaded by this command.
5523 @vindex gnus-uncacheable-groups
5524 @vindex gnus-cacheable-groups
5525 It is likely that you do not want caching on all groups. For instance,
5526 if your @code{nnml} mail is located under your home directory, it makes no
5527 sense to cache it somewhere else under your home directory. Unless you
5528 feel that it's neat to use twice as much space.
5530 To limit the caching, you could set @code{gnus-cacheable-groups} to a
5531 regexp of groups to cache, @samp{^nntp} for instance, or set the
5532 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
5533 Both variables are @code{nil} by default. If a group matches both
5534 variables, the group is not cached.
5536 @findex gnus-cache-generate-nov-databases
5537 @findex gnus-cache-generate-active
5538 @vindex gnus-cache-active-file
5539 The cache stores information on what articles it contains in its active
5540 file (@code{gnus-cache-active-file}). If this file (or any other parts
5541 of the cache) becomes all messed up for some reason or other, Gnus
5542 offers two functions that will try to set things right. @kbd{M-x
5543 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5544 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5548 @node Persistent Articles
5549 @section Persistent Articles
5550 @cindex persistent articles
5552 Closely related to article caching, we have @dfn{persistent articles}.
5553 In fact, it's just a different way of looking at caching, and much more
5554 useful in my opinion.
5556 Say you're reading a newsgroup, and you happen on to some valuable gem
5557 that you want to keep and treasure forever. You'd normally just save it
5558 (using one of the many saving commands) in some file. The problem with
5559 that is that it's just, well, yucky. Ideally you'd prefer just having
5560 the article remain in the group where you found it forever; untouched by
5561 the expiry going on at the news server.
5563 This is what a @dfn{persistent article} is---an article that just won't
5564 be deleted. It's implemented using the normal cache functions, but
5565 you use two explicit commands for managing persistent articles:
5571 @findex gnus-cache-enter-article
5572 Make the current article persistent (@code{gnus-cache-enter-article}).
5575 @kindex M-* (Summary)
5576 @findex gnus-cache-remove-article
5577 Remove the current article from the persistent articles
5578 (@code{gnus-cache-remove-article}). This will normally delete the
5582 Both these commands understand the process/prefix convention.
5584 To avoid having all ticked articles (and stuff) entered into the cache,
5585 you should set @code{gnus-use-cache} to @code{passive} if you're just
5586 interested in persistent articles:
5589 (setq gnus-use-cache 'passive)
5593 @node Article Backlog
5594 @section Article Backlog
5596 @cindex article backlog
5598 If you have a slow connection, but the idea of using caching seems
5599 unappealing to you (and it is, really), you can help the situation some
5600 by switching on the @dfn{backlog}. This is where Gnus will buffer
5601 already read articles so that it doesn't have to re-fetch articles
5602 you've already read. This only helps if you are in the habit of
5603 re-selecting articles you've recently read, of course. If you never do
5604 that, turning the backlog on will slow Gnus down a little bit, and
5605 increase memory usage some.
5607 @vindex gnus-keep-backlog
5608 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5609 at most @var{n} old articles in a buffer for later re-fetching. If this
5610 variable is non-@code{nil} and is not a number, Gnus will store
5611 @emph{all} read articles, which means that your Emacs will grow without
5612 bound before exploding and taking your machine down with you. I put
5613 that in there just to keep y'all on your toes.
5615 This variable is @code{nil} by default.
5618 @node Saving Articles
5619 @section Saving Articles
5620 @cindex saving articles
5622 Gnus can save articles in a number of ways. Below is the documentation
5623 for saving articles in a fairly straight-forward fashion (i.e., little
5624 processing of the article is done before it is saved). For a different
5625 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5626 (@pxref{Decoding Articles}).
5628 @vindex gnus-save-all-headers
5629 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5630 unwanted headers before saving the article.
5632 @vindex gnus-saved-headers
5633 If the preceding variable is @code{nil}, all headers that match the
5634 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5635 deleted before saving.
5641 @kindex O o (Summary)
5643 @findex gnus-summary-save-article
5644 @c @icon{gnus-summary-save-article}
5645 Save the current article using the default article saver
5646 (@code{gnus-summary-save-article}).
5649 @kindex O m (Summary)
5650 @findex gnus-summary-save-article-mail
5651 Save the current article in mail format
5652 (@code{gnus-summary-save-article-mail}).
5655 @kindex O r (Summary)
5656 @findex gnus-summary-save-article-rmail
5657 Save the current article in rmail format
5658 (@code{gnus-summary-save-article-rmail}).
5661 @kindex O f (Summary)
5662 @findex gnus-summary-save-article-file
5663 @c @icon{gnus-summary-save-article-file}
5664 Save the current article in plain file format
5665 (@code{gnus-summary-save-article-file}).
5668 @kindex O F (Summary)
5669 @findex gnus-summary-write-article-file
5670 Write the current article in plain file format, overwriting any previous
5671 file contents (@code{gnus-summary-write-article-file}).
5674 @kindex O b (Summary)
5675 @findex gnus-summary-save-article-body-file
5676 Save the current article body in plain file format
5677 (@code{gnus-summary-save-article-body-file}).
5680 @kindex O h (Summary)
5681 @findex gnus-summary-save-article-folder
5682 Save the current article in mh folder format
5683 (@code{gnus-summary-save-article-folder}).
5686 @kindex O v (Summary)
5687 @findex gnus-summary-save-article-vm
5688 Save the current article in a VM folder
5689 (@code{gnus-summary-save-article-vm}).
5692 @kindex O p (Summary)
5693 @findex gnus-summary-pipe-output
5694 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
5695 the current article to a process (@code{gnus-summary-pipe-output}).
5698 @vindex gnus-prompt-before-saving
5699 All these commands use the process/prefix convention
5700 (@pxref{Process/Prefix}). If you save bunches of articles using these
5701 functions, you might get tired of being prompted for files to save each
5702 and every article in. The prompting action is controlled by
5703 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5704 default, giving you that excessive prompting action you know and
5705 loathe. If you set this variable to @code{t} instead, you'll be prompted
5706 just once for each series of articles you save. If you like to really
5707 have Gnus do all your thinking for you, you can even set this variable
5708 to @code{nil}, which means that you will never be prompted for files to
5709 save articles in. Gnus will simply save all the articles in the default
5713 @vindex gnus-default-article-saver
5714 You can customize the @code{gnus-default-article-saver} variable to make
5715 Gnus do what you want it to. You can use any of the six ready-made
5716 functions below, or you can create your own.
5720 @item gnus-summary-save-in-rmail
5721 @findex gnus-summary-save-in-rmail
5722 @vindex gnus-rmail-save-name
5723 @findex gnus-plain-save-name
5724 This is the default format, @dfn{babyl}. Uses the function in the
5725 @code{gnus-rmail-save-name} variable to get a file name to save the
5726 article in. The default is @code{gnus-plain-save-name}.
5728 @item gnus-summary-save-in-mail
5729 @findex gnus-summary-save-in-mail
5730 @vindex gnus-mail-save-name
5731 Save in a Unix mail (mbox) file. Uses the function in the
5732 @code{gnus-mail-save-name} variable to get a file name to save the
5733 article in. The default is @code{gnus-plain-save-name}.
5735 @item gnus-summary-save-in-file
5736 @findex gnus-summary-save-in-file
5737 @vindex gnus-file-save-name
5738 @findex gnus-numeric-save-name
5739 Append the article straight to an ordinary file. Uses the function in
5740 the @code{gnus-file-save-name} variable to get a file name to save the
5741 article in. The default is @code{gnus-numeric-save-name}.
5743 @item gnus-summary-save-body-in-file
5744 @findex gnus-summary-save-body-in-file
5745 Append the article body to an ordinary file. Uses the function in the
5746 @code{gnus-file-save-name} variable to get a file name to save the
5747 article in. The default is @code{gnus-numeric-save-name}.
5749 @item gnus-summary-save-in-folder
5750 @findex gnus-summary-save-in-folder
5751 @findex gnus-folder-save-name
5752 @findex gnus-Folder-save-name
5753 @vindex gnus-folder-save-name
5756 Save the article to an MH folder using @code{rcvstore} from the MH
5757 library. Uses the function in the @code{gnus-folder-save-name} variable
5758 to get a file name to save the article in. The default is
5759 @code{gnus-folder-save-name}, but you can also use
5760 @code{gnus-Folder-save-name}, which creates capitalized names.
5762 @item gnus-summary-save-in-vm
5763 @findex gnus-summary-save-in-vm
5764 Save the article in a VM folder. You have to have the VM mail
5765 reader to use this setting.
5768 @vindex gnus-article-save-directory
5769 All of these functions, except for the last one, will save the article
5770 in the @code{gnus-article-save-directory}, which is initialized from the
5771 @code{SAVEDIR} environment variable. This is @file{~/News/} by
5774 As you can see above, the functions use different functions to find a
5775 suitable name of a file to save the article in. Below is a list of
5776 available functions that generate names:
5780 @item gnus-Numeric-save-name
5781 @findex gnus-Numeric-save-name
5782 File names like @file{~/News/Alt.andrea-dworkin/45}.
5784 @item gnus-numeric-save-name
5785 @findex gnus-numeric-save-name
5786 File names like @file{~/News/alt.andrea-dworkin/45}.
5788 @item gnus-Plain-save-name
5789 @findex gnus-Plain-save-name
5790 File names like @file{~/News/Alt.andrea-dworkin}.
5792 @item gnus-plain-save-name
5793 @findex gnus-plain-save-name
5794 File names like @file{~/News/alt.andrea-dworkin}.
5797 @vindex gnus-split-methods
5798 You can have Gnus suggest where to save articles by plonking a regexp into
5799 the @code{gnus-split-methods} alist. For instance, if you would like to
5800 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5801 related to VM in @code{vm-stuff}, you could set this variable to something
5805 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5806 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5807 (my-choosing-function "../other-dir/my-stuff")
5808 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5811 We see that this is a list where each element is a list that has two
5812 elements---the @dfn{match} and the @dfn{file}. The match can either be
5813 a string (in which case it is used as a regexp to match on the article
5814 head); it can be a symbol (which will be called as a function with the
5815 group name as a parameter); or it can be a list (which will be
5816 @code{eval}ed). If any of these actions have a non-@code{nil} result,
5817 the @dfn{file} will be used as a default prompt. In addition, the
5818 result of the operation itself will be used if the function or form
5819 called returns a string or a list of strings.
5821 You basically end up with a list of file names that might be used when
5822 saving the current article. (All ``matches'' will be used.) You will
5823 then be prompted for what you really want to use as a name, with file
5824 name completion over the results from applying this variable.
5826 This variable is @code{((gnus-article-archive-name))} by default, which
5827 means that Gnus will look at the articles it saves for an
5828 @code{Archive-name} line and use that as a suggestion for the file
5831 Here's an example function to clean up file names somewhat. If you have
5832 lots of mail groups called things like
5833 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5834 these group names before creating the file name to save to. The
5835 following will do just that:
5838 (defun my-save-name (group)
5839 (when (string-match "^nnml:mail." group)
5840 (substring group (match-end 0))))
5842 (setq gnus-split-methods
5843 '((gnus-article-archive-name)
5848 @vindex gnus-use-long-file-name
5849 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
5850 @code{nil}, all the preceding functions will replace all periods
5851 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5852 the functions will generate hierarchies of directories instead of having
5853 all the files in the top level directory
5854 (@file{~/News/alt/andrea-dworkin} instead of
5855 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
5856 on most systems. However, for historical reasons, this is @code{nil} on
5857 Xenix and usg-unix-v machines by default.
5859 This function also affects kill and score file names. If this variable
5860 is a list, and the list contains the element @code{not-score}, long file
5861 names will not be used for score files, if it contains the element
5862 @code{not-save}, long file names will not be used for saving, and if it
5863 contains the element @code{not-kill}, long file names will not be used
5866 If you'd like to save articles in a hierarchy that looks something like
5870 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5871 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5874 Then just save with @kbd{o}. You'd then read this hierarchy with
5875 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5876 the top level directory as the argument (@file{~/News/}). Then just walk
5877 around to the groups/directories with @code{nneething}.
5880 @node Decoding Articles
5881 @section Decoding Articles
5882 @cindex decoding articles
5884 Sometime users post articles (or series of articles) that have been
5885 encoded in some way or other. Gnus can decode them for you.
5888 * Uuencoded Articles:: Uudecode articles.
5889 * Shell Archives:: Unshar articles.
5890 * PostScript Files:: Split PostScript.
5891 * Other Files:: Plain save and binhex.
5892 * Decoding Variables:: Variables for a happy decoding.
5893 * Viewing Files:: You want to look at the result of the decoding?
5897 @cindex article series
5898 All these functions use the process/prefix convention
5899 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5900 the extension that a ``single article'' means ``a single series''. Gnus
5901 can find out by itself what articles belong to a series, decode all the
5902 articles and unpack/view/save the resulting file(s).
5904 Gnus guesses what articles are in the series according to the following
5905 simplish rule: The subjects must be (nearly) identical, except for the
5906 last two numbers of the line. (Spaces are largely ignored, however.)
5908 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5909 will find all the articles that match the regexp @samp{^cat.gif
5910 ([0-9]+/[0-9]+).*$}.
5912 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5913 series}, will not be properly recognized by any of the automatic viewing
5914 commands, and you have to mark the articles manually with @kbd{#}.
5917 @node Uuencoded Articles
5918 @subsection Uuencoded Articles
5920 @cindex uuencoded articles
5925 @kindex X u (Summary)
5926 @findex gnus-uu-decode-uu
5927 @c @icon{gnus-uu-decode-uu}
5928 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5931 @kindex X U (Summary)
5932 @findex gnus-uu-decode-uu-and-save
5933 Uudecodes and saves the current series
5934 (@code{gnus-uu-decode-uu-and-save}).
5937 @kindex X v u (Summary)
5938 @findex gnus-uu-decode-uu-view
5939 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5942 @kindex X v U (Summary)
5943 @findex gnus-uu-decode-uu-and-save-view
5944 Uudecodes, views and saves the current series
5945 (@code{gnus-uu-decode-uu-and-save-view}).
5949 Remember that these all react to the presence of articles marked with
5950 the process mark. If, for instance, you'd like to decode and save an
5951 entire newsgroup, you'd typically do @kbd{M P a}
5952 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5953 (@code{gnus-uu-decode-uu-and-save}).
5955 All this is very much different from how @code{gnus-uu} worked with
5956 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5957 the sun. This version of @code{gnus-uu} generally assumes that you mark
5958 articles in some way (@pxref{Setting Process Marks}) and then press
5961 @vindex gnus-uu-notify-files
5962 Note: When trying to decode articles that have names matching
5963 @code{gnus-uu-notify-files}, which is hard-coded to
5964 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5965 automatically post an article on @samp{comp.unix.wizards} saying that
5966 you have just viewed the file in question. This feature can't be turned
5970 @node Shell Archives
5971 @subsection Shell Archives
5973 @cindex shell archives
5974 @cindex shared articles
5976 Shell archives (``shar files'') used to be a popular way to distribute
5977 sources, but it isn't used all that much today. In any case, we have
5978 some commands to deal with these:
5983 @kindex X s (Summary)
5984 @findex gnus-uu-decode-unshar
5985 Unshars the current series (@code{gnus-uu-decode-unshar}).
5988 @kindex X S (Summary)
5989 @findex gnus-uu-decode-unshar-and-save
5990 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5993 @kindex X v s (Summary)
5994 @findex gnus-uu-decode-unshar-view
5995 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5998 @kindex X v S (Summary)
5999 @findex gnus-uu-decode-unshar-and-save-view
6000 Unshars, views and saves the current series
6001 (@code{gnus-uu-decode-unshar-and-save-view}).
6005 @node PostScript Files
6006 @subsection PostScript Files
6012 @kindex X p (Summary)
6013 @findex gnus-uu-decode-postscript
6014 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
6017 @kindex X P (Summary)
6018 @findex gnus-uu-decode-postscript-and-save
6019 Unpack and save the current PostScript series
6020 (@code{gnus-uu-decode-postscript-and-save}).
6023 @kindex X v p (Summary)
6024 @findex gnus-uu-decode-postscript-view
6025 View the current PostScript series
6026 (@code{gnus-uu-decode-postscript-view}).
6029 @kindex X v P (Summary)
6030 @findex gnus-uu-decode-postscript-and-save-view
6031 View and save the current PostScript series
6032 (@code{gnus-uu-decode-postscript-and-save-view}).
6037 @subsection Other Files
6041 @kindex X o (Summary)
6042 @findex gnus-uu-decode-save
6043 Save the current series
6044 (@code{gnus-uu-decode-save}).
6047 @kindex X b (Summary)
6048 @findex gnus-uu-decode-binhex
6049 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
6050 doesn't really work yet.
6054 @node Decoding Variables
6055 @subsection Decoding Variables
6057 Adjective, not verb.
6060 * Rule Variables:: Variables that say how a file is to be viewed.
6061 * Other Decode Variables:: Other decode variables.
6062 * Uuencoding and Posting:: Variables for customizing uuencoding.
6066 @node Rule Variables
6067 @subsubsection Rule Variables
6068 @cindex rule variables
6070 Gnus uses @dfn{rule variables} to decide how to view a file. All these
6071 variables are of the form
6074 (list '(regexp1 command2)
6081 @item gnus-uu-user-view-rules
6082 @vindex gnus-uu-user-view-rules
6084 This variable is consulted first when viewing files. If you wish to use,
6085 for instance, @code{sox} to convert an @samp{.au} sound file, you could
6088 (setq gnus-uu-user-view-rules
6089 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
6092 @item gnus-uu-user-view-rules-end
6093 @vindex gnus-uu-user-view-rules-end
6094 This variable is consulted if Gnus couldn't make any matches from the
6095 user and default view rules.
6097 @item gnus-uu-user-archive-rules
6098 @vindex gnus-uu-user-archive-rules
6099 This variable can be used to say what commands should be used to unpack
6104 @node Other Decode Variables
6105 @subsubsection Other Decode Variables
6108 @vindex gnus-uu-grabbed-file-functions
6110 @item gnus-uu-grabbed-file-functions
6111 All functions in this list will be called right after each file has been
6112 successfully decoded---so that you can move or view files right away,
6113 and don't have to wait for all files to be decoded before you can do
6114 anything. Ready-made functions you can put in this list are:
6118 @item gnus-uu-grab-view
6119 @findex gnus-uu-grab-view
6122 @item gnus-uu-grab-move
6123 @findex gnus-uu-grab-move
6124 Move the file (if you're using a saving function.)
6127 @item gnus-uu-be-dangerous
6128 @vindex gnus-uu-be-dangerous
6129 Specifies what to do if unusual situations arise during decoding. If
6130 @code{nil}, be as conservative as possible. If @code{t}, ignore things
6131 that didn't work, and overwrite existing files. Otherwise, ask each
6134 @item gnus-uu-ignore-files-by-name
6135 @vindex gnus-uu-ignore-files-by-name
6136 Files with name matching this regular expression won't be viewed.
6138 @item gnus-uu-ignore-files-by-type
6139 @vindex gnus-uu-ignore-files-by-type
6140 Files with a @sc{mime} type matching this variable won't be viewed.
6141 Note that Gnus tries to guess what type the file is based on the name.
6142 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
6145 @item gnus-uu-tmp-dir
6146 @vindex gnus-uu-tmp-dir
6147 Where @code{gnus-uu} does its work.
6149 @item gnus-uu-do-not-unpack-archives
6150 @vindex gnus-uu-do-not-unpack-archives
6151 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
6152 looking for files to display.
6154 @item gnus-uu-view-and-save
6155 @vindex gnus-uu-view-and-save
6156 Non-@code{nil} means that the user will always be asked to save a file
6159 @item gnus-uu-ignore-default-view-rules
6160 @vindex gnus-uu-ignore-default-view-rules
6161 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
6164 @item gnus-uu-ignore-default-archive-rules
6165 @vindex gnus-uu-ignore-default-archive-rules
6166 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
6169 @item gnus-uu-kill-carriage-return
6170 @vindex gnus-uu-kill-carriage-return
6171 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
6174 @item gnus-uu-unmark-articles-not-decoded
6175 @vindex gnus-uu-unmark-articles-not-decoded
6176 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
6177 decoded articles as unread.
6179 @item gnus-uu-correct-stripped-uucode
6180 @vindex gnus-uu-correct-stripped-uucode
6181 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
6182 uuencoded files that have had trailing spaces deleted.
6184 @item gnus-uu-pre-uudecode-hook
6185 @vindex gnus-uu-pre-uudecode-hook
6186 Hook run before sending a message to @code{uudecode}.
6188 @item gnus-uu-view-with-metamail
6189 @vindex gnus-uu-view-with-metamail
6191 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6192 commands defined by the rule variables and just fudge a @sc{mime}
6193 content type based on the file name. The result will be fed to
6194 @code{metamail} for viewing.
6196 @item gnus-uu-save-in-digest
6197 @vindex gnus-uu-save-in-digest
6198 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6199 decoding, will save in digests. If this variable is @code{nil},
6200 @code{gnus-uu} will just save everything in a file without any
6201 embellishments. The digesting almost conforms to RFC1153---no easy way
6202 to specify any meaningful volume and issue numbers were found, so I
6203 simply dropped them.
6208 @node Uuencoding and Posting
6209 @subsubsection Uuencoding and Posting
6213 @item gnus-uu-post-include-before-composing
6214 @vindex gnus-uu-post-include-before-composing
6215 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6216 before you compose the article. If this variable is @code{t}, you can
6217 either include an encoded file with @kbd{C-c C-i} or have one included
6218 for you when you post the article.
6220 @item gnus-uu-post-length
6221 @vindex gnus-uu-post-length
6222 Maximum length of an article. The encoded file will be split into how
6223 many articles it takes to post the entire file.
6225 @item gnus-uu-post-threaded
6226 @vindex gnus-uu-post-threaded
6227 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6228 thread. This may not be smart, as no other decoder I have seen is able
6229 to follow threads when collecting uuencoded articles. (Well, I have
6230 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6231 think that counts...) Default is @code{nil}.
6233 @item gnus-uu-post-separate-description
6234 @vindex gnus-uu-post-separate-description
6235 Non-@code{nil} means that the description will be posted in a separate
6236 article. The first article will typically be numbered (0/x). If this
6237 variable is @code{nil}, the description the user enters will be included
6238 at the beginning of the first article, which will be numbered (1/x).
6239 Default is @code{t}.
6245 @subsection Viewing Files
6246 @cindex viewing files
6247 @cindex pseudo-articles
6249 After decoding, if the file is some sort of archive, Gnus will attempt
6250 to unpack the archive and see if any of the files in the archive can be
6251 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
6252 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
6253 uncompress and de-tar the main file, and then view the two pictures.
6254 This unpacking process is recursive, so if the archive contains archives
6255 of archives, it'll all be unpacked.
6257 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
6258 extracted file into the summary buffer. If you go to these
6259 ``articles'', you will be prompted for a command to run (usually Gnus
6260 will make a suggestion), and then the command will be run.
6262 @vindex gnus-view-pseudo-asynchronously
6263 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6264 until the viewing is done before proceeding.
6266 @vindex gnus-view-pseudos
6267 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6268 the pseudo-articles into the summary buffer, but view them
6269 immediately. If this variable is @code{not-confirm}, the user won't even
6270 be asked for a confirmation before viewing is done.
6272 @vindex gnus-view-pseudos-separately
6273 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6274 pseudo-article will be created for each file to be viewed. If
6275 @code{nil}, all files that use the same viewing command will be given as
6276 a list of parameters to that command.
6278 @vindex gnus-insert-pseudo-articles
6279 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6280 pseudo-articles when decoding. It is @code{t} by default.
6282 So; there you are, reading your @emph{pseudo-articles} in your
6283 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6284 Why isn't anything real anymore? How did we get here?
6287 @node Article Treatment
6288 @section Article Treatment
6290 Reading through this huge manual, you may have quite forgotten that the
6291 object of newsreaders is to actually, like, read what people have
6292 written. Reading articles. Unfortunately, people are quite bad at
6293 writing, so there are tons of functions and variables to make reading
6294 these articles easier.
6297 * Article Highlighting:: You want to make the article look like fruit salad.
6298 * Article Fontisizing:: Making emphasized text look nice.
6299 * Article Hiding:: You also want to make certain info go away.
6300 * Article Washing:: Lots of way-neat functions to make life better.
6301 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
6302 * Article Date:: Grumble, UT!
6303 * Article Signature:: What is a signature?
6304 * Article Miscellania:: Various other stuff.
6308 @node Article Highlighting
6309 @subsection Article Highlighting
6310 @cindex highlighting
6312 Not only do you want your article buffer to look like fruit salad, but
6313 you want it to look like technicolor fruit salad.
6318 @kindex W H a (Summary)
6319 @findex gnus-article-highlight
6320 @findex gnus-article-maybe-highlight
6321 Do much highlighting of the current article
6322 (@code{gnus-article-highlight}). This function highlights header, cited
6323 text, the signature, and adds buttons to the body and the head.
6326 @kindex W H h (Summary)
6327 @findex gnus-article-highlight-headers
6328 @vindex gnus-header-face-alist
6329 Highlight the headers (@code{gnus-article-highlight-headers}). The
6330 highlighting will be done according to the @code{gnus-header-face-alist}
6331 variable, which is a list where each element has the form @var{(regexp
6332 name content)}. @var{regexp} is a regular expression for matching the
6333 header, @var{name} is the face used for highlighting the header name
6334 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6335 the header value. The first match made will be used. Note that
6336 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6339 @kindex W H c (Summary)
6340 @findex gnus-article-highlight-citation
6341 Highlight cited text (@code{gnus-article-highlight-citation}).
6343 Some variables to customize the citation highlights:
6346 @vindex gnus-cite-parse-max-size
6348 @item gnus-cite-parse-max-size
6349 If the article size if bigger than this variable (which is 25000 by
6350 default), no citation highlighting will be performed.
6352 @item gnus-cite-prefix-regexp
6353 @vindex gnus-cite-prefix-regexp
6354 Regexp matching the longest possible citation prefix on a line.
6356 @item gnus-cite-max-prefix
6357 @vindex gnus-cite-max-prefix
6358 Maximum possible length for a citation prefix (default 20).
6360 @item gnus-cite-face-list
6361 @vindex gnus-cite-face-list
6362 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6363 When there are citations from multiple articles in the same message,
6364 Gnus will try to give each citation from each article its own face.
6365 This should make it easier to see who wrote what.
6367 @item gnus-supercite-regexp
6368 @vindex gnus-supercite-regexp
6369 Regexp matching normal Supercite attribution lines.
6371 @item gnus-supercite-secondary-regexp
6372 @vindex gnus-supercite-secondary-regexp
6373 Regexp matching mangled Supercite attribution lines.
6375 @item gnus-cite-minimum-match-count
6376 @vindex gnus-cite-minimum-match-count
6377 Minimum number of identical prefixes we have to see before we believe
6378 that it's a citation.
6380 @item gnus-cite-attribution-prefix
6381 @vindex gnus-cite-attribution-prefix
6382 Regexp matching the beginning of an attribution line.
6384 @item gnus-cite-attribution-suffix
6385 @vindex gnus-cite-attribution-suffix
6386 Regexp matching the end of an attribution line.
6388 @item gnus-cite-attribution-face
6389 @vindex gnus-cite-attribution-face
6390 Face used for attribution lines. It is merged with the face for the
6391 cited text belonging to the attribution.
6397 @kindex W H s (Summary)
6398 @vindex gnus-signature-separator
6399 @vindex gnus-signature-face
6400 @findex gnus-article-highlight-signature
6401 Highlight the signature (@code{gnus-article-highlight-signature}).
6402 Everything after @code{gnus-signature-separator} (@pxref{Article
6403 Signature}) in an article will be considered a signature and will be
6404 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6409 @xref{Customizing Articles}, for how to highlight articles automatically.
6412 @node Article Fontisizing
6413 @subsection Article Fontisizing
6415 @cindex article emphasis
6417 @findex gnus-article-emphasize
6418 @kindex W e (Summary)
6419 People commonly add emphasis to words in news articles by writing things
6420 like @samp{_this_} or @samp{*this*}. Gnus can make this look nicer by
6421 running the article through the @kbd{W e}
6422 (@code{gnus-article-emphasize}) command.
6424 @vindex gnus-emphasis-alist
6425 How the emphasis is computed is controlled by the
6426 @code{gnus-emphasis-alist} variable. This is an alist where the first
6427 element is a regular expression to be matched. The second is a number
6428 that says what regular expression grouping is used to find the entire
6429 emphasized word. The third is a number that says what regexp grouping
6430 should be displayed and highlighted. (The text between these two
6431 groupings will be hidden.) The fourth is the face used for
6435 (setq gnus-article-emphasis
6436 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6437 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6440 @vindex gnus-emphasis-underline
6441 @vindex gnus-emphasis-bold
6442 @vindex gnus-emphasis-italic
6443 @vindex gnus-emphasis-underline-bold
6444 @vindex gnus-emphasis-underline-italic
6445 @vindex gnus-emphasis-bold-italic
6446 @vindex gnus-emphasis-underline-bold-italic
6447 By default, there are seven rules, and they use the following faces:
6448 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6449 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6450 @code{gnus-emphasis-underline-italic},
6451 @code{gnus-emphasis-underline-bold}, and
6452 @code{gnus-emphasis-underline-bold-italic}.
6454 If you want to change these faces, you can either use @kbd{M-x
6455 customize}, or you can use @code{copy-face}. For instance, if you want
6456 to make @code{gnus-emphasis-italic} use a red face instead, you could
6460 (copy-face 'red 'gnus-emphasis-italic)
6463 @vindex gnus-group-highlight-words-alist
6465 If you want to highlight arbitrary words, you can use the
6466 @code{gnus-group-highlight-words-alist} variable, which uses the same
6467 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
6468 parameter (@pxref{Group Parameters}) can also be used.
6470 @xref{Customizing Articles}, for how to fontize articles automatically.
6473 @node Article Hiding
6474 @subsection Article Hiding
6475 @cindex article hiding
6477 Or rather, hiding certain things in each article. There usually is much
6478 too much cruft in most articles.
6483 @kindex W W a (Summary)
6484 @findex gnus-article-hide
6485 Do quite a lot of hiding on the article buffer
6486 (@kbd{gnus-article-hide}). In particular, this function will hide
6487 headers, PGP, cited text and the signature.
6490 @kindex W W h (Summary)
6491 @findex gnus-article-hide-headers
6492 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
6496 @kindex W W b (Summary)
6497 @findex gnus-article-hide-boring-headers
6498 Hide headers that aren't particularly interesting
6499 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
6502 @kindex W W s (Summary)
6503 @findex gnus-article-hide-signature
6504 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
6508 @kindex W W p (Summary)
6509 @findex gnus-article-hide-pgp
6510 @vindex gnus-article-hide-pgp-hook
6511 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). The
6512 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6513 signature has been hidden. For example, to automatically verify
6514 articles that have signatures in them do:
6516 ;;; Hide pgp cruft if any.
6518 (setq gnus-treat-strip-pgp t)
6520 ;;; After hiding pgp, verify the message;
6521 ;;; only happens if pgp signature is found.
6523 (add-hook 'gnus-article-hide-pgp-hook
6526 (set-buffer gnus-original-article-buffer)
6531 @kindex W W P (Summary)
6532 @findex gnus-article-hide-pem
6533 Hide @sc{pem} (privacy enhanced messages) cruft
6534 (@code{gnus-article-hide-pem}).
6537 @kindex W W B (Summary)
6538 @findex gnus-article-strip-banner
6539 Strip the banner specified by the @code{banner} group parameter
6540 (@code{gnus-article-strip-banner}). This is mainly used to hide those
6541 annoying banners and/or signatures that some mailing lists and moderated
6542 groups adds to all the messages. The way to use this function is to add
6543 the @code{banner} group parameter (@pxref{Group Parameters}) to the
6544 group you want banners stripped from. The parameter either be a string,
6545 which will be interpreted as a regular expression matching text to be
6546 removed, or the symbol @code{signature}, meaning that the (last)
6547 signature should be removed.
6550 @kindex W W c (Summary)
6551 @findex gnus-article-hide-citation
6552 Hide citation (@code{gnus-article-hide-citation}). Some variables for
6553 customizing the hiding:
6557 @item gnus-cited-opened-text-button-line-format
6558 @itemx gnus-cited-closed-text-button-line-format
6559 @vindex gnus-cited-closed-text-button-line-format
6560 @vindex gnus-cited-opened-text-button-line-format
6561 Gnus adds buttons to show where the cited text has been hidden, and to
6562 allow toggle hiding the text. The format of the variable is specified
6563 by these format-like variable (@pxref{Formatting Variables}). These
6568 Starting point of the hidden text.
6570 Ending point of the hidden text.
6572 Number of characters in the hidden region.
6574 Number of lines of hidden text.
6577 @item gnus-cited-lines-visible
6578 @vindex gnus-cited-lines-visible
6579 The number of lines at the beginning of the cited text to leave shown.
6584 @kindex W W C-c (Summary)
6585 @findex gnus-article-hide-citation-maybe
6587 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
6588 following two variables:
6591 @item gnus-cite-hide-percentage
6592 @vindex gnus-cite-hide-percentage
6593 If the cited text is of a bigger percentage than this variable (default
6594 50), hide the cited text.
6596 @item gnus-cite-hide-absolute
6597 @vindex gnus-cite-hide-absolute
6598 The cited text must have at least this length (default 10) before it
6603 @kindex W W C (Summary)
6604 @findex gnus-article-hide-citation-in-followups
6605 Hide cited text in articles that aren't roots
6606 (@code{gnus-article-hide-citation-in-followups}). This isn't very
6607 useful as an interactive command, but might be a handy function to stick
6608 have happen automatically (@pxref{Customizing Articles}).
6612 All these ``hiding'' commands are toggles, but if you give a negative
6613 prefix to these commands, they will show what they have previously
6614 hidden. If you give a positive prefix, they will always hide.
6616 Also @pxref{Article Highlighting} for further variables for
6617 citation customization.
6619 @xref{Customizing Articles}, for how to hide article elements
6623 @node Article Washing
6624 @subsection Article Washing
6626 @cindex article washing
6628 We call this ``article washing'' for a really good reason. Namely, the
6629 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6631 @dfn{Washing} is defined by us as ``changing something from something to
6632 something else'', but normally results in something looking better.
6638 @kindex W l (Summary)
6639 @findex gnus-summary-stop-page-breaking
6640 Remove page breaks from the current article
6641 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
6645 @kindex W r (Summary)
6646 @findex gnus-summary-caesar-message
6647 @c @icon{gnus-summary-caesar-message}
6648 Do a Caesar rotate (rot13) on the article buffer
6649 (@code{gnus-summary-caesar-message}).
6650 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6651 (Typically offensive jokes and such.)
6653 It's commonly called ``rot13'' because each letter is rotated 13
6654 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6655 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
6656 is rumored to have employed this form of, uh, somewhat weak encryption.
6659 @kindex W t (Summary)
6660 @findex gnus-summary-toggle-header
6661 Toggle whether to display all headers in the article buffer
6662 (@code{gnus-summary-toggle-header}).
6665 @kindex W v (Summary)
6666 @findex gnus-summary-verbose-header
6667 Toggle whether to display all headers in the article buffer permanently
6668 (@code{gnus-summary-verbose-header}).
6671 @kindex W o (Summary)
6672 @findex gnus-article-treat-overstrike
6673 Treat overstrike (@code{gnus-article-treat-overstrike}).
6676 @kindex W d (Summary)
6677 @findex gnus-article-treat-dumbquotes
6678 @vindex gnus-article-dumbquotes-map
6680 @cindex M******** sm*rtq**t*s
6682 Treat M******** sm*rtq**t*s according to
6683 @code{gnus-article-dumbquotes-map}
6684 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
6685 whether a character is a sm*rtq**t* or not, so it should only be used
6689 @kindex W w (Summary)
6690 @findex gnus-article-fill-cited-article
6691 Do word wrap (@code{gnus-article-fill-cited-article}).
6693 You can give the command a numerical prefix to specify the width to use
6697 @kindex W q (Summary)
6698 @findex gnus-article-fill-long-lines
6699 Fill long lines (@code{gnus-article-fill-long-lines}).
6702 @kindex W C (Summary)
6703 @findex gnus-article-capitalize-sentencse
6704 Capitalize the first word in each sentence
6705 (@code{gnus-article-capitalize-sentences}).
6708 @kindex W c (Summary)
6709 @findex gnus-article-remove-cr
6710 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
6711 (this takes care of DOS line endings), and then translate any remaining
6712 CRs into LF (this takes care of Mac line endings)
6713 (@code{gnus-article-remove-cr}).
6716 @kindex W q (Summary)
6717 @findex gnus-article-de-quoted-unreadable
6718 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
6719 Quoted-Printable is one common @sc{mime} encoding employed when sending
6720 non-ASCII (i. e., 8-bit) articles. It typically makes strings like
6721 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
6722 readable to me. Note that the this is usually done automatically by
6723 Gnus if the message in question has a @code{Content-Transfer-Encoding}
6724 header that says that this encoding has been done.
6727 @kindex W f (Summary)
6729 @findex gnus-article-display-x-face
6730 @findex gnus-article-x-face-command
6731 @vindex gnus-article-x-face-command
6732 @vindex gnus-article-x-face-too-ugly
6738 Look for and display any X-Face headers
6739 (@code{gnus-article-display-x-face}). The command executed by this
6740 function is given by the @code{gnus-article-x-face-command} variable.
6741 If this variable is a string, this string will be executed in a
6742 sub-shell. If it is a function, this function will be called with the
6743 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
6744 is a regexp) matches the @code{From} header, the face will not be shown.
6745 The default action under Emacs is to fork off an @code{xv} to view the
6746 face; under XEmacs the default action is to display the face before the
6747 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
6748 support---that will make display somewhat faster. If there's no native
6749 X-Face support, Gnus will try to convert the @code{X-Face} header using
6750 external programs from the @code{pbmplus} package and friends.) If you
6751 want to have this function in the display hook, it should probably come
6755 @kindex W b (Summary)
6756 @findex gnus-article-add-buttons
6757 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6758 @xref{Article Buttons}.
6761 @kindex W B (Summary)
6762 @findex gnus-article-add-buttons-to-head
6763 Add clickable buttons to the article headers
6764 (@code{gnus-article-add-buttons-to-head}).
6767 @kindex W W H (Summary)
6768 @findex gnus-article-strip-headers-from-body
6769 Strip headers like the @code{X-No-Archive} header from the beginning of
6770 article bodies (@code{gnus-article-strip-headers-from-body}).
6773 @kindex W E l (Summary)
6774 @findex gnus-article-strip-leading-blank-lines
6775 Remove all blank lines from the beginning of the article
6776 (@code{gnus-article-strip-leading-blank-lines}).
6779 @kindex W E m (Summary)
6780 @findex gnus-article-strip-multiple-blank-lines
6781 Replace all blank lines with empty lines and then all multiple empty
6782 lines with a single empty line.
6783 (@code{gnus-article-strip-multiple-blank-lines}).
6786 @kindex W E t (Summary)
6787 @findex gnus-article-remove-trailing-blank-lines
6788 Remove all blank lines at the end of the article
6789 (@code{gnus-article-remove-trailing-blank-lines}).
6792 @kindex W E a (Summary)
6793 @findex gnus-article-strip-blank-lines
6794 Do all the three commands above
6795 (@code{gnus-article-strip-blank-lines}).
6798 @kindex W E A (Summary)
6799 @findex gnus-article-strip-all-blank-lines
6800 Remove all blank lines
6801 (@code{gnus-article-strip-all-blank-lines}).
6804 @kindex W E s (Summary)
6805 @findex gnus-article-strip-leading-space
6806 Remove all white space from the beginning of all lines of the article
6807 body (@code{gnus-article-strip-leading-space}).
6810 @kindex W E e (Summary)
6811 @findex gnus-article-strip-trailing-space
6812 Remove all white space from the end of all lines of the article
6813 body (@code{gnus-article-strip-trailing-space}).
6817 @xref{Customizing Articles}, for how to wash articles automatically.
6820 @node Article Buttons
6821 @subsection Article Buttons
6824 People often include references to other stuff in articles, and it would
6825 be nice if Gnus could just fetch whatever it is that people talk about
6826 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6827 button on these references.
6829 Gnus adds @dfn{buttons} to certain standard references by default:
6830 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
6831 two variables, one that handles article bodies and one that handles
6836 @item gnus-button-alist
6837 @vindex gnus-button-alist
6838 This is an alist where each entry has this form:
6841 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6847 All text that match this regular expression will be considered an
6848 external reference. Here's a typical regexp that matches embedded URLs:
6849 @samp{<URL:\\([^\n\r>]*\\)>}.
6852 Gnus has to know which parts of the matches is to be highlighted. This
6853 is a number that says what sub-expression of the regexp is to be
6854 highlighted. If you want it all highlighted, you use 0 here.
6857 This form will be @code{eval}ed, and if the result is non-@code{nil},
6858 this is considered a match. This is useful if you want extra sifting to
6859 avoid false matches.
6862 This function will be called when you click on this button.
6865 As with @var{button-par}, this is a sub-expression number, but this one
6866 says which part of the match is to be sent as data to @var{function}.
6870 So the full entry for buttonizing URLs is then
6873 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6876 @item gnus-header-button-alist
6877 @vindex gnus-header-button-alist
6878 This is just like the other alist, except that it is applied to the
6879 article head only, and that each entry has an additional element that is
6880 used to say what headers to apply the buttonize coding to:
6883 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6886 @var{HEADER} is a regular expression.
6888 @item gnus-button-url-regexp
6889 @vindex gnus-button-url-regexp
6890 A regular expression that matches embedded URLs. It is used in the
6891 default values of the variables above.
6893 @item gnus-article-button-face
6894 @vindex gnus-article-button-face
6895 Face used on buttons.
6897 @item gnus-article-mouse-face
6898 @vindex gnus-article-mouse-face
6899 Face used when the mouse cursor is over a button.
6903 @xref{Customizing Articles}, for how to buttonize articles automatically.
6907 @subsection Article Date
6909 The date is most likely generated in some obscure timezone you've never
6910 heard of, so it's quite nice to be able to find out what the time was
6911 when the article was sent.
6916 @kindex W T u (Summary)
6917 @findex gnus-article-date-ut
6918 Display the date in UT (aka. GMT, aka ZULU)
6919 (@code{gnus-article-date-ut}).
6922 @kindex W T i (Summary)
6923 @findex gnus-article-date-iso8601
6925 Display the date in international format, aka. ISO 8601
6926 (@code{gnus-article-date-iso8601}).
6929 @kindex W T l (Summary)
6930 @findex gnus-article-date-local
6931 Display the date in the local timezone (@code{gnus-article-date-local}).
6934 @kindex W T s (Summary)
6935 @vindex gnus-article-time-format
6936 @findex gnus-article-date-user
6937 @findex format-time-string
6938 Display the date using a user-defined format
6939 (@code{gnus-article-date-user}). The format is specified by the
6940 @code{gnus-article-time-format} variable, and is a string that's passed
6941 to @code{format-time-string}. See the documentation of that variable
6942 for a list of possible format specs.
6945 @kindex W T e (Summary)
6946 @findex gnus-article-date-lapsed
6947 @findex gnus-start-date-timer
6948 @findex gnus-stop-date-timer
6949 Say how much time has elapsed between the article was posted and now
6950 (@code{gnus-article-date-lapsed}). It looks something like:
6953 X-Sent: 9 years, 6 weeks, 4 days, 9 hours, 3 minutes, 28 seconds ago
6956 The value of @code{gnus-article-date-lapsed-new-header} determines
6957 whether this header will just be added below the old Date one, or will
6960 An advantage of using Gnus to read mail is that it converts simple bugs
6961 into wonderful absurdities.
6963 If you want to have this line updated continually, you can put
6966 (gnus-start-date-timer)
6969 in your @file{.gnus.el} file, or you can run it off of some hook. If
6970 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
6974 @kindex W T o (Summary)
6975 @findex gnus-article-date-original
6976 Display the original date (@code{gnus-article-date-original}). This can
6977 be useful if you normally use some other conversion function and are
6978 worried that it might be doing something totally wrong. Say, claiming
6979 that the article was posted in 1854. Although something like that is
6980 @emph{totally} impossible. Don't you trust me? *titter*
6984 @xref{Customizing Articles}, for how to display the date in your
6985 preferred format automatically.
6988 @node Article Signature
6989 @subsection Article Signature
6991 @cindex article signature
6993 @vindex gnus-signature-separator
6994 Each article is divided into two parts---the head and the body. The
6995 body can be divided into a signature part and a text part. The variable
6996 that says what is to be considered a signature is
6997 @code{gnus-signature-separator}. This is normally the standard
6998 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
6999 non-standard signature separators, so this variable can also be a list
7000 of regular expressions to be tested, one by one. (Searches are done
7001 from the end of the body towards the beginning.) One likely value is:
7004 (setq gnus-signature-separator
7005 '("^-- $" ; The standard
7006 "^-- *$" ; A common mangling
7007 "^-------*$" ; Many people just use a looong
7008 ; line of dashes. Shame!
7009 "^ *--------*$" ; Double-shame!
7010 "^________*$" ; Underscores are also popular
7011 "^========*$")) ; Pervert!
7014 The more permissive you are, the more likely it is that you'll get false
7017 @vindex gnus-signature-limit
7018 @code{gnus-signature-limit} provides a limit to what is considered a
7023 If it is an integer, no signature may be longer (in characters) than
7026 If it is a floating point number, no signature may be longer (in lines)
7029 If it is a function, the function will be called without any parameters,
7030 and if it returns @code{nil}, there is no signature in the buffer.
7032 If it is a string, it will be used as a regexp. If it matches, the text
7033 in question is not a signature.
7036 This variable can also be a list where the elements may be of the types
7037 listed above. Here's an example:
7040 (setq gnus-signature-limit
7041 '(200.0 "^---*Forwarded article"))
7044 This means that if there are more than 200 lines after the signature
7045 separator, or the text after the signature separator is matched by
7046 the regular expression @samp{^---*Forwarded article}, then it isn't a
7047 signature after all.
7050 @node Article Miscellania
7051 @subsection Article Miscellania
7055 @kindex A t (Summary)
7056 @findex gnus-article-babel
7057 Translate the article from one language to another
7058 (@code{gnus-article-babel}).
7064 @section @sc{mime} Commands
7065 @cindex MIME decoding
7069 @kindex X m (Summary)
7070 @findex gnus-summary-save-parts
7071 Save all parts matching a @sc{mime} type to a directory
7072 (@code{gnus-summary-save-parts}). Understands the process/prefix
7073 convention (@pxref{Process/Prefix}).
7076 @kindex M-t (Summary)
7077 @findex gnus-summary-display-buttonized
7078 Toggle the buttonized display of the article buffer
7079 (@code{gnus-summary-toggle-display-buttonized}).
7082 @kindex W M w (Summary)
7083 Decode RFC2047-encoded words in the article headers
7084 (@code{gnus-article-decode-mime-words}).
7087 @kindex W M c (Summary)
7088 Decode encoded article bodies as well as charsets
7089 (@code{gnus-article-decode-charset}).
7091 This command looks in the @code{Content-Type} header to determine the
7092 charset. If there is no such header in the article, you can give it a
7093 prefix, which will prompt for the charset to decode as. In regional
7094 groups where people post using some common encoding (but do not include
7095 MIME headers), you can set the @code{charset} group/topic parameter to
7096 the required charset (@pxref{Group Parameters}).
7099 @kindex W M v (Summary)
7100 View all the @sc{mime} parts in the current article
7101 (@code{gnus-mime-view-all-parts}).
7108 @item gnus-ignored-mime-types
7109 @vindex gnus-ignored-mime-types
7110 This is a list of regexps. @sc{mime} types that match a regexp from
7111 this list will be completely ignored by Gnus. The default value is
7114 To have all Vcards be ignored, you'd say something like this:
7117 (setq gnus-ignored-mime-types
7121 @item gnus-unbuttonized-mime-types
7122 @vindex gnus-unbuttonized-mime-types
7123 This is a list of regexps. @sc{mime} types that match a regexp from
7124 this list won't have @sc{mime} buttons inserted unless they aren't
7125 displayed. The default value is @code{(".*/.*")}.
7127 @item gnus-article-mime-part-function
7128 @vindex gnus-article-mime-part-function
7129 For each @sc{mime} part, this function will be called with the @sc{mime}
7130 handle as the parameter. The function is meant to be used to allow
7131 users to gather information from the article (e. g., add Vcard info to
7132 the bbdb database) or to do actions based on parts (e. g., automatically
7133 save all jpegs into some directory).
7135 Here's an example function the does the latter:
7138 (defun my-save-all-jpeg-parts (handle)
7139 (when (equal (car (mm-handle-type handle)) "image/jpeg")
7141 (insert (mm-get-part handle))
7142 (write-region (point-min) (point-max)
7143 (read-file-name "Save jpeg to: ")))))
7144 (setq gnus-article-mime-part-function
7145 'my-save-all-jpeg-parts)
7148 @vindex gnus-mime-multipart-functions
7149 @item gnus-mime-multipart-functions
7150 Alist of @sc{mime} multipart types and functions to handle them.
7159 People use different charsets, and we have @sc{mime} to let us know what
7160 charsets they use. Or rather, we wish we had. Many people use
7161 newsreaders and mailers that do not understand or use @sc{mime}, and
7162 just send out messages without saying what character sets they use. To
7163 help a bit with this, some local news hierarchies have policies that say
7164 what character set is the default. For instance, the @samp{fj}
7165 hierarchy uses @code{iso-2022-jp-2}.
7167 @vindex gnus-group-charset-alist
7168 This knowledge is encoded in the @code{gnus-group-charset-alist}
7169 variable, which is an alist of regexps (to match group names) and
7170 default charsets to be used when reading these groups.
7172 In addition, some people do use soi-disant @sc{mime}-aware agents that
7173 aren't. These blitely mark messages as being in @code{iso-8859-1} even
7174 if they really are in @code{koi-8}. To help here, the
7175 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
7176 charsets that are listed here will be ignored. The variable can be set
7177 on a group-by-group basis using the group parameters (@pxref{Group
7178 Parameters}). The default value is @code{(unknown-8bit)}, which is
7179 something some agents insist on having in there.
7182 @node Article Commands
7183 @section Article Commands
7190 @kindex A P (Summary)
7191 @vindex gnus-ps-print-hook
7192 @findex gnus-summary-print-article
7193 Generate and print a PostScript image of the article buffer
7194 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
7195 run just before printing the buffer.
7200 @node Summary Sorting
7201 @section Summary Sorting
7202 @cindex summary sorting
7204 You can have the summary buffer sorted in various ways, even though I
7205 can't really see why you'd want that.
7210 @kindex C-c C-s C-n (Summary)
7211 @findex gnus-summary-sort-by-number
7212 Sort by article number (@code{gnus-summary-sort-by-number}).
7215 @kindex C-c C-s C-a (Summary)
7216 @findex gnus-summary-sort-by-author
7217 Sort by author (@code{gnus-summary-sort-by-author}).
7220 @kindex C-c C-s C-s (Summary)
7221 @findex gnus-summary-sort-by-subject
7222 Sort by subject (@code{gnus-summary-sort-by-subject}).
7225 @kindex C-c C-s C-d (Summary)
7226 @findex gnus-summary-sort-by-date
7227 Sort by date (@code{gnus-summary-sort-by-date}).
7230 @kindex C-c C-s C-l (Summary)
7231 @findex gnus-summary-sort-by-lines
7232 Sort by lines (@code{gnus-summary-sort-by-lines}).
7235 @kindex C-c C-s C-c (Summary)
7236 @findex gnus-summary-sort-by-chars
7237 Sort by article length (@code{gnus-summary-sort-by-chars}).
7240 @kindex C-c C-s C-i (Summary)
7241 @findex gnus-summary-sort-by-score
7242 Sort by score (@code{gnus-summary-sort-by-score}).
7245 These functions will work both when you use threading and when you don't
7246 use threading. In the latter case, all summary lines will be sorted,
7247 line by line. In the former case, sorting will be done on a
7248 root-by-root basis, which might not be what you were looking for. To
7249 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
7253 @node Finding the Parent
7254 @section Finding the Parent
7255 @cindex parent articles
7256 @cindex referring articles
7261 @findex gnus-summary-refer-parent-article
7262 If you'd like to read the parent of the current article, and it is not
7263 displayed in the summary buffer, you might still be able to. That is,
7264 if the current group is fetched by @sc{nntp}, the parent hasn't expired
7265 and the @code{References} in the current article are not mangled, you
7266 can just press @kbd{^} or @kbd{A r}
7267 (@code{gnus-summary-refer-parent-article}). If everything goes well,
7268 you'll get the parent. If the parent is already displayed in the
7269 summary buffer, point will just move to this article.
7271 If given a positive numerical prefix, fetch that many articles back into
7272 the ancestry. If given a negative numerical prefix, fetch just that
7273 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
7274 grandparent and the grandgrandparent of the current article. If you say
7275 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
7279 @findex gnus-summary-refer-references
7280 @kindex A R (Summary)
7281 Fetch all articles mentioned in the @code{References} header of the
7282 article (@code{gnus-summary-refer-references}).
7285 @findex gnus-summary-refer-thread
7286 @kindex A T (Summary)
7287 Display the full thread where the current article appears
7288 (@code{gnus-summary-refer-thread}). This command has to fetch all the
7289 headers in the current group to work, so it usually takes a while. If
7290 you do it often, you may consider setting @code{gnus-fetch-old-headers}
7291 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
7292 visible effects normally, but it'll make this command work a whole lot
7293 faster. Of course, it'll make group entry somewhat slow.
7295 @vindex gnus-refer-thread-limit
7296 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
7297 articles before the first displayed in the current group) headers to
7298 fetch when doing this command. The default is 200. If @code{t}, all
7299 the available headers will be fetched. This variable can be overridden
7300 by giving the @kbd{A T} command a numerical prefix.
7303 @findex gnus-summary-refer-article
7304 @kindex M-^ (Summary)
7306 @cindex fetching by Message-ID
7307 You can also ask the @sc{nntp} server for an arbitrary article, no
7308 matter what group it belongs to. @kbd{M-^}
7309 (@code{gnus-summary-refer-article}) will ask you for a
7310 @code{Message-ID}, which is one of those long, hard-to-read thingies
7311 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
7312 have to get it all exactly right. No fuzzy searches, I'm afraid.
7315 The current select method will be used when fetching by
7316 @code{Message-ID} from non-news select method, but you can override this
7317 by giving this command a prefix.
7319 @vindex gnus-refer-article-method
7320 If the group you are reading is located on a backend that does not
7321 support fetching by @code{Message-ID} very well (like @code{nnspool}),
7322 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
7323 would, perhaps, be best if the @sc{nntp} server you consult is the one
7324 updating the spool you are reading from, but that's not really
7327 Most of the mail backends support fetching by @code{Message-ID}, but do
7328 not do a particularly excellent job at it. That is, @code{nnmbox} and
7329 @code{nnbabyl} are able to locate articles from any groups, while
7330 @code{nnml} and @code{nnfolder} are only able to locate articles that
7331 have been posted to the current group. (Anything else would be too time
7332 consuming.) @code{nnmh} does not support this at all.
7335 @node Alternative Approaches
7336 @section Alternative Approaches
7338 Different people like to read news using different methods. This being
7339 Gnus, we offer a small selection of minor modes for the summary buffers.
7342 * Pick and Read:: First mark articles and then read them.
7343 * Binary Groups:: Auto-decode all articles.
7348 @subsection Pick and Read
7349 @cindex pick and read
7351 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
7352 a two-phased reading interface. The user first marks in a summary
7353 buffer the articles she wants to read. Then she starts reading the
7354 articles with just an article buffer displayed.
7356 @findex gnus-pick-mode
7357 @kindex M-x gnus-pick-mode
7358 Gnus provides a summary buffer minor mode that allows
7359 this---@code{gnus-pick-mode}. This basically means that a few process
7360 mark commands become one-keystroke commands to allow easy marking, and
7361 it provides one additional command for switching to the summary buffer.
7363 Here are the available keystrokes when using pick mode:
7368 @findex gnus-pick-article-or-thread
7369 Pick the article or thread on the current line
7370 (@code{gnus-pick-article-or-thread}). If the variable
7371 @code{gnus-thread-hide-subtree} is true, then this key selects the
7372 entire thread when used at the first article of the thread. Otherwise,
7373 it selects just the article. If given a numerical prefix, go to that
7374 thread or article and pick it. (The line number is normally displayed
7375 at the beginning of the summary pick lines.)
7378 @kindex SPACE (Pick)
7379 @findex gnus-pick-next-page
7380 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
7381 at the end of the buffer, start reading the picked articles.
7385 @findex gnus-pick-unmark-article-or-thread.
7386 Unpick the thread or article
7387 (@code{gnus-pick-unmark-article-or-thread}). If the variable
7388 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
7389 thread if used at the first article of the thread. Otherwise it unpicks
7390 just the article. You can give this key a numerical prefix to unpick
7391 the thread or article at that line.
7395 @findex gnus-pick-start-reading
7396 @vindex gnus-pick-display-summary
7397 Start reading the picked articles (@code{gnus-pick-start-reading}). If
7398 given a prefix, mark all unpicked articles as read first. If
7399 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
7400 will still be visible when you are reading.
7404 All the normal summary mode commands are still available in the
7405 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
7406 which is mapped to the same function
7407 @code{gnus-summary-tick-article-forward}.
7409 If this sounds like a good idea to you, you could say:
7412 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
7415 @vindex gnus-pick-mode-hook
7416 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
7418 @vindex gnus-mark-unpicked-articles-as-read
7419 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
7420 all unpicked articles as read. The default is @code{nil}.
7422 @vindex gnus-summary-pick-line-format
7423 The summary line format in pick mode is slightly different from the
7424 standard format. At the beginning of each line the line number is
7425 displayed. The pick mode line format is controlled by the
7426 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
7427 Variables}). It accepts the same format specs that
7428 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
7432 @subsection Binary Groups
7433 @cindex binary groups
7435 @findex gnus-binary-mode
7436 @kindex M-x gnus-binary-mode
7437 If you spend much time in binary groups, you may grow tired of hitting
7438 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
7439 is a minor mode for summary buffers that makes all ordinary Gnus article
7440 selection functions uudecode series of articles and display the result
7441 instead of just displaying the articles the normal way.
7444 @findex gnus-binary-show-article
7445 The only way, in fact, to see the actual articles is the @kbd{g}
7446 command, when you have turned on this mode
7447 (@code{gnus-binary-show-article}).
7449 @vindex gnus-binary-mode-hook
7450 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
7454 @section Tree Display
7457 @vindex gnus-use-trees
7458 If you don't like the normal Gnus summary display, you might try setting
7459 @code{gnus-use-trees} to @code{t}. This will create (by default) an
7460 additional @dfn{tree buffer}. You can execute all summary mode commands
7463 There are a few variables to customize the tree display, of course:
7466 @item gnus-tree-mode-hook
7467 @vindex gnus-tree-mode-hook
7468 A hook called in all tree mode buffers.
7470 @item gnus-tree-mode-line-format
7471 @vindex gnus-tree-mode-line-format
7472 A format string for the mode bar in the tree mode buffers (@pxref{Mode
7473 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
7474 of valid specs, @pxref{Summary Buffer Mode Line}.
7476 @item gnus-selected-tree-face
7477 @vindex gnus-selected-tree-face
7478 Face used for highlighting the selected article in the tree buffer. The
7479 default is @code{modeline}.
7481 @item gnus-tree-line-format
7482 @vindex gnus-tree-line-format
7483 A format string for the tree nodes. The name is a bit of a misnomer,
7484 though---it doesn't define a line, but just the node. The default value
7485 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
7486 the name of the poster. It is vital that all nodes are of the same
7487 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
7493 The name of the poster.
7495 The @code{From} header.
7497 The number of the article.
7499 The opening bracket.
7501 The closing bracket.
7506 @xref{Formatting Variables}.
7508 Variables related to the display are:
7511 @item gnus-tree-brackets
7512 @vindex gnus-tree-brackets
7513 This is used for differentiating between ``real'' articles and
7514 ``sparse'' articles. The format is @var{((real-open . real-close)
7515 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
7516 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7518 @item gnus-tree-parent-child-edges
7519 @vindex gnus-tree-parent-child-edges
7520 This is a list that contains the characters used for connecting parent
7521 nodes to their children. The default is @code{(?- ?\\ ?|)}.
7525 @item gnus-tree-minimize-window
7526 @vindex gnus-tree-minimize-window
7527 If this variable is non-@code{nil}, Gnus will try to keep the tree
7528 buffer as small as possible to allow more room for the other Gnus
7529 windows. If this variable is a number, the tree buffer will never be
7530 higher than that number. The default is @code{t}. Note that if you
7531 have several windows displayed side-by-side in a frame and the tree
7532 buffer is one of these, minimizing the tree window will also resize all
7533 other windows displayed next to it.
7535 @item gnus-generate-tree-function
7536 @vindex gnus-generate-tree-function
7537 @findex gnus-generate-horizontal-tree
7538 @findex gnus-generate-vertical-tree
7539 The function that actually generates the thread tree. Two predefined
7540 functions are available: @code{gnus-generate-horizontal-tree} and
7541 @code{gnus-generate-vertical-tree} (which is the default).
7545 Here's an example from a horizontal tree buffer:
7548 @{***@}-(***)-[odd]-[Gun]
7558 Here's the same thread displayed in a vertical tree buffer:
7562 |--------------------------\-----\-----\
7563 (***) [Bjo] [Gun] [Gun]
7565 [odd] [Jan] [odd] (***) [Jor]
7567 [Gun] [Eri] [Eri] [odd]
7572 If you're using horizontal trees, it might be nice to display the trees
7573 side-by-side with the summary buffer. You could add something like the
7574 following to your @file{.gnus.el} file:
7577 (setq gnus-use-trees t
7578 gnus-generate-tree-function 'gnus-generate-horizontal-tree
7579 gnus-tree-minimize-window nil)
7580 (gnus-add-configuration
7584 (summary 0.75 point)
7589 @xref{Windows Configuration}.
7592 @node Mail Group Commands
7593 @section Mail Group Commands
7594 @cindex mail group commands
7596 Some commands only make sense in mail groups. If these commands are
7597 invalid in the current group, they will raise a hell and let you know.
7599 All these commands (except the expiry and edit commands) use the
7600 process/prefix convention (@pxref{Process/Prefix}).
7605 @kindex B e (Summary)
7606 @findex gnus-summary-expire-articles
7607 Expire all expirable articles in the group
7608 (@code{gnus-summary-expire-articles}).
7611 @kindex B M-C-e (Summary)
7612 @findex gnus-summary-expire-articles-now
7613 Delete all the expirable articles in the group
7614 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
7615 articles eligible for expiry in the current group will
7616 disappear forever into that big @file{/dev/null} in the sky.
7619 @kindex B DEL (Summary)
7620 @findex gnus-summary-delete-article
7621 @c @icon{gnus-summary-mail-delete}
7622 Delete the mail article. This is ``delete'' as in ``delete it from your
7623 disk forever and ever, never to return again.'' Use with caution.
7624 (@code{gnus-summary-delete-article}).
7627 @kindex B m (Summary)
7629 @findex gnus-summary-move-article
7630 Move the article from one mail group to another
7631 (@code{gnus-summary-move-article}).
7634 @kindex B c (Summary)
7636 @findex gnus-summary-copy-article
7637 @c @icon{gnus-summary-mail-copy}
7638 Copy the article from one group (mail group or not) to a mail group
7639 (@code{gnus-summary-copy-article}).
7642 @kindex B B (Summary)
7643 @cindex crosspost mail
7644 @findex gnus-summary-crosspost-article
7645 Crosspost the current article to some other group
7646 (@code{gnus-summary-crosspost-article}). This will create a new copy of
7647 the article in the other group, and the Xref headers of the article will
7648 be properly updated.
7651 @kindex B i (Summary)
7652 @findex gnus-summary-import-article
7653 Import an arbitrary file into the current mail newsgroup
7654 (@code{gnus-summary-import-article}). You will be prompted for a file
7655 name, a @code{From} header and a @code{Subject} header.
7658 @kindex B r (Summary)
7659 @findex gnus-summary-respool-article
7660 Respool the mail article (@code{gnus-summary-respool-article}).
7661 @code{gnus-summary-respool-default-method} will be used as the default
7662 select method when respooling. This variable is @code{nil} by default,
7663 which means that the current group select method will be used instead.
7667 @kindex B w (Summary)
7669 @findex gnus-summary-edit-article
7670 @kindex C-c C-c (Article)
7671 Edit the current article (@code{gnus-summary-edit-article}). To finish
7672 editing and make the changes permanent, type @kbd{C-c C-c}
7673 (@kbd{gnus-summary-edit-article-done}). If you give a prefix to the
7674 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
7677 @kindex B q (Summary)
7678 @findex gnus-summary-respool-query
7679 If you want to re-spool an article, you might be curious as to what group
7680 the article will end up in before you do the re-spooling. This command
7681 will tell you (@code{gnus-summary-respool-query}).
7684 @kindex B t (Summary)
7685 @findex gnus-summary-respool-trace
7686 Similarly, this command will display all fancy splitting patterns used
7687 when repooling, if any (@code{gnus-summary-respool-trace}).
7690 @kindex B p (Summary)
7691 @findex gnus-summary-article-posted-p
7692 Some people have a tendency to send you "courtesy" copies when they
7693 follow up to articles you have posted. These usually have a
7694 @code{Newsgroups} header in them, but not always. This command
7695 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7696 article from your news server (or rather, from
7697 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7698 report back whether it found the article or not. Even if it says that
7699 it didn't find the article, it may have been posted anyway---mail
7700 propagation is much faster than news propagation, and the news copy may
7701 just not have arrived yet.
7705 @vindex gnus-move-split-methods
7706 @cindex moving articles
7707 If you move (or copy) articles regularly, you might wish to have Gnus
7708 suggest where to put the articles. @code{gnus-move-split-methods} is a
7709 variable that uses the same syntax as @code{gnus-split-methods}
7710 (@pxref{Saving Articles}). You may customize that variable to create
7711 suggestions you find reasonable.
7714 (setq gnus-move-split-methods
7715 '(("^From:.*Lars Magne" "nnml:junk")
7716 ("^Subject:.*gnus" "nnfolder:important")
7717 (".*" "nnml:misc")))
7721 @node Various Summary Stuff
7722 @section Various Summary Stuff
7725 * Summary Group Information:: Information oriented commands.
7726 * Searching for Articles:: Multiple article commands.
7727 * Summary Generation Commands:: (Re)generating the summary buffer.
7728 * Really Various Summary Commands:: Those pesky non-conformant commands.
7732 @vindex gnus-summary-mode-hook
7733 @item gnus-summary-mode-hook
7734 This hook is called when creating a summary mode buffer.
7736 @vindex gnus-summary-generate-hook
7737 @item gnus-summary-generate-hook
7738 This is called as the last thing before doing the threading and the
7739 generation of the summary buffer. It's quite convenient for customizing
7740 the threading variables based on what data the newsgroup has. This hook
7741 is called from the summary buffer after most summary buffer variables
7744 @vindex gnus-summary-prepare-hook
7745 @item gnus-summary-prepare-hook
7746 It is called after the summary buffer has been generated. You might use
7747 it to, for instance, highlight lines or modify the look of the buffer in
7748 some other ungodly manner. I don't care.
7750 @vindex gnus-summary-prepared-hook
7751 @item gnus-summary-prepared-hook
7752 A hook called as the very last thing after the summary buffer has been
7755 @vindex gnus-summary-ignore-duplicates
7756 @item gnus-summary-ignore-duplicates
7757 When Gnus discovers two articles that have the same @code{Message-ID},
7758 it has to do something drastic. No articles are allowed to have the
7759 same @code{Message-ID}, but this may happen when reading mail from some
7760 sources. Gnus allows you to customize what happens with this variable.
7761 If it is @code{nil} (which is the default), Gnus will rename the
7762 @code{Message-ID} (for display purposes only) and display the article as
7763 any other article. If this variable is @code{t}, it won't display the
7764 article---it'll be as if it never existed.
7769 @node Summary Group Information
7770 @subsection Summary Group Information
7775 @kindex H f (Summary)
7776 @findex gnus-summary-fetch-faq
7777 @vindex gnus-group-faq-directory
7778 Try to fetch the FAQ (list of frequently asked questions) for the
7779 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
7780 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7781 on a remote machine. This variable can also be a list of directories.
7782 In that case, giving a prefix to this command will allow you to choose
7783 between the various sites. @code{ange-ftp} or @code{efs} will probably
7784 be used for fetching the file.
7787 @kindex H d (Summary)
7788 @findex gnus-summary-describe-group
7789 Give a brief description of the current group
7790 (@code{gnus-summary-describe-group}). If given a prefix, force
7791 rereading the description from the server.
7794 @kindex H h (Summary)
7795 @findex gnus-summary-describe-briefly
7796 Give an extremely brief description of the most important summary
7797 keystrokes (@code{gnus-summary-describe-briefly}).
7800 @kindex H i (Summary)
7801 @findex gnus-info-find-node
7802 Go to the Gnus info node (@code{gnus-info-find-node}).
7806 @node Searching for Articles
7807 @subsection Searching for Articles
7812 @kindex M-s (Summary)
7813 @findex gnus-summary-search-article-forward
7814 Search through all subsequent articles for a regexp
7815 (@code{gnus-summary-search-article-forward}).
7818 @kindex M-r (Summary)
7819 @findex gnus-summary-search-article-backward
7820 Search through all previous articles for a regexp
7821 (@code{gnus-summary-search-article-backward}).
7825 @findex gnus-summary-execute-command
7826 This command will prompt you for a header field, a regular expression to
7827 match on this field, and a command to be executed if the match is made
7828 (@code{gnus-summary-execute-command}). If given a prefix, search
7832 @kindex M-& (Summary)
7833 @findex gnus-summary-universal-argument
7834 Perform any operation on all articles that have been marked with
7835 the process mark (@code{gnus-summary-universal-argument}).
7838 @node Summary Generation Commands
7839 @subsection Summary Generation Commands
7844 @kindex Y g (Summary)
7845 @findex gnus-summary-prepare
7846 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7849 @kindex Y c (Summary)
7850 @findex gnus-summary-insert-cached-articles
7851 Pull all cached articles (for the current group) into the summary buffer
7852 (@code{gnus-summary-insert-cached-articles}).
7857 @node Really Various Summary Commands
7858 @subsection Really Various Summary Commands
7864 @kindex C-d (Summary)
7865 @kindex A D (Summary)
7866 @findex gnus-summary-enter-digest-group
7867 If the current article is a collection of other articles (for instance,
7868 a digest), you might use this command to enter a group based on the that
7869 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
7870 guess what article type is currently displayed unless you give a prefix
7871 to this command, which forces a ``digest'' interpretation. Basically,
7872 whenever you see a message that is a collection of other messages of
7873 some format, you @kbd{C-d} and read these messages in a more convenient
7877 @kindex M-C-d (Summary)
7878 @findex gnus-summary-read-document
7879 This command is very similar to the one above, but lets you gather
7880 several documents into one biiig group
7881 (@code{gnus-summary-read-document}). It does this by opening several
7882 @code{nndoc} groups for each document, and then opening an
7883 @code{nnvirtual} group on top of these @code{nndoc} groups. This
7884 command understands the process/prefix convention
7885 (@pxref{Process/Prefix}).
7888 @kindex C-t (Summary)
7889 @findex gnus-summary-toggle-truncation
7890 Toggle truncation of summary lines
7891 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
7892 line centering function in the summary buffer, so it's not a good idea
7893 to have truncation switched off while reading articles.
7897 @findex gnus-summary-expand-window
7898 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7899 If given a prefix, force an @code{article} window configuration.
7902 @kindex M-C-e (Summary)
7903 @findex gnus-summary-edit-parameters
7904 Edit the group parameters (@pxref{Group Parameters}) of the current
7905 group (@code{gnus-summary-edit-parameters}).
7908 @kindex M-C-g (Summary)
7909 @findex gnus-summary-customize-parameters
7910 Customize the group parameters (@pxref{Group Parameters}) of the current
7911 group (@code{gnus-summary-customize-parameters}).
7916 @node Exiting the Summary Buffer
7917 @section Exiting the Summary Buffer
7918 @cindex summary exit
7919 @cindex exiting groups
7921 Exiting from the summary buffer will normally update all info on the
7922 group and return you to the group buffer.
7928 @kindex Z Z (Summary)
7930 @findex gnus-summary-exit
7931 @vindex gnus-summary-exit-hook
7932 @vindex gnus-summary-prepare-exit-hook
7933 @c @icon{gnus-summary-exit}
7934 Exit the current group and update all information on the group
7935 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7936 called before doing much of the exiting, which calls
7937 @code{gnus-summary-expire-articles} by default.
7938 @code{gnus-summary-exit-hook} is called after finishing the exit
7939 process. @code{gnus-group-no-more-groups-hook} is run when returning to
7940 group mode having no more (unread) groups.
7944 @kindex Z E (Summary)
7946 @findex gnus-summary-exit-no-update
7947 Exit the current group without updating any information on the group
7948 (@code{gnus-summary-exit-no-update}).
7952 @kindex Z c (Summary)
7954 @findex gnus-summary-catchup-and-exit
7955 @c @icon{gnus-summary-catchup-and-exit}
7956 Mark all unticked articles in the group as read and then exit
7957 (@code{gnus-summary-catchup-and-exit}).
7960 @kindex Z C (Summary)
7961 @findex gnus-summary-catchup-all-and-exit
7962 Mark all articles, even the ticked ones, as read and then exit
7963 (@code{gnus-summary-catchup-all-and-exit}).
7966 @kindex Z n (Summary)
7967 @findex gnus-summary-catchup-and-goto-next-group
7968 Mark all articles as read and go to the next group
7969 (@code{gnus-summary-catchup-and-goto-next-group}).
7972 @kindex Z R (Summary)
7973 @findex gnus-summary-reselect-current-group
7974 Exit this group, and then enter it again
7975 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
7976 all articles, both read and unread.
7980 @kindex Z G (Summary)
7981 @kindex M-g (Summary)
7982 @findex gnus-summary-rescan-group
7983 @c @icon{gnus-summary-mail-get}
7984 Exit the group, check for new articles in the group, and select the
7985 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
7986 articles, both read and unread.
7989 @kindex Z N (Summary)
7990 @findex gnus-summary-next-group
7991 Exit the group and go to the next group
7992 (@code{gnus-summary-next-group}).
7995 @kindex Z P (Summary)
7996 @findex gnus-summary-prev-group
7997 Exit the group and go to the previous group
7998 (@code{gnus-summary-prev-group}).
8001 @kindex Z s (Summary)
8002 @findex gnus-summary-save-newsrc
8003 Save the current number of read/marked articles in the dribble buffer
8004 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
8005 given a prefix, also save the @file{.newsrc} file(s). Using this
8006 command will make exit without updating (the @kbd{Q} command) worthless.
8009 @vindex gnus-exit-group-hook
8010 @code{gnus-exit-group-hook} is called when you exit the current
8013 @findex gnus-summary-wake-up-the-dead
8014 @findex gnus-dead-summary-mode
8015 @vindex gnus-kill-summary-on-exit
8016 If you're in the habit of exiting groups, and then changing your mind
8017 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
8018 If you do that, Gnus won't kill the summary buffer when you exit it.
8019 (Quelle surprise!) Instead it will change the name of the buffer to
8020 something like @samp{*Dead Summary ... *} and install a minor mode
8021 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
8022 buffer, you'll find that all keys are mapped to a function called
8023 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
8024 summary buffer will result in a live, normal summary buffer.
8026 There will never be more than one dead summary buffer at any one time.
8028 @vindex gnus-use-cross-reference
8029 The data on the current group will be updated (which articles you have
8030 read, which articles you have replied to, etc.) when you exit the
8031 summary buffer. If the @code{gnus-use-cross-reference} variable is
8032 @code{t} (which is the default), articles that are cross-referenced to
8033 this group and are marked as read, will also be marked as read in the
8034 other subscribed groups they were cross-posted to. If this variable is
8035 neither @code{nil} nor @code{t}, the article will be marked as read in
8036 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
8039 @node Crosspost Handling
8040 @section Crosspost Handling
8044 Marking cross-posted articles as read ensures that you'll never have to
8045 read the same article more than once. Unless, of course, somebody has
8046 posted it to several groups separately. Posting the same article to
8047 several groups (not cross-posting) is called @dfn{spamming}, and you are
8048 by law required to send nasty-grams to anyone who perpetrates such a
8049 heinous crime. You may want to try NoCeM handling to filter out spam
8052 Remember: Cross-posting is kinda ok, but posting the same article
8053 separately to several groups is not. Massive cross-posting (aka.
8054 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
8055 @code{gnus-summary-mail-crosspost-complaint} command to complain about
8056 excessive crossposting (@pxref{Summary Mail Commands}).
8058 @cindex cross-posting
8061 One thing that may cause Gnus to not do the cross-posting thing
8062 correctly is if you use an @sc{nntp} server that supports @sc{xover}
8063 (which is very nice, because it speeds things up considerably) which
8064 does not include the @code{Xref} header in its @sc{nov} lines. This is
8065 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
8066 even with @sc{xover} by registering the @code{Xref} lines of all
8067 articles you actually read, but if you kill the articles, or just mark
8068 them as read without reading them, Gnus will not get a chance to snoop
8069 the @code{Xref} lines out of these articles, and will be unable to use
8070 the cross reference mechanism.
8072 @cindex LIST overview.fmt
8073 @cindex overview.fmt
8074 To check whether your @sc{nntp} server includes the @code{Xref} header
8075 in its overview files, try @samp{telnet your.nntp.server nntp},
8076 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
8077 overview.fmt}. This may not work, but if it does, and the last line you
8078 get does not read @samp{Xref:full}, then you should shout and whine at
8079 your news admin until she includes the @code{Xref} header in the
8082 @vindex gnus-nov-is-evil
8083 If you want Gnus to get the @code{Xref}s right all the time, you have to
8084 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
8089 For an alternative approach, @pxref{Duplicate Suppression}.
8092 @node Duplicate Suppression
8093 @section Duplicate Suppression
8095 By default, Gnus tries to make sure that you don't have to read the same
8096 article more than once by utilizing the crossposting mechanism
8097 (@pxref{Crosspost Handling}). However, that simple and efficient
8098 approach may not work satisfactory for some users for various
8103 The @sc{nntp} server may fail to generate the @code{Xref} header. This
8104 is evil and not very common.
8107 The @sc{nntp} server may fail to include the @code{Xref} header in the
8108 @file{.overview} data bases. This is evil and all too common, alas.
8111 You may be reading the same group (or several related groups) from
8112 different @sc{nntp} servers.
8115 You may be getting mail that duplicates articles posted to groups.
8118 I'm sure there are other situations where @code{Xref} handling fails as
8119 well, but these four are the most common situations.
8121 If, and only if, @code{Xref} handling fails for you, then you may
8122 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
8123 will remember the @code{Message-ID}s of all articles you have read or
8124 otherwise marked as read, and then, as if by magic, mark them as read
8125 all subsequent times you see them---in @emph{all} groups. Using this
8126 mechanism is quite likely to be somewhat inefficient, but not overly
8127 so. It's certainly preferable to reading the same articles more than
8130 Duplicate suppression is not a very subtle instrument. It's more like a
8131 sledge hammer than anything else. It works in a very simple
8132 fashion---if you have marked an article as read, it adds this Message-ID
8133 to a cache. The next time it sees this Message-ID, it will mark the
8134 article as read with the @samp{M} mark. It doesn't care what group it
8138 @item gnus-suppress-duplicates
8139 @vindex gnus-suppress-duplicates
8140 If non-@code{nil}, suppress duplicates.
8142 @item gnus-save-duplicate-list
8143 @vindex gnus-save-duplicate-list
8144 If non-@code{nil}, save the list of duplicates to a file. This will
8145 make startup and shutdown take longer, so the default is @code{nil}.
8146 However, this means that only duplicate articles read in a single Gnus
8147 session are suppressed.
8149 @item gnus-duplicate-list-length
8150 @vindex gnus-duplicate-list-length
8151 This variable says how many @code{Message-ID}s to keep in the duplicate
8152 suppression list. The default is 10000.
8154 @item gnus-duplicate-file
8155 @vindex gnus-duplicate-file
8156 The name of the file to store the duplicate suppression list in. The
8157 default is @file{~/News/suppression}.
8160 If you have a tendency to stop and start Gnus often, setting
8161 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
8162 you leave Gnus running for weeks on end, you may have it @code{nil}. On
8163 the other hand, saving the list makes startup and shutdown much slower,
8164 so that means that if you stop and start Gnus often, you should set
8165 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
8166 to you to figure out, I think.
8169 @node The Article Buffer
8170 @chapter The Article Buffer
8171 @cindex article buffer
8173 The articles are displayed in the article buffer, of which there is only
8174 one. All the summary buffers share the same article buffer unless you
8175 tell Gnus otherwise.
8178 * Hiding Headers:: Deciding what headers should be displayed.
8179 * Using MIME:: Pushing articles through @sc{mime} before reading them.
8180 * Customizing Articles:: Tailoring the look of the articles.
8181 * Article Keymap:: Keystrokes available in the article buffer.
8182 * Misc Article:: Other stuff.
8186 @node Hiding Headers
8187 @section Hiding Headers
8188 @cindex hiding headers
8189 @cindex deleting headers
8191 The top section of each article is the @dfn{head}. (The rest is the
8192 @dfn{body}, but you may have guessed that already.)
8194 @vindex gnus-show-all-headers
8195 There is a lot of useful information in the head: the name of the person
8196 who wrote the article, the date it was written and the subject of the
8197 article. That's well and nice, but there's also lots of information
8198 most people do not want to see---what systems the article has passed
8199 through before reaching you, the @code{Message-ID}, the
8200 @code{References}, etc. ad nauseum---and you'll probably want to get rid
8201 of some of those lines. If you want to keep all those lines in the
8202 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
8204 Gnus provides you with two variables for sifting headers:
8208 @item gnus-visible-headers
8209 @vindex gnus-visible-headers
8210 If this variable is non-@code{nil}, it should be a regular expression
8211 that says what headers you wish to keep in the article buffer. All
8212 headers that do not match this variable will be hidden.
8214 For instance, if you only want to see the name of the person who wrote
8215 the article and the subject, you'd say:
8218 (setq gnus-visible-headers "^From:\\|^Subject:")
8221 This variable can also be a list of regexps to match headers to
8224 @item gnus-ignored-headers
8225 @vindex gnus-ignored-headers
8226 This variable is the reverse of @code{gnus-visible-headers}. If this
8227 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
8228 should be a regular expression that matches all lines that you want to
8229 hide. All lines that do not match this variable will remain visible.
8231 For instance, if you just want to get rid of the @code{References} line
8232 and the @code{Xref} line, you might say:
8235 (setq gnus-ignored-headers "^References:\\|^Xref:")
8238 This variable can also be a list of regexps to match headers to
8241 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
8242 variable will have no effect.
8246 @vindex gnus-sorted-header-list
8247 Gnus can also sort the headers for you. (It does this by default.) You
8248 can control the sorting by setting the @code{gnus-sorted-header-list}
8249 variable. It is a list of regular expressions that says in what order
8250 the headers are to be displayed.
8252 For instance, if you want the name of the author of the article first,
8253 and then the subject, you might say something like:
8256 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
8259 Any headers that are to remain visible, but are not listed in this
8260 variable, will be displayed in random order after all the headers listed in this variable.
8262 @findex gnus-article-hide-boring-headers
8263 @vindex gnus-boring-article-headers
8264 You can hide further boring headers by setting
8265 @code{gnus-treat-hide-boring-header} to @code{head}. What this function
8266 does depends on the @code{gnus-boring-article-headers} variable. It's a
8267 list, but this list doesn't actually contain header names. Instead is
8268 lists various @dfn{boring conditions} that Gnus can check and remove
8271 These conditions are:
8274 Remove all empty headers.
8276 Remove the @code{Followup-To} header if it is identical to the
8277 @code{Newsgroups} header.
8279 Remove the @code{Reply-To} header if it lists the same address as the
8282 Remove the @code{Newsgroups} header if it only contains the current group
8285 Remove the @code{Date} header if the article is less than three days
8288 Remove the @code{To} header if it is very long.
8290 Remove all @code{To} headers if there are more than one.
8293 To include the four three elements, you could say something like;
8296 (setq gnus-boring-article-headers
8297 '(empty followup-to reply-to))
8300 This is also the default value for this variable.
8304 @section Using @sc{mime}
8307 Mime is a standard for waving your hands through the air, aimlessly,
8308 while people stand around yawning.
8310 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
8311 while all newsreaders die of fear.
8313 @sc{mime} may specify what character set the article uses, the encoding
8314 of the characters, and it also makes it possible to embed pictures and
8315 other naughty stuff in innocent-looking articles.
8317 @vindex gnus-display-mime-function
8318 @findex gnus-display-mime
8319 Gnus pushes @sc{mime} articles through @code{gnus-display-mime-function}
8320 to display the @sc{mime} parts. This is @code{gnus-display-mime} by
8321 default, which creates a bundle of clickable buttons that can be used to
8322 display, save and manipulate the @sc{mime} objects.
8324 The following commands are available when you have placed point over a
8328 @findex gnus-article-press-button
8330 @itemx BUTTON-2 (Article)
8331 Toggle displaying of the @sc{mime} object
8332 (@code{gnus-article-press-button}).
8334 @findex gnus-mime-view-part
8335 @item M-RET (Article)
8337 Prompt for a method, and then view the @sc{mime} object using this
8338 method (@code{gnus-mime-view-part}).
8340 @findex gnus-mime-save-part
8342 Prompt for a file name, and then save the @sc{mime} object
8343 (@code{gnus-mime-save-part}).
8345 @findex gnus-mime-copy-part
8347 Copy the @sc{mime} object to a fresh buffer and display this buffer
8348 (@code{gnus-mime-copy-part}).
8350 @findex gnus-mime-pipe-part
8352 Output the @sc{mime} object to a process (@code{gnus-mime-pipe-part}).
8355 Gnus will display some @sc{mime} objects automatically. The way Gnus
8356 determines which parts to do this with is described in the Emacs MIME
8359 It might be best to just use the toggling functions from the article
8360 buffer to avoid getting nasty surprises. (For instance, you enter the
8361 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
8362 decoded the sound file in the article and some horrible sing-a-long song
8363 comes screaming out your speakers, and you can't find the volume button,
8364 because there isn't one, and people are starting to look at you, and you
8365 try to stop the program, but you can't, and you can't find the program
8366 to control the volume, and everybody else in the room suddenly decides
8367 to look at you disdainfully, and you'll feel rather stupid.)
8369 Any similarity to real events and people is purely coincidental. Ahem.
8371 Also see @pxref{MIME Commands}.
8374 @node Customizing Articles
8375 @section Customizing Articles
8376 @cindex article customization
8378 A slew of functions for customizing how the articles are to look like
8379 exist. You can call these functions interactively, or you can have them
8380 called automatically when you select the articles.
8382 To have them called automatically, you should set the corresponding
8383 ``treatment'' variable. For instance, to have headers hidden, you'd set
8384 @code{gnus-treat-hide-headers}. Below is a list of variables that can
8385 be set, but first we discuss the values these variables can have.
8389 @code{nil}: Don't do this treatment.
8392 @code{t}: Do this treatment on all body parts.
8395 @code{head}: Do the treatment on the headers.
8398 @code{last}: Do this treatment on the last part.
8401 An integer: Do this treatment on all body parts that have a length less
8405 A list of strings: Do this treatment on all body parts that are in
8406 articles that are read in groups that have names that match one of the
8407 regexps in the list.
8410 A list where the first element is not a string:
8412 The list is evaluated recursively. The first element of the list is a
8413 predicate. The following predicates are recognized: @code{or},
8414 @code{and}, @code{not} and @code{typep}. Here's an example:
8418 (typep "text/x-vcard"))
8423 You may have noticed that the word @dfn{part} is used here. This refers
8424 to the fact that some messages are @sc{mime} multipart articles that may
8425 be divided into several parts. Articles that are not multiparts are
8426 considered to contain just a single part.
8428 @vindex gnus-article-treat-types
8429 Are the treatments applied to all sorts of multipart parts? Yes, if you
8430 want to, but by default, only @samp{text/plain} parts are given the
8431 treatment. This is controlled by the @code{gnus-article-treat-types}
8432 variable, which is a list of regular expressions that are matched to the
8433 type of the part. This variable is ignored if the value of the
8434 controlling variable is a predicate list, as described above.
8436 The following treatment options are available. The easiest way to
8437 customize this is to examine the @code{gnus-article-treat} customization
8441 @item gnus-treat-highlight-signature
8442 @item gnus-treat-buttonize
8443 @item gnus-treat-buttonize-head
8444 @item gnus-treat-emphasize
8445 @item gnus-treat-fill-article
8446 @item gnus-treat-strip-cr
8447 @item gnus-treat-hide-headers
8448 @item gnus-treat-hide-boring-headers
8449 @item gnus-treat-hide-signature
8450 @item gnus-treat-hide-citation
8451 @item gnus-treat-strip-pgp
8452 @item gnus-treat-strip-pem
8453 @item gnus-treat-highlight-headers
8454 @item gnus-treat-highlight-citation
8455 @item gnus-treat-highlight-signature
8456 @item gnus-treat-date-ut
8457 @item gnus-treat-date-local
8458 @item gnus-treat-date-lapsed
8459 @item gnus-treat-date-original
8460 @item gnus-treat-strip-headers-in-body
8461 @item gnus-treat-strip-trailing-blank-lines
8462 @item gnus-treat-strip-leading-blank-lines
8463 @item gnus-treat-strip-multiple-blank-lines
8464 @item gnus-treat-strip-blank-lines
8465 @item gnus-treat-overstrike
8466 @item gnus-treat-display-xface
8467 @item gnus-treat-display-smileys
8468 @item gnus-treat-display-picons
8469 @item gnus-treat-capitalize-sentences
8470 @item gnus-treat-fill-long-lines
8471 @item gnus-treat-play-sounds
8472 @item gnus-treat-translate
8475 @vindex gnus-part-display-hook
8476 You can, of course, write your own functions to be called from
8477 @code{gnus-part-display-hook}. The functions are called narrowed to the
8478 part, and you can do anything you like, pretty much. There is no
8479 information that you have to keep in the buffer---you can change
8480 everything. However, you shouldn't delete any headers. Instead make
8481 them invisible if you want to make them go away.
8484 @node Article Keymap
8485 @section Article Keymap
8487 Most of the keystrokes in the summary buffer can also be used in the
8488 article buffer. They should behave as if you typed them in the summary
8489 buffer, which means that you don't actually have to have a summary
8490 buffer displayed while reading. You can do it all from the article
8493 A few additional keystrokes are available:
8498 @kindex SPACE (Article)
8499 @findex gnus-article-next-page
8500 Scroll forwards one page (@code{gnus-article-next-page}).
8503 @kindex DEL (Article)
8504 @findex gnus-article-prev-page
8505 Scroll backwards one page (@code{gnus-article-prev-page}).
8508 @kindex C-c ^ (Article)
8509 @findex gnus-article-refer-article
8510 If point is in the neighborhood of a @code{Message-ID} and you press
8511 @kbd{C-c ^}, Gnus will try to get that article from the server
8512 (@code{gnus-article-refer-article}).
8515 @kindex C-c C-m (Article)
8516 @findex gnus-article-mail
8517 Send a reply to the address near point (@code{gnus-article-mail}). If
8518 given a prefix, include the mail.
8522 @findex gnus-article-show-summary
8523 Reconfigure the buffers so that the summary buffer becomes visible
8524 (@code{gnus-article-show-summary}).
8528 @findex gnus-article-describe-briefly
8529 Give a very brief description of the available keystrokes
8530 (@code{gnus-article-describe-briefly}).
8533 @kindex TAB (Article)
8534 @findex gnus-article-next-button
8535 Go to the next button, if any (@code{gnus-article-next-button}). This
8536 only makes sense if you have buttonizing turned on.
8539 @kindex M-TAB (Article)
8540 @findex gnus-article-prev-button
8541 Go to the previous button, if any (@code{gnus-article-prev-button}).
8547 @section Misc Article
8551 @item gnus-single-article-buffer
8552 @vindex gnus-single-article-buffer
8553 If non-@code{nil}, use the same article buffer for all the groups.
8554 (This is the default.) If @code{nil}, each group will have its own
8557 @vindex gnus-article-decode-hook
8558 @item gnus-article-decode-hook
8560 Hook used to decode @sc{mime} articles. The default value is
8561 @code{(article-decode-charset article-decode-encoded-words)}
8563 @vindex gnus-article-prepare-hook
8564 @item gnus-article-prepare-hook
8565 This hook is called right after the article has been inserted into the
8566 article buffer. It is mainly intended for functions that do something
8567 depending on the contents; it should probably not be used for changing
8568 the contents of the article buffer.
8570 @item gnus-article-mode-hook
8571 @vindex gnus-article-mode-hook
8572 Hook called in article mode buffers.
8574 @item gnus-article-mode-syntax-table
8575 @vindex gnus-article-mode-syntax-table
8576 Syntax table used in article buffers. It is initialized from
8577 @code{text-mode-syntax-table}.
8579 @vindex gnus-article-mode-line-format
8580 @item gnus-article-mode-line-format
8581 This variable is a format string along the same lines as
8582 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
8583 accepts the same format specifications as that variable, with one
8588 The @dfn{wash status} of the article. This is a short string with one
8589 character for each possible article wash operation that may have been
8592 The number of @sc{mime} parts in the article.
8595 @vindex gnus-break-pages
8597 @item gnus-break-pages
8598 Controls whether @dfn{page breaking} is to take place. If this variable
8599 is non-@code{nil}, the articles will be divided into pages whenever a
8600 page delimiter appears in the article. If this variable is @code{nil},
8601 paging will not be done.
8603 @item gnus-page-delimiter
8604 @vindex gnus-page-delimiter
8605 This is the delimiter mentioned above. By default, it is @samp{^L}
8610 @node Composing Messages
8611 @chapter Composing Messages
8612 @cindex composing messages
8615 @cindex sending mail
8620 @kindex C-c C-c (Post)
8621 All commands for posting and mailing will put you in a message buffer
8622 where you can edit the article all you like, before you send the article
8623 by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The Message
8624 Manual}. If you are in a foreign news group, and you wish to post the
8625 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
8626 to make Gnus try to post using the foreign server.
8629 * Mail:: Mailing and replying.
8630 * Post:: Posting and following up.
8631 * Posting Server:: What server should you post via?
8632 * Mail and Post:: Mailing and posting at the same time.
8633 * Archived Messages:: Where Gnus stores the messages you've sent.
8634 * Posting Styles:: An easier way to specify who you are.
8635 * Drafts:: Postponing messages and rejected messages.
8636 * Rejected Articles:: What happens if the server doesn't like your article?
8639 Also see @pxref{Canceling and Superseding} for information on how to
8640 remove articles you shouldn't have posted.
8646 Variables for customizing outgoing mail:
8649 @item gnus-uu-digest-headers
8650 @vindex gnus-uu-digest-headers
8651 List of regexps to match headers included in digested messages. The
8652 headers will be included in the sequence they are matched.
8654 @item gnus-add-to-list
8655 @vindex gnus-add-to-list
8656 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8657 that have none when you do a @kbd{a}.
8665 Variables for composing news articles:
8668 @item gnus-sent-message-ids-file
8669 @vindex gnus-sent-message-ids-file
8670 Gnus will keep a @code{Message-ID} history file of all the mails it has
8671 sent. If it discovers that it has already sent a mail, it will ask the
8672 user whether to re-send the mail. (This is primarily useful when
8673 dealing with @sc{soup} packets and the like where one is apt to send the
8674 same packet multiple times.) This variable says what the name of this
8675 history file is. It is @file{~/News/Sent-Message-IDs} by default. Set
8676 this variable to @code{nil} if you don't want Gnus to keep a history
8679 @item gnus-sent-message-ids-length
8680 @vindex gnus-sent-message-ids-length
8681 This variable says how many @code{Message-ID}s to keep in the history
8682 file. It is 1000 by default.
8687 @node Posting Server
8688 @section Posting Server
8690 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8691 (extremely intelligent, of course) article, where does it go?
8693 Thank you for asking. I hate you.
8695 @vindex gnus-post-method
8697 It can be quite complicated. Normally, Gnus will use the same native
8698 server. However. If your native server doesn't allow posting, just
8699 reading, you probably want to use some other server to post your
8700 (extremely intelligent and fabulously interesting) articles. You can
8701 then set the @code{gnus-post-method} to some other method:
8704 (setq gnus-post-method '(nnspool ""))
8707 Now, if you've done this, and then this server rejects your article, or
8708 this server is down, what do you do then? To override this variable you
8709 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8710 the ``current'' server for posting.
8712 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8713 Gnus will prompt you for what method to use for posting.
8715 You can also set @code{gnus-post-method} to a list of select methods.
8716 If that's the case, Gnus will always prompt you for what method to use
8719 Finally, if you want to always post using the same select method as
8720 you're reading from (which might be convenient if you're reading lots of
8721 groups from different private servers), you can set this variable to
8726 @section Mail and Post
8728 Here's a list of variables relevant to both mailing and
8732 @item gnus-mailing-list-groups
8733 @findex gnus-mailing-list-groups
8734 @cindex mailing lists
8736 If your news server offers groups that are really mailing lists
8737 gatewayed to the @sc{nntp} server, you can read those groups without
8738 problems, but you can't post/followup to them without some difficulty.
8739 One solution is to add a @code{to-address} to the group parameters
8740 (@pxref{Group Parameters}). An easier thing to do is set the
8741 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8742 really are mailing lists. Then, at least, followups to the mailing
8743 lists will work most of the time. Posting to these groups (@kbd{a}) is
8744 still a pain, though.
8748 You may want to do spell-checking on messages that you send out. Or, if
8749 you don't want to spell-check by hand, you could add automatic
8750 spell-checking via the @code{ispell} package:
8753 @findex ispell-message
8755 (add-hook 'message-send-hook 'ispell-message)
8759 @node Archived Messages
8760 @section Archived Messages
8761 @cindex archived messages
8762 @cindex sent messages
8764 Gnus provides a few different methods for storing the mail and news you
8765 send. The default method is to use the @dfn{archive virtual server} to
8766 store the messages. If you want to disable this completely, the
8767 @code{gnus-message-archive-group} variable should be @code{nil}, which
8770 @vindex gnus-message-archive-method
8771 @code{gnus-message-archive-method} says what virtual server Gnus is to
8772 use to store sent messages. The default is:
8776 (nnfolder-directory "~/Mail/archive")
8777 (nnfolder-active-file "~/Mail/archive/active")
8778 (nnfolder-get-new-mail nil)
8779 (nnfolder-inhibit-expiry t))
8782 You can, however, use any mail select method (@code{nnml},
8783 @code{nnmbox}, etc.). @code{nnfolder} is a quite likeable select method
8784 for doing this sort of thing, though. If you don't like the default
8785 directory chosen, you could say something like:
8788 (setq gnus-message-archive-method
8789 '(nnfolder "archive"
8790 (nnfolder-inhibit-expiry t)
8791 (nnfolder-active-file "~/News/sent-mail/active")
8792 (nnfolder-directory "~/News/sent-mail/")))
8795 @vindex gnus-message-archive-group
8797 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8798 to one or more group(s) on that server. Which group to use is
8799 determined by the @code{gnus-message-archive-group} variable.
8801 This variable can be used to do the following:
8805 Messages will be saved in that group.
8806 @item a list of strings
8807 Messages will be saved in all those groups.
8808 @item an alist of regexps, functions and forms
8809 When a key ``matches'', the result is used.
8811 No message archiving will take place. This is the default.
8816 Just saving to a single group called @samp{MisK}:
8818 (setq gnus-message-archive-group "MisK")
8821 Saving to two groups, @samp{MisK} and @samp{safe}:
8823 (setq gnus-message-archive-group '("MisK" "safe"))
8826 Save to different groups based on what group you are in:
8828 (setq gnus-message-archive-group
8829 '(("^alt" "sent-to-alt")
8830 ("mail" "sent-to-mail")
8831 (".*" "sent-to-misc")))
8836 (setq gnus-message-archive-group
8837 '((if (message-news-p)
8842 How about storing all news messages in one file, but storing all mail
8843 messages in one file per month:
8846 (setq gnus-message-archive-group
8847 '((if (message-news-p)
8849 (concat "mail." (format-time-string
8850 "%Y-%m" (current-time))))))
8853 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8854 use a different value for @code{gnus-message-archive-group} there.)
8856 Now, when you send a message off, it will be stored in the appropriate
8857 group. (If you want to disable storing for just one particular message,
8858 you can just remove the @code{Gcc} header that has been inserted.) The
8859 archive group will appear in the group buffer the next time you start
8860 Gnus, or the next time you press @kbd{F} in the group buffer. You can
8861 enter it and read the articles in it just like you'd read any other
8862 group. If the group gets really big and annoying, you can simply rename
8863 if (using @kbd{G r} in the group buffer) to something
8864 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
8865 continue to be stored in the old (now empty) group.
8867 That's the default method of archiving sent messages. Gnus offers a
8868 different way for the people who don't like the default method. In that
8869 case you should set @code{gnus-message-archive-group} to @code{nil};
8870 this will disable archiving.
8873 @item gnus-outgoing-message-group
8874 @vindex gnus-outgoing-message-group
8875 All outgoing messages will be put in this group. If you want to store
8876 all your outgoing mail and articles in the group @samp{nnml:archive},
8877 you set this variable to that value. This variable can also be a list of
8880 If you want to have greater control over what group to put each
8881 message in, you can set this variable to a function that checks the
8882 current newsgroup name and then returns a suitable group name (or list
8885 This variable can be used instead of @code{gnus-message-archive-group},
8886 but the latter is the preferred method.
8890 @node Posting Styles
8891 @section Posting Styles
8892 @cindex posting styles
8895 All them variables, they make my head swim.
8897 So what if you want a different @code{Organization} and signature based
8898 on what groups you post to? And you post both from your home machine
8899 and your work machine, and you want different @code{From} lines, and so
8902 @vindex gnus-posting-styles
8903 One way to do stuff like that is to write clever hooks that change the
8904 variables you need to have changed. That's a bit boring, so somebody
8905 came up with the bright idea of letting the user specify these things in
8906 a handy alist. Here's an example of a @code{gnus-posting-styles}
8911 (signature "Peace and happiness")
8912 (organization "What me?"))
8914 (signature "Death to everybody"))
8915 ("comp.emacs.i-love-it"
8916 (organization "Emacs is it")))
8919 As you might surmise from this example, this alist consists of several
8920 @dfn{styles}. Each style will be applicable if the first element
8921 ``matches'', in some form or other. The entire alist will be iterated
8922 over, from the beginning towards the end, and each match will be
8923 applied, which means that attributes in later styles that match override
8924 the same attributes in earlier matching styles. So
8925 @samp{comp.programming.literate} will have the @samp{Death to everybody}
8926 signature and the @samp{What me?} @code{Organization} header.
8928 The first element in each style is called the @code{match}. If it's a
8929 string, then Gnus will try to regexp match it against the group name.
8930 If it's a function symbol, that function will be called with no
8931 arguments. If it's a variable symbol, then the variable will be
8932 referenced. If it's a list, then that list will be @code{eval}ed. In
8933 any case, if this returns a non-@code{nil} value, then the style is said
8936 Each style may contain a arbitrary amount of @dfn{attributes}. Each
8937 attribute consists of a @var{(name value)} pair. The attribute name
8938 can be one of @code{signature}, @code{signature-file},
8939 @code{organization}, @code{address}, @code{name} or @code{body}. The
8940 attribute name can also be a string. In that case, this will be used as
8941 a header name, and the value will be inserted in the headers of the
8944 The attribute value can be a string (used verbatim), a function (the
8945 return value will be used), a variable (its value will be used) or a
8946 list (it will be @code{eval}ed and the return value will be used).
8948 If you wish to check whether the message you are about to compose is
8949 meant to be a news article or a mail message, you can check the values
8950 of the @code{message-news-p} and @code{message-mail-p} functions.
8952 @findex message-mail-p
8953 @findex message-news-p
8955 So here's a new example:
8958 (setq gnus-posting-styles
8960 (signature-file "~/.signature")
8962 ("X-Home-Page" (getenv "WWW_HOME"))
8963 (organization "People's Front Against MWM"))
8965 (signature my-funny-signature-randomizer))
8966 ((equal (system-name) "gnarly")
8967 (signature my-quote-randomizer))
8969 (signature my-news-signature))
8970 ((posting-from-work-p)
8971 (signature-file "~/.work-signature")
8972 (address "user@@bar.foo")
8973 (body "You are fired.\n\nSincerely, your boss.")
8974 (organization "Important Work, Inc"))
8976 (signature-file "~/.mail-signature"))))
8984 If you are writing a message (mail or news) and suddenly remember that
8985 you have a steak in the oven (or some pesto in the food processor, you
8986 craaazy vegetarians), you'll probably wish there was a method to save
8987 the message you are writing so that you can continue editing it some
8988 other day, and send it when you feel its finished.
8990 Well, don't worry about it. Whenever you start composing a message of
8991 some sort using the Gnus mail and post commands, the buffer you get will
8992 automatically associate to an article in a special @dfn{draft} group.
8993 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
8994 article will be saved there. (Auto-save files also go to the draft
8998 @vindex nndraft-directory
8999 The draft group is a special group (which is implemented as an
9000 @code{nndraft} group, if you absolutely have to know) called
9001 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
9002 @code{nndraft} is to store its files. What makes this group special is
9003 that you can't tick any articles in it or mark any articles as
9004 read---all articles in the group are permanently unread.
9006 If the group doesn't exist, it will be created and you'll be subscribed
9007 to it. The only way to make it disappear from the Group buffer is to
9010 @c @findex gnus-dissociate-buffer-from-draft
9011 @c @kindex C-c M-d (Mail)
9012 @c @kindex C-c M-d (Post)
9013 @c @findex gnus-associate-buffer-with-draft
9014 @c @kindex C-c C-d (Mail)
9015 @c @kindex C-c C-d (Post)
9016 @c If you're writing some super-secret message that you later want to
9017 @c encode with PGP before sending, you may wish to turn the auto-saving
9018 @c (and association with the draft group) off. You never know who might be
9019 @c interested in reading all your extremely valuable and terribly horrible
9020 @c and interesting secrets. The @kbd{C-c M-d}
9021 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
9022 @c If you change your mind and want to turn the auto-saving back on again,
9023 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
9025 @c @vindex gnus-use-draft
9026 @c To leave association with the draft group off by default, set
9027 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
9029 @findex gnus-draft-edit-message
9031 When you want to continue editing the article, you simply enter the
9032 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
9033 that. You will be placed in a buffer where you left off.
9035 Rejected articles will also be put in this draft group (@pxref{Rejected
9038 @findex gnus-draft-send-all-messages
9039 @findex gnus-draft-send-message
9040 If you have lots of rejected messages you want to post (or mail) without
9041 doing further editing, you can use the @kbd{D s} command
9042 (@code{gnus-draft-send-message}). This command understands the
9043 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
9044 command (@code{gnus-draft-send-all-messages}) will ship off all messages
9047 If you have some messages that you wish not to send, you can use the
9048 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
9049 as unsendable. This is a toggling command.
9052 @node Rejected Articles
9053 @section Rejected Articles
9054 @cindex rejected articles
9056 Sometimes a news server will reject an article. Perhaps the server
9057 doesn't like your face. Perhaps it just feels miserable. Perhaps
9058 @emph{there be demons}. Perhaps you have included too much cited text.
9059 Perhaps the disk is full. Perhaps the server is down.
9061 These situations are, of course, totally beyond the control of Gnus.
9062 (Gnus, of course, loves the way you look, always feels great, has angels
9063 fluttering around inside of it, doesn't care about how much cited text
9064 you include, never runs full and never goes down.) So Gnus saves these
9065 articles until some later time when the server feels better.
9067 The rejected articles will automatically be put in a special draft group
9068 (@pxref{Drafts}). When the server comes back up again, you'd then
9069 typically enter that group and send all the articles off.
9072 @node Select Methods
9073 @chapter Select Methods
9074 @cindex foreign groups
9075 @cindex select methods
9077 A @dfn{foreign group} is a group not read by the usual (or
9078 default) means. It could be, for instance, a group from a different
9079 @sc{nntp} server, it could be a virtual group, or it could be your own
9080 personal mail group.
9082 A foreign group (or any group, really) is specified by a @dfn{name} and
9083 a @dfn{select method}. To take the latter first, a select method is a
9084 list where the first element says what backend to use (e.g. @code{nntp},
9085 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
9086 name}. There may be additional elements in the select method, where the
9087 value may have special meaning for the backend in question.
9089 One could say that a select method defines a @dfn{virtual server}---so
9090 we do just that (@pxref{The Server Buffer}).
9092 The @dfn{name} of the group is the name the backend will recognize the
9095 For instance, the group @samp{soc.motss} on the @sc{nntp} server
9096 @samp{some.where.edu} will have the name @samp{soc.motss} and select
9097 method @code{(nntp "some.where.edu")}. Gnus will call this group
9098 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
9099 backend just knows this group as @samp{soc.motss}.
9101 The different methods all have their peculiarities, of course.
9104 * The Server Buffer:: Making and editing virtual servers.
9105 * Getting News:: Reading USENET news with Gnus.
9106 * Getting Mail:: Reading your personal mail with Gnus.
9107 * Other Sources:: Reading directories, files, SOUP packets.
9108 * Combined Groups:: Combining groups into one group.
9109 * Gnus Unplugged:: Reading news and mail offline.
9113 @node The Server Buffer
9114 @section The Server Buffer
9116 Traditionally, a @dfn{server} is a machine or a piece of software that
9117 one connects to, and then requests information from. Gnus does not
9118 connect directly to any real servers, but does all transactions through
9119 one backend or other. But that's just putting one layer more between
9120 the actual media and Gnus, so we might just as well say that each
9121 backend represents a virtual server.
9123 For instance, the @code{nntp} backend may be used to connect to several
9124 different actual @sc{nntp} servers, or, perhaps, to many different ports
9125 on the same actual @sc{nntp} server. You tell Gnus which backend to
9126 use, and what parameters to set by specifying a @dfn{select method}.
9128 These select method specifications can sometimes become quite
9129 complicated---say, for instance, that you want to read from the
9130 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
9131 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
9132 Anyways, if you had to specify that for each group that used this
9133 server, that would be too much work, so Gnus offers a way of naming
9134 select methods, which is what you do in the server buffer.
9136 To enter the server buffer, use the @kbd{^}
9137 (@code{gnus-group-enter-server-mode}) command in the group buffer.
9140 * Server Buffer Format:: You can customize the look of this buffer.
9141 * Server Commands:: Commands to manipulate servers.
9142 * Example Methods:: Examples server specifications.
9143 * Creating a Virtual Server:: An example session.
9144 * Server Variables:: Which variables to set.
9145 * Servers and Methods:: You can use server names as select methods.
9146 * Unavailable Servers:: Some servers you try to contact may be down.
9149 @vindex gnus-server-mode-hook
9150 @code{gnus-server-mode-hook} is run when creating the server buffer.
9153 @node Server Buffer Format
9154 @subsection Server Buffer Format
9155 @cindex server buffer format
9157 @vindex gnus-server-line-format
9158 You can change the look of the server buffer lines by changing the
9159 @code{gnus-server-line-format} variable. This is a @code{format}-like
9160 variable, with some simple extensions:
9165 How the news is fetched---the backend name.
9168 The name of this server.
9171 Where the news is to be fetched from---the address.
9174 The opened/closed/denied status of the server.
9177 @vindex gnus-server-mode-line-format
9178 The mode line can also be customized by using the
9179 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
9180 Formatting}). The following specs are understood:
9190 Also @pxref{Formatting Variables}.
9193 @node Server Commands
9194 @subsection Server Commands
9195 @cindex server commands
9201 @findex gnus-server-add-server
9202 Add a new server (@code{gnus-server-add-server}).
9206 @findex gnus-server-edit-server
9207 Edit a server (@code{gnus-server-edit-server}).
9210 @kindex SPACE (Server)
9211 @findex gnus-server-read-server
9212 Browse the current server (@code{gnus-server-read-server}).
9216 @findex gnus-server-exit
9217 Return to the group buffer (@code{gnus-server-exit}).
9221 @findex gnus-server-kill-server
9222 Kill the current server (@code{gnus-server-kill-server}).
9226 @findex gnus-server-yank-server
9227 Yank the previously killed server (@code{gnus-server-yank-server}).
9231 @findex gnus-server-copy-server
9232 Copy the current server (@code{gnus-server-copy-server}).
9236 @findex gnus-server-list-servers
9237 List all servers (@code{gnus-server-list-servers}).
9241 @findex gnus-server-scan-server
9242 Request that the server scan its sources for new articles
9243 (@code{gnus-server-scan-server}). This is mainly sensible with mail
9248 @findex gnus-server-regenerate-server
9249 Request that the server regenerate all its data structures
9250 (@code{gnus-server-regenerate-server}). This can be useful if you have
9251 a mail backend that has gotten out of synch.
9256 @node Example Methods
9257 @subsection Example Methods
9259 Most select methods are pretty simple and self-explanatory:
9262 (nntp "news.funet.fi")
9265 Reading directly from the spool is even simpler:
9271 As you can see, the first element in a select method is the name of the
9272 backend, and the second is the @dfn{address}, or @dfn{name}, if you
9275 After these two elements, there may be an arbitrary number of
9276 @var{(variable form)} pairs.
9278 To go back to the first example---imagine that you want to read from
9279 port 15 on that machine. This is what the select method should
9283 (nntp "news.funet.fi" (nntp-port-number 15))
9286 You should read the documentation to each backend to find out what
9287 variables are relevant, but here's an @code{nnmh} example:
9289 @code{nnmh} is a mail backend that reads a spool-like structure. Say
9290 you have two structures that you wish to access: One is your private
9291 mail spool, and the other is a public one. Here's the possible spec for
9295 (nnmh "private" (nnmh-directory "~/private/mail/"))
9298 (This server is then called @samp{private}, but you may have guessed
9301 Here's the method for a public spool:
9305 (nnmh-directory "/usr/information/spool/")
9306 (nnmh-get-new-mail nil))
9309 If you are behind a firewall and only have access to the @sc{nntp}
9310 server from the firewall machine, you can instruct Gnus to @code{rlogin}
9311 on the firewall machine and telnet from there to the @sc{nntp} server.
9312 Doing this can be rather fiddly, but your virtual server definition
9313 should probably look something like this:
9317 (nntp-address "the.firewall.machine")
9318 (nntp-open-connection-function nntp-open-rlogin)
9319 (nntp-end-of-line "\n")
9320 (nntp-rlogin-parameters
9321 ("telnet" "the.real.nntp.host" "nntp")))
9324 If you want to use the wonderful @code{ssh} program to provide a
9325 compressed connection over the modem line, you could create a virtual
9326 server that would look something like this:
9330 (nntp-address "copper.uio.no")
9331 (nntp-rlogin-program "ssh")
9332 (nntp-open-connection-function nntp-open-rlogin)
9333 (nntp-end-of-line "\n")
9334 (nntp-rlogin-parameters
9335 ("telnet" "news.uio.no" "nntp")))
9338 This means that you have to have set up @code{ssh-agent} correctly to
9339 provide automatic authorization, of course. And to get a compressed
9340 connection, you have to have the @samp{Compression} option in the
9341 @code{ssh} @file{config} file.
9344 @node Creating a Virtual Server
9345 @subsection Creating a Virtual Server
9347 If you're saving lots of articles in the cache by using persistent
9348 articles, you may want to create a virtual server to read the cache.
9350 First you need to add a new server. The @kbd{a} command does that. It
9351 would probably be best to use @code{nnspool} to read the cache. You
9352 could also use @code{nnml} or @code{nnmh}, though.
9354 Type @kbd{a nnspool RET cache RET}.
9356 You should now have a brand new @code{nnspool} virtual server called
9357 @samp{cache}. You now need to edit it to have the right definitions.
9358 Type @kbd{e} to edit the server. You'll be entered into a buffer that
9359 will contain the following:
9369 (nnspool-spool-directory "~/News/cache/")
9370 (nnspool-nov-directory "~/News/cache/")
9371 (nnspool-active-file "~/News/cache/active"))
9374 Type @kbd{C-c C-c} to return to the server buffer. If you now press
9375 @kbd{RET} over this virtual server, you should be entered into a browse
9376 buffer, and you should be able to enter any of the groups displayed.
9379 @node Server Variables
9380 @subsection Server Variables
9382 One sticky point when defining variables (both on backends and in Emacs
9383 in general) is that some variables are typically initialized from other
9384 variables when the definition of the variables is being loaded. If you
9385 change the "base" variable after the variables have been loaded, you
9386 won't change the "derived" variables.
9388 This typically affects directory and file variables. For instance,
9389 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
9390 directory variables are initialized from that variable, so
9391 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
9392 new virtual @code{nnml} server, it will @emph{not} suffice to set just
9393 @code{nnml-directory}---you have to explicitly set all the file
9394 variables to be what you want them to be. For a complete list of
9395 variables for each backend, see each backend's section later in this
9396 manual, but here's an example @code{nnml} definition:
9400 (nnml-directory "~/my-mail/")
9401 (nnml-active-file "~/my-mail/active")
9402 (nnml-newsgroups-file "~/my-mail/newsgroups"))
9406 @node Servers and Methods
9407 @subsection Servers and Methods
9409 Wherever you would normally use a select method
9410 (e.g. @code{gnus-secondary-select-method}, in the group select method,
9411 when browsing a foreign server) you can use a virtual server name
9412 instead. This could potentially save lots of typing. And it's nice all
9416 @node Unavailable Servers
9417 @subsection Unavailable Servers
9419 If a server seems to be unreachable, Gnus will mark that server as
9420 @code{denied}. That means that any subsequent attempt to make contact
9421 with that server will just be ignored. ``It can't be opened,'' Gnus
9422 will tell you, without making the least effort to see whether that is
9423 actually the case or not.
9425 That might seem quite naughty, but it does make sense most of the time.
9426 Let's say you have 10 groups subscribed to on server
9427 @samp{nephelococcygia.com}. This server is located somewhere quite far
9428 away from you and the machine is quite slow, so it takes 1 minute just
9429 to find out that it refuses connection to you today. If Gnus were to
9430 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
9431 attempt to do that. Once it has gotten a single ``connection refused'',
9432 it will regard that server as ``down''.
9434 So, what happens if the machine was only feeling unwell temporarily?
9435 How do you test to see whether the machine has come up again?
9437 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
9438 with the following commands:
9444 @findex gnus-server-open-server
9445 Try to establish connection to the server on the current line
9446 (@code{gnus-server-open-server}).
9450 @findex gnus-server-close-server
9451 Close the connection (if any) to the server
9452 (@code{gnus-server-close-server}).
9456 @findex gnus-server-deny-server
9457 Mark the current server as unreachable
9458 (@code{gnus-server-deny-server}).
9461 @kindex M-o (Server)
9462 @findex gnus-server-open-all-servers
9463 Open the connections to all servers in the buffer
9464 (@code{gnus-server-open-all-servers}).
9467 @kindex M-c (Server)
9468 @findex gnus-server-close-all-servers
9469 Close the connections to all servers in the buffer
9470 (@code{gnus-server-close-all-servers}).
9474 @findex gnus-server-remove-denials
9475 Remove all marks to whether Gnus was denied connection from any servers
9476 (@code{gnus-server-remove-denials}).
9482 @section Getting News
9483 @cindex reading news
9484 @cindex news backends
9486 A newsreader is normally used for reading news. Gnus currently provides
9487 only two methods of getting news---it can read from an @sc{nntp} server,
9488 or it can read from a local spool.
9491 * NNTP:: Reading news from an @sc{nntp} server.
9492 * News Spool:: Reading news from the local spool.
9497 @subsection @sc{nntp}
9500 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
9501 You just specify @code{nntp} as method and the address of the @sc{nntp}
9502 server as the, uhm, address.
9504 If the @sc{nntp} server is located at a non-standard port, setting the
9505 third element of the select method to this port number should allow you
9506 to connect to the right port. You'll have to edit the group info for
9507 that (@pxref{Foreign Groups}).
9509 The name of the foreign group can be the same as a native group. In
9510 fact, you can subscribe to the same group from as many different servers
9511 you feel like. There will be no name collisions.
9513 The following variables can be used to create a virtual @code{nntp}
9518 @item nntp-server-opened-hook
9519 @vindex nntp-server-opened-hook
9520 @cindex @sc{mode reader}
9522 @cindex authentification
9523 @cindex nntp authentification
9524 @findex nntp-send-authinfo
9525 @findex nntp-send-mode-reader
9526 is run after a connection has been made. It can be used to send
9527 commands to the @sc{nntp} server after it has been contacted. By
9528 default it sends the command @code{MODE READER} to the server with the
9529 @code{nntp-send-mode-reader} function. This function should always be
9530 present in this hook.
9532 @item nntp-authinfo-function
9533 @vindex nntp-authinfo-function
9534 @findex nntp-send-authinfo
9535 @vindex nntp-authinfo-file
9536 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
9537 server. The default function is @code{nntp-send-authinfo}, which looks
9538 through your @file{~/.authinfo} (or whatever you've set the
9539 @code{nntp-authinfo-file} variable to) for applicable entries. If none
9540 are found, it will prompt you for a login name and a password. The
9541 format of the @file{~/.authinfo} file is (almost) the same as the
9542 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
9543 manual page, but here are the salient facts:
9547 The file contains one or more line, each of which define one server.
9550 Each line may contain an arbitrary number of token/value pairs. The
9551 valid tokens include @samp{machine}, @samp{login}, @samp{password},
9552 @samp{default} and @samp{force}. (The latter is not a valid
9553 @file{.netrc}/@code{ftp} token, which is the only way the
9554 @file{.authinfo} file format deviates from the @file{.netrc} file
9559 Here's an example file:
9562 machine news.uio.no login larsi password geheimnis
9563 machine nntp.ifi.uio.no login larsi force yes
9566 The token/value pairs may appear in any order; @samp{machine} doesn't
9567 have to be first, for instance.
9569 In this example, both login name and password have been supplied for the
9570 former server, while the latter has only the login name listed, and the
9571 user will be prompted for the password. The latter also has the
9572 @samp{force} tag, which means that the authinfo will be sent to the
9573 @var{nntp} server upon connection; the default (i.e., when there is not
9574 @samp{force} tag) is to not send authinfo to the @var{nntp} server
9575 until the @var{nntp} server asks for it.
9577 You can also add @samp{default} lines that will apply to all servers
9578 that don't have matching @samp{machine} lines.
9584 This will force sending @samp{AUTHINFO} commands to all servers not
9585 previously mentioned.
9587 Remember to not leave the @file{~/.authinfo} file world-readable.
9589 @item nntp-server-action-alist
9590 @vindex nntp-server-action-alist
9591 This is a list of regexps to match on server types and actions to be
9592 taken when matches are made. For instance, if you want Gnus to beep
9593 every time you connect to innd, you could say something like:
9596 (setq nntp-server-action-alist
9600 You probably don't want to do that, though.
9602 The default value is
9605 '(("nntpd 1\\.5\\.11t"
9606 (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
9609 This ensures that Gnus doesn't send the @code{MODE READER} command to
9610 nntpd 1.5.11t, since that command chokes that server, I've been told.
9612 @item nntp-maximum-request
9613 @vindex nntp-maximum-request
9614 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
9615 will collect headers by sending a series of @code{head} commands. To
9616 speed things up, the backend sends lots of these commands without
9617 waiting for reply, and then reads all the replies. This is controlled
9618 by the @code{nntp-maximum-request} variable, and is 400 by default. If
9619 your network is buggy, you should set this to 1.
9621 @item nntp-connection-timeout
9622 @vindex nntp-connection-timeout
9623 If you have lots of foreign @code{nntp} groups that you connect to
9624 regularly, you're sure to have problems with @sc{nntp} servers not
9625 responding properly, or being too loaded to reply within reasonable
9626 time. This is can lead to awkward problems, which can be helped
9627 somewhat by setting @code{nntp-connection-timeout}. This is an integer
9628 that says how many seconds the @code{nntp} backend should wait for a
9629 connection before giving up. If it is @code{nil}, which is the default,
9630 no timeouts are done.
9632 @c @item nntp-command-timeout
9633 @c @vindex nntp-command-timeout
9634 @c @cindex PPP connections
9635 @c @cindex dynamic IP addresses
9636 @c If you're running Gnus on a machine that has a dynamically assigned
9637 @c address, Gnus may become confused. If the address of your machine
9638 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
9639 @c waiting forever for replies from the server. To help with this
9640 @c unfortunate problem, you can set this command to a number. Gnus will
9641 @c then, if it sits waiting for a reply from the server longer than that
9642 @c number of seconds, shut down the connection, start a new one, and resend
9643 @c the command. This should hopefully be transparent to the user. A
9644 @c likely number is 30 seconds.
9646 @c @item nntp-retry-on-break
9647 @c @vindex nntp-retry-on-break
9648 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
9649 @c hangs. This will have much the same effect as the command timeout
9652 @item nntp-server-hook
9653 @vindex nntp-server-hook
9654 This hook is run as the last step when connecting to an @sc{nntp}
9657 @findex nntp-open-rlogin
9658 @findex nntp-open-telnet
9659 @findex nntp-open-network-stream
9660 @item nntp-open-connection-function
9661 @vindex nntp-open-connection-function
9662 This function is used to connect to the remote system. Four pre-made
9663 functions are supplied:
9666 @item nntp-open-network-stream
9667 This is the default, and simply connects to some port or other on the
9670 @item nntp-open-rlogin
9671 Does an @samp{rlogin} on the
9672 remote system, and then does a @samp{telnet} to the @sc{nntp} server
9675 @code{nntp-open-rlogin}-related variables:
9679 @item nntp-rlogin-program
9680 @vindex nntp-rlogin-program
9681 Program used to log in on remote machines. The default is @samp{rsh},
9682 but @samp{ssh} is a popular alternative.
9684 @item nntp-rlogin-parameters
9685 @vindex nntp-rlogin-parameters
9686 This list will be used as the parameter list given to @code{rsh}.
9688 @item nntp-rlogin-user-name
9689 @vindex nntp-rlogin-user-name
9690 User name on the remote system.
9694 @item nntp-open-telnet
9695 Does a @samp{telnet} to the remote system and then another @samp{telnet}
9696 to get to the @sc{nntp} server.
9698 @code{nntp-open-telnet}-related variables:
9701 @item nntp-telnet-command
9702 @vindex nntp-telnet-command
9703 Command used to start @code{telnet}.
9705 @item nntp-telnet-switches
9706 @vindex nntp-telnet-switches
9707 List of strings to be used as the switches to the @code{telnet} command.
9709 @item nntp-telnet-user-name
9710 @vindex nntp-telnet-user-name
9711 User name for log in on the remote system.
9713 @item nntp-telnet-passwd
9714 @vindex nntp-telnet-passwd
9715 Password to use when logging in.
9717 @item nntp-telnet-parameters
9718 @vindex nntp-telnet-parameters
9719 A list of strings executed as a command after logging in
9722 @item nntp-telnet-shell-prompt
9723 @vindex nntp-telnet-shell-prompt
9724 Regexp matching the shell prompt on the remote machine. The default is
9725 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9727 @item nntp-open-telnet-envuser
9728 @vindex nntp-open-telnet-envuser
9729 If non-@code{nil}, the @code{telnet} session (client and server both)
9730 will support the @code{ENVIRON} option and not prompt for login name.
9731 This works for Solaris @code{telnet}, for instance.
9735 @findex nntp-open-ssl-stream
9736 @item nntp-open-ssl-stream
9737 Opens a connection to a server over a @dfn{secure} channel. To use this
9738 you must have SSLay installed
9739 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
9740 @file{ssl.el} (from the W3 distributeion, for instance). You then
9741 define a server as follows:
9744 ;; Type `C-c C-c' after you've finished editing.
9746 ;; "snews" is port 563 and is predefined in our /etc/services
9748 (nntp "snews.bar.com"
9749 (nntp-open-connection-function nntp-open-ssl-stream)
9750 (nntp-port-number "snews")
9751 (nntp-address "snews.bar.com"))
9756 @item nntp-end-of-line
9757 @vindex nntp-end-of-line
9758 String to use as end-of-line marker when talking to the @sc{nntp}
9759 server. This is @samp{\r\n} by default, but should be @samp{\n} when
9760 using @code{rlogin} to talk to the server.
9762 @item nntp-rlogin-user-name
9763 @vindex nntp-rlogin-user-name
9764 User name on the remote system when using the @code{rlogin} connect
9768 @vindex nntp-address
9769 The address of the remote system running the @sc{nntp} server.
9771 @item nntp-port-number
9772 @vindex nntp-port-number
9773 Port number to connect to when using the @code{nntp-open-network-stream}
9776 @item nntp-buggy-select
9777 @vindex nntp-buggy-select
9778 Set this to non-@code{nil} if your select routine is buggy.
9780 @item nntp-nov-is-evil
9781 @vindex nntp-nov-is-evil
9782 If the @sc{nntp} server does not support @sc{nov}, you could set this
9783 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9786 @item nntp-xover-commands
9787 @vindex nntp-xover-commands
9790 List of strings used as commands to fetch @sc{nov} lines from a
9791 server. The default value of this variable is @code{("XOVER"
9795 @vindex nntp-nov-gap
9796 @code{nntp} normally sends just one big request for @sc{nov} lines to
9797 the server. The server responds with one huge list of lines. However,
9798 if you have read articles 2-5000 in the group, and only want to read
9799 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9800 lines that you will not need. This variable says how
9801 big a gap between two consecutive articles is allowed to be before the
9802 @code{XOVER} request is split into several request. Note that if your
9803 network is fast, setting this variable to a really small number means
9804 that fetching will probably be slower. If this variable is @code{nil},
9805 @code{nntp} will never split requests. The default is 5.
9807 @item nntp-prepare-server-hook
9808 @vindex nntp-prepare-server-hook
9809 A hook run before attempting to connect to an @sc{nntp} server.
9811 @item nntp-warn-about-losing-connection
9812 @vindex nntp-warn-about-losing-connection
9813 If this variable is non-@code{nil}, some noise will be made when a
9814 server closes connection.
9816 @item nntp-record-commands
9817 @vindex nntp-record-commands
9818 If non-@code{nil}, @code{nntp} will log all commands it sends to the
9819 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
9820 buffer. This is useful if you are debugging a Gnus/@sc{nntp} connection
9821 that doesn't seem to work.
9827 @subsection News Spool
9831 Subscribing to a foreign group from the local spool is extremely easy,
9832 and might be useful, for instance, to speed up reading groups that
9833 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9836 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9837 anything else) as the address.
9839 If you have access to a local spool, you should probably use that as the
9840 native select method (@pxref{Finding the News}). It is normally faster
9841 than using an @code{nntp} select method, but might not be. It depends.
9842 You just have to try to find out what's best at your site.
9846 @item nnspool-inews-program
9847 @vindex nnspool-inews-program
9848 Program used to post an article.
9850 @item nnspool-inews-switches
9851 @vindex nnspool-inews-switches
9852 Parameters given to the inews program when posting an article.
9854 @item nnspool-spool-directory
9855 @vindex nnspool-spool-directory
9856 Where @code{nnspool} looks for the articles. This is normally
9857 @file{/usr/spool/news/}.
9859 @item nnspool-nov-directory
9860 @vindex nnspool-nov-directory
9861 Where @code{nnspool} will look for @sc{nov} files. This is normally
9862 @file{/usr/spool/news/over.view/}.
9864 @item nnspool-lib-dir
9865 @vindex nnspool-lib-dir
9866 Where the news lib dir is (@file{/usr/lib/news/} by default).
9868 @item nnspool-active-file
9869 @vindex nnspool-active-file
9870 The path to the active file.
9872 @item nnspool-newsgroups-file
9873 @vindex nnspool-newsgroups-file
9874 The path to the group descriptions file.
9876 @item nnspool-history-file
9877 @vindex nnspool-history-file
9878 The path to the news history file.
9880 @item nnspool-active-times-file
9881 @vindex nnspool-active-times-file
9882 The path to the active date file.
9884 @item nnspool-nov-is-evil
9885 @vindex nnspool-nov-is-evil
9886 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9889 @item nnspool-sift-nov-with-sed
9890 @vindex nnspool-sift-nov-with-sed
9892 If non-@code{nil}, which is the default, use @code{sed} to get the
9893 relevant portion from the overview file. If nil, @code{nnspool} will
9894 load the entire file into a buffer and process it there.
9900 @section Getting Mail
9901 @cindex reading mail
9904 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9908 * Mail in a Newsreader:: Important introductory notes.
9909 * Getting Started Reading Mail:: A simple cookbook example.
9910 * Splitting Mail:: How to create mail groups.
9911 * Mail Sources:: How to tell Gnus where to get mail from.
9912 * Mail Backend Variables:: Variables for customizing mail handling.
9913 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
9914 * Incorporating Old Mail:: What about the old mail you have?
9915 * Expiring Mail:: Getting rid of unwanted mail.
9916 * Washing Mail:: Removing gruft from the mail you get.
9917 * Duplicates:: Dealing with duplicated mail.
9918 * Not Reading Mail:: Using mail backends for reading other files.
9919 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
9923 @node Mail in a Newsreader
9924 @subsection Mail in a Newsreader
9926 If you are used to traditional mail readers, but have decided to switch
9927 to reading mail with Gnus, you may find yourself experiencing something
9930 Gnus does not behave like traditional mail readers. If you want to make
9931 it behave that way, you can, but it's an uphill battle.
9933 Gnus, by default, handles all its group using the same approach. This
9934 approach is very newsreaderly---you enter a group, see the new/unread
9935 messages, and when you read the messages, they get marked as read, and
9936 you don't see them any more. (Unless you explicitly ask for them.)
9938 In particular, you do not do anything explicitly to delete messages.
9940 Does this mean that all the messages that have been marked as read are
9943 But, no, it means that old messages are @dfn{expired} according to some
9944 scheme or other. For news messages, the expire process is controlled by
9945 the news administrator; for mail, the expire process is controlled by
9946 you. The expire process for mail is covered in depth in @pxref{Expiring
9949 What many Gnus users find, after using it a while for both news and
9950 mail, is that the transport becomes more and more irrelevant. What
9951 becomes important is the size of the receiving audience.
9953 Many people subscribe to several mailing lists. These are transported
9954 via SMTP, and are therefore mail. Some people have local news groups
9955 which have only a handful of readers. These are transported via NNTP,
9956 and are therefore news.
9958 The important distinction turns out to be not the transport mechanism,
9959 but whether the messages are @dfn{personal} or @dfn{public}. Many users
9960 then subtly alter the behavior of Gnus according to these two
9963 Some users never get comfortable using the Gnus (ahem) paradigm and wish
9964 that Gnus should grow up and be a male, er, mail reader. It is possible
9965 to whip Gnus into a more mailreaderly being, but, as said before, it's
9966 not easy. People who prefer proper mail readers should try @sc{vm}
9967 instead, which is an excellent, and proper, mail reader.
9969 I don't mean to scare anybody off, but I want to make it clear that you
9970 may be required to learn a new way of thinking about messages. After
9971 you've been subjected to The Gnus Way, you will come to love it. I can
9972 guarantee it. (At least the guy who sold me the Emacs Subliminal
9973 Brain-Washing Functions that I've put into Gnus did guarantee it. You
9974 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
9978 @node Getting Started Reading Mail
9979 @subsection Getting Started Reading Mail
9981 It's quite easy to use Gnus to read your new mail. You just plonk the
9982 mail backend of your choice into @code{gnus-secondary-select-methods},
9983 and things will happen automatically.
9985 For instance, if you want to use @code{nnml} (which is a "one file per
9986 mail" backend), you could put the following in your @file{.gnus} file:
9989 (setq gnus-secondary-select-methods
9990 '((nnml "private")))
9993 Now, the next time you start Gnus, this backend will be queried for new
9994 articles, and it will move all the messages in your spool file to its
9995 directory, which is @code{~/Mail/} by default. The new group that will
9996 be created (@samp{mail.misc}) will be subscribed, and you can read it
9997 like any other group.
9999 You will probably want to split the mail into several groups, though:
10002 (setq nnmail-split-methods
10003 '(("junk" "^From:.*Lars Ingebrigtsen")
10004 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
10008 This will result in three new @code{nnml} mail groups being created:
10009 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
10010 mail that doesn't fit into the first two groups will be placed in the
10013 This should be sufficient for reading mail with Gnus. You might want to
10014 give the other sections in this part of the manual a perusal, though.
10015 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
10018 @node Splitting Mail
10019 @subsection Splitting Mail
10020 @cindex splitting mail
10021 @cindex mail splitting
10023 @vindex nnmail-split-methods
10024 The @code{nnmail-split-methods} variable says how the incoming mail is
10025 to be split into groups.
10028 (setq nnmail-split-methods
10029 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
10030 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
10031 ("mail.other" "")))
10034 This variable is a list of lists, where the first element of each of
10035 these lists is the name of the mail group (they do not have to be called
10036 something beginning with @samp{mail}, by the way), and the second
10037 element is a regular expression used on the header of each mail to
10038 determine if it belongs in this mail group. The first string may
10039 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
10040 insert sub-expressions from the matched text. For instance:
10043 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
10046 The second element can also be a function. In that case, it will be
10047 called narrowed to the headers with the first element of the rule as the
10048 argument. It should return a non-@code{nil} value if it thinks that the
10049 mail belongs in that group.
10051 The last of these groups should always be a general one, and the regular
10052 expression should @emph{always} be @samp{} so that it matches any mails
10053 that haven't been matched by any of the other regexps. (These rules are
10054 processed from the beginning of the alist toward the end. The first
10055 rule to make a match will "win", unless you have crossposting enabled.
10056 In that case, all matching rules will "win".)
10058 If you like to tinker with this yourself, you can set this variable to a
10059 function of your choice. This function will be called without any
10060 arguments in a buffer narrowed to the headers of an incoming mail
10061 message. The function should return a list of group names that it
10062 thinks should carry this mail message.
10064 Note that the mail backends are free to maul the poor, innocent,
10065 incoming headers all they want to. They all add @code{Lines} headers;
10066 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
10067 @code{From<SPACE>} line to something else.
10069 @vindex nnmail-crosspost
10070 The mail backends all support cross-posting. If several regexps match,
10071 the mail will be ``cross-posted'' to all those groups.
10072 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
10073 that no articles are crossposted to the general (@samp{}) group.
10075 @vindex nnmail-crosspost-link-function
10078 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
10079 the crossposted articles. However, not all file systems support hard
10080 links. If that's the case for you, set
10081 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
10082 variable is @code{add-name-to-file} by default.)
10084 @kindex M-x nnmail-split-history
10085 @kindex nnmail-split-history
10086 If you wish to see where the previous mail split put the messages, you
10087 can use the @kbd{M-x nnmail-split-history} command.
10089 Gnus gives you all the opportunity you could possibly want for shooting
10090 yourself in the foot. Let's say you create a group that will contain
10091 all the mail you get from your boss. And then you accidentally
10092 unsubscribe from the group. Gnus will still put all the mail from your
10093 boss in the unsubscribed group, and so, when your boss mails you ``Have
10094 that report ready by Monday or you're fired!'', you'll never see it and,
10095 come Tuesday, you'll still believe that you're gainfully employed while
10096 you really should be out collecting empty bottles to save up for next
10097 month's rent money.
10101 @subsection Mail Sources
10103 Mail can be gotten from many different sources---the mail spool, from a
10104 POP mail server, or from a procmail directory, for instance.
10107 * Mail Source Specifiers:: How to specify what a mail source is.
10108 * Mail Source Customization:: Some variables that influence things.
10109 * Fetching Mail:: Using the mail source specifiers.
10113 @node Mail Source Specifiers
10114 @subsubsection Mail Source Specifiers
10116 @cindex mail server
10119 @cindex mail source
10121 You tell Gnus how to fetch mail by creating a @dfn{mail source
10127 (pop :server "pop3.mailserver.com" :user "myname")
10130 As can be observed, a mail source specifier is a list where the first
10131 element is a @dfn{mail source type}, followed by an arbitrary number of
10132 @dfn{keywords}. Keywords that are not explicitly specified are given
10135 The following mail source types are available:
10139 Get mail from a single file; typically from the mail spool.
10145 The path of the file. Defaults to the value of the @code{MAIL}
10146 environment variable or @file{/usr/mail/spool/user-name}.
10149 An example file mail source:
10152 (file :path "/usr/spool/mail/user-name")
10155 Or using the default path:
10162 Get mail from several files in a directory. This is typically used when
10163 you have procmail split the incoming mail into several files.
10169 The path of the directory where the files are. There is no default
10173 Only files ending with this suffix are used. The default is
10177 Only files that have this predicate return non-@code{nil} are returned.
10178 The default is @code{identity}. This is used as an additional
10179 filter---only files that have the right suffix @emph{and} satisfy this
10180 predicate are considered.
10184 Script run before/after fetching mail.
10188 An example directory mail source:
10191 (directory :path "/home/user-name/procmail-dir/"
10196 Get mail from a POP server.
10202 The name of the POP server. The default is taken from the
10203 @code{MAILHOST} environment variable.
10206 The port number of the POP server. The default is @samp{pop3}.
10209 The user name to give to the POP server. The default is the login
10213 The password to give to the POP server. If not specified, the user is
10217 The program to use to fetch mail from the POP server. This is should be
10218 a @code{format}-like string. Here's an example:
10221 fetchmail %u@@%s -P %p %t
10224 The valid format specifier characters are:
10228 The name of the file the mail is to be moved to. This must always be
10229 included in this string.
10232 The name of the server.
10235 The port number of the server.
10238 The user name to use.
10241 The password to use.
10244 The values used for these specs are taken from the values you give the
10245 corresponding keywords.
10248 A script to be run before fetching the mail. The syntax is the same as
10249 the @code{:program} keyword. This can also be a function to be run.
10252 A script to be run after fetching the mail. The syntax is the same as
10253 the @code{:program} keyword. This can also be a function to be run.
10256 The function to use to fetch mail from the POP server. The function is
10257 called with one parameter---the name of the file where the mail should
10260 @item :authentication
10261 This can be either the symbol @code{password} or the symbol @code{apop}
10262 and says what authentication scheme to use. The default is
10267 If the @code{:program} and @code{:function} keywords aren't specified,
10268 @code{pop3-movemail} will be used.
10270 Here are some examples. Fetch from the default POP server, using the
10271 default user name, and default fetcher:
10277 Fetch from a named server with a named user and password:
10280 (pop :server "my.pop.server"
10281 :user "user-name" :password "secret")
10284 Use @samp{movemail} to move the mail:
10287 (pop :program "movemail po:%u %t %p")
10291 Get mail from a maildir. This is a type of mailbox currently only
10292 supported by qmail, where each file in a special directory contains
10299 The path of the directory where the mails are stored. The default is
10300 @samp{~/Maildir/new}.
10302 If you sometimes look at your mail through a pop3 daemon before fetching
10303 them with Gnus, you may also have to fetch your mails from the
10304 @code{cur} directory inside the maildir, like in the following example.
10308 An example maildir mail source:
10311 (maildir :path "/home/user-name/Maildir/cur")
10317 @node Mail Source Customization
10318 @subsubsection Mail Source Customization
10320 The following is a list of variables that influence how the mail is
10321 fetched. You would normally not need to set or change any of these
10325 @item mail-source-movemail-program
10326 @vindex mail-source-movemail-program
10327 A command to be executed to move mail from the inbox. The default is
10330 This can also be a function. In that case, the function will be
10331 called with two parameters -- the name of the INBOX file, and the file
10334 @item mail-source-movemail-args
10335 @vindex mail-source-movemail-args
10336 Extra arguments to give to the command described above.
10338 @item mail-source-crash-box
10339 @vindex mail-source-crash-box
10340 File where mail will be stored while processing it. The default is
10341 @file{~/.emacs-mail-crash-box}.
10343 @item mail-source-delete-incoming
10344 @vindex mail-source-delete-incoming
10345 If non-@code{nil}, delete incoming files after handling them.
10347 @item mail-source-directory
10348 @vindex mail-source-directory
10349 Directory where files (if any) will be stored. The default is
10350 @file{~/Mail/}. At present, the only thing this is used for is to say
10351 where the incoming files will be stored if the previous variable is
10354 @item mail-source-default-file-modes
10355 @vindex mail-source-default-file-modes
10356 All new mail files will get this file mode. The default is 384.
10361 @node Fetching Mail
10362 @subsubsection Fetching Mail
10364 @vindex mail-sources
10365 @vindex nnmail-spool-file
10366 The way to actually tell Gnus where to get new mail from is to set
10367 @code{mail-sources} to a list of mail source specifiers
10368 (@pxref{Mail Source Specifiers}).
10370 If this variable (and the obsolescent @code{nnmail-spool-file}) is
10371 @code{nil}, the mail backends will never attempt to fetch mail by
10374 If you want to fetch mail both from your local spool as well as a POP
10375 mail server, you'd say something like:
10380 (pop :server "pop3.mail.server"
10381 :password "secret")))
10384 Or, if you don't want to use any of the keyword defaults:
10388 '((file :path "/var/spool/mail/user-name")
10389 (pop :server "pop3.mail.server"
10392 :password "secret")))
10396 When you use a mail backend, Gnus will slurp all your mail from your
10397 inbox and plonk it down in your home directory. Gnus doesn't move any
10398 mail if you're not using a mail backend---you have to do a lot of magic
10399 invocations first. At the time when you have finished drawing the
10400 pentagram, lightened the candles, and sacrificed the goat, you really
10401 shouldn't be too surprised when Gnus moves your mail.
10405 @node Mail Backend Variables
10406 @subsection Mail Backend Variables
10408 These variables are (for the most part) pertinent to all the various
10412 @vindex nnmail-read-incoming-hook
10413 @item nnmail-read-incoming-hook
10414 The mail backends all call this hook after reading new mail. You can
10415 use this hook to notify any mail watch programs, if you want to.
10417 @vindex nnmail-split-hook
10418 @item nnmail-split-hook
10419 @findex article-decode-encoded-words
10420 @findex RFC1522 decoding
10421 @findex RFC2047 decoding
10422 Hook run in the buffer where the mail headers of each message is kept
10423 just before the splitting based on these headers is done. The hook is
10424 free to modify the buffer contents in any way it sees fit---the buffer
10425 is discarded after the splitting has been done, and no changes performed
10426 in the buffer will show up in any files.
10427 @code{gnus-article-decode-encoded-words} is one likely function to add
10430 @vindex nnmail-pre-get-new-mail-hook
10431 @vindex nnmail-post-get-new-mail-hook
10432 @item nnmail-pre-get-new-mail-hook
10433 @itemx nnmail-post-get-new-mail-hook
10434 These are two useful hooks executed when treating new incoming
10435 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
10436 starting to handle the new mail) and
10437 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
10438 is done). Here's and example of using these two hooks to change the
10439 default file modes the new mail files get:
10442 (add-hook 'gnus-pre-get-new-mail-hook
10443 (lambda () (set-default-file-modes 511)))
10445 (add-hook 'gnus-post-get-new-mail-hook
10446 (lambda () (set-default-file-modes 551)))
10449 @item nnmail-use-long-file-names
10450 @vindex nnmail-use-long-file-names
10451 If non-@code{nil}, the mail backends will use long file and directory
10452 names. Groups like @samp{mail.misc} will end up in directories
10453 (assuming use of @code{nnml} backend) or files (assuming use of
10454 @code{nnfolder} backend) like @file{mail.misc}. If it is @code{nil},
10455 the same group will end up in @file{mail/misc}.
10457 @item nnmail-delete-file-function
10458 @vindex nnmail-delete-file-function
10459 @findex delete-file
10460 Function called to delete files. It is @code{delete-file} by default.
10462 @item nnmail-cache-accepted-message-ids
10463 @vindex nnmail-cache-accepted-message-ids
10464 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
10465 the backend (via @code{Gcc}, for instance) into the mail duplication
10466 discovery cache. The default is @code{nil}.
10471 @node Fancy Mail Splitting
10472 @subsection Fancy Mail Splitting
10473 @cindex mail splitting
10474 @cindex fancy mail splitting
10476 @vindex nnmail-split-fancy
10477 @findex nnmail-split-fancy
10478 If the rather simple, standard method for specifying how to split mail
10479 doesn't allow you to do what you want, you can set
10480 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
10481 play with the @code{nnmail-split-fancy} variable.
10483 Let's look at an example value of this variable first:
10486 ;; Messages from the mailer daemon are not crossposted to any of
10487 ;; the ordinary groups. Warnings are put in a separate group
10488 ;; from real errors.
10489 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
10491 ;; Non-error messages are crossposted to all relevant
10492 ;; groups, but we don't crosspost between the group for the
10493 ;; (ding) list and the group for other (ding) related mail.
10494 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
10495 ("subject" "ding" "ding.misc"))
10496 ;; Other mailing lists...
10497 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
10498 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
10500 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
10501 ;; Unmatched mail goes to the catch all group.
10505 This variable has the format of a @dfn{split}. A split is a (possibly)
10506 recursive structure where each split may contain other splits. Here are
10507 the five possible split syntaxes:
10512 @samp{group}: If the split is a string, that will be taken as a group
10513 name. Normal regexp match expansion will be done. See below for
10517 @var{(FIELD VALUE SPLIT)}: If the split is a list, the first element of
10518 which is a string, then store the message as specified by SPLIT, if
10519 header FIELD (a regexp) contains VALUE (also a regexp).
10522 @var{(| SPLIT...)}: If the split is a list, and the first element is
10523 @code{|} (vertical bar), then process each SPLIT until one of them
10524 matches. A SPLIT is said to match if it will cause the mail message to
10525 be stored in one or more groups.
10528 @var{(& SPLIT...)}: If the split is a list, and the first element is
10529 @code{&}, then process all SPLITs in the list.
10532 @code{junk}: If the split is the symbol @code{junk}, then don't save
10533 this message. Use with extreme caution.
10536 @var{(: function arg1 arg2 ...)}: If the split is a list, and the first
10537 element is @code{:}, then the second element will be called as a
10538 function with @var{args} given as arguments. The function should return
10542 @var{(! FUNC SPLIT)}: If the split is a list, and the first element
10543 is @code{!}, then SPLIT will be processed, and FUNC will be called as a
10544 function with the result of SPLIT as argument. FUNC should return a split.
10547 @code{nil}: If the split is @code{nil}, it is ignored.
10551 In these splits, @var{FIELD} must match a complete field name.
10552 @var{VALUE} must match a complete word according to the fundamental mode
10553 syntax table. You can use @code{.*} in the regexps to match partial
10554 field names or words. In other words, all @var{VALUE}'s are wrapped in
10555 @samp{\<} and @samp{\>} pairs.
10557 @vindex nnmail-split-abbrev-alist
10558 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
10559 are expanded as specified by the variable
10560 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
10561 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
10564 @vindex nnmail-split-fancy-syntax-table
10565 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
10566 when all this splitting is performed.
10568 If you want to have Gnus create groups dynamically based on some
10569 information in the headers (i.e., do @code{replace-match}-like
10570 substitutions in the group names), you can say things like:
10573 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
10576 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
10577 will be filed in @samp{mail.debian.foo}.
10579 If the string contains the element @samp{\&}, then the previously
10580 matched string will be substituted. Similarly, the elements @samp{\\1}
10581 up to @samp{\\9} will be substituted with the text matched by the
10582 groupings 1 through 9.
10585 @node Incorporating Old Mail
10586 @subsection Incorporating Old Mail
10588 Most people have lots of old mail stored in various file formats. If
10589 you have set up Gnus to read mail using one of the spiffy Gnus mail
10590 backends, you'll probably wish to have that old mail incorporated into
10593 Doing so can be quite easy.
10595 To take an example: You're reading mail using @code{nnml}
10596 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
10597 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
10598 file filled with important, but old, mail. You want to move it into
10599 your @code{nnml} groups.
10605 Go to the group buffer.
10608 Type `G f' and give the path to the mbox file when prompted to create an
10609 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
10612 Type `SPACE' to enter the newly created group.
10615 Type `M P b' to process-mark all articles in this group's buffer
10616 (@pxref{Setting Process Marks}).
10619 Type `B r' to respool all the process-marked articles, and answer
10620 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
10623 All the mail messages in the mbox file will now also be spread out over
10624 all your @code{nnml} groups. Try entering them and check whether things
10625 have gone without a glitch. If things look ok, you may consider
10626 deleting the mbox file, but I wouldn't do that unless I was absolutely
10627 sure that all the mail has ended up where it should be.
10629 Respooling is also a handy thing to do if you're switching from one mail
10630 backend to another. Just respool all the mail in the old mail groups
10631 using the new mail backend.
10634 @node Expiring Mail
10635 @subsection Expiring Mail
10636 @cindex article expiry
10638 Traditional mail readers have a tendency to remove mail articles when
10639 you mark them as read, in some way. Gnus takes a fundamentally
10640 different approach to mail reading.
10642 Gnus basically considers mail just to be news that has been received in
10643 a rather peculiar manner. It does not think that it has the power to
10644 actually change the mail, or delete any mail messages. If you enter a
10645 mail group, and mark articles as ``read'', or kill them in some other
10646 fashion, the mail articles will still exist on the system. I repeat:
10647 Gnus will not delete your old, read mail. Unless you ask it to, of
10650 To make Gnus get rid of your unwanted mail, you have to mark the
10651 articles as @dfn{expirable}. This does not mean that the articles will
10652 disappear right away, however. In general, a mail article will be
10653 deleted from your system if, 1) it is marked as expirable, AND 2) it is
10654 more than one week old. If you do not mark an article as expirable, it
10655 will remain on your system until hell freezes over. This bears
10656 repeating one more time, with some spurious capitalizations: IF you do
10657 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
10659 @vindex gnus-auto-expirable-newsgroups
10660 You do not have to mark articles as expirable by hand. Groups that
10661 match the regular expression @code{gnus-auto-expirable-newsgroups} will
10662 have all articles that you read marked as expirable automatically. All
10663 articles marked as expirable have an @samp{E} in the first
10664 column in the summary buffer.
10666 By default, if you have auto expiry switched on, Gnus will mark all the
10667 articles you read as expirable, no matter if they were read or unread
10668 before. To avoid having articles marked as read marked as expirable
10669 automatically, you can put something like the following in your
10672 @vindex gnus-mark-article-hook
10674 (remove-hook 'gnus-mark-article-hook
10675 'gnus-summary-mark-read-and-unread-as-read)
10676 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
10679 Note that making a group auto-expirable doesn't mean that all read
10680 articles are expired---only the articles marked as expirable
10681 will be expired. Also note that using the @kbd{d} command won't make
10682 groups expirable---only semi-automatic marking of articles as read will
10683 mark the articles as expirable in auto-expirable groups.
10685 Let's say you subscribe to a couple of mailing lists, and you want the
10686 articles you have read to disappear after a while:
10689 (setq gnus-auto-expirable-newsgroups
10690 "mail.nonsense-list\\|mail.nice-list")
10693 Another way to have auto-expiry happen is to have the element
10694 @code{auto-expire} in the group parameters of the group.
10696 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
10697 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
10698 don't really mix very well.
10700 @vindex nnmail-expiry-wait
10701 The @code{nnmail-expiry-wait} variable supplies the default time an
10702 expirable article has to live. Gnus starts counting days from when the
10703 message @emph{arrived}, not from when it was sent. The default is seven
10706 Gnus also supplies a function that lets you fine-tune how long articles
10707 are to live, based on what group they are in. Let's say you want to
10708 have one month expiry period in the @samp{mail.private} group, a one day
10709 expiry period in the @samp{mail.junk} group, and a six day expiry period
10712 @vindex nnmail-expiry-wait-function
10714 (setq nnmail-expiry-wait-function
10716 (cond ((string= group "mail.private")
10718 ((string= group "mail.junk")
10720 ((string= group "important")
10726 The group names this function is fed are ``unadorned'' group
10727 names---no @samp{nnml:} prefixes and the like.
10729 The @code{nnmail-expiry-wait} variable and
10730 @code{nnmail-expiry-wait-function} function can either be a number (not
10731 necessarily an integer) or one of the symbols @code{immediate} or
10734 You can also use the @code{expiry-wait} group parameter to selectively
10735 change the expiry period (@pxref{Group Parameters}).
10737 @vindex nnmail-keep-last-article
10738 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
10739 expire the final article in a mail newsgroup. This is to make life
10740 easier for procmail users.
10742 @vindex gnus-total-expirable-newsgroups
10743 By the way: That line up there, about Gnus never expiring non-expirable
10744 articles, is a lie. If you put @code{total-expire} in the group
10745 parameters, articles will not be marked as expirable, but all read
10746 articles will be put through the expiry process. Use with extreme
10747 caution. Even more dangerous is the
10748 @code{gnus-total-expirable-newsgroups} variable. All groups that match
10749 this regexp will have all read articles put through the expiry process,
10750 which means that @emph{all} old mail articles in the groups in question
10751 will be deleted after a while. Use with extreme caution, and don't come
10752 crying to me when you discover that the regexp you used matched the
10753 wrong group and all your important mail has disappeared. Be a
10754 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
10757 Most people make most of their mail groups total-expirable, though.
10759 @vindex gnus-inhibit-user-auto-expire
10760 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
10761 commands will not mark an article as expirable, even if the group has
10762 auto-expire turned on.
10766 @subsection Washing Mail
10767 @cindex mail washing
10768 @cindex list server brain damage
10769 @cindex incoming mail treatment
10771 Mailers and list servers are notorious for doing all sorts of really,
10772 really stupid things with mail. ``Hey, RFC822 doesn't explicitly
10773 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
10774 end of all lines passing through our server, so let's do that!!!!1!''
10775 Yes, but RFC822 wasn't designed to be read by morons. Things that were
10776 considered to be self-evident were not discussed. So. Here we are.
10778 Case in point: The German version of Microsoft Exchange adds @samp{AW:
10779 } to the subjects of replies instead of @samp{Re: }. I could pretend to
10780 be shocked and dismayed by this, but I haven't got the energy. It is to
10783 Gnus provides a plethora of functions for washing articles while
10784 displaying them, but it might be nicer to do the filtering before
10785 storing the mail to disc. For that purpose, we have three hooks and
10786 various functions that can be put in these hooks.
10789 @item nnmail-prepare-incoming-hook
10790 @vindex nnmail-prepare-incoming-hook
10791 This hook is called before doing anything with the mail and is meant for
10792 grand, sweeping gestures. It is called in a buffer that contains all
10793 the new, incoming mail. Functions to be used include:
10796 @item nnheader-ms-strip-cr
10797 @findex nnheader-ms-strip-cr
10798 Remove trailing carriage returns from each line. This is default on
10799 Emacs running on MS machines.
10803 @item nnmail-prepare-incoming-header-hook
10804 @vindex nnmail-prepare-incoming-header-hook
10805 This hook is called narrowed to each header. It can be used when
10806 cleaning up the headers. Functions that can be used include:
10809 @item nnmail-remove-leading-whitespace
10810 @findex nnmail-remove-leading-whitespace
10811 Clear leading white space that ``helpful'' listservs have added to the
10812 headers to make them look nice. Aaah.
10814 @item nnmail-remove-list-identifiers
10815 @findex nnmail-remove-list-identifiers
10816 Some list servers add an identifier---for example, @samp{(idm)}---to the
10817 beginning of all @code{Subject} headers. I'm sure that's nice for
10818 people who use stone age mail readers. This function will remove
10819 strings that match the @code{nnmail-list-identifiers} regexp, which can
10820 also be a list of regexp.
10822 For instance, if you want to remove the @samp{(idm)} and the
10823 @samp{nagnagnag} identifiers:
10826 (setq nnmail-list-identifiers
10827 '("(idm)" "nagnagnag"))
10830 @item nnmail-remove-tabs
10831 @findex nnmail-remove-tabs
10832 Translate all @samp{TAB} characters into @samp{SPACE} characters.
10834 @item nnmail-fix-eudora-headers
10835 @findex nnmail-fix-eudora-headers
10837 Eudora produces broken @code{References} headers, but OK
10838 @code{In-Reply-To} headers. This function will get rid of the
10839 @code{References} headers.
10843 @item nnmail-prepare-incoming-message-hook
10844 @vindex nnmail-prepare-incoming-message-hook
10845 This hook is called narrowed to each message. Functions to be used
10849 @item article-de-quoted-unreadable
10850 @findex article-de-quoted-unreadable
10851 Decode Quoted Readable encoding.
10858 @subsection Duplicates
10860 @vindex nnmail-treat-duplicates
10861 @vindex nnmail-message-id-cache-length
10862 @vindex nnmail-message-id-cache-file
10863 @cindex duplicate mails
10864 If you are a member of a couple of mailing lists, you will sometimes
10865 receive two copies of the same mail. This can be quite annoying, so
10866 @code{nnmail} checks for and treats any duplicates it might find. To do
10867 this, it keeps a cache of old @code{Message-ID}s---
10868 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
10869 default. The approximate maximum number of @code{Message-ID}s stored
10870 there is controlled by the @code{nnmail-message-id-cache-length}
10871 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
10872 stored.) If all this sounds scary to you, you can set
10873 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
10874 default), and @code{nnmail} won't delete duplicate mails. Instead it
10875 will insert a warning into the head of the mail saying that it thinks
10876 that this is a duplicate of a different message.
10878 This variable can also be a function. If that's the case, the function
10879 will be called from a buffer narrowed to the message in question with
10880 the @code{Message-ID} as a parameter. The function must return either
10881 @code{nil}, @code{warn}, or @code{delete}.
10883 You can turn this feature off completely by setting the variable to
10886 If you want all the duplicate mails to be put into a special
10887 @dfn{duplicates} group, you could do that using the normal mail split
10891 (setq nnmail-split-fancy
10892 '(| ;; Messages duplicates go to a separate group.
10893 ("gnus-warning" "duplication of message" "duplicate")
10894 ;; Message from daemons, postmaster, and the like to another.
10895 (any mail "mail.misc")
10902 (setq nnmail-split-methods
10903 '(("duplicates" "^Gnus-Warning:")
10908 Here's a neat feature: If you know that the recipient reads her mail
10909 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
10910 @code{delete}, you can send her as many insults as you like, just by
10911 using a @code{Message-ID} of a mail that you know that she's already
10912 received. Think of all the fun! She'll never see any of it! Whee!
10915 @node Not Reading Mail
10916 @subsection Not Reading Mail
10918 If you start using any of the mail backends, they have the annoying
10919 habit of assuming that you want to read mail with them. This might not
10920 be unreasonable, but it might not be what you want.
10922 If you set @code{mail-sources} and @code{nnmail-spool-file} to
10923 @code{nil}, none of the backends will ever attempt to read incoming
10924 mail, which should help.
10926 @vindex nnbabyl-get-new-mail
10927 @vindex nnmbox-get-new-mail
10928 @vindex nnml-get-new-mail
10929 @vindex nnmh-get-new-mail
10930 @vindex nnfolder-get-new-mail
10931 This might be too much, if, for instance, you are reading mail quite
10932 happily with @code{nnml} and just want to peek at some old @sc{rmail}
10933 file you have stashed away with @code{nnbabyl}. All backends have
10934 variables called backend-@code{get-new-mail}. If you want to disable
10935 the @code{nnbabyl} mail reading, you edit the virtual server for the
10936 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
10938 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
10939 narrowed to the article to be saved before saving it when reading
10943 @node Choosing a Mail Backend
10944 @subsection Choosing a Mail Backend
10946 Gnus will read the mail spool when you activate a mail group. The mail
10947 file is first copied to your home directory. What happens after that
10948 depends on what format you want to store your mail in.
10950 There are five different mail backends in the standard Gnus, and more
10951 backends are available separately. The mail backend most people use
10952 (because it is the fastest and most flexible) is @code{nnml}
10953 (@pxref{Mail Spool}).
10956 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
10957 * Rmail Babyl:: Emacs programs use the rmail babyl format.
10958 * Mail Spool:: Store your mail in a private spool?
10959 * MH Spool:: An mhspool-like backend.
10960 * Mail Folders:: Having one file for each group.
10961 * Comparing Mail Backends:: An in-depth looks at pros and cons.
10965 @node Unix Mail Box
10966 @subsubsection Unix Mail Box
10968 @cindex unix mail box
10970 @vindex nnmbox-active-file
10971 @vindex nnmbox-mbox-file
10972 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
10973 mail. @code{nnmbox} will add extra headers to each mail article to say
10974 which group it belongs in.
10976 Virtual server settings:
10979 @item nnmbox-mbox-file
10980 @vindex nnmbox-mbox-file
10981 The name of the mail box in the user's home directory.
10983 @item nnmbox-active-file
10984 @vindex nnmbox-active-file
10985 The name of the active file for the mail box.
10987 @item nnmbox-get-new-mail
10988 @vindex nnmbox-get-new-mail
10989 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
10995 @subsubsection Rmail Babyl
10999 @vindex nnbabyl-active-file
11000 @vindex nnbabyl-mbox-file
11001 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
11002 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
11003 article to say which group it belongs in.
11005 Virtual server settings:
11008 @item nnbabyl-mbox-file
11009 @vindex nnbabyl-mbox-file
11010 The name of the rmail mbox file.
11012 @item nnbabyl-active-file
11013 @vindex nnbabyl-active-file
11014 The name of the active file for the rmail box.
11016 @item nnbabyl-get-new-mail
11017 @vindex nnbabyl-get-new-mail
11018 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
11023 @subsubsection Mail Spool
11025 @cindex mail @sc{nov} spool
11027 The @dfn{nnml} spool mail format isn't compatible with any other known
11028 format. It should be used with some caution.
11030 @vindex nnml-directory
11031 If you use this backend, Gnus will split all incoming mail into files,
11032 one file for each mail, and put the articles into the corresponding
11033 directories under the directory specified by the @code{nnml-directory}
11034 variable. The default value is @file{~/Mail/}.
11036 You do not have to create any directories beforehand; Gnus will take
11039 If you have a strict limit as to how many files you are allowed to store
11040 in your account, you should not use this backend. As each mail gets its
11041 own file, you might very well occupy thousands of inodes within a few
11042 weeks. If this is no problem for you, and it isn't a problem for you
11043 having your friendly systems administrator walking around, madly,
11044 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
11045 know that this is probably the fastest format to use. You do not have
11046 to trudge through a big mbox file just to read your new mail.
11048 @code{nnml} is probably the slowest backend when it comes to article
11049 splitting. It has to create lots of files, and it also generates
11050 @sc{nov} databases for the incoming mails. This makes it the fastest
11051 backend when it comes to reading mail.
11053 Virtual server settings:
11056 @item nnml-directory
11057 @vindex nnml-directory
11058 All @code{nnml} directories will be placed under this directory.
11060 @item nnml-active-file
11061 @vindex nnml-active-file
11062 The active file for the @code{nnml} server.
11064 @item nnml-newsgroups-file
11065 @vindex nnml-newsgroups-file
11066 The @code{nnml} group descriptions file. @xref{Newsgroups File
11069 @item nnml-get-new-mail
11070 @vindex nnml-get-new-mail
11071 If non-@code{nil}, @code{nnml} will read incoming mail.
11073 @item nnml-nov-is-evil
11074 @vindex nnml-nov-is-evil
11075 If non-@code{nil}, this backend will ignore any @sc{nov} files.
11077 @item nnml-nov-file-name
11078 @vindex nnml-nov-file-name
11079 The name of the @sc{nov} files. The default is @file{.overview}.
11081 @item nnml-prepare-save-mail-hook
11082 @vindex nnml-prepare-save-mail-hook
11083 Hook run narrowed to an article before saving.
11087 @findex nnml-generate-nov-databases
11088 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
11089 you can do a complete update by typing @kbd{M-x
11090 nnml-generate-nov-databases}. This command will trawl through the
11091 entire @code{nnml} hierarchy, looking at each and every article, so it
11092 might take a while to complete. A better interface to this
11093 functionality can be found in the server buffer (@pxref{Server
11098 @subsubsection MH Spool
11100 @cindex mh-e mail spool
11102 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
11103 @sc{nov} databases and it doesn't keep an active file. This makes
11104 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
11105 makes it easier to write procmail scripts for.
11107 Virtual server settings:
11110 @item nnmh-directory
11111 @vindex nnmh-directory
11112 All @code{nnmh} directories will be located under this directory.
11114 @item nnmh-get-new-mail
11115 @vindex nnmh-get-new-mail
11116 If non-@code{nil}, @code{nnmh} will read incoming mail.
11119 @vindex nnmh-be-safe
11120 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
11121 sure that the articles in the folder are actually what Gnus thinks they
11122 are. It will check date stamps and stat everything in sight, so
11123 setting this to @code{t} will mean a serious slow-down. If you never
11124 use anything but Gnus to read the @code{nnmh} articles, you do not have
11125 to set this variable to @code{t}.
11130 @subsubsection Mail Folders
11132 @cindex mbox folders
11133 @cindex mail folders
11135 @code{nnfolder} is a backend for storing each mail group in a separate
11136 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
11137 will add extra headers to keep track of article numbers and arrival
11140 Virtual server settings:
11143 @item nnfolder-directory
11144 @vindex nnfolder-directory
11145 All the @code{nnfolder} mail boxes will be stored under this directory.
11147 @item nnfolder-active-file
11148 @vindex nnfolder-active-file
11149 The name of the active file.
11151 @item nnfolder-newsgroups-file
11152 @vindex nnfolder-newsgroups-file
11153 The name of the group descriptions file. @xref{Newsgroups File Format}.
11155 @item nnfolder-get-new-mail
11156 @vindex nnfolder-get-new-mail
11157 If non-@code{nil}, @code{nnfolder} will read incoming mail.
11159 @item nnfolder-save-buffer-hook
11160 @vindex nnfolder-save-buffer-hook
11161 @cindex backup files
11162 Hook run before saving the folders. Note that Emacs does the normal
11163 backup renaming of files even with the @code{nnfolder} buffers. If you
11164 wish to switch this off, you could say something like the following in
11165 your @file{.emacs} file:
11168 (defun turn-off-backup ()
11169 (set (make-local-variable 'backup-inhibited) t))
11171 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
11174 @item nnfolder-delete-mail-hook
11175 @vindex nnfolder-delete-mail-hook
11176 Hook run in a buffer narrowed to the message that is to be deleted.
11177 This function can be used to copy the message to somewhere else, or to
11178 extract some information from it before removing it.
11183 @findex nnfolder-generate-active-file
11184 @kindex M-x nnfolder-generate-active-file
11185 If you have lots of @code{nnfolder}-like files you'd like to read with
11186 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
11187 command to make @code{nnfolder} aware of all likely files in
11188 @code{nnfolder-directory}. This only works if you use long file names,
11191 @node Comparing Mail Backends
11192 @subsubsection Comparing Mail Backends
11194 First, just for terminology, the @dfn{backend} is the common word for a
11195 low-level access method---a transport, if you will, by which something
11196 is acquired. The sense is that one's mail has to come from somewhere,
11197 and so selection of a suitable backend is required in order to get that
11198 mail within spitting distance of Gnus.
11200 The same concept exists for Usenet itself: Though access to articles is
11201 typically done by NNTP these days, once upon a midnight dreary, everyone
11202 in the world got at Usenet by running a reader on the machine where the
11203 articles lay (the machine which today we call an NNTP server), and
11204 access was by the reader stepping into the articles' directory spool
11205 area directly. One can still select between either the @code{nntp} or
11206 @code{nnspool} backends, to select between these methods, if one happens
11207 actually to live on the server (or can see its spool directly, anyway,
11210 The goal in selecting a mail backend is to pick one which
11211 simultaneously represents a suitable way of dealing with the original
11212 format plus leaving mail in a form that is convenient to use in the
11213 future. Here are some high and low points on each:
11218 UNIX systems have historically had a single, very common, and well-
11219 defined format. All messages arrive in a single @dfn{spool file}, and
11220 they are delineated by a line whose regular expression matches
11221 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
11222 to make it clear in this instance that this is not the RFC-specified
11223 @samp{From:} header.) Because Emacs and therefore Gnus emanate
11224 historically from the Unix environment, it is simplest if one does not
11225 mess a great deal with the original mailbox format, so if one chooses
11226 this backend, Gnus' primary activity in getting mail from the real spool
11227 area to Gnus' preferred directory is simply to copy it, with no
11228 (appreciable) format change in the process. It is the ``dumbest'' way
11229 to move mail into availability in the Gnus environment. This makes it
11230 fast to move into place, but slow to parse, when Gnus has to look at
11235 Once upon a time, there was the DEC-10 and DEC-20, running operating
11236 systems called TOPS and related things, and the usual (only?) mail
11237 reading environment was a thing called Babyl. I don't know what format
11238 was used for mail landing on the system, but Babyl had its own internal
11239 format to which mail was converted, primarily involving creating a
11240 spool-file-like entity with a scheme for inserting Babyl-specific
11241 headers and status bits above the top of each message in the file.
11242 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
11243 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
11244 to understand the mail files folks already had in existence. Gnus (and
11245 VM, for that matter) continue to support this format because it's
11246 perceived as having some good qualities in those mailer-specific
11247 headers/status bits stuff. RMAIL itself still exists as well, of
11248 course, and is still maintained by Stallman.
11250 Both of the above forms leave your mail in a single file on your
11251 filesystem, and they must parse that entire file each time you take a
11256 @code{nnml} is the backend which smells the most as though you were
11257 actually operating with an @code{nnspool}-accessed Usenet system. (In
11258 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
11259 lo these years ago.) One's mail is taken from the original spool file,
11260 and is then cut up into individual message files, 1:1. It maintains a
11261 Usenet-style active file (analogous to what one finds in an INN- or
11262 CNews-based news system in (for instance) @file{/var/lib/news/active},
11263 or what is returned via the @samp{NNTP LIST} verb) and also creates
11264 @dfn{overview} files for efficient group entry, as has been defined for
11265 @sc{nntp} servers for some years now. It is slower in mail-splitting,
11266 due to the creation of lots of files, updates to the @code{nnml} active
11267 file, and additions to overview files on a per-message basis, but it is
11268 extremely fast on access because of what amounts to the indexing support
11269 provided by the active file and overviews.
11271 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
11272 resource which defines available places in the filesystem to put new
11273 files. Sysadmins take a dim view of heavy inode occupation within
11274 tight, shared filesystems. But if you live on a personal machine where
11275 the filesystem is your own and space is not at a premium, @code{nnml}
11278 It is also problematic using this backend if you are living in a
11279 FAT16-based Windows world, since much space will be wasted on all these
11284 The Rand MH mail-reading system has been around UNIX systems for a very
11285 long time; it operates by splitting one's spool file of messages into
11286 individual files, but with little or no indexing support -- @code{nnmh}
11287 is considered to be semantically equivalent to ``@code{nnml} without
11288 active file or overviews''. This is arguably the worst choice, because
11289 one gets the slowness of individual file creation married to the
11290 slowness of access parsing when learning what's new in one's groups.
11294 Basically the effetc of @code{nnfolder} is @code{nnmbox} (the first
11295 method described above) on a per-group basis. That is, @code{nnmbox}
11296 itself puts *all* one's mail in one file; @code{nnfolder} provides a
11297 little bit of optimization to this so that each of one's mail groups has
11298 a Unix mail box file. It's faster than @code{nnmbox} because each group
11299 can be parsed separately, and still provides the simple Unix mail box
11300 format requiring minimal effort in moving the mail around. In addition,
11301 it maintains an ``active'' file making it much faster for Gnus to figure
11302 out how many messages there are in each separate group.
11304 If you have groups that are expected to have a massive amount of
11305 messages, @code{nnfolder} is not the best choice, but if you receive
11306 only a moderate amount of mail, @code{nnfolder} is probably the most
11307 friendly mail backend all over.
11313 @node Other Sources
11314 @section Other Sources
11316 Gnus can do more than just read news or mail. The methods described
11317 below allow Gnus to view directories and files as if they were
11321 * Directory Groups:: You can read a directory as if it was a newsgroup.
11322 * Anything Groups:: Dired? Who needs dired?
11323 * Document Groups:: Single files can be the basis of a group.
11324 * SOUP:: Reading @sc{SOUP} packets ``offline''.
11325 * Web Searches:: Creating groups from articles that match a string.
11326 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
11330 @node Directory Groups
11331 @subsection Directory Groups
11333 @cindex directory groups
11335 If you have a directory that has lots of articles in separate files in
11336 it, you might treat it as a newsgroup. The files have to have numerical
11339 This might be an opportune moment to mention @code{ange-ftp} (and its
11340 successor @code{efs}), that most wonderful of all wonderful Emacs
11341 packages. When I wrote @code{nndir}, I didn't think much about it---a
11342 backend to read directories. Big deal.
11344 @code{ange-ftp} changes that picture dramatically. For instance, if you
11345 enter the @code{ange-ftp} file name
11346 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
11347 @code{ange-ftp} or @code{efs} will actually allow you to read this
11348 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
11350 @code{nndir} will use @sc{nov} files if they are present.
11352 @code{nndir} is a ``read-only'' backend---you can't delete or expire
11353 articles with this method. You can use @code{nnmh} or @code{nnml} for
11354 whatever you use @code{nndir} for, so you could switch to any of those
11355 methods if you feel the need to have a non-read-only @code{nndir}.
11358 @node Anything Groups
11359 @subsection Anything Groups
11362 From the @code{nndir} backend (which reads a single spool-like
11363 directory), it's just a hop and a skip to @code{nneething}, which
11364 pretends that any arbitrary directory is a newsgroup. Strange, but
11367 When @code{nneething} is presented with a directory, it will scan this
11368 directory and assign article numbers to each file. When you enter such
11369 a group, @code{nneething} must create ``headers'' that Gnus can use.
11370 After all, Gnus is a newsreader, in case you're
11371 forgetting. @code{nneething} does this in a two-step process. First, it
11372 snoops each file in question. If the file looks like an article (i.e.,
11373 the first few lines look like headers), it will use this as the head.
11374 If this is just some arbitrary file without a head (e.g. a C source
11375 file), @code{nneething} will cobble up a header out of thin air. It
11376 will use file ownership, name and date and do whatever it can with these
11379 All this should happen automatically for you, and you will be presented
11380 with something that looks very much like a newsgroup. Totally like a
11381 newsgroup, to be precise. If you select an article, it will be displayed
11382 in the article buffer, just as usual.
11384 If you select a line that represents a directory, Gnus will pop you into
11385 a new summary buffer for this @code{nneething} group. And so on. You can
11386 traverse the entire disk this way, if you feel like, but remember that
11387 Gnus is not dired, really, and does not intend to be, either.
11389 There are two overall modes to this action---ephemeral or solid. When
11390 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
11391 will not store information on what files you have read, and what files
11392 are new, and so on. If you create a solid @code{nneething} group the
11393 normal way with @kbd{G m}, Gnus will store a mapping table between
11394 article numbers and file names, and you can treat this group like any
11395 other groups. When you activate a solid @code{nneething} group, you will
11396 be told how many unread articles it contains, etc., etc.
11401 @item nneething-map-file-directory
11402 @vindex nneething-map-file-directory
11403 All the mapping files for solid @code{nneething} groups will be stored
11404 in this directory, which defaults to @file{~/.nneething/}.
11406 @item nneething-exclude-files
11407 @vindex nneething-exclude-files
11408 All files that match this regexp will be ignored. Nice to use to exclude
11409 auto-save files and the like, which is what it does by default.
11411 @item nneething-include-files
11412 @vindex nneething-include-files
11413 Regexp saying what files to include in the group. If this variable is
11414 non-@code{nil}, only files matching this regexp will be included.
11416 @item nneething-map-file
11417 @vindex nneething-map-file
11418 Name of the map files.
11422 @node Document Groups
11423 @subsection Document Groups
11425 @cindex documentation group
11428 @code{nndoc} is a cute little thing that will let you read a single file
11429 as a newsgroup. Several files types are supported:
11436 The babyl (rmail) mail box.
11441 The standard Unix mbox file.
11443 @cindex MMDF mail box
11445 The MMDF mail box format.
11448 Several news articles appended into a file.
11451 @cindex rnews batch files
11452 The rnews batch transport format.
11453 @cindex forwarded messages
11456 Forwarded articles.
11459 Netscape mail boxes.
11462 MIME multipart messages.
11464 @item standard-digest
11465 The standard (RFC 1153) digest format.
11468 Non-standard digest format---matches most things, but does it badly.
11471 You can also use the special ``file type'' @code{guess}, which means
11472 that @code{nndoc} will try to guess what file type it is looking at.
11473 @code{digest} means that @code{nndoc} should guess what digest type the
11476 @code{nndoc} will not try to change the file or insert any extra headers into
11477 it---it will simply, like, let you use the file as the basis for a
11478 group. And that's it.
11480 If you have some old archived articles that you want to insert into your
11481 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
11482 that. Say you have an old @file{RMAIL} file with mail that you now want
11483 to split into your new @code{nnml} groups. You look at that file using
11484 @code{nndoc} (using the @kbd{G f} command in the group buffer
11485 (@pxref{Foreign Groups})), set the process mark on all the articles in
11486 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
11487 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
11488 file is now also stored in lots of @code{nnml} directories, and you can
11489 delete that pesky @file{RMAIL} file. If you have the guts!
11491 Virtual server variables:
11494 @item nndoc-article-type
11495 @vindex nndoc-article-type
11496 This should be one of @code{mbox}, @code{babyl}, @code{digest},
11497 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
11498 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
11499 @code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}.
11501 @item nndoc-post-type
11502 @vindex nndoc-post-type
11503 This variable says whether Gnus is to consider the group a news group or
11504 a mail group. There are two valid values: @code{mail} (the default)
11509 * Document Server Internals:: How to add your own document types.
11513 @node Document Server Internals
11514 @subsubsection Document Server Internals
11516 Adding new document types to be recognized by @code{nndoc} isn't
11517 difficult. You just have to whip up a definition of what the document
11518 looks like, write a predicate function to recognize that document type,
11519 and then hook into @code{nndoc}.
11521 First, here's an example document type definition:
11525 (article-begin . "^\^A\^A\^A\^A\n")
11526 (body-end . "^\^A\^A\^A\^A\n"))
11529 The definition is simply a unique @dfn{name} followed by a series of
11530 regexp pseudo-variable settings. Below are the possible
11531 variables---don't be daunted by the number of variables; most document
11532 types can be defined with very few settings:
11535 @item first-article
11536 If present, @code{nndoc} will skip past all text until it finds
11537 something that match this regexp. All text before this will be
11540 @item article-begin
11541 This setting has to be present in all document type definitions. It
11542 says what the beginning of each article looks like.
11544 @item head-begin-function
11545 If present, this should be a function that moves point to the head of
11548 @item nndoc-head-begin
11549 If present, this should be a regexp that matches the head of the
11552 @item nndoc-head-end
11553 This should match the end of the head of the article. It defaults to
11554 @samp{^$}---the empty line.
11556 @item body-begin-function
11557 If present, this function should move point to the beginning of the body
11561 This should match the beginning of the body of the article. It defaults
11564 @item body-end-function
11565 If present, this function should move point to the end of the body of
11569 If present, this should match the end of the body of the article.
11572 If present, this should match the end of the file. All text after this
11573 regexp will be totally ignored.
11577 So, using these variables @code{nndoc} is able to dissect a document
11578 file into a series of articles, each with a head and a body. However, a
11579 few more variables are needed since not all document types are all that
11580 news-like---variables needed to transform the head or the body into
11581 something that's palatable for Gnus:
11584 @item prepare-body-function
11585 If present, this function will be called when requesting an article. It
11586 will be called with point at the start of the body, and is useful if the
11587 document has encoded some parts of its contents.
11589 @item article-transform-function
11590 If present, this function is called when requesting an article. It's
11591 meant to be used for more wide-ranging transformation of both head and
11592 body of the article.
11594 @item generate-head-function
11595 If present, this function is called to generate a head that Gnus can
11596 understand. It is called with the article number as a parameter, and is
11597 expected to generate a nice head for the article in question. It is
11598 called when requesting the headers of all articles.
11602 Let's look at the most complicated example I can come up with---standard
11607 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
11608 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
11609 (prepare-body-function . nndoc-unquote-dashes)
11610 (body-end-function . nndoc-digest-body-end)
11611 (head-end . "^ ?$")
11612 (body-begin . "^ ?\n")
11613 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
11614 (subtype digest guess))
11617 We see that all text before a 70-width line of dashes is ignored; all
11618 text after a line that starts with that @samp{^End of} is also ignored;
11619 each article begins with a 30-width line of dashes; the line separating
11620 the head from the body may contain a single space; and that the body is
11621 run through @code{nndoc-unquote-dashes} before being delivered.
11623 To hook your own document definition into @code{nndoc}, use the
11624 @code{nndoc-add-type} function. It takes two parameters---the first is
11625 the definition itself and the second (optional) parameter says where in
11626 the document type definition alist to put this definition. The alist is
11627 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
11628 is of @code{mmdf} type, and so on. These type predicates should return
11629 @code{nil} if the document is not of the correct type; @code{t} if it is
11630 of the correct type; and a number if the document might be of the
11631 correct type. A high number means high probability; a low number means
11632 low probability with @samp{0} being the lowest valid number.
11640 In the PC world people often talk about ``offline'' newsreaders. These
11641 are thingies that are combined reader/news transport monstrosities.
11642 With built-in modem programs. Yecchh!
11644 Of course, us Unix Weenie types of human beans use things like
11645 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
11646 transport things like Ghod intended. And then we just use normal
11649 However, it can sometimes be convenient to do something a that's a bit
11650 easier on the brain if you have a very slow modem, and you're not really
11651 that interested in doing things properly.
11653 A file format called @sc{soup} has been developed for transporting news
11654 and mail from servers to home machines and back again. It can be a bit
11657 First some terminology:
11662 This is the machine that is connected to the outside world and where you
11663 get news and/or mail from.
11666 This is the machine that you want to do the actual reading and responding
11667 on. It is typically not connected to the rest of the world in any way.
11670 Something that contains messages and/or commands. There are two kinds
11674 @item message packets
11675 These are packets made at the server, and typically contain lots of
11676 messages for you to read. These are called @file{SoupoutX.tgz} by
11677 default, where @var{X} is a number.
11679 @item response packets
11680 These are packets made at the home machine, and typically contains
11681 replies that you've written. These are called @file{SoupinX.tgz} by
11682 default, where @var{X} is a number.
11692 You log in on the server and create a @sc{soup} packet. You can either
11693 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
11694 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
11695 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
11698 You transfer the packet home. Rail, boat, car or modem will do fine.
11701 You put the packet in your home directory.
11704 You fire up Gnus on your home machine using the @code{nnsoup} backend as
11705 the native or secondary server.
11708 You read articles and mail and answer and followup to the things you
11709 want (@pxref{SOUP Replies}).
11712 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
11716 You transfer this packet to the server.
11719 You use Gnus to mail this packet out with the @kbd{G s s} command.
11722 You then repeat until you die.
11726 So you basically have a bipartite system---you use @code{nnsoup} for
11727 reading and Gnus for packing/sending these @sc{soup} packets.
11730 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
11731 * SOUP Groups:: A backend for reading @sc{soup} packets.
11732 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
11736 @node SOUP Commands
11737 @subsubsection SOUP Commands
11739 These are commands for creating and manipulating @sc{soup} packets.
11743 @kindex G s b (Group)
11744 @findex gnus-group-brew-soup
11745 Pack all unread articles in the current group
11746 (@code{gnus-group-brew-soup}). This command understands the
11747 process/prefix convention.
11750 @kindex G s w (Group)
11751 @findex gnus-soup-save-areas
11752 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
11755 @kindex G s s (Group)
11756 @findex gnus-soup-send-replies
11757 Send all replies from the replies packet
11758 (@code{gnus-soup-send-replies}).
11761 @kindex G s p (Group)
11762 @findex gnus-soup-pack-packet
11763 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
11766 @kindex G s r (Group)
11767 @findex nnsoup-pack-replies
11768 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
11771 @kindex O s (Summary)
11772 @findex gnus-soup-add-article
11773 This summary-mode command adds the current article to a @sc{soup} packet
11774 (@code{gnus-soup-add-article}). It understands the process/prefix
11775 convention (@pxref{Process/Prefix}).
11780 There are a few variables to customize where Gnus will put all these
11785 @item gnus-soup-directory
11786 @vindex gnus-soup-directory
11787 Directory where Gnus will save intermediate files while composing
11788 @sc{soup} packets. The default is @file{~/SoupBrew/}.
11790 @item gnus-soup-replies-directory
11791 @vindex gnus-soup-replies-directory
11792 This is what Gnus will use as a temporary directory while sending our
11793 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
11795 @item gnus-soup-prefix-file
11796 @vindex gnus-soup-prefix-file
11797 Name of the file where Gnus stores the last used prefix. The default is
11798 @samp{gnus-prefix}.
11800 @item gnus-soup-packer
11801 @vindex gnus-soup-packer
11802 A format string command for packing a @sc{soup} packet. The default is
11803 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
11805 @item gnus-soup-unpacker
11806 @vindex gnus-soup-unpacker
11807 Format string command for unpacking a @sc{soup} packet. The default is
11808 @samp{gunzip -c %s | tar xvf -}.
11810 @item gnus-soup-packet-directory
11811 @vindex gnus-soup-packet-directory
11812 Where Gnus will look for reply packets. The default is @file{~/}.
11814 @item gnus-soup-packet-regexp
11815 @vindex gnus-soup-packet-regexp
11816 Regular expression matching @sc{soup} reply packets in
11817 @code{gnus-soup-packet-directory}.
11823 @subsubsection @sc{soup} Groups
11826 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
11827 read incoming packets, unpack them, and put them in a directory where
11828 you can read them at leisure.
11830 These are the variables you can use to customize its behavior:
11834 @item nnsoup-tmp-directory
11835 @vindex nnsoup-tmp-directory
11836 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
11837 directory. (@file{/tmp/} by default.)
11839 @item nnsoup-directory
11840 @vindex nnsoup-directory
11841 @code{nnsoup} then moves each message and index file to this directory.
11842 The default is @file{~/SOUP/}.
11844 @item nnsoup-replies-directory
11845 @vindex nnsoup-replies-directory
11846 All replies will be stored in this directory before being packed into a
11847 reply packet. The default is @file{~/SOUP/replies/"}.
11849 @item nnsoup-replies-format-type
11850 @vindex nnsoup-replies-format-type
11851 The @sc{soup} format of the replies packets. The default is @samp{?n}
11852 (rnews), and I don't think you should touch that variable. I probably
11853 shouldn't even have documented it. Drats! Too late!
11855 @item nnsoup-replies-index-type
11856 @vindex nnsoup-replies-index-type
11857 The index type of the replies packet. The default is @samp{?n}, which
11858 means ``none''. Don't fiddle with this one either!
11860 @item nnsoup-active-file
11861 @vindex nnsoup-active-file
11862 Where @code{nnsoup} stores lots of information. This is not an ``active
11863 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
11864 this file or mess it up in any way, you're dead. The default is
11865 @file{~/SOUP/active}.
11867 @item nnsoup-packer
11868 @vindex nnsoup-packer
11869 Format string command for packing a reply @sc{soup} packet. The default
11870 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
11872 @item nnsoup-unpacker
11873 @vindex nnsoup-unpacker
11874 Format string command for unpacking incoming @sc{soup} packets. The
11875 default is @samp{gunzip -c %s | tar xvf -}.
11877 @item nnsoup-packet-directory
11878 @vindex nnsoup-packet-directory
11879 Where @code{nnsoup} will look for incoming packets. The default is
11882 @item nnsoup-packet-regexp
11883 @vindex nnsoup-packet-regexp
11884 Regular expression matching incoming @sc{soup} packets. The default is
11887 @item nnsoup-always-save
11888 @vindex nnsoup-always-save
11889 If non-@code{nil}, save the replies buffer after each posted message.
11895 @subsubsection SOUP Replies
11897 Just using @code{nnsoup} won't mean that your postings and mailings end
11898 up in @sc{soup} reply packets automagically. You have to work a bit
11899 more for that to happen.
11901 @findex nnsoup-set-variables
11902 The @code{nnsoup-set-variables} command will set the appropriate
11903 variables to ensure that all your followups and replies end up in the
11906 In specific, this is what it does:
11909 (setq message-send-news-function 'nnsoup-request-post)
11910 (setq message-send-mail-function 'nnsoup-request-mail)
11913 And that's it, really. If you only want news to go into the @sc{soup}
11914 system you just use the first line. If you only want mail to be
11915 @sc{soup}ed you use the second.
11919 @subsection Web Searches
11923 @cindex InReference
11924 @cindex Usenet searches
11925 @cindex searching the Usenet
11927 It's, like, too neat to search the Usenet for articles that match a
11928 string, but it, like, totally @emph{sucks}, like, totally, to use one of
11929 those, like, Web browsers, and you, like, have to, rilly, like, look at
11930 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
11931 searches without having to use a browser.
11933 The @code{nnweb} backend allows an easy interface to the mighty search
11934 engine. You create an @code{nnweb} group, enter a search pattern, and
11935 then enter the group and read the articles like you would any normal
11936 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
11937 Groups}) will do this in an easy-to-use fashion.
11939 @code{nnweb} groups don't really lend themselves to being solid
11940 groups---they have a very fleeting idea of article numbers. In fact,
11941 each time you enter an @code{nnweb} group (not even changing the search
11942 pattern), you are likely to get the articles ordered in a different
11943 manner. Not even using duplicate suppression (@pxref{Duplicate
11944 Suppression}) will help, since @code{nnweb} doesn't even know the
11945 @code{Message-ID} of the articles before reading them using some search
11946 engines (DejaNews, for instance). The only possible way to keep track
11947 of which articles you've read is by scoring on the @code{Date}
11948 header---mark all articles posted before the last date you read the
11951 If the search engine changes its output substantially, @code{nnweb}
11952 won't be able to parse it and will fail. One could hardly fault the Web
11953 providers if they were to do this---their @emph{raison d'être} is to
11954 make money off of advertisements, not to provide services to the
11955 community. Since @code{nnweb} washes the ads off all the articles, one
11956 might think that the providers might be somewhat miffed. We'll see.
11958 You must have the @code{url} and @code{w3} package installed to be able
11959 to use @code{nnweb}.
11961 Virtual server variables:
11966 What search engine type is being used. The currently supported types
11967 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
11971 @vindex nnweb-search
11972 The search string to feed to the search engine.
11974 @item nnweb-max-hits
11975 @vindex nnweb-max-hits
11976 Advisory maximum number of hits per search to display. The default is
11979 @item nnweb-type-definition
11980 @vindex nnweb-type-definition
11981 Type-to-definition alist. This alist says what @code{nnweb} should do
11982 with the various search engine types. The following elements must be
11987 Function to decode the article and provide something that Gnus
11991 Function to create an article number to message header and URL alist.
11994 Function to send the search string to the search engine.
11997 The address the aforementioned function should send the search string
12001 Format string URL to fetch an article by @code{Message-ID}.
12008 @node Mail-To-News Gateways
12009 @subsection Mail-To-News Gateways
12010 @cindex mail-to-news gateways
12013 If your local @code{nntp} server doesn't allow posting, for some reason
12014 or other, you can post using one of the numerous mail-to-news gateways.
12015 The @code{nngateway} backend provides the interface.
12017 Note that you can't read anything from this backend---it can only be
12023 @item nngateway-address
12024 @vindex nngateway-address
12025 This is the address of the mail-to-news gateway.
12027 @item nngateway-header-transformation
12028 @vindex nngateway-header-transformation
12029 News headers often have to be transformed in some odd way or other
12030 for the mail-to-news gateway to accept it. This variable says what
12031 transformation should be called, and defaults to
12032 @code{nngateway-simple-header-transformation}. The function is called
12033 narrowed to the headers to be transformed and with one parameter---the
12036 This default function just inserts a new @code{To} header based on the
12037 @code{Newsgroups} header and the gateway address.
12038 For instance, an article with this @code{Newsgroups} header:
12041 Newsgroups: alt.religion.emacs
12044 will get this @code{From} header inserted:
12047 To: alt-religion-emacs@@GATEWAY
12050 The following pre-defined functions exist:
12052 @findex nngateway-simple-header-transformation
12055 @item nngateway-simple-header-transformation
12056 Creates a @code{To} header that looks like
12057 @var{newsgroup}@@@code{nngateway-address}.
12059 @findex nngateway-mail2news-header-transformation
12061 @item nngateway-mail2news-header-transformation
12062 Creates a @code{To} header that looks like
12063 @code{nngateway-address}.
12068 (setq gnus-post-method
12069 '(nngateway "mail2news@@replay.com"
12070 (nngateway-header-transformation
12071 nngateway-mail2news-header-transformation)))
12079 So, to use this, simply say something like:
12082 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
12086 @node Combined Groups
12087 @section Combined Groups
12089 Gnus allows combining a mixture of all the other group types into bigger
12093 * Virtual Groups:: Combining articles from many groups.
12094 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
12098 @node Virtual Groups
12099 @subsection Virtual Groups
12101 @cindex virtual groups
12102 @cindex merging groups
12104 An @dfn{nnvirtual group} is really nothing more than a collection of
12107 For instance, if you are tired of reading many small groups, you can
12108 put them all in one big group, and then grow tired of reading one
12109 big, unwieldy group. The joys of computing!
12111 You specify @code{nnvirtual} as the method. The address should be a
12112 regexp to match component groups.
12114 All marks in the virtual group will stick to the articles in the
12115 component groups. So if you tick an article in a virtual group, the
12116 article will also be ticked in the component group from whence it came.
12117 (And vice versa---marks from the component groups will also be shown in
12118 the virtual group.)
12120 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
12121 newsgroups into one, big, happy newsgroup:
12124 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
12127 The component groups can be native or foreign; everything should work
12128 smoothly, but if your computer explodes, it was probably my fault.
12130 Collecting the same group from several servers might actually be a good
12131 idea if users have set the Distribution header to limit distribution.
12132 If you would like to read @samp{soc.motss} both from a server in Japan
12133 and a server in Norway, you could use the following as the group regexp:
12136 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
12139 (Remember, though, that if you're creating the group with @kbd{G m}, you
12140 shouldn't double the backslashes, and you should leave off the quote
12141 characters at the beginning and the end of the string.)
12143 This should work kinda smoothly---all articles from both groups should
12144 end up in this one, and there should be no duplicates. Threading (and
12145 the rest) will still work as usual, but there might be problems with the
12146 sequence of articles. Sorting on date might be an option here
12147 (@pxref{Selecting a Group}).
12149 One limitation, however---all groups included in a virtual
12150 group have to be alive (i.e., subscribed or unsubscribed). Killed or
12151 zombie groups can't be component groups for @code{nnvirtual} groups.
12153 @vindex nnvirtual-always-rescan
12154 If the @code{nnvirtual-always-rescan} is non-@code{nil},
12155 @code{nnvirtual} will always scan groups for unread articles when
12156 entering a virtual group. If this variable is @code{nil} (which is the
12157 default) and you read articles in a component group after the virtual
12158 group has been activated, the read articles from the component group
12159 will show up when you enter the virtual group. You'll also see this
12160 effect if you have two virtual groups that have a component group in
12161 common. If that's the case, you should set this variable to @code{t}.
12162 Or you can just tap @code{M-g} on the virtual group every time before
12163 you enter it---it'll have much the same effect.
12165 @code{nnvirtual} can have both mail and news groups as component groups.
12166 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
12167 has to ask the backend of the component group the article comes from
12168 whether it is a news or mail backend. However, when you do a @kbd{^},
12169 there is typically no sure way for the component backend to know this,
12170 and in that case @code{nnvirtual} tells Gnus that the article came from a
12171 not-news backend. (Just to be on the safe side.)
12173 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
12174 line from the article you respond to in these cases.
12178 @node Kibozed Groups
12179 @subsection Kibozed Groups
12183 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
12184 the news feed''. @code{nnkiboze} is a backend that will do this for
12185 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
12186 with useless requests! Oh happiness!
12188 @kindex G k (Group)
12189 To create a kibozed group, use the @kbd{G k} command in the group
12192 The address field of the @code{nnkiboze} method is, as with
12193 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
12194 @code{nnkiboze} group. That's where most similarities between @code{nnkiboze}
12195 and @code{nnvirtual} end.
12197 In addition to this regexp detailing component groups, an @code{nnkiboze} group
12198 must have a score file to say what articles are to be included in
12199 the group (@pxref{Scoring}).
12201 @kindex M-x nnkiboze-generate-groups
12202 @findex nnkiboze-generate-groups
12203 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
12204 @code{nnkiboze} groups you want to have. This command will take time. Lots of
12205 time. Oodles and oodles of time. Gnus has to fetch the headers from
12206 all the articles in all the component groups and run them through the
12207 scoring process to determine if there are any articles in the groups
12208 that are to be part of the @code{nnkiboze} groups.
12210 Please limit the number of component groups by using restrictive
12211 regexps. Otherwise your sysadmin may become annoyed with you, and the
12212 @sc{nntp} site may throw you off and never let you back in again.
12213 Stranger things have happened.
12215 @code{nnkiboze} component groups do not have to be alive---they can be dead,
12216 and they can be foreign. No restrictions.
12218 @vindex nnkiboze-directory
12219 The generation of an @code{nnkiboze} group means writing two files in
12220 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
12221 contains the @sc{nov} header lines for all the articles in the group,
12222 and the other is an additional @file{.newsrc} file to store information
12223 on what groups have been searched through to find component articles.
12225 Articles marked as read in the @code{nnkiboze} group will have
12226 their @sc{nov} lines removed from the @sc{nov} file.
12229 @node Gnus Unplugged
12230 @section Gnus Unplugged
12235 @cindex Gnus Unplugged
12237 In olden times (ca. February '88), people used to run their newsreaders
12238 on big machines with permanent connections to the net. News transport
12239 was dealt with by news servers, and all the newsreaders had to do was to
12240 read news. Believe it or not.
12242 Nowadays most people read news and mail at home, and use some sort of
12243 modem to connect to the net. To avoid running up huge phone bills, it
12244 would be nice to have a way to slurp down all the news and mail, hang up
12245 the phone, read for several hours, and then upload any responses you
12246 have to make. And then you repeat the procedure.
12248 Of course, you can use news servers for doing this as well. I've used
12249 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
12250 for some years, but doing that's a bore. Moving the news server
12251 functionality up to the newsreader makes sense if you're the only person
12252 reading news on a machine.
12254 Using Gnus as an ``offline'' newsreader is quite simple.
12258 First, set up Gnus as you would do if you were running it on a machine
12259 that has full connection to the net. Go ahead. I'll still be waiting
12263 Then, put the following magical incantation at the end of your
12264 @file{.gnus.el} file:
12271 That's it. Gnus is now an ``offline'' newsreader.
12273 Of course, to use it as such, you have to learn a few new commands.
12276 * Agent Basics:: How it all is supposed to work.
12277 * Agent Categories:: How to tell the Gnus Agent what to download.
12278 * Agent Commands:: New commands for all the buffers.
12279 * Agent Expiry:: How to make old articles go away.
12280 * Outgoing Messages:: What happens when you post/mail something?
12281 * Agent Variables:: Customizing is fun.
12282 * Example Setup:: An example @file{.gnus.el} file for offline people.
12283 * Batching Agents:: How to fetch news from a @code{cron} job.
12284 * Agent Caveats:: What you think it'll do and what it does.
12289 @subsection Agent Basics
12291 First, let's get some terminology out of the way.
12293 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
12294 connection to the net (and notified the Agent that this is the case).
12295 When the connection to the net is up again (and Gnus knows this), the
12296 Agent is @dfn{plugged}.
12298 The @dfn{local} machine is the one you're running on, and which isn't
12299 connected to the net continuously.
12301 @dfn{Downloading} means fetching things from the net to your local
12302 machine. @dfn{Uploading} is doing the opposite.
12304 Let's take a typical Gnus session using the Agent.
12309 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
12310 Agent in a disconnected state. You can read all the news that you have
12311 already fetched while in this mode.
12314 You then decide to see whether any new news has arrived. You connect
12315 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
12316 to make Gnus become @dfn{plugged}.
12319 You can then read the new news immediately, or you can download the news
12320 onto your local machine. If you want to do the latter, you press @kbd{J
12321 s} to fetch all the eligible articles in all the groups. (To let Gnus
12322 know which articles you want to download, @pxref{Agent Categories}.)
12325 After fetching the articles, you press @kbd{J j} to make Gnus become
12326 unplugged again, and you shut down the PPP thing (or whatever). And
12327 then you read the news offline.
12330 And then you go to step 2.
12333 Here are some things you should do the first time (or so) that you use
12339 Decide which servers should be covered by the Agent. If you have a mail
12340 backend, it would probably be nonsensical to have it covered by the
12341 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
12342 @kbd{J a} the server (or servers) that you wish to have covered by the
12343 Agent (@pxref{Server Agent Commands}). This will typically be only the
12344 primary select method, which is listed on the bottom in the buffer.
12347 Decide on download policy. @xref{Agent Categories}.
12354 @node Agent Categories
12355 @subsection Agent Categories
12357 One of the main reasons to integrate the news transport layer into the
12358 newsreader is to allow greater control over what articles to download.
12359 There's not much point in downloading huge amounts of articles, just to
12360 find out that you're not interested in reading any of them. It's better
12361 to be somewhat more conservative in choosing what to download, and then
12362 mark the articles for downloading manually if it should turn out that
12363 you're interested in the articles anyway.
12365 The main way to control what is to be downloaded is to create a
12366 @dfn{category} and then assign some (or all) groups to this category.
12367 Groups that do not belong in any other category belong to the
12368 @code{default} category. Gnus has its own buffer for creating and
12369 managing categories.
12372 * Category Syntax:: What a category looks like.
12373 * The Category Buffer:: A buffer for maintaining categories.
12374 * Category Variables:: Customize'r'Us.
12378 @node Category Syntax
12379 @subsubsection Category Syntax
12381 A category consists of two things.
12385 A predicate which (generally) gives a rough outline of which articles
12386 are eligible for downloading; and
12389 a score rule which (generally) gives you a finer granularity when
12390 deciding what articles to download. (Note that this @dfn{download
12391 score} is not necessarily related to normal scores.)
12394 A predicate in its simplest form can be a single predicate such as
12395 @code{true} or @code{false}. These two will download every available
12396 article or nothing respectively. In the case of these two special
12397 predicates an additional score rule is superfluous.
12399 Predicates of @code{high} or @code{low} download articles in respect of
12400 their scores in relationship to @code{gnus-agent-high-score} and
12401 @code{gnus-agent-low-score} as descibed below.
12403 To gain even finer control of what is to be regarded eligible for
12404 download a predicate can consist of a number of predicates with logical
12405 operators sprinkled in between.
12407 Perhaps some examples are in order.
12409 Here's a simple predicate. (It's the default predicate, in fact, used
12410 for all groups that don't belong to any other category.)
12416 Quite simple, eh? This predicate is true if and only if the article is
12417 short (for some value of ``short'').
12419 Here's a more complex predicate:
12428 This means that an article should be downloaded if it has a high score,
12429 or if the score is not low and the article is not long. You get the
12432 The available logical operators are @code{or}, @code{and} and
12433 @code{not}. (If you prefer, you can use the more ``C''-ish operators
12434 @samp{|}, @code{&} and @code{!} instead.)
12436 The following predicates are pre-defined, but if none of these fit what
12437 you want to do, you can write your own.
12441 True iff the article is shorter than @code{gnus-agent-short-article}
12442 lines; default 100.
12445 True iff the article is longer than @code{gnus-agent-long-article}
12446 lines; default 200.
12449 True iff the article has a download score less than
12450 @code{gnus-agent-low-score}; default 0.
12453 True iff the article has a download score greater than
12454 @code{gnus-agent-high-score}; default 0.
12457 True iff the Gnus Agent guesses that the article is spam. The
12458 heuristics may change over time, but at present it just computes a
12459 checksum and sees whether articles match.
12468 If you want to create your own predicate function, here's what you have
12469 to know: The functions are called with no parameters, but the
12470 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
12473 For example, you could decide that you don't want to download articles
12474 that were posted more than a certain number of days ago (e.g. posted
12475 more than @code{gnus-agent-expire-days} ago) you might write a function
12476 something along the lines of the following:
12479 (defun my-article-old-p ()
12480 "Say whether an article is old."
12481 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
12482 (- (time-to-days (current-time)) gnus-agent-expire-days)))
12485 with the predicate then defined as:
12488 (not my-article-old-p)
12491 or you could append your predicate to the predefined
12492 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
12493 wherever. (Note: this would have to be at a point *after*
12494 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
12497 (defvar gnus-category-predicate-alist
12498 (append gnus-category-predicate-alist
12499 '((old . my-article-old-p))))
12502 and simply specify your predicate as:
12508 If/when using something like the above, be aware that there are many
12509 misconfigured systems/mailers out there and so an article's date is not
12510 always a reliable indication of when it was posted. Hell, some people
12511 just don't give a damm.
12514 The above predicates apply to *all* the groups which belong to the
12515 category. However, if you wish to have a specific predicate for an
12516 individual group within a category, or you're just too lazy to set up a
12517 new category, you can enter a group's individual predicate in it's group
12518 parameters like so:
12521 (agent-predicate . short)
12524 This is the group parameter equivalent of the agent category
12525 default. Note that when specifying a single word predicate like this,
12526 the @code{agent-predicate} specification must be in dotted pair
12529 The equivalent of the longer example from above would be:
12532 (agent-predicate or high (and (not low) (not long)))
12535 The outer parenthesis required in the category specification are not
12536 entered here as, not being in dotted pair notation, the value of the
12537 predicate is assumed to be a list.
12540 Now, the syntax of the download score is the same as the syntax of
12541 normal score files, except that all elements that require actually
12542 seeing the article itself are verboten. This means that only the
12543 following headers can be scored on: @code{Subject}, @code{From},
12544 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
12545 @code{Lines}, and @code{Xref}.
12547 As with predicates, the specification of the @code{download score rule}
12548 to use in respect of a group can be in either the category definition if
12549 it's to be applicable to all groups in therein, or a group's parameters
12550 if it's to be specific to that group.
12552 In both of these places the @code{download score rule} can take one of
12559 This has the same syntax as a normal gnus score file except only a
12560 subset of scoring keywords are available as mentioned above.
12566 Category specification
12570 ("Lars Ingebrigtsen" 1000000 nil s))
12576 Group Parameter specification
12579 (agent-score ("from"
12580 ("Lars Ingebrigtsen" 1000000 nil s))
12585 Again, note the omission of the outermost parenthesis here.
12591 These score files must *only* contain the permitted scoring keywords
12598 Category specification
12601 ("~/News/agent.SCORE")
12607 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
12611 Group Parameter specification
12614 (agent-score "~/News/agent.SCORE")
12617 Additional score files can be specified as above. Need I say anything
12622 Use @code{normal} score files
12624 If you dont want to maintain two sets of scoring rules for a group, and
12625 your desired @code{downloading} criteria for a group are the same as your
12626 @code{reading} criteria then you can tell the agent to refer to your
12627 @code{normal} score files when deciding what to download.
12629 These directives in either the category definition or a group's
12630 parameters will cause the agent to read in all the applicable score
12631 files for a group, *filtering out* those those sections that do not
12632 relate to one of the permitted subset of scoring keywords.
12636 Category Specification
12643 Group Parameter specification
12646 (agent-score . file)
12651 @node The Category Buffer
12652 @subsubsection The Category Buffer
12654 You'd normally do all category maintenance from the category buffer.
12655 When you enter it for the first time (with the @kbd{J c} command from
12656 the group buffer), you'll only see the @code{default} category.
12658 The following commands are available in this buffer:
12662 @kindex q (Category)
12663 @findex gnus-category-exit
12664 Return to the group buffer (@code{gnus-category-exit}).
12667 @kindex k (Category)
12668 @findex gnus-category-kill
12669 Kill the current category (@code{gnus-category-kill}).
12672 @kindex c (Category)
12673 @findex gnus-category-copy
12674 Copy the current category (@code{gnus-category-copy}).
12677 @kindex a (Category)
12678 @findex gnus-category-add
12679 Add a new category (@code{gnus-category-add}).
12682 @kindex p (Category)
12683 @findex gnus-category-edit-predicate
12684 Edit the predicate of the current category
12685 (@code{gnus-category-edit-predicate}).
12688 @kindex g (Category)
12689 @findex gnus-category-edit-groups
12690 Edit the list of groups belonging to the current category
12691 (@code{gnus-category-edit-groups}).
12694 @kindex s (Category)
12695 @findex gnus-category-edit-score
12696 Edit the download score rule of the current category
12697 (@code{gnus-category-edit-score}).
12700 @kindex l (Category)
12701 @findex gnus-category-list
12702 List all the categories (@code{gnus-category-list}).
12706 @node Category Variables
12707 @subsubsection Category Variables
12710 @item gnus-category-mode-hook
12711 @vindex gnus-category-mode-hook
12712 Hook run in category buffers.
12714 @item gnus-category-line-format
12715 @vindex gnus-category-line-format
12716 Format of the lines in the category buffer (@pxref{Formatting
12717 Variables}). Valid elements are:
12721 The name of the category.
12724 The number of groups in the category.
12727 @item gnus-category-mode-line-format
12728 @vindex gnus-category-mode-line-format
12729 Format of the category mode line (@pxref{Mode Line Formatting}).
12731 @item gnus-agent-short-article
12732 @vindex gnus-agent-short-article
12733 Articles that have fewer lines than this are short. Default 100.
12735 @item gnus-agent-long-article
12736 @vindex gnus-agent-long-article
12737 Articles that have more lines than this are long. Default 200.
12739 @item gnus-agent-low-score
12740 @vindex gnus-agent-low-score
12741 Articles that have a score lower than this have a low score. Default
12744 @item gnus-agent-high-score
12745 @vindex gnus-agent-high-score
12746 Articles that have a score higher than this have a high score. Default
12752 @node Agent Commands
12753 @subsection Agent Commands
12755 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
12756 (@code{gnus-agent-toggle-plugged} command works in all modes, and
12757 toggles the plugged/unplugged state of the Gnus Agent.
12761 * Group Agent Commands::
12762 * Summary Agent Commands::
12763 * Server Agent Commands::
12766 You can run a complete batch fetch from the command line with the
12767 following incantation:
12769 @cindex gnus-agent-batch-fetch
12771 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
12776 @node Group Agent Commands
12777 @subsubsection Group Agent Commands
12781 @kindex J u (Agent Group)
12782 @findex gnus-agent-fetch-groups
12783 Fetch all eligible articles in the current group
12784 (@code{gnus-agent-fetch-groups}).
12787 @kindex J c (Agent Group)
12788 @findex gnus-enter-category-buffer
12789 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
12792 @kindex J s (Agent Group)
12793 @findex gnus-agent-fetch-session
12794 Fetch all eligible articles in all groups
12795 (@code{gnus-agent-fetch-session}).
12798 @kindex J S (Agent Group)
12799 @findex gnus-group-send-drafts
12800 Send all sendable messages in the draft group
12801 (@code{gnus-agent-fetch-session}). @xref{Drafts}.
12804 @kindex J a (Agent Group)
12805 @findex gnus-agent-add-group
12806 Add the current group to an Agent category
12807 (@code{gnus-agent-add-group}). This command understands the
12808 process/prefix convention (@pxref{Process/Prefix}).
12811 @kindex J r (Agent Group)
12812 @findex gnus-agent-remove-group
12813 Remove the current group from its category, if any
12814 (@code{gnus-agent-remove-group}). This command understands the
12815 process/prefix convention (@pxref{Process/Prefix}).
12820 @node Summary Agent Commands
12821 @subsubsection Summary Agent Commands
12825 @kindex J # (Agent Summary)
12826 @findex gnus-agent-mark-article
12827 Mark the article for downloading (@code{gnus-agent-mark-article}).
12830 @kindex J M-# (Agent Summary)
12831 @findex gnus-agent-unmark-article
12832 Remove the downloading mark from the article
12833 (@code{gnus-agent-unmark-article}).
12836 @kindex @@ (Agent Summary)
12837 @findex gnus-agent-toggle-mark
12838 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
12841 @kindex J c (Agent Summary)
12842 @findex gnus-agent-catchup
12843 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
12848 @node Server Agent Commands
12849 @subsubsection Server Agent Commands
12853 @kindex J a (Agent Server)
12854 @findex gnus-agent-add-server
12855 Add the current server to the list of servers covered by the Gnus Agent
12856 (@code{gnus-agent-add-server}).
12859 @kindex J r (Agent Server)
12860 @findex gnus-agent-remove-server
12861 Remove the current server from the list of servers covered by the Gnus
12862 Agent (@code{gnus-agent-remove-server}).
12868 @subsection Agent Expiry
12870 @vindex gnus-agent-expire-days
12871 @findex gnus-agent-expire
12872 @kindex M-x gnus-agent-expire
12873 @cindex Agent expiry
12874 @cindex Gnus Agent expiry
12877 @code{nnagent} doesn't handle expiry. Instead, there's a special
12878 @code{gnus-agent-expire} command that will expire all read articles that
12879 are older than @code{gnus-agent-expire-days} days. It can be run
12880 whenever you feel that you're running out of space. It's not
12881 particularly fast or efficient, and it's not a particularly good idea to
12882 interrupt it (with @kbd{C-g} or anything else) once you've started it.
12884 @vindex gnus-agent-expire-all
12885 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
12886 expire all articles---unread, read, ticked and dormant. If @code{nil}
12887 (which is the default), only read articles are eligible for expiry, and
12888 unread, ticked and dormant articles will be kept indefinitely.
12891 @node Outgoing Messages
12892 @subsection Outgoing Messages
12894 When Gnus is unplugged, all outgoing messages (both mail and news) are
12895 stored in the draft groups (@pxref{Drafts}). You can view them there
12896 after posting, and edit them at will.
12898 When Gnus is plugged again, you can send the messages either from the
12899 draft group with the special commands available there, or you can use
12900 the @kbd{J S} command in the group buffer to send all the sendable
12901 messages in the draft group.
12905 @node Agent Variables
12906 @subsection Agent Variables
12909 @item gnus-agent-directory
12910 @vindex gnus-agent-directory
12911 Where the Gnus Agent will store its files. The default is
12912 @file{~/News/agent/}.
12914 @item gnus-agent-handle-level
12915 @vindex gnus-agent-handle-level
12916 Groups on levels (@pxref{Group Levels}) higher than this variable will
12917 be ignored by the Agent. The default is @code{gnus-level-subscribed},
12918 which means that only subscribed group will be considered by the Agent
12921 @item gnus-agent-plugged-hook
12922 @vindex gnus-agent-plugged-hook
12923 Hook run when connecting to the network.
12925 @item gnus-agent-unplugged-hook
12926 @vindex gnus-agent-unplugged-hook
12927 Hook run when disconnecting from the network.
12932 @node Example Setup
12933 @subsection Example Setup
12935 If you don't want to read this manual, and you have a fairly standard
12936 setup, you may be able to use something like the following as your
12937 @file{.gnus.el} file to get started.
12940 ;;; Define how Gnus is to fetch news. We do this over NNTP
12941 ;;; from your ISP's server.
12942 (setq gnus-select-method '(nntp "news.your-isp.com"))
12944 ;;; Define how Gnus is to read your mail. We read mail from
12945 ;;; your ISP's POP server.
12946 (setq mail-sources '((pop :server "pop.your-isp.com")))
12948 ;;; Say how Gnus is to store the mail. We use nnml groups.
12949 (setq gnus-secondary-select-methods '((nnml "")))
12951 ;;; Make Gnus into an offline newsreader.
12955 That should be it, basically. Put that in your @file{~/.gnus.el} file,
12956 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
12959 If this is the first time you've run Gnus, you will be subscribed
12960 automatically to a few default newsgroups. You'll probably want to
12961 subscribe to more groups, and to do that, you have to query the
12962 @sc{nntp} server for a complete list of groups with the @kbd{A A}
12963 command. This usually takes quite a while, but you only have to do it
12966 After reading and parsing a while, you'll be presented with a list of
12967 groups. Subscribe to the ones you want to read with the @kbd{u}
12968 command. @kbd{l} to make all the killed groups disappear after you've
12969 subscribe to all the groups you want to read. (@kbd{A k} will bring
12970 back all the killed groups.)
12972 You can now read the groups at once, or you can download the articles
12973 with the @kbd{J s} command. And then read the rest of this manual to
12974 find out which of the other gazillion things you want to customize.
12977 @node Batching Agents
12978 @subsection Batching Agents
12980 Having the Gnus Agent fetch articles (and post whatever messages you've
12981 written) is quite easy once you've gotten things set up properly. The
12982 following shell script will do everything that is necessary:
12986 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
12990 @node Agent Caveats
12991 @subsection Agent Caveats
12993 The Gnus Agent doesn't seem to work like most other offline
12994 newsreaders. Here are some common questions that some imaginary people
12998 @item If I read an article while plugged, do they get entered into the
13003 @item If I read an article while plugged, and the article already exists
13004 in the Agent, will it get downloaded once more?
13010 In short, when Gnus is unplugged, it only looks into the locally stored
13011 articles; when it's plugged, it only talks to your ISP.
13018 Other people use @dfn{kill files}, but we here at Gnus Towers like
13019 scoring better than killing, so we'd rather switch than fight. They do
13020 something completely different as well, so sit up straight and pay
13023 @vindex gnus-summary-mark-below
13024 All articles have a default score (@code{gnus-summary-default-score}),
13025 which is 0 by default. This score may be raised or lowered either
13026 interactively or by score files. Articles that have a score lower than
13027 @code{gnus-summary-mark-below} are marked as read.
13029 Gnus will read any @dfn{score files} that apply to the current group
13030 before generating the summary buffer.
13032 There are several commands in the summary buffer that insert score
13033 entries based on the current article. You can, for instance, ask Gnus to
13034 lower or increase the score of all articles with a certain subject.
13036 There are two sorts of scoring entries: Permanent and temporary.
13037 Temporary score entries are self-expiring entries. Any entries that are
13038 temporary and have not been used for, say, a week, will be removed
13039 silently to help keep the sizes of the score files down.
13042 * Summary Score Commands:: Adding score entries for the current group.
13043 * Group Score Commands:: General score commands.
13044 * Score Variables:: Customize your scoring. (My, what terminology).
13045 * Score File Format:: What a score file may contain.
13046 * Score File Editing:: You can edit score files by hand as well.
13047 * Adaptive Scoring:: Big Sister Gnus knows what you read.
13048 * Home Score File:: How to say where new score entries are to go.
13049 * Followups To Yourself:: Having Gnus notice when people answer you.
13050 * Scoring Tips:: How to score effectively.
13051 * Reverse Scoring:: That problem child of old is not problem.
13052 * Global Score Files:: Earth-spanning, ear-splitting score files.
13053 * Kill Files:: They are still here, but they can be ignored.
13054 * Converting Kill Files:: Translating kill files to score files.
13055 * GroupLens:: Getting predictions on what you like to read.
13056 * Advanced Scoring:: Using logical expressions to build score rules.
13057 * Score Decays:: It can be useful to let scores wither away.
13061 @node Summary Score Commands
13062 @section Summary Score Commands
13063 @cindex score commands
13065 The score commands that alter score entries do not actually modify real
13066 score files. That would be too inefficient. Gnus maintains a cache of
13067 previously loaded score files, one of which is considered the
13068 @dfn{current score file alist}. The score commands simply insert
13069 entries into this list, and upon group exit, this list is saved.
13071 The current score file is by default the group's local score file, even
13072 if no such score file actually exists. To insert score commands into
13073 some other score file (e.g. @file{all.SCORE}), you must first make this
13074 score file the current one.
13076 General score commands that don't actually change the score file:
13081 @kindex V s (Summary)
13082 @findex gnus-summary-set-score
13083 Set the score of the current article (@code{gnus-summary-set-score}).
13086 @kindex V S (Summary)
13087 @findex gnus-summary-current-score
13088 Display the score of the current article
13089 (@code{gnus-summary-current-score}).
13092 @kindex V t (Summary)
13093 @findex gnus-score-find-trace
13094 Display all score rules that have been used on the current article
13095 (@code{gnus-score-find-trace}).
13098 @kindex V R (Summary)
13099 @findex gnus-summary-rescore
13100 Run the current summary through the scoring process
13101 (@code{gnus-summary-rescore}). This might be useful if you're playing
13102 around with your score files behind Gnus' back and want to see the
13103 effect you're having.
13106 @kindex V c (Summary)
13107 @findex gnus-score-change-score-file
13108 Make a different score file the current
13109 (@code{gnus-score-change-score-file}).
13112 @kindex V e (Summary)
13113 @findex gnus-score-edit-current-scores
13114 Edit the current score file (@code{gnus-score-edit-current-scores}).
13115 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
13119 @kindex V f (Summary)
13120 @findex gnus-score-edit-file
13121 Edit a score file and make this score file the current one
13122 (@code{gnus-score-edit-file}).
13125 @kindex V F (Summary)
13126 @findex gnus-score-flush-cache
13127 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
13128 after editing score files.
13131 @kindex V C (Summary)
13132 @findex gnus-score-customize
13133 Customize a score file in a visually pleasing manner
13134 (@code{gnus-score-customize}).
13138 The rest of these commands modify the local score file.
13143 @kindex V m (Summary)
13144 @findex gnus-score-set-mark-below
13145 Prompt for a score, and mark all articles with a score below this as
13146 read (@code{gnus-score-set-mark-below}).
13149 @kindex V x (Summary)
13150 @findex gnus-score-set-expunge-below
13151 Prompt for a score, and add a score rule to the current score file to
13152 expunge all articles below this score
13153 (@code{gnus-score-set-expunge-below}).
13156 The keystrokes for actually making score entries follow a very regular
13157 pattern, so there's no need to list all the commands. (Hundreds of
13160 @findex gnus-summary-increase-score
13161 @findex gnus-summary-lower-score
13165 The first key is either @kbd{I} (upper case i) for increasing the score
13166 or @kbd{L} for lowering the score.
13168 The second key says what header you want to score on. The following
13169 keys are available:
13173 Score on the author name.
13176 Score on the subject line.
13179 Score on the @code{Xref} line---i.e., the cross-posting line.
13182 Score on the @code{References} line.
13188 Score on the number of lines.
13191 Score on the @code{Message-ID} header.
13194 Score on followups---this matches the author name, and adds scores to
13195 the followups to this author.
13209 The third key is the match type. Which match types are valid depends on
13210 what headers you are scoring on.
13222 Substring matching.
13225 Fuzzy matching (@pxref{Fuzzy Matching}).
13254 Greater than number.
13259 The fourth and final key says whether this is a temporary (i.e., expiring)
13260 score entry, or a permanent (i.e., non-expiring) score entry, or whether
13261 it is to be done immediately, without adding to the score file.
13265 Temporary score entry.
13268 Permanent score entry.
13271 Immediately scoring.
13276 So, let's say you want to increase the score on the current author with
13277 exact matching permanently: @kbd{I a e p}. If you want to lower the
13278 score based on the subject line, using substring matching, and make a
13279 temporary score entry: @kbd{L s s t}. Pretty easy.
13281 To make things a bit more complicated, there are shortcuts. If you use
13282 a capital letter on either the second or third keys, Gnus will use
13283 defaults for the remaining one or two keystrokes. The defaults are
13284 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
13285 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
13287 These functions take both the numerical prefix and the symbolic prefix
13288 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
13289 (or increase) the score of the article. A symbolic prefix of @code{a}
13290 says to use the @file{all.SCORE} file for the command instead of the
13291 current score file.
13293 @vindex gnus-score-mimic-keymap
13294 The @code{gnus-score-mimic-keymap} says whether these commands will
13295 pretend they are keymaps or not.
13298 @node Group Score Commands
13299 @section Group Score Commands
13300 @cindex group score commands
13302 There aren't many of these as yet, I'm afraid.
13307 @kindex W f (Group)
13308 @findex gnus-score-flush-cache
13309 Gnus maintains a cache of score alists to avoid having to reload them
13310 all the time. This command will flush the cache
13311 (@code{gnus-score-flush-cache}).
13315 You can do scoring from the command line by saying something like:
13317 @findex gnus-batch-score
13318 @cindex batch scoring
13320 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
13324 @node Score Variables
13325 @section Score Variables
13326 @cindex score variables
13330 @item gnus-use-scoring
13331 @vindex gnus-use-scoring
13332 If @code{nil}, Gnus will not check for score files, and will not, in
13333 general, do any score-related work. This is @code{t} by default.
13335 @item gnus-kill-killed
13336 @vindex gnus-kill-killed
13337 If this variable is @code{nil}, Gnus will never apply score files to
13338 articles that have already been through the kill process. While this
13339 may save you lots of time, it also means that if you apply a kill file
13340 to a group, and then change the kill file and want to run it over you
13341 group again to kill more articles, it won't work. You have to set this
13342 variable to @code{t} to do that. (It is @code{t} by default.)
13344 @item gnus-kill-files-directory
13345 @vindex gnus-kill-files-directory
13346 All kill and score files will be stored in this directory, which is
13347 initialized from the @code{SAVEDIR} environment variable by default.
13348 This is @file{~/News/} by default.
13350 @item gnus-score-file-suffix
13351 @vindex gnus-score-file-suffix
13352 Suffix to add to the group name to arrive at the score file name
13353 (@samp{SCORE} by default.)
13355 @item gnus-score-uncacheable-files
13356 @vindex gnus-score-uncacheable-files
13357 @cindex score cache
13358 All score files are normally cached to avoid excessive re-loading of
13359 score files. However, if this might make you Emacs grow big and
13360 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
13361 @file{all.SCORE}, while it might be a good idea to not cache
13362 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
13363 variable is @samp{ADAPT$} by default, so no adaptive score files will
13366 @item gnus-save-score
13367 @vindex gnus-save-score
13368 If you have really complicated score files, and do lots of batch
13369 scoring, then you might set this variable to @code{t}. This will make
13370 Gnus save the scores into the @file{.newsrc.eld} file.
13372 If you do not set this to @code{t}, then manual scores (like those set
13373 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
13374 across group visits.
13376 @item gnus-score-interactive-default-score
13377 @vindex gnus-score-interactive-default-score
13378 Score used by all the interactive raise/lower commands to raise/lower
13379 score with. Default is 1000, which may seem excessive, but this is to
13380 ensure that the adaptive scoring scheme gets enough room to play with.
13381 We don't want the small changes from the adaptive scoring to overwrite
13382 manually entered data.
13384 @item gnus-summary-default-score
13385 @vindex gnus-summary-default-score
13386 Default score of an article, which is 0 by default.
13388 @item gnus-summary-expunge-below
13389 @vindex gnus-summary-expunge-below
13390 Don't display the summary lines of articles that have scores lower than
13391 this variable. This is @code{nil} by default, which means that no
13392 articles will be hidden. This variable is local to the summary buffers,
13393 and has to be set from @code{gnus-summary-mode-hook}.
13395 @item gnus-score-over-mark
13396 @vindex gnus-score-over-mark
13397 Mark (in the third column) used for articles with a score over the
13398 default. Default is @samp{+}.
13400 @item gnus-score-below-mark
13401 @vindex gnus-score-below-mark
13402 Mark (in the third column) used for articles with a score below the
13403 default. Default is @samp{-}.
13405 @item gnus-score-find-score-files-function
13406 @vindex gnus-score-find-score-files-function
13407 Function used to find score files for the current group. This function
13408 is called with the name of the group as the argument.
13410 Predefined functions available are:
13413 @item gnus-score-find-single
13414 @findex gnus-score-find-single
13415 Only apply the group's own score file.
13417 @item gnus-score-find-bnews
13418 @findex gnus-score-find-bnews
13419 Apply all score files that match, using bnews syntax. This is the
13420 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
13421 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
13422 @file{gnu.all.SCORE} would all apply. In short, the instances of
13423 @samp{all} in the score file names are translated into @samp{.*}, and
13424 then a regexp match is done.
13426 This means that if you have some score entries that you want to apply to
13427 all groups, then you put those entries in the @file{all.SCORE} file.
13429 The score files are applied in a semi-random order, although Gnus will
13430 try to apply the more general score files before the more specific score
13431 files. It does this by looking at the number of elements in the score
13432 file names---discarding the @samp{all} elements.
13434 @item gnus-score-find-hierarchical
13435 @findex gnus-score-find-hierarchical
13436 Apply all score files from all the parent groups. This means that you
13437 can't have score files like @file{all.SCORE}, but you can have
13438 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
13441 This variable can also be a list of functions. In that case, all these
13442 functions will be called, and all the returned lists of score files will
13443 be applied. These functions can also return lists of score alists
13444 directly. In that case, the functions that return these non-file score
13445 alists should probably be placed before the ``real'' score file
13446 functions, to ensure that the last score file returned is the local
13449 @item gnus-score-expiry-days
13450 @vindex gnus-score-expiry-days
13451 This variable says how many days should pass before an unused score file
13452 entry is expired. If this variable is @code{nil}, no score file entries
13453 are expired. It's 7 by default.
13455 @item gnus-update-score-entry-dates
13456 @vindex gnus-update-score-entry-dates
13457 If this variable is non-@code{nil}, matching score entries will have
13458 their dates updated. (This is how Gnus controls expiry---all
13459 non-matching entries will become too old while matching entries will
13460 stay fresh and young.) However, if you set this variable to @code{nil},
13461 even matching entries will grow old and will have to face that oh-so
13464 @item gnus-score-after-write-file-function
13465 @vindex gnus-score-after-write-file-function
13466 Function called with the name of the score file just written.
13468 @item gnus-score-thread-simplify
13469 @vindex gnus-score-thread-simplify
13470 If this variable is non-@code{nil}, article subjects will be simplified
13471 for subject scoring purposes in the same manner as with
13472 threading---according to the current value of
13473 gnus-simplify-subject-functions. If the scoring entry uses
13474 @code{substring} or @code{exact} matching, the match will also be
13475 simplified in this manner.
13480 @node Score File Format
13481 @section Score File Format
13482 @cindex score file format
13484 A score file is an @code{emacs-lisp} file that normally contains just a
13485 single form. Casual users are not expected to edit these files;
13486 everything can be changed from the summary buffer.
13488 Anyway, if you'd like to dig into it yourself, here's an example:
13492 ("Lars Ingebrigtsen" -10000)
13494 ("larsi\\|lmi" -50000 nil R))
13496 ("Ding is Badd" nil 728373))
13498 ("alt.politics" -1000 728372 s))
13503 (mark-and-expunge -10)
13507 (files "/hom/larsi/News/gnu.SCORE")
13508 (exclude-files "all.SCORE")
13509 (local (gnus-newsgroup-auto-expire t)
13510 (gnus-summary-make-false-root empty))
13514 This example demonstrates most score file elements. For a different
13515 approach, see @pxref{Advanced Scoring}.
13517 Even though this looks much like lisp code, nothing here is actually
13518 @code{eval}ed. The lisp reader is used to read this form, though, so it
13519 has to be valid syntactically, if not semantically.
13521 Six keys are supported by this alist:
13526 If the key is a string, it is the name of the header to perform the
13527 match on. Scoring can only be performed on these eight headers:
13528 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
13529 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
13530 these headers, there are three strings to tell Gnus to fetch the entire
13531 article and do the match on larger parts of the article: @code{Body}
13532 will perform the match on the body of the article, @code{Head} will
13533 perform the match on the head of the article, and @code{All} will
13534 perform the match on the entire article. Note that using any of these
13535 last three keys will slow down group entry @emph{considerably}. The
13536 final ``header'' you can score on is @code{Followup}. These score
13537 entries will result in new score entries being added for all follow-ups
13538 to articles that matches these score entries.
13540 Following this key is a arbitrary number of score entries, where each
13541 score entry has one to four elements.
13545 The first element is the @dfn{match element}. On most headers this will
13546 be a string, but on the Lines and Chars headers, this must be an
13550 If the second element is present, it should be a number---the @dfn{score
13551 element}. This number should be an integer in the neginf to posinf
13552 interval. This number is added to the score of the article if the match
13553 is successful. If this element is not present, the
13554 @code{gnus-score-interactive-default-score} number will be used
13555 instead. This is 1000 by default.
13558 If the third element is present, it should be a number---the @dfn{date
13559 element}. This date says when the last time this score entry matched,
13560 which provides a mechanism for expiring the score entries. It this
13561 element is not present, the score entry is permanent. The date is
13562 represented by the number of days since December 31, 1 BCE.
13565 If the fourth element is present, it should be a symbol---the @dfn{type
13566 element}. This element specifies what function should be used to see
13567 whether this score entry matches the article. What match types that can
13568 be used depends on what header you wish to perform the match on.
13571 @item From, Subject, References, Xref, Message-ID
13572 For most header types, there are the @code{r} and @code{R} (regexp), as
13573 well as @code{s} and @code{S} (substring) types, and @code{e} and
13574 @code{E} (exact match), and @code{w} (word match) types. If this
13575 element is not present, Gnus will assume that substring matching should
13576 be used. @code{R}, @code{S}, and @code{E} differ from the others in
13577 that the matches will be done in a case-sensitive manner. All these
13578 one-letter types are really just abbreviations for the @code{regexp},
13579 @code{string}, @code{exact}, and @code{word} types, which you can use
13580 instead, if you feel like.
13583 These two headers use different match types: @code{<}, @code{>},
13584 @code{=}, @code{>=} and @code{<=}.
13586 These predicates are true if
13589 (PREDICATE HEADER MATCH)
13592 evaluates to non-@code{nil}. For instance, the advanced match
13593 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
13600 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
13601 the match, we get the score added if the article has less than 4 lines.
13602 (It's easy to get confused and think it's the other way around. But
13603 it's not. I think.)
13605 When matching on @code{Lines}, be careful because some backends (like
13606 @code{nndir}) do not generate @code{Lines} header, so every article ends
13607 up being marked as having 0 lines. This can lead to strange results if
13608 you happen to lower score of the articles with few lines.
13611 For the Date header we have three kinda silly match types:
13612 @code{before}, @code{at} and @code{after}. I can't really imagine this
13613 ever being useful, but, like, it would feel kinda silly not to provide
13614 this function. Just in case. You never know. Better safe than sorry.
13615 Once burnt, twice shy. Don't judge a book by its cover. Never not have
13616 sex on a first date. (I have been told that at least one person, and I
13617 quote, ``found this function indispensable'', however.)
13621 A more useful match type is @code{regexp}. With it, you can match the
13622 date string using a regular expression. The date is normalized to
13623 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
13624 you want to match all articles that have been posted on April 1st in
13625 every year, you could use @samp{....0401.........} as a match string,
13626 for instance. (Note that the date is kept in its original time zone, so
13627 this will match articles that were posted when it was April 1st where
13628 the article was posted from. Time zones are such wholesome fun for the
13631 @item Head, Body, All
13632 These three match keys use the same match types as the @code{From} (etc)
13636 This match key is somewhat special, in that it will match the
13637 @code{From} header, and affect the score of not only the matching
13638 articles, but also all followups to the matching articles. This allows
13639 you e.g. increase the score of followups to your own articles, or
13640 decrease the score of followups to the articles of some known
13641 trouble-maker. Uses the same match types as the @code{From} header
13642 uses. (Using this match key will lead to creation of @file{ADAPT}
13646 This match key works along the same lines as the @code{Followup} match
13647 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
13648 @samp{thread} match. This will add a new @samp{thread} match for each
13649 article that has @var{X} in its @code{References} header. (These new
13650 @samp{thread} matches will use the @code{Message-ID}s of these matching
13651 articles.) This will ensure that you can raise/lower the score of an
13652 entire thread, even though some articles in the thread may not have
13653 complete @code{References} headers. Note that using this may lead to
13654 undeterministic scores of the articles in the thread. (Using this match
13655 key will lead to creation of @file{ADAPT} files.)
13659 @cindex Score File Atoms
13661 The value of this entry should be a number. Any articles with a score
13662 lower than this number will be marked as read.
13665 The value of this entry should be a number. Any articles with a score
13666 lower than this number will be removed from the summary buffer.
13668 @item mark-and-expunge
13669 The value of this entry should be a number. Any articles with a score
13670 lower than this number will be marked as read and removed from the
13673 @item thread-mark-and-expunge
13674 The value of this entry should be a number. All articles that belong to
13675 a thread that has a total score below this number will be marked as read
13676 and removed from the summary buffer. @code{gnus-thread-score-function}
13677 says how to compute the total score for a thread.
13680 The value of this entry should be any number of file names. These files
13681 are assumed to be score files as well, and will be loaded the same way
13684 @item exclude-files
13685 The clue of this entry should be any number of files. These files will
13686 not be loaded, even though they would normally be so, for some reason or
13690 The value of this entry will be @code{eval}el. This element will be
13691 ignored when handling global score files.
13694 Read-only score files will not be updated or saved. Global score files
13695 should feature this atom (@pxref{Global Score Files}). (Note:
13696 @dfn{Global} here really means @dfn{global}; not your personal
13697 apply-to-all-groups score files.)
13700 The value of this entry should be a number. Articles that do not have
13701 parents will get this number added to their scores. Imagine you follow
13702 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
13703 will only follow a few of the threads, also want to see any new threads.
13705 You can do this with the following two score file entries:
13709 (mark-and-expunge -100)
13712 When you enter the group the first time, you will only see the new
13713 threads. You then raise the score of the threads that you find
13714 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
13715 rest. Next time you enter the group, you will see new articles in the
13716 interesting threads, plus any new threads.
13718 I.e.---the orphan score atom is for high-volume groups where there
13719 exist a few interesting threads which can't be found automatically by
13720 ordinary scoring rules.
13723 This entry controls the adaptive scoring. If it is @code{t}, the
13724 default adaptive scoring rules will be used. If it is @code{ignore}, no
13725 adaptive scoring will be performed on this group. If it is a list, this
13726 list will be used as the adaptive scoring rules. If it isn't present,
13727 or is something other than @code{t} or @code{ignore}, the default
13728 adaptive scoring rules will be used. If you want to use adaptive
13729 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
13730 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
13731 not want adaptive scoring. If you only want adaptive scoring in a few
13732 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
13733 insert @code{(adapt t)} in the score files of the groups where you want
13737 All adaptive score entries will go to the file named by this entry. It
13738 will also be applied when entering the group. This atom might be handy
13739 if you want to adapt on several groups at once, using the same adaptive
13740 file for a number of groups.
13743 @cindex local variables
13744 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
13745 Each @var{var} will be made buffer-local to the current summary buffer,
13746 and set to the value specified. This is a convenient, if somewhat
13747 strange, way of setting variables in some groups if you don't like hooks
13748 much. Note that the @var{value} won't be evaluated.
13752 @node Score File Editing
13753 @section Score File Editing
13755 You normally enter all scoring commands from the summary buffer, but you
13756 might feel the urge to edit them by hand as well, so we've supplied you
13757 with a mode for that.
13759 It's simply a slightly customized @code{emacs-lisp} mode, with these
13760 additional commands:
13765 @kindex C-c C-c (Score)
13766 @findex gnus-score-edit-done
13767 Save the changes you have made and return to the summary buffer
13768 (@code{gnus-score-edit-done}).
13771 @kindex C-c C-d (Score)
13772 @findex gnus-score-edit-insert-date
13773 Insert the current date in numerical format
13774 (@code{gnus-score-edit-insert-date}). This is really the day number, if
13775 you were wondering.
13778 @kindex C-c C-p (Score)
13779 @findex gnus-score-pretty-print
13780 The adaptive score files are saved in an unformatted fashion. If you
13781 intend to read one of these files, you want to @dfn{pretty print} it
13782 first. This command (@code{gnus-score-pretty-print}) does that for
13787 Type @kbd{M-x gnus-score-mode} to use this mode.
13789 @vindex gnus-score-mode-hook
13790 @code{gnus-score-menu-hook} is run in score mode buffers.
13792 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
13793 e} to begin editing score files.
13796 @node Adaptive Scoring
13797 @section Adaptive Scoring
13798 @cindex adaptive scoring
13800 If all this scoring is getting you down, Gnus has a way of making it all
13801 happen automatically---as if by magic. Or rather, as if by artificial
13802 stupidity, to be precise.
13804 @vindex gnus-use-adaptive-scoring
13805 When you read an article, or mark an article as read, or kill an
13806 article, you leave marks behind. On exit from the group, Gnus can sniff
13807 these marks and add score elements depending on what marks it finds.
13808 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
13809 @code{t} or @code{(line)}. If you want score adaptively on separate
13810 words appearing in the subjects, you should set this variable to
13811 @code{(word)}. If you want to use both adaptive methods, set this
13812 variable to @code{(word line)}.
13814 @vindex gnus-default-adaptive-score-alist
13815 To give you complete control over the scoring process, you can customize
13816 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
13817 might look something like this:
13820 (defvar gnus-default-adaptive-score-alist
13821 '((gnus-unread-mark)
13822 (gnus-ticked-mark (from 4))
13823 (gnus-dormant-mark (from 5))
13824 (gnus-del-mark (from -4) (subject -1))
13825 (gnus-read-mark (from 4) (subject 2))
13826 (gnus-expirable-mark (from -1) (subject -1))
13827 (gnus-killed-mark (from -1) (subject -3))
13828 (gnus-kill-file-mark)
13829 (gnus-ancient-mark)
13830 (gnus-low-score-mark)
13831 (gnus-catchup-mark (from -1) (subject -1))))
13834 As you see, each element in this alist has a mark as a key (either a
13835 variable name or a ``real'' mark---a character). Following this key is
13836 a arbitrary number of header/score pairs. If there are no header/score
13837 pairs following the key, no adaptive scoring will be done on articles
13838 that have that key as the article mark. For instance, articles with
13839 @code{gnus-unread-mark} in the example above will not get adaptive score
13842 Each article can have only one mark, so just a single of these rules
13843 will be applied to each article.
13845 To take @code{gnus-del-mark} as an example---this alist says that all
13846 articles that have that mark (i.e., are marked with @samp{D}) will have a
13847 score entry added to lower based on the @code{From} header by -4, and
13848 lowered by @code{Subject} by -1. Change this to fit your prejudices.
13850 If you have marked 10 articles with the same subject with
13851 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
13852 That means that that subject will get a score of ten times -1, which
13853 should be, unless I'm much mistaken, -10.
13855 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
13856 the read articles will be marked with the @samp{E} mark. This'll
13857 probably make adaptive scoring slightly impossible, so auto-expiring and
13858 adaptive scoring doesn't really mix very well.
13860 The headers you can score on are @code{from}, @code{subject},
13861 @code{message-id}, @code{references}, @code{xref}, @code{lines},
13862 @code{chars} and @code{date}. In addition, you can score on
13863 @code{followup}, which will create an adaptive score entry that matches
13864 on the @code{References} header using the @code{Message-ID} of the
13865 current article, thereby matching the following thread.
13867 You can also score on @code{thread}, which will try to score all
13868 articles that appear in a thread. @code{thread} matches uses a
13869 @code{Message-ID} to match on the @code{References} header of the
13870 article. If the match is made, the @code{Message-ID} of the article is
13871 added to the @code{thread} rule. (Think about it. I'd recommend two
13872 aspirins afterwards.)
13874 If you use this scheme, you should set the score file atom @code{mark}
13875 to something small---like -300, perhaps, to avoid having small random
13876 changes result in articles getting marked as read.
13878 After using adaptive scoring for a week or so, Gnus should start to
13879 become properly trained and enhance the authors you like best, and kill
13880 the authors you like least, without you having to say so explicitly.
13882 You can control what groups the adaptive scoring is to be performed on
13883 by using the score files (@pxref{Score File Format}). This will also
13884 let you use different rules in different groups.
13886 @vindex gnus-adaptive-file-suffix
13887 The adaptive score entries will be put into a file where the name is the
13888 group name with @code{gnus-adaptive-file-suffix} appended. The default
13891 @vindex gnus-score-exact-adapt-limit
13892 When doing adaptive scoring, substring or fuzzy matching would probably
13893 give you the best results in most cases. However, if the header one
13894 matches is short, the possibility for false positives is great, so if
13895 the length of the match is less than
13896 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
13897 this variable is @code{nil}, exact matching will always be used to avoid
13900 @vindex gnus-default-adaptive-word-score-alist
13901 As mentioned above, you can adapt either on individual words or entire
13902 headers. If you adapt on words, the
13903 @code{gnus-default-adaptive-word-score-alist} variable says what score
13904 each instance of a word should add given a mark.
13907 (setq gnus-default-adaptive-word-score-alist
13908 `((,gnus-read-mark . 30)
13909 (,gnus-catchup-mark . -10)
13910 (,gnus-killed-mark . -20)
13911 (,gnus-del-mark . -15)))
13914 This is the default value. If you have adaption on words enabled, every
13915 word that appears in subjects of articles marked with
13916 @code{gnus-read-mark} will result in a score rule that increase the
13917 score with 30 points.
13919 @vindex gnus-default-ignored-adaptive-words
13920 @vindex gnus-ignored-adaptive-words
13921 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
13922 will be ignored. If you wish to add more words to be ignored, use the
13923 @code{gnus-ignored-adaptive-words} list instead.
13925 @vindex gnus-adaptive-word-syntax-table
13926 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
13927 syntax table in effect. It is similar to the standard syntax table, but
13928 it considers numbers to be non-word-constituent characters.
13930 @vindex gnus-adaptive-word-minimum
13931 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
13932 word scoring process will never bring down the score of an article to
13933 below this number. The default is @code{nil}.
13935 @vindex gnus-adaptive-word-no-group-words
13936 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
13937 won't adaptively word score any of the words in the group name. Useful
13938 for groups like @samp{comp.editors.emacs}, where most of the subject
13939 lines contain the word @samp{emacs}.
13941 After using this scheme for a while, it might be nice to write a
13942 @code{gnus-psychoanalyze-user} command to go through the rules and see
13943 what words you like and what words you don't like. Or perhaps not.
13945 Note that the adaptive word scoring thing is highly experimental and is
13946 likely to change in the future. Initial impressions seem to indicate
13947 that it's totally useless as it stands. Some more work (involving more
13948 rigorous statistical methods) will have to be done to make this useful.
13951 @node Home Score File
13952 @section Home Score File
13954 The score file where new score file entries will go is called the
13955 @dfn{home score file}. This is normally (and by default) the score file
13956 for the group itself. For instance, the home score file for
13957 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
13959 However, this may not be what you want. It is often convenient to share
13960 a common home score file among many groups---all @samp{emacs} groups
13961 could perhaps use the same home score file.
13963 @vindex gnus-home-score-file
13964 The variable that controls this is @code{gnus-home-score-file}. It can
13969 A string. Then this file will be used as the home score file for all
13973 A function. The result of this function will be used as the home score
13974 file. The function will be called with the name of the group as the
13978 A list. The elements in this list can be:
13982 @var{(regexp file-name)}. If the @var{regexp} matches the group name,
13983 the @var{file-name} will will be used as the home score file.
13986 A function. If the function returns non-nil, the result will be used as
13987 the home score file.
13990 A string. Use the string as the home score file.
13993 The list will be traversed from the beginning towards the end looking
13998 So, if you want to use just a single score file, you could say:
14001 (setq gnus-home-score-file
14002 "my-total-score-file.SCORE")
14005 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
14006 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
14008 @findex gnus-hierarchial-home-score-file
14010 (setq gnus-home-score-file
14011 'gnus-hierarchial-home-score-file)
14014 This is a ready-made function provided for your convenience.
14015 Other functions include
14018 @item gnus-current-home-score-file
14019 @findex gnus-current-home-score-file
14020 Return the ``current'' regular score file. This will make scoring
14021 commands add entry to the ``innermost'' matching score file.
14025 If you want to have one score file for the @samp{emacs} groups and
14026 another for the @samp{comp} groups, while letting all other groups use
14027 their own home score files:
14030 (setq gnus-home-score-file
14031 ;; All groups that match the regexp "\\.emacs"
14032 '(("\\.emacs" "emacs.SCORE")
14033 ;; All the comp groups in one score file
14034 ("^comp" "comp.SCORE")))
14037 @vindex gnus-home-adapt-file
14038 @code{gnus-home-adapt-file} works exactly the same way as
14039 @code{gnus-home-score-file}, but says what the home adaptive score file
14040 is instead. All new adaptive file entries will go into the file
14041 specified by this variable, and the same syntax is allowed.
14043 In addition to using @code{gnus-home-score-file} and
14044 @code{gnus-home-adapt-file}, you can also use group parameters
14045 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
14046 Parameters}) to achieve much the same. Group and topic parameters take
14047 precedence over this variable.
14050 @node Followups To Yourself
14051 @section Followups To Yourself
14053 Gnus offers two commands for picking out the @code{Message-ID} header in
14054 the current buffer. Gnus will then add a score rule that scores using
14055 this @code{Message-ID} on the @code{References} header of other
14056 articles. This will, in effect, increase the score of all articles that
14057 respond to the article in the current buffer. Quite useful if you want
14058 to easily note when people answer what you've said.
14062 @item gnus-score-followup-article
14063 @findex gnus-score-followup-article
14064 This will add a score to articles that directly follow up your own
14067 @item gnus-score-followup-thread
14068 @findex gnus-score-followup-thread
14069 This will add a score to all articles that appear in a thread ``below''
14073 @vindex message-sent-hook
14074 These two functions are both primarily meant to be used in hooks like
14075 @code{message-sent-hook}.
14077 If you look closely at your own @code{Message-ID}, you'll notice that
14078 the first two or three characters are always the same. Here's two of
14082 <x6u3u47icf.fsf@@eyesore.no>
14083 <x6sp9o7ibw.fsf@@eyesore.no>
14086 So ``my'' ident on this machine is @samp{x6}. This can be
14087 exploited---the following rule will raise the score on all followups to
14092 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
14096 Whether it's the first two or first three characters that are ``yours''
14097 is system-dependent.
14101 @section Scoring Tips
14102 @cindex scoring tips
14108 @cindex scoring crossposts
14109 If you want to lower the score of crossposts, the line to match on is
14110 the @code{Xref} header.
14112 ("xref" (" talk.politics.misc:" -1000))
14115 @item Multiple crossposts
14116 If you want to lower the score of articles that have been crossposted to
14117 more than, say, 3 groups:
14119 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
14122 @item Matching on the body
14123 This is generally not a very good idea---it takes a very long time.
14124 Gnus actually has to fetch each individual article from the server. But
14125 you might want to anyway, I guess. Even though there are three match
14126 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
14127 and stick with it in each score file. If you use any two, each article
14128 will be fetched @emph{twice}. If you want to match a bit on the
14129 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
14132 @item Marking as read
14133 You will probably want to mark articles that has a score below a certain
14134 number as read. This is most easily achieved by putting the following
14135 in your @file{all.SCORE} file:
14139 You may also consider doing something similar with @code{expunge}.
14141 @item Negated character classes
14142 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
14143 That will match newlines, which might lead to, well, The Unknown. Say
14144 @code{[^abcd\n]*} instead.
14148 @node Reverse Scoring
14149 @section Reverse Scoring
14150 @cindex reverse scoring
14152 If you want to keep just articles that have @samp{Sex with Emacs} in the
14153 subject header, and expunge all other articles, you could put something
14154 like this in your score file:
14158 ("Sex with Emacs" 2))
14163 So, you raise all articles that match @samp{Sex with Emacs} and mark the
14164 rest as read, and expunge them to boot.
14167 @node Global Score Files
14168 @section Global Score Files
14169 @cindex global score files
14171 Sure, other newsreaders have ``global kill files''. These are usually
14172 nothing more than a single kill file that applies to all groups, stored
14173 in the user's home directory. Bah! Puny, weak newsreaders!
14175 What I'm talking about here are Global Score Files. Score files from
14176 all over the world, from users everywhere, uniting all nations in one
14177 big, happy score file union! Ange-score! New and untested!
14179 @vindex gnus-global-score-files
14180 All you have to do to use other people's score files is to set the
14181 @code{gnus-global-score-files} variable. One entry for each score file,
14182 or each score file directory. Gnus will decide by itself what score
14183 files are applicable to which group.
14185 Say you want to use the score file
14186 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
14187 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
14190 (setq gnus-global-score-files
14191 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
14192 "/ftp@@ftp.some-where:/pub/score/"))
14195 @findex gnus-score-search-global-directories
14196 Simple, eh? Directory names must end with a @samp{/}. These
14197 directories are typically scanned only once during each Gnus session.
14198 If you feel the need to manually re-scan the remote directories, you can
14199 use the @code{gnus-score-search-global-directories} command.
14201 Note that, at present, using this option will slow down group entry
14202 somewhat. (That is---a lot.)
14204 If you want to start maintaining score files for other people to use,
14205 just put your score file up for anonymous ftp and announce it to the
14206 world. Become a retro-moderator! Participate in the retro-moderator
14207 wars sure to ensue, where retro-moderators battle it out for the
14208 sympathy of the people, luring them to use their score files on false
14209 premises! Yay! The net is saved!
14211 Here are some tips for the would-be retro-moderator, off the top of my
14217 Articles heavily crossposted are probably junk.
14219 To lower a single inappropriate article, lower by @code{Message-ID}.
14221 Particularly brilliant authors can be raised on a permanent basis.
14223 Authors that repeatedly post off-charter for the group can safely be
14224 lowered out of existence.
14226 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
14227 articles completely.
14230 Use expiring score entries to keep the size of the file down. You
14231 should probably have a long expiry period, though, as some sites keep
14232 old articles for a long time.
14235 ... I wonder whether other newsreaders will support global score files
14236 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
14237 Wave, xrn and 1stReader are bound to implement scoring. Should we start
14238 holding our breath yet?
14242 @section Kill Files
14245 Gnus still supports those pesky old kill files. In fact, the kill file
14246 entries can now be expiring, which is something I wrote before Daniel
14247 Quinlan thought of doing score files, so I've left the code in there.
14249 In short, kill processing is a lot slower (and I do mean @emph{a lot})
14250 than score processing, so it might be a good idea to rewrite your kill
14251 files into score files.
14253 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
14254 forms into this file, which means that you can use kill files as some
14255 sort of primitive hook function to be run on group entry, even though
14256 that isn't a very good idea.
14258 Normal kill files look like this:
14261 (gnus-kill "From" "Lars Ingebrigtsen")
14262 (gnus-kill "Subject" "ding")
14266 This will mark every article written by me as read, and remove the
14267 marked articles from the summary buffer. Very useful, you'll agree.
14269 Other programs use a totally different kill file syntax. If Gnus
14270 encounters what looks like a @code{rn} kill file, it will take a stab at
14273 Two summary functions for editing a GNUS kill file:
14278 @kindex M-k (Summary)
14279 @findex gnus-summary-edit-local-kill
14280 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
14283 @kindex M-K (Summary)
14284 @findex gnus-summary-edit-global-kill
14285 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
14288 Two group mode functions for editing the kill files:
14293 @kindex M-k (Group)
14294 @findex gnus-group-edit-local-kill
14295 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
14298 @kindex M-K (Group)
14299 @findex gnus-group-edit-global-kill
14300 Edit the general kill file (@code{gnus-group-edit-global-kill}).
14303 Kill file variables:
14306 @item gnus-kill-file-name
14307 @vindex gnus-kill-file-name
14308 A kill file for the group @samp{soc.motss} is normally called
14309 @file{soc.motss.KILL}. The suffix appended to the group name to get
14310 this file name is detailed by the @code{gnus-kill-file-name} variable.
14311 The ``global'' kill file (not in the score file sense of ``global'', of
14312 course) is just called @file{KILL}.
14314 @vindex gnus-kill-save-kill-file
14315 @item gnus-kill-save-kill-file
14316 If this variable is non-@code{nil}, Gnus will save the
14317 kill file after processing, which is necessary if you use expiring
14320 @item gnus-apply-kill-hook
14321 @vindex gnus-apply-kill-hook
14322 @findex gnus-apply-kill-file-unless-scored
14323 @findex gnus-apply-kill-file
14324 A hook called to apply kill files to a group. It is
14325 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
14326 kill file if you have a score file for the same group, you can set this
14327 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
14328 kill files to be processed, you should set this variable to @code{nil}.
14330 @item gnus-kill-file-mode-hook
14331 @vindex gnus-kill-file-mode-hook
14332 A hook called in kill-file mode buffers.
14337 @node Converting Kill Files
14338 @section Converting Kill Files
14340 @cindex converting kill files
14342 If you have loads of old kill files, you may want to convert them into
14343 score files. If they are ``regular'', you can use
14344 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
14347 The kill to score conversion package isn't included in Gnus by default.
14348 You can fetch it from
14349 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
14351 If your old kill files are very complex---if they contain more
14352 non-@code{gnus-kill} forms than not, you'll have to convert them by
14353 hand. Or just let them be as they are. Gnus will still use them as
14361 GroupLens is a collaborative filtering system that helps you work
14362 together with other people to find the quality news articles out of the
14363 huge volume of news articles generated every day.
14365 To accomplish this the GroupLens system combines your opinions about
14366 articles you have already read with the opinions of others who have done
14367 likewise and gives you a personalized prediction for each unread news
14368 article. Think of GroupLens as a matchmaker. GroupLens watches how you
14369 rate articles, and finds other people that rate articles the same way.
14370 Once it has found some people you agree with it tells you, in the form
14371 of a prediction, what they thought of the article. You can use this
14372 prediction to help you decide whether or not you want to read the
14376 * Using GroupLens:: How to make Gnus use GroupLens.
14377 * Rating Articles:: Letting GroupLens know how you rate articles.
14378 * Displaying Predictions:: Displaying predictions given by GroupLens.
14379 * GroupLens Variables:: Customizing GroupLens.
14383 @node Using GroupLens
14384 @subsection Using GroupLens
14386 To use GroupLens you must register a pseudonym with your local Better
14388 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
14389 better bit in town at the moment.
14391 Once you have registered you'll need to set a couple of variables.
14395 @item gnus-use-grouplens
14396 @vindex gnus-use-grouplens
14397 Setting this variable to a non-@code{nil} value will make Gnus hook into
14398 all the relevant GroupLens functions.
14400 @item grouplens-pseudonym
14401 @vindex grouplens-pseudonym
14402 This variable should be set to the pseudonym you got when registering
14403 with the Better Bit Bureau.
14405 @item grouplens-newsgroups
14406 @vindex grouplens-newsgroups
14407 A list of groups that you want to get GroupLens predictions for.
14411 That's the minimum of what you need to get up and running with GroupLens.
14412 Once you've registered, GroupLens will start giving you scores for
14413 articles based on the average of what other people think. But, to get
14414 the real benefit of GroupLens you need to start rating articles
14415 yourself. Then the scores GroupLens gives you will be personalized for
14416 you, based on how the people you usually agree with have already rated.
14419 @node Rating Articles
14420 @subsection Rating Articles
14422 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
14423 Where 1 means something like this article is a waste of bandwidth and 5
14424 means that the article was really good. The basic question to ask
14425 yourself is, "on a scale from 1 to 5 would I like to see more articles
14428 There are four ways to enter a rating for an article in GroupLens.
14433 @kindex r (GroupLens)
14434 @findex bbb-summary-rate-article
14435 This function will prompt you for a rating on a scale of one to five.
14438 @kindex k (GroupLens)
14439 @findex grouplens-score-thread
14440 This function will prompt you for a rating, and rate all the articles in
14441 the thread. This is really useful for some of those long running giant
14442 threads in rec.humor.
14446 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
14447 the score of the article you're reading.
14452 @kindex n (GroupLens)
14453 @findex grouplens-next-unread-article
14454 Rate the article and go to the next unread article.
14457 @kindex , (GroupLens)
14458 @findex grouplens-best-unread-article
14459 Rate the article and go to the next unread article with the highest score.
14463 If you want to give the current article a score of 4 and then go to the
14464 next article, just type @kbd{4 n}.
14467 @node Displaying Predictions
14468 @subsection Displaying Predictions
14470 GroupLens makes a prediction for you about how much you will like a
14471 news article. The predictions from GroupLens are on a scale from 1 to
14472 5, where 1 is the worst and 5 is the best. You can use the predictions
14473 from GroupLens in one of three ways controlled by the variable
14474 @code{gnus-grouplens-override-scoring}.
14476 @vindex gnus-grouplens-override-scoring
14477 There are three ways to display predictions in grouplens. You may
14478 choose to have the GroupLens scores contribute to, or override the
14479 regular gnus scoring mechanism. override is the default; however, some
14480 people prefer to see the Gnus scores plus the grouplens scores. To get
14481 the separate scoring behavior you need to set
14482 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
14483 GroupLens predictions combined with the grouplens scores set it to
14484 @code{'override} and to combine the scores set
14485 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
14486 the combine option you will also want to set the values for
14487 @code{grouplens-prediction-offset} and
14488 @code{grouplens-score-scale-factor}.
14490 @vindex grouplens-prediction-display
14491 In either case, GroupLens gives you a few choices for how you would like
14492 to see your predictions displayed. The display of predictions is
14493 controlled by the @code{grouplens-prediction-display} variable.
14495 The following are valid values for that variable.
14498 @item prediction-spot
14499 The higher the prediction, the further to the right an @samp{*} is
14502 @item confidence-interval
14503 A numeric confidence interval.
14505 @item prediction-bar
14506 The higher the prediction, the longer the bar.
14508 @item confidence-bar
14509 Numerical confidence.
14511 @item confidence-spot
14512 The spot gets bigger with more confidence.
14514 @item prediction-num
14515 Plain-old numeric value.
14517 @item confidence-plus-minus
14518 Prediction +/- confidence.
14523 @node GroupLens Variables
14524 @subsection GroupLens Variables
14528 @item gnus-summary-grouplens-line-format
14529 The summary line format used in GroupLens-enhanced summary buffers. It
14530 accepts the same specs as the normal summary line format (@pxref{Summary
14531 Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
14534 @item grouplens-bbb-host
14535 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
14538 @item grouplens-bbb-port
14539 Port of the host running the bbbd server. The default is 9000.
14541 @item grouplens-score-offset
14542 Offset the prediction by this value. In other words, subtract the
14543 prediction value by this number to arrive at the effective score. The
14546 @item grouplens-score-scale-factor
14547 This variable allows the user to magnify the effect of GroupLens scores.
14548 The scale factor is applied after the offset. The default is 1.
14553 @node Advanced Scoring
14554 @section Advanced Scoring
14556 Scoring on Subjects and From headers is nice enough, but what if you're
14557 really interested in what a person has to say only when she's talking
14558 about a particular subject? Or what if you really don't want to
14559 read what person A has to say when she's following up to person B, but
14560 want to read what she says when she's following up to person C?
14562 By using advanced scoring rules you may create arbitrarily complex
14566 * Advanced Scoring Syntax:: A definition.
14567 * Advanced Scoring Examples:: What they look like.
14568 * Advanced Scoring Tips:: Getting the most out of it.
14572 @node Advanced Scoring Syntax
14573 @subsection Advanced Scoring Syntax
14575 Ordinary scoring rules have a string as the first element in the rule.
14576 Advanced scoring rules have a list as the first element. The second
14577 element is the score to be applied if the first element evaluated to a
14578 non-@code{nil} value.
14580 These lists may consist of three logical operators, one redirection
14581 operator, and various match operators.
14588 This logical operator will evaluate each of its arguments until it finds
14589 one that evaluates to @code{false}, and then it'll stop. If all arguments
14590 evaluate to @code{true} values, then this operator will return
14595 This logical operator will evaluate each of its arguments until it finds
14596 one that evaluates to @code{true}. If no arguments are @code{true},
14597 then this operator will return @code{false}.
14602 This logical operator only takes a single argument. It returns the
14603 logical negation of the value of its argument.
14607 There is an @dfn{indirection operator} that will make its arguments
14608 apply to the ancestors of the current article being scored. For
14609 instance, @code{1-} will make score rules apply to the parent of the
14610 current article. @code{2-} will make score rules apply to the
14611 grandparent of the current article. Alternatively, you can write
14612 @code{^^}, where the number of @code{^}s (carets) says how far back into
14613 the ancestry you want to go.
14615 Finally, we have the match operators. These are the ones that do the
14616 real work. Match operators are header name strings followed by a match
14617 and a match type. A typical match operator looks like @samp{("from"
14618 "Lars Ingebrigtsen" s)}. The header names are the same as when using
14619 simple scoring, and the match types are also the same.
14622 @node Advanced Scoring Examples
14623 @subsection Advanced Scoring Examples
14625 Let's say you want to increase the score of articles written by Lars
14626 when he's talking about Gnus:
14630 ("from" "Lars Ingebrigtsen")
14631 ("subject" "Gnus"))
14637 When he writes long articles, he sometimes has something nice to say:
14641 ("from" "Lars Ingebrigtsen")
14648 However, when he responds to things written by Reig Eigil Logge, you
14649 really don't want to read what he's written:
14653 ("from" "Lars Ingebrigtsen")
14654 (1- ("from" "Reig Eigir Logge")))
14658 Everybody that follows up Redmondo when he writes about disappearing
14659 socks should have their scores raised, but only when they talk about
14660 white socks. However, when Lars talks about socks, it's usually not
14667 ("from" "redmondo@@.*no" r)
14668 ("body" "disappearing.*socks" t)))
14669 (! ("from" "Lars Ingebrigtsen"))
14670 ("body" "white.*socks"))
14674 The possibilities are endless.
14677 @node Advanced Scoring Tips
14678 @subsection Advanced Scoring Tips
14680 The @code{&} and @code{|} logical operators do short-circuit logic.
14681 That is, they stop processing their arguments when it's clear what the
14682 result of the operation will be. For instance, if one of the arguments
14683 of an @code{&} evaluates to @code{false}, there's no point in evaluating
14684 the rest of the arguments. This means that you should put slow matches
14685 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
14686 @samp{subject}) first.
14688 The indirection arguments (@code{1-} and so on) will make their
14689 arguments work on previous generations of the thread. If you say
14700 Then that means "score on the from header of the grandparent of the
14701 current article". An indirection is quite fast, but it's better to say:
14707 ("subject" "Gnus")))
14714 (1- ("from" "Lars"))
14715 (1- ("subject" "Gnus")))
14720 @section Score Decays
14721 @cindex score decays
14724 You may find that your scores have a tendency to grow without
14725 bounds, especially if you're using adaptive scoring. If scores get too
14726 big, they lose all meaning---they simply max out and it's difficult to
14727 use them in any sensible way.
14729 @vindex gnus-decay-scores
14730 @findex gnus-decay-score
14731 @vindex gnus-decay-score-function
14732 Gnus provides a mechanism for decaying scores to help with this problem.
14733 When score files are loaded and @code{gnus-decay-scores} is
14734 non-@code{nil}, Gnus will run the score files through the decaying
14735 mechanism thereby lowering the scores of all non-permanent score rules.
14736 The decay itself if performed by the @code{gnus-decay-score-function}
14737 function, which is @code{gnus-decay-score} by default. Here's the
14738 definition of that function:
14741 (defun gnus-decay-score (score)
14743 This is done according to `gnus-score-decay-constant'
14744 and `gnus-score-decay-scale'."
14747 (* (if (< score 0) 1 -1)
14749 (max gnus-score-decay-constant
14751 gnus-score-decay-scale)))))))
14754 @vindex gnus-score-decay-scale
14755 @vindex gnus-score-decay-constant
14756 @code{gnus-score-decay-constant} is 3 by default and
14757 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
14761 Scores between -3 and 3 will be set to 0 when this function is called.
14764 Scores with magnitudes between 3 and 60 will be shrunk by 3.
14767 Scores with magnitudes greater than 60 will be shrunk by 5% of the
14771 If you don't like this decay function, write your own. It is called
14772 with the score to be decayed as its only parameter, and it should return
14773 the new score, which should be an integer.
14775 Gnus will try to decay scores once a day. If you haven't run Gnus for
14776 four days, Gnus will decay the scores four times, for instance.
14783 * Process/Prefix:: A convention used by many treatment commands.
14784 * Interactive:: Making Gnus ask you many questions.
14785 * Symbolic Prefixes:: How to supply some Gnus functions with options.
14786 * Formatting Variables:: You can specify what buffers should look like.
14787 * Windows Configuration:: Configuring the Gnus buffer windows.
14788 * Faces and Fonts:: How to change how faces look.
14789 * Compilation:: How to speed Gnus up.
14790 * Mode Lines:: Displaying information in the mode lines.
14791 * Highlighting and Menus:: Making buffers look all nice and cozy.
14792 * Buttons:: Get tendonitis in ten easy steps!
14793 * Daemons:: Gnus can do things behind your back.
14794 * NoCeM:: How to avoid spam and other fatty foods.
14795 * Undo:: Some actions can be undone.
14796 * Moderation:: What to do if you're a moderator.
14797 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
14798 * Fuzzy Matching:: What's the big fuzz?
14799 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
14800 * Various Various:: Things that are really various.
14804 @node Process/Prefix
14805 @section Process/Prefix
14806 @cindex process/prefix convention
14808 Many functions, among them functions for moving, decoding and saving
14809 articles, use what is known as the @dfn{Process/Prefix convention}.
14811 This is a method for figuring out what articles the user wants the
14812 command to be performed on.
14816 If the numeric prefix is N, perform the operation on the next N
14817 articles, starting with the current one. If the numeric prefix is
14818 negative, perform the operation on the previous N articles, starting
14819 with the current one.
14821 @vindex transient-mark-mode
14822 If @code{transient-mark-mode} in non-@code{nil} and the region is
14823 active, all articles in the region will be worked upon.
14825 If there is no numeric prefix, but some articles are marked with the
14826 process mark, perform the operation on the articles marked with
14829 If there is neither a numeric prefix nor any articles marked with the
14830 process mark, just perform the operation on the current article.
14832 Quite simple, really, but it needs to be made clear so that surprises
14835 Commands that react to the process mark will push the current list of
14836 process marked articles onto a stack and will then clear all process
14837 marked articles. You can restore the previous configuration with the
14838 @kbd{M P y} command (@pxref{Setting Process Marks}).
14840 @vindex gnus-summary-goto-unread
14841 One thing that seems to shock & horrify lots of people is that, for
14842 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
14843 Since each @kbd{d} (which marks the current article as read) by default
14844 goes to the next unread article after marking, this means that @kbd{3 d}
14845 will mark the next three unread articles as read, no matter what the
14846 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
14847 @code{nil} for a more straightforward action.
14851 @section Interactive
14852 @cindex interaction
14856 @item gnus-novice-user
14857 @vindex gnus-novice-user
14858 If this variable is non-@code{nil}, you are either a newcomer to the
14859 World of Usenet, or you are very cautious, which is a nice thing to be,
14860 really. You will be given questions of the type ``Are you sure you want
14861 to do this?'' before doing anything dangerous. This is @code{t} by
14864 @item gnus-expert-user
14865 @vindex gnus-expert-user
14866 If this variable is non-@code{nil}, you will seldom be asked any
14867 questions by Gnus. It will simply assume you know what you're doing, no
14868 matter how strange.
14870 @item gnus-interactive-catchup
14871 @vindex gnus-interactive-catchup
14872 Require confirmation before catching up a group if non-@code{nil}. It
14873 is @code{t} by default.
14875 @item gnus-interactive-exit
14876 @vindex gnus-interactive-exit
14877 Require confirmation before exiting Gnus. This variable is @code{t} by
14882 @node Symbolic Prefixes
14883 @section Symbolic Prefixes
14884 @cindex symbolic prefixes
14886 Quite a lot of Emacs commands react to the (numeric) prefix. For
14887 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
14888 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
14889 rule of 900 to the current article.
14891 This is all nice and well, but what if you want to give a command some
14892 additional information? Well, what most commands do is interpret the
14893 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
14894 doesn't want a backup file to be created when saving the current buffer,
14895 for instance. But what if you want to save without making a backup
14896 file, and you want Emacs to flash lights and play a nice tune at the
14897 same time? You can't, and you're probably perfectly happy that way.
14899 @kindex M-i (Summary)
14900 @findex gnus-symbolic-argument
14901 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
14902 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
14903 character typed in is the value. You can stack as many @kbd{M-i}
14904 prefixes as you want. @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
14905 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b M-C-u} means
14906 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
14907 @code{b}''. You get the drift.
14909 Typing in symbolic prefixes to commands that don't accept them doesn't
14910 hurt, but it doesn't do any good either. Currently not many Gnus
14911 functions make use of the symbolic prefix.
14913 If you're interested in how Gnus implements this, @pxref{Extended
14917 @node Formatting Variables
14918 @section Formatting Variables
14919 @cindex formatting variables
14921 Throughout this manual you've probably noticed lots of variables called
14922 things like @code{gnus-group-line-format} and
14923 @code{gnus-summary-mode-line-format}. These control how Gnus is to
14924 output lines in the various buffers. There's quite a lot of them.
14925 Fortunately, they all use the same syntax, so there's not that much to
14928 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
14929 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
14930 lots of percentages everywhere.
14933 * Formatting Basics:: A formatting variable is basically a format string.
14934 * Mode Line Formatting:: Some rules about mode line formatting variables.
14935 * Advanced Formatting:: Modifying output in various ways.
14936 * User-Defined Specs:: Having Gnus call your own functions.
14937 * Formatting Fonts:: Making the formatting look colorful and nice.
14940 Currently Gnus uses the following formatting variables:
14941 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
14942 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
14943 @code{gnus-group-mode-line-format},
14944 @code{gnus-summary-mode-line-format},
14945 @code{gnus-article-mode-line-format},
14946 @code{gnus-server-mode-line-format}, and
14947 @code{gnus-summary-pick-line-format}.
14949 All these format variables can also be arbitrary elisp forms. In that
14950 case, they will be @code{eval}ed to insert the required lines.
14952 @kindex M-x gnus-update-format
14953 @findex gnus-update-format
14954 Gnus includes a command to help you while creating your own format
14955 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
14956 update the spec in question and pop you to a buffer where you can
14957 examine the resulting lisp code to be run to generate the line.
14961 @node Formatting Basics
14962 @subsection Formatting Basics
14964 Each @samp{%} element will be replaced by some string or other when the
14965 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
14966 spec, and pad with spaces to get a 5-character field''.
14968 As with normal C and Emacs Lisp formatting strings, the numerical
14969 modifier between the @samp{%} and the formatting type character will
14970 @dfn{pad} the output so that it is always at least that long.
14971 @samp{%5y} will make the field always (at least) five characters wide by
14972 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
14975 You may also wish to limit the length of the field to protect against
14976 particularly wide values. For that you can say @samp{%4,6y}, which
14977 means that the field will never be more than 6 characters wide and never
14978 less than 4 characters wide.
14981 @node Mode Line Formatting
14982 @subsection Mode Line Formatting
14984 Mode line formatting variables (e.g.,
14985 @code{gnus-summary-mode-line-format}) follow the same rules as other,
14986 buffer line oriented formatting variables (@pxref{Formatting Basics})
14987 with the following two differences:
14992 There must be no newline (@samp{\n}) at the end.
14995 The special @samp{%%b} spec can be used to display the buffer name.
14996 Well, it's no spec at all, really---@samp{%%} is just a way to quote
14997 @samp{%} to allow it to pass through the formatting machinery unmangled,
14998 so that Emacs receives @samp{%b}, which is something the Emacs mode line
14999 display interprets to mean ``show the buffer name''. For a full list of
15000 mode line specs Emacs understands, see the documentation of the
15001 @code{mode-line-format} variable.
15006 @node Advanced Formatting
15007 @subsection Advanced Formatting
15009 It is frequently useful to post-process the fields in some way.
15010 Padding, limiting, cutting off parts and suppressing certain values can
15011 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
15012 look like @samp{%~(cut 3)~(ignore "0")y}.
15014 These are the valid modifiers:
15019 Pad the field to the left with spaces until it reaches the required
15023 Pad the field to the right with spaces until it reaches the required
15028 Cut off characters from the left until it reaches the specified length.
15031 Cut off characters from the right until it reaches the specified
15036 Cut off the specified number of characters from the left.
15039 Cut off the specified number of characters from the right.
15042 Return an empty string if the field is equal to the specified value.
15045 Use the specified form as the field value when the @samp{@@} spec is
15049 Let's take an example. The @samp{%o} spec in the summary mode lines
15050 will return a date in compact ISO8601 format---@samp{19960809T230410}.
15051 This is quite a mouthful, so we want to shave off the century number and
15052 the time, leaving us with a six-character date. That would be
15053 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
15054 maxing, and we need the padding to ensure that the date is never less
15055 than 6 characters to make it look nice in columns.)
15057 Ignoring is done first; then cutting; then maxing; and then as the very
15058 last operation, padding.
15060 If you use lots of these advanced thingies, you'll find that Gnus gets
15061 quite slow. This can be helped enormously by running @kbd{M-x
15062 gnus-compile} when you are satisfied with the look of your lines.
15063 @xref{Compilation}.
15066 @node User-Defined Specs
15067 @subsection User-Defined Specs
15069 All the specs allow for inserting user defined specifiers---@samp{u}.
15070 The next character in the format string should be a letter. Gnus
15071 will call the function @code{gnus-user-format-function-}@samp{X}, where
15072 @samp{X} is the letter following @samp{%u}. The function will be passed
15073 a single parameter---what the parameter means depends on what buffer
15074 it's being called from. The function should return a string, which will
15075 be inserted into the buffer just like information from any other
15076 specifier. This function may also be called with dummy values, so it
15077 should protect against that.
15079 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
15080 much the same without defining new functions. Here's an example:
15081 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
15082 given here will be evaluated to yield the current line number, and then
15086 @node Formatting Fonts
15087 @subsection Formatting Fonts
15089 There are specs for highlighting, and these are shared by all the format
15090 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
15091 the special @code{mouse-face} property set, which means that it will be
15092 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
15095 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
15096 normal faces set using @code{gnus-face-0}, which is @code{bold} by
15097 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
15098 and so on. Create as many faces as you wish. The same goes for the
15099 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
15100 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
15102 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
15103 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you say
15104 @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
15105 @code{gnus-balloon-face-*} variables should be either strings or
15106 symbols naming functions that return a string. Under @code{balloon-help-mode},
15107 when the mouse passes over text with this property set, a balloon window
15108 will appear and display the string. Please refer to the doc string of
15109 @code{balloon-help-mode} for more information on this.
15111 Here's an alternative recipe for the group buffer:
15114 ;; Create three face types.
15115 (setq gnus-face-1 'bold)
15116 (setq gnus-face-3 'italic)
15118 ;; We want the article count to be in
15119 ;; a bold and green face. So we create
15120 ;; a new face called `my-green-bold'.
15121 (copy-face 'bold 'my-green-bold)
15123 (set-face-foreground 'my-green-bold "ForestGreen")
15124 (setq gnus-face-2 'my-green-bold)
15126 ;; Set the new & fancy format.
15127 (setq gnus-group-line-format
15128 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
15131 I'm sure you'll be able to use this scheme to create totally unreadable
15132 and extremely vulgar displays. Have fun!
15134 Note that the @samp{%(} specs (and friends) do not make any sense on the
15135 mode-line variables.
15138 @node Windows Configuration
15139 @section Windows Configuration
15140 @cindex windows configuration
15142 No, there's nothing here about X, so be quiet.
15144 @vindex gnus-use-full-window
15145 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
15146 other windows and occupy the entire Emacs screen by itself. It is
15147 @code{t} by default.
15149 Setting this variable to @code{nil} kinda works, but there are
15150 glitches. Use at your own peril.
15152 @vindex gnus-buffer-configuration
15153 @code{gnus-buffer-configuration} describes how much space each Gnus
15154 buffer should be given. Here's an excerpt of this variable:
15157 ((group (vertical 1.0 (group 1.0 point)
15158 (if gnus-carpal (group-carpal 4))))
15159 (article (vertical 1.0 (summary 0.25 point)
15163 This is an alist. The @dfn{key} is a symbol that names some action or
15164 other. For instance, when displaying the group buffer, the window
15165 configuration function will use @code{group} as the key. A full list of
15166 possible names is listed below.
15168 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
15169 should occupy. To take the @code{article} split as an example -
15172 (article (vertical 1.0 (summary 0.25 point)
15176 This @dfn{split} says that the summary buffer should occupy 25% of upper
15177 half of the screen, and that it is placed over the article buffer. As
15178 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
15179 reaching for that calculator there). However, the special number
15180 @code{1.0} is used to signal that this buffer should soak up all the
15181 rest of the space available after the rest of the buffers have taken
15182 whatever they need. There should be only one buffer with the @code{1.0}
15183 size spec per split.
15185 Point will be put in the buffer that has the optional third element
15186 @code{point}. In a @code{frame} split, the last subsplit having a leaf
15187 split where the tag @code{frame-focus} is a member (i.e. is the third or
15188 fourth element in the list, depending on whether the @code{point} tag is
15189 present) gets focus.
15191 Here's a more complicated example:
15194 (article (vertical 1.0 (group 4)
15195 (summary 0.25 point)
15196 (if gnus-carpal (summary-carpal 4))
15200 If the size spec is an integer instead of a floating point number,
15201 then that number will be used to say how many lines a buffer should
15202 occupy, not a percentage.
15204 If the @dfn{split} looks like something that can be @code{eval}ed (to be
15205 precise---if the @code{car} of the split is a function or a subr), this
15206 split will be @code{eval}ed. If the result is non-@code{nil}, it will
15207 be used as a split. This means that there will be three buffers if
15208 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
15211 Not complicated enough for you? Well, try this on for size:
15214 (article (horizontal 1.0
15219 (summary 0.25 point)
15224 Whoops. Two buffers with the mystery 100% tag. And what's that
15225 @code{horizontal} thingie?
15227 If the first element in one of the split is @code{horizontal}, Gnus will
15228 split the window horizontally, giving you two windows side-by-side.
15229 Inside each of these strips you may carry on all you like in the normal
15230 fashion. The number following @code{horizontal} says what percentage of
15231 the screen is to be given to this strip.
15233 For each split, there @emph{must} be one element that has the 100% tag.
15234 The splitting is never accurate, and this buffer will eat any leftover
15235 lines from the splits.
15237 To be slightly more formal, here's a definition of what a valid split
15241 split = frame | horizontal | vertical | buffer | form
15242 frame = "(frame " size *split ")"
15243 horizontal = "(horizontal " size *split ")"
15244 vertical = "(vertical " size *split ")"
15245 buffer = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
15246 size = number | frame-params
15247 buffer-name = group | article | summary ...
15250 The limitations are that the @code{frame} split can only appear as the
15251 top-level split. @var{form} should be an Emacs Lisp form that should
15252 return a valid split. We see that each split is fully recursive, and
15253 may contain any number of @code{vertical} and @code{horizontal} splits.
15255 @vindex gnus-window-min-width
15256 @vindex gnus-window-min-height
15257 @cindex window height
15258 @cindex window width
15259 Finding the right sizes can be a bit complicated. No window may be less
15260 than @code{gnus-window-min-height} (default 1) characters high, and all
15261 windows must be at least @code{gnus-window-min-width} (default 1)
15262 characters wide. Gnus will try to enforce this before applying the
15263 splits. If you want to use the normal Emacs window width/height limit,
15264 you can just set these two variables to @code{nil}.
15266 If you're not familiar with Emacs terminology, @code{horizontal} and
15267 @code{vertical} splits may work the opposite way of what you'd expect.
15268 Windows inside a @code{horizontal} split are shown side-by-side, and
15269 windows within a @code{vertical} split are shown above each other.
15271 @findex gnus-configure-frame
15272 If you want to experiment with window placement, a good tip is to call
15273 @code{gnus-configure-frame} directly with a split. This is the function
15274 that does all the real work when splitting buffers. Below is a pretty
15275 nonsensical configuration with 5 windows; two for the group buffer and
15276 three for the article buffer. (I said it was nonsensical.) If you
15277 @code{eval} the statement below, you can get an idea of how that would
15278 look straight away, without going through the normal Gnus channels.
15279 Play with it until you're satisfied, and then use
15280 @code{gnus-add-configuration} to add your new creation to the buffer
15281 configuration list.
15284 (gnus-configure-frame
15288 (article 0.3 point))
15296 You might want to have several frames as well. No prob---just use the
15297 @code{frame} split:
15300 (gnus-configure-frame
15303 (summary 0.25 point frame-focus)
15305 (vertical ((height . 5) (width . 15)
15306 (user-position . t)
15307 (left . -1) (top . 1))
15312 This split will result in the familiar summary/article window
15313 configuration in the first (or ``main'') frame, while a small additional
15314 frame will be created where picons will be shown. As you can see,
15315 instead of the normal @code{1.0} top-level spec, each additional split
15316 should have a frame parameter alist as the size spec.
15317 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
15318 Reference Manual}. Under XEmacs, a frame property list will be
15319 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
15321 The list of all possible keys for @code{gnus-buffer-configuration} can
15322 be found in its default value.
15324 Note that the @code{message} key is used for both
15325 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
15326 it is desirable to distinguish between the two, something like this
15330 (message (horizontal 1.0
15331 (vertical 1.0 (message 1.0 point))
15333 (if (buffer-live-p gnus-summary-buffer)
15338 One common desire for a multiple frame split is to have a separate frame
15339 for composing mail and news while leaving the original frame intact. To
15340 accomplish that, something like the following can be done:
15343 (message (frame 1.0
15344 (if (not (buffer-live-p gnus-summary-buffer))
15345 (car (cdr (assoc 'group gnus-buffer-configuration)))
15346 (car (cdr (assoc 'summary gnus-buffer-configuration))))
15347 (vertical ((user-position . t) (top . 1) (left . 1)
15348 (name . "Message"))
15349 (message 1.0 point))))
15352 @findex gnus-add-configuration
15353 Since the @code{gnus-buffer-configuration} variable is so long and
15354 complicated, there's a function you can use to ease changing the config
15355 of a single setting: @code{gnus-add-configuration}. If, for instance,
15356 you want to change the @code{article} setting, you could say:
15359 (gnus-add-configuration
15360 '(article (vertical 1.0
15362 (summary .25 point)
15366 You'd typically stick these @code{gnus-add-configuration} calls in your
15367 @file{.gnus.el} file or in some startup hook---they should be run after
15368 Gnus has been loaded.
15370 @vindex gnus-always-force-window-configuration
15371 If all windows mentioned in the configuration are already visible, Gnus
15372 won't change the window configuration. If you always want to force the
15373 ``right'' window configuration, you can set
15374 @code{gnus-always-force-window-configuration} to non-@code{nil}.
15376 If you're using tree displays (@pxref{Tree Display}), and the tree
15377 window is displayed vertically next to another window, you may also want
15378 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
15382 @node Faces and Fonts
15383 @section Faces and Fonts
15388 Fiddling with fonts and faces used to be very difficult, but these days
15389 it is very simple. You simply say @kbd{M-x customize-face}, pick out
15390 the face you want to alter, and alter it via the standard Customize
15395 @section Compilation
15396 @cindex compilation
15397 @cindex byte-compilation
15399 @findex gnus-compile
15401 Remember all those line format specification variables?
15402 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
15403 on. Now, Gnus will of course heed whatever these variables are, but,
15404 unfortunately, changing them will mean a quite significant slow-down.
15405 (The default values of these variables have byte-compiled functions
15406 associated with them, while the user-generated versions do not, of
15409 To help with this, you can run @kbd{M-x gnus-compile} after you've
15410 fiddled around with the variables and feel that you're (kind of)
15411 satisfied. This will result in the new specs being byte-compiled, and
15412 you'll get top speed again. Gnus will save these compiled specs in the
15413 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
15414 this function, though---you should compile them yourself by sticking
15415 them into the @code{.gnus.el} file and byte-compiling that file.)
15419 @section Mode Lines
15422 @vindex gnus-updated-mode-lines
15423 @code{gnus-updated-mode-lines} says what buffers should keep their mode
15424 lines updated. It is a list of symbols. Supported symbols include
15425 @code{group}, @code{article}, @code{summary}, @code{server},
15426 @code{browse}, and @code{tree}. If the corresponding symbol is present,
15427 Gnus will keep that mode line updated with information that may be
15428 pertinent. If this variable is @code{nil}, screen refresh may be
15431 @cindex display-time
15433 @vindex gnus-mode-non-string-length
15434 By default, Gnus displays information on the current article in the mode
15435 lines of the summary and article buffers. The information Gnus wishes
15436 to display (e.g. the subject of the article) is often longer than the
15437 mode lines, and therefore have to be cut off at some point. The
15438 @code{gnus-mode-non-string-length} variable says how long the other
15439 elements on the line is (i.e., the non-info part). If you put
15440 additional elements on the mode line (e.g. a clock), you should modify
15443 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
15445 (add-hook 'display-time-hook
15446 (lambda () (setq gnus-mode-non-string-length
15448 (if line-number-mode 5 0)
15449 (if column-number-mode 4 0)
15450 (length display-time-string)))))
15453 If this variable is @code{nil} (which is the default), the mode line
15454 strings won't be chopped off, and they won't be padded either. Note
15455 that the default is unlikely to be desirable, as even the percentage
15456 complete in the buffer may be crowded off the mode line; the user should
15457 configure this variable appropriately for her configuration.
15460 @node Highlighting and Menus
15461 @section Highlighting and Menus
15463 @cindex highlighting
15466 @vindex gnus-visual
15467 The @code{gnus-visual} variable controls most of the Gnus-prettifying
15468 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
15469 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
15472 This variable can be a list of visual properties that are enabled. The
15473 following elements are valid, and are all included by default:
15476 @item group-highlight
15477 Do highlights in the group buffer.
15478 @item summary-highlight
15479 Do highlights in the summary buffer.
15480 @item article-highlight
15481 Do highlights in the article buffer.
15483 Turn on highlighting in all buffers.
15485 Create menus in the group buffer.
15487 Create menus in the summary buffers.
15489 Create menus in the article buffer.
15491 Create menus in the browse buffer.
15493 Create menus in the server buffer.
15495 Create menus in the score buffers.
15497 Create menus in all buffers.
15500 So if you only want highlighting in the article buffer and menus in all
15501 buffers, you could say something like:
15504 (setq gnus-visual '(article-highlight menu))
15507 If you want highlighting only and no menus whatsoever, you'd say:
15510 (setq gnus-visual '(highlight))
15513 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
15514 in all Gnus buffers.
15516 Other general variables that influence the look of all buffers include:
15519 @item gnus-mouse-face
15520 @vindex gnus-mouse-face
15521 This is the face (i.e., font) used for mouse highlighting in Gnus. No
15522 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
15526 There are hooks associated with the creation of all the different menus:
15530 @item gnus-article-menu-hook
15531 @vindex gnus-article-menu-hook
15532 Hook called after creating the article mode menu.
15534 @item gnus-group-menu-hook
15535 @vindex gnus-group-menu-hook
15536 Hook called after creating the group mode menu.
15538 @item gnus-summary-menu-hook
15539 @vindex gnus-summary-menu-hook
15540 Hook called after creating the summary mode menu.
15542 @item gnus-server-menu-hook
15543 @vindex gnus-server-menu-hook
15544 Hook called after creating the server mode menu.
15546 @item gnus-browse-menu-hook
15547 @vindex gnus-browse-menu-hook
15548 Hook called after creating the browse mode menu.
15550 @item gnus-score-menu-hook
15551 @vindex gnus-score-menu-hook
15552 Hook called after creating the score mode menu.
15563 Those new-fangled @dfn{mouse} contraptions is very popular with the
15564 young, hep kids who don't want to learn the proper way to do things
15565 these days. Why, I remember way back in the summer of '89, when I was
15566 using Emacs on a Tops 20 system. Three hundred users on one single
15567 machine, and every user was running Simula compilers. Bah!
15571 @vindex gnus-carpal
15572 Well, you can make Gnus display bufferfuls of buttons you can click to
15573 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
15574 really. Tell the chiropractor I sent you.
15579 @item gnus-carpal-mode-hook
15580 @vindex gnus-carpal-mode-hook
15581 Hook run in all carpal mode buffers.
15583 @item gnus-carpal-button-face
15584 @vindex gnus-carpal-button-face
15585 Face used on buttons.
15587 @item gnus-carpal-header-face
15588 @vindex gnus-carpal-header-face
15589 Face used on carpal buffer headers.
15591 @item gnus-carpal-group-buffer-buttons
15592 @vindex gnus-carpal-group-buffer-buttons
15593 Buttons in the group buffer.
15595 @item gnus-carpal-summary-buffer-buttons
15596 @vindex gnus-carpal-summary-buffer-buttons
15597 Buttons in the summary buffer.
15599 @item gnus-carpal-server-buffer-buttons
15600 @vindex gnus-carpal-server-buffer-buttons
15601 Buttons in the server buffer.
15603 @item gnus-carpal-browse-buffer-buttons
15604 @vindex gnus-carpal-browse-buffer-buttons
15605 Buttons in the browse buffer.
15608 All the @code{buttons} variables are lists. The elements in these list
15609 are either cons cells where the @code{car} contains a text to be displayed and
15610 the @code{cdr} contains a function symbol, or a simple string.
15618 Gnus, being larger than any program ever written (allegedly), does lots
15619 of strange stuff that you may wish to have done while you're not
15620 present. For instance, you may want it to check for new mail once in a
15621 while. Or you may want it to close down all connections to all servers
15622 when you leave Emacs idle. And stuff like that.
15624 Gnus will let you do stuff like that by defining various
15625 @dfn{handlers}. Each handler consists of three elements: A
15626 @var{function}, a @var{time}, and an @var{idle} parameter.
15628 Here's an example of a handler that closes connections when Emacs has
15629 been idle for thirty minutes:
15632 (gnus-demon-close-connections nil 30)
15635 Here's a handler that scans for PGP headers every hour when Emacs is
15639 (gnus-demon-scan-pgp 60 t)
15642 This @var{time} parameter and than @var{idle} parameter work together
15643 in a strange, but wonderful fashion. Basically, if @var{idle} is
15644 @code{nil}, then the function will be called every @var{time} minutes.
15646 If @var{idle} is @code{t}, then the function will be called after
15647 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
15648 the function will never be called. But once Emacs goes idle, the
15649 function will be called every @var{time} minutes.
15651 If @var{idle} is a number and @var{time} is a number, the function will
15652 be called every @var{time} minutes only when Emacs has been idle for
15653 @var{idle} minutes.
15655 If @var{idle} is a number and @var{time} is @code{nil}, the function
15656 will be called once every time Emacs has been idle for @var{idle}
15659 And if @var{time} is a string, it should look like @samp{07:31}, and
15660 the function will then be called once every day somewhere near that
15661 time. Modified by the @var{idle} parameter, of course.
15663 @vindex gnus-demon-timestep
15664 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
15665 seconds. This is 60 by default. If you change that variable,
15666 all the timings in the handlers will be affected.)
15668 So, if you want to add a handler, you could put something like this in
15669 your @file{.gnus} file:
15671 @findex gnus-demon-add-handler
15673 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
15676 @findex gnus-demon-add-nocem
15677 @findex gnus-demon-add-scanmail
15678 @findex gnus-demon-add-rescan
15679 @findex gnus-demon-add-scan-timestamps
15680 @findex gnus-demon-add-disconnection
15681 Some ready-made functions to do this have been created:
15682 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
15683 @code{gnus-demon-add-nntp-close-connection},
15684 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
15685 @code{gnus-demon-add-scanmail}. Just put those functions in your
15686 @file{.gnus} if you want those abilities.
15688 @findex gnus-demon-init
15689 @findex gnus-demon-cancel
15690 @vindex gnus-demon-handlers
15691 If you add handlers to @code{gnus-demon-handlers} directly, you should
15692 run @code{gnus-demon-init} to make the changes take hold. To cancel all
15693 daemons, you can use the @code{gnus-demon-cancel} function.
15695 Note that adding daemons can be pretty naughty if you over do it. Adding
15696 functions that scan all news and mail from all servers every two seconds
15697 is a sure-fire way of getting booted off any respectable system. So
15706 @dfn{Spamming} is posting the same article lots and lots of times.
15707 Spamming is bad. Spamming is evil.
15709 Spamming is usually canceled within a day or so by various anti-spamming
15710 agencies. These agencies usually also send out @dfn{NoCeM} messages.
15711 NoCeM is pronounced ``no see-'em'', and means what the name
15712 implies---these are messages that make the offending articles, like, go
15715 What use are these NoCeM messages if the articles are canceled anyway?
15716 Some sites do not honor cancel messages and some sites just honor cancels
15717 from a select few people. Then you may wish to make use of the NoCeM
15718 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
15720 Gnus can read and parse the messages in this group automatically, and
15721 this will make spam disappear.
15723 There are some variables to customize, of course:
15726 @item gnus-use-nocem
15727 @vindex gnus-use-nocem
15728 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
15731 @item gnus-nocem-groups
15732 @vindex gnus-nocem-groups
15733 Gnus will look for NoCeM messages in the groups in this list. The
15734 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
15735 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
15737 @item gnus-nocem-issuers
15738 @vindex gnus-nocem-issuers
15739 There are many people issuing NoCeM messages. This list says what
15740 people you want to listen to. The default is @code{("Automoose-1"
15741 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
15742 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
15743 (Richard E. Depew)")}; fine, upstanding citizens all of them.
15745 Known despammers that you can put in this list include:
15748 @item clewis@@ferret.ocunix.on.ca;
15749 @cindex Chris Lewis
15750 Chris Lewis---Major Canadian despammer who has probably canceled more
15751 usenet abuse than anybody else.
15754 @cindex CancelMoose[tm]
15755 The CancelMoose[tm] on autopilot. The CancelMoose[tm] is reputed to be
15756 Norwegian, and was the person(s) who invented NoCeM.
15758 @item jem@@xpat.com;
15760 John Milburn---despammer located in Korea who is getting very busy these
15763 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
15764 Richard E. Depew---lone American despammer. He mostly cancels binary
15765 postings to non-binary groups and removes spews (regurgitated articles).
15768 You do not have to heed NoCeM messages from all these people---just the
15769 ones you want to listen to. You also don't have to accept all NoCeM
15770 messages from the people you like. Each NoCeM message has a @dfn{type}
15771 header that gives the message a (more or less, usually less) rigorous
15772 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
15773 @samp{binary}, and @samp{troll}. To specify this, you have to use
15774 @var{(issuer conditions ...)} elements in the list. Each condition is
15775 either a string (which is a regexp that matches types you want to use)
15776 or a list on the form @code{(not STRING)}, where @var{string} is a
15777 regexp that matches types you don't want to use.
15779 For instance, if you want all NoCeM messages from Chris Lewis except his
15780 @samp{troll} messages, you'd say:
15783 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
15786 On the other hand, if you just want nothing but his @samp{spam} and
15787 @samp{spew} messages, you'd say:
15790 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
15793 The specs are applied left-to-right.
15796 @item gnus-nocem-verifyer
15797 @vindex gnus-nocem-verifyer
15799 This should be a function for verifying that the NoCeM issuer is who she
15800 says she is. The default is @code{mc-verify}, which is a Mailcrypt
15801 function. If this is too slow and you don't care for verification
15802 (which may be dangerous), you can set this variable to @code{nil}.
15804 If you want signed NoCeM messages to be verified and unsigned messages
15805 not to be verified (but used anyway), you could do something like:
15808 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
15810 (defun my-gnus-mc-verify ()
15818 This might be dangerous, though.
15820 @item gnus-nocem-directory
15821 @vindex gnus-nocem-directory
15822 This is where Gnus will store its NoCeM cache files. The default is
15823 @file{~/News/NoCeM/}.
15825 @item gnus-nocem-expiry-wait
15826 @vindex gnus-nocem-expiry-wait
15827 The number of days before removing old NoCeM entries from the cache.
15828 The default is 15. If you make it shorter Gnus will be faster, but you
15829 might then see old spam.
15833 Using NoCeM could potentially be a memory hog. If you have many living
15834 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
15835 big. If this is a problem, you should kill off all (or most) of your
15836 unsubscribed groups (@pxref{Subscription Commands}).
15843 It is very useful to be able to undo actions one has done. In normal
15844 Emacs buffers, it's easy enough---you just push the @code{undo} button.
15845 In Gnus buffers, however, it isn't that simple.
15847 The things Gnus displays in its buffer is of no value whatsoever to
15848 Gnus---it's all just data designed to look nice to the user.
15849 Killing a group in the group buffer with @kbd{C-k} makes the line
15850 disappear, but that's just a side-effect of the real action---the
15851 removal of the group in question from the internal Gnus structures.
15852 Undoing something like that can't be done by the normal Emacs
15853 @code{undo} function.
15855 Gnus tries to remedy this somewhat by keeping track of what the user
15856 does and coming up with actions that would reverse the actions the user
15857 takes. When the user then presses the @code{undo} key, Gnus will run
15858 the code to reverse the previous action, or the previous actions.
15859 However, not all actions are easily reversible, so Gnus currently offers
15860 a few key functions to be undoable. These include killing groups,
15861 yanking groups, and changing the list of read articles of groups.
15862 That's it, really. More functions may be added in the future, but each
15863 added function means an increase in data to be stored, so Gnus will
15864 never be totally undoable.
15866 @findex gnus-undo-mode
15867 @vindex gnus-use-undo
15869 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
15870 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
15871 default. The @kbd{M-C-_} key performs the @code{gnus-undo} command
15872 command, which should feel kinda like the normal Emacs @code{undo}
15877 @section Moderation
15880 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
15881 It is not included in the standard Gnus package. Write a mail to
15882 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
15885 The moderation package is implemented as a minor mode for summary
15889 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
15892 in your @file{.gnus.el} file.
15894 If you are the moderator of @samp{rec.zoofle}, this is how it's
15899 You split your incoming mail by matching on
15900 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
15901 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
15904 You enter that group once in a while and post articles using the @kbd{e}
15905 (edit-and-post) or @kbd{s} (just send unedited) commands.
15908 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
15909 articles that weren't approved by you, you can cancel them with the
15913 To use moderation mode in these two groups, say:
15916 (setq gnus-moderated-list
15917 "^nnml:rec.zoofle$\\|^rec.zoofle$")
15921 @node XEmacs Enhancements
15922 @section XEmacs Enhancements
15925 XEmacs is able to display pictures and stuff, so Gnus has taken
15929 * Picons:: How to display pictures of what your reading.
15930 * Smileys:: Show all those happy faces the way they were meant to be shown.
15931 * Toolbar:: Click'n'drool.
15932 * XVarious:: Other XEmacsy Gnusey variables.
15945 So... You want to slow down your news reader even more! This is a
15946 good way to do so. Its also a great way to impress people staring
15947 over your shoulder as you read news.
15950 * Picon Basics:: What are picons and How do I get them.
15951 * Picon Requirements:: Don't go further if you aren't using XEmacs.
15952 * Easy Picons:: Displaying Picons---the easy way.
15953 * Hard Picons:: The way you should do it. You'll learn something.
15954 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
15959 @subsubsection Picon Basics
15961 What are Picons? To quote directly from the Picons Web site:
15970 @dfn{Picons} is short for ``personal icons''. They're small,
15971 constrained images used to represent users and domains on the net,
15972 organized into databases so that the appropriate image for a given
15973 e-mail address can be found. Besides users and domains, there are picon
15974 databases for Usenet newsgroups and weather forecasts. The picons are
15975 in either monochrome @code{XBM} format or color @code{XPM} and
15976 @code{GIF} formats.
15979 @vindex gnus-picons-piconsearch-url
15980 If you have a permanent connection to the Internet you can use Steve
15981 Kinzler's Picons Search engine by setting
15982 @code{gnus-picons-piconsearch-url} to the string @*
15983 @file{http://www.cs.indiana.edu/picons/search.html}.
15985 @vindex gnus-picons-database
15986 Otherwise you need a local copy of his database. For instructions on
15987 obtaining and installing the picons databases, point your Web browser at @*
15988 @file{http://www.cs.indiana.edu/picons/ftp/index.html}. Gnus expects
15989 picons to be installed into a location pointed to by
15990 @code{gnus-picons-database}.
15993 @node Picon Requirements
15994 @subsubsection Picon Requirements
15996 To have Gnus display Picons for you, you must be running XEmacs
15997 19.13 or greater since all other versions of Emacs aren't yet able to
16000 Additionally, you must have @code{x} support compiled into XEmacs. To
16001 display color picons which are much nicer than the black & white one,
16002 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
16004 @vindex gnus-picons-convert-x-face
16005 If you want to display faces from @code{X-Face} headers, you should have
16006 the @code{xface} support compiled into XEmacs. Otherwise you must have
16007 the @code{netpbm} utilities installed, or munge the
16008 @code{gnus-picons-convert-x-face} variable to use something else.
16012 @subsubsection Easy Picons
16014 To enable displaying picons, simply put the following line in your
16015 @file{~/.gnus} file and start Gnus.
16018 (setq gnus-use-picons t)
16019 (setq gnus-treat-display-picons t)
16022 and make sure @code{gnus-picons-database} points to the directory
16023 containing the Picons databases.
16025 Alternatively if you want to use the web piconsearch engine add this:
16028 (setq gnus-picons-piconsearch-url
16029 "http://www.cs.indiana.edu:800/piconsearch")
16034 @subsubsection Hard Picons
16042 Gnus can display picons for you as you enter and leave groups and
16043 articles. It knows how to interact with three sections of the picons
16044 database. Namely, it can display the picons newsgroup pictures,
16045 author's face picture(s), and the authors domain. To enable this
16046 feature, you need to select where to get the picons from, and where to
16051 @item gnus-picons-database
16052 @vindex gnus-picons-database
16053 The location of the picons database. Should point to a directory
16054 containing the @file{news}, @file{domains}, @file{users} (and so on)
16055 subdirectories. This is only useful if
16056 @code{gnus-picons-piconsearch-url} is @code{nil}. Defaults to
16057 @file{/usr/local/faces/}.
16059 @item gnus-picons-piconsearch-url
16060 @vindex gnus-picons-piconsearch-url
16061 The URL for the web picons search engine. The only currently known
16062 engine is @file{http://www.cs.indiana.edu:800/piconsearch}. To
16063 workaround network delays, icons will be fetched in the background. If
16064 this is @code{nil} 'the default), then picons are fetched from local
16065 database indicated by @code{gnus-picons-database}.
16067 @item gnus-picons-display-where
16068 @vindex gnus-picons-display-where
16069 Where the picon images should be displayed. It is @code{picons} by
16070 default (which by default maps to the buffer @samp{*Picons*}). Other
16071 valid places could be @code{article}, @code{summary}, or
16072 @samp{*scratch*} for all I care. Just make sure that you've made the
16073 buffer visible using the standard Gnus window configuration
16074 routines---@pxref{Windows Configuration}.
16076 @item gnus-picons-group-excluded-groups
16077 @vindex gnus-picons-group-excluded-groups
16078 Groups that are matched by this regexp won't have their group icons
16083 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
16084 window configuration for you to include the @code{picons} buffer.
16086 Now that you've made those decision, you need to add the following
16087 functions to the appropriate hooks so these pictures will get displayed
16090 @vindex gnus-picons-display-where
16092 @item gnus-article-display-picons
16093 @findex gnus-article-display-picons
16094 Looks up and displays the picons for the author and the author's domain
16095 in the @code{gnus-picons-display-where} buffer.
16097 @item gnus-picons-article-display-x-face
16098 @findex gnus-article-display-picons
16099 Decodes and displays the X-Face header if present.
16105 @node Picon Useless Configuration
16106 @subsubsection Picon Useless Configuration
16114 The following variables offer further control over how things are
16115 done, where things are located, and other useless stuff you really
16116 don't need to worry about.
16120 @item gnus-picons-news-directories
16121 @vindex gnus-picons-news-directories
16122 List of subdirectories to search in @code{gnus-picons-database} for
16123 newsgroups faces. @code{("news")} is the default.
16125 @item gnus-picons-user-directories
16126 @vindex gnus-picons-user-directories
16127 List of subdirectories to search in @code{gnus-picons-database} for user
16128 faces. @code{("local" "users" "usenix" "misc")} is the default.
16130 @item gnus-picons-domain-directories
16131 @vindex gnus-picons-domain-directories
16132 List of subdirectories to search in @code{gnus-picons-database} for
16133 domain name faces. Defaults to @code{("domains")}. Some people may
16134 want to add @samp{"unknown"} to this list.
16136 @item gnus-picons-convert-x-face
16137 @vindex gnus-picons-convert-x-face
16138 If you don't have @code{xface} support builtin XEmacs, this is the
16139 command to use to convert the @code{X-Face} header to an X bitmap
16140 (@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48,
16141 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
16142 gnus-picons-x-face-file-name)}
16144 @item gnus-picons-x-face-file-name
16145 @vindex gnus-picons-x-face-file-name
16146 Names a temporary file to store the @code{X-Face} bitmap in. Defaults
16147 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
16149 @item gnus-picons-has-modeline-p
16150 @vindex gnus-picons-has-modeline-p
16151 If you have set @code{gnus-picons-display-where} to @code{picons}, your
16152 XEmacs frame will become really cluttered. To alleviate this a bit you
16153 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
16154 remove the mode line from the Picons buffer. This is only useful if
16155 @code{gnus-picons-display-where} is @code{picons}.
16157 @item gnus-picons-refresh-before-display
16158 @vindex gnus-picons-refresh-before-display
16159 If non-nil, display the article buffer before computing the picons.
16160 Defaults to @code{nil}.
16162 @item gnus-picons-display-as-address
16163 @vindex gnus-picons-display-as-address
16164 If @code{t} display textual email addresses along with pictures.
16165 Defaults to @code{t}.
16167 @item gnus-picons-file-suffixes
16168 @vindex gnus-picons-file-suffixes
16169 Ordered list of suffixes on picon file names to try. Defaults to
16170 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
16172 @item gnus-picons-setup-hook
16173 @vindex gnus-picons-setup-hook
16174 Hook run in the picon buffer, if that is displayed.
16176 @item gnus-picons-display-article-move-p
16177 @vindex gnus-picons-display-article-move-p
16178 Whether to move point to first empty line when displaying picons. This
16179 has only an effect if `gnus-picons-display-where' has value `article'.
16181 If @code{nil}, display the picons in the @code{From} and
16182 @code{Newsgroups} lines. This is the defailt.
16184 @item gnus-picons-clear-cache-on-shutdown
16185 @vindex gnus-picons-clear-cache-on-shutdown
16186 Whether to clear the picons cache when exiting gnus. Gnus caches every
16187 picons it finds while it is running. This saves some time in the search
16188 process but eats some memory. If this variable is set to @code{nil},
16189 Gnus will never clear the cache itself; you will have to manually call
16190 @code{gnus-picons-clear-cache} to clear it. Otherwise the cache will be
16191 cleared every time you exit Gnus. Defaults to @code{t}.
16202 @subsection Smileys
16207 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
16212 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
16213 currently the only package that uses Smiley, it is documented here.
16215 In short---to use Smiley in Gnus, put the following in your
16216 @file{.gnus.el} file:
16219 (setq gnus-treat-display-smiley t)
16222 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
16223 the like---to pictures and displays those instead of the text smiley
16224 faces. The conversion is controlled by a list of regexps that matches
16225 text and maps that to file names.
16227 @vindex smiley-nosey-regexp-alist
16228 @vindex smiley-deformed-regexp-alist
16229 Smiley supplies two example conversion alists by default:
16230 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
16231 and so on), and @code{smiley-nosey-regexp-alist} (which matches
16232 @samp{:-)}, @samp{:-(} and so on).
16234 The alist used is specified by the @code{smiley-regexp-alist} variable,
16235 which defaults to the value of @code{smiley-deformed-regexp-alist}.
16237 The first item in each element is the regexp to be matched; the second
16238 element is the regexp match group that is to be replaced by the picture;
16239 and the third element is the name of the file to be displayed.
16241 The following variables customize where Smiley will look for these
16242 files, as well as the color to be used and stuff:
16246 @item smiley-data-directory
16247 @vindex smiley-data-directory
16248 Where Smiley will look for smiley faces files.
16250 @item smiley-flesh-color
16251 @vindex smiley-flesh-color
16252 Skin color. The default is @samp{yellow}, which is really racist.
16254 @item smiley-features-color
16255 @vindex smiley-features-color
16256 Color of the features of the face. The default is @samp{black}.
16258 @item smiley-tongue-color
16259 @vindex smiley-tongue-color
16260 Color of the tongue. The default is @samp{red}.
16262 @item smiley-circle-color
16263 @vindex smiley-circle-color
16264 Color of the circle around the face. The default is @samp{black}.
16266 @item smiley-mouse-face
16267 @vindex smiley-mouse-face
16268 Face used for mouse highlighting over the smiley face.
16274 @subsection Toolbar
16284 @item gnus-use-toolbar
16285 @vindex gnus-use-toolbar
16286 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
16287 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
16288 @code{right-toolbar}, or @code{left-toolbar}.
16290 @item gnus-group-toolbar
16291 @vindex gnus-group-toolbar
16292 The toolbar in the group buffer.
16294 @item gnus-summary-toolbar
16295 @vindex gnus-summary-toolbar
16296 The toolbar in the summary buffer.
16298 @item gnus-summary-mail-toolbar
16299 @vindex gnus-summary-mail-toolbar
16300 The toolbar in the summary buffer of mail groups.
16306 @subsection Various XEmacs Variables
16309 @item gnus-xmas-glyph-directory
16310 @vindex gnus-xmas-glyph-directory
16311 This is where Gnus will look for pictures. Gnus will normally
16312 auto-detect this directory, but you may set it manually if you have an
16313 unusual directory structure.
16315 @item gnus-xmas-logo-color-alist
16316 @vindex gnus-xmas-logo-color-alist
16317 This is an alist where the key is a type symbol and the values are the
16318 foreground and background color of the splash page glyph.
16320 @item gnus-xmas-logo-color-style
16321 @vindex gnus-xmas-logo-color-style
16322 This is the key used to look up the color in the alist described above.
16323 Valid values include @code{flame}, @code{pine}, @code{moss},
16324 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
16325 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
16327 @item gnus-xmas-modeline-glyph
16328 @vindex gnus-xmas-modeline-glyph
16329 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
16343 @node Fuzzy Matching
16344 @section Fuzzy Matching
16345 @cindex fuzzy matching
16347 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
16348 things like scoring, thread gathering and thread comparison.
16350 As opposed to regular expression matching, fuzzy matching is very fuzzy.
16351 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
16352 means, and the implementation has changed over time.
16354 Basically, it tries to remove all noise from lines before comparing.
16355 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
16356 out of the strings before comparing the results. This often leads to
16357 adequate results---even when faced with strings generated by text
16358 manglers masquerading as newsreaders.
16361 @node Thwarting Email Spam
16362 @section Thwarting Email Spam
16366 @cindex unsolicited commercial email
16368 In these last days of the Usenet, commercial vultures are hanging about
16369 and grepping through news like crazy to find email addresses they can
16370 foist off their scams and products to. As a reaction to this, many
16371 people have started putting nonsense addresses into their @code{From}
16372 lines. I think this is counterproductive---it makes it difficult for
16373 people to send you legitimate mail in response to things you write, as
16374 well as making it difficult to see who wrote what. This rewriting may
16375 perhaps be a bigger menace than the unsolicited commercial email itself
16378 The biggest problem I have with email spam is that it comes in under
16379 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
16380 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
16381 mail group, only to find two pyramid schemes, seven advertisements
16382 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
16383 and one mail asking me to repent and find some god.
16387 The way to deal with this is having Gnus split out all spam into a
16388 @samp{spam} mail group (@pxref{Splitting Mail}).
16390 First, pick one (1) valid mail address that you can be reached at, and
16391 put it in your @code{From} header of all your news articles. (I've
16392 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
16393 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
16394 sysadm whether your sendmail installation accepts keywords in the local
16395 part of the mail address.)
16398 (setq message-default-news-headers
16399 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
16402 Then put the following split rule in @code{nnmail-split-fancy}
16403 (@pxref{Fancy Mail Splitting}):
16408 (to "larsi@@trym.ifi.uio.no"
16409 (| ("subject" "re:.*" "misc")
16410 ("references" ".*@@.*" "misc")
16416 This says that all mail to this address is suspect, but if it has a
16417 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
16418 header, it's probably ok. All the rest goes to the @samp{spam} group.
16419 (This idea probably comes from Tim Pierce.)
16421 In addition, many mail spammers talk directly to your @code{smtp} server
16422 and do not include your email address explicitly in the @code{To}
16423 header. Why they do this is unknown---perhaps it's to thwart this
16424 thwarting scheme? In any case, this is trivial to deal with---you just
16425 put anything not addressed to you in the @samp{spam} group by ending
16426 your fancy split rule in this way:
16431 (to "larsi" "misc")
16435 In my experience, this will sort virtually everything into the right
16436 group. You still have to check the @samp{spam} group from time to time to
16437 check for legitimate mail, though. If you feel like being a good net
16438 citizen, you can even send off complaints to the proper authorities on
16439 each unsolicited commercial email---at your leisure.
16441 If you are also a lazy net citizen, you will probably prefer complaining
16442 automatically with the @file{gnus-junk.el} package, available FOR FREE
16443 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
16444 Since most e-mail spam is sent automatically, this may reconcile the
16445 cosmic balance somewhat.
16447 This works for me. It allows people an easy way to contact me (they can
16448 just press @kbd{r} in the usual way), and I'm not bothered at all with
16449 spam. It's a win-win situation. Forging @code{From} headers to point
16450 to non-existent domains is yucky, in my opinion.
16453 @node Various Various
16454 @section Various Various
16460 @item gnus-home-directory
16461 All Gnus path variables will be initialized from this variable, which
16462 defaults to @file{~/}.
16464 @item gnus-directory
16465 @vindex gnus-directory
16466 Most Gnus storage path variables will be initialized from this variable,
16467 which defaults to the @samp{SAVEDIR} environment variable, or
16468 @file{~/News/} if that variable isn't set.
16470 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
16471 This means that other directory variables that are initialized from this
16472 variable won't be set properly if you set this variable in
16473 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
16475 @item gnus-default-directory
16476 @vindex gnus-default-directory
16477 Not related to the above variable at all---this variable says what the
16478 default directory of all Gnus buffers should be. If you issue commands
16479 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
16480 default directory. If this variable is @code{nil} (which is the
16481 default), the default directory will be the default directory of the
16482 buffer you were in when you started Gnus.
16485 @vindex gnus-verbose
16486 This variable is an integer between zero and ten. The higher the value,
16487 the more messages will be displayed. If this variable is zero, Gnus
16488 will never flash any messages, if it is seven (which is the default),
16489 most important messages will be shown, and if it is ten, Gnus won't ever
16490 shut up, but will flash so many messages it will make your head swim.
16492 @item gnus-verbose-backends
16493 @vindex gnus-verbose-backends
16494 This variable works the same way as @code{gnus-verbose}, but it applies
16495 to the Gnus backends instead of Gnus proper.
16497 @item nnheader-max-head-length
16498 @vindex nnheader-max-head-length
16499 When the backends read straight heads of articles, they all try to read
16500 as little as possible. This variable (default 4096) specifies
16501 the absolute max length the backends will try to read before giving up
16502 on finding a separator line between the head and the body. If this
16503 variable is @code{nil}, there is no upper read bound. If it is
16504 @code{t}, the backends won't try to read the articles piece by piece,
16505 but read the entire articles. This makes sense with some versions of
16506 @code{ange-ftp} or @code{efs}.
16508 @item nnheader-head-chop-length
16509 @vindex nnheader-head-chop-length
16510 This variable (default 2048) says how big a piece of each article to
16511 read when doing the operation described above.
16513 @item nnheader-file-name-translation-alist
16514 @vindex nnheader-file-name-translation-alist
16516 @cindex invalid characters in file names
16517 @cindex characters in file names
16518 This is an alist that says how to translate characters in file names.
16519 For instance, if @samp{:} is invalid as a file character in file names
16520 on your system (you OS/2 user you), you could say something like:
16523 (setq nnheader-file-name-translation-alist
16527 In fact, this is the default value for this variable on OS/2 and MS
16528 Windows (phooey) systems.
16530 @item gnus-hidden-properties
16531 @vindex gnus-hidden-properties
16532 This is a list of properties to use to hide ``invisible'' text. It is
16533 @code{(invisible t intangible t)} by default on most systems, which
16534 makes invisible text invisible and intangible.
16536 @item gnus-parse-headers-hook
16537 @vindex gnus-parse-headers-hook
16538 A hook called before parsing headers. It can be used, for instance, to
16539 gather statistics on the headers fetched, or perhaps you'd like to prune
16540 some headers. I don't see why you'd want that, though.
16542 @item gnus-shell-command-separator
16543 @vindex gnus-shell-command-separator
16544 String used to separate two shell commands. The default is @samp{;}.
16553 Well, that's the manual---you can get on with your life now. Keep in
16554 touch. Say hello to your cats from me.
16556 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
16558 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
16564 Not because of victories @*
16567 but for the common sunshine,@*
16569 the largess of the spring.
16573 but for the day's work done@*
16574 as well as I was able;@*
16575 not for a seat upon the dais@*
16576 but at the common table.@*
16581 @chapter Appendices
16584 * History:: How Gnus got where it is today.
16585 * Terminology:: We use really difficult, like, words here.
16586 * Customization:: Tailoring Gnus to your needs.
16587 * Troubleshooting:: What you might try if things do not work.
16588 * Gnus Reference Guide:: Rilly, rilly technical stuff.
16589 * Emacs for Heathens:: A short introduction to Emacsian terms.
16590 * Frequently Asked Questions:: A question-and-answer session.
16598 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
16599 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
16601 If you want to investigate the person responsible for this outrage, you
16602 can point your (feh!) web browser to
16603 @file{http://www.stud.ifi.uio.no/~larsi/}. This is also the primary
16604 distribution point for the new and spiffy versions of Gnus, and is known
16605 as The Site That Destroys Newsrcs And Drives People Mad.
16607 During the first extended alpha period of development, the new Gnus was
16608 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
16609 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
16610 (Besides, the ``Gnus'' in this abbreviation should probably be
16611 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
16612 appropriate name, don't you think?)
16614 In any case, after spending all that energy on coming up with a new and
16615 spunky name, we decided that the name was @emph{too} spunky, so we
16616 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
16617 ``@sc{gnus}''. New vs. old.
16619 The first ``proper'' release of Gnus 5 was done in November 1995 when it
16620 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
16621 plus 15 Gnus 5.0 releases).
16623 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
16624 releases)) was released under the name ``Gnus 5.2'' (40 releases).
16626 On July 28th 1996 work on Red Gnus was begun, and it was released on
16627 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
16629 On September 13th 1997, Quassia Gnus was started and lasted 37
16630 releases. If was released as ``Gnus 5.6 on March 8th 1998.
16632 If you happen upon a version of Gnus that has a prefixed name --
16633 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
16634 don't panic. Don't let it know that you're frightened. Back away.
16635 Slowly. Whatever you do, don't run. Walk away, calmly, until you're
16636 out of its reach. Find a proper released version of Gnus and snuggle up
16640 * Why?:: What's the point of Gnus?
16641 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
16642 * Conformity:: Gnus tries to conform to all standards.
16643 * Emacsen:: Gnus can be run on a few modern Emacsen.
16644 * Gnus Development:: How Gnus is developed.
16645 * Contributors:: Oodles of people.
16646 * New Features:: Pointers to some of the new stuff in Gnus.
16647 * Newest Features:: Features so new that they haven't been written yet.
16654 What's the point of Gnus?
16656 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
16657 newsreader, that lets you do anything you can think of. That was my
16658 original motivation, but while working on Gnus, it has become clear to
16659 me that this generation of newsreaders really belong in the stone age.
16660 Newsreaders haven't developed much since the infancy of the net. If the
16661 volume continues to rise with the current rate of increase, all current
16662 newsreaders will be pretty much useless. How do you deal with
16663 newsgroups that have thousands of new articles each day? How do you
16664 keep track of millions of people who post?
16666 Gnus offers no real solutions to these questions, but I would very much
16667 like to see Gnus being used as a testing ground for new methods of
16668 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
16669 to separate the newsreader from the backends, Gnus now offers a simple
16670 interface for anybody who wants to write new backends for fetching mail
16671 and news from different sources. I have added hooks for customizations
16672 everywhere I could imagine it being useful. By doing so, I'm inviting
16673 every one of you to explore and invent.
16675 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
16676 @kbd{C-u 100 M-x all-hail-xemacs}.
16679 @node Compatibility
16680 @subsection Compatibility
16682 @cindex compatibility
16683 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
16684 bindings have been kept. More key bindings have been added, of course,
16685 but only in one or two obscure cases have old bindings been changed.
16690 @center In a cloud bones of steel.
16694 All commands have kept their names. Some internal functions have changed
16697 The @code{gnus-uu} package has changed drastically. @xref{Decoding
16700 One major compatibility question is the presence of several summary
16701 buffers. All variables relevant while reading a group are
16702 buffer-local to the summary buffer they belong in. Although many
16703 important variables have their values copied into their global
16704 counterparts whenever a command is executed in the summary buffer, this
16705 change might lead to incorrect values being used unless you are careful.
16707 All code that relies on knowledge of @sc{gnus} internals will probably
16708 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
16709 changing it in any way, as a matter of fact) is strictly verboten. Gnus
16710 maintains a hash table that points to the entries in this alist (which
16711 speeds up many functions), and changing the alist directly will lead to
16715 @cindex highlighting
16716 Old hilit19 code does not work at all. In fact, you should probably
16717 remove all hilit code from all Gnus hooks
16718 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
16719 Gnus provides various integrated functions for highlighting. These are
16720 faster and more accurate. To make life easier for everybody, Gnus will
16721 by default remove all hilit calls from all hilit hooks. Uncleanliness!
16724 Packages like @code{expire-kill} will no longer work. As a matter of
16725 fact, you should probably remove all old @sc{gnus} packages (and other
16726 code) when you start using Gnus. More likely than not, Gnus already
16727 does what you have written code to make @sc{gnus} do. (Snicker.)
16729 Even though old methods of doing things are still supported, only the
16730 new methods are documented in this manual. If you detect a new method of
16731 doing something while reading this manual, that does not mean you have
16732 to stop doing it the old way.
16734 Gnus understands all @sc{gnus} startup files.
16736 @kindex M-x gnus-bug
16738 @cindex reporting bugs
16740 Overall, a casual user who hasn't written much code that depends on
16741 @sc{gnus} internals should suffer no problems. If problems occur,
16742 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
16744 @vindex gnus-bug-create-help-buffer
16745 If you are in the habit of sending bug reports @emph{very} often, you
16746 may find the helpful help buffer annoying after a while. If so, set
16747 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
16752 @subsection Conformity
16754 No rebels without a clue here, ma'am. We conform to all standards known
16755 to (wo)man. Except for those standards and/or conventions we disagree
16762 There are no known breaches of this standard.
16766 There are no known breaches of this standard, either.
16768 @item Son-of-RFC 1036
16769 @cindex Son-of-RFC 1036
16770 We do have some breaches to this one.
16776 These are considered to be ``vanity headers'', while I consider them
16777 to be consumer information. After seeing so many badly formatted
16778 articles coming from @code{tin} and @code{Netscape} I know not to use
16779 either of those for posting articles. I would not have known that if
16780 it wasn't for the @code{X-Newsreader} header.
16785 USEFOR is an IETF working group writing a successor to RFC 1036, based
16786 on Son-of-RFC 1036. They have produced a number of drafts proposing
16787 various changes to the format of news articles. The Gnus towers will
16788 look into implementing the changes when the draft is accepted as an RFC.
16792 If you ever notice Gnus acting non-compliant with regards to the texts
16793 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
16798 @subsection Emacsen
16804 Gnus should work on :
16812 XEmacs 20.4 and up.
16816 This Gnus version will absolutely not work on any Emacsen older than
16817 that. Not reliably, at least. Older versions of Gnus may work on older
16820 There are some vague differences between Gnus on the various
16821 platforms---XEmacs features more graphics (a logo and a toolbar)---but
16822 other than that, things should look pretty much the same under all
16826 @node Gnus Development
16827 @subsection Gnus Development
16829 Gnus is developed in a two-phased cycle. The first phase involves much
16830 discussion on the @samp{ding@@gnus.org} mailing list, where people
16831 propose changes and new features, post patches and new backends. This
16832 phase is called the @dfn{alpha} phase, since the Gnusae released in this
16833 phase are @dfn{alpha releases}, or (perhaps more commonly in other
16834 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
16835 unstable and should not be used by casual users. Gnus alpha releases
16836 have names like ``Red Gnus'' and ``Quassia Gnus''.
16838 After futzing around for 50-100 alpha releases, Gnus is declared
16839 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
16840 and is called things like ``Gnus 5.6.32'' instead. Normal people are
16841 supposed to be able to use these, and these are mostly discussed on the
16842 @samp{gnu.emacs.gnus} newsgroup.
16845 @vindex nnmail-delete-incoming
16846 Some variable defaults differ between alpha Gnusae and released Gnusae.
16847 In particular, @code{nnmail-delete-incoming} defaults to @code{nil} in
16848 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
16849 lossage of mail if an alpha release hiccups while handling the mail.
16851 The division of discussion between the ding mailing list and the Gnus
16852 newsgroup is not purely based on publicity concerns. It's true that
16853 having people write about the horrible things that an alpha Gnus release
16854 can do (sometimes) in a public forum may scare people off, but more
16855 importantly, talking about new experimental features that have been
16856 introduced may confuse casual users. New features are frequently
16857 introduced, fiddled with, and judged to be found wanting, and then
16858 either discarded or totally rewritten. People reading the mailing list
16859 usually keep up with these rapid changes, whille people on the newsgroup
16860 can't be assumed to do so.
16865 @subsection Contributors
16866 @cindex contributors
16868 The new Gnus version couldn't have been done without the help of all the
16869 people on the (ding) mailing list. Every day for over a year I have
16870 gotten billions of nice bug reports from them, filling me with joy,
16871 every single one of them. Smooches. The people on the list have been
16872 tried beyond endurance, what with my ``oh, that's a neat idea <type
16873 type>, yup, I'll release it right away <ship off> no wait, that doesn't
16874 work at all <type type>, yup, I'll ship that one off right away <ship
16875 off> no, wait, that absolutely does not work'' policy for releases.
16876 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
16877 ``worser''? ``much worser''? ``worsest''?)
16879 I would like to take this opportunity to thank the Academy for... oops,
16885 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
16888 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
16889 well as numerous other things).
16892 Luis Fernandes---design and graphics.
16895 Erik Naggum---help, ideas, support, code and stuff.
16898 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el and many other things
16899 connected with @sc{mime} and other types of en/decoding.
16902 Wes Hardaker---@file{gnus-picon.el} and the manual section on
16903 @dfn{picons} (@pxref{Picons}).
16906 Kim-Minh Kaplan---further work on the picon code.
16909 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
16910 (@pxref{GroupLens}).
16913 Sudish Joseph---innumerable bug fixes.
16916 Ilja Weis---@file{gnus-topic.el}.
16919 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
16922 Vladimir Alexiev---the refcard and reference booklets.
16925 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
16926 distribution by Felix Lee and JWZ.
16929 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
16932 Peter Mutsaers---orphan article scoring code.
16935 Ken Raeburn---POP mail support.
16938 Hallvard B Furuseth---various bits and pieces, especially dealing with
16942 Brian Edmonds---@file{gnus-bbdb.el}.
16945 David Moore---rewrite of @file{nnvirtual.el} and many other things.
16948 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
16951 François Pinard---many, many interesting and thorough bug reports, as
16952 well as autoconf support.
16956 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
16957 Borges, and Jost Krieger proof-reading parts of the manual.
16959 The following people have contributed many patches and suggestions:
16968 Jason L. Tibbitts, III,
16972 Also thanks to the following for patches and stuff:
16995 Massimo Campostrini,
17003 Geoffrey T. Dairiki,
17009 Michael Welsh Duggan,
17013 Enami Tsugutomo, @c Enami
17017 Nelson Jose dos Santos Ferreira,
17024 Arne Georg Gleditsch,
17026 Michelangelo Grigni,
17030 Kenichi Handa, @c Handa
17032 Yoshiki Hayashi, @c ?
17034 Hisashige Kenji, @c Hisashige
17039 François Felix Ingrand,
17040 Ishikawa Ichiro, @c Ishikawa
17042 Iwamuro Motonori, @c Iwamuro
17051 Peter Skov Knudsen,
17052 Shuhei Kobayashi, @c Kobayashi
17053 Koseki Yoshinori, @c Koseki
17054 Thor Kristoffersen,
17057 Seokchan Lee, @c Lee
17075 Morioka Tomohiko, @c Morioka
17076 Erik Toubro Nielsen,
17083 Masaharu Onishi, @c Onishi
17087 Jens-Ulrik Holger Petersen,
17091 John McClary Prevost,
17097 Lars Balker Rasmussen,
17102 Christian von Roques,
17105 Wolfgang Rupprecht,
17112 Philippe Schnoebelen,
17114 Randal L. Schwartz,
17145 Katsumi Yamaoka @c Yamaoka
17150 For a full overview of what each person has done, the ChangeLogs
17151 included in the Gnus alpha distributions should give ample reading
17152 (550kB and counting).
17154 Apologies to everybody that I've forgotten, of which there are many, I'm
17157 Gee, that's quite a list of people. I guess that must mean that there
17158 actually are people who are using Gnus. Who'd'a thunk it!
17162 @subsection New Features
17163 @cindex new features
17166 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
17167 * September Gnus:: The Thing Formally Known As Gnus 5.3/5.3.
17168 * Red Gnus:: Third time best---Gnus 5.4/5.5.
17169 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
17172 These lists are, of course, just @emph{short} overviews of the
17173 @emph{most} important new features. No, really. There are tons more.
17174 Yes, we have feeping creaturism in full effect.
17178 @subsubsection (ding) Gnus
17180 New features in Gnus 5.0/5.1:
17185 The look of all buffers can be changed by setting format-like variables
17186 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
17189 Local spool and several @sc{nntp} servers can be used at once
17190 (@pxref{Select Methods}).
17193 You can combine groups into virtual groups (@pxref{Virtual Groups}).
17196 You can read a number of different mail formats (@pxref{Getting Mail}).
17197 All the mail backends implement a convenient mail expiry scheme
17198 (@pxref{Expiring Mail}).
17201 Gnus can use various strategies for gathering threads that have lost
17202 their roots (thereby gathering loose sub-threads into one thread) or it
17203 can go back and retrieve enough headers to build a complete thread
17204 (@pxref{Customizing Threading}).
17207 Killed groups can be displayed in the group buffer, and you can read
17208 them as well (@pxref{Listing Groups}).
17211 Gnus can do partial group updates---you do not have to retrieve the
17212 entire active file just to check for new articles in a few groups
17213 (@pxref{The Active File}).
17216 Gnus implements a sliding scale of subscribedness to groups
17217 (@pxref{Group Levels}).
17220 You can score articles according to any number of criteria
17221 (@pxref{Scoring}). You can even get Gnus to find out how to score
17222 articles for you (@pxref{Adaptive Scoring}).
17225 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
17226 manner, so it should be difficult to lose much data on what you have
17227 read if your machine should go down (@pxref{Auto Save}).
17230 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
17231 the @file{.emacs} file.
17234 You can set the process mark on both groups and articles and perform
17235 operations on all the marked items (@pxref{Process/Prefix}).
17238 You can grep through a subset of groups and create a group from the
17239 results (@pxref{Kibozed Groups}).
17242 You can list subsets of groups according to, well, anything
17243 (@pxref{Listing Groups}).
17246 You can browse foreign servers and subscribe to groups from those
17247 servers (@pxref{Browse Foreign Server}).
17250 Gnus can fetch articles, asynchronously, on a second connection to the
17251 server (@pxref{Asynchronous Fetching}).
17254 You can cache articles locally (@pxref{Article Caching}).
17257 The uudecode functions have been expanded and generalized
17258 (@pxref{Decoding Articles}).
17261 You can still post uuencoded articles, which was a little-known feature
17262 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
17265 Fetching parents (and other articles) now actually works without
17266 glitches (@pxref{Finding the Parent}).
17269 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
17272 Digests (and other files) can be used as the basis for groups
17273 (@pxref{Document Groups}).
17276 Articles can be highlighted and customized (@pxref{Customizing
17280 URLs and other external references can be buttonized (@pxref{Article
17284 You can do lots of strange stuff with the Gnus window & frame
17285 configuration (@pxref{Windows Configuration}).
17288 You can click on buttons instead of using the keyboard
17294 @node September Gnus
17295 @subsubsection September Gnus
17299 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
17303 New features in Gnus 5.2/5.3:
17308 A new message composition mode is used. All old customization variables
17309 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
17313 Gnus is now able to generate @dfn{sparse} threads---threads where
17314 missing articles are represented by empty nodes (@pxref{Customizing
17318 (setq gnus-build-sparse-threads 'some)
17322 Outgoing articles are stored on a special archive server
17323 (@pxref{Archived Messages}).
17326 Partial thread regeneration now happens when articles are
17330 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
17333 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
17336 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
17339 (setq gnus-use-trees t)
17343 An @code{nn}-like pick-and-read minor mode is available for the summary
17344 buffers (@pxref{Pick and Read}).
17347 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
17351 In binary groups you can use a special binary minor mode (@pxref{Binary
17355 Groups can be grouped in a folding topic hierarchy (@pxref{Group
17359 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
17363 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
17366 Groups can now have a score, and bubbling based on entry frequency
17367 is possible (@pxref{Group Score}).
17370 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
17374 Groups can be process-marked, and commands can be performed on
17375 groups of groups (@pxref{Marking Groups}).
17378 Caching is possible in virtual groups.
17381 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
17382 news batches, ClariNet briefs collections, and just about everything
17383 else (@pxref{Document Groups}).
17386 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
17390 The Gnus cache is much faster.
17393 Groups can be sorted according to many criteria (@pxref{Sorting
17397 New group parameters have been introduced to set list-addresses and
17398 expiry times (@pxref{Group Parameters}).
17401 All formatting specs allow specifying faces to be used
17402 (@pxref{Formatting Fonts}).
17405 There are several more commands for setting/removing/acting on process
17406 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
17409 The summary buffer can be limited to show parts of the available
17410 articles based on a wide range of criteria. These commands have been
17411 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
17414 Articles can be made persistent with the @kbd{*} command
17415 (@pxref{Persistent Articles}).
17418 All functions for hiding article elements are now toggles.
17421 Article headers can be buttonized (@pxref{Article Washing}).
17424 All mail backends support fetching articles by @code{Message-ID}.
17427 Duplicate mail can now be treated properly (@pxref{Duplicates}).
17430 All summary mode commands are available directly from the article
17431 buffer (@pxref{Article Keymap}).
17434 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
17438 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
17441 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
17446 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
17449 (setq gnus-use-nocem t)
17453 Groups can be made permanently visible (@pxref{Listing Groups}).
17456 (setq gnus-permanently-visible-groups "^nnml:")
17460 Many new hooks have been introduced to make customizing easier.
17463 Gnus respects the @code{Mail-Copies-To} header.
17466 Threads can be gathered by looking at the @code{References} header
17467 (@pxref{Customizing Threading}).
17470 (setq gnus-summary-thread-gathering-function
17471 'gnus-gather-threads-by-references)
17475 Read articles can be stored in a special backlog buffer to avoid
17476 refetching (@pxref{Article Backlog}).
17479 (setq gnus-keep-backlog 50)
17483 A clean copy of the current article is always stored in a separate
17484 buffer to allow easier treatment.
17487 Gnus can suggest where to save articles (@pxref{Saving Articles}).
17490 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
17494 (setq gnus-prompt-before-saving t)
17498 @code{gnus-uu} can view decoded files asynchronously while fetching
17499 articles (@pxref{Other Decode Variables}).
17502 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
17506 Filling in the article buffer now works properly on cited text
17507 (@pxref{Article Washing}).
17510 Hiding cited text adds buttons to toggle hiding, and how much
17511 cited text to hide is now customizable (@pxref{Article Hiding}).
17514 (setq gnus-cited-lines-visible 2)
17518 Boring headers can be hidden (@pxref{Article Hiding}).
17521 Default scoring values can now be set from the menu bar.
17524 Further syntax checking of outgoing articles have been added.
17530 @subsubsection Red Gnus
17532 New features in Gnus 5.4/5.5:
17536 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
17543 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
17546 Article prefetching functionality has been moved up into
17547 Gnus (@pxref{Asynchronous Fetching}).
17550 Scoring can now be performed with logical operators like @code{and},
17551 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
17555 Article washing status can be displayed in the
17556 article mode line (@pxref{Misc Article}).
17559 @file{gnus.el} has been split into many smaller files.
17562 Suppression of duplicate articles based on Message-ID can be done
17563 (@pxref{Duplicate Suppression}).
17566 (setq gnus-suppress-duplicates t)
17570 New variables for specifying what score and adapt files are to be
17571 considered home score and adapt files (@pxref{Home Score File}) have
17575 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
17576 Server Internals}).
17579 Groups can inherit group parameters from parent topics (@pxref{Topic
17583 Article editing has been revamped and is now actually usable.
17586 Signatures can be recognized in more intelligent fashions
17587 (@pxref{Article Signature}).
17590 Summary pick mode has been made to look more @code{nn}-like. Line
17591 numbers are displayed and the @kbd{.} command can be used to pick
17592 articles (@code{Pick and Read}).
17595 Commands for moving the @file{.newsrc.eld} from one server to
17596 another have been added (@pxref{Changing Servers}).
17599 There's a way now to specify that ``uninteresting'' fields be suppressed
17600 when generating lines in buffers (@pxref{Advanced Formatting}).
17603 Several commands in the group buffer can be undone with @kbd{M-C-_}
17607 Scoring can be done on words using the new score type @code{w}
17608 (@pxref{Score File Format}).
17611 Adaptive scoring can be done on a Subject word-by-word basis
17612 (@pxref{Adaptive Scoring}).
17615 (setq gnus-use-adaptive-scoring '(word))
17619 Scores can be decayed (@pxref{Score Decays}).
17622 (setq gnus-decay-scores t)
17626 Scoring can be performed using a regexp on the Date header. The Date is
17627 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
17630 A new command has been added to remove all data on articles from
17631 the native server (@pxref{Changing Servers}).
17634 A new command for reading collections of documents
17635 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
17636 (@pxref{Really Various Summary Commands}).
17639 Process mark sets can be pushed and popped (@pxref{Setting Process
17643 A new mail-to-news backend makes it possible to post even when the NNTP
17644 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
17647 A new backend for reading searches from Web search engines
17648 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
17649 (@pxref{Web Searches}).
17652 Groups inside topics can now be sorted using the standard sorting
17653 functions, and each topic can be sorted independently (@pxref{Topic
17657 Subsets of the groups can be sorted independently (@code{Sorting
17661 Cached articles can be pulled into the groups (@pxref{Summary Generation
17665 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
17670 Score files are now applied in a more reliable order (@pxref{Score
17674 Reports on where mail messages end up can be generated (@pxref{Splitting
17678 More hooks and functions have been added to remove junk from incoming
17679 mail before saving the mail (@pxref{Washing Mail}).
17682 Emphasized text can be properly fontisized:
17688 @subsubsection Quassia Gnus
17690 New features in Gnus 5.6:
17695 New functionality for using Gnus as an offline newsreader has been
17696 added. A plethora of new commands and modes have been added. See
17697 @pxref{Gnus Unplugged} for the full story.
17700 The @code{nndraft} backend has returned, but works differently than
17701 before. All Message buffers are now also articles in the @code{nndraft}
17702 group, which is created automatically.
17705 @code{gnus-alter-header-function} can now be used to alter header
17709 @code{gnus-summary-goto-article} now accept Message-ID's.
17712 A new Message command for deleting text in the body of a message
17713 outside the region: @kbd{C-c C-v}.
17716 You can now post to component group in @code{nnvirtual} groups with
17720 @code{nntp-rlogin-program}---new variable to ease customization.
17723 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
17724 re-highlighting of the article buffer.
17727 New element in @code{gnus-boring-article-headers}---@code{long-to}.
17730 @kbd{M-i} symbolic prefix command. See the section "Symbolic
17731 Prefixes" in the Gnus manual for details.
17734 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
17735 @kbd{a} to add the score rule to the "all.SCORE" file.
17738 @code{gnus-simplify-subject-functions} variable to allow greater
17739 control over simplification.
17742 @kbd{A T}---new command for fetching the current thread.
17745 @kbd{/ T}---new command for including the current thread in the
17749 @kbd{M-RET} is a new Message command for breaking cited text.
17752 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
17755 The @code{custom-face-lookup} function has been removed.
17756 If you used this function in your initialization files, you must
17757 rewrite them to use @code{face-spec-set} instead.
17760 Canceling now uses the current select method. Symbolic prefix
17761 @kbd{a} forces normal posting method.
17764 New command to translate M******** sm*rtq**t*s into proper
17768 For easier debugging of @code{nntp}, you can set
17769 @code{nntp-record-commands} to a non-@code{nil} value.
17772 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
17773 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
17776 A command for editing group parameters from the summary buffer
17780 A history of where mails have been split is available.
17783 A new article date command has been added---@code{article-date-iso8601}.
17786 Subjects can be simplified when threading by setting
17787 @code{gnus-score-thread-simplify}.
17790 A new function for citing in Message has been
17791 added---@code{message-cite-original-without-signature}.
17794 @code{article-strip-all-blank-lines}---new article command.
17797 A new Message command to kill to the end of the article has
17801 A minimum adaptive score can be specified by using the
17802 @code{gnus-adaptive-word-minimum} variable.
17805 The "lapsed date" article header can be kept continually
17806 updated by the @code{gnus-start-date-timer} command.
17809 Web listserv archives can be read with the @code{nnlistserv} backend.
17812 Old dejanews archives can now be read by @code{nnweb}.
17817 @node Newest Features
17818 @subsection Newest Features
17821 Also known as the @dfn{todo list}. Sure to be implemented before the
17824 Be afraid. Be very afraid.
17826 (That a feature appears in this list doesn't necessarily mean that I've
17827 decided to actually implement it. It just means that I think it sounds
17830 (Yes, this is the actual, up-to-the-second todo list.)
17835 I would like the zombie-page to contain an URL to the source of the
17836 latest version of gnus or some explanation on where to find it.
17839 A way to continue editing the latest Message composition.
17842 http://www.sonicnet.com/feature/ari3/
17845 facep is not declared.
17848 Include a section in the manual on why the number of articles
17849 isn't the same in the group buffer and on the SPC prompt.
17852 Interacting with rmail fcc isn't easy.
17857 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
17858 <URL:http://www.eit.com/software/hypermail/hypermail.html>
17859 <URL:http://homer.ncm.com/>
17860 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
17861 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
17862 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
17863 http://www.miranova.com/gnus-list/
17868 @samp{^-- } is made into - in LaTeX.
17871 gnus-kill is much slower than it was in GNUS 4.1.3.
17874 when expunging articles on low score, the sparse nodes keep hanging on?
17876 starting the first time seems to hang Gnus on some systems. Does
17877 NEWGROUPS answer too fast?
17879 nndir doesn't read gzipped files.
17881 FAQ doesn't have an up node?
17883 when moving mail from a procmail spool to the crash-box,
17884 the crash-box is only appropriate to one specific group.
17886 `t' `t' makes X-Faces disappear.
17888 nnmh-be-safe means that crossposted articles will
17889 be marked as unread.
17891 Orphan score entries don't show on "V t" score trace
17893 when clearing out data, the cache data should also be reset.
17895 rewrite gnus-summary-limit-children to be non-recursive
17896 to avoid exceeding lisp nesting on huge groups.
17898 expunged articles are counted when computing scores.
17900 implement gnus-batch-brew-soup
17902 ticked articles aren't easy to read in pick mode -- `n' and
17903 stuff just skips past them. Read articles are the same.
17905 topics that contain just groups with ticked
17906 articles aren't displayed.
17908 nndoc should always allocate unique Message-IDs.
17910 If there are mail groups the first time you use Gnus, Gnus'll
17911 make the mail groups killed.
17913 no "no news is good news" when using topics.
17915 when doing crosspost marking, the cache has to be consulted
17916 and articles have to be removed.
17918 nnweb should fetch complete articles when they are split into several
17921 scoring on head immediate doesn't work.
17923 finding short score file names takes forever.
17925 canceling articles in foreign groups.
17927 nntp-open-rlogin no longer works.
17929 C-u C-x C-s (Summary) switches to the group buffer.
17931 move nnmail-split-history out to the backends.
17933 nnweb doesn't work properly.
17935 using a virtual server name as `gnus-select-method' doesn't work?
17937 when killing/yanking a group from one topic to another in a slave, the
17938 master will yank it first to one topic and then add it to another.
17942 warn user about `=' redirection of a group in the active file?
17944 take over the XEmacs menubar and offer a toggle between the XEmacs
17945 bar and the Gnus bar.
17948 push active file and NOV file parsing down into C code.
17949 `(canonize-message-id id)'
17950 `(mail-parent-message-id references n)'
17951 `(parse-news-nov-line &optional dependency-hashtb)'
17952 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
17953 `(parse-news-active-region beg end hashtb)'
17958 nnml .overview directory with splits.
17962 postponed commands.
17964 the selected article show have its Subject displayed in its summary line.
17966 when entering groups, get the real number of unread articles from
17969 sort after gathering threads -- make false roots have the
17970 headers of the oldest orphan with a 0 article number?
17972 nndoc groups should inherit the score files of their parents? Also
17973 inherit copy prompts and save files.
17975 command to start up Gnus (if not running) and enter a mail mode buffer.
17977 allow editing the group description from the group buffer
17978 for backends that support that.
17980 gnus-hide,show-all-topics
17982 groups and sub-topics should be allowed to mingle inside each topic,
17983 and not just list all subtopics at the end.
17985 a command to remove all read articles that are not needed to connect
17986 threads -- `gnus-summary-limit-to-sparse-unread'?
17988 a variable to turn off limiting/cutting of threads in the tree buffer.
17990 a variable to limit how many files are uudecoded.
17992 add zombie groups to a special "New Groups" topic.
17994 server mode command: close/open all connections
17996 put a file date in gnus-score-alist and check whether the file
17997 has been changed before using it.
17999 on exit from a digest group, go to the next article in the parent group.
18001 hide (sub)threads with low score.
18003 when expiring, remove all marks from expired articles.
18005 gnus-summary-limit-to-body
18007 a regexp alist that says what level groups are to be subscribed
18008 on. Eg. -- `(("nnml:" . 1))'.
18010 easier interface to nnkiboze to create ephemeral groups that
18011 contain groups that match a regexp.
18013 allow newlines in <URL:> urls, but remove them before using
18016 If there is no From line, the mail backends should fudge one from the
18019 fuzzy simplifying should strip all non-alpha-numerical info
18020 from subject lines.
18022 gnus-soup-brew-soup-with-high-scores.
18024 nntp-ping-before-connect
18026 command to check whether NOV is evil. "list overview.fmt".
18028 when entering a group, Gnus should look through the score
18029 files very early for `local' atoms and set those local variables.
18031 message annotations.
18033 topics are always yanked before groups, and that's not good.
18035 (set-extent-property extent 'help-echo "String to display in minibuf")
18036 to display help in the minibuffer on buttons under XEmacs.
18038 allow group line format spec to say how many articles there
18043 `run-with-idle-timer' in gnus-demon.
18045 stop using invisible text properties and start using overlays instead
18047 C-c C-f C-e to add an Expires header.
18049 go from one group to the next; everything is expunged; go to the
18050 next group instead of going to the group buffer.
18052 gnus-renumber-cache -- to renumber the cache using "low" numbers.
18054 record topic changes in the dribble buffer.
18056 `nnfolder-generate-active-file' should look at the folders it
18057 finds and generate proper active ranges.
18059 nneething-look-in-files-for-article-heads variable to control
18060 whether nneething should sniff all files in the directories.
18062 gnus-fetch-article -- start Gnus, enter group, display article
18064 gnus-dont-move-articles-to-same-group variable when respooling.
18066 when messages are crossposted between several auto-expirable groups,
18067 articles aren't properly marked as expirable.
18069 nneething should allow deletion/moving.
18071 TAB on the last button should go to the first button.
18073 if the car of an element in `mail-split-methods' is a function,
18074 and the function returns non-nil, use that as the name of the group(s) to
18077 command for listing all score files that have been applied.
18079 a command in the article buffer to return to `summary' config.
18081 `gnus-always-post-using-current-server' -- variable to override
18082 `C-c C-c' when posting.
18084 nnmail-group-spool-alist -- says where each group should use
18087 when an article is crossposted to an auto-expirable group, the article
18088 should be marker as expirable.
18090 article mode command/menu for "send region as URL to browser".
18092 on errors, jump to info nodes that explain the error. For instance,
18093 on invalid From headers, or on error messages from the nntp server.
18095 when gathering threads, make the article that has no "Re: " the parent.
18096 Also consult Date headers.
18098 a token in splits to call shrink-window-if-larger-than-buffer
18100 `1 0 A M' to do matches on the active hashtb.
18102 duplicates -- command to remove Gnus-Warning header, use the read
18103 Message-ID, delete the "original".
18105 when replying to several messages at once, put the "other" message-ids
18106 into a See-Also header.
18108 support setext: URL:http://www.bsdi.com/setext/
18110 support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
18112 when browsing a foreign server, the groups that are already subscribed
18113 should be listed as such and not as "K".
18115 generate font names dynamically.
18117 score file mode auto-alist.
18119 allow nndoc to change/add/delete things from documents. Implement
18120 methods for each format for adding an article to the document.
18122 `gnus-fetch-old-headers' `all' value to incorporate
18123 absolutely all headers there is.
18125 function like `|', but concatenate all marked articles
18126 and pipe them to the process.
18128 cache the list of killed (or active) groups in a separate file. Update
18129 the file whenever we read the active file or the list
18130 of killed groups in the .eld file reaches a certain length.
18132 function for starting to edit a file to put into
18133 the current mail group.
18135 score-find-trace should display the total score of the article.
18137 "ghettozie" -- score on Xref header and nix it out after using it
18138 to avoid marking as read in other groups it has been crossposted to.
18140 look at procmail splitting. The backends should create
18141 the groups automatically if a spool file exists for that group.
18143 function for backends to register themselves with Gnus.
18145 when replying to several process-marked articles,
18146 have all the From end up in Cc headers? Variable to toggle.
18148 command to delete a crossposted mail article from all
18149 groups it has been mailed to.
18151 `B c' and `B m' should be crosspost aware.
18153 hide-pgp should also hide PGP public key blocks.
18155 Command in the group buffer to respool process-marked groups.
18157 `gnus-summary-find-matching' should accept
18158 pseudo-"headers" like "body", "head" and "all"
18160 When buttifying <URL: > things, all white space (including
18161 newlines) should be ignored.
18163 Process-marking all groups in a topic should process-mark
18164 groups in subtopics as well.
18166 Add non-native groups to the list of killed groups when killing them.
18168 nntp-suggest-kewl-config to probe the nntp server and suggest
18171 add edit and forward secondary marks.
18173 nnml shouldn't visit its .overview files.
18175 allow customizing sorting within gathered threads.
18177 `B q' shouldn't select the current article.
18179 nnmbox should support a newsgroups file for descriptions.
18181 allow fetching mail from several pop servers.
18183 Be able to specify whether the saving commands save the original
18184 or the formatted article.
18186 a command to reparent with the child process-marked (cf. `T ^'.).
18188 I think the possibility to send a password with nntp-open-rlogin
18189 should be a feature in Red Gnus.
18191 The `Z n' command should be possible to execute from a mouse click.
18193 more limiting functions -- date, etc.
18195 be able to limit on a random header; on body; using reverse matches.
18197 a group parameter (`absofucking-total-expiry') that will make Gnus expire
18198 even unread articles.
18200 a command to print the article buffer as postscript.
18202 variable to disable password fetching when opening by nntp-open-telnet.
18204 manual: more example servers -- nntp with rlogin, telnet
18206 checking for bogus groups should clean topic alists as well.
18208 canceling articles in foreign groups.
18210 article number in folded topics isn't properly updated by
18213 Movement in the group buffer to the next unread group should go to the
18214 next closed topic with unread messages if no group can be found.
18216 Extensive info pages generated on the fly with help everywhere --
18217 in the "*Gnus edit*" buffers, for instance.
18219 Topic movement commands -- like thread movement. Up, down, forward, next.
18221 a way to tick/mark as read Gcc'd articles.
18223 a way to say that all groups within a specific topic comes
18224 from a particular server? Hm.
18226 `gnus-article-fill-if-long-lines' -- a function to fill
18227 the article buffer if there are any looong lines there.
18229 `T h' should jump to the parent topic and fold it.
18231 a command to create an ephemeral nndoc group out of a file,
18232 and then splitting it/moving it to some other group/backend.
18234 a group parameter for nnkiboze groups that says that
18235 all kibozed articles should be entered into the cache.
18237 It should also probably be possible to delimit what
18238 `gnus-jog-cache' does -- for instance, work on just some groups, or on
18239 some levels, and entering just articles that have a score higher than
18242 nnfolder should append to the folder instead of re-writing
18243 the entire folder to disk when accepting new messages.
18245 allow all backends to do the proper thing with .gz files.
18247 a backend for reading collections of babyl files nnbabylfolder?
18249 a command for making the native groups into foreign groups.
18251 server mode command for clearing read marks from all groups
18254 when following up multiple articles, include all To, Cc, etc headers
18257 a command for deciding what the total score of the current
18258 thread is. Also a way to highlight based on this.
18260 command to show and edit group scores
18262 a gnus-tree-minimize-horizontal to minimize tree buffers
18265 command to generate nnml overview file for one group.
18267 `C-u C-u a' -- prompt for many crossposted groups.
18269 keep track of which mail groups have received new articles (in this session).
18270 Be able to generate a report and perhaps do some marking in the group
18273 gnus-build-sparse-threads to a number -- build only sparse threads
18274 that are of that length.
18276 have nnmh respect mh's unseen sequence in .mh_profile.
18278 cache the newsgroups descriptions locally.
18280 asynchronous posting under nntp.
18282 be able to control word adaptive scoring from the score files.
18284 a variable to make `C-c C-c' post using the "current" select method.
18286 `limit-exclude-low-scored-articles'.
18288 if `gnus-summary-show-thread' is a number, hide threads that have
18289 a score lower than this number.
18291 split newsgroup subscription variable up into "order" and "method".
18293 buttonize ange-ftp file names.
18295 a command to make a duplicate copy of the current article
18296 so that each copy can be edited separately.
18298 nnweb should allow fetching from the local nntp server.
18300 record the sorting done in the summary buffer so that
18301 it can be repeated when limiting/regenerating the buffer.
18303 nnml-generate-nov-databses should generate for
18306 when the user does commands in the group buffer, check
18307 the modification time of the .newsrc.eld file and use
18308 ask-user-about-supersession-threat. Also warn when trying
18309 to save .newsrc.eld and it has changed.
18311 M-g on a topic will display all groups with 0 articles in
18314 command to remove all topic stuff.
18316 allow exploding incoming digests when reading incoming mail
18317 and splitting the resulting digests.
18319 nnsoup shouldn't set the `message-' variables.
18321 command to nix out all nnoo state information.
18323 nnmail-process-alist that calls functions if group names
18324 matches an alist -- before saving.
18326 use buffer-invisibility-spec everywhere for hiding text.
18328 variable to activate each group before entering them
18329 to get the (new) number of articles. `gnus-activate-before-entering'.
18331 command to fetch a Message-ID from any buffer, even
18332 starting Gnus first if necessary.
18334 when posting and checking whether a group exists or not, just
18335 ask the nntp server instead of relying on the active hashtb.
18337 buttonize the output of `C-c C-a' in an apropos-like way.
18339 `G p' should understand process/prefix, and allow editing
18340 of several groups at once.
18342 command to create an ephemeral nnvirtual group that
18343 matches some regexp(s).
18345 nndoc should understand "Content-Type: message/rfc822" forwarded messages.
18347 it should be possible to score "thread" on the From header.
18349 hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
18351 `B i' should display the article at once in the summary buffer.
18353 remove the "*" mark at once when unticking an article.
18355 `M-s' should highlight the matching text.
18357 when checking for duplicated mails, use Resent-Message-ID if present.
18359 killing and yanking groups in topics should be better. If killing one copy
18360 of a group that exists in multiple topics, only that copy should
18361 be removed. Yanking should insert the copy, and yanking topics
18362 should be possible to be interspersed with the other yankings.
18364 command for enter a group just to read the cached articles. A way to say
18365 "ignore the nntp connection; just read from the cache."
18367 `X u' should decode base64 articles.
18369 a way to hide all "inner" cited text, leaving just the most
18370 recently cited text.
18372 nnvirtual should be asynchronous.
18374 after editing an article, gnus-original-article-buffer should
18377 there should probably be a way to make Gnus not connect to the
18378 server and just read the articles in the server
18380 allow a `set-default' (or something) to change the default
18381 value of nnoo variables.
18383 a command to import group infos from a .newsrc.eld file.
18385 groups from secondary servers have the entire select method
18386 listed in each group info.
18388 a command for just switching from the summary buffer to the group
18391 a way to specify that some incoming mail washing functions
18392 should only be applied to some groups.
18394 Message `C-f C-t' should ask the user whether to heed
18395 mail-copies-to: never.
18397 new group parameter -- `post-to-server' that says to post
18398 using the current server. Also a variable to do the same.
18400 the slave dribble files should auto-save to the slave file names.
18402 a group parameter that says what articles to display on group entry, based
18405 a way to visually distinguish slave Gnusae from masters. (Whip instead
18408 Use DJ Bernstein "From " quoting/dequoting, where applicable.
18410 Why is hide-citation-maybe and hide-citation different? Also
18413 group user-defined meta-parameters.
18417 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
18419 I like the option for trying to retrieve the FAQ for a group and I was
18420 thinking it would be great if for those newsgroups that had archives
18421 you could also try to read the archive for that group. Part of the
18422 problem is that archives are spread all over the net, unlike FAQs.
18423 What would be best I suppose is to find the one closest to your site.
18425 In any case, there is a list of general news group archives at @*
18426 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
18433 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
18434 (add-hook 'gnus-select-group-hook
18436 (gnus-group-add-parameter group
18437 (cons 'gnus-group-date-last-entered (list (current-time-string))))))
18439 (defun gnus-user-format-function-d (headers)
18440 "Return the date the group was last read."
18441 (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
18446 tanken var at når du bruker `gnus-startup-file' som prefix (FOO) til å lete
18447 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
18448 liste hvor du bruker hvert element i listen som FOO, istedet. da kunne man
18449 hatt forskjellige serveres startup-filer forskjellige steder.
18453 LMI> Well, nnbabyl could alter the group info to heed labels like
18454 LMI> answered and read, I guess.
18456 It could also keep them updated (the same for the Status: header of
18459 They could be used like this:
18463 `M l <name> RET' add label <name> to current message.
18464 `M u <name> RET' remove label <name> from current message.
18465 `/ l <expr> RET' limit summary buffer according to <expr>.
18467 <expr> would be a boolean expression on the labels, e.g.
18469 `/ l bug & !fixed RET'
18472 would show all the messages which are labeled `bug' but not labeled
18475 One could also imagine the labels being used for highlighting, or
18476 affect the summary line format.
18480 Sender: abraham@@dina.kvl.dk
18482 I'd like a gnus-find-file which work like find file, except that it
18483 would recognize things that looks like messages or folders:
18485 - If it is a directory containing numbered files, create an nndir
18488 - For other directories, create a nneething summary buffer.
18490 - For files matching "\\`From ", create a nndoc/mbox summary.
18492 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
18494 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
18496 - For other files, just find them normally.
18498 I'd like `nneething' to use this function, so it would work on a
18499 directory potentially containing mboxes or babyl files.
18502 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
18503 tell him what you are doing.
18506 Currently, I get prompted:
18510 decend into sci.something ?
18514 The problem above is that since there is really only one subsection of
18515 science, shouldn't it prompt you for only descending sci.something? If
18516 there was a sci.somethingelse group or section, then it should prompt
18517 for sci? first the sci.something? then sci.somethingelse?...
18520 Ja, det burde være en måte å si slikt. Kanskje en ny variabel?
18521 `gnus-use-few-score-files'? SÃ¥ kunne score-regler legges til den
18522 "mest" lokale score-fila. F. eks. ville no-gruppene betjenes av
18523 "no.all.SCORE", osv.
18526 What i want is for Gnus to treat any sequence or combination of the following
18527 as a single spoiler warning and hide it all, replacing it with a "Next Page"
18533 more than n blank lines
18535 more than m identical lines
18536 (which should be replaced with button to show them)
18538 any whitespace surrounding any of the above
18542 Well, we could allow a new value to `gnus-thread-ignore-subject' --
18543 `spaces', or something. (We could even default to that.) And then
18544 subjects that differ in white space only could be considered the
18545 "same" subject for threading purposes.
18548 Modes to preprocess the contents (e.g. jka-compr) use the second form
18549 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
18550 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
18551 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
18554 Under XEmacs -- do funny article marks:
18557 soup - bowl of soup
18558 score below - dim light bulb
18559 score over - bright light bulb
18562 Yes. I think the algorithm is as follows:
18567 show-list-of-articles-in-group
18568 if (key-pressed == SPACE)
18569 if (no-more-articles-in-group-to-select)
18570 if (articles-selected)
18571 start-reading-selected-articles;
18572 junk-unread-articles;
18577 else if (key-pressed = '.')
18578 if (consolidated-menus) # same as hide-thread in Gnus
18579 select-thread-under-cursor;
18581 select-article-under-cursor;
18585 if (key-pressed == SPACE)
18586 if (more-pages-in-article)
18588 else if (more-selected-articles-to-read)
18595 My precise need here would have been to limit files to Incoming*.
18596 One could think of some `nneething-only-files' variable, but I guess
18597 it would have been unacceptable if one was using many unrelated such
18600 A more useful approach would be to, in response to the `G D' prompt, be
18601 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
18602 the top-level directory only (in case directories would be matched by
18603 the wildcard expression).
18606 It would be nice if it also handled
18608 <URL:news://sunsite.auc.dk/>
18610 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
18615 Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
18616 really well. Each menu is 'named' by a symbol that would be on a
18617 gnus-*-menus (where * would be whatever, but at least group, summary, and
18618 article versions) variable.
18620 So for gnus-summary-menus, I would set to '(sort mark dispose ...)
18622 A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
18623 the main menubar. This approach works really well for Emacs-W3 and VM.
18627 nndoc should take care to create unique Message-IDs for all its
18630 gnus-score-followup-article only works when you have a summary buffer
18631 active. Make it work when posting from the group buffer as well.
18632 (message-sent-hook).
18634 rewrite gnus-demon to use run-with-idle-timers.
18637 * Enhancements to Gnus:
18641 * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
18642 straight to the server buffer, without opening any connections to
18645 * gnus-server-read-server-newsrc--produces a buffer very similar to
18646 the group buffer, but with only groups from that server listed;
18647 quitting this buffer returns to the server buffer.
18650 add a command to check the integrity of an nnfolder folder --
18651 go through the article numbers and see that there are no duplicates,
18655 `unsmileyfy-buffer' to undo smileification.
18658 a command to give all relevant info on an article, including all
18662 when doing `-request-accept-article', the backends should do
18663 the nnmail duplicate checking.
18666 allow `message-signature-file' to be a function to return the
18667 value of the signature file.
18670 In addition, I would love it if I could configure message-tab so that it
18671 could call `bbdb-complete-name' in other headers. So, some sort of
18674 (setq message-tab-alist
18675 '((message-header-regexp message-expand-group)
18676 ("^\\(To\\|[cC]c\\|[bB]cc\\)" bbdb-complete-name)))
18678 then you could run the relevant function to complete the information in
18682 cache the newsgroups file locally to avoid reloading it all the time.
18685 a command to import a buffer into a group.
18688 nnweb should allow fetching by Message-ID from servers.
18691 point in the article buffer doesn't always go to the
18692 beginning of the buffer when selecting new articles.
18695 a command to process mark all unread articles.
18698 `gnus-gather-threads-by-references-and-subject' -- first
18699 do gathering by references, and then go through the dummy roots and
18700 do more gathering by subject.
18703 gnus-uu-mark-in-numerical-order -- process mark articles in
18704 article numerical order.
18707 (gnus-thread-total-score
18708 (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
18712 sorting by score is wrong when using sparse threads.
18715 a command to fetch an arbitrary article -- without having to be
18716 in the summary buffer.
18719 a new nncvs backend. Each group would show an article, using
18720 version branches as threading, checkin date as the date, etc.
18723 http://www.dejanews.com/forms/dnsetfilter_exp.html ?
18724 This filter allows one to construct advance queries on the Dejanews
18725 database such as specifying start and end dates, subject, author,
18726 and/or newsgroup name.
18729 new Date header scoring type -- older, newer
18732 use the summary toolbar in the article buffer.
18735 a command to fetch all articles that are less than X days old.
18738 in pick mode, `q' should save the list of selected articles in the
18739 group info. The next time the group is selected, these articles
18740 will automatically get the process mark.
18743 Isn't it possible to (also?) allow M-^ to automatically try the
18744 default server if it fails on the current server? (controlled by a
18745 user variable, (nil, t, 'ask)).
18748 make it possible to cancel articles using the select method for the
18752 `gnus-summary-select-article-on-entry' or something. It'll default
18753 to t and will select whatever article decided by `gnus-auto-select-first'.
18756 a new variable to control which selection commands should be unselecting.
18757 `first', `best', `next', `prev', `next-unread', `prev-unread' are
18761 be able to select groups that have no articles in them
18762 to be able to post in them (using the current select method).
18765 be able to post via DejaNews.
18768 `x' should retain any sortings that have been performed.
18771 allow the user to specify the precedence of the secondary marks. Also
18772 allow them to be displayed separately.
18775 gnus-summary-save-in-pipe should concatenate the results from
18776 the processes when doing a process marked pipe.
18779 a new match type, like Followup, but which adds Thread matches on all
18780 articles that match a certain From header.
18783 a function that can be read from kill-emacs-query-functions to offer
18784 saving living summary buffers.
18787 a function for selecting a particular group which will contain
18788 the articles listed in a list of article numbers/id's.
18791 a battery of character translation functions to translate common
18792 Mac, MS (etc) characters into ISO 8859-1.
18795 (defun article-fix-m$word ()
18796 "Fix M$Word smartquotes in an article."
18799 (let ((buffer-read-only nil))
18800 (goto-char (point-min))
18801 (while (search-forward "\221" nil t)
18802 (replace-match "`" t t))
18803 (goto-char (point-min))
18804 (while (search-forward "\222" nil t)
18805 (replace-match "'" t t))
18806 (goto-char (point-min))
18807 (while (search-forward "\223" nil t)
18808 (replace-match "\"" t t))
18809 (goto-char (point-min))
18810 (while (search-forward "\224" nil t)
18811 (replace-match "\"" t t)))))
18816 (add-hook 'gnus-exit-query-functions
18818 (if (and (file-exists-p nnmail-spool-file)
18819 (> (nnheader-file-size nnmail-spool-file) 0))
18820 (yes-or-no-p "New mail has arrived. Quit Gnus anyways? ")
18821 (y-or-n-p "Are you sure you want to quit Gnus? "))))
18825 allow message-default-headers to be a function.
18828 new Date score match types -- < > = (etc) that take floating point
18829 numbers and match on the age of the article.
18833 > > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
18834 > > > under xemacs-19.14, it's creating a new frame, but is erasing the
18835 > > > buffer in the frame that it was called from =:-O
18837 > > Hm. How do you start up Gnus? From the toolbar or with
18838 > > `M-x gnus-other-frame'?
18840 > I normally start it up from the toolbar; at
18841 > least that's the way I've caught it doing the
18846 all commands that react to the process mark should push
18847 the current process mark set onto the stack.
18850 gnus-article-hide-pgp
18851 Selv ville jeg nok ha valgt å slette den dersom teksten matcher
18853 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
18855 og det er maks hundre tegn mellom match-end og ----linja. Men -det-
18856 er min type heuristikk og langt fra alles.
18859 `gnus-subscribe-sorted' -- insert new groups where they would have been
18860 sorted to if `gnus-group-sort-function' were run.
18863 gnus-(group,summary)-highlight should respect any `face' text props set
18867 use run-with-idle-timer for gnus-demon instead of the
18868 home-brewed stuff for better reliability.
18871 add a way to select which NoCeM type to apply -- spam, troll, etc.
18874 nndraft-request-group should tally auto-save files.
18877 implement nntp-retry-on-break and nntp-command-timeout.
18880 gnus-article-highlight-limit that says when not to highlight (long)
18884 (nnoo-set SERVER VARIABLE VALUE)
18890 interrupitng agent fetching of articles should save articles.
18893 command to open a digest group, and copy all the articles there to the
18897 a variable to disable article body highlights if there's more than
18898 X characters in the body.
18901 handle 480/381 authinfo requests separately.
18904 include the texi/dir file in the distribution.
18907 format spec to "tab" to a position.
18910 Move all prompting to the new `M-n' default style.
18913 command to display all dormant articles.
18916 gnus-auto-select-next makeover -- list of things it should do.
18919 a score match type that adds scores matching on From if From has replied
18920 to something someone else has said.
18923 Read Netscape discussion groups:
18924 snews://secnews.netscape.com/netscape.communicator.unix
18927 One command to edit the original version if an article, and one to edit
18928 the displayed version.
18931 @kbd{T v} -- make all process-marked articles the children of the
18935 Switch from initial text to the new default text mechanism.
18938 How about making it possible to expire local articles? Will it be
18939 possible to make various constraints on when an article can be
18940 expired, e.g. (read), (age > 14 days), or the more interesting (read
18944 New limit command---limit to articles that have a certain string
18945 in the head or body.
18948 Allow breaking lengthy NNTP commands.
18951 gnus-article-highlight-limit, to disable highlighting in big articles.
18954 Editing an article should put the article to be edited
18955 in a special, unique buffer.
18958 A command to send a mail to the admin-address group param.
18961 A Date scoring type that will match if the article
18962 is less than a certain number of days old.
18965 New spec: %~(tab 56) to put point on column 56
18968 Allow Gnus Agent scoring to use normal score files.
18971 Rething the Agent active file thing. `M-g' doesn't update the active
18972 file, for instance.
18975 With dummy roots, `^' and then selecing the first article
18976 in any other dummy thread will make Gnus highlight the
18977 dummy root instead of the first article.
18980 Propagate all group properties (marks, article numbers, etc) up to the
18981 topics for displaying.
18984 `n' in the group buffer with topics should go to the next group
18985 with unread articles, even if that group is hidden in a topic.
18988 gnus-posting-styles doesn't work in drafts.
18991 gnus-summary-limit-include-cached is slow when there are
18992 many articles in the cache, since it regenerates big parts of the
18993 summary buffer for each article.
18996 Implement gnus-batch-brew-soup.
18999 Group parameters and summary commands for un/subscribing to mailing
19003 Introduce nnmail-home-directory.
19006 gnus-fetch-group and friends should exit Gnus when the user
19010 The jingle is only played on the second invocation of Gnus.
19013 Bouncing articles should do MIME.
19016 Crossposted articles should "inherit" the % or @ mark from the other
19017 groups it has been crossposted to, or something. (Agent.)
19020 `S D r' should allow expansion of aliases.
19023 If point is on a group that appears multiple times in topics, and
19024 you press `l', point will move to the first instance of the group.
19027 Fetch by Message-ID from dejanews.
19029 <URL:http://search.dejanews.com/msgid.xp?MID=%3C62h9l9$hm4@@basement.replay.com%3E&fmt=raw>
19032 A spec for the group line format to display the number of
19033 agent-downloaded articles in the group.
19036 Some nntp servers never respond when posting, so there should be a
19037 timeout for all commands.
19040 When stading on a topic line and `t'-ing, point goes to the last line.
19041 It should go somewhere else.
19044 I'm having trouble accessing a newsgroup with a "+" in its name with
19045 Gnus. There is a new newsgroup on msnews.microsoft.com named
19046 "microsoft.public.multimedia.directx.html+time" that I'm trying to
19048 "nntp+msnews.microsoft.com:microsoft.public.multimedia.directx.html+time"
19049 but it gives an error that it cant access the group.
19051 Is the "+" character illegal in newsgroup names? Is there any way in
19052 Gnus to work around this? (gnus 5.6.45 - XEmacs 20.4)
19059 Subject: Answer to your mails 01.01.1999-01.05.1999
19060 --text follows this line--
19061 Sorry I killfiled you...
19063 Under the subject "foo", you wrote on 01.01.1999:
19065 Under the subject "foo1", you wrote on 01.01.1999:
19070 Allow "orphan" scores in the Agent scoring.
19073 Solve the halting problem.
19082 @section The Manual
19086 This manual was generated from a TeXinfo file and then run through
19087 either @code{texi2dvi}
19089 or my own home-brewed TeXinfo to \LaTeX\ transformer,
19090 and then run through @code{latex} and @code{dvips}
19092 to get what you hold in your hands now.
19094 The following conventions have been used:
19099 This is a @samp{string}
19102 This is a @kbd{keystroke}
19105 This is a @file{file}
19108 This is a @code{symbol}
19112 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
19116 (setq flargnoze "yes")
19119 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
19122 (setq flumphel 'yes)
19125 @samp{yes} and @code{yes} are two @emph{very} different things---don't
19126 ever get them confused.
19130 Of course, everything in this manual is of vital interest, so you should
19131 read it all. Several times. However, if you feel like skimming the
19132 manual, look for that gnu head you should see in the margin over
19133 there---it means that what's being discussed is of more importance than
19134 the rest of the stuff. (On the other hand, if everything is infinitely
19135 important, how can anything be more important than that? Just one more
19136 of the mysteries of this world, I guess.)
19144 @section Terminology
19146 @cindex terminology
19151 This is what you are supposed to use this thing for---reading news.
19152 News is generally fetched from a nearby @sc{nntp} server, and is
19153 generally publicly available to everybody. If you post news, the entire
19154 world is likely to read just what you have written, and they'll all
19155 snigger mischievously. Behind your back.
19159 Everything that's delivered to you personally is mail. Some news/mail
19160 readers (like Gnus) blur the distinction between mail and news, but
19161 there is a difference. Mail is private. News is public. Mailing is
19162 not posting, and replying is not following up.
19166 Send a mail to the person who has written what you are reading.
19170 Post an article to the current newsgroup responding to the article you
19175 Gnus gets fed articles from a number of backends, both news and mail
19176 backends. Gnus does not handle the underlying media, so to speak---this
19177 is all done by the backends.
19181 Gnus will always use one method (and backend) as the @dfn{native}, or
19182 default, way of getting news.
19186 You can also have any number of foreign groups active at the same time.
19187 These are groups that use non-native non-secondary backends for getting
19192 Secondary backends are somewhere half-way between being native and being
19193 foreign, but they mostly act like they are native.
19197 A message that has been posted as news.
19200 @cindex mail message
19201 A message that has been mailed.
19205 A mail message or news article
19209 The top part of a message, where administrative information (etc.) is
19214 The rest of an article. Everything not in the head is in the
19219 A line from the head of an article.
19223 A collection of such lines, or a collection of heads. Or even a
19224 collection of @sc{nov} lines.
19228 When Gnus enters a group, it asks the backend for the headers of all
19229 unread articles in the group. Most servers support the News OverView
19230 format, which is more compact and much faster to read and parse than the
19231 normal @sc{head} format.
19235 Each group is subscribed at some @dfn{level} or other (1-9). The ones
19236 that have a lower level are ``more'' subscribed than the groups with a
19237 higher level. In fact, groups on levels 1-5 are considered
19238 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
19239 are @dfn{killed}. Commands for listing groups and scanning for new
19240 articles will all use the numeric prefix as @dfn{working level}.
19242 @item killed groups
19243 @cindex killed groups
19244 No information on killed groups is stored or updated, which makes killed
19245 groups much easier to handle than subscribed groups.
19247 @item zombie groups
19248 @cindex zombie groups
19249 Just like killed groups, only slightly less dead.
19252 @cindex active file
19253 The news server has to keep track of what articles it carries, and what
19254 groups exist. All this information in stored in the active file, which
19255 is rather large, as you might surmise.
19258 @cindex bogus groups
19259 A group that exists in the @file{.newsrc} file, but isn't known to the
19260 server (i.e., it isn't in the active file), is a @emph{bogus group}.
19261 This means that the group probably doesn't exist (any more).
19264 @cindex activating groups
19265 The act of asking the server for info on a group and computing the
19266 number of unread articles is called @dfn{activating the group}.
19267 Un-activated groups are listed with @samp{*} in the group buffer.
19271 A machine one can connect to and get news (or mail) from.
19273 @item select method
19274 @cindex select method
19275 A structure that specifies the backend, the server and the virtual
19278 @item virtual server
19279 @cindex virtual server
19280 A named select method. Since a select method defines all there is to
19281 know about connecting to a (physical) server, taking the thing as a
19282 whole is a virtual server.
19286 Taking a buffer and running it through a filter of some sort. The
19287 result will (more often than not) be cleaner and more pleasing than the
19290 @item ephemeral groups
19291 @cindex ephemeral groups
19292 Most groups store data on what articles you have read. @dfn{Ephemeral}
19293 groups are groups that will have no data stored---when you exit the
19294 group, it'll disappear into the aether.
19297 @cindex solid groups
19298 This is the opposite of ephemeral groups. All groups listed in the
19299 group buffer are solid groups.
19301 @item sparse articles
19302 @cindex sparse articles
19303 These are article placeholders shown in the summary buffer when
19304 @code{gnus-build-sparse-threads} has been switched on.
19308 To put responses to articles directly after the articles they respond
19309 to---in a hierarchical fashion.
19313 @cindex thread root
19314 The first article in a thread is the root. It is the ancestor of all
19315 articles in the thread.
19319 An article that has responses.
19323 An article that responds to a different article---its parent.
19327 A collection of messages in one file. The most common digest format is
19328 specified by RFC1153.
19334 @node Customization
19335 @section Customization
19336 @cindex general customization
19338 All variables are properly documented elsewhere in this manual. This
19339 section is designed to give general pointers on how to customize Gnus
19340 for some quite common situations.
19343 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
19344 * Slow Terminal Connection:: You run a remote Emacs.
19345 * Little Disk Space:: You feel that having large setup files is icky.
19346 * Slow Machine:: You feel like buying a faster machine.
19350 @node Slow/Expensive Connection
19351 @subsection Slow/Expensive @sc{nntp} Connection
19353 If you run Emacs on a machine locally, and get your news from a machine
19354 over some very thin strings, you want to cut down on the amount of data
19355 Gnus has to get from the @sc{nntp} server.
19359 @item gnus-read-active-file
19360 Set this to @code{nil}, which will inhibit Gnus from requesting the
19361 entire active file from the server. This file is often v. large. You
19362 also have to set @code{gnus-check-new-newsgroups} and
19363 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
19364 doesn't suddenly decide to fetch the active file anyway.
19366 @item gnus-nov-is-evil
19367 This one has to be @code{nil}. If not, grabbing article headers from
19368 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
19369 support @sc{xover}; Gnus will detect this by itself.
19373 @node Slow Terminal Connection
19374 @subsection Slow Terminal Connection
19376 Let's say you use your home computer for dialing up the system that runs
19377 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
19378 possible) the amount of data sent over the wires.
19382 @item gnus-auto-center-summary
19383 Set this to @code{nil} to inhibit Gnus from re-centering the summary
19384 buffer all the time. If it is @code{vertical}, do only vertical
19385 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
19386 horizontal and vertical recentering.
19388 @item gnus-visible-headers
19389 Cut down on the headers included in the articles to the
19390 minimum. You can, in fact, make do without them altogether---most of the
19391 useful data is in the summary buffer, anyway. Set this variable to
19392 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
19394 Set this hook to all the available hiding commands:
19396 (setq gnus-treat-hide-headers 'head
19397 gnus-treat-hide-signature t
19398 gnus-treat-hide-citation t)
19401 @item gnus-use-full-window
19402 By setting this to @code{nil}, you can make all the windows smaller.
19403 While this doesn't really cut down much generally, it means that you
19404 have to see smaller portions of articles before deciding that you didn't
19405 want to read them anyway.
19407 @item gnus-thread-hide-subtree
19408 If this is non-@code{nil}, all threads in the summary buffer will be
19411 @item gnus-updated-mode-lines
19412 If this is @code{nil}, Gnus will not put information in the buffer mode
19413 lines, which might save some time.
19417 @node Little Disk Space
19418 @subsection Little Disk Space
19421 The startup files can get rather large, so you may want to cut their
19422 sizes a bit if you are running out of space.
19426 @item gnus-save-newsrc-file
19427 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
19428 only save @file{.newsrc.eld}. This means that you will not be able to
19429 use any other newsreaders than Gnus. This variable is @code{t} by
19432 @item gnus-read-newsrc-file
19433 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
19434 only read @file{.newsrc.eld}. This means that you will not be able to
19435 use any other newsreaders than Gnus. This variable is @code{t} by
19438 @item gnus-save-killed-list
19439 If this is @code{nil}, Gnus will not save the list of dead groups. You
19440 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
19441 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
19442 variable to @code{nil}. This variable is @code{t} by default.
19448 @subsection Slow Machine
19449 @cindex slow machine
19451 If you have a slow machine, or are just really impatient, there are a
19452 few things you can do to make Gnus run faster.
19454 Set @code{gnus-check-new-newsgroups} and
19455 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
19457 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
19458 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
19459 summary buffer faster.
19463 @node Troubleshooting
19464 @section Troubleshooting
19465 @cindex troubleshooting
19467 Gnus works @emph{so} well straight out of the box---I can't imagine any
19475 Make sure your computer is switched on.
19478 Make sure that you really load the current Gnus version. If you have
19479 been running @sc{gnus}, you need to exit Emacs and start it up again before
19483 Try doing an @kbd{M-x gnus-version}. If you get something that looks
19484 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded. If,
19485 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
19486 flee}, you have some old @file{.el} files lying around. Delete these.
19489 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
19493 @vindex max-lisp-eval-depth
19494 Gnus works on many recursive structures, and in some extreme (and very
19495 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
19496 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
19497 something like that.
19500 If all else fails, report the problem as a bug.
19503 @cindex reporting bugs
19505 @kindex M-x gnus-bug
19507 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
19508 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
19509 me the backtrace. I will fix bugs, but I can only fix them if you send
19510 me a precise description as to how to reproduce the bug.
19512 You really can never be too detailed in a bug report. Always use the
19513 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
19514 a 10Kb mail each time you use it, and even if you have sent me your
19515 environment 500 times before. I don't care. I want the full info each
19518 It is also important to remember that I have no memory whatsoever. If
19519 you send a bug report, and I send you a reply, and then you just send
19520 back ``No, it's not! Moron!'', I will have no idea what you are
19521 insulting me about. Always over-explain everything. It's much easier
19522 for all of us---if I don't have all the information I need, I will just
19523 mail you and ask for more info, and everything takes more time.
19525 If the problem you're seeing is very visual, and you can't quite explain
19526 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
19527 it somewhere it can be reached, and include the URL of the picture in
19530 If you just need help, you are better off asking on
19531 @samp{gnu.emacs.gnus}. I'm not very helpful.
19533 @cindex gnu.emacs.gnus
19534 @cindex ding mailing list
19535 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
19536 Write to @samp{ding-request@@gnus.org} to subscribe.
19540 @node Gnus Reference Guide
19541 @section Gnus Reference Guide
19543 It is my hope that other people will figure out smart stuff that Gnus
19544 can do, and that other people will write those smart things as well. To
19545 facilitate that I thought it would be a good idea to describe the inner
19546 workings of Gnus. And some of the not-so-inner workings, while I'm at
19549 You can never expect the internals of a program not to change, but I
19550 will be defining (in some details) the interface between Gnus and its
19551 backends (this is written in stone), the format of the score files
19552 (ditto), data structures (some are less likely to change than others)
19553 and general methods of operation.
19556 * Gnus Utility Functions:: Common functions and variable to use.
19557 * Backend Interface:: How Gnus communicates with the servers.
19558 * Score File Syntax:: A BNF definition of the score file standard.
19559 * Headers:: How Gnus stores headers internally.
19560 * Ranges:: A handy format for storing mucho numbers.
19561 * Group Info:: The group info format.
19562 * Extended Interactive:: Symbolic prefixes and stuff.
19563 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
19564 * Various File Formats:: Formats of files that Gnus use.
19568 @node Gnus Utility Functions
19569 @subsection Gnus Utility Functions
19570 @cindex Gnus utility functions
19571 @cindex utility functions
19573 @cindex internal variables
19575 When writing small functions to be run from hooks (and stuff), it's
19576 vital to have access to the Gnus internal functions and variables.
19577 Below is a list of the most common ones.
19581 @item gnus-newsgroup-name
19582 @vindex gnus-newsgroup-name
19583 This variable holds the name of the current newsgroup.
19585 @item gnus-find-method-for-group
19586 @findex gnus-find-method-for-group
19587 A function that returns the select method for @var{group}.
19589 @item gnus-group-real-name
19590 @findex gnus-group-real-name
19591 Takes a full (prefixed) Gnus group name, and returns the unprefixed
19594 @item gnus-group-prefixed-name
19595 @findex gnus-group-prefixed-name
19596 Takes an unprefixed group name and a select method, and returns the full
19597 (prefixed) Gnus group name.
19599 @item gnus-get-info
19600 @findex gnus-get-info
19601 Returns the group info list for @var{group}.
19603 @item gnus-group-unread
19604 @findex gnus-group-unread
19605 The number of unread articles in @var{group}, or @code{t} if that is
19609 @findex gnus-active
19610 The active entry for @var{group}.
19612 @item gnus-set-active
19613 @findex gnus-set-active
19614 Set the active entry for @var{group}.
19616 @item gnus-add-current-to-buffer-list
19617 @findex gnus-add-current-to-buffer-list
19618 Adds the current buffer to the list of buffers to be killed on Gnus
19621 @item gnus-continuum-version
19622 @findex gnus-continuum-version
19623 Takes a Gnus version string as a parameter and returns a floating point
19624 number. Earlier versions will always get a lower number than later
19627 @item gnus-group-read-only-p
19628 @findex gnus-group-read-only-p
19629 Says whether @var{group} is read-only or not.
19631 @item gnus-news-group-p
19632 @findex gnus-news-group-p
19633 Says whether @var{group} came from a news backend.
19635 @item gnus-ephemeral-group-p
19636 @findex gnus-ephemeral-group-p
19637 Says whether @var{group} is ephemeral or not.
19639 @item gnus-server-to-method
19640 @findex gnus-server-to-method
19641 Returns the select method corresponding to @var{server}.
19643 @item gnus-server-equal
19644 @findex gnus-server-equal
19645 Says whether two virtual servers are equal.
19647 @item gnus-group-native-p
19648 @findex gnus-group-native-p
19649 Says whether @var{group} is native or not.
19651 @item gnus-group-secondary-p
19652 @findex gnus-group-secondary-p
19653 Says whether @var{group} is secondary or not.
19655 @item gnus-group-foreign-p
19656 @findex gnus-group-foreign-p
19657 Says whether @var{group} is foreign or not.
19659 @item group-group-find-parameter
19660 @findex group-group-find-parameter
19661 Returns the parameter list of @var{group}. If given a second parameter,
19662 returns the value of that parameter for @var{group}.
19664 @item gnus-group-set-parameter
19665 @findex gnus-group-set-parameter
19666 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
19668 @item gnus-narrow-to-body
19669 @findex gnus-narrow-to-body
19670 Narrows the current buffer to the body of the article.
19672 @item gnus-check-backend-function
19673 @findex gnus-check-backend-function
19674 Takes two parameters, @var{function} and @var{group}. If the backend
19675 @var{group} comes from supports @var{function}, return non-@code{nil}.
19678 (gnus-check-backend-function "request-scan" "nnml:misc")
19682 @item gnus-read-method
19683 @findex gnus-read-method
19684 Prompts the user for a select method.
19689 @node Backend Interface
19690 @subsection Backend Interface
19692 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
19693 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
19694 server is a @dfn{backend} and some @dfn{backend variables}. As examples
19695 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
19696 examples of the latter we have @code{nntp-port-number} and
19697 @code{nnmbox-directory}.
19699 When Gnus asks for information from a backend---say @code{nntp}---on
19700 something, it will normally include a virtual server name in the
19701 function parameters. (If not, the backend should use the ``current''
19702 virtual server.) For instance, @code{nntp-request-list} takes a virtual
19703 server as its only (optional) parameter. If this virtual server hasn't
19704 been opened, the function should fail.
19706 Note that a virtual server name has no relation to some physical server
19707 name. Take this example:
19711 (nntp-address "ifi.uio.no")
19712 (nntp-port-number 4324))
19715 Here the virtual server name is @samp{odd-one} while the name of
19716 the physical server is @samp{ifi.uio.no}.
19718 The backends should be able to switch between several virtual servers.
19719 The standard backends implement this by keeping an alist of virtual
19720 server environments that they pull down/push up when needed.
19722 There are two groups of interface functions: @dfn{required functions},
19723 which must be present, and @dfn{optional functions}, which Gnus will
19724 always check for presence before attempting to call 'em.
19726 All these functions are expected to return data in the buffer
19727 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
19728 unfortunately named, but we'll have to live with it. When I talk about
19729 @dfn{resulting data}, I always refer to the data in that buffer. When I
19730 talk about @dfn{return value}, I talk about the function value returned by
19731 the function call. Functions that fail should return @code{nil} as the
19734 Some backends could be said to be @dfn{server-forming} backends, and
19735 some might be said not to be. The latter are backends that generally
19736 only operate on one group at a time, and have no concept of ``server''
19737 -- they have a group, and they deliver info on that group and nothing
19740 In the examples and definitions I will refer to the imaginary backend
19743 @cindex @code{nnchoke}
19746 * Required Backend Functions:: Functions that must be implemented.
19747 * Optional Backend Functions:: Functions that need not be implemented.
19748 * Error Messaging:: How to get messages and report errors.
19749 * Writing New Backends:: Extending old backends.
19750 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
19751 * Mail-like Backends:: Some tips on mail backends.
19755 @node Required Backend Functions
19756 @subsubsection Required Backend Functions
19760 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
19762 @var{articles} is either a range of article numbers or a list of
19763 @code{Message-ID}s. Current backends do not fully support either---only
19764 sequences (lists) of article numbers, and most backends do not support
19765 retrieval of @code{Message-ID}s. But they should try for both.
19767 The result data should either be HEADs or NOV lines, and the result
19768 value should either be @code{headers} or @code{nov} to reflect this.
19769 This might later be expanded to @code{various}, which will be a mixture
19770 of HEADs and NOV lines, but this is currently not supported by Gnus.
19772 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
19773 headers", in some meaning of the word. This is generally done by
19774 fetching (at most) @var{fetch-old} extra headers less than the smallest
19775 article number in @code{articles}, and filling the gaps as well. The
19776 presence of this parameter can be ignored if the backend finds it
19777 cumbersome to follow the request. If this is non-@code{nil} and not a
19778 number, do maximum fetches.
19780 Here's an example HEAD:
19783 221 1056 Article retrieved.
19784 Path: ifi.uio.no!sturles
19785 From: sturles@@ifi.uio.no (Sturle Sunde)
19786 Newsgroups: ifi.discussion
19787 Subject: Re: Something very droll
19788 Date: 27 Oct 1994 14:02:57 +0100
19789 Organization: Dept. of Informatics, University of Oslo, Norway
19791 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
19792 References: <38jdmq$4qu@@visbur.ifi.uio.no>
19793 NNTP-Posting-Host: holmenkollen.ifi.uio.no
19797 So a @code{headers} return value would imply that there's a number of
19798 these in the data buffer.
19800 Here's a BNF definition of such a buffer:
19804 head = error / valid-head
19805 error-message = [ "4" / "5" ] 2number " " <error message> eol
19806 valid-head = valid-message *header "." eol
19807 valid-message = "221 " <number> " Article retrieved." eol
19808 header = <text> eol
19811 If the return value is @code{nov}, the data buffer should contain
19812 @dfn{network overview database} lines. These are basically fields
19816 nov-buffer = *nov-line
19817 nov-line = 8*9 [ field <TAB> ] eol
19818 field = <text except TAB>
19821 For a closer look at what should be in those fields,
19825 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
19827 @var{server} is here the virtual server name. @var{definitions} is a
19828 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
19830 If the server can't be opened, no error should be signaled. The backend
19831 may then choose to refuse further attempts at connecting to this
19832 server. In fact, it should do so.
19834 If the server is opened already, this function should return a
19835 non-@code{nil} value. There should be no data returned.
19838 @item (nnchoke-close-server &optional SERVER)
19840 Close connection to @var{server} and free all resources connected
19841 to it. Return @code{nil} if the server couldn't be closed for some
19844 There should be no data returned.
19847 @item (nnchoke-request-close)
19849 Close connection to all servers and free all resources that the backend
19850 have reserved. All buffers that have been created by that backend
19851 should be killed. (Not the @code{nntp-server-buffer}, though.) This
19852 function is generally only called when Gnus is shutting down.
19854 There should be no data returned.
19857 @item (nnchoke-server-opened &optional SERVER)
19859 If @var{server} is the current virtual server, and the connection to the
19860 physical server is alive, then this function should return a
19861 non-@code{nil} vlue. This function should under no circumstances
19862 attempt to reconnect to a server we have lost connection to.
19864 There should be no data returned.
19867 @item (nnchoke-status-message &optional SERVER)
19869 This function should return the last error message from @var{server}.
19871 There should be no data returned.
19874 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
19876 The result data from this function should be the article specified by
19877 @var{article}. This might either be a @code{Message-ID} or a number.
19878 It is optional whether to implement retrieval by @code{Message-ID}, but
19879 it would be nice if that were possible.
19881 If @var{to-buffer} is non-@code{nil}, the result data should be returned
19882 in this buffer instead of the normal data buffer. This is to make it
19883 possible to avoid copying large amounts of data from one buffer to
19884 another, while Gnus mainly requests articles to be inserted directly
19885 into its article buffer.
19887 If it is at all possible, this function should return a cons cell where
19888 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
19889 the article number. This will enable Gnus to find out what the real
19890 group and article numbers are when fetching articles by
19891 @code{Message-ID}. If this isn't possible, @code{t} should be returned
19892 on successful article retrieval.
19895 @item (nnchoke-request-group GROUP &optional SERVER FAST)
19897 Get data on @var{group}. This function also has the side effect of
19898 making @var{group} the current group.
19900 If @var{FAST}, don't bother to return useful data, just make @var{group}
19903 Here's an example of some result data and a definition of the same:
19906 211 56 1000 1059 ifi.discussion
19909 The first number is the status, which should be 211. Next is the
19910 total number of articles in the group, the lowest article number, the
19911 highest article number, and finally the group name. Note that the total
19912 number of articles may be less than one might think while just
19913 considering the highest and lowest article numbers, but some articles
19914 may have been canceled. Gnus just discards the total-number, so
19915 whether one should take the bother to generate it properly (if that is a
19916 problem) is left as an exercise to the reader.
19919 group-status = [ error / info ] eol
19920 error = [ "4" / "5" ] 2<number> " " <Error message>
19921 info = "211 " 3* [ <number> " " ] <string>
19925 @item (nnchoke-close-group GROUP &optional SERVER)
19927 Close @var{group} and free any resources connected to it. This will be
19928 a no-op on most backends.
19930 There should be no data returned.
19933 @item (nnchoke-request-list &optional SERVER)
19935 Return a list of all groups available on @var{server}. And that means
19938 Here's an example from a server that only carries two groups:
19941 ifi.test 0000002200 0000002000 y
19942 ifi.discussion 3324 3300 n
19945 On each line we have a group name, then the highest article number in
19946 that group, the lowest article number, and finally a flag.
19949 active-file = *active-line
19950 active-line = name " " <number> " " <number> " " flags eol
19952 flags = "n" / "y" / "m" / "x" / "j" / "=" name
19955 The flag says whether the group is read-only (@samp{n}), is moderated
19956 (@samp{m}), is dead (@samp{x}), is aliased to some other group
19957 (@samp{=other-group}) or none of the above (@samp{y}).
19960 @item (nnchoke-request-post &optional SERVER)
19962 This function should post the current buffer. It might return whether
19963 the posting was successful or not, but that's not required. If, for
19964 instance, the posting is done asynchronously, it has generally not been
19965 completed by the time this function concludes. In that case, this
19966 function should set up some kind of sentinel to beep the user loud and
19967 clear if the posting could not be completed.
19969 There should be no result data from this function.
19974 @node Optional Backend Functions
19975 @subsubsection Optional Backend Functions
19979 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
19981 @var{groups} is a list of groups, and this function should request data
19982 on all those groups. How it does it is of no concern to Gnus, but it
19983 should attempt to do this in a speedy fashion.
19985 The return value of this function can be either @code{active} or
19986 @code{group}, which says what the format of the result data is. The
19987 former is in the same format as the data from
19988 @code{nnchoke-request-list}, while the latter is a buffer full of lines
19989 in the same format as @code{nnchoke-request-group} gives.
19992 group-buffer = *active-line / *group-status
19996 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
19998 A Gnus group info (@pxref{Group Info}) is handed to the backend for
19999 alterations. This comes in handy if the backend really carries all the
20000 information (as is the case with virtual and imap groups). This
20001 function should destructively alter the info to suit its needs, and
20002 should return the (altered) group info.
20004 There should be no result data from this function.
20007 @item (nnchoke-request-type GROUP &optional ARTICLE)
20009 When the user issues commands for ``sending news'' (@kbd{F} in the
20010 summary buffer, for instance), Gnus has to know whether the article the
20011 user is following up on is news or mail. This function should return
20012 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
20013 is mail and @code{unknown} if the type can't be decided. (The
20014 @var{article} parameter is necessary in @code{nnvirtual} groups which
20015 might very well combine mail groups and news groups.) Both @var{group}
20016 and @var{article} may be @code{nil}.
20018 There should be no result data from this function.
20021 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
20023 Set/remove/add marks on articles. Normally Gnus handles the article
20024 marks (such as read, ticked, expired etc) internally, and store them in
20025 @code{~/.newsrc.eld}. Some backends (such as IMAP) however carry all
20026 information about the articles on the server, so Gnus need to propagate
20027 the mark information to the server.
20029 ACTION is a list of mark setting requests, having this format:
20032 (RANGE ACTION MARK)
20035 Range is a range of articles you wish to update marks on. Action is
20036 @code{set}, @code{add} or @code{del}, respectively used for removing all
20037 existing marks and setting them as specified, adding (preserving the
20038 marks not mentioned) mark and removing (preserving the marks not
20039 mentioned) marks. Mark is a list of marks; where each mark is a
20040 symbol. Currently used marks are @code{read}, @code{tick}, @code{reply},
20041 @code{expire}, @code{killed}, @code{dormant}, @code{save},
20042 @code{download} and @code{unsend}, but your backend should, if possible,
20043 not limit itself to theese.
20045 Given contradictory actions, the last action in the list should be the
20046 effective one. That is, if your action contains a request to add the
20047 @code{tick} mark on article 1 and, later in the list, a request to
20048 remove the mark on the same article, the mark should in fact be removed.
20050 An example action list:
20053 (((5 12 30) 'del '(tick))
20054 ((10 . 90) 'add '(read expire))
20055 ((92 94) 'del '(read)))
20058 The function should return a range of articles it wasn't able to set the
20059 mark on (currently not used for anything).
20061 There should be no result data from this function.
20063 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
20065 If the user tries to set a mark that the backend doesn't like, this
20066 function may change the mark. Gnus will use whatever this function
20067 returns as the mark for @var{article} instead of the original
20068 @var{mark}. If the backend doesn't care, it must return the original
20069 @var{mark}, and not @code{nil} or any other type of garbage.
20071 The only use for this I can see is what @code{nnvirtual} does with
20072 it---if a component group is auto-expirable, marking an article as read
20073 in the virtual group should result in the article being marked as
20076 There should be no result data from this function.
20079 @item (nnchoke-request-scan &optional GROUP SERVER)
20081 This function may be called at any time (by Gnus or anything else) to
20082 request that the backend check for incoming articles, in one way or
20083 another. A mail backend will typically read the spool file or query the
20084 POP server when this function is invoked. The @var{group} doesn't have
20085 to be heeded---if the backend decides that it is too much work just
20086 scanning for a single group, it may do a total scan of all groups. It
20087 would be nice, however, to keep things local if that's practical.
20089 There should be no result data from this function.
20092 @item (nnchoke-request-group-description GROUP &optional SERVER)
20094 The result data from this function should be a description of
20098 description-line = name <TAB> description eol
20100 description = <text>
20103 @item (nnchoke-request-list-newsgroups &optional SERVER)
20105 The result data from this function should be the description of all
20106 groups available on the server.
20109 description-buffer = *description-line
20113 @item (nnchoke-request-newgroups DATE &optional SERVER)
20115 The result data from this function should be all groups that were
20116 created after @samp{date}, which is in normal human-readable date
20117 format. The data should be in the active buffer format.
20120 @item (nnchoke-request-create-group GROUP &optional SERVER)
20122 This function should create an empty group with name @var{group}.
20124 There should be no return data.
20127 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
20129 This function should run the expiry process on all articles in the
20130 @var{articles} range (which is currently a simple list of article
20131 numbers.) It is left up to the backend to decide how old articles
20132 should be before they are removed by this function. If @var{force} is
20133 non-@code{nil}, all @var{articles} should be deleted, no matter how new
20136 This function should return a list of articles that it did not/was not
20139 There should be no result data returned.
20142 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
20145 This function should move @var{article} (which is a number) from
20146 @var{group} by calling @var{accept-form}.
20148 This function should ready the article in question for moving by
20149 removing any header lines it has added to the article, and generally
20150 should ``tidy up'' the article. Then it should @code{eval}
20151 @var{accept-form} in the buffer where the ``tidy'' article is. This
20152 will do the actual copying. If this @code{eval} returns a
20153 non-@code{nil} value, the article should be removed.
20155 If @var{last} is @code{nil}, that means that there is a high likelihood
20156 that there will be more requests issued shortly, so that allows some
20159 The function should return a cons where the @code{car} is the group name and
20160 the @code{cdr} is the article number that the article was entered as.
20162 There should be no data returned.
20165 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
20167 This function takes the current buffer and inserts it into @var{group}.
20168 If @var{last} in @code{nil}, that means that there will be more calls to
20169 this function in short order.
20171 The function should return a cons where the @code{car} is the group name and
20172 the @code{cdr} is the article number that the article was entered as.
20174 There should be no data returned.
20177 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
20179 This function should remove @var{article} (which is a number) from
20180 @var{group} and insert @var{buffer} there instead.
20182 There should be no data returned.
20185 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
20187 This function should delete @var{group}. If @var{force}, it should
20188 really delete all the articles in the group, and then delete the group
20189 itself. (If there is such a thing as ``the group itself''.)
20191 There should be no data returned.
20194 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
20196 This function should rename @var{group} into @var{new-name}. All
20197 articles in @var{group} should move to @var{new-name}.
20199 There should be no data returned.
20204 @node Error Messaging
20205 @subsubsection Error Messaging
20207 @findex nnheader-report
20208 @findex nnheader-get-report
20209 The backends should use the function @code{nnheader-report} to report
20210 error conditions---they should not raise errors when they aren't able to
20211 perform a request. The first argument to this function is the backend
20212 symbol, and the rest are interpreted as arguments to @code{format} if
20213 there are multiple of them, or just a string if there is one of them.
20214 This function must always returns @code{nil}.
20217 (nnheader-report 'nnchoke "You did something totally bogus")
20219 (nnheader-report 'nnchoke "Could not request group %s" group)
20222 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
20223 @code{nil} back from a server, and this function returns the most
20224 recently reported message for the backend in question. This function
20225 takes one argument---the server symbol.
20227 Internally, these functions access @var{backend}@code{-status-string},
20228 so the @code{nnchoke} backend will have its error message stored in
20229 @code{nnchoke-status-string}.
20232 @node Writing New Backends
20233 @subsubsection Writing New Backends
20235 Many backends are quite similar. @code{nnml} is just like
20236 @code{nnspool}, but it allows you to edit the articles on the server.
20237 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
20238 and it doesn't maintain overview databases. @code{nndir} is just like
20239 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
20242 It would make sense if it were possible to ``inherit'' functions from
20243 backends when writing new backends. And, indeed, you can do that if you
20244 want to. (You don't have to if you don't want to, of course.)
20246 All the backends declare their public variables and functions by using a
20247 package called @code{nnoo}.
20249 To inherit functions from other backends (and allow other backends to
20250 inherit functions from the current backend), you should use the
20256 This macro declares the first parameter to be a child of the subsequent
20257 parameters. For instance:
20260 (nnoo-declare nndir
20264 @code{nndir} has declared here that it intends to inherit functions from
20265 both @code{nnml} and @code{nnmh}.
20268 This macro is equivalent to @code{defvar}, but registers the variable as
20269 a public server variable. Most state-oriented variables should be
20270 declared with @code{defvoo} instead of @code{defvar}.
20272 In addition to the normal @code{defvar} parameters, it takes a list of
20273 variables in the parent backends to map the variable to when executing
20274 a function in those backends.
20277 (defvoo nndir-directory nil
20278 "Where nndir will look for groups."
20279 nnml-current-directory nnmh-current-directory)
20282 This means that @code{nnml-current-directory} will be set to
20283 @code{nndir-directory} when an @code{nnml} function is called on behalf
20284 of @code{nndir}. (The same with @code{nnmh}.)
20286 @item nnoo-define-basics
20287 This macro defines some common functions that almost all backends should
20291 (nnoo-define-basics nndir)
20295 This macro is just like @code{defun} and takes the same parameters. In
20296 addition to doing the normal @code{defun} things, it registers the
20297 function as being public so that other backends can inherit it.
20299 @item nnoo-map-functions
20300 This macro allows mapping of functions from the current backend to
20301 functions from the parent backends.
20304 (nnoo-map-functions nndir
20305 (nnml-retrieve-headers 0 nndir-current-group 0 0)
20306 (nnmh-request-article 0 nndir-current-group 0 0))
20309 This means that when @code{nndir-retrieve-headers} is called, the first,
20310 third, and fourth parameters will be passed on to
20311 @code{nnml-retrieve-headers}, while the second parameter is set to the
20312 value of @code{nndir-current-group}.
20315 This macro allows importing functions from backends. It should be the
20316 last thing in the source file, since it will only define functions that
20317 haven't already been defined.
20323 nnmh-request-newgroups)
20327 This means that calls to @code{nndir-request-list} should just be passed
20328 on to @code{nnmh-request-list}, while all public functions from
20329 @code{nnml} that haven't been defined in @code{nndir} yet should be
20334 Below is a slightly shortened version of the @code{nndir} backend.
20337 ;;; nndir.el --- single directory newsgroup access for Gnus
20338 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
20342 (require 'nnheader)
20346 (eval-when-compile (require 'cl))
20348 (nnoo-declare nndir
20351 (defvoo nndir-directory nil
20352 "Where nndir will look for groups."
20353 nnml-current-directory nnmh-current-directory)
20355 (defvoo nndir-nov-is-evil nil
20356 "*Non-nil means that nndir will never retrieve NOV headers."
20359 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
20360 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
20361 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
20363 (defvoo nndir-status-string "" nil nnmh-status-string)
20364 (defconst nndir-version "nndir 1.0")
20366 ;;; Interface functions.
20368 (nnoo-define-basics nndir)
20370 (deffoo nndir-open-server (server &optional defs)
20371 (setq nndir-directory
20372 (or (cadr (assq 'nndir-directory defs))
20374 (unless (assq 'nndir-directory defs)
20375 (push `(nndir-directory ,server) defs))
20376 (push `(nndir-current-group
20377 ,(file-name-nondirectory (directory-file-name nndir-directory)))
20379 (push `(nndir-top-directory
20380 ,(file-name-directory (directory-file-name nndir-directory)))
20382 (nnoo-change-server 'nndir server defs))
20384 (nnoo-map-functions nndir
20385 (nnml-retrieve-headers 0 nndir-current-group 0 0)
20386 (nnmh-request-article 0 nndir-current-group 0 0)
20387 (nnmh-request-group nndir-current-group 0 0)
20388 (nnmh-close-group nndir-current-group 0))
20392 nnmh-status-message
20394 nnmh-request-newgroups))
20400 @node Hooking New Backends Into Gnus
20401 @subsubsection Hooking New Backends Into Gnus
20403 @vindex gnus-valid-select-methods
20404 Having Gnus start using your new backend is rather easy---you just
20405 declare it with the @code{gnus-declare-backend} functions. This will
20406 enter the backend into the @code{gnus-valid-select-methods} variable.
20408 @code{gnus-declare-backend} takes two parameters---the backend name and
20409 an arbitrary number of @dfn{abilities}.
20414 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
20417 The abilities can be:
20421 This is a mailish backend---followups should (probably) go via mail.
20423 This is a newsish backend---followups should (probably) go via news.
20425 This backend supports both mail and news.
20427 This is neither a post nor mail backend---it's something completely
20430 It supports respooling---or rather, it is able to modify its source
20431 articles and groups.
20433 The name of the server should be in the virtual server name. This is
20434 true for almost all backends.
20435 @item prompt-address
20436 The user should be prompted for an address when doing commands like
20437 @kbd{B} in the group buffer. This is true for backends like
20438 @code{nntp}, but not @code{nnmbox}, for instance.
20442 @node Mail-like Backends
20443 @subsubsection Mail-like Backends
20445 One of the things that separate the mail backends from the rest of the
20446 backends is the heavy dependence by the mail backends on common
20447 functions in @file{nnmail.el}. For instance, here's the definition of
20448 @code{nnml-request-scan}:
20451 (deffoo nnml-request-scan (&optional group server)
20452 (setq nnml-article-file-alist nil)
20453 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
20456 It simply calls @code{nnmail-get-new-mail} with a few parameters,
20457 and @code{nnmail} takes care of all the moving and splitting of the
20460 This function takes four parameters.
20464 This should be a symbol to designate which backend is responsible for
20467 @item exit-function
20468 This function should be called after the splitting has been performed.
20470 @item temp-directory
20471 Where the temporary files should be stored.
20474 This optional argument should be a group name if the splitting is to be
20475 performed for one group only.
20478 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
20479 save each article. @var{backend}@code{-active-number} will be called to
20480 find the article number assigned to this article.
20482 The function also uses the following variables:
20483 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
20484 this backend); and @var{backend}@code{-group-alist} and
20485 @var{backend}@code{-active-file} to generate the new active file.
20486 @var{backend}@code{-group-alist} should be a group-active alist, like
20490 (("a-group" (1 . 10))
20491 ("some-group" (34 . 39)))
20495 @node Score File Syntax
20496 @subsection Score File Syntax
20498 Score files are meant to be easily parseable, but yet extremely
20499 mallable. It was decided that something that had the same read syntax
20500 as an Emacs Lisp list would fit that spec.
20502 Here's a typical score file:
20506 ("win95" -10000 nil s)
20513 BNF definition of a score file:
20516 score-file = "" / "(" *element ")"
20517 element = rule / atom
20518 rule = string-rule / number-rule / date-rule
20519 string-rule = "(" quote string-header quote space *string-match ")"
20520 number-rule = "(" quote number-header quote space *number-match ")"
20521 date-rule = "(" quote date-header quote space *date-match ")"
20523 string-header = "subject" / "from" / "references" / "message-id" /
20524 "xref" / "body" / "head" / "all" / "followup"
20525 number-header = "lines" / "chars"
20526 date-header = "date"
20527 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
20528 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
20529 score = "nil" / <integer>
20530 date = "nil" / <natural number>
20531 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
20532 "r" / "regex" / "R" / "Regex" /
20533 "e" / "exact" / "E" / "Exact" /
20534 "f" / "fuzzy" / "F" / "Fuzzy"
20535 number-match = "(" <integer> [ "" / [ space score [ "" /
20536 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
20537 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
20538 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
20539 space date [ "" / [ space date-match-t ] ] ] ] ")"
20540 date-match-t = "nil" / "at" / "before" / "after"
20541 atom = "(" [ required-atom / optional-atom ] ")"
20542 required-atom = mark / expunge / mark-and-expunge / files /
20543 exclude-files / read-only / touched
20544 optional-atom = adapt / local / eval
20545 mark = "mark" space nil-or-number
20546 nil-or-number = "nil" / <integer>
20547 expunge = "expunge" space nil-or-number
20548 mark-and-expunge = "mark-and-expunge" space nil-or-number
20549 files = "files" *[ space <string> ]
20550 exclude-files = "exclude-files" *[ space <string> ]
20551 read-only = "read-only" [ space "nil" / space "t" ]
20552 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
20553 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
20554 local = "local" *[ space "(" <string> space <form> ")" ]
20555 eval = "eval" space <form>
20556 space = *[ " " / <TAB> / <NEWLINE> ]
20559 Any unrecognized elements in a score file should be ignored, but not
20562 As you can see, white space is needed, but the type and amount of white
20563 space is irrelevant. This means that formatting of the score file is
20564 left up to the programmer---if it's simpler to just spew it all out on
20565 one looong line, then that's ok.
20567 The meaning of the various atoms are explained elsewhere in this
20568 manual (@pxref{Score File Format}).
20572 @subsection Headers
20574 Internally Gnus uses a format for storing article headers that
20575 corresponds to the @sc{nov} format in a mysterious fashion. One could
20576 almost suspect that the author looked at the @sc{nov} specification and
20577 just shamelessly @emph{stole} the entire thing, and one would be right.
20579 @dfn{Header} is a severely overloaded term. ``Header'' is used in
20580 RFC1036 to talk about lines in the head of an article (e.g.,
20581 @code{From}). It is used by many people as a synonym for
20582 ``head''---``the header and the body''. (That should be avoided, in my
20583 opinion.) And Gnus uses a format internally that it calls ``header'',
20584 which is what I'm talking about here. This is a 9-element vector,
20585 basically, with each header (ouch) having one slot.
20587 These slots are, in order: @code{number}, @code{subject}, @code{from},
20588 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
20589 @code{xref}, and @code{extra}. There are macros for accessing and
20590 setting these slots---they all have predictable names beginning with
20591 @code{mail-header-} and @code{mail-header-set-}, respectively.
20593 All these slots contain strings, except the @code{extra} slot, which
20594 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
20600 @sc{gnus} introduced a concept that I found so useful that I've started
20601 using it a lot and have elaborated on it greatly.
20603 The question is simple: If you have a large amount of objects that are
20604 identified by numbers (say, articles, to take a @emph{wild} example)
20605 that you want to qualify as being ``included'', a normal sequence isn't
20606 very useful. (A 200,000 length sequence is a bit long-winded.)
20608 The solution is as simple as the question: You just collapse the
20612 (1 2 3 4 5 6 10 11 12)
20615 is transformed into
20618 ((1 . 6) (10 . 12))
20621 To avoid having those nasty @samp{(13 . 13)} elements to denote a
20622 lonesome object, a @samp{13} is a valid element:
20625 ((1 . 6) 7 (10 . 12))
20628 This means that comparing two ranges to find out whether they are equal
20629 is slightly tricky:
20632 ((1 . 5) 7 8 (10 . 12))
20638 ((1 . 5) (7 . 8) (10 . 12))
20641 are equal. In fact, any non-descending list is a range:
20647 is a perfectly valid range, although a pretty long-winded one. This is
20654 and is equal to the previous range.
20656 Here's a BNF definition of ranges. Of course, one must remember the
20657 semantic requirement that the numbers are non-descending. (Any number
20658 of repetition of the same number is allowed, but apt to disappear in
20662 range = simple-range / normal-range
20663 simple-range = "(" number " . " number ")"
20664 normal-range = "(" start-contents ")"
20665 contents = "" / simple-range *[ " " contents ] /
20666 number *[ " " contents ]
20669 Gnus currently uses ranges to keep track of read articles and article
20670 marks. I plan on implementing a number of range operators in C if The
20671 Powers That Be are willing to let me. (I haven't asked yet, because I
20672 need to do some more thinking on what operators I need to make life
20673 totally range-based without ever having to convert back to normal
20678 @subsection Group Info
20680 Gnus stores all permanent info on groups in a @dfn{group info} list.
20681 This list is from three to six elements (or more) long and exhaustively
20682 describes the group.
20684 Here are two example group infos; one is a very simple group while the
20685 second is a more complex one:
20688 ("no.group" 5 ((1 . 54324)))
20690 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
20691 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
20693 ((auto-expire . t) (to-address . "ding@@gnus.org")))
20696 The first element is the @dfn{group name}---as Gnus knows the group,
20697 anyway. The second element is the @dfn{subscription level}, which
20698 normally is a small integer. (It can also be the @dfn{rank}, which is a
20699 cons cell where the @code{car} is the level and the @code{cdr} is the
20700 score.) The third element is a list of ranges of read articles. The
20701 fourth element is a list of lists of article marks of various kinds.
20702 The fifth element is the select method (or virtual server, if you like).
20703 The sixth element is a list of @dfn{group parameters}, which is what
20704 this section is about.
20706 Any of the last three elements may be missing if they are not required.
20707 In fact, the vast majority of groups will normally only have the first
20708 three elements, which saves quite a lot of cons cells.
20710 Here's a BNF definition of the group info format:
20713 info = "(" group space ralevel space read
20714 [ "" / [ space marks-list [ "" / [ space method [ "" /
20715 space parameters ] ] ] ] ] ")"
20716 group = quote <string> quote
20717 ralevel = rank / level
20718 level = <integer in the range of 1 to inf>
20719 rank = "(" level "." score ")"
20720 score = <integer in the range of 1 to inf>
20722 marks-lists = nil / "(" *marks ")"
20723 marks = "(" <string> range ")"
20724 method = "(" <string> *elisp-forms ")"
20725 parameters = "(" *elisp-forms ")"
20728 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
20729 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
20732 If you have a Gnus info and want to access the elements, Gnus offers a
20733 series of macros for getting/setting these elements.
20736 @item gnus-info-group
20737 @itemx gnus-info-set-group
20738 @findex gnus-info-group
20739 @findex gnus-info-set-group
20740 Get/set the group name.
20742 @item gnus-info-rank
20743 @itemx gnus-info-set-rank
20744 @findex gnus-info-rank
20745 @findex gnus-info-set-rank
20746 Get/set the group rank (@pxref{Group Score}).
20748 @item gnus-info-level
20749 @itemx gnus-info-set-level
20750 @findex gnus-info-level
20751 @findex gnus-info-set-level
20752 Get/set the group level.
20754 @item gnus-info-score
20755 @itemx gnus-info-set-score
20756 @findex gnus-info-score
20757 @findex gnus-info-set-score
20758 Get/set the group score (@pxref{Group Score}).
20760 @item gnus-info-read
20761 @itemx gnus-info-set-read
20762 @findex gnus-info-read
20763 @findex gnus-info-set-read
20764 Get/set the ranges of read articles.
20766 @item gnus-info-marks
20767 @itemx gnus-info-set-marks
20768 @findex gnus-info-marks
20769 @findex gnus-info-set-marks
20770 Get/set the lists of ranges of marked articles.
20772 @item gnus-info-method
20773 @itemx gnus-info-set-method
20774 @findex gnus-info-method
20775 @findex gnus-info-set-method
20776 Get/set the group select method.
20778 @item gnus-info-params
20779 @itemx gnus-info-set-params
20780 @findex gnus-info-params
20781 @findex gnus-info-set-params
20782 Get/set the group parameters.
20785 All the getter functions take one parameter---the info list. The setter
20786 functions take two parameters---the info list and the new value.
20788 The last three elements in the group info aren't mandatory, so it may be
20789 necessary to extend the group info before setting the element. If this
20790 is necessary, you can just pass on a non-@code{nil} third parameter to
20791 the three final setter functions to have this happen automatically.
20794 @node Extended Interactive
20795 @subsection Extended Interactive
20796 @cindex interactive
20797 @findex gnus-interactive
20799 Gnus extends the standard Emacs @code{interactive} specification
20800 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
20801 Prefixes}). Here's an example of how this is used:
20804 (defun gnus-summary-increase-score (&optional score symp)
20805 (interactive (gnus-interactive "P\ny"))
20810 The best thing to do would have been to implement
20811 @code{gnus-interactive} as a macro which would have returned an
20812 @code{interactive} form, but this isn't possible since Emacs checks
20813 whether a function is interactive or not by simply doing an @code{assq}
20814 on the lambda form. So, instead we have @code{gnus-interactive}
20815 function that takes a string and returns values that are usable to
20816 @code{interactive}.
20818 This function accepts (almost) all normal @code{interactive} specs, but
20823 @vindex gnus-current-prefix-symbol
20824 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
20828 @vindex gnus-current-prefix-symbols
20829 A list of the current symbolic prefixes---the
20830 @code{gnus-current-prefix-symbol} variable.
20833 The current article number---the @code{gnus-summary-article-number}
20837 The current article header---the @code{gnus-summary-article-header}
20841 The current group name---the @code{gnus-group-group-name}
20847 @node Emacs/XEmacs Code
20848 @subsection Emacs/XEmacs Code
20852 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
20853 platforms must be the primary one. I chose Emacs. Not because I don't
20854 like XEmacs or Mule, but because it comes first alphabetically.
20856 This means that Gnus will byte-compile under Emacs with nary a warning,
20857 while XEmacs will pump out gigabytes of warnings while byte-compiling.
20858 As I use byte-compilation warnings to help me root out trivial errors in
20859 Gnus, that's very useful.
20861 I've also consistently used Emacs function interfaces, but have used
20862 Gnusey aliases for the functions. To take an example: Emacs defines a
20863 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
20864 function. I then define a function called @code{gnus-run-at-time} that
20865 takes the same parameters as the Emacs @code{run-at-time}. When running
20866 Gnus under Emacs, the former function is just an alias for the latter.
20867 However, when running under XEmacs, the former is an alias for the
20868 following function:
20871 (defun gnus-xmas-run-at-time (time repeat function &rest args)
20875 (,function ,@@args))
20879 This sort of thing has been done for bunches of functions. Gnus does
20880 not redefine any native Emacs functions while running under XEmacs---it
20881 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
20884 In the cases where the XEmacs function interface was obviously cleaner,
20885 I used it instead. For example @code{gnus-region-active-p} is an alias
20886 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
20888 Of course, I could have chosen XEmacs as my native platform and done
20889 mapping functions the other way around. But I didn't. The performance
20890 hit these indirections impose on Gnus under XEmacs should be slight.
20893 @node Various File Formats
20894 @subsection Various File Formats
20897 * Active File Format:: Information on articles and groups available.
20898 * Newsgroups File Format:: Group descriptions.
20902 @node Active File Format
20903 @subsubsection Active File Format
20905 The active file lists all groups available on the server in
20906 question. It also lists the highest and lowest current article numbers
20909 Here's an excerpt from a typical active file:
20912 soc.motss 296030 293865 y
20913 alt.binaries.pictures.fractals 3922 3913 n
20914 comp.sources.unix 1605 1593 m
20915 comp.binaries.ibm.pc 5097 5089 y
20916 no.general 1000 900 y
20919 Here's a pseudo-BNF definition of this file:
20922 active = *group-line
20923 group-line = group space high-number space low-number space flag <NEWLINE>
20924 group = <non-white-space string>
20926 high-number = <non-negative integer>
20927 low-number = <positive integer>
20928 flag = "y" / "n" / "m" / "j" / "x" / "=" group
20931 For a full description of this file, see the manual pages for
20932 @samp{innd}, in particular @samp{active(5)}.
20935 @node Newsgroups File Format
20936 @subsubsection Newsgroups File Format
20938 The newsgroups file lists groups along with their descriptions. Not all
20939 groups on the server have to be listed, and not all groups in the file
20940 have to exist on the server. The file is meant purely as information to
20943 The format is quite simple; a group name, a tab, and the description.
20944 Here's the definition:
20948 line = group tab description <NEWLINE>
20949 group = <non-white-space string>
20951 description = <string>
20956 @node Emacs for Heathens
20957 @section Emacs for Heathens
20959 Believe it or not, but some people who use Gnus haven't really used
20960 Emacs much before they embarked on their journey on the Gnus Love Boat.
20961 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
20962 region'', and ``set @code{gnus-flargblossen} to an alist where the key
20963 is a regexp that is used for matching on the group name'' are magical
20964 phrases with little or no meaning, then this appendix is for you. If
20965 you are already familiar with Emacs, just ignore this and go fondle your
20969 * Keystrokes:: Entering text and executing commands.
20970 * Emacs Lisp:: The built-in Emacs programming language.
20975 @subsection Keystrokes
20979 Q: What is an experienced Emacs user?
20982 A: A person who wishes that the terminal had pedals.
20985 Yes, when you use Emacs, you are apt to use the control key, the shift
20986 key and the meta key a lot. This is very annoying to some people
20987 (notably @code{vi}le users), and the rest of us just love the hell out
20988 of it. Just give up and submit. Emacs really does stand for
20989 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
20990 may have heard from other disreputable sources (like the Emacs author).
20992 The shift keys are normally located near your pinky fingers, and are
20993 normally used to get capital letters and stuff. You probably use it all
20994 the time. The control key is normally marked ``CTRL'' or something like
20995 that. The meta key is, funnily enough, never marked as such on any
20996 keyboard. The one I'm currently at has a key that's marked ``Alt'',
20997 which is the meta key on this keyboard. It's usually located somewhere
20998 to the left hand side of the keyboard, usually on the bottom row.
21000 Now, us Emacs people don't say ``press the meta-control-m key'',
21001 because that's just too inconvenient. We say ``press the @kbd{M-C-m}
21002 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
21003 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
21004 down the control key, and hold it down while you press @kbd{k}''.
21005 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
21006 the control key and then press @kbd{k}''. Simple, ay?
21008 This is somewhat complicated by the fact that not all keyboards have a
21009 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
21010 means ``press escape, release escape, press @kbd{k}''. That's much more
21011 work than if you have a meta key, so if that's the case, I respectfully
21012 suggest you get a real keyboard with a meta key. You can't live without
21018 @subsection Emacs Lisp
21020 Emacs is the King of Editors because it's really a Lisp interpreter.
21021 Each and every key you tap runs some Emacs Lisp code snippet, and since
21022 Emacs Lisp is an interpreted language, that means that you can configure
21023 any key to run any arbitrary code. You just, like, do it.
21025 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
21026 functions. (These are byte-compiled for speed, but it's still
21027 interpreted.) If you decide that you don't like the way Gnus does
21028 certain things, it's trivial to have it do something a different way.
21029 (Well, at least if you know how to write Lisp code.) However, that's
21030 beyond the scope of this manual, so we are simply going to talk about
21031 some common constructs that you normally use in your @file{.emacs} file
21034 If you want to set the variable @code{gnus-florgbnize} to four (4), you
21035 write the following:
21038 (setq gnus-florgbnize 4)
21041 This function (really ``special form'') @code{setq} is the one that can
21042 set a variable to some value. This is really all you need to know. Now
21043 you can go and fill your @code{.emacs} file with lots of these to change
21046 If you have put that thing in your @code{.emacs} file, it will be read
21047 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
21048 start Emacs. If you want to change the variable right away, simply say
21049 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
21050 previous ``form'', which is a simple @code{setq} statement here.
21052 Go ahead---just try it, if you're located at your Emacs. After you
21053 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
21054 is the return value of the form you @code{eval}ed.
21058 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
21062 (setq gnus-read-active-file 'some)
21065 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
21066 @samp{nntp.ifi.uio.no}'', that means:
21069 (setq gnus-nntp-server "nntp.ifi.uio.no")
21072 So be careful not to mix up strings (the latter) with symbols (the
21073 former). The manual is unambiguous, but it can be confusing.
21076 @include gnus-faq.texi