1 @c \input texinfo @c -*-texinfo-*-
4 @settitle Pterodactyl Gnus 0.95 Manual
9 @c * Gnus: (gnus). The newsreader Gnus.
14 @setchapternewpage odd
18 \documentclass[twoside,a4paper,openright,11pt]{book}
19 \usepackage[latin1]{inputenc}
20 \usepackage{pagestyle}
28 \newcommand{\gnuschaptername}{}
29 \newcommand{\gnussectionname}{}
31 \newcommand{\gnusbackslash}{/}
33 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
34 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
36 \newcommand{\gnuskindex}[1]{\index{#1}}
37 \newcommand{\gnusindex}[1]{\index{#1}}
39 \newcommand{\gnustt}[1]{{\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}}
40 \newcommand{\gnuscode}[1]{\gnustt{#1}}
41 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}''}
42 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
43 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
44 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
45 \newcommand{\gnusdfn}[1]{\textit{#1}}
46 \newcommand{\gnusi}[1]{\textit{#1}}
47 \newcommand{\gnusstrong}[1]{\textbf{#1}}
48 \newcommand{\gnusemph}[1]{\textit{#1}}
49 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
50 \newcommand{\gnussc}[1]{\textsc{#1}}
51 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
52 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
53 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
55 \newcommand{\gnusbullet}{{${\bullet}$}}
56 \newcommand{\gnusdollar}{\$}
57 \newcommand{\gnusampersand}{\&}
58 \newcommand{\gnuspercent}{\%}
59 \newcommand{\gnushash}{\#}
60 \newcommand{\gnushat}{\symbol{"5E}}
61 \newcommand{\gnusunderline}{\symbol{"5F}}
62 \newcommand{\gnusnot}{$\neg$}
63 \newcommand{\gnustilde}{\symbol{"7E}}
64 \newcommand{\gnusless}{{$<$}}
65 \newcommand{\gnusgreater}{{$>$}}
66 \newcommand{\gnusbraceleft}{{$>$}}
67 \newcommand{\gnusbraceright}{{$>$}}
69 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
70 \newcommand{\gnusinteresting}{
71 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
74 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
76 \newcommand{\gnuspagechapter}[1]{
83 \newcommand{\gnuschapter}[2]{
85 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
87 \renewcommand{\gnussectionname}{}
88 \renewcommand{\gnuschaptername}{#2}
91 \begin{picture}(500,500)(0,0)
92 \put(480,350){\makebox(0,0)[tr]{#1}}
93 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
98 \newcommand{\gnusfigure}[3]{
100 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
107 \newcommand{\gnusicon}[1]{
108 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=tmp/#1-up.ps,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=tmp/#1-up.ps,height=1cm}}}
111 \newcommand{\gnuspicon}[1]{
112 \margindex{\epsfig{figure=#1,width=2cm}}
115 \newcommand{\gnusxface}[2]{
116 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
119 \newcommand{\gnussmiley}[2]{
120 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
123 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
125 \newcommand{\gnussection}[1]{
126 \renewcommand{\gnussectionname}{#1}
130 \newenvironment{codelist}%
135 \newenvironment{kbdlist}%
141 \newenvironment{dfnlist}%
146 \newenvironment{stronglist}%
151 \newenvironment{samplist}%
156 \newenvironment{varlist}%
161 \newenvironment{emphlist}%
166 \newlength\gnusheadtextwidth
167 \setlength{\gnusheadtextwidth}{\headtextwidth}
168 \addtolength{\gnusheadtextwidth}{1cm}
170 \newpagestyle{gnuspreamble}%
175 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
179 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
188 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
190 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
195 \newpagestyle{gnusindex}%
200 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
204 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
212 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
214 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
224 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
228 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
236 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
238 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
243 \pagenumbering{roman}
244 \pagestyle{gnuspreamble}
254 %\addtolength{\oddsidemargin}{-5cm}
255 %\addtolength{\evensidemargin}{-5cm}
257 \addtolength{\textheight}{2cm}
259 \gnustitle{\gnustitlename}\\
262 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
265 \gnusauthor{by Lars Magne Ingebrigtsen}
272 \thispagestyle{empty}
274 Copyright \copyright{} 1995,96,97,98,99 Free Software Foundation, Inc.
276 Permission is granted to make and distribute verbatim copies of
277 this manual provided the copyright notice and this permission notice
278 are preserved on all copies.
280 Permission is granted to copy and distribute modified versions of this
281 manual under the conditions for verbatim copying, provided that the
282 entire resulting derived work is distributed under the terms of a
283 permission notice identical to this one.
285 Permission is granted to copy and distribute translations of this manual
286 into another language, under the above conditions for modified versions.
295 This file documents Gnus, the GNU Emacs newsreader.
297 Copyright (C) 1995,96,97,98,99 Free Software Foundation, Inc.
299 Permission is granted to make and distribute verbatim copies of
300 this manual provided the copyright notice and this permission notice
301 are preserved on all copies.
304 Permission is granted to process this file through Tex and print the
305 results, provided the printed document carries copying permission
306 notice identical to this one except for the removal of this paragraph
307 (this paragraph not being relevant to the printed manual).
310 Permission is granted to copy and distribute modified versions of this
311 manual under the conditions for verbatim copying, provided also that the
312 entire resulting derived work is distributed under the terms of a
313 permission notice identical to this one.
315 Permission is granted to copy and distribute translations of this manual
316 into another language, under the above conditions for modified versions.
322 @title Pterodactyl Gnus 0.95 Manual
324 @author by Lars Magne Ingebrigtsen
327 @vskip 0pt plus 1filll
328 Copyright @copyright{} 1995,96,97,98,99 Free Software Foundation, Inc.
330 Permission is granted to make and distribute verbatim copies of
331 this manual provided the copyright notice and this permission notice
332 are preserved on all copies.
334 Permission is granted to copy and distribute modified versions of this
335 manual under the conditions for verbatim copying, provided that the
336 entire resulting derived work is distributed under the terms of a
337 permission notice identical to this one.
339 Permission is granted to copy and distribute translations of this manual
340 into another language, under the above conditions for modified versions.
349 @top The Gnus Newsreader
353 You can read news (and mail) from within Emacs by using Gnus. The news
354 can be gotten by any nefarious means you can think of---@sc{nntp}, local
355 spool or your mbox file. All at the same time, if you want to push your
358 This manual corresponds to Pterodactyl Gnus 0.95.
369 Gnus is the advanced, self-documenting, customizable, extensible
370 unreal-time newsreader for GNU Emacs.
372 Oops. That sounds oddly familiar, so let's start over again to avoid
373 being accused of plagiarism:
375 Gnus is a message-reading laboratory. It will let you look at just
376 about anything as if it were a newsgroup. You can read mail with it,
377 you can browse directories with it, you can @code{ftp} with it---you can
378 even read news with it!
380 Gnus tries to empower people who read news the same way Emacs empowers
381 people who edit text. Gnus sets no limits to what the user should be
382 allowed to do. Users are encouraged to extend Gnus to make it behave
383 like they want it to behave. A program should not control people;
384 people should be empowered to do what they want by using (or abusing)
391 * Starting Up:: Finding news can be a pain.
392 * The Group Buffer:: Selecting, subscribing and killing groups.
393 * The Summary Buffer:: Reading, saving and posting articles.
394 * The Article Buffer:: Displaying and handling articles.
395 * Composing Messages:: Information on sending mail and news.
396 * Select Methods:: Gnus reads all messages from various select methods.
397 * Scoring:: Assigning values to articles.
398 * Various:: General purpose settings.
399 * The End:: Farewell and goodbye.
400 * Appendices:: Terminology, Emacs intro, FAQ, History, Internals.
401 * Index:: Variable, function and concept index.
402 * Key Index:: Key Index.
406 @chapter Starting Gnus
411 If your system administrator has set things up properly, starting Gnus
412 and reading news is extremely easy---you just type @kbd{M-x gnus} in
415 @findex gnus-other-frame
416 @kindex M-x gnus-other-frame
417 If you want to start Gnus in a different frame, you can use the command
418 @kbd{M-x gnus-other-frame} instead.
420 If things do not go smoothly at startup, you have to twiddle some
421 variables in your @file{~/.gnus} file. This file is similar to
422 @file{~/.emacs}, but is read when gnus starts.
424 If you puzzle at any terms used in this manual, please refer to the
425 terminology section (@pxref{Terminology}).
428 * Finding the News:: Choosing a method for getting news.
429 * The First Time:: What does Gnus do the first time you start it?
430 * The Server is Down:: How can I read my mail then?
431 * Slave Gnusae:: You can have more than one Gnus active at a time.
432 * Fetching a Group:: Starting Gnus just to read a group.
433 * New Groups:: What is Gnus supposed to do with new groups?
434 * Startup Files:: Those pesky startup files---@file{.newsrc}.
435 * Auto Save:: Recovering from a crash.
436 * The Active File:: Reading the active file over a slow line Takes Time.
437 * Changing Servers:: You may want to move from one server to another.
438 * Startup Variables:: Other variables you might change.
442 @node Finding the News
443 @section Finding the News
446 @vindex gnus-select-method
448 The @code{gnus-select-method} variable says where Gnus should look for
449 news. This variable should be a list where the first element says
450 @dfn{how} and the second element says @dfn{where}. This method is your
451 native method. All groups not fetched with this method are
454 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
455 you want to get your daily dosage of news from, you'd say:
458 (setq gnus-select-method '(nntp "news.somewhere.edu"))
461 If you want to read directly from the local spool, say:
464 (setq gnus-select-method '(nnspool ""))
467 If you can use a local spool, you probably should, as it will almost
468 certainly be much faster.
470 @vindex gnus-nntpserver-file
472 @cindex @sc{nntp} server
473 If this variable is not set, Gnus will take a look at the
474 @code{NNTPSERVER} environment variable. If that variable isn't set,
475 Gnus will see whether @code{gnus-nntpserver-file}
476 (@file{/etc/nntpserver} by default) has any opinions on the matter. If
477 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server. That's a long shot, though.
479 @vindex gnus-nntp-server
480 If @code{gnus-nntp-server} is set, this variable will override
481 @code{gnus-select-method}. You should therefore set
482 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
484 @vindex gnus-secondary-servers
485 @vindex gnus-nntp-server
486 You can also make Gnus prompt you interactively for the name of an
487 @sc{nntp} server. If you give a non-numerical prefix to @code{gnus}
488 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
489 in the @code{gnus-secondary-servers} list (if any). You can also just
490 type in the name of any server you feel like visiting. (Note that this
491 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
492 gnus} later in the same Emacs session, Gnus will contact the same
495 @findex gnus-group-browse-foreign-server
497 However, if you use one @sc{nntp} server regularly and are just
498 interested in a couple of groups from a different server, you would be
499 better served by using the @kbd{B} command in the group buffer. It will
500 let you have a look at what groups are available, and you can subscribe
501 to any of the groups you want to. This also makes @file{.newsrc}
502 maintenance much tidier. @xref{Foreign Groups}.
504 @vindex gnus-secondary-select-methods
506 A slightly different approach to foreign groups is to set the
507 @code{gnus-secondary-select-methods} variable. The select methods
508 listed in this variable are in many ways just as native as the
509 @code{gnus-select-method} server. They will also be queried for active
510 files during startup (if that's required), and new newsgroups that
511 appear on these servers will be subscribed (or not) just as native
514 For instance, if you use the @code{nnmbox} backend to read your mail, you
515 would typically set this variable to
518 (setq gnus-secondary-select-methods '((nnmbox "")))
523 @section The First Time
524 @cindex first time usage
526 If no startup files exist, Gnus will try to determine what groups should
527 be subscribed by default.
529 @vindex gnus-default-subscribed-newsgroups
530 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
531 will subscribe you to just those groups in that list, leaving the rest
532 killed. Your system administrator should have set this variable to
535 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
536 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
537 here as @dfn{whatever Lars thinks you should read}.)
539 You'll also be subscribed to the Gnus documentation group, which should
540 help you with most common problems.
542 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
543 use the normal functions for handling new groups, and not do anything
547 @node The Server is Down
548 @section The Server is Down
549 @cindex server errors
551 If the default server is down, Gnus will understandably have some
552 problems starting. However, if you have some mail groups in addition to
553 the news groups, you may want to start Gnus anyway.
555 Gnus, being the trusting sort of program, will ask whether to proceed
556 without a native select method if that server can't be contacted. This
557 will happen whether the server doesn't actually exist (i.e., you have
558 given the wrong address) or the server has just momentarily taken ill
559 for some reason or other. If you decide to continue and have no foreign
560 groups, you'll find it difficult to actually do anything in the group
561 buffer. But, hey, that's your problem. Blllrph!
563 @findex gnus-no-server
564 @kindex M-x gnus-no-server
566 If you know that the server is definitely down, or you just want to read
567 your mail without bothering with the server at all, you can use the
568 @code{gnus-no-server} command to start Gnus. That might come in handy
569 if you're in a hurry as well. This command will not attempt to contact
570 your primary server---instead, it will just activate all groups on level
571 1 and 2. (You should preferably keep no native groups on those two
576 @section Slave Gnusae
579 You might want to run more than one Emacs with more than one Gnus at the
580 same time. If you are using different @file{.newsrc} files (e.g., if you
581 are using the two different Gnusae to read from two different servers),
582 that is no problem whatsoever. You just do it.
584 The problem appears when you want to run two Gnusae that use the same
587 To work around that problem some, we here at the Think-Tank at the Gnus
588 Towers have come up with a new concept: @dfn{Masters} and
589 @dfn{slaves}. (We have applied for a patent on this concept, and have
590 taken out a copyright on those words. If you wish to use those words in
591 conjunction with each other, you have to send $1 per usage instance to
592 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
593 Applications}) will be much more expensive, of course.)
595 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
596 however you do it). Each subsequent slave Gnusae should be started with
597 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
598 files, but instead save @dfn{slave files} that contain information only
599 on what groups have been read in the slave session. When a master Gnus
600 starts, it will read (and delete) these slave files, incorporating all
601 information from them. (The slave files will be read in the sequence
602 they were created, so the latest changes will have precedence.)
604 Information from the slave files has, of course, precedence over the
605 information in the normal (i.e., master) @code{.newsrc} file.
608 @node Fetching a Group
609 @section Fetching a Group
610 @cindex fetching a group
612 @findex gnus-fetch-group
613 It is sometimes convenient to be able to just say ``I want to read this
614 group and I don't care whether Gnus has been started or not''. This is
615 perhaps more useful for people who write code than for users, but the
616 command @code{gnus-fetch-group} provides this functionality in any case.
617 It takes the group name as a parameter.
625 @vindex gnus-check-new-newsgroups
626 If you are satisfied that you really never want to see any new groups,
627 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
628 also save you some time at startup. Even if this variable is
629 @code{nil}, you can always subscribe to the new groups just by pressing
630 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
631 is @code{ask-server} by default. If you set this variable to
632 @code{always}, then Gnus will query the backends for new groups even
633 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
636 * Checking New Groups:: Determining what groups are new.
637 * Subscription Methods:: What Gnus should do with new groups.
638 * Filtering New Groups:: Making Gnus ignore certain new groups.
642 @node Checking New Groups
643 @subsection Checking New Groups
645 Gnus normally determines whether a group is new or not by comparing the
646 list of groups from the active file(s) with the lists of subscribed and
647 dead groups. This isn't a particularly fast method. If
648 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
649 server for new groups since the last time. This is both faster and
650 cheaper. This also means that you can get rid of the list of killed
651 groups altogether, so you may set @code{gnus-save-killed-list} to
652 @code{nil}, which will save time both at startup, at exit, and all over.
653 Saves disk space, too. Why isn't this the default, then?
654 Unfortunately, not all servers support this command.
656 I bet I know what you're thinking now: How do I find out whether my
657 server supports @code{ask-server}? No? Good, because I don't have a
658 fail-safe answer. I would suggest just setting this variable to
659 @code{ask-server} and see whether any new groups appear within the next
660 few days. If any do, then it works. If none do, then it doesn't
661 work. I could write a function to make Gnus guess whether the server
662 supports @code{ask-server}, but it would just be a guess. So I won't.
663 You could @code{telnet} to the server and say @code{HELP} and see
664 whether it lists @samp{NEWGROUPS} among the commands it understands. If
665 it does, then it might work. (But there are servers that lists
666 @samp{NEWGROUPS} without supporting the function properly.)
668 This variable can also be a list of select methods. If so, Gnus will
669 issue an @code{ask-server} command to each of the select methods, and
670 subscribe them (or not) using the normal methods. This might be handy
671 if you are monitoring a few servers for new groups. A side effect is
672 that startup will take much longer, so you can meditate while waiting.
673 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
676 @node Subscription Methods
677 @subsection Subscription Methods
679 @vindex gnus-subscribe-newsgroup-method
680 What Gnus does when it encounters a new group is determined by the
681 @code{gnus-subscribe-newsgroup-method} variable.
683 This variable should contain a function. This function will be called
684 with the name of the new group as the only parameter.
686 Some handy pre-fab functions are:
690 @item gnus-subscribe-zombies
691 @vindex gnus-subscribe-zombies
692 Make all new groups zombies. This is the default. You can browse the
693 zombies later (with @kbd{A z}) and either kill them all off properly
694 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
696 @item gnus-subscribe-randomly
697 @vindex gnus-subscribe-randomly
698 Subscribe all new groups in arbitrary order. This really means that all
699 new groups will be added at ``the top'' of the group buffer.
701 @item gnus-subscribe-alphabetically
702 @vindex gnus-subscribe-alphabetically
703 Subscribe all new groups in alphabetical order.
705 @item gnus-subscribe-hierarchically
706 @vindex gnus-subscribe-hierarchically
707 Subscribe all new groups hierarchically. The difference between this
708 function and @code{gnus-subscribe-alphabetically} is slight.
709 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
710 alphabetical fashion, while this function will enter groups into its
711 hierarchy. So if you want to have the @samp{rec} hierarchy before the
712 @samp{comp} hierarchy, this function will not mess that configuration
713 up. Or something like that.
715 @item gnus-subscribe-interactively
716 @vindex gnus-subscribe-interactively
717 Subscribe new groups interactively. This means that Gnus will ask
718 you about @strong{all} new groups. The groups you choose to subscribe
719 to will be subscribed hierarchically.
721 @item gnus-subscribe-killed
722 @vindex gnus-subscribe-killed
727 @vindex gnus-subscribe-hierarchical-interactive
728 A closely related variable is
729 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
730 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
731 hierarchical fashion whether to subscribe to new groups or not. Gnus
732 will ask you for each sub-hierarchy whether you want to descend the
735 One common mistake is to set the variable a few paragraphs above
736 (@code{gnus-subscribe-newsgroup-method}) to
737 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
738 will not work. This is ga-ga. So don't do it.
741 @node Filtering New Groups
742 @subsection Filtering New Groups
744 A nice and portable way to control which new newsgroups should be
745 subscribed (or ignored) is to put an @dfn{options} line at the start of
746 the @file{.newsrc} file. Here's an example:
749 options -n !alt.all !rec.all sci.all
752 @vindex gnus-subscribe-options-newsgroup-method
753 This line obviously belongs to a serious-minded intellectual scientific
754 person (or she may just be plain old boring), because it says that all
755 groups that have names beginning with @samp{alt} and @samp{rec} should
756 be ignored, and all groups with names beginning with @samp{sci} should
757 be subscribed. Gnus will not use the normal subscription method for
758 subscribing these groups.
759 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
760 variable defaults to @code{gnus-subscribe-alphabetically}.
762 @vindex gnus-options-not-subscribe
763 @vindex gnus-options-subscribe
764 If you don't want to mess with your @file{.newsrc} file, you can just
765 set the two variables @code{gnus-options-subscribe} and
766 @code{gnus-options-not-subscribe}. These two variables do exactly the
767 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
768 and if the new group matches the former, it will be unconditionally
769 subscribed, and if it matches the latter, it will be ignored.
771 @vindex gnus-auto-subscribed-groups
772 Yet another variable that meddles here is
773 @code{gnus-auto-subscribed-groups}. It works exactly like
774 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
775 thought it would be nice to have two of these. This variable is more
776 meant for setting some ground rules, while the other variable is used
777 more for user fiddling. By default this variable makes all new groups
778 that come from mail backends (@code{nnml}, @code{nnbabyl},
779 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you
780 don't like that, just set this variable to @code{nil}.
782 New groups that match this regexp are subscribed using
783 @code{gnus-subscribe-options-newsgroup-method}.
786 @node Changing Servers
787 @section Changing Servers
788 @cindex changing servers
790 Sometimes it is necessary to move from one @sc{nntp} server to another.
791 This happens very rarely, but perhaps you change jobs, or one server is
792 very flaky and you want to use another.
794 Changing the server is pretty easy, right? You just change
795 @code{gnus-select-method} to point to the new server?
799 Article numbers are not (in any way) kept synchronized between different
800 @sc{nntp} servers, and the only way Gnus keeps track of what articles
801 you have read is by keeping track of article numbers. So when you
802 change @code{gnus-select-method}, your @file{.newsrc} file becomes
805 Gnus provides a few functions to attempt to translate a @file{.newsrc}
806 file from one server to another. They all have one thing in
807 common---they take a looong time to run. You don't want to use these
808 functions more than absolutely necessary.
810 @kindex M-x gnus-change-server
811 @findex gnus-change-server
812 If you have access to both servers, Gnus can request the headers for all
813 the articles you have read and compare @code{Message-ID}s and map the
814 article numbers of the read articles and article marks. The @kbd{M-x
815 gnus-change-server} command will do this for all your native groups. It
816 will prompt for the method you want to move to.
818 @kindex M-x gnus-group-move-group-to-server
819 @findex gnus-group-move-group-to-server
820 You can also move individual groups with the @kbd{M-x
821 gnus-group-move-group-to-server} command. This is useful if you want to
822 move a (foreign) group from one server to another.
824 @kindex M-x gnus-group-clear-data-on-native-groups
825 @findex gnus-group-clear-data-on-native-groups
826 If you don't have access to both the old and new server, all your marks
827 and read ranges have become worthless. You can use the @kbd{M-x
828 gnus-group-clear-data-on-native-groups} command to clear out all data
829 that you have on your native groups. Use with caution.
831 After changing servers, you @strong{must} move the cache hierarchy away,
832 since the cached articles will have wrong article numbers, which will
833 affect which articles Gnus thinks are read.
837 @section Startup Files
838 @cindex startup files
843 Now, you all know about the @file{.newsrc} file. All subscription
844 information is traditionally stored in this file.
846 Things got a bit more complicated with @sc{gnus}. In addition to
847 keeping the @file{.newsrc} file updated, it also used a file called
848 @file{.newsrc.el} for storing all the information that didn't fit into
849 the @file{.newsrc} file. (Actually, it also duplicated everything in
850 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
851 files was the most recently saved, which enabled people to swap between
852 @sc{gnus} and other newsreaders.
854 That was kinda silly, so Gnus went one better: In addition to the
855 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
856 @file{.newsrc.eld}. It will read whichever of these files that are most
857 recent, but it will never write a @file{.newsrc.el} file. You should
858 never delete the @file{.newsrc.eld} file---it contains much information
859 not stored in the @file{.newsrc} file.
861 @vindex gnus-save-newsrc-file
862 @vindex gnus-read-newsrc-file
863 You can turn off writing the @file{.newsrc} file by setting
864 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
865 the file and save some space, as well as exiting from Gnus faster.
866 However, this will make it impossible to use other newsreaders than
867 Gnus. But hey, who would want to, right? Similarly, setting
868 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
869 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which is
870 convenient if you have a tendency to use Netscape once in a while.
872 @vindex gnus-save-killed-list
873 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
874 will not save the list of killed groups to the startup file. This will
875 save both time (when starting and quitting) and space (on disk). It
876 will also mean that Gnus has no record of what groups are new or old,
877 so the automatic new groups subscription methods become meaningless.
878 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
879 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
880 Groups}). This variable can also be a regular expression. If that's
881 the case, remove all groups that do not match this regexp before
882 saving. This can be useful in certain obscure situations that involve
883 several servers where not all servers support @code{ask-server}.
885 @vindex gnus-startup-file
886 The @code{gnus-startup-file} variable says where the startup files are.
887 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
888 file being whatever that one is, with a @samp{.eld} appended.
890 @vindex gnus-save-newsrc-hook
891 @vindex gnus-save-quick-newsrc-hook
892 @vindex gnus-save-standard-newsrc-hook
893 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
894 files, while @code{gnus-save-quick-newsrc-hook} is called just before
895 saving the @file{.newsrc.eld} file, and
896 @code{gnus-save-standard-newsrc-hook} is called just before saving the
897 @file{.newsrc} file. The latter two are commonly used to turn version
898 control on or off. Version control is on by default when saving the
899 startup files. If you want to turn backup creation off, say something like:
902 (defun turn-off-backup ()
903 (set (make-local-variable 'backup-inhibited) t))
905 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
906 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
909 @vindex gnus-init-file
910 When Gnus starts, it will read the @code{gnus-site-init-file}
911 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
912 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
913 and can be used to avoid cluttering your @file{~/.emacs} and
914 @file{site-init} files with Gnus stuff. Gnus will also check for files
915 with the same names as these, but with @file{.elc} and @file{.el}
916 suffixes. In other words, if you have set @code{gnus-init-file} to
917 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
918 and finally @file{~/.gnus} (in this order).
927 Whenever you do something that changes the Gnus data (reading articles,
928 catching up, killing/subscribing groups), the change is added to a
929 special @dfn{dribble buffer}. This buffer is auto-saved the normal
930 Emacs way. If your Emacs should crash before you have saved the
931 @file{.newsrc} files, all changes you have made can be recovered from
934 If Gnus detects this file at startup, it will ask the user whether to
935 read it. The auto save file is deleted whenever the real startup file is
938 @vindex gnus-use-dribble-file
939 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
940 maintain a dribble buffer. The default is @code{t}.
942 @vindex gnus-dribble-directory
943 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
944 this variable is @code{nil}, which it is by default, Gnus will dribble
945 into the directory where the @file{.newsrc} file is located. (This is
946 normally the user's home directory.) The dribble file will get the same
947 file permissions as the @code{.newsrc} file.
949 @vindex gnus-always-read-dribble-file
950 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
951 read the dribble file on startup without querying the user.
954 @node The Active File
955 @section The Active File
957 @cindex ignored groups
959 When Gnus starts, or indeed whenever it tries to determine whether new
960 articles have arrived, it reads the active file. This is a very large
961 file that lists all the active groups and articles on the server.
963 @vindex gnus-ignored-newsgroups
964 Before examining the active file, Gnus deletes all lines that match the
965 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
966 any groups with bogus names, but you can use this variable to make Gnus
967 ignore hierarchies you aren't ever interested in. However, this is not
968 recommended. In fact, it's highly discouraged. Instead, @pxref{New
969 Groups} for an overview of other variables that can be used instead.
972 @c @code{nil} by default, and will slow down active file handling somewhat
973 @c if you set it to anything else.
975 @vindex gnus-read-active-file
977 The active file can be rather Huge, so if you have a slow network, you
978 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
979 reading the active file. This variable is @code{some} by default.
981 Gnus will try to make do by getting information just on the groups that
982 you actually subscribe to.
984 Note that if you subscribe to lots and lots of groups, setting this
985 variable to @code{nil} will probably make Gnus slower, not faster. At
986 present, having this variable @code{nil} will slow Gnus down
987 considerably, unless you read news over a 2400 baud modem.
989 This variable can also have the value @code{some}. Gnus will then
990 attempt to read active info only on the subscribed groups. On some
991 servers this is quite fast (on sparkling, brand new INN servers that
992 support the @code{LIST ACTIVE group} command), on others this isn't fast
993 at all. In any case, @code{some} should be faster than @code{nil}, and
994 is certainly faster than @code{t} over slow lines.
996 Some news servers (Leafnode and old versions of INN, for instance) do
997 not support the @code{LIST ACTIVE group}. For these servers, @code{nil}
998 is probably the most effficient value for this variable.
1000 If this variable is @code{nil}, Gnus will ask for group info in total
1001 lock-step, which isn't very fast. If it is @code{some} and you use an
1002 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
1003 read all the replies in one swoop. This will normally result in better
1004 performance, but if the server does not support the aforementioned
1005 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1007 If you think that starting up Gnus takes too long, try all the three
1008 different values for this variable and see what works best for you.
1010 In any case, if you use @code{some} or @code{nil}, you should definitely
1011 kill all groups that you aren't interested in to speed things up.
1013 Note that this variable also affects active file retrieval from
1014 secondary select methods.
1017 @node Startup Variables
1018 @section Startup Variables
1022 @item gnus-load-hook
1023 @vindex gnus-load-hook
1024 A hook run while Gnus is being loaded. Note that this hook will
1025 normally be run just once in each Emacs session, no matter how many
1026 times you start Gnus.
1028 @item gnus-before-startup-hook
1029 @vindex gnus-before-startup-hook
1030 A hook run after starting up Gnus successfully.
1032 @item gnus-startup-hook
1033 @vindex gnus-startup-hook
1034 A hook run as the very last thing after starting up Gnus
1036 @item gnus-started-hook
1037 @vindex gnus-started-hook
1038 A hook that is run as the very last thing after starting up Gnus
1041 @item gnus-setup-news-hook
1042 @vindex gnus-setup-news-hook
1043 A hook that is run after reading the @file{.newsrc} file(s), but before
1044 generating the group buffer.
1046 @item gnus-check-bogus-newsgroups
1047 @vindex gnus-check-bogus-newsgroups
1048 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1049 startup. A @dfn{bogus group} is a group that you have in your
1050 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1051 bogus groups can take quite a while, so to save time and resources it's
1052 best to leave this option off, and do the checking for bogus groups once
1053 in a while from the group buffer instead (@pxref{Group Maintenance}).
1055 @item gnus-inhibit-startup-message
1056 @vindex gnus-inhibit-startup-message
1057 If non-@code{nil}, the startup message won't be displayed. That way,
1058 your boss might not notice as easily that you are reading news instead
1059 of doing your job. Note that this variable is used before
1060 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1062 @item gnus-no-groups-message
1063 @vindex gnus-no-groups-message
1064 Message displayed by Gnus when no groups are available.
1066 @item gnus-play-startup-jingle
1067 @vindex gnus-play-startup-jingle
1068 If non-@code{nil}, play the Gnus jingle at startup.
1070 @item gnus-startup-jingle
1071 @vindex gnus-startup-jingle
1072 Jingle to be played if the above variable is non-@code{nil}. The
1073 default is @samp{Tuxedomoon.Jingle4.au}.
1078 @node The Group Buffer
1079 @chapter The Group Buffer
1080 @cindex group buffer
1082 The @dfn{group buffer} lists all (or parts) of the available groups. It
1083 is the first buffer shown when Gnus starts, and will never be killed as
1084 long as Gnus is active.
1088 \gnusfigure{The Group Buffer}{320}{
1089 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1090 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1091 \put(120,38){\vector(1,2){10}}
1092 \put(40,60){\makebox(0,0)[r]{Mode line}}
1093 \put(40,58){\vector(1,0){30}}
1094 \put(200,28){\makebox(0,0)[t]{Native select method}}
1095 \put(200,26){\vector(-1,2){15}}
1101 * Group Buffer Format:: Information listed and how you can change it.
1102 * Group Maneuvering:: Commands for moving in the group buffer.
1103 * Selecting a Group:: Actually reading news.
1104 * Group Data:: Changing the info for a group.
1105 * Subscription Commands:: Unsubscribing, killing, subscribing.
1106 * Group Levels:: Levels? What are those, then?
1107 * Group Score:: A mechanism for finding out what groups you like.
1108 * Marking Groups:: You can mark groups for later processing.
1109 * Foreign Groups:: Creating and editing groups.
1110 * Group Parameters:: Each group may have different parameters set.
1111 * Listing Groups:: Gnus can list various subsets of the groups.
1112 * Sorting Groups:: Re-arrange the group order.
1113 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1114 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1115 * Exiting Gnus:: Stop reading news and get some work done.
1116 * Group Topics:: A folding group mode divided into topics.
1117 * Misc Group Stuff:: Other stuff that you can to do.
1121 @node Group Buffer Format
1122 @section Group Buffer Format
1125 * Group Line Specification:: Deciding how the group buffer is to look.
1126 * Group Modeline Specification:: The group buffer modeline.
1127 * Group Highlighting:: Having nice colors in the group buffer.
1131 @node Group Line Specification
1132 @subsection Group Line Specification
1133 @cindex group buffer format
1135 The default format of the group buffer is nice and dull, but you can
1136 make it as exciting and ugly as you feel like.
1138 Here's a couple of example group lines:
1141 25: news.announce.newusers
1142 * 0: alt.fan.andrea-dworkin
1147 You can see that there are 25 unread articles in
1148 @samp{news.announce.newusers}. There are no unread articles, but some
1149 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1150 asterisk at the beginning of the line?).
1152 @vindex gnus-group-line-format
1153 You can change that format to whatever you want by fiddling with the
1154 @code{gnus-group-line-format} variable. This variable works along the
1155 lines of a @code{format} specification, which is pretty much the same as
1156 a @code{printf} specifications, for those of you who use (feh!) C.
1157 @xref{Formatting Variables}.
1159 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1161 There should always be a colon on the line; the cursor always moves to
1162 the colon after performing an operation. Nothing else is required---not
1163 even the group name. All displayed text is just window dressing, and is
1164 never examined by Gnus. Gnus stores all real information it needs using
1167 (Note that if you make a really strange, wonderful, spreadsheet-like
1168 layout, everybody will believe you are hard at work with the accounting
1169 instead of wasting time reading news.)
1171 Here's a list of all available format characters:
1176 An asterisk if the group only has marked articles.
1179 Whether the group is subscribed.
1182 Level of subscribedness.
1185 Number of unread articles.
1188 Number of dormant articles.
1191 Number of ticked articles.
1194 Number of read articles.
1197 Estimated total number of articles. (This is really @var{max-number}
1198 minus @var{min-number} plus 1.)
1201 Number of unread, unticked, non-dormant articles.
1204 Number of ticked and dormant articles.
1213 Newsgroup description.
1216 @samp{m} if moderated.
1219 @samp{(m)} if moderated.
1228 A string that looks like @samp{<%s:%n>} if a foreign select method is
1232 Indentation based on the level of the topic (@pxref{Group Topics}).
1235 @vindex gnus-group-uncollapsed-levels
1236 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1237 variable says how many levels to leave at the end of the group name.
1238 The default is 1---this will mean that group names like
1239 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1242 @vindex gnus-new-mail-mark
1244 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1248 A string that says when you last read the group (@pxref{Group
1252 User defined specifier. The next character in the format string should
1253 be a letter. Gnus will call the function
1254 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1255 following @samp{%u}. The function will be passed a single dummy
1256 parameter as argument. The function should return a string, which will
1257 be inserted into the buffer just like information from any other
1262 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1263 if no info is available---for instance, if it is a non-activated foreign
1264 group, or a bogus native group.
1267 @node Group Modeline Specification
1268 @subsection Group Modeline Specification
1269 @cindex group modeline
1271 @vindex gnus-group-mode-line-format
1272 The mode line can be changed by setting
1273 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1274 doesn't understand that many format specifiers:
1278 The native news server.
1280 The native select method.
1284 @node Group Highlighting
1285 @subsection Group Highlighting
1286 @cindex highlighting
1287 @cindex group highlighting
1289 @vindex gnus-group-highlight
1290 Highlighting in the group buffer is controlled by the
1291 @code{gnus-group-highlight} variable. This is an alist with elements
1292 that look like @var{(form . face)}. If @var{form} evaluates to
1293 something non-@code{nil}, the @var{face} will be used on the line.
1295 Here's an example value for this variable that might look nice if the
1299 (face-spec-set 'my-group-face-1
1300 '((t (:foreground "Red" :bold t))))
1301 (face-spec-set 'my-group-face-2
1302 '((t (:foreground "SeaGreen" :bold t))))
1303 (face-spec-set 'my-group-face-3
1304 '((t (:foreground "SpringGreen" :bold t))))
1305 (face-spec-set 'my-group-face-4
1306 '((t (:foreground "SteelBlue" :bold t))))
1307 (face-spec-set 'my-group-face-5
1308 '((t (:foreground "SkyBlue" :bold t))))
1310 (setq gnus-group-highlight
1311 '(((> unread 200) . my-group-face-1)
1312 ((and (< level 3) (zerop unread)) . my-group-face-2)
1313 ((< level 3) . my-group-face-3)
1314 ((zerop unread) . my-group-face-4)
1315 (t . my-group-face-5)))
1318 Also @pxref{Faces and Fonts}.
1320 Variables that are dynamically bound when the forms are evaluated
1327 The number of unread articles in the group.
1331 Whether the group is a mail group.
1333 The level of the group.
1335 The score of the group.
1337 The number of ticked articles in the group.
1339 The total number of articles in the group. Or rather, MAX-NUMBER minus
1340 MIN-NUMBER plus one.
1342 When using the topic minor mode, this variable is bound to the current
1343 topic being inserted.
1346 When the forms are @code{eval}ed, point is at the beginning of the line
1347 of the group in question, so you can use many of the normal Gnus
1348 functions for snarfing info on the group.
1350 @vindex gnus-group-update-hook
1351 @findex gnus-group-highlight-line
1352 @code{gnus-group-update-hook} is called when a group line is changed.
1353 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1354 calls @code{gnus-group-highlight-line} by default.
1357 @node Group Maneuvering
1358 @section Group Maneuvering
1359 @cindex group movement
1361 All movement commands understand the numeric prefix and will behave as
1362 expected, hopefully.
1368 @findex gnus-group-next-unread-group
1369 Go to the next group that has unread articles
1370 (@code{gnus-group-next-unread-group}).
1376 @findex gnus-group-prev-unread-group
1377 Go to the previous group that has unread articles
1378 (@code{gnus-group-prev-unread-group}).
1382 @findex gnus-group-next-group
1383 Go to the next group (@code{gnus-group-next-group}).
1387 @findex gnus-group-prev-group
1388 Go to the previous group (@code{gnus-group-prev-group}).
1392 @findex gnus-group-next-unread-group-same-level
1393 Go to the next unread group on the same (or lower) level
1394 (@code{gnus-group-next-unread-group-same-level}).
1398 @findex gnus-group-prev-unread-group-same-level
1399 Go to the previous unread group on the same (or lower) level
1400 (@code{gnus-group-prev-unread-group-same-level}).
1403 Three commands for jumping to groups:
1409 @findex gnus-group-jump-to-group
1410 Jump to a group (and make it visible if it isn't already)
1411 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
1416 @findex gnus-group-best-unread-group
1417 Jump to the unread group with the lowest level
1418 (@code{gnus-group-best-unread-group}).
1422 @findex gnus-group-first-unread-group
1423 Jump to the first group with unread articles
1424 (@code{gnus-group-first-unread-group}).
1427 @vindex gnus-group-goto-unread
1428 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1429 commands will move to the next group, not the next unread group. Even
1430 the commands that say they move to the next unread group. The default
1434 @node Selecting a Group
1435 @section Selecting a Group
1436 @cindex group selection
1441 @kindex SPACE (Group)
1442 @findex gnus-group-read-group
1443 Select the current group, switch to the summary buffer and display the
1444 first unread article (@code{gnus-group-read-group}). If there are no
1445 unread articles in the group, or if you give a non-numerical prefix to
1446 this command, Gnus will offer to fetch all the old articles in this
1447 group from the server. If you give a numerical prefix @var{N}, @var{N}
1448 determines the number of articles Gnus will fetch. If @var{N} is
1449 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1450 negative, Gnus fetches the @var{abs(N)} oldest articles.
1454 @findex gnus-group-select-group
1455 Select the current group and switch to the summary buffer
1456 (@code{gnus-group-select-group}). Takes the same arguments as
1457 @code{gnus-group-read-group}---the only difference is that this command
1458 does not display the first unread article automatically upon group
1462 @kindex M-RET (Group)
1463 @findex gnus-group-quick-select-group
1464 This does the same as the command above, but tries to do it with the
1465 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
1466 scoring/killing will be performed, there will be no highlights and no
1467 expunging. This might be useful if you're in a real hurry and have to
1468 enter some humongous group. If you give a 0 prefix to this command
1469 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1470 which is useful if you want to toggle threading before generating the
1471 summary buffer (@pxref{Summary Generation Commands}).
1474 @kindex M-SPACE (Group)
1475 @findex gnus-group-visible-select-group
1476 This is yet one more command that does the same as the @kbd{RET}
1477 command, but this one does it without expunging and hiding dormants
1478 (@code{gnus-group-visible-select-group}).
1481 @kindex M-C-RET (Group)
1482 @findex gnus-group-select-group-ephemerally
1483 Finally, this command selects the current group ephemerally without
1484 doing any processing of its contents
1485 (@code{gnus-group-select-group-ephemerally}). Even threading has been
1486 turned off. Everything you do in the group after selecting it in this
1487 manner will have no permanent effects.
1491 @vindex gnus-large-newsgroup
1492 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1493 to be a big group. This is 200 by default. If the group has more
1494 (unread and/or ticked) articles than this, Gnus will query the user
1495 before entering the group. The user can then specify how many articles
1496 should be fetched from the server. If the user specifies a negative
1497 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
1498 is positive, the @code{n} articles that have arrived most recently will
1501 @vindex gnus-select-group-hook
1502 @vindex gnus-auto-select-first
1503 @code{gnus-auto-select-first} control whether any articles are selected
1504 automatically when entering a group with the @kbd{SPACE} command.
1509 Don't select any articles when entering the group. Just display the
1510 full summary buffer.
1513 Select the first unread article when entering the group.
1516 Select the highest scored article in the group when entering the
1521 This variable can also be a function. In that case, that function will
1522 be called to place point on a subject line, and/or select some article.
1523 Useful functions include:
1526 @item gnus-summary-first-unread-subject
1527 Place point on the subject line of the first unread article, but
1528 don't select the article.
1530 @item gnus-summary-first-unread-article
1531 Select the first unread article.
1533 @item gnus-summary-best-unread-article
1534 Select the highest-scored unread article.
1538 If you want to prevent automatic selection in some group (say, in a
1539 binary group with Huge articles) you can set this variable to @code{nil}
1540 in @code{gnus-select-group-hook}, which is called when a group is
1544 @node Subscription Commands
1545 @section Subscription Commands
1546 @cindex subscription
1554 @findex gnus-group-unsubscribe-current-group
1555 @c @icon{gnus-group-unsubscribe}
1556 Toggle subscription to the current group
1557 (@code{gnus-group-unsubscribe-current-group}).
1563 @findex gnus-group-unsubscribe-group
1564 Prompt for a group to subscribe, and then subscribe it. If it was
1565 subscribed already, unsubscribe it instead
1566 (@code{gnus-group-unsubscribe-group}).
1572 @findex gnus-group-kill-group
1573 @c @icon{gnus-group-kill-group}
1574 Kill the current group (@code{gnus-group-kill-group}).
1580 @findex gnus-group-yank-group
1581 Yank the last killed group (@code{gnus-group-yank-group}).
1584 @kindex C-x C-t (Group)
1585 @findex gnus-group-transpose-groups
1586 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
1587 really a subscription command, but you can use it instead of a
1588 kill-and-yank sequence sometimes.
1594 @findex gnus-group-kill-region
1595 Kill all groups in the region (@code{gnus-group-kill-region}).
1599 @findex gnus-group-kill-all-zombies
1600 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1603 @kindex S C-k (Group)
1604 @findex gnus-group-kill-level
1605 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1606 These groups can't be yanked back after killing, so this command should
1607 be used with some caution. The only time where this command comes in
1608 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1609 groups that you want to get rid off. @kbd{S C-k} on level 7 will
1610 kill off all unsubscribed groups that do not have message numbers in the
1611 @file{.newsrc} file.
1615 Also @pxref{Group Levels}.
1625 @findex gnus-group-catchup-current
1626 @vindex gnus-group-catchup-group-hook
1627 @c @icon{gnus-group-catchup-current}
1628 Mark all unticked articles in this group as read
1629 (@code{gnus-group-catchup-current}).
1630 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1635 @findex gnus-group-catchup-current-all
1636 Mark all articles in this group, even the ticked ones, as read
1637 (@code{gnus-group-catchup-current-all}).
1641 @findex gnus-group-clear-data
1642 Clear the data from the current group---nix out marks and the list of
1643 read articles (@code{gnus-group-clear-data}).
1645 @item M-x gnus-group-clear-data-on-native-groups
1646 @kindex M-x gnus-group-clear-data-on-native-groups
1647 @findex gnus-group-clear-data-on-native-groups
1648 If you have switched from one @sc{nntp} server to another, all your marks
1649 and read ranges have become worthless. You can use this command to
1650 clear out all data that you have on your native groups. Use with
1657 @section Group Levels
1661 All groups have a level of @dfn{subscribedness}. For instance, if a
1662 group is on level 2, it is more subscribed than a group on level 5. You
1663 can ask Gnus to just list groups on a given level or lower
1664 (@pxref{Listing Groups}), or to just check for new articles in groups on
1665 a given level or lower (@pxref{Scanning New Messages}).
1667 Remember: The higher the level of the group, the less important it is.
1673 @findex gnus-group-set-current-level
1674 Set the level of the current group. If a numeric prefix is given, the
1675 next @var{n} groups will have their levels set. The user will be
1676 prompted for a level.
1679 @vindex gnus-level-killed
1680 @vindex gnus-level-zombie
1681 @vindex gnus-level-unsubscribed
1682 @vindex gnus-level-subscribed
1683 Gnus considers groups from levels 1 to
1684 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1685 @code{gnus-level-subscribed} (exclusive) and
1686 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1687 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1688 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1689 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
1690 same, but zombie and killed groups have no information on what articles
1691 you have read, etc, stored. This distinction between dead and living
1692 groups isn't done because it is nice or clever, it is done purely for
1693 reasons of efficiency.
1695 It is recommended that you keep all your mail groups (if any) on quite
1696 low levels (e.g. 1 or 2).
1698 If you want to play with the level variables, you should show some care.
1699 Set them once, and don't touch them ever again. Better yet, don't touch
1700 them at all unless you know exactly what you're doing.
1702 @vindex gnus-level-default-unsubscribed
1703 @vindex gnus-level-default-subscribed
1704 Two closely related variables are @code{gnus-level-default-subscribed}
1705 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1706 which are the levels that new groups will be put on if they are
1707 (un)subscribed. These two variables should, of course, be inside the
1708 relevant valid ranges.
1710 @vindex gnus-keep-same-level
1711 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1712 will only move to groups of the same level (or lower). In
1713 particular, going from the last article in one group to the next group
1714 will go to the next group of the same level (or lower). This might be
1715 handy if you want to read the most important groups before you read the
1718 @vindex gnus-group-default-list-level
1719 All groups with a level less than or equal to
1720 @code{gnus-group-default-list-level} will be listed in the group buffer
1723 @vindex gnus-group-list-inactive-groups
1724 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1725 groups will be listed along with the unread groups. This variable is
1726 @code{t} by default. If it is @code{nil}, inactive groups won't be
1729 @vindex gnus-group-use-permanent-levels
1730 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1731 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1732 use this level as the ``work'' level.
1734 @vindex gnus-activate-level
1735 Gnus will normally just activate (i. e., query the server about) groups
1736 on level @code{gnus-activate-level} or less. If you don't want to
1737 activate unsubscribed groups, for instance, you might set this variable
1738 to 5. The default is 6.
1742 @section Group Score
1747 You would normally keep important groups on high levels, but that scheme
1748 is somewhat restrictive. Don't you wish you could have Gnus sort the
1749 group buffer according to how often you read groups, perhaps? Within
1752 This is what @dfn{group score} is for. You can have Gnus assign a score
1753 to each group through the mechanism described below. You can then sort
1754 the group buffer based on this score. Alternatively, you can sort on
1755 score and then level. (Taken together, the level and the score is
1756 called the @dfn{rank} of the group. A group that is on level 4 and has
1757 a score of 1 has a higher rank than a group on level 5 that has a score
1758 of 300. (The level is the most significant part and the score is the
1759 least significant part.))
1761 @findex gnus-summary-bubble-group
1762 If you want groups you read often to get higher scores than groups you
1763 read seldom you can add the @code{gnus-summary-bubble-group} function to
1764 the @code{gnus-summary-exit-hook} hook. This will result (after
1765 sorting) in a bubbling sort of action. If you want to see that in
1766 action after each summary exit, you can add
1767 @code{gnus-group-sort-groups-by-rank} or
1768 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1769 slow things down somewhat.
1772 @node Marking Groups
1773 @section Marking Groups
1774 @cindex marking groups
1776 If you want to perform some command on several groups, and they appear
1777 subsequently in the group buffer, you would normally just give a
1778 numerical prefix to the command. Most group commands will then do your
1779 bidding on those groups.
1781 However, if the groups are not in sequential order, you can still
1782 perform a command on several groups. You simply mark the groups first
1783 with the process mark and then execute the command.
1791 @findex gnus-group-mark-group
1792 Set the mark on the current group (@code{gnus-group-mark-group}).
1798 @findex gnus-group-unmark-group
1799 Remove the mark from the current group
1800 (@code{gnus-group-unmark-group}).
1804 @findex gnus-group-unmark-all-groups
1805 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1809 @findex gnus-group-mark-region
1810 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1814 @findex gnus-group-mark-buffer
1815 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1819 @findex gnus-group-mark-regexp
1820 Mark all groups that match some regular expression
1821 (@code{gnus-group-mark-regexp}).
1824 Also @pxref{Process/Prefix}.
1826 @findex gnus-group-universal-argument
1827 If you want to execute some command on all groups that have been marked
1828 with the process mark, you can use the @kbd{M-&}
1829 (@code{gnus-group-universal-argument}) command. It will prompt you for
1830 the command to be executed.
1833 @node Foreign Groups
1834 @section Foreign Groups
1835 @cindex foreign groups
1837 Below are some group mode commands for making and editing general foreign
1838 groups, as well as commands to ease the creation of a few
1839 special-purpose groups. All these commands insert the newly created
1840 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1847 @findex gnus-group-make-group
1848 @cindex making groups
1849 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
1850 for a name, a method and possibly an @dfn{address}. For an easier way
1851 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1855 @findex gnus-group-rename-group
1856 @cindex renaming groups
1857 Rename the current group to something else
1858 (@code{gnus-group-rename-group}). This is valid only on some
1859 groups---mail groups mostly. This command might very well be quite slow
1865 @findex gnus-group-customize
1866 Customize the group parameters (@code{gnus-group-customize}).
1870 @findex gnus-group-edit-group-method
1871 @cindex renaming groups
1872 Enter a buffer where you can edit the select method of the current
1873 group (@code{gnus-group-edit-group-method}).
1877 @findex gnus-group-edit-group-parameters
1878 Enter a buffer where you can edit the group parameters
1879 (@code{gnus-group-edit-group-parameters}).
1883 @findex gnus-group-edit-group
1884 Enter a buffer where you can edit the group info
1885 (@code{gnus-group-edit-group}).
1889 @findex gnus-group-make-directory-group
1891 Make a directory group (@pxref{Directory Groups}). You will be prompted
1892 for a directory name (@code{gnus-group-make-directory-group}).
1897 @findex gnus-group-make-help-group
1898 Make the Gnus help group (@code{gnus-group-make-help-group}).
1902 @cindex (ding) archive
1903 @cindex archive group
1904 @findex gnus-group-make-archive-group
1905 @vindex gnus-group-archive-directory
1906 @vindex gnus-group-recent-archive-directory
1907 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
1908 default a group pointing to the most recent articles will be created
1909 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1910 group will be created from @code{gnus-group-archive-directory}.
1914 @findex gnus-group-make-kiboze-group
1916 Make a kiboze group. You will be prompted for a name, for a regexp to
1917 match groups to be ``included'' in the kiboze group, and a series of
1918 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1919 @xref{Kibozed Groups}.
1923 @findex gnus-group-enter-directory
1925 Read an arbitrary directory as if it were a newsgroup with the
1926 @code{nneething} backend (@code{gnus-group-enter-directory}).
1927 @xref{Anything Groups}.
1931 @findex gnus-group-make-doc-group
1932 @cindex ClariNet Briefs
1934 Make a group based on some file or other
1935 (@code{gnus-group-make-doc-group}). If you give a prefix to this
1936 command, you will be prompted for a file name and a file type.
1937 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1938 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1939 @code{rfc934}, @code{rfc822-forward}, @code{nsmail} and @code{forward}.
1940 If you run this command without a prefix, Gnus will guess at the file
1941 type. @xref{Document Groups}.
1945 @vindex gnus-useful-groups
1946 @findex gnus-group-make-useful-group
1947 Create one of the groups mentioned in @code{gnus-useful-groups}
1948 (@code{gnus-group-make-useful-group}).
1952 @findex gnus-group-make-web-group
1957 Make an ephemeral group based on a web search
1958 (@code{gnus-group-make-web-group}). If you give a prefix to this
1959 command, make a solid group instead. You will be prompted for the
1960 search engine type and the search string. Valid search engine types
1961 include @code{dejanews}, @code{altavista} and @code{reference}.
1962 @xref{Web Searches}.
1964 If you use the @code{dejanews} search engine, you can limit the search
1965 to a particular group by using a match string like
1966 @samp{~g alt.sysadmin.recovery shaving}.
1969 @kindex G DEL (Group)
1970 @findex gnus-group-delete-group
1971 This function will delete the current group
1972 (@code{gnus-group-delete-group}). If given a prefix, this function will
1973 actually delete all the articles in the group, and forcibly remove the
1974 group itself from the face of the Earth. Use a prefix only if you are
1975 absolutely sure of what you are doing. This command can't be used on
1976 read-only groups (like @code{nntp} group), though.
1980 @findex gnus-group-make-empty-virtual
1981 Make a new, fresh, empty @code{nnvirtual} group
1982 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
1986 @findex gnus-group-add-to-virtual
1987 Add the current group to an @code{nnvirtual} group
1988 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
1991 @xref{Select Methods}, for more information on the various select
1994 @vindex gnus-activate-foreign-newsgroups
1995 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1996 Gnus will check all foreign groups with this level or lower at startup.
1997 This might take quite a while, especially if you subscribe to lots of
1998 groups from different @sc{nntp} servers. Also @pxref{Group Levels};
1999 @code{gnus-activate-level} also affects activation of foreign
2003 @node Group Parameters
2004 @section Group Parameters
2005 @cindex group parameters
2007 The group parameters store information local to a particular group.
2008 Here's an example group parameter list:
2011 ((to-address . "ding@@gnus.org")
2015 We see that each element consists of a "dotted pair"---the thing before
2016 the dot is the key, while the thing after the dot is the value. All the
2017 parameters have this form @emph{except} local variable specs, which are
2018 not dotted pairs, but proper lists.
2020 The following group parameters can be used:
2025 Address used by when doing followups and new posts.
2028 (to-address . "some@@where.com")
2031 This is primarily useful in mail groups that represent closed mailing
2032 lists---mailing lists where it's expected that everybody that writes to
2033 the mailing list is subscribed to it. Since using this parameter
2034 ensures that the mail only goes to the mailing list itself, it means
2035 that members won't receive two copies of your followups.
2037 Using @code{to-address} will actually work whether the group is foreign
2038 or not. Let's say there's a group on the server that is called
2039 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2040 the articles from a mail-to-news gateway. Posting directly to this
2041 group is therefore impossible---you have to send mail to the mailing
2042 list address instead.
2046 Address used when doing a @kbd{a} in that group.
2049 (to-list . "some@@where.com")
2052 It is totally ignored
2053 when doing a followup---except that if it is present in a news group,
2054 you'll get mail group semantics when doing @kbd{f}.
2056 If you do an @kbd{a} command in a mail group and you have neither a
2057 @code{to-list} group parameter nor a @code{to-address} group parameter,
2058 then a @code{to-list} group parameter will be added automatically upon
2059 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2060 @vindex gnus-add-to-list
2062 If you do an @kbd{a} command in a mail group and you don't have a
2063 @code{to-list} group parameter, one will be added automatically upon
2064 sending the message.
2068 If the group parameter list has the element @code{(visible . t)},
2069 that group will always be visible in the Group buffer, regardless
2070 of whether it has any unread articles.
2072 @item broken-reply-to
2073 @cindex broken-reply-to
2074 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2075 headers in this group are to be ignored. This can be useful if you're
2076 reading a mailing list group where the listserv has inserted
2077 @code{Reply-To} headers that point back to the listserv itself. This is
2078 broken behavior. So there!
2082 Elements like @code{(to-group . "some.group.name")} means that all
2083 posts in that group will be sent to @code{some.group.name}.
2087 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2088 will treat all responses as if they were responses to news articles.
2089 This can be useful if you have a mail group that's really a mirror of a
2094 If @code{(gcc-self . t)} is present in the group parameter list, newly
2095 composed messages will be @code{Gcc}'d to the current group. If
2096 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2097 generated, if @code{(gcc-self . "string")} is present, this string will
2098 be inserted literally as a @code{gcc} header. This parameter takes
2099 precedence over any default @code{Gcc} rules as described later
2100 (@pxref{Archived Messages}).
2104 If the group parameter has an element that looks like @code{(auto-expire
2105 . t)}, all articles read will be marked as expirable. For an
2106 alternative approach, @pxref{Expiring Mail}.
2109 @cindex total-expire
2110 If the group parameter has an element that looks like
2111 @code{(total-expire . t)}, all read articles will be put through the
2112 expiry process, even if they are not marked as expirable. Use with
2113 caution. Unread, ticked and dormant articles are not eligible for
2118 @vindex nnmail-expiry-wait-function
2119 If the group parameter has an element that looks like @code{(expiry-wait
2120 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2121 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2122 The value can either be a number of days (not necessarily an integer) or
2123 the symbols @code{never} or @code{immediate}.
2126 @cindex score file group parameter
2127 Elements that look like @code{(score-file . "file")} will make
2128 @file{file} into the current score file for the group in question. All
2129 interactive score entries will be put into this file.
2132 @cindex adapt file group parameter
2133 Elements that look like @code{(adapt-file . "file")} will make
2134 @file{file} into the current adaptive file for the group in question.
2135 All adaptive score entries will be put into this file.
2138 When unsubscribing from a mailing list you should never send the
2139 unsubscription notice to the mailing list itself. Instead, you'd send
2140 messages to the administrative address. This parameter allows you to
2141 put the admin address somewhere convenient.
2144 Elements that look like @code{(display . MODE)} say which articles to
2145 display on entering the group. Valid values are:
2149 Display all articles, both read and unread.
2152 Display the default visible articles, which normally includes unread and
2157 Elements that look like @code{(comment . "This is a comment")}
2158 are arbitrary comments on the group. They are currently ignored by
2159 Gnus, but provide a place for you to store information on particular
2163 Elements that look like @code{(charset . iso-8859-1)} will make
2164 @code{iso-8859-1} the default charset; that is, the charset that will be
2165 used for all articles that do not specify a charset.
2167 @item @var{(variable form)}
2168 You can use the group parameters to set variables local to the group you
2169 are entering. If you want to turn threading off in @samp{news.answers},
2170 you could put @code{(gnus-show-threads nil)} in the group parameters of
2171 that group. @code{gnus-show-threads} will be made into a local variable
2172 in the summary buffer you enter, and the form @code{nil} will be
2173 @code{eval}ed there.
2175 This can also be used as a group-specific hook function, if you'd like.
2176 If you want to hear a beep when you enter a group, you could put
2177 something like @code{(dummy-variable (ding))} in the parameters of that
2178 group. @code{dummy-variable} will be set to the result of the
2179 @code{(ding)} form, but who cares?
2182 You can store additional posting style information for this group only
2183 here (@pxref{Posting Styles}). The format is that of an entry in the
2184 @code{gnus-posting-styles} alist, except that there's no regexp matching
2185 the group name (of course). Style elements in this group parameter will
2186 take precedence over the ones found in @code{gnus-posting-styles}.
2188 For instance, if you want a funky name and signature in this group only,
2189 instead of hacking @code{gnus-posting-styles}, you could put something
2190 like this in the group parameters:
2195 (signature "Funky Signature"))
2200 Use the @kbd{G p} command to edit group parameters of a group. You
2201 might also be interested in reading about topic parameters (@pxref{Topic
2205 @node Listing Groups
2206 @section Listing Groups
2207 @cindex group listing
2209 These commands all list various slices of the groups available.
2217 @findex gnus-group-list-groups
2218 List all groups that have unread articles
2219 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
2220 command will list only groups of level ARG and lower. By default, it
2221 only lists groups of level five (i. e.,
2222 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2229 @findex gnus-group-list-all-groups
2230 List all groups, whether they have unread articles or not
2231 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
2232 this command will list only groups of level ARG and lower. By default,
2233 it lists groups of level seven or lower (i.e., just subscribed and
2234 unsubscribed groups).
2238 @findex gnus-group-list-level
2239 List all unread groups on a specific level
2240 (@code{gnus-group-list-level}). If given a prefix, also list the groups
2241 with no unread articles.
2245 @findex gnus-group-list-killed
2246 List all killed groups (@code{gnus-group-list-killed}). If given a
2247 prefix argument, really list all groups that are available, but aren't
2248 currently (un)subscribed. This could entail reading the active file
2253 @findex gnus-group-list-zombies
2254 List all zombie groups (@code{gnus-group-list-zombies}).
2258 @findex gnus-group-list-matching
2259 List all unread, subscribed groups with names that match a regexp
2260 (@code{gnus-group-list-matching}).
2264 @findex gnus-group-list-all-matching
2265 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2269 @findex gnus-group-list-active
2270 List absolutely all groups in the active file(s) of the
2271 server(s) you are connected to (@code{gnus-group-list-active}). This
2272 might very well take quite a while. It might actually be a better idea
2273 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2274 thing to match on. Also note that this command may list groups that
2275 don't exist (yet)---these will be listed as if they were killed groups.
2276 Take the output with some grains of salt.
2280 @findex gnus-group-apropos
2281 List all groups that have names that match a regexp
2282 (@code{gnus-group-apropos}).
2286 @findex gnus-group-description-apropos
2287 List all groups that have names or descriptions that match a regexp
2288 (@code{gnus-group-description-apropos}).
2292 @vindex gnus-permanently-visible-groups
2293 @cindex visible group parameter
2294 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2295 always be shown, whether they have unread articles or not. You can also
2296 add the @code{visible} element to the group parameters in question to
2297 get the same effect.
2299 @vindex gnus-list-groups-with-ticked-articles
2300 Groups that have just ticked articles in it are normally listed in the
2301 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
2302 @code{nil}, these groups will be treated just like totally empty
2303 groups. It is @code{t} by default.
2306 @node Sorting Groups
2307 @section Sorting Groups
2308 @cindex sorting groups
2310 @kindex C-c C-s (Group)
2311 @findex gnus-group-sort-groups
2312 @vindex gnus-group-sort-function
2313 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2314 group buffer according to the function(s) given by the
2315 @code{gnus-group-sort-function} variable. Available sorting functions
2320 @item gnus-group-sort-by-alphabet
2321 @findex gnus-group-sort-by-alphabet
2322 Sort the group names alphabetically. This is the default.
2324 @item gnus-group-sort-by-real-name
2325 @findex gnus-group-sort-by-real-name
2326 Sort the group alphabetically on the real (unprefixed) group names.
2328 @item gnus-group-sort-by-level
2329 @findex gnus-group-sort-by-level
2330 Sort by group level.
2332 @item gnus-group-sort-by-score
2333 @findex gnus-group-sort-by-score
2334 Sort by group score. @xref{Group Score}.
2336 @item gnus-group-sort-by-rank
2337 @findex gnus-group-sort-by-rank
2338 Sort by group score and then the group level. The level and the score
2339 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
2341 @item gnus-group-sort-by-unread
2342 @findex gnus-group-sort-by-unread
2343 Sort by number of unread articles.
2345 @item gnus-group-sort-by-method
2346 @findex gnus-group-sort-by-method
2347 Sort alphabetically on the select method.
2352 @code{gnus-group-sort-function} can also be a list of sorting
2353 functions. In that case, the most significant sort key function must be
2357 There are also a number of commands for sorting directly according to
2358 some sorting criteria:
2362 @kindex G S a (Group)
2363 @findex gnus-group-sort-groups-by-alphabet
2364 Sort the group buffer alphabetically by group name
2365 (@code{gnus-group-sort-groups-by-alphabet}).
2368 @kindex G S u (Group)
2369 @findex gnus-group-sort-groups-by-unread
2370 Sort the group buffer by the number of unread articles
2371 (@code{gnus-group-sort-groups-by-unread}).
2374 @kindex G S l (Group)
2375 @findex gnus-group-sort-groups-by-level
2376 Sort the group buffer by group level
2377 (@code{gnus-group-sort-groups-by-level}).
2380 @kindex G S v (Group)
2381 @findex gnus-group-sort-groups-by-score
2382 Sort the group buffer by group score
2383 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
2386 @kindex G S r (Group)
2387 @findex gnus-group-sort-groups-by-rank
2388 Sort the group buffer by group rank
2389 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
2392 @kindex G S m (Group)
2393 @findex gnus-group-sort-groups-by-method
2394 Sort the group buffer alphabetically by backend name
2395 (@code{gnus-group-sort-groups-by-method}).
2399 All the commands below obeys the process/prefix convention
2400 (@pxref{Process/Prefix}).
2402 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
2403 commands will sort in reverse order.
2405 You can also sort a subset of the groups:
2409 @kindex G P a (Group)
2410 @findex gnus-group-sort-selected-groups-by-alphabet
2411 Sort the groups alphabetically by group name
2412 (@code{gnus-group-sort-selected-groups-by-alphabet}).
2415 @kindex G P u (Group)
2416 @findex gnus-group-sort-selected-groups-by-unread
2417 Sort the groups by the number of unread articles
2418 (@code{gnus-group-sort-selected-groups-by-unread}).
2421 @kindex G P l (Group)
2422 @findex gnus-group-sort-selected-groups-by-level
2423 Sort the groups by group level
2424 (@code{gnus-group-sort-selected-groups-by-level}).
2427 @kindex G P v (Group)
2428 @findex gnus-group-sort-selected-groups-by-score
2429 Sort the groups by group score
2430 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
2433 @kindex G P r (Group)
2434 @findex gnus-group-sort-selected-groups-by-rank
2435 Sort the groups by group rank
2436 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
2439 @kindex G P m (Group)
2440 @findex gnus-group-sort-selected-groups-by-method
2441 Sort the groups alphabetically by backend name
2442 (@code{gnus-group-sort-selected-groups-by-method}).
2448 @node Group Maintenance
2449 @section Group Maintenance
2450 @cindex bogus groups
2455 @findex gnus-group-check-bogus-groups
2456 Find bogus groups and delete them
2457 (@code{gnus-group-check-bogus-groups}).
2461 @findex gnus-group-find-new-groups
2462 Find new groups and process them (@code{gnus-group-find-new-groups}).
2463 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
2464 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
2465 to query the server for new groups, and subscribe the new groups as
2469 @kindex C-c C-x (Group)
2470 @findex gnus-group-expire-articles
2471 Run all expirable articles in the current group through the expiry
2472 process (if any) (@code{gnus-group-expire-articles}).
2475 @kindex C-c M-C-x (Group)
2476 @findex gnus-group-expire-all-groups
2477 Run all articles in all groups through the expiry process
2478 (@code{gnus-group-expire-all-groups}).
2483 @node Browse Foreign Server
2484 @section Browse Foreign Server
2485 @cindex foreign servers
2486 @cindex browsing servers
2491 @findex gnus-group-browse-foreign-server
2492 You will be queried for a select method and a server name. Gnus will
2493 then attempt to contact this server and let you browse the groups there
2494 (@code{gnus-group-browse-foreign-server}).
2497 @findex gnus-browse-mode
2498 A new buffer with a list of available groups will appear. This buffer
2499 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
2500 a lot) like a normal group buffer.
2502 Here's a list of keystrokes available in the browse mode:
2507 @findex gnus-group-next-group
2508 Go to the next group (@code{gnus-group-next-group}).
2512 @findex gnus-group-prev-group
2513 Go to the previous group (@code{gnus-group-prev-group}).
2516 @kindex SPACE (Browse)
2517 @findex gnus-browse-read-group
2518 Enter the current group and display the first article
2519 (@code{gnus-browse-read-group}).
2522 @kindex RET (Browse)
2523 @findex gnus-browse-select-group
2524 Enter the current group (@code{gnus-browse-select-group}).
2528 @findex gnus-browse-unsubscribe-current-group
2529 Unsubscribe to the current group, or, as will be the case here,
2530 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2536 @findex gnus-browse-exit
2537 Exit browse mode (@code{gnus-browse-exit}).
2541 @findex gnus-browse-describe-briefly
2542 Describe browse mode briefly (well, there's not much to describe, is
2543 there) (@code{gnus-browse-describe-briefly}).
2548 @section Exiting Gnus
2549 @cindex exiting Gnus
2551 Yes, Gnus is ex(c)iting.
2556 @findex gnus-group-suspend
2557 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
2558 but it kills all buffers except the Group buffer. I'm not sure why this
2559 is a gain, but then who am I to judge?
2563 @findex gnus-group-exit
2564 @c @icon{gnus-group-exit}
2565 Quit Gnus (@code{gnus-group-exit}).
2569 @findex gnus-group-quit
2570 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2571 The dribble file will be saved, though (@pxref{Auto Save}).
2574 @vindex gnus-exit-gnus-hook
2575 @vindex gnus-suspend-gnus-hook
2576 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2577 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2578 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2583 If you wish to completely unload Gnus and all its adherents, you can use
2584 the @code{gnus-unload} command. This command is also very handy when
2585 trying to customize meta-variables.
2590 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2591 numbly heavy and herself fall into a hazy trance as the boy sitting
2592 behind her drew repeated lines with his pencil across the back of her
2598 @section Group Topics
2601 If you read lots and lots of groups, it might be convenient to group
2602 them hierarchically according to topics. You put your Emacs groups over
2603 here, your sex groups over there, and the rest (what, two groups or so?)
2604 you put in some misc section that you never bother with anyway. You can
2605 even group the Emacs sex groups as a sub-topic to either the Emacs
2606 groups or the sex groups---or both! Go wild!
2610 \gnusfigure{Group Topics}{400}{
2611 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2622 2: alt.religion.emacs
2625 0: comp.talk.emacs.recovery
2627 8: comp.binaries.fractals
2628 13: comp.sources.unix
2631 @findex gnus-topic-mode
2633 To get this @emph{fab} functionality you simply turn on (ooh!) the
2634 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
2635 is a toggling command.)
2637 Go ahead, just try it. I'll still be here when you get back. La de
2638 dum... Nice tune, that... la la la... What, you're back? Yes, and now
2639 press @kbd{l}. There. All your groups are now listed under
2640 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
2643 If you want this permanently enabled, you should add that minor mode to
2644 the hook for the group mode:
2647 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2651 * Topic Variables:: How to customize the topics the Lisp Way.
2652 * Topic Commands:: Interactive E-Z commands.
2653 * Topic Sorting:: Sorting each topic individually.
2654 * Topic Topology:: A map of the world.
2655 * Topic Parameters:: Parameters that apply to all groups in a topic.
2659 @node Topic Variables
2660 @subsection Topic Variables
2661 @cindex topic variables
2663 Now, if you select a topic, it will fold/unfold that topic, which is
2664 really neat, I think.
2666 @vindex gnus-topic-line-format
2667 The topic lines themselves are created according to the
2668 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2681 Number of groups in the topic.
2683 Number of unread articles in the topic.
2685 Number of unread articles in the topic and all its subtopics.
2688 @vindex gnus-topic-indent-level
2689 Each sub-topic (and the groups in the sub-topics) will be indented with
2690 @code{gnus-topic-indent-level} times the topic level number of spaces.
2693 @vindex gnus-topic-mode-hook
2694 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2696 @vindex gnus-topic-display-empty-topics
2697 The @code{gnus-topic-display-empty-topics} says whether to display even
2698 topics that have no unread articles in them. The default is @code{t}.
2701 @node Topic Commands
2702 @subsection Topic Commands
2703 @cindex topic commands
2705 When the topic minor mode is turned on, a new @kbd{T} submap will be
2706 available. In addition, a few of the standard keys change their
2707 definitions slightly.
2713 @findex gnus-topic-create-topic
2714 Prompt for a new topic name and create it
2715 (@code{gnus-topic-create-topic}).
2719 @findex gnus-topic-move-group
2720 Move the current group to some other topic
2721 (@code{gnus-topic-move-group}). This command uses the process/prefix
2722 convention (@pxref{Process/Prefix}).
2726 @findex gnus-topic-jump-to-topic
2727 Go to a topic (@code{gnus-topic-jump-to-topic}).
2731 @findex gnus-topic-copy-group
2732 Copy the current group to some other topic
2733 (@code{gnus-topic-copy-group}). This command uses the process/prefix
2734 convention (@pxref{Process/Prefix}).
2738 @findex gnus-topic-remove-group
2739 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2740 This command is mainly useful if you have the same group in several
2741 topics and wish to remove it from one of the topics. You may also
2742 remove a group from all topics, but in that case, Gnus will add it to
2743 the root topic the next time you start Gnus. In fact, all new groups
2744 (which, naturally, don't belong to any topic) will show up in the root
2747 This command uses the process/prefix convention
2748 (@pxref{Process/Prefix}).
2752 @findex gnus-topic-move-matching
2753 Move all groups that match some regular expression to a topic
2754 (@code{gnus-topic-move-matching}).
2758 @findex gnus-topic-copy-matching
2759 Copy all groups that match some regular expression to a topic
2760 (@code{gnus-topic-copy-matching}).
2764 @findex gnus-topic-toggle-display-empty-topics
2765 Toggle hiding empty topics
2766 (@code{gnus-topic-toggle-display-empty-topics}).
2770 @findex gnus-topic-mark-topic
2771 Mark all groups in the current topic with the process mark
2772 (@code{gnus-topic-mark-topic}).
2775 @kindex T M-# (Topic)
2776 @findex gnus-topic-unmark-topic
2777 Remove the process mark from all groups in the current topic
2778 (@code{gnus-topic-unmark-topic}).
2782 @kindex T TAB (Topic)
2784 @findex gnus-topic-indent
2785 ``Indent'' the current topic so that it becomes a sub-topic of the
2786 previous topic (@code{gnus-topic-indent}). If given a prefix,
2787 ``un-indent'' the topic instead.
2790 @kindex M-TAB (Topic)
2791 @findex gnus-topic-unindent
2792 ``Un-indent'' the current topic so that it becomes a sub-topic of the
2793 parent of its current parent (@code{gnus-topic-unindent}).
2797 @findex gnus-topic-select-group
2799 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2800 When you perform this command on a group, you'll enter the group, as
2801 usual. When done on a topic line, the topic will be folded (if it was
2802 visible) or unfolded (if it was folded already). So it's basically a
2803 toggling command on topics. In addition, if you give a numerical
2804 prefix, group on that level (and lower) will be displayed.
2807 @kindex C-c C-x (Topic)
2808 @findex gnus-topic-expire-articles
2809 Run all expirable articles in the current group or topic through the expiry
2810 process (if any) (@code{gnus-topic-expire-articles}).
2814 @findex gnus-topic-kill-group
2815 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
2816 topic will be removed along with the topic.
2820 @findex gnus-topic-yank-group
2821 Yank the previously killed group or topic
2822 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
2827 @findex gnus-topic-rename
2828 Rename a topic (@code{gnus-topic-rename}).
2831 @kindex T DEL (Topic)
2832 @findex gnus-topic-delete
2833 Delete an empty topic (@code{gnus-topic-delete}).
2837 @findex gnus-topic-list-active
2838 List all groups that Gnus knows about in a topics-ified way
2839 (@code{gnus-topic-list-active}).
2843 @findex gnus-topic-edit-parameters
2844 @cindex group parameters
2845 @cindex topic parameters
2847 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2848 @xref{Topic Parameters}.
2854 @subsection Topic Sorting
2855 @cindex topic sorting
2857 You can sort the groups in each topic individually with the following
2863 @kindex T S a (Topic)
2864 @findex gnus-topic-sort-groups-by-alphabet
2865 Sort the current topic alphabetically by group name
2866 (@code{gnus-topic-sort-groups-by-alphabet}).
2869 @kindex T S u (Topic)
2870 @findex gnus-topic-sort-groups-by-unread
2871 Sort the current topic by the number of unread articles
2872 (@code{gnus-topic-sort-groups-by-unread}).
2875 @kindex T S l (Topic)
2876 @findex gnus-topic-sort-groups-by-level
2877 Sort the current topic by group level
2878 (@code{gnus-topic-sort-groups-by-level}).
2881 @kindex T S v (Topic)
2882 @findex gnus-topic-sort-groups-by-score
2883 Sort the current topic by group score
2884 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
2887 @kindex T S r (Topic)
2888 @findex gnus-topic-sort-groups-by-rank
2889 Sort the current topic by group rank
2890 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
2893 @kindex T S m (Topic)
2894 @findex gnus-topic-sort-groups-by-method
2895 Sort the current topic alphabetically by backend name
2896 (@code{gnus-topic-sort-groups-by-method}).
2900 @xref{Sorting Groups}, for more information about group sorting.
2903 @node Topic Topology
2904 @subsection Topic Topology
2905 @cindex topic topology
2908 So, let's have a look at an example group buffer:
2914 2: alt.religion.emacs
2917 0: comp.talk.emacs.recovery
2919 8: comp.binaries.fractals
2920 13: comp.sources.unix
2923 So, here we have one top-level topic (@samp{Gnus}), two topics under
2924 that, and one sub-topic under one of the sub-topics. (There is always
2925 just one (1) top-level topic). This topology can be expressed as
2930 (("Emacs -- I wuw it!" visible)
2931 (("Naughty Emacs" visible)))
2935 @vindex gnus-topic-topology
2936 This is in fact how the variable @code{gnus-topic-topology} would look
2937 for the display above. That variable is saved in the @file{.newsrc.eld}
2938 file, and shouldn't be messed with manually---unless you really want
2939 to. Since this variable is read from the @file{.newsrc.eld} file,
2940 setting it in any other startup files will have no effect.
2942 This topology shows what topics are sub-topics of what topics (right),
2943 and which topics are visible. Two settings are currently
2944 allowed---@code{visible} and @code{invisible}.
2947 @node Topic Parameters
2948 @subsection Topic Parameters
2949 @cindex topic parameters
2951 All groups in a topic will inherit group parameters from the parent (and
2952 ancestor) topic parameters. All valid group parameters are valid topic
2953 parameters (@pxref{Group Parameters}).
2955 Group parameters (of course) override topic parameters, and topic
2956 parameters in sub-topics override topic parameters in super-topics. You
2957 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
2958 verb, although you may feel free to disagree with me here.)
2964 2: alt.religion.emacs
2968 0: comp.talk.emacs.recovery
2970 8: comp.binaries.fractals
2971 13: comp.sources.unix
2975 The @samp{Emacs} topic has the topic parameter @code{(score-file
2976 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2977 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2978 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
2979 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
2980 . "religion.SCORE")}.
2982 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2983 will get the @file{relief.SCORE} home score file. If you enter the same
2984 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2985 score file. If you enter the group @samp{alt.religion.emacs}, you'll
2986 get the @file{religion.SCORE} home score file.
2988 This seems rather simple and self-evident, doesn't it? Well, yes. But
2989 there are some problems, especially with the @code{total-expiry}
2990 parameter. Say you have a mail group in two topics; one with
2991 @code{total-expiry} and one without. What happens when you do @kbd{M-x
2992 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
2993 of these topics you mean to expire articles from, so anything may
2994 happen. In fact, I hereby declare that it is @dfn{undefined} what
2995 happens. You just have to be careful if you do stuff like that.
2998 @node Misc Group Stuff
2999 @section Misc Group Stuff
3002 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
3003 * Group Information:: Information and help on groups and Gnus.
3004 * Group Timestamp:: Making Gnus keep track of when you last read a group.
3005 * File Commands:: Reading and writing the Gnus files.
3012 @findex gnus-group-enter-server-mode
3013 Enter the server buffer (@code{gnus-group-enter-server-mode}).
3014 @xref{The Server Buffer}.
3018 @findex gnus-group-post-news
3019 Post an article to a group (@code{gnus-group-post-news}). If given a
3020 prefix, the current group name will be used as the default.
3024 @findex gnus-group-mail
3025 Mail a message somewhere (@code{gnus-group-mail}).
3029 Variables for the group buffer:
3033 @item gnus-group-mode-hook
3034 @vindex gnus-group-mode-hook
3035 is called after the group buffer has been
3038 @item gnus-group-prepare-hook
3039 @vindex gnus-group-prepare-hook
3040 is called after the group buffer is
3041 generated. It may be used to modify the buffer in some strange,
3044 @item gnus-group-prepared-hook
3045 @vindex gnus-group-prepare-hook
3046 is called as the very last thing after the group buffer has been
3047 generated. It may be used to move point around, for instance.
3049 @item gnus-permanently-visible-groups
3050 @vindex gnus-permanently-visible-groups
3051 Groups matching this regexp will always be listed in the group buffer,
3052 whether they are empty or not.
3057 @node Scanning New Messages
3058 @subsection Scanning New Messages
3059 @cindex new messages
3060 @cindex scanning new news
3066 @findex gnus-group-get-new-news
3067 @c @icon{gnus-group-get-new-news}
3068 Check the server(s) for new articles. If the numerical prefix is used,
3069 this command will check only groups of level @var{arg} and lower
3070 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
3071 command will force a total re-reading of the active file(s) from the
3076 @findex gnus-group-get-new-news-this-group
3077 @vindex gnus-goto-next-group-when-activating
3078 @c @icon{gnus-group-get-new-news-this-group}
3079 Check whether new articles have arrived in the current group
3080 (@code{gnus-group-get-new-news-this-group}).
3081 @code{gnus-goto-next-group-when-activating} says whether this command is
3082 to move point to the next group or not. It is @code{t} by default.
3084 @findex gnus-activate-all-groups
3085 @cindex activating groups
3087 @kindex C-c M-g (Group)
3088 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3093 @findex gnus-group-restart
3094 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
3095 file(s), closes the connection to all servers, clears up all run-time
3096 Gnus variables, and then starts Gnus all over again.
3100 @vindex gnus-get-new-news-hook
3101 @code{gnus-get-new-news-hook} is run just before checking for new news.
3103 @vindex gnus-after-getting-new-news-hook
3104 @code{gnus-after-getting-new-news-hook} is run after checking for new
3108 @node Group Information
3109 @subsection Group Information
3110 @cindex group information
3111 @cindex information on groups
3118 @findex gnus-group-fetch-faq
3119 @vindex gnus-group-faq-directory
3122 Try to fetch the FAQ for the current group
3123 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
3124 @code{gnus-group-faq-directory}, which is usually a directory on a
3125 remote machine. This variable can also be a list of directories. In
3126 that case, giving a prefix to this command will allow you to choose
3127 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
3128 for fetching the file.
3130 If fetching from the first site is unsuccessful, Gnus will attempt to go
3131 through @code{gnus-group-faq-directory} and try to open them one by one.
3135 @c @icon{gnus-group-describe-group}
3137 @kindex C-c C-d (Group)
3138 @cindex describing groups
3139 @cindex group description
3140 @findex gnus-group-describe-group
3141 Describe the current group (@code{gnus-group-describe-group}). If given
3142 a prefix, force Gnus to re-read the description from the server.
3146 @findex gnus-group-describe-all-groups
3147 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
3148 prefix, force Gnus to re-read the description file from the server.
3155 @findex gnus-version
3156 Display current Gnus version numbers (@code{gnus-version}).
3160 @findex gnus-group-describe-briefly
3161 Give a very short help message (@code{gnus-group-describe-briefly}).
3164 @kindex C-c C-i (Group)
3167 @findex gnus-info-find-node
3168 Go to the Gnus info node (@code{gnus-info-find-node}).
3172 @node Group Timestamp
3173 @subsection Group Timestamp
3175 @cindex group timestamps
3177 It can be convenient to let Gnus keep track of when you last read a
3178 group. To set the ball rolling, you should add
3179 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3182 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3185 After doing this, each time you enter a group, it'll be recorded.
3187 This information can be displayed in various ways---the easiest is to
3188 use the @samp{%d} spec in the group line format:
3191 (setq gnus-group-line-format
3192 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3195 This will result in lines looking like:
3198 * 0: mail.ding 19961002T012943
3199 0: custom 19961002T012713
3202 As you can see, the date is displayed in compact ISO 8601 format. This
3203 may be a bit too much, so to just display the date, you could say
3207 (setq gnus-group-line-format
3208 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3213 @subsection File Commands
3214 @cindex file commands
3220 @findex gnus-group-read-init-file
3221 @vindex gnus-init-file
3222 @cindex reading init file
3223 Re-read the init file (@code{gnus-init-file}, which defaults to
3224 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3228 @findex gnus-group-save-newsrc
3229 @cindex saving .newsrc
3230 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3231 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
3232 file(s) whether Gnus thinks it is necessary or not.
3235 @c @kindex Z (Group)
3236 @c @findex gnus-group-clear-dribble
3237 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3242 @node The Summary Buffer
3243 @chapter The Summary Buffer
3244 @cindex summary buffer
3246 A line for each article is displayed in the summary buffer. You can
3247 move around, read articles, post articles and reply to articles.
3249 The most common way to a summary buffer is to select a group from the
3250 group buffer (@pxref{Selecting a Group}).
3252 You can have as many summary buffers open as you wish.
3255 * Summary Buffer Format:: Deciding how the summary buffer is to look.
3256 * Summary Maneuvering:: Moving around the summary buffer.
3257 * Choosing Articles:: Reading articles.
3258 * Paging the Article:: Scrolling the current article.
3259 * Reply Followup and Post:: Posting articles.
3260 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
3261 * Marking Articles:: Marking articles as read, expirable, etc.
3262 * Limiting:: You can limit the summary buffer.
3263 * Threading:: How threads are made.
3264 * Sorting:: How articles and threads are sorted.
3265 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
3266 * Article Caching:: You may store articles in a cache.
3267 * Persistent Articles:: Making articles expiry-resistant.
3268 * Article Backlog:: Having already read articles hang around.
3269 * Saving Articles:: Ways of customizing article saving.
3270 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
3271 * Article Treatment:: The article buffer can be mangled at will.
3272 * MIME Commands:: Doing MIMEy things with the articles.
3273 * Charsets:: Character set issues.
3274 * Article Commands:: Doing various things with the article buffer.
3275 * Summary Sorting:: Sorting the summary buffer in various ways.
3276 * Finding the Parent:: No child support? Get the parent.
3277 * Alternative Approaches:: Reading using non-default summaries.
3278 * Tree Display:: A more visual display of threads.
3279 * Mail Group Commands:: Some commands can only be used in mail groups.
3280 * Various Summary Stuff:: What didn't fit anywhere else.
3281 * Exiting the Summary Buffer:: Returning to the Group buffer.
3282 * Crosspost Handling:: How crossposted articles are dealt with.
3283 * Duplicate Suppression:: An alternative when crosspost handling fails.
3287 @node Summary Buffer Format
3288 @section Summary Buffer Format
3289 @cindex summary buffer format
3293 \gnusfigure{The Summary Buffer}{180}{
3294 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3295 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3301 * Summary Buffer Lines:: You can specify how summary lines should look.
3302 * To From Newsgroups:: How to not display your own name.
3303 * Summary Buffer Mode Line:: You can say how the mode line should look.
3304 * Summary Highlighting:: Making the summary buffer all pretty and nice.
3307 @findex mail-extract-address-components
3308 @findex gnus-extract-address-components
3309 @vindex gnus-extract-address-components
3310 Gnus will use the value of the @code{gnus-extract-address-components}
3311 variable as a function for getting the name and address parts of a
3312 @code{From} header. Two pre-defined functions exist:
3313 @code{gnus-extract-address-components}, which is the default, quite
3314 fast, and too simplistic solution; and
3315 @code{mail-extract-address-components}, which works very nicely, but is
3316 slower. The default function will return the wrong answer in 5% of the
3317 cases. If this is unacceptable to you, use the other function instead:
3320 (setq gnus-extract-address-components
3321 'mail-extract-address-components)
3324 @vindex gnus-summary-same-subject
3325 @code{gnus-summary-same-subject} is a string indicating that the current
3326 article has the same subject as the previous. This string will be used
3327 with those specs that require it. The default is @code{""}.
3330 @node Summary Buffer Lines
3331 @subsection Summary Buffer Lines
3333 @vindex gnus-summary-line-format
3334 You can change the format of the lines in the summary buffer by changing
3335 the @code{gnus-summary-line-format} variable. It works along the same
3336 lines as a normal @code{format} string, with some extensions
3337 (@pxref{Formatting Variables}).
3339 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3341 The following format specification characters are understood:
3349 Subject if the article is the root of the thread or the previous article
3350 had a different subject, @code{gnus-summary-same-subject} otherwise.
3351 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3353 Full @code{From} header.
3355 The name (from the @code{From} header).
3357 The name, code @code{To} header or the @code{Newsgroups} header
3358 (@pxref{To From Newsgroups}).
3360 The name (from the @code{From} header). This differs from the @code{n}
3361 spec in that it uses the function designated by the
3362 @code{gnus-extract-address-components} variable, which is slower, but
3363 may be more thorough.
3365 The address (from the @code{From} header). This works the same way as
3368 Number of lines in the article.
3370 Number of characters in the article.
3372 Indentation based on thread level (@pxref{Customizing Threading}).
3374 Nothing if the article is a root and lots of spaces if it isn't (it
3375 pushes everything after it off the screen).
3377 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3378 for adopted articles (@pxref{Customizing Threading}).
3380 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3381 for adopted articles.
3383 One space for each thread level.
3385 Twenty minus thread level spaces.
3390 This misleadingly named specifier is the @dfn{secondary mark}. This
3391 mark will say whether the article has been replied to, has been cached,
3395 Score as a number (@pxref{Scoring}).
3397 @vindex gnus-summary-zcore-fuzz
3398 Zcore, @samp{+} if above the default level and @samp{-} if below the
3399 default level. If the difference between
3400 @code{gnus-summary-default-score} and the score is less than
3401 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3409 The @code{Date} in @code{DD-MMM} format.
3411 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3417 Number of articles in the current sub-thread. Using this spec will slow
3418 down summary buffer generation somewhat.
3420 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3421 article has any children.
3427 User defined specifier. The next character in the format string should
3428 be a letter. Gnus will call the function
3429 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3430 following @samp{%u}. The function will be passed the current header as
3431 argument. The function should return a string, which will be inserted
3432 into the summary just like information from any other summary specifier.
3435 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3436 have to be handled with care. For reasons of efficiency, Gnus will
3437 compute what column these characters will end up in, and ``hard-code''
3438 that. This means that it is invalid to have these specs after a
3439 variable-length spec. Well, you might not be arrested, but your summary
3440 buffer will look strange, which is bad enough.
3442 The smart choice is to have these specs as far to the left as possible.
3443 (Isn't that the case with everything, though? But I digress.)
3445 This restriction may disappear in later versions of Gnus.
3448 @node To From Newsgroups
3449 @subsection To From Newsgroups
3453 In some groups (particularly in archive groups), the @code{From} header
3454 isn't very interesting, since all the articles there are written by
3455 you. To display the information in the @code{To} or @code{Newsgroups}
3456 headers instead, you need to decide three things: What information to
3457 gather; where to display it; and when to display it.
3461 @vindex gnus-extra-headers
3462 The reading of extra header information is controlled by the
3463 @code{gnus-extra-headers}. This is a list of header symbols. For
3467 (setq gnus-extra-headers
3468 '(To Newsgroups X-Newsreader))
3471 This will result in Gnus trying to obtain these three headers, and
3472 storing it in header structures for later easy retrieval.
3475 @findex gnus-extra-header
3476 The value of these extra headers can be accessed via the
3477 @code{gnus-extra-header} function. Here's a format line spec that will
3478 access the @code{X-Newsreader} header:
3481 "%~(form (gnus-extra-header 'X-Newsreader))@@"
3485 @vindex gnus-ignored-from-addresses
3486 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
3487 summary line spec returns the @code{To}, @code{Newsreader} or
3488 @code{From} header. If this regexp matches the contents of the
3489 @code{From} header, the value of the @code{To} or @code{Newsreader}
3490 headers are used instead.
3494 @vindex nnmail-extra-headers
3495 A related variable is @code{nnmail-extra-headers}, which controls when
3496 to include extra headers when generating overview (@sc{nov}) files. If
3497 you have old overview files, you should regenerate them after changing
3500 @vindex gnus-summary-line-format
3501 You also have to instruct Gnus to display the data by changing the
3502 @code{%n} spec to the @code{%f} spec in the
3503 @code{gnus-summary-line-format} variable.
3505 In summary, you'd typically do something like the following:
3508 (setq gnus-extra-headers
3510 (setq nnmail-extra-headers gnus-extra-headers)
3511 (setq gnus-summary-line-format
3512 "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n")
3513 (setq gnus-ignored-from-addresses
3517 Now, this is mostly useful for mail groups, where you have control over
3518 the @sc{nov} files that are created. However, if you can persuade your
3525 to the end of her @file{overview.fmt} file, then you can use that just
3526 as you would the extra headers from the mail groups.
3529 @node Summary Buffer Mode Line
3530 @subsection Summary Buffer Mode Line
3532 @vindex gnus-summary-mode-line-format
3533 You can also change the format of the summary mode bar (@pxref{Mode Line
3534 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
3535 like. The default is @samp{Gnus: %%b [%A] %Z}.
3537 Here are the elements you can play with:
3543 Unprefixed group name.
3545 Current article number.
3547 Current article score.
3551 Number of unread articles in this group.
3553 Number of unread articles in this group that aren't displayed in the
3556 A string with the number of unread and unselected articles represented
3557 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3558 articles, and just as @samp{<%U more>} if there are just unread articles
3559 and no unselected ones.
3561 Shortish group name. For instance, @samp{rec.arts.anime} will be
3562 shortened to @samp{r.a.anime}.
3564 Subject of the current article.
3566 User-defined spec (@pxref{User-Defined Specs}).
3568 Name of the current score file (@pxref{Scoring}).
3570 Number of dormant articles (@pxref{Unread Articles}).
3572 Number of ticked articles (@pxref{Unread Articles}).
3574 Number of articles that have been marked as read in this session.
3576 Number of articles expunged by the score files.
3580 @node Summary Highlighting
3581 @subsection Summary Highlighting
3585 @item gnus-visual-mark-article-hook
3586 @vindex gnus-visual-mark-article-hook
3587 This hook is run after selecting an article. It is meant to be used for
3588 highlighting the article in some way. It is not run if
3589 @code{gnus-visual} is @code{nil}.
3591 @item gnus-summary-update-hook
3592 @vindex gnus-summary-update-hook
3593 This hook is called when a summary line is changed. It is not run if
3594 @code{gnus-visual} is @code{nil}.
3596 @item gnus-summary-selected-face
3597 @vindex gnus-summary-selected-face
3598 This is the face (or @dfn{font} as some people call it) used to
3599 highlight the current article in the summary buffer.
3601 @item gnus-summary-highlight
3602 @vindex gnus-summary-highlight
3603 Summary lines are highlighted according to this variable, which is a
3604 list where the elements are of the format @var{(FORM . FACE)}. If you
3605 would, for instance, like ticked articles to be italic and high-scored
3606 articles to be bold, you could set this variable to something like
3608 (((eq mark gnus-ticked-mark) . italic)
3609 ((> score default) . bold))
3611 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3612 @var{FACE} will be applied to the line.
3616 @node Summary Maneuvering
3617 @section Summary Maneuvering
3618 @cindex summary movement
3620 All the straight movement commands understand the numeric prefix and
3621 behave pretty much as you'd expect.
3623 None of these commands select articles.
3628 @kindex M-n (Summary)
3629 @kindex G M-n (Summary)
3630 @findex gnus-summary-next-unread-subject
3631 Go to the next summary line of an unread article
3632 (@code{gnus-summary-next-unread-subject}).
3636 @kindex M-p (Summary)
3637 @kindex G M-p (Summary)
3638 @findex gnus-summary-prev-unread-subject
3639 Go to the previous summary line of an unread article
3640 (@code{gnus-summary-prev-unread-subject}).
3645 @kindex G j (Summary)
3646 @findex gnus-summary-goto-article
3647 Ask for an article number or @code{Message-ID}, and then go to that
3648 article (@code{gnus-summary-goto-article}).
3651 @kindex G g (Summary)
3652 @findex gnus-summary-goto-subject
3653 Ask for an article number and then go to the summary line of that article
3654 without displaying the article (@code{gnus-summary-goto-subject}).
3657 If Gnus asks you to press a key to confirm going to the next group, you
3658 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3659 buffer, searching for the next group to read without actually returning
3660 to the group buffer.
3662 Variables related to summary movement:
3666 @vindex gnus-auto-select-next
3667 @item gnus-auto-select-next
3668 If you issue one of the movement commands (like @kbd{n}) and there are
3669 no more unread articles after the current one, Gnus will offer to go to
3670 the next group. If this variable is @code{t} and the next group is
3671 empty, Gnus will exit summary mode and return to the group buffer. If
3672 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3673 next group, no matter whether it has any unread articles or not. As a
3674 special case, if this variable is @code{quietly}, Gnus will select the
3675 next group without asking for confirmation. If this variable is
3676 @code{almost-quietly}, the same will happen only if you are located on
3677 the last article in the group. Finally, if this variable is
3678 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3679 without confirmation. Also @pxref{Group Levels}.
3681 @item gnus-auto-select-same
3682 @vindex gnus-auto-select-same
3683 If non-@code{nil}, all the movement commands will try to go to the next
3684 article with the same subject as the current. (@dfn{Same} here might
3685 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
3686 for details (@pxref{Customizing Threading}).) If there are no more
3687 articles with the same subject, go to the first unread article.
3689 This variable is not particularly useful if you use a threaded display.
3691 @item gnus-summary-check-current
3692 @vindex gnus-summary-check-current
3693 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3694 to the next (or previous) article if the current article is unread.
3695 Instead, they will choose the current article.
3697 @item gnus-auto-center-summary
3698 @vindex gnus-auto-center-summary
3699 If non-@code{nil}, Gnus will keep the point in the summary buffer
3700 centered at all times. This makes things quite tidy, but if you have a
3701 slow network connection, or simply do not like this un-Emacsism, you can
3702 set this variable to @code{nil} to get the normal Emacs scrolling
3703 action. This will also inhibit horizontal re-centering of the summary
3704 buffer, which might make it more inconvenient to read extremely long
3707 This variable can also be a number. In that case, center the window at
3708 the given number of lines from the top.
3713 @node Choosing Articles
3714 @section Choosing Articles
3715 @cindex selecting articles
3718 * Choosing Commands:: Commands for choosing articles.
3719 * Choosing Variables:: Variables that influence these commands.
3723 @node Choosing Commands
3724 @subsection Choosing Commands
3726 None of the following movement commands understand the numeric prefix,
3727 and they all select and display an article.
3731 @kindex SPACE (Summary)
3732 @findex gnus-summary-next-page
3733 Select the current article, or, if that one's read already, the next
3734 unread article (@code{gnus-summary-next-page}).
3739 @kindex G n (Summary)
3740 @findex gnus-summary-next-unread-article
3741 @c @icon{gnus-summary-next-unread}
3742 Go to next unread article (@code{gnus-summary-next-unread-article}).
3747 @findex gnus-summary-prev-unread-article
3748 @c @icon{gnus-summary-prev-unread}
3749 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3754 @kindex G N (Summary)
3755 @findex gnus-summary-next-article
3756 Go to the next article (@code{gnus-summary-next-article}).
3761 @kindex G P (Summary)
3762 @findex gnus-summary-prev-article
3763 Go to the previous article (@code{gnus-summary-prev-article}).
3766 @kindex G C-n (Summary)
3767 @findex gnus-summary-next-same-subject
3768 Go to the next article with the same subject
3769 (@code{gnus-summary-next-same-subject}).
3772 @kindex G C-p (Summary)
3773 @findex gnus-summary-prev-same-subject
3774 Go to the previous article with the same subject
3775 (@code{gnus-summary-prev-same-subject}).
3779 @kindex G f (Summary)
3781 @findex gnus-summary-first-unread-article
3782 Go to the first unread article
3783 (@code{gnus-summary-first-unread-article}).
3787 @kindex G b (Summary)
3789 @findex gnus-summary-best-unread-article
3790 Go to the article with the highest score
3791 (@code{gnus-summary-best-unread-article}).
3796 @kindex G l (Summary)
3797 @findex gnus-summary-goto-last-article
3798 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3801 @kindex G o (Summary)
3802 @findex gnus-summary-pop-article
3804 @cindex article history
3805 Pop an article off the summary history and go to this article
3806 (@code{gnus-summary-pop-article}). This command differs from the
3807 command above in that you can pop as many previous articles off the
3808 history as you like, while @kbd{l} toggles the two last read articles.
3809 For a somewhat related issue (if you use these commands a lot),
3810 @pxref{Article Backlog}.
3814 @node Choosing Variables
3815 @subsection Choosing Variables
3817 Some variables relevant for moving and selecting articles:
3820 @item gnus-auto-extend-newsgroup
3821 @vindex gnus-auto-extend-newsgroup
3822 All the movement commands will try to go to the previous (or next)
3823 article, even if that article isn't displayed in the Summary buffer if
3824 this variable is non-@code{nil}. Gnus will then fetch the article from
3825 the server and display it in the article buffer.
3827 @item gnus-select-article-hook
3828 @vindex gnus-select-article-hook
3829 This hook is called whenever an article is selected. By default it
3830 exposes any threads hidden under the selected article.
3832 @item gnus-mark-article-hook
3833 @vindex gnus-mark-article-hook
3834 @findex gnus-summary-mark-unread-as-read
3835 @findex gnus-summary-mark-read-and-unread-as-read
3836 @findex gnus-unread-mark
3837 This hook is called whenever an article is selected. It is intended to
3838 be used for marking articles as read. The default value is
3839 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3840 mark of almost any article you read to @code{gnus-unread-mark}. The
3841 only articles not affected by this function are ticked, dormant, and
3842 expirable articles. If you'd instead like to just have unread articles
3843 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3844 instead. It will leave marks like @code{gnus-low-score-mark},
3845 @code{gnus-del-mark} (and so on) alone.
3850 @node Paging the Article
3851 @section Scrolling the Article
3852 @cindex article scrolling
3857 @kindex SPACE (Summary)
3858 @findex gnus-summary-next-page
3859 Pressing @kbd{SPACE} will scroll the current article forward one page,
3860 or, if you have come to the end of the current article, will choose the
3861 next article (@code{gnus-summary-next-page}).
3864 @kindex DEL (Summary)
3865 @findex gnus-summary-prev-page
3866 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3869 @kindex RET (Summary)
3870 @findex gnus-summary-scroll-up
3871 Scroll the current article one line forward
3872 (@code{gnus-summary-scroll-up}).
3875 @kindex M-RET (Summary)
3876 @findex gnus-summary-scroll-down
3877 Scroll the current article one line backward
3878 (@code{gnus-summary-scroll-down}).
3882 @kindex A g (Summary)
3884 @findex gnus-summary-show-article
3885 (Re)fetch the current article (@code{gnus-summary-show-article}). If
3886 given a prefix, fetch the current article, but don't run any of the
3887 article treatment functions. This will give you a ``raw'' article, just
3888 the way it came from the server.
3893 @kindex A < (Summary)
3894 @findex gnus-summary-beginning-of-article
3895 Scroll to the beginning of the article
3896 (@code{gnus-summary-beginning-of-article}).
3901 @kindex A > (Summary)
3902 @findex gnus-summary-end-of-article
3903 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3907 @kindex A s (Summary)
3909 @findex gnus-summary-isearch-article
3910 Perform an isearch in the article buffer
3911 (@code{gnus-summary-isearch-article}).
3915 @findex gnus-summary-select-article-buffer
3916 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3921 @node Reply Followup and Post
3922 @section Reply, Followup and Post
3925 * Summary Mail Commands:: Sending mail.
3926 * Summary Post Commands:: Sending news.
3930 @node Summary Mail Commands
3931 @subsection Summary Mail Commands
3933 @cindex composing mail
3935 Commands for composing a mail message:
3941 @kindex S r (Summary)
3943 @findex gnus-summary-reply
3944 @c @icon{gnus-summary-mail-reply}
3945 @c @icon{gnus-summary-reply}
3946 Mail a reply to the author of the current article
3947 (@code{gnus-summary-reply}).
3952 @kindex S R (Summary)
3953 @findex gnus-summary-reply-with-original
3954 @c @icon{gnus-summary-reply-with-original}
3955 Mail a reply to the author of the current article and include the
3956 original message (@code{gnus-summary-reply-with-original}). This
3957 command uses the process/prefix convention.
3960 @kindex S w (Summary)
3961 @findex gnus-summary-wide-reply
3962 Mail a wide reply to the author of the current article
3963 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
3964 goes out to all people listed in the @code{To}, @code{From} (or
3965 @code{Reply-to}) and @code{Cc} headers.
3968 @kindex S W (Summary)
3969 @findex gnus-summary-wide-reply-with-original
3970 Mail a wide reply to the current article and include the original
3971 message (@code{gnus-summary-wide-reply-with-original}). This command uses
3972 the process/prefix convention.
3975 @kindex S o m (Summary)
3976 @findex gnus-summary-mail-forward
3977 @c @icon{gnus-summary-mail-forward}
3978 Forward the current article to some other person
3979 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
3980 headers of the forwarded article.
3985 @kindex S m (Summary)
3986 @findex gnus-summary-mail-other-window
3987 @c @icon{gnus-summary-mail-originate}
3988 Send a mail to some other person
3989 (@code{gnus-summary-mail-other-window}).
3992 @kindex S D b (Summary)
3993 @findex gnus-summary-resend-bounced-mail
3994 @cindex bouncing mail
3995 If you have sent a mail, but the mail was bounced back to you for some
3996 reason (wrong address, transient failure), you can use this command to
3997 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
3998 will be popped into a mail buffer where you can edit the headers before
3999 sending the mail off again. If you give a prefix to this command, and
4000 the bounced mail is a reply to some other mail, Gnus will try to fetch
4001 that mail and display it for easy perusal of its headers. This might
4002 very well fail, though.
4005 @kindex S D r (Summary)
4006 @findex gnus-summary-resend-message
4007 Not to be confused with the previous command,
4008 @code{gnus-summary-resend-message} will prompt you for an address to
4009 send the current message off to, and then send it to that place. The
4010 headers of the message won't be altered---but lots of headers that say
4011 @code{Resent-To}, @code{Resent-From} and so on will be added. This
4012 means that you actually send a mail to someone that has a @code{To}
4013 header that (probably) points to yourself. This will confuse people.
4014 So, natcherly you'll only do that if you're really eVIl.
4016 This command is mainly used if you have several accounts and want to
4017 ship a mail to a different account of yours. (If you're both
4018 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4019 to the @code{root} account, you may want to resend it to
4020 @code{postmaster}. Ordnung muß sein!
4022 This command understands the process/prefix convention
4023 (@pxref{Process/Prefix}).
4026 @kindex S O m (Summary)
4027 @findex gnus-uu-digest-mail-forward
4028 Digest the current series (@pxref{Decoding Articles}) and forward the
4029 result using mail (@code{gnus-uu-digest-mail-forward}). This command
4030 uses the process/prefix convention (@pxref{Process/Prefix}).
4033 @kindex S M-c (Summary)
4034 @findex gnus-summary-mail-crosspost-complaint
4035 @cindex crossposting
4036 @cindex excessive crossposting
4037 Send a complaint about excessive crossposting to the author of the
4038 current article (@code{gnus-summary-mail-crosspost-complaint}).
4040 @findex gnus-crosspost-complaint
4041 This command is provided as a way to fight back against the current
4042 crossposting pandemic that's sweeping Usenet. It will compose a reply
4043 using the @code{gnus-crosspost-complaint} variable as a preamble. This
4044 command understands the process/prefix convention
4045 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4049 Also @pxref{(message)Header Commands} for more information.
4052 @node Summary Post Commands
4053 @subsection Summary Post Commands
4055 @cindex composing news
4057 Commands for posting a news article:
4063 @kindex S p (Summary)
4064 @findex gnus-summary-post-news
4065 @c @icon{gnus-summary-post-news}
4066 Post an article to the current group
4067 (@code{gnus-summary-post-news}).
4072 @kindex S f (Summary)
4073 @findex gnus-summary-followup
4074 @c @icon{gnus-summary-followup}
4075 Post a followup to the current article (@code{gnus-summary-followup}).
4079 @kindex S F (Summary)
4081 @c @icon{gnus-summary-followup-with-original}
4082 @findex gnus-summary-followup-with-original
4083 Post a followup to the current article and include the original message
4084 (@code{gnus-summary-followup-with-original}). This command uses the
4085 process/prefix convention.
4088 @kindex S n (Summary)
4089 @findex gnus-summary-followup-to-mail
4090 Post a followup to the current article via news, even if you got the
4091 message through mail (@code{gnus-summary-followup-to-mail}).
4094 @kindex S N (Summary)
4095 @findex gnus-summary-followup-to-mail-with-original
4096 Post a followup to the current article via news, even if you got the
4097 message through mail and include the original message
4098 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
4099 the process/prefix convention.
4102 @kindex S o p (Summary)
4103 @findex gnus-summary-post-forward
4104 Forward the current article to a newsgroup
4105 (@code{gnus-summary-post-forward}). If given a prefix, include the full
4106 headers of the forwarded article.
4109 @kindex S O p (Summary)
4110 @findex gnus-uu-digest-post-forward
4112 @cindex making digests
4113 Digest the current series and forward the result to a newsgroup
4114 (@code{gnus-uu-digest-mail-forward}). This command uses the
4115 process/prefix convention.
4118 @kindex S u (Summary)
4119 @findex gnus-uu-post-news
4120 @c @icon{gnus-uu-post-news}
4121 Uuencode a file, split it into parts, and post it as a series
4122 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
4125 Also @pxref{(message)Header Commands} for more information.
4128 @node Canceling and Superseding
4129 @section Canceling Articles
4130 @cindex canceling articles
4131 @cindex superseding articles
4133 Have you ever written something, and then decided that you really,
4134 really, really wish you hadn't posted that?
4136 Well, you can't cancel mail, but you can cancel posts.
4138 @findex gnus-summary-cancel-article
4140 @c @icon{gnus-summary-cancel-article}
4141 Find the article you wish to cancel (you can only cancel your own
4142 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
4143 c} (@code{gnus-summary-cancel-article}). Your article will be
4144 canceled---machines all over the world will be deleting your article.
4145 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4147 Be aware, however, that not all sites honor cancels, so your article may
4148 live on here and there, while most sites will delete the article in
4151 Gnus will use the ``current'' select method when canceling. If you
4152 want to use the standard posting method, use the @samp{a} symbolic
4153 prefix (@pxref{Symbolic Prefixes}).
4155 If you discover that you have made some mistakes and want to do some
4156 corrections, you can post a @dfn{superseding} article that will replace
4157 your original article.
4159 @findex gnus-summary-supersede-article
4161 Go to the original article and press @kbd{S s}
4162 (@code{gnus-summary-supersede-article}). You will be put in a buffer
4163 where you can edit the article all you want before sending it off the
4166 The same goes for superseding as for canceling, only more so: Some
4167 sites do not honor superseding. On those sites, it will appear that you
4168 have posted almost the same article twice.
4170 If you have just posted the article, and change your mind right away,
4171 there is a trick you can use to cancel/supersede the article without
4172 waiting for the article to appear on your site first. You simply return
4173 to the post buffer (which is called @code{*sent ...*}). There you will
4174 find the article you just posted, with all the headers intact. Change
4175 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4176 header by substituting one of those words for the word
4177 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
4178 you would do normally. The previous article will be
4179 canceled/superseded.
4181 Just remember, kids: There is no 'c' in 'supersede'.
4184 @node Marking Articles
4185 @section Marking Articles
4186 @cindex article marking
4187 @cindex article ticking
4190 There are several marks you can set on an article.
4192 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4193 neologism ohoy!) of the article. Alphabetic marks generally mean
4194 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4196 In addition, you also have marks that do not affect readedness.
4199 * Unread Articles:: Marks for unread articles.
4200 * Read Articles:: Marks for read articles.
4201 * Other Marks:: Marks that do not affect readedness.
4205 There's a plethora of commands for manipulating these marks:
4209 * Setting Marks:: How to set and remove marks.
4210 * Generic Marking Commands:: How to customize the marking.
4211 * Setting Process Marks:: How to mark articles for later processing.
4215 @node Unread Articles
4216 @subsection Unread Articles
4218 The following marks mark articles as (kinda) unread, in one form or
4223 @vindex gnus-ticked-mark
4224 Marked as ticked (@code{gnus-ticked-mark}).
4226 @dfn{Ticked articles} are articles that will remain visible always. If
4227 you see an article that you find interesting, or you want to put off
4228 reading it, or replying to it, until sometime later, you'd typically
4229 tick it. However, articles can be expired, so if you want to keep an
4230 article forever, you'll have to make it persistent (@pxref{Persistent
4234 @vindex gnus-dormant-mark
4235 Marked as dormant (@code{gnus-dormant-mark}).
4237 @dfn{Dormant articles} will only appear in the summary buffer if there
4238 are followups to it. If you want to see them even if they don't have
4239 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4242 @vindex gnus-unread-mark
4243 Marked as unread (@code{gnus-unread-mark}).
4245 @dfn{Unread articles} are articles that haven't been read at all yet.
4250 @subsection Read Articles
4251 @cindex expirable mark
4253 All the following marks mark articles as read.
4258 @vindex gnus-del-mark
4259 These are articles that the user has marked as read with the @kbd{d}
4260 command manually, more or less (@code{gnus-del-mark}).
4263 @vindex gnus-read-mark
4264 Articles that have actually been read (@code{gnus-read-mark}).
4267 @vindex gnus-ancient-mark
4268 Articles that were marked as read in previous sessions and are now
4269 @dfn{old} (@code{gnus-ancient-mark}).
4272 @vindex gnus-killed-mark
4273 Marked as killed (@code{gnus-killed-mark}).
4276 @vindex gnus-kill-file-mark
4277 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4280 @vindex gnus-low-score-mark
4281 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4284 @vindex gnus-catchup-mark
4285 Marked as read by a catchup (@code{gnus-catchup-mark}).
4288 @vindex gnus-canceled-mark
4289 Canceled article (@code{gnus-canceled-mark})
4292 @vindex gnus-souped-mark
4293 @sc{SOUP}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
4296 @vindex gnus-sparse-mark
4297 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
4301 @vindex gnus-duplicate-mark
4302 Article marked as read by duplicate suppression
4303 (@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}.
4307 All these marks just mean that the article is marked as read, really.
4308 They are interpreted differently when doing adaptive scoring, though.
4310 One more special mark, though:
4314 @vindex gnus-expirable-mark
4315 Marked as expirable (@code{gnus-expirable-mark}).
4317 Marking articles as @dfn{expirable} (or have them marked as such
4318 automatically) doesn't make much sense in normal groups---a user doesn't
4319 control expiring of news articles, but in mail groups, for instance,
4320 articles marked as @dfn{expirable} can be deleted by Gnus at
4326 @subsection Other Marks
4327 @cindex process mark
4330 There are some marks that have nothing to do with whether the article is
4336 You can set a bookmark in the current article. Say you are reading a
4337 long thesis on cats' urinary tracts, and have to go home for dinner
4338 before you've finished reading the thesis. You can then set a bookmark
4339 in the article, and Gnus will jump to this bookmark the next time it
4340 encounters the article. @xref{Setting Marks}.
4343 @vindex gnus-replied-mark
4344 All articles that you have replied to or made a followup to (i.e., have
4345 answered) will be marked with an @samp{A} in the second column
4346 (@code{gnus-replied-mark}).
4349 @vindex gnus-cached-mark
4350 Articles stored in the article cache will be marked with an @samp{*} in
4351 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
4354 @vindex gnus-saved-mark
4355 Articles ``saved'' (in some manner or other; not necessarily
4356 religiously) are marked with an @samp{S} in the second column
4357 (@code{gnus-saved-mark}).
4360 @vindex gnus-not-empty-thread-mark
4361 @vindex gnus-empty-thread-mark
4362 If the @samp{%e} spec is used, the presence of threads or not will be
4363 marked with @code{gnus-not-empty-thread-mark} and
4364 @code{gnus-empty-thread-mark} in the third column, respectively.
4367 @vindex gnus-process-mark
4368 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
4369 variety of commands react to the presence of the process mark. For
4370 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4371 all articles that have been marked with the process mark. Articles
4372 marked with the process mark have a @samp{#} in the second column.
4376 You might have noticed that most of these ``non-readedness'' marks
4377 appear in the second column by default. So if you have a cached, saved,
4378 replied article that you have process-marked, what will that look like?
4380 Nothing much. The precedence rules go as follows: process -> cache ->
4381 replied -> saved. So if the article is in the cache and is replied,
4382 you'll only see the cache mark and not the replied mark.
4386 @subsection Setting Marks
4387 @cindex setting marks
4389 All the marking commands understand the numeric prefix.
4394 @kindex M c (Summary)
4395 @kindex M-u (Summary)
4396 @findex gnus-summary-clear-mark-forward
4397 @cindex mark as unread
4398 Clear all readedness-marks from the current article
4399 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
4405 @kindex M t (Summary)
4406 @findex gnus-summary-tick-article-forward
4407 Tick the current article (@code{gnus-summary-tick-article-forward}).
4408 @xref{Article Caching}.
4413 @kindex M ? (Summary)
4414 @findex gnus-summary-mark-as-dormant
4415 Mark the current article as dormant
4416 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
4420 @kindex M d (Summary)
4422 @findex gnus-summary-mark-as-read-forward
4423 Mark the current article as read
4424 (@code{gnus-summary-mark-as-read-forward}).
4428 @findex gnus-summary-mark-as-read-backward
4429 Mark the current article as read and move point to the previous line
4430 (@code{gnus-summary-mark-as-read-backward}).
4435 @kindex M k (Summary)
4436 @findex gnus-summary-kill-same-subject-and-select
4437 Mark all articles that have the same subject as the current one as read,
4438 and then select the next unread article
4439 (@code{gnus-summary-kill-same-subject-and-select}).
4443 @kindex M K (Summary)
4444 @kindex C-k (Summary)
4445 @findex gnus-summary-kill-same-subject
4446 Mark all articles that have the same subject as the current one as read
4447 (@code{gnus-summary-kill-same-subject}).
4450 @kindex M C (Summary)
4451 @findex gnus-summary-catchup
4452 @c @icon{gnus-summary-catchup}
4453 Mark all unread articles as read (@code{gnus-summary-catchup}).
4456 @kindex M C-c (Summary)
4457 @findex gnus-summary-catchup-all
4458 Mark all articles in the group as read---even the ticked and dormant
4459 articles (@code{gnus-summary-catchup-all}).
4462 @kindex M H (Summary)
4463 @findex gnus-summary-catchup-to-here
4464 Catchup the current group to point
4465 (@code{gnus-summary-catchup-to-here}).
4468 @kindex C-w (Summary)
4469 @findex gnus-summary-mark-region-as-read
4470 Mark all articles between point and mark as read
4471 (@code{gnus-summary-mark-region-as-read}).
4474 @kindex M V k (Summary)
4475 @findex gnus-summary-kill-below
4476 Kill all articles with scores below the default score (or below the
4477 numeric prefix) (@code{gnus-summary-kill-below}).
4481 @kindex M e (Summary)
4483 @findex gnus-summary-mark-as-expirable
4484 Mark the current article as expirable
4485 (@code{gnus-summary-mark-as-expirable}).
4488 @kindex M b (Summary)
4489 @findex gnus-summary-set-bookmark
4490 Set a bookmark in the current article
4491 (@code{gnus-summary-set-bookmark}).
4494 @kindex M B (Summary)
4495 @findex gnus-summary-remove-bookmark
4496 Remove the bookmark from the current article
4497 (@code{gnus-summary-remove-bookmark}).
4500 @kindex M V c (Summary)
4501 @findex gnus-summary-clear-above
4502 Clear all marks from articles with scores over the default score (or
4503 over the numeric prefix) (@code{gnus-summary-clear-above}).
4506 @kindex M V u (Summary)
4507 @findex gnus-summary-tick-above
4508 Tick all articles with scores over the default score (or over the
4509 numeric prefix) (@code{gnus-summary-tick-above}).
4512 @kindex M V m (Summary)
4513 @findex gnus-summary-mark-above
4514 Prompt for a mark, and mark all articles with scores over the default
4515 score (or over the numeric prefix) with this mark
4516 (@code{gnus-summary-clear-above}).
4519 @vindex gnus-summary-goto-unread
4520 The @code{gnus-summary-goto-unread} variable controls what action should
4521 be taken after setting a mark. If non-@code{nil}, point will move to
4522 the next/previous unread article. If @code{nil}, point will just move
4523 one line up or down. As a special case, if this variable is
4524 @code{never}, all the marking commands as well as other commands (like
4525 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4526 The default is @code{t}.
4529 @node Generic Marking Commands
4530 @subsection Generic Marking Commands
4532 Some people would like the command that ticks an article (@kbd{!}) go to
4533 the next article. Others would like it to go to the next unread
4534 article. Yet others would like it to stay on the current article. And
4535 even though I haven't heard of anybody wanting it to go the the
4536 previous (unread) article, I'm sure there are people that want that as
4539 Multiply these five behaviours with five different marking commands, and
4540 you get a potentially complex set of variable to control what each
4543 To sidestep that mess, Gnus provides commands that do all these
4544 different things. They can be found on the @kbd{M M} map in the summary
4545 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
4546 to list in this manual.
4548 While you can use these commands directly, most users would prefer
4549 altering the summary mode keymap. For instance, if you would like the
4550 @kbd{!} command to go the the next article instead of the next unread
4551 article, you could say something like:
4554 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
4555 (defun my-alter-summary-map ()
4556 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
4562 (defun my-alter-summary-map ()
4563 (local-set-key "!" "MM!n"))
4567 @node Setting Process Marks
4568 @subsection Setting Process Marks
4569 @cindex setting process marks
4576 @kindex M P p (Summary)
4577 @findex gnus-summary-mark-as-processable
4578 Mark the current article with the process mark
4579 (@code{gnus-summary-mark-as-processable}).
4580 @findex gnus-summary-unmark-as-processable
4584 @kindex M P u (Summary)
4585 @kindex M-# (Summary)
4586 Remove the process mark, if any, from the current article
4587 (@code{gnus-summary-unmark-as-processable}).
4590 @kindex M P U (Summary)
4591 @findex gnus-summary-unmark-all-processable
4592 Remove the process mark from all articles
4593 (@code{gnus-summary-unmark-all-processable}).
4596 @kindex M P i (Summary)
4597 @findex gnus-uu-invert-processable
4598 Invert the list of process marked articles
4599 (@code{gnus-uu-invert-processable}).
4602 @kindex M P R (Summary)
4603 @findex gnus-uu-mark-by-regexp
4604 Mark articles that have a @code{Subject} header that matches a regular
4605 expression (@code{gnus-uu-mark-by-regexp}).
4608 @kindex M P r (Summary)
4609 @findex gnus-uu-mark-region
4610 Mark articles in region (@code{gnus-uu-mark-region}).
4613 @kindex M P t (Summary)
4614 @findex gnus-uu-mark-thread
4615 Mark all articles in the current (sub)thread
4616 (@code{gnus-uu-mark-thread}).
4619 @kindex M P T (Summary)
4620 @findex gnus-uu-unmark-thread
4621 Unmark all articles in the current (sub)thread
4622 (@code{gnus-uu-unmark-thread}).
4625 @kindex M P v (Summary)
4626 @findex gnus-uu-mark-over
4627 Mark all articles that have a score above the prefix argument
4628 (@code{gnus-uu-mark-over}).
4631 @kindex M P s (Summary)
4632 @findex gnus-uu-mark-series
4633 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4636 @kindex M P S (Summary)
4637 @findex gnus-uu-mark-sparse
4638 Mark all series that have already had some articles marked
4639 (@code{gnus-uu-mark-sparse}).
4642 @kindex M P a (Summary)
4643 @findex gnus-uu-mark-all
4644 Mark all articles in series order (@code{gnus-uu-mark-series}).
4647 @kindex M P b (Summary)
4648 @findex gnus-uu-mark-buffer
4649 Mark all articles in the buffer in the order they appear
4650 (@code{gnus-uu-mark-buffer}).
4653 @kindex M P k (Summary)
4654 @findex gnus-summary-kill-process-mark
4655 Push the current process mark set onto the stack and unmark all articles
4656 (@code{gnus-summary-kill-process-mark}).
4659 @kindex M P y (Summary)
4660 @findex gnus-summary-yank-process-mark
4661 Pop the previous process mark set from the stack and restore it
4662 (@code{gnus-summary-yank-process-mark}).
4665 @kindex M P w (Summary)
4666 @findex gnus-summary-save-process-mark
4667 Push the current process mark set onto the stack
4668 (@code{gnus-summary-save-process-mark}).
4677 It can be convenient to limit the summary buffer to just show some
4678 subset of the articles currently in the group. The effect most limit
4679 commands have is to remove a few (or many) articles from the summary
4682 All limiting commands work on subsets of the articles already fetched
4683 from the servers. None of these commands query the server for
4684 additional articles.
4690 @kindex / / (Summary)
4691 @findex gnus-summary-limit-to-subject
4692 Limit the summary buffer to articles that match some subject
4693 (@code{gnus-summary-limit-to-subject}).
4696 @kindex / a (Summary)
4697 @findex gnus-summary-limit-to-author
4698 Limit the summary buffer to articles that match some author
4699 (@code{gnus-summary-limit-to-author}).
4702 @kindex / x (Summary)
4703 @findex gnus-summary-limit-to-extra
4704 Limit the summary buffer to articles that match one of the ``extra''
4705 headers (@pxref{To From Newsgroups})
4706 (@code{gnus-summary-limit-to-author}).
4710 @kindex / u (Summary)
4712 @findex gnus-summary-limit-to-unread
4713 Limit the summary buffer to articles not marked as read
4714 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
4715 buffer to articles strictly unread. This means that ticked and
4716 dormant articles will also be excluded.
4719 @kindex / m (Summary)
4720 @findex gnus-summary-limit-to-marks
4721 Ask for a mark and then limit to all articles that have been marked
4722 with that mark (@code{gnus-summary-limit-to-marks}).
4725 @kindex / t (Summary)
4726 @findex gnus-summary-limit-to-age
4727 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4728 (@code{gnus-summary-limit-to-marks}). If given a prefix, limit to
4729 articles younger than that number of days.
4732 @kindex / n (Summary)
4733 @findex gnus-summary-limit-to-articles
4734 Limit the summary buffer to the current article
4735 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
4736 convention (@pxref{Process/Prefix}).
4739 @kindex / w (Summary)
4740 @findex gnus-summary-pop-limit
4741 Pop the previous limit off the stack and restore it
4742 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
4746 @kindex / v (Summary)
4747 @findex gnus-summary-limit-to-score
4748 Limit the summary buffer to articles that have a score at or above some
4749 score (@code{gnus-summary-limit-to-score}).
4753 @kindex M S (Summary)
4754 @kindex / E (Summary)
4755 @findex gnus-summary-limit-include-expunged
4756 Include all expunged articles in the limit
4757 (@code{gnus-summary-limit-include-expunged}).
4760 @kindex / D (Summary)
4761 @findex gnus-summary-limit-include-dormant
4762 Include all dormant articles in the limit
4763 (@code{gnus-summary-limit-include-dormant}).
4766 @kindex / * (Summary)
4767 @findex gnus-summary-limit-include-cached
4768 Include all cached articles in the limit
4769 (@code{gnus-summary-limit-include-cached}).
4772 @kindex / d (Summary)
4773 @findex gnus-summary-limit-exclude-dormant
4774 Exclude all dormant articles from the limit
4775 (@code{gnus-summary-limit-exclude-dormant}).
4778 @kindex / M (Summary)
4779 @findex gnus-summary-limit-exclude-marks
4780 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
4783 @kindex / T (Summary)
4784 @findex gnus-summary-limit-include-thread
4785 Include all the articles in the current thread in the limit.
4788 @kindex / c (Summary)
4789 @findex gnus-summary-limit-exclude-childless-dormant
4790 Exclude all dormant articles that have no children from the limit
4791 (@code{gnus-summary-limit-exclude-childless-dormant}).
4794 @kindex / C (Summary)
4795 @findex gnus-summary-limit-mark-excluded-as-read
4796 Mark all excluded unread articles as read
4797 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
4798 also mark excluded ticked and dormant articles as read.
4806 @cindex article threading
4808 Gnus threads articles by default. @dfn{To thread} is to put responses
4809 to articles directly after the articles they respond to---in a
4810 hierarchical fashion.
4812 Threading is done by looking at the @code{References} headers of the
4813 articles. In a perfect world, this would be enough to build pretty
4814 trees, but unfortunately, the @code{References} header is often broken
4815 or simply missing. Weird news propagation excarcerbates the problem,
4816 so one has to employ other heuristics to get pleasing results. A
4817 plethora of approaches exists, as detailed in horrible detail in
4818 @pxref{Customizing Threading}.
4820 First, a quick overview of the concepts:
4824 The top-most article in a thread; the first article in the thread.
4827 A tree-like article structure.
4830 A small(er) section of this tree-like structure.
4833 Threads often lose their roots due to article expiry, or due to the root
4834 already having been read in a previous session, and not displayed in the
4835 summary buffer. We then typically have many sub-threads that really
4836 belong to one thread, but are without connecting roots. These are
4837 called loose threads.
4839 @item thread gathering
4840 An attempt to gather loose threads into bigger threads.
4842 @item sparse threads
4843 A thread where the missing articles have been ``guessed'' at, and are
4844 displayed as empty lines in the summary buffer.
4850 * Customizing Threading:: Variables you can change to affect the threading.
4851 * Thread Commands:: Thread based commands in the summary buffer.
4855 @node Customizing Threading
4856 @subsection Customizing Threading
4857 @cindex customizing threading
4860 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
4861 * Filling In Threads:: Making the threads displayed look fuller.
4862 * More Threading:: Even more variables for fiddling with threads.
4863 * Low-Level Threading:: You thought it was over... but you were wrong!
4868 @subsubsection Loose Threads
4871 @cindex loose threads
4874 @item gnus-summary-make-false-root
4875 @vindex gnus-summary-make-false-root
4876 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4877 and create a dummy root at the top. (Wait a minute. Root at the top?
4878 Yup.) Loose subtrees occur when the real root has expired, or you've
4879 read or killed the root in a previous session.
4881 When there is no real root of a thread, Gnus will have to fudge
4882 something. This variable says what fudging method Gnus should use.
4883 There are four possible values:
4887 \gnusfigure{The Summary Buffer}{390}{
4888 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4889 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4890 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4891 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4896 @cindex adopting articles
4901 Gnus will make the first of the orphaned articles the parent. This
4902 parent will adopt all the other articles. The adopted articles will be
4903 marked as such by pointy brackets (@samp{<>}) instead of the standard
4904 square brackets (@samp{[]}). This is the default method.
4907 @vindex gnus-summary-dummy-line-format
4908 Gnus will create a dummy summary line that will pretend to be the
4909 parent. This dummy line does not correspond to any real article, so
4910 selecting it will just select the first real article after the dummy
4911 article. @code{gnus-summary-dummy-line-format} is used to specify the
4912 format of the dummy roots. It accepts only one format spec: @samp{S},
4913 which is the subject of the article. @xref{Formatting Variables}.
4916 Gnus won't actually make any article the parent, but simply leave the
4917 subject field of all orphans except the first empty. (Actually, it will
4918 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4922 Don't make any article parent at all. Just gather the threads and
4923 display them after one another.
4926 Don't gather loose threads.
4929 @item gnus-summary-gather-subject-limit
4930 @vindex gnus-summary-gather-subject-limit
4931 Loose threads are gathered by comparing subjects of articles. If this
4932 variable is @code{nil}, Gnus requires an exact match between the
4933 subjects of the loose threads before gathering them into one big
4934 super-thread. This might be too strict a requirement, what with the
4935 presence of stupid newsreaders that chop off long subject lines. If
4936 you think so, set this variable to, say, 20 to require that only the
4937 first 20 characters of the subjects have to match. If you set this
4938 variable to a really low number, you'll find that Gnus will gather
4939 everything in sight into one thread, which isn't very helpful.
4941 @cindex fuzzy article gathering
4942 If you set this variable to the special value @code{fuzzy}, Gnus will
4943 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4946 @item gnus-simplify-subject-fuzzy-regexp
4947 @vindex gnus-simplify-subject-fuzzy-regexp
4948 This can either be a regular expression or list of regular expressions
4949 that match strings that will be removed from subjects if fuzzy subject
4950 simplification is used.
4952 @item gnus-simplify-ignored-prefixes
4953 @vindex gnus-simplify-ignored-prefixes
4954 If you set @code{gnus-summary-gather-subject-limit} to something as low
4955 as 10, you might consider setting this variable to something sensible:
4957 @c Written by Michael Ernst <mernst@cs.rice.edu>
4959 (setq gnus-simplify-ignored-prefixes
4965 "wanted" "followup" "summary\\( of\\)?"
4966 "help" "query" "problem" "question"
4967 "answer" "reference" "announce"
4968 "How can I" "How to" "Comparison of"
4973 (mapconcat 'identity
4974 '("for" "for reference" "with" "about")
4976 "\\)?\\]?:?[ \t]*"))
4979 All words that match this regexp will be removed before comparing two
4982 @item gnus-simplify-subject-functions
4983 @vindex gnus-simplify-subject-functions
4984 If non-@code{nil}, this variable overrides
4985 @code{gnus-summary-gather-subject-limit}. This variable should be a
4986 list of functions to apply to the @code{Subject} string iteratively to
4987 arrive at the simplified version of the string.
4989 Useful functions to put in this list include:
4992 @item gnus-simplify-subject-re
4993 @findex gnus-simplify-subject-re
4994 Strip the leading @samp{Re:}.
4996 @item gnus-simplify-subject-fuzzy
4997 @findex gnus-simplify-subject-fuzzy
5000 @item gnus-simplify-whitespace
5001 @findex gnus-simplify-whitespace
5002 Remove excessive whitespace.
5005 You may also write your own functions, of course.
5008 @item gnus-summary-gather-exclude-subject
5009 @vindex gnus-summary-gather-exclude-subject
5010 Since loose thread gathering is done on subjects only, that might lead
5011 to many false hits, especially with certain common subjects like
5012 @samp{} and @samp{(none)}. To make the situation slightly better,
5013 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
5014 what subjects should be excluded from the gathering process.@*
5015 The default is @samp{^ *$\\|^(none)$}.
5017 @item gnus-summary-thread-gathering-function
5018 @vindex gnus-summary-thread-gathering-function
5019 Gnus gathers threads by looking at @code{Subject} headers. This means
5020 that totally unrelated articles may end up in the same ``thread'', which
5021 is confusing. An alternate approach is to look at all the
5022 @code{Message-ID}s in all the @code{References} headers to find matches.
5023 This will ensure that no gathered threads ever include unrelated
5024 articles, but it also means that people who have posted with broken
5025 newsreaders won't be gathered properly. The choice is yours---plague or
5029 @item gnus-gather-threads-by-subject
5030 @findex gnus-gather-threads-by-subject
5031 This function is the default gathering function and looks at
5032 @code{Subject}s exclusively.
5034 @item gnus-gather-threads-by-references
5035 @findex gnus-gather-threads-by-references
5036 This function looks at @code{References} headers exclusively.
5039 If you want to test gathering by @code{References}, you could say
5043 (setq gnus-summary-thread-gathering-function
5044 'gnus-gather-threads-by-references)
5050 @node Filling In Threads
5051 @subsubsection Filling In Threads
5054 @item gnus-fetch-old-headers
5055 @vindex gnus-fetch-old-headers
5056 If non-@code{nil}, Gnus will attempt to build old threads by fetching
5057 more old headers---headers to articles marked as read. If you
5058 would like to display as few summary lines as possible, but still
5059 connect as many loose threads as possible, you should set this variable
5060 to @code{some} or a number. If you set it to a number, no more than
5061 that number of extra old headers will be fetched. In either case,
5062 fetching old headers only works if the backend you are using carries
5063 overview files---this would normally be @code{nntp}, @code{nnspool} and
5064 @code{nnml}. Also remember that if the root of the thread has been
5065 expired by the server, there's not much Gnus can do about that.
5067 This variable can also be set to @code{invisible}. This won't have any
5068 visible effects, but is useful if you use the @kbd{A T} command a lot
5069 (@pxref{Finding the Parent}).
5071 @item gnus-build-sparse-threads
5072 @vindex gnus-build-sparse-threads
5073 Fetching old headers can be slow. A low-rent similar effect can be
5074 gotten by setting this variable to @code{some}. Gnus will then look at
5075 the complete @code{References} headers of all articles and try to string
5076 together articles that belong in the same thread. This will leave
5077 @dfn{gaps} in the threading display where Gnus guesses that an article
5078 is missing from the thread. (These gaps appear like normal summary
5079 lines. If you select a gap, Gnus will try to fetch the article in
5080 question.) If this variable is @code{t}, Gnus will display all these
5081 ``gaps'' without regard for whether they are useful for completing the
5082 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
5083 off sparse leaf nodes that don't lead anywhere. This variable is
5084 @code{nil} by default.
5089 @node More Threading
5090 @subsubsection More Threading
5093 @item gnus-show-threads
5094 @vindex gnus-show-threads
5095 If this variable is @code{nil}, no threading will be done, and all of
5096 the rest of the variables here will have no effect. Turning threading
5097 off will speed group selection up a bit, but it is sure to make reading
5098 slower and more awkward.
5100 @item gnus-thread-hide-subtree
5101 @vindex gnus-thread-hide-subtree
5102 If non-@code{nil}, all threads will be hidden when the summary buffer is
5105 @item gnus-thread-expunge-below
5106 @vindex gnus-thread-expunge-below
5107 All threads that have a total score (as defined by
5108 @code{gnus-thread-score-function}) less than this number will be
5109 expunged. This variable is @code{nil} by default, which means that no
5110 threads are expunged.
5112 @item gnus-thread-hide-killed
5113 @vindex gnus-thread-hide-killed
5114 if you kill a thread and this variable is non-@code{nil}, the subtree
5117 @item gnus-thread-ignore-subject
5118 @vindex gnus-thread-ignore-subject
5119 Sometimes somebody changes the subject in the middle of a thread. If
5120 this variable is non-@code{nil}, the subject change is ignored. If it
5121 is @code{nil}, which is the default, a change in the subject will result
5124 @item gnus-thread-indent-level
5125 @vindex gnus-thread-indent-level
5126 This is a number that says how much each sub-thread should be indented.
5132 @node Low-Level Threading
5133 @subsubsection Low-Level Threading
5137 @item gnus-parse-headers-hook
5138 @vindex gnus-parse-headers-hook
5139 Hook run before parsing any headers.
5141 @item gnus-alter-header-function
5142 @vindex gnus-alter-header-function
5143 If non-@code{nil}, this function will be called to allow alteration of
5144 article header structures. The function is called with one parameter,
5145 the article header vector, which it may alter in any way. For instance,
5146 if you have a mail-to-news gateway which alters the @code{Message-ID}s
5147 in systematic ways (by adding prefixes and such), you can use this
5148 variable to un-scramble the @code{Message-ID}s so that they are more
5149 meaningful. Here's one example:
5152 (setq gnus-alter-header-function 'my-alter-message-id)
5154 (defun my-alter-message-id (header)
5155 (let ((id (mail-header-id header)))
5157 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
5159 (concat (match-string 1 id) "@@" (match-string 2 id))
5166 @node Thread Commands
5167 @subsection Thread Commands
5168 @cindex thread commands
5174 @kindex T k (Summary)
5175 @kindex M-C-k (Summary)
5176 @findex gnus-summary-kill-thread
5177 Mark all articles in the current (sub-)thread as read
5178 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
5179 remove all marks instead. If the prefix argument is negative, tick
5184 @kindex T l (Summary)
5185 @kindex M-C-l (Summary)
5186 @findex gnus-summary-lower-thread
5187 Lower the score of the current (sub-)thread
5188 (@code{gnus-summary-lower-thread}).
5191 @kindex T i (Summary)
5192 @findex gnus-summary-raise-thread
5193 Increase the score of the current (sub-)thread
5194 (@code{gnus-summary-raise-thread}).
5197 @kindex T # (Summary)
5198 @findex gnus-uu-mark-thread
5199 Set the process mark on the current (sub-)thread
5200 (@code{gnus-uu-mark-thread}).
5203 @kindex T M-# (Summary)
5204 @findex gnus-uu-unmark-thread
5205 Remove the process mark from the current (sub-)thread
5206 (@code{gnus-uu-unmark-thread}).
5209 @kindex T T (Summary)
5210 @findex gnus-summary-toggle-threads
5211 Toggle threading (@code{gnus-summary-toggle-threads}).
5214 @kindex T s (Summary)
5215 @findex gnus-summary-show-thread
5216 Expose the (sub-)thread hidden under the current article, if any
5217 (@code{gnus-summary-show-thread}).
5220 @kindex T h (Summary)
5221 @findex gnus-summary-hide-thread
5222 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5225 @kindex T S (Summary)
5226 @findex gnus-summary-show-all-threads
5227 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5230 @kindex T H (Summary)
5231 @findex gnus-summary-hide-all-threads
5232 Hide all threads (@code{gnus-summary-hide-all-threads}).
5235 @kindex T t (Summary)
5236 @findex gnus-summary-rethread-current
5237 Re-thread the current article's thread
5238 (@code{gnus-summary-rethread-current}). This works even when the
5239 summary buffer is otherwise unthreaded.
5242 @kindex T ^ (Summary)
5243 @findex gnus-summary-reparent-thread
5244 Make the current article the child of the marked (or previous) article
5245 (@code{gnus-summary-reparent-thread}).
5249 The following commands are thread movement commands. They all
5250 understand the numeric prefix.
5255 @kindex T n (Summary)
5256 @findex gnus-summary-next-thread
5257 Go to the next thread (@code{gnus-summary-next-thread}).
5260 @kindex T p (Summary)
5261 @findex gnus-summary-prev-thread
5262 Go to the previous thread (@code{gnus-summary-prev-thread}).
5265 @kindex T d (Summary)
5266 @findex gnus-summary-down-thread
5267 Descend the thread (@code{gnus-summary-down-thread}).
5270 @kindex T u (Summary)
5271 @findex gnus-summary-up-thread
5272 Ascend the thread (@code{gnus-summary-up-thread}).
5275 @kindex T o (Summary)
5276 @findex gnus-summary-top-thread
5277 Go to the top of the thread (@code{gnus-summary-top-thread}).
5280 @vindex gnus-thread-operation-ignore-subject
5281 If you ignore subject while threading, you'll naturally end up with
5282 threads that have several different subjects in them. If you then issue
5283 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5284 wish to kill the entire thread, but just those parts of the thread that
5285 have the same subject as the current article. If you like this idea,
5286 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
5287 is non-@code{nil} (which it is by default), subjects will be ignored
5288 when doing thread commands. If this variable is @code{nil}, articles in
5289 the same thread with different subjects will not be included in the
5290 operation in question. If this variable is @code{fuzzy}, only articles
5291 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5298 @findex gnus-thread-sort-by-total-score
5299 @findex gnus-thread-sort-by-date
5300 @findex gnus-thread-sort-by-score
5301 @findex gnus-thread-sort-by-subject
5302 @findex gnus-thread-sort-by-author
5303 @findex gnus-thread-sort-by-number
5304 @vindex gnus-thread-sort-functions
5305 If you are using a threaded summary display, you can sort the threads by
5306 setting @code{gnus-thread-sort-functions}, which can be either a single
5307 function, a list of functions, or a list containing functions and
5308 @code{(not some-function)} elements.
5310 By default, sorting is done on article numbers. Ready-made sorting
5311 predicate functions include @code{gnus-thread-sort-by-number},
5312 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5313 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5314 @code{gnus-thread-sort-by-total-score}.
5316 Each function takes two threads and returns non-@code{nil} if the first
5317 thread should be sorted before the other. Note that sorting really is
5318 normally done by looking only at the roots of each thread.
5320 If you use more than one function, the primary sort key should be the
5321 last function in the list. You should probably always include
5322 @code{gnus-thread-sort-by-number} in the list of sorting
5323 functions---preferably first. This will ensure that threads that are
5324 equal with respect to the other sort criteria will be displayed in
5325 ascending article order.
5327 If you would like to sort by reverse score, then by subject, and finally
5328 by number, you could do something like:
5331 (setq gnus-thread-sort-functions
5332 '(gnus-thread-sort-by-number
5333 gnus-thread-sort-by-subject
5334 (not gnus-thread-sort-by-total-score)))
5337 The threads that have highest score will be displayed first in the
5338 summary buffer. When threads have the same score, they will be sorted
5339 alphabetically. The threads that have the same score and the same
5340 subject will be sorted by number, which is (normally) the sequence in
5341 which the articles arrived.
5343 If you want to sort by score and then reverse arrival order, you could
5347 (setq gnus-thread-sort-functions
5349 (not (gnus-thread-sort-by-number t1 t2)))
5350 gnus-thread-sort-by-score))
5353 @vindex gnus-thread-score-function
5354 The function in the @code{gnus-thread-score-function} variable (default
5355 @code{+}) is used for calculating the total score of a thread. Useful
5356 functions might be @code{max}, @code{min}, or squared means, or whatever
5359 @findex gnus-article-sort-functions
5360 @findex gnus-article-sort-by-date
5361 @findex gnus-article-sort-by-score
5362 @findex gnus-article-sort-by-subject
5363 @findex gnus-article-sort-by-author
5364 @findex gnus-article-sort-by-number
5365 If you are using an unthreaded display for some strange reason or other,
5366 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5367 It is very similar to the @code{gnus-thread-sort-functions}, except that
5368 it uses slightly different functions for article comparison. Available
5369 sorting predicate functions are @code{gnus-article-sort-by-number},
5370 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5371 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5373 If you want to sort an unthreaded summary display by subject, you could
5377 (setq gnus-article-sort-functions
5378 '(gnus-article-sort-by-number
5379 gnus-article-sort-by-subject))
5384 @node Asynchronous Fetching
5385 @section Asynchronous Article Fetching
5386 @cindex asynchronous article fetching
5387 @cindex article pre-fetch
5390 If you read your news from an @sc{nntp} server that's far away, the
5391 network latencies may make reading articles a chore. You have to wait
5392 for a while after pressing @kbd{n} to go to the next article before the
5393 article appears. Why can't Gnus just go ahead and fetch the article
5394 while you are reading the previous one? Why not, indeed.
5396 First, some caveats. There are some pitfalls to using asynchronous
5397 article fetching, especially the way Gnus does it.
5399 Let's say you are reading article 1, which is short, and article 2 is
5400 quite long, and you are not interested in reading that. Gnus does not
5401 know this, so it goes ahead and fetches article 2. You decide to read
5402 article 3, but since Gnus is in the process of fetching article 2, the
5403 connection is blocked.
5405 To avoid these situations, Gnus will open two (count 'em two)
5406 connections to the server. Some people may think this isn't a very nice
5407 thing to do, but I don't see any real alternatives. Setting up that
5408 extra connection takes some time, so Gnus startup will be slower.
5410 Gnus will fetch more articles than you will read. This will mean that
5411 the link between your machine and the @sc{nntp} server will become more
5412 loaded than if you didn't use article pre-fetch. The server itself will
5413 also become more loaded---both with the extra article requests, and the
5416 Ok, so now you know that you shouldn't really use this thing... unless
5419 @vindex gnus-asynchronous
5420 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
5421 happen automatically.
5423 @vindex gnus-use-article-prefetch
5424 You can control how many articles are to be pre-fetched by setting
5425 @code{gnus-use-article-prefetch}. This is 30 by default, which means
5426 that when you read an article in the group, the backend will pre-fetch
5427 the next 30 articles. If this variable is @code{t}, the backend will
5428 pre-fetch all the articles it can without bound. If it is
5429 @code{nil}, no pre-fetching will be done.
5431 @vindex gnus-async-prefetch-article-p
5432 @findex gnus-async-read-p
5433 There are probably some articles that you don't want to pre-fetch---read
5434 articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should
5435 return non-@code{nil} when the article in question is to be
5436 pre-fetched. The default is @code{gnus-async-read-p}, which returns
5437 @code{nil} on read articles. The function is called with an article
5438 data structure as the only parameter.
5440 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
5443 (defun my-async-short-unread-p (data)
5444 "Return non-nil for short, unread articles."
5445 (and (gnus-data-unread-p data)
5446 (< (mail-header-lines (gnus-data-header data))
5449 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5452 These functions will be called many, many times, so they should
5453 preferably be short and sweet to avoid slowing down Gnus too much.
5454 It's probably a good idea to byte-compile things like this.
5456 @vindex gnus-prefetched-article-deletion-strategy
5457 Articles have to be removed from the asynch buffer sooner or later. The
5458 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5459 articles. This is a list that may contain the following elements:
5463 Remove articles when they are read.
5466 Remove articles when exiting the group.
5469 The default value is @code{(read exit)}.
5471 @c @vindex gnus-use-header-prefetch
5472 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5473 @c from the next group.
5476 @node Article Caching
5477 @section Article Caching
5478 @cindex article caching
5481 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5482 consider turning article caching on. Each article will then be stored
5483 locally under your home directory. As you may surmise, this could
5484 potentially use @emph{huge} amounts of disk space, as well as eat up all
5485 your inodes so fast it will make your head swim. In vodka.
5487 Used carefully, though, it could be just an easier way to save articles.
5489 @vindex gnus-use-long-file-name
5490 @vindex gnus-cache-directory
5491 @vindex gnus-use-cache
5492 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
5493 all articles ticked or marked as dormant will then be copied
5494 over to your local cache (@code{gnus-cache-directory}). Whether this
5495 cache is flat or hierarchal is controlled by the
5496 @code{gnus-use-long-file-name} variable, as usual.
5498 When re-selecting a ticked or dormant article, it will be fetched from the
5499 cache instead of from the server. As articles in your cache will never
5500 expire, this might serve as a method of saving articles while still
5501 keeping them where they belong. Just mark all articles you want to save
5502 as dormant, and don't worry.
5504 When an article is marked as read, is it removed from the cache.
5506 @vindex gnus-cache-remove-articles
5507 @vindex gnus-cache-enter-articles
5508 The entering/removal of articles from the cache is controlled by the
5509 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5510 variables. Both are lists of symbols. The first is @code{(ticked
5511 dormant)} by default, meaning that ticked and dormant articles will be
5512 put in the cache. The latter is @code{(read)} by default, meaning that
5513 articles marked as read are removed from the cache. Possibly
5514 symbols in these two lists are @code{ticked}, @code{dormant},
5515 @code{unread} and @code{read}.
5517 @findex gnus-jog-cache
5518 So where does the massive article-fetching and storing come into the
5519 picture? The @code{gnus-jog-cache} command will go through all
5520 subscribed newsgroups, request all unread articles, score them, and
5521 store them in the cache. You should only ever, ever ever ever, use this
5522 command if 1) your connection to the @sc{nntp} server is really, really,
5523 really slow and 2) you have a really, really, really huge disk.
5524 Seriously. One way to cut down on the number of articles downloaded is
5525 to score unwanted articles down and have them marked as read. They will
5526 not then be downloaded by this command.
5528 @vindex gnus-uncacheable-groups
5529 @vindex gnus-cacheable-groups
5530 It is likely that you do not want caching on all groups. For instance,
5531 if your @code{nnml} mail is located under your home directory, it makes no
5532 sense to cache it somewhere else under your home directory. Unless you
5533 feel that it's neat to use twice as much space.
5535 To limit the caching, you could set @code{gnus-cacheable-groups} to a
5536 regexp of groups to cache, @samp{^nntp} for instance, or set the
5537 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
5538 Both variables are @code{nil} by default. If a group matches both
5539 variables, the group is not cached.
5541 @findex gnus-cache-generate-nov-databases
5542 @findex gnus-cache-generate-active
5543 @vindex gnus-cache-active-file
5544 The cache stores information on what articles it contains in its active
5545 file (@code{gnus-cache-active-file}). If this file (or any other parts
5546 of the cache) becomes all messed up for some reason or other, Gnus
5547 offers two functions that will try to set things right. @kbd{M-x
5548 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5549 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5553 @node Persistent Articles
5554 @section Persistent Articles
5555 @cindex persistent articles
5557 Closely related to article caching, we have @dfn{persistent articles}.
5558 In fact, it's just a different way of looking at caching, and much more
5559 useful in my opinion.
5561 Say you're reading a newsgroup, and you happen on to some valuable gem
5562 that you want to keep and treasure forever. You'd normally just save it
5563 (using one of the many saving commands) in some file. The problem with
5564 that is that it's just, well, yucky. Ideally you'd prefer just having
5565 the article remain in the group where you found it forever; untouched by
5566 the expiry going on at the news server.
5568 This is what a @dfn{persistent article} is---an article that just won't
5569 be deleted. It's implemented using the normal cache functions, but
5570 you use two explicit commands for managing persistent articles:
5576 @findex gnus-cache-enter-article
5577 Make the current article persistent (@code{gnus-cache-enter-article}).
5580 @kindex M-* (Summary)
5581 @findex gnus-cache-remove-article
5582 Remove the current article from the persistent articles
5583 (@code{gnus-cache-remove-article}). This will normally delete the
5587 Both these commands understand the process/prefix convention.
5589 To avoid having all ticked articles (and stuff) entered into the cache,
5590 you should set @code{gnus-use-cache} to @code{passive} if you're just
5591 interested in persistent articles:
5594 (setq gnus-use-cache 'passive)
5598 @node Article Backlog
5599 @section Article Backlog
5601 @cindex article backlog
5603 If you have a slow connection, but the idea of using caching seems
5604 unappealing to you (and it is, really), you can help the situation some
5605 by switching on the @dfn{backlog}. This is where Gnus will buffer
5606 already read articles so that it doesn't have to re-fetch articles
5607 you've already read. This only helps if you are in the habit of
5608 re-selecting articles you've recently read, of course. If you never do
5609 that, turning the backlog on will slow Gnus down a little bit, and
5610 increase memory usage some.
5612 @vindex gnus-keep-backlog
5613 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5614 at most @var{n} old articles in a buffer for later re-fetching. If this
5615 variable is non-@code{nil} and is not a number, Gnus will store
5616 @emph{all} read articles, which means that your Emacs will grow without
5617 bound before exploding and taking your machine down with you. I put
5618 that in there just to keep y'all on your toes.
5620 This variable is @code{nil} by default.
5623 @node Saving Articles
5624 @section Saving Articles
5625 @cindex saving articles
5627 Gnus can save articles in a number of ways. Below is the documentation
5628 for saving articles in a fairly straight-forward fashion (i.e., little
5629 processing of the article is done before it is saved). For a different
5630 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5631 (@pxref{Decoding Articles}).
5633 @vindex gnus-save-all-headers
5634 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5635 unwanted headers before saving the article.
5637 @vindex gnus-saved-headers
5638 If the preceding variable is @code{nil}, all headers that match the
5639 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5640 deleted before saving.
5646 @kindex O o (Summary)
5648 @findex gnus-summary-save-article
5649 @c @icon{gnus-summary-save-article}
5650 Save the current article using the default article saver
5651 (@code{gnus-summary-save-article}).
5654 @kindex O m (Summary)
5655 @findex gnus-summary-save-article-mail
5656 Save the current article in mail format
5657 (@code{gnus-summary-save-article-mail}).
5660 @kindex O r (Summary)
5661 @findex gnus-summary-save-article-rmail
5662 Save the current article in rmail format
5663 (@code{gnus-summary-save-article-rmail}).
5666 @kindex O f (Summary)
5667 @findex gnus-summary-save-article-file
5668 @c @icon{gnus-summary-save-article-file}
5669 Save the current article in plain file format
5670 (@code{gnus-summary-save-article-file}).
5673 @kindex O F (Summary)
5674 @findex gnus-summary-write-article-file
5675 Write the current article in plain file format, overwriting any previous
5676 file contents (@code{gnus-summary-write-article-file}).
5679 @kindex O b (Summary)
5680 @findex gnus-summary-save-article-body-file
5681 Save the current article body in plain file format
5682 (@code{gnus-summary-save-article-body-file}).
5685 @kindex O h (Summary)
5686 @findex gnus-summary-save-article-folder
5687 Save the current article in mh folder format
5688 (@code{gnus-summary-save-article-folder}).
5691 @kindex O v (Summary)
5692 @findex gnus-summary-save-article-vm
5693 Save the current article in a VM folder
5694 (@code{gnus-summary-save-article-vm}).
5697 @kindex O p (Summary)
5698 @findex gnus-summary-pipe-output
5699 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
5700 the current article to a process (@code{gnus-summary-pipe-output}).
5703 @vindex gnus-prompt-before-saving
5704 All these commands use the process/prefix convention
5705 (@pxref{Process/Prefix}). If you save bunches of articles using these
5706 functions, you might get tired of being prompted for files to save each
5707 and every article in. The prompting action is controlled by
5708 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5709 default, giving you that excessive prompting action you know and
5710 loathe. If you set this variable to @code{t} instead, you'll be prompted
5711 just once for each series of articles you save. If you like to really
5712 have Gnus do all your thinking for you, you can even set this variable
5713 to @code{nil}, which means that you will never be prompted for files to
5714 save articles in. Gnus will simply save all the articles in the default
5718 @vindex gnus-default-article-saver
5719 You can customize the @code{gnus-default-article-saver} variable to make
5720 Gnus do what you want it to. You can use any of the six ready-made
5721 functions below, or you can create your own.
5725 @item gnus-summary-save-in-rmail
5726 @findex gnus-summary-save-in-rmail
5727 @vindex gnus-rmail-save-name
5728 @findex gnus-plain-save-name
5729 This is the default format, @dfn{babyl}. Uses the function in the
5730 @code{gnus-rmail-save-name} variable to get a file name to save the
5731 article in. The default is @code{gnus-plain-save-name}.
5733 @item gnus-summary-save-in-mail
5734 @findex gnus-summary-save-in-mail
5735 @vindex gnus-mail-save-name
5736 Save in a Unix mail (mbox) file. Uses the function in the
5737 @code{gnus-mail-save-name} variable to get a file name to save the
5738 article in. The default is @code{gnus-plain-save-name}.
5740 @item gnus-summary-save-in-file
5741 @findex gnus-summary-save-in-file
5742 @vindex gnus-file-save-name
5743 @findex gnus-numeric-save-name
5744 Append the article straight to an ordinary file. Uses the function in
5745 the @code{gnus-file-save-name} variable to get a file name to save the
5746 article in. The default is @code{gnus-numeric-save-name}.
5748 @item gnus-summary-save-body-in-file
5749 @findex gnus-summary-save-body-in-file
5750 Append the article body to an ordinary file. Uses the function in the
5751 @code{gnus-file-save-name} variable to get a file name to save the
5752 article in. The default is @code{gnus-numeric-save-name}.
5754 @item gnus-summary-save-in-folder
5755 @findex gnus-summary-save-in-folder
5756 @findex gnus-folder-save-name
5757 @findex gnus-Folder-save-name
5758 @vindex gnus-folder-save-name
5761 Save the article to an MH folder using @code{rcvstore} from the MH
5762 library. Uses the function in the @code{gnus-folder-save-name} variable
5763 to get a file name to save the article in. The default is
5764 @code{gnus-folder-save-name}, but you can also use
5765 @code{gnus-Folder-save-name}, which creates capitalized names.
5767 @item gnus-summary-save-in-vm
5768 @findex gnus-summary-save-in-vm
5769 Save the article in a VM folder. You have to have the VM mail
5770 reader to use this setting.
5773 @vindex gnus-article-save-directory
5774 All of these functions, except for the last one, will save the article
5775 in the @code{gnus-article-save-directory}, which is initialized from the
5776 @code{SAVEDIR} environment variable. This is @file{~/News/} by
5779 As you can see above, the functions use different functions to find a
5780 suitable name of a file to save the article in. Below is a list of
5781 available functions that generate names:
5785 @item gnus-Numeric-save-name
5786 @findex gnus-Numeric-save-name
5787 File names like @file{~/News/Alt.andrea-dworkin/45}.
5789 @item gnus-numeric-save-name
5790 @findex gnus-numeric-save-name
5791 File names like @file{~/News/alt.andrea-dworkin/45}.
5793 @item gnus-Plain-save-name
5794 @findex gnus-Plain-save-name
5795 File names like @file{~/News/Alt.andrea-dworkin}.
5797 @item gnus-plain-save-name
5798 @findex gnus-plain-save-name
5799 File names like @file{~/News/alt.andrea-dworkin}.
5802 @vindex gnus-split-methods
5803 You can have Gnus suggest where to save articles by plonking a regexp into
5804 the @code{gnus-split-methods} alist. For instance, if you would like to
5805 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5806 related to VM in @code{vm-stuff}, you could set this variable to something
5810 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5811 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5812 (my-choosing-function "../other-dir/my-stuff")
5813 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5816 We see that this is a list where each element is a list that has two
5817 elements---the @dfn{match} and the @dfn{file}. The match can either be
5818 a string (in which case it is used as a regexp to match on the article
5819 head); it can be a symbol (which will be called as a function with the
5820 group name as a parameter); or it can be a list (which will be
5821 @code{eval}ed). If any of these actions have a non-@code{nil} result,
5822 the @dfn{file} will be used as a default prompt. In addition, the
5823 result of the operation itself will be used if the function or form
5824 called returns a string or a list of strings.
5826 You basically end up with a list of file names that might be used when
5827 saving the current article. (All ``matches'' will be used.) You will
5828 then be prompted for what you really want to use as a name, with file
5829 name completion over the results from applying this variable.
5831 This variable is @code{((gnus-article-archive-name))} by default, which
5832 means that Gnus will look at the articles it saves for an
5833 @code{Archive-name} line and use that as a suggestion for the file
5836 Here's an example function to clean up file names somewhat. If you have
5837 lots of mail groups called things like
5838 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5839 these group names before creating the file name to save to. The
5840 following will do just that:
5843 (defun my-save-name (group)
5844 (when (string-match "^nnml:mail." group)
5845 (substring group (match-end 0))))
5847 (setq gnus-split-methods
5848 '((gnus-article-archive-name)
5853 @vindex gnus-use-long-file-name
5854 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
5855 @code{nil}, all the preceding functions will replace all periods
5856 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5857 the functions will generate hierarchies of directories instead of having
5858 all the files in the top level directory
5859 (@file{~/News/alt/andrea-dworkin} instead of
5860 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
5861 on most systems. However, for historical reasons, this is @code{nil} on
5862 Xenix and usg-unix-v machines by default.
5864 This function also affects kill and score file names. If this variable
5865 is a list, and the list contains the element @code{not-score}, long file
5866 names will not be used for score files, if it contains the element
5867 @code{not-save}, long file names will not be used for saving, and if it
5868 contains the element @code{not-kill}, long file names will not be used
5871 If you'd like to save articles in a hierarchy that looks something like
5875 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5876 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5879 Then just save with @kbd{o}. You'd then read this hierarchy with
5880 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5881 the top level directory as the argument (@file{~/News/}). Then just walk
5882 around to the groups/directories with @code{nneething}.
5885 @node Decoding Articles
5886 @section Decoding Articles
5887 @cindex decoding articles
5889 Sometime users post articles (or series of articles) that have been
5890 encoded in some way or other. Gnus can decode them for you.
5893 * Uuencoded Articles:: Uudecode articles.
5894 * Shell Archives:: Unshar articles.
5895 * PostScript Files:: Split PostScript.
5896 * Other Files:: Plain save and binhex.
5897 * Decoding Variables:: Variables for a happy decoding.
5898 * Viewing Files:: You want to look at the result of the decoding?
5902 @cindex article series
5903 All these functions use the process/prefix convention
5904 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5905 the extension that a ``single article'' means ``a single series''. Gnus
5906 can find out by itself what articles belong to a series, decode all the
5907 articles and unpack/view/save the resulting file(s).
5909 Gnus guesses what articles are in the series according to the following
5910 simplish rule: The subjects must be (nearly) identical, except for the
5911 last two numbers of the line. (Spaces are largely ignored, however.)
5913 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5914 will find all the articles that match the regexp @samp{^cat.gif
5915 ([0-9]+/[0-9]+).*$}.
5917 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5918 series}, will not be properly recognized by any of the automatic viewing
5919 commands, and you have to mark the articles manually with @kbd{#}.
5922 @node Uuencoded Articles
5923 @subsection Uuencoded Articles
5925 @cindex uuencoded articles
5930 @kindex X u (Summary)
5931 @findex gnus-uu-decode-uu
5932 @c @icon{gnus-uu-decode-uu}
5933 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5936 @kindex X U (Summary)
5937 @findex gnus-uu-decode-uu-and-save
5938 Uudecodes and saves the current series
5939 (@code{gnus-uu-decode-uu-and-save}).
5942 @kindex X v u (Summary)
5943 @findex gnus-uu-decode-uu-view
5944 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5947 @kindex X v U (Summary)
5948 @findex gnus-uu-decode-uu-and-save-view
5949 Uudecodes, views and saves the current series
5950 (@code{gnus-uu-decode-uu-and-save-view}).
5954 Remember that these all react to the presence of articles marked with
5955 the process mark. If, for instance, you'd like to decode and save an
5956 entire newsgroup, you'd typically do @kbd{M P a}
5957 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5958 (@code{gnus-uu-decode-uu-and-save}).
5960 All this is very much different from how @code{gnus-uu} worked with
5961 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5962 the sun. This version of @code{gnus-uu} generally assumes that you mark
5963 articles in some way (@pxref{Setting Process Marks}) and then press
5966 @vindex gnus-uu-notify-files
5967 Note: When trying to decode articles that have names matching
5968 @code{gnus-uu-notify-files}, which is hard-coded to
5969 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5970 automatically post an article on @samp{comp.unix.wizards} saying that
5971 you have just viewed the file in question. This feature can't be turned
5975 @node Shell Archives
5976 @subsection Shell Archives
5978 @cindex shell archives
5979 @cindex shared articles
5981 Shell archives (``shar files'') used to be a popular way to distribute
5982 sources, but it isn't used all that much today. In any case, we have
5983 some commands to deal with these:
5988 @kindex X s (Summary)
5989 @findex gnus-uu-decode-unshar
5990 Unshars the current series (@code{gnus-uu-decode-unshar}).
5993 @kindex X S (Summary)
5994 @findex gnus-uu-decode-unshar-and-save
5995 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5998 @kindex X v s (Summary)
5999 @findex gnus-uu-decode-unshar-view
6000 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
6003 @kindex X v S (Summary)
6004 @findex gnus-uu-decode-unshar-and-save-view
6005 Unshars, views and saves the current series
6006 (@code{gnus-uu-decode-unshar-and-save-view}).
6010 @node PostScript Files
6011 @subsection PostScript Files
6017 @kindex X p (Summary)
6018 @findex gnus-uu-decode-postscript
6019 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
6022 @kindex X P (Summary)
6023 @findex gnus-uu-decode-postscript-and-save
6024 Unpack and save the current PostScript series
6025 (@code{gnus-uu-decode-postscript-and-save}).
6028 @kindex X v p (Summary)
6029 @findex gnus-uu-decode-postscript-view
6030 View the current PostScript series
6031 (@code{gnus-uu-decode-postscript-view}).
6034 @kindex X v P (Summary)
6035 @findex gnus-uu-decode-postscript-and-save-view
6036 View and save the current PostScript series
6037 (@code{gnus-uu-decode-postscript-and-save-view}).
6042 @subsection Other Files
6046 @kindex X o (Summary)
6047 @findex gnus-uu-decode-save
6048 Save the current series
6049 (@code{gnus-uu-decode-save}).
6052 @kindex X b (Summary)
6053 @findex gnus-uu-decode-binhex
6054 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
6055 doesn't really work yet.
6059 @node Decoding Variables
6060 @subsection Decoding Variables
6062 Adjective, not verb.
6065 * Rule Variables:: Variables that say how a file is to be viewed.
6066 * Other Decode Variables:: Other decode variables.
6067 * Uuencoding and Posting:: Variables for customizing uuencoding.
6071 @node Rule Variables
6072 @subsubsection Rule Variables
6073 @cindex rule variables
6075 Gnus uses @dfn{rule variables} to decide how to view a file. All these
6076 variables are of the form
6079 (list '(regexp1 command2)
6086 @item gnus-uu-user-view-rules
6087 @vindex gnus-uu-user-view-rules
6089 This variable is consulted first when viewing files. If you wish to use,
6090 for instance, @code{sox} to convert an @samp{.au} sound file, you could
6093 (setq gnus-uu-user-view-rules
6094 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
6097 @item gnus-uu-user-view-rules-end
6098 @vindex gnus-uu-user-view-rules-end
6099 This variable is consulted if Gnus couldn't make any matches from the
6100 user and default view rules.
6102 @item gnus-uu-user-archive-rules
6103 @vindex gnus-uu-user-archive-rules
6104 This variable can be used to say what commands should be used to unpack
6109 @node Other Decode Variables
6110 @subsubsection Other Decode Variables
6113 @vindex gnus-uu-grabbed-file-functions
6115 @item gnus-uu-grabbed-file-functions
6116 All functions in this list will be called right after each file has been
6117 successfully decoded---so that you can move or view files right away,
6118 and don't have to wait for all files to be decoded before you can do
6119 anything. Ready-made functions you can put in this list are:
6123 @item gnus-uu-grab-view
6124 @findex gnus-uu-grab-view
6127 @item gnus-uu-grab-move
6128 @findex gnus-uu-grab-move
6129 Move the file (if you're using a saving function.)
6132 @item gnus-uu-be-dangerous
6133 @vindex gnus-uu-be-dangerous
6134 Specifies what to do if unusual situations arise during decoding. If
6135 @code{nil}, be as conservative as possible. If @code{t}, ignore things
6136 that didn't work, and overwrite existing files. Otherwise, ask each
6139 @item gnus-uu-ignore-files-by-name
6140 @vindex gnus-uu-ignore-files-by-name
6141 Files with name matching this regular expression won't be viewed.
6143 @item gnus-uu-ignore-files-by-type
6144 @vindex gnus-uu-ignore-files-by-type
6145 Files with a @sc{mime} type matching this variable won't be viewed.
6146 Note that Gnus tries to guess what type the file is based on the name.
6147 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
6150 @item gnus-uu-tmp-dir
6151 @vindex gnus-uu-tmp-dir
6152 Where @code{gnus-uu} does its work.
6154 @item gnus-uu-do-not-unpack-archives
6155 @vindex gnus-uu-do-not-unpack-archives
6156 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
6157 looking for files to display.
6159 @item gnus-uu-view-and-save
6160 @vindex gnus-uu-view-and-save
6161 Non-@code{nil} means that the user will always be asked to save a file
6164 @item gnus-uu-ignore-default-view-rules
6165 @vindex gnus-uu-ignore-default-view-rules
6166 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
6169 @item gnus-uu-ignore-default-archive-rules
6170 @vindex gnus-uu-ignore-default-archive-rules
6171 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
6174 @item gnus-uu-kill-carriage-return
6175 @vindex gnus-uu-kill-carriage-return
6176 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
6179 @item gnus-uu-unmark-articles-not-decoded
6180 @vindex gnus-uu-unmark-articles-not-decoded
6181 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
6182 decoded articles as unread.
6184 @item gnus-uu-correct-stripped-uucode
6185 @vindex gnus-uu-correct-stripped-uucode
6186 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
6187 uuencoded files that have had trailing spaces deleted.
6189 @item gnus-uu-pre-uudecode-hook
6190 @vindex gnus-uu-pre-uudecode-hook
6191 Hook run before sending a message to @code{uudecode}.
6193 @item gnus-uu-view-with-metamail
6194 @vindex gnus-uu-view-with-metamail
6196 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6197 commands defined by the rule variables and just fudge a @sc{mime}
6198 content type based on the file name. The result will be fed to
6199 @code{metamail} for viewing.
6201 @item gnus-uu-save-in-digest
6202 @vindex gnus-uu-save-in-digest
6203 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6204 decoding, will save in digests. If this variable is @code{nil},
6205 @code{gnus-uu} will just save everything in a file without any
6206 embellishments. The digesting almost conforms to RFC1153---no easy way
6207 to specify any meaningful volume and issue numbers were found, so I
6208 simply dropped them.
6213 @node Uuencoding and Posting
6214 @subsubsection Uuencoding and Posting
6218 @item gnus-uu-post-include-before-composing
6219 @vindex gnus-uu-post-include-before-composing
6220 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6221 before you compose the article. If this variable is @code{t}, you can
6222 either include an encoded file with @kbd{C-c C-i} or have one included
6223 for you when you post the article.
6225 @item gnus-uu-post-length
6226 @vindex gnus-uu-post-length
6227 Maximum length of an article. The encoded file will be split into how
6228 many articles it takes to post the entire file.
6230 @item gnus-uu-post-threaded
6231 @vindex gnus-uu-post-threaded
6232 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6233 thread. This may not be smart, as no other decoder I have seen is able
6234 to follow threads when collecting uuencoded articles. (Well, I have
6235 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6236 think that counts...) Default is @code{nil}.
6238 @item gnus-uu-post-separate-description
6239 @vindex gnus-uu-post-separate-description
6240 Non-@code{nil} means that the description will be posted in a separate
6241 article. The first article will typically be numbered (0/x). If this
6242 variable is @code{nil}, the description the user enters will be included
6243 at the beginning of the first article, which will be numbered (1/x).
6244 Default is @code{t}.
6250 @subsection Viewing Files
6251 @cindex viewing files
6252 @cindex pseudo-articles
6254 After decoding, if the file is some sort of archive, Gnus will attempt
6255 to unpack the archive and see if any of the files in the archive can be
6256 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
6257 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
6258 uncompress and de-tar the main file, and then view the two pictures.
6259 This unpacking process is recursive, so if the archive contains archives
6260 of archives, it'll all be unpacked.
6262 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
6263 extracted file into the summary buffer. If you go to these
6264 ``articles'', you will be prompted for a command to run (usually Gnus
6265 will make a suggestion), and then the command will be run.
6267 @vindex gnus-view-pseudo-asynchronously
6268 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6269 until the viewing is done before proceeding.
6271 @vindex gnus-view-pseudos
6272 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6273 the pseudo-articles into the summary buffer, but view them
6274 immediately. If this variable is @code{not-confirm}, the user won't even
6275 be asked for a confirmation before viewing is done.
6277 @vindex gnus-view-pseudos-separately
6278 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6279 pseudo-article will be created for each file to be viewed. If
6280 @code{nil}, all files that use the same viewing command will be given as
6281 a list of parameters to that command.
6283 @vindex gnus-insert-pseudo-articles
6284 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6285 pseudo-articles when decoding. It is @code{t} by default.
6287 So; there you are, reading your @emph{pseudo-articles} in your
6288 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6289 Why isn't anything real anymore? How did we get here?
6292 @node Article Treatment
6293 @section Article Treatment
6295 Reading through this huge manual, you may have quite forgotten that the
6296 object of newsreaders is to actually, like, read what people have
6297 written. Reading articles. Unfortunately, people are quite bad at
6298 writing, so there are tons of functions and variables to make reading
6299 these articles easier.
6302 * Article Highlighting:: You want to make the article look like fruit salad.
6303 * Article Fontisizing:: Making emphasized text look nice.
6304 * Article Hiding:: You also want to make certain info go away.
6305 * Article Washing:: Lots of way-neat functions to make life better.
6306 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
6307 * Article Date:: Grumble, UT!
6308 * Article Signature:: What is a signature?
6309 * Article Miscellania:: Various other stuff.
6313 @node Article Highlighting
6314 @subsection Article Highlighting
6315 @cindex highlighting
6317 Not only do you want your article buffer to look like fruit salad, but
6318 you want it to look like technicolor fruit salad.
6323 @kindex W H a (Summary)
6324 @findex gnus-article-highlight
6325 @findex gnus-article-maybe-highlight
6326 Do much highlighting of the current article
6327 (@code{gnus-article-highlight}). This function highlights header, cited
6328 text, the signature, and adds buttons to the body and the head.
6331 @kindex W H h (Summary)
6332 @findex gnus-article-highlight-headers
6333 @vindex gnus-header-face-alist
6334 Highlight the headers (@code{gnus-article-highlight-headers}). The
6335 highlighting will be done according to the @code{gnus-header-face-alist}
6336 variable, which is a list where each element has the form @var{(regexp
6337 name content)}. @var{regexp} is a regular expression for matching the
6338 header, @var{name} is the face used for highlighting the header name
6339 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6340 the header value. The first match made will be used. Note that
6341 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6344 @kindex W H c (Summary)
6345 @findex gnus-article-highlight-citation
6346 Highlight cited text (@code{gnus-article-highlight-citation}).
6348 Some variables to customize the citation highlights:
6351 @vindex gnus-cite-parse-max-size
6353 @item gnus-cite-parse-max-size
6354 If the article size if bigger than this variable (which is 25000 by
6355 default), no citation highlighting will be performed.
6357 @item gnus-cite-prefix-regexp
6358 @vindex gnus-cite-prefix-regexp
6359 Regexp matching the longest possible citation prefix on a line.
6361 @item gnus-cite-max-prefix
6362 @vindex gnus-cite-max-prefix
6363 Maximum possible length for a citation prefix (default 20).
6365 @item gnus-cite-face-list
6366 @vindex gnus-cite-face-list
6367 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6368 When there are citations from multiple articles in the same message,
6369 Gnus will try to give each citation from each article its own face.
6370 This should make it easier to see who wrote what.
6372 @item gnus-supercite-regexp
6373 @vindex gnus-supercite-regexp
6374 Regexp matching normal Supercite attribution lines.
6376 @item gnus-supercite-secondary-regexp
6377 @vindex gnus-supercite-secondary-regexp
6378 Regexp matching mangled Supercite attribution lines.
6380 @item gnus-cite-minimum-match-count
6381 @vindex gnus-cite-minimum-match-count
6382 Minimum number of identical prefixes we have to see before we believe
6383 that it's a citation.
6385 @item gnus-cite-attribution-prefix
6386 @vindex gnus-cite-attribution-prefix
6387 Regexp matching the beginning of an attribution line.
6389 @item gnus-cite-attribution-suffix
6390 @vindex gnus-cite-attribution-suffix
6391 Regexp matching the end of an attribution line.
6393 @item gnus-cite-attribution-face
6394 @vindex gnus-cite-attribution-face
6395 Face used for attribution lines. It is merged with the face for the
6396 cited text belonging to the attribution.
6402 @kindex W H s (Summary)
6403 @vindex gnus-signature-separator
6404 @vindex gnus-signature-face
6405 @findex gnus-article-highlight-signature
6406 Highlight the signature (@code{gnus-article-highlight-signature}).
6407 Everything after @code{gnus-signature-separator} (@pxref{Article
6408 Signature}) in an article will be considered a signature and will be
6409 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6414 @xref{Customizing Articles}, for how to highlight articles automatically.
6417 @node Article Fontisizing
6418 @subsection Article Fontisizing
6420 @cindex article emphasis
6422 @findex gnus-article-emphasize
6423 @kindex W e (Summary)
6424 People commonly add emphasis to words in news articles by writing things
6425 like @samp{_this_} or @samp{*this*}. Gnus can make this look nicer by
6426 running the article through the @kbd{W e}
6427 (@code{gnus-article-emphasize}) command.
6429 @vindex gnus-emphasis-alist
6430 How the emphasis is computed is controlled by the
6431 @code{gnus-emphasis-alist} variable. This is an alist where the first
6432 element is a regular expression to be matched. The second is a number
6433 that says what regular expression grouping is used to find the entire
6434 emphasized word. The third is a number that says what regexp grouping
6435 should be displayed and highlighted. (The text between these two
6436 groupings will be hidden.) The fourth is the face used for
6440 (setq gnus-article-emphasis
6441 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6442 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6445 @vindex gnus-emphasis-underline
6446 @vindex gnus-emphasis-bold
6447 @vindex gnus-emphasis-italic
6448 @vindex gnus-emphasis-underline-bold
6449 @vindex gnus-emphasis-underline-italic
6450 @vindex gnus-emphasis-bold-italic
6451 @vindex gnus-emphasis-underline-bold-italic
6452 By default, there are seven rules, and they use the following faces:
6453 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6454 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6455 @code{gnus-emphasis-underline-italic},
6456 @code{gnus-emphasis-underline-bold}, and
6457 @code{gnus-emphasis-underline-bold-italic}.
6459 If you want to change these faces, you can either use @kbd{M-x
6460 customize}, or you can use @code{copy-face}. For instance, if you want
6461 to make @code{gnus-emphasis-italic} use a red face instead, you could
6465 (copy-face 'red 'gnus-emphasis-italic)
6468 @vindex gnus-group-highlight-words-alist
6470 If you want to highlight arbitrary words, you can use the
6471 @code{gnus-group-highlight-words-alist} variable, which uses the same
6472 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
6473 parameter (@pxref{Group Parameters}) can also be used.
6475 @xref{Customizing Articles}, for how to fontize articles automatically.
6478 @node Article Hiding
6479 @subsection Article Hiding
6480 @cindex article hiding
6482 Or rather, hiding certain things in each article. There usually is much
6483 too much cruft in most articles.
6488 @kindex W W a (Summary)
6489 @findex gnus-article-hide
6490 Do quite a lot of hiding on the article buffer
6491 (@kbd{gnus-article-hide}). In particular, this function will hide
6492 headers, PGP, cited text and the signature.
6495 @kindex W W h (Summary)
6496 @findex gnus-article-hide-headers
6497 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
6501 @kindex W W b (Summary)
6502 @findex gnus-article-hide-boring-headers
6503 Hide headers that aren't particularly interesting
6504 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
6507 @kindex W W s (Summary)
6508 @findex gnus-article-hide-signature
6509 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
6513 @kindex W W p (Summary)
6514 @findex gnus-article-hide-pgp
6515 @vindex gnus-article-hide-pgp-hook
6516 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). The
6517 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6518 signature has been hidden. For example, to automatically verify
6519 articles that have signatures in them do:
6521 ;;; Hide pgp cruft if any.
6523 (setq gnus-treat-strip-pgp t)
6525 ;;; After hiding pgp, verify the message;
6526 ;;; only happens if pgp signature is found.
6528 (add-hook 'gnus-article-hide-pgp-hook
6531 (set-buffer gnus-original-article-buffer)
6536 @kindex W W P (Summary)
6537 @findex gnus-article-hide-pem
6538 Hide @sc{pem} (privacy enhanced messages) cruft
6539 (@code{gnus-article-hide-pem}).
6542 @kindex W W B (Summary)
6543 @findex gnus-article-strip-banner
6544 Strip the banner specified by the @code{banner} group parameter
6545 (@code{gnus-article-strip-banner}). This is mainly used to hide those
6546 annoying banners and/or signatures that some mailing lists and moderated
6547 groups adds to all the messages. The way to use this function is to add
6548 the @code{banner} group parameter (@pxref{Group Parameters}) to the
6549 group you want banners stripped from. The parameter either be a string,
6550 which will be interpreted as a regular expression matching text to be
6551 removed, or the symbol @code{signature}, meaning that the (last)
6552 signature should be removed.
6555 @kindex W W c (Summary)
6556 @findex gnus-article-hide-citation
6557 Hide citation (@code{gnus-article-hide-citation}). Some variables for
6558 customizing the hiding:
6562 @item gnus-cited-opened-text-button-line-format
6563 @itemx gnus-cited-closed-text-button-line-format
6564 @vindex gnus-cited-closed-text-button-line-format
6565 @vindex gnus-cited-opened-text-button-line-format
6566 Gnus adds buttons to show where the cited text has been hidden, and to
6567 allow toggle hiding the text. The format of the variable is specified
6568 by these format-like variable (@pxref{Formatting Variables}). These
6573 Starting point of the hidden text.
6575 Ending point of the hidden text.
6577 Number of characters in the hidden region.
6579 Number of lines of hidden text.
6582 @item gnus-cited-lines-visible
6583 @vindex gnus-cited-lines-visible
6584 The number of lines at the beginning of the cited text to leave shown.
6589 @kindex W W C-c (Summary)
6590 @findex gnus-article-hide-citation-maybe
6592 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
6593 following two variables:
6596 @item gnus-cite-hide-percentage
6597 @vindex gnus-cite-hide-percentage
6598 If the cited text is of a bigger percentage than this variable (default
6599 50), hide the cited text.
6601 @item gnus-cite-hide-absolute
6602 @vindex gnus-cite-hide-absolute
6603 The cited text must have at least this length (default 10) before it
6608 @kindex W W C (Summary)
6609 @findex gnus-article-hide-citation-in-followups
6610 Hide cited text in articles that aren't roots
6611 (@code{gnus-article-hide-citation-in-followups}). This isn't very
6612 useful as an interactive command, but might be a handy function to stick
6613 have happen automatically (@pxref{Customizing Articles}).
6617 All these ``hiding'' commands are toggles, but if you give a negative
6618 prefix to these commands, they will show what they have previously
6619 hidden. If you give a positive prefix, they will always hide.
6621 Also @pxref{Article Highlighting} for further variables for
6622 citation customization.
6624 @xref{Customizing Articles}, for how to hide article elements
6628 @node Article Washing
6629 @subsection Article Washing
6631 @cindex article washing
6633 We call this ``article washing'' for a really good reason. Namely, the
6634 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6636 @dfn{Washing} is defined by us as ``changing something from something to
6637 something else'', but normally results in something looking better.
6643 @kindex W l (Summary)
6644 @findex gnus-summary-stop-page-breaking
6645 Remove page breaks from the current article
6646 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
6650 @kindex W r (Summary)
6651 @findex gnus-summary-caesar-message
6652 @c @icon{gnus-summary-caesar-message}
6653 Do a Caesar rotate (rot13) on the article buffer
6654 (@code{gnus-summary-caesar-message}).
6655 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6656 (Typically offensive jokes and such.)
6658 It's commonly called ``rot13'' because each letter is rotated 13
6659 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6660 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
6661 is rumored to have employed this form of, uh, somewhat weak encryption.
6664 @kindex W t (Summary)
6665 @findex gnus-summary-toggle-header
6666 Toggle whether to display all headers in the article buffer
6667 (@code{gnus-summary-toggle-header}).
6670 @kindex W v (Summary)
6671 @findex gnus-summary-verbose-header
6672 Toggle whether to display all headers in the article buffer permanently
6673 (@code{gnus-summary-verbose-header}).
6676 @kindex W o (Summary)
6677 @findex gnus-article-treat-overstrike
6678 Treat overstrike (@code{gnus-article-treat-overstrike}).
6681 @kindex W d (Summary)
6682 @findex gnus-article-treat-dumbquotes
6683 @vindex gnus-article-dumbquotes-map
6685 @cindex M******** sm*rtq**t*s
6687 Treat M******** sm*rtq**t*s according to
6688 @code{gnus-article-dumbquotes-map}
6689 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
6690 whether a character is a sm*rtq**t* or not, so it should only be used
6694 @kindex W w (Summary)
6695 @findex gnus-article-fill-cited-article
6696 Do word wrap (@code{gnus-article-fill-cited-article}).
6698 You can give the command a numerical prefix to specify the width to use
6702 @kindex W q (Summary)
6703 @findex gnus-article-fill-long-lines
6704 Fill long lines (@code{gnus-article-fill-long-lines}).
6707 @kindex W C (Summary)
6708 @findex gnus-article-capitalize-sentencse
6709 Capitalize the first word in each sentence
6710 (@code{gnus-article-capitalize-sentences}).
6713 @kindex W c (Summary)
6714 @findex gnus-article-remove-cr
6715 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
6716 (this takes care of DOS line endings), and then translate any remaining
6717 CRs into LF (this takes care of Mac line endings)
6718 (@code{gnus-article-remove-cr}).
6721 @kindex W q (Summary)
6722 @findex gnus-article-de-quoted-unreadable
6723 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
6724 Quoted-Printable is one common @sc{mime} encoding employed when sending
6725 non-ASCII (i. e., 8-bit) articles. It typically makes strings like
6726 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
6727 readable to me. Note that the this is usually done automatically by
6728 Gnus if the message in question has a @code{Content-Transfer-Encoding}
6729 header that says that this encoding has been done.
6732 @kindex W f (Summary)
6734 @findex gnus-article-display-x-face
6735 @findex gnus-article-x-face-command
6736 @vindex gnus-article-x-face-command
6737 @vindex gnus-article-x-face-too-ugly
6743 Look for and display any X-Face headers
6744 (@code{gnus-article-display-x-face}). The command executed by this
6745 function is given by the @code{gnus-article-x-face-command} variable.
6746 If this variable is a string, this string will be executed in a
6747 sub-shell. If it is a function, this function will be called with the
6748 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
6749 is a regexp) matches the @code{From} header, the face will not be shown.
6750 The default action under Emacs is to fork off an @code{xv} to view the
6751 face; under XEmacs the default action is to display the face before the
6752 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
6753 support---that will make display somewhat faster. If there's no native
6754 X-Face support, Gnus will try to convert the @code{X-Face} header using
6755 external programs from the @code{pbmplus} package and friends.) If you
6756 want to have this function in the display hook, it should probably come
6760 @kindex W b (Summary)
6761 @findex gnus-article-add-buttons
6762 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6763 @xref{Article Buttons}.
6766 @kindex W B (Summary)
6767 @findex gnus-article-add-buttons-to-head
6768 Add clickable buttons to the article headers
6769 (@code{gnus-article-add-buttons-to-head}).
6772 @kindex W W H (Summary)
6773 @findex gnus-article-strip-headers-from-body
6774 Strip headers like the @code{X-No-Archive} header from the beginning of
6775 article bodies (@code{gnus-article-strip-headers-from-body}).
6778 @kindex W E l (Summary)
6779 @findex gnus-article-strip-leading-blank-lines
6780 Remove all blank lines from the beginning of the article
6781 (@code{gnus-article-strip-leading-blank-lines}).
6784 @kindex W E m (Summary)
6785 @findex gnus-article-strip-multiple-blank-lines
6786 Replace all blank lines with empty lines and then all multiple empty
6787 lines with a single empty line.
6788 (@code{gnus-article-strip-multiple-blank-lines}).
6791 @kindex W E t (Summary)
6792 @findex gnus-article-remove-trailing-blank-lines
6793 Remove all blank lines at the end of the article
6794 (@code{gnus-article-remove-trailing-blank-lines}).
6797 @kindex W E a (Summary)
6798 @findex gnus-article-strip-blank-lines
6799 Do all the three commands above
6800 (@code{gnus-article-strip-blank-lines}).
6803 @kindex W E A (Summary)
6804 @findex gnus-article-strip-all-blank-lines
6805 Remove all blank lines
6806 (@code{gnus-article-strip-all-blank-lines}).
6809 @kindex W E s (Summary)
6810 @findex gnus-article-strip-leading-space
6811 Remove all white space from the beginning of all lines of the article
6812 body (@code{gnus-article-strip-leading-space}).
6815 @kindex W E e (Summary)
6816 @findex gnus-article-strip-trailing-space
6817 Remove all white space from the end of all lines of the article
6818 body (@code{gnus-article-strip-trailing-space}).
6822 @xref{Customizing Articles}, for how to wash articles automatically.
6825 @node Article Buttons
6826 @subsection Article Buttons
6829 People often include references to other stuff in articles, and it would
6830 be nice if Gnus could just fetch whatever it is that people talk about
6831 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6832 button on these references.
6834 Gnus adds @dfn{buttons} to certain standard references by default:
6835 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
6836 two variables, one that handles article bodies and one that handles
6841 @item gnus-button-alist
6842 @vindex gnus-button-alist
6843 This is an alist where each entry has this form:
6846 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6852 All text that match this regular expression will be considered an
6853 external reference. Here's a typical regexp that matches embedded URLs:
6854 @samp{<URL:\\([^\n\r>]*\\)>}.
6857 Gnus has to know which parts of the matches is to be highlighted. This
6858 is a number that says what sub-expression of the regexp is to be
6859 highlighted. If you want it all highlighted, you use 0 here.
6862 This form will be @code{eval}ed, and if the result is non-@code{nil},
6863 this is considered a match. This is useful if you want extra sifting to
6864 avoid false matches.
6867 This function will be called when you click on this button.
6870 As with @var{button-par}, this is a sub-expression number, but this one
6871 says which part of the match is to be sent as data to @var{function}.
6875 So the full entry for buttonizing URLs is then
6878 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6881 @item gnus-header-button-alist
6882 @vindex gnus-header-button-alist
6883 This is just like the other alist, except that it is applied to the
6884 article head only, and that each entry has an additional element that is
6885 used to say what headers to apply the buttonize coding to:
6888 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6891 @var{HEADER} is a regular expression.
6893 @item gnus-button-url-regexp
6894 @vindex gnus-button-url-regexp
6895 A regular expression that matches embedded URLs. It is used in the
6896 default values of the variables above.
6898 @item gnus-article-button-face
6899 @vindex gnus-article-button-face
6900 Face used on buttons.
6902 @item gnus-article-mouse-face
6903 @vindex gnus-article-mouse-face
6904 Face used when the mouse cursor is over a button.
6908 @xref{Customizing Articles}, for how to buttonize articles automatically.
6912 @subsection Article Date
6914 The date is most likely generated in some obscure timezone you've never
6915 heard of, so it's quite nice to be able to find out what the time was
6916 when the article was sent.
6921 @kindex W T u (Summary)
6922 @findex gnus-article-date-ut
6923 Display the date in UT (aka. GMT, aka ZULU)
6924 (@code{gnus-article-date-ut}).
6927 @kindex W T i (Summary)
6928 @findex gnus-article-date-iso8601
6930 Display the date in international format, aka. ISO 8601
6931 (@code{gnus-article-date-iso8601}).
6934 @kindex W T l (Summary)
6935 @findex gnus-article-date-local
6936 Display the date in the local timezone (@code{gnus-article-date-local}).
6939 @kindex W T s (Summary)
6940 @vindex gnus-article-time-format
6941 @findex gnus-article-date-user
6942 @findex format-time-string
6943 Display the date using a user-defined format
6944 (@code{gnus-article-date-user}). The format is specified by the
6945 @code{gnus-article-time-format} variable, and is a string that's passed
6946 to @code{format-time-string}. See the documentation of that variable
6947 for a list of possible format specs.
6950 @kindex W T e (Summary)
6951 @findex gnus-article-date-lapsed
6952 @findex gnus-start-date-timer
6953 @findex gnus-stop-date-timer
6954 Say how much time has elapsed between the article was posted and now
6955 (@code{gnus-article-date-lapsed}). It looks something like:
6958 X-Sent: 9 years, 6 weeks, 4 days, 9 hours, 3 minutes, 28 seconds ago
6961 The value of @code{gnus-article-date-lapsed-new-header} determines
6962 whether this header will just be added below the old Date one, or will
6965 An advantage of using Gnus to read mail is that it converts simple bugs
6966 into wonderful absurdities.
6968 If you want to have this line updated continually, you can put
6971 (gnus-start-date-timer)
6974 in your @file{.gnus.el} file, or you can run it off of some hook. If
6975 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
6979 @kindex W T o (Summary)
6980 @findex gnus-article-date-original
6981 Display the original date (@code{gnus-article-date-original}). This can
6982 be useful if you normally use some other conversion function and are
6983 worried that it might be doing something totally wrong. Say, claiming
6984 that the article was posted in 1854. Although something like that is
6985 @emph{totally} impossible. Don't you trust me? *titter*
6989 @xref{Customizing Articles}, for how to display the date in your
6990 preferred format automatically.
6993 @node Article Signature
6994 @subsection Article Signature
6996 @cindex article signature
6998 @vindex gnus-signature-separator
6999 Each article is divided into two parts---the head and the body. The
7000 body can be divided into a signature part and a text part. The variable
7001 that says what is to be considered a signature is
7002 @code{gnus-signature-separator}. This is normally the standard
7003 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
7004 non-standard signature separators, so this variable can also be a list
7005 of regular expressions to be tested, one by one. (Searches are done
7006 from the end of the body towards the beginning.) One likely value is:
7009 (setq gnus-signature-separator
7010 '("^-- $" ; The standard
7011 "^-- *$" ; A common mangling
7012 "^-------*$" ; Many people just use a looong
7013 ; line of dashes. Shame!
7014 "^ *--------*$" ; Double-shame!
7015 "^________*$" ; Underscores are also popular
7016 "^========*$")) ; Pervert!
7019 The more permissive you are, the more likely it is that you'll get false
7022 @vindex gnus-signature-limit
7023 @code{gnus-signature-limit} provides a limit to what is considered a
7024 signature when displaying articles.
7028 If it is an integer, no signature may be longer (in characters) than
7031 If it is a floating point number, no signature may be longer (in lines)
7034 If it is a function, the function will be called without any parameters,
7035 and if it returns @code{nil}, there is no signature in the buffer.
7037 If it is a string, it will be used as a regexp. If it matches, the text
7038 in question is not a signature.
7041 This variable can also be a list where the elements may be of the types
7042 listed above. Here's an example:
7045 (setq gnus-signature-limit
7046 '(200.0 "^---*Forwarded article"))
7049 This means that if there are more than 200 lines after the signature
7050 separator, or the text after the signature separator is matched by
7051 the regular expression @samp{^---*Forwarded article}, then it isn't a
7052 signature after all.
7055 @node Article Miscellania
7056 @subsection Article Miscellania
7060 @kindex A t (Summary)
7061 @findex gnus-article-babel
7062 Translate the article from one language to another
7063 (@code{gnus-article-babel}).
7069 @section @sc{mime} Commands
7070 @cindex MIME decoding
7074 @kindex X m (Summary)
7075 @findex gnus-summary-save-parts
7076 Save all parts matching a @sc{mime} type to a directory
7077 (@code{gnus-summary-save-parts}). Understands the process/prefix
7078 convention (@pxref{Process/Prefix}).
7081 @kindex M-t (Summary)
7082 @findex gnus-summary-display-buttonized
7083 Toggle the buttonized display of the article buffer
7084 (@code{gnus-summary-toggle-display-buttonized}).
7087 @kindex W M w (Summary)
7088 Decode RFC2047-encoded words in the article headers
7089 (@code{gnus-article-decode-mime-words}).
7092 @kindex W M c (Summary)
7093 Decode encoded article bodies as well as charsets
7094 (@code{gnus-article-decode-charset}).
7096 This command looks in the @code{Content-Type} header to determine the
7097 charset. If there is no such header in the article, you can give it a
7098 prefix, which will prompt for the charset to decode as. In regional
7099 groups where people post using some common encoding (but do not include
7100 MIME headers), you can set the @code{charset} group/topic parameter to
7101 the required charset (@pxref{Group Parameters}).
7104 @kindex W M v (Summary)
7105 View all the @sc{mime} parts in the current article
7106 (@code{gnus-mime-view-all-parts}).
7113 @item gnus-ignored-mime-types
7114 @vindex gnus-ignored-mime-types
7115 This is a list of regexps. @sc{mime} types that match a regexp from
7116 this list will be completely ignored by Gnus. The default value is
7119 To have all Vcards be ignored, you'd say something like this:
7122 (setq gnus-ignored-mime-types
7126 @item gnus-unbuttonized-mime-types
7127 @vindex gnus-unbuttonized-mime-types
7128 This is a list of regexps. @sc{mime} types that match a regexp from
7129 this list won't have @sc{mime} buttons inserted unless they aren't
7130 displayed. The default value is @code{(".*/.*")}.
7132 @item gnus-article-mime-part-function
7133 @vindex gnus-article-mime-part-function
7134 For each @sc{mime} part, this function will be called with the @sc{mime}
7135 handle as the parameter. The function is meant to be used to allow
7136 users to gather information from the article (e. g., add Vcard info to
7137 the bbdb database) or to do actions based on parts (e. g., automatically
7138 save all jpegs into some directory).
7140 Here's an example function the does the latter:
7143 (defun my-save-all-jpeg-parts (handle)
7144 (when (equal (car (mm-handle-type handle)) "image/jpeg")
7146 (insert (mm-get-part handle))
7147 (write-region (point-min) (point-max)
7148 (read-file-name "Save jpeg to: ")))))
7149 (setq gnus-article-mime-part-function
7150 'my-save-all-jpeg-parts)
7153 @vindex gnus-mime-multipart-functions
7154 @item gnus-mime-multipart-functions
7155 Alist of @sc{mime} multipart types and functions to handle them.
7164 People use different charsets, and we have @sc{mime} to let us know what
7165 charsets they use. Or rather, we wish we had. Many people use
7166 newsreaders and mailers that do not understand or use @sc{mime}, and
7167 just send out messages without saying what character sets they use. To
7168 help a bit with this, some local news hierarchies have policies that say
7169 what character set is the default. For instance, the @samp{fj}
7170 hierarchy uses @code{iso-2022-jp-2}.
7172 @vindex gnus-group-charset-alist
7173 This knowledge is encoded in the @code{gnus-group-charset-alist}
7174 variable, which is an alist of regexps (to match group names) and
7175 default charsets to be used when reading these groups.
7177 In addition, some people do use soi-disant @sc{mime}-aware agents that
7178 aren't. These blitely mark messages as being in @code{iso-8859-1} even
7179 if they really are in @code{koi-8}. To help here, the
7180 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
7181 charsets that are listed here will be ignored. The variable can be set
7182 on a group-by-group basis using the group parameters (@pxref{Group
7183 Parameters}). The default value is @code{(unknown-8bit)}, which is
7184 something some agents insist on having in there.
7187 @node Article Commands
7188 @section Article Commands
7195 @kindex A P (Summary)
7196 @vindex gnus-ps-print-hook
7197 @findex gnus-summary-print-article
7198 Generate and print a PostScript image of the article buffer
7199 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
7200 run just before printing the buffer.
7205 @node Summary Sorting
7206 @section Summary Sorting
7207 @cindex summary sorting
7209 You can have the summary buffer sorted in various ways, even though I
7210 can't really see why you'd want that.
7215 @kindex C-c C-s C-n (Summary)
7216 @findex gnus-summary-sort-by-number
7217 Sort by article number (@code{gnus-summary-sort-by-number}).
7220 @kindex C-c C-s C-a (Summary)
7221 @findex gnus-summary-sort-by-author
7222 Sort by author (@code{gnus-summary-sort-by-author}).
7225 @kindex C-c C-s C-s (Summary)
7226 @findex gnus-summary-sort-by-subject
7227 Sort by subject (@code{gnus-summary-sort-by-subject}).
7230 @kindex C-c C-s C-d (Summary)
7231 @findex gnus-summary-sort-by-date
7232 Sort by date (@code{gnus-summary-sort-by-date}).
7235 @kindex C-c C-s C-l (Summary)
7236 @findex gnus-summary-sort-by-lines
7237 Sort by lines (@code{gnus-summary-sort-by-lines}).
7240 @kindex C-c C-s C-c (Summary)
7241 @findex gnus-summary-sort-by-chars
7242 Sort by article length (@code{gnus-summary-sort-by-chars}).
7245 @kindex C-c C-s C-i (Summary)
7246 @findex gnus-summary-sort-by-score
7247 Sort by score (@code{gnus-summary-sort-by-score}).
7250 These functions will work both when you use threading and when you don't
7251 use threading. In the latter case, all summary lines will be sorted,
7252 line by line. In the former case, sorting will be done on a
7253 root-by-root basis, which might not be what you were looking for. To
7254 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
7258 @node Finding the Parent
7259 @section Finding the Parent
7260 @cindex parent articles
7261 @cindex referring articles
7266 @findex gnus-summary-refer-parent-article
7267 If you'd like to read the parent of the current article, and it is not
7268 displayed in the summary buffer, you might still be able to. That is,
7269 if the current group is fetched by @sc{nntp}, the parent hasn't expired
7270 and the @code{References} in the current article are not mangled, you
7271 can just press @kbd{^} or @kbd{A r}
7272 (@code{gnus-summary-refer-parent-article}). If everything goes well,
7273 you'll get the parent. If the parent is already displayed in the
7274 summary buffer, point will just move to this article.
7276 If given a positive numerical prefix, fetch that many articles back into
7277 the ancestry. If given a negative numerical prefix, fetch just that
7278 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
7279 grandparent and the grandgrandparent of the current article. If you say
7280 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
7284 @findex gnus-summary-refer-references
7285 @kindex A R (Summary)
7286 Fetch all articles mentioned in the @code{References} header of the
7287 article (@code{gnus-summary-refer-references}).
7290 @findex gnus-summary-refer-thread
7291 @kindex A T (Summary)
7292 Display the full thread where the current article appears
7293 (@code{gnus-summary-refer-thread}). This command has to fetch all the
7294 headers in the current group to work, so it usually takes a while. If
7295 you do it often, you may consider setting @code{gnus-fetch-old-headers}
7296 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
7297 visible effects normally, but it'll make this command work a whole lot
7298 faster. Of course, it'll make group entry somewhat slow.
7300 @vindex gnus-refer-thread-limit
7301 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
7302 articles before the first displayed in the current group) headers to
7303 fetch when doing this command. The default is 200. If @code{t}, all
7304 the available headers will be fetched. This variable can be overridden
7305 by giving the @kbd{A T} command a numerical prefix.
7308 @findex gnus-summary-refer-article
7309 @kindex M-^ (Summary)
7311 @cindex fetching by Message-ID
7312 You can also ask the @sc{nntp} server for an arbitrary article, no
7313 matter what group it belongs to. @kbd{M-^}
7314 (@code{gnus-summary-refer-article}) will ask you for a
7315 @code{Message-ID}, which is one of those long, hard-to-read thingies
7316 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
7317 have to get it all exactly right. No fuzzy searches, I'm afraid.
7320 The current select method will be used when fetching by
7321 @code{Message-ID} from non-news select method, but you can override this
7322 by giving this command a prefix.
7324 @vindex gnus-refer-article-method
7325 If the group you are reading is located on a backend that does not
7326 support fetching by @code{Message-ID} very well (like @code{nnspool}),
7327 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
7328 would, perhaps, be best if the @sc{nntp} server you consult is the one
7329 updating the spool you are reading from, but that's not really
7332 Most of the mail backends support fetching by @code{Message-ID}, but do
7333 not do a particularly excellent job at it. That is, @code{nnmbox} and
7334 @code{nnbabyl} are able to locate articles from any groups, while
7335 @code{nnml} and @code{nnfolder} are only able to locate articles that
7336 have been posted to the current group. (Anything else would be too time
7337 consuming.) @code{nnmh} does not support this at all.
7340 @node Alternative Approaches
7341 @section Alternative Approaches
7343 Different people like to read news using different methods. This being
7344 Gnus, we offer a small selection of minor modes for the summary buffers.
7347 * Pick and Read:: First mark articles and then read them.
7348 * Binary Groups:: Auto-decode all articles.
7353 @subsection Pick and Read
7354 @cindex pick and read
7356 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
7357 a two-phased reading interface. The user first marks in a summary
7358 buffer the articles she wants to read. Then she starts reading the
7359 articles with just an article buffer displayed.
7361 @findex gnus-pick-mode
7362 @kindex M-x gnus-pick-mode
7363 Gnus provides a summary buffer minor mode that allows
7364 this---@code{gnus-pick-mode}. This basically means that a few process
7365 mark commands become one-keystroke commands to allow easy marking, and
7366 it provides one additional command for switching to the summary buffer.
7368 Here are the available keystrokes when using pick mode:
7373 @findex gnus-pick-article-or-thread
7374 Pick the article or thread on the current line
7375 (@code{gnus-pick-article-or-thread}). If the variable
7376 @code{gnus-thread-hide-subtree} is true, then this key selects the
7377 entire thread when used at the first article of the thread. Otherwise,
7378 it selects just the article. If given a numerical prefix, go to that
7379 thread or article and pick it. (The line number is normally displayed
7380 at the beginning of the summary pick lines.)
7383 @kindex SPACE (Pick)
7384 @findex gnus-pick-next-page
7385 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
7386 at the end of the buffer, start reading the picked articles.
7390 @findex gnus-pick-unmark-article-or-thread.
7391 Unpick the thread or article
7392 (@code{gnus-pick-unmark-article-or-thread}). If the variable
7393 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
7394 thread if used at the first article of the thread. Otherwise it unpicks
7395 just the article. You can give this key a numerical prefix to unpick
7396 the thread or article at that line.
7400 @findex gnus-pick-start-reading
7401 @vindex gnus-pick-display-summary
7402 Start reading the picked articles (@code{gnus-pick-start-reading}). If
7403 given a prefix, mark all unpicked articles as read first. If
7404 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
7405 will still be visible when you are reading.
7409 All the normal summary mode commands are still available in the
7410 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
7411 which is mapped to the same function
7412 @code{gnus-summary-tick-article-forward}.
7414 If this sounds like a good idea to you, you could say:
7417 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
7420 @vindex gnus-pick-mode-hook
7421 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
7423 @vindex gnus-mark-unpicked-articles-as-read
7424 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
7425 all unpicked articles as read. The default is @code{nil}.
7427 @vindex gnus-summary-pick-line-format
7428 The summary line format in pick mode is slightly different from the
7429 standard format. At the beginning of each line the line number is
7430 displayed. The pick mode line format is controlled by the
7431 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
7432 Variables}). It accepts the same format specs that
7433 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
7437 @subsection Binary Groups
7438 @cindex binary groups
7440 @findex gnus-binary-mode
7441 @kindex M-x gnus-binary-mode
7442 If you spend much time in binary groups, you may grow tired of hitting
7443 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
7444 is a minor mode for summary buffers that makes all ordinary Gnus article
7445 selection functions uudecode series of articles and display the result
7446 instead of just displaying the articles the normal way.
7449 @findex gnus-binary-show-article
7450 The only way, in fact, to see the actual articles is the @kbd{g}
7451 command, when you have turned on this mode
7452 (@code{gnus-binary-show-article}).
7454 @vindex gnus-binary-mode-hook
7455 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
7459 @section Tree Display
7462 @vindex gnus-use-trees
7463 If you don't like the normal Gnus summary display, you might try setting
7464 @code{gnus-use-trees} to @code{t}. This will create (by default) an
7465 additional @dfn{tree buffer}. You can execute all summary mode commands
7468 There are a few variables to customize the tree display, of course:
7471 @item gnus-tree-mode-hook
7472 @vindex gnus-tree-mode-hook
7473 A hook called in all tree mode buffers.
7475 @item gnus-tree-mode-line-format
7476 @vindex gnus-tree-mode-line-format
7477 A format string for the mode bar in the tree mode buffers (@pxref{Mode
7478 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
7479 of valid specs, @pxref{Summary Buffer Mode Line}.
7481 @item gnus-selected-tree-face
7482 @vindex gnus-selected-tree-face
7483 Face used for highlighting the selected article in the tree buffer. The
7484 default is @code{modeline}.
7486 @item gnus-tree-line-format
7487 @vindex gnus-tree-line-format
7488 A format string for the tree nodes. The name is a bit of a misnomer,
7489 though---it doesn't define a line, but just the node. The default value
7490 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
7491 the name of the poster. It is vital that all nodes are of the same
7492 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
7498 The name of the poster.
7500 The @code{From} header.
7502 The number of the article.
7504 The opening bracket.
7506 The closing bracket.
7511 @xref{Formatting Variables}.
7513 Variables related to the display are:
7516 @item gnus-tree-brackets
7517 @vindex gnus-tree-brackets
7518 This is used for differentiating between ``real'' articles and
7519 ``sparse'' articles. The format is @var{((real-open . real-close)
7520 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
7521 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7523 @item gnus-tree-parent-child-edges
7524 @vindex gnus-tree-parent-child-edges
7525 This is a list that contains the characters used for connecting parent
7526 nodes to their children. The default is @code{(?- ?\\ ?|)}.
7530 @item gnus-tree-minimize-window
7531 @vindex gnus-tree-minimize-window
7532 If this variable is non-@code{nil}, Gnus will try to keep the tree
7533 buffer as small as possible to allow more room for the other Gnus
7534 windows. If this variable is a number, the tree buffer will never be
7535 higher than that number. The default is @code{t}. Note that if you
7536 have several windows displayed side-by-side in a frame and the tree
7537 buffer is one of these, minimizing the tree window will also resize all
7538 other windows displayed next to it.
7540 @item gnus-generate-tree-function
7541 @vindex gnus-generate-tree-function
7542 @findex gnus-generate-horizontal-tree
7543 @findex gnus-generate-vertical-tree
7544 The function that actually generates the thread tree. Two predefined
7545 functions are available: @code{gnus-generate-horizontal-tree} and
7546 @code{gnus-generate-vertical-tree} (which is the default).
7550 Here's an example from a horizontal tree buffer:
7553 @{***@}-(***)-[odd]-[Gun]
7563 Here's the same thread displayed in a vertical tree buffer:
7567 |--------------------------\-----\-----\
7568 (***) [Bjo] [Gun] [Gun]
7570 [odd] [Jan] [odd] (***) [Jor]
7572 [Gun] [Eri] [Eri] [odd]
7577 If you're using horizontal trees, it might be nice to display the trees
7578 side-by-side with the summary buffer. You could add something like the
7579 following to your @file{.gnus.el} file:
7582 (setq gnus-use-trees t
7583 gnus-generate-tree-function 'gnus-generate-horizontal-tree
7584 gnus-tree-minimize-window nil)
7585 (gnus-add-configuration
7589 (summary 0.75 point)
7594 @xref{Windows Configuration}.
7597 @node Mail Group Commands
7598 @section Mail Group Commands
7599 @cindex mail group commands
7601 Some commands only make sense in mail groups. If these commands are
7602 invalid in the current group, they will raise a hell and let you know.
7604 All these commands (except the expiry and edit commands) use the
7605 process/prefix convention (@pxref{Process/Prefix}).
7610 @kindex B e (Summary)
7611 @findex gnus-summary-expire-articles
7612 Expire all expirable articles in the group
7613 (@code{gnus-summary-expire-articles}).
7616 @kindex B M-C-e (Summary)
7617 @findex gnus-summary-expire-articles-now
7618 Delete all the expirable articles in the group
7619 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
7620 articles eligible for expiry in the current group will
7621 disappear forever into that big @file{/dev/null} in the sky.
7624 @kindex B DEL (Summary)
7625 @findex gnus-summary-delete-article
7626 @c @icon{gnus-summary-mail-delete}
7627 Delete the mail article. This is ``delete'' as in ``delete it from your
7628 disk forever and ever, never to return again.'' Use with caution.
7629 (@code{gnus-summary-delete-article}).
7632 @kindex B m (Summary)
7634 @findex gnus-summary-move-article
7635 Move the article from one mail group to another
7636 (@code{gnus-summary-move-article}).
7639 @kindex B c (Summary)
7641 @findex gnus-summary-copy-article
7642 @c @icon{gnus-summary-mail-copy}
7643 Copy the article from one group (mail group or not) to a mail group
7644 (@code{gnus-summary-copy-article}).
7647 @kindex B B (Summary)
7648 @cindex crosspost mail
7649 @findex gnus-summary-crosspost-article
7650 Crosspost the current article to some other group
7651 (@code{gnus-summary-crosspost-article}). This will create a new copy of
7652 the article in the other group, and the Xref headers of the article will
7653 be properly updated.
7656 @kindex B i (Summary)
7657 @findex gnus-summary-import-article
7658 Import an arbitrary file into the current mail newsgroup
7659 (@code{gnus-summary-import-article}). You will be prompted for a file
7660 name, a @code{From} header and a @code{Subject} header.
7663 @kindex B r (Summary)
7664 @findex gnus-summary-respool-article
7665 Respool the mail article (@code{gnus-summary-respool-article}).
7666 @code{gnus-summary-respool-default-method} will be used as the default
7667 select method when respooling. This variable is @code{nil} by default,
7668 which means that the current group select method will be used instead.
7672 @kindex B w (Summary)
7674 @findex gnus-summary-edit-article
7675 @kindex C-c C-c (Article)
7676 Edit the current article (@code{gnus-summary-edit-article}). To finish
7677 editing and make the changes permanent, type @kbd{C-c C-c}
7678 (@kbd{gnus-summary-edit-article-done}). If you give a prefix to the
7679 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
7682 @kindex B q (Summary)
7683 @findex gnus-summary-respool-query
7684 If you want to re-spool an article, you might be curious as to what group
7685 the article will end up in before you do the re-spooling. This command
7686 will tell you (@code{gnus-summary-respool-query}).
7689 @kindex B t (Summary)
7690 @findex gnus-summary-respool-trace
7691 Similarly, this command will display all fancy splitting patterns used
7692 when repooling, if any (@code{gnus-summary-respool-trace}).
7695 @kindex B p (Summary)
7696 @findex gnus-summary-article-posted-p
7697 Some people have a tendency to send you "courtesy" copies when they
7698 follow up to articles you have posted. These usually have a
7699 @code{Newsgroups} header in them, but not always. This command
7700 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7701 article from your news server (or rather, from
7702 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7703 report back whether it found the article or not. Even if it says that
7704 it didn't find the article, it may have been posted anyway---mail
7705 propagation is much faster than news propagation, and the news copy may
7706 just not have arrived yet.
7710 @vindex gnus-move-split-methods
7711 @cindex moving articles
7712 If you move (or copy) articles regularly, you might wish to have Gnus
7713 suggest where to put the articles. @code{gnus-move-split-methods} is a
7714 variable that uses the same syntax as @code{gnus-split-methods}
7715 (@pxref{Saving Articles}). You may customize that variable to create
7716 suggestions you find reasonable.
7719 (setq gnus-move-split-methods
7720 '(("^From:.*Lars Magne" "nnml:junk")
7721 ("^Subject:.*gnus" "nnfolder:important")
7722 (".*" "nnml:misc")))
7726 @node Various Summary Stuff
7727 @section Various Summary Stuff
7730 * Summary Group Information:: Information oriented commands.
7731 * Searching for Articles:: Multiple article commands.
7732 * Summary Generation Commands:: (Re)generating the summary buffer.
7733 * Really Various Summary Commands:: Those pesky non-conformant commands.
7737 @vindex gnus-summary-mode-hook
7738 @item gnus-summary-mode-hook
7739 This hook is called when creating a summary mode buffer.
7741 @vindex gnus-summary-generate-hook
7742 @item gnus-summary-generate-hook
7743 This is called as the last thing before doing the threading and the
7744 generation of the summary buffer. It's quite convenient for customizing
7745 the threading variables based on what data the newsgroup has. This hook
7746 is called from the summary buffer after most summary buffer variables
7749 @vindex gnus-summary-prepare-hook
7750 @item gnus-summary-prepare-hook
7751 It is called after the summary buffer has been generated. You might use
7752 it to, for instance, highlight lines or modify the look of the buffer in
7753 some other ungodly manner. I don't care.
7755 @vindex gnus-summary-prepared-hook
7756 @item gnus-summary-prepared-hook
7757 A hook called as the very last thing after the summary buffer has been
7760 @vindex gnus-summary-ignore-duplicates
7761 @item gnus-summary-ignore-duplicates
7762 When Gnus discovers two articles that have the same @code{Message-ID},
7763 it has to do something drastic. No articles are allowed to have the
7764 same @code{Message-ID}, but this may happen when reading mail from some
7765 sources. Gnus allows you to customize what happens with this variable.
7766 If it is @code{nil} (which is the default), Gnus will rename the
7767 @code{Message-ID} (for display purposes only) and display the article as
7768 any other article. If this variable is @code{t}, it won't display the
7769 article---it'll be as if it never existed.
7774 @node Summary Group Information
7775 @subsection Summary Group Information
7780 @kindex H f (Summary)
7781 @findex gnus-summary-fetch-faq
7782 @vindex gnus-group-faq-directory
7783 Try to fetch the FAQ (list of frequently asked questions) for the
7784 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
7785 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7786 on a remote machine. This variable can also be a list of directories.
7787 In that case, giving a prefix to this command will allow you to choose
7788 between the various sites. @code{ange-ftp} or @code{efs} will probably
7789 be used for fetching the file.
7792 @kindex H d (Summary)
7793 @findex gnus-summary-describe-group
7794 Give a brief description of the current group
7795 (@code{gnus-summary-describe-group}). If given a prefix, force
7796 rereading the description from the server.
7799 @kindex H h (Summary)
7800 @findex gnus-summary-describe-briefly
7801 Give an extremely brief description of the most important summary
7802 keystrokes (@code{gnus-summary-describe-briefly}).
7805 @kindex H i (Summary)
7806 @findex gnus-info-find-node
7807 Go to the Gnus info node (@code{gnus-info-find-node}).
7811 @node Searching for Articles
7812 @subsection Searching for Articles
7817 @kindex M-s (Summary)
7818 @findex gnus-summary-search-article-forward
7819 Search through all subsequent articles for a regexp
7820 (@code{gnus-summary-search-article-forward}).
7823 @kindex M-r (Summary)
7824 @findex gnus-summary-search-article-backward
7825 Search through all previous articles for a regexp
7826 (@code{gnus-summary-search-article-backward}).
7830 @findex gnus-summary-execute-command
7831 This command will prompt you for a header field, a regular expression to
7832 match on this field, and a command to be executed if the match is made
7833 (@code{gnus-summary-execute-command}). If given a prefix, search
7837 @kindex M-& (Summary)
7838 @findex gnus-summary-universal-argument
7839 Perform any operation on all articles that have been marked with
7840 the process mark (@code{gnus-summary-universal-argument}).
7843 @node Summary Generation Commands
7844 @subsection Summary Generation Commands
7849 @kindex Y g (Summary)
7850 @findex gnus-summary-prepare
7851 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7854 @kindex Y c (Summary)
7855 @findex gnus-summary-insert-cached-articles
7856 Pull all cached articles (for the current group) into the summary buffer
7857 (@code{gnus-summary-insert-cached-articles}).
7862 @node Really Various Summary Commands
7863 @subsection Really Various Summary Commands
7869 @kindex C-d (Summary)
7870 @kindex A D (Summary)
7871 @findex gnus-summary-enter-digest-group
7872 If the current article is a collection of other articles (for instance,
7873 a digest), you might use this command to enter a group based on the that
7874 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
7875 guess what article type is currently displayed unless you give a prefix
7876 to this command, which forces a ``digest'' interpretation. Basically,
7877 whenever you see a message that is a collection of other messages of
7878 some format, you @kbd{C-d} and read these messages in a more convenient
7882 @kindex M-C-d (Summary)
7883 @findex gnus-summary-read-document
7884 This command is very similar to the one above, but lets you gather
7885 several documents into one biiig group
7886 (@code{gnus-summary-read-document}). It does this by opening several
7887 @code{nndoc} groups for each document, and then opening an
7888 @code{nnvirtual} group on top of these @code{nndoc} groups. This
7889 command understands the process/prefix convention
7890 (@pxref{Process/Prefix}).
7893 @kindex C-t (Summary)
7894 @findex gnus-summary-toggle-truncation
7895 Toggle truncation of summary lines
7896 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
7897 line centering function in the summary buffer, so it's not a good idea
7898 to have truncation switched off while reading articles.
7902 @findex gnus-summary-expand-window
7903 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7904 If given a prefix, force an @code{article} window configuration.
7907 @kindex M-C-e (Summary)
7908 @findex gnus-summary-edit-parameters
7909 Edit the group parameters (@pxref{Group Parameters}) of the current
7910 group (@code{gnus-summary-edit-parameters}).
7913 @kindex M-C-g (Summary)
7914 @findex gnus-summary-customize-parameters
7915 Customize the group parameters (@pxref{Group Parameters}) of the current
7916 group (@code{gnus-summary-customize-parameters}).
7921 @node Exiting the Summary Buffer
7922 @section Exiting the Summary Buffer
7923 @cindex summary exit
7924 @cindex exiting groups
7926 Exiting from the summary buffer will normally update all info on the
7927 group and return you to the group buffer.
7933 @kindex Z Z (Summary)
7935 @findex gnus-summary-exit
7936 @vindex gnus-summary-exit-hook
7937 @vindex gnus-summary-prepare-exit-hook
7938 @c @icon{gnus-summary-exit}
7939 Exit the current group and update all information on the group
7940 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7941 called before doing much of the exiting, which calls
7942 @code{gnus-summary-expire-articles} by default.
7943 @code{gnus-summary-exit-hook} is called after finishing the exit
7944 process. @code{gnus-group-no-more-groups-hook} is run when returning to
7945 group mode having no more (unread) groups.
7949 @kindex Z E (Summary)
7951 @findex gnus-summary-exit-no-update
7952 Exit the current group without updating any information on the group
7953 (@code{gnus-summary-exit-no-update}).
7957 @kindex Z c (Summary)
7959 @findex gnus-summary-catchup-and-exit
7960 @c @icon{gnus-summary-catchup-and-exit}
7961 Mark all unticked articles in the group as read and then exit
7962 (@code{gnus-summary-catchup-and-exit}).
7965 @kindex Z C (Summary)
7966 @findex gnus-summary-catchup-all-and-exit
7967 Mark all articles, even the ticked ones, as read and then exit
7968 (@code{gnus-summary-catchup-all-and-exit}).
7971 @kindex Z n (Summary)
7972 @findex gnus-summary-catchup-and-goto-next-group
7973 Mark all articles as read and go to the next group
7974 (@code{gnus-summary-catchup-and-goto-next-group}).
7977 @kindex Z R (Summary)
7978 @findex gnus-summary-reselect-current-group
7979 Exit this group, and then enter it again
7980 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
7981 all articles, both read and unread.
7985 @kindex Z G (Summary)
7986 @kindex M-g (Summary)
7987 @findex gnus-summary-rescan-group
7988 @c @icon{gnus-summary-mail-get}
7989 Exit the group, check for new articles in the group, and select the
7990 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
7991 articles, both read and unread.
7994 @kindex Z N (Summary)
7995 @findex gnus-summary-next-group
7996 Exit the group and go to the next group
7997 (@code{gnus-summary-next-group}).
8000 @kindex Z P (Summary)
8001 @findex gnus-summary-prev-group
8002 Exit the group and go to the previous group
8003 (@code{gnus-summary-prev-group}).
8006 @kindex Z s (Summary)
8007 @findex gnus-summary-save-newsrc
8008 Save the current number of read/marked articles in the dribble buffer
8009 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
8010 given a prefix, also save the @file{.newsrc} file(s). Using this
8011 command will make exit without updating (the @kbd{Q} command) worthless.
8014 @vindex gnus-exit-group-hook
8015 @code{gnus-exit-group-hook} is called when you exit the current
8018 @findex gnus-summary-wake-up-the-dead
8019 @findex gnus-dead-summary-mode
8020 @vindex gnus-kill-summary-on-exit
8021 If you're in the habit of exiting groups, and then changing your mind
8022 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
8023 If you do that, Gnus won't kill the summary buffer when you exit it.
8024 (Quelle surprise!) Instead it will change the name of the buffer to
8025 something like @samp{*Dead Summary ... *} and install a minor mode
8026 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
8027 buffer, you'll find that all keys are mapped to a function called
8028 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
8029 summary buffer will result in a live, normal summary buffer.
8031 There will never be more than one dead summary buffer at any one time.
8033 @vindex gnus-use-cross-reference
8034 The data on the current group will be updated (which articles you have
8035 read, which articles you have replied to, etc.) when you exit the
8036 summary buffer. If the @code{gnus-use-cross-reference} variable is
8037 @code{t} (which is the default), articles that are cross-referenced to
8038 this group and are marked as read, will also be marked as read in the
8039 other subscribed groups they were cross-posted to. If this variable is
8040 neither @code{nil} nor @code{t}, the article will be marked as read in
8041 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
8044 @node Crosspost Handling
8045 @section Crosspost Handling
8049 Marking cross-posted articles as read ensures that you'll never have to
8050 read the same article more than once. Unless, of course, somebody has
8051 posted it to several groups separately. Posting the same article to
8052 several groups (not cross-posting) is called @dfn{spamming}, and you are
8053 by law required to send nasty-grams to anyone who perpetrates such a
8054 heinous crime. You may want to try NoCeM handling to filter out spam
8057 Remember: Cross-posting is kinda ok, but posting the same article
8058 separately to several groups is not. Massive cross-posting (aka.
8059 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
8060 @code{gnus-summary-mail-crosspost-complaint} command to complain about
8061 excessive crossposting (@pxref{Summary Mail Commands}).
8063 @cindex cross-posting
8066 One thing that may cause Gnus to not do the cross-posting thing
8067 correctly is if you use an @sc{nntp} server that supports @sc{xover}
8068 (which is very nice, because it speeds things up considerably) which
8069 does not include the @code{Xref} header in its @sc{nov} lines. This is
8070 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
8071 even with @sc{xover} by registering the @code{Xref} lines of all
8072 articles you actually read, but if you kill the articles, or just mark
8073 them as read without reading them, Gnus will not get a chance to snoop
8074 the @code{Xref} lines out of these articles, and will be unable to use
8075 the cross reference mechanism.
8077 @cindex LIST overview.fmt
8078 @cindex overview.fmt
8079 To check whether your @sc{nntp} server includes the @code{Xref} header
8080 in its overview files, try @samp{telnet your.nntp.server nntp},
8081 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
8082 overview.fmt}. This may not work, but if it does, and the last line you
8083 get does not read @samp{Xref:full}, then you should shout and whine at
8084 your news admin until she includes the @code{Xref} header in the
8087 @vindex gnus-nov-is-evil
8088 If you want Gnus to get the @code{Xref}s right all the time, you have to
8089 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
8094 For an alternative approach, @pxref{Duplicate Suppression}.
8097 @node Duplicate Suppression
8098 @section Duplicate Suppression
8100 By default, Gnus tries to make sure that you don't have to read the same
8101 article more than once by utilizing the crossposting mechanism
8102 (@pxref{Crosspost Handling}). However, that simple and efficient
8103 approach may not work satisfactory for some users for various
8108 The @sc{nntp} server may fail to generate the @code{Xref} header. This
8109 is evil and not very common.
8112 The @sc{nntp} server may fail to include the @code{Xref} header in the
8113 @file{.overview} data bases. This is evil and all too common, alas.
8116 You may be reading the same group (or several related groups) from
8117 different @sc{nntp} servers.
8120 You may be getting mail that duplicates articles posted to groups.
8123 I'm sure there are other situations where @code{Xref} handling fails as
8124 well, but these four are the most common situations.
8126 If, and only if, @code{Xref} handling fails for you, then you may
8127 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
8128 will remember the @code{Message-ID}s of all articles you have read or
8129 otherwise marked as read, and then, as if by magic, mark them as read
8130 all subsequent times you see them---in @emph{all} groups. Using this
8131 mechanism is quite likely to be somewhat inefficient, but not overly
8132 so. It's certainly preferable to reading the same articles more than
8135 Duplicate suppression is not a very subtle instrument. It's more like a
8136 sledge hammer than anything else. It works in a very simple
8137 fashion---if you have marked an article as read, it adds this Message-ID
8138 to a cache. The next time it sees this Message-ID, it will mark the
8139 article as read with the @samp{M} mark. It doesn't care what group it
8143 @item gnus-suppress-duplicates
8144 @vindex gnus-suppress-duplicates
8145 If non-@code{nil}, suppress duplicates.
8147 @item gnus-save-duplicate-list
8148 @vindex gnus-save-duplicate-list
8149 If non-@code{nil}, save the list of duplicates to a file. This will
8150 make startup and shutdown take longer, so the default is @code{nil}.
8151 However, this means that only duplicate articles read in a single Gnus
8152 session are suppressed.
8154 @item gnus-duplicate-list-length
8155 @vindex gnus-duplicate-list-length
8156 This variable says how many @code{Message-ID}s to keep in the duplicate
8157 suppression list. The default is 10000.
8159 @item gnus-duplicate-file
8160 @vindex gnus-duplicate-file
8161 The name of the file to store the duplicate suppression list in. The
8162 default is @file{~/News/suppression}.
8165 If you have a tendency to stop and start Gnus often, setting
8166 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
8167 you leave Gnus running for weeks on end, you may have it @code{nil}. On
8168 the other hand, saving the list makes startup and shutdown much slower,
8169 so that means that if you stop and start Gnus often, you should set
8170 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
8171 to you to figure out, I think.
8174 @node The Article Buffer
8175 @chapter The Article Buffer
8176 @cindex article buffer
8178 The articles are displayed in the article buffer, of which there is only
8179 one. All the summary buffers share the same article buffer unless you
8180 tell Gnus otherwise.
8183 * Hiding Headers:: Deciding what headers should be displayed.
8184 * Using MIME:: Pushing articles through @sc{mime} before reading them.
8185 * Customizing Articles:: Tailoring the look of the articles.
8186 * Article Keymap:: Keystrokes available in the article buffer.
8187 * Misc Article:: Other stuff.
8191 @node Hiding Headers
8192 @section Hiding Headers
8193 @cindex hiding headers
8194 @cindex deleting headers
8196 The top section of each article is the @dfn{head}. (The rest is the
8197 @dfn{body}, but you may have guessed that already.)
8199 @vindex gnus-show-all-headers
8200 There is a lot of useful information in the head: the name of the person
8201 who wrote the article, the date it was written and the subject of the
8202 article. That's well and nice, but there's also lots of information
8203 most people do not want to see---what systems the article has passed
8204 through before reaching you, the @code{Message-ID}, the
8205 @code{References}, etc. ad nauseum---and you'll probably want to get rid
8206 of some of those lines. If you want to keep all those lines in the
8207 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
8209 Gnus provides you with two variables for sifting headers:
8213 @item gnus-visible-headers
8214 @vindex gnus-visible-headers
8215 If this variable is non-@code{nil}, it should be a regular expression
8216 that says what headers you wish to keep in the article buffer. All
8217 headers that do not match this variable will be hidden.
8219 For instance, if you only want to see the name of the person who wrote
8220 the article and the subject, you'd say:
8223 (setq gnus-visible-headers "^From:\\|^Subject:")
8226 This variable can also be a list of regexps to match headers to
8229 @item gnus-ignored-headers
8230 @vindex gnus-ignored-headers
8231 This variable is the reverse of @code{gnus-visible-headers}. If this
8232 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
8233 should be a regular expression that matches all lines that you want to
8234 hide. All lines that do not match this variable will remain visible.
8236 For instance, if you just want to get rid of the @code{References} line
8237 and the @code{Xref} line, you might say:
8240 (setq gnus-ignored-headers "^References:\\|^Xref:")
8243 This variable can also be a list of regexps to match headers to
8246 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
8247 variable will have no effect.
8251 @vindex gnus-sorted-header-list
8252 Gnus can also sort the headers for you. (It does this by default.) You
8253 can control the sorting by setting the @code{gnus-sorted-header-list}
8254 variable. It is a list of regular expressions that says in what order
8255 the headers are to be displayed.
8257 For instance, if you want the name of the author of the article first,
8258 and then the subject, you might say something like:
8261 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
8264 Any headers that are to remain visible, but are not listed in this
8265 variable, will be displayed in random order after all the headers listed in this variable.
8267 @findex gnus-article-hide-boring-headers
8268 @vindex gnus-boring-article-headers
8269 You can hide further boring headers by setting
8270 @code{gnus-treat-hide-boring-header} to @code{head}. What this function
8271 does depends on the @code{gnus-boring-article-headers} variable. It's a
8272 list, but this list doesn't actually contain header names. Instead is
8273 lists various @dfn{boring conditions} that Gnus can check and remove
8276 These conditions are:
8279 Remove all empty headers.
8281 Remove the @code{Followup-To} header if it is identical to the
8282 @code{Newsgroups} header.
8284 Remove the @code{Reply-To} header if it lists the same address as the
8287 Remove the @code{Newsgroups} header if it only contains the current group
8290 Remove the @code{Date} header if the article is less than three days
8293 Remove the @code{To} header if it is very long.
8295 Remove all @code{To} headers if there are more than one.
8298 To include the four three elements, you could say something like;
8301 (setq gnus-boring-article-headers
8302 '(empty followup-to reply-to))
8305 This is also the default value for this variable.
8309 @section Using @sc{mime}
8312 Mime is a standard for waving your hands through the air, aimlessly,
8313 while people stand around yawning.
8315 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
8316 while all newsreaders die of fear.
8318 @sc{mime} may specify what character set the article uses, the encoding
8319 of the characters, and it also makes it possible to embed pictures and
8320 other naughty stuff in innocent-looking articles.
8322 @vindex gnus-display-mime-function
8323 @findex gnus-display-mime
8324 Gnus pushes @sc{mime} articles through @code{gnus-display-mime-function}
8325 to display the @sc{mime} parts. This is @code{gnus-display-mime} by
8326 default, which creates a bundle of clickable buttons that can be used to
8327 display, save and manipulate the @sc{mime} objects.
8329 The following commands are available when you have placed point over a
8333 @findex gnus-article-press-button
8335 @itemx BUTTON-2 (Article)
8336 Toggle displaying of the @sc{mime} object
8337 (@code{gnus-article-press-button}).
8339 @findex gnus-mime-view-part
8340 @item M-RET (Article)
8342 Prompt for a method, and then view the @sc{mime} object using this
8343 method (@code{gnus-mime-view-part}).
8345 @findex gnus-mime-save-part
8347 Prompt for a file name, and then save the @sc{mime} object
8348 (@code{gnus-mime-save-part}).
8350 @findex gnus-mime-copy-part
8352 Copy the @sc{mime} object to a fresh buffer and display this buffer
8353 (@code{gnus-mime-copy-part}).
8355 @findex gnus-mime-view-part-as-type
8357 View the @sc{mime} object as if it were a different @sc{mime} media type
8358 (@code{gnus-mime-view-part-as-type}.
8360 @findex gnus-mime-pipe-part
8362 Output the @sc{mime} object to a process (@code{gnus-mime-pipe-part}).
8365 Gnus will display some @sc{mime} objects automatically. The way Gnus
8366 determines which parts to do this with is described in the Emacs MIME
8369 It might be best to just use the toggling functions from the article
8370 buffer to avoid getting nasty surprises. (For instance, you enter the
8371 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
8372 decoded the sound file in the article and some horrible sing-a-long song
8373 comes screaming out your speakers, and you can't find the volume button,
8374 because there isn't one, and people are starting to look at you, and you
8375 try to stop the program, but you can't, and you can't find the program
8376 to control the volume, and everybody else in the room suddenly decides
8377 to look at you disdainfully, and you'll feel rather stupid.)
8379 Any similarity to real events and people is purely coincidental. Ahem.
8381 Also see @pxref{MIME Commands}.
8384 @node Customizing Articles
8385 @section Customizing Articles
8386 @cindex article customization
8388 A slew of functions for customizing how the articles are to look like
8389 exist. You can call these functions interactively, or you can have them
8390 called automatically when you select the articles.
8392 To have them called automatically, you should set the corresponding
8393 ``treatment'' variable. For instance, to have headers hidden, you'd set
8394 @code{gnus-treat-hide-headers}. Below is a list of variables that can
8395 be set, but first we discuss the values these variables can have.
8399 @code{nil}: Don't do this treatment.
8402 @code{t}: Do this treatment on all body parts.
8405 @code{head}: Do the treatment on the headers.
8408 @code{last}: Do this treatment on the last part.
8411 An integer: Do this treatment on all body parts that have a length less
8415 A list of strings: Do this treatment on all body parts that are in
8416 articles that are read in groups that have names that match one of the
8417 regexps in the list.
8420 A list where the first element is not a string:
8422 The list is evaluated recursively. The first element of the list is a
8423 predicate. The following predicates are recognized: @code{or},
8424 @code{and}, @code{not} and @code{typep}. Here's an example:
8428 (typep "text/x-vcard"))
8433 You may have noticed that the word @dfn{part} is used here. This refers
8434 to the fact that some messages are @sc{mime} multipart articles that may
8435 be divided into several parts. Articles that are not multiparts are
8436 considered to contain just a single part.
8438 @vindex gnus-article-treat-types
8439 Are the treatments applied to all sorts of multipart parts? Yes, if you
8440 want to, but by default, only @samp{text/plain} parts are given the
8441 treatment. This is controlled by the @code{gnus-article-treat-types}
8442 variable, which is a list of regular expressions that are matched to the
8443 type of the part. This variable is ignored if the value of the
8444 controlling variable is a predicate list, as described above.
8446 The following treatment options are available. The easiest way to
8447 customize this is to examine the @code{gnus-article-treat} customization
8451 @item gnus-treat-highlight-signature
8452 @item gnus-treat-buttonize
8453 @item gnus-treat-buttonize-head
8454 @item gnus-treat-emphasize
8455 @item gnus-treat-fill-article
8456 @item gnus-treat-strip-cr
8457 @item gnus-treat-hide-headers
8458 @item gnus-treat-hide-boring-headers
8459 @item gnus-treat-hide-signature
8460 @item gnus-treat-hide-citation
8461 @item gnus-treat-strip-pgp
8462 @item gnus-treat-strip-pem
8463 @item gnus-treat-highlight-headers
8464 @item gnus-treat-highlight-citation
8465 @item gnus-treat-highlight-signature
8466 @item gnus-treat-date-ut
8467 @item gnus-treat-date-local
8468 @item gnus-treat-date-lapsed
8469 @item gnus-treat-date-original
8470 @item gnus-treat-strip-headers-in-body
8471 @item gnus-treat-strip-trailing-blank-lines
8472 @item gnus-treat-strip-leading-blank-lines
8473 @item gnus-treat-strip-multiple-blank-lines
8474 @item gnus-treat-overstrike
8475 @item gnus-treat-display-xface
8476 @item gnus-treat-display-smileys
8477 @item gnus-treat-display-picons
8478 @item gnus-treat-capitalize-sentences
8479 @item gnus-treat-fill-long-lines
8480 @item gnus-treat-play-sounds
8481 @item gnus-treat-translate
8484 @vindex gnus-part-display-hook
8485 You can, of course, write your own functions to be called from
8486 @code{gnus-part-display-hook}. The functions are called narrowed to the
8487 part, and you can do anything you like, pretty much. There is no
8488 information that you have to keep in the buffer---you can change
8489 everything. However, you shouldn't delete any headers. Instead make
8490 them invisible if you want to make them go away.
8493 @node Article Keymap
8494 @section Article Keymap
8496 Most of the keystrokes in the summary buffer can also be used in the
8497 article buffer. They should behave as if you typed them in the summary
8498 buffer, which means that you don't actually have to have a summary
8499 buffer displayed while reading. You can do it all from the article
8502 A few additional keystrokes are available:
8507 @kindex SPACE (Article)
8508 @findex gnus-article-next-page
8509 Scroll forwards one page (@code{gnus-article-next-page}).
8512 @kindex DEL (Article)
8513 @findex gnus-article-prev-page
8514 Scroll backwards one page (@code{gnus-article-prev-page}).
8517 @kindex C-c ^ (Article)
8518 @findex gnus-article-refer-article
8519 If point is in the neighborhood of a @code{Message-ID} and you press
8520 @kbd{C-c ^}, Gnus will try to get that article from the server
8521 (@code{gnus-article-refer-article}).
8524 @kindex C-c C-m (Article)
8525 @findex gnus-article-mail
8526 Send a reply to the address near point (@code{gnus-article-mail}). If
8527 given a prefix, include the mail.
8531 @findex gnus-article-show-summary
8532 Reconfigure the buffers so that the summary buffer becomes visible
8533 (@code{gnus-article-show-summary}).
8537 @findex gnus-article-describe-briefly
8538 Give a very brief description of the available keystrokes
8539 (@code{gnus-article-describe-briefly}).
8542 @kindex TAB (Article)
8543 @findex gnus-article-next-button
8544 Go to the next button, if any (@code{gnus-article-next-button}). This
8545 only makes sense if you have buttonizing turned on.
8548 @kindex M-TAB (Article)
8549 @findex gnus-article-prev-button
8550 Go to the previous button, if any (@code{gnus-article-prev-button}).
8556 @section Misc Article
8560 @item gnus-single-article-buffer
8561 @vindex gnus-single-article-buffer
8562 If non-@code{nil}, use the same article buffer for all the groups.
8563 (This is the default.) If @code{nil}, each group will have its own
8566 @vindex gnus-article-decode-hook
8567 @item gnus-article-decode-hook
8569 Hook used to decode @sc{mime} articles. The default value is
8570 @code{(article-decode-charset article-decode-encoded-words)}
8572 @vindex gnus-article-prepare-hook
8573 @item gnus-article-prepare-hook
8574 This hook is called right after the article has been inserted into the
8575 article buffer. It is mainly intended for functions that do something
8576 depending on the contents; it should probably not be used for changing
8577 the contents of the article buffer.
8579 @item gnus-article-mode-hook
8580 @vindex gnus-article-mode-hook
8581 Hook called in article mode buffers.
8583 @item gnus-article-mode-syntax-table
8584 @vindex gnus-article-mode-syntax-table
8585 Syntax table used in article buffers. It is initialized from
8586 @code{text-mode-syntax-table}.
8588 @vindex gnus-article-mode-line-format
8589 @item gnus-article-mode-line-format
8590 This variable is a format string along the same lines as
8591 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
8592 accepts the same format specifications as that variable, with one
8597 The @dfn{wash status} of the article. This is a short string with one
8598 character for each possible article wash operation that may have been
8601 The number of @sc{mime} parts in the article.
8604 @vindex gnus-break-pages
8606 @item gnus-break-pages
8607 Controls whether @dfn{page breaking} is to take place. If this variable
8608 is non-@code{nil}, the articles will be divided into pages whenever a
8609 page delimiter appears in the article. If this variable is @code{nil},
8610 paging will not be done.
8612 @item gnus-page-delimiter
8613 @vindex gnus-page-delimiter
8614 This is the delimiter mentioned above. By default, it is @samp{^L}
8619 @node Composing Messages
8620 @chapter Composing Messages
8621 @cindex composing messages
8624 @cindex sending mail
8629 @kindex C-c C-c (Post)
8630 All commands for posting and mailing will put you in a message buffer
8631 where you can edit the article all you like, before you send the article
8632 by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The Message
8633 Manual}. If you are in a foreign news group, and you wish to post the
8634 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
8635 to make Gnus try to post using the foreign server.
8638 * Mail:: Mailing and replying.
8639 * Post:: Posting and following up.
8640 * Posting Server:: What server should you post via?
8641 * Mail and Post:: Mailing and posting at the same time.
8642 * Archived Messages:: Where Gnus stores the messages you've sent.
8643 * Posting Styles:: An easier way to specify who you are.
8644 * Drafts:: Postponing messages and rejected messages.
8645 * Rejected Articles:: What happens if the server doesn't like your article?
8648 Also see @pxref{Canceling and Superseding} for information on how to
8649 remove articles you shouldn't have posted.
8655 Variables for customizing outgoing mail:
8658 @item gnus-uu-digest-headers
8659 @vindex gnus-uu-digest-headers
8660 List of regexps to match headers included in digested messages. The
8661 headers will be included in the sequence they are matched.
8663 @item gnus-add-to-list
8664 @vindex gnus-add-to-list
8665 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8666 that have none when you do a @kbd{a}.
8674 Variables for composing news articles:
8677 @item gnus-sent-message-ids-file
8678 @vindex gnus-sent-message-ids-file
8679 Gnus will keep a @code{Message-ID} history file of all the mails it has
8680 sent. If it discovers that it has already sent a mail, it will ask the
8681 user whether to re-send the mail. (This is primarily useful when
8682 dealing with @sc{soup} packets and the like where one is apt to send the
8683 same packet multiple times.) This variable says what the name of this
8684 history file is. It is @file{~/News/Sent-Message-IDs} by default. Set
8685 this variable to @code{nil} if you don't want Gnus to keep a history
8688 @item gnus-sent-message-ids-length
8689 @vindex gnus-sent-message-ids-length
8690 This variable says how many @code{Message-ID}s to keep in the history
8691 file. It is 1000 by default.
8696 @node Posting Server
8697 @section Posting Server
8699 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8700 (extremely intelligent, of course) article, where does it go?
8702 Thank you for asking. I hate you.
8704 @vindex gnus-post-method
8706 It can be quite complicated. Normally, Gnus will use the same native
8707 server. However. If your native server doesn't allow posting, just
8708 reading, you probably want to use some other server to post your
8709 (extremely intelligent and fabulously interesting) articles. You can
8710 then set the @code{gnus-post-method} to some other method:
8713 (setq gnus-post-method '(nnspool ""))
8716 Now, if you've done this, and then this server rejects your article, or
8717 this server is down, what do you do then? To override this variable you
8718 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8719 the ``current'' server for posting.
8721 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8722 Gnus will prompt you for what method to use for posting.
8724 You can also set @code{gnus-post-method} to a list of select methods.
8725 If that's the case, Gnus will always prompt you for what method to use
8728 Finally, if you want to always post using the same select method as
8729 you're reading from (which might be convenient if you're reading lots of
8730 groups from different private servers), you can set this variable to
8735 @section Mail and Post
8737 Here's a list of variables relevant to both mailing and
8741 @item gnus-mailing-list-groups
8742 @findex gnus-mailing-list-groups
8743 @cindex mailing lists
8745 If your news server offers groups that are really mailing lists
8746 gatewayed to the @sc{nntp} server, you can read those groups without
8747 problems, but you can't post/followup to them without some difficulty.
8748 One solution is to add a @code{to-address} to the group parameters
8749 (@pxref{Group Parameters}). An easier thing to do is set the
8750 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8751 really are mailing lists. Then, at least, followups to the mailing
8752 lists will work most of the time. Posting to these groups (@kbd{a}) is
8753 still a pain, though.
8757 You may want to do spell-checking on messages that you send out. Or, if
8758 you don't want to spell-check by hand, you could add automatic
8759 spell-checking via the @code{ispell} package:
8762 @findex ispell-message
8764 (add-hook 'message-send-hook 'ispell-message)
8768 @node Archived Messages
8769 @section Archived Messages
8770 @cindex archived messages
8771 @cindex sent messages
8773 Gnus provides a few different methods for storing the mail and news you
8774 send. The default method is to use the @dfn{archive virtual server} to
8775 store the messages. If you want to disable this completely, the
8776 @code{gnus-message-archive-group} variable should be @code{nil}, which
8779 @vindex gnus-message-archive-method
8780 @code{gnus-message-archive-method} says what virtual server Gnus is to
8781 use to store sent messages. The default is:
8785 (nnfolder-directory "~/Mail/archive")
8786 (nnfolder-active-file "~/Mail/archive/active")
8787 (nnfolder-get-new-mail nil)
8788 (nnfolder-inhibit-expiry t))
8791 You can, however, use any mail select method (@code{nnml},
8792 @code{nnmbox}, etc.). @code{nnfolder} is a quite likeable select method
8793 for doing this sort of thing, though. If you don't like the default
8794 directory chosen, you could say something like:
8797 (setq gnus-message-archive-method
8798 '(nnfolder "archive"
8799 (nnfolder-inhibit-expiry t)
8800 (nnfolder-active-file "~/News/sent-mail/active")
8801 (nnfolder-directory "~/News/sent-mail/")))
8804 @vindex gnus-message-archive-group
8806 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8807 to one or more group(s) on that server. Which group to use is
8808 determined by the @code{gnus-message-archive-group} variable.
8810 This variable can be used to do the following:
8814 Messages will be saved in that group.
8815 @item a list of strings
8816 Messages will be saved in all those groups.
8817 @item an alist of regexps, functions and forms
8818 When a key ``matches'', the result is used.
8820 No message archiving will take place. This is the default.
8825 Just saving to a single group called @samp{MisK}:
8827 (setq gnus-message-archive-group "MisK")
8830 Saving to two groups, @samp{MisK} and @samp{safe}:
8832 (setq gnus-message-archive-group '("MisK" "safe"))
8835 Save to different groups based on what group you are in:
8837 (setq gnus-message-archive-group
8838 '(("^alt" "sent-to-alt")
8839 ("mail" "sent-to-mail")
8840 (".*" "sent-to-misc")))
8845 (setq gnus-message-archive-group
8846 '((if (message-news-p)
8851 How about storing all news messages in one file, but storing all mail
8852 messages in one file per month:
8855 (setq gnus-message-archive-group
8856 '((if (message-news-p)
8858 (concat "mail." (format-time-string
8859 "%Y-%m" (current-time))))))
8862 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8863 use a different value for @code{gnus-message-archive-group} there.)
8865 Now, when you send a message off, it will be stored in the appropriate
8866 group. (If you want to disable storing for just one particular message,
8867 you can just remove the @code{Gcc} header that has been inserted.) The
8868 archive group will appear in the group buffer the next time you start
8869 Gnus, or the next time you press @kbd{F} in the group buffer. You can
8870 enter it and read the articles in it just like you'd read any other
8871 group. If the group gets really big and annoying, you can simply rename
8872 if (using @kbd{G r} in the group buffer) to something
8873 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
8874 continue to be stored in the old (now empty) group.
8876 That's the default method of archiving sent messages. Gnus offers a
8877 different way for the people who don't like the default method. In that
8878 case you should set @code{gnus-message-archive-group} to @code{nil};
8879 this will disable archiving.
8882 @item gnus-outgoing-message-group
8883 @vindex gnus-outgoing-message-group
8884 All outgoing messages will be put in this group. If you want to store
8885 all your outgoing mail and articles in the group @samp{nnml:archive},
8886 you set this variable to that value. This variable can also be a list of
8889 If you want to have greater control over what group to put each
8890 message in, you can set this variable to a function that checks the
8891 current newsgroup name and then returns a suitable group name (or list
8894 This variable can be used instead of @code{gnus-message-archive-group},
8895 but the latter is the preferred method.
8899 @node Posting Styles
8900 @section Posting Styles
8901 @cindex posting styles
8904 All them variables, they make my head swim.
8906 So what if you want a different @code{Organization} and signature based
8907 on what groups you post to? And you post both from your home machine
8908 and your work machine, and you want different @code{From} lines, and so
8911 @vindex gnus-posting-styles
8912 One way to do stuff like that is to write clever hooks that change the
8913 variables you need to have changed. That's a bit boring, so somebody
8914 came up with the bright idea of letting the user specify these things in
8915 a handy alist. Here's an example of a @code{gnus-posting-styles}
8920 (signature "Peace and happiness")
8921 (organization "What me?"))
8923 (signature "Death to everybody"))
8924 ("comp.emacs.i-love-it"
8925 (organization "Emacs is it")))
8928 As you might surmise from this example, this alist consists of several
8929 @dfn{styles}. Each style will be applicable if the first element
8930 ``matches'', in some form or other. The entire alist will be iterated
8931 over, from the beginning towards the end, and each match will be
8932 applied, which means that attributes in later styles that match override
8933 the same attributes in earlier matching styles. So
8934 @samp{comp.programming.literate} will have the @samp{Death to everybody}
8935 signature and the @samp{What me?} @code{Organization} header.
8937 The first element in each style is called the @code{match}. If it's a
8938 string, then Gnus will try to regexp match it against the group name.
8939 If it's a function symbol, that function will be called with no
8940 arguments. If it's a variable symbol, then the variable will be
8941 referenced. If it's a list, then that list will be @code{eval}ed. In
8942 any case, if this returns a non-@code{nil} value, then the style is said
8945 Each style may contain a arbitrary amount of @dfn{attributes}. Each
8946 attribute consists of a @var{(name value)} pair. The attribute name
8947 can be one of @code{signature}, @code{signature-file},
8948 @code{organization}, @code{address}, @code{name} or @code{body}. The
8949 attribute name can also be a string. In that case, this will be used as
8950 a header name, and the value will be inserted in the headers of the
8953 The attribute value can be a string (used verbatim), a function with
8954 zero arguments (the return value will be used), a variable (its value
8955 will be used) or a list (it will be @code{eval}ed and the return value
8956 will be used). The functions and sexps are called/@code{eval}ed in the
8957 message buffer that is being set up. The headers of the current article
8958 are available through the @code{message-reply-headers} variable.
8960 If you wish to check whether the message you are about to compose is
8961 meant to be a news article or a mail message, you can check the values
8962 of the @code{message-news-p} and @code{message-mail-p} functions.
8964 @findex message-mail-p
8965 @findex message-news-p
8967 So here's a new example:
8970 (setq gnus-posting-styles
8972 (signature-file "~/.signature")
8974 ("X-Home-Page" (getenv "WWW_HOME"))
8975 (organization "People's Front Against MWM"))
8977 (signature my-funny-signature-randomizer))
8978 ((equal (system-name) "gnarly")
8979 (signature my-quote-randomizer))
8981 (signature my-news-signature))
8982 ((posting-from-work-p)
8983 (signature-file "~/.work-signature")
8984 (address "user@@bar.foo")
8985 (body "You are fired.\n\nSincerely, your boss.")
8986 (organization "Important Work, Inc"))
8988 (signature-file "~/.mail-signature"))))
8996 If you are writing a message (mail or news) and suddenly remember that
8997 you have a steak in the oven (or some pesto in the food processor, you
8998 craaazy vegetarians), you'll probably wish there was a method to save
8999 the message you are writing so that you can continue editing it some
9000 other day, and send it when you feel its finished.
9002 Well, don't worry about it. Whenever you start composing a message of
9003 some sort using the Gnus mail and post commands, the buffer you get will
9004 automatically associate to an article in a special @dfn{draft} group.
9005 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
9006 article will be saved there. (Auto-save files also go to the draft
9010 @vindex nndraft-directory
9011 The draft group is a special group (which is implemented as an
9012 @code{nndraft} group, if you absolutely have to know) called
9013 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
9014 @code{nndraft} is to store its files. What makes this group special is
9015 that you can't tick any articles in it or mark any articles as
9016 read---all articles in the group are permanently unread.
9018 If the group doesn't exist, it will be created and you'll be subscribed
9019 to it. The only way to make it disappear from the Group buffer is to
9022 @c @findex gnus-dissociate-buffer-from-draft
9023 @c @kindex C-c M-d (Mail)
9024 @c @kindex C-c M-d (Post)
9025 @c @findex gnus-associate-buffer-with-draft
9026 @c @kindex C-c C-d (Mail)
9027 @c @kindex C-c C-d (Post)
9028 @c If you're writing some super-secret message that you later want to
9029 @c encode with PGP before sending, you may wish to turn the auto-saving
9030 @c (and association with the draft group) off. You never know who might be
9031 @c interested in reading all your extremely valuable and terribly horrible
9032 @c and interesting secrets. The @kbd{C-c M-d}
9033 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
9034 @c If you change your mind and want to turn the auto-saving back on again,
9035 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
9037 @c @vindex gnus-use-draft
9038 @c To leave association with the draft group off by default, set
9039 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
9041 @findex gnus-draft-edit-message
9043 When you want to continue editing the article, you simply enter the
9044 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
9045 that. You will be placed in a buffer where you left off.
9047 Rejected articles will also be put in this draft group (@pxref{Rejected
9050 @findex gnus-draft-send-all-messages
9051 @findex gnus-draft-send-message
9052 If you have lots of rejected messages you want to post (or mail) without
9053 doing further editing, you can use the @kbd{D s} command
9054 (@code{gnus-draft-send-message}). This command understands the
9055 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
9056 command (@code{gnus-draft-send-all-messages}) will ship off all messages
9059 If you have some messages that you wish not to send, you can use the
9060 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
9061 as unsendable. This is a toggling command.
9064 @node Rejected Articles
9065 @section Rejected Articles
9066 @cindex rejected articles
9068 Sometimes a news server will reject an article. Perhaps the server
9069 doesn't like your face. Perhaps it just feels miserable. Perhaps
9070 @emph{there be demons}. Perhaps you have included too much cited text.
9071 Perhaps the disk is full. Perhaps the server is down.
9073 These situations are, of course, totally beyond the control of Gnus.
9074 (Gnus, of course, loves the way you look, always feels great, has angels
9075 fluttering around inside of it, doesn't care about how much cited text
9076 you include, never runs full and never goes down.) So Gnus saves these
9077 articles until some later time when the server feels better.
9079 The rejected articles will automatically be put in a special draft group
9080 (@pxref{Drafts}). When the server comes back up again, you'd then
9081 typically enter that group and send all the articles off.
9084 @node Select Methods
9085 @chapter Select Methods
9086 @cindex foreign groups
9087 @cindex select methods
9089 A @dfn{foreign group} is a group not read by the usual (or
9090 default) means. It could be, for instance, a group from a different
9091 @sc{nntp} server, it could be a virtual group, or it could be your own
9092 personal mail group.
9094 A foreign group (or any group, really) is specified by a @dfn{name} and
9095 a @dfn{select method}. To take the latter first, a select method is a
9096 list where the first element says what backend to use (e.g. @code{nntp},
9097 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
9098 name}. There may be additional elements in the select method, where the
9099 value may have special meaning for the backend in question.
9101 One could say that a select method defines a @dfn{virtual server}---so
9102 we do just that (@pxref{The Server Buffer}).
9104 The @dfn{name} of the group is the name the backend will recognize the
9107 For instance, the group @samp{soc.motss} on the @sc{nntp} server
9108 @samp{some.where.edu} will have the name @samp{soc.motss} and select
9109 method @code{(nntp "some.where.edu")}. Gnus will call this group
9110 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
9111 backend just knows this group as @samp{soc.motss}.
9113 The different methods all have their peculiarities, of course.
9116 * The Server Buffer:: Making and editing virtual servers.
9117 * Getting News:: Reading USENET news with Gnus.
9118 * Getting Mail:: Reading your personal mail with Gnus.
9119 * Other Sources:: Reading directories, files, SOUP packets.
9120 * Combined Groups:: Combining groups into one group.
9121 * Gnus Unplugged:: Reading news and mail offline.
9125 @node The Server Buffer
9126 @section The Server Buffer
9128 Traditionally, a @dfn{server} is a machine or a piece of software that
9129 one connects to, and then requests information from. Gnus does not
9130 connect directly to any real servers, but does all transactions through
9131 one backend or other. But that's just putting one layer more between
9132 the actual media and Gnus, so we might just as well say that each
9133 backend represents a virtual server.
9135 For instance, the @code{nntp} backend may be used to connect to several
9136 different actual @sc{nntp} servers, or, perhaps, to many different ports
9137 on the same actual @sc{nntp} server. You tell Gnus which backend to
9138 use, and what parameters to set by specifying a @dfn{select method}.
9140 These select method specifications can sometimes become quite
9141 complicated---say, for instance, that you want to read from the
9142 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
9143 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
9144 Anyways, if you had to specify that for each group that used this
9145 server, that would be too much work, so Gnus offers a way of naming
9146 select methods, which is what you do in the server buffer.
9148 To enter the server buffer, use the @kbd{^}
9149 (@code{gnus-group-enter-server-mode}) command in the group buffer.
9152 * Server Buffer Format:: You can customize the look of this buffer.
9153 * Server Commands:: Commands to manipulate servers.
9154 * Example Methods:: Examples server specifications.
9155 * Creating a Virtual Server:: An example session.
9156 * Server Variables:: Which variables to set.
9157 * Servers and Methods:: You can use server names as select methods.
9158 * Unavailable Servers:: Some servers you try to contact may be down.
9161 @vindex gnus-server-mode-hook
9162 @code{gnus-server-mode-hook} is run when creating the server buffer.
9165 @node Server Buffer Format
9166 @subsection Server Buffer Format
9167 @cindex server buffer format
9169 @vindex gnus-server-line-format
9170 You can change the look of the server buffer lines by changing the
9171 @code{gnus-server-line-format} variable. This is a @code{format}-like
9172 variable, with some simple extensions:
9177 How the news is fetched---the backend name.
9180 The name of this server.
9183 Where the news is to be fetched from---the address.
9186 The opened/closed/denied status of the server.
9189 @vindex gnus-server-mode-line-format
9190 The mode line can also be customized by using the
9191 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
9192 Formatting}). The following specs are understood:
9202 Also @pxref{Formatting Variables}.
9205 @node Server Commands
9206 @subsection Server Commands
9207 @cindex server commands
9213 @findex gnus-server-add-server
9214 Add a new server (@code{gnus-server-add-server}).
9218 @findex gnus-server-edit-server
9219 Edit a server (@code{gnus-server-edit-server}).
9222 @kindex SPACE (Server)
9223 @findex gnus-server-read-server
9224 Browse the current server (@code{gnus-server-read-server}).
9228 @findex gnus-server-exit
9229 Return to the group buffer (@code{gnus-server-exit}).
9233 @findex gnus-server-kill-server
9234 Kill the current server (@code{gnus-server-kill-server}).
9238 @findex gnus-server-yank-server
9239 Yank the previously killed server (@code{gnus-server-yank-server}).
9243 @findex gnus-server-copy-server
9244 Copy the current server (@code{gnus-server-copy-server}).
9248 @findex gnus-server-list-servers
9249 List all servers (@code{gnus-server-list-servers}).
9253 @findex gnus-server-scan-server
9254 Request that the server scan its sources for new articles
9255 (@code{gnus-server-scan-server}). This is mainly sensible with mail
9260 @findex gnus-server-regenerate-server
9261 Request that the server regenerate all its data structures
9262 (@code{gnus-server-regenerate-server}). This can be useful if you have
9263 a mail backend that has gotten out of synch.
9268 @node Example Methods
9269 @subsection Example Methods
9271 Most select methods are pretty simple and self-explanatory:
9274 (nntp "news.funet.fi")
9277 Reading directly from the spool is even simpler:
9283 As you can see, the first element in a select method is the name of the
9284 backend, and the second is the @dfn{address}, or @dfn{name}, if you
9287 After these two elements, there may be an arbitrary number of
9288 @var{(variable form)} pairs.
9290 To go back to the first example---imagine that you want to read from
9291 port 15 on that machine. This is what the select method should
9295 (nntp "news.funet.fi" (nntp-port-number 15))
9298 You should read the documentation to each backend to find out what
9299 variables are relevant, but here's an @code{nnmh} example:
9301 @code{nnmh} is a mail backend that reads a spool-like structure. Say
9302 you have two structures that you wish to access: One is your private
9303 mail spool, and the other is a public one. Here's the possible spec for
9307 (nnmh "private" (nnmh-directory "~/private/mail/"))
9310 (This server is then called @samp{private}, but you may have guessed
9313 Here's the method for a public spool:
9317 (nnmh-directory "/usr/information/spool/")
9318 (nnmh-get-new-mail nil))
9321 If you are behind a firewall and only have access to the @sc{nntp}
9322 server from the firewall machine, you can instruct Gnus to @code{rlogin}
9323 on the firewall machine and telnet from there to the @sc{nntp} server.
9324 Doing this can be rather fiddly, but your virtual server definition
9325 should probably look something like this:
9329 (nntp-address "the.firewall.machine")
9330 (nntp-open-connection-function nntp-open-rlogin)
9331 (nntp-end-of-line "\n")
9332 (nntp-rlogin-parameters
9333 ("telnet" "the.real.nntp.host" "nntp")))
9336 If you want to use the wonderful @code{ssh} program to provide a
9337 compressed connection over the modem line, you could create a virtual
9338 server that would look something like this:
9342 (nntp-address "copper.uio.no")
9343 (nntp-rlogin-program "ssh")
9344 (nntp-open-connection-function nntp-open-rlogin)
9345 (nntp-end-of-line "\n")
9346 (nntp-rlogin-parameters
9347 ("telnet" "news.uio.no" "nntp")))
9350 This means that you have to have set up @code{ssh-agent} correctly to
9351 provide automatic authorization, of course. And to get a compressed
9352 connection, you have to have the @samp{Compression} option in the
9353 @code{ssh} @file{config} file.
9356 @node Creating a Virtual Server
9357 @subsection Creating a Virtual Server
9359 If you're saving lots of articles in the cache by using persistent
9360 articles, you may want to create a virtual server to read the cache.
9362 First you need to add a new server. The @kbd{a} command does that. It
9363 would probably be best to use @code{nnspool} to read the cache. You
9364 could also use @code{nnml} or @code{nnmh}, though.
9366 Type @kbd{a nnspool RET cache RET}.
9368 You should now have a brand new @code{nnspool} virtual server called
9369 @samp{cache}. You now need to edit it to have the right definitions.
9370 Type @kbd{e} to edit the server. You'll be entered into a buffer that
9371 will contain the following:
9381 (nnspool-spool-directory "~/News/cache/")
9382 (nnspool-nov-directory "~/News/cache/")
9383 (nnspool-active-file "~/News/cache/active"))
9386 Type @kbd{C-c C-c} to return to the server buffer. If you now press
9387 @kbd{RET} over this virtual server, you should be entered into a browse
9388 buffer, and you should be able to enter any of the groups displayed.
9391 @node Server Variables
9392 @subsection Server Variables
9394 One sticky point when defining variables (both on backends and in Emacs
9395 in general) is that some variables are typically initialized from other
9396 variables when the definition of the variables is being loaded. If you
9397 change the "base" variable after the variables have been loaded, you
9398 won't change the "derived" variables.
9400 This typically affects directory and file variables. For instance,
9401 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
9402 directory variables are initialized from that variable, so
9403 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
9404 new virtual @code{nnml} server, it will @emph{not} suffice to set just
9405 @code{nnml-directory}---you have to explicitly set all the file
9406 variables to be what you want them to be. For a complete list of
9407 variables for each backend, see each backend's section later in this
9408 manual, but here's an example @code{nnml} definition:
9412 (nnml-directory "~/my-mail/")
9413 (nnml-active-file "~/my-mail/active")
9414 (nnml-newsgroups-file "~/my-mail/newsgroups"))
9418 @node Servers and Methods
9419 @subsection Servers and Methods
9421 Wherever you would normally use a select method
9422 (e.g. @code{gnus-secondary-select-method}, in the group select method,
9423 when browsing a foreign server) you can use a virtual server name
9424 instead. This could potentially save lots of typing. And it's nice all
9428 @node Unavailable Servers
9429 @subsection Unavailable Servers
9431 If a server seems to be unreachable, Gnus will mark that server as
9432 @code{denied}. That means that any subsequent attempt to make contact
9433 with that server will just be ignored. ``It can't be opened,'' Gnus
9434 will tell you, without making the least effort to see whether that is
9435 actually the case or not.
9437 That might seem quite naughty, but it does make sense most of the time.
9438 Let's say you have 10 groups subscribed to on server
9439 @samp{nephelococcygia.com}. This server is located somewhere quite far
9440 away from you and the machine is quite slow, so it takes 1 minute just
9441 to find out that it refuses connection to you today. If Gnus were to
9442 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
9443 attempt to do that. Once it has gotten a single ``connection refused'',
9444 it will regard that server as ``down''.
9446 So, what happens if the machine was only feeling unwell temporarily?
9447 How do you test to see whether the machine has come up again?
9449 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
9450 with the following commands:
9456 @findex gnus-server-open-server
9457 Try to establish connection to the server on the current line
9458 (@code{gnus-server-open-server}).
9462 @findex gnus-server-close-server
9463 Close the connection (if any) to the server
9464 (@code{gnus-server-close-server}).
9468 @findex gnus-server-deny-server
9469 Mark the current server as unreachable
9470 (@code{gnus-server-deny-server}).
9473 @kindex M-o (Server)
9474 @findex gnus-server-open-all-servers
9475 Open the connections to all servers in the buffer
9476 (@code{gnus-server-open-all-servers}).
9479 @kindex M-c (Server)
9480 @findex gnus-server-close-all-servers
9481 Close the connections to all servers in the buffer
9482 (@code{gnus-server-close-all-servers}).
9486 @findex gnus-server-remove-denials
9487 Remove all marks to whether Gnus was denied connection from any servers
9488 (@code{gnus-server-remove-denials}).
9494 @section Getting News
9495 @cindex reading news
9496 @cindex news backends
9498 A newsreader is normally used for reading news. Gnus currently provides
9499 only two methods of getting news---it can read from an @sc{nntp} server,
9500 or it can read from a local spool.
9503 * NNTP:: Reading news from an @sc{nntp} server.
9504 * News Spool:: Reading news from the local spool.
9509 @subsection @sc{nntp}
9512 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
9513 You just specify @code{nntp} as method and the address of the @sc{nntp}
9514 server as the, uhm, address.
9516 If the @sc{nntp} server is located at a non-standard port, setting the
9517 third element of the select method to this port number should allow you
9518 to connect to the right port. You'll have to edit the group info for
9519 that (@pxref{Foreign Groups}).
9521 The name of the foreign group can be the same as a native group. In
9522 fact, you can subscribe to the same group from as many different servers
9523 you feel like. There will be no name collisions.
9525 The following variables can be used to create a virtual @code{nntp}
9530 @item nntp-server-opened-hook
9531 @vindex nntp-server-opened-hook
9532 @cindex @sc{mode reader}
9534 @cindex authentification
9535 @cindex nntp authentification
9536 @findex nntp-send-authinfo
9537 @findex nntp-send-mode-reader
9538 is run after a connection has been made. It can be used to send
9539 commands to the @sc{nntp} server after it has been contacted. By
9540 default it sends the command @code{MODE READER} to the server with the
9541 @code{nntp-send-mode-reader} function. This function should always be
9542 present in this hook.
9544 @item nntp-authinfo-function
9545 @vindex nntp-authinfo-function
9546 @findex nntp-send-authinfo
9547 @vindex nntp-authinfo-file
9548 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
9549 server. The default function is @code{nntp-send-authinfo}, which looks
9550 through your @file{~/.authinfo} (or whatever you've set the
9551 @code{nntp-authinfo-file} variable to) for applicable entries. If none
9552 are found, it will prompt you for a login name and a password. The
9553 format of the @file{~/.authinfo} file is (almost) the same as the
9554 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
9555 manual page, but here are the salient facts:
9559 The file contains one or more line, each of which define one server.
9562 Each line may contain an arbitrary number of token/value pairs. The
9563 valid tokens include @samp{machine}, @samp{login}, @samp{password},
9564 @samp{default} and @samp{force}. (The latter is not a valid
9565 @file{.netrc}/@code{ftp} token, which is the only way the
9566 @file{.authinfo} file format deviates from the @file{.netrc} file
9571 Here's an example file:
9574 machine news.uio.no login larsi password geheimnis
9575 machine nntp.ifi.uio.no login larsi force yes
9578 The token/value pairs may appear in any order; @samp{machine} doesn't
9579 have to be first, for instance.
9581 In this example, both login name and password have been supplied for the
9582 former server, while the latter has only the login name listed, and the
9583 user will be prompted for the password. The latter also has the
9584 @samp{force} tag, which means that the authinfo will be sent to the
9585 @var{nntp} server upon connection; the default (i.e., when there is not
9586 @samp{force} tag) is to not send authinfo to the @var{nntp} server
9587 until the @var{nntp} server asks for it.
9589 You can also add @samp{default} lines that will apply to all servers
9590 that don't have matching @samp{machine} lines.
9596 This will force sending @samp{AUTHINFO} commands to all servers not
9597 previously mentioned.
9599 Remember to not leave the @file{~/.authinfo} file world-readable.
9601 @item nntp-server-action-alist
9602 @vindex nntp-server-action-alist
9603 This is a list of regexps to match on server types and actions to be
9604 taken when matches are made. For instance, if you want Gnus to beep
9605 every time you connect to innd, you could say something like:
9608 (setq nntp-server-action-alist
9612 You probably don't want to do that, though.
9614 The default value is
9617 '(("nntpd 1\\.5\\.11t"
9618 (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
9621 This ensures that Gnus doesn't send the @code{MODE READER} command to
9622 nntpd 1.5.11t, since that command chokes that server, I've been told.
9624 @item nntp-maximum-request
9625 @vindex nntp-maximum-request
9626 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
9627 will collect headers by sending a series of @code{head} commands. To
9628 speed things up, the backend sends lots of these commands without
9629 waiting for reply, and then reads all the replies. This is controlled
9630 by the @code{nntp-maximum-request} variable, and is 400 by default. If
9631 your network is buggy, you should set this to 1.
9633 @item nntp-connection-timeout
9634 @vindex nntp-connection-timeout
9635 If you have lots of foreign @code{nntp} groups that you connect to
9636 regularly, you're sure to have problems with @sc{nntp} servers not
9637 responding properly, or being too loaded to reply within reasonable
9638 time. This is can lead to awkward problems, which can be helped
9639 somewhat by setting @code{nntp-connection-timeout}. This is an integer
9640 that says how many seconds the @code{nntp} backend should wait for a
9641 connection before giving up. If it is @code{nil}, which is the default,
9642 no timeouts are done.
9644 @c @item nntp-command-timeout
9645 @c @vindex nntp-command-timeout
9646 @c @cindex PPP connections
9647 @c @cindex dynamic IP addresses
9648 @c If you're running Gnus on a machine that has a dynamically assigned
9649 @c address, Gnus may become confused. If the address of your machine
9650 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
9651 @c waiting forever for replies from the server. To help with this
9652 @c unfortunate problem, you can set this command to a number. Gnus will
9653 @c then, if it sits waiting for a reply from the server longer than that
9654 @c number of seconds, shut down the connection, start a new one, and resend
9655 @c the command. This should hopefully be transparent to the user. A
9656 @c likely number is 30 seconds.
9658 @c @item nntp-retry-on-break
9659 @c @vindex nntp-retry-on-break
9660 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
9661 @c hangs. This will have much the same effect as the command timeout
9664 @item nntp-server-hook
9665 @vindex nntp-server-hook
9666 This hook is run as the last step when connecting to an @sc{nntp}
9669 @findex nntp-open-rlogin
9670 @findex nntp-open-telnet
9671 @findex nntp-open-network-stream
9672 @item nntp-open-connection-function
9673 @vindex nntp-open-connection-function
9674 This function is used to connect to the remote system. Four pre-made
9675 functions are supplied:
9678 @item nntp-open-network-stream
9679 This is the default, and simply connects to some port or other on the
9682 @item nntp-open-rlogin
9683 Does an @samp{rlogin} on the
9684 remote system, and then does a @samp{telnet} to the @sc{nntp} server
9687 @code{nntp-open-rlogin}-related variables:
9691 @item nntp-rlogin-program
9692 @vindex nntp-rlogin-program
9693 Program used to log in on remote machines. The default is @samp{rsh},
9694 but @samp{ssh} is a popular alternative.
9696 @item nntp-rlogin-parameters
9697 @vindex nntp-rlogin-parameters
9698 This list will be used as the parameter list given to @code{rsh}.
9700 @item nntp-rlogin-user-name
9701 @vindex nntp-rlogin-user-name
9702 User name on the remote system.
9706 @item nntp-open-telnet
9707 Does a @samp{telnet} to the remote system and then another @samp{telnet}
9708 to get to the @sc{nntp} server.
9710 @code{nntp-open-telnet}-related variables:
9713 @item nntp-telnet-command
9714 @vindex nntp-telnet-command
9715 Command used to start @code{telnet}.
9717 @item nntp-telnet-switches
9718 @vindex nntp-telnet-switches
9719 List of strings to be used as the switches to the @code{telnet} command.
9721 @item nntp-telnet-user-name
9722 @vindex nntp-telnet-user-name
9723 User name for log in on the remote system.
9725 @item nntp-telnet-passwd
9726 @vindex nntp-telnet-passwd
9727 Password to use when logging in.
9729 @item nntp-telnet-parameters
9730 @vindex nntp-telnet-parameters
9731 A list of strings executed as a command after logging in
9734 @item nntp-telnet-shell-prompt
9735 @vindex nntp-telnet-shell-prompt
9736 Regexp matching the shell prompt on the remote machine. The default is
9737 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9739 @item nntp-open-telnet-envuser
9740 @vindex nntp-open-telnet-envuser
9741 If non-@code{nil}, the @code{telnet} session (client and server both)
9742 will support the @code{ENVIRON} option and not prompt for login name.
9743 This works for Solaris @code{telnet}, for instance.
9747 @findex nntp-open-ssl-stream
9748 @item nntp-open-ssl-stream
9749 Opens a connection to a server over a @dfn{secure} channel. To use this
9750 you must have SSLay installed
9751 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
9752 @file{ssl.el} (from the W3 distributeion, for instance). You then
9753 define a server as follows:
9756 ;; Type `C-c C-c' after you've finished editing.
9758 ;; "snews" is port 563 and is predefined in our /etc/services
9760 (nntp "snews.bar.com"
9761 (nntp-open-connection-function nntp-open-ssl-stream)
9762 (nntp-port-number "snews")
9763 (nntp-address "snews.bar.com"))
9768 @item nntp-end-of-line
9769 @vindex nntp-end-of-line
9770 String to use as end-of-line marker when talking to the @sc{nntp}
9771 server. This is @samp{\r\n} by default, but should be @samp{\n} when
9772 using @code{rlogin} to talk to the server.
9774 @item nntp-rlogin-user-name
9775 @vindex nntp-rlogin-user-name
9776 User name on the remote system when using the @code{rlogin} connect
9780 @vindex nntp-address
9781 The address of the remote system running the @sc{nntp} server.
9783 @item nntp-port-number
9784 @vindex nntp-port-number
9785 Port number to connect to when using the @code{nntp-open-network-stream}
9788 @item nntp-buggy-select
9789 @vindex nntp-buggy-select
9790 Set this to non-@code{nil} if your select routine is buggy.
9792 @item nntp-nov-is-evil
9793 @vindex nntp-nov-is-evil
9794 If the @sc{nntp} server does not support @sc{nov}, you could set this
9795 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9798 @item nntp-xover-commands
9799 @vindex nntp-xover-commands
9802 List of strings used as commands to fetch @sc{nov} lines from a
9803 server. The default value of this variable is @code{("XOVER"
9807 @vindex nntp-nov-gap
9808 @code{nntp} normally sends just one big request for @sc{nov} lines to
9809 the server. The server responds with one huge list of lines. However,
9810 if you have read articles 2-5000 in the group, and only want to read
9811 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9812 lines that you will not need. This variable says how
9813 big a gap between two consecutive articles is allowed to be before the
9814 @code{XOVER} request is split into several request. Note that if your
9815 network is fast, setting this variable to a really small number means
9816 that fetching will probably be slower. If this variable is @code{nil},
9817 @code{nntp} will never split requests. The default is 5.
9819 @item nntp-prepare-server-hook
9820 @vindex nntp-prepare-server-hook
9821 A hook run before attempting to connect to an @sc{nntp} server.
9823 @item nntp-warn-about-losing-connection
9824 @vindex nntp-warn-about-losing-connection
9825 If this variable is non-@code{nil}, some noise will be made when a
9826 server closes connection.
9828 @item nntp-record-commands
9829 @vindex nntp-record-commands
9830 If non-@code{nil}, @code{nntp} will log all commands it sends to the
9831 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
9832 buffer. This is useful if you are debugging a Gnus/@sc{nntp} connection
9833 that doesn't seem to work.
9839 @subsection News Spool
9843 Subscribing to a foreign group from the local spool is extremely easy,
9844 and might be useful, for instance, to speed up reading groups that
9845 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9848 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9849 anything else) as the address.
9851 If you have access to a local spool, you should probably use that as the
9852 native select method (@pxref{Finding the News}). It is normally faster
9853 than using an @code{nntp} select method, but might not be. It depends.
9854 You just have to try to find out what's best at your site.
9858 @item nnspool-inews-program
9859 @vindex nnspool-inews-program
9860 Program used to post an article.
9862 @item nnspool-inews-switches
9863 @vindex nnspool-inews-switches
9864 Parameters given to the inews program when posting an article.
9866 @item nnspool-spool-directory
9867 @vindex nnspool-spool-directory
9868 Where @code{nnspool} looks for the articles. This is normally
9869 @file{/usr/spool/news/}.
9871 @item nnspool-nov-directory
9872 @vindex nnspool-nov-directory
9873 Where @code{nnspool} will look for @sc{nov} files. This is normally
9874 @file{/usr/spool/news/over.view/}.
9876 @item nnspool-lib-dir
9877 @vindex nnspool-lib-dir
9878 Where the news lib dir is (@file{/usr/lib/news/} by default).
9880 @item nnspool-active-file
9881 @vindex nnspool-active-file
9882 The path to the active file.
9884 @item nnspool-newsgroups-file
9885 @vindex nnspool-newsgroups-file
9886 The path to the group descriptions file.
9888 @item nnspool-history-file
9889 @vindex nnspool-history-file
9890 The path to the news history file.
9892 @item nnspool-active-times-file
9893 @vindex nnspool-active-times-file
9894 The path to the active date file.
9896 @item nnspool-nov-is-evil
9897 @vindex nnspool-nov-is-evil
9898 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9901 @item nnspool-sift-nov-with-sed
9902 @vindex nnspool-sift-nov-with-sed
9904 If non-@code{nil}, which is the default, use @code{sed} to get the
9905 relevant portion from the overview file. If nil, @code{nnspool} will
9906 load the entire file into a buffer and process it there.
9912 @section Getting Mail
9913 @cindex reading mail
9916 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9920 * Mail in a Newsreader:: Important introductory notes.
9921 * Getting Started Reading Mail:: A simple cookbook example.
9922 * Splitting Mail:: How to create mail groups.
9923 * Mail Sources:: How to tell Gnus where to get mail from.
9924 * Mail Backend Variables:: Variables for customizing mail handling.
9925 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
9926 * Incorporating Old Mail:: What about the old mail you have?
9927 * Expiring Mail:: Getting rid of unwanted mail.
9928 * Washing Mail:: Removing gruft from the mail you get.
9929 * Duplicates:: Dealing with duplicated mail.
9930 * Not Reading Mail:: Using mail backends for reading other files.
9931 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
9935 @node Mail in a Newsreader
9936 @subsection Mail in a Newsreader
9938 If you are used to traditional mail readers, but have decided to switch
9939 to reading mail with Gnus, you may find yourself experiencing something
9942 Gnus does not behave like traditional mail readers. If you want to make
9943 it behave that way, you can, but it's an uphill battle.
9945 Gnus, by default, handles all its groups using the same approach. This
9946 approach is very newsreaderly---you enter a group, see the new/unread
9947 messages, and when you read the messages, they get marked as read, and
9948 you don't see them any more. (Unless you explicitly ask for them.)
9950 In particular, you do not do anything explicitly to delete messages.
9952 Does this mean that all the messages that have been marked as read are
9955 But, no, it means that old messages are @dfn{expired} according to some
9956 scheme or other. For news messages, the expire process is controlled by
9957 the news administrator; for mail, the expire process is controlled by
9958 you. The expire process for mail is covered in depth in @pxref{Expiring
9961 What many Gnus users find, after using it a while for both news and
9962 mail, is that the transport mechanism has very little to do with how
9963 they want to treat a message.
9965 Many people subscribe to several mailing lists. These are transported
9966 via SMTP, and are therefore mail. But we might go for weeks without
9967 answering, or even reading these messages very carefully. We may not
9968 need to save them because if we should need to read one again, they are
9969 archived somewhere else.
9971 Some people have local news groups which have only a handful of readers.
9972 These are transported via NNTP, and are therefore news. But we may need
9973 to read and answer a large fraction of the messages very carefully in
9974 order to do our work. And there may not be an archive, so we may need
9975 to save the interesting messages the same way we would personal mail.
9977 The important distinction turns out to be not the transport mechanism,
9978 but other factors such as how interested we are in the subject matter,
9979 or how easy it is to retrieve the message if we need to read it again.
9981 Gnus provides many options for sorting mail into ``groups'' which behave
9982 like newsgroups, and for treating each group (whether mail or news)
9985 Some users never get comfortable using the Gnus (ahem) paradigm and wish
9986 that Gnus should grow up and be a male, er, mail reader. It is possible
9987 to whip Gnus into a more mailreaderly being, but, as said before, it's
9988 not easy. People who prefer proper mail readers should try @sc{vm}
9989 instead, which is an excellent, and proper, mail reader.
9991 I don't mean to scare anybody off, but I want to make it clear that you
9992 may be required to learn a new way of thinking about messages. After
9993 you've been subjected to The Gnus Way, you will come to love it. I can
9994 guarantee it. (At least the guy who sold me the Emacs Subliminal
9995 Brain-Washing Functions that I've put into Gnus did guarantee it. You
9996 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
10000 @node Getting Started Reading Mail
10001 @subsection Getting Started Reading Mail
10003 It's quite easy to use Gnus to read your new mail. You just plonk the
10004 mail backend of your choice into @code{gnus-secondary-select-methods},
10005 and things will happen automatically.
10007 For instance, if you want to use @code{nnml} (which is a "one file per
10008 mail" backend), you could put the following in your @file{.gnus} file:
10011 (setq gnus-secondary-select-methods
10012 '((nnml "private")))
10015 Now, the next time you start Gnus, this backend will be queried for new
10016 articles, and it will move all the messages in your spool file to its
10017 directory, which is @code{~/Mail/} by default. The new group that will
10018 be created (@samp{mail.misc}) will be subscribed, and you can read it
10019 like any other group.
10021 You will probably want to split the mail into several groups, though:
10024 (setq nnmail-split-methods
10025 '(("junk" "^From:.*Lars Ingebrigtsen")
10026 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
10030 This will result in three new @code{nnml} mail groups being created:
10031 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
10032 mail that doesn't fit into the first two groups will be placed in the
10035 This should be sufficient for reading mail with Gnus. You might want to
10036 give the other sections in this part of the manual a perusal, though.
10037 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
10040 @node Splitting Mail
10041 @subsection Splitting Mail
10042 @cindex splitting mail
10043 @cindex mail splitting
10045 @vindex nnmail-split-methods
10046 The @code{nnmail-split-methods} variable says how the incoming mail is
10047 to be split into groups.
10050 (setq nnmail-split-methods
10051 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
10052 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
10053 ("mail.other" "")))
10056 This variable is a list of lists, where the first element of each of
10057 these lists is the name of the mail group (they do not have to be called
10058 something beginning with @samp{mail}, by the way), and the second
10059 element is a regular expression used on the header of each mail to
10060 determine if it belongs in this mail group. The first string may
10061 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
10062 insert sub-expressions from the matched text. For instance:
10065 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
10068 The second element can also be a function. In that case, it will be
10069 called narrowed to the headers with the first element of the rule as the
10070 argument. It should return a non-@code{nil} value if it thinks that the
10071 mail belongs in that group.
10073 The last of these groups should always be a general one, and the regular
10074 expression should @emph{always} be @samp{} so that it matches any mails
10075 that haven't been matched by any of the other regexps. (These rules are
10076 processed from the beginning of the alist toward the end. The first
10077 rule to make a match will "win", unless you have crossposting enabled.
10078 In that case, all matching rules will "win".)
10080 If you like to tinker with this yourself, you can set this variable to a
10081 function of your choice. This function will be called without any
10082 arguments in a buffer narrowed to the headers of an incoming mail
10083 message. The function should return a list of group names that it
10084 thinks should carry this mail message.
10086 Note that the mail backends are free to maul the poor, innocent,
10087 incoming headers all they want to. They all add @code{Lines} headers;
10088 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
10089 @code{From<SPACE>} line to something else.
10091 @vindex nnmail-crosspost
10092 The mail backends all support cross-posting. If several regexps match,
10093 the mail will be ``cross-posted'' to all those groups.
10094 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
10095 that no articles are crossposted to the general (@samp{}) group.
10097 @vindex nnmail-crosspost-link-function
10100 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
10101 the crossposted articles. However, not all file systems support hard
10102 links. If that's the case for you, set
10103 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
10104 variable is @code{add-name-to-file} by default.)
10106 @kindex M-x nnmail-split-history
10107 @kindex nnmail-split-history
10108 If you wish to see where the previous mail split put the messages, you
10109 can use the @kbd{M-x nnmail-split-history} command.
10111 Gnus gives you all the opportunity you could possibly want for shooting
10112 yourself in the foot. Let's say you create a group that will contain
10113 all the mail you get from your boss. And then you accidentally
10114 unsubscribe from the group. Gnus will still put all the mail from your
10115 boss in the unsubscribed group, and so, when your boss mails you ``Have
10116 that report ready by Monday or you're fired!'', you'll never see it and,
10117 come Tuesday, you'll still believe that you're gainfully employed while
10118 you really should be out collecting empty bottles to save up for next
10119 month's rent money.
10123 @subsection Mail Sources
10125 Mail can be gotten from many different sources---the mail spool, from a
10126 POP mail server, or from a procmail directory, for instance.
10129 * Mail Source Specifiers:: How to specify what a mail source is.
10130 * Mail Source Customization:: Some variables that influence things.
10131 * Fetching Mail:: Using the mail source specifiers.
10135 @node Mail Source Specifiers
10136 @subsubsection Mail Source Specifiers
10138 @cindex mail server
10141 @cindex mail source
10143 You tell Gnus how to fetch mail by setting @code{mail-sources}
10144 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
10149 (pop :server "pop3.mailserver.com" :user "myname")
10152 As can be observed, a mail source specifier is a list where the first
10153 element is a @dfn{mail source type}, followed by an arbitrary number of
10154 @dfn{keywords}. Keywords that are not explicitly specified are given
10157 The following mail source types are available:
10161 Get mail from a single file; typically from the mail spool.
10167 The path of the file. Defaults to the value of the @code{MAIL}
10168 environment variable or @file{/usr/mail/spool/user-name}.
10171 An example file mail source:
10174 (file :path "/usr/spool/mail/user-name")
10177 Or using the default path:
10184 Get mail from several files in a directory. This is typically used when
10185 you have procmail split the incoming mail into several files.
10191 The path of the directory where the files are. There is no default
10195 Only files ending with this suffix are used. The default is
10199 Only files that have this predicate return non-@code{nil} are returned.
10200 The default is @code{identity}. This is used as an additional
10201 filter---only files that have the right suffix @emph{and} satisfy this
10202 predicate are considered.
10206 Script run before/after fetching mail.
10210 An example directory mail source:
10213 (directory :path "/home/user-name/procmail-dir/"
10218 Get mail from a POP server.
10224 The name of the POP server. The default is taken from the
10225 @code{MAILHOST} environment variable.
10228 The port number of the POP server. The default is @samp{pop3}.
10231 The user name to give to the POP server. The default is the login
10235 The password to give to the POP server. If not specified, the user is
10239 The program to use to fetch mail from the POP server. This is should be
10240 a @code{format}-like string. Here's an example:
10243 fetchmail %u@@%s -P %p %t
10246 The valid format specifier characters are:
10250 The name of the file the mail is to be moved to. This must always be
10251 included in this string.
10254 The name of the server.
10257 The port number of the server.
10260 The user name to use.
10263 The password to use.
10266 The values used for these specs are taken from the values you give the
10267 corresponding keywords.
10270 A script to be run before fetching the mail. The syntax is the same as
10271 the @code{:program} keyword. This can also be a function to be run.
10274 A script to be run after fetching the mail. The syntax is the same as
10275 the @code{:program} keyword. This can also be a function to be run.
10278 The function to use to fetch mail from the POP server. The function is
10279 called with one parameter---the name of the file where the mail should
10282 @item :authentication
10283 This can be either the symbol @code{password} or the symbol @code{apop}
10284 and says what authentication scheme to use. The default is
10289 If the @code{:program} and @code{:function} keywords aren't specified,
10290 @code{pop3-movemail} will be used.
10292 Here are some examples. Fetch from the default POP server, using the
10293 default user name, and default fetcher:
10299 Fetch from a named server with a named user and password:
10302 (pop :server "my.pop.server"
10303 :user "user-name" :password "secret")
10306 Use @samp{movemail} to move the mail:
10309 (pop :program "movemail po:%u %t %p")
10313 Get mail from a maildir. This is a type of mailbox currently only
10314 supported by qmail, where each file in a special directory contains
10321 The path of the directory where the mails are stored. The default is
10322 @samp{~/Maildir/new}.
10324 If you sometimes look at your mail through a pop3 daemon before fetching
10325 them with Gnus, you may also have to fetch your mails from the
10326 @code{cur} directory inside the maildir, like in the following example.
10330 An example maildir mail source:
10333 (maildir :path "/home/user-name/Maildir/cur")
10339 @node Mail Source Customization
10340 @subsubsection Mail Source Customization
10342 The following is a list of variables that influence how the mail is
10343 fetched. You would normally not need to set or change any of these
10347 @item mail-source-crash-box
10348 @vindex mail-source-crash-box
10349 File where mail will be stored while processing it. The default is
10350 @file{~/.emacs-mail-crash-box}.
10352 @item mail-source-delete-incoming
10353 @vindex mail-source-delete-incoming
10354 If non-@code{nil}, delete incoming files after handling them.
10356 @item mail-source-directory
10357 @vindex mail-source-directory
10358 Directory where files (if any) will be stored. The default is
10359 @file{~/Mail/}. At present, the only thing this is used for is to say
10360 where the incoming files will be stored if the previous variable is
10363 @item mail-source-default-file-modes
10364 @vindex mail-source-default-file-modes
10365 All new mail files will get this file mode. The default is 384.
10370 @node Fetching Mail
10371 @subsubsection Fetching Mail
10373 @vindex mail-sources
10374 @vindex nnmail-spool-file
10375 The way to actually tell Gnus where to get new mail from is to set
10376 @code{mail-sources} to a list of mail source specifiers
10377 (@pxref{Mail Source Specifiers}).
10379 If this variable (and the obsolescent @code{nnmail-spool-file}) is
10380 @code{nil}, the mail backends will never attempt to fetch mail by
10383 If you want to fetch mail both from your local spool as well as a POP
10384 mail server, you'd say something like:
10389 (pop :server "pop3.mail.server"
10390 :password "secret")))
10393 Or, if you don't want to use any of the keyword defaults:
10397 '((file :path "/var/spool/mail/user-name")
10398 (pop :server "pop3.mail.server"
10401 :password "secret")))
10405 When you use a mail backend, Gnus will slurp all your mail from your
10406 inbox and plonk it down in your home directory. Gnus doesn't move any
10407 mail if you're not using a mail backend---you have to do a lot of magic
10408 invocations first. At the time when you have finished drawing the
10409 pentagram, lightened the candles, and sacrificed the goat, you really
10410 shouldn't be too surprised when Gnus moves your mail.
10414 @node Mail Backend Variables
10415 @subsection Mail Backend Variables
10417 These variables are (for the most part) pertinent to all the various
10421 @vindex nnmail-read-incoming-hook
10422 @item nnmail-read-incoming-hook
10423 The mail backends all call this hook after reading new mail. You can
10424 use this hook to notify any mail watch programs, if you want to.
10426 @vindex nnmail-split-hook
10427 @item nnmail-split-hook
10428 @findex article-decode-encoded-words
10429 @findex RFC1522 decoding
10430 @findex RFC2047 decoding
10431 Hook run in the buffer where the mail headers of each message is kept
10432 just before the splitting based on these headers is done. The hook is
10433 free to modify the buffer contents in any way it sees fit---the buffer
10434 is discarded after the splitting has been done, and no changes performed
10435 in the buffer will show up in any files.
10436 @code{gnus-article-decode-encoded-words} is one likely function to add
10439 @vindex nnmail-pre-get-new-mail-hook
10440 @vindex nnmail-post-get-new-mail-hook
10441 @item nnmail-pre-get-new-mail-hook
10442 @itemx nnmail-post-get-new-mail-hook
10443 These are two useful hooks executed when treating new incoming
10444 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
10445 starting to handle the new mail) and
10446 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
10447 is done). Here's and example of using these two hooks to change the
10448 default file modes the new mail files get:
10451 (add-hook 'gnus-pre-get-new-mail-hook
10452 (lambda () (set-default-file-modes 511)))
10454 (add-hook 'gnus-post-get-new-mail-hook
10455 (lambda () (set-default-file-modes 551)))
10458 @item nnmail-use-long-file-names
10459 @vindex nnmail-use-long-file-names
10460 If non-@code{nil}, the mail backends will use long file and directory
10461 names. Groups like @samp{mail.misc} will end up in directories
10462 (assuming use of @code{nnml} backend) or files (assuming use of
10463 @code{nnfolder} backend) like @file{mail.misc}. If it is @code{nil},
10464 the same group will end up in @file{mail/misc}.
10466 @item nnmail-delete-file-function
10467 @vindex nnmail-delete-file-function
10468 @findex delete-file
10469 Function called to delete files. It is @code{delete-file} by default.
10471 @item nnmail-cache-accepted-message-ids
10472 @vindex nnmail-cache-accepted-message-ids
10473 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
10474 the backend (via @code{Gcc}, for instance) into the mail duplication
10475 discovery cache. The default is @code{nil}.
10480 @node Fancy Mail Splitting
10481 @subsection Fancy Mail Splitting
10482 @cindex mail splitting
10483 @cindex fancy mail splitting
10485 @vindex nnmail-split-fancy
10486 @findex nnmail-split-fancy
10487 If the rather simple, standard method for specifying how to split mail
10488 doesn't allow you to do what you want, you can set
10489 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
10490 play with the @code{nnmail-split-fancy} variable.
10492 Let's look at an example value of this variable first:
10495 ;; Messages from the mailer daemon are not crossposted to any of
10496 ;; the ordinary groups. Warnings are put in a separate group
10497 ;; from real errors.
10498 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
10500 ;; Non-error messages are crossposted to all relevant
10501 ;; groups, but we don't crosspost between the group for the
10502 ;; (ding) list and the group for other (ding) related mail.
10503 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
10504 ("subject" "ding" "ding.misc"))
10505 ;; Other mailing lists...
10506 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
10507 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
10508 ;; Both lists below have the same suffix, so prevent
10509 ;; cross-posting to mkpkg.list of messages posted only to
10510 ;; the bugs- list, but allow cross-posting when the
10511 ;; message was really cross-posted.
10512 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
10513 (any "mypackage@@somewhere\" - "bugs-mypackage" "mypkg.list")
10515 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
10516 ;; Unmatched mail goes to the catch all group.
10520 This variable has the format of a @dfn{split}. A split is a (possibly)
10521 recursive structure where each split may contain other splits. Here are
10522 the five possible split syntaxes:
10527 @samp{group}: If the split is a string, that will be taken as a group
10528 name. Normal regexp match expansion will be done. See below for
10532 @var{(FIELD VALUE [- RESTRICT [- RESTRICT [...]]] SPLIT)}: If the split
10533 is a list, the first element of which is a string, then store the
10534 message as specified by SPLIT, if header FIELD (a regexp) contains VALUE
10535 (also a regexp). If RESTRICT (yet another regexp) matches some string
10536 after FIELD and before the end of the matched VALUE, the SPLIT is
10537 ignored. If none of the RESTRICT clauses match, SPLIT is processed.
10540 @var{(| SPLIT...)}: If the split is a list, and the first element is
10541 @code{|} (vertical bar), then process each SPLIT until one of them
10542 matches. A SPLIT is said to match if it will cause the mail message to
10543 be stored in one or more groups.
10546 @var{(& SPLIT...)}: If the split is a list, and the first element is
10547 @code{&}, then process all SPLITs in the list.
10550 @code{junk}: If the split is the symbol @code{junk}, then don't save
10551 this message. Use with extreme caution.
10554 @var{(: function arg1 arg2 ...)}: If the split is a list, and the first
10555 element is @code{:}, then the second element will be called as a
10556 function with @var{args} given as arguments. The function should return
10560 @var{(! FUNC SPLIT)}: If the split is a list, and the first element
10561 is @code{!}, then SPLIT will be processed, and FUNC will be called as a
10562 function with the result of SPLIT as argument. FUNC should return a split.
10565 @code{nil}: If the split is @code{nil}, it is ignored.
10569 In these splits, @var{FIELD} must match a complete field name.
10570 @var{VALUE} must match a complete word according to the fundamental mode
10571 syntax table. You can use @code{.*} in the regexps to match partial
10572 field names or words. In other words, all @var{VALUE}'s are wrapped in
10573 @samp{\<} and @samp{\>} pairs.
10575 @vindex nnmail-split-abbrev-alist
10576 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
10577 are expanded as specified by the variable
10578 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
10579 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
10582 @vindex nnmail-split-fancy-syntax-table
10583 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
10584 when all this splitting is performed.
10586 If you want to have Gnus create groups dynamically based on some
10587 information in the headers (i.e., do @code{replace-match}-like
10588 substitutions in the group names), you can say things like:
10591 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
10594 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
10595 will be filed in @samp{mail.debian.foo}.
10597 If the string contains the element @samp{\&}, then the previously
10598 matched string will be substituted. Similarly, the elements @samp{\\1}
10599 up to @samp{\\9} will be substituted with the text matched by the
10600 groupings 1 through 9.
10603 @node Incorporating Old Mail
10604 @subsection Incorporating Old Mail
10606 Most people have lots of old mail stored in various file formats. If
10607 you have set up Gnus to read mail using one of the spiffy Gnus mail
10608 backends, you'll probably wish to have that old mail incorporated into
10611 Doing so can be quite easy.
10613 To take an example: You're reading mail using @code{nnml}
10614 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
10615 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
10616 file filled with important, but old, mail. You want to move it into
10617 your @code{nnml} groups.
10623 Go to the group buffer.
10626 Type `G f' and give the path to the mbox file when prompted to create an
10627 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
10630 Type `SPACE' to enter the newly created group.
10633 Type `M P b' to process-mark all articles in this group's buffer
10634 (@pxref{Setting Process Marks}).
10637 Type `B r' to respool all the process-marked articles, and answer
10638 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
10641 All the mail messages in the mbox file will now also be spread out over
10642 all your @code{nnml} groups. Try entering them and check whether things
10643 have gone without a glitch. If things look ok, you may consider
10644 deleting the mbox file, but I wouldn't do that unless I was absolutely
10645 sure that all the mail has ended up where it should be.
10647 Respooling is also a handy thing to do if you're switching from one mail
10648 backend to another. Just respool all the mail in the old mail groups
10649 using the new mail backend.
10652 @node Expiring Mail
10653 @subsection Expiring Mail
10654 @cindex article expiry
10656 Traditional mail readers have a tendency to remove mail articles when
10657 you mark them as read, in some way. Gnus takes a fundamentally
10658 different approach to mail reading.
10660 Gnus basically considers mail just to be news that has been received in
10661 a rather peculiar manner. It does not think that it has the power to
10662 actually change the mail, or delete any mail messages. If you enter a
10663 mail group, and mark articles as ``read'', or kill them in some other
10664 fashion, the mail articles will still exist on the system. I repeat:
10665 Gnus will not delete your old, read mail. Unless you ask it to, of
10668 To make Gnus get rid of your unwanted mail, you have to mark the
10669 articles as @dfn{expirable}. This does not mean that the articles will
10670 disappear right away, however. In general, a mail article will be
10671 deleted from your system if, 1) it is marked as expirable, AND 2) it is
10672 more than one week old. If you do not mark an article as expirable, it
10673 will remain on your system until hell freezes over. This bears
10674 repeating one more time, with some spurious capitalizations: IF you do
10675 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
10677 @vindex gnus-auto-expirable-newsgroups
10678 You do not have to mark articles as expirable by hand. Groups that
10679 match the regular expression @code{gnus-auto-expirable-newsgroups} will
10680 have all articles that you read marked as expirable automatically. All
10681 articles marked as expirable have an @samp{E} in the first
10682 column in the summary buffer.
10684 By default, if you have auto expiry switched on, Gnus will mark all the
10685 articles you read as expirable, no matter if they were read or unread
10686 before. To avoid having articles marked as read marked as expirable
10687 automatically, you can put something like the following in your
10690 @vindex gnus-mark-article-hook
10692 (remove-hook 'gnus-mark-article-hook
10693 'gnus-summary-mark-read-and-unread-as-read)
10694 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
10697 Note that making a group auto-expirable doesn't mean that all read
10698 articles are expired---only the articles marked as expirable
10699 will be expired. Also note that using the @kbd{d} command won't make
10700 groups expirable---only semi-automatic marking of articles as read will
10701 mark the articles as expirable in auto-expirable groups.
10703 Let's say you subscribe to a couple of mailing lists, and you want the
10704 articles you have read to disappear after a while:
10707 (setq gnus-auto-expirable-newsgroups
10708 "mail.nonsense-list\\|mail.nice-list")
10711 Another way to have auto-expiry happen is to have the element
10712 @code{auto-expire} in the group parameters of the group.
10714 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
10715 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
10716 don't really mix very well.
10718 @vindex nnmail-expiry-wait
10719 The @code{nnmail-expiry-wait} variable supplies the default time an
10720 expirable article has to live. Gnus starts counting days from when the
10721 message @emph{arrived}, not from when it was sent. The default is seven
10724 Gnus also supplies a function that lets you fine-tune how long articles
10725 are to live, based on what group they are in. Let's say you want to
10726 have one month expiry period in the @samp{mail.private} group, a one day
10727 expiry period in the @samp{mail.junk} group, and a six day expiry period
10730 @vindex nnmail-expiry-wait-function
10732 (setq nnmail-expiry-wait-function
10734 (cond ((string= group "mail.private")
10736 ((string= group "mail.junk")
10738 ((string= group "important")
10744 The group names this function is fed are ``unadorned'' group
10745 names---no @samp{nnml:} prefixes and the like.
10747 The @code{nnmail-expiry-wait} variable and
10748 @code{nnmail-expiry-wait-function} function can either be a number (not
10749 necessarily an integer) or one of the symbols @code{immediate} or
10752 You can also use the @code{expiry-wait} group parameter to selectively
10753 change the expiry period (@pxref{Group Parameters}).
10755 @vindex nnmail-keep-last-article
10756 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
10757 expire the final article in a mail newsgroup. This is to make life
10758 easier for procmail users.
10760 @vindex gnus-total-expirable-newsgroups
10761 By the way: That line up there, about Gnus never expiring non-expirable
10762 articles, is a lie. If you put @code{total-expire} in the group
10763 parameters, articles will not be marked as expirable, but all read
10764 articles will be put through the expiry process. Use with extreme
10765 caution. Even more dangerous is the
10766 @code{gnus-total-expirable-newsgroups} variable. All groups that match
10767 this regexp will have all read articles put through the expiry process,
10768 which means that @emph{all} old mail articles in the groups in question
10769 will be deleted after a while. Use with extreme caution, and don't come
10770 crying to me when you discover that the regexp you used matched the
10771 wrong group and all your important mail has disappeared. Be a
10772 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
10775 Most people make most of their mail groups total-expirable, though.
10777 @vindex gnus-inhibit-user-auto-expire
10778 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
10779 commands will not mark an article as expirable, even if the group has
10780 auto-expire turned on.
10784 @subsection Washing Mail
10785 @cindex mail washing
10786 @cindex list server brain damage
10787 @cindex incoming mail treatment
10789 Mailers and list servers are notorious for doing all sorts of really,
10790 really stupid things with mail. ``Hey, RFC822 doesn't explicitly
10791 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
10792 end of all lines passing through our server, so let's do that!!!!1!''
10793 Yes, but RFC822 wasn't designed to be read by morons. Things that were
10794 considered to be self-evident were not discussed. So. Here we are.
10796 Case in point: The German version of Microsoft Exchange adds @samp{AW:
10797 } to the subjects of replies instead of @samp{Re: }. I could pretend to
10798 be shocked and dismayed by this, but I haven't got the energy. It is to
10801 Gnus provides a plethora of functions for washing articles while
10802 displaying them, but it might be nicer to do the filtering before
10803 storing the mail to disc. For that purpose, we have three hooks and
10804 various functions that can be put in these hooks.
10807 @item nnmail-prepare-incoming-hook
10808 @vindex nnmail-prepare-incoming-hook
10809 This hook is called before doing anything with the mail and is meant for
10810 grand, sweeping gestures. It is called in a buffer that contains all
10811 the new, incoming mail. Functions to be used include:
10814 @item nnheader-ms-strip-cr
10815 @findex nnheader-ms-strip-cr
10816 Remove trailing carriage returns from each line. This is default on
10817 Emacs running on MS machines.
10821 @item nnmail-prepare-incoming-header-hook
10822 @vindex nnmail-prepare-incoming-header-hook
10823 This hook is called narrowed to each header. It can be used when
10824 cleaning up the headers. Functions that can be used include:
10827 @item nnmail-remove-leading-whitespace
10828 @findex nnmail-remove-leading-whitespace
10829 Clear leading white space that ``helpful'' listservs have added to the
10830 headers to make them look nice. Aaah.
10832 @item nnmail-remove-list-identifiers
10833 @findex nnmail-remove-list-identifiers
10834 Some list servers add an identifier---for example, @samp{(idm)}---to the
10835 beginning of all @code{Subject} headers. I'm sure that's nice for
10836 people who use stone age mail readers. This function will remove
10837 strings that match the @code{nnmail-list-identifiers} regexp, which can
10838 also be a list of regexp.
10840 For instance, if you want to remove the @samp{(idm)} and the
10841 @samp{nagnagnag} identifiers:
10844 (setq nnmail-list-identifiers
10845 '("(idm)" "nagnagnag"))
10848 @item nnmail-remove-tabs
10849 @findex nnmail-remove-tabs
10850 Translate all @samp{TAB} characters into @samp{SPACE} characters.
10852 @item nnmail-fix-eudora-headers
10853 @findex nnmail-fix-eudora-headers
10855 Eudora produces broken @code{References} headers, but OK
10856 @code{In-Reply-To} headers. This function will get rid of the
10857 @code{References} headers.
10861 @item nnmail-prepare-incoming-message-hook
10862 @vindex nnmail-prepare-incoming-message-hook
10863 This hook is called narrowed to each message. Functions to be used
10867 @item article-de-quoted-unreadable
10868 @findex article-de-quoted-unreadable
10869 Decode Quoted Readable encoding.
10876 @subsection Duplicates
10878 @vindex nnmail-treat-duplicates
10879 @vindex nnmail-message-id-cache-length
10880 @vindex nnmail-message-id-cache-file
10881 @cindex duplicate mails
10882 If you are a member of a couple of mailing lists, you will sometimes
10883 receive two copies of the same mail. This can be quite annoying, so
10884 @code{nnmail} checks for and treats any duplicates it might find. To do
10885 this, it keeps a cache of old @code{Message-ID}s---
10886 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
10887 default. The approximate maximum number of @code{Message-ID}s stored
10888 there is controlled by the @code{nnmail-message-id-cache-length}
10889 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
10890 stored.) If all this sounds scary to you, you can set
10891 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
10892 default), and @code{nnmail} won't delete duplicate mails. Instead it
10893 will insert a warning into the head of the mail saying that it thinks
10894 that this is a duplicate of a different message.
10896 This variable can also be a function. If that's the case, the function
10897 will be called from a buffer narrowed to the message in question with
10898 the @code{Message-ID} as a parameter. The function must return either
10899 @code{nil}, @code{warn}, or @code{delete}.
10901 You can turn this feature off completely by setting the variable to
10904 If you want all the duplicate mails to be put into a special
10905 @dfn{duplicates} group, you could do that using the normal mail split
10909 (setq nnmail-split-fancy
10910 '(| ;; Messages duplicates go to a separate group.
10911 ("gnus-warning" "duplication of message" "duplicate")
10912 ;; Message from daemons, postmaster, and the like to another.
10913 (any mail "mail.misc")
10920 (setq nnmail-split-methods
10921 '(("duplicates" "^Gnus-Warning:")
10926 Here's a neat feature: If you know that the recipient reads her mail
10927 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
10928 @code{delete}, you can send her as many insults as you like, just by
10929 using a @code{Message-ID} of a mail that you know that she's already
10930 received. Think of all the fun! She'll never see any of it! Whee!
10933 @node Not Reading Mail
10934 @subsection Not Reading Mail
10936 If you start using any of the mail backends, they have the annoying
10937 habit of assuming that you want to read mail with them. This might not
10938 be unreasonable, but it might not be what you want.
10940 If you set @code{mail-sources} and @code{nnmail-spool-file} to
10941 @code{nil}, none of the backends will ever attempt to read incoming
10942 mail, which should help.
10944 @vindex nnbabyl-get-new-mail
10945 @vindex nnmbox-get-new-mail
10946 @vindex nnml-get-new-mail
10947 @vindex nnmh-get-new-mail
10948 @vindex nnfolder-get-new-mail
10949 This might be too much, if, for instance, you are reading mail quite
10950 happily with @code{nnml} and just want to peek at some old @sc{rmail}
10951 file you have stashed away with @code{nnbabyl}. All backends have
10952 variables called backend-@code{get-new-mail}. If you want to disable
10953 the @code{nnbabyl} mail reading, you edit the virtual server for the
10954 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
10956 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
10957 narrowed to the article to be saved before saving it when reading
10961 @node Choosing a Mail Backend
10962 @subsection Choosing a Mail Backend
10964 Gnus will read the mail spool when you activate a mail group. The mail
10965 file is first copied to your home directory. What happens after that
10966 depends on what format you want to store your mail in.
10968 There are five different mail backends in the standard Gnus, and more
10969 backends are available separately. The mail backend most people use
10970 (because it is the fastest and most flexible) is @code{nnml}
10971 (@pxref{Mail Spool}).
10974 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
10975 * Rmail Babyl:: Emacs programs use the rmail babyl format.
10976 * Mail Spool:: Store your mail in a private spool?
10977 * MH Spool:: An mhspool-like backend.
10978 * Mail Folders:: Having one file for each group.
10979 * Comparing Mail Backends:: An in-depth looks at pros and cons.
10983 @node Unix Mail Box
10984 @subsubsection Unix Mail Box
10986 @cindex unix mail box
10988 @vindex nnmbox-active-file
10989 @vindex nnmbox-mbox-file
10990 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
10991 mail. @code{nnmbox} will add extra headers to each mail article to say
10992 which group it belongs in.
10994 Virtual server settings:
10997 @item nnmbox-mbox-file
10998 @vindex nnmbox-mbox-file
10999 The name of the mail box in the user's home directory.
11001 @item nnmbox-active-file
11002 @vindex nnmbox-active-file
11003 The name of the active file for the mail box.
11005 @item nnmbox-get-new-mail
11006 @vindex nnmbox-get-new-mail
11007 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
11013 @subsubsection Rmail Babyl
11017 @vindex nnbabyl-active-file
11018 @vindex nnbabyl-mbox-file
11019 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
11020 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
11021 article to say which group it belongs in.
11023 Virtual server settings:
11026 @item nnbabyl-mbox-file
11027 @vindex nnbabyl-mbox-file
11028 The name of the rmail mbox file.
11030 @item nnbabyl-active-file
11031 @vindex nnbabyl-active-file
11032 The name of the active file for the rmail box.
11034 @item nnbabyl-get-new-mail
11035 @vindex nnbabyl-get-new-mail
11036 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
11041 @subsubsection Mail Spool
11043 @cindex mail @sc{nov} spool
11045 The @dfn{nnml} spool mail format isn't compatible with any other known
11046 format. It should be used with some caution.
11048 @vindex nnml-directory
11049 If you use this backend, Gnus will split all incoming mail into files,
11050 one file for each mail, and put the articles into the corresponding
11051 directories under the directory specified by the @code{nnml-directory}
11052 variable. The default value is @file{~/Mail/}.
11054 You do not have to create any directories beforehand; Gnus will take
11057 If you have a strict limit as to how many files you are allowed to store
11058 in your account, you should not use this backend. As each mail gets its
11059 own file, you might very well occupy thousands of inodes within a few
11060 weeks. If this is no problem for you, and it isn't a problem for you
11061 having your friendly systems administrator walking around, madly,
11062 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
11063 know that this is probably the fastest format to use. You do not have
11064 to trudge through a big mbox file just to read your new mail.
11066 @code{nnml} is probably the slowest backend when it comes to article
11067 splitting. It has to create lots of files, and it also generates
11068 @sc{nov} databases for the incoming mails. This makes it the fastest
11069 backend when it comes to reading mail.
11071 Virtual server settings:
11074 @item nnml-directory
11075 @vindex nnml-directory
11076 All @code{nnml} directories will be placed under this directory.
11078 @item nnml-active-file
11079 @vindex nnml-active-file
11080 The active file for the @code{nnml} server.
11082 @item nnml-newsgroups-file
11083 @vindex nnml-newsgroups-file
11084 The @code{nnml} group descriptions file. @xref{Newsgroups File
11087 @item nnml-get-new-mail
11088 @vindex nnml-get-new-mail
11089 If non-@code{nil}, @code{nnml} will read incoming mail.
11091 @item nnml-nov-is-evil
11092 @vindex nnml-nov-is-evil
11093 If non-@code{nil}, this backend will ignore any @sc{nov} files.
11095 @item nnml-nov-file-name
11096 @vindex nnml-nov-file-name
11097 The name of the @sc{nov} files. The default is @file{.overview}.
11099 @item nnml-prepare-save-mail-hook
11100 @vindex nnml-prepare-save-mail-hook
11101 Hook run narrowed to an article before saving.
11105 @findex nnml-generate-nov-databases
11106 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
11107 you can do a complete update by typing @kbd{M-x
11108 nnml-generate-nov-databases}. This command will trawl through the
11109 entire @code{nnml} hierarchy, looking at each and every article, so it
11110 might take a while to complete. A better interface to this
11111 functionality can be found in the server buffer (@pxref{Server
11116 @subsubsection MH Spool
11118 @cindex mh-e mail spool
11120 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
11121 @sc{nov} databases and it doesn't keep an active file. This makes
11122 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
11123 makes it easier to write procmail scripts for.
11125 Virtual server settings:
11128 @item nnmh-directory
11129 @vindex nnmh-directory
11130 All @code{nnmh} directories will be located under this directory.
11132 @item nnmh-get-new-mail
11133 @vindex nnmh-get-new-mail
11134 If non-@code{nil}, @code{nnmh} will read incoming mail.
11137 @vindex nnmh-be-safe
11138 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
11139 sure that the articles in the folder are actually what Gnus thinks they
11140 are. It will check date stamps and stat everything in sight, so
11141 setting this to @code{t} will mean a serious slow-down. If you never
11142 use anything but Gnus to read the @code{nnmh} articles, you do not have
11143 to set this variable to @code{t}.
11148 @subsubsection Mail Folders
11150 @cindex mbox folders
11151 @cindex mail folders
11153 @code{nnfolder} is a backend for storing each mail group in a separate
11154 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
11155 will add extra headers to keep track of article numbers and arrival
11158 Virtual server settings:
11161 @item nnfolder-directory
11162 @vindex nnfolder-directory
11163 All the @code{nnfolder} mail boxes will be stored under this directory.
11165 @item nnfolder-active-file
11166 @vindex nnfolder-active-file
11167 The name of the active file.
11169 @item nnfolder-newsgroups-file
11170 @vindex nnfolder-newsgroups-file
11171 The name of the group descriptions file. @xref{Newsgroups File Format}.
11173 @item nnfolder-get-new-mail
11174 @vindex nnfolder-get-new-mail
11175 If non-@code{nil}, @code{nnfolder} will read incoming mail.
11177 @item nnfolder-save-buffer-hook
11178 @vindex nnfolder-save-buffer-hook
11179 @cindex backup files
11180 Hook run before saving the folders. Note that Emacs does the normal
11181 backup renaming of files even with the @code{nnfolder} buffers. If you
11182 wish to switch this off, you could say something like the following in
11183 your @file{.emacs} file:
11186 (defun turn-off-backup ()
11187 (set (make-local-variable 'backup-inhibited) t))
11189 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
11192 @item nnfolder-delete-mail-hook
11193 @vindex nnfolder-delete-mail-hook
11194 Hook run in a buffer narrowed to the message that is to be deleted.
11195 This function can be used to copy the message to somewhere else, or to
11196 extract some information from it before removing it.
11201 @findex nnfolder-generate-active-file
11202 @kindex M-x nnfolder-generate-active-file
11203 If you have lots of @code{nnfolder}-like files you'd like to read with
11204 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
11205 command to make @code{nnfolder} aware of all likely files in
11206 @code{nnfolder-directory}. This only works if you use long file names,
11209 @node Comparing Mail Backends
11210 @subsubsection Comparing Mail Backends
11212 First, just for terminology, the @dfn{backend} is the common word for a
11213 low-level access method---a transport, if you will, by which something
11214 is acquired. The sense is that one's mail has to come from somewhere,
11215 and so selection of a suitable backend is required in order to get that
11216 mail within spitting distance of Gnus.
11218 The same concept exists for Usenet itself: Though access to articles is
11219 typically done by NNTP these days, once upon a midnight dreary, everyone
11220 in the world got at Usenet by running a reader on the machine where the
11221 articles lay (the machine which today we call an NNTP server), and
11222 access was by the reader stepping into the articles' directory spool
11223 area directly. One can still select between either the @code{nntp} or
11224 @code{nnspool} backends, to select between these methods, if one happens
11225 actually to live on the server (or can see its spool directly, anyway,
11228 The goal in selecting a mail backend is to pick one which
11229 simultaneously represents a suitable way of dealing with the original
11230 format plus leaving mail in a form that is convenient to use in the
11231 future. Here are some high and low points on each:
11236 UNIX systems have historically had a single, very common, and well-
11237 defined format. All messages arrive in a single @dfn{spool file}, and
11238 they are delineated by a line whose regular expression matches
11239 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
11240 to make it clear in this instance that this is not the RFC-specified
11241 @samp{From:} header.) Because Emacs and therefore Gnus emanate
11242 historically from the Unix environment, it is simplest if one does not
11243 mess a great deal with the original mailbox format, so if one chooses
11244 this backend, Gnus' primary activity in getting mail from the real spool
11245 area to Gnus' preferred directory is simply to copy it, with no
11246 (appreciable) format change in the process. It is the ``dumbest'' way
11247 to move mail into availability in the Gnus environment. This makes it
11248 fast to move into place, but slow to parse, when Gnus has to look at
11253 Once upon a time, there was the DEC-10 and DEC-20, running operating
11254 systems called TOPS and related things, and the usual (only?) mail
11255 reading environment was a thing called Babyl. I don't know what format
11256 was used for mail landing on the system, but Babyl had its own internal
11257 format to which mail was converted, primarily involving creating a
11258 spool-file-like entity with a scheme for inserting Babyl-specific
11259 headers and status bits above the top of each message in the file.
11260 RMAIL was Emacs' first mail reader, it was written by Richard Stallman,
11261 and Stallman came out of that TOPS/Babyl environment, so he wrote RMAIL
11262 to understand the mail files folks already had in existence. Gnus (and
11263 VM, for that matter) continue to support this format because it's
11264 perceived as having some good qualities in those mailer-specific
11265 headers/status bits stuff. RMAIL itself still exists as well, of
11266 course, and is still maintained by Stallman.
11268 Both of the above forms leave your mail in a single file on your
11269 filesystem, and they must parse that entire file each time you take a
11274 @code{nnml} is the backend which smells the most as though you were
11275 actually operating with an @code{nnspool}-accessed Usenet system. (In
11276 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
11277 lo these years ago.) One's mail is taken from the original spool file,
11278 and is then cut up into individual message files, 1:1. It maintains a
11279 Usenet-style active file (analogous to what one finds in an INN- or
11280 CNews-based news system in (for instance) @file{/var/lib/news/active},
11281 or what is returned via the @samp{NNTP LIST} verb) and also creates
11282 @dfn{overview} files for efficient group entry, as has been defined for
11283 @sc{nntp} servers for some years now. It is slower in mail-splitting,
11284 due to the creation of lots of files, updates to the @code{nnml} active
11285 file, and additions to overview files on a per-message basis, but it is
11286 extremely fast on access because of what amounts to the indexing support
11287 provided by the active file and overviews.
11289 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
11290 resource which defines available places in the filesystem to put new
11291 files. Sysadmins take a dim view of heavy inode occupation within
11292 tight, shared filesystems. But if you live on a personal machine where
11293 the filesystem is your own and space is not at a premium, @code{nnml}
11296 It is also problematic using this backend if you are living in a
11297 FAT16-based Windows world, since much space will be wasted on all these
11302 The Rand MH mail-reading system has been around UNIX systems for a very
11303 long time; it operates by splitting one's spool file of messages into
11304 individual files, but with little or no indexing support -- @code{nnmh}
11305 is considered to be semantically equivalent to ``@code{nnml} without
11306 active file or overviews''. This is arguably the worst choice, because
11307 one gets the slowness of individual file creation married to the
11308 slowness of access parsing when learning what's new in one's groups.
11312 Basically the effetc of @code{nnfolder} is @code{nnmbox} (the first
11313 method described above) on a per-group basis. That is, @code{nnmbox}
11314 itself puts *all* one's mail in one file; @code{nnfolder} provides a
11315 little bit of optimization to this so that each of one's mail groups has
11316 a Unix mail box file. It's faster than @code{nnmbox} because each group
11317 can be parsed separately, and still provides the simple Unix mail box
11318 format requiring minimal effort in moving the mail around. In addition,
11319 it maintains an ``active'' file making it much faster for Gnus to figure
11320 out how many messages there are in each separate group.
11322 If you have groups that are expected to have a massive amount of
11323 messages, @code{nnfolder} is not the best choice, but if you receive
11324 only a moderate amount of mail, @code{nnfolder} is probably the most
11325 friendly mail backend all over.
11331 @node Other Sources
11332 @section Other Sources
11334 Gnus can do more than just read news or mail. The methods described
11335 below allow Gnus to view directories and files as if they were
11339 * Directory Groups:: You can read a directory as if it was a newsgroup.
11340 * Anything Groups:: Dired? Who needs dired?
11341 * Document Groups:: Single files can be the basis of a group.
11342 * SOUP:: Reading @sc{SOUP} packets ``offline''.
11343 * Web Searches:: Creating groups from articles that match a string.
11344 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
11348 @node Directory Groups
11349 @subsection Directory Groups
11351 @cindex directory groups
11353 If you have a directory that has lots of articles in separate files in
11354 it, you might treat it as a newsgroup. The files have to have numerical
11357 This might be an opportune moment to mention @code{ange-ftp} (and its
11358 successor @code{efs}), that most wonderful of all wonderful Emacs
11359 packages. When I wrote @code{nndir}, I didn't think much about it---a
11360 backend to read directories. Big deal.
11362 @code{ange-ftp} changes that picture dramatically. For instance, if you
11363 enter the @code{ange-ftp} file name
11364 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
11365 @code{ange-ftp} or @code{efs} will actually allow you to read this
11366 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
11368 @code{nndir} will use @sc{nov} files if they are present.
11370 @code{nndir} is a ``read-only'' backend---you can't delete or expire
11371 articles with this method. You can use @code{nnmh} or @code{nnml} for
11372 whatever you use @code{nndir} for, so you could switch to any of those
11373 methods if you feel the need to have a non-read-only @code{nndir}.
11376 @node Anything Groups
11377 @subsection Anything Groups
11380 From the @code{nndir} backend (which reads a single spool-like
11381 directory), it's just a hop and a skip to @code{nneething}, which
11382 pretends that any arbitrary directory is a newsgroup. Strange, but
11385 When @code{nneething} is presented with a directory, it will scan this
11386 directory and assign article numbers to each file. When you enter such
11387 a group, @code{nneething} must create ``headers'' that Gnus can use.
11388 After all, Gnus is a newsreader, in case you're
11389 forgetting. @code{nneething} does this in a two-step process. First, it
11390 snoops each file in question. If the file looks like an article (i.e.,
11391 the first few lines look like headers), it will use this as the head.
11392 If this is just some arbitrary file without a head (e.g. a C source
11393 file), @code{nneething} will cobble up a header out of thin air. It
11394 will use file ownership, name and date and do whatever it can with these
11397 All this should happen automatically for you, and you will be presented
11398 with something that looks very much like a newsgroup. Totally like a
11399 newsgroup, to be precise. If you select an article, it will be displayed
11400 in the article buffer, just as usual.
11402 If you select a line that represents a directory, Gnus will pop you into
11403 a new summary buffer for this @code{nneething} group. And so on. You can
11404 traverse the entire disk this way, if you feel like, but remember that
11405 Gnus is not dired, really, and does not intend to be, either.
11407 There are two overall modes to this action---ephemeral or solid. When
11408 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
11409 will not store information on what files you have read, and what files
11410 are new, and so on. If you create a solid @code{nneething} group the
11411 normal way with @kbd{G m}, Gnus will store a mapping table between
11412 article numbers and file names, and you can treat this group like any
11413 other groups. When you activate a solid @code{nneething} group, you will
11414 be told how many unread articles it contains, etc., etc.
11419 @item nneething-map-file-directory
11420 @vindex nneething-map-file-directory
11421 All the mapping files for solid @code{nneething} groups will be stored
11422 in this directory, which defaults to @file{~/.nneething/}.
11424 @item nneething-exclude-files
11425 @vindex nneething-exclude-files
11426 All files that match this regexp will be ignored. Nice to use to exclude
11427 auto-save files and the like, which is what it does by default.
11429 @item nneething-include-files
11430 @vindex nneething-include-files
11431 Regexp saying what files to include in the group. If this variable is
11432 non-@code{nil}, only files matching this regexp will be included.
11434 @item nneething-map-file
11435 @vindex nneething-map-file
11436 Name of the map files.
11440 @node Document Groups
11441 @subsection Document Groups
11443 @cindex documentation group
11446 @code{nndoc} is a cute little thing that will let you read a single file
11447 as a newsgroup. Several files types are supported:
11454 The babyl (rmail) mail box.
11459 The standard Unix mbox file.
11461 @cindex MMDF mail box
11463 The MMDF mail box format.
11466 Several news articles appended into a file.
11469 @cindex rnews batch files
11470 The rnews batch transport format.
11471 @cindex forwarded messages
11474 Forwarded articles.
11477 Netscape mail boxes.
11480 MIME multipart messages.
11482 @item standard-digest
11483 The standard (RFC 1153) digest format.
11486 Non-standard digest format---matches most things, but does it badly.
11489 You can also use the special ``file type'' @code{guess}, which means
11490 that @code{nndoc} will try to guess what file type it is looking at.
11491 @code{digest} means that @code{nndoc} should guess what digest type the
11494 @code{nndoc} will not try to change the file or insert any extra headers into
11495 it---it will simply, like, let you use the file as the basis for a
11496 group. And that's it.
11498 If you have some old archived articles that you want to insert into your
11499 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
11500 that. Say you have an old @file{RMAIL} file with mail that you now want
11501 to split into your new @code{nnml} groups. You look at that file using
11502 @code{nndoc} (using the @kbd{G f} command in the group buffer
11503 (@pxref{Foreign Groups})), set the process mark on all the articles in
11504 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
11505 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
11506 file is now also stored in lots of @code{nnml} directories, and you can
11507 delete that pesky @file{RMAIL} file. If you have the guts!
11509 Virtual server variables:
11512 @item nndoc-article-type
11513 @vindex nndoc-article-type
11514 This should be one of @code{mbox}, @code{babyl}, @code{digest},
11515 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
11516 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
11517 @code{slack-digest}, @code{clari-briefs}, @code{nsmail} or @code{guess}.
11519 @item nndoc-post-type
11520 @vindex nndoc-post-type
11521 This variable says whether Gnus is to consider the group a news group or
11522 a mail group. There are two valid values: @code{mail} (the default)
11527 * Document Server Internals:: How to add your own document types.
11531 @node Document Server Internals
11532 @subsubsection Document Server Internals
11534 Adding new document types to be recognized by @code{nndoc} isn't
11535 difficult. You just have to whip up a definition of what the document
11536 looks like, write a predicate function to recognize that document type,
11537 and then hook into @code{nndoc}.
11539 First, here's an example document type definition:
11543 (article-begin . "^\^A\^A\^A\^A\n")
11544 (body-end . "^\^A\^A\^A\^A\n"))
11547 The definition is simply a unique @dfn{name} followed by a series of
11548 regexp pseudo-variable settings. Below are the possible
11549 variables---don't be daunted by the number of variables; most document
11550 types can be defined with very few settings:
11553 @item first-article
11554 If present, @code{nndoc} will skip past all text until it finds
11555 something that match this regexp. All text before this will be
11558 @item article-begin
11559 This setting has to be present in all document type definitions. It
11560 says what the beginning of each article looks like.
11562 @item head-begin-function
11563 If present, this should be a function that moves point to the head of
11566 @item nndoc-head-begin
11567 If present, this should be a regexp that matches the head of the
11570 @item nndoc-head-end
11571 This should match the end of the head of the article. It defaults to
11572 @samp{^$}---the empty line.
11574 @item body-begin-function
11575 If present, this function should move point to the beginning of the body
11579 This should match the beginning of the body of the article. It defaults
11582 @item body-end-function
11583 If present, this function should move point to the end of the body of
11587 If present, this should match the end of the body of the article.
11590 If present, this should match the end of the file. All text after this
11591 regexp will be totally ignored.
11595 So, using these variables @code{nndoc} is able to dissect a document
11596 file into a series of articles, each with a head and a body. However, a
11597 few more variables are needed since not all document types are all that
11598 news-like---variables needed to transform the head or the body into
11599 something that's palatable for Gnus:
11602 @item prepare-body-function
11603 If present, this function will be called when requesting an article. It
11604 will be called with point at the start of the body, and is useful if the
11605 document has encoded some parts of its contents.
11607 @item article-transform-function
11608 If present, this function is called when requesting an article. It's
11609 meant to be used for more wide-ranging transformation of both head and
11610 body of the article.
11612 @item generate-head-function
11613 If present, this function is called to generate a head that Gnus can
11614 understand. It is called with the article number as a parameter, and is
11615 expected to generate a nice head for the article in question. It is
11616 called when requesting the headers of all articles.
11620 Let's look at the most complicated example I can come up with---standard
11625 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
11626 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
11627 (prepare-body-function . nndoc-unquote-dashes)
11628 (body-end-function . nndoc-digest-body-end)
11629 (head-end . "^ ?$")
11630 (body-begin . "^ ?\n")
11631 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
11632 (subtype digest guess))
11635 We see that all text before a 70-width line of dashes is ignored; all
11636 text after a line that starts with that @samp{^End of} is also ignored;
11637 each article begins with a 30-width line of dashes; the line separating
11638 the head from the body may contain a single space; and that the body is
11639 run through @code{nndoc-unquote-dashes} before being delivered.
11641 To hook your own document definition into @code{nndoc}, use the
11642 @code{nndoc-add-type} function. It takes two parameters---the first is
11643 the definition itself and the second (optional) parameter says where in
11644 the document type definition alist to put this definition. The alist is
11645 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
11646 is of @code{mmdf} type, and so on. These type predicates should return
11647 @code{nil} if the document is not of the correct type; @code{t} if it is
11648 of the correct type; and a number if the document might be of the
11649 correct type. A high number means high probability; a low number means
11650 low probability with @samp{0} being the lowest valid number.
11658 In the PC world people often talk about ``offline'' newsreaders. These
11659 are thingies that are combined reader/news transport monstrosities.
11660 With built-in modem programs. Yecchh!
11662 Of course, us Unix Weenie types of human beans use things like
11663 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
11664 transport things like Ghod intended. And then we just use normal
11667 However, it can sometimes be convenient to do something a that's a bit
11668 easier on the brain if you have a very slow modem, and you're not really
11669 that interested in doing things properly.
11671 A file format called @sc{soup} has been developed for transporting news
11672 and mail from servers to home machines and back again. It can be a bit
11675 First some terminology:
11680 This is the machine that is connected to the outside world and where you
11681 get news and/or mail from.
11684 This is the machine that you want to do the actual reading and responding
11685 on. It is typically not connected to the rest of the world in any way.
11688 Something that contains messages and/or commands. There are two kinds
11692 @item message packets
11693 These are packets made at the server, and typically contain lots of
11694 messages for you to read. These are called @file{SoupoutX.tgz} by
11695 default, where @var{X} is a number.
11697 @item response packets
11698 These are packets made at the home machine, and typically contains
11699 replies that you've written. These are called @file{SoupinX.tgz} by
11700 default, where @var{X} is a number.
11710 You log in on the server and create a @sc{soup} packet. You can either
11711 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
11712 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
11713 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
11716 You transfer the packet home. Rail, boat, car or modem will do fine.
11719 You put the packet in your home directory.
11722 You fire up Gnus on your home machine using the @code{nnsoup} backend as
11723 the native or secondary server.
11726 You read articles and mail and answer and followup to the things you
11727 want (@pxref{SOUP Replies}).
11730 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
11734 You transfer this packet to the server.
11737 You use Gnus to mail this packet out with the @kbd{G s s} command.
11740 You then repeat until you die.
11744 So you basically have a bipartite system---you use @code{nnsoup} for
11745 reading and Gnus for packing/sending these @sc{soup} packets.
11748 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
11749 * SOUP Groups:: A backend for reading @sc{soup} packets.
11750 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
11754 @node SOUP Commands
11755 @subsubsection SOUP Commands
11757 These are commands for creating and manipulating @sc{soup} packets.
11761 @kindex G s b (Group)
11762 @findex gnus-group-brew-soup
11763 Pack all unread articles in the current group
11764 (@code{gnus-group-brew-soup}). This command understands the
11765 process/prefix convention.
11768 @kindex G s w (Group)
11769 @findex gnus-soup-save-areas
11770 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
11773 @kindex G s s (Group)
11774 @findex gnus-soup-send-replies
11775 Send all replies from the replies packet
11776 (@code{gnus-soup-send-replies}).
11779 @kindex G s p (Group)
11780 @findex gnus-soup-pack-packet
11781 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
11784 @kindex G s r (Group)
11785 @findex nnsoup-pack-replies
11786 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
11789 @kindex O s (Summary)
11790 @findex gnus-soup-add-article
11791 This summary-mode command adds the current article to a @sc{soup} packet
11792 (@code{gnus-soup-add-article}). It understands the process/prefix
11793 convention (@pxref{Process/Prefix}).
11798 There are a few variables to customize where Gnus will put all these
11803 @item gnus-soup-directory
11804 @vindex gnus-soup-directory
11805 Directory where Gnus will save intermediate files while composing
11806 @sc{soup} packets. The default is @file{~/SoupBrew/}.
11808 @item gnus-soup-replies-directory
11809 @vindex gnus-soup-replies-directory
11810 This is what Gnus will use as a temporary directory while sending our
11811 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
11813 @item gnus-soup-prefix-file
11814 @vindex gnus-soup-prefix-file
11815 Name of the file where Gnus stores the last used prefix. The default is
11816 @samp{gnus-prefix}.
11818 @item gnus-soup-packer
11819 @vindex gnus-soup-packer
11820 A format string command for packing a @sc{soup} packet. The default is
11821 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
11823 @item gnus-soup-unpacker
11824 @vindex gnus-soup-unpacker
11825 Format string command for unpacking a @sc{soup} packet. The default is
11826 @samp{gunzip -c %s | tar xvf -}.
11828 @item gnus-soup-packet-directory
11829 @vindex gnus-soup-packet-directory
11830 Where Gnus will look for reply packets. The default is @file{~/}.
11832 @item gnus-soup-packet-regexp
11833 @vindex gnus-soup-packet-regexp
11834 Regular expression matching @sc{soup} reply packets in
11835 @code{gnus-soup-packet-directory}.
11841 @subsubsection @sc{soup} Groups
11844 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
11845 read incoming packets, unpack them, and put them in a directory where
11846 you can read them at leisure.
11848 These are the variables you can use to customize its behavior:
11852 @item nnsoup-tmp-directory
11853 @vindex nnsoup-tmp-directory
11854 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
11855 directory. (@file{/tmp/} by default.)
11857 @item nnsoup-directory
11858 @vindex nnsoup-directory
11859 @code{nnsoup} then moves each message and index file to this directory.
11860 The default is @file{~/SOUP/}.
11862 @item nnsoup-replies-directory
11863 @vindex nnsoup-replies-directory
11864 All replies will be stored in this directory before being packed into a
11865 reply packet. The default is @file{~/SOUP/replies/"}.
11867 @item nnsoup-replies-format-type
11868 @vindex nnsoup-replies-format-type
11869 The @sc{soup} format of the replies packets. The default is @samp{?n}
11870 (rnews), and I don't think you should touch that variable. I probably
11871 shouldn't even have documented it. Drats! Too late!
11873 @item nnsoup-replies-index-type
11874 @vindex nnsoup-replies-index-type
11875 The index type of the replies packet. The default is @samp{?n}, which
11876 means ``none''. Don't fiddle with this one either!
11878 @item nnsoup-active-file
11879 @vindex nnsoup-active-file
11880 Where @code{nnsoup} stores lots of information. This is not an ``active
11881 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
11882 this file or mess it up in any way, you're dead. The default is
11883 @file{~/SOUP/active}.
11885 @item nnsoup-packer
11886 @vindex nnsoup-packer
11887 Format string command for packing a reply @sc{soup} packet. The default
11888 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
11890 @item nnsoup-unpacker
11891 @vindex nnsoup-unpacker
11892 Format string command for unpacking incoming @sc{soup} packets. The
11893 default is @samp{gunzip -c %s | tar xvf -}.
11895 @item nnsoup-packet-directory
11896 @vindex nnsoup-packet-directory
11897 Where @code{nnsoup} will look for incoming packets. The default is
11900 @item nnsoup-packet-regexp
11901 @vindex nnsoup-packet-regexp
11902 Regular expression matching incoming @sc{soup} packets. The default is
11905 @item nnsoup-always-save
11906 @vindex nnsoup-always-save
11907 If non-@code{nil}, save the replies buffer after each posted message.
11913 @subsubsection SOUP Replies
11915 Just using @code{nnsoup} won't mean that your postings and mailings end
11916 up in @sc{soup} reply packets automagically. You have to work a bit
11917 more for that to happen.
11919 @findex nnsoup-set-variables
11920 The @code{nnsoup-set-variables} command will set the appropriate
11921 variables to ensure that all your followups and replies end up in the
11924 In specific, this is what it does:
11927 (setq message-send-news-function 'nnsoup-request-post)
11928 (setq message-send-mail-function 'nnsoup-request-mail)
11931 And that's it, really. If you only want news to go into the @sc{soup}
11932 system you just use the first line. If you only want mail to be
11933 @sc{soup}ed you use the second.
11937 @subsection Web Searches
11941 @cindex InReference
11942 @cindex Usenet searches
11943 @cindex searching the Usenet
11945 It's, like, too neat to search the Usenet for articles that match a
11946 string, but it, like, totally @emph{sucks}, like, totally, to use one of
11947 those, like, Web browsers, and you, like, have to, rilly, like, look at
11948 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
11949 searches without having to use a browser.
11951 The @code{nnweb} backend allows an easy interface to the mighty search
11952 engine. You create an @code{nnweb} group, enter a search pattern, and
11953 then enter the group and read the articles like you would any normal
11954 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
11955 Groups}) will do this in an easy-to-use fashion.
11957 @code{nnweb} groups don't really lend themselves to being solid
11958 groups---they have a very fleeting idea of article numbers. In fact,
11959 each time you enter an @code{nnweb} group (not even changing the search
11960 pattern), you are likely to get the articles ordered in a different
11961 manner. Not even using duplicate suppression (@pxref{Duplicate
11962 Suppression}) will help, since @code{nnweb} doesn't even know the
11963 @code{Message-ID} of the articles before reading them using some search
11964 engines (DejaNews, for instance). The only possible way to keep track
11965 of which articles you've read is by scoring on the @code{Date}
11966 header---mark all articles posted before the last date you read the
11969 If the search engine changes its output substantially, @code{nnweb}
11970 won't be able to parse it and will fail. One could hardly fault the Web
11971 providers if they were to do this---their @emph{raison d'être} is to
11972 make money off of advertisements, not to provide services to the
11973 community. Since @code{nnweb} washes the ads off all the articles, one
11974 might think that the providers might be somewhat miffed. We'll see.
11976 You must have the @code{url} and @code{w3} package installed to be able
11977 to use @code{nnweb}.
11979 Virtual server variables:
11984 What search engine type is being used. The currently supported types
11985 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
11989 @vindex nnweb-search
11990 The search string to feed to the search engine.
11992 @item nnweb-max-hits
11993 @vindex nnweb-max-hits
11994 Advisory maximum number of hits per search to display. The default is
11997 @item nnweb-type-definition
11998 @vindex nnweb-type-definition
11999 Type-to-definition alist. This alist says what @code{nnweb} should do
12000 with the various search engine types. The following elements must be
12005 Function to decode the article and provide something that Gnus
12009 Function to create an article number to message header and URL alist.
12012 Function to send the search string to the search engine.
12015 The address the aforementioned function should send the search string
12019 Format string URL to fetch an article by @code{Message-ID}.
12026 @node Mail-To-News Gateways
12027 @subsection Mail-To-News Gateways
12028 @cindex mail-to-news gateways
12031 If your local @code{nntp} server doesn't allow posting, for some reason
12032 or other, you can post using one of the numerous mail-to-news gateways.
12033 The @code{nngateway} backend provides the interface.
12035 Note that you can't read anything from this backend---it can only be
12041 @item nngateway-address
12042 @vindex nngateway-address
12043 This is the address of the mail-to-news gateway.
12045 @item nngateway-header-transformation
12046 @vindex nngateway-header-transformation
12047 News headers often have to be transformed in some odd way or other
12048 for the mail-to-news gateway to accept it. This variable says what
12049 transformation should be called, and defaults to
12050 @code{nngateway-simple-header-transformation}. The function is called
12051 narrowed to the headers to be transformed and with one parameter---the
12054 This default function just inserts a new @code{To} header based on the
12055 @code{Newsgroups} header and the gateway address.
12056 For instance, an article with this @code{Newsgroups} header:
12059 Newsgroups: alt.religion.emacs
12062 will get this @code{From} header inserted:
12065 To: alt-religion-emacs@@GATEWAY
12068 The following pre-defined functions exist:
12070 @findex nngateway-simple-header-transformation
12073 @item nngateway-simple-header-transformation
12074 Creates a @code{To} header that looks like
12075 @var{newsgroup}@@@code{nngateway-address}.
12077 @findex nngateway-mail2news-header-transformation
12079 @item nngateway-mail2news-header-transformation
12080 Creates a @code{To} header that looks like
12081 @code{nngateway-address}.
12086 (setq gnus-post-method
12087 '(nngateway "mail2news@@replay.com"
12088 (nngateway-header-transformation
12089 nngateway-mail2news-header-transformation)))
12097 So, to use this, simply say something like:
12100 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
12104 @node Combined Groups
12105 @section Combined Groups
12107 Gnus allows combining a mixture of all the other group types into bigger
12111 * Virtual Groups:: Combining articles from many groups.
12112 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
12116 @node Virtual Groups
12117 @subsection Virtual Groups
12119 @cindex virtual groups
12120 @cindex merging groups
12122 An @dfn{nnvirtual group} is really nothing more than a collection of
12125 For instance, if you are tired of reading many small groups, you can
12126 put them all in one big group, and then grow tired of reading one
12127 big, unwieldy group. The joys of computing!
12129 You specify @code{nnvirtual} as the method. The address should be a
12130 regexp to match component groups.
12132 All marks in the virtual group will stick to the articles in the
12133 component groups. So if you tick an article in a virtual group, the
12134 article will also be ticked in the component group from whence it came.
12135 (And vice versa---marks from the component groups will also be shown in
12136 the virtual group.)
12138 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
12139 newsgroups into one, big, happy newsgroup:
12142 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
12145 The component groups can be native or foreign; everything should work
12146 smoothly, but if your computer explodes, it was probably my fault.
12148 Collecting the same group from several servers might actually be a good
12149 idea if users have set the Distribution header to limit distribution.
12150 If you would like to read @samp{soc.motss} both from a server in Japan
12151 and a server in Norway, you could use the following as the group regexp:
12154 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
12157 (Remember, though, that if you're creating the group with @kbd{G m}, you
12158 shouldn't double the backslashes, and you should leave off the quote
12159 characters at the beginning and the end of the string.)
12161 This should work kinda smoothly---all articles from both groups should
12162 end up in this one, and there should be no duplicates. Threading (and
12163 the rest) will still work as usual, but there might be problems with the
12164 sequence of articles. Sorting on date might be an option here
12165 (@pxref{Selecting a Group}).
12167 One limitation, however---all groups included in a virtual
12168 group have to be alive (i.e., subscribed or unsubscribed). Killed or
12169 zombie groups can't be component groups for @code{nnvirtual} groups.
12171 @vindex nnvirtual-always-rescan
12172 If the @code{nnvirtual-always-rescan} is non-@code{nil},
12173 @code{nnvirtual} will always scan groups for unread articles when
12174 entering a virtual group. If this variable is @code{nil} (which is the
12175 default) and you read articles in a component group after the virtual
12176 group has been activated, the read articles from the component group
12177 will show up when you enter the virtual group. You'll also see this
12178 effect if you have two virtual groups that have a component group in
12179 common. If that's the case, you should set this variable to @code{t}.
12180 Or you can just tap @code{M-g} on the virtual group every time before
12181 you enter it---it'll have much the same effect.
12183 @code{nnvirtual} can have both mail and news groups as component groups.
12184 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
12185 has to ask the backend of the component group the article comes from
12186 whether it is a news or mail backend. However, when you do a @kbd{^},
12187 there is typically no sure way for the component backend to know this,
12188 and in that case @code{nnvirtual} tells Gnus that the article came from a
12189 not-news backend. (Just to be on the safe side.)
12191 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
12192 line from the article you respond to in these cases.
12196 @node Kibozed Groups
12197 @subsection Kibozed Groups
12201 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
12202 the news feed''. @code{nnkiboze} is a backend that will do this for
12203 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
12204 with useless requests! Oh happiness!
12206 @kindex G k (Group)
12207 To create a kibozed group, use the @kbd{G k} command in the group
12210 The address field of the @code{nnkiboze} method is, as with
12211 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
12212 @code{nnkiboze} group. That's where most similarities between @code{nnkiboze}
12213 and @code{nnvirtual} end.
12215 In addition to this regexp detailing component groups, an @code{nnkiboze} group
12216 must have a score file to say what articles are to be included in
12217 the group (@pxref{Scoring}).
12219 @kindex M-x nnkiboze-generate-groups
12220 @findex nnkiboze-generate-groups
12221 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
12222 @code{nnkiboze} groups you want to have. This command will take time. Lots of
12223 time. Oodles and oodles of time. Gnus has to fetch the headers from
12224 all the articles in all the component groups and run them through the
12225 scoring process to determine if there are any articles in the groups
12226 that are to be part of the @code{nnkiboze} groups.
12228 Please limit the number of component groups by using restrictive
12229 regexps. Otherwise your sysadmin may become annoyed with you, and the
12230 @sc{nntp} site may throw you off and never let you back in again.
12231 Stranger things have happened.
12233 @code{nnkiboze} component groups do not have to be alive---they can be dead,
12234 and they can be foreign. No restrictions.
12236 @vindex nnkiboze-directory
12237 The generation of an @code{nnkiboze} group means writing two files in
12238 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
12239 contains the @sc{nov} header lines for all the articles in the group,
12240 and the other is an additional @file{.newsrc} file to store information
12241 on what groups have been searched through to find component articles.
12243 Articles marked as read in the @code{nnkiboze} group will have
12244 their @sc{nov} lines removed from the @sc{nov} file.
12247 @node Gnus Unplugged
12248 @section Gnus Unplugged
12253 @cindex Gnus Unplugged
12255 In olden times (ca. February '88), people used to run their newsreaders
12256 on big machines with permanent connections to the net. News transport
12257 was dealt with by news servers, and all the newsreaders had to do was to
12258 read news. Believe it or not.
12260 Nowadays most people read news and mail at home, and use some sort of
12261 modem to connect to the net. To avoid running up huge phone bills, it
12262 would be nice to have a way to slurp down all the news and mail, hang up
12263 the phone, read for several hours, and then upload any responses you
12264 have to make. And then you repeat the procedure.
12266 Of course, you can use news servers for doing this as well. I've used
12267 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
12268 for some years, but doing that's a bore. Moving the news server
12269 functionality up to the newsreader makes sense if you're the only person
12270 reading news on a machine.
12272 Using Gnus as an ``offline'' newsreader is quite simple.
12276 First, set up Gnus as you would do if you were running it on a machine
12277 that has full connection to the net. Go ahead. I'll still be waiting
12281 Then, put the following magical incantation at the end of your
12282 @file{.gnus.el} file:
12289 That's it. Gnus is now an ``offline'' newsreader.
12291 Of course, to use it as such, you have to learn a few new commands.
12294 * Agent Basics:: How it all is supposed to work.
12295 * Agent Categories:: How to tell the Gnus Agent what to download.
12296 * Agent Commands:: New commands for all the buffers.
12297 * Agent Expiry:: How to make old articles go away.
12298 * Outgoing Messages:: What happens when you post/mail something?
12299 * Agent Variables:: Customizing is fun.
12300 * Example Setup:: An example @file{.gnus.el} file for offline people.
12301 * Batching Agents:: How to fetch news from a @code{cron} job.
12302 * Agent Caveats:: What you think it'll do and what it does.
12307 @subsection Agent Basics
12309 First, let's get some terminology out of the way.
12311 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
12312 connection to the net (and notified the Agent that this is the case).
12313 When the connection to the net is up again (and Gnus knows this), the
12314 Agent is @dfn{plugged}.
12316 The @dfn{local} machine is the one you're running on, and which isn't
12317 connected to the net continuously.
12319 @dfn{Downloading} means fetching things from the net to your local
12320 machine. @dfn{Uploading} is doing the opposite.
12322 Let's take a typical Gnus session using the Agent.
12327 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
12328 Agent in a disconnected state. You can read all the news that you have
12329 already fetched while in this mode.
12332 You then decide to see whether any new news has arrived. You connect
12333 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
12334 to make Gnus become @dfn{plugged}.
12337 You can then read the new news immediately, or you can download the news
12338 onto your local machine. If you want to do the latter, you press @kbd{J
12339 s} to fetch all the eligible articles in all the groups. (To let Gnus
12340 know which articles you want to download, @pxref{Agent Categories}.)
12343 After fetching the articles, you press @kbd{J j} to make Gnus become
12344 unplugged again, and you shut down the PPP thing (or whatever). And
12345 then you read the news offline.
12348 And then you go to step 2.
12351 Here are some things you should do the first time (or so) that you use
12357 Decide which servers should be covered by the Agent. If you have a mail
12358 backend, it would probably be nonsensical to have it covered by the
12359 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
12360 @kbd{J a} the server (or servers) that you wish to have covered by the
12361 Agent (@pxref{Server Agent Commands}). This will typically be only the
12362 primary select method, which is listed on the bottom in the buffer.
12365 Decide on download policy. @xref{Agent Categories}.
12372 @node Agent Categories
12373 @subsection Agent Categories
12375 One of the main reasons to integrate the news transport layer into the
12376 newsreader is to allow greater control over what articles to download.
12377 There's not much point in downloading huge amounts of articles, just to
12378 find out that you're not interested in reading any of them. It's better
12379 to be somewhat more conservative in choosing what to download, and then
12380 mark the articles for downloading manually if it should turn out that
12381 you're interested in the articles anyway.
12383 The main way to control what is to be downloaded is to create a
12384 @dfn{category} and then assign some (or all) groups to this category.
12385 Groups that do not belong in any other category belong to the
12386 @code{default} category. Gnus has its own buffer for creating and
12387 managing categories.
12390 * Category Syntax:: What a category looks like.
12391 * The Category Buffer:: A buffer for maintaining categories.
12392 * Category Variables:: Customize'r'Us.
12396 @node Category Syntax
12397 @subsubsection Category Syntax
12399 A category consists of two things.
12403 A predicate which (generally) gives a rough outline of which articles
12404 are eligible for downloading; and
12407 a score rule which (generally) gives you a finer granularity when
12408 deciding what articles to download. (Note that this @dfn{download
12409 score} is not necessarily related to normal scores.)
12412 A predicate in its simplest form can be a single predicate such as
12413 @code{true} or @code{false}. These two will download every available
12414 article or nothing respectively. In the case of these two special
12415 predicates an additional score rule is superfluous.
12417 Predicates of @code{high} or @code{low} download articles in respect of
12418 their scores in relationship to @code{gnus-agent-high-score} and
12419 @code{gnus-agent-low-score} as descibed below.
12421 To gain even finer control of what is to be regarded eligible for
12422 download a predicate can consist of a number of predicates with logical
12423 operators sprinkled in between.
12425 Perhaps some examples are in order.
12427 Here's a simple predicate. (It's the default predicate, in fact, used
12428 for all groups that don't belong to any other category.)
12434 Quite simple, eh? This predicate is true if and only if the article is
12435 short (for some value of ``short'').
12437 Here's a more complex predicate:
12446 This means that an article should be downloaded if it has a high score,
12447 or if the score is not low and the article is not long. You get the
12450 The available logical operators are @code{or}, @code{and} and
12451 @code{not}. (If you prefer, you can use the more ``C''-ish operators
12452 @samp{|}, @code{&} and @code{!} instead.)
12454 The following predicates are pre-defined, but if none of these fit what
12455 you want to do, you can write your own.
12459 True iff the article is shorter than @code{gnus-agent-short-article}
12460 lines; default 100.
12463 True iff the article is longer than @code{gnus-agent-long-article}
12464 lines; default 200.
12467 True iff the article has a download score less than
12468 @code{gnus-agent-low-score}; default 0.
12471 True iff the article has a download score greater than
12472 @code{gnus-agent-high-score}; default 0.
12475 True iff the Gnus Agent guesses that the article is spam. The
12476 heuristics may change over time, but at present it just computes a
12477 checksum and sees whether articles match.
12486 If you want to create your own predicate function, here's what you have
12487 to know: The functions are called with no parameters, but the
12488 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
12491 For example, you could decide that you don't want to download articles
12492 that were posted more than a certain number of days ago (e.g. posted
12493 more than @code{gnus-agent-expire-days} ago) you might write a function
12494 something along the lines of the following:
12497 (defun my-article-old-p ()
12498 "Say whether an article is old."
12499 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
12500 (- (time-to-days (current-time)) gnus-agent-expire-days)))
12503 with the predicate then defined as:
12506 (not my-article-old-p)
12509 or you could append your predicate to the predefined
12510 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
12511 wherever. (Note: this would have to be at a point *after*
12512 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
12515 (defvar gnus-category-predicate-alist
12516 (append gnus-category-predicate-alist
12517 '((old . my-article-old-p))))
12520 and simply specify your predicate as:
12526 If/when using something like the above, be aware that there are many
12527 misconfigured systems/mailers out there and so an article's date is not
12528 always a reliable indication of when it was posted. Hell, some people
12529 just don't give a damm.
12532 The above predicates apply to *all* the groups which belong to the
12533 category. However, if you wish to have a specific predicate for an
12534 individual group within a category, or you're just too lazy to set up a
12535 new category, you can enter a group's individual predicate in it's group
12536 parameters like so:
12539 (agent-predicate . short)
12542 This is the group parameter equivalent of the agent category
12543 default. Note that when specifying a single word predicate like this,
12544 the @code{agent-predicate} specification must be in dotted pair
12547 The equivalent of the longer example from above would be:
12550 (agent-predicate or high (and (not low) (not long)))
12553 The outer parenthesis required in the category specification are not
12554 entered here as, not being in dotted pair notation, the value of the
12555 predicate is assumed to be a list.
12558 Now, the syntax of the download score is the same as the syntax of
12559 normal score files, except that all elements that require actually
12560 seeing the article itself are verboten. This means that only the
12561 following headers can be scored on: @code{Subject}, @code{From},
12562 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
12563 @code{Lines}, and @code{Xref}.
12565 As with predicates, the specification of the @code{download score rule}
12566 to use in respect of a group can be in either the category definition if
12567 it's to be applicable to all groups in therein, or a group's parameters
12568 if it's to be specific to that group.
12570 In both of these places the @code{download score rule} can take one of
12577 This has the same syntax as a normal gnus score file except only a
12578 subset of scoring keywords are available as mentioned above.
12584 Category specification
12588 ("Lars Ingebrigtsen" 1000000 nil s))
12594 Group Parameter specification
12597 (agent-score ("from"
12598 ("Lars Ingebrigtsen" 1000000 nil s))
12603 Again, note the omission of the outermost parenthesis here.
12609 These score files must *only* contain the permitted scoring keywords
12616 Category specification
12619 ("~/News/agent.SCORE")
12625 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
12629 Group Parameter specification
12632 (agent-score "~/News/agent.SCORE")
12635 Additional score files can be specified as above. Need I say anything
12640 Use @code{normal} score files
12642 If you dont want to maintain two sets of scoring rules for a group, and
12643 your desired @code{downloading} criteria for a group are the same as your
12644 @code{reading} criteria then you can tell the agent to refer to your
12645 @code{normal} score files when deciding what to download.
12647 These directives in either the category definition or a group's
12648 parameters will cause the agent to read in all the applicable score
12649 files for a group, *filtering out* those those sections that do not
12650 relate to one of the permitted subset of scoring keywords.
12654 Category Specification
12661 Group Parameter specification
12664 (agent-score . file)
12669 @node The Category Buffer
12670 @subsubsection The Category Buffer
12672 You'd normally do all category maintenance from the category buffer.
12673 When you enter it for the first time (with the @kbd{J c} command from
12674 the group buffer), you'll only see the @code{default} category.
12676 The following commands are available in this buffer:
12680 @kindex q (Category)
12681 @findex gnus-category-exit
12682 Return to the group buffer (@code{gnus-category-exit}).
12685 @kindex k (Category)
12686 @findex gnus-category-kill
12687 Kill the current category (@code{gnus-category-kill}).
12690 @kindex c (Category)
12691 @findex gnus-category-copy
12692 Copy the current category (@code{gnus-category-copy}).
12695 @kindex a (Category)
12696 @findex gnus-category-add
12697 Add a new category (@code{gnus-category-add}).
12700 @kindex p (Category)
12701 @findex gnus-category-edit-predicate
12702 Edit the predicate of the current category
12703 (@code{gnus-category-edit-predicate}).
12706 @kindex g (Category)
12707 @findex gnus-category-edit-groups
12708 Edit the list of groups belonging to the current category
12709 (@code{gnus-category-edit-groups}).
12712 @kindex s (Category)
12713 @findex gnus-category-edit-score
12714 Edit the download score rule of the current category
12715 (@code{gnus-category-edit-score}).
12718 @kindex l (Category)
12719 @findex gnus-category-list
12720 List all the categories (@code{gnus-category-list}).
12724 @node Category Variables
12725 @subsubsection Category Variables
12728 @item gnus-category-mode-hook
12729 @vindex gnus-category-mode-hook
12730 Hook run in category buffers.
12732 @item gnus-category-line-format
12733 @vindex gnus-category-line-format
12734 Format of the lines in the category buffer (@pxref{Formatting
12735 Variables}). Valid elements are:
12739 The name of the category.
12742 The number of groups in the category.
12745 @item gnus-category-mode-line-format
12746 @vindex gnus-category-mode-line-format
12747 Format of the category mode line (@pxref{Mode Line Formatting}).
12749 @item gnus-agent-short-article
12750 @vindex gnus-agent-short-article
12751 Articles that have fewer lines than this are short. Default 100.
12753 @item gnus-agent-long-article
12754 @vindex gnus-agent-long-article
12755 Articles that have more lines than this are long. Default 200.
12757 @item gnus-agent-low-score
12758 @vindex gnus-agent-low-score
12759 Articles that have a score lower than this have a low score. Default
12762 @item gnus-agent-high-score
12763 @vindex gnus-agent-high-score
12764 Articles that have a score higher than this have a high score. Default
12770 @node Agent Commands
12771 @subsection Agent Commands
12773 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
12774 (@code{gnus-agent-toggle-plugged} command works in all modes, and
12775 toggles the plugged/unplugged state of the Gnus Agent.
12779 * Group Agent Commands::
12780 * Summary Agent Commands::
12781 * Server Agent Commands::
12784 You can run a complete batch fetch from the command line with the
12785 following incantation:
12787 @cindex gnus-agent-batch-fetch
12789 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
12794 @node Group Agent Commands
12795 @subsubsection Group Agent Commands
12799 @kindex J u (Agent Group)
12800 @findex gnus-agent-fetch-groups
12801 Fetch all eligible articles in the current group
12802 (@code{gnus-agent-fetch-groups}).
12805 @kindex J c (Agent Group)
12806 @findex gnus-enter-category-buffer
12807 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
12810 @kindex J s (Agent Group)
12811 @findex gnus-agent-fetch-session
12812 Fetch all eligible articles in all groups
12813 (@code{gnus-agent-fetch-session}).
12816 @kindex J S (Agent Group)
12817 @findex gnus-group-send-drafts
12818 Send all sendable messages in the draft group
12819 (@code{gnus-agent-fetch-session}). @xref{Drafts}.
12822 @kindex J a (Agent Group)
12823 @findex gnus-agent-add-group
12824 Add the current group to an Agent category
12825 (@code{gnus-agent-add-group}). This command understands the
12826 process/prefix convention (@pxref{Process/Prefix}).
12829 @kindex J r (Agent Group)
12830 @findex gnus-agent-remove-group
12831 Remove the current group from its category, if any
12832 (@code{gnus-agent-remove-group}). This command understands the
12833 process/prefix convention (@pxref{Process/Prefix}).
12838 @node Summary Agent Commands
12839 @subsubsection Summary Agent Commands
12843 @kindex J # (Agent Summary)
12844 @findex gnus-agent-mark-article
12845 Mark the article for downloading (@code{gnus-agent-mark-article}).
12848 @kindex J M-# (Agent Summary)
12849 @findex gnus-agent-unmark-article
12850 Remove the downloading mark from the article
12851 (@code{gnus-agent-unmark-article}).
12854 @kindex @@ (Agent Summary)
12855 @findex gnus-agent-toggle-mark
12856 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
12859 @kindex J c (Agent Summary)
12860 @findex gnus-agent-catchup
12861 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
12866 @node Server Agent Commands
12867 @subsubsection Server Agent Commands
12871 @kindex J a (Agent Server)
12872 @findex gnus-agent-add-server
12873 Add the current server to the list of servers covered by the Gnus Agent
12874 (@code{gnus-agent-add-server}).
12877 @kindex J r (Agent Server)
12878 @findex gnus-agent-remove-server
12879 Remove the current server from the list of servers covered by the Gnus
12880 Agent (@code{gnus-agent-remove-server}).
12886 @subsection Agent Expiry
12888 @vindex gnus-agent-expire-days
12889 @findex gnus-agent-expire
12890 @kindex M-x gnus-agent-expire
12891 @cindex Agent expiry
12892 @cindex Gnus Agent expiry
12895 @code{nnagent} doesn't handle expiry. Instead, there's a special
12896 @code{gnus-agent-expire} command that will expire all read articles that
12897 are older than @code{gnus-agent-expire-days} days. It can be run
12898 whenever you feel that you're running out of space. It's not
12899 particularly fast or efficient, and it's not a particularly good idea to
12900 interrupt it (with @kbd{C-g} or anything else) once you've started it.
12902 @vindex gnus-agent-expire-all
12903 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
12904 expire all articles---unread, read, ticked and dormant. If @code{nil}
12905 (which is the default), only read articles are eligible for expiry, and
12906 unread, ticked and dormant articles will be kept indefinitely.
12909 @node Outgoing Messages
12910 @subsection Outgoing Messages
12912 When Gnus is unplugged, all outgoing messages (both mail and news) are
12913 stored in the draft groups (@pxref{Drafts}). You can view them there
12914 after posting, and edit them at will.
12916 When Gnus is plugged again, you can send the messages either from the
12917 draft group with the special commands available there, or you can use
12918 the @kbd{J S} command in the group buffer to send all the sendable
12919 messages in the draft group.
12923 @node Agent Variables
12924 @subsection Agent Variables
12927 @item gnus-agent-directory
12928 @vindex gnus-agent-directory
12929 Where the Gnus Agent will store its files. The default is
12930 @file{~/News/agent/}.
12932 @item gnus-agent-handle-level
12933 @vindex gnus-agent-handle-level
12934 Groups on levels (@pxref{Group Levels}) higher than this variable will
12935 be ignored by the Agent. The default is @code{gnus-level-subscribed},
12936 which means that only subscribed group will be considered by the Agent
12939 @item gnus-agent-plugged-hook
12940 @vindex gnus-agent-plugged-hook
12941 Hook run when connecting to the network.
12943 @item gnus-agent-unplugged-hook
12944 @vindex gnus-agent-unplugged-hook
12945 Hook run when disconnecting from the network.
12950 @node Example Setup
12951 @subsection Example Setup
12953 If you don't want to read this manual, and you have a fairly standard
12954 setup, you may be able to use something like the following as your
12955 @file{.gnus.el} file to get started.
12958 ;;; Define how Gnus is to fetch news. We do this over NNTP
12959 ;;; from your ISP's server.
12960 (setq gnus-select-method '(nntp "news.your-isp.com"))
12962 ;;; Define how Gnus is to read your mail. We read mail from
12963 ;;; your ISP's POP server.
12964 (setq mail-sources '((pop :server "pop.your-isp.com")))
12966 ;;; Say how Gnus is to store the mail. We use nnml groups.
12967 (setq gnus-secondary-select-methods '((nnml "")))
12969 ;;; Make Gnus into an offline newsreader.
12973 That should be it, basically. Put that in your @file{~/.gnus.el} file,
12974 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
12977 If this is the first time you've run Gnus, you will be subscribed
12978 automatically to a few default newsgroups. You'll probably want to
12979 subscribe to more groups, and to do that, you have to query the
12980 @sc{nntp} server for a complete list of groups with the @kbd{A A}
12981 command. This usually takes quite a while, but you only have to do it
12984 After reading and parsing a while, you'll be presented with a list of
12985 groups. Subscribe to the ones you want to read with the @kbd{u}
12986 command. @kbd{l} to make all the killed groups disappear after you've
12987 subscribe to all the groups you want to read. (@kbd{A k} will bring
12988 back all the killed groups.)
12990 You can now read the groups at once, or you can download the articles
12991 with the @kbd{J s} command. And then read the rest of this manual to
12992 find out which of the other gazillion things you want to customize.
12995 @node Batching Agents
12996 @subsection Batching Agents
12998 Having the Gnus Agent fetch articles (and post whatever messages you've
12999 written) is quite easy once you've gotten things set up properly. The
13000 following shell script will do everything that is necessary:
13004 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
13008 @node Agent Caveats
13009 @subsection Agent Caveats
13011 The Gnus Agent doesn't seem to work like most other offline
13012 newsreaders. Here are some common questions that some imaginary people
13016 @item If I read an article while plugged, do they get entered into the
13021 @item If I read an article while plugged, and the article already exists
13022 in the Agent, will it get downloaded once more?
13028 In short, when Gnus is unplugged, it only looks into the locally stored
13029 articles; when it's plugged, it only talks to your ISP.
13036 Other people use @dfn{kill files}, but we here at Gnus Towers like
13037 scoring better than killing, so we'd rather switch than fight. They do
13038 something completely different as well, so sit up straight and pay
13041 @vindex gnus-summary-mark-below
13042 All articles have a default score (@code{gnus-summary-default-score}),
13043 which is 0 by default. This score may be raised or lowered either
13044 interactively or by score files. Articles that have a score lower than
13045 @code{gnus-summary-mark-below} are marked as read.
13047 Gnus will read any @dfn{score files} that apply to the current group
13048 before generating the summary buffer.
13050 There are several commands in the summary buffer that insert score
13051 entries based on the current article. You can, for instance, ask Gnus to
13052 lower or increase the score of all articles with a certain subject.
13054 There are two sorts of scoring entries: Permanent and temporary.
13055 Temporary score entries are self-expiring entries. Any entries that are
13056 temporary and have not been used for, say, a week, will be removed
13057 silently to help keep the sizes of the score files down.
13060 * Summary Score Commands:: Adding score entries for the current group.
13061 * Group Score Commands:: General score commands.
13062 * Score Variables:: Customize your scoring. (My, what terminology).
13063 * Score File Format:: What a score file may contain.
13064 * Score File Editing:: You can edit score files by hand as well.
13065 * Adaptive Scoring:: Big Sister Gnus knows what you read.
13066 * Home Score File:: How to say where new score entries are to go.
13067 * Followups To Yourself:: Having Gnus notice when people answer you.
13068 * Scoring Tips:: How to score effectively.
13069 * Reverse Scoring:: That problem child of old is not problem.
13070 * Global Score Files:: Earth-spanning, ear-splitting score files.
13071 * Kill Files:: They are still here, but they can be ignored.
13072 * Converting Kill Files:: Translating kill files to score files.
13073 * GroupLens:: Getting predictions on what you like to read.
13074 * Advanced Scoring:: Using logical expressions to build score rules.
13075 * Score Decays:: It can be useful to let scores wither away.
13079 @node Summary Score Commands
13080 @section Summary Score Commands
13081 @cindex score commands
13083 The score commands that alter score entries do not actually modify real
13084 score files. That would be too inefficient. Gnus maintains a cache of
13085 previously loaded score files, one of which is considered the
13086 @dfn{current score file alist}. The score commands simply insert
13087 entries into this list, and upon group exit, this list is saved.
13089 The current score file is by default the group's local score file, even
13090 if no such score file actually exists. To insert score commands into
13091 some other score file (e.g. @file{all.SCORE}), you must first make this
13092 score file the current one.
13094 General score commands that don't actually change the score file:
13099 @kindex V s (Summary)
13100 @findex gnus-summary-set-score
13101 Set the score of the current article (@code{gnus-summary-set-score}).
13104 @kindex V S (Summary)
13105 @findex gnus-summary-current-score
13106 Display the score of the current article
13107 (@code{gnus-summary-current-score}).
13110 @kindex V t (Summary)
13111 @findex gnus-score-find-trace
13112 Display all score rules that have been used on the current article
13113 (@code{gnus-score-find-trace}).
13116 @kindex V R (Summary)
13117 @findex gnus-summary-rescore
13118 Run the current summary through the scoring process
13119 (@code{gnus-summary-rescore}). This might be useful if you're playing
13120 around with your score files behind Gnus' back and want to see the
13121 effect you're having.
13124 @kindex V c (Summary)
13125 @findex gnus-score-change-score-file
13126 Make a different score file the current
13127 (@code{gnus-score-change-score-file}).
13130 @kindex V e (Summary)
13131 @findex gnus-score-edit-current-scores
13132 Edit the current score file (@code{gnus-score-edit-current-scores}).
13133 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
13137 @kindex V f (Summary)
13138 @findex gnus-score-edit-file
13139 Edit a score file and make this score file the current one
13140 (@code{gnus-score-edit-file}).
13143 @kindex V F (Summary)
13144 @findex gnus-score-flush-cache
13145 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
13146 after editing score files.
13149 @kindex V C (Summary)
13150 @findex gnus-score-customize
13151 Customize a score file in a visually pleasing manner
13152 (@code{gnus-score-customize}).
13156 The rest of these commands modify the local score file.
13161 @kindex V m (Summary)
13162 @findex gnus-score-set-mark-below
13163 Prompt for a score, and mark all articles with a score below this as
13164 read (@code{gnus-score-set-mark-below}).
13167 @kindex V x (Summary)
13168 @findex gnus-score-set-expunge-below
13169 Prompt for a score, and add a score rule to the current score file to
13170 expunge all articles below this score
13171 (@code{gnus-score-set-expunge-below}).
13174 The keystrokes for actually making score entries follow a very regular
13175 pattern, so there's no need to list all the commands. (Hundreds of
13178 @findex gnus-summary-increase-score
13179 @findex gnus-summary-lower-score
13183 The first key is either @kbd{I} (upper case i) for increasing the score
13184 or @kbd{L} for lowering the score.
13186 The second key says what header you want to score on. The following
13187 keys are available:
13191 Score on the author name.
13194 Score on the subject line.
13197 Score on the @code{Xref} line---i.e., the cross-posting line.
13200 Score on the @code{References} line.
13206 Score on the number of lines.
13209 Score on the @code{Message-ID} header.
13212 Score on followups---this matches the author name, and adds scores to
13213 the followups to this author.
13227 The third key is the match type. Which match types are valid depends on
13228 what headers you are scoring on.
13240 Substring matching.
13243 Fuzzy matching (@pxref{Fuzzy Matching}).
13272 Greater than number.
13277 The fourth and final key says whether this is a temporary (i.e., expiring)
13278 score entry, or a permanent (i.e., non-expiring) score entry, or whether
13279 it is to be done immediately, without adding to the score file.
13283 Temporary score entry.
13286 Permanent score entry.
13289 Immediately scoring.
13294 So, let's say you want to increase the score on the current author with
13295 exact matching permanently: @kbd{I a e p}. If you want to lower the
13296 score based on the subject line, using substring matching, and make a
13297 temporary score entry: @kbd{L s s t}. Pretty easy.
13299 To make things a bit more complicated, there are shortcuts. If you use
13300 a capital letter on either the second or third keys, Gnus will use
13301 defaults for the remaining one or two keystrokes. The defaults are
13302 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
13303 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
13305 These functions take both the numerical prefix and the symbolic prefix
13306 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
13307 (or increase) the score of the article. A symbolic prefix of @code{a}
13308 says to use the @file{all.SCORE} file for the command instead of the
13309 current score file.
13311 @vindex gnus-score-mimic-keymap
13312 The @code{gnus-score-mimic-keymap} says whether these commands will
13313 pretend they are keymaps or not.
13316 @node Group Score Commands
13317 @section Group Score Commands
13318 @cindex group score commands
13320 There aren't many of these as yet, I'm afraid.
13325 @kindex W f (Group)
13326 @findex gnus-score-flush-cache
13327 Gnus maintains a cache of score alists to avoid having to reload them
13328 all the time. This command will flush the cache
13329 (@code{gnus-score-flush-cache}).
13333 You can do scoring from the command line by saying something like:
13335 @findex gnus-batch-score
13336 @cindex batch scoring
13338 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
13342 @node Score Variables
13343 @section Score Variables
13344 @cindex score variables
13348 @item gnus-use-scoring
13349 @vindex gnus-use-scoring
13350 If @code{nil}, Gnus will not check for score files, and will not, in
13351 general, do any score-related work. This is @code{t} by default.
13353 @item gnus-kill-killed
13354 @vindex gnus-kill-killed
13355 If this variable is @code{nil}, Gnus will never apply score files to
13356 articles that have already been through the kill process. While this
13357 may save you lots of time, it also means that if you apply a kill file
13358 to a group, and then change the kill file and want to run it over you
13359 group again to kill more articles, it won't work. You have to set this
13360 variable to @code{t} to do that. (It is @code{t} by default.)
13362 @item gnus-kill-files-directory
13363 @vindex gnus-kill-files-directory
13364 All kill and score files will be stored in this directory, which is
13365 initialized from the @code{SAVEDIR} environment variable by default.
13366 This is @file{~/News/} by default.
13368 @item gnus-score-file-suffix
13369 @vindex gnus-score-file-suffix
13370 Suffix to add to the group name to arrive at the score file name
13371 (@samp{SCORE} by default.)
13373 @item gnus-score-uncacheable-files
13374 @vindex gnus-score-uncacheable-files
13375 @cindex score cache
13376 All score files are normally cached to avoid excessive re-loading of
13377 score files. However, if this might make you Emacs grow big and
13378 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
13379 @file{all.SCORE}, while it might be a good idea to not cache
13380 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
13381 variable is @samp{ADAPT$} by default, so no adaptive score files will
13384 @item gnus-save-score
13385 @vindex gnus-save-score
13386 If you have really complicated score files, and do lots of batch
13387 scoring, then you might set this variable to @code{t}. This will make
13388 Gnus save the scores into the @file{.newsrc.eld} file.
13390 If you do not set this to @code{t}, then manual scores (like those set
13391 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
13392 across group visits.
13394 @item gnus-score-interactive-default-score
13395 @vindex gnus-score-interactive-default-score
13396 Score used by all the interactive raise/lower commands to raise/lower
13397 score with. Default is 1000, which may seem excessive, but this is to
13398 ensure that the adaptive scoring scheme gets enough room to play with.
13399 We don't want the small changes from the adaptive scoring to overwrite
13400 manually entered data.
13402 @item gnus-summary-default-score
13403 @vindex gnus-summary-default-score
13404 Default score of an article, which is 0 by default.
13406 @item gnus-summary-expunge-below
13407 @vindex gnus-summary-expunge-below
13408 Don't display the summary lines of articles that have scores lower than
13409 this variable. This is @code{nil} by default, which means that no
13410 articles will be hidden. This variable is local to the summary buffers,
13411 and has to be set from @code{gnus-summary-mode-hook}.
13413 @item gnus-score-over-mark
13414 @vindex gnus-score-over-mark
13415 Mark (in the third column) used for articles with a score over the
13416 default. Default is @samp{+}.
13418 @item gnus-score-below-mark
13419 @vindex gnus-score-below-mark
13420 Mark (in the third column) used for articles with a score below the
13421 default. Default is @samp{-}.
13423 @item gnus-score-find-score-files-function
13424 @vindex gnus-score-find-score-files-function
13425 Function used to find score files for the current group. This function
13426 is called with the name of the group as the argument.
13428 Predefined functions available are:
13431 @item gnus-score-find-single
13432 @findex gnus-score-find-single
13433 Only apply the group's own score file.
13435 @item gnus-score-find-bnews
13436 @findex gnus-score-find-bnews
13437 Apply all score files that match, using bnews syntax. This is the
13438 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
13439 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
13440 @file{gnu.all.SCORE} would all apply. In short, the instances of
13441 @samp{all} in the score file names are translated into @samp{.*}, and
13442 then a regexp match is done.
13444 This means that if you have some score entries that you want to apply to
13445 all groups, then you put those entries in the @file{all.SCORE} file.
13447 The score files are applied in a semi-random order, although Gnus will
13448 try to apply the more general score files before the more specific score
13449 files. It does this by looking at the number of elements in the score
13450 file names---discarding the @samp{all} elements.
13452 @item gnus-score-find-hierarchical
13453 @findex gnus-score-find-hierarchical
13454 Apply all score files from all the parent groups. This means that you
13455 can't have score files like @file{all.SCORE}, but you can have
13456 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
13459 This variable can also be a list of functions. In that case, all these
13460 functions will be called, and all the returned lists of score files will
13461 be applied. These functions can also return lists of score alists
13462 directly. In that case, the functions that return these non-file score
13463 alists should probably be placed before the ``real'' score file
13464 functions, to ensure that the last score file returned is the local
13467 @item gnus-score-expiry-days
13468 @vindex gnus-score-expiry-days
13469 This variable says how many days should pass before an unused score file
13470 entry is expired. If this variable is @code{nil}, no score file entries
13471 are expired. It's 7 by default.
13473 @item gnus-update-score-entry-dates
13474 @vindex gnus-update-score-entry-dates
13475 If this variable is non-@code{nil}, matching score entries will have
13476 their dates updated. (This is how Gnus controls expiry---all
13477 non-matching entries will become too old while matching entries will
13478 stay fresh and young.) However, if you set this variable to @code{nil},
13479 even matching entries will grow old and will have to face that oh-so
13482 @item gnus-score-after-write-file-function
13483 @vindex gnus-score-after-write-file-function
13484 Function called with the name of the score file just written.
13486 @item gnus-score-thread-simplify
13487 @vindex gnus-score-thread-simplify
13488 If this variable is non-@code{nil}, article subjects will be simplified
13489 for subject scoring purposes in the same manner as with
13490 threading---according to the current value of
13491 gnus-simplify-subject-functions. If the scoring entry uses
13492 @code{substring} or @code{exact} matching, the match will also be
13493 simplified in this manner.
13498 @node Score File Format
13499 @section Score File Format
13500 @cindex score file format
13502 A score file is an @code{emacs-lisp} file that normally contains just a
13503 single form. Casual users are not expected to edit these files;
13504 everything can be changed from the summary buffer.
13506 Anyway, if you'd like to dig into it yourself, here's an example:
13510 ("Lars Ingebrigtsen" -10000)
13512 ("larsi\\|lmi" -50000 nil R))
13514 ("Ding is Badd" nil 728373))
13516 ("alt.politics" -1000 728372 s))
13521 (mark-and-expunge -10)
13525 (files "/hom/larsi/News/gnu.SCORE")
13526 (exclude-files "all.SCORE")
13527 (local (gnus-newsgroup-auto-expire t)
13528 (gnus-summary-make-false-root empty))
13532 This example demonstrates most score file elements. For a different
13533 approach, see @pxref{Advanced Scoring}.
13535 Even though this looks much like lisp code, nothing here is actually
13536 @code{eval}ed. The lisp reader is used to read this form, though, so it
13537 has to be valid syntactically, if not semantically.
13539 Six keys are supported by this alist:
13544 If the key is a string, it is the name of the header to perform the
13545 match on. Scoring can only be performed on these eight headers:
13546 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
13547 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
13548 these headers, there are three strings to tell Gnus to fetch the entire
13549 article and do the match on larger parts of the article: @code{Body}
13550 will perform the match on the body of the article, @code{Head} will
13551 perform the match on the head of the article, and @code{All} will
13552 perform the match on the entire article. Note that using any of these
13553 last three keys will slow down group entry @emph{considerably}. The
13554 final ``header'' you can score on is @code{Followup}. These score
13555 entries will result in new score entries being added for all follow-ups
13556 to articles that matches these score entries.
13558 Following this key is a arbitrary number of score entries, where each
13559 score entry has one to four elements.
13563 The first element is the @dfn{match element}. On most headers this will
13564 be a string, but on the Lines and Chars headers, this must be an
13568 If the second element is present, it should be a number---the @dfn{score
13569 element}. This number should be an integer in the neginf to posinf
13570 interval. This number is added to the score of the article if the match
13571 is successful. If this element is not present, the
13572 @code{gnus-score-interactive-default-score} number will be used
13573 instead. This is 1000 by default.
13576 If the third element is present, it should be a number---the @dfn{date
13577 element}. This date says when the last time this score entry matched,
13578 which provides a mechanism for expiring the score entries. It this
13579 element is not present, the score entry is permanent. The date is
13580 represented by the number of days since December 31, 1 BCE.
13583 If the fourth element is present, it should be a symbol---the @dfn{type
13584 element}. This element specifies what function should be used to see
13585 whether this score entry matches the article. What match types that can
13586 be used depends on what header you wish to perform the match on.
13589 @item From, Subject, References, Xref, Message-ID
13590 For most header types, there are the @code{r} and @code{R} (regexp), as
13591 well as @code{s} and @code{S} (substring) types, and @code{e} and
13592 @code{E} (exact match), and @code{w} (word match) types. If this
13593 element is not present, Gnus will assume that substring matching should
13594 be used. @code{R}, @code{S}, and @code{E} differ from the others in
13595 that the matches will be done in a case-sensitive manner. All these
13596 one-letter types are really just abbreviations for the @code{regexp},
13597 @code{string}, @code{exact}, and @code{word} types, which you can use
13598 instead, if you feel like.
13601 These two headers use different match types: @code{<}, @code{>},
13602 @code{=}, @code{>=} and @code{<=}.
13604 These predicates are true if
13607 (PREDICATE HEADER MATCH)
13610 evaluates to non-@code{nil}. For instance, the advanced match
13611 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
13618 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
13619 the match, we get the score added if the article has less than 4 lines.
13620 (It's easy to get confused and think it's the other way around. But
13621 it's not. I think.)
13623 When matching on @code{Lines}, be careful because some backends (like
13624 @code{nndir}) do not generate @code{Lines} header, so every article ends
13625 up being marked as having 0 lines. This can lead to strange results if
13626 you happen to lower score of the articles with few lines.
13629 For the Date header we have three kinda silly match types:
13630 @code{before}, @code{at} and @code{after}. I can't really imagine this
13631 ever being useful, but, like, it would feel kinda silly not to provide
13632 this function. Just in case. You never know. Better safe than sorry.
13633 Once burnt, twice shy. Don't judge a book by its cover. Never not have
13634 sex on a first date. (I have been told that at least one person, and I
13635 quote, ``found this function indispensable'', however.)
13639 A more useful match type is @code{regexp}. With it, you can match the
13640 date string using a regular expression. The date is normalized to
13641 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
13642 you want to match all articles that have been posted on April 1st in
13643 every year, you could use @samp{....0401.........} as a match string,
13644 for instance. (Note that the date is kept in its original time zone, so
13645 this will match articles that were posted when it was April 1st where
13646 the article was posted from. Time zones are such wholesome fun for the
13649 @item Head, Body, All
13650 These three match keys use the same match types as the @code{From} (etc)
13654 This match key is somewhat special, in that it will match the
13655 @code{From} header, and affect the score of not only the matching
13656 articles, but also all followups to the matching articles. This allows
13657 you e.g. increase the score of followups to your own articles, or
13658 decrease the score of followups to the articles of some known
13659 trouble-maker. Uses the same match types as the @code{From} header
13660 uses. (Using this match key will lead to creation of @file{ADAPT}
13664 This match key works along the same lines as the @code{Followup} match
13665 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
13666 @samp{thread} match. This will add a new @samp{thread} match for each
13667 article that has @var{X} in its @code{References} header. (These new
13668 @samp{thread} matches will use the @code{Message-ID}s of these matching
13669 articles.) This will ensure that you can raise/lower the score of an
13670 entire thread, even though some articles in the thread may not have
13671 complete @code{References} headers. Note that using this may lead to
13672 undeterministic scores of the articles in the thread. (Using this match
13673 key will lead to creation of @file{ADAPT} files.)
13677 @cindex Score File Atoms
13679 The value of this entry should be a number. Any articles with a score
13680 lower than this number will be marked as read.
13683 The value of this entry should be a number. Any articles with a score
13684 lower than this number will be removed from the summary buffer.
13686 @item mark-and-expunge
13687 The value of this entry should be a number. Any articles with a score
13688 lower than this number will be marked as read and removed from the
13691 @item thread-mark-and-expunge
13692 The value of this entry should be a number. All articles that belong to
13693 a thread that has a total score below this number will be marked as read
13694 and removed from the summary buffer. @code{gnus-thread-score-function}
13695 says how to compute the total score for a thread.
13698 The value of this entry should be any number of file names. These files
13699 are assumed to be score files as well, and will be loaded the same way
13702 @item exclude-files
13703 The clue of this entry should be any number of files. These files will
13704 not be loaded, even though they would normally be so, for some reason or
13708 The value of this entry will be @code{eval}el. This element will be
13709 ignored when handling global score files.
13712 Read-only score files will not be updated or saved. Global score files
13713 should feature this atom (@pxref{Global Score Files}). (Note:
13714 @dfn{Global} here really means @dfn{global}; not your personal
13715 apply-to-all-groups score files.)
13718 The value of this entry should be a number. Articles that do not have
13719 parents will get this number added to their scores. Imagine you follow
13720 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
13721 will only follow a few of the threads, also want to see any new threads.
13723 You can do this with the following two score file entries:
13727 (mark-and-expunge -100)
13730 When you enter the group the first time, you will only see the new
13731 threads. You then raise the score of the threads that you find
13732 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
13733 rest. Next time you enter the group, you will see new articles in the
13734 interesting threads, plus any new threads.
13736 I.e.---the orphan score atom is for high-volume groups where there
13737 exist a few interesting threads which can't be found automatically by
13738 ordinary scoring rules.
13741 This entry controls the adaptive scoring. If it is @code{t}, the
13742 default adaptive scoring rules will be used. If it is @code{ignore}, no
13743 adaptive scoring will be performed on this group. If it is a list, this
13744 list will be used as the adaptive scoring rules. If it isn't present,
13745 or is something other than @code{t} or @code{ignore}, the default
13746 adaptive scoring rules will be used. If you want to use adaptive
13747 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
13748 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
13749 not want adaptive scoring. If you only want adaptive scoring in a few
13750 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
13751 insert @code{(adapt t)} in the score files of the groups where you want
13755 All adaptive score entries will go to the file named by this entry. It
13756 will also be applied when entering the group. This atom might be handy
13757 if you want to adapt on several groups at once, using the same adaptive
13758 file for a number of groups.
13761 @cindex local variables
13762 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
13763 Each @var{var} will be made buffer-local to the current summary buffer,
13764 and set to the value specified. This is a convenient, if somewhat
13765 strange, way of setting variables in some groups if you don't like hooks
13766 much. Note that the @var{value} won't be evaluated.
13770 @node Score File Editing
13771 @section Score File Editing
13773 You normally enter all scoring commands from the summary buffer, but you
13774 might feel the urge to edit them by hand as well, so we've supplied you
13775 with a mode for that.
13777 It's simply a slightly customized @code{emacs-lisp} mode, with these
13778 additional commands:
13783 @kindex C-c C-c (Score)
13784 @findex gnus-score-edit-done
13785 Save the changes you have made and return to the summary buffer
13786 (@code{gnus-score-edit-done}).
13789 @kindex C-c C-d (Score)
13790 @findex gnus-score-edit-insert-date
13791 Insert the current date in numerical format
13792 (@code{gnus-score-edit-insert-date}). This is really the day number, if
13793 you were wondering.
13796 @kindex C-c C-p (Score)
13797 @findex gnus-score-pretty-print
13798 The adaptive score files are saved in an unformatted fashion. If you
13799 intend to read one of these files, you want to @dfn{pretty print} it
13800 first. This command (@code{gnus-score-pretty-print}) does that for
13805 Type @kbd{M-x gnus-score-mode} to use this mode.
13807 @vindex gnus-score-mode-hook
13808 @code{gnus-score-menu-hook} is run in score mode buffers.
13810 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
13811 e} to begin editing score files.
13814 @node Adaptive Scoring
13815 @section Adaptive Scoring
13816 @cindex adaptive scoring
13818 If all this scoring is getting you down, Gnus has a way of making it all
13819 happen automatically---as if by magic. Or rather, as if by artificial
13820 stupidity, to be precise.
13822 @vindex gnus-use-adaptive-scoring
13823 When you read an article, or mark an article as read, or kill an
13824 article, you leave marks behind. On exit from the group, Gnus can sniff
13825 these marks and add score elements depending on what marks it finds.
13826 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
13827 @code{t} or @code{(line)}. If you want score adaptively on separate
13828 words appearing in the subjects, you should set this variable to
13829 @code{(word)}. If you want to use both adaptive methods, set this
13830 variable to @code{(word line)}.
13832 @vindex gnus-default-adaptive-score-alist
13833 To give you complete control over the scoring process, you can customize
13834 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
13835 might look something like this:
13838 (defvar gnus-default-adaptive-score-alist
13839 '((gnus-unread-mark)
13840 (gnus-ticked-mark (from 4))
13841 (gnus-dormant-mark (from 5))
13842 (gnus-del-mark (from -4) (subject -1))
13843 (gnus-read-mark (from 4) (subject 2))
13844 (gnus-expirable-mark (from -1) (subject -1))
13845 (gnus-killed-mark (from -1) (subject -3))
13846 (gnus-kill-file-mark)
13847 (gnus-ancient-mark)
13848 (gnus-low-score-mark)
13849 (gnus-catchup-mark (from -1) (subject -1))))
13852 As you see, each element in this alist has a mark as a key (either a
13853 variable name or a ``real'' mark---a character). Following this key is
13854 a arbitrary number of header/score pairs. If there are no header/score
13855 pairs following the key, no adaptive scoring will be done on articles
13856 that have that key as the article mark. For instance, articles with
13857 @code{gnus-unread-mark} in the example above will not get adaptive score
13860 Each article can have only one mark, so just a single of these rules
13861 will be applied to each article.
13863 To take @code{gnus-del-mark} as an example---this alist says that all
13864 articles that have that mark (i.e., are marked with @samp{D}) will have a
13865 score entry added to lower based on the @code{From} header by -4, and
13866 lowered by @code{Subject} by -1. Change this to fit your prejudices.
13868 If you have marked 10 articles with the same subject with
13869 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
13870 That means that that subject will get a score of ten times -1, which
13871 should be, unless I'm much mistaken, -10.
13873 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
13874 the read articles will be marked with the @samp{E} mark. This'll
13875 probably make adaptive scoring slightly impossible, so auto-expiring and
13876 adaptive scoring doesn't really mix very well.
13878 The headers you can score on are @code{from}, @code{subject},
13879 @code{message-id}, @code{references}, @code{xref}, @code{lines},
13880 @code{chars} and @code{date}. In addition, you can score on
13881 @code{followup}, which will create an adaptive score entry that matches
13882 on the @code{References} header using the @code{Message-ID} of the
13883 current article, thereby matching the following thread.
13885 You can also score on @code{thread}, which will try to score all
13886 articles that appear in a thread. @code{thread} matches uses a
13887 @code{Message-ID} to match on the @code{References} header of the
13888 article. If the match is made, the @code{Message-ID} of the article is
13889 added to the @code{thread} rule. (Think about it. I'd recommend two
13890 aspirins afterwards.)
13892 If you use this scheme, you should set the score file atom @code{mark}
13893 to something small---like -300, perhaps, to avoid having small random
13894 changes result in articles getting marked as read.
13896 After using adaptive scoring for a week or so, Gnus should start to
13897 become properly trained and enhance the authors you like best, and kill
13898 the authors you like least, without you having to say so explicitly.
13900 You can control what groups the adaptive scoring is to be performed on
13901 by using the score files (@pxref{Score File Format}). This will also
13902 let you use different rules in different groups.
13904 @vindex gnus-adaptive-file-suffix
13905 The adaptive score entries will be put into a file where the name is the
13906 group name with @code{gnus-adaptive-file-suffix} appended. The default
13909 @vindex gnus-score-exact-adapt-limit
13910 When doing adaptive scoring, substring or fuzzy matching would probably
13911 give you the best results in most cases. However, if the header one
13912 matches is short, the possibility for false positives is great, so if
13913 the length of the match is less than
13914 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
13915 this variable is @code{nil}, exact matching will always be used to avoid
13918 @vindex gnus-default-adaptive-word-score-alist
13919 As mentioned above, you can adapt either on individual words or entire
13920 headers. If you adapt on words, the
13921 @code{gnus-default-adaptive-word-score-alist} variable says what score
13922 each instance of a word should add given a mark.
13925 (setq gnus-default-adaptive-word-score-alist
13926 `((,gnus-read-mark . 30)
13927 (,gnus-catchup-mark . -10)
13928 (,gnus-killed-mark . -20)
13929 (,gnus-del-mark . -15)))
13932 This is the default value. If you have adaption on words enabled, every
13933 word that appears in subjects of articles marked with
13934 @code{gnus-read-mark} will result in a score rule that increase the
13935 score with 30 points.
13937 @vindex gnus-default-ignored-adaptive-words
13938 @vindex gnus-ignored-adaptive-words
13939 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
13940 will be ignored. If you wish to add more words to be ignored, use the
13941 @code{gnus-ignored-adaptive-words} list instead.
13943 @vindex gnus-adaptive-word-syntax-table
13944 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
13945 syntax table in effect. It is similar to the standard syntax table, but
13946 it considers numbers to be non-word-constituent characters.
13948 @vindex gnus-adaptive-word-minimum
13949 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
13950 word scoring process will never bring down the score of an article to
13951 below this number. The default is @code{nil}.
13953 @vindex gnus-adaptive-word-no-group-words
13954 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
13955 won't adaptively word score any of the words in the group name. Useful
13956 for groups like @samp{comp.editors.emacs}, where most of the subject
13957 lines contain the word @samp{emacs}.
13959 After using this scheme for a while, it might be nice to write a
13960 @code{gnus-psychoanalyze-user} command to go through the rules and see
13961 what words you like and what words you don't like. Or perhaps not.
13963 Note that the adaptive word scoring thing is highly experimental and is
13964 likely to change in the future. Initial impressions seem to indicate
13965 that it's totally useless as it stands. Some more work (involving more
13966 rigorous statistical methods) will have to be done to make this useful.
13969 @node Home Score File
13970 @section Home Score File
13972 The score file where new score file entries will go is called the
13973 @dfn{home score file}. This is normally (and by default) the score file
13974 for the group itself. For instance, the home score file for
13975 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
13977 However, this may not be what you want. It is often convenient to share
13978 a common home score file among many groups---all @samp{emacs} groups
13979 could perhaps use the same home score file.
13981 @vindex gnus-home-score-file
13982 The variable that controls this is @code{gnus-home-score-file}. It can
13987 A string. Then this file will be used as the home score file for all
13991 A function. The result of this function will be used as the home score
13992 file. The function will be called with the name of the group as the
13996 A list. The elements in this list can be:
14000 @var{(regexp file-name)}. If the @var{regexp} matches the group name,
14001 the @var{file-name} will will be used as the home score file.
14004 A function. If the function returns non-nil, the result will be used as
14005 the home score file.
14008 A string. Use the string as the home score file.
14011 The list will be traversed from the beginning towards the end looking
14016 So, if you want to use just a single score file, you could say:
14019 (setq gnus-home-score-file
14020 "my-total-score-file.SCORE")
14023 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
14024 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
14026 @findex gnus-hierarchial-home-score-file
14028 (setq gnus-home-score-file
14029 'gnus-hierarchial-home-score-file)
14032 This is a ready-made function provided for your convenience.
14033 Other functions include
14036 @item gnus-current-home-score-file
14037 @findex gnus-current-home-score-file
14038 Return the ``current'' regular score file. This will make scoring
14039 commands add entry to the ``innermost'' matching score file.
14043 If you want to have one score file for the @samp{emacs} groups and
14044 another for the @samp{comp} groups, while letting all other groups use
14045 their own home score files:
14048 (setq gnus-home-score-file
14049 ;; All groups that match the regexp "\\.emacs"
14050 '(("\\.emacs" "emacs.SCORE")
14051 ;; All the comp groups in one score file
14052 ("^comp" "comp.SCORE")))
14055 @vindex gnus-home-adapt-file
14056 @code{gnus-home-adapt-file} works exactly the same way as
14057 @code{gnus-home-score-file}, but says what the home adaptive score file
14058 is instead. All new adaptive file entries will go into the file
14059 specified by this variable, and the same syntax is allowed.
14061 In addition to using @code{gnus-home-score-file} and
14062 @code{gnus-home-adapt-file}, you can also use group parameters
14063 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
14064 Parameters}) to achieve much the same. Group and topic parameters take
14065 precedence over this variable.
14068 @node Followups To Yourself
14069 @section Followups To Yourself
14071 Gnus offers two commands for picking out the @code{Message-ID} header in
14072 the current buffer. Gnus will then add a score rule that scores using
14073 this @code{Message-ID} on the @code{References} header of other
14074 articles. This will, in effect, increase the score of all articles that
14075 respond to the article in the current buffer. Quite useful if you want
14076 to easily note when people answer what you've said.
14080 @item gnus-score-followup-article
14081 @findex gnus-score-followup-article
14082 This will add a score to articles that directly follow up your own
14085 @item gnus-score-followup-thread
14086 @findex gnus-score-followup-thread
14087 This will add a score to all articles that appear in a thread ``below''
14091 @vindex message-sent-hook
14092 These two functions are both primarily meant to be used in hooks like
14093 @code{message-sent-hook}.
14095 If you look closely at your own @code{Message-ID}, you'll notice that
14096 the first two or three characters are always the same. Here's two of
14100 <x6u3u47icf.fsf@@eyesore.no>
14101 <x6sp9o7ibw.fsf@@eyesore.no>
14104 So ``my'' ident on this machine is @samp{x6}. This can be
14105 exploited---the following rule will raise the score on all followups to
14110 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
14114 Whether it's the first two or first three characters that are ``yours''
14115 is system-dependent.
14119 @section Scoring Tips
14120 @cindex scoring tips
14126 @cindex scoring crossposts
14127 If you want to lower the score of crossposts, the line to match on is
14128 the @code{Xref} header.
14130 ("xref" (" talk.politics.misc:" -1000))
14133 @item Multiple crossposts
14134 If you want to lower the score of articles that have been crossposted to
14135 more than, say, 3 groups:
14137 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
14140 @item Matching on the body
14141 This is generally not a very good idea---it takes a very long time.
14142 Gnus actually has to fetch each individual article from the server. But
14143 you might want to anyway, I guess. Even though there are three match
14144 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
14145 and stick with it in each score file. If you use any two, each article
14146 will be fetched @emph{twice}. If you want to match a bit on the
14147 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
14150 @item Marking as read
14151 You will probably want to mark articles that have scores below a certain
14152 number as read. This is most easily achieved by putting the following
14153 in your @file{all.SCORE} file:
14157 You may also consider doing something similar with @code{expunge}.
14159 @item Negated character classes
14160 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
14161 That will match newlines, which might lead to, well, The Unknown. Say
14162 @code{[^abcd\n]*} instead.
14166 @node Reverse Scoring
14167 @section Reverse Scoring
14168 @cindex reverse scoring
14170 If you want to keep just articles that have @samp{Sex with Emacs} in the
14171 subject header, and expunge all other articles, you could put something
14172 like this in your score file:
14176 ("Sex with Emacs" 2))
14181 So, you raise all articles that match @samp{Sex with Emacs} and mark the
14182 rest as read, and expunge them to boot.
14185 @node Global Score Files
14186 @section Global Score Files
14187 @cindex global score files
14189 Sure, other newsreaders have ``global kill files''. These are usually
14190 nothing more than a single kill file that applies to all groups, stored
14191 in the user's home directory. Bah! Puny, weak newsreaders!
14193 What I'm talking about here are Global Score Files. Score files from
14194 all over the world, from users everywhere, uniting all nations in one
14195 big, happy score file union! Ange-score! New and untested!
14197 @vindex gnus-global-score-files
14198 All you have to do to use other people's score files is to set the
14199 @code{gnus-global-score-files} variable. One entry for each score file,
14200 or each score file directory. Gnus will decide by itself what score
14201 files are applicable to which group.
14203 Say you want to use the score file
14204 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
14205 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
14208 (setq gnus-global-score-files
14209 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
14210 "/ftp@@ftp.some-where:/pub/score/"))
14213 @findex gnus-score-search-global-directories
14214 Simple, eh? Directory names must end with a @samp{/}. These
14215 directories are typically scanned only once during each Gnus session.
14216 If you feel the need to manually re-scan the remote directories, you can
14217 use the @code{gnus-score-search-global-directories} command.
14219 Note that, at present, using this option will slow down group entry
14220 somewhat. (That is---a lot.)
14222 If you want to start maintaining score files for other people to use,
14223 just put your score file up for anonymous ftp and announce it to the
14224 world. Become a retro-moderator! Participate in the retro-moderator
14225 wars sure to ensue, where retro-moderators battle it out for the
14226 sympathy of the people, luring them to use their score files on false
14227 premises! Yay! The net is saved!
14229 Here are some tips for the would-be retro-moderator, off the top of my
14235 Articles heavily crossposted are probably junk.
14237 To lower a single inappropriate article, lower by @code{Message-ID}.
14239 Particularly brilliant authors can be raised on a permanent basis.
14241 Authors that repeatedly post off-charter for the group can safely be
14242 lowered out of existence.
14244 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
14245 articles completely.
14248 Use expiring score entries to keep the size of the file down. You
14249 should probably have a long expiry period, though, as some sites keep
14250 old articles for a long time.
14253 ... I wonder whether other newsreaders will support global score files
14254 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
14255 Wave, xrn and 1stReader are bound to implement scoring. Should we start
14256 holding our breath yet?
14260 @section Kill Files
14263 Gnus still supports those pesky old kill files. In fact, the kill file
14264 entries can now be expiring, which is something I wrote before Daniel
14265 Quinlan thought of doing score files, so I've left the code in there.
14267 In short, kill processing is a lot slower (and I do mean @emph{a lot})
14268 than score processing, so it might be a good idea to rewrite your kill
14269 files into score files.
14271 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
14272 forms into this file, which means that you can use kill files as some
14273 sort of primitive hook function to be run on group entry, even though
14274 that isn't a very good idea.
14276 Normal kill files look like this:
14279 (gnus-kill "From" "Lars Ingebrigtsen")
14280 (gnus-kill "Subject" "ding")
14284 This will mark every article written by me as read, and remove the
14285 marked articles from the summary buffer. Very useful, you'll agree.
14287 Other programs use a totally different kill file syntax. If Gnus
14288 encounters what looks like a @code{rn} kill file, it will take a stab at
14291 Two summary functions for editing a GNUS kill file:
14296 @kindex M-k (Summary)
14297 @findex gnus-summary-edit-local-kill
14298 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
14301 @kindex M-K (Summary)
14302 @findex gnus-summary-edit-global-kill
14303 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
14306 Two group mode functions for editing the kill files:
14311 @kindex M-k (Group)
14312 @findex gnus-group-edit-local-kill
14313 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
14316 @kindex M-K (Group)
14317 @findex gnus-group-edit-global-kill
14318 Edit the general kill file (@code{gnus-group-edit-global-kill}).
14321 Kill file variables:
14324 @item gnus-kill-file-name
14325 @vindex gnus-kill-file-name
14326 A kill file for the group @samp{soc.motss} is normally called
14327 @file{soc.motss.KILL}. The suffix appended to the group name to get
14328 this file name is detailed by the @code{gnus-kill-file-name} variable.
14329 The ``global'' kill file (not in the score file sense of ``global'', of
14330 course) is just called @file{KILL}.
14332 @vindex gnus-kill-save-kill-file
14333 @item gnus-kill-save-kill-file
14334 If this variable is non-@code{nil}, Gnus will save the
14335 kill file after processing, which is necessary if you use expiring
14338 @item gnus-apply-kill-hook
14339 @vindex gnus-apply-kill-hook
14340 @findex gnus-apply-kill-file-unless-scored
14341 @findex gnus-apply-kill-file
14342 A hook called to apply kill files to a group. It is
14343 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
14344 kill file if you have a score file for the same group, you can set this
14345 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
14346 kill files to be processed, you should set this variable to @code{nil}.
14348 @item gnus-kill-file-mode-hook
14349 @vindex gnus-kill-file-mode-hook
14350 A hook called in kill-file mode buffers.
14355 @node Converting Kill Files
14356 @section Converting Kill Files
14358 @cindex converting kill files
14360 If you have loads of old kill files, you may want to convert them into
14361 score files. If they are ``regular'', you can use
14362 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
14365 The kill to score conversion package isn't included in Gnus by default.
14366 You can fetch it from
14367 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
14369 If your old kill files are very complex---if they contain more
14370 non-@code{gnus-kill} forms than not, you'll have to convert them by
14371 hand. Or just let them be as they are. Gnus will still use them as
14379 GroupLens is a collaborative filtering system that helps you work
14380 together with other people to find the quality news articles out of the
14381 huge volume of news articles generated every day.
14383 To accomplish this the GroupLens system combines your opinions about
14384 articles you have already read with the opinions of others who have done
14385 likewise and gives you a personalized prediction for each unread news
14386 article. Think of GroupLens as a matchmaker. GroupLens watches how you
14387 rate articles, and finds other people that rate articles the same way.
14388 Once it has found some people you agree with it tells you, in the form
14389 of a prediction, what they thought of the article. You can use this
14390 prediction to help you decide whether or not you want to read the
14394 * Using GroupLens:: How to make Gnus use GroupLens.
14395 * Rating Articles:: Letting GroupLens know how you rate articles.
14396 * Displaying Predictions:: Displaying predictions given by GroupLens.
14397 * GroupLens Variables:: Customizing GroupLens.
14401 @node Using GroupLens
14402 @subsection Using GroupLens
14404 To use GroupLens you must register a pseudonym with your local Better
14406 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
14407 better bit in town at the moment.
14409 Once you have registered you'll need to set a couple of variables.
14413 @item gnus-use-grouplens
14414 @vindex gnus-use-grouplens
14415 Setting this variable to a non-@code{nil} value will make Gnus hook into
14416 all the relevant GroupLens functions.
14418 @item grouplens-pseudonym
14419 @vindex grouplens-pseudonym
14420 This variable should be set to the pseudonym you got when registering
14421 with the Better Bit Bureau.
14423 @item grouplens-newsgroups
14424 @vindex grouplens-newsgroups
14425 A list of groups that you want to get GroupLens predictions for.
14429 That's the minimum of what you need to get up and running with GroupLens.
14430 Once you've registered, GroupLens will start giving you scores for
14431 articles based on the average of what other people think. But, to get
14432 the real benefit of GroupLens you need to start rating articles
14433 yourself. Then the scores GroupLens gives you will be personalized for
14434 you, based on how the people you usually agree with have already rated.
14437 @node Rating Articles
14438 @subsection Rating Articles
14440 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
14441 Where 1 means something like this article is a waste of bandwidth and 5
14442 means that the article was really good. The basic question to ask
14443 yourself is, "on a scale from 1 to 5 would I like to see more articles
14446 There are four ways to enter a rating for an article in GroupLens.
14451 @kindex r (GroupLens)
14452 @findex bbb-summary-rate-article
14453 This function will prompt you for a rating on a scale of one to five.
14456 @kindex k (GroupLens)
14457 @findex grouplens-score-thread
14458 This function will prompt you for a rating, and rate all the articles in
14459 the thread. This is really useful for some of those long running giant
14460 threads in rec.humor.
14464 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
14465 the score of the article you're reading.
14470 @kindex n (GroupLens)
14471 @findex grouplens-next-unread-article
14472 Rate the article and go to the next unread article.
14475 @kindex , (GroupLens)
14476 @findex grouplens-best-unread-article
14477 Rate the article and go to the next unread article with the highest score.
14481 If you want to give the current article a score of 4 and then go to the
14482 next article, just type @kbd{4 n}.
14485 @node Displaying Predictions
14486 @subsection Displaying Predictions
14488 GroupLens makes a prediction for you about how much you will like a
14489 news article. The predictions from GroupLens are on a scale from 1 to
14490 5, where 1 is the worst and 5 is the best. You can use the predictions
14491 from GroupLens in one of three ways controlled by the variable
14492 @code{gnus-grouplens-override-scoring}.
14494 @vindex gnus-grouplens-override-scoring
14495 There are three ways to display predictions in grouplens. You may
14496 choose to have the GroupLens scores contribute to, or override the
14497 regular gnus scoring mechanism. override is the default; however, some
14498 people prefer to see the Gnus scores plus the grouplens scores. To get
14499 the separate scoring behavior you need to set
14500 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
14501 GroupLens predictions combined with the grouplens scores set it to
14502 @code{'override} and to combine the scores set
14503 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
14504 the combine option you will also want to set the values for
14505 @code{grouplens-prediction-offset} and
14506 @code{grouplens-score-scale-factor}.
14508 @vindex grouplens-prediction-display
14509 In either case, GroupLens gives you a few choices for how you would like
14510 to see your predictions displayed. The display of predictions is
14511 controlled by the @code{grouplens-prediction-display} variable.
14513 The following are valid values for that variable.
14516 @item prediction-spot
14517 The higher the prediction, the further to the right an @samp{*} is
14520 @item confidence-interval
14521 A numeric confidence interval.
14523 @item prediction-bar
14524 The higher the prediction, the longer the bar.
14526 @item confidence-bar
14527 Numerical confidence.
14529 @item confidence-spot
14530 The spot gets bigger with more confidence.
14532 @item prediction-num
14533 Plain-old numeric value.
14535 @item confidence-plus-minus
14536 Prediction +/- confidence.
14541 @node GroupLens Variables
14542 @subsection GroupLens Variables
14546 @item gnus-summary-grouplens-line-format
14547 The summary line format used in GroupLens-enhanced summary buffers. It
14548 accepts the same specs as the normal summary line format (@pxref{Summary
14549 Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
14552 @item grouplens-bbb-host
14553 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
14556 @item grouplens-bbb-port
14557 Port of the host running the bbbd server. The default is 9000.
14559 @item grouplens-score-offset
14560 Offset the prediction by this value. In other words, subtract the
14561 prediction value by this number to arrive at the effective score. The
14564 @item grouplens-score-scale-factor
14565 This variable allows the user to magnify the effect of GroupLens scores.
14566 The scale factor is applied after the offset. The default is 1.
14571 @node Advanced Scoring
14572 @section Advanced Scoring
14574 Scoring on Subjects and From headers is nice enough, but what if you're
14575 really interested in what a person has to say only when she's talking
14576 about a particular subject? Or what if you really don't want to
14577 read what person A has to say when she's following up to person B, but
14578 want to read what she says when she's following up to person C?
14580 By using advanced scoring rules you may create arbitrarily complex
14584 * Advanced Scoring Syntax:: A definition.
14585 * Advanced Scoring Examples:: What they look like.
14586 * Advanced Scoring Tips:: Getting the most out of it.
14590 @node Advanced Scoring Syntax
14591 @subsection Advanced Scoring Syntax
14593 Ordinary scoring rules have a string as the first element in the rule.
14594 Advanced scoring rules have a list as the first element. The second
14595 element is the score to be applied if the first element evaluated to a
14596 non-@code{nil} value.
14598 These lists may consist of three logical operators, one redirection
14599 operator, and various match operators.
14606 This logical operator will evaluate each of its arguments until it finds
14607 one that evaluates to @code{false}, and then it'll stop. If all arguments
14608 evaluate to @code{true} values, then this operator will return
14613 This logical operator will evaluate each of its arguments until it finds
14614 one that evaluates to @code{true}. If no arguments are @code{true},
14615 then this operator will return @code{false}.
14620 This logical operator only takes a single argument. It returns the
14621 logical negation of the value of its argument.
14625 There is an @dfn{indirection operator} that will make its arguments
14626 apply to the ancestors of the current article being scored. For
14627 instance, @code{1-} will make score rules apply to the parent of the
14628 current article. @code{2-} will make score rules apply to the
14629 grandparent of the current article. Alternatively, you can write
14630 @code{^^}, where the number of @code{^}s (carets) says how far back into
14631 the ancestry you want to go.
14633 Finally, we have the match operators. These are the ones that do the
14634 real work. Match operators are header name strings followed by a match
14635 and a match type. A typical match operator looks like @samp{("from"
14636 "Lars Ingebrigtsen" s)}. The header names are the same as when using
14637 simple scoring, and the match types are also the same.
14640 @node Advanced Scoring Examples
14641 @subsection Advanced Scoring Examples
14643 Let's say you want to increase the score of articles written by Lars
14644 when he's talking about Gnus:
14648 ("from" "Lars Ingebrigtsen")
14649 ("subject" "Gnus"))
14655 When he writes long articles, he sometimes has something nice to say:
14659 ("from" "Lars Ingebrigtsen")
14666 However, when he responds to things written by Reig Eigil Logge, you
14667 really don't want to read what he's written:
14671 ("from" "Lars Ingebrigtsen")
14672 (1- ("from" "Reig Eigir Logge")))
14676 Everybody that follows up Redmondo when he writes about disappearing
14677 socks should have their scores raised, but only when they talk about
14678 white socks. However, when Lars talks about socks, it's usually not
14685 ("from" "redmondo@@.*no" r)
14686 ("body" "disappearing.*socks" t)))
14687 (! ("from" "Lars Ingebrigtsen"))
14688 ("body" "white.*socks"))
14692 The possibilities are endless.
14695 @node Advanced Scoring Tips
14696 @subsection Advanced Scoring Tips
14698 The @code{&} and @code{|} logical operators do short-circuit logic.
14699 That is, they stop processing their arguments when it's clear what the
14700 result of the operation will be. For instance, if one of the arguments
14701 of an @code{&} evaluates to @code{false}, there's no point in evaluating
14702 the rest of the arguments. This means that you should put slow matches
14703 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
14704 @samp{subject}) first.
14706 The indirection arguments (@code{1-} and so on) will make their
14707 arguments work on previous generations of the thread. If you say
14718 Then that means "score on the from header of the grandparent of the
14719 current article". An indirection is quite fast, but it's better to say:
14725 ("subject" "Gnus")))
14732 (1- ("from" "Lars"))
14733 (1- ("subject" "Gnus")))
14738 @section Score Decays
14739 @cindex score decays
14742 You may find that your scores have a tendency to grow without
14743 bounds, especially if you're using adaptive scoring. If scores get too
14744 big, they lose all meaning---they simply max out and it's difficult to
14745 use them in any sensible way.
14747 @vindex gnus-decay-scores
14748 @findex gnus-decay-score
14749 @vindex gnus-decay-score-function
14750 Gnus provides a mechanism for decaying scores to help with this problem.
14751 When score files are loaded and @code{gnus-decay-scores} is
14752 non-@code{nil}, Gnus will run the score files through the decaying
14753 mechanism thereby lowering the scores of all non-permanent score rules.
14754 The decay itself if performed by the @code{gnus-decay-score-function}
14755 function, which is @code{gnus-decay-score} by default. Here's the
14756 definition of that function:
14759 (defun gnus-decay-score (score)
14761 This is done according to `gnus-score-decay-constant'
14762 and `gnus-score-decay-scale'."
14765 (* (if (< score 0) 1 -1)
14767 (max gnus-score-decay-constant
14769 gnus-score-decay-scale)))))))
14772 @vindex gnus-score-decay-scale
14773 @vindex gnus-score-decay-constant
14774 @code{gnus-score-decay-constant} is 3 by default and
14775 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
14779 Scores between -3 and 3 will be set to 0 when this function is called.
14782 Scores with magnitudes between 3 and 60 will be shrunk by 3.
14785 Scores with magnitudes greater than 60 will be shrunk by 5% of the
14789 If you don't like this decay function, write your own. It is called
14790 with the score to be decayed as its only parameter, and it should return
14791 the new score, which should be an integer.
14793 Gnus will try to decay scores once a day. If you haven't run Gnus for
14794 four days, Gnus will decay the scores four times, for instance.
14801 * Process/Prefix:: A convention used by many treatment commands.
14802 * Interactive:: Making Gnus ask you many questions.
14803 * Symbolic Prefixes:: How to supply some Gnus functions with options.
14804 * Formatting Variables:: You can specify what buffers should look like.
14805 * Windows Configuration:: Configuring the Gnus buffer windows.
14806 * Faces and Fonts:: How to change how faces look.
14807 * Compilation:: How to speed Gnus up.
14808 * Mode Lines:: Displaying information in the mode lines.
14809 * Highlighting and Menus:: Making buffers look all nice and cozy.
14810 * Buttons:: Get tendonitis in ten easy steps!
14811 * Daemons:: Gnus can do things behind your back.
14812 * NoCeM:: How to avoid spam and other fatty foods.
14813 * Undo:: Some actions can be undone.
14814 * Moderation:: What to do if you're a moderator.
14815 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
14816 * Fuzzy Matching:: What's the big fuzz?
14817 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
14818 * Various Various:: Things that are really various.
14822 @node Process/Prefix
14823 @section Process/Prefix
14824 @cindex process/prefix convention
14826 Many functions, among them functions for moving, decoding and saving
14827 articles, use what is known as the @dfn{Process/Prefix convention}.
14829 This is a method for figuring out what articles the user wants the
14830 command to be performed on.
14834 If the numeric prefix is N, perform the operation on the next N
14835 articles, starting with the current one. If the numeric prefix is
14836 negative, perform the operation on the previous N articles, starting
14837 with the current one.
14839 @vindex transient-mark-mode
14840 If @code{transient-mark-mode} in non-@code{nil} and the region is
14841 active, all articles in the region will be worked upon.
14843 If there is no numeric prefix, but some articles are marked with the
14844 process mark, perform the operation on the articles marked with
14847 If there is neither a numeric prefix nor any articles marked with the
14848 process mark, just perform the operation on the current article.
14850 Quite simple, really, but it needs to be made clear so that surprises
14853 Commands that react to the process mark will push the current list of
14854 process marked articles onto a stack and will then clear all process
14855 marked articles. You can restore the previous configuration with the
14856 @kbd{M P y} command (@pxref{Setting Process Marks}).
14858 @vindex gnus-summary-goto-unread
14859 One thing that seems to shock & horrify lots of people is that, for
14860 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
14861 Since each @kbd{d} (which marks the current article as read) by default
14862 goes to the next unread article after marking, this means that @kbd{3 d}
14863 will mark the next three unread articles as read, no matter what the
14864 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
14865 @code{nil} for a more straightforward action.
14869 @section Interactive
14870 @cindex interaction
14874 @item gnus-novice-user
14875 @vindex gnus-novice-user
14876 If this variable is non-@code{nil}, you are either a newcomer to the
14877 World of Usenet, or you are very cautious, which is a nice thing to be,
14878 really. You will be given questions of the type ``Are you sure you want
14879 to do this?'' before doing anything dangerous. This is @code{t} by
14882 @item gnus-expert-user
14883 @vindex gnus-expert-user
14884 If this variable is non-@code{nil}, you will seldom be asked any
14885 questions by Gnus. It will simply assume you know what you're doing, no
14886 matter how strange.
14888 @item gnus-interactive-catchup
14889 @vindex gnus-interactive-catchup
14890 Require confirmation before catching up a group if non-@code{nil}. It
14891 is @code{t} by default.
14893 @item gnus-interactive-exit
14894 @vindex gnus-interactive-exit
14895 Require confirmation before exiting Gnus. This variable is @code{t} by
14900 @node Symbolic Prefixes
14901 @section Symbolic Prefixes
14902 @cindex symbolic prefixes
14904 Quite a lot of Emacs commands react to the (numeric) prefix. For
14905 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
14906 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
14907 rule of 900 to the current article.
14909 This is all nice and well, but what if you want to give a command some
14910 additional information? Well, what most commands do is interpret the
14911 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
14912 doesn't want a backup file to be created when saving the current buffer,
14913 for instance. But what if you want to save without making a backup
14914 file, and you want Emacs to flash lights and play a nice tune at the
14915 same time? You can't, and you're probably perfectly happy that way.
14917 @kindex M-i (Summary)
14918 @findex gnus-symbolic-argument
14919 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
14920 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
14921 character typed in is the value. You can stack as many @kbd{M-i}
14922 prefixes as you want. @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
14923 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b M-C-u} means
14924 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
14925 @code{b}''. You get the drift.
14927 Typing in symbolic prefixes to commands that don't accept them doesn't
14928 hurt, but it doesn't do any good either. Currently not many Gnus
14929 functions make use of the symbolic prefix.
14931 If you're interested in how Gnus implements this, @pxref{Extended
14935 @node Formatting Variables
14936 @section Formatting Variables
14937 @cindex formatting variables
14939 Throughout this manual you've probably noticed lots of variables called
14940 things like @code{gnus-group-line-format} and
14941 @code{gnus-summary-mode-line-format}. These control how Gnus is to
14942 output lines in the various buffers. There's quite a lot of them.
14943 Fortunately, they all use the same syntax, so there's not that much to
14946 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
14947 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
14948 lots of percentages everywhere.
14951 * Formatting Basics:: A formatting variable is basically a format string.
14952 * Mode Line Formatting:: Some rules about mode line formatting variables.
14953 * Advanced Formatting:: Modifying output in various ways.
14954 * User-Defined Specs:: Having Gnus call your own functions.
14955 * Formatting Fonts:: Making the formatting look colorful and nice.
14958 Currently Gnus uses the following formatting variables:
14959 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
14960 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
14961 @code{gnus-group-mode-line-format},
14962 @code{gnus-summary-mode-line-format},
14963 @code{gnus-article-mode-line-format},
14964 @code{gnus-server-mode-line-format}, and
14965 @code{gnus-summary-pick-line-format}.
14967 All these format variables can also be arbitrary elisp forms. In that
14968 case, they will be @code{eval}ed to insert the required lines.
14970 @kindex M-x gnus-update-format
14971 @findex gnus-update-format
14972 Gnus includes a command to help you while creating your own format
14973 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
14974 update the spec in question and pop you to a buffer where you can
14975 examine the resulting lisp code to be run to generate the line.
14979 @node Formatting Basics
14980 @subsection Formatting Basics
14982 Each @samp{%} element will be replaced by some string or other when the
14983 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
14984 spec, and pad with spaces to get a 5-character field''.
14986 As with normal C and Emacs Lisp formatting strings, the numerical
14987 modifier between the @samp{%} and the formatting type character will
14988 @dfn{pad} the output so that it is always at least that long.
14989 @samp{%5y} will make the field always (at least) five characters wide by
14990 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
14993 You may also wish to limit the length of the field to protect against
14994 particularly wide values. For that you can say @samp{%4,6y}, which
14995 means that the field will never be more than 6 characters wide and never
14996 less than 4 characters wide.
14999 @node Mode Line Formatting
15000 @subsection Mode Line Formatting
15002 Mode line formatting variables (e.g.,
15003 @code{gnus-summary-mode-line-format}) follow the same rules as other,
15004 buffer line oriented formatting variables (@pxref{Formatting Basics})
15005 with the following two differences:
15010 There must be no newline (@samp{\n}) at the end.
15013 The special @samp{%%b} spec can be used to display the buffer name.
15014 Well, it's no spec at all, really---@samp{%%} is just a way to quote
15015 @samp{%} to allow it to pass through the formatting machinery unmangled,
15016 so that Emacs receives @samp{%b}, which is something the Emacs mode line
15017 display interprets to mean ``show the buffer name''. For a full list of
15018 mode line specs Emacs understands, see the documentation of the
15019 @code{mode-line-format} variable.
15024 @node Advanced Formatting
15025 @subsection Advanced Formatting
15027 It is frequently useful to post-process the fields in some way.
15028 Padding, limiting, cutting off parts and suppressing certain values can
15029 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
15030 look like @samp{%~(cut 3)~(ignore "0")y}.
15032 These are the valid modifiers:
15037 Pad the field to the left with spaces until it reaches the required
15041 Pad the field to the right with spaces until it reaches the required
15046 Cut off characters from the left until it reaches the specified length.
15049 Cut off characters from the right until it reaches the specified
15054 Cut off the specified number of characters from the left.
15057 Cut off the specified number of characters from the right.
15060 Return an empty string if the field is equal to the specified value.
15063 Use the specified form as the field value when the @samp{@@} spec is
15067 Let's take an example. The @samp{%o} spec in the summary mode lines
15068 will return a date in compact ISO8601 format---@samp{19960809T230410}.
15069 This is quite a mouthful, so we want to shave off the century number and
15070 the time, leaving us with a six-character date. That would be
15071 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
15072 maxing, and we need the padding to ensure that the date is never less
15073 than 6 characters to make it look nice in columns.)
15075 Ignoring is done first; then cutting; then maxing; and then as the very
15076 last operation, padding.
15078 If you use lots of these advanced thingies, you'll find that Gnus gets
15079 quite slow. This can be helped enormously by running @kbd{M-x
15080 gnus-compile} when you are satisfied with the look of your lines.
15081 @xref{Compilation}.
15084 @node User-Defined Specs
15085 @subsection User-Defined Specs
15087 All the specs allow for inserting user defined specifiers---@samp{u}.
15088 The next character in the format string should be a letter. Gnus
15089 will call the function @code{gnus-user-format-function-}@samp{X}, where
15090 @samp{X} is the letter following @samp{%u}. The function will be passed
15091 a single parameter---what the parameter means depends on what buffer
15092 it's being called from. The function should return a string, which will
15093 be inserted into the buffer just like information from any other
15094 specifier. This function may also be called with dummy values, so it
15095 should protect against that.
15097 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
15098 much the same without defining new functions. Here's an example:
15099 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
15100 given here will be evaluated to yield the current line number, and then
15104 @node Formatting Fonts
15105 @subsection Formatting Fonts
15107 There are specs for highlighting, and these are shared by all the format
15108 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
15109 the special @code{mouse-face} property set, which means that it will be
15110 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
15113 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
15114 normal faces set using @code{gnus-face-0}, which is @code{bold} by
15115 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
15116 and so on. Create as many faces as you wish. The same goes for the
15117 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
15118 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
15120 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
15121 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you say
15122 @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
15123 @code{gnus-balloon-face-*} variables should be either strings or
15124 symbols naming functions that return a string. Under @code{balloon-help-mode},
15125 when the mouse passes over text with this property set, a balloon window
15126 will appear and display the string. Please refer to the doc string of
15127 @code{balloon-help-mode} for more information on this.
15129 Here's an alternative recipe for the group buffer:
15132 ;; Create three face types.
15133 (setq gnus-face-1 'bold)
15134 (setq gnus-face-3 'italic)
15136 ;; We want the article count to be in
15137 ;; a bold and green face. So we create
15138 ;; a new face called `my-green-bold'.
15139 (copy-face 'bold 'my-green-bold)
15141 (set-face-foreground 'my-green-bold "ForestGreen")
15142 (setq gnus-face-2 'my-green-bold)
15144 ;; Set the new & fancy format.
15145 (setq gnus-group-line-format
15146 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
15149 I'm sure you'll be able to use this scheme to create totally unreadable
15150 and extremely vulgar displays. Have fun!
15152 Note that the @samp{%(} specs (and friends) do not make any sense on the
15153 mode-line variables.
15156 @node Windows Configuration
15157 @section Windows Configuration
15158 @cindex windows configuration
15160 No, there's nothing here about X, so be quiet.
15162 @vindex gnus-use-full-window
15163 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
15164 other windows and occupy the entire Emacs screen by itself. It is
15165 @code{t} by default.
15167 Setting this variable to @code{nil} kinda works, but there are
15168 glitches. Use at your own peril.
15170 @vindex gnus-buffer-configuration
15171 @code{gnus-buffer-configuration} describes how much space each Gnus
15172 buffer should be given. Here's an excerpt of this variable:
15175 ((group (vertical 1.0 (group 1.0 point)
15176 (if gnus-carpal (group-carpal 4))))
15177 (article (vertical 1.0 (summary 0.25 point)
15181 This is an alist. The @dfn{key} is a symbol that names some action or
15182 other. For instance, when displaying the group buffer, the window
15183 configuration function will use @code{group} as the key. A full list of
15184 possible names is listed below.
15186 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
15187 should occupy. To take the @code{article} split as an example -
15190 (article (vertical 1.0 (summary 0.25 point)
15194 This @dfn{split} says that the summary buffer should occupy 25% of upper
15195 half of the screen, and that it is placed over the article buffer. As
15196 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
15197 reaching for that calculator there). However, the special number
15198 @code{1.0} is used to signal that this buffer should soak up all the
15199 rest of the space available after the rest of the buffers have taken
15200 whatever they need. There should be only one buffer with the @code{1.0}
15201 size spec per split.
15203 Point will be put in the buffer that has the optional third element
15204 @code{point}. In a @code{frame} split, the last subsplit having a leaf
15205 split where the tag @code{frame-focus} is a member (i.e. is the third or
15206 fourth element in the list, depending on whether the @code{point} tag is
15207 present) gets focus.
15209 Here's a more complicated example:
15212 (article (vertical 1.0 (group 4)
15213 (summary 0.25 point)
15214 (if gnus-carpal (summary-carpal 4))
15218 If the size spec is an integer instead of a floating point number,
15219 then that number will be used to say how many lines a buffer should
15220 occupy, not a percentage.
15222 If the @dfn{split} looks like something that can be @code{eval}ed (to be
15223 precise---if the @code{car} of the split is a function or a subr), this
15224 split will be @code{eval}ed. If the result is non-@code{nil}, it will
15225 be used as a split. This means that there will be three buffers if
15226 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
15229 Not complicated enough for you? Well, try this on for size:
15232 (article (horizontal 1.0
15237 (summary 0.25 point)
15242 Whoops. Two buffers with the mystery 100% tag. And what's that
15243 @code{horizontal} thingie?
15245 If the first element in one of the split is @code{horizontal}, Gnus will
15246 split the window horizontally, giving you two windows side-by-side.
15247 Inside each of these strips you may carry on all you like in the normal
15248 fashion. The number following @code{horizontal} says what percentage of
15249 the screen is to be given to this strip.
15251 For each split, there @emph{must} be one element that has the 100% tag.
15252 The splitting is never accurate, and this buffer will eat any leftover
15253 lines from the splits.
15255 To be slightly more formal, here's a definition of what a valid split
15259 split = frame | horizontal | vertical | buffer | form
15260 frame = "(frame " size *split ")"
15261 horizontal = "(horizontal " size *split ")"
15262 vertical = "(vertical " size *split ")"
15263 buffer = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
15264 size = number | frame-params
15265 buffer-name = group | article | summary ...
15268 The limitations are that the @code{frame} split can only appear as the
15269 top-level split. @var{form} should be an Emacs Lisp form that should
15270 return a valid split. We see that each split is fully recursive, and
15271 may contain any number of @code{vertical} and @code{horizontal} splits.
15273 @vindex gnus-window-min-width
15274 @vindex gnus-window-min-height
15275 @cindex window height
15276 @cindex window width
15277 Finding the right sizes can be a bit complicated. No window may be less
15278 than @code{gnus-window-min-height} (default 1) characters high, and all
15279 windows must be at least @code{gnus-window-min-width} (default 1)
15280 characters wide. Gnus will try to enforce this before applying the
15281 splits. If you want to use the normal Emacs window width/height limit,
15282 you can just set these two variables to @code{nil}.
15284 If you're not familiar with Emacs terminology, @code{horizontal} and
15285 @code{vertical} splits may work the opposite way of what you'd expect.
15286 Windows inside a @code{horizontal} split are shown side-by-side, and
15287 windows within a @code{vertical} split are shown above each other.
15289 @findex gnus-configure-frame
15290 If you want to experiment with window placement, a good tip is to call
15291 @code{gnus-configure-frame} directly with a split. This is the function
15292 that does all the real work when splitting buffers. Below is a pretty
15293 nonsensical configuration with 5 windows; two for the group buffer and
15294 three for the article buffer. (I said it was nonsensical.) If you
15295 @code{eval} the statement below, you can get an idea of how that would
15296 look straight away, without going through the normal Gnus channels.
15297 Play with it until you're satisfied, and then use
15298 @code{gnus-add-configuration} to add your new creation to the buffer
15299 configuration list.
15302 (gnus-configure-frame
15306 (article 0.3 point))
15314 You might want to have several frames as well. No prob---just use the
15315 @code{frame} split:
15318 (gnus-configure-frame
15321 (summary 0.25 point frame-focus)
15323 (vertical ((height . 5) (width . 15)
15324 (user-position . t)
15325 (left . -1) (top . 1))
15330 This split will result in the familiar summary/article window
15331 configuration in the first (or ``main'') frame, while a small additional
15332 frame will be created where picons will be shown. As you can see,
15333 instead of the normal @code{1.0} top-level spec, each additional split
15334 should have a frame parameter alist as the size spec.
15335 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
15336 Reference Manual}. Under XEmacs, a frame property list will be
15337 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
15339 The list of all possible keys for @code{gnus-buffer-configuration} can
15340 be found in its default value.
15342 Note that the @code{message} key is used for both
15343 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
15344 it is desirable to distinguish between the two, something like this
15348 (message (horizontal 1.0
15349 (vertical 1.0 (message 1.0 point))
15351 (if (buffer-live-p gnus-summary-buffer)
15356 One common desire for a multiple frame split is to have a separate frame
15357 for composing mail and news while leaving the original frame intact. To
15358 accomplish that, something like the following can be done:
15361 (message (frame 1.0
15362 (if (not (buffer-live-p gnus-summary-buffer))
15363 (car (cdr (assoc 'group gnus-buffer-configuration)))
15364 (car (cdr (assoc 'summary gnus-buffer-configuration))))
15365 (vertical ((user-position . t) (top . 1) (left . 1)
15366 (name . "Message"))
15367 (message 1.0 point))))
15370 @findex gnus-add-configuration
15371 Since the @code{gnus-buffer-configuration} variable is so long and
15372 complicated, there's a function you can use to ease changing the config
15373 of a single setting: @code{gnus-add-configuration}. If, for instance,
15374 you want to change the @code{article} setting, you could say:
15377 (gnus-add-configuration
15378 '(article (vertical 1.0
15380 (summary .25 point)
15384 You'd typically stick these @code{gnus-add-configuration} calls in your
15385 @file{.gnus.el} file or in some startup hook---they should be run after
15386 Gnus has been loaded.
15388 @vindex gnus-always-force-window-configuration
15389 If all windows mentioned in the configuration are already visible, Gnus
15390 won't change the window configuration. If you always want to force the
15391 ``right'' window configuration, you can set
15392 @code{gnus-always-force-window-configuration} to non-@code{nil}.
15394 If you're using tree displays (@pxref{Tree Display}), and the tree
15395 window is displayed vertically next to another window, you may also want
15396 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
15400 @node Faces and Fonts
15401 @section Faces and Fonts
15406 Fiddling with fonts and faces used to be very difficult, but these days
15407 it is very simple. You simply say @kbd{M-x customize-face}, pick out
15408 the face you want to alter, and alter it via the standard Customize
15413 @section Compilation
15414 @cindex compilation
15415 @cindex byte-compilation
15417 @findex gnus-compile
15419 Remember all those line format specification variables?
15420 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
15421 on. Now, Gnus will of course heed whatever these variables are, but,
15422 unfortunately, changing them will mean a quite significant slow-down.
15423 (The default values of these variables have byte-compiled functions
15424 associated with them, while the user-generated versions do not, of
15427 To help with this, you can run @kbd{M-x gnus-compile} after you've
15428 fiddled around with the variables and feel that you're (kind of)
15429 satisfied. This will result in the new specs being byte-compiled, and
15430 you'll get top speed again. Gnus will save these compiled specs in the
15431 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
15432 this function, though---you should compile them yourself by sticking
15433 them into the @code{.gnus.el} file and byte-compiling that file.)
15437 @section Mode Lines
15440 @vindex gnus-updated-mode-lines
15441 @code{gnus-updated-mode-lines} says what buffers should keep their mode
15442 lines updated. It is a list of symbols. Supported symbols include
15443 @code{group}, @code{article}, @code{summary}, @code{server},
15444 @code{browse}, and @code{tree}. If the corresponding symbol is present,
15445 Gnus will keep that mode line updated with information that may be
15446 pertinent. If this variable is @code{nil}, screen refresh may be
15449 @cindex display-time
15451 @vindex gnus-mode-non-string-length
15452 By default, Gnus displays information on the current article in the mode
15453 lines of the summary and article buffers. The information Gnus wishes
15454 to display (e.g. the subject of the article) is often longer than the
15455 mode lines, and therefore have to be cut off at some point. The
15456 @code{gnus-mode-non-string-length} variable says how long the other
15457 elements on the line is (i.e., the non-info part). If you put
15458 additional elements on the mode line (e.g. a clock), you should modify
15461 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
15463 (add-hook 'display-time-hook
15464 (lambda () (setq gnus-mode-non-string-length
15466 (if line-number-mode 5 0)
15467 (if column-number-mode 4 0)
15468 (length display-time-string)))))
15471 If this variable is @code{nil} (which is the default), the mode line
15472 strings won't be chopped off, and they won't be padded either. Note
15473 that the default is unlikely to be desirable, as even the percentage
15474 complete in the buffer may be crowded off the mode line; the user should
15475 configure this variable appropriately for her configuration.
15478 @node Highlighting and Menus
15479 @section Highlighting and Menus
15481 @cindex highlighting
15484 @vindex gnus-visual
15485 The @code{gnus-visual} variable controls most of the Gnus-prettifying
15486 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
15487 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
15490 This variable can be a list of visual properties that are enabled. The
15491 following elements are valid, and are all included by default:
15494 @item group-highlight
15495 Do highlights in the group buffer.
15496 @item summary-highlight
15497 Do highlights in the summary buffer.
15498 @item article-highlight
15499 Do highlights in the article buffer.
15501 Turn on highlighting in all buffers.
15503 Create menus in the group buffer.
15505 Create menus in the summary buffers.
15507 Create menus in the article buffer.
15509 Create menus in the browse buffer.
15511 Create menus in the server buffer.
15513 Create menus in the score buffers.
15515 Create menus in all buffers.
15518 So if you only want highlighting in the article buffer and menus in all
15519 buffers, you could say something like:
15522 (setq gnus-visual '(article-highlight menu))
15525 If you want highlighting only and no menus whatsoever, you'd say:
15528 (setq gnus-visual '(highlight))
15531 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
15532 in all Gnus buffers.
15534 Other general variables that influence the look of all buffers include:
15537 @item gnus-mouse-face
15538 @vindex gnus-mouse-face
15539 This is the face (i.e., font) used for mouse highlighting in Gnus. No
15540 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
15544 There are hooks associated with the creation of all the different menus:
15548 @item gnus-article-menu-hook
15549 @vindex gnus-article-menu-hook
15550 Hook called after creating the article mode menu.
15552 @item gnus-group-menu-hook
15553 @vindex gnus-group-menu-hook
15554 Hook called after creating the group mode menu.
15556 @item gnus-summary-menu-hook
15557 @vindex gnus-summary-menu-hook
15558 Hook called after creating the summary mode menu.
15560 @item gnus-server-menu-hook
15561 @vindex gnus-server-menu-hook
15562 Hook called after creating the server mode menu.
15564 @item gnus-browse-menu-hook
15565 @vindex gnus-browse-menu-hook
15566 Hook called after creating the browse mode menu.
15568 @item gnus-score-menu-hook
15569 @vindex gnus-score-menu-hook
15570 Hook called after creating the score mode menu.
15581 Those new-fangled @dfn{mouse} contraptions is very popular with the
15582 young, hep kids who don't want to learn the proper way to do things
15583 these days. Why, I remember way back in the summer of '89, when I was
15584 using Emacs on a Tops 20 system. Three hundred users on one single
15585 machine, and every user was running Simula compilers. Bah!
15589 @vindex gnus-carpal
15590 Well, you can make Gnus display bufferfuls of buttons you can click to
15591 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
15592 really. Tell the chiropractor I sent you.
15597 @item gnus-carpal-mode-hook
15598 @vindex gnus-carpal-mode-hook
15599 Hook run in all carpal mode buffers.
15601 @item gnus-carpal-button-face
15602 @vindex gnus-carpal-button-face
15603 Face used on buttons.
15605 @item gnus-carpal-header-face
15606 @vindex gnus-carpal-header-face
15607 Face used on carpal buffer headers.
15609 @item gnus-carpal-group-buffer-buttons
15610 @vindex gnus-carpal-group-buffer-buttons
15611 Buttons in the group buffer.
15613 @item gnus-carpal-summary-buffer-buttons
15614 @vindex gnus-carpal-summary-buffer-buttons
15615 Buttons in the summary buffer.
15617 @item gnus-carpal-server-buffer-buttons
15618 @vindex gnus-carpal-server-buffer-buttons
15619 Buttons in the server buffer.
15621 @item gnus-carpal-browse-buffer-buttons
15622 @vindex gnus-carpal-browse-buffer-buttons
15623 Buttons in the browse buffer.
15626 All the @code{buttons} variables are lists. The elements in these list
15627 are either cons cells where the @code{car} contains a text to be displayed and
15628 the @code{cdr} contains a function symbol, or a simple string.
15636 Gnus, being larger than any program ever written (allegedly), does lots
15637 of strange stuff that you may wish to have done while you're not
15638 present. For instance, you may want it to check for new mail once in a
15639 while. Or you may want it to close down all connections to all servers
15640 when you leave Emacs idle. And stuff like that.
15642 Gnus will let you do stuff like that by defining various
15643 @dfn{handlers}. Each handler consists of three elements: A
15644 @var{function}, a @var{time}, and an @var{idle} parameter.
15646 Here's an example of a handler that closes connections when Emacs has
15647 been idle for thirty minutes:
15650 (gnus-demon-close-connections nil 30)
15653 Here's a handler that scans for PGP headers every hour when Emacs is
15657 (gnus-demon-scan-pgp 60 t)
15660 This @var{time} parameter and than @var{idle} parameter work together
15661 in a strange, but wonderful fashion. Basically, if @var{idle} is
15662 @code{nil}, then the function will be called every @var{time} minutes.
15664 If @var{idle} is @code{t}, then the function will be called after
15665 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
15666 the function will never be called. But once Emacs goes idle, the
15667 function will be called every @var{time} minutes.
15669 If @var{idle} is a number and @var{time} is a number, the function will
15670 be called every @var{time} minutes only when Emacs has been idle for
15671 @var{idle} minutes.
15673 If @var{idle} is a number and @var{time} is @code{nil}, the function
15674 will be called once every time Emacs has been idle for @var{idle}
15677 And if @var{time} is a string, it should look like @samp{07:31}, and
15678 the function will then be called once every day somewhere near that
15679 time. Modified by the @var{idle} parameter, of course.
15681 @vindex gnus-demon-timestep
15682 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
15683 seconds. This is 60 by default. If you change that variable,
15684 all the timings in the handlers will be affected.)
15686 So, if you want to add a handler, you could put something like this in
15687 your @file{.gnus} file:
15689 @findex gnus-demon-add-handler
15691 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
15694 @findex gnus-demon-add-nocem
15695 @findex gnus-demon-add-scanmail
15696 @findex gnus-demon-add-rescan
15697 @findex gnus-demon-add-scan-timestamps
15698 @findex gnus-demon-add-disconnection
15699 Some ready-made functions to do this have been created:
15700 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
15701 @code{gnus-demon-add-nntp-close-connection},
15702 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
15703 @code{gnus-demon-add-scanmail}. Just put those functions in your
15704 @file{.gnus} if you want those abilities.
15706 @findex gnus-demon-init
15707 @findex gnus-demon-cancel
15708 @vindex gnus-demon-handlers
15709 If you add handlers to @code{gnus-demon-handlers} directly, you should
15710 run @code{gnus-demon-init} to make the changes take hold. To cancel all
15711 daemons, you can use the @code{gnus-demon-cancel} function.
15713 Note that adding daemons can be pretty naughty if you over do it. Adding
15714 functions that scan all news and mail from all servers every two seconds
15715 is a sure-fire way of getting booted off any respectable system. So
15724 @dfn{Spamming} is posting the same article lots and lots of times.
15725 Spamming is bad. Spamming is evil.
15727 Spamming is usually canceled within a day or so by various anti-spamming
15728 agencies. These agencies usually also send out @dfn{NoCeM} messages.
15729 NoCeM is pronounced ``no see-'em'', and means what the name
15730 implies---these are messages that make the offending articles, like, go
15733 What use are these NoCeM messages if the articles are canceled anyway?
15734 Some sites do not honor cancel messages and some sites just honor cancels
15735 from a select few people. Then you may wish to make use of the NoCeM
15736 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
15738 Gnus can read and parse the messages in this group automatically, and
15739 this will make spam disappear.
15741 There are some variables to customize, of course:
15744 @item gnus-use-nocem
15745 @vindex gnus-use-nocem
15746 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
15749 @item gnus-nocem-groups
15750 @vindex gnus-nocem-groups
15751 Gnus will look for NoCeM messages in the groups in this list. The
15752 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
15753 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
15755 @item gnus-nocem-issuers
15756 @vindex gnus-nocem-issuers
15757 There are many people issuing NoCeM messages. This list says what
15758 people you want to listen to. The default is @code{("Automoose-1"
15759 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
15760 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
15761 (Richard E. Depew)")}; fine, upstanding citizens all of them.
15763 Known despammers that you can put in this list include:
15766 @item clewis@@ferret.ocunix.on.ca;
15767 @cindex Chris Lewis
15768 Chris Lewis---Major Canadian despammer who has probably canceled more
15769 usenet abuse than anybody else.
15772 @cindex CancelMoose[tm]
15773 The CancelMoose[tm] on autopilot. The CancelMoose[tm] is reputed to be
15774 Norwegian, and was the person(s) who invented NoCeM.
15776 @item jem@@xpat.com;
15778 John Milburn---despammer located in Korea who is getting very busy these
15781 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
15782 Richard E. Depew---lone American despammer. He mostly cancels binary
15783 postings to non-binary groups and removes spews (regurgitated articles).
15786 You do not have to heed NoCeM messages from all these people---just the
15787 ones you want to listen to. You also don't have to accept all NoCeM
15788 messages from the people you like. Each NoCeM message has a @dfn{type}
15789 header that gives the message a (more or less, usually less) rigorous
15790 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
15791 @samp{binary}, and @samp{troll}. To specify this, you have to use
15792 @var{(issuer conditions ...)} elements in the list. Each condition is
15793 either a string (which is a regexp that matches types you want to use)
15794 or a list on the form @code{(not STRING)}, where @var{string} is a
15795 regexp that matches types you don't want to use.
15797 For instance, if you want all NoCeM messages from Chris Lewis except his
15798 @samp{troll} messages, you'd say:
15801 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
15804 On the other hand, if you just want nothing but his @samp{spam} and
15805 @samp{spew} messages, you'd say:
15808 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
15811 The specs are applied left-to-right.
15814 @item gnus-nocem-verifyer
15815 @vindex gnus-nocem-verifyer
15817 This should be a function for verifying that the NoCeM issuer is who she
15818 says she is. The default is @code{mc-verify}, which is a Mailcrypt
15819 function. If this is too slow and you don't care for verification
15820 (which may be dangerous), you can set this variable to @code{nil}.
15822 If you want signed NoCeM messages to be verified and unsigned messages
15823 not to be verified (but used anyway), you could do something like:
15826 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
15828 (defun my-gnus-mc-verify ()
15836 This might be dangerous, though.
15838 @item gnus-nocem-directory
15839 @vindex gnus-nocem-directory
15840 This is where Gnus will store its NoCeM cache files. The default is
15841 @file{~/News/NoCeM/}.
15843 @item gnus-nocem-expiry-wait
15844 @vindex gnus-nocem-expiry-wait
15845 The number of days before removing old NoCeM entries from the cache.
15846 The default is 15. If you make it shorter Gnus will be faster, but you
15847 might then see old spam.
15851 Using NoCeM could potentially be a memory hog. If you have many living
15852 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
15853 big. If this is a problem, you should kill off all (or most) of your
15854 unsubscribed groups (@pxref{Subscription Commands}).
15861 It is very useful to be able to undo actions one has done. In normal
15862 Emacs buffers, it's easy enough---you just push the @code{undo} button.
15863 In Gnus buffers, however, it isn't that simple.
15865 The things Gnus displays in its buffer is of no value whatsoever to
15866 Gnus---it's all just data designed to look nice to the user.
15867 Killing a group in the group buffer with @kbd{C-k} makes the line
15868 disappear, but that's just a side-effect of the real action---the
15869 removal of the group in question from the internal Gnus structures.
15870 Undoing something like that can't be done by the normal Emacs
15871 @code{undo} function.
15873 Gnus tries to remedy this somewhat by keeping track of what the user
15874 does and coming up with actions that would reverse the actions the user
15875 takes. When the user then presses the @code{undo} key, Gnus will run
15876 the code to reverse the previous action, or the previous actions.
15877 However, not all actions are easily reversible, so Gnus currently offers
15878 a few key functions to be undoable. These include killing groups,
15879 yanking groups, and changing the list of read articles of groups.
15880 That's it, really. More functions may be added in the future, but each
15881 added function means an increase in data to be stored, so Gnus will
15882 never be totally undoable.
15884 @findex gnus-undo-mode
15885 @vindex gnus-use-undo
15887 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
15888 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
15889 default. The @kbd{M-C-_} key performs the @code{gnus-undo} command
15890 command, which should feel kinda like the normal Emacs @code{undo}
15895 @section Moderation
15898 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
15899 It is not included in the standard Gnus package. Write a mail to
15900 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
15903 The moderation package is implemented as a minor mode for summary
15907 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
15910 in your @file{.gnus.el} file.
15912 If you are the moderator of @samp{rec.zoofle}, this is how it's
15917 You split your incoming mail by matching on
15918 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
15919 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
15922 You enter that group once in a while and post articles using the @kbd{e}
15923 (edit-and-post) or @kbd{s} (just send unedited) commands.
15926 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
15927 articles that weren't approved by you, you can cancel them with the
15931 To use moderation mode in these two groups, say:
15934 (setq gnus-moderated-list
15935 "^nnml:rec.zoofle$\\|^rec.zoofle$")
15939 @node XEmacs Enhancements
15940 @section XEmacs Enhancements
15943 XEmacs is able to display pictures and stuff, so Gnus has taken
15947 * Picons:: How to display pictures of what your reading.
15948 * Smileys:: Show all those happy faces the way they were meant to be shown.
15949 * Toolbar:: Click'n'drool.
15950 * XVarious:: Other XEmacsy Gnusey variables.
15963 So... You want to slow down your news reader even more! This is a
15964 good way to do so. Its also a great way to impress people staring
15965 over your shoulder as you read news.
15968 * Picon Basics:: What are picons and How do I get them.
15969 * Picon Requirements:: Don't go further if you aren't using XEmacs.
15970 * Easy Picons:: Displaying Picons---the easy way.
15971 * Hard Picons:: The way you should do it. You'll learn something.
15972 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
15977 @subsubsection Picon Basics
15979 What are Picons? To quote directly from the Picons Web site:
15988 @dfn{Picons} is short for ``personal icons''. They're small,
15989 constrained images used to represent users and domains on the net,
15990 organized into databases so that the appropriate image for a given
15991 e-mail address can be found. Besides users and domains, there are picon
15992 databases for Usenet newsgroups and weather forecasts. The picons are
15993 in either monochrome @code{XBM} format or color @code{XPM} and
15994 @code{GIF} formats.
15997 @vindex gnus-picons-piconsearch-url
15998 If you have a permanent connection to the Internet you can use Steve
15999 Kinzler's Picons Search engine by setting
16000 @code{gnus-picons-piconsearch-url} to the string @*
16001 @file{http://www.cs.indiana.edu/picons/search.html}.
16003 @vindex gnus-picons-database
16004 Otherwise you need a local copy of his database. For instructions on
16005 obtaining and installing the picons databases, point your Web browser at @*
16006 @file{http://www.cs.indiana.edu/picons/ftp/index.html}. Gnus expects
16007 picons to be installed into a location pointed to by
16008 @code{gnus-picons-database}.
16011 @node Picon Requirements
16012 @subsubsection Picon Requirements
16014 To have Gnus display Picons for you, you must be running XEmacs
16015 19.13 or greater since all other versions of Emacs aren't yet able to
16018 Additionally, you must have @code{x} support compiled into XEmacs. To
16019 display color picons which are much nicer than the black & white one,
16020 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
16022 @vindex gnus-picons-convert-x-face
16023 If you want to display faces from @code{X-Face} headers, you should have
16024 the @code{xface} support compiled into XEmacs. Otherwise you must have
16025 the @code{netpbm} utilities installed, or munge the
16026 @code{gnus-picons-convert-x-face} variable to use something else.
16030 @subsubsection Easy Picons
16032 To enable displaying picons, simply put the following line in your
16033 @file{~/.gnus} file and start Gnus.
16036 (setq gnus-use-picons t)
16037 (setq gnus-treat-display-picons t)
16040 and make sure @code{gnus-picons-database} points to the directory
16041 containing the Picons databases.
16043 Alternatively if you want to use the web piconsearch engine add this:
16046 (setq gnus-picons-piconsearch-url
16047 "http://www.cs.indiana.edu:800/piconsearch")
16052 @subsubsection Hard Picons
16060 Gnus can display picons for you as you enter and leave groups and
16061 articles. It knows how to interact with three sections of the picons
16062 database. Namely, it can display the picons newsgroup pictures,
16063 author's face picture(s), and the authors domain. To enable this
16064 feature, you need to select where to get the picons from, and where to
16069 @item gnus-picons-database
16070 @vindex gnus-picons-database
16071 The location of the picons database. Should point to a directory
16072 containing the @file{news}, @file{domains}, @file{users} (and so on)
16073 subdirectories. This is only useful if
16074 @code{gnus-picons-piconsearch-url} is @code{nil}. Defaults to
16075 @file{/usr/local/faces/}.
16077 @item gnus-picons-piconsearch-url
16078 @vindex gnus-picons-piconsearch-url
16079 The URL for the web picons search engine. The only currently known
16080 engine is @file{http://www.cs.indiana.edu:800/piconsearch}. To
16081 workaround network delays, icons will be fetched in the background. If
16082 this is @code{nil} 'the default), then picons are fetched from local
16083 database indicated by @code{gnus-picons-database}.
16085 @item gnus-picons-display-where
16086 @vindex gnus-picons-display-where
16087 Where the picon images should be displayed. It is @code{picons} by
16088 default (which by default maps to the buffer @samp{*Picons*}). Other
16089 valid places could be @code{article}, @code{summary}, or
16090 @samp{*scratch*} for all I care. Just make sure that you've made the
16091 buffer visible using the standard Gnus window configuration
16092 routines---@pxref{Windows Configuration}.
16094 @item gnus-picons-group-excluded-groups
16095 @vindex gnus-picons-group-excluded-groups
16096 Groups that are matched by this regexp won't have their group icons
16101 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
16102 window configuration for you to include the @code{picons} buffer.
16104 Now that you've made those decision, you need to add the following
16105 functions to the appropriate hooks so these pictures will get displayed
16108 @vindex gnus-picons-display-where
16110 @item gnus-article-display-picons
16111 @findex gnus-article-display-picons
16112 Looks up and displays the picons for the author and the author's domain
16113 in the @code{gnus-picons-display-where} buffer.
16115 @item gnus-picons-article-display-x-face
16116 @findex gnus-article-display-picons
16117 Decodes and displays the X-Face header if present.
16123 @node Picon Useless Configuration
16124 @subsubsection Picon Useless Configuration
16132 The following variables offer further control over how things are
16133 done, where things are located, and other useless stuff you really
16134 don't need to worry about.
16138 @item gnus-picons-news-directories
16139 @vindex gnus-picons-news-directories
16140 List of subdirectories to search in @code{gnus-picons-database} for
16141 newsgroups faces. @code{("news")} is the default.
16143 @item gnus-picons-user-directories
16144 @vindex gnus-picons-user-directories
16145 List of subdirectories to search in @code{gnus-picons-database} for user
16146 faces. @code{("local" "users" "usenix" "misc")} is the default.
16148 @item gnus-picons-domain-directories
16149 @vindex gnus-picons-domain-directories
16150 List of subdirectories to search in @code{gnus-picons-database} for
16151 domain name faces. Defaults to @code{("domains")}. Some people may
16152 want to add @samp{"unknown"} to this list.
16154 @item gnus-picons-convert-x-face
16155 @vindex gnus-picons-convert-x-face
16156 If you don't have @code{xface} support builtin XEmacs, this is the
16157 command to use to convert the @code{X-Face} header to an X bitmap
16158 (@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48,
16159 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
16160 gnus-picons-x-face-file-name)}
16162 @item gnus-picons-x-face-file-name
16163 @vindex gnus-picons-x-face-file-name
16164 Names a temporary file to store the @code{X-Face} bitmap in. Defaults
16165 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
16167 @item gnus-picons-has-modeline-p
16168 @vindex gnus-picons-has-modeline-p
16169 If you have set @code{gnus-picons-display-where} to @code{picons}, your
16170 XEmacs frame will become really cluttered. To alleviate this a bit you
16171 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
16172 remove the mode line from the Picons buffer. This is only useful if
16173 @code{gnus-picons-display-where} is @code{picons}.
16175 @item gnus-picons-refresh-before-display
16176 @vindex gnus-picons-refresh-before-display
16177 If non-nil, display the article buffer before computing the picons.
16178 Defaults to @code{nil}.
16180 @item gnus-picons-display-as-address
16181 @vindex gnus-picons-display-as-address
16182 If @code{t} display textual email addresses along with pictures.
16183 Defaults to @code{t}.
16185 @item gnus-picons-file-suffixes
16186 @vindex gnus-picons-file-suffixes
16187 Ordered list of suffixes on picon file names to try. Defaults to
16188 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
16190 @item gnus-picons-setup-hook
16191 @vindex gnus-picons-setup-hook
16192 Hook run in the picon buffer, if that is displayed.
16194 @item gnus-picons-display-article-move-p
16195 @vindex gnus-picons-display-article-move-p
16196 Whether to move point to first empty line when displaying picons. This
16197 has only an effect if `gnus-picons-display-where' has value `article'.
16199 If @code{nil}, display the picons in the @code{From} and
16200 @code{Newsgroups} lines. This is the defailt.
16202 @item gnus-picons-clear-cache-on-shutdown
16203 @vindex gnus-picons-clear-cache-on-shutdown
16204 Whether to clear the picons cache when exiting gnus. Gnus caches every
16205 picons it finds while it is running. This saves some time in the search
16206 process but eats some memory. If this variable is set to @code{nil},
16207 Gnus will never clear the cache itself; you will have to manually call
16208 @code{gnus-picons-clear-cache} to clear it. Otherwise the cache will be
16209 cleared every time you exit Gnus. Defaults to @code{t}.
16220 @subsection Smileys
16225 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
16230 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
16231 currently the only package that uses Smiley, it is documented here.
16233 In short---to use Smiley in Gnus, put the following in your
16234 @file{.gnus.el} file:
16237 (setq gnus-treat-display-smiley t)
16240 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
16241 the like---to pictures and displays those instead of the text smiley
16242 faces. The conversion is controlled by a list of regexps that matches
16243 text and maps that to file names.
16245 @vindex smiley-nosey-regexp-alist
16246 @vindex smiley-deformed-regexp-alist
16247 Smiley supplies two example conversion alists by default:
16248 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
16249 and so on), and @code{smiley-nosey-regexp-alist} (which matches
16250 @samp{:-)}, @samp{:-(} and so on).
16252 The alist used is specified by the @code{smiley-regexp-alist} variable,
16253 which defaults to the value of @code{smiley-deformed-regexp-alist}.
16255 The first item in each element is the regexp to be matched; the second
16256 element is the regexp match group that is to be replaced by the picture;
16257 and the third element is the name of the file to be displayed.
16259 The following variables customize where Smiley will look for these
16260 files, as well as the color to be used and stuff:
16264 @item smiley-data-directory
16265 @vindex smiley-data-directory
16266 Where Smiley will look for smiley faces files.
16268 @item smiley-flesh-color
16269 @vindex smiley-flesh-color
16270 Skin color. The default is @samp{yellow}, which is really racist.
16272 @item smiley-features-color
16273 @vindex smiley-features-color
16274 Color of the features of the face. The default is @samp{black}.
16276 @item smiley-tongue-color
16277 @vindex smiley-tongue-color
16278 Color of the tongue. The default is @samp{red}.
16280 @item smiley-circle-color
16281 @vindex smiley-circle-color
16282 Color of the circle around the face. The default is @samp{black}.
16284 @item smiley-mouse-face
16285 @vindex smiley-mouse-face
16286 Face used for mouse highlighting over the smiley face.
16292 @subsection Toolbar
16302 @item gnus-use-toolbar
16303 @vindex gnus-use-toolbar
16304 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
16305 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
16306 @code{right-toolbar}, or @code{left-toolbar}.
16308 @item gnus-group-toolbar
16309 @vindex gnus-group-toolbar
16310 The toolbar in the group buffer.
16312 @item gnus-summary-toolbar
16313 @vindex gnus-summary-toolbar
16314 The toolbar in the summary buffer.
16316 @item gnus-summary-mail-toolbar
16317 @vindex gnus-summary-mail-toolbar
16318 The toolbar in the summary buffer of mail groups.
16324 @subsection Various XEmacs Variables
16327 @item gnus-xmas-glyph-directory
16328 @vindex gnus-xmas-glyph-directory
16329 This is where Gnus will look for pictures. Gnus will normally
16330 auto-detect this directory, but you may set it manually if you have an
16331 unusual directory structure.
16333 @item gnus-xmas-logo-color-alist
16334 @vindex gnus-xmas-logo-color-alist
16335 This is an alist where the key is a type symbol and the values are the
16336 foreground and background color of the splash page glyph.
16338 @item gnus-xmas-logo-color-style
16339 @vindex gnus-xmas-logo-color-style
16340 This is the key used to look up the color in the alist described above.
16341 Valid values include @code{flame}, @code{pine}, @code{moss},
16342 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
16343 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
16345 @item gnus-xmas-modeline-glyph
16346 @vindex gnus-xmas-modeline-glyph
16347 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
16361 @node Fuzzy Matching
16362 @section Fuzzy Matching
16363 @cindex fuzzy matching
16365 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
16366 things like scoring, thread gathering and thread comparison.
16368 As opposed to regular expression matching, fuzzy matching is very fuzzy.
16369 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
16370 means, and the implementation has changed over time.
16372 Basically, it tries to remove all noise from lines before comparing.
16373 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
16374 out of the strings before comparing the results. This often leads to
16375 adequate results---even when faced with strings generated by text
16376 manglers masquerading as newsreaders.
16379 @node Thwarting Email Spam
16380 @section Thwarting Email Spam
16384 @cindex unsolicited commercial email
16386 In these last days of the Usenet, commercial vultures are hanging about
16387 and grepping through news like crazy to find email addresses they can
16388 foist off their scams and products to. As a reaction to this, many
16389 people have started putting nonsense addresses into their @code{From}
16390 lines. I think this is counterproductive---it makes it difficult for
16391 people to send you legitimate mail in response to things you write, as
16392 well as making it difficult to see who wrote what. This rewriting may
16393 perhaps be a bigger menace than the unsolicited commercial email itself
16396 The biggest problem I have with email spam is that it comes in under
16397 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
16398 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
16399 mail group, only to find two pyramid schemes, seven advertisements
16400 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
16401 and one mail asking me to repent and find some god.
16405 The way to deal with this is having Gnus split out all spam into a
16406 @samp{spam} mail group (@pxref{Splitting Mail}).
16408 First, pick one (1) valid mail address that you can be reached at, and
16409 put it in your @code{From} header of all your news articles. (I've
16410 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
16411 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
16412 sysadm whether your sendmail installation accepts keywords in the local
16413 part of the mail address.)
16416 (setq message-default-news-headers
16417 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
16420 Then put the following split rule in @code{nnmail-split-fancy}
16421 (@pxref{Fancy Mail Splitting}):
16426 (to "larsi@@trym.ifi.uio.no"
16427 (| ("subject" "re:.*" "misc")
16428 ("references" ".*@@.*" "misc")
16434 This says that all mail to this address is suspect, but if it has a
16435 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
16436 header, it's probably ok. All the rest goes to the @samp{spam} group.
16437 (This idea probably comes from Tim Pierce.)
16439 In addition, many mail spammers talk directly to your @code{smtp} server
16440 and do not include your email address explicitly in the @code{To}
16441 header. Why they do this is unknown---perhaps it's to thwart this
16442 thwarting scheme? In any case, this is trivial to deal with---you just
16443 put anything not addressed to you in the @samp{spam} group by ending
16444 your fancy split rule in this way:
16449 (to "larsi" "misc")
16453 In my experience, this will sort virtually everything into the right
16454 group. You still have to check the @samp{spam} group from time to time to
16455 check for legitimate mail, though. If you feel like being a good net
16456 citizen, you can even send off complaints to the proper authorities on
16457 each unsolicited commercial email---at your leisure.
16459 If you are also a lazy net citizen, you will probably prefer complaining
16460 automatically with the @file{gnus-junk.el} package, available FOR FREE
16461 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
16462 Since most e-mail spam is sent automatically, this may reconcile the
16463 cosmic balance somewhat.
16465 This works for me. It allows people an easy way to contact me (they can
16466 just press @kbd{r} in the usual way), and I'm not bothered at all with
16467 spam. It's a win-win situation. Forging @code{From} headers to point
16468 to non-existent domains is yucky, in my opinion.
16471 @node Various Various
16472 @section Various Various
16478 @item gnus-home-directory
16479 All Gnus path variables will be initialized from this variable, which
16480 defaults to @file{~/}.
16482 @item gnus-directory
16483 @vindex gnus-directory
16484 Most Gnus storage path variables will be initialized from this variable,
16485 which defaults to the @samp{SAVEDIR} environment variable, or
16486 @file{~/News/} if that variable isn't set.
16488 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
16489 This means that other directory variables that are initialized from this
16490 variable won't be set properly if you set this variable in
16491 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
16493 @item gnus-default-directory
16494 @vindex gnus-default-directory
16495 Not related to the above variable at all---this variable says what the
16496 default directory of all Gnus buffers should be. If you issue commands
16497 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
16498 default directory. If this variable is @code{nil} (which is the
16499 default), the default directory will be the default directory of the
16500 buffer you were in when you started Gnus.
16503 @vindex gnus-verbose
16504 This variable is an integer between zero and ten. The higher the value,
16505 the more messages will be displayed. If this variable is zero, Gnus
16506 will never flash any messages, if it is seven (which is the default),
16507 most important messages will be shown, and if it is ten, Gnus won't ever
16508 shut up, but will flash so many messages it will make your head swim.
16510 @item gnus-verbose-backends
16511 @vindex gnus-verbose-backends
16512 This variable works the same way as @code{gnus-verbose}, but it applies
16513 to the Gnus backends instead of Gnus proper.
16515 @item nnheader-max-head-length
16516 @vindex nnheader-max-head-length
16517 When the backends read straight heads of articles, they all try to read
16518 as little as possible. This variable (default 4096) specifies
16519 the absolute max length the backends will try to read before giving up
16520 on finding a separator line between the head and the body. If this
16521 variable is @code{nil}, there is no upper read bound. If it is
16522 @code{t}, the backends won't try to read the articles piece by piece,
16523 but read the entire articles. This makes sense with some versions of
16524 @code{ange-ftp} or @code{efs}.
16526 @item nnheader-head-chop-length
16527 @vindex nnheader-head-chop-length
16528 This variable (default 2048) says how big a piece of each article to
16529 read when doing the operation described above.
16531 @item nnheader-file-name-translation-alist
16532 @vindex nnheader-file-name-translation-alist
16534 @cindex invalid characters in file names
16535 @cindex characters in file names
16536 This is an alist that says how to translate characters in file names.
16537 For instance, if @samp{:} is invalid as a file character in file names
16538 on your system (you OS/2 user you), you could say something like:
16541 (setq nnheader-file-name-translation-alist
16545 In fact, this is the default value for this variable on OS/2 and MS
16546 Windows (phooey) systems.
16548 @item gnus-hidden-properties
16549 @vindex gnus-hidden-properties
16550 This is a list of properties to use to hide ``invisible'' text. It is
16551 @code{(invisible t intangible t)} by default on most systems, which
16552 makes invisible text invisible and intangible.
16554 @item gnus-parse-headers-hook
16555 @vindex gnus-parse-headers-hook
16556 A hook called before parsing headers. It can be used, for instance, to
16557 gather statistics on the headers fetched, or perhaps you'd like to prune
16558 some headers. I don't see why you'd want that, though.
16560 @item gnus-shell-command-separator
16561 @vindex gnus-shell-command-separator
16562 String used to separate two shell commands. The default is @samp{;}.
16571 Well, that's the manual---you can get on with your life now. Keep in
16572 touch. Say hello to your cats from me.
16574 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
16576 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
16582 Not because of victories @*
16585 but for the common sunshine,@*
16587 the largess of the spring.
16591 but for the day's work done@*
16592 as well as I was able;@*
16593 not for a seat upon the dais@*
16594 but at the common table.@*
16599 @chapter Appendices
16602 * History:: How Gnus got where it is today.
16603 * Terminology:: We use really difficult, like, words here.
16604 * Customization:: Tailoring Gnus to your needs.
16605 * Troubleshooting:: What you might try if things do not work.
16606 * Gnus Reference Guide:: Rilly, rilly technical stuff.
16607 * Emacs for Heathens:: A short introduction to Emacsian terms.
16608 * Frequently Asked Questions:: A question-and-answer session.
16616 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
16617 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
16619 If you want to investigate the person responsible for this outrage, you
16620 can point your (feh!) web browser to
16621 @file{http://www.stud.ifi.uio.no/~larsi/}. This is also the primary
16622 distribution point for the new and spiffy versions of Gnus, and is known
16623 as The Site That Destroys Newsrcs And Drives People Mad.
16625 During the first extended alpha period of development, the new Gnus was
16626 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
16627 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
16628 (Besides, the ``Gnus'' in this abbreviation should probably be
16629 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
16630 appropriate name, don't you think?)
16632 In any case, after spending all that energy on coming up with a new and
16633 spunky name, we decided that the name was @emph{too} spunky, so we
16634 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
16635 ``@sc{gnus}''. New vs. old.
16637 The first ``proper'' release of Gnus 5 was done in November 1995 when it
16638 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
16639 plus 15 Gnus 5.0 releases).
16641 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
16642 releases)) was released under the name ``Gnus 5.2'' (40 releases).
16644 On July 28th 1996 work on Red Gnus was begun, and it was released on
16645 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
16647 On September 13th 1997, Quassia Gnus was started and lasted 37
16648 releases. If was released as ``Gnus 5.6 on March 8th 1998.
16650 If you happen upon a version of Gnus that has a prefixed name --
16651 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
16652 don't panic. Don't let it know that you're frightened. Back away.
16653 Slowly. Whatever you do, don't run. Walk away, calmly, until you're
16654 out of its reach. Find a proper released version of Gnus and snuggle up
16658 * Why?:: What's the point of Gnus?
16659 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
16660 * Conformity:: Gnus tries to conform to all standards.
16661 * Emacsen:: Gnus can be run on a few modern Emacsen.
16662 * Gnus Development:: How Gnus is developed.
16663 * Contributors:: Oodles of people.
16664 * New Features:: Pointers to some of the new stuff in Gnus.
16665 * Newest Features:: Features so new that they haven't been written yet.
16672 What's the point of Gnus?
16674 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
16675 newsreader, that lets you do anything you can think of. That was my
16676 original motivation, but while working on Gnus, it has become clear to
16677 me that this generation of newsreaders really belong in the stone age.
16678 Newsreaders haven't developed much since the infancy of the net. If the
16679 volume continues to rise with the current rate of increase, all current
16680 newsreaders will be pretty much useless. How do you deal with
16681 newsgroups that have thousands of new articles each day? How do you
16682 keep track of millions of people who post?
16684 Gnus offers no real solutions to these questions, but I would very much
16685 like to see Gnus being used as a testing ground for new methods of
16686 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
16687 to separate the newsreader from the backends, Gnus now offers a simple
16688 interface for anybody who wants to write new backends for fetching mail
16689 and news from different sources. I have added hooks for customizations
16690 everywhere I could imagine it being useful. By doing so, I'm inviting
16691 every one of you to explore and invent.
16693 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
16694 @kbd{C-u 100 M-x all-hail-xemacs}.
16697 @node Compatibility
16698 @subsection Compatibility
16700 @cindex compatibility
16701 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
16702 bindings have been kept. More key bindings have been added, of course,
16703 but only in one or two obscure cases have old bindings been changed.
16708 @center In a cloud bones of steel.
16712 All commands have kept their names. Some internal functions have changed
16715 The @code{gnus-uu} package has changed drastically. @xref{Decoding
16718 One major compatibility question is the presence of several summary
16719 buffers. All variables relevant while reading a group are
16720 buffer-local to the summary buffer they belong in. Although many
16721 important variables have their values copied into their global
16722 counterparts whenever a command is executed in the summary buffer, this
16723 change might lead to incorrect values being used unless you are careful.
16725 All code that relies on knowledge of @sc{gnus} internals will probably
16726 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
16727 changing it in any way, as a matter of fact) is strictly verboten. Gnus
16728 maintains a hash table that points to the entries in this alist (which
16729 speeds up many functions), and changing the alist directly will lead to
16733 @cindex highlighting
16734 Old hilit19 code does not work at all. In fact, you should probably
16735 remove all hilit code from all Gnus hooks
16736 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
16737 Gnus provides various integrated functions for highlighting. These are
16738 faster and more accurate. To make life easier for everybody, Gnus will
16739 by default remove all hilit calls from all hilit hooks. Uncleanliness!
16742 Packages like @code{expire-kill} will no longer work. As a matter of
16743 fact, you should probably remove all old @sc{gnus} packages (and other
16744 code) when you start using Gnus. More likely than not, Gnus already
16745 does what you have written code to make @sc{gnus} do. (Snicker.)
16747 Even though old methods of doing things are still supported, only the
16748 new methods are documented in this manual. If you detect a new method of
16749 doing something while reading this manual, that does not mean you have
16750 to stop doing it the old way.
16752 Gnus understands all @sc{gnus} startup files.
16754 @kindex M-x gnus-bug
16756 @cindex reporting bugs
16758 Overall, a casual user who hasn't written much code that depends on
16759 @sc{gnus} internals should suffer no problems. If problems occur,
16760 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
16762 @vindex gnus-bug-create-help-buffer
16763 If you are in the habit of sending bug reports @emph{very} often, you
16764 may find the helpful help buffer annoying after a while. If so, set
16765 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
16770 @subsection Conformity
16772 No rebels without a clue here, ma'am. We conform to all standards known
16773 to (wo)man. Except for those standards and/or conventions we disagree
16780 There are no known breaches of this standard.
16784 There are no known breaches of this standard, either.
16786 @item Son-of-RFC 1036
16787 @cindex Son-of-RFC 1036
16788 We do have some breaches to this one.
16794 These are considered to be ``vanity headers'', while I consider them
16795 to be consumer information. After seeing so many badly formatted
16796 articles coming from @code{tin} and @code{Netscape} I know not to use
16797 either of those for posting articles. I would not have known that if
16798 it wasn't for the @code{X-Newsreader} header.
16803 USEFOR is an IETF working group writing a successor to RFC 1036, based
16804 on Son-of-RFC 1036. They have produced a number of drafts proposing
16805 various changes to the format of news articles. The Gnus towers will
16806 look into implementing the changes when the draft is accepted as an RFC.
16810 If you ever notice Gnus acting non-compliant with regards to the texts
16811 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
16816 @subsection Emacsen
16822 Gnus should work on :
16830 XEmacs 20.4 and up.
16834 This Gnus version will absolutely not work on any Emacsen older than
16835 that. Not reliably, at least. Older versions of Gnus may work on older
16838 There are some vague differences between Gnus on the various
16839 platforms---XEmacs features more graphics (a logo and a toolbar)---but
16840 other than that, things should look pretty much the same under all
16844 @node Gnus Development
16845 @subsection Gnus Development
16847 Gnus is developed in a two-phased cycle. The first phase involves much
16848 discussion on the @samp{ding@@gnus.org} mailing list, where people
16849 propose changes and new features, post patches and new backends. This
16850 phase is called the @dfn{alpha} phase, since the Gnusae released in this
16851 phase are @dfn{alpha releases}, or (perhaps more commonly in other
16852 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
16853 unstable and should not be used by casual users. Gnus alpha releases
16854 have names like ``Red Gnus'' and ``Quassia Gnus''.
16856 After futzing around for 50-100 alpha releases, Gnus is declared
16857 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
16858 and is called things like ``Gnus 5.6.32'' instead. Normal people are
16859 supposed to be able to use these, and these are mostly discussed on the
16860 @samp{gnu.emacs.gnus} newsgroup.
16863 @vindex nnmail-delete-incoming
16864 Some variable defaults differ between alpha Gnusae and released Gnusae.
16865 In particular, @code{nnmail-delete-incoming} defaults to @code{nil} in
16866 alpha Gnusae and @code{t} in released Gnusae. This is to prevent
16867 lossage of mail if an alpha release hiccups while handling the mail.
16869 The division of discussion between the ding mailing list and the Gnus
16870 newsgroup is not purely based on publicity concerns. It's true that
16871 having people write about the horrible things that an alpha Gnus release
16872 can do (sometimes) in a public forum may scare people off, but more
16873 importantly, talking about new experimental features that have been
16874 introduced may confuse casual users. New features are frequently
16875 introduced, fiddled with, and judged to be found wanting, and then
16876 either discarded or totally rewritten. People reading the mailing list
16877 usually keep up with these rapid changes, whille people on the newsgroup
16878 can't be assumed to do so.
16883 @subsection Contributors
16884 @cindex contributors
16886 The new Gnus version couldn't have been done without the help of all the
16887 people on the (ding) mailing list. Every day for over a year I have
16888 gotten billions of nice bug reports from them, filling me with joy,
16889 every single one of them. Smooches. The people on the list have been
16890 tried beyond endurance, what with my ``oh, that's a neat idea <type
16891 type>, yup, I'll release it right away <ship off> no wait, that doesn't
16892 work at all <type type>, yup, I'll ship that one off right away <ship
16893 off> no, wait, that absolutely does not work'' policy for releases.
16894 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
16895 ``worser''? ``much worser''? ``worsest''?)
16897 I would like to take this opportunity to thank the Academy for... oops,
16903 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
16906 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
16907 well as numerous other things).
16910 Luis Fernandes---design and graphics.
16913 Erik Naggum---help, ideas, support, code and stuff.
16916 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el and many other things
16917 connected with @sc{mime} and other types of en/decoding.
16920 Wes Hardaker---@file{gnus-picon.el} and the manual section on
16921 @dfn{picons} (@pxref{Picons}).
16924 Kim-Minh Kaplan---further work on the picon code.
16927 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
16928 (@pxref{GroupLens}).
16931 Sudish Joseph---innumerable bug fixes.
16934 Ilja Weis---@file{gnus-topic.el}.
16937 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
16940 Vladimir Alexiev---the refcard and reference booklets.
16943 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
16944 distribution by Felix Lee and JWZ.
16947 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
16950 Peter Mutsaers---orphan article scoring code.
16953 Ken Raeburn---POP mail support.
16956 Hallvard B Furuseth---various bits and pieces, especially dealing with
16960 Brian Edmonds---@file{gnus-bbdb.el}.
16963 David Moore---rewrite of @file{nnvirtual.el} and many other things.
16966 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
16969 François Pinard---many, many interesting and thorough bug reports, as
16970 well as autoconf support.
16974 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
16975 Borges, and Jost Krieger proof-reading parts of the manual.
16977 The following people have contributed many patches and suggestions:
16986 Jason L. Tibbitts, III,
16990 Also thanks to the following for patches and stuff:
17000 Alexei V. Barantsev,
17015 Massimo Campostrini,
17020 Jae-you Chung, @c ?
17021 James H. Cloos, Jr.,
17025 Andrew J. Cosgriff,
17028 Geoffrey T. Dairiki,
17034 Michael Welsh Duggan,
17039 Enami Tsugutomo, @c Enami
17043 Nelson Jose dos Santos Ferreira,
17051 Arne Georg Gleditsch,
17053 Michelangelo Grigni,
17057 Kenichi Handa, @c Handa
17059 Yoshiki Hayashi, @c ?
17061 Hisashige Kenji, @c Hisashige
17068 François Felix Ingrand,
17069 Tatsuya Ichikawa, @c ?
17070 Ishikawa Ichiro, @c Ishikawa
17072 Iwamuro Motonori, @c Iwamuro
17083 Peter Skov Knudsen,
17084 Shuhei Kobayashi, @c Kobayashi
17086 Koseki Yoshinori, @c Koseki
17087 Thor Kristoffersen,
17090 Seokchan Lee, @c Lee
17108 Morioka Tomohiko, @c Morioka
17109 Erik Toubro Nielsen,
17116 Masaharu Onishi, @c Onishi
17121 Jens-Ulrik Holger Petersen,
17125 John McClary Prevost,
17131 Lars Balker Rasmussen,
17136 Christian von Roques,
17139 Wolfgang Rupprecht,
17146 Philippe Schnoebelen,
17148 Randal L. Schwartz,
17163 Kiyokazu Suto, @c Suto
17168 Tozawa Akihiko, @c Tozawa
17184 Katsumi Yamaoka @c Yamaoka
17189 For a full overview of what each person has done, the ChangeLogs
17190 included in the Gnus alpha distributions should give ample reading
17191 (550kB and counting).
17193 Apologies to everybody that I've forgotten, of which there are many, I'm
17196 Gee, that's quite a list of people. I guess that must mean that there
17197 actually are people who are using Gnus. Who'd'a thunk it!
17201 @subsection New Features
17202 @cindex new features
17205 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
17206 * September Gnus:: The Thing Formally Known As Gnus 5.3/5.3.
17207 * Red Gnus:: Third time best---Gnus 5.4/5.5.
17208 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
17211 These lists are, of course, just @emph{short} overviews of the
17212 @emph{most} important new features. No, really. There are tons more.
17213 Yes, we have feeping creaturism in full effect.
17217 @subsubsection (ding) Gnus
17219 New features in Gnus 5.0/5.1:
17224 The look of all buffers can be changed by setting format-like variables
17225 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
17228 Local spool and several @sc{nntp} servers can be used at once
17229 (@pxref{Select Methods}).
17232 You can combine groups into virtual groups (@pxref{Virtual Groups}).
17235 You can read a number of different mail formats (@pxref{Getting Mail}).
17236 All the mail backends implement a convenient mail expiry scheme
17237 (@pxref{Expiring Mail}).
17240 Gnus can use various strategies for gathering threads that have lost
17241 their roots (thereby gathering loose sub-threads into one thread) or it
17242 can go back and retrieve enough headers to build a complete thread
17243 (@pxref{Customizing Threading}).
17246 Killed groups can be displayed in the group buffer, and you can read
17247 them as well (@pxref{Listing Groups}).
17250 Gnus can do partial group updates---you do not have to retrieve the
17251 entire active file just to check for new articles in a few groups
17252 (@pxref{The Active File}).
17255 Gnus implements a sliding scale of subscribedness to groups
17256 (@pxref{Group Levels}).
17259 You can score articles according to any number of criteria
17260 (@pxref{Scoring}). You can even get Gnus to find out how to score
17261 articles for you (@pxref{Adaptive Scoring}).
17264 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
17265 manner, so it should be difficult to lose much data on what you have
17266 read if your machine should go down (@pxref{Auto Save}).
17269 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
17270 the @file{.emacs} file.
17273 You can set the process mark on both groups and articles and perform
17274 operations on all the marked items (@pxref{Process/Prefix}).
17277 You can grep through a subset of groups and create a group from the
17278 results (@pxref{Kibozed Groups}).
17281 You can list subsets of groups according to, well, anything
17282 (@pxref{Listing Groups}).
17285 You can browse foreign servers and subscribe to groups from those
17286 servers (@pxref{Browse Foreign Server}).
17289 Gnus can fetch articles, asynchronously, on a second connection to the
17290 server (@pxref{Asynchronous Fetching}).
17293 You can cache articles locally (@pxref{Article Caching}).
17296 The uudecode functions have been expanded and generalized
17297 (@pxref{Decoding Articles}).
17300 You can still post uuencoded articles, which was a little-known feature
17301 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
17304 Fetching parents (and other articles) now actually works without
17305 glitches (@pxref{Finding the Parent}).
17308 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
17311 Digests (and other files) can be used as the basis for groups
17312 (@pxref{Document Groups}).
17315 Articles can be highlighted and customized (@pxref{Customizing
17319 URLs and other external references can be buttonized (@pxref{Article
17323 You can do lots of strange stuff with the Gnus window & frame
17324 configuration (@pxref{Windows Configuration}).
17327 You can click on buttons instead of using the keyboard
17333 @node September Gnus
17334 @subsubsection September Gnus
17338 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
17342 New features in Gnus 5.2/5.3:
17347 A new message composition mode is used. All old customization variables
17348 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
17352 Gnus is now able to generate @dfn{sparse} threads---threads where
17353 missing articles are represented by empty nodes (@pxref{Customizing
17357 (setq gnus-build-sparse-threads 'some)
17361 Outgoing articles are stored on a special archive server
17362 (@pxref{Archived Messages}).
17365 Partial thread regeneration now happens when articles are
17369 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
17372 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
17375 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
17378 (setq gnus-use-trees t)
17382 An @code{nn}-like pick-and-read minor mode is available for the summary
17383 buffers (@pxref{Pick and Read}).
17386 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
17390 In binary groups you can use a special binary minor mode (@pxref{Binary
17394 Groups can be grouped in a folding topic hierarchy (@pxref{Group
17398 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
17402 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
17405 Groups can now have a score, and bubbling based on entry frequency
17406 is possible (@pxref{Group Score}).
17409 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
17413 Groups can be process-marked, and commands can be performed on
17414 groups of groups (@pxref{Marking Groups}).
17417 Caching is possible in virtual groups.
17420 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
17421 news batches, ClariNet briefs collections, and just about everything
17422 else (@pxref{Document Groups}).
17425 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
17429 The Gnus cache is much faster.
17432 Groups can be sorted according to many criteria (@pxref{Sorting
17436 New group parameters have been introduced to set list-addresses and
17437 expiry times (@pxref{Group Parameters}).
17440 All formatting specs allow specifying faces to be used
17441 (@pxref{Formatting Fonts}).
17444 There are several more commands for setting/removing/acting on process
17445 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
17448 The summary buffer can be limited to show parts of the available
17449 articles based on a wide range of criteria. These commands have been
17450 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
17453 Articles can be made persistent with the @kbd{*} command
17454 (@pxref{Persistent Articles}).
17457 All functions for hiding article elements are now toggles.
17460 Article headers can be buttonized (@pxref{Article Washing}).
17463 All mail backends support fetching articles by @code{Message-ID}.
17466 Duplicate mail can now be treated properly (@pxref{Duplicates}).
17469 All summary mode commands are available directly from the article
17470 buffer (@pxref{Article Keymap}).
17473 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
17477 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
17480 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
17485 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
17488 (setq gnus-use-nocem t)
17492 Groups can be made permanently visible (@pxref{Listing Groups}).
17495 (setq gnus-permanently-visible-groups "^nnml:")
17499 Many new hooks have been introduced to make customizing easier.
17502 Gnus respects the @code{Mail-Copies-To} header.
17505 Threads can be gathered by looking at the @code{References} header
17506 (@pxref{Customizing Threading}).
17509 (setq gnus-summary-thread-gathering-function
17510 'gnus-gather-threads-by-references)
17514 Read articles can be stored in a special backlog buffer to avoid
17515 refetching (@pxref{Article Backlog}).
17518 (setq gnus-keep-backlog 50)
17522 A clean copy of the current article is always stored in a separate
17523 buffer to allow easier treatment.
17526 Gnus can suggest where to save articles (@pxref{Saving Articles}).
17529 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
17533 (setq gnus-prompt-before-saving t)
17537 @code{gnus-uu} can view decoded files asynchronously while fetching
17538 articles (@pxref{Other Decode Variables}).
17541 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
17545 Filling in the article buffer now works properly on cited text
17546 (@pxref{Article Washing}).
17549 Hiding cited text adds buttons to toggle hiding, and how much
17550 cited text to hide is now customizable (@pxref{Article Hiding}).
17553 (setq gnus-cited-lines-visible 2)
17557 Boring headers can be hidden (@pxref{Article Hiding}).
17560 Default scoring values can now be set from the menu bar.
17563 Further syntax checking of outgoing articles have been added.
17569 @subsubsection Red Gnus
17571 New features in Gnus 5.4/5.5:
17575 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
17582 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
17585 Article prefetching functionality has been moved up into
17586 Gnus (@pxref{Asynchronous Fetching}).
17589 Scoring can now be performed with logical operators like @code{and},
17590 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
17594 Article washing status can be displayed in the
17595 article mode line (@pxref{Misc Article}).
17598 @file{gnus.el} has been split into many smaller files.
17601 Suppression of duplicate articles based on Message-ID can be done
17602 (@pxref{Duplicate Suppression}).
17605 (setq gnus-suppress-duplicates t)
17609 New variables for specifying what score and adapt files are to be
17610 considered home score and adapt files (@pxref{Home Score File}) have
17614 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
17615 Server Internals}).
17618 Groups can inherit group parameters from parent topics (@pxref{Topic
17622 Article editing has been revamped and is now actually usable.
17625 Signatures can be recognized in more intelligent fashions
17626 (@pxref{Article Signature}).
17629 Summary pick mode has been made to look more @code{nn}-like. Line
17630 numbers are displayed and the @kbd{.} command can be used to pick
17631 articles (@code{Pick and Read}).
17634 Commands for moving the @file{.newsrc.eld} from one server to
17635 another have been added (@pxref{Changing Servers}).
17638 There's a way now to specify that ``uninteresting'' fields be suppressed
17639 when generating lines in buffers (@pxref{Advanced Formatting}).
17642 Several commands in the group buffer can be undone with @kbd{M-C-_}
17646 Scoring can be done on words using the new score type @code{w}
17647 (@pxref{Score File Format}).
17650 Adaptive scoring can be done on a Subject word-by-word basis
17651 (@pxref{Adaptive Scoring}).
17654 (setq gnus-use-adaptive-scoring '(word))
17658 Scores can be decayed (@pxref{Score Decays}).
17661 (setq gnus-decay-scores t)
17665 Scoring can be performed using a regexp on the Date header. The Date is
17666 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
17669 A new command has been added to remove all data on articles from
17670 the native server (@pxref{Changing Servers}).
17673 A new command for reading collections of documents
17674 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
17675 (@pxref{Really Various Summary Commands}).
17678 Process mark sets can be pushed and popped (@pxref{Setting Process
17682 A new mail-to-news backend makes it possible to post even when the NNTP
17683 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
17686 A new backend for reading searches from Web search engines
17687 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
17688 (@pxref{Web Searches}).
17691 Groups inside topics can now be sorted using the standard sorting
17692 functions, and each topic can be sorted independently (@pxref{Topic
17696 Subsets of the groups can be sorted independently (@code{Sorting
17700 Cached articles can be pulled into the groups (@pxref{Summary Generation
17704 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
17709 Score files are now applied in a more reliable order (@pxref{Score
17713 Reports on where mail messages end up can be generated (@pxref{Splitting
17717 More hooks and functions have been added to remove junk from incoming
17718 mail before saving the mail (@pxref{Washing Mail}).
17721 Emphasized text can be properly fontisized:
17727 @subsubsection Quassia Gnus
17729 New features in Gnus 5.6:
17734 New functionality for using Gnus as an offline newsreader has been
17735 added. A plethora of new commands and modes have been added. See
17736 @pxref{Gnus Unplugged} for the full story.
17739 The @code{nndraft} backend has returned, but works differently than
17740 before. All Message buffers are now also articles in the @code{nndraft}
17741 group, which is created automatically.
17744 @code{gnus-alter-header-function} can now be used to alter header
17748 @code{gnus-summary-goto-article} now accept Message-ID's.
17751 A new Message command for deleting text in the body of a message
17752 outside the region: @kbd{C-c C-v}.
17755 You can now post to component group in @code{nnvirtual} groups with
17759 @code{nntp-rlogin-program}---new variable to ease customization.
17762 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
17763 re-highlighting of the article buffer.
17766 New element in @code{gnus-boring-article-headers}---@code{long-to}.
17769 @kbd{M-i} symbolic prefix command. See the section "Symbolic
17770 Prefixes" in the Gnus manual for details.
17773 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
17774 @kbd{a} to add the score rule to the "all.SCORE" file.
17777 @code{gnus-simplify-subject-functions} variable to allow greater
17778 control over simplification.
17781 @kbd{A T}---new command for fetching the current thread.
17784 @kbd{/ T}---new command for including the current thread in the
17788 @kbd{M-RET} is a new Message command for breaking cited text.
17791 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
17794 The @code{custom-face-lookup} function has been removed.
17795 If you used this function in your initialization files, you must
17796 rewrite them to use @code{face-spec-set} instead.
17799 Canceling now uses the current select method. Symbolic prefix
17800 @kbd{a} forces normal posting method.
17803 New command to translate M******** sm*rtq**t*s into proper
17807 For easier debugging of @code{nntp}, you can set
17808 @code{nntp-record-commands} to a non-@code{nil} value.
17811 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
17812 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
17815 A command for editing group parameters from the summary buffer
17819 A history of where mails have been split is available.
17822 A new article date command has been added---@code{article-date-iso8601}.
17825 Subjects can be simplified when threading by setting
17826 @code{gnus-score-thread-simplify}.
17829 A new function for citing in Message has been
17830 added---@code{message-cite-original-without-signature}.
17833 @code{article-strip-all-blank-lines}---new article command.
17836 A new Message command to kill to the end of the article has
17840 A minimum adaptive score can be specified by using the
17841 @code{gnus-adaptive-word-minimum} variable.
17844 The "lapsed date" article header can be kept continually
17845 updated by the @code{gnus-start-date-timer} command.
17848 Web listserv archives can be read with the @code{nnlistserv} backend.
17851 Old dejanews archives can now be read by @code{nnweb}.
17856 @node Newest Features
17857 @subsection Newest Features
17860 Also known as the @dfn{todo list}. Sure to be implemented before the
17863 Be afraid. Be very afraid.
17865 (That a feature appears in this list doesn't necessarily mean that I've
17866 decided to actually implement it. It just means that I think it sounds
17869 (Yes, this is the actual, up-to-the-second todo list.)
17874 I would like the zombie-page to contain an URL to the source of the
17875 latest version of gnus or some explanation on where to find it.
17878 A way to continue editing the latest Message composition.
17881 http://www.sonicnet.com/feature/ari3/
17884 facep is not declared.
17887 Include a section in the manual on why the number of articles
17888 isn't the same in the group buffer and on the SPC prompt.
17891 Interacting with rmail fcc isn't easy.
17896 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
17897 <URL:http://www.eit.com/software/hypermail/hypermail.html>
17898 <URL:http://homer.ncm.com/>
17899 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
17900 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
17901 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
17902 http://www.miranova.com/gnus-list/
17907 @samp{^-- } is made into - in LaTeX.
17910 gnus-kill is much slower than it was in GNUS 4.1.3.
17913 when expunging articles on low score, the sparse nodes keep hanging on?
17915 starting the first time seems to hang Gnus on some systems. Does
17916 NEWGROUPS answer too fast?
17918 nndir doesn't read gzipped files.
17920 FAQ doesn't have an up node?
17922 when moving mail from a procmail spool to the crash-box,
17923 the crash-box is only appropriate to one specific group.
17925 `t' `t' makes X-Faces disappear.
17927 nnmh-be-safe means that crossposted articles will
17928 be marked as unread.
17930 Orphan score entries don't show on "V t" score trace
17932 when clearing out data, the cache data should also be reset.
17934 rewrite gnus-summary-limit-children to be non-recursive
17935 to avoid exceeding lisp nesting on huge groups.
17937 expunged articles are counted when computing scores.
17939 implement gnus-batch-brew-soup
17941 ticked articles aren't easy to read in pick mode -- `n' and
17942 stuff just skips past them. Read articles are the same.
17944 topics that contain just groups with ticked
17945 articles aren't displayed.
17947 nndoc should always allocate unique Message-IDs.
17949 If there are mail groups the first time you use Gnus, Gnus'll
17950 make the mail groups killed.
17952 no "no news is good news" when using topics.
17954 when doing crosspost marking, the cache has to be consulted
17955 and articles have to be removed.
17957 nnweb should fetch complete articles when they are split into several
17960 scoring on head immediate doesn't work.
17962 finding short score file names takes forever.
17964 canceling articles in foreign groups.
17966 nntp-open-rlogin no longer works.
17968 C-u C-x C-s (Summary) switches to the group buffer.
17970 move nnmail-split-history out to the backends.
17972 nnweb doesn't work properly.
17974 using a virtual server name as `gnus-select-method' doesn't work?
17976 when killing/yanking a group from one topic to another in a slave, the
17977 master will yank it first to one topic and then add it to another.
17981 warn user about `=' redirection of a group in the active file?
17983 take over the XEmacs menubar and offer a toggle between the XEmacs
17984 bar and the Gnus bar.
17987 push active file and NOV file parsing down into C code.
17988 `(canonize-message-id id)'
17989 `(mail-parent-message-id references n)'
17990 `(parse-news-nov-line &optional dependency-hashtb)'
17991 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
17992 `(parse-news-active-region beg end hashtb)'
17997 nnml .overview directory with splits.
18001 postponed commands.
18003 the selected article show have its Subject displayed in its summary line.
18005 when entering groups, get the real number of unread articles from
18008 sort after gathering threads -- make false roots have the
18009 headers of the oldest orphan with a 0 article number?
18011 nndoc groups should inherit the score files of their parents? Also
18012 inherit copy prompts and save files.
18014 command to start up Gnus (if not running) and enter a mail mode buffer.
18016 allow editing the group description from the group buffer
18017 for backends that support that.
18019 gnus-hide,show-all-topics
18021 groups and sub-topics should be allowed to mingle inside each topic,
18022 and not just list all subtopics at the end.
18024 a command to remove all read articles that are not needed to connect
18025 threads -- `gnus-summary-limit-to-sparse-unread'?
18027 a variable to turn off limiting/cutting of threads in the tree buffer.
18029 a variable to limit how many files are uudecoded.
18031 add zombie groups to a special "New Groups" topic.
18033 server mode command: close/open all connections
18035 put a file date in gnus-score-alist and check whether the file
18036 has been changed before using it.
18038 on exit from a digest group, go to the next article in the parent group.
18040 hide (sub)threads with low score.
18042 when expiring, remove all marks from expired articles.
18044 gnus-summary-limit-to-body
18046 a regexp alist that says what level groups are to be subscribed
18047 on. Eg. -- `(("nnml:" . 1))'.
18049 easier interface to nnkiboze to create ephemeral groups that
18050 contain groups that match a regexp.
18052 allow newlines in <URL:> urls, but remove them before using
18055 If there is no From line, the mail backends should fudge one from the
18058 fuzzy simplifying should strip all non-alpha-numerical info
18059 from subject lines.
18061 gnus-soup-brew-soup-with-high-scores.
18063 nntp-ping-before-connect
18065 command to check whether NOV is evil. "list overview.fmt".
18067 when entering a group, Gnus should look through the score
18068 files very early for `local' atoms and set those local variables.
18070 message annotations.
18072 topics are always yanked before groups, and that's not good.
18074 (set-extent-property extent 'help-echo "String to display in minibuf")
18075 to display help in the minibuffer on buttons under XEmacs.
18077 allow group line format spec to say how many articles there
18082 `run-with-idle-timer' in gnus-demon.
18084 stop using invisible text properties and start using overlays instead
18086 C-c C-f C-e to add an Expires header.
18088 go from one group to the next; everything is expunged; go to the
18089 next group instead of going to the group buffer.
18091 gnus-renumber-cache -- to renumber the cache using "low" numbers.
18093 record topic changes in the dribble buffer.
18095 `nnfolder-generate-active-file' should look at the folders it
18096 finds and generate proper active ranges.
18098 nneething-look-in-files-for-article-heads variable to control
18099 whether nneething should sniff all files in the directories.
18101 gnus-fetch-article -- start Gnus, enter group, display article
18103 gnus-dont-move-articles-to-same-group variable when respooling.
18105 when messages are crossposted between several auto-expirable groups,
18106 articles aren't properly marked as expirable.
18108 nneething should allow deletion/moving.
18110 TAB on the last button should go to the first button.
18112 if the car of an element in `mail-split-methods' is a function,
18113 and the function returns non-nil, use that as the name of the group(s) to
18116 command for listing all score files that have been applied.
18118 a command in the article buffer to return to `summary' config.
18120 `gnus-always-post-using-current-server' -- variable to override
18121 `C-c C-c' when posting.
18123 nnmail-group-spool-alist -- says where each group should use
18126 when an article is crossposted to an auto-expirable group, the article
18127 should be marker as expirable.
18129 article mode command/menu for "send region as URL to browser".
18131 on errors, jump to info nodes that explain the error. For instance,
18132 on invalid From headers, or on error messages from the nntp server.
18134 when gathering threads, make the article that has no "Re: " the parent.
18135 Also consult Date headers.
18137 a token in splits to call shrink-window-if-larger-than-buffer
18139 `1 0 A M' to do matches on the active hashtb.
18141 duplicates -- command to remove Gnus-Warning header, use the read
18142 Message-ID, delete the "original".
18144 when replying to several messages at once, put the "other" message-ids
18145 into a See-Also header.
18147 support setext: URL:http://www.bsdi.com/setext/
18149 support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
18151 when browsing a foreign server, the groups that are already subscribed
18152 should be listed as such and not as "K".
18154 generate font names dynamically.
18156 score file mode auto-alist.
18158 allow nndoc to change/add/delete things from documents. Implement
18159 methods for each format for adding an article to the document.
18161 `gnus-fetch-old-headers' `all' value to incorporate
18162 absolutely all headers there is.
18164 function like `|', but concatenate all marked articles
18165 and pipe them to the process.
18167 cache the list of killed (or active) groups in a separate file. Update
18168 the file whenever we read the active file or the list
18169 of killed groups in the .eld file reaches a certain length.
18171 function for starting to edit a file to put into
18172 the current mail group.
18174 score-find-trace should display the total score of the article.
18176 "ghettozie" -- score on Xref header and nix it out after using it
18177 to avoid marking as read in other groups it has been crossposted to.
18179 look at procmail splitting. The backends should create
18180 the groups automatically if a spool file exists for that group.
18182 function for backends to register themselves with Gnus.
18184 when replying to several process-marked articles,
18185 have all the From end up in Cc headers? Variable to toggle.
18187 command to delete a crossposted mail article from all
18188 groups it has been mailed to.
18190 `B c' and `B m' should be crosspost aware.
18192 hide-pgp should also hide PGP public key blocks.
18194 Command in the group buffer to respool process-marked groups.
18196 `gnus-summary-find-matching' should accept
18197 pseudo-"headers" like "body", "head" and "all"
18199 When buttifying <URL: > things, all white space (including
18200 newlines) should be ignored.
18202 Process-marking all groups in a topic should process-mark
18203 groups in subtopics as well.
18205 Add non-native groups to the list of killed groups when killing them.
18207 nntp-suggest-kewl-config to probe the nntp server and suggest
18210 add edit and forward secondary marks.
18212 nnml shouldn't visit its .overview files.
18214 allow customizing sorting within gathered threads.
18216 `B q' shouldn't select the current article.
18218 nnmbox should support a newsgroups file for descriptions.
18220 allow fetching mail from several pop servers.
18222 Be able to specify whether the saving commands save the original
18223 or the formatted article.
18225 a command to reparent with the child process-marked (cf. `T ^'.).
18227 I think the possibility to send a password with nntp-open-rlogin
18228 should be a feature in Red Gnus.
18230 The `Z n' command should be possible to execute from a mouse click.
18232 more limiting functions -- date, etc.
18234 be able to limit on a random header; on body; using reverse matches.
18236 a group parameter (`absofucking-total-expiry') that will make Gnus expire
18237 even unread articles.
18239 a command to print the article buffer as postscript.
18241 variable to disable password fetching when opening by nntp-open-telnet.
18243 manual: more example servers -- nntp with rlogin, telnet
18245 checking for bogus groups should clean topic alists as well.
18247 canceling articles in foreign groups.
18249 article number in folded topics isn't properly updated by
18252 Movement in the group buffer to the next unread group should go to the
18253 next closed topic with unread messages if no group can be found.
18255 Extensive info pages generated on the fly with help everywhere --
18256 in the "*Gnus edit*" buffers, for instance.
18258 Topic movement commands -- like thread movement. Up, down, forward, next.
18260 a way to tick/mark as read Gcc'd articles.
18262 a way to say that all groups within a specific topic comes
18263 from a particular server? Hm.
18265 `gnus-article-fill-if-long-lines' -- a function to fill
18266 the article buffer if there are any looong lines there.
18268 `T h' should jump to the parent topic and fold it.
18270 a command to create an ephemeral nndoc group out of a file,
18271 and then splitting it/moving it to some other group/backend.
18273 a group parameter for nnkiboze groups that says that
18274 all kibozed articles should be entered into the cache.
18276 It should also probably be possible to delimit what
18277 `gnus-jog-cache' does -- for instance, work on just some groups, or on
18278 some levels, and entering just articles that have a score higher than
18281 nnfolder should append to the folder instead of re-writing
18282 the entire folder to disk when accepting new messages.
18284 allow all backends to do the proper thing with .gz files.
18286 a backend for reading collections of babyl files nnbabylfolder?
18288 a command for making the native groups into foreign groups.
18290 server mode command for clearing read marks from all groups
18293 when following up multiple articles, include all To, Cc, etc headers
18296 a command for deciding what the total score of the current
18297 thread is. Also a way to highlight based on this.
18299 command to show and edit group scores
18301 a gnus-tree-minimize-horizontal to minimize tree buffers
18304 command to generate nnml overview file for one group.
18306 `C-u C-u a' -- prompt for many crossposted groups.
18308 keep track of which mail groups have received new articles (in this session).
18309 Be able to generate a report and perhaps do some marking in the group
18312 gnus-build-sparse-threads to a number -- build only sparse threads
18313 that are of that length.
18315 have nnmh respect mh's unseen sequence in .mh_profile.
18317 cache the newsgroups descriptions locally.
18319 asynchronous posting under nntp.
18321 be able to control word adaptive scoring from the score files.
18323 a variable to make `C-c C-c' post using the "current" select method.
18325 `limit-exclude-low-scored-articles'.
18327 if `gnus-summary-show-thread' is a number, hide threads that have
18328 a score lower than this number.
18330 split newsgroup subscription variable up into "order" and "method".
18332 buttonize ange-ftp file names.
18334 a command to make a duplicate copy of the current article
18335 so that each copy can be edited separately.
18337 nnweb should allow fetching from the local nntp server.
18339 record the sorting done in the summary buffer so that
18340 it can be repeated when limiting/regenerating the buffer.
18342 nnml-generate-nov-databses should generate for
18345 when the user does commands in the group buffer, check
18346 the modification time of the .newsrc.eld file and use
18347 ask-user-about-supersession-threat. Also warn when trying
18348 to save .newsrc.eld and it has changed.
18350 M-g on a topic will display all groups with 0 articles in
18353 command to remove all topic stuff.
18355 allow exploding incoming digests when reading incoming mail
18356 and splitting the resulting digests.
18358 nnsoup shouldn't set the `message-' variables.
18360 command to nix out all nnoo state information.
18362 nnmail-process-alist that calls functions if group names
18363 matches an alist -- before saving.
18365 use buffer-invisibility-spec everywhere for hiding text.
18367 variable to activate each group before entering them
18368 to get the (new) number of articles. `gnus-activate-before-entering'.
18370 command to fetch a Message-ID from any buffer, even
18371 starting Gnus first if necessary.
18373 when posting and checking whether a group exists or not, just
18374 ask the nntp server instead of relying on the active hashtb.
18376 buttonize the output of `C-c C-a' in an apropos-like way.
18378 `G p' should understand process/prefix, and allow editing
18379 of several groups at once.
18381 command to create an ephemeral nnvirtual group that
18382 matches some regexp(s).
18384 nndoc should understand "Content-Type: message/rfc822" forwarded messages.
18386 it should be possible to score "thread" on the From header.
18388 hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
18390 `B i' should display the article at once in the summary buffer.
18392 remove the "*" mark at once when unticking an article.
18394 `M-s' should highlight the matching text.
18396 when checking for duplicated mails, use Resent-Message-ID if present.
18398 killing and yanking groups in topics should be better. If killing one copy
18399 of a group that exists in multiple topics, only that copy should
18400 be removed. Yanking should insert the copy, and yanking topics
18401 should be possible to be interspersed with the other yankings.
18403 command for enter a group just to read the cached articles. A way to say
18404 "ignore the nntp connection; just read from the cache."
18406 `X u' should decode base64 articles.
18408 a way to hide all "inner" cited text, leaving just the most
18409 recently cited text.
18411 nnvirtual should be asynchronous.
18413 after editing an article, gnus-original-article-buffer should
18416 there should probably be a way to make Gnus not connect to the
18417 server and just read the articles in the server
18419 allow a `set-default' (or something) to change the default
18420 value of nnoo variables.
18422 a command to import group infos from a .newsrc.eld file.
18424 groups from secondary servers have the entire select method
18425 listed in each group info.
18427 a command for just switching from the summary buffer to the group
18430 a way to specify that some incoming mail washing functions
18431 should only be applied to some groups.
18433 Message `C-f C-t' should ask the user whether to heed
18434 mail-copies-to: never.
18436 new group parameter -- `post-to-server' that says to post
18437 using the current server. Also a variable to do the same.
18439 the slave dribble files should auto-save to the slave file names.
18441 a group parameter that says what articles to display on group entry, based
18444 a way to visually distinguish slave Gnusae from masters. (Whip instead
18447 Use DJ Bernstein "From " quoting/dequoting, where applicable.
18449 Why is hide-citation-maybe and hide-citation different? Also
18452 group user-defined meta-parameters.
18456 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
18458 I like the option for trying to retrieve the FAQ for a group and I was
18459 thinking it would be great if for those newsgroups that had archives
18460 you could also try to read the archive for that group. Part of the
18461 problem is that archives are spread all over the net, unlike FAQs.
18462 What would be best I suppose is to find the one closest to your site.
18464 In any case, there is a list of general news group archives at @*
18465 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
18472 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
18473 (add-hook 'gnus-select-group-hook
18475 (gnus-group-add-parameter group
18476 (cons 'gnus-group-date-last-entered (list (current-time-string))))))
18478 (defun gnus-user-format-function-d (headers)
18479 "Return the date the group was last read."
18480 (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
18485 tanken var at når du bruker `gnus-startup-file' som prefix (FOO) til å lete
18486 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
18487 liste hvor du bruker hvert element i listen som FOO, istedet. da kunne man
18488 hatt forskjellige serveres startup-filer forskjellige steder.
18492 LMI> Well, nnbabyl could alter the group info to heed labels like
18493 LMI> answered and read, I guess.
18495 It could also keep them updated (the same for the Status: header of
18498 They could be used like this:
18502 `M l <name> RET' add label <name> to current message.
18503 `M u <name> RET' remove label <name> from current message.
18504 `/ l <expr> RET' limit summary buffer according to <expr>.
18506 <expr> would be a boolean expression on the labels, e.g.
18508 `/ l bug & !fixed RET'
18511 would show all the messages which are labeled `bug' but not labeled
18514 One could also imagine the labels being used for highlighting, or
18515 affect the summary line format.
18519 Sender: abraham@@dina.kvl.dk
18521 I'd like a gnus-find-file which work like find file, except that it
18522 would recognize things that looks like messages or folders:
18524 - If it is a directory containing numbered files, create an nndir
18527 - For other directories, create a nneething summary buffer.
18529 - For files matching "\\`From ", create a nndoc/mbox summary.
18531 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
18533 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
18535 - For other files, just find them normally.
18537 I'd like `nneething' to use this function, so it would work on a
18538 directory potentially containing mboxes or babyl files.
18541 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
18542 tell him what you are doing.
18545 Currently, I get prompted:
18549 decend into sci.something ?
18553 The problem above is that since there is really only one subsection of
18554 science, shouldn't it prompt you for only descending sci.something? If
18555 there was a sci.somethingelse group or section, then it should prompt
18556 for sci? first the sci.something? then sci.somethingelse?...
18559 Ja, det burde være en måte å si slikt. Kanskje en ny variabel?
18560 `gnus-use-few-score-files'? SÃ¥ kunne score-regler legges til den
18561 "mest" lokale score-fila. F. eks. ville no-gruppene betjenes av
18562 "no.all.SCORE", osv.
18565 What i want is for Gnus to treat any sequence or combination of the following
18566 as a single spoiler warning and hide it all, replacing it with a "Next Page"
18572 more than n blank lines
18574 more than m identical lines
18575 (which should be replaced with button to show them)
18577 any whitespace surrounding any of the above
18581 Well, we could allow a new value to `gnus-thread-ignore-subject' --
18582 `spaces', or something. (We could even default to that.) And then
18583 subjects that differ in white space only could be considered the
18584 "same" subject for threading purposes.
18587 Modes to preprocess the contents (e.g. jka-compr) use the second form
18588 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
18589 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
18590 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
18593 Under XEmacs -- do funny article marks:
18596 soup - bowl of soup
18597 score below - dim light bulb
18598 score over - bright light bulb
18601 Yes. I think the algorithm is as follows:
18606 show-list-of-articles-in-group
18607 if (key-pressed == SPACE)
18608 if (no-more-articles-in-group-to-select)
18609 if (articles-selected)
18610 start-reading-selected-articles;
18611 junk-unread-articles;
18616 else if (key-pressed = '.')
18617 if (consolidated-menus) # same as hide-thread in Gnus
18618 select-thread-under-cursor;
18620 select-article-under-cursor;
18624 if (key-pressed == SPACE)
18625 if (more-pages-in-article)
18627 else if (more-selected-articles-to-read)
18634 My precise need here would have been to limit files to Incoming*.
18635 One could think of some `nneething-only-files' variable, but I guess
18636 it would have been unacceptable if one was using many unrelated such
18639 A more useful approach would be to, in response to the `G D' prompt, be
18640 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
18641 the top-level directory only (in case directories would be matched by
18642 the wildcard expression).
18645 It would be nice if it also handled
18647 <URL:news://sunsite.auc.dk/>
18649 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
18654 Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
18655 really well. Each menu is 'named' by a symbol that would be on a
18656 gnus-*-menus (where * would be whatever, but at least group, summary, and
18657 article versions) variable.
18659 So for gnus-summary-menus, I would set to '(sort mark dispose ...)
18661 A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
18662 the main menubar. This approach works really well for Emacs-W3 and VM.
18666 nndoc should take care to create unique Message-IDs for all its
18669 gnus-score-followup-article only works when you have a summary buffer
18670 active. Make it work when posting from the group buffer as well.
18671 (message-sent-hook).
18673 rewrite gnus-demon to use run-with-idle-timers.
18676 * Enhancements to Gnus:
18680 * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
18681 straight to the server buffer, without opening any connections to
18684 * gnus-server-read-server-newsrc--produces a buffer very similar to
18685 the group buffer, but with only groups from that server listed;
18686 quitting this buffer returns to the server buffer.
18689 add a command to check the integrity of an nnfolder folder --
18690 go through the article numbers and see that there are no duplicates,
18694 `unsmileyfy-buffer' to undo smileification.
18697 a command to give all relevant info on an article, including all
18701 when doing `-request-accept-article', the backends should do
18702 the nnmail duplicate checking.
18705 allow `message-signature-file' to be a function to return the
18706 value of the signature file.
18709 In addition, I would love it if I could configure message-tab so that it
18710 could call `bbdb-complete-name' in other headers. So, some sort of
18713 (setq message-tab-alist
18714 '((message-header-regexp message-expand-group)
18715 ("^\\(To\\|[cC]c\\|[bB]cc\\)" bbdb-complete-name)))
18717 then you could run the relevant function to complete the information in
18721 cache the newsgroups file locally to avoid reloading it all the time.
18724 a command to import a buffer into a group.
18727 nnweb should allow fetching by Message-ID from servers.
18730 point in the article buffer doesn't always go to the
18731 beginning of the buffer when selecting new articles.
18734 a command to process mark all unread articles.
18737 `gnus-gather-threads-by-references-and-subject' -- first
18738 do gathering by references, and then go through the dummy roots and
18739 do more gathering by subject.
18742 gnus-uu-mark-in-numerical-order -- process mark articles in
18743 article numerical order.
18746 (gnus-thread-total-score
18747 (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
18751 sorting by score is wrong when using sparse threads.
18754 a command to fetch an arbitrary article -- without having to be
18755 in the summary buffer.
18758 a new nncvs backend. Each group would show an article, using
18759 version branches as threading, checkin date as the date, etc.
18762 http://www.dejanews.com/forms/dnsetfilter_exp.html ?
18763 This filter allows one to construct advance queries on the Dejanews
18764 database such as specifying start and end dates, subject, author,
18765 and/or newsgroup name.
18768 new Date header scoring type -- older, newer
18771 use the summary toolbar in the article buffer.
18774 a command to fetch all articles that are less than X days old.
18777 in pick mode, `q' should save the list of selected articles in the
18778 group info. The next time the group is selected, these articles
18779 will automatically get the process mark.
18782 Isn't it possible to (also?) allow M-^ to automatically try the
18783 default server if it fails on the current server? (controlled by a
18784 user variable, (nil, t, 'ask)).
18787 make it possible to cancel articles using the select method for the
18791 `gnus-summary-select-article-on-entry' or something. It'll default
18792 to t and will select whatever article decided by `gnus-auto-select-first'.
18795 a new variable to control which selection commands should be unselecting.
18796 `first', `best', `next', `prev', `next-unread', `prev-unread' are
18800 be able to select groups that have no articles in them
18801 to be able to post in them (using the current select method).
18804 be able to post via DejaNews.
18807 `x' should retain any sortings that have been performed.
18810 allow the user to specify the precedence of the secondary marks. Also
18811 allow them to be displayed separately.
18814 gnus-summary-save-in-pipe should concatenate the results from
18815 the processes when doing a process marked pipe.
18818 a new match type, like Followup, but which adds Thread matches on all
18819 articles that match a certain From header.
18822 a function that can be read from kill-emacs-query-functions to offer
18823 saving living summary buffers.
18826 a function for selecting a particular group which will contain
18827 the articles listed in a list of article numbers/id's.
18830 a battery of character translation functions to translate common
18831 Mac, MS (etc) characters into ISO 8859-1.
18834 (defun article-fix-m$word ()
18835 "Fix M$Word smartquotes in an article."
18838 (let ((buffer-read-only nil))
18839 (goto-char (point-min))
18840 (while (search-forward "\221" nil t)
18841 (replace-match "`" t t))
18842 (goto-char (point-min))
18843 (while (search-forward "\222" nil t)
18844 (replace-match "'" t t))
18845 (goto-char (point-min))
18846 (while (search-forward "\223" nil t)
18847 (replace-match "\"" t t))
18848 (goto-char (point-min))
18849 (while (search-forward "\224" nil t)
18850 (replace-match "\"" t t)))))
18855 (add-hook 'gnus-exit-query-functions
18857 (if (and (file-exists-p nnmail-spool-file)
18858 (> (nnheader-file-size nnmail-spool-file) 0))
18859 (yes-or-no-p "New mail has arrived. Quit Gnus anyways? ")
18860 (y-or-n-p "Are you sure you want to quit Gnus? "))))
18864 allow message-default-headers to be a function.
18867 new Date score match types -- < > = (etc) that take floating point
18868 numbers and match on the age of the article.
18872 > > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
18873 > > > under xemacs-19.14, it's creating a new frame, but is erasing the
18874 > > > buffer in the frame that it was called from =:-O
18876 > > Hm. How do you start up Gnus? From the toolbar or with
18877 > > `M-x gnus-other-frame'?
18879 > I normally start it up from the toolbar; at
18880 > least that's the way I've caught it doing the
18885 all commands that react to the process mark should push
18886 the current process mark set onto the stack.
18889 gnus-article-hide-pgp
18890 Selv ville jeg nok ha valgt å slette den dersom teksten matcher
18892 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
18894 og det er maks hundre tegn mellom match-end og ----linja. Men -det-
18895 er min type heuristikk og langt fra alles.
18898 `gnus-subscribe-sorted' -- insert new groups where they would have been
18899 sorted to if `gnus-group-sort-function' were run.
18902 gnus-(group,summary)-highlight should respect any `face' text props set
18906 use run-with-idle-timer for gnus-demon instead of the
18907 home-brewed stuff for better reliability.
18910 add a way to select which NoCeM type to apply -- spam, troll, etc.
18913 nndraft-request-group should tally auto-save files.
18916 implement nntp-retry-on-break and nntp-command-timeout.
18919 gnus-article-highlight-limit that says when not to highlight (long)
18923 (nnoo-set SERVER VARIABLE VALUE)
18929 interrupitng agent fetching of articles should save articles.
18932 command to open a digest group, and copy all the articles there to the
18936 a variable to disable article body highlights if there's more than
18937 X characters in the body.
18940 handle 480/381 authinfo requests separately.
18943 include the texi/dir file in the distribution.
18946 format spec to "tab" to a position.
18949 Move all prompting to the new `M-n' default style.
18952 command to display all dormant articles.
18955 gnus-auto-select-next makeover -- list of things it should do.
18958 a score match type that adds scores matching on From if From has replied
18959 to something someone else has said.
18962 Read Netscape discussion groups:
18963 snews://secnews.netscape.com/netscape.communicator.unix
18966 One command to edit the original version if an article, and one to edit
18967 the displayed version.
18970 @kbd{T v} -- make all process-marked articles the children of the
18974 Switch from initial text to the new default text mechanism.
18977 How about making it possible to expire local articles? Will it be
18978 possible to make various constraints on when an article can be
18979 expired, e.g. (read), (age > 14 days), or the more interesting (read
18983 New limit command---limit to articles that have a certain string
18984 in the head or body.
18987 Allow breaking lengthy NNTP commands.
18990 gnus-article-highlight-limit, to disable highlighting in big articles.
18993 Editing an article should put the article to be edited
18994 in a special, unique buffer.
18997 A command to send a mail to the admin-address group param.
19000 A Date scoring type that will match if the article
19001 is less than a certain number of days old.
19004 New spec: %~(tab 56) to put point on column 56
19007 Allow Gnus Agent scoring to use normal score files.
19010 Rething the Agent active file thing. `M-g' doesn't update the active
19011 file, for instance.
19014 With dummy roots, `^' and then selecing the first article
19015 in any other dummy thread will make Gnus highlight the
19016 dummy root instead of the first article.
19019 Propagate all group properties (marks, article numbers, etc) up to the
19020 topics for displaying.
19023 `n' in the group buffer with topics should go to the next group
19024 with unread articles, even if that group is hidden in a topic.
19027 gnus-posting-styles doesn't work in drafts.
19030 gnus-summary-limit-include-cached is slow when there are
19031 many articles in the cache, since it regenerates big parts of the
19032 summary buffer for each article.
19035 Implement gnus-batch-brew-soup.
19038 Group parameters and summary commands for un/subscribing to mailing
19042 Introduce nnmail-home-directory.
19045 gnus-fetch-group and friends should exit Gnus when the user
19049 The jingle is only played on the second invocation of Gnus.
19052 Bouncing articles should do MIME.
19055 Crossposted articles should "inherit" the % or @ mark from the other
19056 groups it has been crossposted to, or something. (Agent.)
19059 `S D r' should allow expansion of aliases.
19062 If point is on a group that appears multiple times in topics, and
19063 you press `l', point will move to the first instance of the group.
19066 Fetch by Message-ID from dejanews.
19068 <URL:http://search.dejanews.com/msgid.xp?MID=%3C62h9l9$hm4@@basement.replay.com%3E&fmt=raw>
19071 A spec for the group line format to display the number of
19072 agent-downloaded articles in the group.
19075 Some nntp servers never respond when posting, so there should be a
19076 timeout for all commands.
19079 When stading on a topic line and `t'-ing, point goes to the last line.
19080 It should go somewhere else.
19083 I'm having trouble accessing a newsgroup with a "+" in its name with
19084 Gnus. There is a new newsgroup on msnews.microsoft.com named
19085 "microsoft.public.multimedia.directx.html+time" that I'm trying to
19087 "nntp+msnews.microsoft.com:microsoft.public.multimedia.directx.html+time"
19088 but it gives an error that it cant access the group.
19090 Is the "+" character illegal in newsgroup names? Is there any way in
19091 Gnus to work around this? (gnus 5.6.45 - XEmacs 20.4)
19098 Subject: Answer to your mails 01.01.1999-01.05.1999
19099 --text follows this line--
19100 Sorry I killfiled you...
19102 Under the subject "foo", you wrote on 01.01.1999:
19104 Under the subject "foo1", you wrote on 01.01.1999:
19109 Allow "orphan" scores in the Agent scoring.
19113 - Edit article's summary line.
19115 - Sort lines in buffer by subject
19117 --> the old subject line appears in Summary buffer, not the one that was
19122 Solve the halting problem.
19131 @section The Manual
19135 This manual was generated from a TeXinfo file and then run through
19136 either @code{texi2dvi}
19138 or my own home-brewed TeXinfo to \LaTeX\ transformer,
19139 and then run through @code{latex} and @code{dvips}
19141 to get what you hold in your hands now.
19143 The following conventions have been used:
19148 This is a @samp{string}
19151 This is a @kbd{keystroke}
19154 This is a @file{file}
19157 This is a @code{symbol}
19161 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
19165 (setq flargnoze "yes")
19168 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
19171 (setq flumphel 'yes)
19174 @samp{yes} and @code{yes} are two @emph{very} different things---don't
19175 ever get them confused.
19179 Of course, everything in this manual is of vital interest, so you should
19180 read it all. Several times. However, if you feel like skimming the
19181 manual, look for that gnu head you should see in the margin over
19182 there---it means that what's being discussed is of more importance than
19183 the rest of the stuff. (On the other hand, if everything is infinitely
19184 important, how can anything be more important than that? Just one more
19185 of the mysteries of this world, I guess.)
19193 @section Terminology
19195 @cindex terminology
19200 This is what you are supposed to use this thing for---reading news.
19201 News is generally fetched from a nearby @sc{nntp} server, and is
19202 generally publicly available to everybody. If you post news, the entire
19203 world is likely to read just what you have written, and they'll all
19204 snigger mischievously. Behind your back.
19208 Everything that's delivered to you personally is mail. Some news/mail
19209 readers (like Gnus) blur the distinction between mail and news, but
19210 there is a difference. Mail is private. News is public. Mailing is
19211 not posting, and replying is not following up.
19215 Send a mail to the person who has written what you are reading.
19219 Post an article to the current newsgroup responding to the article you
19224 Gnus gets fed articles from a number of backends, both news and mail
19225 backends. Gnus does not handle the underlying media, so to speak---this
19226 is all done by the backends.
19230 Gnus will always use one method (and backend) as the @dfn{native}, or
19231 default, way of getting news.
19235 You can also have any number of foreign groups active at the same time.
19236 These are groups that use non-native non-secondary backends for getting
19241 Secondary backends are somewhere half-way between being native and being
19242 foreign, but they mostly act like they are native.
19246 A message that has been posted as news.
19249 @cindex mail message
19250 A message that has been mailed.
19254 A mail message or news article
19258 The top part of a message, where administrative information (etc.) is
19263 The rest of an article. Everything not in the head is in the
19268 A line from the head of an article.
19272 A collection of such lines, or a collection of heads. Or even a
19273 collection of @sc{nov} lines.
19277 When Gnus enters a group, it asks the backend for the headers of all
19278 unread articles in the group. Most servers support the News OverView
19279 format, which is more compact and much faster to read and parse than the
19280 normal @sc{head} format.
19284 Each group is subscribed at some @dfn{level} or other (1-9). The ones
19285 that have a lower level are ``more'' subscribed than the groups with a
19286 higher level. In fact, groups on levels 1-5 are considered
19287 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
19288 are @dfn{killed}. Commands for listing groups and scanning for new
19289 articles will all use the numeric prefix as @dfn{working level}.
19291 @item killed groups
19292 @cindex killed groups
19293 No information on killed groups is stored or updated, which makes killed
19294 groups much easier to handle than subscribed groups.
19296 @item zombie groups
19297 @cindex zombie groups
19298 Just like killed groups, only slightly less dead.
19301 @cindex active file
19302 The news server has to keep track of what articles it carries, and what
19303 groups exist. All this information in stored in the active file, which
19304 is rather large, as you might surmise.
19307 @cindex bogus groups
19308 A group that exists in the @file{.newsrc} file, but isn't known to the
19309 server (i.e., it isn't in the active file), is a @emph{bogus group}.
19310 This means that the group probably doesn't exist (any more).
19313 @cindex activating groups
19314 The act of asking the server for info on a group and computing the
19315 number of unread articles is called @dfn{activating the group}.
19316 Un-activated groups are listed with @samp{*} in the group buffer.
19320 A machine one can connect to and get news (or mail) from.
19322 @item select method
19323 @cindex select method
19324 A structure that specifies the backend, the server and the virtual
19327 @item virtual server
19328 @cindex virtual server
19329 A named select method. Since a select method defines all there is to
19330 know about connecting to a (physical) server, taking the thing as a
19331 whole is a virtual server.
19335 Taking a buffer and running it through a filter of some sort. The
19336 result will (more often than not) be cleaner and more pleasing than the
19339 @item ephemeral groups
19340 @cindex ephemeral groups
19341 Most groups store data on what articles you have read. @dfn{Ephemeral}
19342 groups are groups that will have no data stored---when you exit the
19343 group, it'll disappear into the aether.
19346 @cindex solid groups
19347 This is the opposite of ephemeral groups. All groups listed in the
19348 group buffer are solid groups.
19350 @item sparse articles
19351 @cindex sparse articles
19352 These are article placeholders shown in the summary buffer when
19353 @code{gnus-build-sparse-threads} has been switched on.
19357 To put responses to articles directly after the articles they respond
19358 to---in a hierarchical fashion.
19362 @cindex thread root
19363 The first article in a thread is the root. It is the ancestor of all
19364 articles in the thread.
19368 An article that has responses.
19372 An article that responds to a different article---its parent.
19376 A collection of messages in one file. The most common digest format is
19377 specified by RFC1153.
19383 @node Customization
19384 @section Customization
19385 @cindex general customization
19387 All variables are properly documented elsewhere in this manual. This
19388 section is designed to give general pointers on how to customize Gnus
19389 for some quite common situations.
19392 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
19393 * Slow Terminal Connection:: You run a remote Emacs.
19394 * Little Disk Space:: You feel that having large setup files is icky.
19395 * Slow Machine:: You feel like buying a faster machine.
19399 @node Slow/Expensive Connection
19400 @subsection Slow/Expensive @sc{nntp} Connection
19402 If you run Emacs on a machine locally, and get your news from a machine
19403 over some very thin strings, you want to cut down on the amount of data
19404 Gnus has to get from the @sc{nntp} server.
19408 @item gnus-read-active-file
19409 Set this to @code{nil}, which will inhibit Gnus from requesting the
19410 entire active file from the server. This file is often v. large. You
19411 also have to set @code{gnus-check-new-newsgroups} and
19412 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
19413 doesn't suddenly decide to fetch the active file anyway.
19415 @item gnus-nov-is-evil
19416 This one has to be @code{nil}. If not, grabbing article headers from
19417 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
19418 support @sc{xover}; Gnus will detect this by itself.
19422 @node Slow Terminal Connection
19423 @subsection Slow Terminal Connection
19425 Let's say you use your home computer for dialing up the system that runs
19426 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
19427 possible) the amount of data sent over the wires.
19431 @item gnus-auto-center-summary
19432 Set this to @code{nil} to inhibit Gnus from re-centering the summary
19433 buffer all the time. If it is @code{vertical}, do only vertical
19434 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
19435 horizontal and vertical recentering.
19437 @item gnus-visible-headers
19438 Cut down on the headers included in the articles to the
19439 minimum. You can, in fact, make do without them altogether---most of the
19440 useful data is in the summary buffer, anyway. Set this variable to
19441 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
19443 Set this hook to all the available hiding commands:
19445 (setq gnus-treat-hide-headers 'head
19446 gnus-treat-hide-signature t
19447 gnus-treat-hide-citation t)
19450 @item gnus-use-full-window
19451 By setting this to @code{nil}, you can make all the windows smaller.
19452 While this doesn't really cut down much generally, it means that you
19453 have to see smaller portions of articles before deciding that you didn't
19454 want to read them anyway.
19456 @item gnus-thread-hide-subtree
19457 If this is non-@code{nil}, all threads in the summary buffer will be
19460 @item gnus-updated-mode-lines
19461 If this is @code{nil}, Gnus will not put information in the buffer mode
19462 lines, which might save some time.
19466 @node Little Disk Space
19467 @subsection Little Disk Space
19470 The startup files can get rather large, so you may want to cut their
19471 sizes a bit if you are running out of space.
19475 @item gnus-save-newsrc-file
19476 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
19477 only save @file{.newsrc.eld}. This means that you will not be able to
19478 use any other newsreaders than Gnus. This variable is @code{t} by
19481 @item gnus-read-newsrc-file
19482 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
19483 only read @file{.newsrc.eld}. This means that you will not be able to
19484 use any other newsreaders than Gnus. This variable is @code{t} by
19487 @item gnus-save-killed-list
19488 If this is @code{nil}, Gnus will not save the list of dead groups. You
19489 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
19490 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
19491 variable to @code{nil}. This variable is @code{t} by default.
19497 @subsection Slow Machine
19498 @cindex slow machine
19500 If you have a slow machine, or are just really impatient, there are a
19501 few things you can do to make Gnus run faster.
19503 Set @code{gnus-check-new-newsgroups} and
19504 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
19506 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
19507 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
19508 summary buffer faster.
19512 @node Troubleshooting
19513 @section Troubleshooting
19514 @cindex troubleshooting
19516 Gnus works @emph{so} well straight out of the box---I can't imagine any
19524 Make sure your computer is switched on.
19527 Make sure that you really load the current Gnus version. If you have
19528 been running @sc{gnus}, you need to exit Emacs and start it up again before
19532 Try doing an @kbd{M-x gnus-version}. If you get something that looks
19533 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded. If,
19534 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
19535 flee}, you have some old @file{.el} files lying around. Delete these.
19538 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
19542 @vindex max-lisp-eval-depth
19543 Gnus works on many recursive structures, and in some extreme (and very
19544 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
19545 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
19546 something like that.
19549 If all else fails, report the problem as a bug.
19552 @cindex reporting bugs
19554 @kindex M-x gnus-bug
19556 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
19557 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
19558 me the backtrace. I will fix bugs, but I can only fix them if you send
19559 me a precise description as to how to reproduce the bug.
19561 You really can never be too detailed in a bug report. Always use the
19562 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
19563 a 10Kb mail each time you use it, and even if you have sent me your
19564 environment 500 times before. I don't care. I want the full info each
19567 It is also important to remember that I have no memory whatsoever. If
19568 you send a bug report, and I send you a reply, and then you just send
19569 back ``No, it's not! Moron!'', I will have no idea what you are
19570 insulting me about. Always over-explain everything. It's much easier
19571 for all of us---if I don't have all the information I need, I will just
19572 mail you and ask for more info, and everything takes more time.
19574 If the problem you're seeing is very visual, and you can't quite explain
19575 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
19576 it somewhere it can be reached, and include the URL of the picture in
19579 If you just need help, you are better off asking on
19580 @samp{gnu.emacs.gnus}. I'm not very helpful.
19582 @cindex gnu.emacs.gnus
19583 @cindex ding mailing list
19584 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
19585 Write to @samp{ding-request@@gnus.org} to subscribe.
19589 @node Gnus Reference Guide
19590 @section Gnus Reference Guide
19592 It is my hope that other people will figure out smart stuff that Gnus
19593 can do, and that other people will write those smart things as well. To
19594 facilitate that I thought it would be a good idea to describe the inner
19595 workings of Gnus. And some of the not-so-inner workings, while I'm at
19598 You can never expect the internals of a program not to change, but I
19599 will be defining (in some details) the interface between Gnus and its
19600 backends (this is written in stone), the format of the score files
19601 (ditto), data structures (some are less likely to change than others)
19602 and general methods of operation.
19605 * Gnus Utility Functions:: Common functions and variable to use.
19606 * Backend Interface:: How Gnus communicates with the servers.
19607 * Score File Syntax:: A BNF definition of the score file standard.
19608 * Headers:: How Gnus stores headers internally.
19609 * Ranges:: A handy format for storing mucho numbers.
19610 * Group Info:: The group info format.
19611 * Extended Interactive:: Symbolic prefixes and stuff.
19612 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
19613 * Various File Formats:: Formats of files that Gnus use.
19617 @node Gnus Utility Functions
19618 @subsection Gnus Utility Functions
19619 @cindex Gnus utility functions
19620 @cindex utility functions
19622 @cindex internal variables
19624 When writing small functions to be run from hooks (and stuff), it's
19625 vital to have access to the Gnus internal functions and variables.
19626 Below is a list of the most common ones.
19630 @item gnus-newsgroup-name
19631 @vindex gnus-newsgroup-name
19632 This variable holds the name of the current newsgroup.
19634 @item gnus-find-method-for-group
19635 @findex gnus-find-method-for-group
19636 A function that returns the select method for @var{group}.
19638 @item gnus-group-real-name
19639 @findex gnus-group-real-name
19640 Takes a full (prefixed) Gnus group name, and returns the unprefixed
19643 @item gnus-group-prefixed-name
19644 @findex gnus-group-prefixed-name
19645 Takes an unprefixed group name and a select method, and returns the full
19646 (prefixed) Gnus group name.
19648 @item gnus-get-info
19649 @findex gnus-get-info
19650 Returns the group info list for @var{group}.
19652 @item gnus-group-unread
19653 @findex gnus-group-unread
19654 The number of unread articles in @var{group}, or @code{t} if that is
19658 @findex gnus-active
19659 The active entry for @var{group}.
19661 @item gnus-set-active
19662 @findex gnus-set-active
19663 Set the active entry for @var{group}.
19665 @item gnus-add-current-to-buffer-list
19666 @findex gnus-add-current-to-buffer-list
19667 Adds the current buffer to the list of buffers to be killed on Gnus
19670 @item gnus-continuum-version
19671 @findex gnus-continuum-version
19672 Takes a Gnus version string as a parameter and returns a floating point
19673 number. Earlier versions will always get a lower number than later
19676 @item gnus-group-read-only-p
19677 @findex gnus-group-read-only-p
19678 Says whether @var{group} is read-only or not.
19680 @item gnus-news-group-p
19681 @findex gnus-news-group-p
19682 Says whether @var{group} came from a news backend.
19684 @item gnus-ephemeral-group-p
19685 @findex gnus-ephemeral-group-p
19686 Says whether @var{group} is ephemeral or not.
19688 @item gnus-server-to-method
19689 @findex gnus-server-to-method
19690 Returns the select method corresponding to @var{server}.
19692 @item gnus-server-equal
19693 @findex gnus-server-equal
19694 Says whether two virtual servers are equal.
19696 @item gnus-group-native-p
19697 @findex gnus-group-native-p
19698 Says whether @var{group} is native or not.
19700 @item gnus-group-secondary-p
19701 @findex gnus-group-secondary-p
19702 Says whether @var{group} is secondary or not.
19704 @item gnus-group-foreign-p
19705 @findex gnus-group-foreign-p
19706 Says whether @var{group} is foreign or not.
19708 @item group-group-find-parameter
19709 @findex group-group-find-parameter
19710 Returns the parameter list of @var{group}. If given a second parameter,
19711 returns the value of that parameter for @var{group}.
19713 @item gnus-group-set-parameter
19714 @findex gnus-group-set-parameter
19715 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
19717 @item gnus-narrow-to-body
19718 @findex gnus-narrow-to-body
19719 Narrows the current buffer to the body of the article.
19721 @item gnus-check-backend-function
19722 @findex gnus-check-backend-function
19723 Takes two parameters, @var{function} and @var{group}. If the backend
19724 @var{group} comes from supports @var{function}, return non-@code{nil}.
19727 (gnus-check-backend-function "request-scan" "nnml:misc")
19731 @item gnus-read-method
19732 @findex gnus-read-method
19733 Prompts the user for a select method.
19738 @node Backend Interface
19739 @subsection Backend Interface
19741 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
19742 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
19743 server is a @dfn{backend} and some @dfn{backend variables}. As examples
19744 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
19745 examples of the latter we have @code{nntp-port-number} and
19746 @code{nnmbox-directory}.
19748 When Gnus asks for information from a backend---say @code{nntp}---on
19749 something, it will normally include a virtual server name in the
19750 function parameters. (If not, the backend should use the ``current''
19751 virtual server.) For instance, @code{nntp-request-list} takes a virtual
19752 server as its only (optional) parameter. If this virtual server hasn't
19753 been opened, the function should fail.
19755 Note that a virtual server name has no relation to some physical server
19756 name. Take this example:
19760 (nntp-address "ifi.uio.no")
19761 (nntp-port-number 4324))
19764 Here the virtual server name is @samp{odd-one} while the name of
19765 the physical server is @samp{ifi.uio.no}.
19767 The backends should be able to switch between several virtual servers.
19768 The standard backends implement this by keeping an alist of virtual
19769 server environments that they pull down/push up when needed.
19771 There are two groups of interface functions: @dfn{required functions},
19772 which must be present, and @dfn{optional functions}, which Gnus will
19773 always check for presence before attempting to call 'em.
19775 All these functions are expected to return data in the buffer
19776 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
19777 unfortunately named, but we'll have to live with it. When I talk about
19778 @dfn{resulting data}, I always refer to the data in that buffer. When I
19779 talk about @dfn{return value}, I talk about the function value returned by
19780 the function call. Functions that fail should return @code{nil} as the
19783 Some backends could be said to be @dfn{server-forming} backends, and
19784 some might be said not to be. The latter are backends that generally
19785 only operate on one group at a time, and have no concept of ``server''
19786 -- they have a group, and they deliver info on that group and nothing
19789 In the examples and definitions I will refer to the imaginary backend
19792 @cindex @code{nnchoke}
19795 * Required Backend Functions:: Functions that must be implemented.
19796 * Optional Backend Functions:: Functions that need not be implemented.
19797 * Error Messaging:: How to get messages and report errors.
19798 * Writing New Backends:: Extending old backends.
19799 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
19800 * Mail-like Backends:: Some tips on mail backends.
19804 @node Required Backend Functions
19805 @subsubsection Required Backend Functions
19809 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
19811 @var{articles} is either a range of article numbers or a list of
19812 @code{Message-ID}s. Current backends do not fully support either---only
19813 sequences (lists) of article numbers, and most backends do not support
19814 retrieval of @code{Message-ID}s. But they should try for both.
19816 The result data should either be HEADs or NOV lines, and the result
19817 value should either be @code{headers} or @code{nov} to reflect this.
19818 This might later be expanded to @code{various}, which will be a mixture
19819 of HEADs and NOV lines, but this is currently not supported by Gnus.
19821 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
19822 headers", in some meaning of the word. This is generally done by
19823 fetching (at most) @var{fetch-old} extra headers less than the smallest
19824 article number in @code{articles}, and filling the gaps as well. The
19825 presence of this parameter can be ignored if the backend finds it
19826 cumbersome to follow the request. If this is non-@code{nil} and not a
19827 number, do maximum fetches.
19829 Here's an example HEAD:
19832 221 1056 Article retrieved.
19833 Path: ifi.uio.no!sturles
19834 From: sturles@@ifi.uio.no (Sturle Sunde)
19835 Newsgroups: ifi.discussion
19836 Subject: Re: Something very droll
19837 Date: 27 Oct 1994 14:02:57 +0100
19838 Organization: Dept. of Informatics, University of Oslo, Norway
19840 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
19841 References: <38jdmq$4qu@@visbur.ifi.uio.no>
19842 NNTP-Posting-Host: holmenkollen.ifi.uio.no
19846 So a @code{headers} return value would imply that there's a number of
19847 these in the data buffer.
19849 Here's a BNF definition of such a buffer:
19853 head = error / valid-head
19854 error-message = [ "4" / "5" ] 2number " " <error message> eol
19855 valid-head = valid-message *header "." eol
19856 valid-message = "221 " <number> " Article retrieved." eol
19857 header = <text> eol
19860 If the return value is @code{nov}, the data buffer should contain
19861 @dfn{network overview database} lines. These are basically fields
19865 nov-buffer = *nov-line
19866 nov-line = 8*9 [ field <TAB> ] eol
19867 field = <text except TAB>
19870 For a closer look at what should be in those fields,
19874 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
19876 @var{server} is here the virtual server name. @var{definitions} is a
19877 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
19879 If the server can't be opened, no error should be signaled. The backend
19880 may then choose to refuse further attempts at connecting to this
19881 server. In fact, it should do so.
19883 If the server is opened already, this function should return a
19884 non-@code{nil} value. There should be no data returned.
19887 @item (nnchoke-close-server &optional SERVER)
19889 Close connection to @var{server} and free all resources connected
19890 to it. Return @code{nil} if the server couldn't be closed for some
19893 There should be no data returned.
19896 @item (nnchoke-request-close)
19898 Close connection to all servers and free all resources that the backend
19899 have reserved. All buffers that have been created by that backend
19900 should be killed. (Not the @code{nntp-server-buffer}, though.) This
19901 function is generally only called when Gnus is shutting down.
19903 There should be no data returned.
19906 @item (nnchoke-server-opened &optional SERVER)
19908 If @var{server} is the current virtual server, and the connection to the
19909 physical server is alive, then this function should return a
19910 non-@code{nil} vlue. This function should under no circumstances
19911 attempt to reconnect to a server we have lost connection to.
19913 There should be no data returned.
19916 @item (nnchoke-status-message &optional SERVER)
19918 This function should return the last error message from @var{server}.
19920 There should be no data returned.
19923 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
19925 The result data from this function should be the article specified by
19926 @var{article}. This might either be a @code{Message-ID} or a number.
19927 It is optional whether to implement retrieval by @code{Message-ID}, but
19928 it would be nice if that were possible.
19930 If @var{to-buffer} is non-@code{nil}, the result data should be returned
19931 in this buffer instead of the normal data buffer. This is to make it
19932 possible to avoid copying large amounts of data from one buffer to
19933 another, while Gnus mainly requests articles to be inserted directly
19934 into its article buffer.
19936 If it is at all possible, this function should return a cons cell where
19937 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
19938 the article number. This will enable Gnus to find out what the real
19939 group and article numbers are when fetching articles by
19940 @code{Message-ID}. If this isn't possible, @code{t} should be returned
19941 on successful article retrieval.
19944 @item (nnchoke-request-group GROUP &optional SERVER FAST)
19946 Get data on @var{group}. This function also has the side effect of
19947 making @var{group} the current group.
19949 If @var{FAST}, don't bother to return useful data, just make @var{group}
19952 Here's an example of some result data and a definition of the same:
19955 211 56 1000 1059 ifi.discussion
19958 The first number is the status, which should be 211. Next is the
19959 total number of articles in the group, the lowest article number, the
19960 highest article number, and finally the group name. Note that the total
19961 number of articles may be less than one might think while just
19962 considering the highest and lowest article numbers, but some articles
19963 may have been canceled. Gnus just discards the total-number, so
19964 whether one should take the bother to generate it properly (if that is a
19965 problem) is left as an exercise to the reader.
19968 group-status = [ error / info ] eol
19969 error = [ "4" / "5" ] 2<number> " " <Error message>
19970 info = "211 " 3* [ <number> " " ] <string>
19974 @item (nnchoke-close-group GROUP &optional SERVER)
19976 Close @var{group} and free any resources connected to it. This will be
19977 a no-op on most backends.
19979 There should be no data returned.
19982 @item (nnchoke-request-list &optional SERVER)
19984 Return a list of all groups available on @var{server}. And that means
19987 Here's an example from a server that only carries two groups:
19990 ifi.test 0000002200 0000002000 y
19991 ifi.discussion 3324 3300 n
19994 On each line we have a group name, then the highest article number in
19995 that group, the lowest article number, and finally a flag.
19998 active-file = *active-line
19999 active-line = name " " <number> " " <number> " " flags eol
20001 flags = "n" / "y" / "m" / "x" / "j" / "=" name
20004 The flag says whether the group is read-only (@samp{n}), is moderated
20005 (@samp{m}), is dead (@samp{x}), is aliased to some other group
20006 (@samp{=other-group}) or none of the above (@samp{y}).
20009 @item (nnchoke-request-post &optional SERVER)
20011 This function should post the current buffer. It might return whether
20012 the posting was successful or not, but that's not required. If, for
20013 instance, the posting is done asynchronously, it has generally not been
20014 completed by the time this function concludes. In that case, this
20015 function should set up some kind of sentinel to beep the user loud and
20016 clear if the posting could not be completed.
20018 There should be no result data from this function.
20023 @node Optional Backend Functions
20024 @subsubsection Optional Backend Functions
20028 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
20030 @var{groups} is a list of groups, and this function should request data
20031 on all those groups. How it does it is of no concern to Gnus, but it
20032 should attempt to do this in a speedy fashion.
20034 The return value of this function can be either @code{active} or
20035 @code{group}, which says what the format of the result data is. The
20036 former is in the same format as the data from
20037 @code{nnchoke-request-list}, while the latter is a buffer full of lines
20038 in the same format as @code{nnchoke-request-group} gives.
20041 group-buffer = *active-line / *group-status
20045 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
20047 A Gnus group info (@pxref{Group Info}) is handed to the backend for
20048 alterations. This comes in handy if the backend really carries all the
20049 information (as is the case with virtual and imap groups). This
20050 function should destructively alter the info to suit its needs, and
20051 should return the (altered) group info.
20053 There should be no result data from this function.
20056 @item (nnchoke-request-type GROUP &optional ARTICLE)
20058 When the user issues commands for ``sending news'' (@kbd{F} in the
20059 summary buffer, for instance), Gnus has to know whether the article the
20060 user is following up on is news or mail. This function should return
20061 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
20062 is mail and @code{unknown} if the type can't be decided. (The
20063 @var{article} parameter is necessary in @code{nnvirtual} groups which
20064 might very well combine mail groups and news groups.) Both @var{group}
20065 and @var{article} may be @code{nil}.
20067 There should be no result data from this function.
20070 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
20072 Set/remove/add marks on articles. Normally Gnus handles the article
20073 marks (such as read, ticked, expired etc) internally, and store them in
20074 @code{~/.newsrc.eld}. Some backends (such as IMAP) however carry all
20075 information about the articles on the server, so Gnus need to propagate
20076 the mark information to the server.
20078 ACTION is a list of mark setting requests, having this format:
20081 (RANGE ACTION MARK)
20084 Range is a range of articles you wish to update marks on. Action is
20085 @code{set}, @code{add} or @code{del}, respectively used for removing all
20086 existing marks and setting them as specified, adding (preserving the
20087 marks not mentioned) mark and removing (preserving the marks not
20088 mentioned) marks. Mark is a list of marks; where each mark is a
20089 symbol. Currently used marks are @code{read}, @code{tick}, @code{reply},
20090 @code{expire}, @code{killed}, @code{dormant}, @code{save},
20091 @code{download} and @code{unsend}, but your backend should, if possible,
20092 not limit itself to theese.
20094 Given contradictory actions, the last action in the list should be the
20095 effective one. That is, if your action contains a request to add the
20096 @code{tick} mark on article 1 and, later in the list, a request to
20097 remove the mark on the same article, the mark should in fact be removed.
20099 An example action list:
20102 (((5 12 30) 'del '(tick))
20103 ((10 . 90) 'add '(read expire))
20104 ((92 94) 'del '(read)))
20107 The function should return a range of articles it wasn't able to set the
20108 mark on (currently not used for anything).
20110 There should be no result data from this function.
20112 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
20114 If the user tries to set a mark that the backend doesn't like, this
20115 function may change the mark. Gnus will use whatever this function
20116 returns as the mark for @var{article} instead of the original
20117 @var{mark}. If the backend doesn't care, it must return the original
20118 @var{mark}, and not @code{nil} or any other type of garbage.
20120 The only use for this I can see is what @code{nnvirtual} does with
20121 it---if a component group is auto-expirable, marking an article as read
20122 in the virtual group should result in the article being marked as
20125 There should be no result data from this function.
20128 @item (nnchoke-request-scan &optional GROUP SERVER)
20130 This function may be called at any time (by Gnus or anything else) to
20131 request that the backend check for incoming articles, in one way or
20132 another. A mail backend will typically read the spool file or query the
20133 POP server when this function is invoked. The @var{group} doesn't have
20134 to be heeded---if the backend decides that it is too much work just
20135 scanning for a single group, it may do a total scan of all groups. It
20136 would be nice, however, to keep things local if that's practical.
20138 There should be no result data from this function.
20141 @item (nnchoke-request-group-description GROUP &optional SERVER)
20143 The result data from this function should be a description of
20147 description-line = name <TAB> description eol
20149 description = <text>
20152 @item (nnchoke-request-list-newsgroups &optional SERVER)
20154 The result data from this function should be the description of all
20155 groups available on the server.
20158 description-buffer = *description-line
20162 @item (nnchoke-request-newgroups DATE &optional SERVER)
20164 The result data from this function should be all groups that were
20165 created after @samp{date}, which is in normal human-readable date
20166 format. The data should be in the active buffer format.
20169 @item (nnchoke-request-create-group GROUP &optional SERVER)
20171 This function should create an empty group with name @var{group}.
20173 There should be no return data.
20176 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
20178 This function should run the expiry process on all articles in the
20179 @var{articles} range (which is currently a simple list of article
20180 numbers.) It is left up to the backend to decide how old articles
20181 should be before they are removed by this function. If @var{force} is
20182 non-@code{nil}, all @var{articles} should be deleted, no matter how new
20185 This function should return a list of articles that it did not/was not
20188 There should be no result data returned.
20191 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
20194 This function should move @var{article} (which is a number) from
20195 @var{group} by calling @var{accept-form}.
20197 This function should ready the article in question for moving by
20198 removing any header lines it has added to the article, and generally
20199 should ``tidy up'' the article. Then it should @code{eval}
20200 @var{accept-form} in the buffer where the ``tidy'' article is. This
20201 will do the actual copying. If this @code{eval} returns a
20202 non-@code{nil} value, the article should be removed.
20204 If @var{last} is @code{nil}, that means that there is a high likelihood
20205 that there will be more requests issued shortly, so that allows some
20208 The function should return a cons where the @code{car} is the group name and
20209 the @code{cdr} is the article number that the article was entered as.
20211 There should be no data returned.
20214 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
20216 This function takes the current buffer and inserts it into @var{group}.
20217 If @var{last} in @code{nil}, that means that there will be more calls to
20218 this function in short order.
20220 The function should return a cons where the @code{car} is the group name and
20221 the @code{cdr} is the article number that the article was entered as.
20223 There should be no data returned.
20226 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
20228 This function should remove @var{article} (which is a number) from
20229 @var{group} and insert @var{buffer} there instead.
20231 There should be no data returned.
20234 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
20236 This function should delete @var{group}. If @var{force}, it should
20237 really delete all the articles in the group, and then delete the group
20238 itself. (If there is such a thing as ``the group itself''.)
20240 There should be no data returned.
20243 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
20245 This function should rename @var{group} into @var{new-name}. All
20246 articles in @var{group} should move to @var{new-name}.
20248 There should be no data returned.
20253 @node Error Messaging
20254 @subsubsection Error Messaging
20256 @findex nnheader-report
20257 @findex nnheader-get-report
20258 The backends should use the function @code{nnheader-report} to report
20259 error conditions---they should not raise errors when they aren't able to
20260 perform a request. The first argument to this function is the backend
20261 symbol, and the rest are interpreted as arguments to @code{format} if
20262 there are multiple of them, or just a string if there is one of them.
20263 This function must always returns @code{nil}.
20266 (nnheader-report 'nnchoke "You did something totally bogus")
20268 (nnheader-report 'nnchoke "Could not request group %s" group)
20271 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
20272 @code{nil} back from a server, and this function returns the most
20273 recently reported message for the backend in question. This function
20274 takes one argument---the server symbol.
20276 Internally, these functions access @var{backend}@code{-status-string},
20277 so the @code{nnchoke} backend will have its error message stored in
20278 @code{nnchoke-status-string}.
20281 @node Writing New Backends
20282 @subsubsection Writing New Backends
20284 Many backends are quite similar. @code{nnml} is just like
20285 @code{nnspool}, but it allows you to edit the articles on the server.
20286 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
20287 and it doesn't maintain overview databases. @code{nndir} is just like
20288 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
20291 It would make sense if it were possible to ``inherit'' functions from
20292 backends when writing new backends. And, indeed, you can do that if you
20293 want to. (You don't have to if you don't want to, of course.)
20295 All the backends declare their public variables and functions by using a
20296 package called @code{nnoo}.
20298 To inherit functions from other backends (and allow other backends to
20299 inherit functions from the current backend), you should use the
20305 This macro declares the first parameter to be a child of the subsequent
20306 parameters. For instance:
20309 (nnoo-declare nndir
20313 @code{nndir} has declared here that it intends to inherit functions from
20314 both @code{nnml} and @code{nnmh}.
20317 This macro is equivalent to @code{defvar}, but registers the variable as
20318 a public server variable. Most state-oriented variables should be
20319 declared with @code{defvoo} instead of @code{defvar}.
20321 In addition to the normal @code{defvar} parameters, it takes a list of
20322 variables in the parent backends to map the variable to when executing
20323 a function in those backends.
20326 (defvoo nndir-directory nil
20327 "Where nndir will look for groups."
20328 nnml-current-directory nnmh-current-directory)
20331 This means that @code{nnml-current-directory} will be set to
20332 @code{nndir-directory} when an @code{nnml} function is called on behalf
20333 of @code{nndir}. (The same with @code{nnmh}.)
20335 @item nnoo-define-basics
20336 This macro defines some common functions that almost all backends should
20340 (nnoo-define-basics nndir)
20344 This macro is just like @code{defun} and takes the same parameters. In
20345 addition to doing the normal @code{defun} things, it registers the
20346 function as being public so that other backends can inherit it.
20348 @item nnoo-map-functions
20349 This macro allows mapping of functions from the current backend to
20350 functions from the parent backends.
20353 (nnoo-map-functions nndir
20354 (nnml-retrieve-headers 0 nndir-current-group 0 0)
20355 (nnmh-request-article 0 nndir-current-group 0 0))
20358 This means that when @code{nndir-retrieve-headers} is called, the first,
20359 third, and fourth parameters will be passed on to
20360 @code{nnml-retrieve-headers}, while the second parameter is set to the
20361 value of @code{nndir-current-group}.
20364 This macro allows importing functions from backends. It should be the
20365 last thing in the source file, since it will only define functions that
20366 haven't already been defined.
20372 nnmh-request-newgroups)
20376 This means that calls to @code{nndir-request-list} should just be passed
20377 on to @code{nnmh-request-list}, while all public functions from
20378 @code{nnml} that haven't been defined in @code{nndir} yet should be
20383 Below is a slightly shortened version of the @code{nndir} backend.
20386 ;;; nndir.el --- single directory newsgroup access for Gnus
20387 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
20391 (require 'nnheader)
20395 (eval-when-compile (require 'cl))
20397 (nnoo-declare nndir
20400 (defvoo nndir-directory nil
20401 "Where nndir will look for groups."
20402 nnml-current-directory nnmh-current-directory)
20404 (defvoo nndir-nov-is-evil nil
20405 "*Non-nil means that nndir will never retrieve NOV headers."
20408 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
20409 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
20410 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
20412 (defvoo nndir-status-string "" nil nnmh-status-string)
20413 (defconst nndir-version "nndir 1.0")
20415 ;;; Interface functions.
20417 (nnoo-define-basics nndir)
20419 (deffoo nndir-open-server (server &optional defs)
20420 (setq nndir-directory
20421 (or (cadr (assq 'nndir-directory defs))
20423 (unless (assq 'nndir-directory defs)
20424 (push `(nndir-directory ,server) defs))
20425 (push `(nndir-current-group
20426 ,(file-name-nondirectory (directory-file-name nndir-directory)))
20428 (push `(nndir-top-directory
20429 ,(file-name-directory (directory-file-name nndir-directory)))
20431 (nnoo-change-server 'nndir server defs))
20433 (nnoo-map-functions nndir
20434 (nnml-retrieve-headers 0 nndir-current-group 0 0)
20435 (nnmh-request-article 0 nndir-current-group 0 0)
20436 (nnmh-request-group nndir-current-group 0 0)
20437 (nnmh-close-group nndir-current-group 0))
20441 nnmh-status-message
20443 nnmh-request-newgroups))
20449 @node Hooking New Backends Into Gnus
20450 @subsubsection Hooking New Backends Into Gnus
20452 @vindex gnus-valid-select-methods
20453 Having Gnus start using your new backend is rather easy---you just
20454 declare it with the @code{gnus-declare-backend} functions. This will
20455 enter the backend into the @code{gnus-valid-select-methods} variable.
20457 @code{gnus-declare-backend} takes two parameters---the backend name and
20458 an arbitrary number of @dfn{abilities}.
20463 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
20466 The abilities can be:
20470 This is a mailish backend---followups should (probably) go via mail.
20472 This is a newsish backend---followups should (probably) go via news.
20474 This backend supports both mail and news.
20476 This is neither a post nor mail backend---it's something completely
20479 It supports respooling---or rather, it is able to modify its source
20480 articles and groups.
20482 The name of the server should be in the virtual server name. This is
20483 true for almost all backends.
20484 @item prompt-address
20485 The user should be prompted for an address when doing commands like
20486 @kbd{B} in the group buffer. This is true for backends like
20487 @code{nntp}, but not @code{nnmbox}, for instance.
20491 @node Mail-like Backends
20492 @subsubsection Mail-like Backends
20494 One of the things that separate the mail backends from the rest of the
20495 backends is the heavy dependence by the mail backends on common
20496 functions in @file{nnmail.el}. For instance, here's the definition of
20497 @code{nnml-request-scan}:
20500 (deffoo nnml-request-scan (&optional group server)
20501 (setq nnml-article-file-alist nil)
20502 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
20505 It simply calls @code{nnmail-get-new-mail} with a few parameters,
20506 and @code{nnmail} takes care of all the moving and splitting of the
20509 This function takes four parameters.
20513 This should be a symbol to designate which backend is responsible for
20516 @item exit-function
20517 This function should be called after the splitting has been performed.
20519 @item temp-directory
20520 Where the temporary files should be stored.
20523 This optional argument should be a group name if the splitting is to be
20524 performed for one group only.
20527 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
20528 save each article. @var{backend}@code{-active-number} will be called to
20529 find the article number assigned to this article.
20531 The function also uses the following variables:
20532 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
20533 this backend); and @var{backend}@code{-group-alist} and
20534 @var{backend}@code{-active-file} to generate the new active file.
20535 @var{backend}@code{-group-alist} should be a group-active alist, like
20539 (("a-group" (1 . 10))
20540 ("some-group" (34 . 39)))
20544 @node Score File Syntax
20545 @subsection Score File Syntax
20547 Score files are meant to be easily parseable, but yet extremely
20548 mallable. It was decided that something that had the same read syntax
20549 as an Emacs Lisp list would fit that spec.
20551 Here's a typical score file:
20555 ("win95" -10000 nil s)
20562 BNF definition of a score file:
20565 score-file = "" / "(" *element ")"
20566 element = rule / atom
20567 rule = string-rule / number-rule / date-rule
20568 string-rule = "(" quote string-header quote space *string-match ")"
20569 number-rule = "(" quote number-header quote space *number-match ")"
20570 date-rule = "(" quote date-header quote space *date-match ")"
20572 string-header = "subject" / "from" / "references" / "message-id" /
20573 "xref" / "body" / "head" / "all" / "followup"
20574 number-header = "lines" / "chars"
20575 date-header = "date"
20576 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
20577 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
20578 score = "nil" / <integer>
20579 date = "nil" / <natural number>
20580 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
20581 "r" / "regex" / "R" / "Regex" /
20582 "e" / "exact" / "E" / "Exact" /
20583 "f" / "fuzzy" / "F" / "Fuzzy"
20584 number-match = "(" <integer> [ "" / [ space score [ "" /
20585 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
20586 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
20587 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
20588 space date [ "" / [ space date-match-t ] ] ] ] ")"
20589 date-match-t = "nil" / "at" / "before" / "after"
20590 atom = "(" [ required-atom / optional-atom ] ")"
20591 required-atom = mark / expunge / mark-and-expunge / files /
20592 exclude-files / read-only / touched
20593 optional-atom = adapt / local / eval
20594 mark = "mark" space nil-or-number
20595 nil-or-number = "nil" / <integer>
20596 expunge = "expunge" space nil-or-number
20597 mark-and-expunge = "mark-and-expunge" space nil-or-number
20598 files = "files" *[ space <string> ]
20599 exclude-files = "exclude-files" *[ space <string> ]
20600 read-only = "read-only" [ space "nil" / space "t" ]
20601 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
20602 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
20603 local = "local" *[ space "(" <string> space <form> ")" ]
20604 eval = "eval" space <form>
20605 space = *[ " " / <TAB> / <NEWLINE> ]
20608 Any unrecognized elements in a score file should be ignored, but not
20611 As you can see, white space is needed, but the type and amount of white
20612 space is irrelevant. This means that formatting of the score file is
20613 left up to the programmer---if it's simpler to just spew it all out on
20614 one looong line, then that's ok.
20616 The meaning of the various atoms are explained elsewhere in this
20617 manual (@pxref{Score File Format}).
20621 @subsection Headers
20623 Internally Gnus uses a format for storing article headers that
20624 corresponds to the @sc{nov} format in a mysterious fashion. One could
20625 almost suspect that the author looked at the @sc{nov} specification and
20626 just shamelessly @emph{stole} the entire thing, and one would be right.
20628 @dfn{Header} is a severely overloaded term. ``Header'' is used in
20629 RFC1036 to talk about lines in the head of an article (e.g.,
20630 @code{From}). It is used by many people as a synonym for
20631 ``head''---``the header and the body''. (That should be avoided, in my
20632 opinion.) And Gnus uses a format internally that it calls ``header'',
20633 which is what I'm talking about here. This is a 9-element vector,
20634 basically, with each header (ouch) having one slot.
20636 These slots are, in order: @code{number}, @code{subject}, @code{from},
20637 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
20638 @code{xref}, and @code{extra}. There are macros for accessing and
20639 setting these slots---they all have predictable names beginning with
20640 @code{mail-header-} and @code{mail-header-set-}, respectively.
20642 All these slots contain strings, except the @code{extra} slot, which
20643 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
20649 @sc{gnus} introduced a concept that I found so useful that I've started
20650 using it a lot and have elaborated on it greatly.
20652 The question is simple: If you have a large amount of objects that are
20653 identified by numbers (say, articles, to take a @emph{wild} example)
20654 that you want to qualify as being ``included'', a normal sequence isn't
20655 very useful. (A 200,000 length sequence is a bit long-winded.)
20657 The solution is as simple as the question: You just collapse the
20661 (1 2 3 4 5 6 10 11 12)
20664 is transformed into
20667 ((1 . 6) (10 . 12))
20670 To avoid having those nasty @samp{(13 . 13)} elements to denote a
20671 lonesome object, a @samp{13} is a valid element:
20674 ((1 . 6) 7 (10 . 12))
20677 This means that comparing two ranges to find out whether they are equal
20678 is slightly tricky:
20681 ((1 . 5) 7 8 (10 . 12))
20687 ((1 . 5) (7 . 8) (10 . 12))
20690 are equal. In fact, any non-descending list is a range:
20696 is a perfectly valid range, although a pretty long-winded one. This is
20703 and is equal to the previous range.
20705 Here's a BNF definition of ranges. Of course, one must remember the
20706 semantic requirement that the numbers are non-descending. (Any number
20707 of repetition of the same number is allowed, but apt to disappear in
20711 range = simple-range / normal-range
20712 simple-range = "(" number " . " number ")"
20713 normal-range = "(" start-contents ")"
20714 contents = "" / simple-range *[ " " contents ] /
20715 number *[ " " contents ]
20718 Gnus currently uses ranges to keep track of read articles and article
20719 marks. I plan on implementing a number of range operators in C if The
20720 Powers That Be are willing to let me. (I haven't asked yet, because I
20721 need to do some more thinking on what operators I need to make life
20722 totally range-based without ever having to convert back to normal
20727 @subsection Group Info
20729 Gnus stores all permanent info on groups in a @dfn{group info} list.
20730 This list is from three to six elements (or more) long and exhaustively
20731 describes the group.
20733 Here are two example group infos; one is a very simple group while the
20734 second is a more complex one:
20737 ("no.group" 5 ((1 . 54324)))
20739 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
20740 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
20742 ((auto-expire . t) (to-address . "ding@@gnus.org")))
20745 The first element is the @dfn{group name}---as Gnus knows the group,
20746 anyway. The second element is the @dfn{subscription level}, which
20747 normally is a small integer. (It can also be the @dfn{rank}, which is a
20748 cons cell where the @code{car} is the level and the @code{cdr} is the
20749 score.) The third element is a list of ranges of read articles. The
20750 fourth element is a list of lists of article marks of various kinds.
20751 The fifth element is the select method (or virtual server, if you like).
20752 The sixth element is a list of @dfn{group parameters}, which is what
20753 this section is about.
20755 Any of the last three elements may be missing if they are not required.
20756 In fact, the vast majority of groups will normally only have the first
20757 three elements, which saves quite a lot of cons cells.
20759 Here's a BNF definition of the group info format:
20762 info = "(" group space ralevel space read
20763 [ "" / [ space marks-list [ "" / [ space method [ "" /
20764 space parameters ] ] ] ] ] ")"
20765 group = quote <string> quote
20766 ralevel = rank / level
20767 level = <integer in the range of 1 to inf>
20768 rank = "(" level "." score ")"
20769 score = <integer in the range of 1 to inf>
20771 marks-lists = nil / "(" *marks ")"
20772 marks = "(" <string> range ")"
20773 method = "(" <string> *elisp-forms ")"
20774 parameters = "(" *elisp-forms ")"
20777 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
20778 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
20781 If you have a Gnus info and want to access the elements, Gnus offers a
20782 series of macros for getting/setting these elements.
20785 @item gnus-info-group
20786 @itemx gnus-info-set-group
20787 @findex gnus-info-group
20788 @findex gnus-info-set-group
20789 Get/set the group name.
20791 @item gnus-info-rank
20792 @itemx gnus-info-set-rank
20793 @findex gnus-info-rank
20794 @findex gnus-info-set-rank
20795 Get/set the group rank (@pxref{Group Score}).
20797 @item gnus-info-level
20798 @itemx gnus-info-set-level
20799 @findex gnus-info-level
20800 @findex gnus-info-set-level
20801 Get/set the group level.
20803 @item gnus-info-score
20804 @itemx gnus-info-set-score
20805 @findex gnus-info-score
20806 @findex gnus-info-set-score
20807 Get/set the group score (@pxref{Group Score}).
20809 @item gnus-info-read
20810 @itemx gnus-info-set-read
20811 @findex gnus-info-read
20812 @findex gnus-info-set-read
20813 Get/set the ranges of read articles.
20815 @item gnus-info-marks
20816 @itemx gnus-info-set-marks
20817 @findex gnus-info-marks
20818 @findex gnus-info-set-marks
20819 Get/set the lists of ranges of marked articles.
20821 @item gnus-info-method
20822 @itemx gnus-info-set-method
20823 @findex gnus-info-method
20824 @findex gnus-info-set-method
20825 Get/set the group select method.
20827 @item gnus-info-params
20828 @itemx gnus-info-set-params
20829 @findex gnus-info-params
20830 @findex gnus-info-set-params
20831 Get/set the group parameters.
20834 All the getter functions take one parameter---the info list. The setter
20835 functions take two parameters---the info list and the new value.
20837 The last three elements in the group info aren't mandatory, so it may be
20838 necessary to extend the group info before setting the element. If this
20839 is necessary, you can just pass on a non-@code{nil} third parameter to
20840 the three final setter functions to have this happen automatically.
20843 @node Extended Interactive
20844 @subsection Extended Interactive
20845 @cindex interactive
20846 @findex gnus-interactive
20848 Gnus extends the standard Emacs @code{interactive} specification
20849 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
20850 Prefixes}). Here's an example of how this is used:
20853 (defun gnus-summary-increase-score (&optional score symp)
20854 (interactive (gnus-interactive "P\ny"))
20859 The best thing to do would have been to implement
20860 @code{gnus-interactive} as a macro which would have returned an
20861 @code{interactive} form, but this isn't possible since Emacs checks
20862 whether a function is interactive or not by simply doing an @code{assq}
20863 on the lambda form. So, instead we have @code{gnus-interactive}
20864 function that takes a string and returns values that are usable to
20865 @code{interactive}.
20867 This function accepts (almost) all normal @code{interactive} specs, but
20872 @vindex gnus-current-prefix-symbol
20873 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
20877 @vindex gnus-current-prefix-symbols
20878 A list of the current symbolic prefixes---the
20879 @code{gnus-current-prefix-symbol} variable.
20882 The current article number---the @code{gnus-summary-article-number}
20886 The current article header---the @code{gnus-summary-article-header}
20890 The current group name---the @code{gnus-group-group-name}
20896 @node Emacs/XEmacs Code
20897 @subsection Emacs/XEmacs Code
20901 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
20902 platforms must be the primary one. I chose Emacs. Not because I don't
20903 like XEmacs or Mule, but because it comes first alphabetically.
20905 This means that Gnus will byte-compile under Emacs with nary a warning,
20906 while XEmacs will pump out gigabytes of warnings while byte-compiling.
20907 As I use byte-compilation warnings to help me root out trivial errors in
20908 Gnus, that's very useful.
20910 I've also consistently used Emacs function interfaces, but have used
20911 Gnusey aliases for the functions. To take an example: Emacs defines a
20912 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
20913 function. I then define a function called @code{gnus-run-at-time} that
20914 takes the same parameters as the Emacs @code{run-at-time}. When running
20915 Gnus under Emacs, the former function is just an alias for the latter.
20916 However, when running under XEmacs, the former is an alias for the
20917 following function:
20920 (defun gnus-xmas-run-at-time (time repeat function &rest args)
20924 (,function ,@@args))
20928 This sort of thing has been done for bunches of functions. Gnus does
20929 not redefine any native Emacs functions while running under XEmacs---it
20930 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
20933 In the cases where the XEmacs function interface was obviously cleaner,
20934 I used it instead. For example @code{gnus-region-active-p} is an alias
20935 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
20937 Of course, I could have chosen XEmacs as my native platform and done
20938 mapping functions the other way around. But I didn't. The performance
20939 hit these indirections impose on Gnus under XEmacs should be slight.
20942 @node Various File Formats
20943 @subsection Various File Formats
20946 * Active File Format:: Information on articles and groups available.
20947 * Newsgroups File Format:: Group descriptions.
20951 @node Active File Format
20952 @subsubsection Active File Format
20954 The active file lists all groups available on the server in
20955 question. It also lists the highest and lowest current article numbers
20958 Here's an excerpt from a typical active file:
20961 soc.motss 296030 293865 y
20962 alt.binaries.pictures.fractals 3922 3913 n
20963 comp.sources.unix 1605 1593 m
20964 comp.binaries.ibm.pc 5097 5089 y
20965 no.general 1000 900 y
20968 Here's a pseudo-BNF definition of this file:
20971 active = *group-line
20972 group-line = group space high-number space low-number space flag <NEWLINE>
20973 group = <non-white-space string>
20975 high-number = <non-negative integer>
20976 low-number = <positive integer>
20977 flag = "y" / "n" / "m" / "j" / "x" / "=" group
20980 For a full description of this file, see the manual pages for
20981 @samp{innd}, in particular @samp{active(5)}.
20984 @node Newsgroups File Format
20985 @subsubsection Newsgroups File Format
20987 The newsgroups file lists groups along with their descriptions. Not all
20988 groups on the server have to be listed, and not all groups in the file
20989 have to exist on the server. The file is meant purely as information to
20992 The format is quite simple; a group name, a tab, and the description.
20993 Here's the definition:
20997 line = group tab description <NEWLINE>
20998 group = <non-white-space string>
21000 description = <string>
21005 @node Emacs for Heathens
21006 @section Emacs for Heathens
21008 Believe it or not, but some people who use Gnus haven't really used
21009 Emacs much before they embarked on their journey on the Gnus Love Boat.
21010 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
21011 region'', and ``set @code{gnus-flargblossen} to an alist where the key
21012 is a regexp that is used for matching on the group name'' are magical
21013 phrases with little or no meaning, then this appendix is for you. If
21014 you are already familiar with Emacs, just ignore this and go fondle your
21018 * Keystrokes:: Entering text and executing commands.
21019 * Emacs Lisp:: The built-in Emacs programming language.
21024 @subsection Keystrokes
21028 Q: What is an experienced Emacs user?
21031 A: A person who wishes that the terminal had pedals.
21034 Yes, when you use Emacs, you are apt to use the control key, the shift
21035 key and the meta key a lot. This is very annoying to some people
21036 (notably @code{vi}le users), and the rest of us just love the hell out
21037 of it. Just give up and submit. Emacs really does stand for
21038 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
21039 may have heard from other disreputable sources (like the Emacs author).
21041 The shift keys are normally located near your pinky fingers, and are
21042 normally used to get capital letters and stuff. You probably use it all
21043 the time. The control key is normally marked ``CTRL'' or something like
21044 that. The meta key is, funnily enough, never marked as such on any
21045 keyboard. The one I'm currently at has a key that's marked ``Alt'',
21046 which is the meta key on this keyboard. It's usually located somewhere
21047 to the left hand side of the keyboard, usually on the bottom row.
21049 Now, us Emacs people don't say ``press the meta-control-m key'',
21050 because that's just too inconvenient. We say ``press the @kbd{M-C-m}
21051 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
21052 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
21053 down the control key, and hold it down while you press @kbd{k}''.
21054 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
21055 the control key and then press @kbd{k}''. Simple, ay?
21057 This is somewhat complicated by the fact that not all keyboards have a
21058 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
21059 means ``press escape, release escape, press @kbd{k}''. That's much more
21060 work than if you have a meta key, so if that's the case, I respectfully
21061 suggest you get a real keyboard with a meta key. You can't live without
21067 @subsection Emacs Lisp
21069 Emacs is the King of Editors because it's really a Lisp interpreter.
21070 Each and every key you tap runs some Emacs Lisp code snippet, and since
21071 Emacs Lisp is an interpreted language, that means that you can configure
21072 any key to run any arbitrary code. You just, like, do it.
21074 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
21075 functions. (These are byte-compiled for speed, but it's still
21076 interpreted.) If you decide that you don't like the way Gnus does
21077 certain things, it's trivial to have it do something a different way.
21078 (Well, at least if you know how to write Lisp code.) However, that's
21079 beyond the scope of this manual, so we are simply going to talk about
21080 some common constructs that you normally use in your @file{.emacs} file
21083 If you want to set the variable @code{gnus-florgbnize} to four (4), you
21084 write the following:
21087 (setq gnus-florgbnize 4)
21090 This function (really ``special form'') @code{setq} is the one that can
21091 set a variable to some value. This is really all you need to know. Now
21092 you can go and fill your @code{.emacs} file with lots of these to change
21095 If you have put that thing in your @code{.emacs} file, it will be read
21096 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
21097 start Emacs. If you want to change the variable right away, simply say
21098 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
21099 previous ``form'', which is a simple @code{setq} statement here.
21101 Go ahead---just try it, if you're located at your Emacs. After you
21102 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
21103 is the return value of the form you @code{eval}ed.
21107 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
21111 (setq gnus-read-active-file 'some)
21114 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
21115 @samp{nntp.ifi.uio.no}'', that means:
21118 (setq gnus-nntp-server "nntp.ifi.uio.no")
21121 So be careful not to mix up strings (the latter) with symbols (the
21122 former). The manual is unambiguous, but it can be confusing.
21125 @include gnus-faq.texi