1 @c \input texinfo @c -*-texinfo-*-
4 @settitle T-gnus 6.13 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 T-gnus 6.13 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 T-gnus provides MIME features based on SEMI API. So T-gnus supports
359 your right to read strange messages including big images or other
360 various kinds of formats. T-gnus also supports
361 internationalization/localization and multiscript features based on MULE
362 API. So T-gnus does not discriminate various language communities.
363 Oh, if you are a Klingon, please wait Unicode Next Generation.
365 This manual corresponds to T-gnus 6.13.
376 Gnus is the advanced, self-documenting, customizable, extensible
377 unreal-time newsreader for GNU Emacs.
379 Oops. That sounds oddly familiar, so let's start over again to avoid
380 being accused of plagiarism:
382 Gnus is a message-reading laboratory. It will let you look at just
383 about anything as if it were a newsgroup. You can read mail with it,
384 you can browse directories with it, you can @code{ftp} with it---you can
385 even read news with it!
387 Gnus tries to empower people who read news the same way Emacs empowers
388 people who edit text. Gnus sets no limits to what the user should be
389 allowed to do. Users are encouraged to extend gnus to make it behave
390 like they want it to behave. A program should not control people;
391 people should be empowered to do what they want by using (or abusing)
398 * Starting Up:: Finding news can be a pain.
399 * The Group Buffer:: Selecting, subscribing and killing groups.
400 * The Summary Buffer:: Reading, saving and posting articles.
401 * The Article Buffer:: Displaying and handling articles.
402 * Composing Messages:: Information on sending mail and news.
403 * Select Methods:: Gnus reads all messages from various select methods.
404 * Scoring:: Assigning values to articles.
405 * Various:: General purpose settings.
406 * The End:: Farewell and goodbye.
407 * Appendices:: Terminology, Emacs intro, FAQ, History, Internals.
408 * Index:: Variable, function and concept index.
409 * Key Index:: Key Index.
413 @chapter Starting gnus
418 If your system administrator has set things up properly, starting gnus
419 and reading news is extremely easy---you just type @kbd{M-x gnus} in
422 @findex gnus-other-frame
423 @kindex M-x gnus-other-frame
424 If you want to start gnus in a different frame, you can use the command
425 @kbd{M-x gnus-other-frame} instead.
427 If things do not go smoothly at startup, you have to twiddle some
428 variables in your @file{~/.gnus} file. This file is similar to
429 @file{~/.emacs}, but is read when gnus starts.
431 If you puzzle at any terms used in this manual, please refer to the
432 terminology section (@pxref{Terminology}).
435 * Finding the News:: Choosing a method for getting news.
436 * The First Time:: What does gnus do the first time you start it?
437 * The Server is Down:: How can I read my mail then?
438 * Slave Gnusae:: You can have more than one gnus active at a time.
439 * Fetching a Group:: Starting gnus just to read a group.
440 * New Groups:: What is gnus supposed to do with new groups?
441 * Startup Files:: Those pesky startup files---@file{.newsrc}.
442 * Auto Save:: Recovering from a crash.
443 * The Active File:: Reading the active file over a slow line Takes Time.
444 * Changing Servers:: You may want to move from one server to another.
445 * Startup Variables:: Other variables you might change.
449 @node Finding the News
450 @section Finding the News
453 @vindex gnus-select-method
455 The @code{gnus-select-method} variable says where gnus should look for
456 news. This variable should be a list where the first element says
457 @dfn{how} and the second element says @dfn{where}. This method is your
458 native method. All groups not fetched with this method are
461 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
462 you want to get your daily dosage of news from, you'd say:
465 (setq gnus-select-method '(nntp "news.somewhere.edu"))
468 If you want to read directly from the local spool, say:
471 (setq gnus-select-method '(nnspool ""))
474 If you can use a local spool, you probably should, as it will almost
475 certainly be much faster.
477 @vindex gnus-nntpserver-file
479 @cindex @sc{nntp} server
480 If this variable is not set, gnus will take a look at the
481 @code{NNTPSERVER} environment variable. If that variable isn't set,
482 gnus will see whether @code{gnus-nntpserver-file}
483 (@file{/etc/nntpserver} by default) has any opinions on the matter. If
484 that fails as well, gnus will try to use the machine running Emacs as an @sc{nntp} server. That's a long shot, though.
486 @vindex gnus-nntp-server
487 If @code{gnus-nntp-server} is set, this variable will override
488 @code{gnus-select-method}. You should therefore set
489 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
491 @vindex gnus-secondary-servers
492 @vindex gnus-nntp-server
493 You can also make gnus prompt you interactively for the name of an
494 @sc{nntp} server. If you give a non-numerical prefix to @code{gnus}
495 (i.e., @kbd{C-u M-x gnus}), gnus will let you choose between the servers
496 in the @code{gnus-secondary-servers} list (if any). You can also just
497 type in the name of any server you feel like visiting. (Note that this
498 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
499 gnus} later in the same Emacs session, Gnus will contact the same
502 @findex gnus-group-browse-foreign-server
504 However, if you use one @sc{nntp} server regularly and are just
505 interested in a couple of groups from a different server, you would be
506 better served by using the @kbd{B} command in the group buffer. It will
507 let you have a look at what groups are available, and you can subscribe
508 to any of the groups you want to. This also makes @file{.newsrc}
509 maintenance much tidier. @xref{Foreign Groups}.
511 @vindex gnus-secondary-select-methods
513 A slightly different approach to foreign groups is to set the
514 @code{gnus-secondary-select-methods} variable. The select methods
515 listed in this variable are in many ways just as native as the
516 @code{gnus-select-method} server. They will also be queried for active
517 files during startup (if that's required), and new newsgroups that
518 appear on these servers will be subscribed (or not) just as native
521 For instance, if you use the @code{nnmbox} backend to read your mail, you
522 would typically set this variable to
525 (setq gnus-secondary-select-methods '((nnmbox "")))
530 @section The First Time
531 @cindex first time usage
533 If no startup files exist, gnus will try to determine what groups should
534 be subscribed by default.
536 @vindex gnus-default-subscribed-newsgroups
537 If the variable @code{gnus-default-subscribed-newsgroups} is set, gnus
538 will subscribe you to just those groups in that list, leaving the rest
539 killed. Your system administrator should have set this variable to
542 Since she hasn't, gnus will just subscribe you to a few arbitrarily
543 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
544 here as @dfn{whatever Lars thinks you should read}.)
546 You'll also be subscribed to the gnus documentation group, which should
547 help you with most common problems.
549 If @code{gnus-default-subscribed-newsgroups} is @code{t}, gnus will just
550 use the normal functions for handling new groups, and not do anything
554 @node The Server is Down
555 @section The Server is Down
556 @cindex server errors
558 If the default server is down, gnus will understandably have some
559 problems starting. However, if you have some mail groups in addition to
560 the news groups, you may want to start gnus anyway.
562 Gnus, being the trusting sort of program, will ask whether to proceed
563 without a native select method if that server can't be contacted. This
564 will happen whether the server doesn't actually exist (i.e., you have
565 given the wrong address) or the server has just momentarily taken ill
566 for some reason or other. If you decide to continue and have no foreign
567 groups, you'll find it difficult to actually do anything in the group
568 buffer. But, hey, that's your problem. Blllrph!
570 @findex gnus-no-server
571 @kindex M-x gnus-no-server
573 If you know that the server is definitely down, or you just want to read
574 your mail without bothering with the server at all, you can use the
575 @code{gnus-no-server} command to start gnus. That might come in handy
576 if you're in a hurry as well. This command will not attempt to contact
577 your primary server---instead, it will just activate all groups on level
578 1 and 2. (You should preferably keep no native groups on those two
583 @section Slave Gnusae
586 You might want to run more than one Emacs with more than one gnus at the
587 same time. If you are using different @file{.newsrc} files (e.g., if you
588 are using the two different gnusae to read from two different servers),
589 that is no problem whatsoever. You just do it.
591 The problem appears when you want to run two Gnusae that use the same
594 To work around that problem some, we here at the Think-Tank at the gnus
595 Towers have come up with a new concept: @dfn{Masters} and
596 @dfn{slaves}. (We have applied for a patent on this concept, and have
597 taken out a copyright on those words. If you wish to use those words in
598 conjunction with each other, you have to send $1 per usage instance to
599 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
600 Applications}) will be much more expensive, of course.)
602 Anyways, you start one gnus up the normal way with @kbd{M-x gnus} (or
603 however you do it). Each subsequent slave gnusae should be started with
604 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
605 files, but instead save @dfn{slave files} that contain information only
606 on what groups have been read in the slave session. When a master gnus
607 starts, it will read (and delete) these slave files, incorporating all
608 information from them. (The slave files will be read in the sequence
609 they were created, so the latest changes will have precedence.)
611 Information from the slave files has, of course, precedence over the
612 information in the normal (i.e., master) @code{.newsrc} file.
615 @node Fetching a Group
616 @section Fetching a Group
617 @cindex fetching a group
619 @findex gnus-fetch-group
620 It is sometimes convenient to be able to just say ``I want to read this
621 group and I don't care whether gnus has been started or not''. This is
622 perhaps more useful for people who write code than for users, but the
623 command @code{gnus-fetch-group} provides this functionality in any case.
624 It takes the group name as a parameter.
632 @vindex gnus-check-new-newsgroups
633 If you are satisfied that you really never want to see any new groups,
634 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
635 also save you some time at startup. Even if this variable is
636 @code{nil}, you can always subscribe to the new groups just by pressing
637 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
638 is @code{ask-server} by default. If you set this variable to
639 @code{always}, then gnus will query the backends for new groups even
640 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
643 * Checking New Groups:: Determining what groups are new.
644 * Subscription Methods:: What gnus should do with new groups.
645 * Filtering New Groups:: Making gnus ignore certain new groups.
649 @node Checking New Groups
650 @subsection Checking New Groups
652 Gnus normally determines whether a group is new or not by comparing the
653 list of groups from the active file(s) with the lists of subscribed and
654 dead groups. This isn't a particularly fast method. If
655 @code{gnus-check-new-newsgroups} is @code{ask-server}, gnus will ask the
656 server for new groups since the last time. This is both faster and
657 cheaper. This also means that you can get rid of the list of killed
658 groups altogether, so you may set @code{gnus-save-killed-list} to
659 @code{nil}, which will save time both at startup, at exit, and all over.
660 Saves disk space, too. Why isn't this the default, then?
661 Unfortunately, not all servers support this command.
663 I bet I know what you're thinking now: How do I find out whether my
664 server supports @code{ask-server}? No? Good, because I don't have a
665 fail-safe answer. I would suggest just setting this variable to
666 @code{ask-server} and see whether any new groups appear within the next
667 few days. If any do, then it works. If none do, then it doesn't
668 work. I could write a function to make gnus guess whether the server
669 supports @code{ask-server}, but it would just be a guess. So I won't.
670 You could @code{telnet} to the server and say @code{HELP} and see
671 whether it lists @samp{NEWGROUPS} among the commands it understands. If
672 it does, then it might work. (But there are servers that lists
673 @samp{NEWGROUPS} without supporting the function properly.)
675 This variable can also be a list of select methods. If so, gnus will
676 issue an @code{ask-server} command to each of the select methods, and
677 subscribe them (or not) using the normal methods. This might be handy
678 if you are monitoring a few servers for new groups. A side effect is
679 that startup will take much longer, so you can meditate while waiting.
680 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
683 @node Subscription Methods
684 @subsection Subscription Methods
686 @vindex gnus-subscribe-newsgroup-method
687 What gnus does when it encounters a new group is determined by the
688 @code{gnus-subscribe-newsgroup-method} variable.
690 This variable should contain a function. This function will be called
691 with the name of the new group as the only parameter.
693 Some handy pre-fab functions are:
697 @item gnus-subscribe-zombies
698 @vindex gnus-subscribe-zombies
699 Make all new groups zombies. This is the default. You can browse the
700 zombies later (with @kbd{A z}) and either kill them all off properly
701 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
703 @item gnus-subscribe-randomly
704 @vindex gnus-subscribe-randomly
705 Subscribe all new groups in arbitrary order. This really means that all
706 new groups will be added at ``the top'' of the group buffer.
708 @item gnus-subscribe-alphabetically
709 @vindex gnus-subscribe-alphabetically
710 Subscribe all new groups in alphabetical order.
712 @item gnus-subscribe-hierarchically
713 @vindex gnus-subscribe-hierarchically
714 Subscribe all new groups hierarchically. The difference between this
715 function and @code{gnus-subscribe-alphabetically} is slight.
716 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
717 alphabetical fashion, while this function will enter groups into its
718 hierarchy. So if you want to have the @samp{rec} hierarchy before the
719 @samp{comp} hierarchy, this function will not mess that configuration
720 up. Or something like that.
722 @item gnus-subscribe-interactively
723 @vindex gnus-subscribe-interactively
724 Subscribe new groups interactively. This means that gnus will ask
725 you about @strong{all} new groups. The groups you choose to subscribe
726 to will be subscribed hierarchically.
728 @item gnus-subscribe-killed
729 @vindex gnus-subscribe-killed
734 @vindex gnus-subscribe-hierarchical-interactive
735 A closely related variable is
736 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
737 mouthful.) If this variable is non-@code{nil}, gnus will ask you in a
738 hierarchical fashion whether to subscribe to new groups or not. Gnus
739 will ask you for each sub-hierarchy whether you want to descend the
742 One common mistake is to set the variable a few paragraphs above
743 (@code{gnus-subscribe-newsgroup-method}) to
744 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
745 will not work. This is ga-ga. So don't do it.
748 @node Filtering New Groups
749 @subsection Filtering New Groups
751 A nice and portable way to control which new newsgroups should be
752 subscribed (or ignored) is to put an @dfn{options} line at the start of
753 the @file{.newsrc} file. Here's an example:
756 options -n !alt.all !rec.all sci.all
759 @vindex gnus-subscribe-options-newsgroup-method
760 This line obviously belongs to a serious-minded intellectual scientific
761 person (or she may just be plain old boring), because it says that all
762 groups that have names beginning with @samp{alt} and @samp{rec} should
763 be ignored, and all groups with names beginning with @samp{sci} should
764 be subscribed. Gnus will not use the normal subscription method for
765 subscribing these groups.
766 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
767 variable defaults to @code{gnus-subscribe-alphabetically}.
769 @vindex gnus-options-not-subscribe
770 @vindex gnus-options-subscribe
771 If you don't want to mess with your @file{.newsrc} file, you can just
772 set the two variables @code{gnus-options-subscribe} and
773 @code{gnus-options-not-subscribe}. These two variables do exactly the
774 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
775 and if the new group matches the former, it will be unconditionally
776 subscribed, and if it matches the latter, it will be ignored.
778 @vindex gnus-auto-subscribed-groups
779 Yet another variable that meddles here is
780 @code{gnus-auto-subscribed-groups}. It works exactly like
781 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
782 thought it would be nice to have two of these. This variable is more
783 meant for setting some ground rules, while the other variable is used
784 more for user fiddling. By default this variable makes all new groups
785 that come from mail backends (@code{nnml}, @code{nnbabyl},
786 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you
787 don't like that, just set this variable to @code{nil}.
789 New groups that match this regexp are subscribed using
790 @code{gnus-subscribe-options-newsgroup-method}.
793 @node Changing Servers
794 @section Changing Servers
795 @cindex changing servers
797 Sometimes it is necessary to move from one @sc{nntp} server to another.
798 This happens very rarely, but perhaps you change jobs, or one server is
799 very flaky and you want to use another.
801 Changing the server is pretty easy, right? You just change
802 @code{gnus-select-method} to point to the new server?
806 Article numbers are not (in any way) kept synchronized between different
807 @sc{nntp} servers, and the only way Gnus keeps track of what articles
808 you have read is by keeping track of article numbers. So when you
809 change @code{gnus-select-method}, your @file{.newsrc} file becomes
812 Gnus provides a few functions to attempt to translate a @file{.newsrc}
813 file from one server to another. They all have one thing in
814 common---they take a looong time to run. You don't want to use these
815 functions more than absolutely necessary.
817 @kindex M-x gnus-change-server
818 @findex gnus-change-server
819 If you have access to both servers, Gnus can request the headers for all
820 the articles you have read and compare @code{Message-ID}s and map the
821 article numbers of the read articles and article marks. The @kbd{M-x
822 gnus-change-server} command will do this for all your native groups. It
823 will prompt for the method you want to move to.
825 @kindex M-x gnus-group-move-group-to-server
826 @findex gnus-group-move-group-to-server
827 You can also move individual groups with the @kbd{M-x
828 gnus-group-move-group-to-server} command. This is useful if you want to
829 move a (foreign) group from one server to another.
831 @kindex M-x gnus-group-clear-data-on-native-groups
832 @findex gnus-group-clear-data-on-native-groups
833 If you don't have access to both the old and new server, all your marks
834 and read ranges have become worthless. You can use the @kbd{M-x
835 gnus-group-clear-data-on-native-groups} command to clear out all data
836 that you have on your native groups. Use with caution.
838 After changing servers, you @strong{must} move the cache hierarchy away,
839 since the cached articles will have wrong article numbers, which will
840 affect which articles Gnus thinks are read.
844 @section Startup Files
845 @cindex startup files
850 Now, you all know about the @file{.newsrc} file. All subscription
851 information is traditionally stored in this file.
853 Things got a bit more complicated with @sc{GNUS}. In addition to
854 keeping the @file{.newsrc} file updated, it also used a file called
855 @file{.newsrc.el} for storing all the information that didn't fit into
856 the @file{.newsrc} file. (Actually, it also duplicated everything in
857 the @file{.newsrc} file.) @sc{GNUS} would read whichever one of these
858 files was the most recently saved, which enabled people to swap between
859 @sc{gnus} and other newsreaders.
861 That was kinda silly, so Gnus went one better: In addition to the
862 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
863 @file{.newsrc.eld}. It will read whichever of these files that are most
864 recent, but it will never write a @file{.newsrc.el} file. You should
865 never delete the @file{.newsrc.eld} file---it contains much information
866 not stored in the @file{.newsrc} file.
868 @vindex gnus-save-newsrc-file
869 @vindex gnus-read-newsrc-file
870 You can turn off writing the @file{.newsrc} file by setting
871 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
872 the file and save some space, as well as exiting from gnus faster.
873 However, this will make it impossible to use other newsreaders than
874 gnus. But hey, who would want to, right? Similarly, setting
875 @code{gnus-read-newsrc-file} to @code{nil} makes gnus ignore the
876 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
877 convenient if you have a tendency to use Netscape once in a while.
879 @vindex gnus-save-killed-list
880 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
881 will not save the list of killed groups to the startup file. This will
882 save both time (when starting and quitting) and space (on disk). It
883 will also mean that Gnus has no record of what groups are new or old,
884 so the automatic new groups subscription methods become meaningless.
885 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
886 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
887 Groups}). This variable can also be a regular expression. If that's
888 the case, remove all groups that do not match this regexp before
889 saving. This can be useful in certain obscure situations that involve
890 several servers where not all servers support @code{ask-server}.
892 @vindex gnus-startup-file
893 The @code{gnus-startup-file} variable says where the startup files are.
894 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
895 file being whatever that one is, with a @samp{.eld} appended.
897 @vindex gnus-save-newsrc-hook
898 @vindex gnus-save-quick-newsrc-hook
899 @vindex gnus-save-standard-newsrc-hook
900 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
901 files, while @code{gnus-save-quick-newsrc-hook} is called just before
902 saving the @file{.newsrc.eld} file, and
903 @code{gnus-save-standard-newsrc-hook} is called just before saving the
904 @file{.newsrc} file. The latter two are commonly used to turn version
905 control on or off. Version control is on by default when saving the
906 startup files. If you want to turn backup creation off, say something like:
909 (defun turn-off-backup ()
910 (set (make-local-variable 'backup-inhibited) t))
912 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
913 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
916 @vindex gnus-init-file
917 When gnus starts, it will read the @code{gnus-site-init-file}
918 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
919 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
920 and can be used to avoid cluttering your @file{~/.emacs} and
921 @file{site-init} files with gnus stuff. Gnus will also check for files
922 with the same names as these, but with @file{.elc} and @file{.el}
923 suffixes. In other words, if you have set @code{gnus-init-file} to
924 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
925 and finally @file{~/.gnus} (in this order).
934 Whenever you do something that changes the gnus data (reading articles,
935 catching up, killing/subscribing groups), the change is added to a
936 special @dfn{dribble buffer}. This buffer is auto-saved the normal
937 Emacs way. If your Emacs should crash before you have saved the
938 @file{.newsrc} files, all changes you have made can be recovered from
941 If gnus detects this file at startup, it will ask the user whether to
942 read it. The auto save file is deleted whenever the real startup file is
945 @vindex gnus-use-dribble-file
946 If @code{gnus-use-dribble-file} is @code{nil}, gnus won't create and
947 maintain a dribble buffer. The default is @code{t}.
949 @vindex gnus-dribble-directory
950 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
951 this variable is @code{nil}, which it is by default, gnus will dribble
952 into the directory where the @file{.newsrc} file is located. (This is
953 normally the user's home directory.) The dribble file will get the same
954 file permissions as the @code{.newsrc} file.
956 @vindex gnus-always-read-dribble-file
957 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
958 read the dribble file on startup without querying the user.
961 @node The Active File
962 @section The Active File
964 @cindex ignored groups
966 When gnus starts, or indeed whenever it tries to determine whether new
967 articles have arrived, it reads the active file. This is a very large
968 file that lists all the active groups and articles on the server.
970 @vindex gnus-ignored-newsgroups
971 Before examining the active file, gnus deletes all lines that match the
972 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
973 any groups with bogus names, but you can use this variable to make gnus
974 ignore hierarchies you aren't ever interested in. However, this is not
975 recommended. In fact, it's highly discouraged. Instead, @pxref{New
976 Groups} for an overview of other variables that can be used instead.
979 @c @code{nil} by default, and will slow down active file handling somewhat
980 @c if you set it to anything else.
982 @vindex gnus-read-active-file
984 The active file can be rather Huge, so if you have a slow network, you
985 can set @code{gnus-read-active-file} to @code{nil} to prevent gnus from
986 reading the active file. This variable is @code{some} by default.
988 Gnus will try to make do by getting information just on the groups that
989 you actually subscribe to.
991 Note that if you subscribe to lots and lots of groups, setting this
992 variable to @code{nil} will probably make gnus slower, not faster. At
993 present, having this variable @code{nil} will slow gnus down
994 considerably, unless you read news over a 2400 baud modem.
996 This variable can also have the value @code{some}. Gnus will then
997 attempt to read active info only on the subscribed groups. On some
998 servers this is quite fast (on sparkling, brand new INN servers that
999 support the @code{LIST ACTIVE group} command), on others this isn't fast
1000 at all. In any case, @code{some} should be faster than @code{nil}, and
1001 is certainly faster than @code{t} over slow lines.
1003 Some news servers (Leafnode and old versions of INN, for instance) do
1004 not support the @code{LIST ACTIVE group}. For these servers, @code{nil}
1005 is probably the most efficient value for this variable.
1007 If this variable is @code{nil}, gnus will ask for group info in total
1008 lock-step, which isn't very fast. If it is @code{some} and you use an
1009 @sc{nntp} server, gnus will pump out commands as fast as it can, and
1010 read all the replies in one swoop. This will normally result in better
1011 performance, but if the server does not support the aforementioned
1012 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1014 If you think that starting up Gnus takes too long, try all the three
1015 different values for this variable and see what works best for you.
1017 In any case, if you use @code{some} or @code{nil}, you should definitely
1018 kill all groups that you aren't interested in to speed things up.
1020 Note that this variable also affects active file retrieval from
1021 secondary select methods.
1024 @node Startup Variables
1025 @section Startup Variables
1029 @item gnus-load-hook
1030 @vindex gnus-load-hook
1031 A hook run while gnus is being loaded. Note that this hook will
1032 normally be run just once in each Emacs session, no matter how many
1033 times you start gnus.
1035 @item gnus-before-startup-hook
1036 @vindex gnus-before-startup-hook
1037 A hook run after starting up gnus successfully.
1039 @item gnus-startup-hook
1040 @vindex gnus-startup-hook
1041 A hook run as the very last thing after starting up gnus
1043 @item gnus-started-hook
1044 @vindex gnus-started-hook
1045 A hook that is run as the very last thing after starting up gnus
1048 @item gnus-setup-news-hook
1049 @vindex gnus-setup-news-hook
1050 A hook that is run after reading the @file{.newsrc} file(s), but before
1051 generating the group buffer.
1053 @item gnus-check-bogus-newsgroups
1054 @vindex gnus-check-bogus-newsgroups
1055 If non-@code{nil}, gnus will check for and delete all bogus groups at
1056 startup. A @dfn{bogus group} is a group that you have in your
1057 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1058 bogus groups can take quite a while, so to save time and resources it's
1059 best to leave this option off, and do the checking for bogus groups once
1060 in a while from the group buffer instead (@pxref{Group Maintenance}).
1062 @item gnus-inhibit-startup-message
1063 @vindex gnus-inhibit-startup-message
1064 If non-@code{nil}, the startup message won't be displayed. That way,
1065 your boss might not notice as easily that you are reading news instead
1066 of doing your job. Note that this variable is used before
1067 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1069 @item gnus-no-groups-message
1070 @vindex gnus-no-groups-message
1071 Message displayed by gnus when no groups are available.
1073 @item gnus-play-startup-jingle
1074 @vindex gnus-play-startup-jingle
1075 If non-@code{nil}, play the gnus jingle at startup.
1077 @item gnus-startup-jingle
1078 @vindex gnus-startup-jingle
1079 Jingle to be played if the above variable is non-@code{nil}. The
1080 default is @samp{Tuxedomoon.Jingle4.au}.
1085 @node The Group Buffer
1086 @chapter The Group Buffer
1087 @cindex group buffer
1089 The @dfn{group buffer} lists all (or parts) of the available groups. It
1090 is the first buffer shown when gnus starts, and will never be killed as
1091 long as gnus is active.
1095 \gnusfigure{The Group Buffer}{320}{
1096 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1097 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1098 \put(120,38){\vector(1,2){10}}
1099 \put(40,60){\makebox(0,0)[r]{Mode line}}
1100 \put(40,58){\vector(1,0){30}}
1101 \put(200,28){\makebox(0,0)[t]{Native select method}}
1102 \put(200,26){\vector(-1,2){15}}
1108 * Group Buffer Format:: Information listed and how you can change it.
1109 * Group Maneuvering:: Commands for moving in the group buffer.
1110 * Selecting a Group:: Actually reading news.
1111 * Group Data:: Changing the info for a group.
1112 * Subscription Commands:: Unsubscribing, killing, subscribing.
1113 * Group Levels:: Levels? What are those, then?
1114 * Group Score:: A mechanism for finding out what groups you like.
1115 * Marking Groups:: You can mark groups for later processing.
1116 * Foreign Groups:: Creating and editing groups.
1117 * Group Parameters:: Each group may have different parameters set.
1118 * Listing Groups:: Gnus can list various subsets of the groups.
1119 * Sorting Groups:: Re-arrange the group order.
1120 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1121 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1122 * Exiting Gnus:: Stop reading news and get some work done.
1123 * Group Topics:: A folding group mode divided into topics.
1124 * Misc Group Stuff:: Other stuff that you can to do.
1128 @node Group Buffer Format
1129 @section Group Buffer Format
1132 * Group Line Specification:: Deciding how the group buffer is to look.
1133 * Group Modeline Specification:: The group buffer modeline.
1134 * Group Highlighting:: Having nice colors in the group buffer.
1138 @node Group Line Specification
1139 @subsection Group Line Specification
1140 @cindex group buffer format
1142 The default format of the group buffer is nice and dull, but you can
1143 make it as exciting and ugly as you feel like.
1145 Here's a couple of example group lines:
1148 25: news.announce.newusers
1149 * 0: alt.fan.andrea-dworkin
1154 You can see that there are 25 unread articles in
1155 @samp{news.announce.newusers}. There are no unread articles, but some
1156 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1157 asterisk at the beginning of the line?).
1159 @vindex gnus-group-line-format
1160 You can change that format to whatever you want by fiddling with the
1161 @code{gnus-group-line-format} variable. This variable works along the
1162 lines of a @code{format} specification, which is pretty much the same as
1163 a @code{printf} specifications, for those of you who use (feh!) C.
1164 @xref{Formatting Variables}.
1166 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1168 There should always be a colon on the line; the cursor always moves to
1169 the colon after performing an operation. Nothing else is required---not
1170 even the group name. All displayed text is just window dressing, and is
1171 never examined by gnus. Gnus stores all real information it needs using
1174 (Note that if you make a really strange, wonderful, spreadsheet-like
1175 layout, everybody will believe you are hard at work with the accounting
1176 instead of wasting time reading news.)
1178 Here's a list of all available format characters:
1183 An asterisk if the group only has marked articles.
1186 Whether the group is subscribed.
1189 Level of subscribedness.
1192 Number of unread articles.
1195 Number of dormant articles.
1198 Number of ticked articles.
1201 Number of read articles.
1204 Estimated total number of articles. (This is really @var{max-number}
1205 minus @var{min-number} plus 1.)
1208 Number of unread, unticked, non-dormant articles.
1211 Number of ticked and dormant articles.
1220 Newsgroup description.
1223 @samp{m} if moderated.
1226 @samp{(m)} if moderated.
1235 A string that looks like @samp{<%s:%n>} if a foreign select method is
1239 Indentation based on the level of the topic (@pxref{Group Topics}).
1242 @vindex gnus-group-uncollapsed-levels
1243 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1244 variable says how many levels to leave at the end of the group name.
1245 The default is 1---this will mean that group names like
1246 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1249 @vindex gnus-new-mail-mark
1251 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1255 A string that says when you last read the group (@pxref{Group
1259 User defined specifier. The next character in the format string should
1260 be a letter. Gnus will call the function
1261 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1262 following @samp{%u}. The function will be passed a single dummy
1263 parameter as argument. The function should return a string, which will
1264 be inserted into the buffer just like information from any other
1269 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1270 if no info is available---for instance, if it is a non-activated foreign
1271 group, or a bogus native group.
1274 @node Group Modeline Specification
1275 @subsection Group Modeline Specification
1276 @cindex group modeline
1278 @vindex gnus-group-mode-line-format
1279 The mode line can be changed by setting
1280 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1281 doesn't understand that many format specifiers:
1285 The native news server.
1287 The native select method.
1291 @node Group Highlighting
1292 @subsection Group Highlighting
1293 @cindex highlighting
1294 @cindex group highlighting
1296 @vindex gnus-group-highlight
1297 Highlighting in the group buffer is controlled by the
1298 @code{gnus-group-highlight} variable. This is an alist with elements
1299 that look like @var{(form . face)}. If @var{form} evaluates to
1300 something non-@code{nil}, the @var{face} will be used on the line.
1302 Here's an example value for this variable that might look nice if the
1306 (face-spec-set 'my-group-face-1
1307 '((t (:foreground "Red" :bold t))))
1308 (face-spec-set 'my-group-face-2
1309 '((t (:foreground "SeaGreen" :bold t))))
1310 (face-spec-set 'my-group-face-3
1311 '((t (:foreground "SpringGreen" :bold t))))
1312 (face-spec-set 'my-group-face-4
1313 '((t (:foreground "SteelBlue" :bold t))))
1314 (face-spec-set 'my-group-face-5
1315 '((t (:foreground "SkyBlue" :bold t))))
1317 (setq gnus-group-highlight
1318 '(((> unread 200) . my-group-face-1)
1319 ((and (< level 3) (zerop unread)) . my-group-face-2)
1320 ((< level 3) . my-group-face-3)
1321 ((zerop unread) . my-group-face-4)
1322 (t . my-group-face-5)))
1325 Also @pxref{Faces and Fonts}.
1327 Variables that are dynamically bound when the forms are evaluated
1334 The number of unread articles in the group.
1338 Whether the group is a mail group.
1340 The level of the group.
1342 The score of the group.
1344 The number of ticked articles in the group.
1346 The total number of articles in the group. Or rather, MAX-NUMBER minus
1347 MIN-NUMBER plus one.
1349 When using the topic minor mode, this variable is bound to the current
1350 topic being inserted.
1353 When the forms are @code{eval}ed, point is at the beginning of the line
1354 of the group in question, so you can use many of the normal gnus
1355 functions for snarfing info on the group.
1357 @vindex gnus-group-update-hook
1358 @findex gnus-group-highlight-line
1359 @code{gnus-group-update-hook} is called when a group line is changed.
1360 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1361 calls @code{gnus-group-highlight-line} by default.
1364 @node Group Maneuvering
1365 @section Group Maneuvering
1366 @cindex group movement
1368 All movement commands understand the numeric prefix and will behave as
1369 expected, hopefully.
1375 @findex gnus-group-next-unread-group
1376 Go to the next group that has unread articles
1377 (@code{gnus-group-next-unread-group}).
1383 @findex gnus-group-prev-unread-group
1384 Go to the previous group that has unread articles
1385 (@code{gnus-group-prev-unread-group}).
1389 @findex gnus-group-next-group
1390 Go to the next group (@code{gnus-group-next-group}).
1394 @findex gnus-group-prev-group
1395 Go to the previous group (@code{gnus-group-prev-group}).
1399 @findex gnus-group-next-unread-group-same-level
1400 Go to the next unread group on the same (or lower) level
1401 (@code{gnus-group-next-unread-group-same-level}).
1405 @findex gnus-group-prev-unread-group-same-level
1406 Go to the previous unread group on the same (or lower) level
1407 (@code{gnus-group-prev-unread-group-same-level}).
1410 Three commands for jumping to groups:
1416 @findex gnus-group-jump-to-group
1417 Jump to a group (and make it visible if it isn't already)
1418 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
1423 @findex gnus-group-best-unread-group
1424 Jump to the unread group with the lowest level
1425 (@code{gnus-group-best-unread-group}).
1429 @findex gnus-group-first-unread-group
1430 Jump to the first group with unread articles
1431 (@code{gnus-group-first-unread-group}).
1434 @vindex gnus-group-goto-unread
1435 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1436 commands will move to the next group, not the next unread group. Even
1437 the commands that say they move to the next unread group. The default
1441 @node Selecting a Group
1442 @section Selecting a Group
1443 @cindex group selection
1448 @kindex SPACE (Group)
1449 @findex gnus-group-read-group
1450 Select the current group, switch to the summary buffer and display the
1451 first unread article (@code{gnus-group-read-group}). If there are no
1452 unread articles in the group, or if you give a non-numerical prefix to
1453 this command, gnus will offer to fetch all the old articles in this
1454 group from the server. If you give a numerical prefix @var{N}, @var{N}
1455 determines the number of articles gnus will fetch. If @var{N} is
1456 positive, gnus fetches the @var{N} newest articles, if @var{N} is
1457 negative, gnus fetches the @var{abs(N)} oldest articles.
1461 @findex gnus-group-select-group
1462 Select the current group and switch to the summary buffer
1463 (@code{gnus-group-select-group}). Takes the same arguments as
1464 @code{gnus-group-read-group}---the only difference is that this command
1465 does not display the first unread article automatically upon group
1469 @kindex M-RET (Group)
1470 @findex gnus-group-quick-select-group
1471 This does the same as the command above, but tries to do it with the
1472 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
1473 scoring/killing will be performed, there will be no highlights and no
1474 expunging. This might be useful if you're in a real hurry and have to
1475 enter some humongous group. If you give a 0 prefix to this command
1476 (i.e., @kbd{0 M-RET}), gnus won't even generate the summary buffer,
1477 which is useful if you want to toggle threading before generating the
1478 summary buffer (@pxref{Summary Generation Commands}).
1481 @kindex M-SPACE (Group)
1482 @findex gnus-group-visible-select-group
1483 This is yet one more command that does the same as the @kbd{RET}
1484 command, but this one does it without expunging and hiding dormants
1485 (@code{gnus-group-visible-select-group}).
1488 @kindex M-C-RET (Group)
1489 @findex gnus-group-select-group-ephemerally
1490 Finally, this command selects the current group ephemerally without
1491 doing any processing of its contents
1492 (@code{gnus-group-select-group-ephemerally}). Even threading has been
1493 turned off. Everything you do in the group after selecting it in this
1494 manner will have no permanent effects.
1498 @vindex gnus-large-newsgroup
1499 The @code{gnus-large-newsgroup} variable says what gnus should consider
1500 to be a big group. This is 200 by default. If the group has more
1501 (unread and/or ticked) articles than this, gnus will query the user
1502 before entering the group. The user can then specify how many articles
1503 should be fetched from the server. If the user specifies a negative
1504 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
1505 is positive, the @code{n} articles that have arrived most recently will
1508 @vindex gnus-select-group-hook
1509 @vindex gnus-auto-select-first
1510 @code{gnus-auto-select-first} control whether any articles are selected
1511 automatically when entering a group with the @kbd{SPACE} command.
1516 Don't select any articles when entering the group. Just display the
1517 full summary buffer.
1520 Select the first unread article when entering the group.
1523 Select the highest scored article in the group when entering the
1528 This variable can also be a function. In that case, that function will
1529 be called to place point on a subject line, and/or select some article.
1530 Useful functions include:
1533 @item gnus-summary-first-unread-subject
1534 Place point on the subject line of the first unread article, but
1535 don't select the article.
1537 @item gnus-summary-first-unread-article
1538 Select the first unread article.
1540 @item gnus-summary-best-unread-article
1541 Select the highest-scored unread article.
1545 If you want to prevent automatic selection in some group (say, in a
1546 binary group with Huge articles) you can set this variable to @code{nil}
1547 in @code{gnus-select-group-hook}, which is called when a group is
1551 @node Subscription Commands
1552 @section Subscription Commands
1553 @cindex subscription
1561 @findex gnus-group-unsubscribe-current-group
1562 @c @icon{gnus-group-unsubscribe}
1563 Toggle subscription to the current group
1564 (@code{gnus-group-unsubscribe-current-group}).
1570 @findex gnus-group-unsubscribe-group
1571 Prompt for a group to subscribe, and then subscribe it. If it was
1572 subscribed already, unsubscribe it instead
1573 (@code{gnus-group-unsubscribe-group}).
1579 @findex gnus-group-kill-group
1580 @c @icon{gnus-group-kill-group}
1581 Kill the current group (@code{gnus-group-kill-group}).
1587 @findex gnus-group-yank-group
1588 Yank the last killed group (@code{gnus-group-yank-group}).
1591 @kindex C-x C-t (Group)
1592 @findex gnus-group-transpose-groups
1593 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
1594 really a subscription command, but you can use it instead of a
1595 kill-and-yank sequence sometimes.
1601 @findex gnus-group-kill-region
1602 Kill all groups in the region (@code{gnus-group-kill-region}).
1606 @findex gnus-group-kill-all-zombies
1607 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1610 @kindex S C-k (Group)
1611 @findex gnus-group-kill-level
1612 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1613 These groups can't be yanked back after killing, so this command should
1614 be used with some caution. The only time where this command comes in
1615 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1616 groups that you want to get rid off. @kbd{S C-k} on level 7 will
1617 kill off all unsubscribed groups that do not have message numbers in the
1618 @file{.newsrc} file.
1622 Also @pxref{Group Levels}.
1632 @findex gnus-group-catchup-current
1633 @vindex gnus-group-catchup-group-hook
1634 @c @icon{gnus-group-catchup-current}
1635 Mark all unticked articles in this group as read
1636 (@code{gnus-group-catchup-current}).
1637 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1642 @findex gnus-group-catchup-current-all
1643 Mark all articles in this group, even the ticked ones, as read
1644 (@code{gnus-group-catchup-current-all}).
1648 @findex gnus-group-clear-data
1649 Clear the data from the current group---nix out marks and the list of
1650 read articles (@code{gnus-group-clear-data}).
1652 @item M-x gnus-group-clear-data-on-native-groups
1653 @kindex M-x gnus-group-clear-data-on-native-groups
1654 @findex gnus-group-clear-data-on-native-groups
1655 If you have switched from one @sc{nntp} server to another, all your marks
1656 and read ranges have become worthless. You can use this command to
1657 clear out all data that you have on your native groups. Use with
1664 @section Group Levels
1668 All groups have a level of @dfn{subscribedness}. For instance, if a
1669 group is on level 2, it is more subscribed than a group on level 5. You
1670 can ask gnus to just list groups on a given level or lower
1671 (@pxref{Listing Groups}), or to just check for new articles in groups on
1672 a given level or lower (@pxref{Scanning New Messages}).
1674 Remember: The higher the level of the group, the less important it is.
1680 @findex gnus-group-set-current-level
1681 Set the level of the current group. If a numeric prefix is given, the
1682 next @var{n} groups will have their levels set. The user will be
1683 prompted for a level.
1686 @vindex gnus-level-killed
1687 @vindex gnus-level-zombie
1688 @vindex gnus-level-unsubscribed
1689 @vindex gnus-level-subscribed
1690 Gnus considers groups from levels 1 to
1691 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1692 @code{gnus-level-subscribed} (exclusive) and
1693 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1694 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1695 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1696 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
1697 same, but zombie and killed groups have no information on what articles
1698 you have read, etc, stored. This distinction between dead and living
1699 groups isn't done because it is nice or clever, it is done purely for
1700 reasons of efficiency.
1702 It is recommended that you keep all your mail groups (if any) on quite
1703 low levels (e.g. 1 or 2).
1705 If you want to play with the level variables, you should show some care.
1706 Set them once, and don't touch them ever again. Better yet, don't touch
1707 them at all unless you know exactly what you're doing.
1709 @vindex gnus-level-default-unsubscribed
1710 @vindex gnus-level-default-subscribed
1711 Two closely related variables are @code{gnus-level-default-subscribed}
1712 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1713 which are the levels that new groups will be put on if they are
1714 (un)subscribed. These two variables should, of course, be inside the
1715 relevant valid ranges.
1717 @vindex gnus-keep-same-level
1718 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1719 will only move to groups of the same level (or lower). In
1720 particular, going from the last article in one group to the next group
1721 will go to the next group of the same level (or lower). This might be
1722 handy if you want to read the most important groups before you read the
1725 @vindex gnus-group-default-list-level
1726 All groups with a level less than or equal to
1727 @code{gnus-group-default-list-level} will be listed in the group buffer
1730 @vindex gnus-group-list-inactive-groups
1731 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1732 groups will be listed along with the unread groups. This variable is
1733 @code{t} by default. If it is @code{nil}, inactive groups won't be
1736 @vindex gnus-group-use-permanent-levels
1737 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1738 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1739 use this level as the ``work'' level.
1741 @vindex gnus-activate-level
1742 Gnus will normally just activate (i. e., query the server about) groups
1743 on level @code{gnus-activate-level} or less. If you don't want to
1744 activate unsubscribed groups, for instance, you might set this variable
1745 to 5. The default is 6.
1749 @section Group Score
1754 You would normally keep important groups on high levels, but that scheme
1755 is somewhat restrictive. Don't you wish you could have Gnus sort the
1756 group buffer according to how often you read groups, perhaps? Within
1759 This is what @dfn{group score} is for. You can have Gnus assign a score
1760 to each group through the mechanism described below. You can then sort
1761 the group buffer based on this score. Alternatively, you can sort on
1762 score and then level. (Taken together, the level and the score is
1763 called the @dfn{rank} of the group. A group that is on level 4 and has
1764 a score of 1 has a higher rank than a group on level 5 that has a score
1765 of 300. (The level is the most significant part and the score is the
1766 least significant part.))
1768 @findex gnus-summary-bubble-group
1769 If you want groups you read often to get higher scores than groups you
1770 read seldom you can add the @code{gnus-summary-bubble-group} function to
1771 the @code{gnus-summary-exit-hook} hook. This will result (after
1772 sorting) in a bubbling sort of action. If you want to see that in
1773 action after each summary exit, you can add
1774 @code{gnus-group-sort-groups-by-rank} or
1775 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1776 slow things down somewhat.
1779 @node Marking Groups
1780 @section Marking Groups
1781 @cindex marking groups
1783 If you want to perform some command on several groups, and they appear
1784 subsequently in the group buffer, you would normally just give a
1785 numerical prefix to the command. Most group commands will then do your
1786 bidding on those groups.
1788 However, if the groups are not in sequential order, you can still
1789 perform a command on several groups. You simply mark the groups first
1790 with the process mark and then execute the command.
1798 @findex gnus-group-mark-group
1799 Set the mark on the current group (@code{gnus-group-mark-group}).
1805 @findex gnus-group-unmark-group
1806 Remove the mark from the current group
1807 (@code{gnus-group-unmark-group}).
1811 @findex gnus-group-unmark-all-groups
1812 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1816 @findex gnus-group-mark-region
1817 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1821 @findex gnus-group-mark-buffer
1822 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1826 @findex gnus-group-mark-regexp
1827 Mark all groups that match some regular expression
1828 (@code{gnus-group-mark-regexp}).
1831 Also @pxref{Process/Prefix}.
1833 @findex gnus-group-universal-argument
1834 If you want to execute some command on all groups that have been marked
1835 with the process mark, you can use the @kbd{M-&}
1836 (@code{gnus-group-universal-argument}) command. It will prompt you for
1837 the command to be executed.
1840 @node Foreign Groups
1841 @section Foreign Groups
1842 @cindex foreign groups
1844 Below are some group mode commands for making and editing general foreign
1845 groups, as well as commands to ease the creation of a few
1846 special-purpose groups. All these commands insert the newly created
1847 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1854 @findex gnus-group-make-group
1855 @cindex making groups
1856 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
1857 for a name, a method and possibly an @dfn{address}. For an easier way
1858 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1862 @findex gnus-group-rename-group
1863 @cindex renaming groups
1864 Rename the current group to something else
1865 (@code{gnus-group-rename-group}). This is valid only on some
1866 groups---mail groups mostly. This command might very well be quite slow
1872 @findex gnus-group-customize
1873 Customize the group parameters (@code{gnus-group-customize}).
1877 @findex gnus-group-edit-group-method
1878 @cindex renaming groups
1879 Enter a buffer where you can edit the select method of the current
1880 group (@code{gnus-group-edit-group-method}).
1884 @findex gnus-group-edit-group-parameters
1885 Enter a buffer where you can edit the group parameters
1886 (@code{gnus-group-edit-group-parameters}).
1890 @findex gnus-group-edit-group
1891 Enter a buffer where you can edit the group info
1892 (@code{gnus-group-edit-group}).
1896 @findex gnus-group-make-directory-group
1898 Make a directory group (@pxref{Directory Groups}). You will be prompted
1899 for a directory name (@code{gnus-group-make-directory-group}).
1904 @findex gnus-group-make-help-group
1905 Make the gnus help group (@code{gnus-group-make-help-group}).
1909 @cindex (ding) archive
1910 @cindex archive group
1911 @findex gnus-group-make-archive-group
1912 @vindex gnus-group-archive-directory
1913 @vindex gnus-group-recent-archive-directory
1914 Make a gnus archive group (@code{gnus-group-make-archive-group}). By
1915 default a group pointing to the most recent articles will be created
1916 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1917 group will be created from @code{gnus-group-archive-directory}.
1921 @findex gnus-group-make-kiboze-group
1923 Make a kiboze group. You will be prompted for a name, for a regexp to
1924 match groups to be ``included'' in the kiboze group, and a series of
1925 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1926 @xref{Kibozed Groups}.
1930 @findex gnus-group-enter-directory
1932 Read an arbitrary directory as if it were a newsgroup with the
1933 @code{nneething} backend (@code{gnus-group-enter-directory}).
1934 @xref{Anything Groups}.
1938 @findex gnus-group-make-doc-group
1939 @cindex ClariNet Briefs
1941 Make a group based on some file or other
1942 (@code{gnus-group-make-doc-group}). If you give a prefix to this
1943 command, you will be prompted for a file name and a file type.
1944 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1945 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1946 @code{rfc934}, @code{rfc822-forward}, @code{nsmail} and @code{forward}.
1947 If you run this command without a prefix, Gnus will guess at the file
1948 type. @xref{Document Groups}.
1952 @vindex gnus-useful-groups
1953 @findex gnus-group-make-useful-group
1954 Create one of the groups mentioned in @code{gnus-useful-groups}
1955 (@code{gnus-group-make-useful-group}).
1959 @findex gnus-group-make-web-group
1964 Make an ephemeral group based on a web search
1965 (@code{gnus-group-make-web-group}). If you give a prefix to this
1966 command, make a solid group instead. You will be prompted for the
1967 search engine type and the search string. Valid search engine types
1968 include @code{dejanews}, @code{altavista} and @code{reference}.
1969 @xref{Web Searches}.
1971 If you use the @code{dejanews} search engine, you can limit the search
1972 to a particular group by using a match string like
1973 @samp{~g alt.sysadmin.recovery shaving}.
1976 @kindex G DEL (Group)
1977 @findex gnus-group-delete-group
1978 This function will delete the current group
1979 (@code{gnus-group-delete-group}). If given a prefix, this function will
1980 actually delete all the articles in the group, and forcibly remove the
1981 group itself from the face of the Earth. Use a prefix only if you are
1982 absolutely sure of what you are doing. This command can't be used on
1983 read-only groups (like @code{nntp} group), though.
1987 @findex gnus-group-make-empty-virtual
1988 Make a new, fresh, empty @code{nnvirtual} group
1989 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
1993 @findex gnus-group-add-to-virtual
1994 Add the current group to an @code{nnvirtual} group
1995 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
1998 @xref{Select Methods}, for more information on the various select
2001 @vindex gnus-activate-foreign-newsgroups
2002 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2003 gnus will check all foreign groups with this level or lower at startup.
2004 This might take quite a while, especially if you subscribe to lots of
2005 groups from different @sc{nntp} servers. Also @pxref{Group Levels};
2006 @code{gnus-activate-level} also affects activation of foreign
2010 @node Group Parameters
2011 @section Group Parameters
2012 @cindex group parameters
2014 The group parameters store information local to a particular group.
2015 Here's an example group parameter list:
2018 ((to-address . "ding@@gnus.org")
2022 We see that each element consists of a "dotted pair"---the thing before
2023 the dot is the key, while the thing after the dot is the value. All the
2024 parameters have this form @emph{except} local variable specs, which are
2025 not dotted pairs, but proper lists.
2027 The following group parameters can be used:
2032 Address used by when doing followups and new posts.
2035 (to-address . "some@@where.com")
2038 This is primarily useful in mail groups that represent closed mailing
2039 lists---mailing lists where it's expected that everybody that writes to
2040 the mailing list is subscribed to it. Since using this parameter
2041 ensures that the mail only goes to the mailing list itself, it means
2042 that members won't receive two copies of your followups.
2044 Using @code{to-address} will actually work whether the group is foreign
2045 or not. Let's say there's a group on the server that is called
2046 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2047 the articles from a mail-to-news gateway. Posting directly to this
2048 group is therefore impossible---you have to send mail to the mailing
2049 list address instead.
2053 Address used when doing a @kbd{a} in that group.
2056 (to-list . "some@@where.com")
2059 It is totally ignored
2060 when doing a followup---except that if it is present in a news group,
2061 you'll get mail group semantics when doing @kbd{f}.
2063 If you do an @kbd{a} command in a mail group and you have neither a
2064 @code{to-list} group parameter nor a @code{to-address} group parameter,
2065 then a @code{to-list} group parameter will be added automatically upon
2066 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2067 @vindex gnus-add-to-list
2069 If you do an @kbd{a} command in a mail group and you don't have a
2070 @code{to-list} group parameter, one will be added automatically upon
2071 sending the message.
2075 If the group parameter list has the element @code{(visible . t)},
2076 that group will always be visible in the Group buffer, regardless
2077 of whether it has any unread articles.
2079 @item broken-reply-to
2080 @cindex broken-reply-to
2081 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2082 headers in this group are to be ignored. This can be useful if you're
2083 reading a mailing list group where the listserv has inserted
2084 @code{Reply-To} headers that point back to the listserv itself. This is
2085 broken behavior. So there!
2089 Elements like @code{(to-group . "some.group.name")} means that all
2090 posts in that group will be sent to @code{some.group.name}.
2094 If you have @code{(newsgroup . t)} in the group parameter list, gnus
2095 will treat all responses as if they were responses to news articles.
2096 This can be useful if you have a mail group that's really a mirror of a
2101 If @code{(gcc-self . t)} is present in the group parameter list, newly
2102 composed messages will be @code{Gcc}'d to the current group. If
2103 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2104 generated, if @code{(gcc-self . "string")} is present, this string will
2105 be inserted literally as a @code{gcc} header. This parameter takes
2106 precedence over any default @code{Gcc} rules as described later
2107 (@pxref{Archived Messages}).
2111 If the group parameter has an element that looks like @code{(auto-expire
2112 . t)}, all articles read will be marked as expirable. For an
2113 alternative approach, @pxref{Expiring Mail}.
2116 @cindex total-expire
2117 If the group parameter has an element that looks like
2118 @code{(total-expire . t)}, all read articles will be put through the
2119 expiry process, even if they are not marked as expirable. Use with
2120 caution. Unread, ticked and dormant articles are not eligible for
2125 @vindex nnmail-expiry-wait-function
2126 If the group parameter has an element that looks like @code{(expiry-wait
2127 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2128 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2129 The value can either be a number of days (not necessarily an integer) or
2130 the symbols @code{never} or @code{immediate}.
2133 @cindex score file group parameter
2134 Elements that look like @code{(score-file . "file")} will make
2135 @file{file} into the current score file for the group in question. All
2136 interactive score entries will be put into this file.
2139 @cindex adapt file group parameter
2140 Elements that look like @code{(adapt-file . "file")} will make
2141 @file{file} into the current adaptive file for the group in question.
2142 All adaptive score entries will be put into this file.
2145 When unsubscribing from a mailing list you should never send the
2146 unsubscription notice to the mailing list itself. Instead, you'd send
2147 messages to the administrative address. This parameter allows you to
2148 put the admin address somewhere convenient.
2151 Elements that look like @code{(display . MODE)} say which articles to
2152 display on entering the group. Valid values are:
2156 Display all articles, both read and unread.
2159 Display the default visible articles, which normally includes unread and
2164 Elements that look like @code{(comment . "This is a comment")}
2165 are arbitrary comments on the group. They are currently ignored by
2166 gnus, but provide a place for you to store information on particular
2170 Elements that look like @code{(charset . iso-8859-1)} will make
2171 @code{iso-8859-1} the default charset; that is, the charset that will be
2172 used for all articles that do not specify a charset.
2174 @item @var{(variable form)}
2175 You can use the group parameters to set variables local to the group you
2176 are entering. If you want to turn threading off in @samp{news.answers},
2177 you could put @code{(gnus-show-threads nil)} in the group parameters of
2178 that group. @code{gnus-show-threads} will be made into a local variable
2179 in the summary buffer you enter, and the form @code{nil} will be
2180 @code{eval}ed there.
2182 This can also be used as a group-specific hook function, if you'd like.
2183 If you want to hear a beep when you enter a group, you could put
2184 something like @code{(dummy-variable (ding))} in the parameters of that
2185 group. @code{dummy-variable} will be set to the result of the
2186 @code{(ding)} form, but who cares?
2189 You can store additional posting style information for this group only
2190 here (@pxref{Posting Styles}). The format is that of an entry in the
2191 @code{gnus-posting-styles} alist, except that there's no regexp matching
2192 the group name (of course). Style elements in this group parameter will
2193 take precedence over the ones found in @code{gnus-posting-styles}.
2195 For instance, if you want a funky name and signature in this group only,
2196 instead of hacking @code{gnus-posting-styles}, you could put something
2197 like this in the group parameters:
2202 (signature "Funky Signature"))
2207 Use the @kbd{G p} command to edit group parameters of a group. You
2208 might also be interested in reading about topic parameters (@pxref{Topic
2212 @node Listing Groups
2213 @section Listing Groups
2214 @cindex group listing
2216 These commands all list various slices of the groups available.
2224 @findex gnus-group-list-groups
2225 List all groups that have unread articles
2226 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
2227 command will list only groups of level ARG and lower. By default, it
2228 only lists groups of level five (i. e.,
2229 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2236 @findex gnus-group-list-all-groups
2237 List all groups, whether they have unread articles or not
2238 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
2239 this command will list only groups of level ARG and lower. By default,
2240 it lists groups of level seven or lower (i.e., just subscribed and
2241 unsubscribed groups).
2245 @findex gnus-group-list-level
2246 List all unread groups on a specific level
2247 (@code{gnus-group-list-level}). If given a prefix, also list the groups
2248 with no unread articles.
2252 @findex gnus-group-list-killed
2253 List all killed groups (@code{gnus-group-list-killed}). If given a
2254 prefix argument, really list all groups that are available, but aren't
2255 currently (un)subscribed. This could entail reading the active file
2260 @findex gnus-group-list-zombies
2261 List all zombie groups (@code{gnus-group-list-zombies}).
2265 @findex gnus-group-list-matching
2266 List all unread, subscribed groups with names that match a regexp
2267 (@code{gnus-group-list-matching}).
2271 @findex gnus-group-list-all-matching
2272 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2276 @findex gnus-group-list-active
2277 List absolutely all groups in the active file(s) of the
2278 server(s) you are connected to (@code{gnus-group-list-active}). This
2279 might very well take quite a while. It might actually be a better idea
2280 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2281 thing to match on. Also note that this command may list groups that
2282 don't exist (yet)---these will be listed as if they were killed groups.
2283 Take the output with some grains of salt.
2287 @findex gnus-group-apropos
2288 List all groups that have names that match a regexp
2289 (@code{gnus-group-apropos}).
2293 @findex gnus-group-description-apropos
2294 List all groups that have names or descriptions that match a regexp
2295 (@code{gnus-group-description-apropos}).
2299 @vindex gnus-permanently-visible-groups
2300 @cindex visible group parameter
2301 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2302 always be shown, whether they have unread articles or not. You can also
2303 add the @code{visible} element to the group parameters in question to
2304 get the same effect.
2306 @vindex gnus-list-groups-with-ticked-articles
2307 Groups that have just ticked articles in it are normally listed in the
2308 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
2309 @code{nil}, these groups will be treated just like totally empty
2310 groups. It is @code{t} by default.
2313 @node Sorting Groups
2314 @section Sorting Groups
2315 @cindex sorting groups
2317 @kindex C-c C-s (Group)
2318 @findex gnus-group-sort-groups
2319 @vindex gnus-group-sort-function
2320 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2321 group buffer according to the function(s) given by the
2322 @code{gnus-group-sort-function} variable. Available sorting functions
2327 @item gnus-group-sort-by-alphabet
2328 @findex gnus-group-sort-by-alphabet
2329 Sort the group names alphabetically. This is the default.
2331 @item gnus-group-sort-by-real-name
2332 @findex gnus-group-sort-by-real-name
2333 Sort the group alphabetically on the real (unprefixed) group names.
2335 @item gnus-group-sort-by-level
2336 @findex gnus-group-sort-by-level
2337 Sort by group level.
2339 @item gnus-group-sort-by-score
2340 @findex gnus-group-sort-by-score
2341 Sort by group score. @xref{Group Score}.
2343 @item gnus-group-sort-by-rank
2344 @findex gnus-group-sort-by-rank
2345 Sort by group score and then the group level. The level and the score
2346 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
2348 @item gnus-group-sort-by-unread
2349 @findex gnus-group-sort-by-unread
2350 Sort by number of unread articles.
2352 @item gnus-group-sort-by-method
2353 @findex gnus-group-sort-by-method
2354 Sort alphabetically on the select method.
2359 @code{gnus-group-sort-function} can also be a list of sorting
2360 functions. In that case, the most significant sort key function must be
2364 There are also a number of commands for sorting directly according to
2365 some sorting criteria:
2369 @kindex G S a (Group)
2370 @findex gnus-group-sort-groups-by-alphabet
2371 Sort the group buffer alphabetically by group name
2372 (@code{gnus-group-sort-groups-by-alphabet}).
2375 @kindex G S u (Group)
2376 @findex gnus-group-sort-groups-by-unread
2377 Sort the group buffer by the number of unread articles
2378 (@code{gnus-group-sort-groups-by-unread}).
2381 @kindex G S l (Group)
2382 @findex gnus-group-sort-groups-by-level
2383 Sort the group buffer by group level
2384 (@code{gnus-group-sort-groups-by-level}).
2387 @kindex G S v (Group)
2388 @findex gnus-group-sort-groups-by-score
2389 Sort the group buffer by group score
2390 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
2393 @kindex G S r (Group)
2394 @findex gnus-group-sort-groups-by-rank
2395 Sort the group buffer by group rank
2396 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
2399 @kindex G S m (Group)
2400 @findex gnus-group-sort-groups-by-method
2401 Sort the group buffer alphabetically by backend name
2402 (@code{gnus-group-sort-groups-by-method}).
2406 All the commands below obey the process/prefix convention
2407 (@pxref{Process/Prefix}).
2409 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
2410 commands will sort in reverse order.
2412 You can also sort a subset of the groups:
2416 @kindex G P a (Group)
2417 @findex gnus-group-sort-selected-groups-by-alphabet
2418 Sort the groups alphabetically by group name
2419 (@code{gnus-group-sort-selected-groups-by-alphabet}).
2422 @kindex G P u (Group)
2423 @findex gnus-group-sort-selected-groups-by-unread
2424 Sort the groups by the number of unread articles
2425 (@code{gnus-group-sort-selected-groups-by-unread}).
2428 @kindex G P l (Group)
2429 @findex gnus-group-sort-selected-groups-by-level
2430 Sort the groups by group level
2431 (@code{gnus-group-sort-selected-groups-by-level}).
2434 @kindex G P v (Group)
2435 @findex gnus-group-sort-selected-groups-by-score
2436 Sort the groups by group score
2437 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
2440 @kindex G P r (Group)
2441 @findex gnus-group-sort-selected-groups-by-rank
2442 Sort the groups by group rank
2443 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
2446 @kindex G P m (Group)
2447 @findex gnus-group-sort-selected-groups-by-method
2448 Sort the groups alphabetically by backend name
2449 (@code{gnus-group-sort-selected-groups-by-method}).
2455 @node Group Maintenance
2456 @section Group Maintenance
2457 @cindex bogus groups
2462 @findex gnus-group-check-bogus-groups
2463 Find bogus groups and delete them
2464 (@code{gnus-group-check-bogus-groups}).
2468 @findex gnus-group-find-new-groups
2469 Find new groups and process them (@code{gnus-group-find-new-groups}).
2470 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
2471 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
2472 to query the server for new groups, and subscribe the new groups as
2476 @kindex C-c C-x (Group)
2477 @findex gnus-group-expire-articles
2478 Run all expirable articles in the current group through the expiry
2479 process (if any) (@code{gnus-group-expire-articles}).
2482 @kindex C-c M-C-x (Group)
2483 @findex gnus-group-expire-all-groups
2484 Run all articles in all groups through the expiry process
2485 (@code{gnus-group-expire-all-groups}).
2490 @node Browse Foreign Server
2491 @section Browse Foreign Server
2492 @cindex foreign servers
2493 @cindex browsing servers
2498 @findex gnus-group-browse-foreign-server
2499 You will be queried for a select method and a server name. Gnus will
2500 then attempt to contact this server and let you browse the groups there
2501 (@code{gnus-group-browse-foreign-server}).
2504 @findex gnus-browse-mode
2505 A new buffer with a list of available groups will appear. This buffer
2506 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
2507 a lot) like a normal group buffer.
2509 Here's a list of keystrokes available in the browse mode:
2514 @findex gnus-group-next-group
2515 Go to the next group (@code{gnus-group-next-group}).
2519 @findex gnus-group-prev-group
2520 Go to the previous group (@code{gnus-group-prev-group}).
2523 @kindex SPACE (Browse)
2524 @findex gnus-browse-read-group
2525 Enter the current group and display the first article
2526 (@code{gnus-browse-read-group}).
2529 @kindex RET (Browse)
2530 @findex gnus-browse-select-group
2531 Enter the current group (@code{gnus-browse-select-group}).
2535 @findex gnus-browse-unsubscribe-current-group
2536 Unsubscribe to the current group, or, as will be the case here,
2537 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2543 @findex gnus-browse-exit
2544 Exit browse mode (@code{gnus-browse-exit}).
2548 @findex gnus-browse-describe-briefly
2549 Describe browse mode briefly (well, there's not much to describe, is
2550 there) (@code{gnus-browse-describe-briefly}).
2555 @section Exiting gnus
2556 @cindex exiting gnus
2558 Yes, gnus is ex(c)iting.
2563 @findex gnus-group-suspend
2564 Suspend gnus (@code{gnus-group-suspend}). This doesn't really exit gnus,
2565 but it kills all buffers except the Group buffer. I'm not sure why this
2566 is a gain, but then who am I to judge?
2570 @findex gnus-group-exit
2571 @c @icon{gnus-group-exit}
2572 Quit gnus (@code{gnus-group-exit}).
2576 @findex gnus-group-quit
2577 Quit gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2578 The dribble file will be saved, though (@pxref{Auto Save}).
2581 @vindex gnus-exit-gnus-hook
2582 @vindex gnus-suspend-gnus-hook
2583 @code{gnus-suspend-gnus-hook} is called when you suspend gnus and
2584 @code{gnus-exit-gnus-hook} is called when you quit gnus, while
2585 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2590 If you wish to completely unload gnus and all its adherents, you can use
2591 the @code{gnus-unload} command. This command is also very handy when
2592 trying to customize meta-variables.
2597 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2598 numbly heavy and herself fall into a hazy trance as the boy sitting
2599 behind her drew repeated lines with his pencil across the back of her
2605 @section Group Topics
2608 If you read lots and lots of groups, it might be convenient to group
2609 them hierarchically according to topics. You put your Emacs groups over
2610 here, your sex groups over there, and the rest (what, two groups or so?)
2611 you put in some misc section that you never bother with anyway. You can
2612 even group the Emacs sex groups as a sub-topic to either the Emacs
2613 groups or the sex groups---or both! Go wild!
2617 \gnusfigure{Group Topics}{400}{
2618 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2629 2: alt.religion.emacs
2632 0: comp.talk.emacs.recovery
2634 8: comp.binaries.fractals
2635 13: comp.sources.unix
2638 @findex gnus-topic-mode
2640 To get this @emph{fab} functionality you simply turn on (ooh!) the
2641 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
2642 is a toggling command.)
2644 Go ahead, just try it. I'll still be here when you get back. La de
2645 dum... Nice tune, that... la la la... What, you're back? Yes, and now
2646 press @kbd{l}. There. All your groups are now listed under
2647 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
2650 If you want this permanently enabled, you should add that minor mode to
2651 the hook for the group mode:
2654 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2658 * Topic Variables:: How to customize the topics the Lisp Way.
2659 * Topic Commands:: Interactive E-Z commands.
2660 * Topic Sorting:: Sorting each topic individually.
2661 * Topic Topology:: A map of the world.
2662 * Topic Parameters:: Parameters that apply to all groups in a topic.
2666 @node Topic Variables
2667 @subsection Topic Variables
2668 @cindex topic variables
2670 Now, if you select a topic, it will fold/unfold that topic, which is
2671 really neat, I think.
2673 @vindex gnus-topic-line-format
2674 The topic lines themselves are created according to the
2675 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2688 Number of groups in the topic.
2690 Number of unread articles in the topic.
2692 Number of unread articles in the topic and all its subtopics.
2695 @vindex gnus-topic-indent-level
2696 Each sub-topic (and the groups in the sub-topics) will be indented with
2697 @code{gnus-topic-indent-level} times the topic level number of spaces.
2700 @vindex gnus-topic-mode-hook
2701 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2703 @vindex gnus-topic-display-empty-topics
2704 The @code{gnus-topic-display-empty-topics} says whether to display even
2705 topics that have no unread articles in them. The default is @code{t}.
2708 @node Topic Commands
2709 @subsection Topic Commands
2710 @cindex topic commands
2712 When the topic minor mode is turned on, a new @kbd{T} submap will be
2713 available. In addition, a few of the standard keys change their
2714 definitions slightly.
2720 @findex gnus-topic-create-topic
2721 Prompt for a new topic name and create it
2722 (@code{gnus-topic-create-topic}).
2726 @findex gnus-topic-move-group
2727 Move the current group to some other topic
2728 (@code{gnus-topic-move-group}). This command uses the process/prefix
2729 convention (@pxref{Process/Prefix}).
2733 @findex gnus-topic-jump-to-topic
2734 Go to a topic (@code{gnus-topic-jump-to-topic}).
2738 @findex gnus-topic-copy-group
2739 Copy the current group to some other topic
2740 (@code{gnus-topic-copy-group}). This command uses the process/prefix
2741 convention (@pxref{Process/Prefix}).
2745 @findex gnus-topic-remove-group
2746 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2747 This command is mainly useful if you have the same group in several
2748 topics and wish to remove it from one of the topics. You may also
2749 remove a group from all topics, but in that case, Gnus will add it to
2750 the root topic the next time you start Gnus. In fact, all new groups
2751 (which, naturally, don't belong to any topic) will show up in the root
2754 This command uses the process/prefix convention
2755 (@pxref{Process/Prefix}).
2759 @findex gnus-topic-move-matching
2760 Move all groups that match some regular expression to a topic
2761 (@code{gnus-topic-move-matching}).
2765 @findex gnus-topic-copy-matching
2766 Copy all groups that match some regular expression to a topic
2767 (@code{gnus-topic-copy-matching}).
2771 @findex gnus-topic-toggle-display-empty-topics
2772 Toggle hiding empty topics
2773 (@code{gnus-topic-toggle-display-empty-topics}).
2777 @findex gnus-topic-mark-topic
2778 Mark all groups in the current topic with the process mark
2779 (@code{gnus-topic-mark-topic}).
2782 @kindex T M-# (Topic)
2783 @findex gnus-topic-unmark-topic
2784 Remove the process mark from all groups in the current topic
2785 (@code{gnus-topic-unmark-topic}).
2789 @kindex T TAB (Topic)
2791 @findex gnus-topic-indent
2792 ``Indent'' the current topic so that it becomes a sub-topic of the
2793 previous topic (@code{gnus-topic-indent}). If given a prefix,
2794 ``un-indent'' the topic instead.
2797 @kindex M-TAB (Topic)
2798 @findex gnus-topic-unindent
2799 ``Un-indent'' the current topic so that it becomes a sub-topic of the
2800 parent of its current parent (@code{gnus-topic-unindent}).
2804 @findex gnus-topic-select-group
2806 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2807 When you perform this command on a group, you'll enter the group, as
2808 usual. When done on a topic line, the topic will be folded (if it was
2809 visible) or unfolded (if it was folded already). So it's basically a
2810 toggling command on topics. In addition, if you give a numerical
2811 prefix, group on that level (and lower) will be displayed.
2814 @kindex C-c C-x (Topic)
2815 @findex gnus-topic-expire-articles
2816 Run all expirable articles in the current group or topic through the expiry
2817 process (if any) (@code{gnus-topic-expire-articles}).
2821 @findex gnus-topic-kill-group
2822 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
2823 topic will be removed along with the topic.
2827 @findex gnus-topic-yank-group
2828 Yank the previously killed group or topic
2829 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
2834 @findex gnus-topic-rename
2835 Rename a topic (@code{gnus-topic-rename}).
2838 @kindex T DEL (Topic)
2839 @findex gnus-topic-delete
2840 Delete an empty topic (@code{gnus-topic-delete}).
2844 @findex gnus-topic-list-active
2845 List all groups that gnus knows about in a topics-ified way
2846 (@code{gnus-topic-list-active}).
2850 @findex gnus-topic-edit-parameters
2851 @cindex group parameters
2852 @cindex topic parameters
2854 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2855 @xref{Topic Parameters}.
2861 @subsection Topic Sorting
2862 @cindex topic sorting
2864 You can sort the groups in each topic individually with the following
2870 @kindex T S a (Topic)
2871 @findex gnus-topic-sort-groups-by-alphabet
2872 Sort the current topic alphabetically by group name
2873 (@code{gnus-topic-sort-groups-by-alphabet}).
2876 @kindex T S u (Topic)
2877 @findex gnus-topic-sort-groups-by-unread
2878 Sort the current topic by the number of unread articles
2879 (@code{gnus-topic-sort-groups-by-unread}).
2882 @kindex T S l (Topic)
2883 @findex gnus-topic-sort-groups-by-level
2884 Sort the current topic by group level
2885 (@code{gnus-topic-sort-groups-by-level}).
2888 @kindex T S v (Topic)
2889 @findex gnus-topic-sort-groups-by-score
2890 Sort the current topic by group score
2891 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
2894 @kindex T S r (Topic)
2895 @findex gnus-topic-sort-groups-by-rank
2896 Sort the current topic by group rank
2897 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
2900 @kindex T S m (Topic)
2901 @findex gnus-topic-sort-groups-by-method
2902 Sort the current topic alphabetically by backend name
2903 (@code{gnus-topic-sort-groups-by-method}).
2907 @xref{Sorting Groups}, for more information about group sorting.
2910 @node Topic Topology
2911 @subsection Topic Topology
2912 @cindex topic topology
2915 So, let's have a look at an example group buffer:
2921 2: alt.religion.emacs
2924 0: comp.talk.emacs.recovery
2926 8: comp.binaries.fractals
2927 13: comp.sources.unix
2930 So, here we have one top-level topic (@samp{Gnus}), two topics under
2931 that, and one sub-topic under one of the sub-topics. (There is always
2932 just one (1) top-level topic). This topology can be expressed as
2937 (("Emacs -- I wuw it!" visible)
2938 (("Naughty Emacs" visible)))
2942 @vindex gnus-topic-topology
2943 This is in fact how the variable @code{gnus-topic-topology} would look
2944 for the display above. That variable is saved in the @file{.newsrc.eld}
2945 file, and shouldn't be messed with manually---unless you really want
2946 to. Since this variable is read from the @file{.newsrc.eld} file,
2947 setting it in any other startup files will have no effect.
2949 This topology shows what topics are sub-topics of what topics (right),
2950 and which topics are visible. Two settings are currently
2951 allowed---@code{visible} and @code{invisible}.
2954 @node Topic Parameters
2955 @subsection Topic Parameters
2956 @cindex topic parameters
2958 All groups in a topic will inherit group parameters from the parent (and
2959 ancestor) topic parameters. All valid group parameters are valid topic
2960 parameters (@pxref{Group Parameters}).
2962 Group parameters (of course) override topic parameters, and topic
2963 parameters in sub-topics override topic parameters in super-topics. You
2964 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
2965 verb, although you may feel free to disagree with me here.)
2971 2: alt.religion.emacs
2975 0: comp.talk.emacs.recovery
2977 8: comp.binaries.fractals
2978 13: comp.sources.unix
2982 The @samp{Emacs} topic has the topic parameter @code{(score-file
2983 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2984 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2985 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
2986 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
2987 . "religion.SCORE")}.
2989 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2990 will get the @file{relief.SCORE} home score file. If you enter the same
2991 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2992 score file. If you enter the group @samp{alt.religion.emacs}, you'll
2993 get the @file{religion.SCORE} home score file.
2995 This seems rather simple and self-evident, doesn't it? Well, yes. But
2996 there are some problems, especially with the @code{total-expiry}
2997 parameter. Say you have a mail group in two topics; one with
2998 @code{total-expiry} and one without. What happens when you do @kbd{M-x
2999 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
3000 of these topics you mean to expire articles from, so anything may
3001 happen. In fact, I hereby declare that it is @dfn{undefined} what
3002 happens. You just have to be careful if you do stuff like that.
3005 @node Misc Group Stuff
3006 @section Misc Group Stuff
3009 * Scanning New Messages:: Asking gnus to see whether new messages have arrived.
3010 * Group Information:: Information and help on groups and gnus.
3011 * Group Timestamp:: Making gnus keep track of when you last read a group.
3012 * File Commands:: Reading and writing the gnus files.
3019 @findex gnus-group-enter-server-mode
3020 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3021 @xref{The Server Buffer}.
3025 @findex gnus-group-post-news
3026 Post an article to a group (@code{gnus-group-post-news}). If given a
3027 prefix, the current group name will be used as the default.
3031 @findex gnus-group-mail
3032 Mail a message somewhere (@code{gnus-group-mail}).
3036 Variables for the group buffer:
3040 @item gnus-group-mode-hook
3041 @vindex gnus-group-mode-hook
3042 is called after the group buffer has been
3045 @item gnus-group-prepare-hook
3046 @vindex gnus-group-prepare-hook
3047 is called after the group buffer is
3048 generated. It may be used to modify the buffer in some strange,
3051 @item gnus-group-prepared-hook
3052 @vindex gnus-group-prepare-hook
3053 is called as the very last thing after the group buffer has been
3054 generated. It may be used to move point around, for instance.
3056 @item gnus-permanently-visible-groups
3057 @vindex gnus-permanently-visible-groups
3058 Groups matching this regexp will always be listed in the group buffer,
3059 whether they are empty or not.
3064 @node Scanning New Messages
3065 @subsection Scanning New Messages
3066 @cindex new messages
3067 @cindex scanning new news
3073 @findex gnus-group-get-new-news
3074 @c @icon{gnus-group-get-new-news}
3075 Check the server(s) for new articles. If the numerical prefix is used,
3076 this command will check only groups of level @var{arg} and lower
3077 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
3078 command will force a total re-reading of the active file(s) from the
3083 @findex gnus-group-get-new-news-this-group
3084 @vindex gnus-goto-next-group-when-activating
3085 @c @icon{gnus-group-get-new-news-this-group}
3086 Check whether new articles have arrived in the current group
3087 (@code{gnus-group-get-new-news-this-group}).
3088 @code{gnus-goto-next-group-when-activating} says whether this command is
3089 to move point to the next group or not. It is @code{t} by default.
3091 @findex gnus-activate-all-groups
3092 @cindex activating groups
3094 @kindex C-c M-g (Group)
3095 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3100 @findex gnus-group-restart
3101 Restart gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
3102 file(s), closes the connection to all servers, clears up all run-time
3103 gnus variables, and then starts gnus all over again.
3107 @vindex gnus-get-new-news-hook
3108 @code{gnus-get-new-news-hook} is run just before checking for new news.
3110 @vindex gnus-after-getting-new-news-hook
3111 @code{gnus-after-getting-new-news-hook} is run after checking for new
3115 @node Group Information
3116 @subsection Group Information
3117 @cindex group information
3118 @cindex information on groups
3125 @findex gnus-group-fetch-faq
3126 @vindex gnus-group-faq-directory
3129 Try to fetch the FAQ for the current group
3130 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
3131 @code{gnus-group-faq-directory}, which is usually a directory on a
3132 remote machine. This variable can also be a list of directories. In
3133 that case, giving a prefix to this command will allow you to choose
3134 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
3135 for fetching the file.
3137 If fetching from the first site is unsuccessful, gnus will attempt to go
3138 through @code{gnus-group-faq-directory} and try to open them one by one.
3142 @c @icon{gnus-group-describe-group}
3144 @kindex C-c C-d (Group)
3145 @cindex describing groups
3146 @cindex group description
3147 @findex gnus-group-describe-group
3148 Describe the current group (@code{gnus-group-describe-group}). If given
3149 a prefix, force Gnus to re-read the description from the server.
3153 @findex gnus-group-describe-all-groups
3154 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
3155 prefix, force gnus to re-read the description file from the server.
3162 @findex gnus-version
3163 Display current gnus version numbers (@code{gnus-version}).
3167 @findex gnus-group-describe-briefly
3168 Give a very short help message (@code{gnus-group-describe-briefly}).
3171 @kindex C-c C-i (Group)
3174 @findex gnus-info-find-node
3175 Go to the gnus info node (@code{gnus-info-find-node}).
3179 @node Group Timestamp
3180 @subsection Group Timestamp
3182 @cindex group timestamps
3184 It can be convenient to let gnus keep track of when you last read a
3185 group. To set the ball rolling, you should add
3186 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3189 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3192 After doing this, each time you enter a group, it'll be recorded.
3194 This information can be displayed in various ways---the easiest is to
3195 use the @samp{%d} spec in the group line format:
3198 (setq gnus-group-line-format
3199 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3202 This will result in lines looking like:
3205 * 0: mail.ding 19961002T012943
3206 0: custom 19961002T012713
3209 As you can see, the date is displayed in compact ISO 8601 format. This
3210 may be a bit too much, so to just display the date, you could say
3214 (setq gnus-group-line-format
3215 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3220 @subsection File Commands
3221 @cindex file commands
3227 @findex gnus-group-read-init-file
3228 @vindex gnus-init-file
3229 @cindex reading init file
3230 Re-read the init file (@code{gnus-init-file}, which defaults to
3231 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3235 @findex gnus-group-save-newsrc
3236 @cindex saving .newsrc
3237 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3238 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
3239 file(s) whether Gnus thinks it is necessary or not.
3242 @c @kindex Z (Group)
3243 @c @findex gnus-group-clear-dribble
3244 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3249 @node The Summary Buffer
3250 @chapter The Summary Buffer
3251 @cindex summary buffer
3253 A line for each article is displayed in the summary buffer. You can
3254 move around, read articles, post articles and reply to articles.
3256 The most common way to a summary buffer is to select a group from the
3257 group buffer (@pxref{Selecting a Group}).
3259 You can have as many summary buffers open as you wish.
3262 * Summary Buffer Format:: Deciding how the summary buffer is to look.
3263 * Summary Maneuvering:: Moving around the summary buffer.
3264 * Choosing Articles:: Reading articles.
3265 * Paging the Article:: Scrolling the current article.
3266 * Reply Followup and Post:: Posting articles.
3267 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
3268 * Marking Articles:: Marking articles as read, expirable, etc.
3269 * Limiting:: You can limit the summary buffer.
3270 * Threading:: How threads are made.
3271 * Sorting:: How articles and threads are sorted.
3272 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
3273 * Article Caching:: You may store articles in a cache.
3274 * Persistent Articles:: Making articles expiry-resistant.
3275 * Article Backlog:: Having already read articles hang around.
3276 * Saving Articles:: Ways of customizing article saving.
3277 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
3278 * Article Treatment:: The article buffer can be mangled at will.
3279 * MIME Commands:: Doing MIMEy things with the articles.
3280 * Charsets:: Character set issues.
3281 * Article Commands:: Doing various things with the article buffer.
3282 * Summary Sorting:: Sorting the summary buffer in various ways.
3283 * Finding the Parent:: No child support? Get the parent.
3284 * Alternative Approaches:: Reading using non-default summaries.
3285 * Tree Display:: A more visual display of threads.
3286 * Mail Group Commands:: Some commands can only be used in mail groups.
3287 * Various Summary Stuff:: What didn't fit anywhere else.
3288 * Exiting the Summary Buffer:: Returning to the Group buffer.
3289 * Crosspost Handling:: How crossposted articles are dealt with.
3290 * Duplicate Suppression:: An alternative when crosspost handling fails.
3294 @node Summary Buffer Format
3295 @section Summary Buffer Format
3296 @cindex summary buffer format
3300 \gnusfigure{The Summary Buffer}{180}{
3301 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3302 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3308 * Summary Buffer Lines:: You can specify how summary lines should look.
3309 * To From Newsgroups:: How to not display your own name.
3310 * Summary Buffer Mode Line:: You can say how the mode line should look.
3311 * Summary Highlighting:: Making the summary buffer all pretty and nice.
3314 @findex mail-extract-address-components
3315 @findex gnus-extract-address-components
3316 @vindex gnus-extract-address-components
3317 Gnus will use the value of the @code{gnus-extract-address-components}
3318 variable as a function for getting the name and address parts of a
3319 @code{From} header. Three pre-defined functions exist:
3320 @code{gnus-extract-address-components}, which is the default, quite
3321 fast, and too simplistic solution;
3322 @code{mail-extract-address-components}, which works nicely, but is
3323 slower; and @code{std11-extract-address-components}, which works very
3324 nicely, but is slower. The default function will return the wrong
3325 answer in 5% of the cases. If this is unacceptable to you, use the
3326 other function instead:
3329 (setq gnus-extract-address-components
3330 'mail-extract-address-components)
3333 @vindex gnus-summary-same-subject
3334 @code{gnus-summary-same-subject} is a string indicating that the current
3335 article has the same subject as the previous. This string will be used
3336 with those specs that require it. The default is @code{""}.
3339 @node Summary Buffer Lines
3340 @subsection Summary Buffer Lines
3342 @vindex gnus-summary-line-format
3343 You can change the format of the lines in the summary buffer by changing
3344 the @code{gnus-summary-line-format} variable. It works along the same
3345 lines as a normal @code{format} string, with some extensions
3346 (@pxref{Formatting Variables}).
3348 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3350 The following format specification characters are understood:
3356 Subject string. List identifiers stripped, @code{gnus-list-identifies}. @xref{Article Hiding}.
3358 Subject if the article is the root of the thread or the previous article
3359 had a different subject, @code{gnus-summary-same-subject} otherwise.
3360 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3362 Full @code{From} header.
3364 The name (from the @code{From} header).
3366 The name, code @code{To} header or the @code{Newsgroups} header
3367 (@pxref{To From Newsgroups}).
3369 The name (from the @code{From} header). This differs from the @code{n}
3370 spec in that it uses the function designated by the
3371 @code{gnus-extract-address-components} variable, which is slower, but
3372 may be more thorough.
3374 The address (from the @code{From} header). This works the same way as
3377 Number of lines in the article.
3379 Number of characters in the article.
3381 Indentation based on thread level (@pxref{Customizing Threading}).
3383 Nothing if the article is a root and lots of spaces if it isn't (it
3384 pushes everything after it off the screen).
3386 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3387 for adopted articles (@pxref{Customizing Threading}).
3389 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3390 for adopted articles.
3392 One space for each thread level.
3394 Twenty minus thread level spaces.
3399 This misleadingly named specifier is the @dfn{secondary mark}. This
3400 mark will say whether the article has been replied to, has been cached,
3404 Score as a number (@pxref{Scoring}).
3406 @vindex gnus-summary-zcore-fuzz
3407 Zcore, @samp{+} if above the default level and @samp{-} if below the
3408 default level. If the difference between
3409 @code{gnus-summary-default-score} and the score is less than
3410 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3418 The @code{Date} in @code{DD-MMM} format.
3420 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3426 Number of articles in the current sub-thread. Using this spec will slow
3427 down summary buffer generation somewhat.
3429 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3430 article has any children.
3436 User defined specifier. The next character in the format string should
3437 be a letter. Gnus will call the function
3438 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3439 following @samp{%u}. The function will be passed the current header as
3440 argument. The function should return a string, which will be inserted
3441 into the summary just like information from any other summary specifier.
3444 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3445 have to be handled with care. For reasons of efficiency, gnus will
3446 compute what column these characters will end up in, and ``hard-code''
3447 that. This means that it is invalid to have these specs after a
3448 variable-length spec. Well, you might not be arrested, but your summary
3449 buffer will look strange, which is bad enough.
3451 The smart choice is to have these specs as far to the left as possible.
3452 (Isn't that the case with everything, though? But I digress.)
3454 This restriction may disappear in later versions of gnus.
3457 @node To From Newsgroups
3458 @subsection To From Newsgroups
3462 In some groups (particularly in archive groups), the @code{From} header
3463 isn't very interesting, since all the articles there are written by
3464 you. To display the information in the @code{To} or @code{Newsgroups}
3465 headers instead, you need to decide three things: What information to
3466 gather; where to display it; and when to display it.
3470 @vindex gnus-extra-headers
3471 The reading of extra header information is controlled by the
3472 @code{gnus-extra-headers}. This is a list of header symbols. For
3476 (setq gnus-extra-headers
3477 '(To Newsgroups X-Newsreader))
3480 This will result in Gnus trying to obtain these three headers, and
3481 storing it in header structures for later easy retrieval.
3484 @findex gnus-extra-header
3485 The value of these extra headers can be accessed via the
3486 @code{gnus-extra-header} function. Here's a format line spec that will
3487 access the @code{X-Newsreader} header:
3490 "%~(form (gnus-extra-header 'X-Newsreader))@@"
3494 @vindex gnus-ignored-from-addresses
3495 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
3496 summary line spec returns the @code{To}, @code{Newsreader} or
3497 @code{From} header. If this regexp matches the contents of the
3498 @code{From} header, the value of the @code{To} or @code{Newsreader}
3499 headers are used instead.
3503 @vindex nnmail-extra-headers
3504 A related variable is @code{nnmail-extra-headers}, which controls when
3505 to include extra headers when generating overview (@sc{nov}) files. If
3506 you have old overview files, you should regenerate them after changing
3509 @vindex gnus-summary-line-format
3510 You also have to instruct Gnus to display the data by changing the
3511 @code{%n} spec to the @code{%f} spec in the
3512 @code{gnus-summary-line-format} variable.
3514 In summary, you'd typically do something like the following:
3517 (setq gnus-extra-headers
3519 (setq nnmail-extra-headers gnus-extra-headers)
3520 (setq gnus-summary-line-format
3521 "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n")
3522 (setq gnus-ignored-from-addresses
3526 Now, this is mostly useful for mail groups, where you have control over
3527 the @sc{nov} files that are created. However, if you can persuade your
3534 to the end of her @file{overview.fmt} file, then you can use that just
3535 as you would the extra headers from the mail groups.
3538 @node Summary Buffer Mode Line
3539 @subsection Summary Buffer Mode Line
3541 @vindex gnus-summary-mode-line-format
3542 You can also change the format of the summary mode bar (@pxref{Mode Line
3543 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
3544 like. The default is @samp{Gnus: %%b [%A] %Z}.
3546 Here are the elements you can play with:
3552 Unprefixed group name.
3554 Current article number.
3556 Current article score.
3560 Number of unread articles in this group.
3562 Number of unread articles in this group that aren't displayed in the
3565 A string with the number of unread and unselected articles represented
3566 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3567 articles, and just as @samp{<%U more>} if there are just unread articles
3568 and no unselected ones.
3570 Shortish group name. For instance, @samp{rec.arts.anime} will be
3571 shortened to @samp{r.a.anime}.
3573 Subject of the current article.
3575 User-defined spec (@pxref{User-Defined Specs}).
3577 Name of the current score file (@pxref{Scoring}).
3579 Number of dormant articles (@pxref{Unread Articles}).
3581 Number of ticked articles (@pxref{Unread Articles}).
3583 Number of articles that have been marked as read in this session.
3585 Number of articles expunged by the score files.
3589 @node Summary Highlighting
3590 @subsection Summary Highlighting
3594 @item gnus-visual-mark-article-hook
3595 @vindex gnus-visual-mark-article-hook
3596 This hook is run after selecting an article. It is meant to be used for
3597 highlighting the article in some way. It is not run if
3598 @code{gnus-visual} is @code{nil}.
3600 @item gnus-summary-update-hook
3601 @vindex gnus-summary-update-hook
3602 This hook is called when a summary line is changed. It is not run if
3603 @code{gnus-visual} is @code{nil}.
3605 @item gnus-summary-selected-face
3606 @vindex gnus-summary-selected-face
3607 This is the face (or @dfn{font} as some people call it) used to
3608 highlight the current article in the summary buffer.
3610 @item gnus-summary-highlight
3611 @vindex gnus-summary-highlight
3612 Summary lines are highlighted according to this variable, which is a
3613 list where the elements are of the format @var{(FORM . FACE)}. If you
3614 would, for instance, like ticked articles to be italic and high-scored
3615 articles to be bold, you could set this variable to something like
3617 (((eq mark gnus-ticked-mark) . italic)
3618 ((> score default) . bold))
3620 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3621 @var{FACE} will be applied to the line.
3625 @node Summary Maneuvering
3626 @section Summary Maneuvering
3627 @cindex summary movement
3629 All the straight movement commands understand the numeric prefix and
3630 behave pretty much as you'd expect.
3632 None of these commands select articles.
3637 @kindex M-n (Summary)
3638 @kindex G M-n (Summary)
3639 @findex gnus-summary-next-unread-subject
3640 Go to the next summary line of an unread article
3641 (@code{gnus-summary-next-unread-subject}).
3645 @kindex M-p (Summary)
3646 @kindex G M-p (Summary)
3647 @findex gnus-summary-prev-unread-subject
3648 Go to the previous summary line of an unread article
3649 (@code{gnus-summary-prev-unread-subject}).
3654 @kindex G j (Summary)
3655 @findex gnus-summary-goto-article
3656 Ask for an article number or @code{Message-ID}, and then go to that
3657 article (@code{gnus-summary-goto-article}).
3660 @kindex G g (Summary)
3661 @findex gnus-summary-goto-subject
3662 Ask for an article number and then go to the summary line of that article
3663 without displaying the article (@code{gnus-summary-goto-subject}).
3666 If gnus asks you to press a key to confirm going to the next group, you
3667 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3668 buffer, searching for the next group to read without actually returning
3669 to the group buffer.
3671 Variables related to summary movement:
3675 @vindex gnus-auto-select-next
3676 @item gnus-auto-select-next
3677 If you issue one of the movement commands (like @kbd{n}) and there are
3678 no more unread articles after the current one, gnus will offer to go to
3679 the next group. If this variable is @code{t} and the next group is
3680 empty, gnus will exit summary mode and return to the group buffer. If
3681 this variable is neither @code{t} nor @code{nil}, gnus will select the
3682 next group, no matter whether it has any unread articles or not. As a
3683 special case, if this variable is @code{quietly}, gnus will select the
3684 next group without asking for confirmation. If this variable is
3685 @code{almost-quietly}, the same will happen only if you are located on
3686 the last article in the group. Finally, if this variable is
3687 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3688 without confirmation. Also @pxref{Group Levels}.
3690 @item gnus-auto-select-same
3691 @vindex gnus-auto-select-same
3692 If non-@code{nil}, all the movement commands will try to go to the next
3693 article with the same subject as the current. (@dfn{Same} here might
3694 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
3695 for details (@pxref{Customizing Threading}).) If there are no more
3696 articles with the same subject, go to the first unread article.
3698 This variable is not particularly useful if you use a threaded display.
3700 @item gnus-summary-check-current
3701 @vindex gnus-summary-check-current
3702 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3703 to the next (or previous) article if the current article is unread.
3704 Instead, they will choose the current article.
3706 @item gnus-auto-center-summary
3707 @vindex gnus-auto-center-summary
3708 If non-@code{nil}, gnus will keep the point in the summary buffer
3709 centered at all times. This makes things quite tidy, but if you have a
3710 slow network connection, or simply do not like this un-Emacsism, you can
3711 set this variable to @code{nil} to get the normal Emacs scrolling
3712 action. This will also inhibit horizontal re-centering of the summary
3713 buffer, which might make it more inconvenient to read extremely long
3716 This variable can also be a number. In that case, center the window at
3717 the given number of lines from the top.
3722 @node Choosing Articles
3723 @section Choosing Articles
3724 @cindex selecting articles
3727 * Choosing Commands:: Commands for choosing articles.
3728 * Choosing Variables:: Variables that influence these commands.
3732 @node Choosing Commands
3733 @subsection Choosing Commands
3735 None of the following movement commands understand the numeric prefix,
3736 and they all select and display an article.
3740 @kindex SPACE (Summary)
3741 @findex gnus-summary-next-page
3742 Select the current article, or, if that one's read already, the next
3743 unread article (@code{gnus-summary-next-page}).
3748 @kindex G n (Summary)
3749 @findex gnus-summary-next-unread-article
3750 @c @icon{gnus-summary-next-unread}
3751 Go to next unread article (@code{gnus-summary-next-unread-article}).
3756 @findex gnus-summary-prev-unread-article
3757 @c @icon{gnus-summary-prev-unread}
3758 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3763 @kindex G N (Summary)
3764 @findex gnus-summary-next-article
3765 Go to the next article (@code{gnus-summary-next-article}).
3770 @kindex G P (Summary)
3771 @findex gnus-summary-prev-article
3772 Go to the previous article (@code{gnus-summary-prev-article}).
3775 @kindex G C-n (Summary)
3776 @findex gnus-summary-next-same-subject
3777 Go to the next article with the same subject
3778 (@code{gnus-summary-next-same-subject}).
3781 @kindex G C-p (Summary)
3782 @findex gnus-summary-prev-same-subject
3783 Go to the previous article with the same subject
3784 (@code{gnus-summary-prev-same-subject}).
3788 @kindex G f (Summary)
3790 @findex gnus-summary-first-unread-article
3791 Go to the first unread article
3792 (@code{gnus-summary-first-unread-article}).
3796 @kindex G b (Summary)
3798 @findex gnus-summary-best-unread-article
3799 Go to the article with the highest score
3800 (@code{gnus-summary-best-unread-article}).
3805 @kindex G l (Summary)
3806 @findex gnus-summary-goto-last-article
3807 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3810 @kindex G o (Summary)
3811 @findex gnus-summary-pop-article
3813 @cindex article history
3814 Pop an article off the summary history and go to this article
3815 (@code{gnus-summary-pop-article}). This command differs from the
3816 command above in that you can pop as many previous articles off the
3817 history as you like, while @kbd{l} toggles the two last read articles.
3818 For a somewhat related issue (if you use these commands a lot),
3819 @pxref{Article Backlog}.
3823 @node Choosing Variables
3824 @subsection Choosing Variables
3826 Some variables relevant for moving and selecting articles:
3829 @item gnus-auto-extend-newsgroup
3830 @vindex gnus-auto-extend-newsgroup
3831 All the movement commands will try to go to the previous (or next)
3832 article, even if that article isn't displayed in the Summary buffer if
3833 this variable is non-@code{nil}. Gnus will then fetch the article from
3834 the server and display it in the article buffer.
3836 @item gnus-select-article-hook
3837 @vindex gnus-select-article-hook
3838 This hook is called whenever an article is selected. By default it
3839 exposes any threads hidden under the selected article.
3841 @item gnus-mark-article-hook
3842 @vindex gnus-mark-article-hook
3843 @findex gnus-summary-mark-unread-as-read
3844 @findex gnus-summary-mark-read-and-unread-as-read
3845 @findex gnus-unread-mark
3846 This hook is called whenever an article is selected. It is intended to
3847 be used for marking articles as read. The default value is
3848 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3849 mark of almost any article you read to @code{gnus-unread-mark}. The
3850 only articles not affected by this function are ticked, dormant, and
3851 expirable articles. If you'd instead like to just have unread articles
3852 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3853 instead. It will leave marks like @code{gnus-low-score-mark},
3854 @code{gnus-del-mark} (and so on) alone.
3859 @node Paging the Article
3860 @section Scrolling the Article
3861 @cindex article scrolling
3866 @kindex SPACE (Summary)
3867 @findex gnus-summary-next-page
3868 Pressing @kbd{SPACE} will scroll the current article forward one page,
3869 or, if you have come to the end of the current article, will choose the
3870 next article (@code{gnus-summary-next-page}).
3873 @kindex DEL (Summary)
3874 @findex gnus-summary-prev-page
3875 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3878 @kindex RET (Summary)
3879 @findex gnus-summary-scroll-up
3880 Scroll the current article one line forward
3881 (@code{gnus-summary-scroll-up}).
3884 @kindex M-RET (Summary)
3885 @findex gnus-summary-scroll-down
3886 Scroll the current article one line backward
3887 (@code{gnus-summary-scroll-down}).
3891 @kindex A g (Summary)
3893 @findex gnus-summary-show-article
3894 (Re)fetch the current article (@code{gnus-summary-show-article}). If
3895 given a prefix, fetch the current article, but don't run any of the
3896 article treatment functions. This will give you a ``raw'' article, just
3897 the way it came from the server.
3902 @kindex A < (Summary)
3903 @findex gnus-summary-beginning-of-article
3904 Scroll to the beginning of the article
3905 (@code{gnus-summary-beginning-of-article}).
3910 @kindex A > (Summary)
3911 @findex gnus-summary-end-of-article
3912 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3916 @kindex A s (Summary)
3918 @findex gnus-summary-isearch-article
3919 Perform an isearch in the article buffer
3920 (@code{gnus-summary-isearch-article}).
3924 @findex gnus-summary-select-article-buffer
3925 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3930 @node Reply Followup and Post
3931 @section Reply, Followup and Post
3934 * Summary Mail Commands:: Sending mail.
3935 * Summary Post Commands:: Sending news.
3939 @node Summary Mail Commands
3940 @subsection Summary Mail Commands
3942 @cindex composing mail
3944 Commands for composing a mail message:
3950 @kindex S r (Summary)
3952 @findex gnus-summary-reply
3953 @c @icon{gnus-summary-mail-reply}
3954 @c @icon{gnus-summary-reply}
3955 Mail a reply to the author of the current article
3956 (@code{gnus-summary-reply}).
3961 @kindex S R (Summary)
3962 @findex gnus-summary-reply-with-original
3963 @c @icon{gnus-summary-reply-with-original}
3964 Mail a reply to the author of the current article and include the
3965 original message (@code{gnus-summary-reply-with-original}). This
3966 command uses the process/prefix convention.
3969 @kindex S w (Summary)
3970 @findex gnus-summary-wide-reply
3971 Mail a wide reply to the author of the current article
3972 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
3973 goes out to all people listed in the @code{To}, @code{From} (or
3974 @code{Reply-to}) and @code{Cc} headers.
3977 @kindex S W (Summary)
3978 @findex gnus-summary-wide-reply-with-original
3979 Mail a wide reply to the current article and include the original
3980 message (@code{gnus-summary-wide-reply-with-original}). This command uses
3981 the process/prefix convention.
3984 @kindex S o m (Summary)
3985 @findex gnus-summary-mail-forward
3986 @c @icon{gnus-summary-mail-forward}
3987 Forward the current article to some other person
3988 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
3989 headers of the forwarded article.
3994 @kindex S m (Summary)
3995 @findex gnus-summary-mail-other-window
3996 @c @icon{gnus-summary-mail-originate}
3997 Send a mail to some other person
3998 (@code{gnus-summary-mail-other-window}).
4001 @kindex S D b (Summary)
4002 @findex gnus-summary-resend-bounced-mail
4003 @cindex bouncing mail
4004 If you have sent a mail, but the mail was bounced back to you for some
4005 reason (wrong address, transient failure), you can use this command to
4006 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
4007 will be popped into a mail buffer where you can edit the headers before
4008 sending the mail off again. If you give a prefix to this command, and
4009 the bounced mail is a reply to some other mail, gnus will try to fetch
4010 that mail and display it for easy perusal of its headers. This might
4011 very well fail, though.
4014 @kindex S D r (Summary)
4015 @findex gnus-summary-resend-message
4016 Not to be confused with the previous command,
4017 @code{gnus-summary-resend-message} will prompt you for an address to
4018 send the current message off to, and then send it to that place. The
4019 headers of the message won't be altered---but lots of headers that say
4020 @code{Resent-To}, @code{Resent-From} and so on will be added. This
4021 means that you actually send a mail to someone that has a @code{To}
4022 header that (probably) points to yourself. This will confuse people.
4023 So, natcherly you'll only do that if you're really eVIl.
4025 This command is mainly used if you have several accounts and want to
4026 ship a mail to a different account of yours. (If you're both
4027 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4028 to the @code{root} account, you may want to resend it to
4029 @code{postmaster}. Ordnung muß sein!
4031 This command understands the process/prefix convention
4032 (@pxref{Process/Prefix}).
4035 @kindex S O m (Summary)
4036 @findex gnus-uu-digest-mail-forward
4037 Digest the current series (@pxref{Decoding Articles}) and forward the
4038 result using mail (@code{gnus-uu-digest-mail-forward}). This command
4039 uses the process/prefix convention (@pxref{Process/Prefix}).
4042 @kindex S M-c (Summary)
4043 @findex gnus-summary-mail-crosspost-complaint
4044 @cindex crossposting
4045 @cindex excessive crossposting
4046 Send a complaint about excessive crossposting to the author of the
4047 current article (@code{gnus-summary-mail-crosspost-complaint}).
4049 @findex gnus-crosspost-complaint
4050 This command is provided as a way to fight back against the current
4051 crossposting pandemic that's sweeping Usenet. It will compose a reply
4052 using the @code{gnus-crosspost-complaint} variable as a preamble. This
4053 command understands the process/prefix convention
4054 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4058 Also @pxref{(message)Header Commands} for more information.
4061 @node Summary Post Commands
4062 @subsection Summary Post Commands
4064 @cindex composing news
4066 Commands for posting a news article:
4072 @kindex S p (Summary)
4073 @findex gnus-summary-post-news
4074 @c @icon{gnus-summary-post-news}
4075 Post an article to the current group
4076 (@code{gnus-summary-post-news}).
4081 @kindex S f (Summary)
4082 @findex gnus-summary-followup
4083 @c @icon{gnus-summary-followup}
4084 Post a followup to the current article (@code{gnus-summary-followup}).
4088 @kindex S F (Summary)
4090 @c @icon{gnus-summary-followup-with-original}
4091 @findex gnus-summary-followup-with-original
4092 Post a followup to the current article and include the original message
4093 (@code{gnus-summary-followup-with-original}). This command uses the
4094 process/prefix convention.
4097 @kindex S n (Summary)
4098 @findex gnus-summary-followup-to-mail
4099 Post a followup to the current article via news, even if you got the
4100 message through mail (@code{gnus-summary-followup-to-mail}).
4103 @kindex S N (Summary)
4104 @findex gnus-summary-followup-to-mail-with-original
4105 Post a followup to the current article via news, even if you got the
4106 message through mail and include the original message
4107 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
4108 the process/prefix convention.
4111 @kindex S o p (Summary)
4112 @findex gnus-summary-post-forward
4113 Forward the current article to a newsgroup
4114 (@code{gnus-summary-post-forward}). If given a prefix, include the full
4115 headers of the forwarded article.
4118 @kindex S O p (Summary)
4119 @findex gnus-uu-digest-post-forward
4121 @cindex making digests
4122 Digest the current series and forward the result to a newsgroup
4123 (@code{gnus-uu-digest-mail-forward}). This command uses the
4124 process/prefix convention.
4127 @kindex S u (Summary)
4128 @findex gnus-uu-post-news
4129 @c @icon{gnus-uu-post-news}
4130 Uuencode a file, split it into parts, and post it as a series
4131 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
4134 Also @pxref{(message)Header Commands} for more information.
4137 @node Canceling and Superseding
4138 @section Canceling Articles
4139 @cindex canceling articles
4140 @cindex superseding articles
4142 Have you ever written something, and then decided that you really,
4143 really, really wish you hadn't posted that?
4145 Well, you can't cancel mail, but you can cancel posts.
4147 @findex gnus-summary-cancel-article
4149 @c @icon{gnus-summary-cancel-article}
4150 Find the article you wish to cancel (you can only cancel your own
4151 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
4152 c} (@code{gnus-summary-cancel-article}). Your article will be
4153 canceled---machines all over the world will be deleting your article.
4154 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4156 Be aware, however, that not all sites honor cancels, so your article may
4157 live on here and there, while most sites will delete the article in
4160 Gnus will use the ``current'' select method when canceling. If you
4161 want to use the standard posting method, use the @samp{a} symbolic
4162 prefix (@pxref{Symbolic Prefixes}).
4164 If you discover that you have made some mistakes and want to do some
4165 corrections, you can post a @dfn{superseding} article that will replace
4166 your original article.
4168 @findex gnus-summary-supersede-article
4170 Go to the original article and press @kbd{S s}
4171 (@code{gnus-summary-supersede-article}). You will be put in a buffer
4172 where you can edit the article all you want before sending it off the
4175 The same goes for superseding as for canceling, only more so: Some
4176 sites do not honor superseding. On those sites, it will appear that you
4177 have posted almost the same article twice.
4179 If you have just posted the article, and change your mind right away,
4180 there is a trick you can use to cancel/supersede the article without
4181 waiting for the article to appear on your site first. You simply return
4182 to the post buffer (which is called @code{*sent ...*}). There you will
4183 find the article you just posted, with all the headers intact. Change
4184 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4185 header by substituting one of those words for the word
4186 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
4187 you would do normally. The previous article will be
4188 canceled/superseded.
4190 Just remember, kids: There is no 'c' in 'supersede'.
4193 @node Marking Articles
4194 @section Marking Articles
4195 @cindex article marking
4196 @cindex article ticking
4199 There are several marks you can set on an article.
4201 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4202 neologism ohoy!) of the article. Alphabetic marks generally mean
4203 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4205 In addition, you also have marks that do not affect readedness.
4208 * Unread Articles:: Marks for unread articles.
4209 * Read Articles:: Marks for read articles.
4210 * Other Marks:: Marks that do not affect readedness.
4214 There's a plethora of commands for manipulating these marks:
4218 * Setting Marks:: How to set and remove marks.
4219 * Generic Marking Commands:: How to customize the marking.
4220 * Setting Process Marks:: How to mark articles for later processing.
4224 @node Unread Articles
4225 @subsection Unread Articles
4227 The following marks mark articles as (kinda) unread, in one form or
4232 @vindex gnus-ticked-mark
4233 Marked as ticked (@code{gnus-ticked-mark}).
4235 @dfn{Ticked articles} are articles that will remain visible always. If
4236 you see an article that you find interesting, or you want to put off
4237 reading it, or replying to it, until sometime later, you'd typically
4238 tick it. However, articles can be expired, so if you want to keep an
4239 article forever, you'll have to make it persistent (@pxref{Persistent
4243 @vindex gnus-dormant-mark
4244 Marked as dormant (@code{gnus-dormant-mark}).
4246 @dfn{Dormant articles} will only appear in the summary buffer if there
4247 are followups to it. If you want to see them even if they don't have
4248 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4251 @vindex gnus-unread-mark
4252 Marked as unread (@code{gnus-unread-mark}).
4254 @dfn{Unread articles} are articles that haven't been read at all yet.
4259 @subsection Read Articles
4260 @cindex expirable mark
4262 All the following marks mark articles as read.
4267 @vindex gnus-del-mark
4268 These are articles that the user has marked as read with the @kbd{d}
4269 command manually, more or less (@code{gnus-del-mark}).
4272 @vindex gnus-read-mark
4273 Articles that have actually been read (@code{gnus-read-mark}).
4276 @vindex gnus-ancient-mark
4277 Articles that were marked as read in previous sessions and are now
4278 @dfn{old} (@code{gnus-ancient-mark}).
4281 @vindex gnus-killed-mark
4282 Marked as killed (@code{gnus-killed-mark}).
4285 @vindex gnus-kill-file-mark
4286 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4289 @vindex gnus-low-score-mark
4290 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4293 @vindex gnus-catchup-mark
4294 Marked as read by a catchup (@code{gnus-catchup-mark}).
4297 @vindex gnus-canceled-mark
4298 Canceled article (@code{gnus-canceled-mark})
4301 @vindex gnus-souped-mark
4302 @sc{SOUP}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
4305 @vindex gnus-sparse-mark
4306 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
4310 @vindex gnus-duplicate-mark
4311 Article marked as read by duplicate suppression
4312 (@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}.
4316 All these marks just mean that the article is marked as read, really.
4317 They are interpreted differently when doing adaptive scoring, though.
4319 One more special mark, though:
4323 @vindex gnus-expirable-mark
4324 Marked as expirable (@code{gnus-expirable-mark}).
4326 Marking articles as @dfn{expirable} (or have them marked as such
4327 automatically) doesn't make much sense in normal groups---a user doesn't
4328 control expiring of news articles, but in mail groups, for instance,
4329 articles marked as @dfn{expirable} can be deleted by gnus at
4335 @subsection Other Marks
4336 @cindex process mark
4339 There are some marks that have nothing to do with whether the article is
4345 You can set a bookmark in the current article. Say you are reading a
4346 long thesis on cats' urinary tracts, and have to go home for dinner
4347 before you've finished reading the thesis. You can then set a bookmark
4348 in the article, and gnus will jump to this bookmark the next time it
4349 encounters the article. @xref{Setting Marks}.
4352 @vindex gnus-replied-mark
4353 All articles that you have replied to or made a followup to (i.e., have
4354 answered) will be marked with an @samp{A} in the second column
4355 (@code{gnus-replied-mark}).
4358 @vindex gnus-cached-mark
4359 Articles stored in the article cache will be marked with an @samp{*} in
4360 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
4363 @vindex gnus-saved-mark
4364 Articles ``saved'' (in some manner or other; not necessarily
4365 religiously) are marked with an @samp{S} in the second column
4366 (@code{gnus-saved-mark}).
4369 @vindex gnus-not-empty-thread-mark
4370 @vindex gnus-empty-thread-mark
4371 If the @samp{%e} spec is used, the presence of threads or not will be
4372 marked with @code{gnus-not-empty-thread-mark} and
4373 @code{gnus-empty-thread-mark} in the third column, respectively.
4376 @vindex gnus-process-mark
4377 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
4378 variety of commands react to the presence of the process mark. For
4379 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4380 all articles that have been marked with the process mark. Articles
4381 marked with the process mark have a @samp{#} in the second column.
4385 You might have noticed that most of these ``non-readedness'' marks
4386 appear in the second column by default. So if you have a cached, saved,
4387 replied article that you have process-marked, what will that look like?
4389 Nothing much. The precedence rules go as follows: process -> cache ->
4390 replied -> saved. So if the article is in the cache and is replied,
4391 you'll only see the cache mark and not the replied mark.
4395 @subsection Setting Marks
4396 @cindex setting marks
4398 All the marking commands understand the numeric prefix.
4403 @kindex M c (Summary)
4404 @kindex M-u (Summary)
4405 @findex gnus-summary-clear-mark-forward
4406 @cindex mark as unread
4407 Clear all readedness-marks from the current article
4408 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
4414 @kindex M t (Summary)
4415 @findex gnus-summary-tick-article-forward
4416 Tick the current article (@code{gnus-summary-tick-article-forward}).
4417 @xref{Article Caching}.
4422 @kindex M ? (Summary)
4423 @findex gnus-summary-mark-as-dormant
4424 Mark the current article as dormant
4425 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
4429 @kindex M d (Summary)
4431 @findex gnus-summary-mark-as-read-forward
4432 Mark the current article as read
4433 (@code{gnus-summary-mark-as-read-forward}).
4437 @findex gnus-summary-mark-as-read-backward
4438 Mark the current article as read and move point to the previous line
4439 (@code{gnus-summary-mark-as-read-backward}).
4444 @kindex M k (Summary)
4445 @findex gnus-summary-kill-same-subject-and-select
4446 Mark all articles that have the same subject as the current one as read,
4447 and then select the next unread article
4448 (@code{gnus-summary-kill-same-subject-and-select}).
4452 @kindex M K (Summary)
4453 @kindex C-k (Summary)
4454 @findex gnus-summary-kill-same-subject
4455 Mark all articles that have the same subject as the current one as read
4456 (@code{gnus-summary-kill-same-subject}).
4459 @kindex M C (Summary)
4460 @findex gnus-summary-catchup
4461 @c @icon{gnus-summary-catchup}
4462 Mark all unread articles as read (@code{gnus-summary-catchup}).
4465 @kindex M C-c (Summary)
4466 @findex gnus-summary-catchup-all
4467 Mark all articles in the group as read---even the ticked and dormant
4468 articles (@code{gnus-summary-catchup-all}).
4471 @kindex M H (Summary)
4472 @findex gnus-summary-catchup-to-here
4473 Catchup the current group to point
4474 (@code{gnus-summary-catchup-to-here}).
4477 @kindex C-w (Summary)
4478 @findex gnus-summary-mark-region-as-read
4479 Mark all articles between point and mark as read
4480 (@code{gnus-summary-mark-region-as-read}).
4483 @kindex M V k (Summary)
4484 @findex gnus-summary-kill-below
4485 Kill all articles with scores below the default score (or below the
4486 numeric prefix) (@code{gnus-summary-kill-below}).
4490 @kindex M e (Summary)
4492 @findex gnus-summary-mark-as-expirable
4493 Mark the current article as expirable
4494 (@code{gnus-summary-mark-as-expirable}).
4497 @kindex M b (Summary)
4498 @findex gnus-summary-set-bookmark
4499 Set a bookmark in the current article
4500 (@code{gnus-summary-set-bookmark}).
4503 @kindex M B (Summary)
4504 @findex gnus-summary-remove-bookmark
4505 Remove the bookmark from the current article
4506 (@code{gnus-summary-remove-bookmark}).
4509 @kindex M V c (Summary)
4510 @findex gnus-summary-clear-above
4511 Clear all marks from articles with scores over the default score (or
4512 over the numeric prefix) (@code{gnus-summary-clear-above}).
4515 @kindex M V u (Summary)
4516 @findex gnus-summary-tick-above
4517 Tick all articles with scores over the default score (or over the
4518 numeric prefix) (@code{gnus-summary-tick-above}).
4521 @kindex M V m (Summary)
4522 @findex gnus-summary-mark-above
4523 Prompt for a mark, and mark all articles with scores over the default
4524 score (or over the numeric prefix) with this mark
4525 (@code{gnus-summary-clear-above}).
4528 @vindex gnus-summary-goto-unread
4529 The @code{gnus-summary-goto-unread} variable controls what action should
4530 be taken after setting a mark. If non-@code{nil}, point will move to
4531 the next/previous unread article. If @code{nil}, point will just move
4532 one line up or down. As a special case, if this variable is
4533 @code{never}, all the marking commands as well as other commands (like
4534 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4535 The default is @code{t}.
4538 @node Generic Marking Commands
4539 @subsection Generic Marking Commands
4541 Some people would like the command that ticks an article (@kbd{!}) go to
4542 the next article. Others would like it to go to the next unread
4543 article. Yet others would like it to stay on the current article. And
4544 even though I haven't heard of anybody wanting it to go to the
4545 previous (unread) article, I'm sure there are people that want that as
4548 Multiply these five behaviours with five different marking commands, and
4549 you get a potentially complex set of variable to control what each
4552 To sidestep that mess, Gnus provides commands that do all these
4553 different things. They can be found on the @kbd{M M} map in the summary
4554 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
4555 to list in this manual.
4557 While you can use these commands directly, most users would prefer
4558 altering the summary mode keymap. For instance, if you would like the
4559 @kbd{!} command to go to the next article instead of the next unread
4560 article, you could say something like:
4563 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
4564 (defun my-alter-summary-map ()
4565 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
4571 (defun my-alter-summary-map ()
4572 (local-set-key "!" "MM!n"))
4576 @node Setting Process Marks
4577 @subsection Setting Process Marks
4578 @cindex setting process marks
4585 @kindex M P p (Summary)
4586 @findex gnus-summary-mark-as-processable
4587 Mark the current article with the process mark
4588 (@code{gnus-summary-mark-as-processable}).
4589 @findex gnus-summary-unmark-as-processable
4593 @kindex M P u (Summary)
4594 @kindex M-# (Summary)
4595 Remove the process mark, if any, from the current article
4596 (@code{gnus-summary-unmark-as-processable}).
4599 @kindex M P U (Summary)
4600 @findex gnus-summary-unmark-all-processable
4601 Remove the process mark from all articles
4602 (@code{gnus-summary-unmark-all-processable}).
4605 @kindex M P i (Summary)
4606 @findex gnus-uu-invert-processable
4607 Invert the list of process marked articles
4608 (@code{gnus-uu-invert-processable}).
4611 @kindex M P R (Summary)
4612 @findex gnus-uu-mark-by-regexp
4613 Mark articles that have a @code{Subject} header that matches a regular
4614 expression (@code{gnus-uu-mark-by-regexp}).
4617 @kindex M P r (Summary)
4618 @findex gnus-uu-mark-region
4619 Mark articles in region (@code{gnus-uu-mark-region}).
4622 @kindex M P t (Summary)
4623 @findex gnus-uu-mark-thread
4624 Mark all articles in the current (sub)thread
4625 (@code{gnus-uu-mark-thread}).
4628 @kindex M P T (Summary)
4629 @findex gnus-uu-unmark-thread
4630 Unmark all articles in the current (sub)thread
4631 (@code{gnus-uu-unmark-thread}).
4634 @kindex M P v (Summary)
4635 @findex gnus-uu-mark-over
4636 Mark all articles that have a score above the prefix argument
4637 (@code{gnus-uu-mark-over}).
4640 @kindex M P s (Summary)
4641 @findex gnus-uu-mark-series
4642 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4645 @kindex M P S (Summary)
4646 @findex gnus-uu-mark-sparse
4647 Mark all series that have already had some articles marked
4648 (@code{gnus-uu-mark-sparse}).
4651 @kindex M P a (Summary)
4652 @findex gnus-uu-mark-all
4653 Mark all articles in series order (@code{gnus-uu-mark-series}).
4656 @kindex M P b (Summary)
4657 @findex gnus-uu-mark-buffer
4658 Mark all articles in the buffer in the order they appear
4659 (@code{gnus-uu-mark-buffer}).
4662 @kindex M P k (Summary)
4663 @findex gnus-summary-kill-process-mark
4664 Push the current process mark set onto the stack and unmark all articles
4665 (@code{gnus-summary-kill-process-mark}).
4668 @kindex M P y (Summary)
4669 @findex gnus-summary-yank-process-mark
4670 Pop the previous process mark set from the stack and restore it
4671 (@code{gnus-summary-yank-process-mark}).
4674 @kindex M P w (Summary)
4675 @findex gnus-summary-save-process-mark
4676 Push the current process mark set onto the stack
4677 (@code{gnus-summary-save-process-mark}).
4686 It can be convenient to limit the summary buffer to just show some
4687 subset of the articles currently in the group. The effect most limit
4688 commands have is to remove a few (or many) articles from the summary
4691 All limiting commands work on subsets of the articles already fetched
4692 from the servers. None of these commands query the server for
4693 additional articles.
4699 @kindex / / (Summary)
4700 @findex gnus-summary-limit-to-subject
4701 Limit the summary buffer to articles that match some subject
4702 (@code{gnus-summary-limit-to-subject}).
4705 @kindex / a (Summary)
4706 @findex gnus-summary-limit-to-author
4707 Limit the summary buffer to articles that match some author
4708 (@code{gnus-summary-limit-to-author}).
4711 @kindex / x (Summary)
4712 @findex gnus-summary-limit-to-extra
4713 Limit the summary buffer to articles that match one of the ``extra''
4714 headers (@pxref{To From Newsgroups})
4715 (@code{gnus-summary-limit-to-author}).
4719 @kindex / u (Summary)
4721 @findex gnus-summary-limit-to-unread
4722 Limit the summary buffer to articles not marked as read
4723 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
4724 buffer to articles strictly unread. This means that ticked and
4725 dormant articles will also be excluded.
4728 @kindex / m (Summary)
4729 @findex gnus-summary-limit-to-marks
4730 Ask for a mark and then limit to all articles that have been marked
4731 with that mark (@code{gnus-summary-limit-to-marks}).
4734 @kindex / t (Summary)
4735 @findex gnus-summary-limit-to-age
4736 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4737 (@code{gnus-summary-limit-to-marks}). If given a prefix, limit to
4738 articles younger than that number of days.
4741 @kindex / n (Summary)
4742 @findex gnus-summary-limit-to-articles
4743 Limit the summary buffer to the current article
4744 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
4745 convention (@pxref{Process/Prefix}).
4748 @kindex / w (Summary)
4749 @findex gnus-summary-pop-limit
4750 Pop the previous limit off the stack and restore it
4751 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
4755 @kindex / v (Summary)
4756 @findex gnus-summary-limit-to-score
4757 Limit the summary buffer to articles that have a score at or above some
4758 score (@code{gnus-summary-limit-to-score}).
4762 @kindex M S (Summary)
4763 @kindex / E (Summary)
4764 @findex gnus-summary-limit-include-expunged
4765 Include all expunged articles in the limit
4766 (@code{gnus-summary-limit-include-expunged}).
4769 @kindex / D (Summary)
4770 @findex gnus-summary-limit-include-dormant
4771 Include all dormant articles in the limit
4772 (@code{gnus-summary-limit-include-dormant}).
4775 @kindex / * (Summary)
4776 @findex gnus-summary-limit-include-cached
4777 Include all cached articles in the limit
4778 (@code{gnus-summary-limit-include-cached}).
4781 @kindex / d (Summary)
4782 @findex gnus-summary-limit-exclude-dormant
4783 Exclude all dormant articles from the limit
4784 (@code{gnus-summary-limit-exclude-dormant}).
4787 @kindex / M (Summary)
4788 @findex gnus-summary-limit-exclude-marks
4789 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
4792 @kindex / T (Summary)
4793 @findex gnus-summary-limit-include-thread
4794 Include all the articles in the current thread in the limit.
4797 @kindex / c (Summary)
4798 @findex gnus-summary-limit-exclude-childless-dormant
4799 Exclude all dormant articles that have no children from the limit
4800 (@code{gnus-summary-limit-exclude-childless-dormant}).
4803 @kindex / C (Summary)
4804 @findex gnus-summary-limit-mark-excluded-as-read
4805 Mark all excluded unread articles as read
4806 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
4807 also mark excluded ticked and dormant articles as read.
4815 @cindex article threading
4817 Gnus threads articles by default. @dfn{To thread} is to put responses
4818 to articles directly after the articles they respond to---in a
4819 hierarchical fashion.
4821 Threading is done by looking at the @code{References} headers of the
4822 articles. In a perfect world, this would be enough to build pretty
4823 trees, but unfortunately, the @code{References} header is often broken
4824 or simply missing. Weird news propagation excarcerbates the problem,
4825 so one has to employ other heuristics to get pleasing results. A
4826 plethora of approaches exists, as detailed in horrible detail in
4827 @pxref{Customizing Threading}.
4829 First, a quick overview of the concepts:
4833 The top-most article in a thread; the first article in the thread.
4836 A tree-like article structure.
4839 A small(er) section of this tree-like structure.
4842 Threads often lose their roots due to article expiry, or due to the root
4843 already having been read in a previous session, and not displayed in the
4844 summary buffer. We then typically have many sub-threads that really
4845 belong to one thread, but are without connecting roots. These are
4846 called loose threads.
4848 @item thread gathering
4849 An attempt to gather loose threads into bigger threads.
4851 @item sparse threads
4852 A thread where the missing articles have been ``guessed'' at, and are
4853 displayed as empty lines in the summary buffer.
4859 * Customizing Threading:: Variables you can change to affect the threading.
4860 * Thread Commands:: Thread based commands in the summary buffer.
4864 @node Customizing Threading
4865 @subsection Customizing Threading
4866 @cindex customizing threading
4869 * Loose Threads:: How gnus gathers loose threads into bigger threads.
4870 * Filling In Threads:: Making the threads displayed look fuller.
4871 * More Threading:: Even more variables for fiddling with threads.
4872 * Low-Level Threading:: You thought it was over... but you were wrong!
4877 @subsubsection Loose Threads
4880 @cindex loose threads
4883 @item gnus-summary-make-false-root
4884 @vindex gnus-summary-make-false-root
4885 If non-@code{nil}, gnus will gather all loose subtrees into one big tree
4886 and create a dummy root at the top. (Wait a minute. Root at the top?
4887 Yup.) Loose subtrees occur when the real root has expired, or you've
4888 read or killed the root in a previous session.
4890 When there is no real root of a thread, gnus will have to fudge
4891 something. This variable says what fudging method gnus should use.
4892 There are four possible values:
4896 \gnusfigure{The Summary Buffer}{390}{
4897 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4898 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4899 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4900 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4905 @cindex adopting articles
4910 Gnus will make the first of the orphaned articles the parent. This
4911 parent will adopt all the other articles. The adopted articles will be
4912 marked as such by pointy brackets (@samp{<>}) instead of the standard
4913 square brackets (@samp{[]}). This is the default method.
4916 @vindex gnus-summary-dummy-line-format
4917 Gnus will create a dummy summary line that will pretend to be the
4918 parent. This dummy line does not correspond to any real article, so
4919 selecting it will just select the first real article after the dummy
4920 article. @code{gnus-summary-dummy-line-format} is used to specify the
4921 format of the dummy roots. It accepts only one format spec: @samp{S},
4922 which is the subject of the article. @xref{Formatting Variables}.
4925 Gnus won't actually make any article the parent, but simply leave the
4926 subject field of all orphans except the first empty. (Actually, it will
4927 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4931 Don't make any article parent at all. Just gather the threads and
4932 display them after one another.
4935 Don't gather loose threads.
4938 @item gnus-summary-gather-subject-limit
4939 @vindex gnus-summary-gather-subject-limit
4940 Loose threads are gathered by comparing subjects of articles. If this
4941 variable is @code{nil}, gnus requires an exact match between the
4942 subjects of the loose threads before gathering them into one big
4943 super-thread. This might be too strict a requirement, what with the
4944 presence of stupid newsreaders that chop off long subject lines. If
4945 you think so, set this variable to, say, 20 to require that only the
4946 first 20 characters of the subjects have to match. If you set this
4947 variable to a really low number, you'll find that gnus will gather
4948 everything in sight into one thread, which isn't very helpful.
4950 @cindex fuzzy article gathering
4951 If you set this variable to the special value @code{fuzzy}, gnus will
4952 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4955 @item gnus-simplify-subject-fuzzy-regexp
4956 @vindex gnus-simplify-subject-fuzzy-regexp
4957 This can either be a regular expression or list of regular expressions
4958 that match strings that will be removed from subjects if fuzzy subject
4959 simplification is used.
4961 @item gnus-simplify-ignored-prefixes
4962 @vindex gnus-simplify-ignored-prefixes
4963 If you set @code{gnus-summary-gather-subject-limit} to something as low
4964 as 10, you might consider setting this variable to something sensible:
4966 @c Written by Michael Ernst <mernst@cs.rice.edu>
4968 (setq gnus-simplify-ignored-prefixes
4974 "wanted" "followup" "summary\\( of\\)?"
4975 "help" "query" "problem" "question"
4976 "answer" "reference" "announce"
4977 "How can I" "How to" "Comparison of"
4982 (mapconcat 'identity
4983 '("for" "for reference" "with" "about")
4985 "\\)?\\]?:?[ \t]*"))
4988 All words that match this regexp will be removed before comparing two
4991 @item gnus-simplify-subject-functions
4992 @vindex gnus-simplify-subject-functions
4993 If non-@code{nil}, this variable overrides
4994 @code{gnus-summary-gather-subject-limit}. This variable should be a
4995 list of functions to apply to the @code{Subject} string iteratively to
4996 arrive at the simplified version of the string.
4998 Useful functions to put in this list include:
5001 @item gnus-simplify-subject-re
5002 @findex gnus-simplify-subject-re
5003 Strip the leading @samp{Re:}.
5005 @item gnus-simplify-subject-fuzzy
5006 @findex gnus-simplify-subject-fuzzy
5009 @item gnus-simplify-whitespace
5010 @findex gnus-simplify-whitespace
5011 Remove excessive whitespace.
5014 You may also write your own functions, of course.
5017 @item gnus-summary-gather-exclude-subject
5018 @vindex gnus-summary-gather-exclude-subject
5019 Since loose thread gathering is done on subjects only, that might lead
5020 to many false hits, especially with certain common subjects like
5021 @samp{} and @samp{(none)}. To make the situation slightly better,
5022 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
5023 what subjects should be excluded from the gathering process.@*
5024 The default is @samp{^ *$\\|^(none)$}.
5026 @item gnus-summary-thread-gathering-function
5027 @vindex gnus-summary-thread-gathering-function
5028 Gnus gathers threads by looking at @code{Subject} headers. This means
5029 that totally unrelated articles may end up in the same ``thread'', which
5030 is confusing. An alternate approach is to look at all the
5031 @code{Message-ID}s in all the @code{References} headers to find matches.
5032 This will ensure that no gathered threads ever include unrelated
5033 articles, but it also means that people who have posted with broken
5034 newsreaders won't be gathered properly. The choice is yours---plague or
5038 @item gnus-gather-threads-by-subject
5039 @findex gnus-gather-threads-by-subject
5040 This function is the default gathering function and looks at
5041 @code{Subject}s exclusively.
5043 @item gnus-gather-threads-by-references
5044 @findex gnus-gather-threads-by-references
5045 This function looks at @code{References} headers exclusively.
5048 If you want to test gathering by @code{References}, you could say
5052 (setq gnus-summary-thread-gathering-function
5053 'gnus-gather-threads-by-references)
5059 @node Filling In Threads
5060 @subsubsection Filling In Threads
5063 @item gnus-fetch-old-headers
5064 @vindex gnus-fetch-old-headers
5065 If non-@code{nil}, gnus will attempt to build old threads by fetching
5066 more old headers---headers to articles marked as read. If you
5067 would like to display as few summary lines as possible, but still
5068 connect as many loose threads as possible, you should set this variable
5069 to @code{some} or a number. If you set it to a number, no more than
5070 that number of extra old headers will be fetched. In either case,
5071 fetching old headers only works if the backend you are using carries
5072 overview files---this would normally be @code{nntp}, @code{nnspool} and
5073 @code{nnml}. Also remember that if the root of the thread has been
5074 expired by the server, there's not much gnus can do about that.
5076 This variable can also be set to @code{invisible}. This won't have any
5077 visible effects, but is useful if you use the @kbd{A T} command a lot
5078 (@pxref{Finding the Parent}).
5080 @item gnus-build-sparse-threads
5081 @vindex gnus-build-sparse-threads
5082 Fetching old headers can be slow. A low-rent similar effect can be
5083 gotten by setting this variable to @code{some}. Gnus will then look at
5084 the complete @code{References} headers of all articles and try to string
5085 together articles that belong in the same thread. This will leave
5086 @dfn{gaps} in the threading display where gnus guesses that an article
5087 is missing from the thread. (These gaps appear like normal summary
5088 lines. If you select a gap, gnus will try to fetch the article in
5089 question.) If this variable is @code{t}, gnus will display all these
5090 ``gaps'' without regard for whether they are useful for completing the
5091 thread or not. Finally, if this variable is @code{more}, gnus won't cut
5092 off sparse leaf nodes that don't lead anywhere. This variable is
5093 @code{nil} by default.
5098 @node More Threading
5099 @subsubsection More Threading
5102 @item gnus-show-threads
5103 @vindex gnus-show-threads
5104 If this variable is @code{nil}, no threading will be done, and all of
5105 the rest of the variables here will have no effect. Turning threading
5106 off will speed group selection up a bit, but it is sure to make reading
5107 slower and more awkward.
5109 @item gnus-thread-hide-subtree
5110 @vindex gnus-thread-hide-subtree
5111 If non-@code{nil}, all threads will be hidden when the summary buffer is
5114 @item gnus-thread-expunge-below
5115 @vindex gnus-thread-expunge-below
5116 All threads that have a total score (as defined by
5117 @code{gnus-thread-score-function}) less than this number will be
5118 expunged. This variable is @code{nil} by default, which means that no
5119 threads are expunged.
5121 @item gnus-thread-hide-killed
5122 @vindex gnus-thread-hide-killed
5123 if you kill a thread and this variable is non-@code{nil}, the subtree
5126 @item gnus-thread-ignore-subject
5127 @vindex gnus-thread-ignore-subject
5128 Sometimes somebody changes the subject in the middle of a thread. If
5129 this variable is non-@code{nil}, the subject change is ignored. If it
5130 is @code{nil}, which is the default, a change in the subject will result
5133 @item gnus-thread-indent-level
5134 @vindex gnus-thread-indent-level
5135 This is a number that says how much each sub-thread should be indented.
5138 @item gnus-sort-gathered-threads-function
5139 @vindex gnus-sort-gathered-threads-function
5140 Sometimes, particularly with mailing lists, the order in which mails
5141 arrive locally is not necessarily the same as the order in which they
5142 arrived on the mailing list. Consequently, when sorting sub-threads
5143 using the default @code{gnus-thread-sort-by-number}, responses can end
5144 up appearing before the article to which they are responding to. Setting
5145 this variable to an alternate value
5146 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
5147 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
5148 more logical sub-thread ordering in such instances.
5153 @node Low-Level Threading
5154 @subsubsection Low-Level Threading
5158 @item gnus-parse-headers-hook
5159 @vindex gnus-parse-headers-hook
5160 Hook run before parsing any headers. The default value is
5161 @code{(gnus-set-summary-default-charset)}, which sets up local value of
5162 @code{default-mime-charset} in summary buffer based on variable
5163 @code{gnus-newsgroup-default-charset-alist}.
5165 @item gnus-alter-header-function
5166 @vindex gnus-alter-header-function
5167 If non-@code{nil}, this function will be called to allow alteration of
5168 article header structures. The function is called with one parameter,
5169 the article header vector, which it may alter in any way. For instance,
5170 if you have a mail-to-news gateway which alters the @code{Message-ID}s
5171 in systematic ways (by adding prefixes and such), you can use this
5172 variable to un-scramble the @code{Message-ID}s so that they are more
5173 meaningful. Here's one example:
5176 (setq gnus-alter-header-function 'my-alter-message-id)
5178 (defun my-alter-message-id (header)
5179 (let ((id (mail-header-id header)))
5181 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
5183 (concat (match-string 1 id) "@@" (match-string 2 id))
5190 @node Thread Commands
5191 @subsection Thread Commands
5192 @cindex thread commands
5198 @kindex T k (Summary)
5199 @kindex M-C-k (Summary)
5200 @findex gnus-summary-kill-thread
5201 Mark all articles in the current (sub-)thread as read
5202 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
5203 remove all marks instead. If the prefix argument is negative, tick
5208 @kindex T l (Summary)
5209 @kindex M-C-l (Summary)
5210 @findex gnus-summary-lower-thread
5211 Lower the score of the current (sub-)thread
5212 (@code{gnus-summary-lower-thread}).
5215 @kindex T i (Summary)
5216 @findex gnus-summary-raise-thread
5217 Increase the score of the current (sub-)thread
5218 (@code{gnus-summary-raise-thread}).
5221 @kindex T # (Summary)
5222 @findex gnus-uu-mark-thread
5223 Set the process mark on the current (sub-)thread
5224 (@code{gnus-uu-mark-thread}).
5227 @kindex T M-# (Summary)
5228 @findex gnus-uu-unmark-thread
5229 Remove the process mark from the current (sub-)thread
5230 (@code{gnus-uu-unmark-thread}).
5233 @kindex T T (Summary)
5234 @findex gnus-summary-toggle-threads
5235 Toggle threading (@code{gnus-summary-toggle-threads}).
5238 @kindex T s (Summary)
5239 @findex gnus-summary-show-thread
5240 Expose the (sub-)thread hidden under the current article, if any
5241 (@code{gnus-summary-show-thread}).
5244 @kindex T h (Summary)
5245 @findex gnus-summary-hide-thread
5246 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5249 @kindex T S (Summary)
5250 @findex gnus-summary-show-all-threads
5251 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5254 @kindex T H (Summary)
5255 @findex gnus-summary-hide-all-threads
5256 Hide all threads (@code{gnus-summary-hide-all-threads}).
5259 @kindex T t (Summary)
5260 @findex gnus-summary-rethread-current
5261 Re-thread the current article's thread
5262 (@code{gnus-summary-rethread-current}). This works even when the
5263 summary buffer is otherwise unthreaded.
5266 @kindex T ^ (Summary)
5267 @findex gnus-summary-reparent-thread
5268 Make the current article the child of the marked (or previous) article
5269 (@code{gnus-summary-reparent-thread}).
5273 The following commands are thread movement commands. They all
5274 understand the numeric prefix.
5279 @kindex T n (Summary)
5280 @findex gnus-summary-next-thread
5281 Go to the next thread (@code{gnus-summary-next-thread}).
5284 @kindex T p (Summary)
5285 @findex gnus-summary-prev-thread
5286 Go to the previous thread (@code{gnus-summary-prev-thread}).
5289 @kindex T d (Summary)
5290 @findex gnus-summary-down-thread
5291 Descend the thread (@code{gnus-summary-down-thread}).
5294 @kindex T u (Summary)
5295 @findex gnus-summary-up-thread
5296 Ascend the thread (@code{gnus-summary-up-thread}).
5299 @kindex T o (Summary)
5300 @findex gnus-summary-top-thread
5301 Go to the top of the thread (@code{gnus-summary-top-thread}).
5304 @vindex gnus-thread-operation-ignore-subject
5305 If you ignore subject while threading, you'll naturally end up with
5306 threads that have several different subjects in them. If you then issue
5307 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5308 wish to kill the entire thread, but just those parts of the thread that
5309 have the same subject as the current article. If you like this idea,
5310 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
5311 is non-@code{nil} (which it is by default), subjects will be ignored
5312 when doing thread commands. If this variable is @code{nil}, articles in
5313 the same thread with different subjects will not be included in the
5314 operation in question. If this variable is @code{fuzzy}, only articles
5315 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5322 @findex gnus-thread-sort-by-total-score
5323 @findex gnus-thread-sort-by-date
5324 @findex gnus-thread-sort-by-score
5325 @findex gnus-thread-sort-by-subject
5326 @findex gnus-thread-sort-by-author
5327 @findex gnus-thread-sort-by-number
5328 @vindex gnus-thread-sort-functions
5329 If you are using a threaded summary display, you can sort the threads by
5330 setting @code{gnus-thread-sort-functions}, which can be either a single
5331 function, a list of functions, or a list containing functions and
5332 @code{(not some-function)} elements.
5334 By default, sorting is done on article numbers. Ready-made sorting
5335 predicate functions include @code{gnus-thread-sort-by-number},
5336 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5337 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5338 @code{gnus-thread-sort-by-total-score}.
5340 Each function takes two threads and returns non-@code{nil} if the first
5341 thread should be sorted before the other. Note that sorting really is
5342 normally done by looking only at the roots of each thread.
5344 If you use more than one function, the primary sort key should be the
5345 last function in the list. You should probably always include
5346 @code{gnus-thread-sort-by-number} in the list of sorting
5347 functions---preferably first. This will ensure that threads that are
5348 equal with respect to the other sort criteria will be displayed in
5349 ascending article order.
5351 If you would like to sort by reverse score, then by subject, and finally
5352 by number, you could do something like:
5355 (setq gnus-thread-sort-functions
5356 '(gnus-thread-sort-by-number
5357 gnus-thread-sort-by-subject
5358 (not gnus-thread-sort-by-total-score)))
5361 The threads that have highest score will be displayed first in the
5362 summary buffer. When threads have the same score, they will be sorted
5363 alphabetically. The threads that have the same score and the same
5364 subject will be sorted by number, which is (normally) the sequence in
5365 which the articles arrived.
5367 If you want to sort by score and then reverse arrival order, you could
5371 (setq gnus-thread-sort-functions
5373 (not (gnus-thread-sort-by-number t1 t2)))
5374 gnus-thread-sort-by-score))
5377 @vindex gnus-thread-score-function
5378 The function in the @code{gnus-thread-score-function} variable (default
5379 @code{+}) is used for calculating the total score of a thread. Useful
5380 functions might be @code{max}, @code{min}, or squared means, or whatever
5383 @findex gnus-article-sort-functions
5384 @findex gnus-article-sort-by-date
5385 @findex gnus-article-sort-by-score
5386 @findex gnus-article-sort-by-subject
5387 @findex gnus-article-sort-by-author
5388 @findex gnus-article-sort-by-number
5389 If you are using an unthreaded display for some strange reason or other,
5390 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5391 It is very similar to the @code{gnus-thread-sort-functions}, except that
5392 it uses slightly different functions for article comparison. Available
5393 sorting predicate functions are @code{gnus-article-sort-by-number},
5394 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5395 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5397 If you want to sort an unthreaded summary display by subject, you could
5401 (setq gnus-article-sort-functions
5402 '(gnus-article-sort-by-number
5403 gnus-article-sort-by-subject))
5408 @node Asynchronous Fetching
5409 @section Asynchronous Article Fetching
5410 @cindex asynchronous article fetching
5411 @cindex article pre-fetch
5414 If you read your news from an @sc{nntp} server that's far away, the
5415 network latencies may make reading articles a chore. You have to wait
5416 for a while after pressing @kbd{n} to go to the next article before the
5417 article appears. Why can't gnus just go ahead and fetch the article
5418 while you are reading the previous one? Why not, indeed.
5420 First, some caveats. There are some pitfalls to using asynchronous
5421 article fetching, especially the way gnus does it.
5423 Let's say you are reading article 1, which is short, and article 2 is
5424 quite long, and you are not interested in reading that. Gnus does not
5425 know this, so it goes ahead and fetches article 2. You decide to read
5426 article 3, but since gnus is in the process of fetching article 2, the
5427 connection is blocked.
5429 To avoid these situations, gnus will open two (count 'em two)
5430 connections to the server. Some people may think this isn't a very nice
5431 thing to do, but I don't see any real alternatives. Setting up that
5432 extra connection takes some time, so gnus startup will be slower.
5434 Gnus will fetch more articles than you will read. This will mean that
5435 the link between your machine and the @sc{nntp} server will become more
5436 loaded than if you didn't use article pre-fetch. The server itself will
5437 also become more loaded---both with the extra article requests, and the
5440 Ok, so now you know that you shouldn't really use this thing... unless
5443 @vindex gnus-asynchronous
5444 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
5445 happen automatically.
5447 @vindex gnus-use-article-prefetch
5448 You can control how many articles are to be pre-fetched by setting
5449 @code{gnus-use-article-prefetch}. This is 30 by default, which means
5450 that when you read an article in the group, the backend will pre-fetch
5451 the next 30 articles. If this variable is @code{t}, the backend will
5452 pre-fetch all the articles it can without bound. If it is
5453 @code{nil}, no pre-fetching will be done.
5455 @vindex gnus-async-prefetch-article-p
5456 @findex gnus-async-read-p
5457 There are probably some articles that you don't want to pre-fetch---read
5458 articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should
5459 return non-@code{nil} when the article in question is to be
5460 pre-fetched. The default is @code{gnus-async-read-p}, which returns
5461 @code{nil} on read articles. The function is called with an article
5462 data structure as the only parameter.
5464 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
5467 (defun my-async-short-unread-p (data)
5468 "Return non-nil for short, unread articles."
5469 (and (gnus-data-unread-p data)
5470 (< (mail-header-lines (gnus-data-header data))
5473 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5476 These functions will be called many, many times, so they should
5477 preferably be short and sweet to avoid slowing down gnus too much.
5478 It's probably a good idea to byte-compile things like this.
5480 @vindex gnus-prefetched-article-deletion-strategy
5481 Articles have to be removed from the asynch buffer sooner or later. The
5482 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5483 articles. This is a list that may contain the following elements:
5487 Remove articles when they are read.
5490 Remove articles when exiting the group.
5493 The default value is @code{(read exit)}.
5495 @c @vindex gnus-use-header-prefetch
5496 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5497 @c from the next group.
5500 @node Article Caching
5501 @section Article Caching
5502 @cindex article caching
5505 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5506 consider turning article caching on. Each article will then be stored
5507 locally under your home directory. As you may surmise, this could
5508 potentially use @emph{huge} amounts of disk space, as well as eat up all
5509 your inodes so fast it will make your head swim. In vodka.
5511 Used carefully, though, it could be just an easier way to save articles.
5513 @vindex gnus-use-long-file-name
5514 @vindex gnus-cache-directory
5515 @vindex gnus-use-cache
5516 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
5517 all articles ticked or marked as dormant will then be copied
5518 over to your local cache (@code{gnus-cache-directory}). Whether this
5519 cache is flat or hierarchal is controlled by the
5520 @code{gnus-use-long-file-name} variable, as usual.
5522 When re-selecting a ticked or dormant article, it will be fetched from the
5523 cache instead of from the server. As articles in your cache will never
5524 expire, this might serve as a method of saving articles while still
5525 keeping them where they belong. Just mark all articles you want to save
5526 as dormant, and don't worry.
5528 When an article is marked as read, is it removed from the cache.
5530 @vindex gnus-cache-remove-articles
5531 @vindex gnus-cache-enter-articles
5532 The entering/removal of articles from the cache is controlled by the
5533 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5534 variables. Both are lists of symbols. The first is @code{(ticked
5535 dormant)} by default, meaning that ticked and dormant articles will be
5536 put in the cache. The latter is @code{(read)} by default, meaning that
5537 articles marked as read are removed from the cache. Possibly
5538 symbols in these two lists are @code{ticked}, @code{dormant},
5539 @code{unread} and @code{read}.
5541 @findex gnus-jog-cache
5542 So where does the massive article-fetching and storing come into the
5543 picture? The @code{gnus-jog-cache} command will go through all
5544 subscribed newsgroups, request all unread articles, score them, and
5545 store them in the cache. You should only ever, ever ever ever, use this
5546 command if 1) your connection to the @sc{nntp} server is really, really,
5547 really slow and 2) you have a really, really, really huge disk.
5548 Seriously. One way to cut down on the number of articles downloaded is
5549 to score unwanted articles down and have them marked as read. They will
5550 not then be downloaded by this command.
5552 @vindex gnus-uncacheable-groups
5553 @vindex gnus-cacheable-groups
5554 It is likely that you do not want caching on all groups. For instance,
5555 if your @code{nnml} mail is located under your home directory, it makes no
5556 sense to cache it somewhere else under your home directory. Unless you
5557 feel that it's neat to use twice as much space.
5559 To limit the caching, you could set @code{gnus-cacheable-groups} to a
5560 regexp of groups to cache, @samp{^nntp} for instance, or set the
5561 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
5562 Both variables are @code{nil} by default. If a group matches both
5563 variables, the group is not cached.
5565 @findex gnus-cache-generate-nov-databases
5566 @findex gnus-cache-generate-active
5567 @vindex gnus-cache-active-file
5568 The cache stores information on what articles it contains in its active
5569 file (@code{gnus-cache-active-file}). If this file (or any other parts
5570 of the cache) becomes all messed up for some reason or other, gnus
5571 offers two functions that will try to set things right. @kbd{M-x
5572 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5573 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5577 @node Persistent Articles
5578 @section Persistent Articles
5579 @cindex persistent articles
5581 Closely related to article caching, we have @dfn{persistent articles}.
5582 In fact, it's just a different way of looking at caching, and much more
5583 useful in my opinion.
5585 Say you're reading a newsgroup, and you happen on to some valuable gem
5586 that you want to keep and treasure forever. You'd normally just save it
5587 (using one of the many saving commands) in some file. The problem with
5588 that is that it's just, well, yucky. Ideally you'd prefer just having
5589 the article remain in the group where you found it forever; untouched by
5590 the expiry going on at the news server.
5592 This is what a @dfn{persistent article} is---an article that just won't
5593 be deleted. It's implemented using the normal cache functions, but
5594 you use two explicit commands for managing persistent articles:
5600 @findex gnus-cache-enter-article
5601 Make the current article persistent (@code{gnus-cache-enter-article}).
5604 @kindex M-* (Summary)
5605 @findex gnus-cache-remove-article
5606 Remove the current article from the persistent articles
5607 (@code{gnus-cache-remove-article}). This will normally delete the
5611 Both these commands understand the process/prefix convention.
5613 To avoid having all ticked articles (and stuff) entered into the cache,
5614 you should set @code{gnus-use-cache} to @code{passive} if you're just
5615 interested in persistent articles:
5618 (setq gnus-use-cache 'passive)
5622 @node Article Backlog
5623 @section Article Backlog
5625 @cindex article backlog
5627 If you have a slow connection, but the idea of using caching seems
5628 unappealing to you (and it is, really), you can help the situation some
5629 by switching on the @dfn{backlog}. This is where gnus will buffer
5630 already read articles so that it doesn't have to re-fetch articles
5631 you've already read. This only helps if you are in the habit of
5632 re-selecting articles you've recently read, of course. If you never do
5633 that, turning the backlog on will slow gnus down a little bit, and
5634 increase memory usage some.
5636 @vindex gnus-keep-backlog
5637 If you set @code{gnus-keep-backlog} to a number @var{n}, gnus will store
5638 at most @var{n} old articles in a buffer for later re-fetching. If this
5639 variable is non-@code{nil} and is not a number, gnus will store
5640 @emph{all} read articles, which means that your Emacs will grow without
5641 bound before exploding and taking your machine down with you. I put
5642 that in there just to keep y'all on your toes.
5644 This variable is @code{nil} by default.
5647 @node Saving Articles
5648 @section Saving Articles
5649 @cindex saving articles
5651 Gnus can save articles in a number of ways. Below is the documentation
5652 for saving articles in a fairly straight-forward fashion (i.e., little
5653 processing of the article is done before it is saved). For a different
5654 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5655 (@pxref{Decoding Articles}).
5657 @vindex gnus-save-all-headers
5658 If @code{gnus-save-all-headers} is non-@code{nil}, gnus will not delete
5659 unwanted headers before saving the article.
5661 @vindex gnus-saved-headers
5662 If the preceding variable is @code{nil}, all headers that match the
5663 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5664 deleted before saving.
5670 @kindex O o (Summary)
5672 @findex gnus-summary-save-article
5673 @c @icon{gnus-summary-save-article}
5674 Save the current article using the default article saver
5675 (@code{gnus-summary-save-article}).
5678 @kindex O m (Summary)
5679 @findex gnus-summary-save-article-mail
5680 Save the current article in mail format
5681 (@code{gnus-summary-save-article-mail}).
5684 @kindex O r (Summary)
5685 @findex gnus-summary-save-article-rmail
5686 Save the current article in rmail format
5687 (@code{gnus-summary-save-article-rmail}).
5690 @kindex O f (Summary)
5691 @findex gnus-summary-save-article-file
5692 @c @icon{gnus-summary-save-article-file}
5693 Save the current article in plain file format
5694 (@code{gnus-summary-save-article-file}).
5697 @kindex O F (Summary)
5698 @findex gnus-summary-write-article-file
5699 Write the current article in plain file format, overwriting any previous
5700 file contents (@code{gnus-summary-write-article-file}).
5703 @kindex O b (Summary)
5704 @findex gnus-summary-save-article-body-file
5705 Save the current article body in plain file format
5706 (@code{gnus-summary-save-article-body-file}).
5709 @kindex O h (Summary)
5710 @findex gnus-summary-save-article-folder
5711 Save the current article in mh folder format
5712 (@code{gnus-summary-save-article-folder}).
5715 @kindex O v (Summary)
5716 @findex gnus-summary-save-article-vm
5717 Save the current article in a VM folder
5718 (@code{gnus-summary-save-article-vm}).
5721 @kindex O p (Summary)
5722 @findex gnus-summary-pipe-output
5723 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
5724 the current article to a process (@code{gnus-summary-pipe-output}).
5727 @vindex gnus-prompt-before-saving
5728 All these commands use the process/prefix convention
5729 (@pxref{Process/Prefix}). If you save bunches of articles using these
5730 functions, you might get tired of being prompted for files to save each
5731 and every article in. The prompting action is controlled by
5732 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5733 default, giving you that excessive prompting action you know and
5734 loathe. If you set this variable to @code{t} instead, you'll be prompted
5735 just once for each series of articles you save. If you like to really
5736 have Gnus do all your thinking for you, you can even set this variable
5737 to @code{nil}, which means that you will never be prompted for files to
5738 save articles in. Gnus will simply save all the articles in the default
5742 @vindex gnus-default-article-saver
5743 You can customize the @code{gnus-default-article-saver} variable to make
5744 gnus do what you want it to. You can use any of the four ready-made
5745 functions below, or you can create your own.
5749 @item gnus-summary-save-in-rmail
5750 @findex gnus-summary-save-in-rmail
5751 @vindex gnus-rmail-save-name
5752 @findex gnus-plain-save-name
5753 This is the default format, @dfn{babyl}. Uses the function in the
5754 @code{gnus-rmail-save-name} variable to get a file name to save the
5755 article in. The default is @code{gnus-plain-save-name}.
5757 @item gnus-summary-save-in-mail
5758 @findex gnus-summary-save-in-mail
5759 @vindex gnus-mail-save-name
5760 Save in a Unix mail (mbox) file. Uses the function in the
5761 @code{gnus-mail-save-name} variable to get a file name to save the
5762 article in. The default is @code{gnus-plain-save-name}.
5764 @item gnus-summary-save-in-file
5765 @findex gnus-summary-save-in-file
5766 @vindex gnus-file-save-name
5767 @findex gnus-numeric-save-name
5768 Append the article straight to an ordinary file. Uses the function in
5769 the @code{gnus-file-save-name} variable to get a file name to save the
5770 article in. The default is @code{gnus-numeric-save-name}.
5772 @item gnus-summary-save-body-in-file
5773 @findex gnus-summary-save-body-in-file
5774 Append the article body to an ordinary file. Uses the function in the
5775 @code{gnus-file-save-name} variable to get a file name to save the
5776 article in. The default is @code{gnus-numeric-save-name}.
5778 @item gnus-summary-save-in-folder
5779 @findex gnus-summary-save-in-folder
5780 @findex gnus-folder-save-name
5781 @findex gnus-Folder-save-name
5782 @vindex gnus-folder-save-name
5785 Save the article to an MH folder using @code{rcvstore} from the MH
5786 library. Uses the function in the @code{gnus-folder-save-name} variable
5787 to get a file name to save the article in. The default is
5788 @code{gnus-folder-save-name}, but you can also use
5789 @code{gnus-Folder-save-name}, which creates capitalized names.
5791 @item gnus-summary-save-in-vm
5792 @findex gnus-summary-save-in-vm
5793 Save the article in a VM folder. You have to have the VM mail
5794 reader to use this setting.
5797 @vindex gnus-article-save-directory
5798 All of these functions, except for the last one, will save the article
5799 in the @code{gnus-article-save-directory}, which is initialized from the
5800 @code{SAVEDIR} environment variable. This is @file{~/News/} by
5803 As you can see above, the functions use different functions to find a
5804 suitable name of a file to save the article in. Below is a list of
5805 available functions that generate names:
5809 @item gnus-Numeric-save-name
5810 @findex gnus-Numeric-save-name
5811 File names like @file{~/News/Alt.andrea-dworkin/45}.
5813 @item gnus-numeric-save-name
5814 @findex gnus-numeric-save-name
5815 File names like @file{~/News/alt.andrea-dworkin/45}.
5817 @item gnus-Plain-save-name
5818 @findex gnus-Plain-save-name
5819 File names like @file{~/News/Alt.andrea-dworkin}.
5821 @item gnus-plain-save-name
5822 @findex gnus-plain-save-name
5823 File names like @file{~/News/alt.andrea-dworkin}.
5826 @vindex gnus-split-methods
5827 You can have gnus suggest where to save articles by plonking a regexp into
5828 the @code{gnus-split-methods} alist. For instance, if you would like to
5829 save articles related to gnus in the file @file{gnus-stuff}, and articles
5830 related to VM in @code{vm-stuff}, you could set this variable to something
5834 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5835 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5836 (my-choosing-function "../other-dir/my-stuff")
5837 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5840 We see that this is a list where each element is a list that has two
5841 elements---the @dfn{match} and the @dfn{file}. The match can either be
5842 a string (in which case it is used as a regexp to match on the article
5843 head); it can be a symbol (which will be called as a function with the
5844 group name as a parameter); or it can be a list (which will be
5845 @code{eval}ed). If any of these actions have a non-@code{nil} result,
5846 the @dfn{file} will be used as a default prompt. In addition, the
5847 result of the operation itself will be used if the function or form
5848 called returns a string or a list of strings.
5850 You basically end up with a list of file names that might be used when
5851 saving the current article. (All ``matches'' will be used.) You will
5852 then be prompted for what you really want to use as a name, with file
5853 name completion over the results from applying this variable.
5855 This variable is @code{((gnus-article-archive-name))} by default, which
5856 means that gnus will look at the articles it saves for an
5857 @code{Archive-name} line and use that as a suggestion for the file
5860 Here's an example function to clean up file names somewhat. If you have
5861 lots of mail groups called things like
5862 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5863 these group names before creating the file name to save to. The
5864 following will do just that:
5867 (defun my-save-name (group)
5868 (when (string-match "^nnml:mail." group)
5869 (substring group (match-end 0))))
5871 (setq gnus-split-methods
5872 '((gnus-article-archive-name)
5877 @vindex gnus-use-long-file-name
5878 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
5879 @code{nil}, all the preceding functions will replace all periods
5880 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5881 the functions will generate hierarchies of directories instead of having
5882 all the files in the top level directory
5883 (@file{~/News/alt/andrea-dworkin} instead of
5884 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
5885 on most systems. However, for historical reasons, this is @code{nil} on
5886 Xenix and usg-unix-v machines by default.
5888 This function also affects kill and score file names. If this variable
5889 is a list, and the list contains the element @code{not-score}, long file
5890 names will not be used for score files, if it contains the element
5891 @code{not-save}, long file names will not be used for saving, and if it
5892 contains the element @code{not-kill}, long file names will not be used
5895 If you'd like to save articles in a hierarchy that looks something like
5899 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5900 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5903 Then just save with @kbd{o}. You'd then read this hierarchy with
5904 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5905 the top level directory as the argument (@file{~/News/}). Then just walk
5906 around to the groups/directories with @code{nneething}.
5909 @node Decoding Articles
5910 @section Decoding Articles
5911 @cindex decoding articles
5913 Sometime users post articles (or series of articles) that have been
5914 encoded in some way or other. Gnus can decode them for you.
5917 * Uuencoded Articles:: Uudecode articles.
5918 * Shell Archives:: Unshar articles.
5919 * PostScript Files:: Split PostScript.
5920 * Other Files:: Plain save and binhex.
5921 * Decoding Variables:: Variables for a happy decoding.
5922 * Viewing Files:: You want to look at the result of the decoding?
5926 @cindex article series
5927 All these functions use the process/prefix convention
5928 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5929 the extension that a ``single article'' means ``a single series''. Gnus
5930 can find out by itself what articles belong to a series, decode all the
5931 articles and unpack/view/save the resulting file(s).
5933 Gnus guesses what articles are in the series according to the following
5934 simplish rule: The subjects must be (nearly) identical, except for the
5935 last two numbers of the line. (Spaces are largely ignored, however.)
5937 For example: If you choose a subject called @samp{cat.gif (2/3)}, gnus
5938 will find all the articles that match the regexp @samp{^cat.gif
5939 ([0-9]+/[0-9]+).*$}.
5941 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5942 series}, will not be properly recognized by any of the automatic viewing
5943 commands, and you have to mark the articles manually with @kbd{#}.
5946 @node Uuencoded Articles
5947 @subsection Uuencoded Articles
5949 @cindex uuencoded articles
5954 @kindex X u (Summary)
5955 @findex gnus-uu-decode-uu
5956 @c @icon{gnus-uu-decode-uu}
5957 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5960 @kindex X U (Summary)
5961 @findex gnus-uu-decode-uu-and-save
5962 Uudecodes and saves the current series
5963 (@code{gnus-uu-decode-uu-and-save}).
5966 @kindex X v u (Summary)
5967 @findex gnus-uu-decode-uu-view
5968 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5971 @kindex X v U (Summary)
5972 @findex gnus-uu-decode-uu-and-save-view
5973 Uudecodes, views and saves the current series
5974 (@code{gnus-uu-decode-uu-and-save-view}).
5978 Remember that these all react to the presence of articles marked with
5979 the process mark. If, for instance, you'd like to decode and save an
5980 entire newsgroup, you'd typically do @kbd{M P a}
5981 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5982 (@code{gnus-uu-decode-uu-and-save}).
5984 All this is very much different from how @code{gnus-uu} worked with
5985 @sc{GNUS 4.1}, where you had explicit keystrokes for everything under
5986 the sun. This version of @code{gnus-uu} generally assumes that you mark
5987 articles in some way (@pxref{Setting Process Marks}) and then press
5990 @vindex gnus-uu-notify-files
5991 Note: When trying to decode articles that have names matching
5992 @code{gnus-uu-notify-files}, which is hard-coded to
5993 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5994 automatically post an article on @samp{comp.unix.wizards} saying that
5995 you have just viewed the file in question. This feature can't be turned
5999 @node Shell Archives
6000 @subsection Shell Archives
6002 @cindex shell archives
6003 @cindex shared articles
6005 Shell archives (``shar files'') used to be a popular way to distribute
6006 sources, but it isn't used all that much today. In any case, we have
6007 some commands to deal with these:
6012 @kindex X s (Summary)
6013 @findex gnus-uu-decode-unshar
6014 Unshars the current series (@code{gnus-uu-decode-unshar}).
6017 @kindex X S (Summary)
6018 @findex gnus-uu-decode-unshar-and-save
6019 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
6022 @kindex X v s (Summary)
6023 @findex gnus-uu-decode-unshar-view
6024 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
6027 @kindex X v S (Summary)
6028 @findex gnus-uu-decode-unshar-and-save-view
6029 Unshars, views and saves the current series
6030 (@code{gnus-uu-decode-unshar-and-save-view}).
6034 @node PostScript Files
6035 @subsection PostScript Files
6041 @kindex X p (Summary)
6042 @findex gnus-uu-decode-postscript
6043 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
6046 @kindex X P (Summary)
6047 @findex gnus-uu-decode-postscript-and-save
6048 Unpack and save the current PostScript series
6049 (@code{gnus-uu-decode-postscript-and-save}).
6052 @kindex X v p (Summary)
6053 @findex gnus-uu-decode-postscript-view
6054 View the current PostScript series
6055 (@code{gnus-uu-decode-postscript-view}).
6058 @kindex X v P (Summary)
6059 @findex gnus-uu-decode-postscript-and-save-view
6060 View and save the current PostScript series
6061 (@code{gnus-uu-decode-postscript-and-save-view}).
6066 @subsection Other Files
6070 @kindex X o (Summary)
6071 @findex gnus-uu-decode-save
6072 Save the current series
6073 (@code{gnus-uu-decode-save}).
6076 @kindex X b (Summary)
6077 @findex gnus-uu-decode-binhex
6078 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
6079 doesn't really work yet.
6083 @node Decoding Variables
6084 @subsection Decoding Variables
6086 Adjective, not verb.
6089 * Rule Variables:: Variables that say how a file is to be viewed.
6090 * Other Decode Variables:: Other decode variables.
6091 * Uuencoding and Posting:: Variables for customizing uuencoding.
6095 @node Rule Variables
6096 @subsubsection Rule Variables
6097 @cindex rule variables
6099 Gnus uses @dfn{rule variables} to decide how to view a file. All these
6100 variables are of the form
6103 (list '(regexp1 command2)
6110 @item gnus-uu-user-view-rules
6111 @vindex gnus-uu-user-view-rules
6113 This variable is consulted first when viewing files. If you wish to use,
6114 for instance, @code{sox} to convert an @samp{.au} sound file, you could
6117 (setq gnus-uu-user-view-rules
6118 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
6121 @item gnus-uu-user-view-rules-end
6122 @vindex gnus-uu-user-view-rules-end
6123 This variable is consulted if gnus couldn't make any matches from the
6124 user and default view rules.
6126 @item gnus-uu-user-archive-rules
6127 @vindex gnus-uu-user-archive-rules
6128 This variable can be used to say what commands should be used to unpack
6133 @node Other Decode Variables
6134 @subsubsection Other Decode Variables
6137 @vindex gnus-uu-grabbed-file-functions
6139 @item gnus-uu-grabbed-file-functions
6140 All functions in this list will be called right after each file has been
6141 successfully decoded---so that you can move or view files right away,
6142 and don't have to wait for all files to be decoded before you can do
6143 anything. Ready-made functions you can put in this list are:
6147 @item gnus-uu-grab-view
6148 @findex gnus-uu-grab-view
6151 @item gnus-uu-grab-move
6152 @findex gnus-uu-grab-move
6153 Move the file (if you're using a saving function.)
6156 @item gnus-uu-be-dangerous
6157 @vindex gnus-uu-be-dangerous
6158 Specifies what to do if unusual situations arise during decoding. If
6159 @code{nil}, be as conservative as possible. If @code{t}, ignore things
6160 that didn't work, and overwrite existing files. Otherwise, ask each
6163 @item gnus-uu-ignore-files-by-name
6164 @vindex gnus-uu-ignore-files-by-name
6165 Files with name matching this regular expression won't be viewed.
6167 @item gnus-uu-ignore-files-by-type
6168 @vindex gnus-uu-ignore-files-by-type
6169 Files with a @sc{mime} type matching this variable won't be viewed.
6170 Note that Gnus tries to guess what type the file is based on the name.
6171 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
6174 @item gnus-uu-tmp-dir
6175 @vindex gnus-uu-tmp-dir
6176 Where @code{gnus-uu} does its work.
6178 @item gnus-uu-do-not-unpack-archives
6179 @vindex gnus-uu-do-not-unpack-archives
6180 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
6181 looking for files to display.
6183 @item gnus-uu-view-and-save
6184 @vindex gnus-uu-view-and-save
6185 Non-@code{nil} means that the user will always be asked to save a file
6188 @item gnus-uu-ignore-default-view-rules
6189 @vindex gnus-uu-ignore-default-view-rules
6190 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
6193 @item gnus-uu-ignore-default-archive-rules
6194 @vindex gnus-uu-ignore-default-archive-rules
6195 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
6198 @item gnus-uu-kill-carriage-return
6199 @vindex gnus-uu-kill-carriage-return
6200 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
6203 @item gnus-uu-unmark-articles-not-decoded
6204 @vindex gnus-uu-unmark-articles-not-decoded
6205 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
6206 decoded articles as unread.
6208 @item gnus-uu-correct-stripped-uucode
6209 @vindex gnus-uu-correct-stripped-uucode
6210 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
6211 uuencoded files that have had trailing spaces deleted.
6213 @item gnus-uu-pre-uudecode-hook
6214 @vindex gnus-uu-pre-uudecode-hook
6215 Hook run before sending a message to @code{uudecode}.
6217 @item gnus-uu-view-with-metamail
6218 @vindex gnus-uu-view-with-metamail
6220 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6221 commands defined by the rule variables and just fudge a @sc{mime}
6222 content type based on the file name. The result will be fed to
6223 @code{metamail} for viewing.
6225 @item gnus-uu-save-in-digest
6226 @vindex gnus-uu-save-in-digest
6227 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6228 decoding, will save in digests. If this variable is @code{nil},
6229 @code{gnus-uu} will just save everything in a file without any
6230 embellishments. The digesting almost conforms to RFC1153---no easy way
6231 to specify any meaningful volume and issue numbers were found, so I
6232 simply dropped them.
6237 @node Uuencoding and Posting
6238 @subsubsection Uuencoding and Posting
6242 @item gnus-uu-post-include-before-composing
6243 @vindex gnus-uu-post-include-before-composing
6244 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6245 before you compose the article. If this variable is @code{t}, you can
6246 either include an encoded file with @kbd{C-c C-i} or have one included
6247 for you when you post the article.
6249 @item gnus-uu-post-length
6250 @vindex gnus-uu-post-length
6251 Maximum length of an article. The encoded file will be split into how
6252 many articles it takes to post the entire file.
6254 @item gnus-uu-post-threaded
6255 @vindex gnus-uu-post-threaded
6256 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6257 thread. This may not be smart, as no other decoder I have seen is able
6258 to follow threads when collecting uuencoded articles. (Well, I have
6259 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6260 think that counts...) Default is @code{nil}.
6262 @item gnus-uu-post-separate-description
6263 @vindex gnus-uu-post-separate-description
6264 Non-@code{nil} means that the description will be posted in a separate
6265 article. The first article will typically be numbered (0/x). If this
6266 variable is @code{nil}, the description the user enters will be included
6267 at the beginning of the first article, which will be numbered (1/x).
6268 Default is @code{t}.
6274 @subsection Viewing Files
6275 @cindex viewing files
6276 @cindex pseudo-articles
6278 After decoding, if the file is some sort of archive, gnus will attempt
6279 to unpack the archive and see if any of the files in the archive can be
6280 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
6281 containing the files @file{pic1.jpg} and @file{pic2.gif}, gnus will
6282 uncompress and de-tar the main file, and then view the two pictures.
6283 This unpacking process is recursive, so if the archive contains archives
6284 of archives, it'll all be unpacked.
6286 Finally, gnus will normally insert a @dfn{pseudo-article} for each
6287 extracted file into the summary buffer. If you go to these
6288 ``articles'', you will be prompted for a command to run (usually Gnus
6289 will make a suggestion), and then the command will be run.
6291 @vindex gnus-view-pseudo-asynchronously
6292 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6293 until the viewing is done before proceeding.
6295 @vindex gnus-view-pseudos
6296 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6297 the pseudo-articles into the summary buffer, but view them
6298 immediately. If this variable is @code{not-confirm}, the user won't even
6299 be asked for a confirmation before viewing is done.
6301 @vindex gnus-view-pseudos-separately
6302 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6303 pseudo-article will be created for each file to be viewed. If
6304 @code{nil}, all files that use the same viewing command will be given as
6305 a list of parameters to that command.
6307 @vindex gnus-insert-pseudo-articles
6308 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6309 pseudo-articles when decoding. It is @code{t} by default.
6311 So; there you are, reading your @emph{pseudo-articles} in your
6312 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6313 Why isn't anything real anymore? How did we get here?
6316 @node Article Treatment
6317 @section Article Treatment
6319 Reading through this huge manual, you may have quite forgotten that the
6320 object of newsreaders is to actually, like, read what people have
6321 written. Reading articles. Unfortunately, people are quite bad at
6322 writing, so there are tons of functions and variables to make reading
6323 these articles easier.
6326 * Article Highlighting:: You want to make the article look like fruit salad.
6327 * Article Fontisizing:: Making emphasized text look nice.
6328 * Article Hiding:: You also want to make certain info go away.
6329 * Article Washing:: Lots of way-neat functions to make life better.
6330 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
6331 * Article Date:: Grumble, UT!
6332 * Article Signature:: What is a signature?
6333 * Article Miscellania:: Various other stuff.
6337 @node Article Highlighting
6338 @subsection Article Highlighting
6339 @cindex highlighting
6341 Not only do you want your article buffer to look like fruit salad, but
6342 you want it to look like technicolor fruit salad.
6347 @kindex W H a (Summary)
6348 @findex gnus-article-highlight
6349 @findex gnus-article-maybe-highlight
6350 Do much highlighting of the current article
6351 (@code{gnus-article-highlight}). This function highlights header, cited
6352 text, the signature, and adds buttons to the body and the head.
6355 @kindex W H h (Summary)
6356 @findex gnus-article-highlight-headers
6357 @vindex gnus-header-face-alist
6358 Highlight the headers (@code{gnus-article-highlight-headers}). The
6359 highlighting will be done according to the @code{gnus-header-face-alist}
6360 variable, which is a list where each element has the form @var{(regexp
6361 name content)}. @var{regexp} is a regular expression for matching the
6362 header, @var{name} is the face used for highlighting the header name
6363 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6364 the header value. The first match made will be used. Note that
6365 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6368 @kindex W H c (Summary)
6369 @findex gnus-article-highlight-citation
6370 Highlight cited text (@code{gnus-article-highlight-citation}).
6372 Some variables to customize the citation highlights:
6375 @vindex gnus-cite-parse-max-size
6377 @item gnus-cite-parse-max-size
6378 If the article size if bigger than this variable (which is 25000 by
6379 default), no citation highlighting will be performed.
6381 @item gnus-cite-prefix-regexp
6382 @vindex gnus-cite-prefix-regexp
6383 Regexp matching the longest possible citation prefix on a line.
6385 @item gnus-cite-max-prefix
6386 @vindex gnus-cite-max-prefix
6387 Maximum possible length for a citation prefix (default 20).
6389 @item gnus-cite-face-list
6390 @vindex gnus-cite-face-list
6391 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6392 When there are citations from multiple articles in the same message,
6393 gnus will try to give each citation from each article its own face.
6394 This should make it easier to see who wrote what.
6396 @item gnus-supercite-regexp
6397 @vindex gnus-supercite-regexp
6398 Regexp matching normal Supercite attribution lines.
6400 @item gnus-supercite-secondary-regexp
6401 @vindex gnus-supercite-secondary-regexp
6402 Regexp matching mangled Supercite attribution lines.
6404 @item gnus-cite-minimum-match-count
6405 @vindex gnus-cite-minimum-match-count
6406 Minimum number of identical prefixes we have to see before we believe
6407 that it's a citation.
6409 @item gnus-cite-attribution-prefix
6410 @vindex gnus-cite-attribution-prefix
6411 Regexp matching the beginning of an attribution line.
6413 @item gnus-cite-attribution-suffix
6414 @vindex gnus-cite-attribution-suffix
6415 Regexp matching the end of an attribution line.
6417 @item gnus-cite-attribution-face
6418 @vindex gnus-cite-attribution-face
6419 Face used for attribution lines. It is merged with the face for the
6420 cited text belonging to the attribution.
6426 @kindex W H s (Summary)
6427 @vindex gnus-signature-separator
6428 @vindex gnus-signature-face
6429 @findex gnus-article-highlight-signature
6430 Highlight the signature (@code{gnus-article-highlight-signature}).
6431 Everything after @code{gnus-signature-separator} (@pxref{Article
6432 Signature}) in an article will be considered a signature and will be
6433 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6438 @xref{Customizing Articles}, for how to highlight articles automatically.
6441 @node Article Fontisizing
6442 @subsection Article Fontisizing
6444 @cindex article emphasis
6446 @findex gnus-article-emphasize
6447 @kindex W e (Summary)
6448 People commonly add emphasis to words in news articles by writing things
6449 like @samp{_this_} or @samp{*this*}. Gnus can make this look nicer by
6450 running the article through the @kbd{W e}
6451 (@code{gnus-article-emphasize}) command.
6453 @vindex gnus-emphasis-alist
6454 How the emphasis is computed is controlled by the
6455 @code{gnus-emphasis-alist} variable. This is an alist where the first
6456 element is a regular expression to be matched. The second is a number
6457 that says what regular expression grouping is used to find the entire
6458 emphasized word. The third is a number that says what regexp grouping
6459 should be displayed and highlighted. (The text between these two
6460 groupings will be hidden.) The fourth is the face used for
6464 (setq gnus-article-emphasis
6465 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6466 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6469 @vindex gnus-emphasis-underline
6470 @vindex gnus-emphasis-bold
6471 @vindex gnus-emphasis-italic
6472 @vindex gnus-emphasis-underline-bold
6473 @vindex gnus-emphasis-underline-italic
6474 @vindex gnus-emphasis-bold-italic
6475 @vindex gnus-emphasis-underline-bold-italic
6476 By default, there are seven rules, and they use the following faces:
6477 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6478 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6479 @code{gnus-emphasis-underline-italic},
6480 @code{gnus-emphasis-underline-bold}, and
6481 @code{gnus-emphasis-underline-bold-italic}.
6483 If you want to change these faces, you can either use @kbd{M-x
6484 customize}, or you can use @code{copy-face}. For instance, if you want
6485 to make @code{gnus-emphasis-italic} use a red face instead, you could
6489 (copy-face 'red 'gnus-emphasis-italic)
6492 @vindex gnus-group-highlight-words-alist
6494 If you want to highlight arbitrary words, you can use the
6495 @code{gnus-group-highlight-words-alist} variable, which uses the same
6496 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
6497 parameter (@pxref{Group Parameters}) can also be used.
6499 @xref{Customizing Articles}, for how to fontize articles automatically.
6502 @node Article Hiding
6503 @subsection Article Hiding
6504 @cindex article hiding
6506 Or rather, hiding certain things in each article. There usually is much
6507 too much cruft in most articles.
6512 @kindex W W a (Summary)
6513 @findex gnus-article-hide
6514 Do quite a lot of hiding on the article buffer
6515 (@kbd{gnus-article-hide}). In particular, this function will hide
6516 headers, PGP, cited text and the signature.
6519 @kindex W W h (Summary)
6520 @findex gnus-article-toggle-headers
6521 Toggle hiding of headers (@code{gnus-article-toggle-headers}). @xref{Hiding
6525 @kindex W W b (Summary)
6526 @findex gnus-article-hide-boring-headers
6527 Hide headers that aren't particularly interesting
6528 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
6531 @kindex W W s (Summary)
6532 @findex gnus-article-hide-signature
6533 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
6537 @kindex W W l (Summary)
6538 @findex gnus-article-hide-list-identifiers
6539 @vindex gnus-list-identifiers
6540 Hide list identifiers specified in @code{gnus-list-identifiers}. Theese
6541 are strings some list servers add to the beginning of all @code{Subject}
6542 headers---for example, @samp{[zebra 4711]}.
6546 @item gnus-list-identifiers
6547 @vindex gnus-list-identifiers
6548 A regular expression that matches list identifiers to be removed from
6549 subject. This can also be a list of regular expressions.
6554 @kindex W W p (Summary)
6555 @findex gnus-article-hide-pgp
6556 @vindex gnus-article-hide-pgp-hook
6557 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). The
6558 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6559 signature has been hidden. For example, to automatically verify
6560 articles that have signatures in them do:
6562 ;;; Hide pgp cruft if any.
6564 (setq gnus-treat-strip-pgp t)
6566 ;;; After hiding pgp, verify the message;
6567 ;;; only happens if pgp signature is found.
6569 (add-hook 'gnus-article-hide-pgp-hook
6572 (set-buffer gnus-original-article-buffer)
6577 @kindex W W P (Summary)
6578 @findex gnus-article-hide-pem
6579 Hide @sc{pem} (privacy enhanced messages) cruft
6580 (@code{gnus-article-hide-pem}).
6583 @kindex W W B (Summary)
6584 @findex gnus-article-strip-banner
6585 Strip the banner specified by the @code{banner} group parameter
6586 (@code{gnus-article-strip-banner}). This is mainly used to hide those
6587 annoying banners and/or signatures that some mailing lists and moderated
6588 groups adds to all the messages. The way to use this function is to add
6589 the @code{banner} group parameter (@pxref{Group Parameters}) to the
6590 group you want banners stripped from. The parameter either be a string,
6591 which will be interpreted as a regular expression matching text to be
6592 removed, or the symbol @code{signature}, meaning that the (last)
6593 signature should be removed.
6596 @kindex W W c (Summary)
6597 @findex gnus-article-hide-citation
6598 Hide citation (@code{gnus-article-hide-citation}). Some variables for
6599 customizing the hiding:
6603 @item gnus-cited-opened-text-button-line-format
6604 @itemx gnus-cited-closed-text-button-line-format
6605 @vindex gnus-cited-closed-text-button-line-format
6606 @vindex gnus-cited-opened-text-button-line-format
6607 Gnus adds buttons to show where the cited text has been hidden, and to
6608 allow toggle hiding the text. The format of the variable is specified
6609 by these format-like variable (@pxref{Formatting Variables}). These
6614 Starting point of the hidden text.
6616 Ending point of the hidden text.
6618 Number of characters in the hidden region.
6620 Number of lines of hidden text.
6623 @item gnus-cited-lines-visible
6624 @vindex gnus-cited-lines-visible
6625 The number of lines at the beginning of the cited text to leave shown.
6630 @kindex W W C-c (Summary)
6631 @findex gnus-article-hide-citation-maybe
6633 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
6634 following two variables:
6637 @item gnus-cite-hide-percentage
6638 @vindex gnus-cite-hide-percentage
6639 If the cited text is of a bigger percentage than this variable (default
6640 50), hide the cited text.
6642 @item gnus-cite-hide-absolute
6643 @vindex gnus-cite-hide-absolute
6644 The cited text must have at least this length (default 10) before it
6649 @kindex W W C (Summary)
6650 @findex gnus-article-hide-citation-in-followups
6651 Hide cited text in articles that aren't roots
6652 (@code{gnus-article-hide-citation-in-followups}). This isn't very
6653 useful as an interactive command, but might be a handy function to stick
6654 have happen automatically (@pxref{Customizing Articles}).
6658 All these ``hiding'' commands are toggles, but if you give a negative
6659 prefix to these commands, they will show what they have previously
6660 hidden. If you give a positive prefix, they will always hide.
6662 Also @pxref{Article Highlighting} for further variables for
6663 citation customization.
6665 @xref{Customizing Articles}, for how to hide article elements
6669 @node Article Washing
6670 @subsection Article Washing
6672 @cindex article washing
6674 We call this ``article washing'' for a really good reason. Namely, the
6675 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6677 @dfn{Washing} is defined by us as ``changing something from something to
6678 something else'', but normally results in something looking better.
6684 @kindex W l (Summary)
6685 @findex gnus-summary-stop-page-breaking
6686 Remove page breaks from the current article
6687 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
6691 @kindex W r (Summary)
6692 @findex gnus-summary-caesar-message
6693 @c @icon{gnus-summary-caesar-message}
6694 Do a Caesar rotate (rot13) on the article buffer
6695 (@code{gnus-summary-caesar-message}).
6696 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6697 (Typically offensive jokes and such.)
6699 It's commonly called ``rot13'' because each letter is rotated 13
6700 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6701 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
6702 is rumored to have employed this form of, uh, somewhat weak encryption.
6705 @kindex W t (Summary)
6706 @findex gnus-summary-toggle-header
6707 Toggle whether to display all headers in the article buffer
6708 (@code{gnus-summary-toggle-header}).
6711 @kindex W v (Summary)
6712 @findex gnus-summary-verbose-header
6713 Toggle whether to display all headers in the article buffer permanently
6714 (@code{gnus-summary-verbose-header}).
6717 @kindex W m (Summary)
6718 @findex gnus-summary-toggle-mime
6719 Toggle whether to run the article through @sc{mime} before displaying
6720 (@code{gnus-summary-toggle-mime}).
6723 @kindex W o (Summary)
6724 @findex gnus-article-treat-overstrike
6725 Treat overstrike (@code{gnus-article-treat-overstrike}).
6728 @kindex W d (Summary)
6729 @findex gnus-article-treat-dumbquotes
6730 @vindex gnus-article-dumbquotes-map
6732 @cindex M******** sm*rtq**t*s
6734 Treat M******** sm*rtq**t*s according to
6735 @code{gnus-article-dumbquotes-map}
6736 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
6737 whether a character is a sm*rtq**t* or not, so it should only be used
6741 @kindex W w (Summary)
6742 @findex gnus-article-fill-cited-article
6743 Do word wrap (@code{gnus-article-fill-cited-article}).
6745 You can give the command a numerical prefix to specify the width to use
6749 @kindex W q (Summary)
6750 @findex gnus-article-fill-long-lines
6751 Fill long lines (@code{gnus-article-fill-long-lines}).
6754 @kindex W C (Summary)
6755 @findex gnus-article-capitalize-sentences
6756 Capitalize the first word in each sentence
6757 (@code{gnus-article-capitalize-sentences}).
6760 @kindex W c (Summary)
6761 @findex gnus-article-remove-cr
6762 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
6763 (this takes care of DOS line endings), and then translate any remaining
6764 CRs into LF (this takes care of Mac line endings)
6765 (@code{gnus-article-remove-cr}).
6768 @kindex W f (Summary)
6770 @findex gnus-article-display-x-face
6771 @findex gnus-article-x-face-command
6772 @vindex gnus-article-x-face-command
6773 @vindex gnus-article-x-face-too-ugly
6779 Look for and display any X-Face headers
6780 (@code{gnus-article-display-x-face}). The command executed by this
6781 function is given by the @code{gnus-article-x-face-command} variable.
6782 If this variable is a string, this string will be executed in a
6783 sub-shell. If it is a function, this function will be called with the
6784 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
6785 is a regexp) matches the @code{From} header, the face will not be shown.
6786 The default action under Emacs is to fork off an @code{xv} to view the
6787 face; under XEmacs the default action is to display the face before the
6788 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
6789 support---that will make display somewhat faster. If there's no native
6790 X-Face support, Gnus will try to convert the @code{X-Face} header using
6791 external programs from the @code{pbmplus} package and friends.) If you
6792 want to have this function in the display hook, it should probably come
6796 @kindex W b (Summary)
6797 @findex gnus-article-add-buttons
6798 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6799 @xref{Article Buttons}.
6802 @kindex W B (Summary)
6803 @findex gnus-article-add-buttons-to-head
6804 Add clickable buttons to the article headers
6805 (@code{gnus-article-add-buttons-to-head}).
6808 @kindex W W H (Summary)
6809 @findex gnus-article-strip-headers-from-body
6810 Strip headers like the @code{X-No-Archive} header from the beginning of
6811 article bodies (@code{gnus-article-strip-headers-from-body}).
6814 @kindex W E l (Summary)
6815 @findex gnus-article-strip-leading-blank-lines
6816 Remove all blank lines from the beginning of the article
6817 (@code{gnus-article-strip-leading-blank-lines}).
6820 @kindex W E m (Summary)
6821 @findex gnus-article-strip-multiple-blank-lines
6822 Replace all blank lines with empty lines and then all multiple empty
6823 lines with a single empty line.
6824 (@code{gnus-article-strip-multiple-blank-lines}).
6827 @kindex W E t (Summary)
6828 @findex gnus-article-remove-trailing-blank-lines
6829 Remove all blank lines at the end of the article
6830 (@code{gnus-article-remove-trailing-blank-lines}).
6833 @kindex W E a (Summary)
6834 @findex gnus-article-strip-blank-lines
6835 Do all the three commands above
6836 (@code{gnus-article-strip-blank-lines}).
6839 @kindex W E A (Summary)
6840 @findex gnus-article-strip-all-blank-lines
6841 Remove all blank lines
6842 (@code{gnus-article-strip-all-blank-lines}).
6845 @kindex W E s (Summary)
6846 @findex gnus-article-strip-leading-space
6847 Remove all white space from the beginning of all lines of the article
6848 body (@code{gnus-article-strip-leading-space}).
6851 @kindex W E e (Summary)
6852 @findex gnus-article-strip-trailing-space
6853 Remove all white space from the end of all lines of the article
6854 body (@code{gnus-article-strip-trailing-space}).
6858 @xref{Customizing Articles}, for how to wash articles automatically.
6861 @node Article Buttons
6862 @subsection Article Buttons
6865 People often include references to other stuff in articles, and it would
6866 be nice if Gnus could just fetch whatever it is that people talk about
6867 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6868 button on these references.
6870 Gnus adds @dfn{buttons} to certain standard references by default:
6871 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
6872 two variables, one that handles article bodies and one that handles
6877 @item gnus-button-alist
6878 @vindex gnus-button-alist
6879 This is an alist where each entry has this form:
6882 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6888 All text that match this regular expression will be considered an
6889 external reference. Here's a typical regexp that matches embedded URLs:
6890 @samp{<URL:\\([^\n\r>]*\\)>}.
6893 Gnus has to know which parts of the matches is to be highlighted. This
6894 is a number that says what sub-expression of the regexp is to be
6895 highlighted. If you want it all highlighted, you use 0 here.
6898 This form will be @code{eval}ed, and if the result is non-@code{nil},
6899 this is considered a match. This is useful if you want extra sifting to
6900 avoid false matches.
6903 This function will be called when you click on this button.
6906 As with @var{button-par}, this is a sub-expression number, but this one
6907 says which part of the match is to be sent as data to @var{function}.
6911 So the full entry for buttonizing URLs is then
6914 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6917 @item gnus-header-button-alist
6918 @vindex gnus-header-button-alist
6919 This is just like the other alist, except that it is applied to the
6920 article head only, and that each entry has an additional element that is
6921 used to say what headers to apply the buttonize coding to:
6924 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6927 @var{HEADER} is a regular expression.
6929 @item gnus-button-url-regexp
6930 @vindex gnus-button-url-regexp
6931 A regular expression that matches embedded URLs. It is used in the
6932 default values of the variables above.
6934 @item gnus-article-button-face
6935 @vindex gnus-article-button-face
6936 Face used on buttons.
6938 @item gnus-article-mouse-face
6939 @vindex gnus-article-mouse-face
6940 Face used when the mouse cursor is over a button.
6944 @xref{Customizing Articles}, for how to buttonize articles automatically.
6948 @subsection Article Date
6950 The date is most likely generated in some obscure timezone you've never
6951 heard of, so it's quite nice to be able to find out what the time was
6952 when the article was sent.
6957 @kindex W T u (Summary)
6958 @findex gnus-article-date-ut
6959 Display the date in UT (aka. GMT, aka ZULU)
6960 (@code{gnus-article-date-ut}).
6963 @kindex W T i (Summary)
6964 @findex gnus-article-date-iso8601
6966 Display the date in international format, aka. ISO 8601
6967 (@code{gnus-article-date-iso8601}).
6970 @kindex W T l (Summary)
6971 @findex gnus-article-date-local
6972 Display the date in the local timezone (@code{gnus-article-date-local}).
6975 @kindex W T s (Summary)
6976 @vindex gnus-article-time-format
6977 @findex gnus-article-date-user
6978 @findex format-time-string
6979 Display the date using a user-defined format
6980 (@code{gnus-article-date-user}). The format is specified by the
6981 @code{gnus-article-time-format} variable, and is a string that's passed
6982 to @code{format-time-string}. See the documentation of that variable
6983 for a list of possible format specs.
6986 @kindex W T e (Summary)
6987 @findex gnus-article-date-lapsed
6988 @findex gnus-start-date-timer
6989 @findex gnus-stop-date-timer
6990 Say how much time has elapsed between the article was posted and now
6991 (@code{gnus-article-date-lapsed}). It looks something like:
6994 X-Sent: 9 years, 6 weeks, 4 days, 9 hours, 3 minutes, 28 seconds ago
6997 The value of @code{gnus-article-date-lapsed-new-header} determines
6998 whether this header will just be added below the old Date one, or will
7001 An advantage of using Gnus to read mail is that it converts simple bugs
7002 into wonderful absurdities.
7004 If you want to have this line updated continually, you can put
7007 (gnus-start-date-timer)
7010 in your @file{.gnus.el} file, or you can run it off of some hook. If
7011 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
7015 @kindex W T o (Summary)
7016 @findex gnus-article-date-original
7017 Display the original date (@code{gnus-article-date-original}). This can
7018 be useful if you normally use some other conversion function and are
7019 worried that it might be doing something totally wrong. Say, claiming
7020 that the article was posted in 1854. Although something like that is
7021 @emph{totally} impossible. Don't you trust me? *titter*
7025 @xref{Customizing Articles}, for how to display the date in your
7026 preferred format automatically.
7029 @node Article Signature
7030 @subsection Article Signature
7032 @cindex article signature
7034 @vindex gnus-signature-separator
7035 Each article is divided into two parts---the head and the body. The
7036 body can be divided into a signature part and a text part. The variable
7037 that says what is to be considered a signature is
7038 @code{gnus-signature-separator}. This is normally the standard
7039 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
7040 non-standard signature separators, so this variable can also be a list
7041 of regular expressions to be tested, one by one. (Searches are done
7042 from the end of the body towards the beginning.) One likely value is:
7045 (setq gnus-signature-separator
7046 '("^-- $" ; The standard
7047 "^-- *$" ; A common mangling
7048 "^-------*$" ; Many people just use a looong
7049 ; line of dashes. Shame!
7050 "^ *--------*$" ; Double-shame!
7051 "^________*$" ; Underscores are also popular
7052 "^========*$")) ; Pervert!
7055 The more permissive you are, the more likely it is that you'll get false
7058 @vindex gnus-signature-limit
7059 @code{gnus-signature-limit} provides a limit to what is considered a
7060 signature when displaying articles.
7064 If it is an integer, no signature may be longer (in characters) than
7067 If it is a floating point number, no signature may be longer (in lines)
7070 If it is a function, the function will be called without any parameters,
7071 and if it returns @code{nil}, there is no signature in the buffer.
7073 If it is a string, it will be used as a regexp. If it matches, the text
7074 in question is not a signature.
7077 This variable can also be a list where the elements may be of the types
7078 listed above. Here's an example:
7081 (setq gnus-signature-limit
7082 '(200.0 "^---*Forwarded article"))
7085 This means that if there are more than 200 lines after the signature
7086 separator, or the text after the signature separator is matched by
7087 the regular expression @samp{^---*Forwarded article}, then it isn't a
7088 signature after all.
7091 @node Article Miscellania
7092 @subsection Article Miscellania
7096 @kindex A t (Summary)
7097 @findex gnus-article-babel
7098 Translate the article from one language to another
7099 (@code{gnus-article-babel}).
7105 @section @sc{mime} Commands
7106 @cindex MIME decoding
7110 @kindex X m (Summary)
7111 @findex gnus-summary-save-parts
7112 Save all parts matching a @sc{mime} type to a directory
7113 (@code{gnus-summary-save-parts}). Understands the process/prefix
7114 convention (@pxref{Process/Prefix}).
7117 @kindex M-t (Summary)
7118 @findex gnus-summary-display-buttonized
7119 Toggle the buttonized display of the article buffer
7120 (@code{gnus-summary-toggle-display-buttonized}).
7123 @kindex W M w (Summary)
7124 Decode RFC2047-encoded words in the article headers
7125 (@code{gnus-article-decode-mime-words}).
7128 @kindex W M c (Summary)
7129 Decode encoded article bodies as well as charsets
7130 (@code{gnus-article-decode-charset}).
7132 This command looks in the @code{Content-Type} header to determine the
7133 charset. If there is no such header in the article, you can give it a
7134 prefix, which will prompt for the charset to decode as. In regional
7135 groups where people post using some common encoding (but do not include
7136 MIME headers), you can set the @code{charset} group/topic parameter to
7137 the required charset (@pxref{Group Parameters}).
7140 @kindex W M v (Summary)
7141 View all the @sc{mime} parts in the current article
7142 (@code{gnus-mime-view-all-parts}).
7149 @item gnus-ignored-mime-types
7150 @vindex gnus-ignored-mime-types
7151 This is a list of regexps. @sc{mime} types that match a regexp from
7152 this list will be completely ignored by Gnus. The default value is
7155 To have all Vcards be ignored, you'd say something like this:
7158 (setq gnus-ignored-mime-types
7162 @item gnus-unbuttonized-mime-types
7163 @vindex gnus-unbuttonized-mime-types
7164 This is a list of regexps. @sc{mime} types that match a regexp from
7165 this list won't have @sc{mime} buttons inserted unless they aren't
7166 displayed. The default value is @code{(".*/.*")}.
7168 @item gnus-article-mime-part-function
7169 @vindex gnus-article-mime-part-function
7170 For each @sc{mime} part, this function will be called with the @sc{mime}
7171 handle as the parameter. The function is meant to be used to allow
7172 users to gather information from the article (e. g., add Vcard info to
7173 the bbdb database) or to do actions based on parts (e. g., automatically
7174 save all jpegs into some directory).
7176 Here's an example function the does the latter:
7179 (defun my-save-all-jpeg-parts (handle)
7180 (when (equal (car (mm-handle-type handle)) "image/jpeg")
7182 (insert (mm-get-part handle))
7183 (write-region (point-min) (point-max)
7184 (read-file-name "Save jpeg to: ")))))
7185 (setq gnus-article-mime-part-function
7186 'my-save-all-jpeg-parts)
7189 @vindex gnus-mime-multipart-functions
7190 @item gnus-mime-multipart-functions
7191 Alist of @sc{mime} multipart types and functions to handle them.
7200 People use different charsets, and we have @sc{mime} to let us know what
7201 charsets they use. Or rather, we wish we had. Many people use
7202 newsreaders and mailers that do not understand or use @sc{mime}, and
7203 just send out messages without saying what character sets they use. To
7204 help a bit with this, some local news hierarchies have policies that say
7205 what character set is the default. For instance, the @samp{fj}
7206 hierarchy uses @code{iso-2022-jp-2}.
7208 @vindex gnus-group-charset-alist
7209 This knowledge is encoded in the @code{gnus-group-charset-alist}
7210 variable, which is an alist of regexps (to match group names) and
7211 default charsets to be used when reading these groups.
7213 In addition, some people do use soi-disant @sc{mime}-aware agents that
7214 aren't. These blitely mark messages as being in @code{iso-8859-1} even
7215 if they really are in @code{koi-8}. To help here, the
7216 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
7217 charsets that are listed here will be ignored. The variable can be set
7218 on a group-by-group basis using the group parameters (@pxref{Group
7219 Parameters}). The default value is @code{(unknown-8bit)}, which is
7220 something some agents insist on having in there.
7223 @node Article Commands
7224 @section Article Commands
7231 @kindex A P (Summary)
7232 @vindex gnus-ps-print-hook
7233 @findex gnus-summary-print-article
7234 Generate and print a PostScript image of the article buffer
7235 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
7236 run just before printing the buffer.
7241 @node Summary Sorting
7242 @section Summary Sorting
7243 @cindex summary sorting
7245 You can have the summary buffer sorted in various ways, even though I
7246 can't really see why you'd want that.
7251 @kindex C-c C-s C-n (Summary)
7252 @findex gnus-summary-sort-by-number
7253 Sort by article number (@code{gnus-summary-sort-by-number}).
7256 @kindex C-c C-s C-a (Summary)
7257 @findex gnus-summary-sort-by-author
7258 Sort by author (@code{gnus-summary-sort-by-author}).
7261 @kindex C-c C-s C-s (Summary)
7262 @findex gnus-summary-sort-by-subject
7263 Sort by subject (@code{gnus-summary-sort-by-subject}).
7266 @kindex C-c C-s C-d (Summary)
7267 @findex gnus-summary-sort-by-date
7268 Sort by date (@code{gnus-summary-sort-by-date}).
7271 @kindex C-c C-s C-l (Summary)
7272 @findex gnus-summary-sort-by-lines
7273 Sort by lines (@code{gnus-summary-sort-by-lines}).
7276 @kindex C-c C-s C-c (Summary)
7277 @findex gnus-summary-sort-by-chars
7278 Sort by article length (@code{gnus-summary-sort-by-chars}).
7281 @kindex C-c C-s C-i (Summary)
7282 @findex gnus-summary-sort-by-score
7283 Sort by score (@code{gnus-summary-sort-by-score}).
7286 These functions will work both when you use threading and when you don't
7287 use threading. In the latter case, all summary lines will be sorted,
7288 line by line. In the former case, sorting will be done on a
7289 root-by-root basis, which might not be what you were looking for. To
7290 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
7294 @node Finding the Parent
7295 @section Finding the Parent
7296 @cindex parent articles
7297 @cindex referring articles
7302 @findex gnus-summary-refer-parent-article
7303 If you'd like to read the parent of the current article, and it is not
7304 displayed in the summary buffer, you might still be able to. That is,
7305 if the current group is fetched by @sc{nntp}, the parent hasn't expired
7306 and the @code{References} in the current article are not mangled, you
7307 can just press @kbd{^} or @kbd{A r}
7308 (@code{gnus-summary-refer-parent-article}). If everything goes well,
7309 you'll get the parent. If the parent is already displayed in the
7310 summary buffer, point will just move to this article.
7312 If given a positive numerical prefix, fetch that many articles back into
7313 the ancestry. If given a negative numerical prefix, fetch just that
7314 ancestor. So if you say @kbd{3 ^}, gnus will fetch the parent, the
7315 grandparent and the grandgrandparent of the current article. If you say
7316 @kbd{-3 ^}, gnus will only fetch the grandgrandparent of the current
7320 @findex gnus-summary-refer-references
7321 @kindex A R (Summary)
7322 Fetch all articles mentioned in the @code{References} header of the
7323 article (@code{gnus-summary-refer-references}).
7326 @findex gnus-summary-refer-thread
7327 @kindex A T (Summary)
7328 Display the full thread where the current article appears
7329 (@code{gnus-summary-refer-thread}). This command has to fetch all the
7330 headers in the current group to work, so it usually takes a while. If
7331 you do it often, you may consider setting @code{gnus-fetch-old-headers}
7332 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
7333 visible effects normally, but it'll make this command work a whole lot
7334 faster. Of course, it'll make group entry somewhat slow.
7336 @vindex gnus-refer-thread-limit
7337 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
7338 articles before the first displayed in the current group) headers to
7339 fetch when doing this command. The default is 200. If @code{t}, all
7340 the available headers will be fetched. This variable can be overridden
7341 by giving the @kbd{A T} command a numerical prefix.
7344 @findex gnus-summary-refer-article
7345 @kindex M-^ (Summary)
7347 @cindex fetching by Message-ID
7348 You can also ask the @sc{nntp} server for an arbitrary article, no
7349 matter what group it belongs to. @kbd{M-^}
7350 (@code{gnus-summary-refer-article}) will ask you for a
7351 @code{Message-ID}, which is one of those long, hard-to-read thingies
7352 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
7353 have to get it all exactly right. No fuzzy searches, I'm afraid.
7356 The current select method will be used when fetching by
7357 @code{Message-ID} from non-news select method, but you can override this
7358 by giving this command a prefix.
7360 @vindex gnus-refer-article-method
7361 If the group you are reading is located on a backend that does not
7362 support fetching by @code{Message-ID} very well (like @code{nnspool}),
7363 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
7364 would, perhaps, be best if the @sc{nntp} server you consult is the one
7365 updating the spool you are reading from, but that's not really
7368 Most of the mail backends support fetching by @code{Message-ID}, but do
7369 not do a particularly excellent job at it. That is, @code{nnmbox} and
7370 @code{nnbabyl} are able to locate articles from any groups, while
7371 @code{nnml} and @code{nnfolder} are only able to locate articles that
7372 have been posted to the current group. (Anything else would be too time
7373 consuming.) @code{nnmh} does not support this at all.
7376 @node Alternative Approaches
7377 @section Alternative Approaches
7379 Different people like to read news using different methods. This being
7380 gnus, we offer a small selection of minor modes for the summary buffers.
7383 * Pick and Read:: First mark articles and then read them.
7384 * Binary Groups:: Auto-decode all articles.
7389 @subsection Pick and Read
7390 @cindex pick and read
7392 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
7393 a two-phased reading interface. The user first marks in a summary
7394 buffer the articles she wants to read. Then she starts reading the
7395 articles with just an article buffer displayed.
7397 @findex gnus-pick-mode
7398 @kindex M-x gnus-pick-mode
7399 Gnus provides a summary buffer minor mode that allows
7400 this---@code{gnus-pick-mode}. This basically means that a few process
7401 mark commands become one-keystroke commands to allow easy marking, and
7402 it provides one additional command for switching to the summary buffer.
7404 Here are the available keystrokes when using pick mode:
7409 @findex gnus-pick-article-or-thread
7410 Pick the article or thread on the current line
7411 (@code{gnus-pick-article-or-thread}). If the variable
7412 @code{gnus-thread-hide-subtree} is true, then this key selects the
7413 entire thread when used at the first article of the thread. Otherwise,
7414 it selects just the article. If given a numerical prefix, go to that
7415 thread or article and pick it. (The line number is normally displayed
7416 at the beginning of the summary pick lines.)
7419 @kindex SPACE (Pick)
7420 @findex gnus-pick-next-page
7421 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
7422 at the end of the buffer, start reading the picked articles.
7426 @findex gnus-pick-unmark-article-or-thread.
7427 Unpick the thread or article
7428 (@code{gnus-pick-unmark-article-or-thread}). If the variable
7429 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
7430 thread if used at the first article of the thread. Otherwise it unpicks
7431 just the article. You can give this key a numerical prefix to unpick
7432 the thread or article at that line.
7436 @findex gnus-pick-start-reading
7437 @vindex gnus-pick-display-summary
7438 Start reading the picked articles (@code{gnus-pick-start-reading}). If
7439 given a prefix, mark all unpicked articles as read first. If
7440 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
7441 will still be visible when you are reading.
7445 All the normal summary mode commands are still available in the
7446 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
7447 which is mapped to the same function
7448 @code{gnus-summary-tick-article-forward}.
7450 If this sounds like a good idea to you, you could say:
7453 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
7456 @vindex gnus-pick-mode-hook
7457 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
7459 @vindex gnus-mark-unpicked-articles-as-read
7460 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
7461 all unpicked articles as read. The default is @code{nil}.
7463 @vindex gnus-summary-pick-line-format
7464 The summary line format in pick mode is slightly different from the
7465 standard format. At the beginning of each line the line number is
7466 displayed. The pick mode line format is controlled by the
7467 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
7468 Variables}). It accepts the same format specs that
7469 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
7473 @subsection Binary Groups
7474 @cindex binary groups
7476 @findex gnus-binary-mode
7477 @kindex M-x gnus-binary-mode
7478 If you spend much time in binary groups, you may grow tired of hitting
7479 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
7480 is a minor mode for summary buffers that makes all ordinary Gnus article
7481 selection functions uudecode series of articles and display the result
7482 instead of just displaying the articles the normal way.
7485 @findex gnus-binary-show-article
7486 The only way, in fact, to see the actual articles is the @kbd{g}
7487 command, when you have turned on this mode
7488 (@code{gnus-binary-show-article}).
7490 @vindex gnus-binary-mode-hook
7491 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
7495 @section Tree Display
7498 @vindex gnus-use-trees
7499 If you don't like the normal gnus summary display, you might try setting
7500 @code{gnus-use-trees} to @code{t}. This will create (by default) an
7501 additional @dfn{tree buffer}. You can execute all summary mode commands
7504 There are a few variables to customize the tree display, of course:
7507 @item gnus-tree-mode-hook
7508 @vindex gnus-tree-mode-hook
7509 A hook called in all tree mode buffers.
7511 @item gnus-tree-mode-line-format
7512 @vindex gnus-tree-mode-line-format
7513 A format string for the mode bar in the tree mode buffers (@pxref{Mode
7514 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
7515 of valid specs, @pxref{Summary Buffer Mode Line}.
7517 @item gnus-selected-tree-face
7518 @vindex gnus-selected-tree-face
7519 Face used for highlighting the selected article in the tree buffer. The
7520 default is @code{modeline}.
7522 @item gnus-tree-line-format
7523 @vindex gnus-tree-line-format
7524 A format string for the tree nodes. The name is a bit of a misnomer,
7525 though---it doesn't define a line, but just the node. The default value
7526 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
7527 the name of the poster. It is vital that all nodes are of the same
7528 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
7534 The name of the poster.
7536 The @code{From} header.
7538 The number of the article.
7540 The opening bracket.
7542 The closing bracket.
7547 @xref{Formatting Variables}.
7549 Variables related to the display are:
7552 @item gnus-tree-brackets
7553 @vindex gnus-tree-brackets
7554 This is used for differentiating between ``real'' articles and
7555 ``sparse'' articles. The format is @var{((real-open . real-close)
7556 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
7557 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7559 @item gnus-tree-parent-child-edges
7560 @vindex gnus-tree-parent-child-edges
7561 This is a list that contains the characters used for connecting parent
7562 nodes to their children. The default is @code{(?- ?\\ ?|)}.
7566 @item gnus-tree-minimize-window
7567 @vindex gnus-tree-minimize-window
7568 If this variable is non-@code{nil}, gnus will try to keep the tree
7569 buffer as small as possible to allow more room for the other gnus
7570 windows. If this variable is a number, the tree buffer will never be
7571 higher than that number. The default is @code{t}. Note that if you
7572 have several windows displayed side-by-side in a frame and the tree
7573 buffer is one of these, minimizing the tree window will also resize all
7574 other windows displayed next to it.
7576 @item gnus-generate-tree-function
7577 @vindex gnus-generate-tree-function
7578 @findex gnus-generate-horizontal-tree
7579 @findex gnus-generate-vertical-tree
7580 The function that actually generates the thread tree. Two predefined
7581 functions are available: @code{gnus-generate-horizontal-tree} and
7582 @code{gnus-generate-vertical-tree} (which is the default).
7586 Here's an example from a horizontal tree buffer:
7589 @{***@}-(***)-[odd]-[Gun]
7599 Here's the same thread displayed in a vertical tree buffer:
7603 |--------------------------\-----\-----\
7604 (***) [Bjo] [Gun] [Gun]
7606 [odd] [Jan] [odd] (***) [Jor]
7608 [Gun] [Eri] [Eri] [odd]
7613 If you're using horizontal trees, it might be nice to display the trees
7614 side-by-side with the summary buffer. You could add something like the
7615 following to your @file{.gnus.el} file:
7618 (setq gnus-use-trees t
7619 gnus-generate-tree-function 'gnus-generate-horizontal-tree
7620 gnus-tree-minimize-window nil)
7621 (gnus-add-configuration
7625 (summary 0.75 point)
7630 @xref{Windows Configuration}.
7633 @node Mail Group Commands
7634 @section Mail Group Commands
7635 @cindex mail group commands
7637 Some commands only make sense in mail groups. If these commands are
7638 invalid in the current group, they will raise a hell and let you know.
7640 All these commands (except the expiry and edit commands) use the
7641 process/prefix convention (@pxref{Process/Prefix}).
7646 @kindex B e (Summary)
7647 @findex gnus-summary-expire-articles
7648 Expire all expirable articles in the group
7649 (@code{gnus-summary-expire-articles}).
7652 @kindex B M-C-e (Summary)
7653 @findex gnus-summary-expire-articles-now
7654 Delete all the expirable articles in the group
7655 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
7656 articles eligible for expiry in the current group will
7657 disappear forever into that big @file{/dev/null} in the sky.
7660 @kindex B DEL (Summary)
7661 @findex gnus-summary-delete-article
7662 @c @icon{gnus-summary-mail-delete}
7663 Delete the mail article. This is ``delete'' as in ``delete it from your
7664 disk forever and ever, never to return again.'' Use with caution.
7665 (@code{gnus-summary-delete-article}).
7668 @kindex B m (Summary)
7670 @findex gnus-summary-move-article
7671 Move the article from one mail group to another
7672 (@code{gnus-summary-move-article}).
7675 @kindex B c (Summary)
7677 @findex gnus-summary-copy-article
7678 @c @icon{gnus-summary-mail-copy}
7679 Copy the article from one group (mail group or not) to a mail group
7680 (@code{gnus-summary-copy-article}).
7683 @kindex B B (Summary)
7684 @cindex crosspost mail
7685 @findex gnus-summary-crosspost-article
7686 Crosspost the current article to some other group
7687 (@code{gnus-summary-crosspost-article}). This will create a new copy of
7688 the article in the other group, and the Xref headers of the article will
7689 be properly updated.
7692 @kindex B i (Summary)
7693 @findex gnus-summary-import-article
7694 Import an arbitrary file into the current mail newsgroup
7695 (@code{gnus-summary-import-article}). You will be prompted for a file
7696 name, a @code{From} header and a @code{Subject} header.
7699 @kindex B r (Summary)
7700 @findex gnus-summary-respool-article
7701 Respool the mail article (@code{gnus-summary-respool-article}).
7702 @code{gnus-summary-respool-default-method} will be used as the default
7703 select method when respooling. This variable is @code{nil} by default,
7704 which means that the current group select method will be used instead.
7708 @kindex B w (Summary)
7710 @findex gnus-summary-edit-article
7711 @kindex C-c C-c (Article)
7712 Edit the current article (@code{gnus-summary-edit-article}). To finish
7713 editing and make the changes permanent, type @kbd{C-c C-c}
7714 (@kbd{gnus-summary-edit-article-done}). If you give a prefix to the
7715 @kbd{C-c C-c} command, gnus won't re-highlight the article.
7718 @kindex B q (Summary)
7719 @findex gnus-summary-respool-query
7720 If you want to re-spool an article, you might be curious as to what group
7721 the article will end up in before you do the re-spooling. This command
7722 will tell you (@code{gnus-summary-respool-query}).
7725 @kindex B t (Summary)
7726 @findex gnus-summary-respool-trace
7727 Similarly, this command will display all fancy splitting patterns used
7728 when repooling, if any (@code{gnus-summary-respool-trace}).
7731 @kindex B p (Summary)
7732 @findex gnus-summary-article-posted-p
7733 Some people have a tendency to send you "courtesy" copies when they
7734 follow up to articles you have posted. These usually have a
7735 @code{Newsgroups} header in them, but not always. This command
7736 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7737 article from your news server (or rather, from
7738 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7739 report back whether it found the article or not. Even if it says that
7740 it didn't find the article, it may have been posted anyway---mail
7741 propagation is much faster than news propagation, and the news copy may
7742 just not have arrived yet.
7746 @vindex gnus-move-split-methods
7747 @cindex moving articles
7748 If you move (or copy) articles regularly, you might wish to have gnus
7749 suggest where to put the articles. @code{gnus-move-split-methods} is a
7750 variable that uses the same syntax as @code{gnus-split-methods}
7751 (@pxref{Saving Articles}). You may customize that variable to create
7752 suggestions you find reasonable.
7755 (setq gnus-move-split-methods
7756 '(("^From:.*Lars Magne" "nnml:junk")
7757 ("^Subject:.*gnus" "nnfolder:important")
7758 (".*" "nnml:misc")))
7762 @node Various Summary Stuff
7763 @section Various Summary Stuff
7766 * Summary Group Information:: Information oriented commands.
7767 * Searching for Articles:: Multiple article commands.
7768 * Summary Generation Commands:: (Re)generating the summary buffer.
7769 * Really Various Summary Commands:: Those pesky non-conformant commands.
7773 @vindex gnus-summary-mode-hook
7774 @item gnus-summary-mode-hook
7775 This hook is called when creating a summary mode buffer.
7777 @vindex gnus-summary-generate-hook
7778 @item gnus-summary-generate-hook
7779 This is called as the last thing before doing the threading and the
7780 generation of the summary buffer. It's quite convenient for customizing
7781 the threading variables based on what data the newsgroup has. This hook
7782 is called from the summary buffer after most summary buffer variables
7785 @vindex gnus-summary-prepare-hook
7786 @item gnus-summary-prepare-hook
7787 It is called after the summary buffer has been generated. You might use
7788 it to, for instance, highlight lines or modify the look of the buffer in
7789 some other ungodly manner. I don't care.
7791 @vindex gnus-summary-prepared-hook
7792 @item gnus-summary-prepared-hook
7793 A hook called as the very last thing after the summary buffer has been
7796 @vindex gnus-summary-ignore-duplicates
7797 @item gnus-summary-ignore-duplicates
7798 When gnus discovers two articles that have the same @code{Message-ID},
7799 it has to do something drastic. No articles are allowed to have the
7800 same @code{Message-ID}, but this may happen when reading mail from some
7801 sources. Gnus allows you to customize what happens with this variable.
7802 If it is @code{nil} (which is the default), gnus will rename the
7803 @code{Message-ID} (for display purposes only) and display the article as
7804 any other article. If this variable is @code{t}, it won't display the
7805 article---it'll be as if it never existed.
7810 @node Summary Group Information
7811 @subsection Summary Group Information
7816 @kindex H f (Summary)
7817 @findex gnus-summary-fetch-faq
7818 @vindex gnus-group-faq-directory
7819 Try to fetch the FAQ (list of frequently asked questions) for the
7820 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
7821 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7822 on a remote machine. This variable can also be a list of directories.
7823 In that case, giving a prefix to this command will allow you to choose
7824 between the various sites. @code{ange-ftp} or @code{efs} will probably
7825 be used for fetching the file.
7828 @kindex H d (Summary)
7829 @findex gnus-summary-describe-group
7830 Give a brief description of the current group
7831 (@code{gnus-summary-describe-group}). If given a prefix, force
7832 rereading the description from the server.
7835 @kindex H h (Summary)
7836 @findex gnus-summary-describe-briefly
7837 Give an extremely brief description of the most important summary
7838 keystrokes (@code{gnus-summary-describe-briefly}).
7841 @kindex H i (Summary)
7842 @findex gnus-info-find-node
7843 Go to the gnus info node (@code{gnus-info-find-node}).
7847 @node Searching for Articles
7848 @subsection Searching for Articles
7853 @kindex M-s (Summary)
7854 @findex gnus-summary-search-article-forward
7855 Search through all subsequent articles for a regexp
7856 (@code{gnus-summary-search-article-forward}).
7859 @kindex M-r (Summary)
7860 @findex gnus-summary-search-article-backward
7861 Search through all previous articles for a regexp
7862 (@code{gnus-summary-search-article-backward}).
7866 @findex gnus-summary-execute-command
7867 This command will prompt you for a header field, a regular expression to
7868 match on this field, and a command to be executed if the match is made
7869 (@code{gnus-summary-execute-command}). If given a prefix, search
7873 @kindex M-& (Summary)
7874 @findex gnus-summary-universal-argument
7875 Perform any operation on all articles that have been marked with
7876 the process mark (@code{gnus-summary-universal-argument}).
7879 @node Summary Generation Commands
7880 @subsection Summary Generation Commands
7885 @kindex Y g (Summary)
7886 @findex gnus-summary-prepare
7887 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7890 @kindex Y c (Summary)
7891 @findex gnus-summary-insert-cached-articles
7892 Pull all cached articles (for the current group) into the summary buffer
7893 (@code{gnus-summary-insert-cached-articles}).
7898 @node Really Various Summary Commands
7899 @subsection Really Various Summary Commands
7905 @kindex C-d (Summary)
7906 @kindex A D (Summary)
7907 @findex gnus-summary-enter-digest-group
7908 If the current article is a collection of other articles (for instance,
7909 a digest), you might use this command to enter a group based on the that
7910 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
7911 guess what article type is currently displayed unless you give a prefix
7912 to this command, which forces a ``digest'' interpretation. Basically,
7913 whenever you see a message that is a collection of other messages of
7914 some format, you @kbd{C-d} and read these messages in a more convenient
7918 @kindex M-C-d (Summary)
7919 @findex gnus-summary-read-document
7920 This command is very similar to the one above, but lets you gather
7921 several documents into one biiig group
7922 (@code{gnus-summary-read-document}). It does this by opening several
7923 @code{nndoc} groups for each document, and then opening an
7924 @code{nnvirtual} group on top of these @code{nndoc} groups. This
7925 command understands the process/prefix convention
7926 (@pxref{Process/Prefix}).
7929 @kindex C-t (Summary)
7930 @findex gnus-summary-toggle-truncation
7931 Toggle truncation of summary lines
7932 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
7933 line centering function in the summary buffer, so it's not a good idea
7934 to have truncation switched off while reading articles.
7938 @findex gnus-summary-expand-window
7939 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7940 If given a prefix, force an @code{article} window configuration.
7943 @kindex M-C-e (Summary)
7944 @findex gnus-summary-edit-parameters
7945 Edit the group parameters (@pxref{Group Parameters}) of the current
7946 group (@code{gnus-summary-edit-parameters}).
7949 @kindex M-C-g (Summary)
7950 @findex gnus-summary-customize-parameters
7951 Customize the group parameters (@pxref{Group Parameters}) of the current
7952 group (@code{gnus-summary-customize-parameters}).
7957 @node Exiting the Summary Buffer
7958 @section Exiting the Summary Buffer
7959 @cindex summary exit
7960 @cindex exiting groups
7962 Exiting from the summary buffer will normally update all info on the
7963 group and return you to the group buffer.
7969 @kindex Z Z (Summary)
7971 @findex gnus-summary-exit
7972 @vindex gnus-summary-exit-hook
7973 @vindex gnus-summary-prepare-exit-hook
7974 @c @icon{gnus-summary-exit}
7975 Exit the current group and update all information on the group
7976 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7977 called before doing much of the exiting, which calls
7978 @code{gnus-summary-expire-articles} by default.
7979 @code{gnus-summary-exit-hook} is called after finishing the exit
7980 process. @code{gnus-group-no-more-groups-hook} is run when returning to
7981 group mode having no more (unread) groups.
7985 @kindex Z E (Summary)
7987 @findex gnus-summary-exit-no-update
7988 Exit the current group without updating any information on the group
7989 (@code{gnus-summary-exit-no-update}).
7993 @kindex Z c (Summary)
7995 @findex gnus-summary-catchup-and-exit
7996 @c @icon{gnus-summary-catchup-and-exit}
7997 Mark all unticked articles in the group as read and then exit
7998 (@code{gnus-summary-catchup-and-exit}).
8001 @kindex Z C (Summary)
8002 @findex gnus-summary-catchup-all-and-exit
8003 Mark all articles, even the ticked ones, as read and then exit
8004 (@code{gnus-summary-catchup-all-and-exit}).
8007 @kindex Z n (Summary)
8008 @findex gnus-summary-catchup-and-goto-next-group
8009 Mark all articles as read and go to the next group
8010 (@code{gnus-summary-catchup-and-goto-next-group}).
8013 @kindex Z R (Summary)
8014 @findex gnus-summary-reselect-current-group
8015 Exit this group, and then enter it again
8016 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
8017 all articles, both read and unread.
8021 @kindex Z G (Summary)
8022 @kindex M-g (Summary)
8023 @findex gnus-summary-rescan-group
8024 @c @icon{gnus-summary-mail-get}
8025 Exit the group, check for new articles in the group, and select the
8026 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
8027 articles, both read and unread.
8030 @kindex Z N (Summary)
8031 @findex gnus-summary-next-group
8032 Exit the group and go to the next group
8033 (@code{gnus-summary-next-group}).
8036 @kindex Z P (Summary)
8037 @findex gnus-summary-prev-group
8038 Exit the group and go to the previous group
8039 (@code{gnus-summary-prev-group}).
8042 @kindex Z s (Summary)
8043 @findex gnus-summary-save-newsrc
8044 Save the current number of read/marked articles in the dribble buffer
8045 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
8046 given a prefix, also save the @file{.newsrc} file(s). Using this
8047 command will make exit without updating (the @kbd{Q} command) worthless.
8050 @vindex gnus-exit-group-hook
8051 @code{gnus-exit-group-hook} is called when you exit the current
8054 @findex gnus-summary-wake-up-the-dead
8055 @findex gnus-dead-summary-mode
8056 @vindex gnus-kill-summary-on-exit
8057 If you're in the habit of exiting groups, and then changing your mind
8058 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
8059 If you do that, gnus won't kill the summary buffer when you exit it.
8060 (Quelle surprise!) Instead it will change the name of the buffer to
8061 something like @samp{*Dead Summary ... *} and install a minor mode
8062 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
8063 buffer, you'll find that all keys are mapped to a function called
8064 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
8065 summary buffer will result in a live, normal summary buffer.
8067 There will never be more than one dead summary buffer at any one time.
8069 @vindex gnus-use-cross-reference
8070 The data on the current group will be updated (which articles you have
8071 read, which articles you have replied to, etc.) when you exit the
8072 summary buffer. If the @code{gnus-use-cross-reference} variable is
8073 @code{t} (which is the default), articles that are cross-referenced to
8074 this group and are marked as read, will also be marked as read in the
8075 other subscribed groups they were cross-posted to. If this variable is
8076 neither @code{nil} nor @code{t}, the article will be marked as read in
8077 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
8080 @node Crosspost Handling
8081 @section Crosspost Handling
8085 Marking cross-posted articles as read ensures that you'll never have to
8086 read the same article more than once. Unless, of course, somebody has
8087 posted it to several groups separately. Posting the same article to
8088 several groups (not cross-posting) is called @dfn{spamming}, and you are
8089 by law required to send nasty-grams to anyone who perpetrates such a
8090 heinous crime. You may want to try NoCeM handling to filter out spam
8093 Remember: Cross-posting is kinda ok, but posting the same article
8094 separately to several groups is not. Massive cross-posting (aka.
8095 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
8096 @code{gnus-summary-mail-crosspost-complaint} command to complain about
8097 excessive crossposting (@pxref{Summary Mail Commands}).
8099 @cindex cross-posting
8102 One thing that may cause Gnus to not do the cross-posting thing
8103 correctly is if you use an @sc{nntp} server that supports @sc{xover}
8104 (which is very nice, because it speeds things up considerably) which
8105 does not include the @code{Xref} header in its @sc{nov} lines. This is
8106 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
8107 even with @sc{xover} by registering the @code{Xref} lines of all
8108 articles you actually read, but if you kill the articles, or just mark
8109 them as read without reading them, Gnus will not get a chance to snoop
8110 the @code{Xref} lines out of these articles, and will be unable to use
8111 the cross reference mechanism.
8113 @cindex LIST overview.fmt
8114 @cindex overview.fmt
8115 To check whether your @sc{nntp} server includes the @code{Xref} header
8116 in its overview files, try @samp{telnet your.nntp.server nntp},
8117 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
8118 overview.fmt}. This may not work, but if it does, and the last line you
8119 get does not read @samp{Xref:full}, then you should shout and whine at
8120 your news admin until she includes the @code{Xref} header in the
8123 @vindex gnus-nov-is-evil
8124 If you want Gnus to get the @code{Xref}s right all the time, you have to
8125 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
8130 For an alternative approach, @pxref{Duplicate Suppression}.
8133 @node Duplicate Suppression
8134 @section Duplicate Suppression
8136 By default, gnus tries to make sure that you don't have to read the same
8137 article more than once by utilizing the crossposting mechanism
8138 (@pxref{Crosspost Handling}). However, that simple and efficient
8139 approach may not work satisfactory for some users for various
8144 The @sc{nntp} server may fail to generate the @code{Xref} header. This
8145 is evil and not very common.
8148 The @sc{nntp} server may fail to include the @code{Xref} header in the
8149 @file{.overview} data bases. This is evil and all too common, alas.
8152 You may be reading the same group (or several related groups) from
8153 different @sc{nntp} servers.
8156 You may be getting mail that duplicates articles posted to groups.
8159 I'm sure there are other situations where @code{Xref} handling fails as
8160 well, but these four are the most common situations.
8162 If, and only if, @code{Xref} handling fails for you, then you may
8163 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
8164 will remember the @code{Message-ID}s of all articles you have read or
8165 otherwise marked as read, and then, as if by magic, mark them as read
8166 all subsequent times you see them---in @emph{all} groups. Using this
8167 mechanism is quite likely to be somewhat inefficient, but not overly
8168 so. It's certainly preferable to reading the same articles more than
8171 Duplicate suppression is not a very subtle instrument. It's more like a
8172 sledge hammer than anything else. It works in a very simple
8173 fashion---if you have marked an article as read, it adds this Message-ID
8174 to a cache. The next time it sees this Message-ID, it will mark the
8175 article as read with the @samp{M} mark. It doesn't care what group it
8179 @item gnus-suppress-duplicates
8180 @vindex gnus-suppress-duplicates
8181 If non-@code{nil}, suppress duplicates.
8183 @item gnus-save-duplicate-list
8184 @vindex gnus-save-duplicate-list
8185 If non-@code{nil}, save the list of duplicates to a file. This will
8186 make startup and shutdown take longer, so the default is @code{nil}.
8187 However, this means that only duplicate articles read in a single gnus
8188 session are suppressed.
8190 @item gnus-duplicate-list-length
8191 @vindex gnus-duplicate-list-length
8192 This variable says how many @code{Message-ID}s to keep in the duplicate
8193 suppression list. The default is 10000.
8195 @item gnus-duplicate-file
8196 @vindex gnus-duplicate-file
8197 The name of the file to store the duplicate suppression list in. The
8198 default is @file{~/News/suppression}.
8201 If you have a tendency to stop and start gnus often, setting
8202 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
8203 you leave gnus running for weeks on end, you may have it @code{nil}. On
8204 the other hand, saving the list makes startup and shutdown much slower,
8205 so that means that if you stop and start gnus often, you should set
8206 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
8207 to you to figure out, I think.
8210 @node The Article Buffer
8211 @chapter The Article Buffer
8212 @cindex article buffer
8214 The articles are displayed in the article buffer, of which there is only
8215 one. All the summary buffers share the same article buffer unless you
8216 tell gnus otherwise.
8219 * Hiding Headers:: Deciding what headers should be displayed.
8220 * Using MIME:: Pushing to mime articles as @sc{mime} messages.
8221 * Customizing Articles:: Tailoring the look of the articles.
8222 * Article Keymap:: Keystrokes available in the article buffer.
8223 * Misc Article:: Other stuff.
8227 @node Hiding Headers
8228 @section Hiding Headers
8229 @cindex hiding headers
8230 @cindex deleting headers
8232 The top section of each article is the @dfn{head}. (The rest is the
8233 @dfn{body}, but you may have guessed that already.)
8235 @vindex gnus-show-all-headers
8236 There is a lot of useful information in the head: the name of the person
8237 who wrote the article, the date it was written and the subject of the
8238 article. That's well and nice, but there's also lots of information
8239 most people do not want to see---what systems the article has passed
8240 through before reaching you, the @code{Message-ID}, the
8241 @code{References}, etc. ad nauseum---and you'll probably want to get rid
8242 of some of those lines. If you want to keep all those lines in the
8243 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
8245 Gnus provides you with two variables for sifting headers:
8249 @item gnus-visible-headers
8250 @vindex gnus-visible-headers
8251 If this variable is non-@code{nil}, it should be a regular expression
8252 that says what headers you wish to keep in the article buffer. All
8253 headers that do not match this variable will be hidden.
8255 For instance, if you only want to see the name of the person who wrote
8256 the article and the subject, you'd say:
8259 (setq gnus-visible-headers "^From:\\|^Subject:")
8262 This variable can also be a list of regexps to match headers to
8265 @item gnus-ignored-headers
8266 @vindex gnus-ignored-headers
8267 This variable is the reverse of @code{gnus-visible-headers}. If this
8268 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
8269 should be a regular expression that matches all lines that you want to
8270 hide. All lines that do not match this variable will remain visible.
8272 For instance, if you just want to get rid of the @code{References} field
8273 and the @code{Xref} field, you might say:
8276 (setq gnus-ignored-headers "^References:\\|^Xref:")
8279 This variable can also be a list of regexps to match headers to
8282 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
8283 variable will have no effect.
8287 @vindex gnus-sorted-header-list
8288 Gnus can also sort the headers for you. (It does this by default.) You
8289 can control the sorting by setting the @code{gnus-sorted-header-list}
8290 variable. It is a list of regular expressions that says in what order
8291 the headers are to be displayed.
8293 For instance, if you want the name of the author of the article first,
8294 and then the subject, you might say something like:
8297 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
8300 Any headers that are to remain visible, but are not listed in this
8301 variable, will be displayed in random order after all the headers listed in this variable.
8303 @findex gnus-article-hide-boring-headers
8304 @vindex gnus-boring-article-headers
8305 You can hide further boring headers by setting
8306 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
8307 does depends on the @code{gnus-boring-article-headers} variable. It's a
8308 list, but this list doesn't actually contain header names. Instead is
8309 lists various @dfn{boring conditions} that Gnus can check and remove
8312 These conditions are:
8315 Remove all empty headers.
8317 Remove the @code{Followup-To} header if it is identical to the
8318 @code{Newsgroups} header.
8320 Remove the @code{Reply-To} header if it lists the same address as the
8323 Remove the @code{Newsgroups} header if it only contains the current group
8326 Remove the @code{Date} header if the article is less than three days
8329 Remove the @code{To} header if it is very long.
8331 Remove all @code{To} headers if there are more than one.
8334 To include the four three elements, you could say something like;
8337 (setq gnus-boring-article-headers
8338 '(empty followup-to reply-to))
8341 This is also the default value for this variable.
8345 @section Using @sc{mime}
8348 Mime is a standard for waving your hands through the air, aimlessly,
8349 while people stand around yawning.
8351 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
8352 while all newsreaders die of fear.
8354 @sc{mime} may specify what character set the article uses, the encoding
8355 of the characters, and it also makes it possible to embed pictures and
8356 other naughty stuff in innocent-looking articles.
8358 @vindex gnus-show-mime
8359 @vindex gnus-article-display-method-for-mime
8360 @vindex gnus-strict-mime
8361 @findex gnus-article-display-mime-message
8362 Gnus handles @sc{mime} by pushing the articles through
8363 @code{gnus-article-display-method-for-mime}, which is
8364 @code{gnus-article-display-mime-message} by default. This function
8365 calls the SEMI MIME-View program to actually do the work. For more
8366 information on SEMI MIME-View, see its manual page (however it is not
8367 existed yet, sorry).
8369 Set @code{gnus-show-mime} to @code{t} if you want to use
8370 @sc{mime} all the time. However, if @code{gnus-strict-mime} is
8371 non-@code{nil}, the @sc{mime} method will only be used if there are
8372 @sc{mime} headers in the article. If you have @code{gnus-show-mime}
8373 set, then you'll see some unfortunate display glitches in the article
8374 buffer. These can't be avoided.
8376 In GNUS or Gnus, it might be best to just use the toggling functions
8377 from the summary buffer to avoid getting nasty surprises. (For instance,
8378 you enter the group @samp{alt.sing-a-long} and, before you know it,
8379 @sc{mime} has decoded the sound file in the article and some horrible
8380 sing-a-long song comes screaming out your speakers, and you can't find
8381 the volume button, because there isn't one, and people are starting to
8382 look at you, and you try to stop the program, but you can't, and you
8383 can't find the program to control the volume, and everybody else in the
8384 room suddenly decides to look at you disdainfully, and you'll feel
8387 Any similarity to real events and people is purely coincidental. Ahem.
8389 To avoid such kind of situation, gnus stops to use
8390 @code{metamail-buffer}. So now, you can set @code{gnus-show-mime} to
8391 non-@code{nil} every-time, then you can push button in the article
8392 buffer when there are nobody else.
8394 Also see @pxref{MIME Commands}.
8397 @node Customizing Articles
8398 @section Customizing Articles
8399 @cindex article customization
8401 A slew of functions for customizing how the articles are to look like
8402 exist. You can call these functions interactively, or you can have them
8403 called automatically when you select the articles.
8405 To have them called automatically, you should set the corresponding
8406 ``treatment'' variable. For instance, to have headers hidden, you'd set
8407 @code{gnus-treat-hide-headers}. Below is a list of variables that can
8408 be set, but first we discuss the values these variables can have.
8410 Note: Some values, while valid, make little sense. Check the list below
8411 for sensible values.
8415 @code{nil}: Don't do this treatment.
8418 @code{t}: Do this treatment on all body parts.
8421 @code{head}: Do the treatment on the headers.
8424 @code{last}: Do this treatment on the last part.
8427 An integer: Do this treatment on all body parts that have a length less
8431 A list of strings: Do this treatment on all body parts that are in
8432 articles that are read in groups that have names that match one of the
8433 regexps in the list.
8436 A list where the first element is not a string:
8438 The list is evaluated recursively. The first element of the list is a
8439 predicate. The following predicates are recognized: @code{or},
8440 @code{and}, @code{not} and @code{typep}. Here's an example:
8444 (typep "text/x-vcard"))
8448 @code{mime}: Do this treatment if the value of @code{gnus-show-mime}' is
8453 You may have noticed that the word @dfn{part} is used here. This refers
8454 to the fact that some messages are @sc{mime} multipart articles that may
8455 be divided into several parts. Articles that are not multiparts are
8456 considered to contain just a single part.
8458 @vindex gnus-article-treat-types
8459 Are the treatments applied to all sorts of multipart parts? Yes, if you
8460 want to, but by default, only @samp{text/plain} parts are given the
8461 treatment. This is controlled by the @code{gnus-article-treat-types}
8462 variable, which is a list of regular expressions that are matched to the
8463 type of the part. This variable is ignored if the value of the
8464 controlling variable is a predicate list, as described above.
8466 The following treatment options are available. The easiest way to
8467 customize this is to examine the @code{gnus-article-treat} customization
8468 group. Values in brackets are suggested sensible values. Others are possible
8469 but those listed are probably sufficient for most people.
8472 @item gnus-treat-highlight-signature (t, last)
8473 @item gnus-treat-buttonize (t, integer)
8474 @item gnus-treat-buttonize-head (head)
8475 @item gnus-treat-emphasize (t, head, integer)
8476 @item gnus-treat-fill-article (t, integer)
8477 @item gnus-treat-strip-cr (t, integer)
8478 @item gnus-treat-hide-headers (head)
8479 @item gnus-treat-hide-boring-headers (head)
8480 @item gnus-treat-hide-signature (t, last)
8481 @item gnus-treat-hide-citation (t, integer)
8482 @item gnus-treat-strip-pgp (t, last, integer)
8483 @item gnus-treat-strip-pem (t, last, integer)
8484 @item gnus-treat-highlight-headers (head)
8485 @item gnus-treat-highlight-citation (t, integer)
8486 @item gnus-treat-highlight-signature (t, last, integer)
8487 @item gnus-treat-date-ut (head)
8488 @item gnus-treat-date-local (head)
8489 @item gnus-treat-date-lapsed (head)
8490 @item gnus-treat-date-original (head)
8491 @item gnus-treat-strip-headers-in-body (t, integer)
8492 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
8493 @item gnus-treat-strip-leading-blank-lines (t, integer)
8494 @item gnus-treat-strip-multiple-blank-lines (t, integer)
8495 @item gnus-treat-overstrike (t, integer)
8496 @item gnus-treat-display-xface (head)
8497 @item gnus-treat-display-smileys (t, integer)
8498 @item gnus-treat-display-picons (head)
8499 @item gnus-treat-capitalize-sentences (t, integer)
8500 @item gnus-treat-fill-long-lines (t, integer)
8501 @item gnus-treat-play-sounds
8502 @item gnus-treat-translate
8503 @item gnus-treat-decode-article-as-default-mime-charset
8506 @vindex gnus-part-display-hook
8507 You can, of course, write your own functions to be called from
8508 @code{gnus-part-display-hook}. The functions are called narrowed to the
8509 part, and you can do anything you like, pretty much. There is no
8510 information that you have to keep in the buffer---you can change
8511 everything. However, you shouldn't delete any headers. Instead make
8512 them invisible if you want to make them go away.
8515 @node Article Keymap
8516 @section Article Keymap
8518 Most of the keystrokes in the summary buffer can also be used in the
8519 article buffer. They should behave as if you typed them in the summary
8520 buffer, which means that you don't actually have to have a summary
8521 buffer displayed while reading. You can do it all from the article
8524 A few additional keystrokes are available:
8529 @kindex SPACE (Article)
8530 @findex gnus-article-next-page
8531 Scroll forwards one page (@code{gnus-article-next-page}).
8534 @kindex DEL (Article)
8535 @findex gnus-article-prev-page
8536 Scroll backwards one page (@code{gnus-article-prev-page}).
8539 @kindex C-c ^ (Article)
8540 @findex gnus-article-refer-article
8541 If point is in the neighborhood of a @code{Message-ID} and you press
8542 @kbd{C-c ^}, Gnus will try to get that article from the server
8543 (@code{gnus-article-refer-article}).
8546 @kindex C-c C-m (Article)
8547 @findex gnus-article-mail
8548 Send a reply to the address near point (@code{gnus-article-mail}). If
8549 given a prefix, include the mail.
8553 @findex gnus-article-show-summary
8554 Reconfigure the buffers so that the summary buffer becomes visible
8555 (@code{gnus-article-show-summary}).
8559 @findex gnus-article-describe-briefly
8560 Give a very brief description of the available keystrokes
8561 (@code{gnus-article-describe-briefly}).
8564 @kindex TAB (Article)
8565 @findex gnus-article-next-button
8566 Go to the next button, if any (@code{gnus-article-next-button}). This
8567 only makes sense if you have buttonizing turned on.
8570 @kindex M-TAB (Article)
8571 @findex gnus-article-prev-button
8572 Go to the previous button, if any (@code{gnus-article-prev-button}).
8578 @section Misc Article
8582 @item gnus-single-article-buffer
8583 @vindex gnus-single-article-buffer
8584 If non-@code{nil}, use the same article buffer for all the groups.
8585 (This is the default.) If @code{nil}, each group will have its own
8588 @vindex gnus-article-decode-hook
8589 @item gnus-article-decode-hook
8591 Hook used to decode @sc{mime} articles. The default value is
8592 @code{(article-decode-charset article-decode-encoded-words)}
8594 @vindex gnus-article-prepare-hook
8595 @item gnus-article-prepare-hook
8596 This hook is called right after the article has been inserted into the
8597 article buffer. It is mainly intended for functions that do something
8598 depending on the contents; it should probably not be used for changing
8599 the contents of the article buffer.
8601 @item gnus-article-mode-hook
8602 @vindex gnus-article-mode-hook
8603 Hook called in article mode buffers.
8605 @item gnus-article-mode-syntax-table
8606 @vindex gnus-article-mode-syntax-table
8607 Syntax table used in article buffers. It is initialized from
8608 @code{text-mode-syntax-table}.
8610 @vindex gnus-article-mode-line-format
8611 @item gnus-article-mode-line-format
8612 This variable is a format string along the same lines as
8613 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
8614 accepts the same format specifications as that variable, with one
8619 The @dfn{wash status} of the article. This is a short string with one
8620 character for each possible article wash operation that may have been
8623 The number of @sc{mime} parts in the article.
8626 @vindex gnus-break-pages
8628 @item gnus-break-pages
8629 Controls whether @dfn{page breaking} is to take place. If this variable
8630 is non-@code{nil}, the articles will be divided into pages whenever a
8631 page delimiter appears in the article. If this variable is @code{nil},
8632 paging will not be done.
8634 @item gnus-page-delimiter
8635 @vindex gnus-page-delimiter
8636 This is the delimiter mentioned above. By default, it is @samp{^L}
8641 @node Composing Messages
8642 @chapter Composing Messages
8643 @cindex composing messages
8646 @cindex sending mail
8651 @kindex C-c C-c (Post)
8652 All commands for posting and mailing will put you in a message buffer
8653 where you can edit the article all you like, before you send the article
8654 by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The Message
8655 Manual}. If you are in a foreign news group, and you wish to post the
8656 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
8657 to make gnus try to post using the foreign server.
8660 * Mail:: Mailing and replying.
8661 * Post:: Posting and following up.
8662 * Posting Server:: What server should you post via?
8663 * Mail and Post:: Mailing and posting at the same time.
8664 * Archived Messages:: Where gnus stores the messages you've sent.
8665 * Posting Styles:: An easier way to specify who you are.
8666 * Drafts:: Postponing messages and rejected messages.
8667 * Rejected Articles:: What happens if the server doesn't like your article?
8670 Also see @pxref{Canceling and Superseding} for information on how to
8671 remove articles you shouldn't have posted.
8677 Variables for customizing outgoing mail:
8680 @item gnus-uu-digest-headers
8681 @vindex gnus-uu-digest-headers
8682 List of regexps to match headers included in digested messages. The
8683 headers will be included in the sequence they are matched.
8685 @item gnus-add-to-list
8686 @vindex gnus-add-to-list
8687 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8688 that have none when you do a @kbd{a}.
8696 Variables for composing news articles:
8699 @item gnus-sent-message-ids-file
8700 @vindex gnus-sent-message-ids-file
8701 Gnus will keep a @code{Message-ID} history file of all the mails it has
8702 sent. If it discovers that it has already sent a mail, it will ask the
8703 user whether to re-send the mail. (This is primarily useful when
8704 dealing with @sc{soup} packets and the like where one is apt to send the
8705 same packet multiple times.) This variable says what the name of this
8706 history file is. It is @file{~/News/Sent-Message-IDs} by default. Set
8707 this variable to @code{nil} if you don't want gnus to keep a history
8710 @item gnus-sent-message-ids-length
8711 @vindex gnus-sent-message-ids-length
8712 This variable says how many @code{Message-ID}s to keep in the history
8713 file. It is 1000 by default.
8718 @node Posting Server
8719 @section Posting Server
8721 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8722 (extremely intelligent, of course) article, where does it go?
8724 Thank you for asking. I hate you.
8726 @vindex gnus-post-method
8728 It can be quite complicated. Normally, gnus will use the same native
8729 server. However. If your native server doesn't allow posting, just
8730 reading, you probably want to use some other server to post your
8731 (extremely intelligent and fabulously interesting) articles. You can
8732 then set the @code{gnus-post-method} to some other method:
8735 (setq gnus-post-method '(nnspool ""))
8738 Now, if you've done this, and then this server rejects your article, or
8739 this server is down, what do you do then? To override this variable you
8740 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8741 the ``current'' server for posting.
8743 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8744 gnus will prompt you for what method to use for posting.
8746 You can also set @code{gnus-post-method} to a list of select methods.
8747 If that's the case, gnus will always prompt you for what method to use
8750 Finally, if you want to always post using the same select method as
8751 you're reading from (which might be convenient if you're reading lots of
8752 groups from different private servers), you can set this variable to
8757 @section Mail and Post
8759 Here's a list of variables relevant to both mailing and
8763 @item gnus-mailing-list-groups
8764 @findex gnus-mailing-list-groups
8765 @cindex mailing lists
8767 If your news server offers groups that are really mailing lists
8768 gatewayed to the @sc{nntp} server, you can read those groups without
8769 problems, but you can't post/followup to them without some difficulty.
8770 One solution is to add a @code{to-address} to the group parameters
8771 (@pxref{Group Parameters}). An easier thing to do is set the
8772 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8773 really are mailing lists. Then, at least, followups to the mailing
8774 lists will work most of the time. Posting to these groups (@kbd{a}) is
8775 still a pain, though.
8779 You may want to do spell-checking on messages that you send out. Or, if
8780 you don't want to spell-check by hand, you could add automatic
8781 spell-checking via the @code{ispell} package:
8784 @findex ispell-message
8786 (add-hook 'message-send-hook 'ispell-message)
8790 @node Archived Messages
8791 @section Archived Messages
8792 @cindex archived messages
8793 @cindex sent messages
8795 Gnus provides a few different methods for storing the mail and news you
8796 send. The default method is to use the @dfn{archive virtual server} to
8797 store the messages. If you want to disable this completely, the
8798 @code{gnus-message-archive-group} variable should be @code{nil}, which
8801 @vindex gnus-message-archive-method
8802 @code{gnus-message-archive-method} says what virtual server gnus is to
8803 use to store sent messages. The default is:
8807 (nnfolder-directory "~/Mail/archive")
8808 (nnfolder-active-file "~/Mail/archive/active")
8809 (nnfolder-get-new-mail nil)
8810 (nnfolder-inhibit-expiry t))
8813 You can, however, use any mail select method (@code{nnml},
8814 @code{nnmbox}, etc.). @code{nnfolder} is a quite likeable select method
8815 for doing this sort of thing, though. If you don't like the default
8816 directory chosen, you could say something like:
8819 (setq gnus-message-archive-method
8820 '(nnfolder "archive"
8821 (nnfolder-inhibit-expiry t)
8822 (nnfolder-active-file "~/News/sent-mail/active")
8823 (nnfolder-directory "~/News/sent-mail/")))
8826 @vindex gnus-message-archive-group
8828 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8829 to one or more group(s) on that server. Which group to use is
8830 determined by the @code{gnus-message-archive-group} variable.
8832 This variable can be used to do the following:
8836 Messages will be saved in that group.
8837 @item a list of strings
8838 Messages will be saved in all those groups.
8839 @item an alist of regexps, functions and forms
8840 When a key ``matches'', the result is used.
8842 No message archiving will take place. This is the default.
8847 Just saving to a single group called @samp{MisK}:
8849 (setq gnus-message-archive-group "MisK")
8852 Saving to two groups, @samp{MisK} and @samp{safe}:
8854 (setq gnus-message-archive-group '("MisK" "safe"))
8857 Save to different groups based on what group you are in:
8859 (setq gnus-message-archive-group
8860 '(("^alt" "sent-to-alt")
8861 ("mail" "sent-to-mail")
8862 (".*" "sent-to-misc")))
8867 (setq gnus-message-archive-group
8868 '((if (message-news-p)
8873 How about storing all news messages in one file, but storing all mail
8874 messages in one file per month:
8877 (setq gnus-message-archive-group
8878 '((if (message-news-p)
8880 (concat "mail." (format-time-string
8881 "%Y-%m" (current-time))))))
8884 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8885 use a different value for @code{gnus-message-archive-group} there.)
8887 Now, when you send a message off, it will be stored in the appropriate
8888 group. (If you want to disable storing for just one particular message,
8889 you can just remove the @code{Gcc} header that has been inserted.) The
8890 archive group will appear in the group buffer the next time you start
8891 gnus, or the next time you press @kbd{F} in the group buffer. You can
8892 enter it and read the articles in it just like you'd read any other
8893 group. If the group gets really big and annoying, you can simply rename
8894 if (using @kbd{G r} in the group buffer) to something
8895 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
8896 continue to be stored in the old (now empty) group.
8898 That's the default method of archiving sent messages. Gnus offers a
8899 different way for the people who don't like the default method. In that
8900 case you should set @code{gnus-message-archive-group} to @code{nil};
8901 this will disable archiving.
8904 @item gnus-outgoing-message-group
8905 @vindex gnus-outgoing-message-group
8906 All outgoing messages will be put in this group. If you want to store
8907 all your outgoing mail and articles in the group @samp{nnml:archive},
8908 you set this variable to that value. This variable can also be a list of
8911 If you want to have greater control over what group to put each
8912 message in, you can set this variable to a function that checks the
8913 current newsgroup name and then returns a suitable group name (or list
8916 This variable can be used instead of @code{gnus-message-archive-group},
8917 but the latter is the preferred method.
8921 @node Posting Styles
8922 @section Posting Styles
8923 @cindex posting styles
8926 All them variables, they make my head swim.
8928 So what if you want a different @code{Organization} and signature based
8929 on what groups you post to? And you post both from your home machine
8930 and your work machine, and you want different @code{From} lines, and so
8933 @vindex gnus-posting-styles
8934 One way to do stuff like that is to write clever hooks that change the
8935 variables you need to have changed. That's a bit boring, so somebody
8936 came up with the bright idea of letting the user specify these things in
8937 a handy alist. Here's an example of a @code{gnus-posting-styles}
8942 (signature "Peace and happiness")
8943 (organization "What me?"))
8945 (signature "Death to everybody"))
8946 ("comp.emacs.i-love-it"
8947 (organization "Emacs is it")))
8950 As you might surmise from this example, this alist consists of several
8951 @dfn{styles}. Each style will be applicable if the first element
8952 ``matches'', in some form or other. The entire alist will be iterated
8953 over, from the beginning towards the end, and each match will be
8954 applied, which means that attributes in later styles that match override
8955 the same attributes in earlier matching styles. So
8956 @samp{comp.programming.literate} will have the @samp{Death to everybody}
8957 signature and the @samp{What me?} @code{Organization} header.
8959 The first element in each style is called the @code{match}. If it's a
8960 string, then Gnus will try to regexp match it against the group name.
8961 If it's a function symbol, that function will be called with no
8962 arguments. If it's a variable symbol, then the variable will be
8963 referenced. If it's a list, then that list will be @code{eval}ed. In
8964 any case, if this returns a non-@code{nil} value, then the style is said
8967 Each style may contain a arbitrary amount of @dfn{attributes}. Each
8968 attribute consists of a @var{(name value)} pair. The attribute name
8969 can be one of @code{signature}, @code{signature-file},
8970 @code{organization}, @code{address}, @code{name} or @code{body}. The
8971 attribute name can also be a string. In that case, this will be used as
8972 a header name, and the value will be inserted in the headers of the
8975 The attribute value can be a string (used verbatim), a function with
8976 zero arguments (the return value will be used), a variable (its value
8977 will be used) or a list (it will be @code{eval}ed and the return value
8978 will be used). The functions and sexps are called/@code{eval}ed in the
8979 message buffer that is being set up. The headers of the current article
8980 are available through the @code{message-reply-headers} variable.
8982 If you wish to check whether the message you are about to compose is
8983 meant to be a news article or a mail message, you can check the values
8984 of the @code{message-news-p} and @code{message-mail-p} functions.
8986 @findex message-mail-p
8987 @findex message-news-p
8989 So here's a new example:
8992 (setq gnus-posting-styles
8994 (signature-file "~/.signature")
8996 ("X-Home-Page" (getenv "WWW_HOME"))
8997 (organization "People's Front Against MWM"))
8999 (signature my-funny-signature-randomizer))
9000 ((equal (system-name) "gnarly")
9001 (signature my-quote-randomizer))
9003 (signature my-news-signature))
9004 ((posting-from-work-p)
9005 (signature-file "~/.work-signature")
9006 (address "user@@bar.foo")
9007 (body "You are fired.\n\nSincerely, your boss.")
9008 (organization "Important Work, Inc"))
9010 (signature-file "~/.mail-signature"))))
9018 If you are writing a message (mail or news) and suddenly remember that
9019 you have a steak in the oven (or some pesto in the food processor, you
9020 craaazy vegetarians), you'll probably wish there was a method to save
9021 the message you are writing so that you can continue editing it some
9022 other day, and send it when you feel its finished.
9024 Well, don't worry about it. Whenever you start composing a message of
9025 some sort using the gnus mail and post commands, the buffer you get will
9026 automatically associate to an article in a special @dfn{draft} group.
9027 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
9028 article will be saved there. (Auto-save files also go to the draft
9032 @vindex nndraft-directory
9033 The draft group is a special group (which is implemented as an
9034 @code{nndraft} group, if you absolutely have to know) called
9035 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
9036 @code{nndraft} is to store its files. What makes this group special is
9037 that you can't tick any articles in it or mark any articles as
9038 read---all articles in the group are permanently unread.
9040 If the group doesn't exist, it will be created and you'll be subscribed
9041 to it. The only way to make it disappear from the Group buffer is to
9044 @c @findex gnus-dissociate-buffer-from-draft
9045 @c @kindex C-c M-d (Mail)
9046 @c @kindex C-c M-d (Post)
9047 @c @findex gnus-associate-buffer-with-draft
9048 @c @kindex C-c C-d (Mail)
9049 @c @kindex C-c C-d (Post)
9050 @c If you're writing some super-secret message that you later want to
9051 @c encode with PGP before sending, you may wish to turn the auto-saving
9052 @c (and association with the draft group) off. You never know who might be
9053 @c interested in reading all your extremely valuable and terribly horrible
9054 @c and interesting secrets. The @kbd{C-c M-d}
9055 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
9056 @c If you change your mind and want to turn the auto-saving back on again,
9057 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
9059 @c @vindex gnus-use-draft
9060 @c To leave association with the draft group off by default, set
9061 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
9063 @findex gnus-draft-edit-message
9065 When you want to continue editing the article, you simply enter the
9066 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
9067 that. You will be placed in a buffer where you left off.
9069 Rejected articles will also be put in this draft group (@pxref{Rejected
9072 @findex gnus-draft-send-all-messages
9073 @findex gnus-draft-send-message
9074 If you have lots of rejected messages you want to post (or mail) without
9075 doing further editing, you can use the @kbd{D s} command
9076 (@code{gnus-draft-send-message}). This command understands the
9077 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
9078 command (@code{gnus-draft-send-all-messages}) will ship off all messages
9081 If you have some messages that you wish not to send, you can use the
9082 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
9083 as unsendable. This is a toggling command.
9086 @node Rejected Articles
9087 @section Rejected Articles
9088 @cindex rejected articles
9090 Sometimes a news server will reject an article. Perhaps the server
9091 doesn't like your face. Perhaps it just feels miserable. Perhaps
9092 @emph{there be demons}. Perhaps you have included too much cited text.
9093 Perhaps the disk is full. Perhaps the server is down.
9095 These situations are, of course, totally beyond the control of gnus.
9096 (Gnus, of course, loves the way you look, always feels great, has angels
9097 fluttering around inside of it, doesn't care about how much cited text
9098 you include, never runs full and never goes down.) So gnus saves these
9099 articles until some later time when the server feels better.
9101 The rejected articles will automatically be put in a special draft group
9102 (@pxref{Drafts}). When the server comes back up again, you'd then
9103 typically enter that group and send all the articles off.
9106 @node Select Methods
9107 @chapter Select Methods
9108 @cindex foreign groups
9109 @cindex select methods
9111 A @dfn{foreign group} is a group not read by the usual (or
9112 default) means. It could be, for instance, a group from a different
9113 @sc{nntp} server, it could be a virtual group, or it could be your own
9114 personal mail group.
9116 A foreign group (or any group, really) is specified by a @dfn{name} and
9117 a @dfn{select method}. To take the latter first, a select method is a
9118 list where the first element says what backend to use (e.g. @code{nntp},
9119 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
9120 name}. There may be additional elements in the select method, where the
9121 value may have special meaning for the backend in question.
9123 One could say that a select method defines a @dfn{virtual server}---so
9124 we do just that (@pxref{The Server Buffer}).
9126 The @dfn{name} of the group is the name the backend will recognize the
9129 For instance, the group @samp{soc.motss} on the @sc{nntp} server
9130 @samp{some.where.edu} will have the name @samp{soc.motss} and select
9131 method @code{(nntp "some.where.edu")}. Gnus will call this group
9132 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
9133 backend just knows this group as @samp{soc.motss}.
9135 The different methods all have their peculiarities, of course.
9138 * The Server Buffer:: Making and editing virtual servers.
9139 * Getting News:: Reading USENET news with Gnus.
9140 * Getting Mail:: Reading your personal mail with Gnus.
9141 * Other Sources:: Reading directories, files, SOUP packets.
9142 * Combined Groups:: Combining groups into one group.
9143 * Gnus Unplugged:: Reading news and mail offline.
9147 @node The Server Buffer
9148 @section The Server Buffer
9150 Traditionally, a @dfn{server} is a machine or a piece of software that
9151 one connects to, and then requests information from. Gnus does not
9152 connect directly to any real servers, but does all transactions through
9153 one backend or other. But that's just putting one layer more between
9154 the actual media and Gnus, so we might just as well say that each
9155 backend represents a virtual server.
9157 For instance, the @code{nntp} backend may be used to connect to several
9158 different actual @sc{nntp} servers, or, perhaps, to many different ports
9159 on the same actual @sc{nntp} server. You tell Gnus which backend to
9160 use, and what parameters to set by specifying a @dfn{select method}.
9162 These select method specifications can sometimes become quite
9163 complicated---say, for instance, that you want to read from the
9164 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
9165 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
9166 Anyways, if you had to specify that for each group that used this
9167 server, that would be too much work, so Gnus offers a way of naming
9168 select methods, which is what you do in the server buffer.
9170 To enter the server buffer, use the @kbd{^}
9171 (@code{gnus-group-enter-server-mode}) command in the group buffer.
9174 * Server Buffer Format:: You can customize the look of this buffer.
9175 * Server Commands:: Commands to manipulate servers.
9176 * Example Methods:: Examples server specifications.
9177 * Creating a Virtual Server:: An example session.
9178 * Server Variables:: Which variables to set.
9179 * Servers and Methods:: You can use server names as select methods.
9180 * Unavailable Servers:: Some servers you try to contact may be down.
9183 @vindex gnus-server-mode-hook
9184 @code{gnus-server-mode-hook} is run when creating the server buffer.
9187 @node Server Buffer Format
9188 @subsection Server Buffer Format
9189 @cindex server buffer format
9191 @vindex gnus-server-line-format
9192 You can change the look of the server buffer lines by changing the
9193 @code{gnus-server-line-format} variable. This is a @code{format}-like
9194 variable, with some simple extensions:
9199 How the news is fetched---the backend name.
9202 The name of this server.
9205 Where the news is to be fetched from---the address.
9208 The opened/closed/denied status of the server.
9211 @vindex gnus-server-mode-line-format
9212 The mode line can also be customized by using the
9213 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
9214 Formatting}). The following specs are understood:
9224 Also @pxref{Formatting Variables}.
9227 @node Server Commands
9228 @subsection Server Commands
9229 @cindex server commands
9235 @findex gnus-server-add-server
9236 Add a new server (@code{gnus-server-add-server}).
9240 @findex gnus-server-edit-server
9241 Edit a server (@code{gnus-server-edit-server}).
9244 @kindex SPACE (Server)
9245 @findex gnus-server-read-server
9246 Browse the current server (@code{gnus-server-read-server}).
9250 @findex gnus-server-exit
9251 Return to the group buffer (@code{gnus-server-exit}).
9255 @findex gnus-server-kill-server
9256 Kill the current server (@code{gnus-server-kill-server}).
9260 @findex gnus-server-yank-server
9261 Yank the previously killed server (@code{gnus-server-yank-server}).
9265 @findex gnus-server-copy-server
9266 Copy the current server (@code{gnus-server-copy-server}).
9270 @findex gnus-server-list-servers
9271 List all servers (@code{gnus-server-list-servers}).
9275 @findex gnus-server-scan-server
9276 Request that the server scan its sources for new articles
9277 (@code{gnus-server-scan-server}). This is mainly sensible with mail
9282 @findex gnus-server-regenerate-server
9283 Request that the server regenerate all its data structures
9284 (@code{gnus-server-regenerate-server}). This can be useful if you have
9285 a mail backend that has gotten out of synch.
9290 @node Example Methods
9291 @subsection Example Methods
9293 Most select methods are pretty simple and self-explanatory:
9296 (nntp "news.funet.fi")
9299 Reading directly from the spool is even simpler:
9305 As you can see, the first element in a select method is the name of the
9306 backend, and the second is the @dfn{address}, or @dfn{name}, if you
9309 After these two elements, there may be an arbitrary number of
9310 @var{(variable form)} pairs.
9312 To go back to the first example---imagine that you want to read from
9313 port 15 on that machine. This is what the select method should
9317 (nntp "news.funet.fi" (nntp-port-number 15))
9320 You should read the documentation to each backend to find out what
9321 variables are relevant, but here's an @code{nnmh} example:
9323 @code{nnmh} is a mail backend that reads a spool-like structure. Say
9324 you have two structures that you wish to access: One is your private
9325 mail spool, and the other is a public one. Here's the possible spec for
9329 (nnmh "private" (nnmh-directory "~/private/mail/"))
9332 (This server is then called @samp{private}, but you may have guessed
9335 Here's the method for a public spool:
9339 (nnmh-directory "/usr/information/spool/")
9340 (nnmh-get-new-mail nil))
9343 If you are behind a firewall and only have access to the @sc{nntp}
9344 server from the firewall machine, you can instruct Gnus to @code{rlogin}
9345 on the firewall machine and telnet from there to the @sc{nntp} server.
9346 Doing this can be rather fiddly, but your virtual server definition
9347 should probably look something like this:
9351 (nntp-address "the.firewall.machine")
9352 (nntp-open-connection-function nntp-open-rlogin)
9353 (nntp-end-of-line "\n")
9354 (nntp-rlogin-parameters
9355 ("telnet" "the.real.nntp.host" "nntp")))
9358 If you want to use the wonderful @code{ssh} program to provide a
9359 compressed connection over the modem line, you could create a virtual
9360 server that would look something like this:
9364 (nntp-address "copper.uio.no")
9365 (nntp-rlogin-program "ssh")
9366 (nntp-open-connection-function nntp-open-rlogin)
9367 (nntp-end-of-line "\n")
9368 (nntp-rlogin-parameters
9369 ("telnet" "news.uio.no" "nntp")))
9372 This means that you have to have set up @code{ssh-agent} correctly to
9373 provide automatic authorization, of course. And to get a compressed
9374 connection, you have to have the @samp{Compression} option in the
9375 @code{ssh} @file{config} file.
9378 @node Creating a Virtual Server
9379 @subsection Creating a Virtual Server
9381 If you're saving lots of articles in the cache by using persistent
9382 articles, you may want to create a virtual server to read the cache.
9384 First you need to add a new server. The @kbd{a} command does that. It
9385 would probably be best to use @code{nnspool} to read the cache. You
9386 could also use @code{nnml} or @code{nnmh}, though.
9388 Type @kbd{a nnspool RET cache RET}.
9390 You should now have a brand new @code{nnspool} virtual server called
9391 @samp{cache}. You now need to edit it to have the right definitions.
9392 Type @kbd{e} to edit the server. You'll be entered into a buffer that
9393 will contain the following:
9403 (nnspool-spool-directory "~/News/cache/")
9404 (nnspool-nov-directory "~/News/cache/")
9405 (nnspool-active-file "~/News/cache/active"))
9408 Type @kbd{C-c C-c} to return to the server buffer. If you now press
9409 @kbd{RET} over this virtual server, you should be entered into a browse
9410 buffer, and you should be able to enter any of the groups displayed.
9413 @node Server Variables
9414 @subsection Server Variables
9416 One sticky point when defining variables (both on backends and in Emacs
9417 in general) is that some variables are typically initialized from other
9418 variables when the definition of the variables is being loaded. If you
9419 change the "base" variable after the variables have been loaded, you
9420 won't change the "derived" variables.
9422 This typically affects directory and file variables. For instance,
9423 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
9424 directory variables are initialized from that variable, so
9425 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
9426 new virtual @code{nnml} server, it will @emph{not} suffice to set just
9427 @code{nnml-directory}---you have to explicitly set all the file
9428 variables to be what you want them to be. For a complete list of
9429 variables for each backend, see each backend's section later in this
9430 manual, but here's an example @code{nnml} definition:
9434 (nnml-directory "~/my-mail/")
9435 (nnml-active-file "~/my-mail/active")
9436 (nnml-newsgroups-file "~/my-mail/newsgroups"))
9440 @node Servers and Methods
9441 @subsection Servers and Methods
9443 Wherever you would normally use a select method
9444 (e.g. @code{gnus-secondary-select-method}, in the group select method,
9445 when browsing a foreign server) you can use a virtual server name
9446 instead. This could potentially save lots of typing. And it's nice all
9450 @node Unavailable Servers
9451 @subsection Unavailable Servers
9453 If a server seems to be unreachable, Gnus will mark that server as
9454 @code{denied}. That means that any subsequent attempt to make contact
9455 with that server will just be ignored. ``It can't be opened,'' Gnus
9456 will tell you, without making the least effort to see whether that is
9457 actually the case or not.
9459 That might seem quite naughty, but it does make sense most of the time.
9460 Let's say you have 10 groups subscribed to on server
9461 @samp{nephelococcygia.com}. This server is located somewhere quite far
9462 away from you and the machine is quite slow, so it takes 1 minute just
9463 to find out that it refuses connection to you today. If Gnus were to
9464 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
9465 attempt to do that. Once it has gotten a single ``connection refused'',
9466 it will regard that server as ``down''.
9468 So, what happens if the machine was only feeling unwell temporarily?
9469 How do you test to see whether the machine has come up again?
9471 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
9472 with the following commands:
9478 @findex gnus-server-open-server
9479 Try to establish connection to the server on the current line
9480 (@code{gnus-server-open-server}).
9484 @findex gnus-server-close-server
9485 Close the connection (if any) to the server
9486 (@code{gnus-server-close-server}).
9490 @findex gnus-server-deny-server
9491 Mark the current server as unreachable
9492 (@code{gnus-server-deny-server}).
9495 @kindex M-o (Server)
9496 @findex gnus-server-open-all-servers
9497 Open the connections to all servers in the buffer
9498 (@code{gnus-server-open-all-servers}).
9501 @kindex M-c (Server)
9502 @findex gnus-server-close-all-servers
9503 Close the connections to all servers in the buffer
9504 (@code{gnus-server-close-all-servers}).
9508 @findex gnus-server-remove-denials
9509 Remove all marks to whether Gnus was denied connection from any servers
9510 (@code{gnus-server-remove-denials}).
9516 @section Getting News
9517 @cindex reading news
9518 @cindex news backends
9520 A newsreader is normally used for reading news. Gnus currently provides
9521 only two methods of getting news---it can read from an @sc{nntp} server,
9522 or it can read from a local spool.
9525 * NNTP:: Reading news from an @sc{nntp} server.
9526 * News Spool:: Reading news from the local spool.
9531 @subsection @sc{nntp}
9534 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
9535 You just specify @code{nntp} as method and the address of the @sc{nntp}
9536 server as the, uhm, address.
9538 If the @sc{nntp} server is located at a non-standard port, setting the
9539 third element of the select method to this port number should allow you
9540 to connect to the right port. You'll have to edit the group info for
9541 that (@pxref{Foreign Groups}).
9543 The name of the foreign group can be the same as a native group. In
9544 fact, you can subscribe to the same group from as many different servers
9545 you feel like. There will be no name collisions.
9547 The following variables can be used to create a virtual @code{nntp}
9552 @item nntp-server-opened-hook
9553 @vindex nntp-server-opened-hook
9554 @cindex @sc{mode reader}
9556 @cindex authentification
9557 @cindex nntp authentification
9558 @findex nntp-send-authinfo
9559 @findex nntp-send-mode-reader
9560 is run after a connection has been made. It can be used to send
9561 commands to the @sc{nntp} server after it has been contacted. By
9562 default it sends the command @code{MODE READER} to the server with the
9563 @code{nntp-send-mode-reader} function. This function should always be
9564 present in this hook.
9566 @item nntp-authinfo-function
9567 @vindex nntp-authinfo-function
9568 @findex nntp-send-authinfo
9569 @vindex nntp-authinfo-file
9570 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
9571 server. The default function is @code{nntp-send-authinfo}, which looks
9572 through your @file{~/.authinfo} (or whatever you've set the
9573 @code{nntp-authinfo-file} variable to) for applicable entries. If none
9574 are found, it will prompt you for a login name and a password. The
9575 format of the @file{~/.authinfo} file is (almost) the same as the
9576 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
9577 manual page, but here are the salient facts:
9581 The file contains one or more line, each of which define one server.
9584 Each line may contain an arbitrary number of token/value pairs. The
9585 valid tokens include @samp{machine}, @samp{login}, @samp{password},
9586 @samp{default} and @samp{force}. (The latter is not a valid
9587 @file{.netrc}/@code{ftp} token, which is the only way the
9588 @file{.authinfo} file format deviates from the @file{.netrc} file
9593 Here's an example file:
9596 machine news.uio.no login larsi password geheimnis
9597 machine nntp.ifi.uio.no login larsi force yes
9600 The token/value pairs may appear in any order; @samp{machine} doesn't
9601 have to be first, for instance.
9603 In this example, both login name and password have been supplied for the
9604 former server, while the latter has only the login name listed, and the
9605 user will be prompted for the password. The latter also has the
9606 @samp{force} tag, which means that the authinfo will be sent to the
9607 @var{nntp} server upon connection; the default (i.e., when there is not
9608 @samp{force} tag) is to not send authinfo to the @var{nntp} server
9609 until the @var{nntp} server asks for it.
9611 You can also add @samp{default} lines that will apply to all servers
9612 that don't have matching @samp{machine} lines.
9618 This will force sending @samp{AUTHINFO} commands to all servers not
9619 previously mentioned.
9621 Remember to not leave the @file{~/.authinfo} file world-readable.
9623 @item nntp-server-action-alist
9624 @vindex nntp-server-action-alist
9625 This is a list of regexps to match on server types and actions to be
9626 taken when matches are made. For instance, if you want Gnus to beep
9627 every time you connect to innd, you could say something like:
9630 (setq nntp-server-action-alist
9634 You probably don't want to do that, though.
9636 The default value is
9639 '(("nntpd 1\\.5\\.11t"
9640 (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
9643 This ensures that Gnus doesn't send the @code{MODE READER} command to
9644 nntpd 1.5.11t, since that command chokes that server, I've been told.
9646 @item nntp-maximum-request
9647 @vindex nntp-maximum-request
9648 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
9649 will collect headers by sending a series of @code{head} commands. To
9650 speed things up, the backend sends lots of these commands without
9651 waiting for reply, and then reads all the replies. This is controlled
9652 by the @code{nntp-maximum-request} variable, and is 400 by default. If
9653 your network is buggy, you should set this to 1.
9655 @item nntp-connection-timeout
9656 @vindex nntp-connection-timeout
9657 If you have lots of foreign @code{nntp} groups that you connect to
9658 regularly, you're sure to have problems with @sc{nntp} servers not
9659 responding properly, or being too loaded to reply within reasonable
9660 time. This is can lead to awkward problems, which can be helped
9661 somewhat by setting @code{nntp-connection-timeout}. This is an integer
9662 that says how many seconds the @code{nntp} backend should wait for a
9663 connection before giving up. If it is @code{nil}, which is the default,
9664 no timeouts are done.
9666 @c @item nntp-command-timeout
9667 @c @vindex nntp-command-timeout
9668 @c @cindex PPP connections
9669 @c @cindex dynamic IP addresses
9670 @c If you're running Gnus on a machine that has a dynamically assigned
9671 @c address, Gnus may become confused. If the address of your machine
9672 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
9673 @c waiting forever for replies from the server. To help with this
9674 @c unfortunate problem, you can set this command to a number. Gnus will
9675 @c then, if it sits waiting for a reply from the server longer than that
9676 @c number of seconds, shut down the connection, start a new one, and resend
9677 @c the command. This should hopefully be transparent to the user. A
9678 @c likely number is 30 seconds.
9680 @c @item nntp-retry-on-break
9681 @c @vindex nntp-retry-on-break
9682 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
9683 @c hangs. This will have much the same effect as the command timeout
9686 @item nntp-server-hook
9687 @vindex nntp-server-hook
9688 This hook is run as the last step when connecting to an @sc{nntp}
9691 @findex nntp-open-rlogin
9692 @findex nntp-open-telnet
9693 @findex nntp-open-network-stream
9694 @item nntp-open-connection-function
9695 @vindex nntp-open-connection-function
9696 This function is used to connect to the remote system. Four pre-made
9697 functions are supplied:
9700 @item nntp-open-network-stream
9701 This is the default, and simply connects to some port or other on the
9704 @item nntp-open-rlogin
9705 Does an @samp{rlogin} on the
9706 remote system, and then does a @samp{telnet} to the @sc{nntp} server
9709 @code{nntp-open-rlogin}-related variables:
9713 @item nntp-rlogin-program
9714 @vindex nntp-rlogin-program
9715 Program used to log in on remote machines. The default is @samp{rsh},
9716 but @samp{ssh} is a popular alternative.
9718 @item nntp-rlogin-parameters
9719 @vindex nntp-rlogin-parameters
9720 This list will be used as the parameter list given to @code{rsh}.
9722 @item nntp-rlogin-user-name
9723 @vindex nntp-rlogin-user-name
9724 User name on the remote system.
9728 @item nntp-open-telnet
9729 Does a @samp{telnet} to the remote system and then another @samp{telnet}
9730 to get to the @sc{nntp} server.
9732 @code{nntp-open-telnet}-related variables:
9735 @item nntp-telnet-command
9736 @vindex nntp-telnet-command
9737 Command used to start @code{telnet}.
9739 @item nntp-telnet-switches
9740 @vindex nntp-telnet-switches
9741 List of strings to be used as the switches to the @code{telnet} command.
9743 @item nntp-telnet-user-name
9744 @vindex nntp-telnet-user-name
9745 User name for log in on the remote system.
9747 @item nntp-telnet-passwd
9748 @vindex nntp-telnet-passwd
9749 Password to use when logging in.
9751 @item nntp-telnet-parameters
9752 @vindex nntp-telnet-parameters
9753 A list of strings executed as a command after logging in
9756 @item nntp-telnet-shell-prompt
9757 @vindex nntp-telnet-shell-prompt
9758 Regexp matching the shell prompt on the remote machine. The default is
9759 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9761 @item nntp-open-telnet-envuser
9762 @vindex nntp-open-telnet-envuser
9763 If non-@code{nil}, the @code{telnet} session (client and server both)
9764 will support the @code{ENVIRON} option and not prompt for login name.
9765 This works for Solaris @code{telnet}, for instance.
9769 @findex nntp-open-ssl-stream
9770 @item nntp-open-ssl-stream
9771 Opens a connection to a server over a @dfn{secure} channel. To use this
9772 you must have SSLay installed
9773 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
9774 @file{ssl.el} (from the W3 distributeion, for instance). You then
9775 define a server as follows:
9778 ;; Type `C-c C-c' after you've finished editing.
9780 ;; "snews" is port 563 and is predefined in our /etc/services
9782 (nntp "snews.bar.com"
9783 (nntp-open-connection-function nntp-open-ssl-stream)
9784 (nntp-port-number "snews")
9785 (nntp-address "snews.bar.com"))
9790 @item nntp-end-of-line
9791 @vindex nntp-end-of-line
9792 String to use as end-of-line marker when talking to the @sc{nntp}
9793 server. This is @samp{\r\n} by default, but should be @samp{\n} when
9794 using @code{rlogin} to talk to the server.
9796 @item nntp-rlogin-user-name
9797 @vindex nntp-rlogin-user-name
9798 User name on the remote system when using the @code{rlogin} connect
9802 @vindex nntp-address
9803 The address of the remote system running the @sc{nntp} server.
9805 @item nntp-port-number
9806 @vindex nntp-port-number
9807 Port number to connect to when using the @code{nntp-open-network-stream}
9810 @item nntp-buggy-select
9811 @vindex nntp-buggy-select
9812 Set this to non-@code{nil} if your select routine is buggy.
9814 @item nntp-nov-is-evil
9815 @vindex nntp-nov-is-evil
9816 If the @sc{nntp} server does not support @sc{nov}, you could set this
9817 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9820 @item nntp-xover-commands
9821 @vindex nntp-xover-commands
9824 List of strings used as commands to fetch @sc{nov} lines from a
9825 server. The default value of this variable is @code{("XOVER"
9829 @vindex nntp-nov-gap
9830 @code{nntp} normally sends just one big request for @sc{nov} lines to
9831 the server. The server responds with one huge list of lines. However,
9832 if you have read articles 2-5000 in the group, and only want to read
9833 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9834 lines that you will not need. This variable says how
9835 big a gap between two consecutive articles is allowed to be before the
9836 @code{XOVER} request is split into several request. Note that if your
9837 network is fast, setting this variable to a really small number means
9838 that fetching will probably be slower. If this variable is @code{nil},
9839 @code{nntp} will never split requests. The default is 5.
9841 @item nntp-prepare-server-hook
9842 @vindex nntp-prepare-server-hook
9843 A hook run before attempting to connect to an @sc{nntp} server.
9845 @item nntp-warn-about-losing-connection
9846 @vindex nntp-warn-about-losing-connection
9847 If this variable is non-@code{nil}, some noise will be made when a
9848 server closes connection.
9850 @item nntp-record-commands
9851 @vindex nntp-record-commands
9852 If non-@code{nil}, @code{nntp} will log all commands it sends to the
9853 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
9854 buffer. This is useful if you are debugging a Gnus/@sc{nntp} connection
9855 that doesn't seem to work.
9861 @subsection News Spool
9865 Subscribing to a foreign group from the local spool is extremely easy,
9866 and might be useful, for instance, to speed up reading groups that
9867 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9870 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9871 anything else) as the address.
9873 If you have access to a local spool, you should probably use that as the
9874 native select method (@pxref{Finding the News}). It is normally faster
9875 than using an @code{nntp} select method, but might not be. It depends.
9876 You just have to try to find out what's best at your site.
9880 @item nnspool-inews-program
9881 @vindex nnspool-inews-program
9882 Program used to post an article.
9884 @item nnspool-inews-switches
9885 @vindex nnspool-inews-switches
9886 Parameters given to the inews program when posting an article.
9888 @item nnspool-spool-directory
9889 @vindex nnspool-spool-directory
9890 Where @code{nnspool} looks for the articles. This is normally
9891 @file{/usr/spool/news/}.
9893 @item nnspool-nov-directory
9894 @vindex nnspool-nov-directory
9895 Where @code{nnspool} will look for @sc{nov} files. This is normally
9896 @file{/usr/spool/news/over.view/}.
9898 @item nnspool-lib-dir
9899 @vindex nnspool-lib-dir
9900 Where the news lib dir is (@file{/usr/lib/news/} by default).
9902 @item nnspool-active-file
9903 @vindex nnspool-active-file
9904 The path to the active file.
9906 @item nnspool-newsgroups-file
9907 @vindex nnspool-newsgroups-file
9908 The path to the group descriptions file.
9910 @item nnspool-history-file
9911 @vindex nnspool-history-file
9912 The path to the news history file.
9914 @item nnspool-active-times-file
9915 @vindex nnspool-active-times-file
9916 The path to the active date file.
9918 @item nnspool-nov-is-evil
9919 @vindex nnspool-nov-is-evil
9920 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9923 @item nnspool-sift-nov-with-sed
9924 @vindex nnspool-sift-nov-with-sed
9926 If non-@code{nil}, which is the default, use @code{sed} to get the
9927 relevant portion from the overview file. If nil, @code{nnspool} will
9928 load the entire file into a buffer and process it there.
9934 @section Getting Mail
9935 @cindex reading mail
9938 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9942 * Mail in a Newsreader:: Important introductory notes.
9943 * Getting Started Reading Mail:: A simple cookbook example.
9944 * Splitting Mail:: How to create mail groups.
9945 * Mail Sources:: How to tell Gnus where to get mail from.
9946 * Mail Backend Variables:: Variables for customizing mail handling.
9947 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
9948 * Group Mail Splitting:: Use group customize to drive mail splitting.
9949 * Incorporating Old Mail:: What about the old mail you have?
9950 * Expiring Mail:: Getting rid of unwanted mail.
9951 * Washing Mail:: Removing gruft from the mail you get.
9952 * Duplicates:: Dealing with duplicated mail.
9953 * Not Reading Mail:: Using mail backends for reading other files.
9954 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
9958 @node Mail in a Newsreader
9959 @subsection Mail in a Newsreader
9961 If you are used to traditional mail readers, but have decided to switch
9962 to reading mail with Gnus, you may find yourself experiencing something
9965 Gnus does not behave like traditional mail readers. If you want to make
9966 it behave that way, you can, but it's an uphill battle.
9968 Gnus, by default, handles all its groups using the same approach. This
9969 approach is very newsreaderly---you enter a group, see the new/unread
9970 messages, and when you read the messages, they get marked as read, and
9971 you don't see them any more. (Unless you explicitly ask for them.)
9973 In particular, you do not do anything explicitly to delete messages.
9975 Does this mean that all the messages that have been marked as read are
9978 But, no, it means that old messages are @dfn{expired} according to some
9979 scheme or other. For news messages, the expire process is controlled by
9980 the news administrator; for mail, the expire process is controlled by
9981 you. The expire process for mail is covered in depth in @pxref{Expiring
9984 What many Gnus users find, after using it a while for both news and
9985 mail, is that the transport mechanism has very little to do with how
9986 they want to treat a message.
9988 Many people subscribe to several mailing lists. These are transported
9989 via SMTP, and are therefore mail. But we might go for weeks without
9990 answering, or even reading these messages very carefully. We may not
9991 need to save them because if we should need to read one again, they are
9992 archived somewhere else.
9994 Some people have local news groups which have only a handful of readers.
9995 These are transported via NNTP, and are therefore news. But we may need
9996 to read and answer a large fraction of the messages very carefully in
9997 order to do our work. And there may not be an archive, so we may need
9998 to save the interesting messages the same way we would personal mail.
10000 The important distinction turns out to be not the transport mechanism,
10001 but other factors such as how interested we are in the subject matter,
10002 or how easy it is to retrieve the message if we need to read it again.
10004 Gnus provides many options for sorting mail into ``groups'' which behave
10005 like newsgroups, and for treating each group (whether mail or news)
10008 Some users never get comfortable using the Gnus (ahem) paradigm and wish
10009 that Gnus should grow up and be a male, er, mail reader. It is possible
10010 to whip Gnus into a more mailreaderly being, but, as said before, it's
10011 not easy. People who prefer proper mail readers should try @sc{vm}
10012 instead, which is an excellent, and proper, mail reader.
10014 I don't mean to scare anybody off, but I want to make it clear that you
10015 may be required to learn a new way of thinking about messages. After
10016 you've been subjected to The Gnus Way, you will come to love it. I can
10017 guarantee it. (At least the guy who sold me the Emacs Subliminal
10018 Brain-Washing Functions that I've put into Gnus did guarantee it. You
10019 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
10023 @node Getting Started Reading Mail
10024 @subsection Getting Started Reading Mail
10026 It's quite easy to use Gnus to read your new mail. You just plonk the
10027 mail backend of your choice into @code{gnus-secondary-select-methods},
10028 and things will happen automatically.
10030 For instance, if you want to use @code{nnml} (which is a "one file per
10031 mail" backend), you could put the following in your @file{.gnus} file:
10034 (setq gnus-secondary-select-methods
10035 '((nnml "private")))
10038 Now, the next time you start Gnus, this backend will be queried for new
10039 articles, and it will move all the messages in your spool file to its
10040 directory, which is @code{~/Mail/} by default. The new group that will
10041 be created (@samp{mail.misc}) will be subscribed, and you can read it
10042 like any other group.
10044 You will probably want to split the mail into several groups, though:
10047 (setq nnmail-split-methods
10048 '(("junk" "^From:.*Lars Ingebrigtsen")
10049 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
10053 This will result in three new @code{nnml} mail groups being created:
10054 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
10055 mail that doesn't fit into the first two groups will be placed in the
10058 This should be sufficient for reading mail with Gnus. You might want to
10059 give the other sections in this part of the manual a perusal, though.
10060 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
10063 @node Splitting Mail
10064 @subsection Splitting Mail
10065 @cindex splitting mail
10066 @cindex mail splitting
10068 @vindex nnmail-split-methods
10069 The @code{nnmail-split-methods} variable says how the incoming mail is
10070 to be split into groups.
10073 (setq nnmail-split-methods
10074 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
10075 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
10076 ("mail.other" "")))
10079 This variable is a list of lists, where the first element of each of
10080 these lists is the name of the mail group (they do not have to be called
10081 something beginning with @samp{mail}, by the way), and the second
10082 element is a regular expression used on the header of each mail to
10083 determine if it belongs in this mail group. The first string may
10084 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
10085 insert sub-expressions from the matched text. For instance:
10088 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
10091 The second element can also be a function. In that case, it will be
10092 called narrowed to the headers with the first element of the rule as the
10093 argument. It should return a non-@code{nil} value if it thinks that the
10094 mail belongs in that group.
10096 The last of these groups should always be a general one, and the regular
10097 expression should @emph{always} be @samp{} so that it matches any mails
10098 that haven't been matched by any of the other regexps. (These rules are
10099 processed from the beginning of the alist toward the end. The first
10100 rule to make a match will "win", unless you have crossposting enabled.
10101 In that case, all matching rules will "win".)
10103 If you like to tinker with this yourself, you can set this variable to a
10104 function of your choice. This function will be called without any
10105 arguments in a buffer narrowed to the headers of an incoming mail
10106 message. The function should return a list of group names that it
10107 thinks should carry this mail message.
10109 Note that the mail backends are free to maul the poor, innocent,
10110 incoming headers all they want to. They all add @code{Lines} headers;
10111 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
10112 @code{From<SPACE>} line to something else.
10114 @vindex nnmail-crosspost
10115 The mail backends all support cross-posting. If several regexps match,
10116 the mail will be ``cross-posted'' to all those groups.
10117 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
10118 that no articles are crossposted to the general (@samp{}) group.
10120 @vindex nnmail-crosspost-link-function
10123 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
10124 the crossposted articles. However, not all file systems support hard
10125 links. If that's the case for you, set
10126 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
10127 variable is @code{add-name-to-file} by default.)
10129 @kindex M-x nnmail-split-history
10130 @kindex nnmail-split-history
10131 If you wish to see where the previous mail split put the messages, you
10132 can use the @kbd{M-x nnmail-split-history} command.
10134 Gnus gives you all the opportunity you could possibly want for shooting
10135 yourself in the foot. Let's say you create a group that will contain
10136 all the mail you get from your boss. And then you accidentally
10137 unsubscribe from the group. Gnus will still put all the mail from your
10138 boss in the unsubscribed group, and so, when your boss mails you ``Have
10139 that report ready by Monday or you're fired!'', you'll never see it and,
10140 come Tuesday, you'll still believe that you're gainfully employed while
10141 you really should be out collecting empty bottles to save up for next
10142 month's rent money.
10146 @subsection Mail Sources
10148 Mail can be gotten from many different sources---the mail spool, from a
10149 POP mail server, or from a procmail directory, for instance.
10152 * Mail Source Specifiers:: How to specify what a mail source is.
10153 * Mail Source Customization:: Some variables that influence things.
10154 * Fetching Mail:: Using the mail source specifiers.
10158 @node Mail Source Specifiers
10159 @subsubsection Mail Source Specifiers
10161 @cindex mail server
10164 @cindex mail source
10166 You tell Gnus how to fetch mail by setting @code{mail-sources}
10167 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
10172 (pop :server "pop3.mailserver.com" :user "myname")
10175 As can be observed, a mail source specifier is a list where the first
10176 element is a @dfn{mail source type}, followed by an arbitrary number of
10177 @dfn{keywords}. Keywords that are not explicitly specified are given
10180 The following mail source types are available:
10184 Get mail from a single file; typically from the mail spool.
10190 The path of the file. Defaults to the value of the @code{MAIL}
10191 environment variable or @file{/usr/mail/spool/user-name}.
10194 An example file mail source:
10197 (file :path "/usr/spool/mail/user-name")
10200 Or using the default path:
10207 Get mail from several files in a directory. This is typically used when
10208 you have procmail split the incoming mail into several files.
10214 The path of the directory where the files are. There is no default
10218 Only files ending with this suffix are used. The default is
10222 Only files that have this predicate return non-@code{nil} are returned.
10223 The default is @code{identity}. This is used as an additional
10224 filter---only files that have the right suffix @emph{and} satisfy this
10225 predicate are considered.
10229 Script run before/after fetching mail.
10233 An example directory mail source:
10236 (directory :path "/home/user-name/procmail-dir/"
10241 Get mail from a POP server.
10247 The name of the POP server. The default is taken from the
10248 @code{MAILHOST} environment variable.
10251 The port number of the POP server. The default is @samp{pop3}.
10254 The user name to give to the POP server. The default is the login
10258 The password to give to the POP server. If not specified, the user is
10262 The program to use to fetch mail from the POP server. This is should be
10263 a @code{format}-like string. Here's an example:
10266 fetchmail %u@@%s -P %p %t
10269 The valid format specifier characters are:
10273 The name of the file the mail is to be moved to. This must always be
10274 included in this string.
10277 The name of the server.
10280 The port number of the server.
10283 The user name to use.
10286 The password to use.
10289 The values used for these specs are taken from the values you give the
10290 corresponding keywords.
10293 A script to be run before fetching the mail. The syntax is the same as
10294 the @code{:program} keyword. This can also be a function to be run.
10297 A script to be run after fetching the mail. The syntax is the same as
10298 the @code{:program} keyword. This can also be a function to be run.
10301 The function to use to fetch mail from the POP server. The function is
10302 called with one parameter---the name of the file where the mail should
10305 @item :authentication
10306 This can be either the symbol @code{password} or the symbol @code{apop}
10307 and says what authentication scheme to use. The default is
10312 If the @code{:program} and @code{:function} keywords aren't specified,
10313 @code{pop3-movemail} will be used.
10315 Here are some examples. Fetch from the default POP server, using the
10316 default user name, and default fetcher:
10322 Fetch from a named server with a named user and password:
10325 (pop :server "my.pop.server"
10326 :user "user-name" :password "secret")
10329 Use @samp{movemail} to move the mail:
10332 (pop :program "movemail po:%u %t %p")
10336 Get mail from a maildir. This is a type of mailbox currently only
10337 supported by qmail, where each file in a special directory contains
10344 The path of the directory where the mails are stored. The default is
10345 @samp{~/Maildir/new}.
10347 If you sometimes look at your mail through a pop3 daemon before fetching
10348 them with Gnus, you may also have to fetch your mails from the
10349 @code{cur} directory inside the maildir, like in the following example.
10353 An example maildir mail source:
10356 (maildir :path "/home/user-name/Maildir/cur")
10362 @node Mail Source Customization
10363 @subsubsection Mail Source Customization
10365 The following is a list of variables that influence how the mail is
10366 fetched. You would normally not need to set or change any of these
10370 @item mail-source-crash-box
10371 @vindex mail-source-crash-box
10372 File where mail will be stored while processing it. The default is
10373 @file{~/.emacs-mail-crash-box}.
10375 @item mail-source-delete-incoming
10376 @vindex mail-source-delete-incoming
10377 If non-@code{nil}, delete incoming files after handling them.
10379 @item mail-source-directory
10380 @vindex mail-source-directory
10381 Directory where files (if any) will be stored. The default is
10382 @file{~/Mail/}. At present, the only thing this is used for is to say
10383 where the incoming files will be stored if the previous variable is
10386 @item mail-source-default-file-modes
10387 @vindex mail-source-default-file-modes
10388 All new mail files will get this file mode. The default is 384.
10393 @node Fetching Mail
10394 @subsubsection Fetching Mail
10396 @vindex mail-sources
10397 @vindex nnmail-spool-file
10398 The way to actually tell Gnus where to get new mail from is to set
10399 @code{mail-sources} to a list of mail source specifiers
10400 (@pxref{Mail Source Specifiers}).
10402 If this variable (and the obsolescent @code{nnmail-spool-file}) is
10403 @code{nil}, the mail backends will never attempt to fetch mail by
10406 If you want to fetch mail both from your local spool as well as a POP
10407 mail server, you'd say something like:
10412 (pop :server "pop3.mail.server"
10413 :password "secret")))
10416 Or, if you don't want to use any of the keyword defaults:
10420 '((file :path "/var/spool/mail/user-name")
10421 (pop :server "pop3.mail.server"
10424 :password "secret")))
10428 When you use a mail backend, Gnus will slurp all your mail from your
10429 inbox and plonk it down in your home directory. Gnus doesn't move any
10430 mail if you're not using a mail backend---you have to do a lot of magic
10431 invocations first. At the time when you have finished drawing the
10432 pentagram, lightened the candles, and sacrificed the goat, you really
10433 shouldn't be too surprised when Gnus moves your mail.
10437 @node Mail Backend Variables
10438 @subsection Mail Backend Variables
10440 These variables are (for the most part) pertinent to all the various
10444 @vindex nnmail-read-incoming-hook
10445 @item nnmail-read-incoming-hook
10446 The mail backends all call this hook after reading new mail. You can
10447 use this hook to notify any mail watch programs, if you want to.
10449 @vindex nnmail-split-hook
10450 @item nnmail-split-hook
10451 @findex article-decode-encoded-words
10452 @findex RFC1522 decoding
10453 @findex RFC2047 decoding
10454 Hook run in the buffer where the mail headers of each message is kept
10455 just before the splitting based on these headers is done. The hook is
10456 free to modify the buffer contents in any way it sees fit---the buffer
10457 is discarded after the splitting has been done, and no changes performed
10458 in the buffer will show up in any files.
10459 @code{gnus-article-decode-encoded-words} is one likely function to add
10462 @vindex nnmail-pre-get-new-mail-hook
10463 @vindex nnmail-post-get-new-mail-hook
10464 @item nnmail-pre-get-new-mail-hook
10465 @itemx nnmail-post-get-new-mail-hook
10466 These are two useful hooks executed when treating new incoming
10467 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
10468 starting to handle the new mail) and
10469 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
10470 is done). Here's and example of using these two hooks to change the
10471 default file modes the new mail files get:
10474 (add-hook 'gnus-pre-get-new-mail-hook
10475 (lambda () (set-default-file-modes 511)))
10477 (add-hook 'gnus-post-get-new-mail-hook
10478 (lambda () (set-default-file-modes 551)))
10481 @item nnmail-use-long-file-names
10482 @vindex nnmail-use-long-file-names
10483 If non-@code{nil}, the mail backends will use long file and directory
10484 names. Groups like @samp{mail.misc} will end up in directories
10485 (assuming use of @code{nnml} backend) or files (assuming use of
10486 @code{nnfolder} backend) like @file{mail.misc}. If it is @code{nil},
10487 the same group will end up in @file{mail/misc}.
10489 @item nnmail-delete-file-function
10490 @vindex nnmail-delete-file-function
10491 @findex delete-file
10492 Function called to delete files. It is @code{delete-file} by default.
10494 @item nnmail-cache-accepted-message-ids
10495 @vindex nnmail-cache-accepted-message-ids
10496 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
10497 the backend (via @code{Gcc}, for instance) into the mail duplication
10498 discovery cache. The default is @code{nil}.
10503 @node Fancy Mail Splitting
10504 @subsection Fancy Mail Splitting
10505 @cindex mail splitting
10506 @cindex fancy mail splitting
10508 @vindex nnmail-split-fancy
10509 @findex nnmail-split-fancy
10510 If the rather simple, standard method for specifying how to split mail
10511 doesn't allow you to do what you want, you can set
10512 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
10513 play with the @code{nnmail-split-fancy} variable.
10515 Let's look at an example value of this variable first:
10518 ;; Messages from the mailer daemon are not crossposted to any of
10519 ;; the ordinary groups. Warnings are put in a separate group
10520 ;; from real errors.
10521 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
10523 ;; Non-error messages are crossposted to all relevant
10524 ;; groups, but we don't crosspost between the group for the
10525 ;; (ding) list and the group for other (ding) related mail.
10526 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
10527 ("subject" "ding" "ding.misc"))
10528 ;; Other mailing lists...
10529 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
10530 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
10531 ;; Both lists below have the same suffix, so prevent
10532 ;; cross-posting to mkpkg.list of messages posted only to
10533 ;; the bugs- list, but allow cross-posting when the
10534 ;; message was really cross-posted.
10535 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
10536 (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
10538 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
10539 ;; Unmatched mail goes to the catch all group.
10543 This variable has the format of a @dfn{split}. A split is a (possibly)
10544 recursive structure where each split may contain other splits. Here are
10545 the five possible split syntaxes:
10550 @samp{group}: If the split is a string, that will be taken as a group
10551 name. Normal regexp match expansion will be done. See below for
10555 @var{(FIELD VALUE [- RESTRICT [- RESTRICT [...]]] SPLIT)}: If the split
10556 is a list, the first element of which is a string, then store the
10557 message as specified by SPLIT, if header FIELD (a regexp) contains VALUE
10558 (also a regexp). If RESTRICT (yet another regexp) matches some string
10559 after FIELD and before the end of the matched VALUE, the SPLIT is
10560 ignored. If none of the RESTRICT clauses match, SPLIT is processed.
10563 @var{(| SPLIT...)}: If the split is a list, and the first element is
10564 @code{|} (vertical bar), then process each SPLIT until one of them
10565 matches. A SPLIT is said to match if it will cause the mail message to
10566 be stored in one or more groups.
10569 @var{(& SPLIT...)}: If the split is a list, and the first element is
10570 @code{&}, then process all SPLITs in the list.
10573 @code{junk}: If the split is the symbol @code{junk}, then don't save
10574 this message. Use with extreme caution.
10577 @var{(: function arg1 arg2 ...)}: If the split is a list, and the first
10578 element is @code{:}, then the second element will be called as a
10579 function with @var{args} given as arguments. The function should return
10583 @var{(! FUNC SPLIT)}: If the split is a list, and the first element
10584 is @code{!}, then SPLIT will be processed, and FUNC will be called as a
10585 function with the result of SPLIT as argument. FUNC should return a split.
10588 @code{nil}: If the split is @code{nil}, it is ignored.
10592 In these splits, @var{FIELD} must match a complete field name.
10593 @var{VALUE} must match a complete word according to the fundamental mode
10594 syntax table. You can use @code{.*} in the regexps to match partial
10595 field names or words. In other words, all @var{VALUE}'s are wrapped in
10596 @samp{\<} and @samp{\>} pairs.
10598 @vindex nnmail-split-abbrev-alist
10599 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
10600 are expanded as specified by the variable
10601 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
10602 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
10605 @vindex nnmail-split-fancy-syntax-table
10606 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
10607 when all this splitting is performed.
10609 If you want to have Gnus create groups dynamically based on some
10610 information in the headers (i.e., do @code{replace-match}-like
10611 substitutions in the group names), you can say things like:
10614 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
10617 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
10618 will be filed in @samp{mail.debian.foo}.
10620 If the string contains the element @samp{\&}, then the previously
10621 matched string will be substituted. Similarly, the elements @samp{\\1}
10622 up to @samp{\\9} will be substituted with the text matched by the
10623 groupings 1 through 9.
10626 @node Group Mail Splitting
10627 @subsection Group Mail Splitting
10628 @cindex mail splitting
10629 @cindex group mail splitting
10631 @findex gnus-group-split
10632 If you subscribe to dozens of mailing lists but you don't want to
10633 maintain mail splitting rules manually, group mail splitting is for you.
10634 You just have to set @var{to-list} and/or @var{to-address} in group
10635 parameters or group customization and set @code{nnmail-split-methods} to
10636 @code{gnus-group-split}. This splitting function will scan all groups
10637 for those parameters and split mail accordingly, i.e., messages posted
10638 from or to the addresses specified in the parameters @var{to-list} or
10639 @var{to-address} of a mail group will be stored in that group.
10641 Sometimes, mailing lists have multiple addresses, and you may want mail
10642 splitting to recognize them all: just set the @var{extra-aliases} group
10643 parameter to the list of additional addresses and it's done. If you'd
10644 rather use a regular expression, set @var{split-regexp}.
10646 All these parameters in a group will be used to create an
10647 @code{nnmail-split-fancy} split, in which the @var{FIELD} is @samp{any},
10648 the @var{VALUE} is a single regular expression that matches
10649 @var{to-list}, @var{to-address}, all of @var{extra-aliases} and all
10650 matches of @var{split-regexp}, and the @var{SPLIT} is the name of the
10651 group. @var{RESTRICT}s are also supported: just set the
10652 @var{split-exclude} parameter to a list of regular expressions.
10654 If you can't get the right split to be generated using all these
10655 parameters, or you just need something fancier, you can set the
10656 parameter @var{split-spec} to an @code{nnmail-split-fancy} split. In
10657 this case, all other aforementioned parameters will be ignored by
10658 @code{gnus-group-split}. In particular, @var{split-spec} may be set to
10659 @code{nil}, in which case the group will be ignored by
10660 @code{gnus-group-split}.
10662 @vindex gnus-group-split-default-catch-all-group
10663 @code{gnus-group-split} will do cross-posting on all groups that match,
10664 by defining a single @code{&} fancy split containing one split for each
10665 group. If a message doesn't match any split, it will be stored in the
10666 group named in @code{gnus-group-split-default-catch-all-group}, unless
10667 some group has @var{split-spec} set to @code{catch-all}, in which case
10668 that group is used as the catch-all group. Note that, in this case,
10669 there's no cross-posting, as a @code{|} fancy split encloses the
10670 @code{&} split and the catch-all group.
10672 It's time for an example. Assume the following group parameters have
10677 ((to-address . "bar@@femail.com")
10678 (split-regexp . ".*@@femail\\.com"))
10680 ((to-list . "foo@@nowhere.gov")
10681 (extra-aliases "foo@@localhost" "foo-redist@@home")
10682 (split-exclude "bugs-foo" "rambling-foo")
10683 (admin-address . "foo-request@@nowhere.gov"))
10685 ((split-spec . catch-all))
10688 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
10689 behave as if @code{nnmail-split-fancy} had been selected and variable
10690 @code{nnmail-split-fancy} had been set as follows:
10693 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
10694 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
10695 - "bugs-foo" - "rambling-foo" "mail.foo"))
10699 @findex gnus-group-split-fancy
10700 If you'd rather not use group splitting for all your mail groups, you
10701 may use it for only some of them, by using @code{nnmail-split-fancy}
10705 (: gnus-mlsplt-fancy GROUPS NO-CROSSPOST CATCH-ALL)
10708 @var{GROUPS} may be a regular expression or a list of group names whose
10709 parameters will be scanned to generate the output split.
10710 @var{NO-CROSSPOST} can be used to disable cross-posting; in this case, a
10711 single @code{|} split will be output. @var{CATCH-ALL} may be the name
10712 of a group to be used as the default catch-all group. If
10713 @var{CATCH-ALL} is @code{nil}, or if @var{SPLIT-REGEXP} matches the
10714 empty string in any selected group, no catch-all split will be issued.
10715 Otherwise, if some group has @var{SPLIT-SPEC} set to @code{catch-all},
10716 this group will override the value of the @var{CATCH-ALL} argument.
10718 @findex gnus-group-split-setup
10719 Unfortunately, scanning all groups and their parameters can be quite
10720 slow, especially considering that it has to be done for every message.
10721 But don't despair! The function @code{gnus-group-split-setup} can be
10722 used to select @code{gnus-group-split} in a much more efficient way. It
10723 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
10724 @code{nnmail-split-fancy} to the split produced by
10725 @code{gnus-group-split-fancy}. Thus, the group parameters are only
10726 scanned once, no matter how many messages are split.
10728 @findex gnus-group-split-update
10729 However, if you change group parameters, you have to update
10730 @code{nnmail-split-fancy} manually. You can do it by running
10731 @code{gnus-group-split-update}. If you'd rather have it updated
10732 automatically, just tell @code{gnus-group-split-setup} to do it for
10733 you. For example, add to your @file{.gnus}:
10736 (gnus-group-split-setup AUTO-UPDATE CATCH-ALL)
10739 If @var{AUTO-UPDATE} is non-@code{nil}, @code{gnus-group-split-update}
10740 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
10741 have to worry about updating @code{nnmail-split-fancy} again. If you
10742 don't omit @var{CATCH-ALL} (it's optional),
10743 @code{gnus-group-split-default-catch-all-group} will be set to its
10746 @vindex gnus-group-split-updated-hook
10747 Because you may want to change @code{nnmail-split-fancy} after it is set
10748 by @code{gnus-group-split-update}, this function will run
10749 @code{gnus-group-split-updated-hook} just before finishing.
10751 @node Incorporating Old Mail
10752 @subsection Incorporating Old Mail
10754 Most people have lots of old mail stored in various file formats. If
10755 you have set up Gnus to read mail using one of the spiffy Gnus mail
10756 backends, you'll probably wish to have that old mail incorporated into
10759 Doing so can be quite easy.
10761 To take an example: You're reading mail using @code{nnml}
10762 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
10763 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
10764 file filled with important, but old, mail. You want to move it into
10765 your @code{nnml} groups.
10771 Go to the group buffer.
10774 Type `G f' and give the path to the mbox file when prompted to create an
10775 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
10778 Type `SPACE' to enter the newly created group.
10781 Type `M P b' to process-mark all articles in this group's buffer
10782 (@pxref{Setting Process Marks}).
10785 Type `B r' to respool all the process-marked articles, and answer
10786 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
10789 All the mail messages in the mbox file will now also be spread out over
10790 all your @code{nnml} groups. Try entering them and check whether things
10791 have gone without a glitch. If things look ok, you may consider
10792 deleting the mbox file, but I wouldn't do that unless I was absolutely
10793 sure that all the mail has ended up where it should be.
10795 Respooling is also a handy thing to do if you're switching from one mail
10796 backend to another. Just respool all the mail in the old mail groups
10797 using the new mail backend.
10800 @node Expiring Mail
10801 @subsection Expiring Mail
10802 @cindex article expiry
10804 Traditional mail readers have a tendency to remove mail articles when
10805 you mark them as read, in some way. Gnus takes a fundamentally
10806 different approach to mail reading.
10808 Gnus basically considers mail just to be news that has been received in
10809 a rather peculiar manner. It does not think that it has the power to
10810 actually change the mail, or delete any mail messages. If you enter a
10811 mail group, and mark articles as ``read'', or kill them in some other
10812 fashion, the mail articles will still exist on the system. I repeat:
10813 Gnus will not delete your old, read mail. Unless you ask it to, of
10816 To make Gnus get rid of your unwanted mail, you have to mark the
10817 articles as @dfn{expirable}. This does not mean that the articles will
10818 disappear right away, however. In general, a mail article will be
10819 deleted from your system if, 1) it is marked as expirable, AND 2) it is
10820 more than one week old. If you do not mark an article as expirable, it
10821 will remain on your system until hell freezes over. This bears
10822 repeating one more time, with some spurious capitalizations: IF you do
10823 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
10825 @vindex gnus-auto-expirable-newsgroups
10826 You do not have to mark articles as expirable by hand. Groups that
10827 match the regular expression @code{gnus-auto-expirable-newsgroups} will
10828 have all articles that you read marked as expirable automatically. All
10829 articles marked as expirable have an @samp{E} in the first
10830 column in the summary buffer.
10832 By default, if you have auto expiry switched on, Gnus will mark all the
10833 articles you read as expirable, no matter if they were read or unread
10834 before. To avoid having articles marked as read marked as expirable
10835 automatically, you can put something like the following in your
10838 @vindex gnus-mark-article-hook
10840 (remove-hook 'gnus-mark-article-hook
10841 'gnus-summary-mark-read-and-unread-as-read)
10842 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
10845 Note that making a group auto-expirable doesn't mean that all read
10846 articles are expired---only the articles marked as expirable
10847 will be expired. Also note that using the @kbd{d} command won't make
10848 groups expirable---only semi-automatic marking of articles as read will
10849 mark the articles as expirable in auto-expirable groups.
10851 Let's say you subscribe to a couple of mailing lists, and you want the
10852 articles you have read to disappear after a while:
10855 (setq gnus-auto-expirable-newsgroups
10856 "mail.nonsense-list\\|mail.nice-list")
10859 Another way to have auto-expiry happen is to have the element
10860 @code{auto-expire} in the group parameters of the group.
10862 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
10863 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
10864 don't really mix very well.
10866 @vindex nnmail-expiry-wait
10867 The @code{nnmail-expiry-wait} variable supplies the default time an
10868 expirable article has to live. Gnus starts counting days from when the
10869 message @emph{arrived}, not from when it was sent. The default is seven
10872 Gnus also supplies a function that lets you fine-tune how long articles
10873 are to live, based on what group they are in. Let's say you want to
10874 have one month expiry period in the @samp{mail.private} group, a one day
10875 expiry period in the @samp{mail.junk} group, and a six day expiry period
10878 @vindex nnmail-expiry-wait-function
10880 (setq nnmail-expiry-wait-function
10882 (cond ((string= group "mail.private")
10884 ((string= group "mail.junk")
10886 ((string= group "important")
10892 The group names this function is fed are ``unadorned'' group
10893 names---no @samp{nnml:} prefixes and the like.
10895 The @code{nnmail-expiry-wait} variable and
10896 @code{nnmail-expiry-wait-function} function can either be a number (not
10897 necessarily an integer) or one of the symbols @code{immediate} or
10900 You can also use the @code{expiry-wait} group parameter to selectively
10901 change the expiry period (@pxref{Group Parameters}).
10903 @vindex nnmail-keep-last-article
10904 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
10905 expire the final article in a mail newsgroup. This is to make life
10906 easier for procmail users.
10908 @vindex gnus-total-expirable-newsgroups
10909 By the way: That line up there, about Gnus never expiring non-expirable
10910 articles, is a lie. If you put @code{total-expire} in the group
10911 parameters, articles will not be marked as expirable, but all read
10912 articles will be put through the expiry process. Use with extreme
10913 caution. Even more dangerous is the
10914 @code{gnus-total-expirable-newsgroups} variable. All groups that match
10915 this regexp will have all read articles put through the expiry process,
10916 which means that @emph{all} old mail articles in the groups in question
10917 will be deleted after a while. Use with extreme caution, and don't come
10918 crying to me when you discover that the regexp you used matched the
10919 wrong group and all your important mail has disappeared. Be a
10920 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
10923 Most people make most of their mail groups total-expirable, though.
10925 @vindex gnus-inhibit-user-auto-expire
10926 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
10927 commands will not mark an article as expirable, even if the group has
10928 auto-expire turned on.
10932 @subsection Washing Mail
10933 @cindex mail washing
10934 @cindex list server brain damage
10935 @cindex incoming mail treatment
10937 Mailers and list servers are notorious for doing all sorts of really,
10938 really stupid things with mail. ``Hey, RFC822 doesn't explicitly
10939 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
10940 end of all lines passing through our server, so let's do that!!!!1!''
10941 Yes, but RFC822 wasn't designed to be read by morons. Things that were
10942 considered to be self-evident were not discussed. So. Here we are.
10944 Case in point: The German version of Microsoft Exchange adds @samp{AW:
10945 } to the subjects of replies instead of @samp{Re: }. I could pretend to
10946 be shocked and dismayed by this, but I haven't got the energy. It is to
10949 Gnus provides a plethora of functions for washing articles while
10950 displaying them, but it might be nicer to do the filtering before
10951 storing the mail to disc. For that purpose, we have three hooks and
10952 various functions that can be put in these hooks.
10955 @item nnmail-prepare-incoming-hook
10956 @vindex nnmail-prepare-incoming-hook
10957 This hook is called before doing anything with the mail and is meant for
10958 grand, sweeping gestures. It is called in a buffer that contains all
10959 the new, incoming mail. Functions to be used include:
10962 @item nnheader-ms-strip-cr
10963 @findex nnheader-ms-strip-cr
10964 Remove trailing carriage returns from each line. This is default on
10965 Emacs running on MS machines.
10969 @item nnmail-prepare-incoming-header-hook
10970 @vindex nnmail-prepare-incoming-header-hook
10971 This hook is called narrowed to each header. It can be used when
10972 cleaning up the headers. Functions that can be used include:
10975 @item nnmail-remove-leading-whitespace
10976 @findex nnmail-remove-leading-whitespace
10977 Clear leading white space that ``helpful'' listservs have added to the
10978 headers to make them look nice. Aaah.
10980 @item nnmail-remove-list-identifiers
10981 @findex nnmail-remove-list-identifiers
10982 Some list servers add an identifier---for example, @samp{(idm)}---to the
10983 beginning of all @code{Subject} headers. I'm sure that's nice for
10984 people who use stone age mail readers. This function will remove
10985 strings that match the @code{nnmail-list-identifiers} regexp, which can
10986 also be a list of regexp.
10988 For instance, if you want to remove the @samp{(idm)} and the
10989 @samp{nagnagnag} identifiers:
10992 (setq nnmail-list-identifiers
10993 '("(idm)" "nagnagnag"))
10996 This can also be done non-destructively with
10997 @code{gnus-list-identifiers}, @xref{Article Hiding}.
10999 @item nnmail-remove-tabs
11000 @findex nnmail-remove-tabs
11001 Translate all @samp{TAB} characters into @samp{SPACE} characters.
11003 @item nnmail-fix-eudora-headers
11004 @findex nnmail-fix-eudora-headers
11006 Eudora produces broken @code{References} headers, but OK
11007 @code{In-Reply-To} headers. This function will get rid of the
11008 @code{References} headers.
11012 @item nnmail-prepare-incoming-message-hook
11013 @vindex nnmail-prepare-incoming-message-hook
11014 This hook is called narrowed to each message. Functions to be used
11018 @item article-de-quoted-unreadable
11019 @findex article-de-quoted-unreadable
11020 Decode Quoted Readable encoding.
11027 @subsection Duplicates
11029 @vindex nnmail-treat-duplicates
11030 @vindex nnmail-message-id-cache-length
11031 @vindex nnmail-message-id-cache-file
11032 @cindex duplicate mails
11033 If you are a member of a couple of mailing lists, you will sometimes
11034 receive two copies of the same mail. This can be quite annoying, so
11035 @code{nnmail} checks for and treats any duplicates it might find. To do
11036 this, it keeps a cache of old @code{Message-ID}s---
11037 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
11038 default. The approximate maximum number of @code{Message-ID}s stored
11039 there is controlled by the @code{nnmail-message-id-cache-length}
11040 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
11041 stored.) If all this sounds scary to you, you can set
11042 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
11043 default), and @code{nnmail} won't delete duplicate mails. Instead it
11044 will insert a warning into the head of the mail saying that it thinks
11045 that this is a duplicate of a different message.
11047 This variable can also be a function. If that's the case, the function
11048 will be called from a buffer narrowed to the message in question with
11049 the @code{Message-ID} as a parameter. The function must return either
11050 @code{nil}, @code{warn}, or @code{delete}.
11052 You can turn this feature off completely by setting the variable to
11055 If you want all the duplicate mails to be put into a special
11056 @dfn{duplicates} group, you could do that using the normal mail split
11060 (setq nnmail-split-fancy
11061 '(| ;; Messages duplicates go to a separate group.
11062 ("gnus-warning" "duplication of message" "duplicate")
11063 ;; Message from daemons, postmaster, and the like to another.
11064 (any mail "mail.misc")
11071 (setq nnmail-split-methods
11072 '(("duplicates" "^Gnus-Warning:")
11077 Here's a neat feature: If you know that the recipient reads her mail
11078 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
11079 @code{delete}, you can send her as many insults as you like, just by
11080 using a @code{Message-ID} of a mail that you know that she's already
11081 received. Think of all the fun! She'll never see any of it! Whee!
11084 @node Not Reading Mail
11085 @subsection Not Reading Mail
11087 If you start using any of the mail backends, they have the annoying
11088 habit of assuming that you want to read mail with them. This might not
11089 be unreasonable, but it might not be what you want.
11091 If you set @code{mail-sources} and @code{nnmail-spool-file} to
11092 @code{nil}, none of the backends will ever attempt to read incoming
11093 mail, which should help.
11095 @vindex nnbabyl-get-new-mail
11096 @vindex nnmbox-get-new-mail
11097 @vindex nnml-get-new-mail
11098 @vindex nnmh-get-new-mail
11099 @vindex nnfolder-get-new-mail
11100 This might be too much, if, for instance, you are reading mail quite
11101 happily with @code{nnml} and just want to peek at some old @sc{rmail}
11102 file you have stashed away with @code{nnbabyl}. All backends have
11103 variables called backend-@code{get-new-mail}. If you want to disable
11104 the @code{nnbabyl} mail reading, you edit the virtual server for the
11105 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
11107 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
11108 narrowed to the article to be saved before saving it when reading
11112 @node Choosing a Mail Backend
11113 @subsection Choosing a Mail Backend
11115 Gnus will read the mail spool when you activate a mail group. The mail
11116 file is first copied to your home directory. What happens after that
11117 depends on what format you want to store your mail in.
11119 There are five different mail backends in the standard Gnus, and more
11120 backends are available separately. The mail backend most people use
11121 (because it is the fastest and most flexible) is @code{nnml}
11122 (@pxref{Mail Spool}).
11125 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
11126 * Rmail Babyl:: Emacs programs use the rmail babyl format.
11127 * Mail Spool:: Store your mail in a private spool?
11128 * MH Spool:: An mhspool-like backend.
11129 * Mail Folders:: Having one file for each group.
11130 * Comparing Mail Backends:: An in-depth looks at pros and cons.
11134 @node Unix Mail Box
11135 @subsubsection Unix Mail Box
11137 @cindex unix mail box
11139 @vindex nnmbox-active-file
11140 @vindex nnmbox-mbox-file
11141 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
11142 mail. @code{nnmbox} will add extra headers to each mail article to say
11143 which group it belongs in.
11145 Virtual server settings:
11148 @item nnmbox-mbox-file
11149 @vindex nnmbox-mbox-file
11150 The name of the mail box in the user's home directory.
11152 @item nnmbox-active-file
11153 @vindex nnmbox-active-file
11154 The name of the active file for the mail box.
11156 @item nnmbox-get-new-mail
11157 @vindex nnmbox-get-new-mail
11158 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
11164 @subsubsection Rmail Babyl
11168 @vindex nnbabyl-active-file
11169 @vindex nnbabyl-mbox-file
11170 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
11171 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
11172 article to say which group it belongs in.
11174 Virtual server settings:
11177 @item nnbabyl-mbox-file
11178 @vindex nnbabyl-mbox-file
11179 The name of the rmail mbox file.
11181 @item nnbabyl-active-file
11182 @vindex nnbabyl-active-file
11183 The name of the active file for the rmail box.
11185 @item nnbabyl-get-new-mail
11186 @vindex nnbabyl-get-new-mail
11187 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
11192 @subsubsection Mail Spool
11194 @cindex mail @sc{nov} spool
11196 The @dfn{nnml} spool mail format isn't compatible with any other known
11197 format. It should be used with some caution.
11199 @vindex nnml-directory
11200 If you use this backend, Gnus will split all incoming mail into files,
11201 one file for each mail, and put the articles into the corresponding
11202 directories under the directory specified by the @code{nnml-directory}
11203 variable. The default value is @file{~/Mail/}.
11205 You do not have to create any directories beforehand; Gnus will take
11208 If you have a strict limit as to how many files you are allowed to store
11209 in your account, you should not use this backend. As each mail gets its
11210 own file, you might very well occupy thousands of inodes within a few
11211 weeks. If this is no problem for you, and it isn't a problem for you
11212 having your friendly systems administrator walking around, madly,
11213 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
11214 know that this is probably the fastest format to use. You do not have
11215 to trudge through a big mbox file just to read your new mail.
11217 @code{nnml} is probably the slowest backend when it comes to article
11218 splitting. It has to create lots of files, and it also generates
11219 @sc{nov} databases for the incoming mails. This makes it the fastest
11220 backend when it comes to reading mail.
11222 Virtual server settings:
11225 @item nnml-directory
11226 @vindex nnml-directory
11227 All @code{nnml} directories will be placed under this directory.
11229 @item nnml-active-file
11230 @vindex nnml-active-file
11231 The active file for the @code{nnml} server.
11233 @item nnml-newsgroups-file
11234 @vindex nnml-newsgroups-file
11235 The @code{nnml} group descriptions file. @xref{Newsgroups File
11238 @item nnml-get-new-mail
11239 @vindex nnml-get-new-mail
11240 If non-@code{nil}, @code{nnml} will read incoming mail.
11242 @item nnml-nov-is-evil
11243 @vindex nnml-nov-is-evil
11244 If non-@code{nil}, this backend will ignore any @sc{nov} files.
11246 @item nnml-nov-file-name
11247 @vindex nnml-nov-file-name
11248 The name of the @sc{nov} files. The default is @file{.overview}.
11250 @item nnml-prepare-save-mail-hook
11251 @vindex nnml-prepare-save-mail-hook
11252 Hook run narrowed to an article before saving.
11256 @findex nnml-generate-nov-databases
11257 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
11258 you can do a complete update by typing @kbd{M-x
11259 nnml-generate-nov-databases}. This command will trawl through the
11260 entire @code{nnml} hierarchy, looking at each and every article, so it
11261 might take a while to complete. A better interface to this
11262 functionality can be found in the server buffer (@pxref{Server
11267 @subsubsection MH Spool
11269 @cindex mh-e mail spool
11271 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
11272 @sc{nov} databases and it doesn't keep an active file. This makes
11273 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
11274 makes it easier to write procmail scripts for.
11276 Virtual server settings:
11279 @item nnmh-directory
11280 @vindex nnmh-directory
11281 All @code{nnmh} directories will be located under this directory.
11283 @item nnmh-get-new-mail
11284 @vindex nnmh-get-new-mail
11285 If non-@code{nil}, @code{nnmh} will read incoming mail.
11288 @vindex nnmh-be-safe
11289 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
11290 sure that the articles in the folder are actually what Gnus thinks they
11291 are. It will check date stamps and stat everything in sight, so
11292 setting this to @code{t} will mean a serious slow-down. If you never
11293 use anything but Gnus to read the @code{nnmh} articles, you do not have
11294 to set this variable to @code{t}.
11299 @subsubsection Mail Folders
11301 @cindex mbox folders
11302 @cindex mail folders
11304 @code{nnfolder} is a backend for storing each mail group in a separate
11305 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
11306 will add extra headers to keep track of article numbers and arrival
11309 Virtual server settings:
11312 @item nnfolder-directory
11313 @vindex nnfolder-directory
11314 All the @code{nnfolder} mail boxes will be stored under this directory.
11316 @item nnfolder-active-file
11317 @vindex nnfolder-active-file
11318 The name of the active file.
11320 @item nnfolder-newsgroups-file
11321 @vindex nnfolder-newsgroups-file
11322 The name of the group descriptions file. @xref{Newsgroups File Format}.
11324 @item nnfolder-get-new-mail
11325 @vindex nnfolder-get-new-mail
11326 If non-@code{nil}, @code{nnfolder} will read incoming mail.
11328 @item nnfolder-save-buffer-hook
11329 @vindex nnfolder-save-buffer-hook
11330 @cindex backup files
11331 Hook run before saving the folders. Note that Emacs does the normal
11332 backup renaming of files even with the @code{nnfolder} buffers. If you
11333 wish to switch this off, you could say something like the following in
11334 your @file{.emacs} file:
11337 (defun turn-off-backup ()
11338 (set (make-local-variable 'backup-inhibited) t))
11340 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
11343 @item nnfolder-delete-mail-hook
11344 @vindex nnfolder-delete-mail-hook
11345 Hook run in a buffer narrowed to the message that is to be deleted.
11346 This function can be used to copy the message to somewhere else, or to
11347 extract some information from it before removing it.
11352 @findex nnfolder-generate-active-file
11353 @kindex M-x nnfolder-generate-active-file
11354 If you have lots of @code{nnfolder}-like files you'd like to read with
11355 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
11356 command to make @code{nnfolder} aware of all likely files in
11357 @code{nnfolder-directory}. This only works if you use long file names,
11360 @node Comparing Mail Backends
11361 @subsubsection Comparing Mail Backends
11363 First, just for terminology, the @dfn{backend} is the common word for a
11364 low-level access method---a transport, if you will, by which something
11365 is acquired. The sense is that one's mail has to come from somewhere,
11366 and so selection of a suitable backend is required in order to get that
11367 mail within spitting distance of Gnus.
11369 The same concept exists for Usenet itself: Though access to articles is
11370 typically done by NNTP these days, once upon a midnight dreary, everyone
11371 in the world got at Usenet by running a reader on the machine where the
11372 articles lay (the machine which today we call an NNTP server), and
11373 access was by the reader stepping into the articles' directory spool
11374 area directly. One can still select between either the @code{nntp} or
11375 @code{nnspool} backends, to select between these methods, if one happens
11376 actually to live on the server (or can see its spool directly, anyway,
11379 The goal in selecting a mail backend is to pick one which
11380 simultaneously represents a suitable way of dealing with the original
11381 format plus leaving mail in a form that is convenient to use in the
11382 future. Here are some high and low points on each:
11387 UNIX systems have historically had a single, very common, and well-
11388 defined format. All messages arrive in a single @dfn{spool file}, and
11389 they are delineated by a line whose regular expression matches
11390 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
11391 to make it clear in this instance that this is not the RFC-specified
11392 @samp{From:} header.) Because Emacs and therefore Gnus emanate
11393 historically from the Unix environment, it is simplest if one does not
11394 mess a great deal with the original mailbox format, so if one chooses
11395 this backend, Gnus' primary activity in getting mail from the real spool
11396 area to Gnus' preferred directory is simply to copy it, with no
11397 (appreciable) format change in the process. It is the ``dumbest'' way
11398 to move mail into availability in the Gnus environment. This makes it
11399 fast to move into place, but slow to parse, when Gnus has to look at
11404 Once upon a time, there was the DEC-10 and DEC-20, running operating
11405 systems called TOPS and related things, and the usual (only?) mail
11406 reading environment was a thing called Babyl. I don't know what format
11407 was used for mail landing on the system, but Babyl had its own internal
11408 format to which mail was converted, primarily involving creating a
11409 spool-file-like entity with a scheme for inserting Babyl-specific
11410 headers and status bits above the top of each message in the file.
11411 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
11412 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
11413 to understand the mail files folks already had in existence. Gnus (and
11414 VM, for that matter) continue to support this format because it's
11415 perceived as having some good qualities in those mailer-specific
11416 headers/status bits stuff. RMAIL itself still exists as well, of
11417 course, and is still maintained by Stallman.
11419 Both of the above forms leave your mail in a single file on your
11420 filesystem, and they must parse that entire file each time you take a
11425 @code{nnml} is the backend which smells the most as though you were
11426 actually operating with an @code{nnspool}-accessed Usenet system. (In
11427 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
11428 lo these years ago.) One's mail is taken from the original spool file,
11429 and is then cut up into individual message files, 1:1. It maintains a
11430 Usenet-style active file (analogous to what one finds in an INN- or
11431 CNews-based news system in (for instance) @file{/var/lib/news/active},
11432 or what is returned via the @samp{NNTP LIST} verb) and also creates
11433 @dfn{overview} files for efficient group entry, as has been defined for
11434 @sc{nntp} servers for some years now. It is slower in mail-splitting,
11435 due to the creation of lots of files, updates to the @code{nnml} active
11436 file, and additions to overview files on a per-message basis, but it is
11437 extremely fast on access because of what amounts to the indexing support
11438 provided by the active file and overviews.
11440 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
11441 resource which defines available places in the filesystem to put new
11442 files. Sysadmins take a dim view of heavy inode occupation within
11443 tight, shared filesystems. But if you live on a personal machine where
11444 the filesystem is your own and space is not at a premium, @code{nnml}
11447 It is also problematic using this backend if you are living in a
11448 FAT16-based Windows world, since much space will be wasted on all these
11453 The Rand MH mail-reading system has been around UNIX systems for a very
11454 long time; it operates by splitting one's spool file of messages into
11455 individual files, but with little or no indexing support -- @code{nnmh}
11456 is considered to be semantically equivalent to ``@code{nnml} without
11457 active file or overviews''. This is arguably the worst choice, because
11458 one gets the slowness of individual file creation married to the
11459 slowness of access parsing when learning what's new in one's groups.
11463 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
11464 method described above) on a per-group basis. That is, @code{nnmbox}
11465 itself puts *all* one's mail in one file; @code{nnfolder} provides a
11466 little bit of optimization to this so that each of one's mail groups has
11467 a Unix mail box file. It's faster than @code{nnmbox} because each group
11468 can be parsed separately, and still provides the simple Unix mail box
11469 format requiring minimal effort in moving the mail around. In addition,
11470 it maintains an ``active'' file making it much faster for Gnus to figure
11471 out how many messages there are in each separate group.
11473 If you have groups that are expected to have a massive amount of
11474 messages, @code{nnfolder} is not the best choice, but if you receive
11475 only a moderate amount of mail, @code{nnfolder} is probably the most
11476 friendly mail backend all over.
11482 @node Other Sources
11483 @section Other Sources
11485 Gnus can do more than just read news or mail. The methods described
11486 below allow Gnus to view directories and files as if they were
11490 * Directory Groups:: You can read a directory as if it was a newsgroup.
11491 * Anything Groups:: Dired? Who needs dired?
11492 * Document Groups:: Single files can be the basis of a group.
11493 * SOUP:: Reading @sc{SOUP} packets ``offline''.
11494 * Web Searches:: Creating groups from articles that match a string.
11495 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
11499 @node Directory Groups
11500 @subsection Directory Groups
11502 @cindex directory groups
11504 If you have a directory that has lots of articles in separate files in
11505 it, you might treat it as a newsgroup. The files have to have numerical
11508 This might be an opportune moment to mention @code{ange-ftp} (and its
11509 successor @code{efs}), that most wonderful of all wonderful Emacs
11510 packages. When I wrote @code{nndir}, I didn't think much about it---a
11511 backend to read directories. Big deal.
11513 @code{ange-ftp} changes that picture dramatically. For instance, if you
11514 enter the @code{ange-ftp} file name
11515 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
11516 @code{ange-ftp} or @code{efs} will actually allow you to read this
11517 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
11519 @code{nndir} will use @sc{nov} files if they are present.
11521 @code{nndir} is a ``read-only'' backend---you can't delete or expire
11522 articles with this method. You can use @code{nnmh} or @code{nnml} for
11523 whatever you use @code{nndir} for, so you could switch to any of those
11524 methods if you feel the need to have a non-read-only @code{nndir}.
11527 @node Anything Groups
11528 @subsection Anything Groups
11531 From the @code{nndir} backend (which reads a single spool-like
11532 directory), it's just a hop and a skip to @code{nneething}, which
11533 pretends that any arbitrary directory is a newsgroup. Strange, but
11536 When @code{nneething} is presented with a directory, it will scan this
11537 directory and assign article numbers to each file. When you enter such
11538 a group, @code{nneething} must create ``headers'' that Gnus can use.
11539 After all, Gnus is a newsreader, in case you're
11540 forgetting. @code{nneething} does this in a two-step process. First, it
11541 snoops each file in question. If the file looks like an article (i.e.,
11542 the first few lines look like headers), it will use this as the head.
11543 If this is just some arbitrary file without a head (e.g. a C source
11544 file), @code{nneething} will cobble up a header out of thin air. It
11545 will use file ownership, name and date and do whatever it can with these
11548 All this should happen automatically for you, and you will be presented
11549 with something that looks very much like a newsgroup. Totally like a
11550 newsgroup, to be precise. If you select an article, it will be displayed
11551 in the article buffer, just as usual.
11553 If you select a line that represents a directory, Gnus will pop you into
11554 a new summary buffer for this @code{nneething} group. And so on. You can
11555 traverse the entire disk this way, if you feel like, but remember that
11556 Gnus is not dired, really, and does not intend to be, either.
11558 There are two overall modes to this action---ephemeral or solid. When
11559 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
11560 will not store information on what files you have read, and what files
11561 are new, and so on. If you create a solid @code{nneething} group the
11562 normal way with @kbd{G m}, Gnus will store a mapping table between
11563 article numbers and file names, and you can treat this group like any
11564 other groups. When you activate a solid @code{nneething} group, you will
11565 be told how many unread articles it contains, etc., etc.
11570 @item nneething-map-file-directory
11571 @vindex nneething-map-file-directory
11572 All the mapping files for solid @code{nneething} groups will be stored
11573 in this directory, which defaults to @file{~/.nneething/}.
11575 @item nneething-exclude-files
11576 @vindex nneething-exclude-files
11577 All files that match this regexp will be ignored. Nice to use to exclude
11578 auto-save files and the like, which is what it does by default.
11580 @item nneething-include-files
11581 @vindex nneething-include-files
11582 Regexp saying what files to include in the group. If this variable is
11583 non-@code{nil}, only files matching this regexp will be included.
11585 @item nneething-map-file
11586 @vindex nneething-map-file
11587 Name of the map files.
11591 @node Document Groups
11592 @subsection Document Groups
11594 @cindex documentation group
11597 @code{nndoc} is a cute little thing that will let you read a single file
11598 as a newsgroup. Several files types are supported:
11605 The babyl (rmail) mail box.
11610 The standard Unix mbox file.
11612 @cindex MMDF mail box
11614 The MMDF mail box format.
11617 Several news articles appended into a file.
11620 @cindex rnews batch files
11621 The rnews batch transport format.
11622 @cindex forwarded messages
11625 Forwarded articles.
11628 Netscape mail boxes.
11631 MIME multipart messages.
11633 @item standard-digest
11634 The standard (RFC 1153) digest format.
11637 Non-standard digest format---matches most things, but does it badly.
11640 You can also use the special ``file type'' @code{guess}, which means
11641 that @code{nndoc} will try to guess what file type it is looking at.
11642 @code{digest} means that @code{nndoc} should guess what digest type the
11645 @code{nndoc} will not try to change the file or insert any extra headers into
11646 it---it will simply, like, let you use the file as the basis for a
11647 group. And that's it.
11649 If you have some old archived articles that you want to insert into your
11650 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
11651 that. Say you have an old @file{RMAIL} file with mail that you now want
11652 to split into your new @code{nnml} groups. You look at that file using
11653 @code{nndoc} (using the @kbd{G f} command in the group buffer
11654 (@pxref{Foreign Groups})), set the process mark on all the articles in
11655 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
11656 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
11657 file is now also stored in lots of @code{nnml} directories, and you can
11658 delete that pesky @file{RMAIL} file. If you have the guts!
11660 Virtual server variables:
11663 @item nndoc-article-type
11664 @vindex nndoc-article-type
11665 This should be one of @code{mbox}, @code{babyl}, @code{digest},
11666 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
11667 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
11668 @code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}.
11670 @item nndoc-post-type
11671 @vindex nndoc-post-type
11672 This variable says whether Gnus is to consider the group a news group or
11673 a mail group. There are two valid values: @code{mail} (the default)
11678 * Document Server Internals:: How to add your own document types.
11682 @node Document Server Internals
11683 @subsubsection Document Server Internals
11685 Adding new document types to be recognized by @code{nndoc} isn't
11686 difficult. You just have to whip up a definition of what the document
11687 looks like, write a predicate function to recognize that document type,
11688 and then hook into @code{nndoc}.
11690 First, here's an example document type definition:
11694 (article-begin . "^\^A\^A\^A\^A\n")
11695 (body-end . "^\^A\^A\^A\^A\n"))
11698 The definition is simply a unique @dfn{name} followed by a series of
11699 regexp pseudo-variable settings. Below are the possible
11700 variables---don't be daunted by the number of variables; most document
11701 types can be defined with very few settings:
11704 @item first-article
11705 If present, @code{nndoc} will skip past all text until it finds
11706 something that match this regexp. All text before this will be
11709 @item article-begin
11710 This setting has to be present in all document type definitions. It
11711 says what the beginning of each article looks like.
11713 @item head-begin-function
11714 If present, this should be a function that moves point to the head of
11717 @item nndoc-head-begin
11718 If present, this should be a regexp that matches the head of the
11721 @item nndoc-head-end
11722 This should match the end of the head of the article. It defaults to
11723 @samp{^$}---the empty line.
11725 @item body-begin-function
11726 If present, this function should move point to the beginning of the body
11730 This should match the beginning of the body of the article. It defaults
11733 @item body-end-function
11734 If present, this function should move point to the end of the body of
11738 If present, this should match the end of the body of the article.
11741 If present, this should match the end of the file. All text after this
11742 regexp will be totally ignored.
11746 So, using these variables @code{nndoc} is able to dissect a document
11747 file into a series of articles, each with a head and a body. However, a
11748 few more variables are needed since not all document types are all that
11749 news-like---variables needed to transform the head or the body into
11750 something that's palatable for Gnus:
11753 @item prepare-body-function
11754 If present, this function will be called when requesting an article. It
11755 will be called with point at the start of the body, and is useful if the
11756 document has encoded some parts of its contents.
11758 @item article-transform-function
11759 If present, this function is called when requesting an article. It's
11760 meant to be used for more wide-ranging transformation of both head and
11761 body of the article.
11763 @item generate-head-function
11764 If present, this function is called to generate a head that Gnus can
11765 understand. It is called with the article number as a parameter, and is
11766 expected to generate a nice head for the article in question. It is
11767 called when requesting the headers of all articles.
11771 Let's look at the most complicated example I can come up with---standard
11776 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
11777 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
11778 (prepare-body-function . nndoc-unquote-dashes)
11779 (body-end-function . nndoc-digest-body-end)
11780 (head-end . "^ ?$")
11781 (body-begin . "^ ?\n")
11782 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
11783 (subtype digest guess))
11786 We see that all text before a 70-width line of dashes is ignored; all
11787 text after a line that starts with that @samp{^End of} is also ignored;
11788 each article begins with a 30-width line of dashes; the line separating
11789 the head from the body may contain a single space; and that the body is
11790 run through @code{nndoc-unquote-dashes} before being delivered.
11792 To hook your own document definition into @code{nndoc}, use the
11793 @code{nndoc-add-type} function. It takes two parameters---the first is
11794 the definition itself and the second (optional) parameter says where in
11795 the document type definition alist to put this definition. The alist is
11796 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
11797 is of @code{mmdf} type, and so on. These type predicates should return
11798 @code{nil} if the document is not of the correct type; @code{t} if it is
11799 of the correct type; and a number if the document might be of the
11800 correct type. A high number means high probability; a low number means
11801 low probability with @samp{0} being the lowest valid number.
11809 In the PC world people often talk about ``offline'' newsreaders. These
11810 are thingies that are combined reader/news transport monstrosities.
11811 With built-in modem programs. Yecchh!
11813 Of course, us Unix Weenie types of human beans use things like
11814 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
11815 transport things like Ghod intended. And then we just use normal
11818 However, it can sometimes be convenient to do something a that's a bit
11819 easier on the brain if you have a very slow modem, and you're not really
11820 that interested in doing things properly.
11822 A file format called @sc{soup} has been developed for transporting news
11823 and mail from servers to home machines and back again. It can be a bit
11826 First some terminology:
11831 This is the machine that is connected to the outside world and where you
11832 get news and/or mail from.
11835 This is the machine that you want to do the actual reading and responding
11836 on. It is typically not connected to the rest of the world in any way.
11839 Something that contains messages and/or commands. There are two kinds
11843 @item message packets
11844 These are packets made at the server, and typically contain lots of
11845 messages for you to read. These are called @file{SoupoutX.tgz} by
11846 default, where @var{X} is a number.
11848 @item response packets
11849 These are packets made at the home machine, and typically contains
11850 replies that you've written. These are called @file{SoupinX.tgz} by
11851 default, where @var{X} is a number.
11861 You log in on the server and create a @sc{soup} packet. You can either
11862 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
11863 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
11864 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
11867 You transfer the packet home. Rail, boat, car or modem will do fine.
11870 You put the packet in your home directory.
11873 You fire up Gnus on your home machine using the @code{nnsoup} backend as
11874 the native or secondary server.
11877 You read articles and mail and answer and followup to the things you
11878 want (@pxref{SOUP Replies}).
11881 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
11885 You transfer this packet to the server.
11888 You use Gnus to mail this packet out with the @kbd{G s s} command.
11891 You then repeat until you die.
11895 So you basically have a bipartite system---you use @code{nnsoup} for
11896 reading and Gnus for packing/sending these @sc{soup} packets.
11899 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
11900 * SOUP Groups:: A backend for reading @sc{soup} packets.
11901 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
11905 @node SOUP Commands
11906 @subsubsection SOUP Commands
11908 These are commands for creating and manipulating @sc{soup} packets.
11912 @kindex G s b (Group)
11913 @findex gnus-group-brew-soup
11914 Pack all unread articles in the current group
11915 (@code{gnus-group-brew-soup}). This command understands the
11916 process/prefix convention.
11919 @kindex G s w (Group)
11920 @findex gnus-soup-save-areas
11921 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
11924 @kindex G s s (Group)
11925 @findex gnus-soup-send-replies
11926 Send all replies from the replies packet
11927 (@code{gnus-soup-send-replies}).
11930 @kindex G s p (Group)
11931 @findex gnus-soup-pack-packet
11932 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
11935 @kindex G s r (Group)
11936 @findex nnsoup-pack-replies
11937 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
11940 @kindex O s (Summary)
11941 @findex gnus-soup-add-article
11942 This summary-mode command adds the current article to a @sc{soup} packet
11943 (@code{gnus-soup-add-article}). It understands the process/prefix
11944 convention (@pxref{Process/Prefix}).
11949 There are a few variables to customize where Gnus will put all these
11954 @item gnus-soup-directory
11955 @vindex gnus-soup-directory
11956 Directory where Gnus will save intermediate files while composing
11957 @sc{soup} packets. The default is @file{~/SoupBrew/}.
11959 @item gnus-soup-replies-directory
11960 @vindex gnus-soup-replies-directory
11961 This is what Gnus will use as a temporary directory while sending our
11962 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
11964 @item gnus-soup-prefix-file
11965 @vindex gnus-soup-prefix-file
11966 Name of the file where Gnus stores the last used prefix. The default is
11967 @samp{gnus-prefix}.
11969 @item gnus-soup-packer
11970 @vindex gnus-soup-packer
11971 A format string command for packing a @sc{soup} packet. The default is
11972 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
11974 @item gnus-soup-unpacker
11975 @vindex gnus-soup-unpacker
11976 Format string command for unpacking a @sc{soup} packet. The default is
11977 @samp{gunzip -c %s | tar xvf -}.
11979 @item gnus-soup-packet-directory
11980 @vindex gnus-soup-packet-directory
11981 Where Gnus will look for reply packets. The default is @file{~/}.
11983 @item gnus-soup-packet-regexp
11984 @vindex gnus-soup-packet-regexp
11985 Regular expression matching @sc{soup} reply packets in
11986 @code{gnus-soup-packet-directory}.
11992 @subsubsection @sc{soup} Groups
11995 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
11996 read incoming packets, unpack them, and put them in a directory where
11997 you can read them at leisure.
11999 These are the variables you can use to customize its behavior:
12003 @item nnsoup-tmp-directory
12004 @vindex nnsoup-tmp-directory
12005 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
12006 directory. (@file{/tmp/} by default.)
12008 @item nnsoup-directory
12009 @vindex nnsoup-directory
12010 @code{nnsoup} then moves each message and index file to this directory.
12011 The default is @file{~/SOUP/}.
12013 @item nnsoup-replies-directory
12014 @vindex nnsoup-replies-directory
12015 All replies will be stored in this directory before being packed into a
12016 reply packet. The default is @file{~/SOUP/replies/"}.
12018 @item nnsoup-replies-format-type
12019 @vindex nnsoup-replies-format-type
12020 The @sc{soup} format of the replies packets. The default is @samp{?n}
12021 (rnews), and I don't think you should touch that variable. I probably
12022 shouldn't even have documented it. Drats! Too late!
12024 @item nnsoup-replies-index-type
12025 @vindex nnsoup-replies-index-type
12026 The index type of the replies packet. The default is @samp{?n}, which
12027 means ``none''. Don't fiddle with this one either!
12029 @item nnsoup-active-file
12030 @vindex nnsoup-active-file
12031 Where @code{nnsoup} stores lots of information. This is not an ``active
12032 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
12033 this file or mess it up in any way, you're dead. The default is
12034 @file{~/SOUP/active}.
12036 @item nnsoup-packer
12037 @vindex nnsoup-packer
12038 Format string command for packing a reply @sc{soup} packet. The default
12039 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
12041 @item nnsoup-unpacker
12042 @vindex nnsoup-unpacker
12043 Format string command for unpacking incoming @sc{soup} packets. The
12044 default is @samp{gunzip -c %s | tar xvf -}.
12046 @item nnsoup-packet-directory
12047 @vindex nnsoup-packet-directory
12048 Where @code{nnsoup} will look for incoming packets. The default is
12051 @item nnsoup-packet-regexp
12052 @vindex nnsoup-packet-regexp
12053 Regular expression matching incoming @sc{soup} packets. The default is
12056 @item nnsoup-always-save
12057 @vindex nnsoup-always-save
12058 If non-@code{nil}, save the replies buffer after each posted message.
12064 @subsubsection SOUP Replies
12066 Just using @code{nnsoup} won't mean that your postings and mailings end
12067 up in @sc{soup} reply packets automagically. You have to work a bit
12068 more for that to happen.
12070 @findex nnsoup-set-variables
12071 The @code{nnsoup-set-variables} command will set the appropriate
12072 variables to ensure that all your followups and replies end up in the
12075 In specific, this is what it does:
12078 (setq message-send-news-function 'nnsoup-request-post)
12079 (setq message-send-mail-function 'nnsoup-request-mail)
12082 And that's it, really. If you only want news to go into the @sc{soup}
12083 system you just use the first line. If you only want mail to be
12084 @sc{soup}ed you use the second.
12088 @subsection Web Searches
12092 @cindex InReference
12093 @cindex Usenet searches
12094 @cindex searching the Usenet
12096 It's, like, too neat to search the Usenet for articles that match a
12097 string, but it, like, totally @emph{sucks}, like, totally, to use one of
12098 those, like, Web browsers, and you, like, have to, rilly, like, look at
12099 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
12100 searches without having to use a browser.
12102 The @code{nnweb} backend allows an easy interface to the mighty search
12103 engine. You create an @code{nnweb} group, enter a search pattern, and
12104 then enter the group and read the articles like you would any normal
12105 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
12106 Groups}) will do this in an easy-to-use fashion.
12108 @code{nnweb} groups don't really lend themselves to being solid
12109 groups---they have a very fleeting idea of article numbers. In fact,
12110 each time you enter an @code{nnweb} group (not even changing the search
12111 pattern), you are likely to get the articles ordered in a different
12112 manner. Not even using duplicate suppression (@pxref{Duplicate
12113 Suppression}) will help, since @code{nnweb} doesn't even know the
12114 @code{Message-ID} of the articles before reading them using some search
12115 engines (DejaNews, for instance). The only possible way to keep track
12116 of which articles you've read is by scoring on the @code{Date}
12117 header---mark all articles posted before the last date you read the
12120 If the search engine changes its output substantially, @code{nnweb}
12121 won't be able to parse it and will fail. One could hardly fault the Web
12122 providers if they were to do this---their @emph{raison d'être} is to
12123 make money off of advertisements, not to provide services to the
12124 community. Since @code{nnweb} washes the ads off all the articles, one
12125 might think that the providers might be somewhat miffed. We'll see.
12127 You must have the @code{url} and @code{w3} package installed to be able
12128 to use @code{nnweb}.
12130 Virtual server variables:
12135 What search engine type is being used. The currently supported types
12136 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
12140 @vindex nnweb-search
12141 The search string to feed to the search engine.
12143 @item nnweb-max-hits
12144 @vindex nnweb-max-hits
12145 Advisory maximum number of hits per search to display. The default is
12148 @item nnweb-type-definition
12149 @vindex nnweb-type-definition
12150 Type-to-definition alist. This alist says what @code{nnweb} should do
12151 with the various search engine types. The following elements must be
12156 Function to decode the article and provide something that Gnus
12160 Function to create an article number to message header and URL alist.
12163 Function to send the search string to the search engine.
12166 The address the aforementioned function should send the search string
12170 Format string URL to fetch an article by @code{Message-ID}.
12177 @node Mail-To-News Gateways
12178 @subsection Mail-To-News Gateways
12179 @cindex mail-to-news gateways
12182 If your local @code{nntp} server doesn't allow posting, for some reason
12183 or other, you can post using one of the numerous mail-to-news gateways.
12184 The @code{nngateway} backend provides the interface.
12186 Note that you can't read anything from this backend---it can only be
12192 @item nngateway-address
12193 @vindex nngateway-address
12194 This is the address of the mail-to-news gateway.
12196 @item nngateway-header-transformation
12197 @vindex nngateway-header-transformation
12198 News headers often have to be transformed in some odd way or other
12199 for the mail-to-news gateway to accept it. This variable says what
12200 transformation should be called, and defaults to
12201 @code{nngateway-simple-header-transformation}. The function is called
12202 narrowed to the headers to be transformed and with one parameter---the
12205 This default function just inserts a new @code{To} header based on the
12206 @code{Newsgroups} header and the gateway address.
12207 For instance, an article with this @code{Newsgroups} header:
12210 Newsgroups: alt.religion.emacs
12213 will get this @code{From} header inserted:
12216 To: alt-religion-emacs@@GATEWAY
12219 The following pre-defined functions exist:
12221 @findex nngateway-simple-header-transformation
12224 @item nngateway-simple-header-transformation
12225 Creates a @code{To} header that looks like
12226 @var{newsgroup}@@@code{nngateway-address}.
12228 @findex nngateway-mail2news-header-transformation
12230 @item nngateway-mail2news-header-transformation
12231 Creates a @code{To} header that looks like
12232 @code{nngateway-address}.
12237 (setq gnus-post-method
12238 '(nngateway "mail2news@@replay.com"
12239 (nngateway-header-transformation
12240 nngateway-mail2news-header-transformation)))
12248 So, to use this, simply say something like:
12251 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
12255 @node Combined Groups
12256 @section Combined Groups
12258 Gnus allows combining a mixture of all the other group types into bigger
12262 * Virtual Groups:: Combining articles from many groups.
12263 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
12267 @node Virtual Groups
12268 @subsection Virtual Groups
12270 @cindex virtual groups
12271 @cindex merging groups
12273 An @dfn{nnvirtual group} is really nothing more than a collection of
12276 For instance, if you are tired of reading many small groups, you can
12277 put them all in one big group, and then grow tired of reading one
12278 big, unwieldy group. The joys of computing!
12280 You specify @code{nnvirtual} as the method. The address should be a
12281 regexp to match component groups.
12283 All marks in the virtual group will stick to the articles in the
12284 component groups. So if you tick an article in a virtual group, the
12285 article will also be ticked in the component group from whence it came.
12286 (And vice versa---marks from the component groups will also be shown in
12287 the virtual group.)
12289 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
12290 newsgroups into one, big, happy newsgroup:
12293 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
12296 The component groups can be native or foreign; everything should work
12297 smoothly, but if your computer explodes, it was probably my fault.
12299 Collecting the same group from several servers might actually be a good
12300 idea if users have set the Distribution header to limit distribution.
12301 If you would like to read @samp{soc.motss} both from a server in Japan
12302 and a server in Norway, you could use the following as the group regexp:
12305 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
12308 (Remember, though, that if you're creating the group with @kbd{G m}, you
12309 shouldn't double the backslashes, and you should leave off the quote
12310 characters at the beginning and the end of the string.)
12312 This should work kinda smoothly---all articles from both groups should
12313 end up in this one, and there should be no duplicates. Threading (and
12314 the rest) will still work as usual, but there might be problems with the
12315 sequence of articles. Sorting on date might be an option here
12316 (@pxref{Selecting a Group}).
12318 One limitation, however---all groups included in a virtual
12319 group have to be alive (i.e., subscribed or unsubscribed). Killed or
12320 zombie groups can't be component groups for @code{nnvirtual} groups.
12322 @vindex nnvirtual-always-rescan
12323 If the @code{nnvirtual-always-rescan} is non-@code{nil},
12324 @code{nnvirtual} will always scan groups for unread articles when
12325 entering a virtual group. If this variable is @code{nil} (which is the
12326 default) and you read articles in a component group after the virtual
12327 group has been activated, the read articles from the component group
12328 will show up when you enter the virtual group. You'll also see this
12329 effect if you have two virtual groups that have a component group in
12330 common. If that's the case, you should set this variable to @code{t}.
12331 Or you can just tap @code{M-g} on the virtual group every time before
12332 you enter it---it'll have much the same effect.
12334 @code{nnvirtual} can have both mail and news groups as component groups.
12335 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
12336 has to ask the backend of the component group the article comes from
12337 whether it is a news or mail backend. However, when you do a @kbd{^},
12338 there is typically no sure way for the component backend to know this,
12339 and in that case @code{nnvirtual} tells Gnus that the article came from a
12340 not-news backend. (Just to be on the safe side.)
12342 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
12343 line from the article you respond to in these cases.
12347 @node Kibozed Groups
12348 @subsection Kibozed Groups
12352 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
12353 the news feed''. @code{nnkiboze} is a backend that will do this for
12354 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
12355 with useless requests! Oh happiness!
12357 @kindex G k (Group)
12358 To create a kibozed group, use the @kbd{G k} command in the group
12361 The address field of the @code{nnkiboze} method is, as with
12362 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
12363 @code{nnkiboze} group. That's where most similarities between @code{nnkiboze}
12364 and @code{nnvirtual} end.
12366 In addition to this regexp detailing component groups, an @code{nnkiboze} group
12367 must have a score file to say what articles are to be included in
12368 the group (@pxref{Scoring}).
12370 @kindex M-x nnkiboze-generate-groups
12371 @findex nnkiboze-generate-groups
12372 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
12373 @code{nnkiboze} groups you want to have. This command will take time. Lots of
12374 time. Oodles and oodles of time. Gnus has to fetch the headers from
12375 all the articles in all the component groups and run them through the
12376 scoring process to determine if there are any articles in the groups
12377 that are to be part of the @code{nnkiboze} groups.
12379 Please limit the number of component groups by using restrictive
12380 regexps. Otherwise your sysadmin may become annoyed with you, and the
12381 @sc{nntp} site may throw you off and never let you back in again.
12382 Stranger things have happened.
12384 @code{nnkiboze} component groups do not have to be alive---they can be dead,
12385 and they can be foreign. No restrictions.
12387 @vindex nnkiboze-directory
12388 The generation of an @code{nnkiboze} group means writing two files in
12389 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
12390 contains the @sc{nov} header lines for all the articles in the group,
12391 and the other is an additional @file{.newsrc} file to store information
12392 on what groups have been searched through to find component articles.
12394 Articles marked as read in the @code{nnkiboze} group will have
12395 their @sc{nov} lines removed from the @sc{nov} file.
12398 @node Gnus Unplugged
12399 @section Gnus Unplugged
12404 @cindex Gnus Unplugged
12406 In olden times (ca. February '88), people used to run their newsreaders
12407 on big machines with permanent connections to the net. News transport
12408 was dealt with by news servers, and all the newsreaders had to do was to
12409 read news. Believe it or not.
12411 Nowadays most people read news and mail at home, and use some sort of
12412 modem to connect to the net. To avoid running up huge phone bills, it
12413 would be nice to have a way to slurp down all the news and mail, hang up
12414 the phone, read for several hours, and then upload any responses you
12415 have to make. And then you repeat the procedure.
12417 Of course, you can use news servers for doing this as well. I've used
12418 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
12419 for some years, but doing that's a bore. Moving the news server
12420 functionality up to the newsreader makes sense if you're the only person
12421 reading news on a machine.
12423 Using Gnus as an ``offline'' newsreader is quite simple.
12427 First, set up Gnus as you would do if you were running it on a machine
12428 that has full connection to the net. Go ahead. I'll still be waiting
12432 Then, put the following magical incantation at the end of your
12433 @file{.gnus.el} file:
12440 That's it. Gnus is now an ``offline'' newsreader.
12442 Of course, to use it as such, you have to learn a few new commands.
12445 * Agent Basics:: How it all is supposed to work.
12446 * Agent Categories:: How to tell the Gnus Agent what to download.
12447 * Agent Commands:: New commands for all the buffers.
12448 * Agent Expiry:: How to make old articles go away.
12449 * Outgoing Messages:: What happens when you post/mail something?
12450 * Agent Variables:: Customizing is fun.
12451 * Example Setup:: An example @file{.gnus.el} file for offline people.
12452 * Batching Agents:: How to fetch news from a @code{cron} job.
12453 * Agent Caveats:: What you think it'll do and what it does.
12458 @subsection Agent Basics
12460 First, let's get some terminology out of the way.
12462 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
12463 connection to the net (and notified the Agent that this is the case).
12464 When the connection to the net is up again (and Gnus knows this), the
12465 Agent is @dfn{plugged}.
12467 The @dfn{local} machine is the one you're running on, and which isn't
12468 connected to the net continuously.
12470 @dfn{Downloading} means fetching things from the net to your local
12471 machine. @dfn{Uploading} is doing the opposite.
12473 Let's take a typical Gnus session using the Agent.
12478 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
12479 Agent in a disconnected state. You can read all the news that you have
12480 already fetched while in this mode.
12483 You then decide to see whether any new news has arrived. You connect
12484 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
12485 to make Gnus become @dfn{plugged}.
12488 You can then read the new news immediately, or you can download the news
12489 onto your local machine. If you want to do the latter, you press @kbd{J
12490 s} to fetch all the eligible articles in all the groups. (To let Gnus
12491 know which articles you want to download, @pxref{Agent Categories}.)
12494 After fetching the articles, you press @kbd{J j} to make Gnus become
12495 unplugged again, and you shut down the PPP thing (or whatever). And
12496 then you read the news offline.
12499 And then you go to step 2.
12502 Here are some things you should do the first time (or so) that you use
12508 Decide which servers should be covered by the Agent. If you have a mail
12509 backend, it would probably be nonsensical to have it covered by the
12510 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
12511 @kbd{J a} the server (or servers) that you wish to have covered by the
12512 Agent (@pxref{Server Agent Commands}). This will typically be only the
12513 primary select method, which is listed on the bottom in the buffer.
12516 Decide on download policy. @xref{Agent Categories}.
12523 @node Agent Categories
12524 @subsection Agent Categories
12526 One of the main reasons to integrate the news transport layer into the
12527 newsreader is to allow greater control over what articles to download.
12528 There's not much point in downloading huge amounts of articles, just to
12529 find out that you're not interested in reading any of them. It's better
12530 to be somewhat more conservative in choosing what to download, and then
12531 mark the articles for downloading manually if it should turn out that
12532 you're interested in the articles anyway.
12534 The main way to control what is to be downloaded is to create a
12535 @dfn{category} and then assign some (or all) groups to this category.
12536 Groups that do not belong in any other category belong to the
12537 @code{default} category. Gnus has its own buffer for creating and
12538 managing categories.
12541 * Category Syntax:: What a category looks like.
12542 * The Category Buffer:: A buffer for maintaining categories.
12543 * Category Variables:: Customize'r'Us.
12547 @node Category Syntax
12548 @subsubsection Category Syntax
12550 A category consists of two things.
12554 A predicate which (generally) gives a rough outline of which articles
12555 are eligible for downloading; and
12558 a score rule which (generally) gives you a finer granularity when
12559 deciding what articles to download. (Note that this @dfn{download
12560 score} is not necessarily related to normal scores.)
12563 A predicate in its simplest form can be a single predicate such as
12564 @code{true} or @code{false}. These two will download every available
12565 article or nothing respectively. In the case of these two special
12566 predicates an additional score rule is superfluous.
12568 Predicates of @code{high} or @code{low} download articles in respect of
12569 their scores in relationship to @code{gnus-agent-high-score} and
12570 @code{gnus-agent-low-score} as descibed below.
12572 To gain even finer control of what is to be regarded eligible for
12573 download a predicate can consist of a number of predicates with logical
12574 operators sprinkled in between.
12576 Perhaps some examples are in order.
12578 Here's a simple predicate. (It's the default predicate, in fact, used
12579 for all groups that don't belong to any other category.)
12585 Quite simple, eh? This predicate is true if and only if the article is
12586 short (for some value of ``short'').
12588 Here's a more complex predicate:
12597 This means that an article should be downloaded if it has a high score,
12598 or if the score is not low and the article is not long. You get the
12601 The available logical operators are @code{or}, @code{and} and
12602 @code{not}. (If you prefer, you can use the more ``C''-ish operators
12603 @samp{|}, @code{&} and @code{!} instead.)
12605 The following predicates are pre-defined, but if none of these fit what
12606 you want to do, you can write your own.
12610 True iff the article is shorter than @code{gnus-agent-short-article}
12611 lines; default 100.
12614 True iff the article is longer than @code{gnus-agent-long-article}
12615 lines; default 200.
12618 True iff the article has a download score less than
12619 @code{gnus-agent-low-score}; default 0.
12622 True iff the article has a download score greater than
12623 @code{gnus-agent-high-score}; default 0.
12626 True iff the Gnus Agent guesses that the article is spam. The
12627 heuristics may change over time, but at present it just computes a
12628 checksum and sees whether articles match.
12637 If you want to create your own predicate function, here's what you have
12638 to know: The functions are called with no parameters, but the
12639 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
12642 For example, you could decide that you don't want to download articles
12643 that were posted more than a certain number of days ago (e.g. posted
12644 more than @code{gnus-agent-expire-days} ago) you might write a function
12645 something along the lines of the following:
12648 (defun my-article-old-p ()
12649 "Say whether an article is old."
12650 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
12651 (- (time-to-days (current-time)) gnus-agent-expire-days)))
12654 with the predicate then defined as:
12657 (not my-article-old-p)
12660 or you could append your predicate to the predefined
12661 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
12662 wherever. (Note: this would have to be at a point *after*
12663 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
12666 (defvar gnus-category-predicate-alist
12667 (append gnus-category-predicate-alist
12668 '((old . my-article-old-p))))
12671 and simply specify your predicate as:
12677 If/when using something like the above, be aware that there are many
12678 misconfigured systems/mailers out there and so an article's date is not
12679 always a reliable indication of when it was posted. Hell, some people
12680 just don't give a damm.
12683 The above predicates apply to *all* the groups which belong to the
12684 category. However, if you wish to have a specific predicate for an
12685 individual group within a category, or you're just too lazy to set up a
12686 new category, you can enter a group's individual predicate in it's group
12687 parameters like so:
12690 (agent-predicate . short)
12693 This is the group parameter equivalent of the agent category
12694 default. Note that when specifying a single word predicate like this,
12695 the @code{agent-predicate} specification must be in dotted pair
12698 The equivalent of the longer example from above would be:
12701 (agent-predicate or high (and (not low) (not long)))
12704 The outer parenthesis required in the category specification are not
12705 entered here as, not being in dotted pair notation, the value of the
12706 predicate is assumed to be a list.
12709 Now, the syntax of the download score is the same as the syntax of
12710 normal score files, except that all elements that require actually
12711 seeing the article itself are verboten. This means that only the
12712 following headers can be scored on: @code{Subject}, @code{From},
12713 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
12714 @code{Lines}, and @code{Xref}.
12716 As with predicates, the specification of the @code{download score rule}
12717 to use in respect of a group can be in either the category definition if
12718 it's to be applicable to all groups in therein, or a group's parameters
12719 if it's to be specific to that group.
12721 In both of these places the @code{download score rule} can take one of
12728 This has the same syntax as a normal gnus score file except only a
12729 subset of scoring keywords are available as mentioned above.
12735 Category specification
12739 ("Lars Ingebrigtsen" 1000000 nil s))
12745 Group Parameter specification
12748 (agent-score ("from"
12749 ("Lars Ingebrigtsen" 1000000 nil s))
12754 Again, note the omission of the outermost parenthesis here.
12760 These score files must *only* contain the permitted scoring keywords
12767 Category specification
12770 ("~/News/agent.SCORE")
12776 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
12780 Group Parameter specification
12783 (agent-score "~/News/agent.SCORE")
12786 Additional score files can be specified as above. Need I say anything
12791 Use @code{normal} score files
12793 If you dont want to maintain two sets of scoring rules for a group, and
12794 your desired @code{downloading} criteria for a group are the same as your
12795 @code{reading} criteria then you can tell the agent to refer to your
12796 @code{normal} score files when deciding what to download.
12798 These directives in either the category definition or a group's
12799 parameters will cause the agent to read in all the applicable score
12800 files for a group, *filtering out* those those sections that do not
12801 relate to one of the permitted subset of scoring keywords.
12805 Category Specification
12812 Group Parameter specification
12815 (agent-score . file)
12820 @node The Category Buffer
12821 @subsubsection The Category Buffer
12823 You'd normally do all category maintenance from the category buffer.
12824 When you enter it for the first time (with the @kbd{J c} command from
12825 the group buffer), you'll only see the @code{default} category.
12827 The following commands are available in this buffer:
12831 @kindex q (Category)
12832 @findex gnus-category-exit
12833 Return to the group buffer (@code{gnus-category-exit}).
12836 @kindex k (Category)
12837 @findex gnus-category-kill
12838 Kill the current category (@code{gnus-category-kill}).
12841 @kindex c (Category)
12842 @findex gnus-category-copy
12843 Copy the current category (@code{gnus-category-copy}).
12846 @kindex a (Category)
12847 @findex gnus-category-add
12848 Add a new category (@code{gnus-category-add}).
12851 @kindex p (Category)
12852 @findex gnus-category-edit-predicate
12853 Edit the predicate of the current category
12854 (@code{gnus-category-edit-predicate}).
12857 @kindex g (Category)
12858 @findex gnus-category-edit-groups
12859 Edit the list of groups belonging to the current category
12860 (@code{gnus-category-edit-groups}).
12863 @kindex s (Category)
12864 @findex gnus-category-edit-score
12865 Edit the download score rule of the current category
12866 (@code{gnus-category-edit-score}).
12869 @kindex l (Category)
12870 @findex gnus-category-list
12871 List all the categories (@code{gnus-category-list}).
12875 @node Category Variables
12876 @subsubsection Category Variables
12879 @item gnus-category-mode-hook
12880 @vindex gnus-category-mode-hook
12881 Hook run in category buffers.
12883 @item gnus-category-line-format
12884 @vindex gnus-category-line-format
12885 Format of the lines in the category buffer (@pxref{Formatting
12886 Variables}). Valid elements are:
12890 The name of the category.
12893 The number of groups in the category.
12896 @item gnus-category-mode-line-format
12897 @vindex gnus-category-mode-line-format
12898 Format of the category mode line (@pxref{Mode Line Formatting}).
12900 @item gnus-agent-short-article
12901 @vindex gnus-agent-short-article
12902 Articles that have fewer lines than this are short. Default 100.
12904 @item gnus-agent-long-article
12905 @vindex gnus-agent-long-article
12906 Articles that have more lines than this are long. Default 200.
12908 @item gnus-agent-low-score
12909 @vindex gnus-agent-low-score
12910 Articles that have a score lower than this have a low score. Default
12913 @item gnus-agent-high-score
12914 @vindex gnus-agent-high-score
12915 Articles that have a score higher than this have a high score. Default
12921 @node Agent Commands
12922 @subsection Agent Commands
12924 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
12925 (@code{gnus-agent-toggle-plugged} command works in all modes, and
12926 toggles the plugged/unplugged state of the Gnus Agent.
12930 * Group Agent Commands::
12931 * Summary Agent Commands::
12932 * Server Agent Commands::
12935 You can run a complete batch fetch from the command line with the
12936 following incantation:
12938 @cindex gnus-agent-batch-fetch
12940 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
12945 @node Group Agent Commands
12946 @subsubsection Group Agent Commands
12950 @kindex J u (Agent Group)
12951 @findex gnus-agent-fetch-groups
12952 Fetch all eligible articles in the current group
12953 (@code{gnus-agent-fetch-groups}).
12956 @kindex J c (Agent Group)
12957 @findex gnus-enter-category-buffer
12958 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
12961 @kindex J s (Agent Group)
12962 @findex gnus-agent-fetch-session
12963 Fetch all eligible articles in all groups
12964 (@code{gnus-agent-fetch-session}).
12967 @kindex J S (Agent Group)
12968 @findex gnus-group-send-drafts
12969 Send all sendable messages in the draft group
12970 (@code{gnus-group-send-drafts}). @xref{Drafts}.
12973 @kindex J a (Agent Group)
12974 @findex gnus-agent-add-group
12975 Add the current group to an Agent category
12976 (@code{gnus-agent-add-group}). This command understands the
12977 process/prefix convention (@pxref{Process/Prefix}).
12980 @kindex J r (Agent Group)
12981 @findex gnus-agent-remove-group
12982 Remove the current group from its category, if any
12983 (@code{gnus-agent-remove-group}). This command understands the
12984 process/prefix convention (@pxref{Process/Prefix}).
12989 @node Summary Agent Commands
12990 @subsubsection Summary Agent Commands
12994 @kindex J # (Agent Summary)
12995 @findex gnus-agent-mark-article
12996 Mark the article for downloading (@code{gnus-agent-mark-article}).
12999 @kindex J M-# (Agent Summary)
13000 @findex gnus-agent-unmark-article
13001 Remove the downloading mark from the article
13002 (@code{gnus-agent-unmark-article}).
13005 @kindex @@ (Agent Summary)
13006 @findex gnus-agent-toggle-mark
13007 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
13010 @kindex J c (Agent Summary)
13011 @findex gnus-agent-catchup
13012 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
13017 @node Server Agent Commands
13018 @subsubsection Server Agent Commands
13022 @kindex J a (Agent Server)
13023 @findex gnus-agent-add-server
13024 Add the current server to the list of servers covered by the Gnus Agent
13025 (@code{gnus-agent-add-server}).
13028 @kindex J r (Agent Server)
13029 @findex gnus-agent-remove-server
13030 Remove the current server from the list of servers covered by the Gnus
13031 Agent (@code{gnus-agent-remove-server}).
13037 @subsection Agent Expiry
13039 @vindex gnus-agent-expire-days
13040 @findex gnus-agent-expire
13041 @kindex M-x gnus-agent-expire
13042 @cindex Agent expiry
13043 @cindex Gnus Agent expiry
13046 @code{nnagent} doesn't handle expiry. Instead, there's a special
13047 @code{gnus-agent-expire} command that will expire all read articles that
13048 are older than @code{gnus-agent-expire-days} days. It can be run
13049 whenever you feel that you're running out of space. It's not
13050 particularly fast or efficient, and it's not a particularly good idea to
13051 interrupt it (with @kbd{C-g} or anything else) once you've started it.
13053 @vindex gnus-agent-expire-all
13054 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
13055 expire all articles---unread, read, ticked and dormant. If @code{nil}
13056 (which is the default), only read articles are eligible for expiry, and
13057 unread, ticked and dormant articles will be kept indefinitely.
13060 @node Outgoing Messages
13061 @subsection Outgoing Messages
13063 When Gnus is unplugged, all outgoing messages (both mail and news) are
13064 stored in the draft groups (@pxref{Drafts}). You can view them there
13065 after posting, and edit them at will.
13067 When Gnus is plugged again, you can send the messages either from the
13068 draft group with the special commands available there, or you can use
13069 the @kbd{J S} command in the group buffer to send all the sendable
13070 messages in the draft group.
13074 @node Agent Variables
13075 @subsection Agent Variables
13078 @item gnus-agent-directory
13079 @vindex gnus-agent-directory
13080 Where the Gnus Agent will store its files. The default is
13081 @file{~/News/agent/}.
13083 @item gnus-agent-handle-level
13084 @vindex gnus-agent-handle-level
13085 Groups on levels (@pxref{Group Levels}) higher than this variable will
13086 be ignored by the Agent. The default is @code{gnus-level-subscribed},
13087 which means that only subscribed group will be considered by the Agent
13090 @item gnus-agent-plugged-hook
13091 @vindex gnus-agent-plugged-hook
13092 Hook run when connecting to the network.
13094 @item gnus-agent-unplugged-hook
13095 @vindex gnus-agent-unplugged-hook
13096 Hook run when disconnecting from the network.
13101 @node Example Setup
13102 @subsection Example Setup
13104 If you don't want to read this manual, and you have a fairly standard
13105 setup, you may be able to use something like the following as your
13106 @file{.gnus.el} file to get started.
13109 ;;; Define how Gnus is to fetch news. We do this over NNTP
13110 ;;; from your ISP's server.
13111 (setq gnus-select-method '(nntp "news.your-isp.com"))
13113 ;;; Define how Gnus is to read your mail. We read mail from
13114 ;;; your ISP's POP server.
13115 (setq mail-sources '((pop :server "pop.your-isp.com")))
13117 ;;; Say how Gnus is to store the mail. We use nnml groups.
13118 (setq gnus-secondary-select-methods '((nnml "")))
13120 ;;; Make Gnus into an offline newsreader.
13124 That should be it, basically. Put that in your @file{~/.gnus.el} file,
13125 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
13128 If this is the first time you've run Gnus, you will be subscribed
13129 automatically to a few default newsgroups. You'll probably want to
13130 subscribe to more groups, and to do that, you have to query the
13131 @sc{nntp} server for a complete list of groups with the @kbd{A A}
13132 command. This usually takes quite a while, but you only have to do it
13135 After reading and parsing a while, you'll be presented with a list of
13136 groups. Subscribe to the ones you want to read with the @kbd{u}
13137 command. @kbd{l} to make all the killed groups disappear after you've
13138 subscribe to all the groups you want to read. (@kbd{A k} will bring
13139 back all the killed groups.)
13141 You can now read the groups at once, or you can download the articles
13142 with the @kbd{J s} command. And then read the rest of this manual to
13143 find out which of the other gazillion things you want to customize.
13146 @node Batching Agents
13147 @subsection Batching Agents
13149 Having the Gnus Agent fetch articles (and post whatever messages you've
13150 written) is quite easy once you've gotten things set up properly. The
13151 following shell script will do everything that is necessary:
13155 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
13159 @node Agent Caveats
13160 @subsection Agent Caveats
13162 The Gnus Agent doesn't seem to work like most other offline
13163 newsreaders. Here are some common questions that some imaginary people
13167 @item If I read an article while plugged, do they get entered into the
13172 @item If I read an article while plugged, and the article already exists
13173 in the Agent, will it get downloaded once more?
13179 In short, when Gnus is unplugged, it only looks into the locally stored
13180 articles; when it's plugged, it only talks to your ISP.
13187 Other people use @dfn{kill files}, but we here at Gnus Towers like
13188 scoring better than killing, so we'd rather switch than fight. They do
13189 something completely different as well, so sit up straight and pay
13192 @vindex gnus-summary-mark-below
13193 All articles have a default score (@code{gnus-summary-default-score}),
13194 which is 0 by default. This score may be raised or lowered either
13195 interactively or by score files. Articles that have a score lower than
13196 @code{gnus-summary-mark-below} are marked as read.
13198 Gnus will read any @dfn{score files} that apply to the current group
13199 before generating the summary buffer.
13201 There are several commands in the summary buffer that insert score
13202 entries based on the current article. You can, for instance, ask Gnus to
13203 lower or increase the score of all articles with a certain subject.
13205 There are two sorts of scoring entries: Permanent and temporary.
13206 Temporary score entries are self-expiring entries. Any entries that are
13207 temporary and have not been used for, say, a week, will be removed
13208 silently to help keep the sizes of the score files down.
13211 * Summary Score Commands:: Adding score entries for the current group.
13212 * Group Score Commands:: General score commands.
13213 * Score Variables:: Customize your scoring. (My, what terminology).
13214 * Score File Format:: What a score file may contain.
13215 * Score File Editing:: You can edit score files by hand as well.
13216 * Adaptive Scoring:: Big Sister Gnus knows what you read.
13217 * Home Score File:: How to say where new score entries are to go.
13218 * Followups To Yourself:: Having Gnus notice when people answer you.
13219 * Scoring Tips:: How to score effectively.
13220 * Reverse Scoring:: That problem child of old is not problem.
13221 * Global Score Files:: Earth-spanning, ear-splitting score files.
13222 * Kill Files:: They are still here, but they can be ignored.
13223 * Converting Kill Files:: Translating kill files to score files.
13224 * GroupLens:: Getting predictions on what you like to read.
13225 * Advanced Scoring:: Using logical expressions to build score rules.
13226 * Score Decays:: It can be useful to let scores wither away.
13230 @node Summary Score Commands
13231 @section Summary Score Commands
13232 @cindex score commands
13234 The score commands that alter score entries do not actually modify real
13235 score files. That would be too inefficient. Gnus maintains a cache of
13236 previously loaded score files, one of which is considered the
13237 @dfn{current score file alist}. The score commands simply insert
13238 entries into this list, and upon group exit, this list is saved.
13240 The current score file is by default the group's local score file, even
13241 if no such score file actually exists. To insert score commands into
13242 some other score file (e.g. @file{all.SCORE}), you must first make this
13243 score file the current one.
13245 General score commands that don't actually change the score file:
13250 @kindex V s (Summary)
13251 @findex gnus-summary-set-score
13252 Set the score of the current article (@code{gnus-summary-set-score}).
13255 @kindex V S (Summary)
13256 @findex gnus-summary-current-score
13257 Display the score of the current article
13258 (@code{gnus-summary-current-score}).
13261 @kindex V t (Summary)
13262 @findex gnus-score-find-trace
13263 Display all score rules that have been used on the current article
13264 (@code{gnus-score-find-trace}).
13267 @kindex V R (Summary)
13268 @findex gnus-summary-rescore
13269 Run the current summary through the scoring process
13270 (@code{gnus-summary-rescore}). This might be useful if you're playing
13271 around with your score files behind Gnus' back and want to see the
13272 effect you're having.
13275 @kindex V c (Summary)
13276 @findex gnus-score-change-score-file
13277 Make a different score file the current
13278 (@code{gnus-score-change-score-file}).
13281 @kindex V e (Summary)
13282 @findex gnus-score-edit-current-scores
13283 Edit the current score file (@code{gnus-score-edit-current-scores}).
13284 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
13288 @kindex V f (Summary)
13289 @findex gnus-score-edit-file
13290 Edit a score file and make this score file the current one
13291 (@code{gnus-score-edit-file}).
13294 @kindex V F (Summary)
13295 @findex gnus-score-flush-cache
13296 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
13297 after editing score files.
13300 @kindex V C (Summary)
13301 @findex gnus-score-customize
13302 Customize a score file in a visually pleasing manner
13303 (@code{gnus-score-customize}).
13307 The rest of these commands modify the local score file.
13312 @kindex V m (Summary)
13313 @findex gnus-score-set-mark-below
13314 Prompt for a score, and mark all articles with a score below this as
13315 read (@code{gnus-score-set-mark-below}).
13318 @kindex V x (Summary)
13319 @findex gnus-score-set-expunge-below
13320 Prompt for a score, and add a score rule to the current score file to
13321 expunge all articles below this score
13322 (@code{gnus-score-set-expunge-below}).
13325 The keystrokes for actually making score entries follow a very regular
13326 pattern, so there's no need to list all the commands. (Hundreds of
13329 @findex gnus-summary-increase-score
13330 @findex gnus-summary-lower-score
13334 The first key is either @kbd{I} (upper case i) for increasing the score
13335 or @kbd{L} for lowering the score.
13337 The second key says what header you want to score on. The following
13338 keys are available:
13342 Score on the author name.
13345 Score on the subject line.
13348 Score on the @code{Xref} line---i.e., the cross-posting line.
13351 Score on the @code{References} line.
13357 Score on the number of lines.
13360 Score on the @code{Message-ID} header.
13363 Score on followups---this matches the author name, and adds scores to
13364 the followups to this author.
13378 The third key is the match type. Which match types are valid depends on
13379 what headers you are scoring on.
13391 Substring matching.
13394 Fuzzy matching (@pxref{Fuzzy Matching}).
13423 Greater than number.
13428 The fourth and final key says whether this is a temporary (i.e., expiring)
13429 score entry, or a permanent (i.e., non-expiring) score entry, or whether
13430 it is to be done immediately, without adding to the score file.
13434 Temporary score entry.
13437 Permanent score entry.
13440 Immediately scoring.
13445 So, let's say you want to increase the score on the current author with
13446 exact matching permanently: @kbd{I a e p}. If you want to lower the
13447 score based on the subject line, using substring matching, and make a
13448 temporary score entry: @kbd{L s s t}. Pretty easy.
13450 To make things a bit more complicated, there are shortcuts. If you use
13451 a capital letter on either the second or third keys, Gnus will use
13452 defaults for the remaining one or two keystrokes. The defaults are
13453 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
13454 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
13456 These functions take both the numerical prefix and the symbolic prefix
13457 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
13458 (or increase) the score of the article. A symbolic prefix of @code{a}
13459 says to use the @file{all.SCORE} file for the command instead of the
13460 current score file.
13462 @vindex gnus-score-mimic-keymap
13463 The @code{gnus-score-mimic-keymap} says whether these commands will
13464 pretend they are keymaps or not.
13467 @node Group Score Commands
13468 @section Group Score Commands
13469 @cindex group score commands
13471 There aren't many of these as yet, I'm afraid.
13476 @kindex W f (Group)
13477 @findex gnus-score-flush-cache
13478 Gnus maintains a cache of score alists to avoid having to reload them
13479 all the time. This command will flush the cache
13480 (@code{gnus-score-flush-cache}).
13484 You can do scoring from the command line by saying something like:
13486 @findex gnus-batch-score
13487 @cindex batch scoring
13489 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
13493 @node Score Variables
13494 @section Score Variables
13495 @cindex score variables
13499 @item gnus-use-scoring
13500 @vindex gnus-use-scoring
13501 If @code{nil}, Gnus will not check for score files, and will not, in
13502 general, do any score-related work. This is @code{t} by default.
13504 @item gnus-kill-killed
13505 @vindex gnus-kill-killed
13506 If this variable is @code{nil}, Gnus will never apply score files to
13507 articles that have already been through the kill process. While this
13508 may save you lots of time, it also means that if you apply a kill file
13509 to a group, and then change the kill file and want to run it over you
13510 group again to kill more articles, it won't work. You have to set this
13511 variable to @code{t} to do that. (It is @code{t} by default.)
13513 @item gnus-kill-files-directory
13514 @vindex gnus-kill-files-directory
13515 All kill and score files will be stored in this directory, which is
13516 initialized from the @code{SAVEDIR} environment variable by default.
13517 This is @file{~/News/} by default.
13519 @item gnus-score-file-suffix
13520 @vindex gnus-score-file-suffix
13521 Suffix to add to the group name to arrive at the score file name
13522 (@samp{SCORE} by default.)
13524 @item gnus-score-uncacheable-files
13525 @vindex gnus-score-uncacheable-files
13526 @cindex score cache
13527 All score files are normally cached to avoid excessive re-loading of
13528 score files. However, if this might make you Emacs grow big and
13529 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
13530 @file{all.SCORE}, while it might be a good idea to not cache
13531 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
13532 variable is @samp{ADAPT$} by default, so no adaptive score files will
13535 @item gnus-save-score
13536 @vindex gnus-save-score
13537 If you have really complicated score files, and do lots of batch
13538 scoring, then you might set this variable to @code{t}. This will make
13539 Gnus save the scores into the @file{.newsrc.eld} file.
13541 If you do not set this to @code{t}, then manual scores (like those set
13542 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
13543 across group visits.
13545 @item gnus-score-interactive-default-score
13546 @vindex gnus-score-interactive-default-score
13547 Score used by all the interactive raise/lower commands to raise/lower
13548 score with. Default is 1000, which may seem excessive, but this is to
13549 ensure that the adaptive scoring scheme gets enough room to play with.
13550 We don't want the small changes from the adaptive scoring to overwrite
13551 manually entered data.
13553 @item gnus-summary-default-score
13554 @vindex gnus-summary-default-score
13555 Default score of an article, which is 0 by default.
13557 @item gnus-summary-expunge-below
13558 @vindex gnus-summary-expunge-below
13559 Don't display the summary lines of articles that have scores lower than
13560 this variable. This is @code{nil} by default, which means that no
13561 articles will be hidden. This variable is local to the summary buffers,
13562 and has to be set from @code{gnus-summary-mode-hook}.
13564 @item gnus-score-over-mark
13565 @vindex gnus-score-over-mark
13566 Mark (in the third column) used for articles with a score over the
13567 default. Default is @samp{+}.
13569 @item gnus-score-below-mark
13570 @vindex gnus-score-below-mark
13571 Mark (in the third column) used for articles with a score below the
13572 default. Default is @samp{-}.
13574 @item gnus-score-find-score-files-function
13575 @vindex gnus-score-find-score-files-function
13576 Function used to find score files for the current group. This function
13577 is called with the name of the group as the argument.
13579 Predefined functions available are:
13582 @item gnus-score-find-single
13583 @findex gnus-score-find-single
13584 Only apply the group's own score file.
13586 @item gnus-score-find-bnews
13587 @findex gnus-score-find-bnews
13588 Apply all score files that match, using bnews syntax. This is the
13589 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
13590 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
13591 @file{gnu.all.SCORE} would all apply. In short, the instances of
13592 @samp{all} in the score file names are translated into @samp{.*}, and
13593 then a regexp match is done.
13595 This means that if you have some score entries that you want to apply to
13596 all groups, then you put those entries in the @file{all.SCORE} file.
13598 The score files are applied in a semi-random order, although Gnus will
13599 try to apply the more general score files before the more specific score
13600 files. It does this by looking at the number of elements in the score
13601 file names---discarding the @samp{all} elements.
13603 @item gnus-score-find-hierarchical
13604 @findex gnus-score-find-hierarchical
13605 Apply all score files from all the parent groups. This means that you
13606 can't have score files like @file{all.SCORE}, but you can have
13607 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
13610 This variable can also be a list of functions. In that case, all these
13611 functions will be called, and all the returned lists of score files will
13612 be applied. These functions can also return lists of score alists
13613 directly. In that case, the functions that return these non-file score
13614 alists should probably be placed before the ``real'' score file
13615 functions, to ensure that the last score file returned is the local
13618 @item gnus-score-expiry-days
13619 @vindex gnus-score-expiry-days
13620 This variable says how many days should pass before an unused score file
13621 entry is expired. If this variable is @code{nil}, no score file entries
13622 are expired. It's 7 by default.
13624 @item gnus-update-score-entry-dates
13625 @vindex gnus-update-score-entry-dates
13626 If this variable is non-@code{nil}, matching score entries will have
13627 their dates updated. (This is how Gnus controls expiry---all
13628 non-matching entries will become too old while matching entries will
13629 stay fresh and young.) However, if you set this variable to @code{nil},
13630 even matching entries will grow old and will have to face that oh-so
13633 @item gnus-score-after-write-file-function
13634 @vindex gnus-score-after-write-file-function
13635 Function called with the name of the score file just written.
13637 @item gnus-score-thread-simplify
13638 @vindex gnus-score-thread-simplify
13639 If this variable is non-@code{nil}, article subjects will be simplified
13640 for subject scoring purposes in the same manner as with
13641 threading---according to the current value of
13642 gnus-simplify-subject-functions. If the scoring entry uses
13643 @code{substring} or @code{exact} matching, the match will also be
13644 simplified in this manner.
13649 @node Score File Format
13650 @section Score File Format
13651 @cindex score file format
13653 A score file is an @code{emacs-lisp} file that normally contains just a
13654 single form. Casual users are not expected to edit these files;
13655 everything can be changed from the summary buffer.
13657 Anyway, if you'd like to dig into it yourself, here's an example:
13661 ("Lars Ingebrigtsen" -10000)
13663 ("larsi\\|lmi" -50000 nil R))
13665 ("Ding is Badd" nil 728373))
13667 ("alt.politics" -1000 728372 s))
13672 (mark-and-expunge -10)
13676 (files "/hom/larsi/News/gnu.SCORE")
13677 (exclude-files "all.SCORE")
13678 (local (gnus-newsgroup-auto-expire t)
13679 (gnus-summary-make-false-root empty))
13683 This example demonstrates most score file elements. For a different
13684 approach, see @pxref{Advanced Scoring}.
13686 Even though this looks much like lisp code, nothing here is actually
13687 @code{eval}ed. The lisp reader is used to read this form, though, so it
13688 has to be valid syntactically, if not semantically.
13690 Six keys are supported by this alist:
13695 If the key is a string, it is the name of the header to perform the
13696 match on. Scoring can only be performed on these eight headers:
13697 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
13698 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
13699 these headers, there are three strings to tell Gnus to fetch the entire
13700 article and do the match on larger parts of the article: @code{Body}
13701 will perform the match on the body of the article, @code{Head} will
13702 perform the match on the head of the article, and @code{All} will
13703 perform the match on the entire article. Note that using any of these
13704 last three keys will slow down group entry @emph{considerably}. The
13705 final ``header'' you can score on is @code{Followup}. These score
13706 entries will result in new score entries being added for all follow-ups
13707 to articles that matches these score entries.
13709 Following this key is a arbitrary number of score entries, where each
13710 score entry has one to four elements.
13714 The first element is the @dfn{match element}. On most headers this will
13715 be a string, but on the Lines and Chars headers, this must be an
13719 If the second element is present, it should be a number---the @dfn{score
13720 element}. This number should be an integer in the neginf to posinf
13721 interval. This number is added to the score of the article if the match
13722 is successful. If this element is not present, the
13723 @code{gnus-score-interactive-default-score} number will be used
13724 instead. This is 1000 by default.
13727 If the third element is present, it should be a number---the @dfn{date
13728 element}. This date says when the last time this score entry matched,
13729 which provides a mechanism for expiring the score entries. It this
13730 element is not present, the score entry is permanent. The date is
13731 represented by the number of days since December 31, 1 BCE.
13734 If the fourth element is present, it should be a symbol---the @dfn{type
13735 element}. This element specifies what function should be used to see
13736 whether this score entry matches the article. What match types that can
13737 be used depends on what header you wish to perform the match on.
13740 @item From, Subject, References, Xref, Message-ID
13741 For most header types, there are the @code{r} and @code{R} (regexp), as
13742 well as @code{s} and @code{S} (substring) types, and @code{e} and
13743 @code{E} (exact match), and @code{w} (word match) types. If this
13744 element is not present, Gnus will assume that substring matching should
13745 be used. @code{R}, @code{S}, and @code{E} differ from the others in
13746 that the matches will be done in a case-sensitive manner. All these
13747 one-letter types are really just abbreviations for the @code{regexp},
13748 @code{string}, @code{exact}, and @code{word} types, which you can use
13749 instead, if you feel like.
13752 These two headers use different match types: @code{<}, @code{>},
13753 @code{=}, @code{>=} and @code{<=}.
13755 These predicates are true if
13758 (PREDICATE HEADER MATCH)
13761 evaluates to non-@code{nil}. For instance, the advanced match
13762 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
13769 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
13770 the match, we get the score added if the article has less than 4 lines.
13771 (It's easy to get confused and think it's the other way around. But
13772 it's not. I think.)
13774 When matching on @code{Lines}, be careful because some backends (like
13775 @code{nndir}) do not generate @code{Lines} header, so every article ends
13776 up being marked as having 0 lines. This can lead to strange results if
13777 you happen to lower score of the articles with few lines.
13780 For the Date header we have three kinda silly match types:
13781 @code{before}, @code{at} and @code{after}. I can't really imagine this
13782 ever being useful, but, like, it would feel kinda silly not to provide
13783 this function. Just in case. You never know. Better safe than sorry.
13784 Once burnt, twice shy. Don't judge a book by its cover. Never not have
13785 sex on a first date. (I have been told that at least one person, and I
13786 quote, ``found this function indispensable'', however.)
13790 A more useful match type is @code{regexp}. With it, you can match the
13791 date string using a regular expression. The date is normalized to
13792 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
13793 you want to match all articles that have been posted on April 1st in
13794 every year, you could use @samp{....0401.........} as a match string,
13795 for instance. (Note that the date is kept in its original time zone, so
13796 this will match articles that were posted when it was April 1st where
13797 the article was posted from. Time zones are such wholesome fun for the
13800 @item Head, Body, All
13801 These three match keys use the same match types as the @code{From} (etc)
13805 This match key is somewhat special, in that it will match the
13806 @code{From} header, and affect the score of not only the matching
13807 articles, but also all followups to the matching articles. This allows
13808 you e.g. increase the score of followups to your own articles, or
13809 decrease the score of followups to the articles of some known
13810 trouble-maker. Uses the same match types as the @code{From} header
13811 uses. (Using this match key will lead to creation of @file{ADAPT}
13815 This match key works along the same lines as the @code{Followup} match
13816 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
13817 @samp{thread} match. This will add a new @samp{thread} match for each
13818 article that has @var{X} in its @code{References} header. (These new
13819 @samp{thread} matches will use the @code{Message-ID}s of these matching
13820 articles.) This will ensure that you can raise/lower the score of an
13821 entire thread, even though some articles in the thread may not have
13822 complete @code{References} headers. Note that using this may lead to
13823 undeterministic scores of the articles in the thread. (Using this match
13824 key will lead to creation of @file{ADAPT} files.)
13828 @cindex Score File Atoms
13830 The value of this entry should be a number. Any articles with a score
13831 lower than this number will be marked as read.
13834 The value of this entry should be a number. Any articles with a score
13835 lower than this number will be removed from the summary buffer.
13837 @item mark-and-expunge
13838 The value of this entry should be a number. Any articles with a score
13839 lower than this number will be marked as read and removed from the
13842 @item thread-mark-and-expunge
13843 The value of this entry should be a number. All articles that belong to
13844 a thread that has a total score below this number will be marked as read
13845 and removed from the summary buffer. @code{gnus-thread-score-function}
13846 says how to compute the total score for a thread.
13849 The value of this entry should be any number of file names. These files
13850 are assumed to be score files as well, and will be loaded the same way
13853 @item exclude-files
13854 The clue of this entry should be any number of files. These files will
13855 not be loaded, even though they would normally be so, for some reason or
13859 The value of this entry will be @code{eval}el. This element will be
13860 ignored when handling global score files.
13863 Read-only score files will not be updated or saved. Global score files
13864 should feature this atom (@pxref{Global Score Files}). (Note:
13865 @dfn{Global} here really means @dfn{global}; not your personal
13866 apply-to-all-groups score files.)
13869 The value of this entry should be a number. Articles that do not have
13870 parents will get this number added to their scores. Imagine you follow
13871 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
13872 will only follow a few of the threads, also want to see any new threads.
13874 You can do this with the following two score file entries:
13878 (mark-and-expunge -100)
13881 When you enter the group the first time, you will only see the new
13882 threads. You then raise the score of the threads that you find
13883 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
13884 rest. Next time you enter the group, you will see new articles in the
13885 interesting threads, plus any new threads.
13887 I.e.---the orphan score atom is for high-volume groups where there
13888 exist a few interesting threads which can't be found automatically by
13889 ordinary scoring rules.
13892 This entry controls the adaptive scoring. If it is @code{t}, the
13893 default adaptive scoring rules will be used. If it is @code{ignore}, no
13894 adaptive scoring will be performed on this group. If it is a list, this
13895 list will be used as the adaptive scoring rules. If it isn't present,
13896 or is something other than @code{t} or @code{ignore}, the default
13897 adaptive scoring rules will be used. If you want to use adaptive
13898 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
13899 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
13900 not want adaptive scoring. If you only want adaptive scoring in a few
13901 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
13902 insert @code{(adapt t)} in the score files of the groups where you want
13906 All adaptive score entries will go to the file named by this entry. It
13907 will also be applied when entering the group. This atom might be handy
13908 if you want to adapt on several groups at once, using the same adaptive
13909 file for a number of groups.
13912 @cindex local variables
13913 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
13914 Each @var{var} will be made buffer-local to the current summary buffer,
13915 and set to the value specified. This is a convenient, if somewhat
13916 strange, way of setting variables in some groups if you don't like hooks
13917 much. Note that the @var{value} won't be evaluated.
13921 @node Score File Editing
13922 @section Score File Editing
13924 You normally enter all scoring commands from the summary buffer, but you
13925 might feel the urge to edit them by hand as well, so we've supplied you
13926 with a mode for that.
13928 It's simply a slightly customized @code{emacs-lisp} mode, with these
13929 additional commands:
13934 @kindex C-c C-c (Score)
13935 @findex gnus-score-edit-done
13936 Save the changes you have made and return to the summary buffer
13937 (@code{gnus-score-edit-done}).
13940 @kindex C-c C-d (Score)
13941 @findex gnus-score-edit-insert-date
13942 Insert the current date in numerical format
13943 (@code{gnus-score-edit-insert-date}). This is really the day number, if
13944 you were wondering.
13947 @kindex C-c C-p (Score)
13948 @findex gnus-score-pretty-print
13949 The adaptive score files are saved in an unformatted fashion. If you
13950 intend to read one of these files, you want to @dfn{pretty print} it
13951 first. This command (@code{gnus-score-pretty-print}) does that for
13956 Type @kbd{M-x gnus-score-mode} to use this mode.
13958 @vindex gnus-score-mode-hook
13959 @code{gnus-score-menu-hook} is run in score mode buffers.
13961 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
13962 e} to begin editing score files.
13965 @node Adaptive Scoring
13966 @section Adaptive Scoring
13967 @cindex adaptive scoring
13969 If all this scoring is getting you down, Gnus has a way of making it all
13970 happen automatically---as if by magic. Or rather, as if by artificial
13971 stupidity, to be precise.
13973 @vindex gnus-use-adaptive-scoring
13974 When you read an article, or mark an article as read, or kill an
13975 article, you leave marks behind. On exit from the group, Gnus can sniff
13976 these marks and add score elements depending on what marks it finds.
13977 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
13978 @code{t} or @code{(line)}. If you want score adaptively on separate
13979 words appearing in the subjects, you should set this variable to
13980 @code{(word)}. If you want to use both adaptive methods, set this
13981 variable to @code{(word line)}.
13983 @vindex gnus-default-adaptive-score-alist
13984 To give you complete control over the scoring process, you can customize
13985 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
13986 might look something like this:
13989 (defvar gnus-default-adaptive-score-alist
13990 '((gnus-unread-mark)
13991 (gnus-ticked-mark (from 4))
13992 (gnus-dormant-mark (from 5))
13993 (gnus-del-mark (from -4) (subject -1))
13994 (gnus-read-mark (from 4) (subject 2))
13995 (gnus-expirable-mark (from -1) (subject -1))
13996 (gnus-killed-mark (from -1) (subject -3))
13997 (gnus-kill-file-mark)
13998 (gnus-ancient-mark)
13999 (gnus-low-score-mark)
14000 (gnus-catchup-mark (from -1) (subject -1))))
14003 As you see, each element in this alist has a mark as a key (either a
14004 variable name or a ``real'' mark---a character). Following this key is
14005 a arbitrary number of header/score pairs. If there are no header/score
14006 pairs following the key, no adaptive scoring will be done on articles
14007 that have that key as the article mark. For instance, articles with
14008 @code{gnus-unread-mark} in the example above will not get adaptive score
14011 Each article can have only one mark, so just a single of these rules
14012 will be applied to each article.
14014 To take @code{gnus-del-mark} as an example---this alist says that all
14015 articles that have that mark (i.e., are marked with @samp{D}) will have a
14016 score entry added to lower based on the @code{From} header by -4, and
14017 lowered by @code{Subject} by -1. Change this to fit your prejudices.
14019 If you have marked 10 articles with the same subject with
14020 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
14021 That means that that subject will get a score of ten times -1, which
14022 should be, unless I'm much mistaken, -10.
14024 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
14025 the read articles will be marked with the @samp{E} mark. This'll
14026 probably make adaptive scoring slightly impossible, so auto-expiring and
14027 adaptive scoring doesn't really mix very well.
14029 The headers you can score on are @code{from}, @code{subject},
14030 @code{message-id}, @code{references}, @code{xref}, @code{lines},
14031 @code{chars} and @code{date}. In addition, you can score on
14032 @code{followup}, which will create an adaptive score entry that matches
14033 on the @code{References} header using the @code{Message-ID} of the
14034 current article, thereby matching the following thread.
14036 You can also score on @code{thread}, which will try to score all
14037 articles that appear in a thread. @code{thread} matches uses a
14038 @code{Message-ID} to match on the @code{References} header of the
14039 article. If the match is made, the @code{Message-ID} of the article is
14040 added to the @code{thread} rule. (Think about it. I'd recommend two
14041 aspirins afterwards.)
14043 If you use this scheme, you should set the score file atom @code{mark}
14044 to something small---like -300, perhaps, to avoid having small random
14045 changes result in articles getting marked as read.
14047 After using adaptive scoring for a week or so, Gnus should start to
14048 become properly trained and enhance the authors you like best, and kill
14049 the authors you like least, without you having to say so explicitly.
14051 You can control what groups the adaptive scoring is to be performed on
14052 by using the score files (@pxref{Score File Format}). This will also
14053 let you use different rules in different groups.
14055 @vindex gnus-adaptive-file-suffix
14056 The adaptive score entries will be put into a file where the name is the
14057 group name with @code{gnus-adaptive-file-suffix} appended. The default
14060 @vindex gnus-score-exact-adapt-limit
14061 When doing adaptive scoring, substring or fuzzy matching would probably
14062 give you the best results in most cases. However, if the header one
14063 matches is short, the possibility for false positives is great, so if
14064 the length of the match is less than
14065 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
14066 this variable is @code{nil}, exact matching will always be used to avoid
14069 @vindex gnus-default-adaptive-word-score-alist
14070 As mentioned above, you can adapt either on individual words or entire
14071 headers. If you adapt on words, the
14072 @code{gnus-default-adaptive-word-score-alist} variable says what score
14073 each instance of a word should add given a mark.
14076 (setq gnus-default-adaptive-word-score-alist
14077 `((,gnus-read-mark . 30)
14078 (,gnus-catchup-mark . -10)
14079 (,gnus-killed-mark . -20)
14080 (,gnus-del-mark . -15)))
14083 This is the default value. If you have adaption on words enabled, every
14084 word that appears in subjects of articles marked with
14085 @code{gnus-read-mark} will result in a score rule that increase the
14086 score with 30 points.
14088 @vindex gnus-default-ignored-adaptive-words
14089 @vindex gnus-ignored-adaptive-words
14090 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
14091 will be ignored. If you wish to add more words to be ignored, use the
14092 @code{gnus-ignored-adaptive-words} list instead.
14094 @vindex gnus-adaptive-word-syntax-table
14095 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
14096 syntax table in effect. It is similar to the standard syntax table, but
14097 it considers numbers to be non-word-constituent characters.
14099 @vindex gnus-adaptive-word-minimum
14100 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
14101 word scoring process will never bring down the score of an article to
14102 below this number. The default is @code{nil}.
14104 @vindex gnus-adaptive-word-no-group-words
14105 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
14106 won't adaptively word score any of the words in the group name. Useful
14107 for groups like @samp{comp.editors.emacs}, where most of the subject
14108 lines contain the word @samp{emacs}.
14110 After using this scheme for a while, it might be nice to write a
14111 @code{gnus-psychoanalyze-user} command to go through the rules and see
14112 what words you like and what words you don't like. Or perhaps not.
14114 Note that the adaptive word scoring thing is highly experimental and is
14115 likely to change in the future. Initial impressions seem to indicate
14116 that it's totally useless as it stands. Some more work (involving more
14117 rigorous statistical methods) will have to be done to make this useful.
14120 @node Home Score File
14121 @section Home Score File
14123 The score file where new score file entries will go is called the
14124 @dfn{home score file}. This is normally (and by default) the score file
14125 for the group itself. For instance, the home score file for
14126 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
14128 However, this may not be what you want. It is often convenient to share
14129 a common home score file among many groups---all @samp{emacs} groups
14130 could perhaps use the same home score file.
14132 @vindex gnus-home-score-file
14133 The variable that controls this is @code{gnus-home-score-file}. It can
14138 A string. Then this file will be used as the home score file for all
14142 A function. The result of this function will be used as the home score
14143 file. The function will be called with the name of the group as the
14147 A list. The elements in this list can be:
14151 @var{(regexp file-name)}. If the @var{regexp} matches the group name,
14152 the @var{file-name} will will be used as the home score file.
14155 A function. If the function returns non-nil, the result will be used as
14156 the home score file.
14159 A string. Use the string as the home score file.
14162 The list will be traversed from the beginning towards the end looking
14167 So, if you want to use just a single score file, you could say:
14170 (setq gnus-home-score-file
14171 "my-total-score-file.SCORE")
14174 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
14175 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
14177 @findex gnus-hierarchial-home-score-file
14179 (setq gnus-home-score-file
14180 'gnus-hierarchial-home-score-file)
14183 This is a ready-made function provided for your convenience.
14184 Other functions include
14187 @item gnus-current-home-score-file
14188 @findex gnus-current-home-score-file
14189 Return the ``current'' regular score file. This will make scoring
14190 commands add entry to the ``innermost'' matching score file.
14194 If you want to have one score file for the @samp{emacs} groups and
14195 another for the @samp{comp} groups, while letting all other groups use
14196 their own home score files:
14199 (setq gnus-home-score-file
14200 ;; All groups that match the regexp "\\.emacs"
14201 '(("\\.emacs" "emacs.SCORE")
14202 ;; All the comp groups in one score file
14203 ("^comp" "comp.SCORE")))
14206 @vindex gnus-home-adapt-file
14207 @code{gnus-home-adapt-file} works exactly the same way as
14208 @code{gnus-home-score-file}, but says what the home adaptive score file
14209 is instead. All new adaptive file entries will go into the file
14210 specified by this variable, and the same syntax is allowed.
14212 In addition to using @code{gnus-home-score-file} and
14213 @code{gnus-home-adapt-file}, you can also use group parameters
14214 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
14215 Parameters}) to achieve much the same. Group and topic parameters take
14216 precedence over this variable.
14219 @node Followups To Yourself
14220 @section Followups To Yourself
14222 Gnus offers two commands for picking out the @code{Message-ID} header in
14223 the current buffer. Gnus will then add a score rule that scores using
14224 this @code{Message-ID} on the @code{References} header of other
14225 articles. This will, in effect, increase the score of all articles that
14226 respond to the article in the current buffer. Quite useful if you want
14227 to easily note when people answer what you've said.
14231 @item gnus-score-followup-article
14232 @findex gnus-score-followup-article
14233 This will add a score to articles that directly follow up your own
14236 @item gnus-score-followup-thread
14237 @findex gnus-score-followup-thread
14238 This will add a score to all articles that appear in a thread ``below''
14242 @vindex message-sent-hook
14243 These two functions are both primarily meant to be used in hooks like
14244 @code{message-sent-hook}.
14246 If you look closely at your own @code{Message-ID}, you'll notice that
14247 the first two or three characters are always the same. Here's two of
14251 <x6u3u47icf.fsf@@eyesore.no>
14252 <x6sp9o7ibw.fsf@@eyesore.no>
14255 So ``my'' ident on this machine is @samp{x6}. This can be
14256 exploited---the following rule will raise the score on all followups to
14261 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
14265 Whether it's the first two or first three characters that are ``yours''
14266 is system-dependent.
14270 @section Scoring Tips
14271 @cindex scoring tips
14277 @cindex scoring crossposts
14278 If you want to lower the score of crossposts, the line to match on is
14279 the @code{Xref} header.
14281 ("xref" (" talk.politics.misc:" -1000))
14284 @item Multiple crossposts
14285 If you want to lower the score of articles that have been crossposted to
14286 more than, say, 3 groups:
14288 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
14291 @item Matching on the body
14292 This is generally not a very good idea---it takes a very long time.
14293 Gnus actually has to fetch each individual article from the server. But
14294 you might want to anyway, I guess. Even though there are three match
14295 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
14296 and stick with it in each score file. If you use any two, each article
14297 will be fetched @emph{twice}. If you want to match a bit on the
14298 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
14301 @item Marking as read
14302 You will probably want to mark articles that have scores below a certain
14303 number as read. This is most easily achieved by putting the following
14304 in your @file{all.SCORE} file:
14308 You may also consider doing something similar with @code{expunge}.
14310 @item Negated character classes
14311 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
14312 That will match newlines, which might lead to, well, The Unknown. Say
14313 @code{[^abcd\n]*} instead.
14317 @node Reverse Scoring
14318 @section Reverse Scoring
14319 @cindex reverse scoring
14321 If you want to keep just articles that have @samp{Sex with Emacs} in the
14322 subject header, and expunge all other articles, you could put something
14323 like this in your score file:
14327 ("Sex with Emacs" 2))
14332 So, you raise all articles that match @samp{Sex with Emacs} and mark the
14333 rest as read, and expunge them to boot.
14336 @node Global Score Files
14337 @section Global Score Files
14338 @cindex global score files
14340 Sure, other newsreaders have ``global kill files''. These are usually
14341 nothing more than a single kill file that applies to all groups, stored
14342 in the user's home directory. Bah! Puny, weak newsreaders!
14344 What I'm talking about here are Global Score Files. Score files from
14345 all over the world, from users everywhere, uniting all nations in one
14346 big, happy score file union! Ange-score! New and untested!
14348 @vindex gnus-global-score-files
14349 All you have to do to use other people's score files is to set the
14350 @code{gnus-global-score-files} variable. One entry for each score file,
14351 or each score file directory. Gnus will decide by itself what score
14352 files are applicable to which group.
14354 Say you want to use the score file
14355 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
14356 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
14359 (setq gnus-global-score-files
14360 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
14361 "/ftp@@ftp.some-where:/pub/score/"))
14364 @findex gnus-score-search-global-directories
14365 Simple, eh? Directory names must end with a @samp{/}. These
14366 directories are typically scanned only once during each Gnus session.
14367 If you feel the need to manually re-scan the remote directories, you can
14368 use the @code{gnus-score-search-global-directories} command.
14370 Note that, at present, using this option will slow down group entry
14371 somewhat. (That is---a lot.)
14373 If you want to start maintaining score files for other people to use,
14374 just put your score file up for anonymous ftp and announce it to the
14375 world. Become a retro-moderator! Participate in the retro-moderator
14376 wars sure to ensue, where retro-moderators battle it out for the
14377 sympathy of the people, luring them to use their score files on false
14378 premises! Yay! The net is saved!
14380 Here are some tips for the would-be retro-moderator, off the top of my
14386 Articles heavily crossposted are probably junk.
14388 To lower a single inappropriate article, lower by @code{Message-ID}.
14390 Particularly brilliant authors can be raised on a permanent basis.
14392 Authors that repeatedly post off-charter for the group can safely be
14393 lowered out of existence.
14395 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
14396 articles completely.
14399 Use expiring score entries to keep the size of the file down. You
14400 should probably have a long expiry period, though, as some sites keep
14401 old articles for a long time.
14404 ... I wonder whether other newsreaders will support global score files
14405 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
14406 Wave, xrn and 1stReader are bound to implement scoring. Should we start
14407 holding our breath yet?
14411 @section Kill Files
14414 Gnus still supports those pesky old kill files. In fact, the kill file
14415 entries can now be expiring, which is something I wrote before Daniel
14416 Quinlan thought of doing score files, so I've left the code in there.
14418 In short, kill processing is a lot slower (and I do mean @emph{a lot})
14419 than score processing, so it might be a good idea to rewrite your kill
14420 files into score files.
14422 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
14423 forms into this file, which means that you can use kill files as some
14424 sort of primitive hook function to be run on group entry, even though
14425 that isn't a very good idea.
14427 Normal kill files look like this:
14430 (gnus-kill "From" "Lars Ingebrigtsen")
14431 (gnus-kill "Subject" "ding")
14435 This will mark every article written by me as read, and remove the
14436 marked articles from the summary buffer. Very useful, you'll agree.
14438 Other programs use a totally different kill file syntax. If Gnus
14439 encounters what looks like a @code{rn} kill file, it will take a stab at
14442 Two summary functions for editing a GNUS kill file:
14447 @kindex M-k (Summary)
14448 @findex gnus-summary-edit-local-kill
14449 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
14452 @kindex M-K (Summary)
14453 @findex gnus-summary-edit-global-kill
14454 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
14457 Two group mode functions for editing the kill files:
14462 @kindex M-k (Group)
14463 @findex gnus-group-edit-local-kill
14464 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
14467 @kindex M-K (Group)
14468 @findex gnus-group-edit-global-kill
14469 Edit the general kill file (@code{gnus-group-edit-global-kill}).
14472 Kill file variables:
14475 @item gnus-kill-file-name
14476 @vindex gnus-kill-file-name
14477 A kill file for the group @samp{soc.motss} is normally called
14478 @file{soc.motss.KILL}. The suffix appended to the group name to get
14479 this file name is detailed by the @code{gnus-kill-file-name} variable.
14480 The ``global'' kill file (not in the score file sense of ``global'', of
14481 course) is just called @file{KILL}.
14483 @vindex gnus-kill-save-kill-file
14484 @item gnus-kill-save-kill-file
14485 If this variable is non-@code{nil}, Gnus will save the
14486 kill file after processing, which is necessary if you use expiring
14489 @item gnus-apply-kill-hook
14490 @vindex gnus-apply-kill-hook
14491 @findex gnus-apply-kill-file-unless-scored
14492 @findex gnus-apply-kill-file
14493 A hook called to apply kill files to a group. It is
14494 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
14495 kill file if you have a score file for the same group, you can set this
14496 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
14497 kill files to be processed, you should set this variable to @code{nil}.
14499 @item gnus-kill-file-mode-hook
14500 @vindex gnus-kill-file-mode-hook
14501 A hook called in kill-file mode buffers.
14506 @node Converting Kill Files
14507 @section Converting Kill Files
14509 @cindex converting kill files
14511 If you have loads of old kill files, you may want to convert them into
14512 score files. If they are ``regular'', you can use
14513 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
14516 The kill to score conversion package isn't included in Gnus by default.
14517 You can fetch it from
14518 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
14520 If your old kill files are very complex---if they contain more
14521 non-@code{gnus-kill} forms than not, you'll have to convert them by
14522 hand. Or just let them be as they are. Gnus will still use them as
14530 GroupLens is a collaborative filtering system that helps you work
14531 together with other people to find the quality news articles out of the
14532 huge volume of news articles generated every day.
14534 To accomplish this the GroupLens system combines your opinions about
14535 articles you have already read with the opinions of others who have done
14536 likewise and gives you a personalized prediction for each unread news
14537 article. Think of GroupLens as a matchmaker. GroupLens watches how you
14538 rate articles, and finds other people that rate articles the same way.
14539 Once it has found some people you agree with it tells you, in the form
14540 of a prediction, what they thought of the article. You can use this
14541 prediction to help you decide whether or not you want to read the
14545 * Using GroupLens:: How to make Gnus use GroupLens.
14546 * Rating Articles:: Letting GroupLens know how you rate articles.
14547 * Displaying Predictions:: Displaying predictions given by GroupLens.
14548 * GroupLens Variables:: Customizing GroupLens.
14552 @node Using GroupLens
14553 @subsection Using GroupLens
14555 To use GroupLens you must register a pseudonym with your local Better
14557 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
14558 better bit in town at the moment.
14560 Once you have registered you'll need to set a couple of variables.
14564 @item gnus-use-grouplens
14565 @vindex gnus-use-grouplens
14566 Setting this variable to a non-@code{nil} value will make Gnus hook into
14567 all the relevant GroupLens functions.
14569 @item grouplens-pseudonym
14570 @vindex grouplens-pseudonym
14571 This variable should be set to the pseudonym you got when registering
14572 with the Better Bit Bureau.
14574 @item grouplens-newsgroups
14575 @vindex grouplens-newsgroups
14576 A list of groups that you want to get GroupLens predictions for.
14580 That's the minimum of what you need to get up and running with GroupLens.
14581 Once you've registered, GroupLens will start giving you scores for
14582 articles based on the average of what other people think. But, to get
14583 the real benefit of GroupLens you need to start rating articles
14584 yourself. Then the scores GroupLens gives you will be personalized for
14585 you, based on how the people you usually agree with have already rated.
14588 @node Rating Articles
14589 @subsection Rating Articles
14591 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
14592 Where 1 means something like this article is a waste of bandwidth and 5
14593 means that the article was really good. The basic question to ask
14594 yourself is, "on a scale from 1 to 5 would I like to see more articles
14597 There are four ways to enter a rating for an article in GroupLens.
14602 @kindex r (GroupLens)
14603 @findex bbb-summary-rate-article
14604 This function will prompt you for a rating on a scale of one to five.
14607 @kindex k (GroupLens)
14608 @findex grouplens-score-thread
14609 This function will prompt you for a rating, and rate all the articles in
14610 the thread. This is really useful for some of those long running giant
14611 threads in rec.humor.
14615 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
14616 the score of the article you're reading.
14621 @kindex n (GroupLens)
14622 @findex grouplens-next-unread-article
14623 Rate the article and go to the next unread article.
14626 @kindex , (GroupLens)
14627 @findex grouplens-best-unread-article
14628 Rate the article and go to the next unread article with the highest score.
14632 If you want to give the current article a score of 4 and then go to the
14633 next article, just type @kbd{4 n}.
14636 @node Displaying Predictions
14637 @subsection Displaying Predictions
14639 GroupLens makes a prediction for you about how much you will like a
14640 news article. The predictions from GroupLens are on a scale from 1 to
14641 5, where 1 is the worst and 5 is the best. You can use the predictions
14642 from GroupLens in one of three ways controlled by the variable
14643 @code{gnus-grouplens-override-scoring}.
14645 @vindex gnus-grouplens-override-scoring
14646 There are three ways to display predictions in grouplens. You may
14647 choose to have the GroupLens scores contribute to, or override the
14648 regular gnus scoring mechanism. override is the default; however, some
14649 people prefer to see the Gnus scores plus the grouplens scores. To get
14650 the separate scoring behavior you need to set
14651 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
14652 GroupLens predictions combined with the grouplens scores set it to
14653 @code{'override} and to combine the scores set
14654 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
14655 the combine option you will also want to set the values for
14656 @code{grouplens-prediction-offset} and
14657 @code{grouplens-score-scale-factor}.
14659 @vindex grouplens-prediction-display
14660 In either case, GroupLens gives you a few choices for how you would like
14661 to see your predictions displayed. The display of predictions is
14662 controlled by the @code{grouplens-prediction-display} variable.
14664 The following are valid values for that variable.
14667 @item prediction-spot
14668 The higher the prediction, the further to the right an @samp{*} is
14671 @item confidence-interval
14672 A numeric confidence interval.
14674 @item prediction-bar
14675 The higher the prediction, the longer the bar.
14677 @item confidence-bar
14678 Numerical confidence.
14680 @item confidence-spot
14681 The spot gets bigger with more confidence.
14683 @item prediction-num
14684 Plain-old numeric value.
14686 @item confidence-plus-minus
14687 Prediction +/- confidence.
14692 @node GroupLens Variables
14693 @subsection GroupLens Variables
14697 @item gnus-summary-grouplens-line-format
14698 The summary line format used in GroupLens-enhanced summary buffers. It
14699 accepts the same specs as the normal summary line format (@pxref{Summary
14700 Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
14703 @item grouplens-bbb-host
14704 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
14707 @item grouplens-bbb-port
14708 Port of the host running the bbbd server. The default is 9000.
14710 @item grouplens-score-offset
14711 Offset the prediction by this value. In other words, subtract the
14712 prediction value by this number to arrive at the effective score. The
14715 @item grouplens-score-scale-factor
14716 This variable allows the user to magnify the effect of GroupLens scores.
14717 The scale factor is applied after the offset. The default is 1.
14722 @node Advanced Scoring
14723 @section Advanced Scoring
14725 Scoring on Subjects and From headers is nice enough, but what if you're
14726 really interested in what a person has to say only when she's talking
14727 about a particular subject? Or what if you really don't want to
14728 read what person A has to say when she's following up to person B, but
14729 want to read what she says when she's following up to person C?
14731 By using advanced scoring rules you may create arbitrarily complex
14735 * Advanced Scoring Syntax:: A definition.
14736 * Advanced Scoring Examples:: What they look like.
14737 * Advanced Scoring Tips:: Getting the most out of it.
14741 @node Advanced Scoring Syntax
14742 @subsection Advanced Scoring Syntax
14744 Ordinary scoring rules have a string as the first element in the rule.
14745 Advanced scoring rules have a list as the first element. The second
14746 element is the score to be applied if the first element evaluated to a
14747 non-@code{nil} value.
14749 These lists may consist of three logical operators, one redirection
14750 operator, and various match operators.
14757 This logical operator will evaluate each of its arguments until it finds
14758 one that evaluates to @code{false}, and then it'll stop. If all arguments
14759 evaluate to @code{true} values, then this operator will return
14764 This logical operator will evaluate each of its arguments until it finds
14765 one that evaluates to @code{true}. If no arguments are @code{true},
14766 then this operator will return @code{false}.
14771 This logical operator only takes a single argument. It returns the
14772 logical negation of the value of its argument.
14776 There is an @dfn{indirection operator} that will make its arguments
14777 apply to the ancestors of the current article being scored. For
14778 instance, @code{1-} will make score rules apply to the parent of the
14779 current article. @code{2-} will make score rules apply to the
14780 grandparent of the current article. Alternatively, you can write
14781 @code{^^}, where the number of @code{^}s (carets) says how far back into
14782 the ancestry you want to go.
14784 Finally, we have the match operators. These are the ones that do the
14785 real work. Match operators are header name strings followed by a match
14786 and a match type. A typical match operator looks like @samp{("from"
14787 "Lars Ingebrigtsen" s)}. The header names are the same as when using
14788 simple scoring, and the match types are also the same.
14791 @node Advanced Scoring Examples
14792 @subsection Advanced Scoring Examples
14794 Let's say you want to increase the score of articles written by Lars
14795 when he's talking about Gnus:
14799 ("from" "Lars Ingebrigtsen")
14800 ("subject" "Gnus"))
14806 When he writes long articles, he sometimes has something nice to say:
14810 ("from" "Lars Ingebrigtsen")
14817 However, when he responds to things written by Reig Eigil Logge, you
14818 really don't want to read what he's written:
14822 ("from" "Lars Ingebrigtsen")
14823 (1- ("from" "Reig Eigir Logge")))
14827 Everybody that follows up Redmondo when he writes about disappearing
14828 socks should have their scores raised, but only when they talk about
14829 white socks. However, when Lars talks about socks, it's usually not
14836 ("from" "redmondo@@.*no" r)
14837 ("body" "disappearing.*socks" t)))
14838 (! ("from" "Lars Ingebrigtsen"))
14839 ("body" "white.*socks"))
14843 The possibilities are endless.
14846 @node Advanced Scoring Tips
14847 @subsection Advanced Scoring Tips
14849 The @code{&} and @code{|} logical operators do short-circuit logic.
14850 That is, they stop processing their arguments when it's clear what the
14851 result of the operation will be. For instance, if one of the arguments
14852 of an @code{&} evaluates to @code{false}, there's no point in evaluating
14853 the rest of the arguments. This means that you should put slow matches
14854 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
14855 @samp{subject}) first.
14857 The indirection arguments (@code{1-} and so on) will make their
14858 arguments work on previous generations of the thread. If you say
14869 Then that means "score on the from header of the grandparent of the
14870 current article". An indirection is quite fast, but it's better to say:
14876 ("subject" "Gnus")))
14883 (1- ("from" "Lars"))
14884 (1- ("subject" "Gnus")))
14889 @section Score Decays
14890 @cindex score decays
14893 You may find that your scores have a tendency to grow without
14894 bounds, especially if you're using adaptive scoring. If scores get too
14895 big, they lose all meaning---they simply max out and it's difficult to
14896 use them in any sensible way.
14898 @vindex gnus-decay-scores
14899 @findex gnus-decay-score
14900 @vindex gnus-decay-score-function
14901 Gnus provides a mechanism for decaying scores to help with this problem.
14902 When score files are loaded and @code{gnus-decay-scores} is
14903 non-@code{nil}, Gnus will run the score files through the decaying
14904 mechanism thereby lowering the scores of all non-permanent score rules.
14905 The decay itself if performed by the @code{gnus-decay-score-function}
14906 function, which is @code{gnus-decay-score} by default. Here's the
14907 definition of that function:
14910 (defun gnus-decay-score (score)
14912 This is done according to `gnus-score-decay-constant'
14913 and `gnus-score-decay-scale'."
14916 (* (if (< score 0) 1 -1)
14918 (max gnus-score-decay-constant
14920 gnus-score-decay-scale)))))))
14923 @vindex gnus-score-decay-scale
14924 @vindex gnus-score-decay-constant
14925 @code{gnus-score-decay-constant} is 3 by default and
14926 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
14930 Scores between -3 and 3 will be set to 0 when this function is called.
14933 Scores with magnitudes between 3 and 60 will be shrunk by 3.
14936 Scores with magnitudes greater than 60 will be shrunk by 5% of the
14940 If you don't like this decay function, write your own. It is called
14941 with the score to be decayed as its only parameter, and it should return
14942 the new score, which should be an integer.
14944 Gnus will try to decay scores once a day. If you haven't run Gnus for
14945 four days, Gnus will decay the scores four times, for instance.
14952 * Process/Prefix:: A convention used by many treatment commands.
14953 * Interactive:: Making Gnus ask you many questions.
14954 * Symbolic Prefixes:: How to supply some Gnus functions with options.
14955 * Formatting Variables:: You can specify what buffers should look like.
14956 * Windows Configuration:: Configuring the Gnus buffer windows.
14957 * Faces and Fonts:: How to change how faces look.
14958 * Compilation:: How to speed Gnus up.
14959 * Mode Lines:: Displaying information in the mode lines.
14960 * Highlighting and Menus:: Making buffers look all nice and cozy.
14961 * Buttons:: Get tendonitis in ten easy steps!
14962 * Daemons:: Gnus can do things behind your back.
14963 * NoCeM:: How to avoid spam and other fatty foods.
14964 * Undo:: Some actions can be undone.
14965 * Moderation:: What to do if you're a moderator.
14966 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
14967 * Fuzzy Matching:: What's the big fuzz?
14968 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
14969 * Various Various:: Things that are really various.
14973 @node Process/Prefix
14974 @section Process/Prefix
14975 @cindex process/prefix convention
14977 Many functions, among them functions for moving, decoding and saving
14978 articles, use what is known as the @dfn{Process/Prefix convention}.
14980 This is a method for figuring out what articles the user wants the
14981 command to be performed on.
14985 If the numeric prefix is N, perform the operation on the next N
14986 articles, starting with the current one. If the numeric prefix is
14987 negative, perform the operation on the previous N articles, starting
14988 with the current one.
14990 @vindex transient-mark-mode
14991 If @code{transient-mark-mode} in non-@code{nil} and the region is
14992 active, all articles in the region will be worked upon.
14994 If there is no numeric prefix, but some articles are marked with the
14995 process mark, perform the operation on the articles marked with
14998 If there is neither a numeric prefix nor any articles marked with the
14999 process mark, just perform the operation on the current article.
15001 Quite simple, really, but it needs to be made clear so that surprises
15004 Commands that react to the process mark will push the current list of
15005 process marked articles onto a stack and will then clear all process
15006 marked articles. You can restore the previous configuration with the
15007 @kbd{M P y} command (@pxref{Setting Process Marks}).
15009 @vindex gnus-summary-goto-unread
15010 One thing that seems to shock & horrify lots of people is that, for
15011 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
15012 Since each @kbd{d} (which marks the current article as read) by default
15013 goes to the next unread article after marking, this means that @kbd{3 d}
15014 will mark the next three unread articles as read, no matter what the
15015 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
15016 @code{nil} for a more straightforward action.
15020 @section Interactive
15021 @cindex interaction
15025 @item gnus-novice-user
15026 @vindex gnus-novice-user
15027 If this variable is non-@code{nil}, you are either a newcomer to the
15028 World of Usenet, or you are very cautious, which is a nice thing to be,
15029 really. You will be given questions of the type ``Are you sure you want
15030 to do this?'' before doing anything dangerous. This is @code{t} by
15033 @item gnus-expert-user
15034 @vindex gnus-expert-user
15035 If this variable is non-@code{nil}, you will seldom be asked any
15036 questions by Gnus. It will simply assume you know what you're doing, no
15037 matter how strange.
15039 @item gnus-interactive-catchup
15040 @vindex gnus-interactive-catchup
15041 Require confirmation before catching up a group if non-@code{nil}. It
15042 is @code{t} by default.
15044 @item gnus-interactive-exit
15045 @vindex gnus-interactive-exit
15046 Require confirmation before exiting Gnus. This variable is @code{t} by
15051 @node Symbolic Prefixes
15052 @section Symbolic Prefixes
15053 @cindex symbolic prefixes
15055 Quite a lot of Emacs commands react to the (numeric) prefix. For
15056 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
15057 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
15058 rule of 900 to the current article.
15060 This is all nice and well, but what if you want to give a command some
15061 additional information? Well, what most commands do is interpret the
15062 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
15063 doesn't want a backup file to be created when saving the current buffer,
15064 for instance. But what if you want to save without making a backup
15065 file, and you want Emacs to flash lights and play a nice tune at the
15066 same time? You can't, and you're probably perfectly happy that way.
15068 @kindex M-i (Summary)
15069 @findex gnus-symbolic-argument
15070 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
15071 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
15072 character typed in is the value. You can stack as many @kbd{M-i}
15073 prefixes as you want. @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
15074 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b M-C-u} means
15075 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
15076 @code{b}''. You get the drift.
15078 Typing in symbolic prefixes to commands that don't accept them doesn't
15079 hurt, but it doesn't do any good either. Currently not many Gnus
15080 functions make use of the symbolic prefix.
15082 If you're interested in how Gnus implements this, @pxref{Extended
15086 @node Formatting Variables
15087 @section Formatting Variables
15088 @cindex formatting variables
15090 Throughout this manual you've probably noticed lots of variables called
15091 things like @code{gnus-group-line-format} and
15092 @code{gnus-summary-mode-line-format}. These control how Gnus is to
15093 output lines in the various buffers. There's quite a lot of them.
15094 Fortunately, they all use the same syntax, so there's not that much to
15097 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
15098 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
15099 lots of percentages everywhere.
15102 * Formatting Basics:: A formatting variable is basically a format string.
15103 * Mode Line Formatting:: Some rules about mode line formatting variables.
15104 * Advanced Formatting:: Modifying output in various ways.
15105 * User-Defined Specs:: Having Gnus call your own functions.
15106 * Formatting Fonts:: Making the formatting look colorful and nice.
15109 Currently Gnus uses the following formatting variables:
15110 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
15111 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
15112 @code{gnus-group-mode-line-format},
15113 @code{gnus-summary-mode-line-format},
15114 @code{gnus-article-mode-line-format},
15115 @code{gnus-server-mode-line-format}, and
15116 @code{gnus-summary-pick-line-format}.
15118 All these format variables can also be arbitrary elisp forms. In that
15119 case, they will be @code{eval}ed to insert the required lines.
15121 @kindex M-x gnus-update-format
15122 @findex gnus-update-format
15123 Gnus includes a command to help you while creating your own format
15124 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
15125 update the spec in question and pop you to a buffer where you can
15126 examine the resulting lisp code to be run to generate the line.
15130 @node Formatting Basics
15131 @subsection Formatting Basics
15133 Each @samp{%} element will be replaced by some string or other when the
15134 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
15135 spec, and pad with spaces to get a 5-character field''.
15137 As with normal C and Emacs Lisp formatting strings, the numerical
15138 modifier between the @samp{%} and the formatting type character will
15139 @dfn{pad} the output so that it is always at least that long.
15140 @samp{%5y} will make the field always (at least) five characters wide by
15141 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
15144 You may also wish to limit the length of the field to protect against
15145 particularly wide values. For that you can say @samp{%4,6y}, which
15146 means that the field will never be more than 6 characters wide and never
15147 less than 4 characters wide.
15150 @node Mode Line Formatting
15151 @subsection Mode Line Formatting
15153 Mode line formatting variables (e.g.,
15154 @code{gnus-summary-mode-line-format}) follow the same rules as other,
15155 buffer line oriented formatting variables (@pxref{Formatting Basics})
15156 with the following two differences:
15161 There must be no newline (@samp{\n}) at the end.
15164 The special @samp{%%b} spec can be used to display the buffer name.
15165 Well, it's no spec at all, really---@samp{%%} is just a way to quote
15166 @samp{%} to allow it to pass through the formatting machinery unmangled,
15167 so that Emacs receives @samp{%b}, which is something the Emacs mode line
15168 display interprets to mean ``show the buffer name''. For a full list of
15169 mode line specs Emacs understands, see the documentation of the
15170 @code{mode-line-format} variable.
15175 @node Advanced Formatting
15176 @subsection Advanced Formatting
15178 It is frequently useful to post-process the fields in some way.
15179 Padding, limiting, cutting off parts and suppressing certain values can
15180 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
15181 look like @samp{%~(cut 3)~(ignore "0")y}.
15183 These are the valid modifiers:
15188 Pad the field to the left with spaces until it reaches the required
15192 Pad the field to the right with spaces until it reaches the required
15197 Cut off characters from the left until it reaches the specified length.
15200 Cut off characters from the right until it reaches the specified
15205 Cut off the specified number of characters from the left.
15208 Cut off the specified number of characters from the right.
15211 Return an empty string if the field is equal to the specified value.
15214 Use the specified form as the field value when the @samp{@@} spec is
15218 Let's take an example. The @samp{%o} spec in the summary mode lines
15219 will return a date in compact ISO8601 format---@samp{19960809T230410}.
15220 This is quite a mouthful, so we want to shave off the century number and
15221 the time, leaving us with a six-character date. That would be
15222 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
15223 maxing, and we need the padding to ensure that the date is never less
15224 than 6 characters to make it look nice in columns.)
15226 Ignoring is done first; then cutting; then maxing; and then as the very
15227 last operation, padding.
15229 If you use lots of these advanced thingies, you'll find that Gnus gets
15230 quite slow. This can be helped enormously by running @kbd{M-x
15231 gnus-compile} when you are satisfied with the look of your lines.
15232 @xref{Compilation}.
15235 @node User-Defined Specs
15236 @subsection User-Defined Specs
15238 All the specs allow for inserting user defined specifiers---@samp{u}.
15239 The next character in the format string should be a letter. Gnus
15240 will call the function @code{gnus-user-format-function-}@samp{X}, where
15241 @samp{X} is the letter following @samp{%u}. The function will be passed
15242 a single parameter---what the parameter means depends on what buffer
15243 it's being called from. The function should return a string, which will
15244 be inserted into the buffer just like information from any other
15245 specifier. This function may also be called with dummy values, so it
15246 should protect against that.
15248 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
15249 much the same without defining new functions. Here's an example:
15250 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
15251 given here will be evaluated to yield the current line number, and then
15255 @node Formatting Fonts
15256 @subsection Formatting Fonts
15258 There are specs for highlighting, and these are shared by all the format
15259 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
15260 the special @code{mouse-face} property set, which means that it will be
15261 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
15264 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
15265 normal faces set using @code{gnus-face-0}, which is @code{bold} by
15266 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
15267 and so on. Create as many faces as you wish. The same goes for the
15268 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
15269 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
15271 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
15272 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you say
15273 @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
15274 @code{gnus-balloon-face-*} variables should be either strings or
15275 symbols naming functions that return a string. Under @code{balloon-help-mode},
15276 when the mouse passes over text with this property set, a balloon window
15277 will appear and display the string. Please refer to the doc string of
15278 @code{balloon-help-mode} for more information on this.
15280 Here's an alternative recipe for the group buffer:
15283 ;; Create three face types.
15284 (setq gnus-face-1 'bold)
15285 (setq gnus-face-3 'italic)
15287 ;; We want the article count to be in
15288 ;; a bold and green face. So we create
15289 ;; a new face called `my-green-bold'.
15290 (copy-face 'bold 'my-green-bold)
15292 (set-face-foreground 'my-green-bold "ForestGreen")
15293 (setq gnus-face-2 'my-green-bold)
15295 ;; Set the new & fancy format.
15296 (setq gnus-group-line-format
15297 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
15300 I'm sure you'll be able to use this scheme to create totally unreadable
15301 and extremely vulgar displays. Have fun!
15303 Note that the @samp{%(} specs (and friends) do not make any sense on the
15304 mode-line variables.
15307 @node Windows Configuration
15308 @section Windows Configuration
15309 @cindex windows configuration
15311 No, there's nothing here about X, so be quiet.
15313 @vindex gnus-use-full-window
15314 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
15315 other windows and occupy the entire Emacs screen by itself. It is
15316 @code{t} by default.
15318 Setting this variable to @code{nil} kinda works, but there are
15319 glitches. Use at your own peril.
15321 @vindex gnus-buffer-configuration
15322 @code{gnus-buffer-configuration} describes how much space each Gnus
15323 buffer should be given. Here's an excerpt of this variable:
15326 ((group (vertical 1.0 (group 1.0 point)
15327 (if gnus-carpal (group-carpal 4))))
15328 (article (vertical 1.0 (summary 0.25 point)
15332 This is an alist. The @dfn{key} is a symbol that names some action or
15333 other. For instance, when displaying the group buffer, the window
15334 configuration function will use @code{group} as the key. A full list of
15335 possible names is listed below.
15337 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
15338 should occupy. To take the @code{article} split as an example -
15341 (article (vertical 1.0 (summary 0.25 point)
15345 This @dfn{split} says that the summary buffer should occupy 25% of upper
15346 half of the screen, and that it is placed over the article buffer. As
15347 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
15348 reaching for that calculator there). However, the special number
15349 @code{1.0} is used to signal that this buffer should soak up all the
15350 rest of the space available after the rest of the buffers have taken
15351 whatever they need. There should be only one buffer with the @code{1.0}
15352 size spec per split.
15354 Point will be put in the buffer that has the optional third element
15355 @code{point}. In a @code{frame} split, the last subsplit having a leaf
15356 split where the tag @code{frame-focus} is a member (i.e. is the third or
15357 fourth element in the list, depending on whether the @code{point} tag is
15358 present) gets focus.
15360 Here's a more complicated example:
15363 (article (vertical 1.0 (group 4)
15364 (summary 0.25 point)
15365 (if gnus-carpal (summary-carpal 4))
15369 If the size spec is an integer instead of a floating point number,
15370 then that number will be used to say how many lines a buffer should
15371 occupy, not a percentage.
15373 If the @dfn{split} looks like something that can be @code{eval}ed (to be
15374 precise---if the @code{car} of the split is a function or a subr), this
15375 split will be @code{eval}ed. If the result is non-@code{nil}, it will
15376 be used as a split. This means that there will be three buffers if
15377 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
15380 Not complicated enough for you? Well, try this on for size:
15383 (article (horizontal 1.0
15388 (summary 0.25 point)
15393 Whoops. Two buffers with the mystery 100% tag. And what's that
15394 @code{horizontal} thingie?
15396 If the first element in one of the split is @code{horizontal}, Gnus will
15397 split the window horizontally, giving you two windows side-by-side.
15398 Inside each of these strips you may carry on all you like in the normal
15399 fashion. The number following @code{horizontal} says what percentage of
15400 the screen is to be given to this strip.
15402 For each split, there @emph{must} be one element that has the 100% tag.
15403 The splitting is never accurate, and this buffer will eat any leftover
15404 lines from the splits.
15406 To be slightly more formal, here's a definition of what a valid split
15410 split = frame | horizontal | vertical | buffer | form
15411 frame = "(frame " size *split ")"
15412 horizontal = "(horizontal " size *split ")"
15413 vertical = "(vertical " size *split ")"
15414 buffer = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
15415 size = number | frame-params
15416 buffer-name = group | article | summary ...
15419 The limitations are that the @code{frame} split can only appear as the
15420 top-level split. @var{form} should be an Emacs Lisp form that should
15421 return a valid split. We see that each split is fully recursive, and
15422 may contain any number of @code{vertical} and @code{horizontal} splits.
15424 @vindex gnus-window-min-width
15425 @vindex gnus-window-min-height
15426 @cindex window height
15427 @cindex window width
15428 Finding the right sizes can be a bit complicated. No window may be less
15429 than @code{gnus-window-min-height} (default 1) characters high, and all
15430 windows must be at least @code{gnus-window-min-width} (default 1)
15431 characters wide. Gnus will try to enforce this before applying the
15432 splits. If you want to use the normal Emacs window width/height limit,
15433 you can just set these two variables to @code{nil}.
15435 If you're not familiar with Emacs terminology, @code{horizontal} and
15436 @code{vertical} splits may work the opposite way of what you'd expect.
15437 Windows inside a @code{horizontal} split are shown side-by-side, and
15438 windows within a @code{vertical} split are shown above each other.
15440 @findex gnus-configure-frame
15441 If you want to experiment with window placement, a good tip is to call
15442 @code{gnus-configure-frame} directly with a split. This is the function
15443 that does all the real work when splitting buffers. Below is a pretty
15444 nonsensical configuration with 5 windows; two for the group buffer and
15445 three for the article buffer. (I said it was nonsensical.) If you
15446 @code{eval} the statement below, you can get an idea of how that would
15447 look straight away, without going through the normal Gnus channels.
15448 Play with it until you're satisfied, and then use
15449 @code{gnus-add-configuration} to add your new creation to the buffer
15450 configuration list.
15453 (gnus-configure-frame
15457 (article 0.3 point))
15465 You might want to have several frames as well. No prob---just use the
15466 @code{frame} split:
15469 (gnus-configure-frame
15472 (summary 0.25 point frame-focus)
15474 (vertical ((height . 5) (width . 15)
15475 (user-position . t)
15476 (left . -1) (top . 1))
15481 This split will result in the familiar summary/article window
15482 configuration in the first (or ``main'') frame, while a small additional
15483 frame will be created where picons will be shown. As you can see,
15484 instead of the normal @code{1.0} top-level spec, each additional split
15485 should have a frame parameter alist as the size spec.
15486 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
15487 Reference Manual}. Under XEmacs, a frame property list will be
15488 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
15490 The list of all possible keys for @code{gnus-buffer-configuration} can
15491 be found in its default value.
15493 Note that the @code{message} key is used for both
15494 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
15495 it is desirable to distinguish between the two, something like this
15499 (message (horizontal 1.0
15500 (vertical 1.0 (message 1.0 point))
15502 (if (buffer-live-p gnus-summary-buffer)
15507 One common desire for a multiple frame split is to have a separate frame
15508 for composing mail and news while leaving the original frame intact. To
15509 accomplish that, something like the following can be done:
15512 (message (frame 1.0
15513 (if (not (buffer-live-p gnus-summary-buffer))
15514 (car (cdr (assoc 'group gnus-buffer-configuration)))
15515 (car (cdr (assoc 'summary gnus-buffer-configuration))))
15516 (vertical ((user-position . t) (top . 1) (left . 1)
15517 (name . "Message"))
15518 (message 1.0 point))))
15521 @findex gnus-add-configuration
15522 Since the @code{gnus-buffer-configuration} variable is so long and
15523 complicated, there's a function you can use to ease changing the config
15524 of a single setting: @code{gnus-add-configuration}. If, for instance,
15525 you want to change the @code{article} setting, you could say:
15528 (gnus-add-configuration
15529 '(article (vertical 1.0
15531 (summary .25 point)
15535 You'd typically stick these @code{gnus-add-configuration} calls in your
15536 @file{.gnus.el} file or in some startup hook---they should be run after
15537 Gnus has been loaded.
15539 @vindex gnus-always-force-window-configuration
15540 If all windows mentioned in the configuration are already visible, Gnus
15541 won't change the window configuration. If you always want to force the
15542 ``right'' window configuration, you can set
15543 @code{gnus-always-force-window-configuration} to non-@code{nil}.
15545 If you're using tree displays (@pxref{Tree Display}), and the tree
15546 window is displayed vertically next to another window, you may also want
15547 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
15551 @node Faces and Fonts
15552 @section Faces and Fonts
15557 Fiddling with fonts and faces used to be very difficult, but these days
15558 it is very simple. You simply say @kbd{M-x customize-face}, pick out
15559 the face you want to alter, and alter it via the standard Customize
15564 @section Compilation
15565 @cindex compilation
15566 @cindex byte-compilation
15568 @findex gnus-compile
15570 Remember all those line format specification variables?
15571 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
15572 on. Now, Gnus will of course heed whatever these variables are, but,
15573 unfortunately, changing them will mean a quite significant slow-down.
15574 (The default values of these variables have byte-compiled functions
15575 associated with them, while the user-generated versions do not, of
15578 To help with this, you can run @kbd{M-x gnus-compile} after you've
15579 fiddled around with the variables and feel that you're (kind of)
15580 satisfied. This will result in the new specs being byte-compiled, and
15581 you'll get top speed again. Gnus will save these compiled specs in the
15582 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
15583 this function, though---you should compile them yourself by sticking
15584 them into the @code{.gnus.el} file and byte-compiling that file.)
15588 @section Mode Lines
15591 @vindex gnus-updated-mode-lines
15592 @code{gnus-updated-mode-lines} says what buffers should keep their mode
15593 lines updated. It is a list of symbols. Supported symbols include
15594 @code{group}, @code{article}, @code{summary}, @code{server},
15595 @code{browse}, and @code{tree}. If the corresponding symbol is present,
15596 Gnus will keep that mode line updated with information that may be
15597 pertinent. If this variable is @code{nil}, screen refresh may be
15600 @cindex display-time
15602 @vindex gnus-mode-non-string-length
15603 By default, Gnus displays information on the current article in the mode
15604 lines of the summary and article buffers. The information Gnus wishes
15605 to display (e.g. the subject of the article) is often longer than the
15606 mode lines, and therefore have to be cut off at some point. The
15607 @code{gnus-mode-non-string-length} variable says how long the other
15608 elements on the line is (i.e., the non-info part). If you put
15609 additional elements on the mode line (e.g. a clock), you should modify
15612 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
15614 (add-hook 'display-time-hook
15615 (lambda () (setq gnus-mode-non-string-length
15617 (if line-number-mode 5 0)
15618 (if column-number-mode 4 0)
15619 (length display-time-string)))))
15622 If this variable is @code{nil} (which is the default), the mode line
15623 strings won't be chopped off, and they won't be padded either. Note
15624 that the default is unlikely to be desirable, as even the percentage
15625 complete in the buffer may be crowded off the mode line; the user should
15626 configure this variable appropriately for her configuration.
15629 @node Highlighting and Menus
15630 @section Highlighting and Menus
15632 @cindex highlighting
15635 @vindex gnus-visual
15636 The @code{gnus-visual} variable controls most of the Gnus-prettifying
15637 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
15638 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
15641 This variable can be a list of visual properties that are enabled. The
15642 following elements are valid, and are all included by default:
15645 @item group-highlight
15646 Do highlights in the group buffer.
15647 @item summary-highlight
15648 Do highlights in the summary buffer.
15649 @item article-highlight
15650 Do highlights in the article buffer.
15652 Turn on highlighting in all buffers.
15654 Create menus in the group buffer.
15656 Create menus in the summary buffers.
15658 Create menus in the article buffer.
15660 Create menus in the browse buffer.
15662 Create menus in the server buffer.
15664 Create menus in the score buffers.
15666 Create menus in all buffers.
15669 So if you only want highlighting in the article buffer and menus in all
15670 buffers, you could say something like:
15673 (setq gnus-visual '(article-highlight menu))
15676 If you want highlighting only and no menus whatsoever, you'd say:
15679 (setq gnus-visual '(highlight))
15682 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
15683 in all Gnus buffers.
15685 Other general variables that influence the look of all buffers include:
15688 @item gnus-mouse-face
15689 @vindex gnus-mouse-face
15690 This is the face (i.e., font) used for mouse highlighting in Gnus. No
15691 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
15695 There are hooks associated with the creation of all the different menus:
15699 @item gnus-article-menu-hook
15700 @vindex gnus-article-menu-hook
15701 Hook called after creating the article mode menu.
15703 @item gnus-group-menu-hook
15704 @vindex gnus-group-menu-hook
15705 Hook called after creating the group mode menu.
15707 @item gnus-summary-menu-hook
15708 @vindex gnus-summary-menu-hook
15709 Hook called after creating the summary mode menu.
15711 @item gnus-server-menu-hook
15712 @vindex gnus-server-menu-hook
15713 Hook called after creating the server mode menu.
15715 @item gnus-browse-menu-hook
15716 @vindex gnus-browse-menu-hook
15717 Hook called after creating the browse mode menu.
15719 @item gnus-score-menu-hook
15720 @vindex gnus-score-menu-hook
15721 Hook called after creating the score mode menu.
15732 Those new-fangled @dfn{mouse} contraptions is very popular with the
15733 young, hep kids who don't want to learn the proper way to do things
15734 these days. Why, I remember way back in the summer of '89, when I was
15735 using Emacs on a Tops 20 system. Three hundred users on one single
15736 machine, and every user was running Simula compilers. Bah!
15740 @vindex gnus-carpal
15741 Well, you can make Gnus display bufferfuls of buttons you can click to
15742 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
15743 really. Tell the chiropractor I sent you.
15748 @item gnus-carpal-mode-hook
15749 @vindex gnus-carpal-mode-hook
15750 Hook run in all carpal mode buffers.
15752 @item gnus-carpal-button-face
15753 @vindex gnus-carpal-button-face
15754 Face used on buttons.
15756 @item gnus-carpal-header-face
15757 @vindex gnus-carpal-header-face
15758 Face used on carpal buffer headers.
15760 @item gnus-carpal-group-buffer-buttons
15761 @vindex gnus-carpal-group-buffer-buttons
15762 Buttons in the group buffer.
15764 @item gnus-carpal-summary-buffer-buttons
15765 @vindex gnus-carpal-summary-buffer-buttons
15766 Buttons in the summary buffer.
15768 @item gnus-carpal-server-buffer-buttons
15769 @vindex gnus-carpal-server-buffer-buttons
15770 Buttons in the server buffer.
15772 @item gnus-carpal-browse-buffer-buttons
15773 @vindex gnus-carpal-browse-buffer-buttons
15774 Buttons in the browse buffer.
15777 All the @code{buttons} variables are lists. The elements in these list
15778 are either cons cells where the @code{car} contains a text to be displayed and
15779 the @code{cdr} contains a function symbol, or a simple string.
15787 Gnus, being larger than any program ever written (allegedly), does lots
15788 of strange stuff that you may wish to have done while you're not
15789 present. For instance, you may want it to check for new mail once in a
15790 while. Or you may want it to close down all connections to all servers
15791 when you leave Emacs idle. And stuff like that.
15793 Gnus will let you do stuff like that by defining various
15794 @dfn{handlers}. Each handler consists of three elements: A
15795 @var{function}, a @var{time}, and an @var{idle} parameter.
15797 Here's an example of a handler that closes connections when Emacs has
15798 been idle for thirty minutes:
15801 (gnus-demon-close-connections nil 30)
15804 Here's a handler that scans for PGP headers every hour when Emacs is
15808 (gnus-demon-scan-pgp 60 t)
15811 This @var{time} parameter and than @var{idle} parameter work together
15812 in a strange, but wonderful fashion. Basically, if @var{idle} is
15813 @code{nil}, then the function will be called every @var{time} minutes.
15815 If @var{idle} is @code{t}, then the function will be called after
15816 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
15817 the function will never be called. But once Emacs goes idle, the
15818 function will be called every @var{time} minutes.
15820 If @var{idle} is a number and @var{time} is a number, the function will
15821 be called every @var{time} minutes only when Emacs has been idle for
15822 @var{idle} minutes.
15824 If @var{idle} is a number and @var{time} is @code{nil}, the function
15825 will be called once every time Emacs has been idle for @var{idle}
15828 And if @var{time} is a string, it should look like @samp{07:31}, and
15829 the function will then be called once every day somewhere near that
15830 time. Modified by the @var{idle} parameter, of course.
15832 @vindex gnus-demon-timestep
15833 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
15834 seconds. This is 60 by default. If you change that variable,
15835 all the timings in the handlers will be affected.)
15837 So, if you want to add a handler, you could put something like this in
15838 your @file{.gnus} file:
15840 @findex gnus-demon-add-handler
15842 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
15845 @findex gnus-demon-add-nocem
15846 @findex gnus-demon-add-scanmail
15847 @findex gnus-demon-add-rescan
15848 @findex gnus-demon-add-scan-timestamps
15849 @findex gnus-demon-add-disconnection
15850 Some ready-made functions to do this have been created:
15851 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
15852 @code{gnus-demon-add-nntp-close-connection},
15853 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
15854 @code{gnus-demon-add-scanmail}. Just put those functions in your
15855 @file{.gnus} if you want those abilities.
15857 @findex gnus-demon-init
15858 @findex gnus-demon-cancel
15859 @vindex gnus-demon-handlers
15860 If you add handlers to @code{gnus-demon-handlers} directly, you should
15861 run @code{gnus-demon-init} to make the changes take hold. To cancel all
15862 daemons, you can use the @code{gnus-demon-cancel} function.
15864 Note that adding daemons can be pretty naughty if you over do it. Adding
15865 functions that scan all news and mail from all servers every two seconds
15866 is a sure-fire way of getting booted off any respectable system. So
15875 @dfn{Spamming} is posting the same article lots and lots of times.
15876 Spamming is bad. Spamming is evil.
15878 Spamming is usually canceled within a day or so by various anti-spamming
15879 agencies. These agencies usually also send out @dfn{NoCeM} messages.
15880 NoCeM is pronounced ``no see-'em'', and means what the name
15881 implies---these are messages that make the offending articles, like, go
15884 What use are these NoCeM messages if the articles are canceled anyway?
15885 Some sites do not honor cancel messages and some sites just honor cancels
15886 from a select few people. Then you may wish to make use of the NoCeM
15887 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
15889 Gnus can read and parse the messages in this group automatically, and
15890 this will make spam disappear.
15892 There are some variables to customize, of course:
15895 @item gnus-use-nocem
15896 @vindex gnus-use-nocem
15897 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
15900 @item gnus-nocem-groups
15901 @vindex gnus-nocem-groups
15902 Gnus will look for NoCeM messages in the groups in this list. The
15903 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
15904 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
15906 @item gnus-nocem-issuers
15907 @vindex gnus-nocem-issuers
15908 There are many people issuing NoCeM messages. This list says what
15909 people you want to listen to. The default is @code{("Automoose-1"
15910 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
15911 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
15912 (Richard E. Depew)")}; fine, upstanding citizens all of them.
15914 Known despammers that you can put in this list include:
15917 @item clewis@@ferret.ocunix.on.ca;
15918 @cindex Chris Lewis
15919 Chris Lewis---Major Canadian despammer who has probably canceled more
15920 usenet abuse than anybody else.
15923 @cindex CancelMoose[tm]
15924 The CancelMoose[tm] on autopilot. The CancelMoose[tm] is reputed to be
15925 Norwegian, and was the person(s) who invented NoCeM.
15927 @item jem@@xpat.com;
15929 John Milburn---despammer located in Korea who is getting very busy these
15932 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
15933 Richard E. Depew---lone American despammer. He mostly cancels binary
15934 postings to non-binary groups and removes spews (regurgitated articles).
15937 You do not have to heed NoCeM messages from all these people---just the
15938 ones you want to listen to. You also don't have to accept all NoCeM
15939 messages from the people you like. Each NoCeM message has a @dfn{type}
15940 header that gives the message a (more or less, usually less) rigorous
15941 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
15942 @samp{binary}, and @samp{troll}. To specify this, you have to use
15943 @var{(issuer conditions ...)} elements in the list. Each condition is
15944 either a string (which is a regexp that matches types you want to use)
15945 or a list on the form @code{(not STRING)}, where @var{string} is a
15946 regexp that matches types you don't want to use.
15948 For instance, if you want all NoCeM messages from Chris Lewis except his
15949 @samp{troll} messages, you'd say:
15952 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
15955 On the other hand, if you just want nothing but his @samp{spam} and
15956 @samp{spew} messages, you'd say:
15959 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
15962 The specs are applied left-to-right.
15965 @item gnus-nocem-verifyer
15966 @vindex gnus-nocem-verifyer
15968 This should be a function for verifying that the NoCeM issuer is who she
15969 says she is. The default is @code{mc-verify}, which is a Mailcrypt
15970 function. If this is too slow and you don't care for verification
15971 (which may be dangerous), you can set this variable to @code{nil}.
15973 If you want signed NoCeM messages to be verified and unsigned messages
15974 not to be verified (but used anyway), you could do something like:
15977 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
15979 (defun my-gnus-mc-verify ()
15987 This might be dangerous, though.
15989 @item gnus-nocem-directory
15990 @vindex gnus-nocem-directory
15991 This is where Gnus will store its NoCeM cache files. The default is
15992 @file{~/News/NoCeM/}.
15994 @item gnus-nocem-expiry-wait
15995 @vindex gnus-nocem-expiry-wait
15996 The number of days before removing old NoCeM entries from the cache.
15997 The default is 15. If you make it shorter Gnus will be faster, but you
15998 might then see old spam.
16002 Using NoCeM could potentially be a memory hog. If you have many living
16003 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
16004 big. If this is a problem, you should kill off all (or most) of your
16005 unsubscribed groups (@pxref{Subscription Commands}).
16012 It is very useful to be able to undo actions one has done. In normal
16013 Emacs buffers, it's easy enough---you just push the @code{undo} button.
16014 In Gnus buffers, however, it isn't that simple.
16016 The things Gnus displays in its buffer is of no value whatsoever to
16017 Gnus---it's all just data designed to look nice to the user.
16018 Killing a group in the group buffer with @kbd{C-k} makes the line
16019 disappear, but that's just a side-effect of the real action---the
16020 removal of the group in question from the internal Gnus structures.
16021 Undoing something like that can't be done by the normal Emacs
16022 @code{undo} function.
16024 Gnus tries to remedy this somewhat by keeping track of what the user
16025 does and coming up with actions that would reverse the actions the user
16026 takes. When the user then presses the @code{undo} key, Gnus will run
16027 the code to reverse the previous action, or the previous actions.
16028 However, not all actions are easily reversible, so Gnus currently offers
16029 a few key functions to be undoable. These include killing groups,
16030 yanking groups, and changing the list of read articles of groups.
16031 That's it, really. More functions may be added in the future, but each
16032 added function means an increase in data to be stored, so Gnus will
16033 never be totally undoable.
16035 @findex gnus-undo-mode
16036 @vindex gnus-use-undo
16038 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
16039 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
16040 default. The @kbd{M-C-_} key performs the @code{gnus-undo} command
16041 command, which should feel kinda like the normal Emacs @code{undo}
16046 @section Moderation
16049 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
16050 It is not included in the standard Gnus package. Write a mail to
16051 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
16054 The moderation package is implemented as a minor mode for summary
16058 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
16061 in your @file{.gnus.el} file.
16063 If you are the moderator of @samp{rec.zoofle}, this is how it's
16068 You split your incoming mail by matching on
16069 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
16070 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
16073 You enter that group once in a while and post articles using the @kbd{e}
16074 (edit-and-post) or @kbd{s} (just send unedited) commands.
16077 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
16078 articles that weren't approved by you, you can cancel them with the
16082 To use moderation mode in these two groups, say:
16085 (setq gnus-moderated-list
16086 "^nnml:rec.zoofle$\\|^rec.zoofle$")
16090 @node XEmacs Enhancements
16091 @section XEmacs Enhancements
16094 XEmacs is able to display pictures and stuff, so Gnus has taken
16098 * Picons:: How to display pictures of what your reading.
16099 * Smileys:: Show all those happy faces the way they were meant to be shown.
16100 * Toolbar:: Click'n'drool.
16101 * XVarious:: Other XEmacsy Gnusey variables.
16114 So... You want to slow down your news reader even more! This is a
16115 good way to do so. Its also a great way to impress people staring
16116 over your shoulder as you read news.
16119 * Picon Basics:: What are picons and How do I get them.
16120 * Picon Requirements:: Don't go further if you aren't using XEmacs.
16121 * Easy Picons:: Displaying Picons---the easy way.
16122 * Hard Picons:: The way you should do it. You'll learn something.
16123 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
16128 @subsubsection Picon Basics
16130 What are Picons? To quote directly from the Picons Web site:
16139 @dfn{Picons} is short for ``personal icons''. They're small,
16140 constrained images used to represent users and domains on the net,
16141 organized into databases so that the appropriate image for a given
16142 e-mail address can be found. Besides users and domains, there are picon
16143 databases for Usenet newsgroups and weather forecasts. The picons are
16144 in either monochrome @code{XBM} format or color @code{XPM} and
16145 @code{GIF} formats.
16148 @vindex gnus-picons-piconsearch-url
16149 If you have a permanent connection to the Internet you can use Steve
16150 Kinzler's Picons Search engine by setting
16151 @code{gnus-picons-piconsearch-url} to the string @*
16152 @file{http://www.cs.indiana.edu/picons/search.html}.
16154 @vindex gnus-picons-database
16155 Otherwise you need a local copy of his database. For instructions on
16156 obtaining and installing the picons databases, point your Web browser at @*
16157 @file{http://www.cs.indiana.edu/picons/ftp/index.html}. Gnus expects
16158 picons to be installed into a location pointed to by
16159 @code{gnus-picons-database}.
16162 @node Picon Requirements
16163 @subsubsection Picon Requirements
16165 To have Gnus display Picons for you, you must be running XEmacs
16166 19.13 or greater since all other versions of Emacs aren't yet able to
16169 Additionally, you must have @code{x} support compiled into XEmacs. To
16170 display color picons which are much nicer than the black & white one,
16171 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
16173 @vindex gnus-picons-convert-x-face
16174 If you want to display faces from @code{X-Face} headers, you should have
16175 the @code{xface} support compiled into XEmacs. Otherwise you must have
16176 the @code{netpbm} utilities installed, or munge the
16177 @code{gnus-picons-convert-x-face} variable to use something else.
16181 @subsubsection Easy Picons
16183 To enable displaying picons, simply put the following line in your
16184 @file{~/.gnus} file and start Gnus.
16187 (setq gnus-use-picons t)
16188 (setq gnus-treat-display-picons t)
16191 and make sure @code{gnus-picons-database} points to the directory
16192 containing the Picons databases.
16194 Alternatively if you want to use the web piconsearch engine add this:
16197 (setq gnus-picons-piconsearch-url
16198 "http://www.cs.indiana.edu:800/piconsearch")
16203 @subsubsection Hard Picons
16211 Gnus can display picons for you as you enter and leave groups and
16212 articles. It knows how to interact with three sections of the picons
16213 database. Namely, it can display the picons newsgroup pictures,
16214 author's face picture(s), and the authors domain. To enable this
16215 feature, you need to select where to get the picons from, and where to
16220 @item gnus-picons-database
16221 @vindex gnus-picons-database
16222 The location of the picons database. Should point to a directory
16223 containing the @file{news}, @file{domains}, @file{users} (and so on)
16224 subdirectories. This is only useful if
16225 @code{gnus-picons-piconsearch-url} is @code{nil}. Defaults to
16226 @file{/usr/local/faces/}.
16228 @item gnus-picons-piconsearch-url
16229 @vindex gnus-picons-piconsearch-url
16230 The URL for the web picons search engine. The only currently known
16231 engine is @file{http://www.cs.indiana.edu:800/piconsearch}. To
16232 workaround network delays, icons will be fetched in the background. If
16233 this is @code{nil} 'the default), then picons are fetched from local
16234 database indicated by @code{gnus-picons-database}.
16236 @item gnus-picons-display-where
16237 @vindex gnus-picons-display-where
16238 Where the picon images should be displayed. It is @code{picons} by
16239 default (which by default maps to the buffer @samp{*Picons*}). Other
16240 valid places could be @code{article}, @code{summary}, or
16241 @samp{*scratch*} for all I care. Just make sure that you've made the
16242 buffer visible using the standard Gnus window configuration
16243 routines---@pxref{Windows Configuration}.
16245 @item gnus-picons-group-excluded-groups
16246 @vindex gnus-picons-group-excluded-groups
16247 Groups that are matched by this regexp won't have their group icons
16252 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
16253 window configuration for you to include the @code{picons} buffer.
16255 Now that you've made those decision, you need to add the following
16256 functions to the appropriate hooks so these pictures will get displayed
16259 @vindex gnus-picons-display-where
16261 @item gnus-article-display-picons
16262 @findex gnus-article-display-picons
16263 Looks up and displays the picons for the author and the author's domain
16264 in the @code{gnus-picons-display-where} buffer.
16266 @item gnus-picons-article-display-x-face
16267 @findex gnus-article-display-picons
16268 Decodes and displays the X-Face header if present.
16274 @node Picon Useless Configuration
16275 @subsubsection Picon Useless Configuration
16283 The following variables offer further control over how things are
16284 done, where things are located, and other useless stuff you really
16285 don't need to worry about.
16289 @item gnus-picons-news-directories
16290 @vindex gnus-picons-news-directories
16291 List of subdirectories to search in @code{gnus-picons-database} for
16292 newsgroups faces. @code{("news")} is the default.
16294 @item gnus-picons-user-directories
16295 @vindex gnus-picons-user-directories
16296 List of subdirectories to search in @code{gnus-picons-database} for user
16297 faces. @code{("local" "users" "usenix" "misc")} is the default.
16299 @item gnus-picons-domain-directories
16300 @vindex gnus-picons-domain-directories
16301 List of subdirectories to search in @code{gnus-picons-database} for
16302 domain name faces. Defaults to @code{("domains")}. Some people may
16303 want to add @samp{"unknown"} to this list.
16305 @item gnus-picons-convert-x-face
16306 @vindex gnus-picons-convert-x-face
16307 If you don't have @code{xface} support builtin XEmacs, this is the
16308 command to use to convert the @code{X-Face} header to an X bitmap
16309 (@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48,
16310 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
16311 gnus-picons-x-face-file-name)}
16313 @item gnus-picons-x-face-file-name
16314 @vindex gnus-picons-x-face-file-name
16315 Names a temporary file to store the @code{X-Face} bitmap in. Defaults
16316 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
16318 @item gnus-picons-has-modeline-p
16319 @vindex gnus-picons-has-modeline-p
16320 If you have set @code{gnus-picons-display-where} to @code{picons}, your
16321 XEmacs frame will become really cluttered. To alleviate this a bit you
16322 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
16323 remove the mode line from the Picons buffer. This is only useful if
16324 @code{gnus-picons-display-where} is @code{picons}.
16326 @item gnus-picons-refresh-before-display
16327 @vindex gnus-picons-refresh-before-display
16328 If non-nil, display the article buffer before computing the picons.
16329 Defaults to @code{nil}.
16331 @item gnus-picons-display-as-address
16332 @vindex gnus-picons-display-as-address
16333 If @code{t} display textual email addresses along with pictures.
16334 Defaults to @code{t}.
16336 @item gnus-picons-file-suffixes
16337 @vindex gnus-picons-file-suffixes
16338 Ordered list of suffixes on picon file names to try. Defaults to
16339 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
16341 @item gnus-picons-setup-hook
16342 @vindex gnus-picons-setup-hook
16343 Hook run in the picon buffer, if that is displayed.
16345 @item gnus-picons-display-article-move-p
16346 @vindex gnus-picons-display-article-move-p
16347 Whether to move point to first empty line when displaying picons. This
16348 has only an effect if `gnus-picons-display-where' has value `article'.
16350 If @code{nil}, display the picons in the @code{From} and
16351 @code{Newsgroups} lines. This is the defailt.
16353 @item gnus-picons-clear-cache-on-shutdown
16354 @vindex gnus-picons-clear-cache-on-shutdown
16355 Whether to clear the picons cache when exiting gnus. Gnus caches every
16356 picons it finds while it is running. This saves some time in the search
16357 process but eats some memory. If this variable is set to @code{nil},
16358 Gnus will never clear the cache itself; you will have to manually call
16359 @code{gnus-picons-clear-cache} to clear it. Otherwise the cache will be
16360 cleared every time you exit Gnus. Defaults to @code{t}.
16371 @subsection Smileys
16376 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
16381 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
16382 currently the only package that uses Smiley, it is documented here.
16384 In short---to use Smiley in Gnus, put the following in your
16385 @file{.gnus.el} file:
16388 (setq gnus-treat-display-smiley t)
16391 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
16392 the like---to pictures and displays those instead of the text smiley
16393 faces. The conversion is controlled by a list of regexps that matches
16394 text and maps that to file names.
16396 @vindex smiley-nosey-regexp-alist
16397 @vindex smiley-deformed-regexp-alist
16398 Smiley supplies two example conversion alists by default:
16399 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
16400 and so on), and @code{smiley-nosey-regexp-alist} (which matches
16401 @samp{:-)}, @samp{:-(} and so on).
16403 The alist used is specified by the @code{smiley-regexp-alist} variable,
16404 which defaults to the value of @code{smiley-deformed-regexp-alist}.
16406 The first item in each element is the regexp to be matched; the second
16407 element is the regexp match group that is to be replaced by the picture;
16408 and the third element is the name of the file to be displayed.
16410 The following variables customize where Smiley will look for these
16411 files, as well as the color to be used and stuff:
16415 @item smiley-data-directory
16416 @vindex smiley-data-directory
16417 Where Smiley will look for smiley faces files.
16419 @item smiley-flesh-color
16420 @vindex smiley-flesh-color
16421 Skin color. The default is @samp{yellow}, which is really racist.
16423 @item smiley-features-color
16424 @vindex smiley-features-color
16425 Color of the features of the face. The default is @samp{black}.
16427 @item smiley-tongue-color
16428 @vindex smiley-tongue-color
16429 Color of the tongue. The default is @samp{red}.
16431 @item smiley-circle-color
16432 @vindex smiley-circle-color
16433 Color of the circle around the face. The default is @samp{black}.
16435 @item smiley-mouse-face
16436 @vindex smiley-mouse-face
16437 Face used for mouse highlighting over the smiley face.
16443 @subsection Toolbar
16453 @item gnus-use-toolbar
16454 @vindex gnus-use-toolbar
16455 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
16456 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
16457 @code{right-toolbar}, or @code{left-toolbar}.
16459 @item gnus-group-toolbar
16460 @vindex gnus-group-toolbar
16461 The toolbar in the group buffer.
16463 @item gnus-summary-toolbar
16464 @vindex gnus-summary-toolbar
16465 The toolbar in the summary buffer.
16467 @item gnus-summary-mail-toolbar
16468 @vindex gnus-summary-mail-toolbar
16469 The toolbar in the summary buffer of mail groups.
16475 @subsection Various XEmacs Variables
16478 @item gnus-xmas-glyph-directory
16479 @vindex gnus-xmas-glyph-directory
16480 This is where Gnus will look for pictures. Gnus will normally
16481 auto-detect this directory, but you may set it manually if you have an
16482 unusual directory structure.
16484 @item gnus-xmas-logo-color-alist
16485 @vindex gnus-xmas-logo-color-alist
16486 This is an alist where the key is a type symbol and the values are the
16487 foreground and background color of the splash page glyph.
16489 @item gnus-xmas-logo-color-style
16490 @vindex gnus-xmas-logo-color-style
16491 This is the key used to look up the color in the alist described above.
16492 Valid values include @code{flame}, @code{pine}, @code{moss},
16493 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
16494 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
16496 @item gnus-xmas-modeline-glyph
16497 @vindex gnus-xmas-modeline-glyph
16498 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
16512 @node Fuzzy Matching
16513 @section Fuzzy Matching
16514 @cindex fuzzy matching
16516 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
16517 things like scoring, thread gathering and thread comparison.
16519 As opposed to regular expression matching, fuzzy matching is very fuzzy.
16520 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
16521 means, and the implementation has changed over time.
16523 Basically, it tries to remove all noise from lines before comparing.
16524 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
16525 out of the strings before comparing the results. This often leads to
16526 adequate results---even when faced with strings generated by text
16527 manglers masquerading as newsreaders.
16530 @node Thwarting Email Spam
16531 @section Thwarting Email Spam
16535 @cindex unsolicited commercial email
16537 In these last days of the Usenet, commercial vultures are hanging about
16538 and grepping through news like crazy to find email addresses they can
16539 foist off their scams and products to. As a reaction to this, many
16540 people have started putting nonsense addresses into their @code{From}
16541 lines. I think this is counterproductive---it makes it difficult for
16542 people to send you legitimate mail in response to things you write, as
16543 well as making it difficult to see who wrote what. This rewriting may
16544 perhaps be a bigger menace than the unsolicited commercial email itself
16547 The biggest problem I have with email spam is that it comes in under
16548 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
16549 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
16550 mail group, only to find two pyramid schemes, seven advertisements
16551 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
16552 and one mail asking me to repent and find some god.
16556 The way to deal with this is having Gnus split out all spam into a
16557 @samp{spam} mail group (@pxref{Splitting Mail}).
16559 First, pick one (1) valid mail address that you can be reached at, and
16560 put it in your @code{From} header of all your news articles. (I've
16561 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
16562 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
16563 sysadm whether your sendmail installation accepts keywords in the local
16564 part of the mail address.)
16567 (setq message-default-news-headers
16568 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
16571 Then put the following split rule in @code{nnmail-split-fancy}
16572 (@pxref{Fancy Mail Splitting}):
16577 (to "larsi@@trym.ifi.uio.no"
16578 (| ("subject" "re:.*" "misc")
16579 ("references" ".*@@.*" "misc")
16585 This says that all mail to this address is suspect, but if it has a
16586 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
16587 header, it's probably ok. All the rest goes to the @samp{spam} group.
16588 (This idea probably comes from Tim Pierce.)
16590 In addition, many mail spammers talk directly to your @code{smtp} server
16591 and do not include your email address explicitly in the @code{To}
16592 header. Why they do this is unknown---perhaps it's to thwart this
16593 thwarting scheme? In any case, this is trivial to deal with---you just
16594 put anything not addressed to you in the @samp{spam} group by ending
16595 your fancy split rule in this way:
16600 (to "larsi" "misc")
16604 In my experience, this will sort virtually everything into the right
16605 group. You still have to check the @samp{spam} group from time to time to
16606 check for legitimate mail, though. If you feel like being a good net
16607 citizen, you can even send off complaints to the proper authorities on
16608 each unsolicited commercial email---at your leisure.
16610 If you are also a lazy net citizen, you will probably prefer complaining
16611 automatically with the @file{gnus-junk.el} package, available FOR FREE
16612 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
16613 Since most e-mail spam is sent automatically, this may reconcile the
16614 cosmic balance somewhat.
16616 This works for me. It allows people an easy way to contact me (they can
16617 just press @kbd{r} in the usual way), and I'm not bothered at all with
16618 spam. It's a win-win situation. Forging @code{From} headers to point
16619 to non-existent domains is yucky, in my opinion.
16622 @node Various Various
16623 @section Various Various
16629 @item gnus-home-directory
16630 All Gnus path variables will be initialized from this variable, which
16631 defaults to @file{~/}.
16633 @item gnus-directory
16634 @vindex gnus-directory
16635 Most Gnus storage path variables will be initialized from this variable,
16636 which defaults to the @samp{SAVEDIR} environment variable, or
16637 @file{~/News/} if that variable isn't set.
16639 Note that gnus is mostly loaded when the @file{.gnus.el} file is read.
16640 This means that other directory variables that are initialized from this
16641 variable won't be set properly if you set this variable in
16642 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
16644 @item gnus-default-directory
16645 @vindex gnus-default-directory
16646 Not related to the above variable at all---this variable says what the
16647 default directory of all Gnus buffers should be. If you issue commands
16648 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
16649 default directory. If this variable is @code{nil} (which is the
16650 default), the default directory will be the default directory of the
16651 buffer you were in when you started Gnus.
16654 @vindex gnus-verbose
16655 This variable is an integer between zero and ten. The higher the value,
16656 the more messages will be displayed. If this variable is zero, Gnus
16657 will never flash any messages, if it is seven (which is the default),
16658 most important messages will be shown, and if it is ten, Gnus won't ever
16659 shut up, but will flash so many messages it will make your head swim.
16661 @item gnus-verbose-backends
16662 @vindex gnus-verbose-backends
16663 This variable works the same way as @code{gnus-verbose}, but it applies
16664 to the Gnus backends instead of Gnus proper.
16666 @item nnheader-max-head-length
16667 @vindex nnheader-max-head-length
16668 When the backends read straight heads of articles, they all try to read
16669 as little as possible. This variable (default 4096) specifies
16670 the absolute max length the backends will try to read before giving up
16671 on finding a separator line between the head and the body. If this
16672 variable is @code{nil}, there is no upper read bound. If it is
16673 @code{t}, the backends won't try to read the articles piece by piece,
16674 but read the entire articles. This makes sense with some versions of
16675 @code{ange-ftp} or @code{efs}.
16677 @item nnheader-head-chop-length
16678 @vindex nnheader-head-chop-length
16679 This variable (default 2048) says how big a piece of each article to
16680 read when doing the operation described above.
16682 @item nnheader-file-name-translation-alist
16683 @vindex nnheader-file-name-translation-alist
16685 @cindex invalid characters in file names
16686 @cindex characters in file names
16687 This is an alist that says how to translate characters in file names.
16688 For instance, if @samp{:} is invalid as a file character in file names
16689 on your system (you OS/2 user you), you could say something like:
16692 (setq nnheader-file-name-translation-alist
16696 In fact, this is the default value for this variable on OS/2 and MS
16697 Windows (phooey) systems.
16699 @item gnus-hidden-properties
16700 @vindex gnus-hidden-properties
16701 This is a list of properties to use to hide ``invisible'' text. It is
16702 @code{(invisible t intangible t)} by default on most systems, which
16703 makes invisible text invisible and intangible.
16705 @item gnus-parse-headers-hook
16706 @vindex gnus-parse-headers-hook
16707 A hook called before parsing headers. It can be used, for instance, to
16708 gather statistics on the headers fetched, or perhaps you'd like to prune
16709 some headers. I don't see why you'd want that, though.
16711 @item gnus-shell-command-separator
16712 @vindex gnus-shell-command-separator
16713 String used to separate two shell commands. The default is @samp{;}.
16722 Well, that's the manual---you can get on with your life now. Keep in
16723 touch. Say hello to your cats from me.
16725 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
16727 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
16733 Not because of victories @*
16736 but for the common sunshine,@*
16738 the largess of the spring.
16742 but for the day's work done@*
16743 as well as I was able;@*
16744 not for a seat upon the dais@*
16745 but at the common table.@*
16750 @chapter Appendices
16753 * History:: How Gnus got where it is today.
16754 * Terminology:: We use really difficult, like, words here.
16755 * Customization:: Tailoring Gnus to your needs.
16756 * Troubleshooting:: What you might try if things do not work.
16757 * Gnus Reference Guide:: Rilly, rilly technical stuff.
16758 * Emacs for Heathens:: A short introduction to Emacsian terms.
16759 * Frequently Asked Questions:: A question-and-answer session.
16767 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
16768 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
16770 If you want to investigate the person responsible for this outrage, you
16771 can point your (feh!) web browser to
16772 @file{http://www.stud.ifi.uio.no/~larsi/}. This is also the primary
16773 distribution point for the new and spiffy versions of Gnus, and is known
16774 as The Site That Destroys Newsrcs And Drives People Mad.
16776 During the first extended alpha period of development, the new Gnus was
16777 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
16778 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
16779 (Besides, the ``Gnus'' in this abbreviation should probably be
16780 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
16781 appropriate name, don't you think?)
16783 In any case, after spending all that energy on coming up with a new and
16784 spunky name, we decided that the name was @emph{too} spunky, so we
16785 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
16786 ``@sc{gnus}''. New vs. old.
16788 The first ``proper'' release of Gnus 5 was done in November 1995 when it
16789 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
16790 plus 15 Gnus 5.0 releases).
16792 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
16793 releases)) was released under the name ``Gnus 5.2'' (40 releases).
16795 On July 28th 1996 work on Red Gnus was begun, and it was released on
16796 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
16798 On September 13th 1997, Quassia Gnus was started and lasted 37
16799 releases. If was released as ``Gnus 5.6 on March 8th 1998.
16801 If you happen upon a version of Gnus that has a prefixed name --
16802 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
16803 don't panic. Don't let it know that you're frightened. Back away.
16804 Slowly. Whatever you do, don't run. Walk away, calmly, until you're
16805 out of its reach. Find a proper released version of Gnus and snuggle up
16809 * Why?:: What's the point of Gnus?
16810 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
16811 * Conformity:: Gnus tries to conform to all standards.
16812 * Emacsen:: Gnus can be run on a few modern Emacsen.
16813 * Gnus Development:: How Gnus is developed.
16814 * Contributors:: Oodles of people.
16815 * New Features:: Pointers to some of the new stuff in Gnus.
16816 * Newest Features:: Features so new that they haven't been written yet.
16823 What's the point of Gnus?
16825 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
16826 newsreader, that lets you do anything you can think of. That was my
16827 original motivation, but while working on Gnus, it has become clear to
16828 me that this generation of newsreaders really belong in the stone age.
16829 Newsreaders haven't developed much since the infancy of the net. If the
16830 volume continues to rise with the current rate of increase, all current
16831 newsreaders will be pretty much useless. How do you deal with
16832 newsgroups that have thousands of new articles each day? How do you
16833 keep track of millions of people who post?
16835 Gnus offers no real solutions to these questions, but I would very much
16836 like to see Gnus being used as a testing ground for new methods of
16837 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
16838 to separate the newsreader from the backends, Gnus now offers a simple
16839 interface for anybody who wants to write new backends for fetching mail
16840 and news from different sources. I have added hooks for customizations
16841 everywhere I could imagine it being useful. By doing so, I'm inviting
16842 every one of you to explore and invent.
16844 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
16845 @kbd{C-u 100 M-x all-hail-xemacs}.
16848 @node Compatibility
16849 @subsection Compatibility
16851 @cindex compatibility
16852 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
16853 bindings have been kept. More key bindings have been added, of course,
16854 but only in one or two obscure cases have old bindings been changed.
16859 @center In a cloud bones of steel.
16863 All commands have kept their names. Some internal functions have changed
16866 The @code{gnus-uu} package has changed drastically. @xref{Decoding
16869 One major compatibility question is the presence of several summary
16870 buffers. All variables relevant while reading a group are
16871 buffer-local to the summary buffer they belong in. Although many
16872 important variables have their values copied into their global
16873 counterparts whenever a command is executed in the summary buffer, this
16874 change might lead to incorrect values being used unless you are careful.
16876 All code that relies on knowledge of @sc{gnus} internals will probably
16877 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
16878 changing it in any way, as a matter of fact) is strictly verboten. Gnus
16879 maintains a hash table that points to the entries in this alist (which
16880 speeds up many functions), and changing the alist directly will lead to
16884 @cindex highlighting
16885 Old hilit19 code does not work at all. In fact, you should probably
16886 remove all hilit code from all Gnus hooks
16887 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
16888 Gnus provides various integrated functions for highlighting. These are
16889 faster and more accurate. To make life easier for everybody, Gnus will
16890 by default remove all hilit calls from all hilit hooks. Uncleanliness!
16893 Packages like @code{expire-kill} will no longer work. As a matter of
16894 fact, you should probably remove all old @sc{gnus} packages (and other
16895 code) when you start using Gnus. More likely than not, Gnus already
16896 does what you have written code to make @sc{gnus} do. (Snicker.)
16898 Even though old methods of doing things are still supported, only the
16899 new methods are documented in this manual. If you detect a new method of
16900 doing something while reading this manual, that does not mean you have
16901 to stop doing it the old way.
16903 Gnus understands all @sc{gnus} startup files.
16905 @kindex M-x gnus-bug
16907 @cindex reporting bugs
16909 Overall, a casual user who hasn't written much code that depends on
16910 @sc{gnus} internals should suffer no problems. If problems occur,
16911 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
16913 @vindex gnus-bug-create-help-buffer
16914 If you are in the habit of sending bug reports @emph{very} often, you
16915 may find the helpful help buffer annoying after a while. If so, set
16916 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
16921 @subsection Conformity
16923 No rebels without a clue here, ma'am. We conform to all standards known
16924 to (wo)man. Except for those standards and/or conventions we disagree
16931 There are no known breaches of this standard.
16935 There are no known breaches of this standard, either.
16937 @item Son-of-RFC 1036
16938 @cindex Son-of-RFC 1036
16939 We do have some breaches to this one.
16945 These are considered to be ``vanity headers'', while I consider them
16946 to be consumer information. After seeing so many badly formatted
16947 articles coming from @code{tin} and @code{Netscape} I know not to use
16948 either of those for posting articles. I would not have known that if
16949 it wasn't for the @code{X-Newsreader} header.
16954 USEFOR is an IETF working group writing a successor to RFC 1036, based
16955 on Son-of-RFC 1036. They have produced a number of drafts proposing
16956 various changes to the format of news articles. The Gnus towers will
16957 look into implementing the changes when the draft is accepted as an RFC.
16961 If you ever notice Gnus acting non-compliant with regards to the texts
16962 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
16967 @subsection Emacsen
16973 Gnus should work on :
16981 XEmacs 20.4 and up.
16985 This Gnus version will absolutely not work on any Emacsen older than
16986 that. Not reliably, at least. Older versions of Gnus may work on older
16989 There are some vague differences between Gnus on the various
16990 platforms---XEmacs features more graphics (a logo and a toolbar)---but
16991 other than that, things should look pretty much the same under all
16995 @node Gnus Development
16996 @subsection Gnus Development
16998 Gnus is developed in a two-phased cycle. The first phase involves much
16999 discussion on the @samp{ding@@gnus.org} mailing list, where people
17000 propose changes and new features, post patches and new backends. This
17001 phase is called the @dfn{alpha} phase, since the Gnusae released in this
17002 phase are @dfn{alpha releases}, or (perhaps more commonly in other
17003 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
17004 unstable and should not be used by casual users. Gnus alpha releases
17005 have names like ``Red Gnus'' and ``Quassia Gnus''.
17007 After futzing around for 50-100 alpha releases, Gnus is declared
17008 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
17009 and is called things like ``Gnus 5.6.32'' instead. Normal people are
17010 supposed to be able to use these, and these are mostly discussed on the
17011 @samp{gnu.emacs.gnus} newsgroup.
17014 @vindex nnmail-delete-incoming
17015 Some variable defaults differ between alpha Gnusae and released Gnusae.
17016 In particular, @code{nnmail-delete-incoming} defaults to @code{nil} in
17017 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
17018 lossage of mail if an alpha release hiccups while handling the mail.
17020 The division of discussion between the ding mailing list and the Gnus
17021 newsgroup is not purely based on publicity concerns. It's true that
17022 having people write about the horrible things that an alpha Gnus release
17023 can do (sometimes) in a public forum may scare people off, but more
17024 importantly, talking about new experimental features that have been
17025 introduced may confuse casual users. New features are frequently
17026 introduced, fiddled with, and judged to be found wanting, and then
17027 either discarded or totally rewritten. People reading the mailing list
17028 usually keep up with these rapid changes, whille people on the newsgroup
17029 can't be assumed to do so.
17034 @subsection Contributors
17035 @cindex contributors
17037 The new Gnus version couldn't have been done without the help of all the
17038 people on the (ding) mailing list. Every day for over a year I have
17039 gotten billions of nice bug reports from them, filling me with joy,
17040 every single one of them. Smooches. The people on the list have been
17041 tried beyond endurance, what with my ``oh, that's a neat idea <type
17042 type>, yup, I'll release it right away <ship off> no wait, that doesn't
17043 work at all <type type>, yup, I'll ship that one off right away <ship
17044 off> no, wait, that absolutely does not work'' policy for releases.
17045 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
17046 ``worser''? ``much worser''? ``worsest''?)
17048 I would like to take this opportunity to thank the Academy for... oops,
17054 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
17057 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
17058 well as numerous other things).
17061 Luis Fernandes---design and graphics.
17064 Erik Naggum---help, ideas, support, code and stuff.
17067 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el and many other things
17068 connected with @sc{mime} and other types of en/decoding.
17071 Wes Hardaker---@file{gnus-picon.el} and the manual section on
17072 @dfn{picons} (@pxref{Picons}).
17075 Kim-Minh Kaplan---further work on the picon code.
17078 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
17079 (@pxref{GroupLens}).
17082 Sudish Joseph---innumerable bug fixes.
17085 Ilja Weis---@file{gnus-topic.el}.
17088 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
17091 Vladimir Alexiev---the refcard and reference booklets.
17094 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
17095 distribution by Felix Lee and JWZ.
17098 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
17101 Peter Mutsaers---orphan article scoring code.
17104 Ken Raeburn---POP mail support.
17107 Hallvard B Furuseth---various bits and pieces, especially dealing with
17111 Brian Edmonds---@file{gnus-bbdb.el}.
17114 David Moore---rewrite of @file{nnvirtual.el} and many other things.
17117 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
17120 François Pinard---many, many interesting and thorough bug reports, as
17121 well as autoconf support.
17125 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
17126 Borges, and Jost Krieger proof-reading parts of the manual.
17128 The following people have contributed many patches and suggestions:
17137 Jason L. Tibbitts, III,
17141 Also thanks to the following for patches and stuff:
17151 Alexei V. Barantsev,
17166 Massimo Campostrini,
17171 Jae-you Chung, @c ?
17172 James H. Cloos, Jr.,
17176 Andrew J. Cosgriff,
17179 Geoffrey T. Dairiki,
17185 Michael Welsh Duggan,
17190 Enami Tsugutomo, @c Enami
17194 Nelson Jose dos Santos Ferreira,
17202 Arne Georg Gleditsch,
17204 Michelangelo Grigni,
17208 Kenichi Handa, @c Handa
17210 Yoshiki Hayashi, @c ?
17212 Hisashige Kenji, @c Hisashige
17219 François Felix Ingrand,
17220 Tatsuya Ichikawa, @c ?
17221 Ishikawa Ichiro, @c Ishikawa
17223 Iwamuro Motonori, @c Iwamuro
17234 Peter Skov Knudsen,
17235 Shuhei Kobayashi, @c Kobayashi
17237 Koseki Yoshinori, @c Koseki
17238 Thor Kristoffersen,
17241 Seokchan Lee, @c Lee
17259 Morioka Tomohiko, @c Morioka
17260 Erik Toubro Nielsen,
17267 Masaharu Onishi, @c Onishi
17272 Jens-Ulrik Holger Petersen,
17276 John McClary Prevost,
17282 Lars Balker Rasmussen,
17287 Christian von Roques,
17290 Wolfgang Rupprecht,
17297 Philippe Schnoebelen,
17299 Randal L. Schwartz,
17314 Kiyokazu Suto, @c Suto
17319 Tozawa Akihiko, @c Tozawa
17335 Katsumi Yamaoka @c Yamaoka
17340 For a full overview of what each person has done, the ChangeLogs
17341 included in the Gnus alpha distributions should give ample reading
17342 (550kB and counting).
17344 Apologies to everybody that I've forgotten, of which there are many, I'm
17347 Gee, that's quite a list of people. I guess that must mean that there
17348 actually are people who are using Gnus. Who'd'a thunk it!
17352 @subsection New Features
17353 @cindex new features
17356 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
17357 * September Gnus:: The Thing Formally Known As Gnus 5.3/5.3.
17358 * Red Gnus:: Third time best---Gnus 5.4/5.5.
17359 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
17362 These lists are, of course, just @emph{short} overviews of the
17363 @emph{most} important new features. No, really. There are tons more.
17364 Yes, we have feeping creaturism in full effect.
17368 @subsubsection (ding) Gnus
17370 New features in Gnus 5.0/5.1:
17375 The look of all buffers can be changed by setting format-like variables
17376 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
17379 Local spool and several @sc{nntp} servers can be used at once
17380 (@pxref{Select Methods}).
17383 You can combine groups into virtual groups (@pxref{Virtual Groups}).
17386 You can read a number of different mail formats (@pxref{Getting Mail}).
17387 All the mail backends implement a convenient mail expiry scheme
17388 (@pxref{Expiring Mail}).
17391 Gnus can use various strategies for gathering threads that have lost
17392 their roots (thereby gathering loose sub-threads into one thread) or it
17393 can go back and retrieve enough headers to build a complete thread
17394 (@pxref{Customizing Threading}).
17397 Killed groups can be displayed in the group buffer, and you can read
17398 them as well (@pxref{Listing Groups}).
17401 Gnus can do partial group updates---you do not have to retrieve the
17402 entire active file just to check for new articles in a few groups
17403 (@pxref{The Active File}).
17406 Gnus implements a sliding scale of subscribedness to groups
17407 (@pxref{Group Levels}).
17410 You can score articles according to any number of criteria
17411 (@pxref{Scoring}). You can even get Gnus to find out how to score
17412 articles for you (@pxref{Adaptive Scoring}).
17415 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
17416 manner, so it should be difficult to lose much data on what you have
17417 read if your machine should go down (@pxref{Auto Save}).
17420 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
17421 the @file{.emacs} file.
17424 You can set the process mark on both groups and articles and perform
17425 operations on all the marked items (@pxref{Process/Prefix}).
17428 You can grep through a subset of groups and create a group from the
17429 results (@pxref{Kibozed Groups}).
17432 You can list subsets of groups according to, well, anything
17433 (@pxref{Listing Groups}).
17436 You can browse foreign servers and subscribe to groups from those
17437 servers (@pxref{Browse Foreign Server}).
17440 Gnus can fetch articles, asynchronously, on a second connection to the
17441 server (@pxref{Asynchronous Fetching}).
17444 You can cache articles locally (@pxref{Article Caching}).
17447 The uudecode functions have been expanded and generalized
17448 (@pxref{Decoding Articles}).
17451 You can still post uuencoded articles, which was a little-known feature
17452 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
17455 Fetching parents (and other articles) now actually works without
17456 glitches (@pxref{Finding the Parent}).
17459 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
17462 Digests (and other files) can be used as the basis for groups
17463 (@pxref{Document Groups}).
17466 Articles can be highlighted and customized (@pxref{Customizing
17470 URLs and other external references can be buttonized (@pxref{Article
17474 You can do lots of strange stuff with the Gnus window & frame
17475 configuration (@pxref{Windows Configuration}).
17478 You can click on buttons instead of using the keyboard
17484 @node September Gnus
17485 @subsubsection September Gnus
17489 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
17493 New features in Gnus 5.2/5.3:
17498 A new message composition mode is used. All old customization variables
17499 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
17503 Gnus is now able to generate @dfn{sparse} threads---threads where
17504 missing articles are represented by empty nodes (@pxref{Customizing
17508 (setq gnus-build-sparse-threads 'some)
17512 Outgoing articles are stored on a special archive server
17513 (@pxref{Archived Messages}).
17516 Partial thread regeneration now happens when articles are
17520 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
17523 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
17526 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
17529 (setq gnus-use-trees t)
17533 An @code{nn}-like pick-and-read minor mode is available for the summary
17534 buffers (@pxref{Pick and Read}).
17537 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
17541 In binary groups you can use a special binary minor mode (@pxref{Binary
17545 Groups can be grouped in a folding topic hierarchy (@pxref{Group
17549 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
17553 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
17556 Groups can now have a score, and bubbling based on entry frequency
17557 is possible (@pxref{Group Score}).
17560 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
17564 Groups can be process-marked, and commands can be performed on
17565 groups of groups (@pxref{Marking Groups}).
17568 Caching is possible in virtual groups.
17571 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
17572 news batches, ClariNet briefs collections, and just about everything
17573 else (@pxref{Document Groups}).
17576 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
17580 The Gnus cache is much faster.
17583 Groups can be sorted according to many criteria (@pxref{Sorting
17587 New group parameters have been introduced to set list-addresses and
17588 expiry times (@pxref{Group Parameters}).
17591 All formatting specs allow specifying faces to be used
17592 (@pxref{Formatting Fonts}).
17595 There are several more commands for setting/removing/acting on process
17596 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
17599 The summary buffer can be limited to show parts of the available
17600 articles based on a wide range of criteria. These commands have been
17601 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
17604 Articles can be made persistent with the @kbd{*} command
17605 (@pxref{Persistent Articles}).
17608 All functions for hiding article elements are now toggles.
17611 Article headers can be buttonized (@pxref{Article Washing}).
17614 All mail backends support fetching articles by @code{Message-ID}.
17617 Duplicate mail can now be treated properly (@pxref{Duplicates}).
17620 All summary mode commands are available directly from the article
17621 buffer (@pxref{Article Keymap}).
17624 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
17628 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
17631 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
17636 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
17639 (setq gnus-use-nocem t)
17643 Groups can be made permanently visible (@pxref{Listing Groups}).
17646 (setq gnus-permanently-visible-groups "^nnml:")
17650 Many new hooks have been introduced to make customizing easier.
17653 Gnus respects the @code{Mail-Copies-To} header.
17656 Threads can be gathered by looking at the @code{References} header
17657 (@pxref{Customizing Threading}).
17660 (setq gnus-summary-thread-gathering-function
17661 'gnus-gather-threads-by-references)
17665 Read articles can be stored in a special backlog buffer to avoid
17666 refetching (@pxref{Article Backlog}).
17669 (setq gnus-keep-backlog 50)
17673 A clean copy of the current article is always stored in a separate
17674 buffer to allow easier treatment.
17677 Gnus can suggest where to save articles (@pxref{Saving Articles}).
17680 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
17684 (setq gnus-prompt-before-saving t)
17688 @code{gnus-uu} can view decoded files asynchronously while fetching
17689 articles (@pxref{Other Decode Variables}).
17692 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
17696 Filling in the article buffer now works properly on cited text
17697 (@pxref{Article Washing}).
17700 Hiding cited text adds buttons to toggle hiding, and how much
17701 cited text to hide is now customizable (@pxref{Article Hiding}).
17704 (setq gnus-cited-lines-visible 2)
17708 Boring headers can be hidden (@pxref{Article Hiding}).
17711 Default scoring values can now be set from the menu bar.
17714 Further syntax checking of outgoing articles have been added.
17720 @subsubsection Red Gnus
17722 New features in Gnus 5.4/5.5:
17726 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
17733 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
17736 Article prefetching functionality has been moved up into
17737 Gnus (@pxref{Asynchronous Fetching}).
17740 Scoring can now be performed with logical operators like @code{and},
17741 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
17745 Article washing status can be displayed in the
17746 article mode line (@pxref{Misc Article}).
17749 @file{gnus.el} has been split into many smaller files.
17752 Suppression of duplicate articles based on Message-ID can be done
17753 (@pxref{Duplicate Suppression}).
17756 (setq gnus-suppress-duplicates t)
17760 New variables for specifying what score and adapt files are to be
17761 considered home score and adapt files (@pxref{Home Score File}) have
17765 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
17766 Server Internals}).
17769 Groups can inherit group parameters from parent topics (@pxref{Topic
17773 Article editing has been revamped and is now actually usable.
17776 Signatures can be recognized in more intelligent fashions
17777 (@pxref{Article Signature}).
17780 Summary pick mode has been made to look more @code{nn}-like. Line
17781 numbers are displayed and the @kbd{.} command can be used to pick
17782 articles (@code{Pick and Read}).
17785 Commands for moving the @file{.newsrc.eld} from one server to
17786 another have been added (@pxref{Changing Servers}).
17789 There's a way now to specify that ``uninteresting'' fields be suppressed
17790 when generating lines in buffers (@pxref{Advanced Formatting}).
17793 Several commands in the group buffer can be undone with @kbd{M-C-_}
17797 Scoring can be done on words using the new score type @code{w}
17798 (@pxref{Score File Format}).
17801 Adaptive scoring can be done on a Subject word-by-word basis
17802 (@pxref{Adaptive Scoring}).
17805 (setq gnus-use-adaptive-scoring '(word))
17809 Scores can be decayed (@pxref{Score Decays}).
17812 (setq gnus-decay-scores t)
17816 Scoring can be performed using a regexp on the Date header. The Date is
17817 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
17820 A new command has been added to remove all data on articles from
17821 the native server (@pxref{Changing Servers}).
17824 A new command for reading collections of documents
17825 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
17826 (@pxref{Really Various Summary Commands}).
17829 Process mark sets can be pushed and popped (@pxref{Setting Process
17833 A new mail-to-news backend makes it possible to post even when the NNTP
17834 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
17837 A new backend for reading searches from Web search engines
17838 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
17839 (@pxref{Web Searches}).
17842 Groups inside topics can now be sorted using the standard sorting
17843 functions, and each topic can be sorted independently (@pxref{Topic
17847 Subsets of the groups can be sorted independently (@code{Sorting
17851 Cached articles can be pulled into the groups (@pxref{Summary Generation
17855 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
17860 Score files are now applied in a more reliable order (@pxref{Score
17864 Reports on where mail messages end up can be generated (@pxref{Splitting
17868 More hooks and functions have been added to remove junk from incoming
17869 mail before saving the mail (@pxref{Washing Mail}).
17872 Emphasized text can be properly fontisized:
17878 @subsubsection Quassia Gnus
17880 New features in Gnus 5.6:
17885 New functionality for using Gnus as an offline newsreader has been
17886 added. A plethora of new commands and modes have been added. See
17887 @pxref{Gnus Unplugged} for the full story.
17890 The @code{nndraft} backend has returned, but works differently than
17891 before. All Message buffers are now also articles in the @code{nndraft}
17892 group, which is created automatically.
17895 @code{gnus-alter-header-function} can now be used to alter header
17899 @code{gnus-summary-goto-article} now accept Message-ID's.
17902 A new Message command for deleting text in the body of a message
17903 outside the region: @kbd{C-c C-v}.
17906 You can now post to component group in @code{nnvirtual} groups with
17910 @code{nntp-rlogin-program}---new variable to ease customization.
17913 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
17914 re-highlighting of the article buffer.
17917 New element in @code{gnus-boring-article-headers}---@code{long-to}.
17920 @kbd{M-i} symbolic prefix command. See the section "Symbolic
17921 Prefixes" in the Gnus manual for details.
17924 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
17925 @kbd{a} to add the score rule to the "all.SCORE" file.
17928 @code{gnus-simplify-subject-functions} variable to allow greater
17929 control over simplification.
17932 @kbd{A T}---new command for fetching the current thread.
17935 @kbd{/ T}---new command for including the current thread in the
17939 @kbd{M-RET} is a new Message command for breaking cited text.
17942 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
17945 The @code{custom-face-lookup} function has been removed.
17946 If you used this function in your initialization files, you must
17947 rewrite them to use @code{face-spec-set} instead.
17950 Canceling now uses the current select method. Symbolic prefix
17951 @kbd{a} forces normal posting method.
17954 New command to translate M******** sm*rtq**t*s into proper
17958 For easier debugging of @code{nntp}, you can set
17959 @code{nntp-record-commands} to a non-@code{nil} value.
17962 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
17963 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
17966 A command for editing group parameters from the summary buffer
17970 A history of where mails have been split is available.
17973 A new article date command has been added---@code{article-date-iso8601}.
17976 Subjects can be simplified when threading by setting
17977 @code{gnus-score-thread-simplify}.
17980 A new function for citing in Message has been
17981 added---@code{message-cite-original-without-signature}.
17984 @code{article-strip-all-blank-lines}---new article command.
17987 A new Message command to kill to the end of the article has
17991 A minimum adaptive score can be specified by using the
17992 @code{gnus-adaptive-word-minimum} variable.
17995 The "lapsed date" article header can be kept continually
17996 updated by the @code{gnus-start-date-timer} command.
17999 Web listserv archives can be read with the @code{nnlistserv} backend.
18002 Old dejanews archives can now be read by @code{nnweb}.
18007 @node Newest Features
18008 @subsection Newest Features
18011 Also known as the @dfn{todo list}. Sure to be implemented before the
18014 Be afraid. Be very afraid.
18016 (That a feature appears in this list doesn't necessarily mean that I've
18017 decided to actually implement it. It just means that I think it sounds
18020 (Yes, this is the actual, up-to-the-second todo list.)
18025 I would like the zombie-page to contain an URL to the source of the
18026 latest version of gnus or some explanation on where to find it.
18029 A way to continue editing the latest Message composition.
18032 http://www.sonicnet.com/feature/ari3/
18035 facep is not declared.
18038 Include a section in the manual on why the number of articles
18039 isn't the same in the group buffer and on the SPC prompt.
18042 Interacting with rmail fcc isn't easy.
18047 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
18048 <URL:http://www.eit.com/software/hypermail/hypermail.html>
18049 <URL:http://homer.ncm.com/>
18050 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
18051 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
18052 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
18053 http://www.miranova.com/gnus-list/
18058 @samp{^-- } is made into - in LaTeX.
18061 gnus-kill is much slower than it was in GNUS 4.1.3.
18064 when expunging articles on low score, the sparse nodes keep hanging on?
18066 starting the first time seems to hang Gnus on some systems. Does
18067 NEWGROUPS answer too fast?
18069 nndir doesn't read gzipped files.
18071 FAQ doesn't have an up node?
18073 when moving mail from a procmail spool to the crash-box,
18074 the crash-box is only appropriate to one specific group.
18076 `t' `t' makes X-Faces disappear.
18078 nnmh-be-safe means that crossposted articles will
18079 be marked as unread.
18081 Orphan score entries don't show on "V t" score trace
18083 when clearing out data, the cache data should also be reset.
18085 rewrite gnus-summary-limit-children to be non-recursive
18086 to avoid exceeding lisp nesting on huge groups.
18088 expunged articles are counted when computing scores.
18090 implement gnus-batch-brew-soup
18092 ticked articles aren't easy to read in pick mode -- `n' and
18093 stuff just skips past them. Read articles are the same.
18095 topics that contain just groups with ticked
18096 articles aren't displayed.
18098 nndoc should always allocate unique Message-IDs.
18100 If there are mail groups the first time you use Gnus, Gnus'll
18101 make the mail groups killed.
18103 no "no news is good news" when using topics.
18105 when doing crosspost marking, the cache has to be consulted
18106 and articles have to be removed.
18108 nnweb should fetch complete articles when they are split into several
18111 scoring on head immediate doesn't work.
18113 finding short score file names takes forever.
18115 canceling articles in foreign groups.
18117 nntp-open-rlogin no longer works.
18119 C-u C-x C-s (Summary) switches to the group buffer.
18121 move nnmail-split-history out to the backends.
18123 nnweb doesn't work properly.
18125 using a virtual server name as `gnus-select-method' doesn't work?
18127 when killing/yanking a group from one topic to another in a slave, the
18128 master will yank it first to one topic and then add it to another.
18132 warn user about `=' redirection of a group in the active file?
18134 take over the XEmacs menubar and offer a toggle between the XEmacs
18135 bar and the Gnus bar.
18138 push active file and NOV file parsing down into C code.
18139 `(canonize-message-id id)'
18140 `(mail-parent-message-id references n)'
18141 `(parse-news-nov-line &optional dependency-hashtb)'
18142 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
18143 `(parse-news-active-region beg end hashtb)'
18148 nnml .overview directory with splits.
18152 postponed commands.
18154 the selected article show have its Subject displayed in its summary line.
18156 when entering groups, get the real number of unread articles from
18159 sort after gathering threads -- make false roots have the
18160 headers of the oldest orphan with a 0 article number?
18162 nndoc groups should inherit the score files of their parents? Also
18163 inherit copy prompts and save files.
18165 command to start up Gnus (if not running) and enter a mail mode buffer.
18167 allow editing the group description from the group buffer
18168 for backends that support that.
18170 gnus-hide,show-all-topics
18172 groups and sub-topics should be allowed to mingle inside each topic,
18173 and not just list all subtopics at the end.
18175 a command to remove all read articles that are not needed to connect
18176 threads -- `gnus-summary-limit-to-sparse-unread'?
18178 a variable to turn off limiting/cutting of threads in the tree buffer.
18180 a variable to limit how many files are uudecoded.
18182 add zombie groups to a special "New Groups" topic.
18184 server mode command: close/open all connections
18186 put a file date in gnus-score-alist and check whether the file
18187 has been changed before using it.
18189 on exit from a digest group, go to the next article in the parent group.
18191 hide (sub)threads with low score.
18193 when expiring, remove all marks from expired articles.
18195 gnus-summary-limit-to-body
18197 a regexp alist that says what level groups are to be subscribed
18198 on. Eg. -- `(("nnml:" . 1))'.
18200 easier interface to nnkiboze to create ephemeral groups that
18201 contain groups that match a regexp.
18203 allow newlines in <URL:> urls, but remove them before using
18206 If there is no From line, the mail backends should fudge one from the
18209 fuzzy simplifying should strip all non-alpha-numerical info
18210 from subject lines.
18212 gnus-soup-brew-soup-with-high-scores.
18214 nntp-ping-before-connect
18216 command to check whether NOV is evil. "list overview.fmt".
18218 when entering a group, Gnus should look through the score
18219 files very early for `local' atoms and set those local variables.
18221 message annotations.
18223 topics are always yanked before groups, and that's not good.
18225 (set-extent-property extent 'help-echo "String to display in minibuf")
18226 to display help in the minibuffer on buttons under XEmacs.
18228 allow group line format spec to say how many articles there
18233 `run-with-idle-timer' in gnus-demon.
18235 stop using invisible text properties and start using overlays instead
18237 C-c C-f C-e to add an Expires header.
18239 go from one group to the next; everything is expunged; go to the
18240 next group instead of going to the group buffer.
18242 gnus-renumber-cache -- to renumber the cache using "low" numbers.
18244 record topic changes in the dribble buffer.
18246 `nnfolder-generate-active-file' should look at the folders it
18247 finds and generate proper active ranges.
18249 nneething-look-in-files-for-article-heads variable to control
18250 whether nneething should sniff all files in the directories.
18252 gnus-fetch-article -- start Gnus, enter group, display article
18254 gnus-dont-move-articles-to-same-group variable when respooling.
18256 when messages are crossposted between several auto-expirable groups,
18257 articles aren't properly marked as expirable.
18259 nneething should allow deletion/moving.
18261 TAB on the last button should go to the first button.
18263 if the car of an element in `mail-split-methods' is a function,
18264 and the function returns non-nil, use that as the name of the group(s) to
18267 command for listing all score files that have been applied.
18269 a command in the article buffer to return to `summary' config.
18271 `gnus-always-post-using-current-server' -- variable to override
18272 `C-c C-c' when posting.
18274 nnmail-group-spool-alist -- says where each group should use
18277 when an article is crossposted to an auto-expirable group, the article
18278 should be marker as expirable.
18280 article mode command/menu for "send region as URL to browser".
18282 on errors, jump to info nodes that explain the error. For instance,
18283 on invalid From headers, or on error messages from the nntp server.
18285 when gathering threads, make the article that has no "Re: " the parent.
18286 Also consult Date headers.
18288 a token in splits to call shrink-window-if-larger-than-buffer
18290 `1 0 A M' to do matches on the active hashtb.
18292 duplicates -- command to remove Gnus-Warning header, use the read
18293 Message-ID, delete the "original".
18295 when replying to several messages at once, put the "other" message-ids
18296 into a See-Also header.
18298 support setext: URL:http://www.bsdi.com/setext/
18300 support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
18302 when browsing a foreign server, the groups that are already subscribed
18303 should be listed as such and not as "K".
18305 generate font names dynamically.
18307 score file mode auto-alist.
18309 allow nndoc to change/add/delete things from documents. Implement
18310 methods for each format for adding an article to the document.
18312 `gnus-fetch-old-headers' `all' value to incorporate
18313 absolutely all headers there is.
18315 function like `|', but concatenate all marked articles
18316 and pipe them to the process.
18318 cache the list of killed (or active) groups in a separate file. Update
18319 the file whenever we read the active file or the list
18320 of killed groups in the .eld file reaches a certain length.
18322 function for starting to edit a file to put into
18323 the current mail group.
18325 score-find-trace should display the total score of the article.
18327 "ghettozie" -- score on Xref header and nix it out after using it
18328 to avoid marking as read in other groups it has been crossposted to.
18330 look at procmail splitting. The backends should create
18331 the groups automatically if a spool file exists for that group.
18333 function for backends to register themselves with Gnus.
18335 when replying to several process-marked articles,
18336 have all the From end up in Cc headers? Variable to toggle.
18338 command to delete a crossposted mail article from all
18339 groups it has been mailed to.
18341 `B c' and `B m' should be crosspost aware.
18343 hide-pgp should also hide PGP public key blocks.
18345 Command in the group buffer to respool process-marked groups.
18347 `gnus-summary-find-matching' should accept
18348 pseudo-"headers" like "body", "head" and "all"
18350 When buttifying <URL: > things, all white space (including
18351 newlines) should be ignored.
18353 Process-marking all groups in a topic should process-mark
18354 groups in subtopics as well.
18356 Add non-native groups to the list of killed groups when killing them.
18358 nntp-suggest-kewl-config to probe the nntp server and suggest
18361 add edit and forward secondary marks.
18363 nnml shouldn't visit its .overview files.
18365 allow customizing sorting within gathered threads.
18367 `B q' shouldn't select the current article.
18369 nnmbox should support a newsgroups file for descriptions.
18371 allow fetching mail from several pop servers.
18373 Be able to specify whether the saving commands save the original
18374 or the formatted article.
18376 a command to reparent with the child process-marked (cf. `T ^'.).
18378 I think the possibility to send a password with nntp-open-rlogin
18379 should be a feature in Red Gnus.
18381 The `Z n' command should be possible to execute from a mouse click.
18383 more limiting functions -- date, etc.
18385 be able to limit on a random header; on body; using reverse matches.
18387 a group parameter (`absofucking-total-expiry') that will make Gnus expire
18388 even unread articles.
18390 a command to print the article buffer as postscript.
18392 variable to disable password fetching when opening by nntp-open-telnet.
18394 manual: more example servers -- nntp with rlogin, telnet
18396 checking for bogus groups should clean topic alists as well.
18398 canceling articles in foreign groups.
18400 article number in folded topics isn't properly updated by
18403 Movement in the group buffer to the next unread group should go to the
18404 next closed topic with unread messages if no group can be found.
18406 Extensive info pages generated on the fly with help everywhere --
18407 in the "*Gnus edit*" buffers, for instance.
18409 Topic movement commands -- like thread movement. Up, down, forward, next.
18411 a way to tick/mark as read Gcc'd articles.
18413 a way to say that all groups within a specific topic comes
18414 from a particular server? Hm.
18416 `gnus-article-fill-if-long-lines' -- a function to fill
18417 the article buffer if there are any looong lines there.
18419 `T h' should jump to the parent topic and fold it.
18421 a command to create an ephemeral nndoc group out of a file,
18422 and then splitting it/moving it to some other group/backend.
18424 a group parameter for nnkiboze groups that says that
18425 all kibozed articles should be entered into the cache.
18427 It should also probably be possible to delimit what
18428 `gnus-jog-cache' does -- for instance, work on just some groups, or on
18429 some levels, and entering just articles that have a score higher than
18432 nnfolder should append to the folder instead of re-writing
18433 the entire folder to disk when accepting new messages.
18435 allow all backends to do the proper thing with .gz files.
18437 a backend for reading collections of babyl files nnbabylfolder?
18439 a command for making the native groups into foreign groups.
18441 server mode command for clearing read marks from all groups
18444 when following up multiple articles, include all To, Cc, etc headers
18447 a command for deciding what the total score of the current
18448 thread is. Also a way to highlight based on this.
18450 command to show and edit group scores
18452 a gnus-tree-minimize-horizontal to minimize tree buffers
18455 command to generate nnml overview file for one group.
18457 `C-u C-u a' -- prompt for many crossposted groups.
18459 keep track of which mail groups have received new articles (in this session).
18460 Be able to generate a report and perhaps do some marking in the group
18463 gnus-build-sparse-threads to a number -- build only sparse threads
18464 that are of that length.
18466 have nnmh respect mh's unseen sequence in .mh_profile.
18468 cache the newsgroups descriptions locally.
18470 asynchronous posting under nntp.
18472 be able to control word adaptive scoring from the score files.
18474 a variable to make `C-c C-c' post using the "current" select method.
18476 `limit-exclude-low-scored-articles'.
18478 if `gnus-summary-show-thread' is a number, hide threads that have
18479 a score lower than this number.
18481 split newsgroup subscription variable up into "order" and "method".
18483 buttonize ange-ftp file names.
18485 a command to make a duplicate copy of the current article
18486 so that each copy can be edited separately.
18488 nnweb should allow fetching from the local nntp server.
18490 record the sorting done in the summary buffer so that
18491 it can be repeated when limiting/regenerating the buffer.
18493 nnml-generate-nov-databses should generate for
18496 when the user does commands in the group buffer, check
18497 the modification time of the .newsrc.eld file and use
18498 ask-user-about-supersession-threat. Also warn when trying
18499 to save .newsrc.eld and it has changed.
18501 M-g on a topic will display all groups with 0 articles in
18504 command to remove all topic stuff.
18506 allow exploding incoming digests when reading incoming mail
18507 and splitting the resulting digests.
18509 nnsoup shouldn't set the `message-' variables.
18511 command to nix out all nnoo state information.
18513 nnmail-process-alist that calls functions if group names
18514 matches an alist -- before saving.
18516 use buffer-invisibility-spec everywhere for hiding text.
18518 variable to activate each group before entering them
18519 to get the (new) number of articles. `gnus-activate-before-entering'.
18521 command to fetch a Message-ID from any buffer, even
18522 starting Gnus first if necessary.
18524 when posting and checking whether a group exists or not, just
18525 ask the nntp server instead of relying on the active hashtb.
18527 buttonize the output of `C-c C-a' in an apropos-like way.
18529 `G p' should understand process/prefix, and allow editing
18530 of several groups at once.
18532 command to create an ephemeral nnvirtual group that
18533 matches some regexp(s).
18535 nndoc should understand "Content-Type: message/rfc822" forwarded messages.
18537 it should be possible to score "thread" on the From header.
18539 hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
18541 `B i' should display the article at once in the summary buffer.
18543 remove the "*" mark at once when unticking an article.
18545 `M-s' should highlight the matching text.
18547 when checking for duplicated mails, use Resent-Message-ID if present.
18549 killing and yanking groups in topics should be better. If killing one copy
18550 of a group that exists in multiple topics, only that copy should
18551 be removed. Yanking should insert the copy, and yanking topics
18552 should be possible to be interspersed with the other yankings.
18554 command for enter a group just to read the cached articles. A way to say
18555 "ignore the nntp connection; just read from the cache."
18557 `X u' should decode base64 articles.
18559 a way to hide all "inner" cited text, leaving just the most
18560 recently cited text.
18562 nnvirtual should be asynchronous.
18564 after editing an article, gnus-original-article-buffer should
18567 there should probably be a way to make Gnus not connect to the
18568 server and just read the articles in the server
18570 allow a `set-default' (or something) to change the default
18571 value of nnoo variables.
18573 a command to import group infos from a .newsrc.eld file.
18575 groups from secondary servers have the entire select method
18576 listed in each group info.
18578 a command for just switching from the summary buffer to the group
18581 a way to specify that some incoming mail washing functions
18582 should only be applied to some groups.
18584 Message `C-f C-t' should ask the user whether to heed
18585 mail-copies-to: never.
18587 new group parameter -- `post-to-server' that says to post
18588 using the current server. Also a variable to do the same.
18590 the slave dribble files should auto-save to the slave file names.
18592 a group parameter that says what articles to display on group entry, based
18595 a way to visually distinguish slave Gnusae from masters. (Whip instead
18598 Use DJ Bernstein "From " quoting/dequoting, where applicable.
18600 Why is hide-citation-maybe and hide-citation different? Also
18603 group user-defined meta-parameters.
18607 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
18609 I like the option for trying to retrieve the FAQ for a group and I was
18610 thinking it would be great if for those newsgroups that had archives
18611 you could also try to read the archive for that group. Part of the
18612 problem is that archives are spread all over the net, unlike FAQs.
18613 What would be best I suppose is to find the one closest to your site.
18615 In any case, there is a list of general news group archives at @*
18616 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
18623 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
18624 (add-hook 'gnus-select-group-hook
18626 (gnus-group-add-parameter group
18627 (cons 'gnus-group-date-last-entered (list (current-time-string))))))
18629 (defun gnus-user-format-function-d (headers)
18630 "Return the date the group was last read."
18631 (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
18636 tanken var at når du bruker `gnus-startup-file' som prefix (FOO) til å lete
18637 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
18638 liste hvor du bruker hvert element i listen som FOO, istedet. da kunne man
18639 hatt forskjellige serveres startup-filer forskjellige steder.
18643 LMI> Well, nnbabyl could alter the group info to heed labels like
18644 LMI> answered and read, I guess.
18646 It could also keep them updated (the same for the Status: header of
18649 They could be used like this:
18653 `M l <name> RET' add label <name> to current message.
18654 `M u <name> RET' remove label <name> from current message.
18655 `/ l <expr> RET' limit summary buffer according to <expr>.
18657 <expr> would be a boolean expression on the labels, e.g.
18659 `/ l bug & !fixed RET'
18662 would show all the messages which are labeled `bug' but not labeled
18665 One could also imagine the labels being used for highlighting, or
18666 affect the summary line format.
18670 Sender: abraham@@dina.kvl.dk
18672 I'd like a gnus-find-file which work like find file, except that it
18673 would recognize things that looks like messages or folders:
18675 - If it is a directory containing numbered files, create an nndir
18678 - For other directories, create a nneething summary buffer.
18680 - For files matching "\\`From ", create a nndoc/mbox summary.
18682 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
18684 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
18686 - For other files, just find them normally.
18688 I'd like `nneething' to use this function, so it would work on a
18689 directory potentially containing mboxes or babyl files.
18692 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
18693 tell him what you are doing.
18696 Currently, I get prompted:
18700 decend into sci.something ?
18704 The problem above is that since there is really only one subsection of
18705 science, shouldn't it prompt you for only descending sci.something? If
18706 there was a sci.somethingelse group or section, then it should prompt
18707 for sci? first the sci.something? then sci.somethingelse?...
18710 Ja, det burde være en måte å si slikt. Kanskje en ny variabel?
18711 `gnus-use-few-score-files'? SÃ¥ kunne score-regler legges til den
18712 "mest" lokale score-fila. F. eks. ville no-gruppene betjenes av
18713 "no.all.SCORE", osv.
18716 What i want is for Gnus to treat any sequence or combination of the following
18717 as a single spoiler warning and hide it all, replacing it with a "Next Page"
18723 more than n blank lines
18725 more than m identical lines
18726 (which should be replaced with button to show them)
18728 any whitespace surrounding any of the above
18732 Well, we could allow a new value to `gnus-thread-ignore-subject' --
18733 `spaces', or something. (We could even default to that.) And then
18734 subjects that differ in white space only could be considered the
18735 "same" subject for threading purposes.
18738 Modes to preprocess the contents (e.g. jka-compr) use the second form
18739 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
18740 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
18741 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
18744 Under XEmacs -- do funny article marks:
18747 soup - bowl of soup
18748 score below - dim light bulb
18749 score over - bright light bulb
18752 Yes. I think the algorithm is as follows:
18757 show-list-of-articles-in-group
18758 if (key-pressed == SPACE)
18759 if (no-more-articles-in-group-to-select)
18760 if (articles-selected)
18761 start-reading-selected-articles;
18762 junk-unread-articles;
18767 else if (key-pressed = '.')
18768 if (consolidated-menus) # same as hide-thread in Gnus
18769 select-thread-under-cursor;
18771 select-article-under-cursor;
18775 if (key-pressed == SPACE)
18776 if (more-pages-in-article)
18778 else if (more-selected-articles-to-read)
18785 My precise need here would have been to limit files to Incoming*.
18786 One could think of some `nneething-only-files' variable, but I guess
18787 it would have been unacceptable if one was using many unrelated such
18790 A more useful approach would be to, in response to the `G D' prompt, be
18791 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
18792 the top-level directory only (in case directories would be matched by
18793 the wildcard expression).
18796 It would be nice if it also handled
18798 <URL:news://sunsite.auc.dk/>
18800 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
18805 Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
18806 really well. Each menu is 'named' by a symbol that would be on a
18807 gnus-*-menus (where * would be whatever, but at least group, summary, and
18808 article versions) variable.
18810 So for gnus-summary-menus, I would set to '(sort mark dispose ...)
18812 A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
18813 the main menubar. This approach works really well for Emacs-W3 and VM.
18817 nndoc should take care to create unique Message-IDs for all its
18820 gnus-score-followup-article only works when you have a summary buffer
18821 active. Make it work when posting from the group buffer as well.
18822 (message-sent-hook).
18824 rewrite gnus-demon to use run-with-idle-timers.
18827 * Enhancements to Gnus:
18831 * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
18832 straight to the server buffer, without opening any connections to
18835 * gnus-server-read-server-newsrc--produces a buffer very similar to
18836 the group buffer, but with only groups from that server listed;
18837 quitting this buffer returns to the server buffer.
18840 add a command to check the integrity of an nnfolder folder --
18841 go through the article numbers and see that there are no duplicates,
18845 `unsmileyfy-buffer' to undo smileification.
18848 a command to give all relevant info on an article, including all
18852 when doing `-request-accept-article', the backends should do
18853 the nnmail duplicate checking.
18856 allow `message-signature-file' to be a function to return the
18857 value of the signature file.
18860 In addition, I would love it if I could configure message-tab so that it
18861 could call `bbdb-complete-name' in other headers. So, some sort of
18864 (setq message-tab-alist
18865 '((message-header-regexp message-expand-group)
18866 ("^\\(To\\|[cC]c\\|[bB]cc\\)" bbdb-complete-name)))
18868 then you could run the relevant function to complete the information in
18872 cache the newsgroups file locally to avoid reloading it all the time.
18875 a command to import a buffer into a group.
18878 nnweb should allow fetching by Message-ID from servers.
18881 point in the article buffer doesn't always go to the
18882 beginning of the buffer when selecting new articles.
18885 a command to process mark all unread articles.
18888 `gnus-gather-threads-by-references-and-subject' -- first
18889 do gathering by references, and then go through the dummy roots and
18890 do more gathering by subject.
18893 gnus-uu-mark-in-numerical-order -- process mark articles in
18894 article numerical order.
18897 (gnus-thread-total-score
18898 (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
18902 sorting by score is wrong when using sparse threads.
18905 a command to fetch an arbitrary article -- without having to be
18906 in the summary buffer.
18909 a new nncvs backend. Each group would show an article, using
18910 version branches as threading, checkin date as the date, etc.
18913 http://www.dejanews.com/forms/dnsetfilter_exp.html ?
18914 This filter allows one to construct advance queries on the Dejanews
18915 database such as specifying start and end dates, subject, author,
18916 and/or newsgroup name.
18919 new Date header scoring type -- older, newer
18922 use the summary toolbar in the article buffer.
18925 a command to fetch all articles that are less than X days old.
18928 in pick mode, `q' should save the list of selected articles in the
18929 group info. The next time the group is selected, these articles
18930 will automatically get the process mark.
18933 Isn't it possible to (also?) allow M-^ to automatically try the
18934 default server if it fails on the current server? (controlled by a
18935 user variable, (nil, t, 'ask)).
18938 make it possible to cancel articles using the select method for the
18942 `gnus-summary-select-article-on-entry' or something. It'll default
18943 to t and will select whatever article decided by `gnus-auto-select-first'.
18946 a new variable to control which selection commands should be unselecting.
18947 `first', `best', `next', `prev', `next-unread', `prev-unread' are
18951 be able to select groups that have no articles in them
18952 to be able to post in them (using the current select method).
18955 be able to post via DejaNews.
18958 `x' should retain any sortings that have been performed.
18961 allow the user to specify the precedence of the secondary marks. Also
18962 allow them to be displayed separately.
18965 gnus-summary-save-in-pipe should concatenate the results from
18966 the processes when doing a process marked pipe.
18969 a new match type, like Followup, but which adds Thread matches on all
18970 articles that match a certain From header.
18973 a function that can be read from kill-emacs-query-functions to offer
18974 saving living summary buffers.
18977 a function for selecting a particular group which will contain
18978 the articles listed in a list of article numbers/id's.
18981 a battery of character translation functions to translate common
18982 Mac, MS (etc) characters into ISO 8859-1.
18985 (defun article-fix-m$word ()
18986 "Fix M$Word smartquotes in an article."
18989 (let ((buffer-read-only nil))
18990 (goto-char (point-min))
18991 (while (search-forward "\221" nil t)
18992 (replace-match "`" t t))
18993 (goto-char (point-min))
18994 (while (search-forward "\222" nil t)
18995 (replace-match "'" t t))
18996 (goto-char (point-min))
18997 (while (search-forward "\223" nil t)
18998 (replace-match "\"" t t))
18999 (goto-char (point-min))
19000 (while (search-forward "\224" nil t)
19001 (replace-match "\"" t t)))))
19006 (add-hook 'gnus-exit-query-functions
19008 (if (and (file-exists-p nnmail-spool-file)
19009 (> (nnheader-file-size nnmail-spool-file) 0))
19010 (yes-or-no-p "New mail has arrived. Quit Gnus anyways? ")
19011 (y-or-n-p "Are you sure you want to quit Gnus? "))))
19015 allow message-default-headers to be a function.
19018 new Date score match types -- < > = (etc) that take floating point
19019 numbers and match on the age of the article.
19023 > > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
19024 > > > under xemacs-19.14, it's creating a new frame, but is erasing the
19025 > > > buffer in the frame that it was called from =:-O
19027 > > Hm. How do you start up Gnus? From the toolbar or with
19028 > > `M-x gnus-other-frame'?
19030 > I normally start it up from the toolbar; at
19031 > least that's the way I've caught it doing the
19036 all commands that react to the process mark should push
19037 the current process mark set onto the stack.
19040 gnus-article-hide-pgp
19041 Selv ville jeg nok ha valgt å slette den dersom teksten matcher
19043 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
19045 og det er maks hundre tegn mellom match-end og ----linja. Men -det-
19046 er min type heuristikk og langt fra alles.
19049 `gnus-subscribe-sorted' -- insert new groups where they would have been
19050 sorted to if `gnus-group-sort-function' were run.
19053 gnus-(group,summary)-highlight should respect any `face' text props set
19057 use run-with-idle-timer for gnus-demon instead of the
19058 home-brewed stuff for better reliability.
19061 add a way to select which NoCeM type to apply -- spam, troll, etc.
19064 nndraft-request-group should tally auto-save files.
19067 implement nntp-retry-on-break and nntp-command-timeout.
19070 gnus-article-highlight-limit that says when not to highlight (long)
19074 (nnoo-set SERVER VARIABLE VALUE)
19080 interrupitng agent fetching of articles should save articles.
19083 command to open a digest group, and copy all the articles there to the
19087 a variable to disable article body highlights if there's more than
19088 X characters in the body.
19091 handle 480/381 authinfo requests separately.
19094 include the texi/dir file in the distribution.
19097 format spec to "tab" to a position.
19100 Move all prompting to the new `M-n' default style.
19103 command to display all dormant articles.
19106 gnus-auto-select-next makeover -- list of things it should do.
19109 a score match type that adds scores matching on From if From has replied
19110 to something someone else has said.
19113 Read Netscape discussion groups:
19114 snews://secnews.netscape.com/netscape.communicator.unix
19117 One command to edit the original version if an article, and one to edit
19118 the displayed version.
19121 @kbd{T v} -- make all process-marked articles the children of the
19125 Switch from initial text to the new default text mechanism.
19128 How about making it possible to expire local articles? Will it be
19129 possible to make various constraints on when an article can be
19130 expired, e.g. (read), (age > 14 days), or the more interesting (read
19134 New limit command---limit to articles that have a certain string
19135 in the head or body.
19138 Allow breaking lengthy NNTP commands.
19141 gnus-article-highlight-limit, to disable highlighting in big articles.
19144 Editing an article should put the article to be edited
19145 in a special, unique buffer.
19148 A command to send a mail to the admin-address group param.
19151 A Date scoring type that will match if the article
19152 is less than a certain number of days old.
19155 New spec: %~(tab 56) to put point on column 56
19158 Allow Gnus Agent scoring to use normal score files.
19161 Rething the Agent active file thing. `M-g' doesn't update the active
19162 file, for instance.
19165 With dummy roots, `^' and then selecing the first article
19166 in any other dummy thread will make gnus highlight the
19167 dummy root instead of the first article.
19170 Propagate all group properties (marks, article numbers, etc) up to the
19171 topics for displaying.
19174 `n' in the group buffer with topics should go to the next group
19175 with unread articles, even if that group is hidden in a topic.
19178 gnus-posting-styles doesn't work in drafts.
19181 gnus-summary-limit-include-cached is slow when there are
19182 many articles in the cache, since it regenerates big parts of the
19183 summary buffer for each article.
19186 Implement gnus-batch-brew-soup.
19189 Group parameters and summary commands for un/subscribing to mailing
19193 Introduce nnmail-home-directory.
19196 gnus-fetch-group and friends should exit Gnus when the user
19200 The jingle is only played on the second invocation of Gnus.
19203 Bouncing articles should do MIME.
19206 Crossposted articles should "inherit" the % or @ mark from the other
19207 groups it has been crossposted to, or something. (Agent.)
19210 `S D r' should allow expansion of aliases.
19213 If point is on a group that appears multiple times in topics, and
19214 you press `l', point will move to the first instance of the group.
19217 Fetch by Message-ID from dejanews.
19219 <URL:http://search.dejanews.com/msgid.xp?MID=%3C62h9l9$hm4@@basement.replay.com%3E&fmt=raw>
19222 A spec for the group line format to display the number of
19223 agent-downloaded articles in the group.
19226 Some nntp servers never respond when posting, so there should be a
19227 timeout for all commands.
19230 When stading on a topic line and `t'-ing, point goes to the last line.
19231 It should go somewhere else.
19234 I'm having trouble accessing a newsgroup with a "+" in its name with
19235 Gnus. There is a new newsgroup on msnews.microsoft.com named
19236 "microsoft.public.multimedia.directx.html+time" that I'm trying to
19238 "nntp+msnews.microsoft.com:microsoft.public.multimedia.directx.html+time"
19239 but it gives an error that it cant access the group.
19241 Is the "+" character illegal in newsgroup names? Is there any way in
19242 Gnus to work around this? (gnus 5.6.45 - XEmacs 20.4)
19249 Subject: Answer to your mails 01.01.1999-01.05.1999
19250 --text follows this line--
19251 Sorry I killfiled you...
19253 Under the subject "foo", you wrote on 01.01.1999:
19255 Under the subject "foo1", you wrote on 01.01.1999:
19260 Allow "orphan" scores in the Agent scoring.
19264 - Edit article's summary line.
19266 - Sort lines in buffer by subject
19268 --> the old subject line appears in Summary buffer, not the one that was
19273 Solve the halting problem.
19282 @section The Manual
19286 This manual was generated from a TeXinfo file and then run through
19287 either @code{texi2dvi}
19289 or my own home-brewed TeXinfo to \LaTeX\ transformer,
19290 and then run through @code{latex} and @code{dvips}
19292 to get what you hold in your hands now.
19294 The following conventions have been used:
19299 This is a @samp{string}
19302 This is a @kbd{keystroke}
19305 This is a @file{file}
19308 This is a @code{symbol}
19312 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
19316 (setq flargnoze "yes")
19319 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
19322 (setq flumphel 'yes)
19325 @samp{yes} and @code{yes} are two @emph{very} different things---don't
19326 ever get them confused.
19330 Of course, everything in this manual is of vital interest, so you should
19331 read it all. Several times. However, if you feel like skimming the
19332 manual, look for that gnu head you should see in the margin over
19333 there---it means that what's being discussed is of more importance than
19334 the rest of the stuff. (On the other hand, if everything is infinitely
19335 important, how can anything be more important than that? Just one more
19336 of the mysteries of this world, I guess.)
19344 @section Terminology
19346 @cindex terminology
19351 This is what you are supposed to use this thing for---reading news.
19352 News is generally fetched from a nearby @sc{nntp} server, and is
19353 generally publicly available to everybody. If you post news, the entire
19354 world is likely to read just what you have written, and they'll all
19355 snigger mischievously. Behind your back.
19359 Everything that's delivered to you personally is mail. Some news/mail
19360 readers (like Gnus) blur the distinction between mail and news, but
19361 there is a difference. Mail is private. News is public. Mailing is
19362 not posting, and replying is not following up.
19366 Send a mail to the person who has written what you are reading.
19370 Post an article to the current newsgroup responding to the article you
19375 Gnus gets fed articles from a number of backends, both news and mail
19376 backends. Gnus does not handle the underlying media, so to speak---this
19377 is all done by the backends.
19381 Gnus will always use one method (and backend) as the @dfn{native}, or
19382 default, way of getting news.
19386 You can also have any number of foreign groups active at the same time.
19387 These are groups that use non-native non-secondary backends for getting
19392 Secondary backends are somewhere half-way between being native and being
19393 foreign, but they mostly act like they are native.
19397 A message that has been posted as news.
19400 @cindex mail message
19401 A message that has been mailed.
19405 A mail message or news article
19409 The top part of a message, where administrative information (etc.) is
19414 The rest of an article. Everything not in the head is in the
19419 A line from the head of an article.
19423 A collection of such lines, or a collection of heads. Or even a
19424 collection of @sc{nov} lines.
19428 When Gnus enters a group, it asks the backend for the headers of all
19429 unread articles in the group. Most servers support the News OverView
19430 format, which is more compact and much faster to read and parse than the
19431 normal @sc{head} format.
19435 Each group is subscribed at some @dfn{level} or other (1-9). The ones
19436 that have a lower level are ``more'' subscribed than the groups with a
19437 higher level. In fact, groups on levels 1-5 are considered
19438 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
19439 are @dfn{killed}. Commands for listing groups and scanning for new
19440 articles will all use the numeric prefix as @dfn{working level}.
19442 @item killed groups
19443 @cindex killed groups
19444 No information on killed groups is stored or updated, which makes killed
19445 groups much easier to handle than subscribed groups.
19447 @item zombie groups
19448 @cindex zombie groups
19449 Just like killed groups, only slightly less dead.
19452 @cindex active file
19453 The news server has to keep track of what articles it carries, and what
19454 groups exist. All this information in stored in the active file, which
19455 is rather large, as you might surmise.
19458 @cindex bogus groups
19459 A group that exists in the @file{.newsrc} file, but isn't known to the
19460 server (i.e., it isn't in the active file), is a @emph{bogus group}.
19461 This means that the group probably doesn't exist (any more).
19464 @cindex activating groups
19465 The act of asking the server for info on a group and computing the
19466 number of unread articles is called @dfn{activating the group}.
19467 Un-activated groups are listed with @samp{*} in the group buffer.
19471 A machine one can connect to and get news (or mail) from.
19473 @item select method
19474 @cindex select method
19475 A structure that specifies the backend, the server and the virtual
19478 @item virtual server
19479 @cindex virtual server
19480 A named select method. Since a select method defines all there is to
19481 know about connecting to a (physical) server, taking the thing as a
19482 whole is a virtual server.
19486 Taking a buffer and running it through a filter of some sort. The
19487 result will (more often than not) be cleaner and more pleasing than the
19490 @item ephemeral groups
19491 @cindex ephemeral groups
19492 Most groups store data on what articles you have read. @dfn{Ephemeral}
19493 groups are groups that will have no data stored---when you exit the
19494 group, it'll disappear into the aether.
19497 @cindex solid groups
19498 This is the opposite of ephemeral groups. All groups listed in the
19499 group buffer are solid groups.
19501 @item sparse articles
19502 @cindex sparse articles
19503 These are article placeholders shown in the summary buffer when
19504 @code{gnus-build-sparse-threads} has been switched on.
19508 To put responses to articles directly after the articles they respond
19509 to---in a hierarchical fashion.
19513 @cindex thread root
19514 The first article in a thread is the root. It is the ancestor of all
19515 articles in the thread.
19519 An article that has responses.
19523 An article that responds to a different article---its parent.
19527 A collection of messages in one file. The most common digest format is
19528 specified by RFC1153.
19534 @node Customization
19535 @section Customization
19536 @cindex general customization
19538 All variables are properly documented elsewhere in this manual. This
19539 section is designed to give general pointers on how to customize Gnus
19540 for some quite common situations.
19543 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
19544 * Slow Terminal Connection:: You run a remote Emacs.
19545 * Little Disk Space:: You feel that having large setup files is icky.
19546 * Slow Machine:: You feel like buying a faster machine.
19550 @node Slow/Expensive Connection
19551 @subsection Slow/Expensive @sc{nntp} Connection
19553 If you run Emacs on a machine locally, and get your news from a machine
19554 over some very thin strings, you want to cut down on the amount of data
19555 Gnus has to get from the @sc{nntp} server.
19559 @item gnus-read-active-file
19560 Set this to @code{nil}, which will inhibit Gnus from requesting the
19561 entire active file from the server. This file is often v. large. You
19562 also have to set @code{gnus-check-new-newsgroups} and
19563 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
19564 doesn't suddenly decide to fetch the active file anyway.
19566 @item gnus-nov-is-evil
19567 This one has to be @code{nil}. If not, grabbing article headers from
19568 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
19569 support @sc{xover}; Gnus will detect this by itself.
19573 @node Slow Terminal Connection
19574 @subsection Slow Terminal Connection
19576 Let's say you use your home computer for dialing up the system that runs
19577 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
19578 possible) the amount of data sent over the wires.
19582 @item gnus-auto-center-summary
19583 Set this to @code{nil} to inhibit Gnus from re-centering the summary
19584 buffer all the time. If it is @code{vertical}, do only vertical
19585 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
19586 horizontal and vertical recentering.
19588 @item gnus-visible-headers
19589 Cut down on the headers included in the articles to the
19590 minimum. You can, in fact, make do without them altogether---most of the
19591 useful data is in the summary buffer, anyway. Set this variable to
19592 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
19594 Set this hook to all the available hiding commands:
19596 (setq gnus-treat-hide-headers 'head
19597 gnus-treat-hide-signature t
19598 gnus-treat-hide-citation t)
19601 @item gnus-use-full-window
19602 By setting this to @code{nil}, you can make all the windows smaller.
19603 While this doesn't really cut down much generally, it means that you
19604 have to see smaller portions of articles before deciding that you didn't
19605 want to read them anyway.
19607 @item gnus-thread-hide-subtree
19608 If this is non-@code{nil}, all threads in the summary buffer will be
19611 @item gnus-updated-mode-lines
19612 If this is @code{nil}, Gnus will not put information in the buffer mode
19613 lines, which might save some time.
19617 @node Little Disk Space
19618 @subsection Little Disk Space
19621 The startup files can get rather large, so you may want to cut their
19622 sizes a bit if you are running out of space.
19626 @item gnus-save-newsrc-file
19627 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
19628 only save @file{.newsrc.eld}. This means that you will not be able to
19629 use any other newsreaders than Gnus. This variable is @code{t} by
19632 @item gnus-read-newsrc-file
19633 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
19634 only read @file{.newsrc.eld}. This means that you will not be able to
19635 use any other newsreaders than Gnus. This variable is @code{t} by
19638 @item gnus-save-killed-list
19639 If this is @code{nil}, Gnus will not save the list of dead groups. You
19640 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
19641 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
19642 variable to @code{nil}. This variable is @code{t} by default.
19648 @subsection Slow Machine
19649 @cindex slow machine
19651 If you have a slow machine, or are just really impatient, there are a
19652 few things you can do to make Gnus run faster.
19654 Set @code{gnus-check-new-newsgroups} and
19655 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
19657 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
19658 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
19659 summary buffer faster.
19663 @node Troubleshooting
19664 @section Troubleshooting
19665 @cindex troubleshooting
19667 Gnus works @emph{so} well straight out of the box---I can't imagine any
19675 Make sure your computer is switched on.
19678 Make sure that you really load the current Gnus version. If you have
19679 been running @sc{gnus}, you need to exit Emacs and start it up again before
19683 Try doing an @kbd{M-x gnus-version}. If you get something that looks
19684 like @samp{T-gnus 6.13.* (based on Pterodactyl Gnus v0.*; for SEMI 1.1*,
19685 FLIM 1.1*)} you have the right files loaded. If, on the other hand, you
19686 get something like @samp{NNTP 3.x} or @samp{nntp flee}, you have some
19687 old @file{.el} files lying around. Delete these.
19690 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
19694 @vindex max-lisp-eval-depth
19695 Gnus works on many recursive structures, and in some extreme (and very
19696 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
19697 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
19698 something like that.
19701 If all else fails, report the problem as a bug.
19704 @cindex reporting bugs
19706 @kindex M-x gnus-bug
19708 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
19709 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
19710 me the backtrace. I will fix bugs, but I can only fix them if you send
19711 me a precise description as to how to reproduce the bug.
19713 You really can never be too detailed in a bug report. Always use the
19714 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
19715 a 10Kb mail each time you use it, and even if you have sent me your
19716 environment 500 times before. I don't care. I want the full info each
19719 It is also important to remember that I have no memory whatsoever. If
19720 you send a bug report, and I send you a reply, and then you just send
19721 back ``No, it's not! Moron!'', I will have no idea what you are
19722 insulting me about. Always over-explain everything. It's much easier
19723 for all of us---if I don't have all the information I need, I will just
19724 mail you and ask for more info, and everything takes more time.
19726 If the problem you're seeing is very visual, and you can't quite explain
19727 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
19728 it somewhere it can be reached, and include the URL of the picture in
19731 If you just need help, you are better off asking on
19732 @samp{gnu.emacs.gnus}. I'm not very helpful.
19734 @cindex gnu.emacs.gnus
19735 @cindex ding mailing list
19736 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
19737 Write to @samp{ding-request@@gnus.org} to subscribe.
19741 @node Gnus Reference Guide
19742 @section Gnus Reference Guide
19744 It is my hope that other people will figure out smart stuff that Gnus
19745 can do, and that other people will write those smart things as well. To
19746 facilitate that I thought it would be a good idea to describe the inner
19747 workings of Gnus. And some of the not-so-inner workings, while I'm at
19750 You can never expect the internals of a program not to change, but I
19751 will be defining (in some details) the interface between Gnus and its
19752 backends (this is written in stone), the format of the score files
19753 (ditto), data structures (some are less likely to change than others)
19754 and general methods of operation.
19757 * Gnus Utility Functions:: Common functions and variable to use.
19758 * Backend Interface:: How Gnus communicates with the servers.
19759 * Score File Syntax:: A BNF definition of the score file standard.
19760 * Headers:: How Gnus stores headers internally.
19761 * Ranges:: A handy format for storing mucho numbers.
19762 * Group Info:: The group info format.
19763 * Extended Interactive:: Symbolic prefixes and stuff.
19764 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
19765 * Various File Formats:: Formats of files that Gnus use.
19769 @node Gnus Utility Functions
19770 @subsection Gnus Utility Functions
19771 @cindex Gnus utility functions
19772 @cindex utility functions
19774 @cindex internal variables
19776 When writing small functions to be run from hooks (and stuff), it's
19777 vital to have access to the Gnus internal functions and variables.
19778 Below is a list of the most common ones.
19782 @item gnus-newsgroup-name
19783 @vindex gnus-newsgroup-name
19784 This variable holds the name of the current newsgroup.
19786 @item gnus-find-method-for-group
19787 @findex gnus-find-method-for-group
19788 A function that returns the select method for @var{group}.
19790 @item gnus-group-real-name
19791 @findex gnus-group-real-name
19792 Takes a full (prefixed) Gnus group name, and returns the unprefixed
19795 @item gnus-group-prefixed-name
19796 @findex gnus-group-prefixed-name
19797 Takes an unprefixed group name and a select method, and returns the full
19798 (prefixed) Gnus group name.
19800 @item gnus-get-info
19801 @findex gnus-get-info
19802 Returns the group info list for @var{group}.
19804 @item gnus-group-unread
19805 @findex gnus-group-unread
19806 The number of unread articles in @var{group}, or @code{t} if that is
19810 @findex gnus-active
19811 The active entry for @var{group}.
19813 @item gnus-set-active
19814 @findex gnus-set-active
19815 Set the active entry for @var{group}.
19817 @item gnus-add-current-to-buffer-list
19818 @findex gnus-add-current-to-buffer-list
19819 Adds the current buffer to the list of buffers to be killed on Gnus
19822 @item gnus-continuum-version
19823 @findex gnus-continuum-version
19824 Takes a Gnus version string as a parameter and returns a floating point
19825 number. Earlier versions will always get a lower number than later
19828 @item gnus-group-read-only-p
19829 @findex gnus-group-read-only-p
19830 Says whether @var{group} is read-only or not.
19832 @item gnus-news-group-p
19833 @findex gnus-news-group-p
19834 Says whether @var{group} came from a news backend.
19836 @item gnus-ephemeral-group-p
19837 @findex gnus-ephemeral-group-p
19838 Says whether @var{group} is ephemeral or not.
19840 @item gnus-server-to-method
19841 @findex gnus-server-to-method
19842 Returns the select method corresponding to @var{server}.
19844 @item gnus-server-equal
19845 @findex gnus-server-equal
19846 Says whether two virtual servers are equal.
19848 @item gnus-group-native-p
19849 @findex gnus-group-native-p
19850 Says whether @var{group} is native or not.
19852 @item gnus-group-secondary-p
19853 @findex gnus-group-secondary-p
19854 Says whether @var{group} is secondary or not.
19856 @item gnus-group-foreign-p
19857 @findex gnus-group-foreign-p
19858 Says whether @var{group} is foreign or not.
19860 @item group-group-find-parameter
19861 @findex group-group-find-parameter
19862 Returns the parameter list of @var{group}. If given a second parameter,
19863 returns the value of that parameter for @var{group}.
19865 @item gnus-group-set-parameter
19866 @findex gnus-group-set-parameter
19867 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
19869 @item gnus-narrow-to-body
19870 @findex gnus-narrow-to-body
19871 Narrows the current buffer to the body of the article.
19873 @item gnus-check-backend-function
19874 @findex gnus-check-backend-function
19875 Takes two parameters, @var{function} and @var{group}. If the backend
19876 @var{group} comes from supports @var{function}, return non-@code{nil}.
19879 (gnus-check-backend-function "request-scan" "nnml:misc")
19883 @item gnus-read-method
19884 @findex gnus-read-method
19885 Prompts the user for a select method.
19890 @node Backend Interface
19891 @subsection Backend Interface
19893 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
19894 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
19895 server is a @dfn{backend} and some @dfn{backend variables}. As examples
19896 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
19897 examples of the latter we have @code{nntp-port-number} and
19898 @code{nnmbox-directory}.
19900 When Gnus asks for information from a backend---say @code{nntp}---on
19901 something, it will normally include a virtual server name in the
19902 function parameters. (If not, the backend should use the ``current''
19903 virtual server.) For instance, @code{nntp-request-list} takes a virtual
19904 server as its only (optional) parameter. If this virtual server hasn't
19905 been opened, the function should fail.
19907 Note that a virtual server name has no relation to some physical server
19908 name. Take this example:
19912 (nntp-address "ifi.uio.no")
19913 (nntp-port-number 4324))
19916 Here the virtual server name is @samp{odd-one} while the name of
19917 the physical server is @samp{ifi.uio.no}.
19919 The backends should be able to switch between several virtual servers.
19920 The standard backends implement this by keeping an alist of virtual
19921 server environments that they pull down/push up when needed.
19923 There are two groups of interface functions: @dfn{required functions},
19924 which must be present, and @dfn{optional functions}, which Gnus will
19925 always check for presence before attempting to call 'em.
19927 All these functions are expected to return data in the buffer
19928 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
19929 unfortunately named, but we'll have to live with it. When I talk about
19930 @dfn{resulting data}, I always refer to the data in that buffer. When I
19931 talk about @dfn{return value}, I talk about the function value returned by
19932 the function call. Functions that fail should return @code{nil} as the
19935 Some backends could be said to be @dfn{server-forming} backends, and
19936 some might be said not to be. The latter are backends that generally
19937 only operate on one group at a time, and have no concept of ``server''
19938 -- they have a group, and they deliver info on that group and nothing
19941 In the examples and definitions I will refer to the imaginary backend
19944 @cindex @code{nnchoke}
19947 * Required Backend Functions:: Functions that must be implemented.
19948 * Optional Backend Functions:: Functions that need not be implemented.
19949 * Error Messaging:: How to get messages and report errors.
19950 * Writing New Backends:: Extending old backends.
19951 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
19952 * Mail-like Backends:: Some tips on mail backends.
19956 @node Required Backend Functions
19957 @subsubsection Required Backend Functions
19961 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
19963 @var{articles} is either a range of article numbers or a list of
19964 @code{Message-ID}s. Current backends do not fully support either---only
19965 sequences (lists) of article numbers, and most backends do not support
19966 retrieval of @code{Message-ID}s. But they should try for both.
19968 The result data should either be HEADs or NOV lines, and the result
19969 value should either be @code{headers} or @code{nov} to reflect this.
19970 This might later be expanded to @code{various}, which will be a mixture
19971 of HEADs and NOV lines, but this is currently not supported by Gnus.
19973 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
19974 headers", in some meaning of the word. This is generally done by
19975 fetching (at most) @var{fetch-old} extra headers less than the smallest
19976 article number in @code{articles}, and filling the gaps as well. The
19977 presence of this parameter can be ignored if the backend finds it
19978 cumbersome to follow the request. If this is non-@code{nil} and not a
19979 number, do maximum fetches.
19981 Here's an example HEAD:
19984 221 1056 Article retrieved.
19985 Path: ifi.uio.no!sturles
19986 From: sturles@@ifi.uio.no (Sturle Sunde)
19987 Newsgroups: ifi.discussion
19988 Subject: Re: Something very droll
19989 Date: 27 Oct 1994 14:02:57 +0100
19990 Organization: Dept. of Informatics, University of Oslo, Norway
19992 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
19993 References: <38jdmq$4qu@@visbur.ifi.uio.no>
19994 NNTP-Posting-Host: holmenkollen.ifi.uio.no
19998 So a @code{headers} return value would imply that there's a number of
19999 these in the data buffer.
20001 Here's a BNF definition of such a buffer:
20005 head = error / valid-head
20006 error-message = [ "4" / "5" ] 2number " " <error message> eol
20007 valid-head = valid-message *header "." eol
20008 valid-message = "221 " <number> " Article retrieved." eol
20009 header = <text> eol
20012 If the return value is @code{nov}, the data buffer should contain
20013 @dfn{network overview database} lines. These are basically fields
20017 nov-buffer = *nov-line
20018 nov-line = 8*9 [ field <TAB> ] eol
20019 field = <text except TAB>
20022 For a closer look at what should be in those fields,
20026 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
20028 @var{server} is here the virtual server name. @var{definitions} is a
20029 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
20031 If the server can't be opened, no error should be signaled. The backend
20032 may then choose to refuse further attempts at connecting to this
20033 server. In fact, it should do so.
20035 If the server is opened already, this function should return a
20036 non-@code{nil} value. There should be no data returned.
20039 @item (nnchoke-close-server &optional SERVER)
20041 Close connection to @var{server} and free all resources connected
20042 to it. Return @code{nil} if the server couldn't be closed for some
20045 There should be no data returned.
20048 @item (nnchoke-request-close)
20050 Close connection to all servers and free all resources that the backend
20051 have reserved. All buffers that have been created by that backend
20052 should be killed. (Not the @code{nntp-server-buffer}, though.) This
20053 function is generally only called when Gnus is shutting down.
20055 There should be no data returned.
20058 @item (nnchoke-server-opened &optional SERVER)
20060 If @var{server} is the current virtual server, and the connection to the
20061 physical server is alive, then this function should return a
20062 non-@code{nil} vlue. This function should under no circumstances
20063 attempt to reconnect to a server we have lost connection to.
20065 There should be no data returned.
20068 @item (nnchoke-status-message &optional SERVER)
20070 This function should return the last error message from @var{server}.
20072 There should be no data returned.
20075 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
20077 The result data from this function should be the article specified by
20078 @var{article}. This might either be a @code{Message-ID} or a number.
20079 It is optional whether to implement retrieval by @code{Message-ID}, but
20080 it would be nice if that were possible.
20082 If @var{to-buffer} is non-@code{nil}, the result data should be returned
20083 in this buffer instead of the normal data buffer. This is to make it
20084 possible to avoid copying large amounts of data from one buffer to
20085 another, while Gnus mainly requests articles to be inserted directly
20086 into its article buffer.
20088 If it is at all possible, this function should return a cons cell where
20089 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
20090 the article number. This will enable Gnus to find out what the real
20091 group and article numbers are when fetching articles by
20092 @code{Message-ID}. If this isn't possible, @code{t} should be returned
20093 on successful article retrieval.
20096 @item (nnchoke-request-group GROUP &optional SERVER FAST)
20098 Get data on @var{group}. This function also has the side effect of
20099 making @var{group} the current group.
20101 If @var{FAST}, don't bother to return useful data, just make @var{group}
20104 Here's an example of some result data and a definition of the same:
20107 211 56 1000 1059 ifi.discussion
20110 The first number is the status, which should be 211. Next is the
20111 total number of articles in the group, the lowest article number, the
20112 highest article number, and finally the group name. Note that the total
20113 number of articles may be less than one might think while just
20114 considering the highest and lowest article numbers, but some articles
20115 may have been canceled. Gnus just discards the total-number, so
20116 whether one should take the bother to generate it properly (if that is a
20117 problem) is left as an exercise to the reader.
20120 group-status = [ error / info ] eol
20121 error = [ "4" / "5" ] 2<number> " " <Error message>
20122 info = "211 " 3* [ <number> " " ] <string>
20126 @item (nnchoke-close-group GROUP &optional SERVER)
20128 Close @var{group} and free any resources connected to it. This will be
20129 a no-op on most backends.
20131 There should be no data returned.
20134 @item (nnchoke-request-list &optional SERVER)
20136 Return a list of all groups available on @var{server}. And that means
20139 Here's an example from a server that only carries two groups:
20142 ifi.test 0000002200 0000002000 y
20143 ifi.discussion 3324 3300 n
20146 On each line we have a group name, then the highest article number in
20147 that group, the lowest article number, and finally a flag.
20150 active-file = *active-line
20151 active-line = name " " <number> " " <number> " " flags eol
20153 flags = "n" / "y" / "m" / "x" / "j" / "=" name
20156 The flag says whether the group is read-only (@samp{n}), is moderated
20157 (@samp{m}), is dead (@samp{x}), is aliased to some other group
20158 (@samp{=other-group}) or none of the above (@samp{y}).
20161 @item (nnchoke-request-post &optional SERVER)
20163 This function should post the current buffer. It might return whether
20164 the posting was successful or not, but that's not required. If, for
20165 instance, the posting is done asynchronously, it has generally not been
20166 completed by the time this function concludes. In that case, this
20167 function should set up some kind of sentinel to beep the user loud and
20168 clear if the posting could not be completed.
20170 There should be no result data from this function.
20175 @node Optional Backend Functions
20176 @subsubsection Optional Backend Functions
20180 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
20182 @var{groups} is a list of groups, and this function should request data
20183 on all those groups. How it does it is of no concern to Gnus, but it
20184 should attempt to do this in a speedy fashion.
20186 The return value of this function can be either @code{active} or
20187 @code{group}, which says what the format of the result data is. The
20188 former is in the same format as the data from
20189 @code{nnchoke-request-list}, while the latter is a buffer full of lines
20190 in the same format as @code{nnchoke-request-group} gives.
20193 group-buffer = *active-line / *group-status
20197 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
20199 A Gnus group info (@pxref{Group Info}) is handed to the backend for
20200 alterations. This comes in handy if the backend really carries all the
20201 information (as is the case with virtual and imap groups). This
20202 function should destructively alter the info to suit its needs, and
20203 should return the (altered) group info.
20205 There should be no result data from this function.
20208 @item (nnchoke-request-type GROUP &optional ARTICLE)
20210 When the user issues commands for ``sending news'' (@kbd{F} in the
20211 summary buffer, for instance), Gnus has to know whether the article the
20212 user is following up on is news or mail. This function should return
20213 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
20214 is mail and @code{unknown} if the type can't be decided. (The
20215 @var{article} parameter is necessary in @code{nnvirtual} groups which
20216 might very well combine mail groups and news groups.) Both @var{group}
20217 and @var{article} may be @code{nil}.
20219 There should be no result data from this function.
20222 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
20224 Set/remove/add marks on articles. Normally Gnus handles the article
20225 marks (such as read, ticked, expired etc) internally, and store them in
20226 @code{~/.newsrc.eld}. Some backends (such as IMAP) however carry all
20227 information about the articles on the server, so Gnus need to propagate
20228 the mark information to the server.
20230 ACTION is a list of mark setting requests, having this format:
20233 (RANGE ACTION MARK)
20236 Range is a range of articles you wish to update marks on. Action is
20237 @code{set}, @code{add} or @code{del}, respectively used for removing all
20238 existing marks and setting them as specified, adding (preserving the
20239 marks not mentioned) mark and removing (preserving the marks not
20240 mentioned) marks. Mark is a list of marks; where each mark is a
20241 symbol. Currently used marks are @code{read}, @code{tick}, @code{reply},
20242 @code{expire}, @code{killed}, @code{dormant}, @code{save},
20243 @code{download} and @code{unsend}, but your backend should, if possible,
20244 not limit itself to theese.
20246 Given contradictory actions, the last action in the list should be the
20247 effective one. That is, if your action contains a request to add the
20248 @code{tick} mark on article 1 and, later in the list, a request to
20249 remove the mark on the same article, the mark should in fact be removed.
20251 An example action list:
20254 (((5 12 30) 'del '(tick))
20255 ((10 . 90) 'add '(read expire))
20256 ((92 94) 'del '(read)))
20259 The function should return a range of articles it wasn't able to set the
20260 mark on (currently not used for anything).
20262 There should be no result data from this function.
20264 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
20266 If the user tries to set a mark that the backend doesn't like, this
20267 function may change the mark. Gnus will use whatever this function
20268 returns as the mark for @var{article} instead of the original
20269 @var{mark}. If the backend doesn't care, it must return the original
20270 @var{mark}, and not @code{nil} or any other type of garbage.
20272 The only use for this I can see is what @code{nnvirtual} does with
20273 it---if a component group is auto-expirable, marking an article as read
20274 in the virtual group should result in the article being marked as
20277 There should be no result data from this function.
20280 @item (nnchoke-request-scan &optional GROUP SERVER)
20282 This function may be called at any time (by Gnus or anything else) to
20283 request that the backend check for incoming articles, in one way or
20284 another. A mail backend will typically read the spool file or query the
20285 POP server when this function is invoked. The @var{group} doesn't have
20286 to be heeded---if the backend decides that it is too much work just
20287 scanning for a single group, it may do a total scan of all groups. It
20288 would be nice, however, to keep things local if that's practical.
20290 There should be no result data from this function.
20293 @item (nnchoke-request-group-description GROUP &optional SERVER)
20295 The result data from this function should be a description of
20299 description-line = name <TAB> description eol
20301 description = <text>
20304 @item (nnchoke-request-list-newsgroups &optional SERVER)
20306 The result data from this function should be the description of all
20307 groups available on the server.
20310 description-buffer = *description-line
20314 @item (nnchoke-request-newgroups DATE &optional SERVER)
20316 The result data from this function should be all groups that were
20317 created after @samp{date}, which is in normal human-readable date
20318 format. The data should be in the active buffer format.
20321 @item (nnchoke-request-create-group GROUP &optional SERVER)
20323 This function should create an empty group with name @var{group}.
20325 There should be no return data.
20328 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
20330 This function should run the expiry process on all articles in the
20331 @var{articles} range (which is currently a simple list of article
20332 numbers.) It is left up to the backend to decide how old articles
20333 should be before they are removed by this function. If @var{force} is
20334 non-@code{nil}, all @var{articles} should be deleted, no matter how new
20337 This function should return a list of articles that it did not/was not
20340 There should be no result data returned.
20343 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
20346 This function should move @var{article} (which is a number) from
20347 @var{group} by calling @var{accept-form}.
20349 This function should ready the article in question for moving by
20350 removing any header lines it has added to the article, and generally
20351 should ``tidy up'' the article. Then it should @code{eval}
20352 @var{accept-form} in the buffer where the ``tidy'' article is. This
20353 will do the actual copying. If this @code{eval} returns a
20354 non-@code{nil} value, the article should be removed.
20356 If @var{last} is @code{nil}, that means that there is a high likelihood
20357 that there will be more requests issued shortly, so that allows some
20360 The function should return a cons where the @code{car} is the group name and
20361 the @code{cdr} is the article number that the article was entered as.
20363 There should be no data returned.
20366 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
20368 This function takes the current buffer and inserts it into @var{group}.
20369 If @var{last} in @code{nil}, that means that there will be more calls to
20370 this function in short order.
20372 The function should return a cons where the @code{car} is the group name and
20373 the @code{cdr} is the article number that the article was entered as.
20375 There should be no data returned.
20378 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
20380 This function should remove @var{article} (which is a number) from
20381 @var{group} and insert @var{buffer} there instead.
20383 There should be no data returned.
20386 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
20388 This function should delete @var{group}. If @var{force}, it should
20389 really delete all the articles in the group, and then delete the group
20390 itself. (If there is such a thing as ``the group itself''.)
20392 There should be no data returned.
20395 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
20397 This function should rename @var{group} into @var{new-name}. All
20398 articles in @var{group} should move to @var{new-name}.
20400 There should be no data returned.
20405 @node Error Messaging
20406 @subsubsection Error Messaging
20408 @findex nnheader-report
20409 @findex nnheader-get-report
20410 The backends should use the function @code{nnheader-report} to report
20411 error conditions---they should not raise errors when they aren't able to
20412 perform a request. The first argument to this function is the backend
20413 symbol, and the rest are interpreted as arguments to @code{format} if
20414 there are multiple of them, or just a string if there is one of them.
20415 This function must always returns @code{nil}.
20418 (nnheader-report 'nnchoke "You did something totally bogus")
20420 (nnheader-report 'nnchoke "Could not request group %s" group)
20423 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
20424 @code{nil} back from a server, and this function returns the most
20425 recently reported message for the backend in question. This function
20426 takes one argument---the server symbol.
20428 Internally, these functions access @var{backend}@code{-status-string},
20429 so the @code{nnchoke} backend will have its error message stored in
20430 @code{nnchoke-status-string}.
20433 @node Writing New Backends
20434 @subsubsection Writing New Backends
20436 Many backends are quite similar. @code{nnml} is just like
20437 @code{nnspool}, but it allows you to edit the articles on the server.
20438 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
20439 and it doesn't maintain overview databases. @code{nndir} is just like
20440 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
20443 It would make sense if it were possible to ``inherit'' functions from
20444 backends when writing new backends. And, indeed, you can do that if you
20445 want to. (You don't have to if you don't want to, of course.)
20447 All the backends declare their public variables and functions by using a
20448 package called @code{nnoo}.
20450 To inherit functions from other backends (and allow other backends to
20451 inherit functions from the current backend), you should use the
20457 This macro declares the first parameter to be a child of the subsequent
20458 parameters. For instance:
20461 (nnoo-declare nndir
20465 @code{nndir} has declared here that it intends to inherit functions from
20466 both @code{nnml} and @code{nnmh}.
20469 This macro is equivalent to @code{defvar}, but registers the variable as
20470 a public server variable. Most state-oriented variables should be
20471 declared with @code{defvoo} instead of @code{defvar}.
20473 In addition to the normal @code{defvar} parameters, it takes a list of
20474 variables in the parent backends to map the variable to when executing
20475 a function in those backends.
20478 (defvoo nndir-directory nil
20479 "Where nndir will look for groups."
20480 nnml-current-directory nnmh-current-directory)
20483 This means that @code{nnml-current-directory} will be set to
20484 @code{nndir-directory} when an @code{nnml} function is called on behalf
20485 of @code{nndir}. (The same with @code{nnmh}.)
20487 @item nnoo-define-basics
20488 This macro defines some common functions that almost all backends should
20492 (nnoo-define-basics nndir)
20496 This macro is just like @code{defun} and takes the same parameters. In
20497 addition to doing the normal @code{defun} things, it registers the
20498 function as being public so that other backends can inherit it.
20500 @item nnoo-map-functions
20501 This macro allows mapping of functions from the current backend to
20502 functions from the parent backends.
20505 (nnoo-map-functions nndir
20506 (nnml-retrieve-headers 0 nndir-current-group 0 0)
20507 (nnmh-request-article 0 nndir-current-group 0 0))
20510 This means that when @code{nndir-retrieve-headers} is called, the first,
20511 third, and fourth parameters will be passed on to
20512 @code{nnml-retrieve-headers}, while the second parameter is set to the
20513 value of @code{nndir-current-group}.
20516 This macro allows importing functions from backends. It should be the
20517 last thing in the source file, since it will only define functions that
20518 haven't already been defined.
20524 nnmh-request-newgroups)
20528 This means that calls to @code{nndir-request-list} should just be passed
20529 on to @code{nnmh-request-list}, while all public functions from
20530 @code{nnml} that haven't been defined in @code{nndir} yet should be
20535 Below is a slightly shortened version of the @code{nndir} backend.
20538 ;;; nndir.el --- single directory newsgroup access for Gnus
20539 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
20543 (require 'nnheader)
20547 (eval-when-compile (require 'cl))
20549 (nnoo-declare nndir
20552 (defvoo nndir-directory nil
20553 "Where nndir will look for groups."
20554 nnml-current-directory nnmh-current-directory)
20556 (defvoo nndir-nov-is-evil nil
20557 "*Non-nil means that nndir will never retrieve NOV headers."
20560 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
20561 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
20562 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
20564 (defvoo nndir-status-string "" nil nnmh-status-string)
20565 (defconst nndir-version "nndir 1.0")
20567 ;;; Interface functions.
20569 (nnoo-define-basics nndir)
20571 (deffoo nndir-open-server (server &optional defs)
20572 (setq nndir-directory
20573 (or (cadr (assq 'nndir-directory defs))
20575 (unless (assq 'nndir-directory defs)
20576 (push `(nndir-directory ,server) defs))
20577 (push `(nndir-current-group
20578 ,(file-name-nondirectory (directory-file-name nndir-directory)))
20580 (push `(nndir-top-directory
20581 ,(file-name-directory (directory-file-name nndir-directory)))
20583 (nnoo-change-server 'nndir server defs))
20585 (nnoo-map-functions nndir
20586 (nnml-retrieve-headers 0 nndir-current-group 0 0)
20587 (nnmh-request-article 0 nndir-current-group 0 0)
20588 (nnmh-request-group nndir-current-group 0 0)
20589 (nnmh-close-group nndir-current-group 0))
20593 nnmh-status-message
20595 nnmh-request-newgroups))
20601 @node Hooking New Backends Into Gnus
20602 @subsubsection Hooking New Backends Into Gnus
20604 @vindex gnus-valid-select-methods
20605 Having Gnus start using your new backend is rather easy---you just
20606 declare it with the @code{gnus-declare-backend} functions. This will
20607 enter the backend into the @code{gnus-valid-select-methods} variable.
20609 @code{gnus-declare-backend} takes two parameters---the backend name and
20610 an arbitrary number of @dfn{abilities}.
20615 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
20618 The abilities can be:
20622 This is a mailish backend---followups should (probably) go via mail.
20624 This is a newsish backend---followups should (probably) go via news.
20626 This backend supports both mail and news.
20628 This is neither a post nor mail backend---it's something completely
20631 It supports respooling---or rather, it is able to modify its source
20632 articles and groups.
20634 The name of the server should be in the virtual server name. This is
20635 true for almost all backends.
20636 @item prompt-address
20637 The user should be prompted for an address when doing commands like
20638 @kbd{B} in the group buffer. This is true for backends like
20639 @code{nntp}, but not @code{nnmbox}, for instance.
20643 @node Mail-like Backends
20644 @subsubsection Mail-like Backends
20646 One of the things that separate the mail backends from the rest of the
20647 backends is the heavy dependence by the mail backends on common
20648 functions in @file{nnmail.el}. For instance, here's the definition of
20649 @code{nnml-request-scan}:
20652 (deffoo nnml-request-scan (&optional group server)
20653 (setq nnml-article-file-alist nil)
20654 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
20657 It simply calls @code{nnmail-get-new-mail} with a few parameters,
20658 and @code{nnmail} takes care of all the moving and splitting of the
20661 This function takes four parameters.
20665 This should be a symbol to designate which backend is responsible for
20668 @item exit-function
20669 This function should be called after the splitting has been performed.
20671 @item temp-directory
20672 Where the temporary files should be stored.
20675 This optional argument should be a group name if the splitting is to be
20676 performed for one group only.
20679 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
20680 save each article. @var{backend}@code{-active-number} will be called to
20681 find the article number assigned to this article.
20683 The function also uses the following variables:
20684 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
20685 this backend); and @var{backend}@code{-group-alist} and
20686 @var{backend}@code{-active-file} to generate the new active file.
20687 @var{backend}@code{-group-alist} should be a group-active alist, like
20691 (("a-group" (1 . 10))
20692 ("some-group" (34 . 39)))
20696 @node Score File Syntax
20697 @subsection Score File Syntax
20699 Score files are meant to be easily parseable, but yet extremely
20700 mallable. It was decided that something that had the same read syntax
20701 as an Emacs Lisp list would fit that spec.
20703 Here's a typical score file:
20707 ("win95" -10000 nil s)
20714 BNF definition of a score file:
20717 score-file = "" / "(" *element ")"
20718 element = rule / atom
20719 rule = string-rule / number-rule / date-rule
20720 string-rule = "(" quote string-header quote space *string-match ")"
20721 number-rule = "(" quote number-header quote space *number-match ")"
20722 date-rule = "(" quote date-header quote space *date-match ")"
20724 string-header = "subject" / "from" / "references" / "message-id" /
20725 "xref" / "body" / "head" / "all" / "followup"
20726 number-header = "lines" / "chars"
20727 date-header = "date"
20728 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
20729 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
20730 score = "nil" / <integer>
20731 date = "nil" / <natural number>
20732 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
20733 "r" / "regex" / "R" / "Regex" /
20734 "e" / "exact" / "E" / "Exact" /
20735 "f" / "fuzzy" / "F" / "Fuzzy"
20736 number-match = "(" <integer> [ "" / [ space score [ "" /
20737 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
20738 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
20739 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
20740 space date [ "" / [ space date-match-t ] ] ] ] ")"
20741 date-match-t = "nil" / "at" / "before" / "after"
20742 atom = "(" [ required-atom / optional-atom ] ")"
20743 required-atom = mark / expunge / mark-and-expunge / files /
20744 exclude-files / read-only / touched
20745 optional-atom = adapt / local / eval
20746 mark = "mark" space nil-or-number
20747 nil-or-number = "nil" / <integer>
20748 expunge = "expunge" space nil-or-number
20749 mark-and-expunge = "mark-and-expunge" space nil-or-number
20750 files = "files" *[ space <string> ]
20751 exclude-files = "exclude-files" *[ space <string> ]
20752 read-only = "read-only" [ space "nil" / space "t" ]
20753 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
20754 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
20755 local = "local" *[ space "(" <string> space <form> ")" ]
20756 eval = "eval" space <form>
20757 space = *[ " " / <TAB> / <NEWLINE> ]
20760 Any unrecognized elements in a score file should be ignored, but not
20763 As you can see, white space is needed, but the type and amount of white
20764 space is irrelevant. This means that formatting of the score file is
20765 left up to the programmer---if it's simpler to just spew it all out on
20766 one looong line, then that's ok.
20768 The meaning of the various atoms are explained elsewhere in this
20769 manual (@pxref{Score File Format}).
20773 @subsection Headers
20775 Internally Gnus uses a format for storing article headers that
20776 corresponds to the @sc{nov} format in a mysterious fashion. One could
20777 almost suspect that the author looked at the @sc{nov} specification and
20778 just shamelessly @emph{stole} the entire thing, and one would be right.
20780 @dfn{Header} is a severely overloaded term. ``Header'' is used in
20781 RFC1036 to talk about lines in the head of an article (e.g.,
20782 @code{From}). It is used by many people as a synonym for
20783 ``head''---``the header and the body''. (That should be avoided, in my
20784 opinion.) And Gnus uses a format internally that it calls ``header'',
20785 which is what I'm talking about here. This is a 9-element vector,
20786 basically, with each header (ouch) having one slot.
20788 These slots are, in order: @code{number}, @code{subject}, @code{from},
20789 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
20790 @code{xref}, and @code{extra}. There are macros for accessing and
20791 setting these slots---they all have predictable names beginning with
20792 @code{mail-header-} and @code{mail-header-set-}, respectively.
20794 All these slots contain strings, except the @code{extra} slot, which
20795 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
20801 @sc{gnus} introduced a concept that I found so useful that I've started
20802 using it a lot and have elaborated on it greatly.
20804 The question is simple: If you have a large amount of objects that are
20805 identified by numbers (say, articles, to take a @emph{wild} example)
20806 that you want to qualify as being ``included'', a normal sequence isn't
20807 very useful. (A 200,000 length sequence is a bit long-winded.)
20809 The solution is as simple as the question: You just collapse the
20813 (1 2 3 4 5 6 10 11 12)
20816 is transformed into
20819 ((1 . 6) (10 . 12))
20822 To avoid having those nasty @samp{(13 . 13)} elements to denote a
20823 lonesome object, a @samp{13} is a valid element:
20826 ((1 . 6) 7 (10 . 12))
20829 This means that comparing two ranges to find out whether they are equal
20830 is slightly tricky:
20833 ((1 . 5) 7 8 (10 . 12))
20839 ((1 . 5) (7 . 8) (10 . 12))
20842 are equal. In fact, any non-descending list is a range:
20848 is a perfectly valid range, although a pretty long-winded one. This is
20855 and is equal to the previous range.
20857 Here's a BNF definition of ranges. Of course, one must remember the
20858 semantic requirement that the numbers are non-descending. (Any number
20859 of repetition of the same number is allowed, but apt to disappear in
20863 range = simple-range / normal-range
20864 simple-range = "(" number " . " number ")"
20865 normal-range = "(" start-contents ")"
20866 contents = "" / simple-range *[ " " contents ] /
20867 number *[ " " contents ]
20870 Gnus currently uses ranges to keep track of read articles and article
20871 marks. I plan on implementing a number of range operators in C if The
20872 Powers That Be are willing to let me. (I haven't asked yet, because I
20873 need to do some more thinking on what operators I need to make life
20874 totally range-based without ever having to convert back to normal
20879 @subsection Group Info
20881 Gnus stores all permanent info on groups in a @dfn{group info} list.
20882 This list is from three to six elements (or more) long and exhaustively
20883 describes the group.
20885 Here are two example group infos; one is a very simple group while the
20886 second is a more complex one:
20889 ("no.group" 5 ((1 . 54324)))
20891 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
20892 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
20894 ((auto-expire . t) (to-address . "ding@@gnus.org")))
20897 The first element is the @dfn{group name}---as Gnus knows the group,
20898 anyway. The second element is the @dfn{subscription level}, which
20899 normally is a small integer. (It can also be the @dfn{rank}, which is a
20900 cons cell where the @code{car} is the level and the @code{cdr} is the
20901 score.) The third element is a list of ranges of read articles. The
20902 fourth element is a list of lists of article marks of various kinds.
20903 The fifth element is the select method (or virtual server, if you like).
20904 The sixth element is a list of @dfn{group parameters}, which is what
20905 this section is about.
20907 Any of the last three elements may be missing if they are not required.
20908 In fact, the vast majority of groups will normally only have the first
20909 three elements, which saves quite a lot of cons cells.
20911 Here's a BNF definition of the group info format:
20914 info = "(" group space ralevel space read
20915 [ "" / [ space marks-list [ "" / [ space method [ "" /
20916 space parameters ] ] ] ] ] ")"
20917 group = quote <string> quote
20918 ralevel = rank / level
20919 level = <integer in the range of 1 to inf>
20920 rank = "(" level "." score ")"
20921 score = <integer in the range of 1 to inf>
20923 marks-lists = nil / "(" *marks ")"
20924 marks = "(" <string> range ")"
20925 method = "(" <string> *elisp-forms ")"
20926 parameters = "(" *elisp-forms ")"
20929 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
20930 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
20933 If you have a Gnus info and want to access the elements, Gnus offers a
20934 series of macros for getting/setting these elements.
20937 @item gnus-info-group
20938 @itemx gnus-info-set-group
20939 @findex gnus-info-group
20940 @findex gnus-info-set-group
20941 Get/set the group name.
20943 @item gnus-info-rank
20944 @itemx gnus-info-set-rank
20945 @findex gnus-info-rank
20946 @findex gnus-info-set-rank
20947 Get/set the group rank (@pxref{Group Score}).
20949 @item gnus-info-level
20950 @itemx gnus-info-set-level
20951 @findex gnus-info-level
20952 @findex gnus-info-set-level
20953 Get/set the group level.
20955 @item gnus-info-score
20956 @itemx gnus-info-set-score
20957 @findex gnus-info-score
20958 @findex gnus-info-set-score
20959 Get/set the group score (@pxref{Group Score}).
20961 @item gnus-info-read
20962 @itemx gnus-info-set-read
20963 @findex gnus-info-read
20964 @findex gnus-info-set-read
20965 Get/set the ranges of read articles.
20967 @item gnus-info-marks
20968 @itemx gnus-info-set-marks
20969 @findex gnus-info-marks
20970 @findex gnus-info-set-marks
20971 Get/set the lists of ranges of marked articles.
20973 @item gnus-info-method
20974 @itemx gnus-info-set-method
20975 @findex gnus-info-method
20976 @findex gnus-info-set-method
20977 Get/set the group select method.
20979 @item gnus-info-params
20980 @itemx gnus-info-set-params
20981 @findex gnus-info-params
20982 @findex gnus-info-set-params
20983 Get/set the group parameters.
20986 All the getter functions take one parameter---the info list. The setter
20987 functions take two parameters---the info list and the new value.
20989 The last three elements in the group info aren't mandatory, so it may be
20990 necessary to extend the group info before setting the element. If this
20991 is necessary, you can just pass on a non-@code{nil} third parameter to
20992 the three final setter functions to have this happen automatically.
20995 @node Extended Interactive
20996 @subsection Extended Interactive
20997 @cindex interactive
20998 @findex gnus-interactive
21000 Gnus extends the standard Emacs @code{interactive} specification
21001 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
21002 Prefixes}). Here's an example of how this is used:
21005 (defun gnus-summary-increase-score (&optional score symp)
21006 (interactive (gnus-interactive "P\ny"))
21011 The best thing to do would have been to implement
21012 @code{gnus-interactive} as a macro which would have returned an
21013 @code{interactive} form, but this isn't possible since Emacs checks
21014 whether a function is interactive or not by simply doing an @code{assq}
21015 on the lambda form. So, instead we have @code{gnus-interactive}
21016 function that takes a string and returns values that are usable to
21017 @code{interactive}.
21019 This function accepts (almost) all normal @code{interactive} specs, but
21024 @vindex gnus-current-prefix-symbol
21025 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
21029 @vindex gnus-current-prefix-symbols
21030 A list of the current symbolic prefixes---the
21031 @code{gnus-current-prefix-symbol} variable.
21034 The current article number---the @code{gnus-summary-article-number}
21038 The current article header---the @code{gnus-summary-article-header}
21042 The current group name---the @code{gnus-group-group-name}
21048 @node Emacs/XEmacs Code
21049 @subsection Emacs/XEmacs Code
21053 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
21054 platforms must be the primary one. I chose Emacs. Not because I don't
21055 like XEmacs or Mule, but because it comes first alphabetically.
21057 This means that Gnus will byte-compile under Emacs with nary a warning,
21058 while XEmacs will pump out gigabytes of warnings while byte-compiling.
21059 As I use byte-compilation warnings to help me root out trivial errors in
21060 Gnus, that's very useful.
21062 I've also consistently used Emacs function interfaces, but have used
21063 Gnusey aliases for the functions. To take an example: Emacs defines a
21064 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
21065 function. I then define a function called @code{gnus-run-at-time} that
21066 takes the same parameters as the Emacs @code{run-at-time}. When running
21067 Gnus under Emacs, the former function is just an alias for the latter.
21068 However, when running under XEmacs, the former is an alias for the
21069 following function:
21072 (defun gnus-xmas-run-at-time (time repeat function &rest args)
21076 (,function ,@@args))
21080 This sort of thing has been done for bunches of functions. Gnus does
21081 not redefine any native Emacs functions while running under XEmacs---it
21082 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
21085 In the cases where the XEmacs function interface was obviously cleaner,
21086 I used it instead. For example @code{gnus-region-active-p} is an alias
21087 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
21089 Of course, I could have chosen XEmacs as my native platform and done
21090 mapping functions the other way around. But I didn't. The performance
21091 hit these indirections impose on Gnus under XEmacs should be slight.
21094 @node Various File Formats
21095 @subsection Various File Formats
21098 * Active File Format:: Information on articles and groups available.
21099 * Newsgroups File Format:: Group descriptions.
21103 @node Active File Format
21104 @subsubsection Active File Format
21106 The active file lists all groups available on the server in
21107 question. It also lists the highest and lowest current article numbers
21110 Here's an excerpt from a typical active file:
21113 soc.motss 296030 293865 y
21114 alt.binaries.pictures.fractals 3922 3913 n
21115 comp.sources.unix 1605 1593 m
21116 comp.binaries.ibm.pc 5097 5089 y
21117 no.general 1000 900 y
21120 Here's a pseudo-BNF definition of this file:
21123 active = *group-line
21124 group-line = group space high-number space low-number space flag <NEWLINE>
21125 group = <non-white-space string>
21127 high-number = <non-negative integer>
21128 low-number = <positive integer>
21129 flag = "y" / "n" / "m" / "j" / "x" / "=" group
21132 For a full description of this file, see the manual pages for
21133 @samp{innd}, in particular @samp{active(5)}.
21136 @node Newsgroups File Format
21137 @subsubsection Newsgroups File Format
21139 The newsgroups file lists groups along with their descriptions. Not all
21140 groups on the server have to be listed, and not all groups in the file
21141 have to exist on the server. The file is meant purely as information to
21144 The format is quite simple; a group name, a tab, and the description.
21145 Here's the definition:
21149 line = group tab description <NEWLINE>
21150 group = <non-white-space string>
21152 description = <string>
21157 @node Emacs for Heathens
21158 @section Emacs for Heathens
21160 Believe it or not, but some people who use Gnus haven't really used
21161 Emacs much before they embarked on their journey on the Gnus Love Boat.
21162 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
21163 region'', and ``set @code{gnus-flargblossen} to an alist where the key
21164 is a regexp that is used for matching on the group name'' are magical
21165 phrases with little or no meaning, then this appendix is for you. If
21166 you are already familiar with Emacs, just ignore this and go fondle your
21170 * Keystrokes:: Entering text and executing commands.
21171 * Emacs Lisp:: The built-in Emacs programming language.
21176 @subsection Keystrokes
21180 Q: What is an experienced Emacs user?
21183 A: A person who wishes that the terminal had pedals.
21186 Yes, when you use Emacs, you are apt to use the control key, the shift
21187 key and the meta key a lot. This is very annoying to some people
21188 (notably @code{vi}le users), and the rest of us just love the hell out
21189 of it. Just give up and submit. Emacs really does stand for
21190 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
21191 may have heard from other disreputable sources (like the Emacs author).
21193 The shift keys are normally located near your pinky fingers, and are
21194 normally used to get capital letters and stuff. You probably use it all
21195 the time. The control key is normally marked ``CTRL'' or something like
21196 that. The meta key is, funnily enough, never marked as such on any
21197 keyboard. The one I'm currently at has a key that's marked ``Alt'',
21198 which is the meta key on this keyboard. It's usually located somewhere
21199 to the left hand side of the keyboard, usually on the bottom row.
21201 Now, us Emacs people don't say ``press the meta-control-m key'',
21202 because that's just too inconvenient. We say ``press the @kbd{M-C-m}
21203 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
21204 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
21205 down the control key, and hold it down while you press @kbd{k}''.
21206 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
21207 the control key and then press @kbd{k}''. Simple, ay?
21209 This is somewhat complicated by the fact that not all keyboards have a
21210 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
21211 means ``press escape, release escape, press @kbd{k}''. That's much more
21212 work than if you have a meta key, so if that's the case, I respectfully
21213 suggest you get a real keyboard with a meta key. You can't live without
21219 @subsection Emacs Lisp
21221 Emacs is the King of Editors because it's really a Lisp interpreter.
21222 Each and every key you tap runs some Emacs Lisp code snippet, and since
21223 Emacs Lisp is an interpreted language, that means that you can configure
21224 any key to run any arbitrary code. You just, like, do it.
21226 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
21227 functions. (These are byte-compiled for speed, but it's still
21228 interpreted.) If you decide that you don't like the way Gnus does
21229 certain things, it's trivial to have it do something a different way.
21230 (Well, at least if you know how to write Lisp code.) However, that's
21231 beyond the scope of this manual, so we are simply going to talk about
21232 some common constructs that you normally use in your @file{.emacs} file
21235 If you want to set the variable @code{gnus-florgbnize} to four (4), you
21236 write the following:
21239 (setq gnus-florgbnize 4)
21242 This function (really ``special form'') @code{setq} is the one that can
21243 set a variable to some value. This is really all you need to know. Now
21244 you can go and fill your @code{.emacs} file with lots of these to change
21247 If you have put that thing in your @code{.emacs} file, it will be read
21248 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
21249 start Emacs. If you want to change the variable right away, simply say
21250 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
21251 previous ``form'', which is a simple @code{setq} statement here.
21253 Go ahead---just try it, if you're located at your Emacs. After you
21254 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
21255 is the return value of the form you @code{eval}ed.
21259 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
21263 (setq gnus-read-active-file 'some)
21266 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
21267 @samp{nntp.ifi.uio.no}'', that means:
21270 (setq gnus-nntp-server "nntp.ifi.uio.no")
21273 So be careful not to mix up strings (the latter) with symbols (the
21274 former). The manual is unambiguous, but it can be confusing.
21277 @include gnus-faq.texi