1 \input texinfo @c -*-texinfo-*-
4 @settitle Pterodactyl Gnus 0.80 Manual
9 @c * Gnus: (gnus). The newsreader Gnus.
14 @setchapternewpage odd
18 \documentclass[twoside,a4paper,openright,11pt]{book}
19 \usepackage[latin1]{inputenc}
20 \usepackage{pagestyle}
28 \newcommand{\gnuschaptername}{}
29 \newcommand{\gnussectionname}{}
31 \newcommand{\gnusbackslash}{/}
33 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
34 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
36 \newcommand{\gnuskindex}[1]{\index{#1}}
37 \newcommand{\gnusindex}[1]{\index{#1}}
39 \newcommand{\gnustt}[1]{{\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}}
40 \newcommand{\gnuscode}[1]{\gnustt{#1}}
41 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}''}
42 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
43 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
44 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
45 \newcommand{\gnusdfn}[1]{\textit{#1}}
46 \newcommand{\gnusi}[1]{\textit{#1}}
47 \newcommand{\gnusstrong}[1]{\textbf{#1}}
48 \newcommand{\gnusemph}[1]{\textit{#1}}
49 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
50 \newcommand{\gnussc}[1]{\textsc{#1}}
51 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
52 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
54 \newcommand{\gnusbullet}{{${\bullet}$}}
55 \newcommand{\gnusdollar}{\$}
56 \newcommand{\gnusampersand}{\&}
57 \newcommand{\gnuspercent}{\%}
58 \newcommand{\gnushash}{\#}
59 \newcommand{\gnushat}{\symbol{"5E}}
60 \newcommand{\gnusunderline}{\symbol{"5F}}
61 \newcommand{\gnusnot}{$\neg$}
62 \newcommand{\gnustilde}{\symbol{"7E}}
63 \newcommand{\gnusless}{{$<$}}
64 \newcommand{\gnusgreater}{{$>$}}
65 \newcommand{\gnusbraceleft}{{$>$}}
66 \newcommand{\gnusbraceright}{{$>$}}
68 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head.eps,height=1cm}}}
69 \newcommand{\gnusinteresting}{
70 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
73 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
75 \newcommand{\gnuspagechapter}[1]{
82 \newcommand{\gnuschapter}[2]{
84 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
86 \renewcommand{\gnussectionname}{}
87 \renewcommand{\gnuschaptername}{#2}
90 \begin{picture}(500,500)(0,0)
91 \put(480,350){\makebox(0,0)[tr]{#1}}
92 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
97 \newcommand{\gnusfigure}[3]{
99 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
106 \newcommand{\gnusicon}[1]{
107 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=tmp/#1-up.ps,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=tmp/#1-up.ps,height=1cm}}}
110 \newcommand{\gnuspicon}[1]{
111 \margindex{\epsfig{figure=#1,width=2cm}}
114 \newcommand{\gnusxface}[2]{
115 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
118 \newcommand{\gnussmiley}[2]{
119 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
122 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
124 \newcommand{\gnussection}[1]{
125 \renewcommand{\gnussectionname}{#1}
129 \newenvironment{codelist}%
134 \newenvironment{kbdlist}%
140 \newenvironment{dfnlist}%
145 \newenvironment{stronglist}%
150 \newenvironment{samplist}%
155 \newenvironment{varlist}%
160 \newenvironment{emphlist}%
165 \newlength\gnusheadtextwidth
166 \setlength{\gnusheadtextwidth}{\headtextwidth}
167 \addtolength{\gnusheadtextwidth}{1cm}
169 \newpagestyle{gnuspreamble}%
174 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
178 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
187 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
189 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
194 \newpagestyle{gnusindex}%
199 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
203 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
211 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
213 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
223 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
227 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
235 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
237 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo.eps,height=1cm}}
242 \pagenumbering{roman}
243 \pagestyle{gnuspreamble}
253 %\addtolength{\oddsidemargin}{-5cm}
254 %\addtolength{\evensidemargin}{-5cm}
256 \addtolength{\textheight}{2cm}
258 \gnustitle{\gnustitlename}\\
261 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo.eps,height=15cm}
264 \gnusauthor{by Lars Magne Ingebrigtsen}
271 \thispagestyle{empty}
273 Copyright \copyright{} 1995,96,97,98,99 Free Software Foundation, Inc.
275 Permission is granted to make and distribute verbatim copies of
276 this manual provided the copyright notice and this permission notice
277 are preserved on all copies.
279 Permission is granted to copy and distribute modified versions of this
280 manual under the conditions for verbatim copying, provided that the
281 entire resulting derived work is distributed under the terms of a
282 permission notice identical to this one.
284 Permission is granted to copy and distribute translations of this manual
285 into another language, under the above conditions for modified versions.
294 This file documents Gnus, the GNU Emacs newsreader.
296 Copyright (C) 1995,96,97,98,99 Free Software Foundation, Inc.
298 Permission is granted to make and distribute verbatim copies of
299 this manual provided the copyright notice and this permission notice
300 are preserved on all copies.
303 Permission is granted to process this file through Tex and print the
304 results, provided the printed document carries copying permission
305 notice identical to this one except for the removal of this paragraph
306 (this paragraph not being relevant to the printed manual).
309 Permission is granted to copy and distribute modified versions of this
310 manual under the conditions for verbatim copying, provided also that the
311 entire resulting derived work is distributed under the terms of a
312 permission notice identical to this one.
314 Permission is granted to copy and distribute translations of this manual
315 into another language, under the above conditions for modified versions.
321 @title Pterodactyl Gnus 0.80 Manual
323 @author by Lars Magne Ingebrigtsen
326 @vskip 0pt plus 1filll
327 Copyright @copyright{} 1995,96,97,98,99 Free Software Foundation, Inc.
329 Permission is granted to make and distribute verbatim copies of
330 this manual provided the copyright notice and this permission notice
331 are preserved on all copies.
333 Permission is granted to copy and distribute modified versions of this
334 manual under the conditions for verbatim copying, provided that the
335 entire resulting derived work is distributed under the terms of a
336 permission notice identical to this one.
338 Permission is granted to copy and distribute translations of this manual
339 into another language, under the above conditions for modified versions.
348 @top The Gnus Newsreader
352 You can read news (and mail) from within Emacs by using Gnus. The news
353 can be gotten by any nefarious means you can think of---@sc{nntp}, local
354 spool or your mbox file. All at the same time, if you want to push your
357 This manual corresponds to Pterodactyl Gnus 0.80.
368 Gnus is the advanced, self-documenting, customizable, extensible
369 unreal-time newsreader for GNU Emacs.
371 Oops. That sounds oddly familiar, so let's start over again to avoid
372 being accused of plagiarism:
374 Gnus is a message-reading laboratory. It will let you look at just
375 about anything as if it were a newsgroup. You can read mail with it,
376 you can browse directories with it, you can @code{ftp} with it---you can
377 even read news with it!
379 Gnus tries to empower people who read news the same way Emacs empowers
380 people who edit text. Gnus sets no limits to what the user should be
381 allowed to do. Users are encouraged to extend Gnus to make it behave
382 like they want it to behave. A program should not control people;
383 people should be empowered to do what they want by using (or abusing)
390 * Starting Up:: Finding news can be a pain.
391 * The Group Buffer:: Selecting, subscribing and killing groups.
392 * The Summary Buffer:: Reading, saving and posting articles.
393 * The Article Buffer:: Displaying and handling articles.
394 * Composing Messages:: Information on sending mail and news.
395 * Select Methods:: Gnus reads all messages from various select methods.
396 * Scoring:: Assigning values to articles.
397 * Various:: General purpose settings.
398 * The End:: Farewell and goodbye.
399 * Appendices:: Terminology, Emacs intro, FAQ, History, Internals.
400 * Index:: Variable, function and concept index.
401 * Key Index:: Key Index.
405 @chapter Starting Gnus
410 If your system administrator has set things up properly, starting Gnus
411 and reading news is extremely easy---you just type @kbd{M-x gnus} in
414 @findex gnus-other-frame
415 @kindex M-x gnus-other-frame
416 If you want to start Gnus in a different frame, you can use the command
417 @kbd{M-x gnus-other-frame} instead.
419 If things do not go smoothly at startup, you have to twiddle some
420 variables in your @file{~/.gnus} file. This file is similar to
421 @file{~/.emacs}, but is read when gnus starts.
423 If you puzzle at any terms used in this manual, please refer to the
424 terminology section (@pxref{Terminology}).
427 * Finding the News:: Choosing a method for getting news.
428 * The First Time:: What does Gnus do the first time you start it?
429 * The Server is Down:: How can I read my mail then?
430 * Slave Gnusae:: You can have more than one Gnus active at a time.
431 * Fetching a Group:: Starting Gnus just to read a group.
432 * New Groups:: What is Gnus supposed to do with new groups?
433 * Startup Files:: Those pesky startup files---@file{.newsrc}.
434 * Auto Save:: Recovering from a crash.
435 * The Active File:: Reading the active file over a slow line Takes Time.
436 * Changing Servers:: You may want to move from one server to another.
437 * Startup Variables:: Other variables you might change.
441 @node Finding the News
442 @section Finding the News
445 @vindex gnus-select-method
447 The @code{gnus-select-method} variable says where Gnus should look for
448 news. This variable should be a list where the first element says
449 @dfn{how} and the second element says @dfn{where}. This method is your
450 native method. All groups not fetched with this method are
453 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
454 you want to get your daily dosage of news from, you'd say:
457 (setq gnus-select-method '(nntp "news.somewhere.edu"))
460 If you want to read directly from the local spool, say:
463 (setq gnus-select-method '(nnspool ""))
466 If you can use a local spool, you probably should, as it will almost
467 certainly be much faster.
469 @vindex gnus-nntpserver-file
471 @cindex @sc{nntp} server
472 If this variable is not set, Gnus will take a look at the
473 @code{NNTPSERVER} environment variable. If that variable isn't set,
474 Gnus will see whether @code{gnus-nntpserver-file}
475 (@file{/etc/nntpserver} by default) has any opinions on the matter. If
476 that fails as well, Gnus will try to use the machine running Emacs as an @sc{nntp} server. That's a long shot, though.
478 @vindex gnus-nntp-server
479 If @code{gnus-nntp-server} is set, this variable will override
480 @code{gnus-select-method}. You should therefore set
481 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
483 @vindex gnus-secondary-servers
484 @vindex gnus-nntp-server
485 You can also make Gnus prompt you interactively for the name of an
486 @sc{nntp} server. If you give a non-numerical prefix to @code{gnus}
487 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
488 in the @code{gnus-secondary-servers} list (if any). You can also just
489 type in the name of any server you feel like visiting. (Note that this
490 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
491 gnus} later in the same Emacs session, Gnus will contact the same
494 @findex gnus-group-browse-foreign-server
496 However, if you use one @sc{nntp} server regularly and are just
497 interested in a couple of groups from a different server, you would be
498 better served by using the @kbd{B} command in the group buffer. It will
499 let you have a look at what groups are available, and you can subscribe
500 to any of the groups you want to. This also makes @file{.newsrc}
501 maintenance much tidier. @xref{Foreign Groups}.
503 @vindex gnus-secondary-select-methods
505 A slightly different approach to foreign groups is to set the
506 @code{gnus-secondary-select-methods} variable. The select methods
507 listed in this variable are in many ways just as native as the
508 @code{gnus-select-method} server. They will also be queried for active
509 files during startup (if that's required), and new newsgroups that
510 appear on these servers will be subscribed (or not) just as native
513 For instance, if you use the @code{nnmbox} backend to read your mail, you
514 would typically set this variable to
517 (setq gnus-secondary-select-methods '((nnmbox "")))
522 @section The First Time
523 @cindex first time usage
525 If no startup files exist, Gnus will try to determine what groups should
526 be subscribed by default.
528 @vindex gnus-default-subscribed-newsgroups
529 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
530 will subscribe you to just those groups in that list, leaving the rest
531 killed. Your system administrator should have set this variable to
534 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
535 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
536 here as @dfn{whatever Lars thinks you should read}.)
538 You'll also be subscribed to the Gnus documentation group, which should
539 help you with most common problems.
541 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
542 use the normal functions for handling new groups, and not do anything
546 @node The Server is Down
547 @section The Server is Down
548 @cindex server errors
550 If the default server is down, Gnus will understandably have some
551 problems starting. However, if you have some mail groups in addition to
552 the news groups, you may want to start Gnus anyway.
554 Gnus, being the trusting sort of program, will ask whether to proceed
555 without a native select method if that server can't be contacted. This
556 will happen whether the server doesn't actually exist (i.e., you have
557 given the wrong address) or the server has just momentarily taken ill
558 for some reason or other. If you decide to continue and have no foreign
559 groups, you'll find it difficult to actually do anything in the group
560 buffer. But, hey, that's your problem. Blllrph!
562 @findex gnus-no-server
563 @kindex M-x gnus-no-server
565 If you know that the server is definitely down, or you just want to read
566 your mail without bothering with the server at all, you can use the
567 @code{gnus-no-server} command to start Gnus. That might come in handy
568 if you're in a hurry as well. This command will not attempt to contact
569 your primary server---instead, it will just activate all groups on level
570 1 and 2. (You should preferably keep no native groups on those two
575 @section Slave Gnusae
578 You might want to run more than one Emacs with more than one Gnus at the
579 same time. If you are using different @file{.newsrc} files (e.g., if you
580 are using the two different Gnusae to read from two different servers),
581 that is no problem whatsoever. You just do it.
583 The problem appears when you want to run two Gnusae that use the same
586 To work around that problem some, we here at the Think-Tank at the Gnus
587 Towers have come up with a new concept: @dfn{Masters} and
588 @dfn{slaves}. (We have applied for a patent on this concept, and have
589 taken out a copyright on those words. If you wish to use those words in
590 conjunction with each other, you have to send $1 per usage instance to
591 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
592 Applications}) will be much more expensive, of course.)
594 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
595 however you do it). Each subsequent slave Gnusae should be started with
596 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
597 files, but instead save @dfn{slave files} that contain information only
598 on what groups have been read in the slave session. When a master Gnus
599 starts, it will read (and delete) these slave files, incorporating all
600 information from them. (The slave files will be read in the sequence
601 they were created, so the latest changes will have precedence.)
603 Information from the slave files has, of course, precedence over the
604 information in the normal (i.e., master) @code{.newsrc} file.
607 @node Fetching a Group
608 @section Fetching a Group
609 @cindex fetching a group
611 @findex gnus-fetch-group
612 It is sometimes convenient to be able to just say ``I want to read this
613 group and I don't care whether Gnus has been started or not''. This is
614 perhaps more useful for people who write code than for users, but the
615 command @code{gnus-fetch-group} provides this functionality in any case.
616 It takes the group name as a parameter.
624 @vindex gnus-check-new-newsgroups
625 If you are satisfied that you really never want to see any new groups,
626 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
627 also save you some time at startup. Even if this variable is
628 @code{nil}, you can always subscribe to the new groups just by pressing
629 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
630 is @code{ask-server} by default. If you set this variable to
631 @code{always}, then Gnus will query the backends for new groups even
632 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
635 * Checking New Groups:: Determining what groups are new.
636 * Subscription Methods:: What Gnus should do with new groups.
637 * Filtering New Groups:: Making Gnus ignore certain new groups.
641 @node Checking New Groups
642 @subsection Checking New Groups
644 Gnus normally determines whether a group is new or not by comparing the
645 list of groups from the active file(s) with the lists of subscribed and
646 dead groups. This isn't a particularly fast method. If
647 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
648 server for new groups since the last time. This is both faster and
649 cheaper. This also means that you can get rid of the list of killed
650 groups altogether, so you may set @code{gnus-save-killed-list} to
651 @code{nil}, which will save time both at startup, at exit, and all over.
652 Saves disk space, too. Why isn't this the default, then?
653 Unfortunately, not all servers support this command.
655 I bet I know what you're thinking now: How do I find out whether my
656 server supports @code{ask-server}? No? Good, because I don't have a
657 fail-safe answer. I would suggest just setting this variable to
658 @code{ask-server} and see whether any new groups appear within the next
659 few days. If any do, then it works. If none do, then it doesn't
660 work. I could write a function to make Gnus guess whether the server
661 supports @code{ask-server}, but it would just be a guess. So I won't.
662 You could @code{telnet} to the server and say @code{HELP} and see
663 whether it lists @samp{NEWGROUPS} among the commands it understands. If
664 it does, then it might work. (But there are servers that lists
665 @samp{NEWGROUPS} without supporting the function properly.)
667 This variable can also be a list of select methods. If so, Gnus will
668 issue an @code{ask-server} command to each of the select methods, and
669 subscribe them (or not) using the normal methods. This might be handy
670 if you are monitoring a few servers for new groups. A side effect is
671 that startup will take much longer, so you can meditate while waiting.
672 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
675 @node Subscription Methods
676 @subsection Subscription Methods
678 @vindex gnus-subscribe-newsgroup-method
679 What Gnus does when it encounters a new group is determined by the
680 @code{gnus-subscribe-newsgroup-method} variable.
682 This variable should contain a function. This function will be called
683 with the name of the new group as the only parameter.
685 Some handy pre-fab functions are:
689 @item gnus-subscribe-zombies
690 @vindex gnus-subscribe-zombies
691 Make all new groups zombies. This is the default. You can browse the
692 zombies later (with @kbd{A z}) and either kill them all off properly
693 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
695 @item gnus-subscribe-randomly
696 @vindex gnus-subscribe-randomly
697 Subscribe all new groups in arbitrary order. This really means that all
698 new groups will be added at ``the top'' of the group buffer.
700 @item gnus-subscribe-alphabetically
701 @vindex gnus-subscribe-alphabetically
702 Subscribe all new groups in alphabetical order.
704 @item gnus-subscribe-hierarchically
705 @vindex gnus-subscribe-hierarchically
706 Subscribe all new groups hierarchically. The difference between this
707 function and @code{gnus-subscribe-alphabetically} is slight.
708 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
709 alphabetical fashion, while this function will enter groups into it's
710 hierarchy. So if you want to have the @samp{rec} hierarchy before the
711 @samp{comp} hierarchy, this function will not mess that configuration
712 up. Or something like that.
714 @item gnus-subscribe-interactively
715 @vindex gnus-subscribe-interactively
716 Subscribe new groups interactively. This means that Gnus will ask
717 you about @strong{all} new groups. The groups you choose to subscribe
718 to will be subscribed hierarchically.
720 @item gnus-subscribe-killed
721 @vindex gnus-subscribe-killed
726 @vindex gnus-subscribe-hierarchical-interactive
727 A closely related variable is
728 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
729 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
730 hierarchical fashion whether to subscribe to new groups or not. Gnus
731 will ask you for each sub-hierarchy whether you want to descend the
734 One common mistake is to set the variable a few paragraphs above
735 (@code{gnus-subscribe-newsgroup-method}) to
736 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
737 will not work. This is ga-ga. So don't do it.
740 @node Filtering New Groups
741 @subsection Filtering New Groups
743 A nice and portable way to control which new newsgroups should be
744 subscribed (or ignored) is to put an @dfn{options} line at the start of
745 the @file{.newsrc} file. Here's an example:
748 options -n !alt.all !rec.all sci.all
751 @vindex gnus-subscribe-options-newsgroup-method
752 This line obviously belongs to a serious-minded intellectual scientific
753 person (or she may just be plain old boring), because it says that all
754 groups that have names beginning with @samp{alt} and @samp{rec} should
755 be ignored, and all groups with names beginning with @samp{sci} should
756 be subscribed. Gnus will not use the normal subscription method for
757 subscribing these groups.
758 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
759 variable defaults to @code{gnus-subscribe-alphabetically}.
761 @vindex gnus-options-not-subscribe
762 @vindex gnus-options-subscribe
763 If you don't want to mess with your @file{.newsrc} file, you can just
764 set the two variables @code{gnus-options-subscribe} and
765 @code{gnus-options-not-subscribe}. These two variables do exactly the
766 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
767 and if the new group matches the former, it will be unconditionally
768 subscribed, and if it matches the latter, it will be ignored.
770 @vindex gnus-auto-subscribed-groups
771 Yet another variable that meddles here is
772 @code{gnus-auto-subscribed-groups}. It works exactly like
773 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
774 thought it would be nice to have two of these. This variable is more
775 meant for setting some ground rules, while the other variable is used
776 more for user fiddling. By default this variable makes all new groups
777 that come from mail backends (@code{nnml}, @code{nnbabyl},
778 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you
779 don't like that, just set this variable to @code{nil}.
781 New groups that match this regexp are subscribed using
782 @code{gnus-subscribe-options-newsgroup-method}.
785 @node Changing Servers
786 @section Changing Servers
787 @cindex changing servers
789 Sometimes it is necessary to move from one @sc{nntp} server to another.
790 This happens very rarely, but perhaps you change jobs, or one server is
791 very flaky and you want to use another.
793 Changing the server is pretty easy, right? You just change
794 @code{gnus-select-method} to point to the new server?
798 Article numbers are not (in any way) kept synchronized between different
799 @sc{nntp} servers, and the only way Gnus keeps track of what articles
800 you have read is by keeping track of article numbers. So when you
801 change @code{gnus-select-method}, your @file{.newsrc} file becomes
804 Gnus provides a few functions to attempt to translate a @file{.newsrc}
805 file from one server to another. They all have one thing in
806 common---they take a looong time to run. You don't want to use these
807 functions more than absolutely necessary.
809 @kindex M-x gnus-change-server
810 @findex gnus-change-server
811 If you have access to both servers, Gnus can request the headers for all
812 the articles you have read and compare @code{Message-ID}s and map the
813 article numbers of the read articles and article marks. The @kbd{M-x
814 gnus-change-server} command will do this for all your native groups. It
815 will prompt for the method you want to move to.
817 @kindex M-x gnus-group-move-group-to-server
818 @findex gnus-group-move-group-to-server
819 You can also move individual groups with the @kbd{M-x
820 gnus-group-move-group-to-server} command. This is useful if you want to
821 move a (foreign) group from one server to another.
823 @kindex M-x gnus-group-clear-data-on-native-groups
824 @findex gnus-group-clear-data-on-native-groups
825 If you don't have access to both the old and new server, all your marks
826 and read ranges have become worthless. You can use the @kbd{M-x
827 gnus-group-clear-data-on-native-groups} command to clear out all data
828 that you have on your native groups. Use with caution.
830 After changing servers, you @strong{must} move the cache hierarchy away,
831 since the cached articles will have wrong article numbers, which will
832 affect which articles Gnus thinks are read.
836 @section Startup Files
837 @cindex startup files
842 Now, you all know about the @file{.newsrc} file. All subscription
843 information is traditionally stored in this file.
845 Things got a bit more complicated with @sc{gnus}. In addition to
846 keeping the @file{.newsrc} file updated, it also used a file called
847 @file{.newsrc.el} for storing all the information that didn't fit into
848 the @file{.newsrc} file. (Actually, it also duplicated everything in
849 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
850 files was the most recently saved, which enabled people to swap between
851 @sc{gnus} and other newsreaders.
853 That was kinda silly, so Gnus went one better: In addition to the
854 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
855 @file{.newsrc.eld}. It will read whichever of these files that are most
856 recent, but it will never write a @file{.newsrc.el} file. You should
857 never delete the @file{.newsrc.eld} file---it contains much information
858 not stored in the @file{.newsrc} file.
860 @vindex gnus-save-newsrc-file
861 You can turn off writing the @file{.newsrc} file by setting
862 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
863 the file and save some space, as well as exiting from Gnus faster.
864 However, this will make it impossible to use other newsreaders than
865 Gnus. But hey, who would want to, right?
867 @vindex gnus-save-killed-list
868 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
869 will not save the list of killed groups to the startup file. This will
870 save both time (when starting and quitting) and space (on disk). It
871 will also mean that Gnus has no record of what groups are new or old,
872 so the automatic new groups subscription methods become meaningless.
873 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
874 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
875 Groups}). This variable can also be a regular expression. If that's
876 the case, remove all groups that do not match this regexp before
877 saving. This can be useful in certain obscure situations that involve
878 several servers where not all servers support @code{ask-server}.
880 @vindex gnus-startup-file
881 The @code{gnus-startup-file} variable says where the startup files are.
882 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
883 file being whatever that one is, with a @samp{.eld} appended.
885 @vindex gnus-save-newsrc-hook
886 @vindex gnus-save-quick-newsrc-hook
887 @vindex gnus-save-standard-newsrc-hook
888 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
889 files, while @code{gnus-save-quick-newsrc-hook} is called just before
890 saving the @file{.newsrc.eld} file, and
891 @code{gnus-save-standard-newsrc-hook} is called just before saving the
892 @file{.newsrc} file. The latter two are commonly used to turn version
893 control on or off. Version control is on by default when saving the
894 startup files. If you want to turn backup creation off, say something like:
897 (defun turn-off-backup ()
898 (set (make-local-variable 'backup-inhibited) t))
900 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
901 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
904 @vindex gnus-init-file
905 When Gnus starts, it will read the @code{gnus-site-init-file}
906 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
907 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
908 and can be used to avoid cluttering your @file{~/.emacs} and
909 @file{site-init} files with Gnus stuff. Gnus will also check for files
910 with the same names as these, but with @file{.elc} and @file{.el}
911 suffixes. In other words, if you have set @code{gnus-init-file} to
912 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
913 and finally @file{~/.gnus} (in this order).
922 Whenever you do something that changes the Gnus data (reading articles,
923 catching up, killing/subscribing groups), the change is added to a
924 special @dfn{dribble buffer}. This buffer is auto-saved the normal
925 Emacs way. If your Emacs should crash before you have saved the
926 @file{.newsrc} files, all changes you have made can be recovered from
929 If Gnus detects this file at startup, it will ask the user whether to
930 read it. The auto save file is deleted whenever the real startup file is
933 @vindex gnus-use-dribble-file
934 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
935 maintain a dribble buffer. The default is @code{t}.
937 @vindex gnus-dribble-directory
938 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
939 this variable is @code{nil}, which it is by default, Gnus will dribble
940 into the directory where the @file{.newsrc} file is located. (This is
941 normally the user's home directory.) The dribble file will get the same
942 file permissions as the @code{.newsrc} file.
944 @vindex gnus-always-read-dribble-file
945 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
946 read the dribble file on startup without querying the user.
949 @node The Active File
950 @section The Active File
952 @cindex ignored groups
954 When Gnus starts, or indeed whenever it tries to determine whether new
955 articles have arrived, it reads the active file. This is a very large
956 file that lists all the active groups and articles on the server.
958 @vindex gnus-ignored-newsgroups
959 Before examining the active file, Gnus deletes all lines that match the
960 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
961 any groups with bogus names, but you can use this variable to make Gnus
962 ignore hierarchies you aren't ever interested in. However, this is not
963 recommended. In fact, it's highly discouraged. Instead, @pxref{New
964 Groups} for an overview of other variables that can be used instead.
967 @c @code{nil} by default, and will slow down active file handling somewhat
968 @c if you set it to anything else.
970 @vindex gnus-read-active-file
972 The active file can be rather Huge, so if you have a slow network, you
973 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
974 reading the active file. This variable is @code{some} by default.
976 Gnus will try to make do by getting information just on the groups that
977 you actually subscribe to.
979 Note that if you subscribe to lots and lots of groups, setting this
980 variable to @code{nil} will probably make Gnus slower, not faster. At
981 present, having this variable @code{nil} will slow Gnus down
982 considerably, unless you read news over a 2400 baud modem.
984 This variable can also have the value @code{some}. Gnus will then
985 attempt to read active info only on the subscribed groups. On some
986 servers this is quite fast (on sparkling, brand new INN servers that
987 support the @code{LIST ACTIVE group} command), on others this isn't fast
988 at all. In any case, @code{some} should be faster than @code{nil}, and
989 is certainly faster than @code{t} over slow lines.
991 If this variable is @code{nil}, Gnus will ask for group info in total
992 lock-step, which isn't very fast. If it is @code{some} and you use an
993 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
994 read all the replies in one swoop. This will normally result in better
995 performance, but if the server does not support the aforementioned
996 @code{LIST ACTIVE group} command, this isn't very nice to the server.
998 In any case, if you use @code{some} or @code{nil}, you should definitely
999 kill all groups that you aren't interested in to speed things up.
1001 Note that this variable also affects active file retrieval from
1002 secondary select methods.
1005 @node Startup Variables
1006 @section Startup Variables
1010 @item gnus-load-hook
1011 @vindex gnus-load-hook
1012 A hook run while Gnus is being loaded. Note that this hook will
1013 normally be run just once in each Emacs session, no matter how many
1014 times you start Gnus.
1016 @item gnus-before-startup-hook
1017 @vindex gnus-before-startup-hook
1018 A hook run after starting up Gnus successfully.
1020 @item gnus-startup-hook
1021 @vindex gnus-startup-hook
1022 A hook run as the very last thing after starting up Gnus
1024 @item gnus-started-hook
1025 @vindex gnus-started-hook
1026 A hook that is run as the very last thing after starting up Gnus
1029 @item gnus-started-hook
1030 @vindex gnus-started-hook
1031 A hook that is run after reading the @file{.newsrc} file(s), but before
1032 generating the group buffer.
1034 @item gnus-check-bogus-newsgroups
1035 @vindex gnus-check-bogus-newsgroups
1036 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1037 startup. A @dfn{bogus group} is a group that you have in your
1038 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1039 bogus groups can take quite a while, so to save time and resources it's
1040 best to leave this option off, and do the checking for bogus groups once
1041 in a while from the group buffer instead (@pxref{Group Maintenance}).
1043 @item gnus-inhibit-startup-message
1044 @vindex gnus-inhibit-startup-message
1045 If non-@code{nil}, the startup message won't be displayed. That way,
1046 your boss might not notice as easily that you are reading news instead
1047 of doing your job. Note that this variable is used before
1048 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1050 @item gnus-no-groups-message
1051 @vindex gnus-no-groups-message
1052 Message displayed by Gnus when no groups are available.
1054 @item gnus-play-startup-jingle
1055 @vindex gnus-play-startup-jingle
1056 If non-@code{nil}, play the Gnus jingle at startup.
1058 @item gnus-startup-jingle
1059 @vindex gnus-startup-jingle
1060 Jingle to be played if the above variable is non-@code{nil}. The
1061 default is @samp{Tuxedomoon.Jingle4.au}.
1066 @node The Group Buffer
1067 @chapter The Group Buffer
1068 @cindex group buffer
1070 The @dfn{group buffer} lists all (or parts) of the available groups. It
1071 is the first buffer shown when Gnus starts, and will never be killed as
1072 long as Gnus is active.
1076 \gnusfigure{The Group Buffer}{320}{
1077 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1078 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1079 \put(120,38){\vector(1,2){10}}
1080 \put(40,60){\makebox(0,0)[r]{Mode line}}
1081 \put(40,58){\vector(1,0){30}}
1082 \put(200,28){\makebox(0,0)[t]{Native select method}}
1083 \put(200,26){\vector(-1,2){15}}
1089 * Group Buffer Format:: Information listed and how you can change it.
1090 * Group Maneuvering:: Commands for moving in the group buffer.
1091 * Selecting a Group:: Actually reading news.
1092 * Group Data:: Changing the info for a group.
1093 * Subscription Commands:: Unsubscribing, killing, subscribing.
1094 * Group Levels:: Levels? What are those, then?
1095 * Group Score:: A mechanism for finding out what groups you like.
1096 * Marking Groups:: You can mark groups for later processing.
1097 * Foreign Groups:: Creating and editing groups.
1098 * Group Parameters:: Each group may have different parameters set.
1099 * Listing Groups:: Gnus can list various subsets of the groups.
1100 * Sorting Groups:: Re-arrange the group order.
1101 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1102 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1103 * Exiting Gnus:: Stop reading news and get some work done.
1104 * Group Topics:: A folding group mode divided into topics.
1105 * Misc Group Stuff:: Other stuff that you can to do.
1109 @node Group Buffer Format
1110 @section Group Buffer Format
1113 * Group Line Specification:: Deciding how the group buffer is to look.
1114 * Group Modeline Specification:: The group buffer modeline.
1115 * Group Highlighting:: Having nice colors in the group buffer.
1119 @node Group Line Specification
1120 @subsection Group Line Specification
1121 @cindex group buffer format
1123 The default format of the group buffer is nice and dull, but you can
1124 make it as exciting and ugly as you feel like.
1126 Here's a couple of example group lines:
1129 25: news.announce.newusers
1130 * 0: alt.fan.andrea-dworkin
1135 You can see that there are 25 unread articles in
1136 @samp{news.announce.newusers}. There are no unread articles, but some
1137 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1138 asterisk at the beginning of the line?).
1140 @vindex gnus-group-line-format
1141 You can change that format to whatever you want by fiddling with the
1142 @code{gnus-group-line-format} variable. This variable works along the
1143 lines of a @code{format} specification, which is pretty much the same as
1144 a @code{printf} specifications, for those of you who use (feh!) C.
1145 @xref{Formatting Variables}.
1147 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1149 There should always be a colon on the line; the cursor always moves to
1150 the colon after performing an operation. Nothing else is required---not
1151 even the group name. All displayed text is just window dressing, and is
1152 never examined by Gnus. Gnus stores all real information it needs using
1155 (Note that if you make a really strange, wonderful, spreadsheet-like
1156 layout, everybody will believe you are hard at work with the accounting
1157 instead of wasting time reading news.)
1159 Here's a list of all available format characters:
1164 An asterisk if the group only has marked articles.
1167 Whether the group is subscribed.
1170 Level of subscribedness.
1173 Number of unread articles.
1176 Number of dormant articles.
1179 Number of ticked articles.
1182 Number of read articles.
1185 Estimated total number of articles. (This is really @var{max-number}
1186 minus @var{min-number} plus 1.)
1189 Number of unread, unticked, non-dormant articles.
1192 Number of ticked and dormant articles.
1201 Newsgroup description.
1204 @samp{m} if moderated.
1207 @samp{(m)} if moderated.
1216 A string that looks like @samp{<%s:%n>} if a foreign select method is
1220 Indentation based on the level of the topic (@pxref{Group Topics}).
1223 @vindex gnus-group-uncollapsed-levels
1224 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1225 variable says how many levels to leave at the end of the group name.
1226 The default is 1---this will mean that group names like
1227 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1230 @vindex gnus-new-mail-mark
1232 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1236 A string that says when you last read the group (@pxref{Group
1240 User defined specifier. The next character in the format string should
1241 be a letter. Gnus will call the function
1242 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1243 following @samp{%u}. The function will be passed a single dummy
1244 parameter as argument. The function should return a string, which will
1245 be inserted into the buffer just like information from any other
1250 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1251 if no info is available---for instance, if it is a non-activated foreign
1252 group, or a bogus native group.
1255 @node Group Modeline Specification
1256 @subsection Group Modeline Specification
1257 @cindex group modeline
1259 @vindex gnus-group-mode-line-format
1260 The mode line can be changed by setting
1261 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1262 doesn't understand that many format specifiers:
1266 The native news server.
1268 The native select method.
1272 @node Group Highlighting
1273 @subsection Group Highlighting
1274 @cindex highlighting
1275 @cindex group highlighting
1277 @vindex gnus-group-highlight
1278 Highlighting in the group buffer is controlled by the
1279 @code{gnus-group-highlight} variable. This is an alist with elements
1280 that look like @var{(form . face)}. If @var{form} evaluates to
1281 something non-@code{nil}, the @var{face} will be used on the line.
1283 Here's an example value for this variable that might look nice if the
1287 (face-spec-set 'my-group-face-1
1288 '((t (:foreground "Red" :bold t))))
1289 (face-spec-set 'my-group-face-2
1290 '((t (:foreground "SeaGreen" :bold t))))
1291 (face-spec-set 'my-group-face-3
1292 '((t (:foreground "SpringGreen" :bold t))))
1293 (face-spec-set 'my-group-face-4
1294 '((t (:foreground "SteelBlue" :bold t))))
1295 (face-spec-set 'my-group-face-5
1296 '((t (:foreground "SkyBlue" :bold t))))
1298 (setq gnus-group-highlight
1299 '(((> unread 200) . my-group-face-1)
1300 ((and (< level 3) (zerop unread)) . my-group-face-2)
1301 ((< level 3) . my-group-face-3)
1302 ((zerop unread) . my-group-face-4)
1303 (t . my-group-face-5)))
1306 Also @pxref{Faces and Fonts}.
1308 Variables that are dynamically bound when the forms are evaluated
1315 The number of unread articles in the group.
1319 Whether the group is a mail group.
1321 The level of the group.
1323 The score of the group.
1325 The number of ticked articles in the group.
1327 The total number of articles in the group. Or rather, MAX-NUMBER minus
1328 MIN-NUMBER plus one.
1330 When using the topic minor mode, this variable is bound to the current
1331 topic being inserted.
1334 When the forms are @code{eval}ed, point is at the beginning of the line
1335 of the group in question, so you can use many of the normal Gnus
1336 functions for snarfing info on the group.
1338 @vindex gnus-group-update-hook
1339 @findex gnus-group-highlight-line
1340 @code{gnus-group-update-hook} is called when a group line is changed.
1341 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1342 calls @code{gnus-group-highlight-line} by default.
1345 @node Group Maneuvering
1346 @section Group Maneuvering
1347 @cindex group movement
1349 All movement commands understand the numeric prefix and will behave as
1350 expected, hopefully.
1356 @findex gnus-group-next-unread-group
1357 Go to the next group that has unread articles
1358 (@code{gnus-group-next-unread-group}).
1364 @findex gnus-group-prev-unread-group
1365 Go to the previous group that has unread articles
1366 (@code{gnus-group-prev-unread-group}).
1370 @findex gnus-group-next-group
1371 Go to the next group (@code{gnus-group-next-group}).
1375 @findex gnus-group-prev-group
1376 Go to the previous group (@code{gnus-group-prev-group}).
1380 @findex gnus-group-next-unread-group-same-level
1381 Go to the next unread group on the same (or lower) level
1382 (@code{gnus-group-next-unread-group-same-level}).
1386 @findex gnus-group-prev-unread-group-same-level
1387 Go to the previous unread group on the same (or lower) level
1388 (@code{gnus-group-prev-unread-group-same-level}).
1391 Three commands for jumping to groups:
1397 @findex gnus-group-jump-to-group
1398 Jump to a group (and make it visible if it isn't already)
1399 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
1404 @findex gnus-group-best-unread-group
1405 Jump to the unread group with the lowest level
1406 (@code{gnus-group-best-unread-group}).
1410 @findex gnus-group-first-unread-group
1411 Jump to the first group with unread articles
1412 (@code{gnus-group-first-unread-group}).
1415 @vindex gnus-group-goto-unread
1416 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1417 commands will move to the next group, not the next unread group. Even
1418 the commands that say they move to the next unread group. The default
1422 @node Selecting a Group
1423 @section Selecting a Group
1424 @cindex group selection
1429 @kindex SPACE (Group)
1430 @findex gnus-group-read-group
1431 Select the current group, switch to the summary buffer and display the
1432 first unread article (@code{gnus-group-read-group}). If there are no
1433 unread articles in the group, or if you give a non-numerical prefix to
1434 this command, Gnus will offer to fetch all the old articles in this
1435 group from the server. If you give a numerical prefix @var{N}, @var{N}
1436 determines the number of articles Gnus will fetch. If @var{N} is
1437 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1438 negative, Gnus fetches the @var{abs(N)} oldest articles.
1442 @findex gnus-group-select-group
1443 Select the current group and switch to the summary buffer
1444 (@code{gnus-group-select-group}). Takes the same arguments as
1445 @code{gnus-group-read-group}---the only difference is that this command
1446 does not display the first unread article automatically upon group
1450 @kindex M-RET (Group)
1451 @findex gnus-group-quick-select-group
1452 This does the same as the command above, but tries to do it with the
1453 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
1454 scoring/killing will be performed, there will be no highlights and no
1455 expunging. This might be useful if you're in a real hurry and have to
1456 enter some humongous group. If you give a 0 prefix to this command
1457 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
1458 which is useful if you want to toggle threading before generating the
1459 summary buffer (@pxref{Summary Generation Commands}).
1462 @kindex M-SPACE (Group)
1463 @findex gnus-group-visible-select-group
1464 This is yet one more command that does the same as the @kbd{RET}
1465 command, but this one does it without expunging and hiding dormants
1466 (@code{gnus-group-visible-select-group}).
1469 @kindex M-C-RET (Group)
1470 @findex gnus-group-select-group-ephemerally
1471 Finally, this command selects the current group ephemerally without
1472 doing any processing of its contents
1473 (@code{gnus-group-select-group-ephemerally}). Even threading has been
1474 turned off. Everything you do in the group after selecting it in this
1475 manner will have no permanent effects.
1479 @vindex gnus-large-newsgroup
1480 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1481 to be a big group. This is 200 by default. If the group has more
1482 (unread and/or ticked) articles than this, Gnus will query the user
1483 before entering the group. The user can then specify how many articles
1484 should be fetched from the server. If the user specifies a negative
1485 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
1486 is positive, the @code{n} articles that have arrived most recently will
1489 @vindex gnus-select-group-hook
1490 @vindex gnus-auto-select-first
1491 @code{gnus-auto-select-first} control whether any articles are selected
1492 automatically when entering a group with the @kbd{SPACE} command.
1497 Don't select any articles when entering the group. Just display the
1498 full summary buffer.
1501 Select the first unread article when entering the group.
1504 Select the highest scored article in the group when entering the
1509 This variable can also be a function. In that case, that function will
1510 be called to place point on a subject line, and/or select some article.
1511 Useful functions include:
1514 @item gnus-summary-first-unread-subject
1515 Place point on the subject line of the first unread article, but
1516 don't select the article.
1518 @item gnus-summary-first-unread-article
1519 Select the first unread article.
1521 @item gnus-summary-best-unread-article
1522 Select the highest-scored unread article.
1526 If you want to prevent automatic selection in some group (say, in a
1527 binary group with Huge articles) you can set this variable to @code{nil}
1528 in @code{gnus-select-group-hook}, which is called when a group is
1532 @node Subscription Commands
1533 @section Subscription Commands
1534 @cindex subscription
1542 @findex gnus-group-unsubscribe-current-group
1543 @c @icon{gnus-group-unsubscribe}
1544 Toggle subscription to the current group
1545 (@code{gnus-group-unsubscribe-current-group}).
1551 @findex gnus-group-unsubscribe-group
1552 Prompt for a group to subscribe, and then subscribe it. If it was
1553 subscribed already, unsubscribe it instead
1554 (@code{gnus-group-unsubscribe-group}).
1560 @findex gnus-group-kill-group
1561 @c @icon{gnus-group-kill-group}
1562 Kill the current group (@code{gnus-group-kill-group}).
1568 @findex gnus-group-yank-group
1569 Yank the last killed group (@code{gnus-group-yank-group}).
1572 @kindex C-x C-t (Group)
1573 @findex gnus-group-transpose-groups
1574 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
1575 really a subscription command, but you can use it instead of a
1576 kill-and-yank sequence sometimes.
1582 @findex gnus-group-kill-region
1583 Kill all groups in the region (@code{gnus-group-kill-region}).
1587 @findex gnus-group-kill-all-zombies
1588 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1591 @kindex S C-k (Group)
1592 @findex gnus-group-kill-level
1593 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1594 These groups can't be yanked back after killing, so this command should
1595 be used with some caution. The only time where this command comes in
1596 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1597 groups that you want to get rid off. @kbd{S C-k} on level 7 will
1598 kill off all unsubscribed groups that do not have message numbers in the
1599 @file{.newsrc} file.
1603 Also @pxref{Group Levels}.
1613 @findex gnus-group-catchup-current
1614 @vindex gnus-group-catchup-group-hook
1615 @c @icon{gnus-group-catchup-current}
1616 Mark all unticked articles in this group as read
1617 (@code{gnus-group-catchup-current}).
1618 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1623 @findex gnus-group-catchup-current-all
1624 Mark all articles in this group, even the ticked ones, as read
1625 (@code{gnus-group-catchup-current-all}).
1629 @findex gnus-group-clear-data
1630 Clear the data from the current group---nix out marks and the list of
1631 read articles (@code{gnus-group-clear-data}).
1633 @item M-x gnus-group-clear-data-on-native-groups
1634 @kindex M-x gnus-group-clear-data-on-native-groups
1635 @findex gnus-group-clear-data-on-native-groups
1636 If you have switched from one @sc{nntp} server to another, all your marks
1637 and read ranges have become worthless. You can use this command to
1638 clear out all data that you have on your native groups. Use with
1645 @section Group Levels
1649 All groups have a level of @dfn{subscribedness}. For instance, if a
1650 group is on level 2, it is more subscribed than a group on level 5. You
1651 can ask Gnus to just list groups on a given level or lower
1652 (@pxref{Listing Groups}), or to just check for new articles in groups on
1653 a given level or lower (@pxref{Scanning New Messages}).
1655 Remember: The higher the level of the group, the less important it is.
1661 @findex gnus-group-set-current-level
1662 Set the level of the current group. If a numeric prefix is given, the
1663 next @var{n} groups will have their levels set. The user will be
1664 prompted for a level.
1667 @vindex gnus-level-killed
1668 @vindex gnus-level-zombie
1669 @vindex gnus-level-unsubscribed
1670 @vindex gnus-level-subscribed
1671 Gnus considers groups from levels 1 to
1672 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1673 @code{gnus-level-subscribed} (exclusive) and
1674 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1675 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1676 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1677 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
1678 same, but zombie and killed groups have no information on what articles
1679 you have read, etc, stored. This distinction between dead and living
1680 groups isn't done because it is nice or clever, it is done purely for
1681 reasons of efficiency.
1683 It is recommended that you keep all your mail groups (if any) on quite
1684 low levels (e.g. 1 or 2).
1686 If you want to play with the level variables, you should show some care.
1687 Set them once, and don't touch them ever again. Better yet, don't touch
1688 them at all unless you know exactly what you're doing.
1690 @vindex gnus-level-default-unsubscribed
1691 @vindex gnus-level-default-subscribed
1692 Two closely related variables are @code{gnus-level-default-subscribed}
1693 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1694 which are the levels that new groups will be put on if they are
1695 (un)subscribed. These two variables should, of course, be inside the
1696 relevant valid ranges.
1698 @vindex gnus-keep-same-level
1699 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1700 will only move to groups of the same level (or lower). In
1701 particular, going from the last article in one group to the next group
1702 will go to the next group of the same level (or lower). This might be
1703 handy if you want to read the most important groups before you read the
1706 @vindex gnus-group-default-list-level
1707 All groups with a level less than or equal to
1708 @code{gnus-group-default-list-level} will be listed in the group buffer
1711 @vindex gnus-group-list-inactive-groups
1712 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1713 groups will be listed along with the unread groups. This variable is
1714 @code{t} by default. If it is @code{nil}, inactive groups won't be
1717 @vindex gnus-group-use-permanent-levels
1718 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1719 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1720 use this level as the ``work'' level.
1722 @vindex gnus-activate-level
1723 Gnus will normally just activate (i. e., query the server about) groups
1724 on level @code{gnus-activate-level} or less. If you don't want to
1725 activate unsubscribed groups, for instance, you might set this variable
1726 to 5. The default is 6.
1730 @section Group Score
1735 You would normally keep important groups on high levels, but that scheme
1736 is somewhat restrictive. Don't you wish you could have Gnus sort the
1737 group buffer according to how often you read groups, perhaps? Within
1740 This is what @dfn{group score} is for. You can assign a score to each
1741 group. You can then sort the group buffer based on this score.
1742 Alternatively, you can sort on score and then level. (Taken together,
1743 the level and the score is called the @dfn{rank} of the group. A group
1744 that is on level 4 and has a score of 1 has a higher rank than a group
1745 on level 5 that has a score of 300. (The level is the most significant
1746 part and the score is the least significant part.))
1748 @findex gnus-summary-bubble-group
1749 If you want groups you read often to get higher scores than groups you
1750 read seldom you can add the @code{gnus-summary-bubble-group} function to
1751 the @code{gnus-summary-exit-hook} hook. This will result (after
1752 sorting) in a bubbling sort of action. If you want to see that in
1753 action after each summary exit, you can add
1754 @code{gnus-group-sort-groups-by-rank} or
1755 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1756 slow things down somewhat.
1759 @node Marking Groups
1760 @section Marking Groups
1761 @cindex marking groups
1763 If you want to perform some command on several groups, and they appear
1764 subsequently in the group buffer, you would normally just give a
1765 numerical prefix to the command. Most group commands will then do your
1766 bidding on those groups.
1768 However, if the groups are not in sequential order, you can still
1769 perform a command on several groups. You simply mark the groups first
1770 with the process mark and then execute the command.
1778 @findex gnus-group-mark-group
1779 Set the mark on the current group (@code{gnus-group-mark-group}).
1785 @findex gnus-group-unmark-group
1786 Remove the mark from the current group
1787 (@code{gnus-group-unmark-group}).
1791 @findex gnus-group-unmark-all-groups
1792 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1796 @findex gnus-group-mark-region
1797 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1801 @findex gnus-group-mark-buffer
1802 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1806 @findex gnus-group-mark-regexp
1807 Mark all groups that match some regular expression
1808 (@code{gnus-group-mark-regexp}).
1811 Also @pxref{Process/Prefix}.
1813 @findex gnus-group-universal-argument
1814 If you want to execute some command on all groups that have been marked
1815 with the process mark, you can use the @kbd{M-&}
1816 (@code{gnus-group-universal-argument}) command. It will prompt you for
1817 the command to be executed.
1820 @node Foreign Groups
1821 @section Foreign Groups
1822 @cindex foreign groups
1824 Below are some group mode commands for making and editing general foreign
1825 groups, as well as commands to ease the creation of a few
1826 special-purpose groups. All these commands insert the newly created
1827 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1834 @findex gnus-group-make-group
1835 @cindex making groups
1836 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
1837 for a name, a method and possibly an @dfn{address}. For an easier way
1838 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1842 @findex gnus-group-rename-group
1843 @cindex renaming groups
1844 Rename the current group to something else
1845 (@code{gnus-group-rename-group}). This is valid only on some
1846 groups---mail groups mostly. This command might very well be quite slow
1852 @findex gnus-group-customize
1853 Customize the group parameters (@code{gnus-group-customize}).
1857 @findex gnus-group-edit-group-method
1858 @cindex renaming groups
1859 Enter a buffer where you can edit the select method of the current
1860 group (@code{gnus-group-edit-group-method}).
1864 @findex gnus-group-edit-group-parameters
1865 Enter a buffer where you can edit the group parameters
1866 (@code{gnus-group-edit-group-parameters}).
1870 @findex gnus-group-edit-group
1871 Enter a buffer where you can edit the group info
1872 (@code{gnus-group-edit-group}).
1876 @findex gnus-group-make-directory-group
1878 Make a directory group (@pxref{Directory Groups}). You will be prompted
1879 for a directory name (@code{gnus-group-make-directory-group}).
1884 @findex gnus-group-make-help-group
1885 Make the Gnus help group (@code{gnus-group-make-help-group}).
1889 @cindex (ding) archive
1890 @cindex archive group
1891 @findex gnus-group-make-archive-group
1892 @vindex gnus-group-archive-directory
1893 @vindex gnus-group-recent-archive-directory
1894 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
1895 default a group pointing to the most recent articles will be created
1896 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1897 group will be created from @code{gnus-group-archive-directory}.
1901 @findex gnus-group-make-kiboze-group
1903 Make a kiboze group. You will be prompted for a name, for a regexp to
1904 match groups to be ``included'' in the kiboze group, and a series of
1905 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1906 @xref{Kibozed Groups}.
1910 @findex gnus-group-enter-directory
1912 Read an arbitrary directory as if it were a newsgroup with the
1913 @code{nneething} backend (@code{gnus-group-enter-directory}).
1914 @xref{Anything Groups}.
1918 @findex gnus-group-make-doc-group
1919 @cindex ClariNet Briefs
1921 Make a group based on some file or other
1922 (@code{gnus-group-make-doc-group}). If you give a prefix to this
1923 command, you will be prompted for a file name and a file type.
1924 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1925 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1926 @code{rfc934}, @code{rfc822-forward}, and @code{forward}. If you run
1927 this command without a prefix, Gnus will guess at the file type.
1928 @xref{Document Groups}.
1932 @vindex gnus-useful-groups
1933 @findex gnus-group-make-useful-group
1934 Create one of the groups mentioned in @code{gnus-useful-groups}
1935 (@code{gnus-group-make-useful-group}).
1939 @findex gnus-group-make-web-group
1944 Make an ephemeral group based on a web search
1945 (@code{gnus-group-make-web-group}). If you give a prefix to this
1946 command, make a solid group instead. You will be prompted for the
1947 search engine type and the search string. Valid search engine types
1948 include @code{dejanews}, @code{altavista} and @code{reference}.
1949 @xref{Web Searches}.
1951 If you use the @code{dejanews} search engine, you can limit the search
1952 to a particular group by using a match string like
1953 @samp{~g alt.sysadmin.recovery shaving}.
1956 @kindex G DEL (Group)
1957 @findex gnus-group-delete-group
1958 This function will delete the current group
1959 (@code{gnus-group-delete-group}). If given a prefix, this function will
1960 actually delete all the articles in the group, and forcibly remove the
1961 group itself from the face of the Earth. Use a prefix only if you are
1962 absolutely sure of what you are doing. This command can't be used on
1963 read-only groups (like @code{nntp} group), though.
1967 @findex gnus-group-make-empty-virtual
1968 Make a new, fresh, empty @code{nnvirtual} group
1969 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
1973 @findex gnus-group-add-to-virtual
1974 Add the current group to an @code{nnvirtual} group
1975 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
1978 @xref{Select Methods}, for more information on the various select
1981 @vindex gnus-activate-foreign-newsgroups
1982 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1983 Gnus will check all foreign groups with this level or lower at startup.
1984 This might take quite a while, especially if you subscribe to lots of
1985 groups from different @sc{nntp} servers. Also @pxref{Group Levels};
1986 @code{gnus-activate-level} also affects activation of foreign
1990 @node Group Parameters
1991 @section Group Parameters
1992 @cindex group parameters
1994 The group parameters store information local to a particular group.
1995 Here's an example group parameter list:
1998 ((to-address . "ding@@gnus.org")
2002 We see that each element consists of a "dotted pair"---the thing before
2003 the dot is the key, while the thing after the dot is the value. All the
2004 parameters have this form @emph{except} local variable specs, which are
2005 not dotted pairs, but proper lists.
2007 The following group parameters can be used:
2012 Address used by when doing followups and new posts.
2015 (to-address . "some@@where.com")
2018 This is primarily useful in mail groups that represent closed mailing
2019 lists---mailing lists where it's expected that everybody that writes to
2020 the mailing list is subscribed to it. Since using this parameter
2021 ensures that the mail only goes to the mailing list itself, it means
2022 that members won't receive two copies of your followups.
2024 Using @code{to-address} will actually work whether the group is foreign
2025 or not. Let's say there's a group on the server that is called
2026 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2027 the articles from a mail-to-news gateway. Posting directly to this
2028 group is therefore impossible---you have to send mail to the mailing
2029 list address instead.
2033 Address used when doing a @kbd{a} in that group.
2036 (to-list . "some@@where.com")
2039 It is totally ignored
2040 when doing a followup---except that if it is present in a news group,
2041 you'll get mail group semantics when doing @kbd{f}.
2043 If you do an @kbd{a} command in a mail group and you have neither a
2044 @code{to-list} group parameter nor a @code{to-address} group parameter,
2045 then a @code{to-list} group parameter will be added automatically upon
2046 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2047 @vindex gnus-add-to-list
2049 If you do an @kbd{a} command in a mail group and you don't have a
2050 @code{to-list} group parameter, one will be added automatically upon
2051 sending the message.
2055 If the group parameter list has the element @code{(visible . t)},
2056 that group will always be visible in the Group buffer, regardless
2057 of whether it has any unread articles.
2059 @item broken-reply-to
2060 @cindex broken-reply-to
2061 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2062 headers in this group are to be ignored. This can be useful if you're
2063 reading a mailing list group where the listserv has inserted
2064 @code{Reply-To} headers that point back to the listserv itself. This is
2065 broken behavior. So there!
2069 Elements like @code{(to-group . "some.group.name")} means that all
2070 posts in that group will be sent to @code{some.group.name}.
2074 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2075 will treat all responses as if they were responses to news articles.
2076 This can be useful if you have a mail group that's really a mirror of a
2081 If @code{(gcc-self . t)} is present in the group parameter list, newly
2082 composed messages will be @code{Gcc}'d to the current group. If
2083 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2084 generated, if @code{(gcc-self . "string")} is present, this string will
2085 be inserted literally as a @code{gcc} header. This parameter takes
2086 precedence over any default @code{Gcc} rules as described later
2087 (@pxref{Archived Messages}).
2091 If the group parameter has an element that looks like @code{(auto-expire
2092 . t)}, all articles read will be marked as expirable. For an
2093 alternative approach, @pxref{Expiring Mail}.
2096 @cindex total-expire
2097 If the group parameter has an element that looks like
2098 @code{(total-expire . t)}, all read articles will be put through the
2099 expiry process, even if they are not marked as expirable. Use with
2100 caution. Unread, ticked and dormant articles are not eligible for
2105 @vindex nnmail-expiry-wait-function
2106 If the group parameter has an element that looks like @code{(expiry-wait
2107 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2108 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2109 The value can either be a number of days (not necessarily an integer) or
2110 the symbols @code{never} or @code{immediate}.
2113 @cindex score file group parameter
2114 Elements that look like @code{(score-file . "file")} will make
2115 @file{file} into the current score file for the group in question. All
2116 interactive score entries will be put into this file.
2119 @cindex adapt file group parameter
2120 Elements that look like @code{(adapt-file . "file")} will make
2121 @file{file} into the current adaptive file for the group in question.
2122 All adaptive score entries will be put into this file.
2125 When unsubscribing from a mailing list you should never send the
2126 unsubscription notice to the mailing list itself. Instead, you'd send
2127 messages to the administrative address. This parameter allows you to
2128 put the admin address somewhere convenient.
2131 Elements that look like @code{(display . MODE)} say which articles to
2132 display on entering the group. Valid values are:
2136 Display all articles, both read and unread.
2139 Display the default visible articles, which normally includes unread and
2144 Elements that look like @code{(comment . "This is a comment")}
2145 are arbitrary comments on the group. They are currently ignored by
2146 Gnus, but provide a place for you to store information on particular
2150 Elements that look like @code{(charset . iso-8859-1)} will make
2151 @code{iso-8859-1} the default charset; that is, the charset that will be
2152 used for all articles that do not specify a charset.
2154 @item @var{(variable form)}
2155 You can use the group parameters to set variables local to the group you
2156 are entering. If you want to turn threading off in @samp{news.answers},
2157 you could put @code{(gnus-show-threads nil)} in the group parameters of
2158 that group. @code{gnus-show-threads} will be made into a local variable
2159 in the summary buffer you enter, and the form @code{nil} will be
2160 @code{eval}ed there.
2162 This can also be used as a group-specific hook function, if you'd like.
2163 If you want to hear a beep when you enter a group, you could put
2164 something like @code{(dummy-variable (ding))} in the parameters of that
2165 group. @code{dummy-variable} will be set to the result of the
2166 @code{(ding)} form, but who cares?
2169 You can store additional posting style information for this group only
2170 here (@pxref{Posting Styles}). The format is that of an entry in the
2171 @code{gnus-posting-styles} alist, except that there's no regexp matching
2172 the group name (of course). Style elements in this group parameter will
2173 take precedence over the ones found in @code{gnus-posting-styles}.
2175 For instance, if you want a funky name and signature in this group only,
2176 instead of hacking @code{gnus-posting-styles}, you could put something
2177 like this in the group parameters:
2182 (signature "Funky Signature"))
2187 Use the @kbd{G p} command to edit group parameters of a group. You
2188 might also be interested in reading about topic parameters (@pxref{Topic
2192 @node Listing Groups
2193 @section Listing Groups
2194 @cindex group listing
2196 These commands all list various slices of the groups available.
2204 @findex gnus-group-list-groups
2205 List all groups that have unread articles
2206 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
2207 command will list only groups of level ARG and lower. By default, it
2208 only lists groups of level five (i. e.,
2209 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2216 @findex gnus-group-list-all-groups
2217 List all groups, whether they have unread articles or not
2218 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
2219 this command will list only groups of level ARG and lower. By default,
2220 it lists groups of level seven or lower (i.e., just subscribed and
2221 unsubscribed groups).
2225 @findex gnus-group-list-level
2226 List all unread groups on a specific level
2227 (@code{gnus-group-list-level}). If given a prefix, also list the groups
2228 with no unread articles.
2232 @findex gnus-group-list-killed
2233 List all killed groups (@code{gnus-group-list-killed}). If given a
2234 prefix argument, really list all groups that are available, but aren't
2235 currently (un)subscribed. This could entail reading the active file
2240 @findex gnus-group-list-zombies
2241 List all zombie groups (@code{gnus-group-list-zombies}).
2245 @findex gnus-group-list-matching
2246 List all unread, subscribed groups with names that match a regexp
2247 (@code{gnus-group-list-matching}).
2251 @findex gnus-group-list-all-matching
2252 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2256 @findex gnus-group-list-active
2257 List absolutely all groups in the active file(s) of the
2258 server(s) you are connected to (@code{gnus-group-list-active}). This
2259 might very well take quite a while. It might actually be a better idea
2260 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2261 thing to match on. Also note that this command may list groups that
2262 don't exist (yet)---these will be listed as if they were killed groups.
2263 Take the output with some grains of salt.
2267 @findex gnus-group-apropos
2268 List all groups that have names that match a regexp
2269 (@code{gnus-group-apropos}).
2273 @findex gnus-group-description-apropos
2274 List all groups that have names or descriptions that match a regexp
2275 (@code{gnus-group-description-apropos}).
2279 @vindex gnus-permanently-visible-groups
2280 @cindex visible group parameter
2281 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2282 always be shown, whether they have unread articles or not. You can also
2283 add the @code{visible} element to the group parameters in question to
2284 get the same effect.
2286 @vindex gnus-list-groups-with-ticked-articles
2287 Groups that have just ticked articles in it are normally listed in the
2288 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
2289 @code{nil}, these groups will be treated just like totally empty
2290 groups. It is @code{t} by default.
2293 @node Sorting Groups
2294 @section Sorting Groups
2295 @cindex sorting groups
2297 @kindex C-c C-s (Group)
2298 @findex gnus-group-sort-groups
2299 @vindex gnus-group-sort-function
2300 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2301 group buffer according to the function(s) given by the
2302 @code{gnus-group-sort-function} variable. Available sorting functions
2307 @item gnus-group-sort-by-alphabet
2308 @findex gnus-group-sort-by-alphabet
2309 Sort the group names alphabetically. This is the default.
2311 @item gnus-group-sort-by-real-name
2312 @findex gnus-group-sort-by-real-name
2313 Sort the group alphabetically on the real (unprefixed) group names.
2315 @item gnus-group-sort-by-level
2316 @findex gnus-group-sort-by-level
2317 Sort by group level.
2319 @item gnus-group-sort-by-score
2320 @findex gnus-group-sort-by-score
2321 Sort by group score. @xref{Group Score}.
2323 @item gnus-group-sort-by-rank
2324 @findex gnus-group-sort-by-rank
2325 Sort by group score and then the group level. The level and the score
2326 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
2328 @item gnus-group-sort-by-unread
2329 @findex gnus-group-sort-by-unread
2330 Sort by number of unread articles.
2332 @item gnus-group-sort-by-method
2333 @findex gnus-group-sort-by-method
2334 Sort alphabetically on the select method.
2339 @code{gnus-group-sort-function} can also be a list of sorting
2340 functions. In that case, the most significant sort key function must be
2344 There are also a number of commands for sorting directly according to
2345 some sorting criteria:
2349 @kindex G S a (Group)
2350 @findex gnus-group-sort-groups-by-alphabet
2351 Sort the group buffer alphabetically by group name
2352 (@code{gnus-group-sort-groups-by-alphabet}).
2355 @kindex G S u (Group)
2356 @findex gnus-group-sort-groups-by-unread
2357 Sort the group buffer by the number of unread articles
2358 (@code{gnus-group-sort-groups-by-unread}).
2361 @kindex G S l (Group)
2362 @findex gnus-group-sort-groups-by-level
2363 Sort the group buffer by group level
2364 (@code{gnus-group-sort-groups-by-level}).
2367 @kindex G S v (Group)
2368 @findex gnus-group-sort-groups-by-score
2369 Sort the group buffer by group score
2370 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
2373 @kindex G S r (Group)
2374 @findex gnus-group-sort-groups-by-rank
2375 Sort the group buffer by group rank
2376 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
2379 @kindex G S m (Group)
2380 @findex gnus-group-sort-groups-by-method
2381 Sort the group buffer alphabetically by backend name
2382 (@code{gnus-group-sort-groups-by-method}).
2386 All the commands below obeys the process/prefix convention
2387 (@pxref{Process/Prefix}).
2389 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
2390 commands will sort in reverse order.
2392 You can also sort a subset of the groups:
2396 @kindex G P a (Group)
2397 @findex gnus-group-sort-selected-groups-by-alphabet
2398 Sort the groups alphabetically by group name
2399 (@code{gnus-group-sort-selected-groups-by-alphabet}).
2402 @kindex G P u (Group)
2403 @findex gnus-group-sort-selected-groups-by-unread
2404 Sort the groups by the number of unread articles
2405 (@code{gnus-group-sort-selected-groups-by-unread}).
2408 @kindex G P l (Group)
2409 @findex gnus-group-sort-selected-groups-by-level
2410 Sort the groups by group level
2411 (@code{gnus-group-sort-selected-groups-by-level}).
2414 @kindex G P v (Group)
2415 @findex gnus-group-sort-selected-groups-by-score
2416 Sort the groups by group score
2417 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
2420 @kindex G P r (Group)
2421 @findex gnus-group-sort-selected-groups-by-rank
2422 Sort the groups by group rank
2423 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
2426 @kindex G P m (Group)
2427 @findex gnus-group-sort-selected-groups-by-method
2428 Sort the groups alphabetically by backend name
2429 (@code{gnus-group-sort-selected-groups-by-method}).
2435 @node Group Maintenance
2436 @section Group Maintenance
2437 @cindex bogus groups
2442 @findex gnus-group-check-bogus-groups
2443 Find bogus groups and delete them
2444 (@code{gnus-group-check-bogus-groups}).
2448 @findex gnus-group-find-new-groups
2449 Find new groups and process them (@code{gnus-group-find-new-groups}).
2450 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
2451 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
2452 to query the server for new groups, and subscribe the new groups as
2456 @kindex C-c C-x (Group)
2457 @findex gnus-group-expire-articles
2458 Run all expirable articles in the current group through the expiry
2459 process (if any) (@code{gnus-group-expire-articles}).
2462 @kindex C-c M-C-x (Group)
2463 @findex gnus-group-expire-all-groups
2464 Run all articles in all groups through the expiry process
2465 (@code{gnus-group-expire-all-groups}).
2470 @node Browse Foreign Server
2471 @section Browse Foreign Server
2472 @cindex foreign servers
2473 @cindex browsing servers
2478 @findex gnus-group-browse-foreign-server
2479 You will be queried for a select method and a server name. Gnus will
2480 then attempt to contact this server and let you browse the groups there
2481 (@code{gnus-group-browse-foreign-server}).
2484 @findex gnus-browse-mode
2485 A new buffer with a list of available groups will appear. This buffer
2486 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
2487 a lot) like a normal group buffer.
2489 Here's a list of keystrokes available in the browse mode:
2494 @findex gnus-group-next-group
2495 Go to the next group (@code{gnus-group-next-group}).
2499 @findex gnus-group-prev-group
2500 Go to the previous group (@code{gnus-group-prev-group}).
2503 @kindex SPACE (Browse)
2504 @findex gnus-browse-read-group
2505 Enter the current group and display the first article
2506 (@code{gnus-browse-read-group}).
2509 @kindex RET (Browse)
2510 @findex gnus-browse-select-group
2511 Enter the current group (@code{gnus-browse-select-group}).
2515 @findex gnus-browse-unsubscribe-current-group
2516 Unsubscribe to the current group, or, as will be the case here,
2517 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2523 @findex gnus-browse-exit
2524 Exit browse mode (@code{gnus-browse-exit}).
2528 @findex gnus-browse-describe-briefly
2529 Describe browse mode briefly (well, there's not much to describe, is
2530 there) (@code{gnus-browse-describe-briefly}).
2535 @section Exiting Gnus
2536 @cindex exiting Gnus
2538 Yes, Gnus is ex(c)iting.
2543 @findex gnus-group-suspend
2544 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
2545 but it kills all buffers except the Group buffer. I'm not sure why this
2546 is a gain, but then who am I to judge?
2550 @findex gnus-group-exit
2551 @c @icon{gnus-group-exit}
2552 Quit Gnus (@code{gnus-group-exit}).
2556 @findex gnus-group-quit
2557 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2558 The dribble file will be saved, though (@pxref{Auto Save}).
2561 @vindex gnus-exit-gnus-hook
2562 @vindex gnus-suspend-gnus-hook
2563 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2564 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2565 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2570 If you wish to completely unload Gnus and all its adherents, you can use
2571 the @code{gnus-unload} command. This command is also very handy when
2572 trying to customize meta-variables.
2577 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2578 numbly heavy and herself fall into a hazy trance as the boy sitting
2579 behind her drew repeated lines with his pencil across the back of her
2585 @section Group Topics
2588 If you read lots and lots of groups, it might be convenient to group
2589 them hierarchically according to topics. You put your Emacs groups over
2590 here, your sex groups over there, and the rest (what, two groups or so?)
2591 you put in some misc section that you never bother with anyway. You can
2592 even group the Emacs sex groups as a sub-topic to either the Emacs
2593 groups or the sex groups---or both! Go wild!
2597 \gnusfigure{Group Topics}{400}{
2598 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2609 2: alt.religion.emacs
2612 0: comp.talk.emacs.recovery
2614 8: comp.binaries.fractals
2615 13: comp.sources.unix
2618 @findex gnus-topic-mode
2620 To get this @emph{fab} functionality you simply turn on (ooh!) the
2621 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
2622 is a toggling command.)
2624 Go ahead, just try it. I'll still be here when you get back. La de
2625 dum... Nice tune, that... la la la... What, you're back? Yes, and now
2626 press @kbd{l}. There. All your groups are now listed under
2627 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
2630 If you want this permanently enabled, you should add that minor mode to
2631 the hook for the group mode:
2634 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2638 * Topic Variables:: How to customize the topics the Lisp Way.
2639 * Topic Commands:: Interactive E-Z commands.
2640 * Topic Sorting:: Sorting each topic individually.
2641 * Topic Topology:: A map of the world.
2642 * Topic Parameters:: Parameters that apply to all groups in a topic.
2646 @node Topic Variables
2647 @subsection Topic Variables
2648 @cindex topic variables
2650 Now, if you select a topic, it will fold/unfold that topic, which is
2651 really neat, I think.
2653 @vindex gnus-topic-line-format
2654 The topic lines themselves are created according to the
2655 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2668 Number of groups in the topic.
2670 Number of unread articles in the topic.
2672 Number of unread articles in the topic and all its subtopics.
2675 @vindex gnus-topic-indent-level
2676 Each sub-topic (and the groups in the sub-topics) will be indented with
2677 @code{gnus-topic-indent-level} times the topic level number of spaces.
2680 @vindex gnus-topic-mode-hook
2681 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2683 @vindex gnus-topic-display-empty-topics
2684 The @code{gnus-topic-display-empty-topics} says whether to display even
2685 topics that have no unread articles in them. The default is @code{t}.
2688 @node Topic Commands
2689 @subsection Topic Commands
2690 @cindex topic commands
2692 When the topic minor mode is turned on, a new @kbd{T} submap will be
2693 available. In addition, a few of the standard keys change their
2694 definitions slightly.
2700 @findex gnus-topic-create-topic
2701 Prompt for a new topic name and create it
2702 (@code{gnus-topic-create-topic}).
2706 @findex gnus-topic-move-group
2707 Move the current group to some other topic
2708 (@code{gnus-topic-move-group}). This command uses the process/prefix
2709 convention (@pxref{Process/Prefix}).
2713 @findex gnus-topic-copy-group
2714 Copy the current group to some other topic
2715 (@code{gnus-topic-copy-group}). This command uses the process/prefix
2716 convention (@pxref{Process/Prefix}).
2720 @findex gnus-topic-remove-group
2721 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2722 This command is mainly useful if you have the same group in several
2723 topics and wish to remove it from one of the topics. You may also
2724 remove a group from all topics, but in that case, Gnus will add it to
2725 the root topic the next time you start Gnus. In fact, all new groups
2726 (which, naturally, don't belong to any topic) will show up in the root
2729 This command uses the process/prefix convention
2730 (@pxref{Process/Prefix}).
2734 @findex gnus-topic-move-matching
2735 Move all groups that match some regular expression to a topic
2736 (@code{gnus-topic-move-matching}).
2740 @findex gnus-topic-copy-matching
2741 Copy all groups that match some regular expression to a topic
2742 (@code{gnus-topic-copy-matching}).
2746 @findex gnus-topic-toggle-display-empty-topics
2747 Toggle hiding empty topics
2748 (@code{gnus-topic-toggle-display-empty-topics}).
2752 @findex gnus-topic-mark-topic
2753 Mark all groups in the current topic with the process mark
2754 (@code{gnus-topic-mark-topic}).
2757 @kindex T M-# (Topic)
2758 @findex gnus-topic-unmark-topic
2759 Remove the process mark from all groups in the current topic
2760 (@code{gnus-topic-unmark-topic}).
2764 @kindex T TAB (Topic)
2766 @findex gnus-topic-indent
2767 ``Indent'' the current topic so that it becomes a sub-topic of the
2768 previous topic (@code{gnus-topic-indent}). If given a prefix,
2769 ``un-indent'' the topic instead.
2772 @kindex M-TAB (Topic)
2773 @findex gnus-topic-unindent
2774 ``Un-indent'' the current topic so that it becomes a sub-topic of the
2775 parent of its current parent (@code{gnus-topic-unindent}).
2779 @findex gnus-topic-select-group
2781 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2782 When you perform this command on a group, you'll enter the group, as
2783 usual. When done on a topic line, the topic will be folded (if it was
2784 visible) or unfolded (if it was folded already). So it's basically a
2785 toggling command on topics. In addition, if you give a numerical
2786 prefix, group on that level (and lower) will be displayed.
2789 @kindex C-c C-x (Topic)
2790 @findex gnus-topic-expire-articles
2791 Run all expirable articles in the current group or topic through the expiry
2792 process (if any) (@code{gnus-topic-expire-articles}).
2796 @findex gnus-topic-kill-group
2797 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
2798 topic will be removed along with the topic.
2802 @findex gnus-topic-yank-group
2803 Yank the previously killed group or topic
2804 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
2809 @findex gnus-topic-rename
2810 Rename a topic (@code{gnus-topic-rename}).
2813 @kindex T DEL (Topic)
2814 @findex gnus-topic-delete
2815 Delete an empty topic (@code{gnus-topic-delete}).
2819 @findex gnus-topic-list-active
2820 List all groups that Gnus knows about in a topics-ified way
2821 (@code{gnus-topic-list-active}).
2825 @findex gnus-topic-edit-parameters
2826 @cindex group parameters
2827 @cindex topic parameters
2829 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2830 @xref{Topic Parameters}.
2836 @subsection Topic Sorting
2837 @cindex topic sorting
2839 You can sort the groups in each topic individually with the following
2845 @kindex T S a (Topic)
2846 @findex gnus-topic-sort-groups-by-alphabet
2847 Sort the current topic alphabetically by group name
2848 (@code{gnus-topic-sort-groups-by-alphabet}).
2851 @kindex T S u (Topic)
2852 @findex gnus-topic-sort-groups-by-unread
2853 Sort the current topic by the number of unread articles
2854 (@code{gnus-topic-sort-groups-by-unread}).
2857 @kindex T S l (Topic)
2858 @findex gnus-topic-sort-groups-by-level
2859 Sort the current topic by group level
2860 (@code{gnus-topic-sort-groups-by-level}).
2863 @kindex T S v (Topic)
2864 @findex gnus-topic-sort-groups-by-score
2865 Sort the current topic by group score
2866 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
2869 @kindex T S r (Topic)
2870 @findex gnus-topic-sort-groups-by-rank
2871 Sort the current topic by group rank
2872 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
2875 @kindex T S m (Topic)
2876 @findex gnus-topic-sort-groups-by-method
2877 Sort the current topic alphabetically by backend name
2878 (@code{gnus-topic-sort-groups-by-method}).
2882 @xref{Sorting Groups}, for more information about group sorting.
2885 @node Topic Topology
2886 @subsection Topic Topology
2887 @cindex topic topology
2890 So, let's have a look at an example group buffer:
2896 2: alt.religion.emacs
2899 0: comp.talk.emacs.recovery
2901 8: comp.binaries.fractals
2902 13: comp.sources.unix
2905 So, here we have one top-level topic (@samp{Gnus}), two topics under
2906 that, and one sub-topic under one of the sub-topics. (There is always
2907 just one (1) top-level topic). This topology can be expressed as
2912 (("Emacs -- I wuw it!" visible)
2913 (("Naughty Emacs" visible)))
2917 @vindex gnus-topic-topology
2918 This is in fact how the variable @code{gnus-topic-topology} would look
2919 for the display above. That variable is saved in the @file{.newsrc.eld}
2920 file, and shouldn't be messed with manually---unless you really want
2921 to. Since this variable is read from the @file{.newsrc.eld} file,
2922 setting it in any other startup files will have no effect.
2924 This topology shows what topics are sub-topics of what topics (right),
2925 and which topics are visible. Two settings are currently
2926 allowed---@code{visible} and @code{invisible}.
2929 @node Topic Parameters
2930 @subsection Topic Parameters
2931 @cindex topic parameters
2933 All groups in a topic will inherit group parameters from the parent (and
2934 ancestor) topic parameters. All valid group parameters are valid topic
2935 parameters (@pxref{Group Parameters}).
2937 Group parameters (of course) override topic parameters, and topic
2938 parameters in sub-topics override topic parameters in super-topics. You
2939 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
2940 verb, although you may feel free to disagree with me here.)
2946 2: alt.religion.emacs
2950 0: comp.talk.emacs.recovery
2952 8: comp.binaries.fractals
2953 13: comp.sources.unix
2957 The @samp{Emacs} topic has the topic parameter @code{(score-file
2958 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2959 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2960 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
2961 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
2962 . "religion.SCORE")}.
2964 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2965 will get the @file{relief.SCORE} home score file. If you enter the same
2966 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2967 score file. If you enter the group @samp{alt.religion.emacs}, you'll
2968 get the @file{religion.SCORE} home score file.
2970 This seems rather simple and self-evident, doesn't it? Well, yes. But
2971 there are some problems, especially with the @code{total-expiry}
2972 parameter. Say you have a mail group in two topics; one with
2973 @code{total-expiry} and one without. What happens when you do @kbd{M-x
2974 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
2975 of these topics you mean to expire articles from, so anything may
2976 happen. In fact, I hereby declare that it is @dfn{undefined} what
2977 happens. You just have to be careful if you do stuff like that.
2980 @node Misc Group Stuff
2981 @section Misc Group Stuff
2984 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2985 * Group Information:: Information and help on groups and Gnus.
2986 * Group Timestamp:: Making Gnus keep track of when you last read a group.
2987 * File Commands:: Reading and writing the Gnus files.
2994 @findex gnus-group-enter-server-mode
2995 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2996 @xref{The Server Buffer}.
3000 @findex gnus-group-post-news
3001 Post an article to a group (@code{gnus-group-post-news}). If given a
3002 prefix, the current group name will be used as the default.
3006 @findex gnus-group-mail
3007 Mail a message somewhere (@code{gnus-group-mail}).
3011 Variables for the group buffer:
3015 @item gnus-group-mode-hook
3016 @vindex gnus-group-mode-hook
3017 is called after the group buffer has been
3020 @item gnus-group-prepare-hook
3021 @vindex gnus-group-prepare-hook
3022 is called after the group buffer is
3023 generated. It may be used to modify the buffer in some strange,
3026 @item gnus-group-prepared-hook
3027 @vindex gnus-group-prepare-hook
3028 is called as the very last thing after the group buffer has been
3029 generated. It may be used to move point around, for instance.
3031 @item gnus-permanently-visible-groups
3032 @vindex gnus-permanently-visible-groups
3033 Groups matching this regexp will always be listed in the group buffer,
3034 whether they are empty or not.
3039 @node Scanning New Messages
3040 @subsection Scanning New Messages
3041 @cindex new messages
3042 @cindex scanning new news
3048 @findex gnus-group-get-new-news
3049 @c @icon{gnus-group-get-new-news}
3050 Check the server(s) for new articles. If the numerical prefix is used,
3051 this command will check only groups of level @var{arg} and lower
3052 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
3053 command will force a total re-reading of the active file(s) from the
3058 @findex gnus-group-get-new-news-this-group
3059 @vindex gnus-goto-next-group-when-activating
3060 @c @icon{gnus-group-get-new-news-this-group}
3061 Check whether new articles have arrived in the current group
3062 (@code{gnus-group-get-new-news-this-group}).
3063 @code{gnus-goto-next-group-when-activating} says whether this command is
3064 to move point to the next group or not. It is @code{t} by default.
3066 @findex gnus-activate-all-groups
3067 @cindex activating groups
3069 @kindex C-c M-g (Group)
3070 Activate absolutely all groups (@code{gnus-activate-all-groups}).
3075 @findex gnus-group-restart
3076 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
3077 file(s), closes the connection to all servers, clears up all run-time
3078 Gnus variables, and then starts Gnus all over again.
3082 @vindex gnus-get-new-news-hook
3083 @code{gnus-get-new-news-hook} is run just before checking for new news.
3085 @vindex gnus-after-getting-new-news-hook
3086 @code{gnus-after-getting-new-news-hook} is run after checking for new
3090 @node Group Information
3091 @subsection Group Information
3092 @cindex group information
3093 @cindex information on groups
3100 @findex gnus-group-fetch-faq
3101 @vindex gnus-group-faq-directory
3104 Try to fetch the FAQ for the current group
3105 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
3106 @code{gnus-group-faq-directory}, which is usually a directory on a
3107 remote machine. This variable can also be a list of directories. In
3108 that case, giving a prefix to this command will allow you to choose
3109 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
3110 for fetching the file.
3112 If fetching from the first site is unsuccessful, Gnus will attempt to go
3113 through @code{gnus-group-faq-directory} and try to open them one by one.
3117 @c @icon{gnus-group-describe-group}
3119 @kindex C-c C-d (Group)
3120 @cindex describing groups
3121 @cindex group description
3122 @findex gnus-group-describe-group
3123 Describe the current group (@code{gnus-group-describe-group}). If given
3124 a prefix, force Gnus to re-read the description from the server.
3128 @findex gnus-group-describe-all-groups
3129 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
3130 prefix, force Gnus to re-read the description file from the server.
3137 @findex gnus-version
3138 Display current Gnus version numbers (@code{gnus-version}).
3142 @findex gnus-group-describe-briefly
3143 Give a very short help message (@code{gnus-group-describe-briefly}).
3146 @kindex C-c C-i (Group)
3149 @findex gnus-info-find-node
3150 Go to the Gnus info node (@code{gnus-info-find-node}).
3154 @node Group Timestamp
3155 @subsection Group Timestamp
3157 @cindex group timestamps
3159 It can be convenient to let Gnus keep track of when you last read a
3160 group. To set the ball rolling, you should add
3161 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3164 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3167 After doing this, each time you enter a group, it'll be recorded.
3169 This information can be displayed in various ways---the easiest is to
3170 use the @samp{%d} spec in the group line format:
3173 (setq gnus-group-line-format
3174 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3177 This will result in lines looking like:
3180 * 0: mail.ding 19961002T012943
3181 0: custom 19961002T012713
3184 As you can see, the date is displayed in compact ISO 8601 format. This
3185 may be a bit too much, so to just display the date, you could say
3189 (setq gnus-group-line-format
3190 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3195 @subsection File Commands
3196 @cindex file commands
3202 @findex gnus-group-read-init-file
3203 @vindex gnus-init-file
3204 @cindex reading init file
3205 Re-read the init file (@code{gnus-init-file}, which defaults to
3206 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3210 @findex gnus-group-save-newsrc
3211 @cindex saving .newsrc
3212 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3213 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
3214 file(s) whether Gnus thinks it is necessary or not.
3217 @c @kindex Z (Group)
3218 @c @findex gnus-group-clear-dribble
3219 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3224 @node The Summary Buffer
3225 @chapter The Summary Buffer
3226 @cindex summary buffer
3228 A line for each article is displayed in the summary buffer. You can
3229 move around, read articles, post articles and reply to articles.
3231 The most common way to a summary buffer is to select a group from the
3232 group buffer (@pxref{Selecting a Group}).
3234 You can have as many summary buffers open as you wish.
3237 * Summary Buffer Format:: Deciding how the summary buffer is to look.
3238 * Summary Maneuvering:: Moving around the summary buffer.
3239 * Choosing Articles:: Reading articles.
3240 * Paging the Article:: Scrolling the current article.
3241 * Reply Followup and Post:: Posting articles.
3242 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
3243 * Marking Articles:: Marking articles as read, expirable, etc.
3244 * Limiting:: You can limit the summary buffer.
3245 * Threading:: How threads are made.
3246 * Sorting:: How articles and threads are sorted.
3247 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
3248 * Article Caching:: You may store articles in a cache.
3249 * Persistent Articles:: Making articles expiry-resistant.
3250 * Article Backlog:: Having already read articles hang around.
3251 * Saving Articles:: Ways of customizing article saving.
3252 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
3253 * Article Treatment:: The article buffer can be mangled at will.
3254 * MIME Commands:: Doing MIMEy things with the articles.
3255 * Charsets:: Character set issues.
3256 * Article Commands:: Doing various things with the article buffer.
3257 * Summary Sorting:: Sorting the summary buffer in various ways.
3258 * Finding the Parent:: No child support? Get the parent.
3259 * Alternative Approaches:: Reading using non-default summaries.
3260 * Tree Display:: A more visual display of threads.
3261 * Mail Group Commands:: Some commands can only be used in mail groups.
3262 * Various Summary Stuff:: What didn't fit anywhere else.
3263 * Exiting the Summary Buffer:: Returning to the Group buffer.
3264 * Crosspost Handling:: How crossposted articles are dealt with.
3265 * Duplicate Suppression:: An alternative when crosspost handling fails.
3269 @node Summary Buffer Format
3270 @section Summary Buffer Format
3271 @cindex summary buffer format
3275 \gnusfigure{The Summary Buffer}{180}{
3276 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3277 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3283 * Summary Buffer Lines:: You can specify how summary lines should look.
3284 * To From Newsgroups:: How to not display your own name.
3285 * Summary Buffer Mode Line:: You can say how the mode line should look.
3286 * Summary Highlighting:: Making the summary buffer all pretty and nice.
3289 @findex mail-extract-address-components
3290 @findex gnus-extract-address-components
3291 @vindex gnus-extract-address-components
3292 Gnus will use the value of the @code{gnus-extract-address-components}
3293 variable as a function for getting the name and address parts of a
3294 @code{From} header. Two pre-defined functions exist:
3295 @code{gnus-extract-address-components}, which is the default, quite
3296 fast, and too simplistic solution; and
3297 @code{mail-extract-address-components}, which works very nicely, but is
3298 slower. The default function will return the wrong answer in 5% of the
3299 cases. If this is unacceptable to you, use the other function instead:
3302 (setq gnus-extract-address-components
3303 'mail-extract-address-components)
3306 @vindex gnus-summary-same-subject
3307 @code{gnus-summary-same-subject} is a string indicating that the current
3308 article has the same subject as the previous. This string will be used
3309 with those specs that require it. The default is @code{""}.
3312 @node Summary Buffer Lines
3313 @subsection Summary Buffer Lines
3315 @vindex gnus-summary-line-format
3316 You can change the format of the lines in the summary buffer by changing
3317 the @code{gnus-summary-line-format} variable. It works along the same
3318 lines as a normal @code{format} string, with some extensions
3319 (@pxref{Formatting Variables}).
3321 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3323 The following format specification characters are understood:
3331 Subject if the article is the root of the thread or the previous article
3332 had a different subject, @code{gnus-summary-same-subject} otherwise.
3333 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3335 Full @code{From} header.
3337 The name (from the @code{From} header).
3339 The name, code @code{To} header or the @code{Newsgroups} header
3340 (@pxref{To From Newsgroups}).
3342 The name (from the @code{From} header). This differs from the @code{n}
3343 spec in that it uses the function designated by the
3344 @code{gnus-extract-address-components} variable, which is slower, but
3345 may be more thorough.
3347 The address (from the @code{From} header). This works the same way as
3350 Number of lines in the article.
3352 Number of characters in the article.
3354 Indentation based on thread level (@pxref{Customizing Threading}).
3356 Nothing if the article is a root and lots of spaces if it isn't (it
3357 pushes everything after it off the screen).
3359 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3360 for adopted articles (@pxref{Customizing Threading}).
3362 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3363 for adopted articles.
3365 One space for each thread level.
3367 Twenty minus thread level spaces.
3372 This misleadingly named specifier is the @dfn{secondary mark}. This
3373 mark will say whether the article has been replied to, has been cached,
3377 Score as a number (@pxref{Scoring}).
3379 @vindex gnus-summary-zcore-fuzz
3380 Zcore, @samp{+} if above the default level and @samp{-} if below the
3381 default level. If the difference between
3382 @code{gnus-summary-default-score} and the score is less than
3383 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3391 The @code{Date} in @code{DD-MMM} format.
3393 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3399 Number of articles in the current sub-thread. Using this spec will slow
3400 down summary buffer generation somewhat.
3402 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3403 article has any children.
3409 User defined specifier. The next character in the format string should
3410 be a letter. Gnus will call the function
3411 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3412 following @samp{%u}. The function will be passed the current header as
3413 argument. The function should return a string, which will be inserted
3414 into the summary just like information from any other summary specifier.
3417 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3418 have to be handled with care. For reasons of efficiency, Gnus will
3419 compute what column these characters will end up in, and ``hard-code''
3420 that. This means that it is invalid to have these specs after a
3421 variable-length spec. Well, you might not be arrested, but your summary
3422 buffer will look strange, which is bad enough.
3424 The smart choice is to have these specs as far to the left as possible.
3425 (Isn't that the case with everything, though? But I digress.)
3427 This restriction may disappear in later versions of Gnus.
3430 @node To From Newsgroups
3431 @subsection To From Newsgroups
3435 In some groups (particularly in archive groups), the @code{From} header
3436 isn't very interesting, since all the articles there are written by
3437 you. To display the information in the @code{To} or @code{Newsgroups}
3438 headers instead, you need to decide three things: What information to
3439 gather; where to display it; and when to display it.
3443 @vindex gnus-extra-headers
3444 The reading of extra header information is controlled by the
3445 @code{gnus-extra-headers}. This is a list of header symbols. For
3449 (setq gnus-extra-headers
3450 '(To Newsgroups X-Newsreader))
3453 This will result in Gnus trying to obtain these three headers, and
3454 storing it in header structures for later easy retrieval.
3457 @findex gnus-extra-header
3458 The value of these extra headers can be accessed via the
3459 @code{gnus-extra-header} function. Here's a format line spec that will
3460 access the @code{X-Newsreader} header:
3463 "%~(form (gnus-extra-header 'X-Newsreader))@@"
3467 @vindex gnus-ignored-from-addresses
3468 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
3469 summary line spec returns the @code{To}, @code{Newsreader} or
3470 @code{From} header. If this regexp matches the contents of the
3471 @code{From} header, the value of the @code{To} or @code{Newsreader}
3472 headers are used instead.
3476 @vindex nnmail-extra-headers
3477 A related variable is @code{nnmail-extra-headers}, which controls when
3478 to include extra headers when generating overview (@sc{nov}) files. If
3479 you have old overview files, you should regenerate them after changing
3482 @vindex gnus-summary-line-format
3483 You also have to instruct Gnus to display the data by changing the
3484 @code{%n} spec to the @code{%f} spec in the
3485 @code{gnus-summary-line-format} variable.
3487 In summary, you'd typically do something like the following:
3490 (setq gnus-extra-headers
3492 (setq nnmail-extra-headers gnus-extra-headers)
3493 (setq gnus-summary-line-format
3494 "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n")
3495 (setq gnus-ignored-from-addresses
3499 Now, this is mostly useful for mail groups, where you have control over
3500 the @sc{nov} files that are created. However, if you can persuade your
3507 to the end of her @file{overview.fmt} file, then you can use that just
3508 as you would the extra headers from the mail groups.
3511 @node Summary Buffer Mode Line
3512 @subsection Summary Buffer Mode Line
3514 @vindex gnus-summary-mode-line-format
3515 You can also change the format of the summary mode bar (@pxref{Mode Line
3516 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
3517 like. The default is @samp{Gnus: %%b [%A] %Z}.
3519 Here are the elements you can play with:
3525 Unprefixed group name.
3527 Current article number.
3529 Current article score.
3533 Number of unread articles in this group.
3535 Number of unread articles in this group that aren't displayed in the
3538 A string with the number of unread and unselected articles represented
3539 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3540 articles, and just as @samp{<%U more>} if there are just unread articles
3541 and no unselected ones.
3543 Shortish group name. For instance, @samp{rec.arts.anime} will be
3544 shortened to @samp{r.a.anime}.
3546 Subject of the current article.
3548 User-defined spec (@pxref{User-Defined Specs}).
3550 Name of the current score file (@pxref{Scoring}).
3552 Number of dormant articles (@pxref{Unread Articles}).
3554 Number of ticked articles (@pxref{Unread Articles}).
3556 Number of articles that have been marked as read in this session.
3558 Number of articles expunged by the score files.
3562 @node Summary Highlighting
3563 @subsection Summary Highlighting
3567 @item gnus-visual-mark-article-hook
3568 @vindex gnus-visual-mark-article-hook
3569 This hook is run after selecting an article. It is meant to be used for
3570 highlighting the article in some way. It is not run if
3571 @code{gnus-visual} is @code{nil}.
3573 @item gnus-summary-update-hook
3574 @vindex gnus-summary-update-hook
3575 This hook is called when a summary line is changed. It is not run if
3576 @code{gnus-visual} is @code{nil}.
3578 @item gnus-summary-selected-face
3579 @vindex gnus-summary-selected-face
3580 This is the face (or @dfn{font} as some people call it) used to
3581 highlight the current article in the summary buffer.
3583 @item gnus-summary-highlight
3584 @vindex gnus-summary-highlight
3585 Summary lines are highlighted according to this variable, which is a
3586 list where the elements are of the format @var{(FORM . FACE)}. If you
3587 would, for instance, like ticked articles to be italic and high-scored
3588 articles to be bold, you could set this variable to something like
3590 (((eq mark gnus-ticked-mark) . italic)
3591 ((> score default) . bold))
3593 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3594 @var{FACE} will be applied to the line.
3598 @node Summary Maneuvering
3599 @section Summary Maneuvering
3600 @cindex summary movement
3602 All the straight movement commands understand the numeric prefix and
3603 behave pretty much as you'd expect.
3605 None of these commands select articles.
3610 @kindex M-n (Summary)
3611 @kindex G M-n (Summary)
3612 @findex gnus-summary-next-unread-subject
3613 Go to the next summary line of an unread article
3614 (@code{gnus-summary-next-unread-subject}).
3618 @kindex M-p (Summary)
3619 @kindex G M-p (Summary)
3620 @findex gnus-summary-prev-unread-subject
3621 Go to the previous summary line of an unread article
3622 (@code{gnus-summary-prev-unread-subject}).
3627 @kindex G j (Summary)
3628 @findex gnus-summary-goto-article
3629 Ask for an article number or @code{Message-ID}, and then go to that
3630 article (@code{gnus-summary-goto-article}).
3633 @kindex G g (Summary)
3634 @findex gnus-summary-goto-subject
3635 Ask for an article number and then go to the summary line of that article
3636 without displaying the article (@code{gnus-summary-goto-subject}).
3639 If Gnus asks you to press a key to confirm going to the next group, you
3640 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3641 buffer, searching for the next group to read without actually returning
3642 to the group buffer.
3644 Variables related to summary movement:
3648 @vindex gnus-auto-select-next
3649 @item gnus-auto-select-next
3650 If you issue one of the movement commands (like @kbd{n}) and there are
3651 no more unread articles after the current one, Gnus will offer to go to
3652 the next group. If this variable is @code{t} and the next group is
3653 empty, Gnus will exit summary mode and return to the group buffer. If
3654 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3655 next group, no matter whether it has any unread articles or not. As a
3656 special case, if this variable is @code{quietly}, Gnus will select the
3657 next group without asking for confirmation. If this variable is
3658 @code{almost-quietly}, the same will happen only if you are located on
3659 the last article in the group. Finally, if this variable is
3660 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3661 without confirmation. Also @pxref{Group Levels}.
3663 @item gnus-auto-select-same
3664 @vindex gnus-auto-select-same
3665 If non-@code{nil}, all the movement commands will try to go to the next
3666 article with the same subject as the current. (@dfn{Same} here might
3667 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
3668 for details (@pxref{Customizing Threading}).) If there are no more
3669 articles with the same subject, go to the first unread article.
3671 This variable is not particularly useful if you use a threaded display.
3673 @item gnus-summary-check-current
3674 @vindex gnus-summary-check-current
3675 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3676 to the next (or previous) article if the current article is unread.
3677 Instead, they will choose the current article.
3679 @item gnus-auto-center-summary
3680 @vindex gnus-auto-center-summary
3681 If non-@code{nil}, Gnus will keep the point in the summary buffer
3682 centered at all times. This makes things quite tidy, but if you have a
3683 slow network connection, or simply do not like this un-Emacsism, you can
3684 set this variable to @code{nil} to get the normal Emacs scrolling
3685 action. This will also inhibit horizontal re-centering of the summary
3686 buffer, which might make it more inconvenient to read extremely long
3689 This variable can also be a number. In that case, center the window at
3690 the given number of lines from the top.
3695 @node Choosing Articles
3696 @section Choosing Articles
3697 @cindex selecting articles
3700 * Choosing Commands:: Commands for choosing articles.
3701 * Choosing Variables:: Variables that influence these commands.
3705 @node Choosing Commands
3706 @subsection Choosing Commands
3708 None of the following movement commands understand the numeric prefix,
3709 and they all select and display an article.
3713 @kindex SPACE (Summary)
3714 @findex gnus-summary-next-page
3715 Select the current article, or, if that one's read already, the next
3716 unread article (@code{gnus-summary-next-page}).
3721 @kindex G n (Summary)
3722 @findex gnus-summary-next-unread-article
3723 @c @icon{gnus-summary-next-unread}
3724 Go to next unread article (@code{gnus-summary-next-unread-article}).
3729 @findex gnus-summary-prev-unread-article
3730 @c @icon{gnus-summary-prev-unread}
3731 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3736 @kindex G N (Summary)
3737 @findex gnus-summary-next-article
3738 Go to the next article (@code{gnus-summary-next-article}).
3743 @kindex G P (Summary)
3744 @findex gnus-summary-prev-article
3745 Go to the previous article (@code{gnus-summary-prev-article}).
3748 @kindex G C-n (Summary)
3749 @findex gnus-summary-next-same-subject
3750 Go to the next article with the same subject
3751 (@code{gnus-summary-next-same-subject}).
3754 @kindex G C-p (Summary)
3755 @findex gnus-summary-prev-same-subject
3756 Go to the previous article with the same subject
3757 (@code{gnus-summary-prev-same-subject}).
3761 @kindex G f (Summary)
3763 @findex gnus-summary-first-unread-article
3764 Go to the first unread article
3765 (@code{gnus-summary-first-unread-article}).
3769 @kindex G b (Summary)
3771 @findex gnus-summary-best-unread-article
3772 Go to the article with the highest score
3773 (@code{gnus-summary-best-unread-article}).
3778 @kindex G l (Summary)
3779 @findex gnus-summary-goto-last-article
3780 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3783 @kindex G o (Summary)
3784 @findex gnus-summary-pop-article
3786 @cindex article history
3787 Pop an article off the summary history and go to this article
3788 (@code{gnus-summary-pop-article}). This command differs from the
3789 command above in that you can pop as many previous articles off the
3790 history as you like, while @kbd{l} toggles the two last read articles.
3791 For a somewhat related issue (if you use these commands a lot),
3792 @pxref{Article Backlog}.
3796 @node Choosing Variables
3797 @subsection Choosing Variables
3799 Some variables relevant for moving and selecting articles:
3802 @item gnus-auto-extend-newsgroup
3803 @vindex gnus-auto-extend-newsgroup
3804 All the movement commands will try to go to the previous (or next)
3805 article, even if that article isn't displayed in the Summary buffer if
3806 this variable is non-@code{nil}. Gnus will then fetch the article from
3807 the server and display it in the article buffer.
3809 @item gnus-select-article-hook
3810 @vindex gnus-select-article-hook
3811 This hook is called whenever an article is selected. By default it
3812 exposes any threads hidden under the selected article.
3814 @item gnus-mark-article-hook
3815 @vindex gnus-mark-article-hook
3816 @findex gnus-summary-mark-unread-as-read
3817 @findex gnus-summary-mark-read-and-unread-as-read
3818 @findex gnus-unread-mark
3819 This hook is called whenever an article is selected. It is intended to
3820 be used for marking articles as read. The default value is
3821 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3822 mark of almost any article you read to @code{gnus-unread-mark}. The
3823 only articles not affected by this function are ticked, dormant, and
3824 expirable articles. If you'd instead like to just have unread articles
3825 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3826 instead. It will leave marks like @code{gnus-low-score-mark},
3827 @code{gnus-del-mark} (and so on) alone.
3832 @node Paging the Article
3833 @section Scrolling the Article
3834 @cindex article scrolling
3839 @kindex SPACE (Summary)
3840 @findex gnus-summary-next-page
3841 Pressing @kbd{SPACE} will scroll the current article forward one page,
3842 or, if you have come to the end of the current article, will choose the
3843 next article (@code{gnus-summary-next-page}).
3846 @kindex DEL (Summary)
3847 @findex gnus-summary-prev-page
3848 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3851 @kindex RET (Summary)
3852 @findex gnus-summary-scroll-up
3853 Scroll the current article one line forward
3854 (@code{gnus-summary-scroll-up}).
3857 @kindex M-RET (Summary)
3858 @findex gnus-summary-scroll-down
3859 Scroll the current article one line backward
3860 (@code{gnus-summary-scroll-down}).
3864 @kindex A g (Summary)
3866 @findex gnus-summary-show-article
3867 (Re)fetch the current article (@code{gnus-summary-show-article}). If
3868 given a prefix, fetch the current article, but don't run any of the
3869 article treatment functions. This will give you a ``raw'' article, just
3870 the way it came from the server.
3875 @kindex A < (Summary)
3876 @findex gnus-summary-beginning-of-article
3877 Scroll to the beginning of the article
3878 (@code{gnus-summary-beginning-of-article}).
3883 @kindex A > (Summary)
3884 @findex gnus-summary-end-of-article
3885 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3889 @kindex A s (Summary)
3891 @findex gnus-summary-isearch-article
3892 Perform an isearch in the article buffer
3893 (@code{gnus-summary-isearch-article}).
3897 @findex gnus-summary-select-article-buffer
3898 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3903 @node Reply Followup and Post
3904 @section Reply, Followup and Post
3907 * Summary Mail Commands:: Sending mail.
3908 * Summary Post Commands:: Sending news.
3912 @node Summary Mail Commands
3913 @subsection Summary Mail Commands
3915 @cindex composing mail
3917 Commands for composing a mail message:
3923 @kindex S r (Summary)
3925 @findex gnus-summary-reply
3926 @c @icon{gnus-summary-mail-reply}
3927 @c @icon{gnus-summary-reply}
3928 Mail a reply to the author of the current article
3929 (@code{gnus-summary-reply}).
3934 @kindex S R (Summary)
3935 @findex gnus-summary-reply-with-original
3936 @c @icon{gnus-summary-reply-with-original}
3937 Mail a reply to the author of the current article and include the
3938 original message (@code{gnus-summary-reply-with-original}). This
3939 command uses the process/prefix convention.
3942 @kindex S w (Summary)
3943 @findex gnus-summary-wide-reply
3944 Mail a wide reply to the author of the current article
3945 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
3946 goes out to all people listed in the @code{To}, @code{From} (or
3947 @code{Reply-to}) and @code{Cc} headers.
3950 @kindex S W (Summary)
3951 @findex gnus-summary-wide-reply-with-original
3952 Mail a wide reply to the current article and include the original
3953 message (@code{gnus-summary-wide-reply-with-original}). This command uses
3954 the process/prefix convention.
3957 @kindex S o m (Summary)
3958 @findex gnus-summary-mail-forward
3959 @c @icon{gnus-summary-mail-forward}
3960 Forward the current article to some other person
3961 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
3962 headers of the forwarded article.
3967 @kindex S m (Summary)
3968 @findex gnus-summary-mail-other-window
3969 @c @icon{gnus-summary-mail-originate}
3970 Send a mail to some other person
3971 (@code{gnus-summary-mail-other-window}).
3974 @kindex S D b (Summary)
3975 @findex gnus-summary-resend-bounced-mail
3976 @cindex bouncing mail
3977 If you have sent a mail, but the mail was bounced back to you for some
3978 reason (wrong address, transient failure), you can use this command to
3979 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
3980 will be popped into a mail buffer where you can edit the headers before
3981 sending the mail off again. If you give a prefix to this command, and
3982 the bounced mail is a reply to some other mail, Gnus will try to fetch
3983 that mail and display it for easy perusal of its headers. This might
3984 very well fail, though.
3987 @kindex S D r (Summary)
3988 @findex gnus-summary-resend-message
3989 Not to be confused with the previous command,
3990 @code{gnus-summary-resend-message} will prompt you for an address to
3991 send the current message off to, and then send it to that place. The
3992 headers of the message won't be altered---but lots of headers that say
3993 @code{Resent-To}, @code{Resent-From} and so on will be added. This
3994 means that you actually send a mail to someone that has a @code{To}
3995 header that (probably) points to yourself. This will confuse people.
3996 So, natcherly you'll only do that if you're really eVIl.
3998 This command is mainly used if you have several accounts and want to
3999 ship a mail to a different account of yours. (If you're both
4000 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4001 to the @code{root} account, you may want to resend it to
4002 @code{postmaster}. Ordnung muß sein!
4004 This command understands the process/prefix convention
4005 (@pxref{Process/Prefix}).
4008 @kindex S O m (Summary)
4009 @findex gnus-uu-digest-mail-forward
4010 Digest the current series (@pxref{Decoding Articles}) and forward the
4011 result using mail (@code{gnus-uu-digest-mail-forward}). This command
4012 uses the process/prefix convention (@pxref{Process/Prefix}).
4015 @kindex S M-c (Summary)
4016 @findex gnus-summary-mail-crosspost-complaint
4017 @cindex crossposting
4018 @cindex excessive crossposting
4019 Send a complaint about excessive crossposting to the author of the
4020 current article (@code{gnus-summary-mail-crosspost-complaint}).
4022 @findex gnus-crosspost-complaint
4023 This command is provided as a way to fight back against the current
4024 crossposting pandemic that's sweeping Usenet. It will compose a reply
4025 using the @code{gnus-crosspost-complaint} variable as a preamble. This
4026 command understands the process/prefix convention
4027 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4031 Also @pxref{(message)Header Commands} for more information.
4034 @node Summary Post Commands
4035 @subsection Summary Post Commands
4037 @cindex composing news
4039 Commands for posting a news article:
4045 @kindex S p (Summary)
4046 @findex gnus-summary-post-news
4047 @c @icon{gnus-summary-post-news}
4048 Post an article to the current group
4049 (@code{gnus-summary-post-news}).
4054 @kindex S f (Summary)
4055 @findex gnus-summary-followup
4056 @c @icon{gnus-summary-followup}
4057 Post a followup to the current article (@code{gnus-summary-followup}).
4061 @kindex S F (Summary)
4063 @c @icon{gnus-summary-followup-with-original}
4064 @findex gnus-summary-followup-with-original
4065 Post a followup to the current article and include the original message
4066 (@code{gnus-summary-followup-with-original}). This command uses the
4067 process/prefix convention.
4070 @kindex S n (Summary)
4071 @findex gnus-summary-followup-to-mail
4072 Post a followup to the current article via news, even if you got the
4073 message through mail (@code{gnus-summary-followup-to-mail}).
4076 @kindex S N (Summary)
4077 @findex gnus-summary-followup-to-mail-with-original
4078 Post a followup to the current article via news, even if you got the
4079 message through mail and include the original message
4080 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
4081 the process/prefix convention.
4084 @kindex S o p (Summary)
4085 @findex gnus-summary-post-forward
4086 Forward the current article to a newsgroup
4087 (@code{gnus-summary-post-forward}). If given a prefix, include the full
4088 headers of the forwarded article.
4091 @kindex S O p (Summary)
4092 @findex gnus-uu-digest-post-forward
4094 @cindex making digests
4095 Digest the current series and forward the result to a newsgroup
4096 (@code{gnus-uu-digest-mail-forward}). This command uses the
4097 process/prefix convention.
4100 @kindex S u (Summary)
4101 @findex gnus-uu-post-news
4102 @c @icon{gnus-uu-post-news}
4103 Uuencode a file, split it into parts, and post it as a series
4104 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
4107 Also @pxref{(message)Header Commands} for more information.
4110 @node Canceling and Superseding
4111 @section Canceling Articles
4112 @cindex canceling articles
4113 @cindex superseding articles
4115 Have you ever written something, and then decided that you really,
4116 really, really wish you hadn't posted that?
4118 Well, you can't cancel mail, but you can cancel posts.
4120 @findex gnus-summary-cancel-article
4122 @c @icon{gnus-summary-cancel-article}
4123 Find the article you wish to cancel (you can only cancel your own
4124 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
4125 c} (@code{gnus-summary-cancel-article}). Your article will be
4126 canceled---machines all over the world will be deleting your article.
4127 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4129 Be aware, however, that not all sites honor cancels, so your article may
4130 live on here and there, while most sites will delete the article in
4133 Gnus will use the ``current'' select method when canceling. If you
4134 want to use the standard posting method, use the @samp{a} symbolic
4135 prefix (@pxref{Symbolic Prefixes}).
4137 If you discover that you have made some mistakes and want to do some
4138 corrections, you can post a @dfn{superseding} article that will replace
4139 your original article.
4141 @findex gnus-summary-supersede-article
4143 Go to the original article and press @kbd{S s}
4144 (@code{gnus-summary-supersede-article}). You will be put in a buffer
4145 where you can edit the article all you want before sending it off the
4148 The same goes for superseding as for canceling, only more so: Some
4149 sites do not honor superseding. On those sites, it will appear that you
4150 have posted almost the same article twice.
4152 If you have just posted the article, and change your mind right away,
4153 there is a trick you can use to cancel/supersede the article without
4154 waiting for the article to appear on your site first. You simply return
4155 to the post buffer (which is called @code{*sent ...*}). There you will
4156 find the article you just posted, with all the headers intact. Change
4157 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4158 header by substituting one of those words for the word
4159 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
4160 you would do normally. The previous article will be
4161 canceled/superseded.
4163 Just remember, kids: There is no 'c' in 'supersede'.
4166 @node Marking Articles
4167 @section Marking Articles
4168 @cindex article marking
4169 @cindex article ticking
4172 There are several marks you can set on an article.
4174 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4175 neologism ohoy!) of the article. Alphabetic marks generally mean
4176 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4178 In addition, you also have marks that do not affect readedness.
4181 * Unread Articles:: Marks for unread articles.
4182 * Read Articles:: Marks for read articles.
4183 * Other Marks:: Marks that do not affect readedness.
4187 There's a plethora of commands for manipulating these marks:
4191 * Setting Marks:: How to set and remove marks.
4192 * Setting Process Marks:: How to mark articles for later processing.
4196 @node Unread Articles
4197 @subsection Unread Articles
4199 The following marks mark articles as (kinda) unread, in one form or
4204 @vindex gnus-ticked-mark
4205 Marked as ticked (@code{gnus-ticked-mark}).
4207 @dfn{Ticked articles} are articles that will remain visible always. If
4208 you see an article that you find interesting, or you want to put off
4209 reading it, or replying to it, until sometime later, you'd typically
4210 tick it. However, articles can be expired, so if you want to keep an
4211 article forever, you'll have to make it persistent (@pxref{Persistent
4215 @vindex gnus-dormant-mark
4216 Marked as dormant (@code{gnus-dormant-mark}).
4218 @dfn{Dormant articles} will only appear in the summary buffer if there
4219 are followups to it. If you want to see them even if they don't have
4220 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4223 @vindex gnus-unread-mark
4224 Marked as unread (@code{gnus-unread-mark}).
4226 @dfn{Unread articles} are articles that haven't been read at all yet.
4231 @subsection Read Articles
4232 @cindex expirable mark
4234 All the following marks mark articles as read.
4239 @vindex gnus-del-mark
4240 These are articles that the user has marked as read with the @kbd{d}
4241 command manually, more or less (@code{gnus-del-mark}).
4244 @vindex gnus-read-mark
4245 Articles that have actually been read (@code{gnus-read-mark}).
4248 @vindex gnus-ancient-mark
4249 Articles that were marked as read in previous sessions and are now
4250 @dfn{old} (@code{gnus-ancient-mark}).
4253 @vindex gnus-killed-mark
4254 Marked as killed (@code{gnus-killed-mark}).
4257 @vindex gnus-kill-file-mark
4258 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4261 @vindex gnus-low-score-mark
4262 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4265 @vindex gnus-catchup-mark
4266 Marked as read by a catchup (@code{gnus-catchup-mark}).
4269 @vindex gnus-canceled-mark
4270 Canceled article (@code{gnus-canceled-mark})
4273 @vindex gnus-souped-mark
4274 @sc{SOUP}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
4277 @vindex gnus-sparse-mark
4278 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
4282 @vindex gnus-duplicate-mark
4283 Article marked as read by duplicate suppression
4284 (@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}.
4288 All these marks just mean that the article is marked as read, really.
4289 They are interpreted differently when doing adaptive scoring, though.
4291 One more special mark, though:
4295 @vindex gnus-expirable-mark
4296 Marked as expirable (@code{gnus-expirable-mark}).
4298 Marking articles as @dfn{expirable} (or have them marked as such
4299 automatically) doesn't make much sense in normal groups---a user doesn't
4300 control expiring of news articles, but in mail groups, for instance,
4301 articles marked as @dfn{expirable} can be deleted by Gnus at
4307 @subsection Other Marks
4308 @cindex process mark
4311 There are some marks that have nothing to do with whether the article is
4317 You can set a bookmark in the current article. Say you are reading a
4318 long thesis on cats' urinary tracts, and have to go home for dinner
4319 before you've finished reading the thesis. You can then set a bookmark
4320 in the article, and Gnus will jump to this bookmark the next time it
4321 encounters the article. @xref{Setting Marks}.
4324 @vindex gnus-replied-mark
4325 All articles that you have replied to or made a followup to (i.e., have
4326 answered) will be marked with an @samp{A} in the second column
4327 (@code{gnus-replied-mark}).
4330 @vindex gnus-cached-mark
4331 Articles stored in the article cache will be marked with an @samp{*} in
4332 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
4335 @vindex gnus-saved-mark
4336 Articles ``saved'' (in some manner or other; not necessarily
4337 religiously) are marked with an @samp{S} in the second column
4338 (@code{gnus-saved-mark}).
4341 @vindex gnus-not-empty-thread-mark
4342 @vindex gnus-empty-thread-mark
4343 If the @samp{%e} spec is used, the presence of threads or not will be
4344 marked with @code{gnus-not-empty-thread-mark} and
4345 @code{gnus-empty-thread-mark} in the third column, respectively.
4348 @vindex gnus-process-mark
4349 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
4350 variety of commands react to the presence of the process mark. For
4351 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4352 all articles that have been marked with the process mark. Articles
4353 marked with the process mark have a @samp{#} in the second column.
4357 You might have noticed that most of these ``non-readedness'' marks
4358 appear in the second column by default. So if you have a cached, saved,
4359 replied article that you have process-marked, what will that look like?
4361 Nothing much. The precedence rules go as follows: process -> cache ->
4362 replied -> saved. So if the article is in the cache and is replied,
4363 you'll only see the cache mark and not the replied mark.
4367 @subsection Setting Marks
4368 @cindex setting marks
4370 All the marking commands understand the numeric prefix.
4375 @kindex M c (Summary)
4376 @kindex M-u (Summary)
4377 @findex gnus-summary-clear-mark-forward
4378 @cindex mark as unread
4379 Clear all readedness-marks from the current article
4380 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
4386 @kindex M t (Summary)
4387 @findex gnus-summary-tick-article-forward
4388 Tick the current article (@code{gnus-summary-tick-article-forward}).
4389 @xref{Article Caching}.
4394 @kindex M ? (Summary)
4395 @findex gnus-summary-mark-as-dormant
4396 Mark the current article as dormant
4397 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
4401 @kindex M d (Summary)
4403 @findex gnus-summary-mark-as-read-forward
4404 Mark the current article as read
4405 (@code{gnus-summary-mark-as-read-forward}).
4409 @findex gnus-summary-mark-as-read-backward
4410 Mark the current article as read and move point to the previous line
4411 (@code{gnus-summary-mark-as-read-backward}).
4416 @kindex M k (Summary)
4417 @findex gnus-summary-kill-same-subject-and-select
4418 Mark all articles that have the same subject as the current one as read,
4419 and then select the next unread article
4420 (@code{gnus-summary-kill-same-subject-and-select}).
4424 @kindex M K (Summary)
4425 @kindex C-k (Summary)
4426 @findex gnus-summary-kill-same-subject
4427 Mark all articles that have the same subject as the current one as read
4428 (@code{gnus-summary-kill-same-subject}).
4431 @kindex M C (Summary)
4432 @findex gnus-summary-catchup
4433 @c @icon{gnus-summary-catchup}
4434 Mark all unread articles as read (@code{gnus-summary-catchup}).
4437 @kindex M C-c (Summary)
4438 @findex gnus-summary-catchup-all
4439 Mark all articles in the group as read---even the ticked and dormant
4440 articles (@code{gnus-summary-catchup-all}).
4443 @kindex M H (Summary)
4444 @findex gnus-summary-catchup-to-here
4445 Catchup the current group to point
4446 (@code{gnus-summary-catchup-to-here}).
4449 @kindex C-w (Summary)
4450 @findex gnus-summary-mark-region-as-read
4451 Mark all articles between point and mark as read
4452 (@code{gnus-summary-mark-region-as-read}).
4455 @kindex M V k (Summary)
4456 @findex gnus-summary-kill-below
4457 Kill all articles with scores below the default score (or below the
4458 numeric prefix) (@code{gnus-summary-kill-below}).
4462 @kindex M e (Summary)
4464 @findex gnus-summary-mark-as-expirable
4465 Mark the current article as expirable
4466 (@code{gnus-summary-mark-as-expirable}).
4469 @kindex M b (Summary)
4470 @findex gnus-summary-set-bookmark
4471 Set a bookmark in the current article
4472 (@code{gnus-summary-set-bookmark}).
4475 @kindex M B (Summary)
4476 @findex gnus-summary-remove-bookmark
4477 Remove the bookmark from the current article
4478 (@code{gnus-summary-remove-bookmark}).
4481 @kindex M V c (Summary)
4482 @findex gnus-summary-clear-above
4483 Clear all marks from articles with scores over the default score (or
4484 over the numeric prefix) (@code{gnus-summary-clear-above}).
4487 @kindex M V u (Summary)
4488 @findex gnus-summary-tick-above
4489 Tick all articles with scores over the default score (or over the
4490 numeric prefix) (@code{gnus-summary-tick-above}).
4493 @kindex M V m (Summary)
4494 @findex gnus-summary-mark-above
4495 Prompt for a mark, and mark all articles with scores over the default
4496 score (or over the numeric prefix) with this mark
4497 (@code{gnus-summary-clear-above}).
4500 @vindex gnus-summary-goto-unread
4501 The @code{gnus-summary-goto-unread} variable controls what action should
4502 be taken after setting a mark. If non-@code{nil}, point will move to
4503 the next/previous unread article. If @code{nil}, point will just move
4504 one line up or down. As a special case, if this variable is
4505 @code{never}, all the marking commands as well as other commands (like
4506 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4507 The default is @code{t}.
4510 @node Setting Process Marks
4511 @subsection Setting Process Marks
4512 @cindex setting process marks
4519 @kindex M P p (Summary)
4520 @findex gnus-summary-mark-as-processable
4521 Mark the current article with the process mark
4522 (@code{gnus-summary-mark-as-processable}).
4523 @findex gnus-summary-unmark-as-processable
4527 @kindex M P u (Summary)
4528 @kindex M-# (Summary)
4529 Remove the process mark, if any, from the current article
4530 (@code{gnus-summary-unmark-as-processable}).
4533 @kindex M P U (Summary)
4534 @findex gnus-summary-unmark-all-processable
4535 Remove the process mark from all articles
4536 (@code{gnus-summary-unmark-all-processable}).
4539 @kindex M P i (Summary)
4540 @findex gnus-uu-invert-processable
4541 Invert the list of process marked articles
4542 (@code{gnus-uu-invert-processable}).
4545 @kindex M P R (Summary)
4546 @findex gnus-uu-mark-by-regexp
4547 Mark articles that have a @code{Subject} header that matches a regular
4548 expression (@code{gnus-uu-mark-by-regexp}).
4551 @kindex M P r (Summary)
4552 @findex gnus-uu-mark-region
4553 Mark articles in region (@code{gnus-uu-mark-region}).
4556 @kindex M P t (Summary)
4557 @findex gnus-uu-mark-thread
4558 Mark all articles in the current (sub)thread
4559 (@code{gnus-uu-mark-thread}).
4562 @kindex M P T (Summary)
4563 @findex gnus-uu-unmark-thread
4564 Unmark all articles in the current (sub)thread
4565 (@code{gnus-uu-unmark-thread}).
4568 @kindex M P v (Summary)
4569 @findex gnus-uu-mark-over
4570 Mark all articles that have a score above the prefix argument
4571 (@code{gnus-uu-mark-over}).
4574 @kindex M P s (Summary)
4575 @findex gnus-uu-mark-series
4576 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4579 @kindex M P S (Summary)
4580 @findex gnus-uu-mark-sparse
4581 Mark all series that have already had some articles marked
4582 (@code{gnus-uu-mark-sparse}).
4585 @kindex M P a (Summary)
4586 @findex gnus-uu-mark-all
4587 Mark all articles in series order (@code{gnus-uu-mark-series}).
4590 @kindex M P b (Summary)
4591 @findex gnus-uu-mark-buffer
4592 Mark all articles in the buffer in the order they appear
4593 (@code{gnus-uu-mark-buffer}).
4596 @kindex M P k (Summary)
4597 @findex gnus-summary-kill-process-mark
4598 Push the current process mark set onto the stack and unmark all articles
4599 (@code{gnus-summary-kill-process-mark}).
4602 @kindex M P y (Summary)
4603 @findex gnus-summary-yank-process-mark
4604 Pop the previous process mark set from the stack and restore it
4605 (@code{gnus-summary-yank-process-mark}).
4608 @kindex M P w (Summary)
4609 @findex gnus-summary-save-process-mark
4610 Push the current process mark set onto the stack
4611 (@code{gnus-summary-save-process-mark}).
4620 It can be convenient to limit the summary buffer to just show some
4621 subset of the articles currently in the group. The effect most limit
4622 commands have is to remove a few (or many) articles from the summary
4625 All limiting commands work on subsets of the articles already fetched
4626 from the servers. None of these commands query the server for
4627 additional articles.
4633 @kindex / / (Summary)
4634 @findex gnus-summary-limit-to-subject
4635 Limit the summary buffer to articles that match some subject
4636 (@code{gnus-summary-limit-to-subject}).
4639 @kindex / a (Summary)
4640 @findex gnus-summary-limit-to-author
4641 Limit the summary buffer to articles that match some author
4642 (@code{gnus-summary-limit-to-author}).
4646 @kindex / u (Summary)
4648 @findex gnus-summary-limit-to-unread
4649 Limit the summary buffer to articles not marked as read
4650 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
4651 buffer to articles strictly unread. This means that ticked and
4652 dormant articles will also be excluded.
4655 @kindex / m (Summary)
4656 @findex gnus-summary-limit-to-marks
4657 Ask for a mark and then limit to all articles that have been marked
4658 with that mark (@code{gnus-summary-limit-to-marks}).
4661 @kindex / t (Summary)
4662 @findex gnus-summary-limit-to-age
4663 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4664 (@code{gnus-summary-limit-to-marks}). If given a prefix, limit to
4665 articles younger than that number of days.
4668 @kindex / n (Summary)
4669 @findex gnus-summary-limit-to-articles
4670 Limit the summary buffer to the current article
4671 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
4672 convention (@pxref{Process/Prefix}).
4675 @kindex / w (Summary)
4676 @findex gnus-summary-pop-limit
4677 Pop the previous limit off the stack and restore it
4678 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
4682 @kindex / v (Summary)
4683 @findex gnus-summary-limit-to-score
4684 Limit the summary buffer to articles that have a score at or above some
4685 score (@code{gnus-summary-limit-to-score}).
4689 @kindex M S (Summary)
4690 @kindex / E (Summary)
4691 @findex gnus-summary-limit-include-expunged
4692 Include all expunged articles in the limit
4693 (@code{gnus-summary-limit-include-expunged}).
4696 @kindex / D (Summary)
4697 @findex gnus-summary-limit-include-dormant
4698 Include all dormant articles in the limit
4699 (@code{gnus-summary-limit-include-dormant}).
4702 @kindex / * (Summary)
4703 @findex gnus-summary-limit-include-cached
4704 Include all cached articles in the limit
4705 (@code{gnus-summary-limit-include-cached}).
4708 @kindex / d (Summary)
4709 @findex gnus-summary-limit-exclude-dormant
4710 Exclude all dormant articles from the limit
4711 (@code{gnus-summary-limit-exclude-dormant}).
4714 @kindex / M (Summary)
4715 @findex gnus-summary-limit-exclude-marks
4716 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
4719 @kindex / T (Summary)
4720 @findex gnus-summary-limit-include-thread
4721 Include all the articles in the current thread in the limit.
4724 @kindex / c (Summary)
4725 @findex gnus-summary-limit-exclude-childless-dormant
4726 Exclude all dormant articles that have no children from the limit
4727 (@code{gnus-summary-limit-exclude-childless-dormant}).
4730 @kindex / C (Summary)
4731 @findex gnus-summary-limit-mark-excluded-as-read
4732 Mark all excluded unread articles as read
4733 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
4734 also mark excluded ticked and dormant articles as read.
4742 @cindex article threading
4744 Gnus threads articles by default. @dfn{To thread} is to put responses
4745 to articles directly after the articles they respond to---in a
4746 hierarchical fashion.
4748 Threading is done by looking at the @code{References} headers of the
4749 articles. In a perfect world, this would be enough to build pretty
4750 trees, but unfortunately, the @code{References} header is often broken
4751 or simply missing. Weird news propagation excarcerbates the problem,
4752 so one has to employ other heuristics to get pleasing results. A
4753 plethora of approaches exists, as detailed in horrible detail in
4754 @pxref{Customizing Threading}.
4756 First, a quick overview of the concepts:
4760 The top-most article in a thread; the first article in the thread.
4763 A tree-like article structure.
4766 A small(er) section of this tree-like structure.
4769 Threads often lose their roots due to article expiry, or due to the root
4770 already having been read in a previous session, and not displayed in the
4771 summary buffer. We then typically have many sub-threads that really
4772 belong to one thread, but are without connecting roots. These are
4773 called loose threads.
4775 @item thread gathering
4776 An attempt to gather loose threads into bigger threads.
4778 @item sparse threads
4779 A thread where the missing articles have been ``guessed'' at, and are
4780 displayed as empty lines in the summary buffer.
4786 * Customizing Threading:: Variables you can change to affect the threading.
4787 * Thread Commands:: Thread based commands in the summary buffer.
4791 @node Customizing Threading
4792 @subsection Customizing Threading
4793 @cindex customizing threading
4796 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
4797 * Filling In Threads:: Making the threads displayed look fuller.
4798 * More Threading:: Even more variables for fiddling with threads.
4799 * Low-Level Threading:: You thought it was over... but you were wrong!
4804 @subsubsection Loose Threads
4807 @cindex loose threads
4810 @item gnus-summary-make-false-root
4811 @vindex gnus-summary-make-false-root
4812 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4813 and create a dummy root at the top. (Wait a minute. Root at the top?
4814 Yup.) Loose subtrees occur when the real root has expired, or you've
4815 read or killed the root in a previous session.
4817 When there is no real root of a thread, Gnus will have to fudge
4818 something. This variable says what fudging method Gnus should use.
4819 There are four possible values:
4823 \gnusfigure{The Summary Buffer}{390}{
4824 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4825 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4826 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4827 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4832 @cindex adopting articles
4837 Gnus will make the first of the orphaned articles the parent. This
4838 parent will adopt all the other articles. The adopted articles will be
4839 marked as such by pointy brackets (@samp{<>}) instead of the standard
4840 square brackets (@samp{[]}). This is the default method.
4843 @vindex gnus-summary-dummy-line-format
4844 Gnus will create a dummy summary line that will pretend to be the
4845 parent. This dummy line does not correspond to any real article, so
4846 selecting it will just select the first real article after the dummy
4847 article. @code{gnus-summary-dummy-line-format} is used to specify the
4848 format of the dummy roots. It accepts only one format spec: @samp{S},
4849 which is the subject of the article. @xref{Formatting Variables}.
4852 Gnus won't actually make any article the parent, but simply leave the
4853 subject field of all orphans except the first empty. (Actually, it will
4854 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4858 Don't make any article parent at all. Just gather the threads and
4859 display them after one another.
4862 Don't gather loose threads.
4865 @item gnus-summary-gather-subject-limit
4866 @vindex gnus-summary-gather-subject-limit
4867 Loose threads are gathered by comparing subjects of articles. If this
4868 variable is @code{nil}, Gnus requires an exact match between the
4869 subjects of the loose threads before gathering them into one big
4870 super-thread. This might be too strict a requirement, what with the
4871 presence of stupid newsreaders that chop off long subject lines. If
4872 you think so, set this variable to, say, 20 to require that only the
4873 first 20 characters of the subjects have to match. If you set this
4874 variable to a really low number, you'll find that Gnus will gather
4875 everything in sight into one thread, which isn't very helpful.
4877 @cindex fuzzy article gathering
4878 If you set this variable to the special value @code{fuzzy}, Gnus will
4879 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4882 @item gnus-simplify-subject-fuzzy-regexp
4883 @vindex gnus-simplify-subject-fuzzy-regexp
4884 This can either be a regular expression or list of regular expressions
4885 that match strings that will be removed from subjects if fuzzy subject
4886 simplification is used.
4888 @item gnus-simplify-ignored-prefixes
4889 @vindex gnus-simplify-ignored-prefixes
4890 If you set @code{gnus-summary-gather-subject-limit} to something as low
4891 as 10, you might consider setting this variable to something sensible:
4893 @c Written by Michael Ernst <mernst@cs.rice.edu>
4895 (setq gnus-simplify-ignored-prefixes
4901 "wanted" "followup" "summary\\( of\\)?"
4902 "help" "query" "problem" "question"
4903 "answer" "reference" "announce"
4904 "How can I" "How to" "Comparison of"
4909 (mapconcat 'identity
4910 '("for" "for reference" "with" "about")
4912 "\\)?\\]?:?[ \t]*"))
4915 All words that match this regexp will be removed before comparing two
4918 @item gnus-simplify-subject-functions
4919 @vindex gnus-simplify-subject-functions
4920 If non-@code{nil}, this variable overrides
4921 @code{gnus-summary-gather-subject-limit}. This variable should be a
4922 list of functions to apply to the @code{Subject} string iteratively to
4923 arrive at the simplified version of the string.
4925 Useful functions to put in this list include:
4928 @item gnus-simplify-subject-re
4929 @findex gnus-simplify-subject-re
4930 Strip the leading @samp{Re:}.
4932 @item gnus-simplify-subject-fuzzy
4933 @findex gnus-simplify-subject-fuzzy
4936 @item gnus-simplify-whitespace
4937 @findex gnus-simplify-whitespace
4938 Remove excessive whitespace.
4941 You may also write your own functions, of course.
4944 @item gnus-summary-gather-exclude-subject
4945 @vindex gnus-summary-gather-exclude-subject
4946 Since loose thread gathering is done on subjects only, that might lead
4947 to many false hits, especially with certain common subjects like
4948 @samp{} and @samp{(none)}. To make the situation slightly better,
4949 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4950 what subjects should be excluded from the gathering process.@*
4951 The default is @samp{^ *$\\|^(none)$}.
4953 @item gnus-summary-thread-gathering-function
4954 @vindex gnus-summary-thread-gathering-function
4955 Gnus gathers threads by looking at @code{Subject} headers. This means
4956 that totally unrelated articles may end up in the same ``thread'', which
4957 is confusing. An alternate approach is to look at all the
4958 @code{Message-ID}s in all the @code{References} headers to find matches.
4959 This will ensure that no gathered threads ever include unrelated
4960 articles, but it also means that people who have posted with broken
4961 newsreaders won't be gathered properly. The choice is yours---plague or
4965 @item gnus-gather-threads-by-subject
4966 @findex gnus-gather-threads-by-subject
4967 This function is the default gathering function and looks at
4968 @code{Subject}s exclusively.
4970 @item gnus-gather-threads-by-references
4971 @findex gnus-gather-threads-by-references
4972 This function looks at @code{References} headers exclusively.
4975 If you want to test gathering by @code{References}, you could say
4979 (setq gnus-summary-thread-gathering-function
4980 'gnus-gather-threads-by-references)
4986 @node Filling In Threads
4987 @subsubsection Filling In Threads
4990 @item gnus-fetch-old-headers
4991 @vindex gnus-fetch-old-headers
4992 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4993 more old headers---headers to articles marked as read. If you
4994 would like to display as few summary lines as possible, but still
4995 connect as many loose threads as possible, you should set this variable
4996 to @code{some} or a number. If you set it to a number, no more than
4997 that number of extra old headers will be fetched. In either case,
4998 fetching old headers only works if the backend you are using carries
4999 overview files---this would normally be @code{nntp}, @code{nnspool} and
5000 @code{nnml}. Also remember that if the root of the thread has been
5001 expired by the server, there's not much Gnus can do about that.
5003 This variable can also be set to @code{invisible}. This won't have any
5004 visible effects, but is useful if you use the @kbd{A T} command a lot
5005 (@pxref{Finding the Parent}).
5007 @item gnus-build-sparse-threads
5008 @vindex gnus-build-sparse-threads
5009 Fetching old headers can be slow. A low-rent similar effect can be
5010 gotten by setting this variable to @code{some}. Gnus will then look at
5011 the complete @code{References} headers of all articles and try to string
5012 together articles that belong in the same thread. This will leave
5013 @dfn{gaps} in the threading display where Gnus guesses that an article
5014 is missing from the thread. (These gaps appear like normal summary
5015 lines. If you select a gap, Gnus will try to fetch the article in
5016 question.) If this variable is @code{t}, Gnus will display all these
5017 ``gaps'' without regard for whether they are useful for completing the
5018 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
5019 off sparse leaf nodes that don't lead anywhere. This variable is
5020 @code{nil} by default.
5025 @node More Threading
5026 @subsubsection More Threading
5029 @item gnus-show-threads
5030 @vindex gnus-show-threads
5031 If this variable is @code{nil}, no threading will be done, and all of
5032 the rest of the variables here will have no effect. Turning threading
5033 off will speed group selection up a bit, but it is sure to make reading
5034 slower and more awkward.
5036 @item gnus-thread-hide-subtree
5037 @vindex gnus-thread-hide-subtree
5038 If non-@code{nil}, all threads will be hidden when the summary buffer is
5041 @item gnus-thread-expunge-below
5042 @vindex gnus-thread-expunge-below
5043 All threads that have a total score (as defined by
5044 @code{gnus-thread-score-function}) less than this number will be
5045 expunged. This variable is @code{nil} by default, which means that no
5046 threads are expunged.
5048 @item gnus-thread-hide-killed
5049 @vindex gnus-thread-hide-killed
5050 if you kill a thread and this variable is non-@code{nil}, the subtree
5053 @item gnus-thread-ignore-subject
5054 @vindex gnus-thread-ignore-subject
5055 Sometimes somebody changes the subject in the middle of a thread. If
5056 this variable is non-@code{nil}, the subject change is ignored. If it
5057 is @code{nil}, which is the default, a change in the subject will result
5060 @item gnus-thread-indent-level
5061 @vindex gnus-thread-indent-level
5062 This is a number that says how much each sub-thread should be indented.
5068 @node Low-Level Threading
5069 @subsubsection Low-Level Threading
5073 @item gnus-parse-headers-hook
5074 @vindex gnus-parse-headers-hook
5075 Hook run before parsing any headers.
5077 @item gnus-alter-header-function
5078 @vindex gnus-alter-header-function
5079 If non-@code{nil}, this function will be called to allow alteration of
5080 article header structures. The function is called with one parameter,
5081 the article header vector, which it may alter in any way. For instance,
5082 if you have a mail-to-news gateway which alters the @code{Message-ID}s
5083 in systematic ways (by adding prefixes and such), you can use this
5084 variable to un-scramble the @code{Message-ID}s so that they are more
5085 meaningful. Here's one example:
5088 (setq gnus-alter-header-function 'my-alter-message-id)
5090 (defun my-alter-message-id (header)
5091 (let ((id (mail-header-id header)))
5093 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
5095 (concat (match-string 1 id) "@@" (match-string 2 id))
5102 @node Thread Commands
5103 @subsection Thread Commands
5104 @cindex thread commands
5110 @kindex T k (Summary)
5111 @kindex M-C-k (Summary)
5112 @findex gnus-summary-kill-thread
5113 Mark all articles in the current (sub-)thread as read
5114 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
5115 remove all marks instead. If the prefix argument is negative, tick
5120 @kindex T l (Summary)
5121 @kindex M-C-l (Summary)
5122 @findex gnus-summary-lower-thread
5123 Lower the score of the current (sub-)thread
5124 (@code{gnus-summary-lower-thread}).
5127 @kindex T i (Summary)
5128 @findex gnus-summary-raise-thread
5129 Increase the score of the current (sub-)thread
5130 (@code{gnus-summary-raise-thread}).
5133 @kindex T # (Summary)
5134 @findex gnus-uu-mark-thread
5135 Set the process mark on the current (sub-)thread
5136 (@code{gnus-uu-mark-thread}).
5139 @kindex T M-# (Summary)
5140 @findex gnus-uu-unmark-thread
5141 Remove the process mark from the current (sub-)thread
5142 (@code{gnus-uu-unmark-thread}).
5145 @kindex T T (Summary)
5146 @findex gnus-summary-toggle-threads
5147 Toggle threading (@code{gnus-summary-toggle-threads}).
5150 @kindex T s (Summary)
5151 @findex gnus-summary-show-thread
5152 Expose the (sub-)thread hidden under the current article, if any
5153 (@code{gnus-summary-show-thread}).
5156 @kindex T h (Summary)
5157 @findex gnus-summary-hide-thread
5158 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5161 @kindex T S (Summary)
5162 @findex gnus-summary-show-all-threads
5163 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5166 @kindex T H (Summary)
5167 @findex gnus-summary-hide-all-threads
5168 Hide all threads (@code{gnus-summary-hide-all-threads}).
5171 @kindex T t (Summary)
5172 @findex gnus-summary-rethread-current
5173 Re-thread the current article's thread
5174 (@code{gnus-summary-rethread-current}). This works even when the
5175 summary buffer is otherwise unthreaded.
5178 @kindex T ^ (Summary)
5179 @findex gnus-summary-reparent-thread
5180 Make the current article the child of the marked (or previous) article
5181 (@code{gnus-summary-reparent-thread}).
5185 The following commands are thread movement commands. They all
5186 understand the numeric prefix.
5191 @kindex T n (Summary)
5192 @findex gnus-summary-next-thread
5193 Go to the next thread (@code{gnus-summary-next-thread}).
5196 @kindex T p (Summary)
5197 @findex gnus-summary-prev-thread
5198 Go to the previous thread (@code{gnus-summary-prev-thread}).
5201 @kindex T d (Summary)
5202 @findex gnus-summary-down-thread
5203 Descend the thread (@code{gnus-summary-down-thread}).
5206 @kindex T u (Summary)
5207 @findex gnus-summary-up-thread
5208 Ascend the thread (@code{gnus-summary-up-thread}).
5211 @kindex T o (Summary)
5212 @findex gnus-summary-top-thread
5213 Go to the top of the thread (@code{gnus-summary-top-thread}).
5216 @vindex gnus-thread-operation-ignore-subject
5217 If you ignore subject while threading, you'll naturally end up with
5218 threads that have several different subjects in them. If you then issue
5219 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5220 wish to kill the entire thread, but just those parts of the thread that
5221 have the same subject as the current article. If you like this idea,
5222 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
5223 is non-@code{nil} (which it is by default), subjects will be ignored
5224 when doing thread commands. If this variable is @code{nil}, articles in
5225 the same thread with different subjects will not be included in the
5226 operation in question. If this variable is @code{fuzzy}, only articles
5227 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5234 @findex gnus-thread-sort-by-total-score
5235 @findex gnus-thread-sort-by-date
5236 @findex gnus-thread-sort-by-score
5237 @findex gnus-thread-sort-by-subject
5238 @findex gnus-thread-sort-by-author
5239 @findex gnus-thread-sort-by-number
5240 @vindex gnus-thread-sort-functions
5241 If you are using a threaded summary display, you can sort the threads by
5242 setting @code{gnus-thread-sort-functions}, which can be either a single
5243 function, a list of functions, or a list containing functions and
5244 @code{(not some-function)} elements.
5246 By default, sorting is done on article numbers. Ready-made sorting
5247 predicate functions include @code{gnus-thread-sort-by-number},
5248 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5249 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5250 @code{gnus-thread-sort-by-total-score}.
5252 Each function takes two threads and returns non-@code{nil} if the first
5253 thread should be sorted before the other. Note that sorting really is
5254 normally done by looking only at the roots of each thread.
5256 If you use more than one function, the primary sort key should be the
5257 last function in the list. You should probably always include
5258 @code{gnus-thread-sort-by-number} in the list of sorting
5259 functions---preferably first. This will ensure that threads that are
5260 equal with respect to the other sort criteria will be displayed in
5261 ascending article order.
5263 If you would like to sort by reverse score, then by subject, and finally
5264 by number, you could do something like:
5267 (setq gnus-thread-sort-functions
5268 '(gnus-thread-sort-by-number
5269 gnus-thread-sort-by-subject
5270 (reverse gnus-thread-sort-by-total-score)))
5273 The threads that have highest score will be displayed first in the
5274 summary buffer. When threads have the same score, they will be sorted
5275 alphabetically. The threads that have the same score and the same
5276 subject will be sorted by number, which is (normally) the sequence in
5277 which the articles arrived.
5279 If you want to sort by score and then reverse arrival order, you could
5283 (setq gnus-thread-sort-functions
5285 (not (gnus-thread-sort-by-number t1 t2)))
5286 gnus-thread-sort-by-score))
5289 @vindex gnus-thread-score-function
5290 The function in the @code{gnus-thread-score-function} variable (default
5291 @code{+}) is used for calculating the total score of a thread. Useful
5292 functions might be @code{max}, @code{min}, or squared means, or whatever
5295 @findex gnus-article-sort-functions
5296 @findex gnus-article-sort-by-date
5297 @findex gnus-article-sort-by-score
5298 @findex gnus-article-sort-by-subject
5299 @findex gnus-article-sort-by-author
5300 @findex gnus-article-sort-by-number
5301 If you are using an unthreaded display for some strange reason or other,
5302 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5303 It is very similar to the @code{gnus-thread-sort-functions}, except that
5304 it uses slightly different functions for article comparison. Available
5305 sorting predicate functions are @code{gnus-article-sort-by-number},
5306 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5307 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5309 If you want to sort an unthreaded summary display by subject, you could
5313 (setq gnus-article-sort-functions
5314 '(gnus-article-sort-by-number
5315 gnus-article-sort-by-subject))
5320 @node Asynchronous Fetching
5321 @section Asynchronous Article Fetching
5322 @cindex asynchronous article fetching
5323 @cindex article pre-fetch
5326 If you read your news from an @sc{nntp} server that's far away, the
5327 network latencies may make reading articles a chore. You have to wait
5328 for a while after pressing @kbd{n} to go to the next article before the
5329 article appears. Why can't Gnus just go ahead and fetch the article
5330 while you are reading the previous one? Why not, indeed.
5332 First, some caveats. There are some pitfalls to using asynchronous
5333 article fetching, especially the way Gnus does it.
5335 Let's say you are reading article 1, which is short, and article 2 is
5336 quite long, and you are not interested in reading that. Gnus does not
5337 know this, so it goes ahead and fetches article 2. You decide to read
5338 article 3, but since Gnus is in the process of fetching article 2, the
5339 connection is blocked.
5341 To avoid these situations, Gnus will open two (count 'em two)
5342 connections to the server. Some people may think this isn't a very nice
5343 thing to do, but I don't see any real alternatives. Setting up that
5344 extra connection takes some time, so Gnus startup will be slower.
5346 Gnus will fetch more articles than you will read. This will mean that
5347 the link between your machine and the @sc{nntp} server will become more
5348 loaded than if you didn't use article pre-fetch. The server itself will
5349 also become more loaded---both with the extra article requests, and the
5352 Ok, so now you know that you shouldn't really use this thing... unless
5355 @vindex gnus-asynchronous
5356 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
5357 happen automatically.
5359 @vindex gnus-use-article-prefetch
5360 You can control how many articles are to be pre-fetched by setting
5361 @code{gnus-use-article-prefetch}. This is 30 by default, which means
5362 that when you read an article in the group, the backend will pre-fetch
5363 the next 30 articles. If this variable is @code{t}, the backend will
5364 pre-fetch all the articles it can without bound. If it is
5365 @code{nil}, no pre-fetching will be done.
5367 @vindex gnus-async-prefetch-article-p
5368 @findex gnus-async-read-p
5369 There are probably some articles that you don't want to pre-fetch---read
5370 articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should
5371 return non-@code{nil} when the article in question is to be
5372 pre-fetched. The default is @code{gnus-async-read-p}, which returns
5373 @code{nil} on read articles. The function is called with an article
5374 data structure as the only parameter.
5376 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
5379 (defun my-async-short-unread-p (data)
5380 "Return non-nil for short, unread articles."
5381 (and (gnus-data-unread-p data)
5382 (< (mail-header-lines (gnus-data-header data))
5385 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5388 These functions will be called many, many times, so they should
5389 preferably be short and sweet to avoid slowing down Gnus too much.
5390 It's probably a good idea to byte-compile things like this.
5392 @vindex gnus-prefetched-article-deletion-strategy
5393 Articles have to be removed from the asynch buffer sooner or later. The
5394 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5395 articles. This is a list that may contain the following elements:
5399 Remove articles when they are read.
5402 Remove articles when exiting the group.
5405 The default value is @code{(read exit)}.
5407 @c @vindex gnus-use-header-prefetch
5408 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5409 @c from the next group.
5412 @node Article Caching
5413 @section Article Caching
5414 @cindex article caching
5417 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5418 consider turning article caching on. Each article will then be stored
5419 locally under your home directory. As you may surmise, this could
5420 potentially use @emph{huge} amounts of disk space, as well as eat up all
5421 your inodes so fast it will make your head swim. In vodka.
5423 Used carefully, though, it could be just an easier way to save articles.
5425 @vindex gnus-use-long-file-name
5426 @vindex gnus-cache-directory
5427 @vindex gnus-use-cache
5428 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
5429 all articles ticked or marked as dormant will then be copied
5430 over to your local cache (@code{gnus-cache-directory}). Whether this
5431 cache is flat or hierarchal is controlled by the
5432 @code{gnus-use-long-file-name} variable, as usual.
5434 When re-selecting a ticked or dormant article, it will be fetched from the
5435 cache instead of from the server. As articles in your cache will never
5436 expire, this might serve as a method of saving articles while still
5437 keeping them where they belong. Just mark all articles you want to save
5438 as dormant, and don't worry.
5440 When an article is marked as read, is it removed from the cache.
5442 @vindex gnus-cache-remove-articles
5443 @vindex gnus-cache-enter-articles
5444 The entering/removal of articles from the cache is controlled by the
5445 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5446 variables. Both are lists of symbols. The first is @code{(ticked
5447 dormant)} by default, meaning that ticked and dormant articles will be
5448 put in the cache. The latter is @code{(read)} by default, meaning that
5449 articles marked as read are removed from the cache. Possibly
5450 symbols in these two lists are @code{ticked}, @code{dormant},
5451 @code{unread} and @code{read}.
5453 @findex gnus-jog-cache
5454 So where does the massive article-fetching and storing come into the
5455 picture? The @code{gnus-jog-cache} command will go through all
5456 subscribed newsgroups, request all unread articles, score them, and
5457 store them in the cache. You should only ever, ever ever ever, use this
5458 command if 1) your connection to the @sc{nntp} server is really, really,
5459 really slow and 2) you have a really, really, really huge disk.
5460 Seriously. One way to cut down on the number of articles downloaded is
5461 to score unwanted articles down and have them marked as read. They will
5462 not then be downloaded by this command.
5464 @vindex gnus-uncacheable-groups
5465 @vindex gnus-cacheable-groups
5466 It is likely that you do not want caching on all groups. For instance,
5467 if your @code{nnml} mail is located under your home directory, it makes no
5468 sense to cache it somewhere else under your home directory. Unless you
5469 feel that it's neat to use twice as much space.
5471 To limit the caching, you could set @code{gnus-cacheable-groups} to a
5472 regexp of groups to cache, @samp{^nntp} for instance, or set the
5473 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
5474 Both variables are @code{nil} by default. If a group matches both
5475 variables, the group is not cached.
5477 @findex gnus-cache-generate-nov-databases
5478 @findex gnus-cache-generate-active
5479 @vindex gnus-cache-active-file
5480 The cache stores information on what articles it contains in its active
5481 file (@code{gnus-cache-active-file}). If this file (or any other parts
5482 of the cache) becomes all messed up for some reason or other, Gnus
5483 offers two functions that will try to set things right. @kbd{M-x
5484 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5485 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5489 @node Persistent Articles
5490 @section Persistent Articles
5491 @cindex persistent articles
5493 Closely related to article caching, we have @dfn{persistent articles}.
5494 In fact, it's just a different way of looking at caching, and much more
5495 useful in my opinion.
5497 Say you're reading a newsgroup, and you happen on to some valuable gem
5498 that you want to keep and treasure forever. You'd normally just save it
5499 (using one of the many saving commands) in some file. The problem with
5500 that is that it's just, well, yucky. Ideally you'd prefer just having
5501 the article remain in the group where you found it forever; untouched by
5502 the expiry going on at the news server.
5504 This is what a @dfn{persistent article} is---an article that just won't
5505 be deleted. It's implemented using the normal cache functions, but
5506 you use two explicit commands for managing persistent articles:
5512 @findex gnus-cache-enter-article
5513 Make the current article persistent (@code{gnus-cache-enter-article}).
5516 @kindex M-* (Summary)
5517 @findex gnus-cache-remove-article
5518 Remove the current article from the persistent articles
5519 (@code{gnus-cache-remove-article}). This will normally delete the
5523 Both these commands understand the process/prefix convention.
5525 To avoid having all ticked articles (and stuff) entered into the cache,
5526 you should set @code{gnus-use-cache} to @code{passive} if you're just
5527 interested in persistent articles:
5530 (setq gnus-use-cache 'passive)
5534 @node Article Backlog
5535 @section Article Backlog
5537 @cindex article backlog
5539 If you have a slow connection, but the idea of using caching seems
5540 unappealing to you (and it is, really), you can help the situation some
5541 by switching on the @dfn{backlog}. This is where Gnus will buffer
5542 already read articles so that it doesn't have to re-fetch articles
5543 you've already read. This only helps if you are in the habit of
5544 re-selecting articles you've recently read, of course. If you never do
5545 that, turning the backlog on will slow Gnus down a little bit, and
5546 increase memory usage some.
5548 @vindex gnus-keep-backlog
5549 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5550 at most @var{n} old articles in a buffer for later re-fetching. If this
5551 variable is non-@code{nil} and is not a number, Gnus will store
5552 @emph{all} read articles, which means that your Emacs will grow without
5553 bound before exploding and taking your machine down with you. I put
5554 that in there just to keep y'all on your toes.
5556 This variable is @code{nil} by default.
5559 @node Saving Articles
5560 @section Saving Articles
5561 @cindex saving articles
5563 Gnus can save articles in a number of ways. Below is the documentation
5564 for saving articles in a fairly straight-forward fashion (i.e., little
5565 processing of the article is done before it is saved). For a different
5566 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5567 (@pxref{Decoding Articles}).
5569 @vindex gnus-save-all-headers
5570 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5571 unwanted headers before saving the article.
5573 @vindex gnus-saved-headers
5574 If the preceding variable is @code{nil}, all headers that match the
5575 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5576 deleted before saving.
5582 @kindex O o (Summary)
5584 @findex gnus-summary-save-article
5585 @c @icon{gnus-summary-save-article}
5586 Save the current article using the default article saver
5587 (@code{gnus-summary-save-article}).
5590 @kindex O m (Summary)
5591 @findex gnus-summary-save-article-mail
5592 Save the current article in mail format
5593 (@code{gnus-summary-save-article-mail}).
5596 @kindex O r (Summary)
5597 @findex gnus-summary-save-article-rmail
5598 Save the current article in rmail format
5599 (@code{gnus-summary-save-article-rmail}).
5602 @kindex O f (Summary)
5603 @findex gnus-summary-save-article-file
5604 @c @icon{gnus-summary-save-article-file}
5605 Save the current article in plain file format
5606 (@code{gnus-summary-save-article-file}).
5609 @kindex O F (Summary)
5610 @findex gnus-summary-write-article-file
5611 Write the current article in plain file format, overwriting any previous
5612 file contents (@code{gnus-summary-write-article-file}).
5615 @kindex O b (Summary)
5616 @findex gnus-summary-save-article-body-file
5617 Save the current article body in plain file format
5618 (@code{gnus-summary-save-article-body-file}).
5621 @kindex O h (Summary)
5622 @findex gnus-summary-save-article-folder
5623 Save the current article in mh folder format
5624 (@code{gnus-summary-save-article-folder}).
5627 @kindex O v (Summary)
5628 @findex gnus-summary-save-article-vm
5629 Save the current article in a VM folder
5630 (@code{gnus-summary-save-article-vm}).
5633 @kindex O p (Summary)
5634 @findex gnus-summary-pipe-output
5635 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
5636 the current article to a process (@code{gnus-summary-pipe-output}).
5639 @vindex gnus-prompt-before-saving
5640 All these commands use the process/prefix convention
5641 (@pxref{Process/Prefix}). If you save bunches of articles using these
5642 functions, you might get tired of being prompted for files to save each
5643 and every article in. The prompting action is controlled by
5644 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5645 default, giving you that excessive prompting action you know and
5646 loathe. If you set this variable to @code{t} instead, you'll be prompted
5647 just once for each series of articles you save. If you like to really
5648 have Gnus do all your thinking for you, you can even set this variable
5649 to @code{nil}, which means that you will never be prompted for files to
5650 save articles in. Gnus will simply save all the articles in the default
5654 @vindex gnus-default-article-saver
5655 You can customize the @code{gnus-default-article-saver} variable to make
5656 Gnus do what you want it to. You can use any of the six ready-made
5657 functions below, or you can create your own.
5661 @item gnus-summary-save-in-rmail
5662 @findex gnus-summary-save-in-rmail
5663 @vindex gnus-rmail-save-name
5664 @findex gnus-plain-save-name
5665 This is the default format, @dfn{babyl}. Uses the function in the
5666 @code{gnus-rmail-save-name} variable to get a file name to save the
5667 article in. The default is @code{gnus-plain-save-name}.
5669 @item gnus-summary-save-in-mail
5670 @findex gnus-summary-save-in-mail
5671 @vindex gnus-mail-save-name
5672 Save in a Unix mail (mbox) file. Uses the function in the
5673 @code{gnus-mail-save-name} variable to get a file name to save the
5674 article in. The default is @code{gnus-plain-save-name}.
5676 @item gnus-summary-save-in-file
5677 @findex gnus-summary-save-in-file
5678 @vindex gnus-file-save-name
5679 @findex gnus-numeric-save-name
5680 Append the article straight to an ordinary file. Uses the function in
5681 the @code{gnus-file-save-name} variable to get a file name to save the
5682 article in. The default is @code{gnus-numeric-save-name}.
5684 @item gnus-summary-save-body-in-file
5685 @findex gnus-summary-save-body-in-file
5686 Append the article body to an ordinary file. Uses the function in the
5687 @code{gnus-file-save-name} variable to get a file name to save the
5688 article in. The default is @code{gnus-numeric-save-name}.
5690 @item gnus-summary-save-in-folder
5691 @findex gnus-summary-save-in-folder
5692 @findex gnus-folder-save-name
5693 @findex gnus-Folder-save-name
5694 @vindex gnus-folder-save-name
5697 Save the article to an MH folder using @code{rcvstore} from the MH
5698 library. Uses the function in the @code{gnus-folder-save-name} variable
5699 to get a file name to save the article in. The default is
5700 @code{gnus-folder-save-name}, but you can also use
5701 @code{gnus-Folder-save-name}, which creates capitalized names.
5703 @item gnus-summary-save-in-vm
5704 @findex gnus-summary-save-in-vm
5705 Save the article in a VM folder. You have to have the VM mail
5706 reader to use this setting.
5709 @vindex gnus-article-save-directory
5710 All of these functions, except for the last one, will save the article
5711 in the @code{gnus-article-save-directory}, which is initialized from the
5712 @code{SAVEDIR} environment variable. This is @file{~/News/} by
5715 As you can see above, the functions use different functions to find a
5716 suitable name of a file to save the article in. Below is a list of
5717 available functions that generate names:
5721 @item gnus-Numeric-save-name
5722 @findex gnus-Numeric-save-name
5723 File names like @file{~/News/Alt.andrea-dworkin/45}.
5725 @item gnus-numeric-save-name
5726 @findex gnus-numeric-save-name
5727 File names like @file{~/News/alt.andrea-dworkin/45}.
5729 @item gnus-Plain-save-name
5730 @findex gnus-Plain-save-name
5731 File names like @file{~/News/Alt.andrea-dworkin}.
5733 @item gnus-plain-save-name
5734 @findex gnus-plain-save-name
5735 File names like @file{~/News/alt.andrea-dworkin}.
5738 @vindex gnus-split-methods
5739 You can have Gnus suggest where to save articles by plonking a regexp into
5740 the @code{gnus-split-methods} alist. For instance, if you would like to
5741 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5742 related to VM in @code{vm-stuff}, you could set this variable to something
5746 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5747 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5748 (my-choosing-function "../other-dir/my-stuff")
5749 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5752 We see that this is a list where each element is a list that has two
5753 elements---the @dfn{match} and the @dfn{file}. The match can either be
5754 a string (in which case it is used as a regexp to match on the article
5755 head); it can be a symbol (which will be called as a function with the
5756 group name as a parameter); or it can be a list (which will be
5757 @code{eval}ed). If any of these actions have a non-@code{nil} result,
5758 the @dfn{file} will be used as a default prompt. In addition, the
5759 result of the operation itself will be used if the function or form
5760 called returns a string or a list of strings.
5762 You basically end up with a list of file names that might be used when
5763 saving the current article. (All ``matches'' will be used.) You will
5764 then be prompted for what you really want to use as a name, with file
5765 name completion over the results from applying this variable.
5767 This variable is @code{((gnus-article-archive-name))} by default, which
5768 means that Gnus will look at the articles it saves for an
5769 @code{Archive-name} line and use that as a suggestion for the file
5772 Here's an example function to clean up file names somewhat. If you have
5773 lots of mail groups called things like
5774 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5775 these group names before creating the file name to save to. The
5776 following will do just that:
5779 (defun my-save-name (group)
5780 (when (string-match "^nnml:mail." group)
5781 (substring group (match-end 0))))
5783 (setq gnus-split-methods
5784 '((gnus-article-archive-name)
5789 @vindex gnus-use-long-file-name
5790 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
5791 @code{nil}, all the preceding functions will replace all periods
5792 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5793 the functions will generate hierarchies of directories instead of having
5794 all the files in the top level directory
5795 (@file{~/News/alt/andrea-dworkin} instead of
5796 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
5797 on most systems. However, for historical reasons, this is @code{nil} on
5798 Xenix and usg-unix-v machines by default.
5800 This function also affects kill and score file names. If this variable
5801 is a list, and the list contains the element @code{not-score}, long file
5802 names will not be used for score files, if it contains the element
5803 @code{not-save}, long file names will not be used for saving, and if it
5804 contains the element @code{not-kill}, long file names will not be used
5807 If you'd like to save articles in a hierarchy that looks something like
5811 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5812 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5815 Then just save with @kbd{o}. You'd then read this hierarchy with
5816 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5817 the top level directory as the argument (@file{~/News/}). Then just walk
5818 around to the groups/directories with @code{nneething}.
5821 @node Decoding Articles
5822 @section Decoding Articles
5823 @cindex decoding articles
5825 Sometime users post articles (or series of articles) that have been
5826 encoded in some way or other. Gnus can decode them for you.
5829 * Uuencoded Articles:: Uudecode articles.
5830 * Shell Archives:: Unshar articles.
5831 * PostScript Files:: Split PostScript.
5832 * Other Files:: Plain save and binhex.
5833 * Decoding Variables:: Variables for a happy decoding.
5834 * Viewing Files:: You want to look at the result of the decoding?
5838 @cindex article series
5839 All these functions use the process/prefix convention
5840 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5841 the extension that a ``single article'' means ``a single series''. Gnus
5842 can find out by itself what articles belong to a series, decode all the
5843 articles and unpack/view/save the resulting file(s).
5845 Gnus guesses what articles are in the series according to the following
5846 simplish rule: The subjects must be (nearly) identical, except for the
5847 last two numbers of the line. (Spaces are largely ignored, however.)
5849 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5850 will find all the articles that match the regexp @samp{^cat.gif
5851 ([0-9]+/[0-9]+).*$}.
5853 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5854 series}, will not be properly recognized by any of the automatic viewing
5855 commands, and you have to mark the articles manually with @kbd{#}.
5858 @node Uuencoded Articles
5859 @subsection Uuencoded Articles
5861 @cindex uuencoded articles
5866 @kindex X u (Summary)
5867 @findex gnus-uu-decode-uu
5868 @c @icon{gnus-uu-decode-uu}
5869 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5872 @kindex X U (Summary)
5873 @findex gnus-uu-decode-uu-and-save
5874 Uudecodes and saves the current series
5875 (@code{gnus-uu-decode-uu-and-save}).
5878 @kindex X v u (Summary)
5879 @findex gnus-uu-decode-uu-view
5880 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5883 @kindex X v U (Summary)
5884 @findex gnus-uu-decode-uu-and-save-view
5885 Uudecodes, views and saves the current series
5886 (@code{gnus-uu-decode-uu-and-save-view}).
5890 Remember that these all react to the presence of articles marked with
5891 the process mark. If, for instance, you'd like to decode and save an
5892 entire newsgroup, you'd typically do @kbd{M P a}
5893 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5894 (@code{gnus-uu-decode-uu-and-save}).
5896 All this is very much different from how @code{gnus-uu} worked with
5897 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5898 the sun. This version of @code{gnus-uu} generally assumes that you mark
5899 articles in some way (@pxref{Setting Process Marks}) and then press
5902 @vindex gnus-uu-notify-files
5903 Note: When trying to decode articles that have names matching
5904 @code{gnus-uu-notify-files}, which is hard-coded to
5905 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5906 automatically post an article on @samp{comp.unix.wizards} saying that
5907 you have just viewed the file in question. This feature can't be turned
5911 @node Shell Archives
5912 @subsection Shell Archives
5914 @cindex shell archives
5915 @cindex shared articles
5917 Shell archives (``shar files'') used to be a popular way to distribute
5918 sources, but it isn't used all that much today. In any case, we have
5919 some commands to deal with these:
5924 @kindex X s (Summary)
5925 @findex gnus-uu-decode-unshar
5926 Unshars the current series (@code{gnus-uu-decode-unshar}).
5929 @kindex X S (Summary)
5930 @findex gnus-uu-decode-unshar-and-save
5931 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5934 @kindex X v s (Summary)
5935 @findex gnus-uu-decode-unshar-view
5936 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5939 @kindex X v S (Summary)
5940 @findex gnus-uu-decode-unshar-and-save-view
5941 Unshars, views and saves the current series
5942 (@code{gnus-uu-decode-unshar-and-save-view}).
5946 @node PostScript Files
5947 @subsection PostScript Files
5953 @kindex X p (Summary)
5954 @findex gnus-uu-decode-postscript
5955 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5958 @kindex X P (Summary)
5959 @findex gnus-uu-decode-postscript-and-save
5960 Unpack and save the current PostScript series
5961 (@code{gnus-uu-decode-postscript-and-save}).
5964 @kindex X v p (Summary)
5965 @findex gnus-uu-decode-postscript-view
5966 View the current PostScript series
5967 (@code{gnus-uu-decode-postscript-view}).
5970 @kindex X v P (Summary)
5971 @findex gnus-uu-decode-postscript-and-save-view
5972 View and save the current PostScript series
5973 (@code{gnus-uu-decode-postscript-and-save-view}).
5978 @subsection Other Files
5982 @kindex X o (Summary)
5983 @findex gnus-uu-decode-save
5984 Save the current series
5985 (@code{gnus-uu-decode-save}).
5988 @kindex X b (Summary)
5989 @findex gnus-uu-decode-binhex
5990 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
5991 doesn't really work yet.
5995 @node Decoding Variables
5996 @subsection Decoding Variables
5998 Adjective, not verb.
6001 * Rule Variables:: Variables that say how a file is to be viewed.
6002 * Other Decode Variables:: Other decode variables.
6003 * Uuencoding and Posting:: Variables for customizing uuencoding.
6007 @node Rule Variables
6008 @subsubsection Rule Variables
6009 @cindex rule variables
6011 Gnus uses @dfn{rule variables} to decide how to view a file. All these
6012 variables are of the form
6015 (list '(regexp1 command2)
6022 @item gnus-uu-user-view-rules
6023 @vindex gnus-uu-user-view-rules
6025 This variable is consulted first when viewing files. If you wish to use,
6026 for instance, @code{sox} to convert an @samp{.au} sound file, you could
6029 (setq gnus-uu-user-view-rules
6030 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
6033 @item gnus-uu-user-view-rules-end
6034 @vindex gnus-uu-user-view-rules-end
6035 This variable is consulted if Gnus couldn't make any matches from the
6036 user and default view rules.
6038 @item gnus-uu-user-archive-rules
6039 @vindex gnus-uu-user-archive-rules
6040 This variable can be used to say what commands should be used to unpack
6045 @node Other Decode Variables
6046 @subsubsection Other Decode Variables
6049 @vindex gnus-uu-grabbed-file-functions
6051 @item gnus-uu-grabbed-file-functions
6052 All functions in this list will be called right after each file has been
6053 successfully decoded---so that you can move or view files right away,
6054 and don't have to wait for all files to be decoded before you can do
6055 anything. Ready-made functions you can put in this list are:
6059 @item gnus-uu-grab-view
6060 @findex gnus-uu-grab-view
6063 @item gnus-uu-grab-move
6064 @findex gnus-uu-grab-move
6065 Move the file (if you're using a saving function.)
6068 @item gnus-uu-be-dangerous
6069 @vindex gnus-uu-be-dangerous
6070 Specifies what to do if unusual situations arise during decoding. If
6071 @code{nil}, be as conservative as possible. If @code{t}, ignore things
6072 that didn't work, and overwrite existing files. Otherwise, ask each
6075 @item gnus-uu-ignore-files-by-name
6076 @vindex gnus-uu-ignore-files-by-name
6077 Files with name matching this regular expression won't be viewed.
6079 @item gnus-uu-ignore-files-by-type
6080 @vindex gnus-uu-ignore-files-by-type
6081 Files with a @sc{mime} type matching this variable won't be viewed.
6082 Note that Gnus tries to guess what type the file is based on the name.
6083 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
6086 @item gnus-uu-tmp-dir
6087 @vindex gnus-uu-tmp-dir
6088 Where @code{gnus-uu} does its work.
6090 @item gnus-uu-do-not-unpack-archives
6091 @vindex gnus-uu-do-not-unpack-archives
6092 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
6093 looking for files to display.
6095 @item gnus-uu-view-and-save
6096 @vindex gnus-uu-view-and-save
6097 Non-@code{nil} means that the user will always be asked to save a file
6100 @item gnus-uu-ignore-default-view-rules
6101 @vindex gnus-uu-ignore-default-view-rules
6102 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
6105 @item gnus-uu-ignore-default-archive-rules
6106 @vindex gnus-uu-ignore-default-archive-rules
6107 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
6110 @item gnus-uu-kill-carriage-return
6111 @vindex gnus-uu-kill-carriage-return
6112 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
6115 @item gnus-uu-unmark-articles-not-decoded
6116 @vindex gnus-uu-unmark-articles-not-decoded
6117 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
6118 decoded articles as unread.
6120 @item gnus-uu-correct-stripped-uucode
6121 @vindex gnus-uu-correct-stripped-uucode
6122 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
6123 uuencoded files that have had trailing spaces deleted.
6125 @item gnus-uu-pre-uudecode-hook
6126 @vindex gnus-uu-pre-uudecode-hook
6127 Hook run before sending a message to @code{uudecode}.
6129 @item gnus-uu-view-with-metamail
6130 @vindex gnus-uu-view-with-metamail
6132 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6133 commands defined by the rule variables and just fudge a @sc{mime}
6134 content type based on the file name. The result will be fed to
6135 @code{metamail} for viewing.
6137 @item gnus-uu-save-in-digest
6138 @vindex gnus-uu-save-in-digest
6139 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6140 decoding, will save in digests. If this variable is @code{nil},
6141 @code{gnus-uu} will just save everything in a file without any
6142 embellishments. The digesting almost conforms to RFC1153---no easy way
6143 to specify any meaningful volume and issue numbers were found, so I
6144 simply dropped them.
6149 @node Uuencoding and Posting
6150 @subsubsection Uuencoding and Posting
6154 @item gnus-uu-post-include-before-composing
6155 @vindex gnus-uu-post-include-before-composing
6156 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6157 before you compose the article. If this variable is @code{t}, you can
6158 either include an encoded file with @kbd{C-c C-i} or have one included
6159 for you when you post the article.
6161 @item gnus-uu-post-length
6162 @vindex gnus-uu-post-length
6163 Maximum length of an article. The encoded file will be split into how
6164 many articles it takes to post the entire file.
6166 @item gnus-uu-post-threaded
6167 @vindex gnus-uu-post-threaded
6168 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6169 thread. This may not be smart, as no other decoder I have seen is able
6170 to follow threads when collecting uuencoded articles. (Well, I have
6171 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6172 think that counts...) Default is @code{nil}.
6174 @item gnus-uu-post-separate-description
6175 @vindex gnus-uu-post-separate-description
6176 Non-@code{nil} means that the description will be posted in a separate
6177 article. The first article will typically be numbered (0/x). If this
6178 variable is @code{nil}, the description the user enters will be included
6179 at the beginning of the first article, which will be numbered (1/x).
6180 Default is @code{t}.
6186 @subsection Viewing Files
6187 @cindex viewing files
6188 @cindex pseudo-articles
6190 After decoding, if the file is some sort of archive, Gnus will attempt
6191 to unpack the archive and see if any of the files in the archive can be
6192 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
6193 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
6194 uncompress and de-tar the main file, and then view the two pictures.
6195 This unpacking process is recursive, so if the archive contains archives
6196 of archives, it'll all be unpacked.
6198 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
6199 extracted file into the summary buffer. If you go to these
6200 ``articles'', you will be prompted for a command to run (usually Gnus
6201 will make a suggestion), and then the command will be run.
6203 @vindex gnus-view-pseudo-asynchronously
6204 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6205 until the viewing is done before proceeding.
6207 @vindex gnus-view-pseudos
6208 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6209 the pseudo-articles into the summary buffer, but view them
6210 immediately. If this variable is @code{not-confirm}, the user won't even
6211 be asked for a confirmation before viewing is done.
6213 @vindex gnus-view-pseudos-separately
6214 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6215 pseudo-article will be created for each file to be viewed. If
6216 @code{nil}, all files that use the same viewing command will be given as
6217 a list of parameters to that command.
6219 @vindex gnus-insert-pseudo-articles
6220 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6221 pseudo-articles when decoding. It is @code{t} by default.
6223 So; there you are, reading your @emph{pseudo-articles} in your
6224 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6225 Why isn't anything real anymore? How did we get here?
6228 @node Article Treatment
6229 @section Article Treatment
6231 Reading through this huge manual, you may have quite forgotten that the
6232 object of newsreaders is to actually, like, read what people have
6233 written. Reading articles. Unfortunately, people are quite bad at
6234 writing, so there are tons of functions and variables to make reading
6235 these articles easier.
6238 * Article Highlighting:: You want to make the article look like fruit salad.
6239 * Article Fontisizing:: Making emphasized text look nice.
6240 * Article Hiding:: You also want to make certain info go away.
6241 * Article Washing:: Lots of way-neat functions to make life better.
6242 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
6243 * Article Date:: Grumble, UT!
6244 * Article Signature:: What is a signature?
6248 @node Article Highlighting
6249 @subsection Article Highlighting
6250 @cindex highlighting
6252 Not only do you want your article buffer to look like fruit salad, but
6253 you want it to look like technicolor fruit salad.
6258 @kindex W H a (Summary)
6259 @findex gnus-article-highlight
6260 @findex gnus-article-maybe-highlight
6261 Do much highlighting of the current article
6262 (@code{gnus-article-highlight}). This function highlights header, cited
6263 text, the signature, and adds buttons to the body and the head.
6266 @kindex W H h (Summary)
6267 @findex gnus-article-highlight-headers
6268 @vindex gnus-header-face-alist
6269 Highlight the headers (@code{gnus-article-highlight-headers}). The
6270 highlighting will be done according to the @code{gnus-header-face-alist}
6271 variable, which is a list where each element has the form @var{(regexp
6272 name content)}. @var{regexp} is a regular expression for matching the
6273 header, @var{name} is the face used for highlighting the header name
6274 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6275 the header value. The first match made will be used. Note that
6276 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6279 @kindex W H c (Summary)
6280 @findex gnus-article-highlight-citation
6281 Highlight cited text (@code{gnus-article-highlight-citation}).
6283 Some variables to customize the citation highlights:
6286 @vindex gnus-cite-parse-max-size
6288 @item gnus-cite-parse-max-size
6289 If the article size if bigger than this variable (which is 25000 by
6290 default), no citation highlighting will be performed.
6292 @item gnus-cite-prefix-regexp
6293 @vindex gnus-cite-prefix-regexp
6294 Regexp matching the longest possible citation prefix on a line.
6296 @item gnus-cite-max-prefix
6297 @vindex gnus-cite-max-prefix
6298 Maximum possible length for a citation prefix (default 20).
6300 @item gnus-cite-face-list
6301 @vindex gnus-cite-face-list
6302 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6303 When there are citations from multiple articles in the same message,
6304 Gnus will try to give each citation from each article its own face.
6305 This should make it easier to see who wrote what.
6307 @item gnus-supercite-regexp
6308 @vindex gnus-supercite-regexp
6309 Regexp matching normal Supercite attribution lines.
6311 @item gnus-supercite-secondary-regexp
6312 @vindex gnus-supercite-secondary-regexp
6313 Regexp matching mangled Supercite attribution lines.
6315 @item gnus-cite-minimum-match-count
6316 @vindex gnus-cite-minimum-match-count
6317 Minimum number of identical prefixes we have to see before we believe
6318 that it's a citation.
6320 @item gnus-cite-attribution-prefix
6321 @vindex gnus-cite-attribution-prefix
6322 Regexp matching the beginning of an attribution line.
6324 @item gnus-cite-attribution-suffix
6325 @vindex gnus-cite-attribution-suffix
6326 Regexp matching the end of an attribution line.
6328 @item gnus-cite-attribution-face
6329 @vindex gnus-cite-attribution-face
6330 Face used for attribution lines. It is merged with the face for the
6331 cited text belonging to the attribution.
6337 @kindex W H s (Summary)
6338 @vindex gnus-signature-separator
6339 @vindex gnus-signature-face
6340 @findex gnus-article-highlight-signature
6341 Highlight the signature (@code{gnus-article-highlight-signature}).
6342 Everything after @code{gnus-signature-separator} (@pxref{Article
6343 Signature}) in an article will be considered a signature and will be
6344 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6349 @xref{Customizing Articles}, for how to highlight articles automatically.
6352 @node Article Fontisizing
6353 @subsection Article Fontisizing
6355 @cindex article emphasis
6357 @findex gnus-article-emphasize
6358 @kindex W e (Summary)
6359 People commonly add emphasis to words in news articles by writing things
6360 like @samp{_this_} or @samp{*this*}. Gnus can make this look nicer by
6361 running the article through the @kbd{W e}
6362 (@code{gnus-article-emphasize}) command.
6364 @vindex gnus-emphasis-alist
6365 How the emphasis is computed is controlled by the
6366 @code{gnus-emphasis-alist} variable. This is an alist where the first
6367 element is a regular expression to be matched. The second is a number
6368 that says what regular expression grouping is used to find the entire
6369 emphasized word. The third is a number that says what regexp grouping
6370 should be displayed and highlighted. (The text between these two
6371 groupings will be hidden.) The fourth is the face used for
6375 (setq gnus-article-emphasis
6376 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6377 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6380 @vindex gnus-emphasis-underline
6381 @vindex gnus-emphasis-bold
6382 @vindex gnus-emphasis-italic
6383 @vindex gnus-emphasis-underline-bold
6384 @vindex gnus-emphasis-underline-italic
6385 @vindex gnus-emphasis-bold-italic
6386 @vindex gnus-emphasis-underline-bold-italic
6387 By default, there are seven rules, and they use the following faces:
6388 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6389 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6390 @code{gnus-emphasis-underline-italic},
6391 @code{gnus-emphasis-underline-bold}, and
6392 @code{gnus-emphasis-underline-bold-italic}.
6394 If you want to change these faces, you can either use @kbd{M-x
6395 customize}, or you can use @code{copy-face}. For instance, if you want
6396 to make @code{gnus-emphasis-italic} use a red face instead, you could
6400 (copy-face 'red 'gnus-emphasis-italic)
6403 @xref{Customizing Articles}, for how to fontize articles automatically.
6406 @node Article Hiding
6407 @subsection Article Hiding
6408 @cindex article hiding
6410 Or rather, hiding certain things in each article. There usually is much
6411 too much cruft in most articles.
6416 @kindex W W a (Summary)
6417 @findex gnus-article-hide
6418 Do quite a lot of hiding on the article buffer
6419 (@kbd{gnus-article-hide}). In particular, this function will hide
6420 headers, PGP, cited text and the signature.
6423 @kindex W W h (Summary)
6424 @findex gnus-article-hide-headers
6425 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
6429 @kindex W W b (Summary)
6430 @findex gnus-article-hide-boring-headers
6431 Hide headers that aren't particularly interesting
6432 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
6435 @kindex W W s (Summary)
6436 @findex gnus-article-hide-signature
6437 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
6441 @kindex W W p (Summary)
6442 @findex gnus-article-hide-pgp
6443 @vindex gnus-article-hide-pgp-hook
6444 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). The
6445 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6446 signature has been hidden. For example, to automatically verify
6447 articles that have signatures in them do:
6449 ;;; Hide pgp cruft if any.
6451 (setq gnus-treat-strip-pgp t)
6453 ;;; After hiding pgp, verify the message;
6454 ;;; only happens if pgp signature is found.
6456 (add-hook 'gnus-article-hide-pgp-hook
6459 (set-buffer gnus-original-article-buffer)
6464 @kindex W W P (Summary)
6465 @findex gnus-article-hide-pem
6466 Hide @sc{pem} (privacy enhanced messages) cruft
6467 (@code{gnus-article-hide-pem}).
6470 @kindex W W B (Summary)
6471 @findex gnus-article-strip-banner
6472 Strip the banner specified by the @code{banner} group parameter
6473 (@code{gnus-article-strip-banner}). This is mainly used to hide those
6474 annoying banners and/or signatures that some mailing lists and moderated
6475 groups adds to all the messages. The way to use this function is to add
6476 the @code{banner} group parameter (@pxref{Group Parameters}) to the
6477 group you want banners stripped from. The parameter either be a string,
6478 which will be interpreted as a regulax expression matching text to be
6479 removed, or the symbol @code{signature}, meaning that the (last)
6480 signature should be removed.
6483 @kindex W W c (Summary)
6484 @findex gnus-article-hide-citation
6485 Hide citation (@code{gnus-article-hide-citation}). Some variables for
6486 customizing the hiding:
6490 @item gnus-cited-opened-text-button-line-format
6491 @itemx gnus-cited-closed-text-button-line-format
6492 @vindex gnus-cited-closed-text-button-line-format
6493 @vindex gnus-cited-opened-text-button-line-format
6494 Gnus adds buttons to show where the cited text has been hidden, and to
6495 allow toggle hiding the text. The format of the variable is specified
6496 by these format-like variable (@pxref{Formatting Variables}). These
6501 Starting point of the hidden text.
6503 Ending point of the hidden text.
6505 Number of characters in the hidden region.
6507 Number of lines of hidden text.
6510 @item gnus-cited-lines-visible
6511 @vindex gnus-cited-lines-visible
6512 The number of lines at the beginning of the cited text to leave shown.
6517 @kindex W W C-c (Summary)
6518 @findex gnus-article-hide-citation-maybe
6520 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
6521 following two variables:
6524 @item gnus-cite-hide-percentage
6525 @vindex gnus-cite-hide-percentage
6526 If the cited text is of a bigger percentage than this variable (default
6527 50), hide the cited text.
6529 @item gnus-cite-hide-absolute
6530 @vindex gnus-cite-hide-absolute
6531 The cited text must have at least this length (default 10) before it
6536 @kindex W W C (Summary)
6537 @findex gnus-article-hide-citation-in-followups
6538 Hide cited text in articles that aren't roots
6539 (@code{gnus-article-hide-citation-in-followups}). This isn't very
6540 useful as an interactive command, but might be a handy function to stick
6541 have happen automatically (@pxref{Customizing Articles}).
6545 All these ``hiding'' commands are toggles, but if you give a negative
6546 prefix to these commands, they will show what they have previously
6547 hidden. If you give a positive prefix, they will always hide.
6549 Also @pxref{Article Highlighting} for further variables for
6550 citation customization.
6552 @xref{Customizing Articles}, for how to hide article elements
6556 @node Article Washing
6557 @subsection Article Washing
6559 @cindex article washing
6561 We call this ``article washing'' for a really good reason. Namely, the
6562 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6564 @dfn{Washing} is defined by us as ``changing something from something to
6565 something else'', but normally results in something looking better.
6571 @kindex W l (Summary)
6572 @findex gnus-summary-stop-page-breaking
6573 Remove page breaks from the current article
6574 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
6578 @kindex W r (Summary)
6579 @findex gnus-summary-caesar-message
6580 @c @icon{gnus-summary-caesar-message}
6581 Do a Caesar rotate (rot13) on the article buffer
6582 (@code{gnus-summary-caesar-message}).
6583 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6584 (Typically offensive jokes and such.)
6586 It's commonly called ``rot13'' because each letter is rotated 13
6587 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6588 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
6589 is rumored to have employed this form of, uh, somewhat weak encryption.
6592 @kindex W t (Summary)
6593 @findex gnus-summary-toggle-header
6594 Toggle whether to display all headers in the article buffer
6595 (@code{gnus-summary-toggle-header}).
6598 @kindex W v (Summary)
6599 @findex gnus-summary-verbose-header
6600 Toggle whether to display all headers in the article buffer permanently
6601 (@code{gnus-summary-verbose-header}).
6604 @kindex W o (Summary)
6605 @findex gnus-article-treat-overstrike
6606 Treat overstrike (@code{gnus-article-treat-overstrike}).
6609 @kindex W d (Summary)
6610 @findex gnus-article-treat-dumbquotes
6611 @vindex gnus-article-dumbquotes-map
6613 @cindex M******** sm*rtq**t*s
6615 Treat M******** sm*rtq**t*s according to
6616 @code{gnus-article-dumbquotes-map}
6617 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
6618 whether a character is a sm*rtq**t* or not, so it should only be used
6622 @kindex W w (Summary)
6623 @findex gnus-article-fill-cited-article
6624 Do word wrap (@code{gnus-article-fill-cited-article}).
6626 You can give the command a numerical prefix to specify the width to use
6630 @kindex W q (Summary)
6631 @findex gnus-article-fill-long-lines
6632 Fill long lines (@code{gnus-article-fill-long-lines}).
6635 @kindex W C (Summary)
6636 @findex gnus-article-capitalize-sentencse
6637 Capitalize the first word in each sentence
6638 (@code{gnus-article-capitalize-sentences}).
6641 @kindex W c (Summary)
6642 @findex gnus-article-remove-cr
6643 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
6644 (this takes care of DOS line endings), and then translate any remaining
6645 CRs into LF (this takes care of Mac line endings)
6646 (@code{gnus-article-remove-cr}).
6649 @kindex W q (Summary)
6650 @findex gnus-article-de-quoted-unreadable
6651 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
6652 Quoted-Printable is one common @sc{mime} encoding employed when sending
6653 non-ASCII (i. e., 8-bit) articles. It typically makes strings like
6654 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
6655 readable to me. Note that the this is usually done automatically by
6656 Gnus if the message in question has a @code{Content-Transfer-Encoding}
6657 header that says that this encoding has been done.
6660 @kindex W f (Summary)
6662 @findex gnus-article-display-x-face
6663 @findex gnus-article-x-face-command
6664 @vindex gnus-article-x-face-command
6665 @vindex gnus-article-x-face-too-ugly
6671 Look for and display any X-Face headers
6672 (@code{gnus-article-display-x-face}). The command executed by this
6673 function is given by the @code{gnus-article-x-face-command} variable.
6674 If this variable is a string, this string will be executed in a
6675 sub-shell. If it is a function, this function will be called with the
6676 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
6677 is a regexp) matches the @code{From} header, the face will not be shown.
6678 The default action under Emacs is to fork off an @code{xv} to view the
6679 face; under XEmacs the default action is to display the face before the
6680 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
6681 support---that will make display somewhat faster. If there's no native
6682 X-Face support, Gnus will try to convert the @code{X-Face} header using
6683 external programs from the @code{pbmplus} package and friends.) If you
6684 want to have this function in the display hook, it should probably come
6688 @kindex W b (Summary)
6689 @findex gnus-article-add-buttons
6690 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6691 @xref{Article Buttons}.
6694 @kindex W B (Summary)
6695 @findex gnus-article-add-buttons-to-head
6696 Add clickable buttons to the article headers
6697 (@code{gnus-article-add-buttons-to-head}).
6700 @kindex W E l (Summary)
6701 @findex gnus-article-strip-leading-blank-lines
6702 Remove all blank lines from the beginning of the article
6703 (@code{gnus-article-strip-leading-blank-lines}).
6706 @kindex W E m (Summary)
6707 @findex gnus-article-strip-multiple-blank-lines
6708 Replace all blank lines with empty lines and then all multiple empty
6709 lines with a single empty line.
6710 (@code{gnus-article-strip-multiple-blank-lines}).
6713 @kindex W E t (Summary)
6714 @findex gnus-article-remove-trailing-blank-lines
6715 Remove all blank lines at the end of the article
6716 (@code{gnus-article-remove-trailing-blank-lines}).
6719 @kindex W E a (Summary)
6720 @findex gnus-article-strip-blank-lines
6721 Do all the three commands above
6722 (@code{gnus-article-strip-blank-lines}).
6725 @kindex W E A (Summary)
6726 @findex gnus-article-strip-all-blank-lines
6727 Remove all blank lines
6728 (@code{gnus-article-strip-all-blank-lines}).
6731 @kindex W E s (Summary)
6732 @findex gnus-article-strip-leading-space
6733 Remove all white space from the beginning of all lines of the article
6734 body (@code{gnus-article-strip-leading-space}).
6737 @kindex W E e (Summary)
6738 @findex gnus-article-strip-trailing-space
6739 Remove all white space from the end of all lines of the article
6740 body (@code{gnus-article-strip-trailing-space}).
6744 @xref{Customizing Articles}, for how to wash articles automatically.
6747 @node Article Buttons
6748 @subsection Article Buttons
6751 People often include references to other stuff in articles, and it would
6752 be nice if Gnus could just fetch whatever it is that people talk about
6753 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6754 button on these references.
6756 Gnus adds @dfn{buttons} to certain standard references by default:
6757 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
6758 two variables, one that handles article bodies and one that handles
6763 @item gnus-button-alist
6764 @vindex gnus-button-alist
6765 This is an alist where each entry has this form:
6768 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6774 All text that match this regular expression will be considered an
6775 external reference. Here's a typical regexp that matches embedded URLs:
6776 @samp{<URL:\\([^\n\r>]*\\)>}.
6779 Gnus has to know which parts of the matches is to be highlighted. This
6780 is a number that says what sub-expression of the regexp is to be
6781 highlighted. If you want it all highlighted, you use 0 here.
6784 This form will be @code{eval}ed, and if the result is non-@code{nil},
6785 this is considered a match. This is useful if you want extra sifting to
6786 avoid false matches.
6789 This function will be called when you click on this button.
6792 As with @var{button-par}, this is a sub-expression number, but this one
6793 says which part of the match is to be sent as data to @var{function}.
6797 So the full entry for buttonizing URLs is then
6800 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6803 @item gnus-header-button-alist
6804 @vindex gnus-header-button-alist
6805 This is just like the other alist, except that it is applied to the
6806 article head only, and that each entry has an additional element that is
6807 used to say what headers to apply the buttonize coding to:
6810 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6813 @var{HEADER} is a regular expression.
6815 @item gnus-button-url-regexp
6816 @vindex gnus-button-url-regexp
6817 A regular expression that matches embedded URLs. It is used in the
6818 default values of the variables above.
6820 @item gnus-article-button-face
6821 @vindex gnus-article-button-face
6822 Face used on buttons.
6824 @item gnus-article-mouse-face
6825 @vindex gnus-article-mouse-face
6826 Face used when the mouse cursor is over a button.
6830 @xref{Customizing Articles}, for how to buttonize articles automatically.
6834 @subsection Article Date
6836 The date is most likely generated in some obscure timezone you've never
6837 heard of, so it's quite nice to be able to find out what the time was
6838 when the article was sent.
6843 @kindex W T u (Summary)
6844 @findex gnus-article-date-ut
6845 Display the date in UT (aka. GMT, aka ZULU)
6846 (@code{gnus-article-date-ut}).
6849 @kindex W T i (Summary)
6850 @findex gnus-article-date-iso8601
6852 Display the date in international format, aka. ISO 8601
6853 (@code{gnus-article-date-iso8601}).
6856 @kindex W T l (Summary)
6857 @findex gnus-article-date-local
6858 Display the date in the local timezone (@code{gnus-article-date-local}).
6861 @kindex W T s (Summary)
6862 @vindex gnus-article-time-format
6863 @findex gnus-article-date-user
6864 @findex format-time-string
6865 Display the date using a user-defined format
6866 (@code{gnus-article-date-user}). The format is specified by the
6867 @code{gnus-article-time-format} variable, and is a string that's passed
6868 to @code{format-time-string}. See the documentation of that variable
6869 for a list of possible format specs.
6872 @kindex W T e (Summary)
6873 @findex gnus-article-date-lapsed
6874 @findex gnus-start-date-timer
6875 @findex gnus-stop-date-timer
6876 Say how much time has elapsed between the article was posted and now
6877 (@code{gnus-article-date-lapsed}). It looks something like:
6880 X-Sent: 29 years, 6 weeks, 4 days, 10 hours, 3 minutes, 28 seconds ago
6883 An advantage of using Gnus to read mail is that it converts simple bugs
6884 into wonderful absurdities.
6886 If you want to have this line updated continually, you can put
6889 (gnus-start-date-timer)
6892 in your @file{.gnus.el} file, or you can run it off of some hook. If
6893 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
6897 @kindex W T o (Summary)
6898 @findex gnus-article-date-original
6899 Display the original date (@code{gnus-article-date-original}). This can
6900 be useful if you normally use some other conversion function and are
6901 worried that it might be doing something totally wrong. Say, claiming
6902 that the article was posted in 1854. Although something like that is
6903 @emph{totally} impossible. Don't you trust me? *titter*
6907 @xref{Customizing Articles}, for how to display the date in your
6908 preferred format automatically.
6911 @node Article Signature
6912 @subsection Article Signature
6914 @cindex article signature
6916 @vindex gnus-signature-separator
6917 Each article is divided into two parts---the head and the body. The
6918 body can be divided into a signature part and a text part. The variable
6919 that says what is to be considered a signature is
6920 @code{gnus-signature-separator}. This is normally the standard
6921 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
6922 non-standard signature separators, so this variable can also be a list
6923 of regular expressions to be tested, one by one. (Searches are done
6924 from the end of the body towards the beginning.) One likely value is:
6927 (setq gnus-signature-separator
6928 '("^-- $" ; The standard
6929 "^-- *$" ; A common mangling
6930 "^-------*$" ; Many people just use a looong
6931 ; line of dashes. Shame!
6932 "^ *--------*$" ; Double-shame!
6933 "^________*$" ; Underscores are also popular
6934 "^========*$")) ; Pervert!
6937 The more permissive you are, the more likely it is that you'll get false
6940 @vindex gnus-signature-limit
6941 @code{gnus-signature-limit} provides a limit to what is considered a
6946 If it is an integer, no signature may be longer (in characters) than
6949 If it is a floating point number, no signature may be longer (in lines)
6952 If it is a function, the function will be called without any parameters,
6953 and if it returns @code{nil}, there is no signature in the buffer.
6955 If it is a string, it will be used as a regexp. If it matches, the text
6956 in question is not a signature.
6959 This variable can also be a list where the elements may be of the types
6960 listed above. Here's an example:
6963 (setq gnus-signature-limit
6964 '(200.0 "^---*Forwarded article"))
6967 This means that if there are more than 200 lines after the signature
6968 separator, or the text after the signature separator is matched by
6969 the regular expression @samp{^---*Forwarded article}, then it isn't a
6970 signature after all.
6974 @section MIME Commands
6975 @cindex MIME decoding
6979 @kindex M-t (Summary)
6980 @findex gnus-summary-display-buttonized
6981 Toggle the buttonized display of the article buffer
6982 (@code{gnus-summary-toggle-display-buttonized}).
6985 @kindex W M w (Summary)
6986 Decode RFC2047-encoded words in the article headers
6987 (@code{gnus-article-decode-mime-words}).
6990 @kindex W M c (Summary)
6991 Decode encoded article bodies as well as charsets
6992 (@code{gnus-article-decode-charset}).
6994 This command looks in the @code{Content-Type} header to determine the
6995 charset. If there is no such header in the article, you can give it a
6996 prefix, which will prompt for the charset to decode as. In regional
6997 groups where people post using some common encoding (but do not include
6998 MIME headers), you can set the @code{charset} group/topic parameter to
6999 the required charset (@pxref{Group Parameters}).
7002 @kindex W M v (Summary)
7003 View all the @sc{mime} parts in the current article
7004 (@code{gnus-mime-view-all-parts}).
7011 @item gnus-ignored-mime-types
7012 @vindex gnus-ignored-mime-types
7013 This is a list of regexps. @sc{mime} types that match a regexp from
7014 this list will be completely ignored by Gnus. The default value is
7017 To have all Vcards be ignored, you'd say something like this:
7020 (setq gnus-ignored-mime-types
7024 @item gnus-unbuttonized-mime-types
7025 @vindex gnus-unbuttonized-mime-types
7026 This is a list of regexps. @sc{mime} types that match a regexp from
7027 this list won't have @sc{mime} buttons inserted unless they aren't
7028 displayed. The default value is @code{(".*/.*")}.
7030 @item gnus-article-mime-part-function
7031 @vindex gnus-article-mime-part-function
7032 For each @sc{mime} part, this function will be called with the @sc{mime}
7033 handle as the parameter. The function is meant to be used to allow
7034 users to gather information from the article (e. g., add Vcard info to
7035 the bbdb database) or to do actions based on parts (e. g., automatically
7036 save all jpegs into some directory).
7038 Here's an example function the does the latter:
7041 (defun my-save-all-jpeg-parts (handle)
7042 (when (equal (car (mm-handle-type handle)) "image/jpeg")
7044 (insert (mm-get-part handle))
7045 (write-region (point-min) (point-max)
7046 (read-file-name "Save jpeg to: ")))))
7047 (setq gnus-article-mime-part-function
7048 'my-save-all-jpeg-parts)
7058 People use different charsets, and we have @sc{mime} to let us know what
7059 charsets they use. Or rather, we wish we had. Many people use
7060 newsreaders and mailers that do not understand or use @sc{mime}, and
7061 just send out messages without saying what character sets they use. To
7062 help a bit with this, some local news hierarchies have policies that say
7063 what character set is the default. For instance, the @samp{fj}
7064 hierarchy uses @code{iso-2022-jp-2}.
7066 @vindex gnus-group-charset-alist
7067 This knowledge is encoded in the @code{gnus-group-charset-alist}
7068 variable, which is an alist of regexps (to match group names) and
7069 default charsets to be used when reading these groups.
7071 In addition, some people do use soi-disant @sc{mime}-aware agents that
7072 aren't. These blitely mark messages as being in @code{iso-8859-1} even
7073 if they really are in @code{koi-8}. To help here, the
7074 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
7075 charsets that are listed here will be ignored. The variable can be set
7076 on a group-by-group basis using the group parameters (@pxref{Group
7077 Parameters}). The default value is @code{(unknown-8bit)}, which is
7078 something some agents insist on having in there.
7081 @node Article Commands
7082 @section Article Commands
7089 @kindex A P (Summary)
7090 @vindex gnus-ps-print-hook
7091 @findex gnus-summary-print-article
7092 Generate and print a PostScript image of the article buffer
7093 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
7094 run just before printing the buffer.
7099 @node Summary Sorting
7100 @section Summary Sorting
7101 @cindex summary sorting
7103 You can have the summary buffer sorted in various ways, even though I
7104 can't really see why you'd want that.
7109 @kindex C-c C-s C-n (Summary)
7110 @findex gnus-summary-sort-by-number
7111 Sort by article number (@code{gnus-summary-sort-by-number}).
7114 @kindex C-c C-s C-a (Summary)
7115 @findex gnus-summary-sort-by-author
7116 Sort by author (@code{gnus-summary-sort-by-author}).
7119 @kindex C-c C-s C-s (Summary)
7120 @findex gnus-summary-sort-by-subject
7121 Sort by subject (@code{gnus-summary-sort-by-subject}).
7124 @kindex C-c C-s C-d (Summary)
7125 @findex gnus-summary-sort-by-date
7126 Sort by date (@code{gnus-summary-sort-by-date}).
7129 @kindex C-c C-s C-l (Summary)
7130 @findex gnus-summary-sort-by-lines
7131 Sort by lines (@code{gnus-summary-sort-by-lines}).
7134 @kindex C-c C-s C-c (Summary)
7135 @findex gnus-summary-sort-by-chars
7136 Sort by article length (@code{gnus-summary-sort-by-chars}).
7139 @kindex C-c C-s C-i (Summary)
7140 @findex gnus-summary-sort-by-score
7141 Sort by score (@code{gnus-summary-sort-by-score}).
7144 These functions will work both when you use threading and when you don't
7145 use threading. In the latter case, all summary lines will be sorted,
7146 line by line. In the former case, sorting will be done on a
7147 root-by-root basis, which might not be what you were looking for. To
7148 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
7152 @node Finding the Parent
7153 @section Finding the Parent
7154 @cindex parent articles
7155 @cindex referring articles
7160 @findex gnus-summary-refer-parent-article
7161 If you'd like to read the parent of the current article, and it is not
7162 displayed in the summary buffer, you might still be able to. That is,
7163 if the current group is fetched by @sc{nntp}, the parent hasn't expired
7164 and the @code{References} in the current article are not mangled, you
7165 can just press @kbd{^} or @kbd{A r}
7166 (@code{gnus-summary-refer-parent-article}). If everything goes well,
7167 you'll get the parent. If the parent is already displayed in the
7168 summary buffer, point will just move to this article.
7170 If given a positive numerical prefix, fetch that many articles back into
7171 the ancestry. If given a negative numerical prefix, fetch just that
7172 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
7173 grandparent and the grandgrandparent of the current article. If you say
7174 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
7178 @findex gnus-summary-refer-references
7179 @kindex A R (Summary)
7180 Fetch all articles mentioned in the @code{References} header of the
7181 article (@code{gnus-summary-refer-references}).
7184 @findex gnus-summary-refer-thread
7185 @kindex A T (Summary)
7186 Display the full thread where the current article appears
7187 (@code{gnus-summary-refer-thread}). This command has to fetch all the
7188 headers in the current group to work, so it usually takes a while. If
7189 you do it often, you may consider setting @code{gnus-fetch-old-headers}
7190 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
7191 visible effects normally, but it'll make this command work a whole lot
7192 faster. Of course, it'll make group entry somewhat slow.
7194 @vindex gnus-refer-thread-limit
7195 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
7196 articles before the first displayed in the current group) headers to
7197 fetch when doing this command. The default is 200. If @code{t}, all
7198 the available headers will be fetched. This variable can be overridden
7199 by giving the @kbd{A T} command a numerical prefix.
7202 @findex gnus-summary-refer-article
7203 @kindex M-^ (Summary)
7205 @cindex fetching by Message-ID
7206 You can also ask the @sc{nntp} server for an arbitrary article, no
7207 matter what group it belongs to. @kbd{M-^}
7208 (@code{gnus-summary-refer-article}) will ask you for a
7209 @code{Message-ID}, which is one of those long, hard-to-read thingies
7210 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
7211 have to get it all exactly right. No fuzzy searches, I'm afraid.
7214 The current select method will be used when fetching by
7215 @code{Message-ID} from non-news select method, but you can override this
7216 by giving this command a prefix.
7218 @vindex gnus-refer-article-method
7219 If the group you are reading is located on a backend that does not
7220 support fetching by @code{Message-ID} very well (like @code{nnspool}),
7221 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
7222 would, perhaps, be best if the @sc{nntp} server you consult is the one
7223 updating the spool you are reading from, but that's not really
7226 Most of the mail backends support fetching by @code{Message-ID}, but do
7227 not do a particularly excellent job at it. That is, @code{nnmbox} and
7228 @code{nnbabyl} are able to locate articles from any groups, while
7229 @code{nnml} and @code{nnfolder} are only able to locate articles that
7230 have been posted to the current group. (Anything else would be too time
7231 consuming.) @code{nnmh} does not support this at all.
7234 @node Alternative Approaches
7235 @section Alternative Approaches
7237 Different people like to read news using different methods. This being
7238 Gnus, we offer a small selection of minor modes for the summary buffers.
7241 * Pick and Read:: First mark articles and then read them.
7242 * Binary Groups:: Auto-decode all articles.
7247 @subsection Pick and Read
7248 @cindex pick and read
7250 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
7251 a two-phased reading interface. The user first marks in a summary
7252 buffer the articles she wants to read. Then she starts reading the
7253 articles with just an article buffer displayed.
7255 @findex gnus-pick-mode
7256 @kindex M-x gnus-pick-mode
7257 Gnus provides a summary buffer minor mode that allows
7258 this---@code{gnus-pick-mode}. This basically means that a few process
7259 mark commands become one-keystroke commands to allow easy marking, and
7260 it provides one additional command for switching to the summary buffer.
7262 Here are the available keystrokes when using pick mode:
7267 @findex gnus-pick-article-or-thread
7268 Pick the article or thread on the current line
7269 (@code{gnus-pick-article-or-thread}). If the variable
7270 @code{gnus-thread-hide-subtree} is true, then this key selects the
7271 entire thread when used at the first article of the thread. Otherwise,
7272 it selects just the article. If given a numerical prefix, go to that
7273 thread or article and pick it. (The line number is normally displayed
7274 at the beginning of the summary pick lines.)
7277 @kindex SPACE (Pick)
7278 @findex gnus-pick-next-page
7279 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
7280 at the end of the buffer, start reading the picked articles.
7284 @findex gnus-pick-unmark-article-or-thread.
7285 Unpick the thread or article
7286 (@code{gnus-pick-unmark-article-or-thread}). If the variable
7287 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
7288 thread if used at the first article of the thread. Otherwise it unpicks
7289 just the article. You can give this key a numerical prefix to unpick
7290 the thread or article at that line.
7294 @findex gnus-pick-start-reading
7295 @vindex gnus-pick-display-summary
7296 Start reading the picked articles (@code{gnus-pick-start-reading}). If
7297 given a prefix, mark all unpicked articles as read first. If
7298 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
7299 will still be visible when you are reading.
7303 All the normal summary mode commands are still available in the
7304 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
7305 which is mapped to the same function
7306 @code{gnus-summary-tick-article-forward}.
7308 If this sounds like a good idea to you, you could say:
7311 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
7314 @vindex gnus-pick-mode-hook
7315 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
7317 @vindex gnus-mark-unpicked-articles-as-read
7318 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
7319 all unpicked articles as read. The default is @code{nil}.
7321 @vindex gnus-summary-pick-line-format
7322 The summary line format in pick mode is slightly different from the
7323 standard format. At the beginning of each line the line number is
7324 displayed. The pick mode line format is controlled by the
7325 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
7326 Variables}). It accepts the same format specs that
7327 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
7331 @subsection Binary Groups
7332 @cindex binary groups
7334 @findex gnus-binary-mode
7335 @kindex M-x gnus-binary-mode
7336 If you spend much time in binary groups, you may grow tired of hitting
7337 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
7338 is a minor mode for summary buffers that makes all ordinary Gnus article
7339 selection functions uudecode series of articles and display the result
7340 instead of just displaying the articles the normal way.
7343 @findex gnus-binary-show-article
7344 The only way, in fact, to see the actual articles is the @kbd{g}
7345 command, when you have turned on this mode
7346 (@code{gnus-binary-show-article}).
7348 @vindex gnus-binary-mode-hook
7349 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
7353 @section Tree Display
7356 @vindex gnus-use-trees
7357 If you don't like the normal Gnus summary display, you might try setting
7358 @code{gnus-use-trees} to @code{t}. This will create (by default) an
7359 additional @dfn{tree buffer}. You can execute all summary mode commands
7362 There are a few variables to customize the tree display, of course:
7365 @item gnus-tree-mode-hook
7366 @vindex gnus-tree-mode-hook
7367 A hook called in all tree mode buffers.
7369 @item gnus-tree-mode-line-format
7370 @vindex gnus-tree-mode-line-format
7371 A format string for the mode bar in the tree mode buffers (@pxref{Mode
7372 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
7373 of valid specs, @pxref{Summary Buffer Mode Line}.
7375 @item gnus-selected-tree-face
7376 @vindex gnus-selected-tree-face
7377 Face used for highlighting the selected article in the tree buffer. The
7378 default is @code{modeline}.
7380 @item gnus-tree-line-format
7381 @vindex gnus-tree-line-format
7382 A format string for the tree nodes. The name is a bit of a misnomer,
7383 though---it doesn't define a line, but just the node. The default value
7384 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
7385 the name of the poster. It is vital that all nodes are of the same
7386 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
7392 The name of the poster.
7394 The @code{From} header.
7396 The number of the article.
7398 The opening bracket.
7400 The closing bracket.
7405 @xref{Formatting Variables}.
7407 Variables related to the display are:
7410 @item gnus-tree-brackets
7411 @vindex gnus-tree-brackets
7412 This is used for differentiating between ``real'' articles and
7413 ``sparse'' articles. The format is @var{((real-open . real-close)
7414 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
7415 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7417 @item gnus-tree-parent-child-edges
7418 @vindex gnus-tree-parent-child-edges
7419 This is a list that contains the characters used for connecting parent
7420 nodes to their children. The default is @code{(?- ?\\ ?|)}.
7424 @item gnus-tree-minimize-window
7425 @vindex gnus-tree-minimize-window
7426 If this variable is non-@code{nil}, Gnus will try to keep the tree
7427 buffer as small as possible to allow more room for the other Gnus
7428 windows. If this variable is a number, the tree buffer will never be
7429 higher than that number. The default is @code{t}. Note that if you
7430 have several windows displayed side-by-side in a frame and the tree
7431 buffer is one of these, minimizing the tree window will also resize all
7432 other windows displayed next to it.
7434 @item gnus-generate-tree-function
7435 @vindex gnus-generate-tree-function
7436 @findex gnus-generate-horizontal-tree
7437 @findex gnus-generate-vertical-tree
7438 The function that actually generates the thread tree. Two predefined
7439 functions are available: @code{gnus-generate-horizontal-tree} and
7440 @code{gnus-generate-vertical-tree} (which is the default).
7444 Here's an example from a horizontal tree buffer:
7447 @{***@}-(***)-[odd]-[Gun]
7457 Here's the same thread displayed in a vertical tree buffer:
7461 |--------------------------\-----\-----\
7462 (***) [Bjo] [Gun] [Gun]
7464 [odd] [Jan] [odd] (***) [Jor]
7466 [Gun] [Eri] [Eri] [odd]
7471 If you're using horizontal trees, it might be nice to display the trees
7472 side-by-side with the summary buffer. You could add something like the
7473 following to your @file{.gnus.el} file:
7476 (setq gnus-use-trees t
7477 gnus-generate-tree-function 'gnus-generate-horizontal-tree
7478 gnus-tree-minimize-window nil)
7479 (gnus-add-configuration
7483 (summary 0.75 point)
7488 @xref{Windows Configuration}.
7491 @node Mail Group Commands
7492 @section Mail Group Commands
7493 @cindex mail group commands
7495 Some commands only make sense in mail groups. If these commands are
7496 invalid in the current group, they will raise a hell and let you know.
7498 All these commands (except the expiry and edit commands) use the
7499 process/prefix convention (@pxref{Process/Prefix}).
7504 @kindex B e (Summary)
7505 @findex gnus-summary-expire-articles
7506 Expire all expirable articles in the group
7507 (@code{gnus-summary-expire-articles}).
7510 @kindex B M-C-e (Summary)
7511 @findex gnus-summary-expire-articles-now
7512 Delete all the expirable articles in the group
7513 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
7514 articles eligible for expiry in the current group will
7515 disappear forever into that big @file{/dev/null} in the sky.
7518 @kindex B DEL (Summary)
7519 @findex gnus-summary-delete-article
7520 @c @icon{gnus-summary-mail-delete}
7521 Delete the mail article. This is ``delete'' as in ``delete it from your
7522 disk forever and ever, never to return again.'' Use with caution.
7523 (@code{gnus-summary-delete-article}).
7526 @kindex B m (Summary)
7528 @findex gnus-summary-move-article
7529 Move the article from one mail group to another
7530 (@code{gnus-summary-move-article}).
7533 @kindex B c (Summary)
7535 @findex gnus-summary-copy-article
7536 @c @icon{gnus-summary-mail-copy}
7537 Copy the article from one group (mail group or not) to a mail group
7538 (@code{gnus-summary-copy-article}).
7541 @kindex B B (Summary)
7542 @cindex crosspost mail
7543 @findex gnus-summary-crosspost-article
7544 Crosspost the current article to some other group
7545 (@code{gnus-summary-crosspost-article}). This will create a new copy of
7546 the article in the other group, and the Xref headers of the article will
7547 be properly updated.
7550 @kindex B i (Summary)
7551 @findex gnus-summary-import-article
7552 Import an arbitrary file into the current mail newsgroup
7553 (@code{gnus-summary-import-article}). You will be prompted for a file
7554 name, a @code{From} header and a @code{Subject} header.
7557 @kindex B r (Summary)
7558 @findex gnus-summary-respool-article
7559 Respool the mail article (@code{gnus-summary-respool-article}).
7560 @code{gnus-summary-respool-default-method} will be used as the default
7561 select method when respooling. This variable is @code{nil} by default,
7562 which means that the current group select method will be used instead.
7566 @kindex B w (Summary)
7568 @findex gnus-summary-edit-article
7569 @kindex C-c C-c (Article)
7570 Edit the current article (@code{gnus-summary-edit-article}). To finish
7571 editing and make the changes permanent, type @kbd{C-c C-c}
7572 (@kbd{gnus-summary-edit-article-done}). If you give a prefix to the
7573 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
7576 @kindex B q (Summary)
7577 @findex gnus-summary-respool-query
7578 If you want to re-spool an article, you might be curious as to what group
7579 the article will end up in before you do the re-spooling. This command
7580 will tell you (@code{gnus-summary-respool-query}).
7583 @kindex B t (Summary)
7584 @findex gnus-summary-respool-trace
7585 Similarly, this command will display all fancy splitting patterns used
7586 when repooling, if any (@code{gnus-summary-respool-trace}).
7589 @kindex B p (Summary)
7590 @findex gnus-summary-article-posted-p
7591 Some people have a tendency to send you "courtesy" copies when they
7592 follow up to articles you have posted. These usually have a
7593 @code{Newsgroups} header in them, but not always. This command
7594 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7595 article from your news server (or rather, from
7596 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7597 report back whether it found the article or not. Even if it says that
7598 it didn't find the article, it may have been posted anyway---mail
7599 propagation is much faster than news propagation, and the news copy may
7600 just not have arrived yet.
7604 @vindex gnus-move-split-methods
7605 @cindex moving articles
7606 If you move (or copy) articles regularly, you might wish to have Gnus
7607 suggest where to put the articles. @code{gnus-move-split-methods} is a
7608 variable that uses the same syntax as @code{gnus-split-methods}
7609 (@pxref{Saving Articles}). You may customize that variable to create
7610 suggestions you find reasonable.
7613 (setq gnus-move-split-methods
7614 '(("^From:.*Lars Magne" "nnml:junk")
7615 ("^Subject:.*gnus" "nnfolder:important")
7616 (".*" "nnml:misc")))
7620 @node Various Summary Stuff
7621 @section Various Summary Stuff
7624 * Summary Group Information:: Information oriented commands.
7625 * Searching for Articles:: Multiple article commands.
7626 * Summary Generation Commands:: (Re)generating the summary buffer.
7627 * Really Various Summary Commands:: Those pesky non-conformant commands.
7631 @vindex gnus-summary-mode-hook
7632 @item gnus-summary-mode-hook
7633 This hook is called when creating a summary mode buffer.
7635 @vindex gnus-summary-generate-hook
7636 @item gnus-summary-generate-hook
7637 This is called as the last thing before doing the threading and the
7638 generation of the summary buffer. It's quite convenient for customizing
7639 the threading variables based on what data the newsgroup has. This hook
7640 is called from the summary buffer after most summary buffer variables
7643 @vindex gnus-summary-prepare-hook
7644 @item gnus-summary-prepare-hook
7645 It is called after the summary buffer has been generated. You might use
7646 it to, for instance, highlight lines or modify the look of the buffer in
7647 some other ungodly manner. I don't care.
7649 @vindex gnus-summary-prepared-hook
7650 @item gnus-summary-prepared-hook
7651 A hook called as the very last thing after the summary buffer has been
7654 @vindex gnus-summary-ignore-duplicates
7655 @item gnus-summary-ignore-duplicates
7656 When Gnus discovers two articles that have the same @code{Message-ID},
7657 it has to do something drastic. No articles are allowed to have the
7658 same @code{Message-ID}, but this may happen when reading mail from some
7659 sources. Gnus allows you to customize what happens with this variable.
7660 If it is @code{nil} (which is the default), Gnus will rename the
7661 @code{Message-ID} (for display purposes only) and display the article as
7662 any other article. If this variable is @code{t}, it won't display the
7663 article---it'll be as if it never existed.
7668 @node Summary Group Information
7669 @subsection Summary Group Information
7674 @kindex H f (Summary)
7675 @findex gnus-summary-fetch-faq
7676 @vindex gnus-group-faq-directory
7677 Try to fetch the FAQ (list of frequently asked questions) for the
7678 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
7679 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7680 on a remote machine. This variable can also be a list of directories.
7681 In that case, giving a prefix to this command will allow you to choose
7682 between the various sites. @code{ange-ftp} or @code{efs} will probably
7683 be used for fetching the file.
7686 @kindex H d (Summary)
7687 @findex gnus-summary-describe-group
7688 Give a brief description of the current group
7689 (@code{gnus-summary-describe-group}). If given a prefix, force
7690 rereading the description from the server.
7693 @kindex H h (Summary)
7694 @findex gnus-summary-describe-briefly
7695 Give an extremely brief description of the most important summary
7696 keystrokes (@code{gnus-summary-describe-briefly}).
7699 @kindex H i (Summary)
7700 @findex gnus-info-find-node
7701 Go to the Gnus info node (@code{gnus-info-find-node}).
7705 @node Searching for Articles
7706 @subsection Searching for Articles
7711 @kindex M-s (Summary)
7712 @findex gnus-summary-search-article-forward
7713 Search through all subsequent articles for a regexp
7714 (@code{gnus-summary-search-article-forward}).
7717 @kindex M-r (Summary)
7718 @findex gnus-summary-search-article-backward
7719 Search through all previous articles for a regexp
7720 (@code{gnus-summary-search-article-backward}).
7724 @findex gnus-summary-execute-command
7725 This command will prompt you for a header field, a regular expression to
7726 match on this field, and a command to be executed if the match is made
7727 (@code{gnus-summary-execute-command}). If given a prefix, search
7731 @kindex M-& (Summary)
7732 @findex gnus-summary-universal-argument
7733 Perform any operation on all articles that have been marked with
7734 the process mark (@code{gnus-summary-universal-argument}).
7737 @node Summary Generation Commands
7738 @subsection Summary Generation Commands
7743 @kindex Y g (Summary)
7744 @findex gnus-summary-prepare
7745 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7748 @kindex Y c (Summary)
7749 @findex gnus-summary-insert-cached-articles
7750 Pull all cached articles (for the current group) into the summary buffer
7751 (@code{gnus-summary-insert-cached-articles}).
7756 @node Really Various Summary Commands
7757 @subsection Really Various Summary Commands
7762 @kindex C-d (Summary)
7763 @findex gnus-summary-enter-digest-group
7764 If the current article is a collection of other articles (for instance,
7765 a digest), you might use this command to enter a group based on the that
7766 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
7767 guess what article type is currently displayed unless you give a prefix
7768 to this command, which forces a ``digest'' interpretation. Basically,
7769 whenever you see a message that is a collection of other messages of
7770 some format, you @kbd{C-d} and read these messages in a more convenient
7774 @kindex M-C-d (Summary)
7775 @findex gnus-summary-read-document
7776 This command is very similar to the one above, but lets you gather
7777 several documents into one biiig group
7778 (@code{gnus-summary-read-document}). It does this by opening several
7779 @code{nndoc} groups for each document, and then opening an
7780 @code{nnvirtual} group on top of these @code{nndoc} groups. This
7781 command understands the process/prefix convention
7782 (@pxref{Process/Prefix}).
7785 @kindex C-t (Summary)
7786 @findex gnus-summary-toggle-truncation
7787 Toggle truncation of summary lines
7788 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
7789 line centering function in the summary buffer, so it's not a good idea
7790 to have truncation switched off while reading articles.
7794 @findex gnus-summary-expand-window
7795 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7796 If given a prefix, force an @code{article} window configuration.
7799 @kindex M-C-e (Summary)
7800 @findex gnus-summary-edit-parameters
7801 Edit the group parameters (@pxref{Group Parameters}) of the current
7802 group (@code{gnus-summary-edit-parameters}).
7805 @kindex M-C-g (Summary)
7806 @findex gnus-summary-customize-parameters
7807 Customize the group parameters (@pxref{Group Parameters}) of the current
7808 group (@code{gnus-summary-customize-parameters}).
7813 @node Exiting the Summary Buffer
7814 @section Exiting the Summary Buffer
7815 @cindex summary exit
7816 @cindex exiting groups
7818 Exiting from the summary buffer will normally update all info on the
7819 group and return you to the group buffer.
7825 @kindex Z Z (Summary)
7827 @findex gnus-summary-exit
7828 @vindex gnus-summary-exit-hook
7829 @vindex gnus-summary-prepare-exit-hook
7830 @c @icon{gnus-summary-exit}
7831 Exit the current group and update all information on the group
7832 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7833 called before doing much of the exiting, which calls
7834 @code{gnus-summary-expire-articles} by default.
7835 @code{gnus-summary-exit-hook} is called after finishing the exit
7836 process. @code{gnus-group-no-more-groups-hook} is run when returning to
7837 group mode having no more (unread) groups.
7841 @kindex Z E (Summary)
7843 @findex gnus-summary-exit-no-update
7844 Exit the current group without updating any information on the group
7845 (@code{gnus-summary-exit-no-update}).
7849 @kindex Z c (Summary)
7851 @findex gnus-summary-catchup-and-exit
7852 @c @icon{gnus-summary-catchup-and-exit}
7853 Mark all unticked articles in the group as read and then exit
7854 (@code{gnus-summary-catchup-and-exit}).
7857 @kindex Z C (Summary)
7858 @findex gnus-summary-catchup-all-and-exit
7859 Mark all articles, even the ticked ones, as read and then exit
7860 (@code{gnus-summary-catchup-all-and-exit}).
7863 @kindex Z n (Summary)
7864 @findex gnus-summary-catchup-and-goto-next-group
7865 Mark all articles as read and go to the next group
7866 (@code{gnus-summary-catchup-and-goto-next-group}).
7869 @kindex Z R (Summary)
7870 @findex gnus-summary-reselect-current-group
7871 Exit this group, and then enter it again
7872 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
7873 all articles, both read and unread.
7877 @kindex Z G (Summary)
7878 @kindex M-g (Summary)
7879 @findex gnus-summary-rescan-group
7880 @c @icon{gnus-summary-mail-get}
7881 Exit the group, check for new articles in the group, and select the
7882 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
7883 articles, both read and unread.
7886 @kindex Z N (Summary)
7887 @findex gnus-summary-next-group
7888 Exit the group and go to the next group
7889 (@code{gnus-summary-next-group}).
7892 @kindex Z P (Summary)
7893 @findex gnus-summary-prev-group
7894 Exit the group and go to the previous group
7895 (@code{gnus-summary-prev-group}).
7898 @kindex Z s (Summary)
7899 @findex gnus-summary-save-newsrc
7900 Save the current number of read/marked articles in the dribble buffer
7901 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
7902 given a prefix, also save the @file{.newsrc} file(s). Using this
7903 command will make exit without updating (the @kbd{Q} command) worthless.
7906 @vindex gnus-exit-group-hook
7907 @code{gnus-exit-group-hook} is called when you exit the current
7910 @findex gnus-summary-wake-up-the-dead
7911 @findex gnus-dead-summary-mode
7912 @vindex gnus-kill-summary-on-exit
7913 If you're in the habit of exiting groups, and then changing your mind
7914 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
7915 If you do that, Gnus won't kill the summary buffer when you exit it.
7916 (Quelle surprise!) Instead it will change the name of the buffer to
7917 something like @samp{*Dead Summary ... *} and install a minor mode
7918 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
7919 buffer, you'll find that all keys are mapped to a function called
7920 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
7921 summary buffer will result in a live, normal summary buffer.
7923 There will never be more than one dead summary buffer at any one time.
7925 @vindex gnus-use-cross-reference
7926 The data on the current group will be updated (which articles you have
7927 read, which articles you have replied to, etc.) when you exit the
7928 summary buffer. If the @code{gnus-use-cross-reference} variable is
7929 @code{t} (which is the default), articles that are cross-referenced to
7930 this group and are marked as read, will also be marked as read in the
7931 other subscribed groups they were cross-posted to. If this variable is
7932 neither @code{nil} nor @code{t}, the article will be marked as read in
7933 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7936 @node Crosspost Handling
7937 @section Crosspost Handling
7941 Marking cross-posted articles as read ensures that you'll never have to
7942 read the same article more than once. Unless, of course, somebody has
7943 posted it to several groups separately. Posting the same article to
7944 several groups (not cross-posting) is called @dfn{spamming}, and you are
7945 by law required to send nasty-grams to anyone who perpetrates such a
7946 heinous crime. You may want to try NoCeM handling to filter out spam
7949 Remember: Cross-posting is kinda ok, but posting the same article
7950 separately to several groups is not. Massive cross-posting (aka.
7951 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7952 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7953 excessive crossposting (@pxref{Summary Mail Commands}).
7955 @cindex cross-posting
7958 One thing that may cause Gnus to not do the cross-posting thing
7959 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7960 (which is very nice, because it speeds things up considerably) which
7961 does not include the @code{Xref} header in its @sc{nov} lines. This is
7962 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
7963 even with @sc{xover} by registering the @code{Xref} lines of all
7964 articles you actually read, but if you kill the articles, or just mark
7965 them as read without reading them, Gnus will not get a chance to snoop
7966 the @code{Xref} lines out of these articles, and will be unable to use
7967 the cross reference mechanism.
7969 @cindex LIST overview.fmt
7970 @cindex overview.fmt
7971 To check whether your @sc{nntp} server includes the @code{Xref} header
7972 in its overview files, try @samp{telnet your.nntp.server nntp},
7973 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7974 overview.fmt}. This may not work, but if it does, and the last line you
7975 get does not read @samp{Xref:full}, then you should shout and whine at
7976 your news admin until she includes the @code{Xref} header in the
7979 @vindex gnus-nov-is-evil
7980 If you want Gnus to get the @code{Xref}s right all the time, you have to
7981 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7986 For an alternative approach, @pxref{Duplicate Suppression}.
7989 @node Duplicate Suppression
7990 @section Duplicate Suppression
7992 By default, Gnus tries to make sure that you don't have to read the same
7993 article more than once by utilizing the crossposting mechanism
7994 (@pxref{Crosspost Handling}). However, that simple and efficient
7995 approach may not work satisfactory for some users for various
8000 The @sc{nntp} server may fail to generate the @code{Xref} header. This
8001 is evil and not very common.
8004 The @sc{nntp} server may fail to include the @code{Xref} header in the
8005 @file{.overview} data bases. This is evil and all too common, alas.
8008 You may be reading the same group (or several related groups) from
8009 different @sc{nntp} servers.
8012 You may be getting mail that duplicates articles posted to groups.
8015 I'm sure there are other situations where @code{Xref} handling fails as
8016 well, but these four are the most common situations.
8018 If, and only if, @code{Xref} handling fails for you, then you may
8019 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
8020 will remember the @code{Message-ID}s of all articles you have read or
8021 otherwise marked as read, and then, as if by magic, mark them as read
8022 all subsequent times you see them---in @emph{all} groups. Using this
8023 mechanism is quite likely to be somewhat inefficient, but not overly
8024 so. It's certainly preferable to reading the same articles more than
8027 Duplicate suppression is not a very subtle instrument. It's more like a
8028 sledge hammer than anything else. It works in a very simple
8029 fashion---if you have marked an article as read, it adds this Message-ID
8030 to a cache. The next time it sees this Message-ID, it will mark the
8031 article as read with the @samp{M} mark. It doesn't care what group it
8035 @item gnus-suppress-duplicates
8036 @vindex gnus-suppress-duplicates
8037 If non-@code{nil}, suppress duplicates.
8039 @item gnus-save-duplicate-list
8040 @vindex gnus-save-duplicate-list
8041 If non-@code{nil}, save the list of duplicates to a file. This will
8042 make startup and shutdown take longer, so the default is @code{nil}.
8043 However, this means that only duplicate articles read in a single Gnus
8044 session are suppressed.
8046 @item gnus-duplicate-list-length
8047 @vindex gnus-duplicate-list-length
8048 This variable says how many @code{Message-ID}s to keep in the duplicate
8049 suppression list. The default is 10000.
8051 @item gnus-duplicate-file
8052 @vindex gnus-duplicate-file
8053 The name of the file to store the duplicate suppression list in. The
8054 default is @file{~/News/suppression}.
8057 If you have a tendency to stop and start Gnus often, setting
8058 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
8059 you leave Gnus running for weeks on end, you may have it @code{nil}. On
8060 the other hand, saving the list makes startup and shutdown much slower,
8061 so that means that if you stop and start Gnus often, you should set
8062 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
8063 to you to figure out, I think.
8066 @node The Article Buffer
8067 @chapter The Article Buffer
8068 @cindex article buffer
8070 The articles are displayed in the article buffer, of which there is only
8071 one. All the summary buffers share the same article buffer unless you
8072 tell Gnus otherwise.
8075 * Hiding Headers:: Deciding what headers should be displayed.
8076 * Using MIME:: Pushing articles through @sc{mime} before reading them.
8077 * Customizing Articles:: Tailoring the look of the articles.
8078 * Article Keymap:: Keystrokes available in the article buffer.
8079 * Misc Article:: Other stuff.
8083 @node Hiding Headers
8084 @section Hiding Headers
8085 @cindex hiding headers
8086 @cindex deleting headers
8088 The top section of each article is the @dfn{head}. (The rest is the
8089 @dfn{body}, but you may have guessed that already.)
8091 @vindex gnus-show-all-headers
8092 There is a lot of useful information in the head: the name of the person
8093 who wrote the article, the date it was written and the subject of the
8094 article. That's well and nice, but there's also lots of information
8095 most people do not want to see---what systems the article has passed
8096 through before reaching you, the @code{Message-ID}, the
8097 @code{References}, etc. ad nauseum---and you'll probably want to get rid
8098 of some of those lines. If you want to keep all those lines in the
8099 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
8101 Gnus provides you with two variables for sifting headers:
8105 @item gnus-visible-headers
8106 @vindex gnus-visible-headers
8107 If this variable is non-@code{nil}, it should be a regular expression
8108 that says what headers you wish to keep in the article buffer. All
8109 headers that do not match this variable will be hidden.
8111 For instance, if you only want to see the name of the person who wrote
8112 the article and the subject, you'd say:
8115 (setq gnus-visible-headers "^From:\\|^Subject:")
8118 This variable can also be a list of regexps to match headers to
8121 @item gnus-ignored-headers
8122 @vindex gnus-ignored-headers
8123 This variable is the reverse of @code{gnus-visible-headers}. If this
8124 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
8125 should be a regular expression that matches all lines that you want to
8126 hide. All lines that do not match this variable will remain visible.
8128 For instance, if you just want to get rid of the @code{References} line
8129 and the @code{Xref} line, you might say:
8132 (setq gnus-ignored-headers "^References:\\|^Xref:")
8135 This variable can also be a list of regexps to match headers to
8138 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
8139 variable will have no effect.
8143 @vindex gnus-sorted-header-list
8144 Gnus can also sort the headers for you. (It does this by default.) You
8145 can control the sorting by setting the @code{gnus-sorted-header-list}
8146 variable. It is a list of regular expressions that says in what order
8147 the headers are to be displayed.
8149 For instance, if you want the name of the author of the article first,
8150 and then the subject, you might say something like:
8153 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
8156 Any headers that are to remain visible, but are not listed in this
8157 variable, will be displayed in random order after all the headers listed in this variable.
8159 @findex gnus-article-hide-boring-headers
8160 @vindex gnus-boring-article-headers
8161 You can hide further boring headers by setting
8162 @code{gnus-treat-hide-boring-header} to @code{head}. What this function
8163 does depends on the @code{gnus-boring-article-headers} variable. It's a
8164 list, but this list doesn't actually contain header names. Instead is
8165 lists various @dfn{boring conditions} that Gnus can check and remove
8168 These conditions are:
8171 Remove all empty headers.
8173 Remove the @code{Followup-To} header if it is identical to the
8174 @code{Newsgroups} header.
8176 Remove the @code{Reply-To} header if it lists the same address as the
8179 Remove the @code{Newsgroups} header if it only contains the current group
8182 Remove the @code{Date} header if the article is less than three days
8185 Remove the @code{To} header if it is very long.
8187 Remove all @code{To} headers if there are more than one.
8190 To include the four three elements, you could say something like;
8193 (setq gnus-boring-article-headers
8194 '(empty followup-to reply-to))
8197 This is also the default value for this variable.
8201 @section Using @sc{mime}
8204 Mime is a standard for waving your hands through the air, aimlessly,
8205 while people stand around yawning.
8207 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
8208 while all newsreaders die of fear.
8210 @sc{mime} may specify what character set the article uses, the encoding
8211 of the characters, and it also makes it possible to embed pictures and
8212 other naughty stuff in innocent-looking articles.
8214 @vindex gnus-display-mime-function
8215 @findex gnus-display-mime
8216 Gnus pushes @sc{mime} articles through @code{gnus-display-mime-function}
8217 to display the @sc{mime} parts. This is @code{gnus-display-mime} by
8218 default, which creates a bundle of clickable buttons that can be used to
8219 display, save and manipulate the @sc{mime} objects.
8221 The following commands are available when you have placed point over a
8225 @findex gnus-article-press-button
8227 @itemx BUTTON-2 (Article)
8228 Toggle displaying of the @sc{mime} object
8229 (@code{gnus-article-press-button}).
8231 @findex gnus-mime-view-part
8232 @item M-RET (Article)
8234 Prompt for a method, and then view the @sc{mime} object using this
8235 method (@code{gnus-mime-view-part}).
8237 @findex gnus-mime-save-part
8239 Prompt for a file name, and then save the @sc{mime} object
8240 (@code{gnus-mime-save-part}).
8242 @findex gnus-mime-copy-part
8244 Copy the @sc{mime} object to a fresh buffer and display this buffer
8245 (@code{gnus-mime-copy-part}).
8247 @findex gnus-mime-pipe-part
8249 Output the @sc{mime} object to a process (@code{gnus-mime-pipe-part}).
8252 Gnus will display some @sc{mime} objects automatically. The way Gnus
8253 determines which parts to do this with is described in the Emacs MIME
8256 It might be best to just use the toggling functions from the article
8257 buffer to avoid getting nasty surprises. (For instance, you enter the
8258 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
8259 decoded the sound file in the article and some horrible sing-a-long song
8260 comes screaming out your speakers, and you can't find the volume button,
8261 because there isn't one, and people are starting to look at you, and you
8262 try to stop the program, but you can't, and you can't find the program
8263 to control the volume, and everybody else in the room suddenly decides
8264 to look at you disdainfully, and you'll feel rather stupid.)
8266 Any similarity to real events and people is purely coincidental. Ahem.
8269 @node Customizing Articles
8270 @section Customizing Articles
8271 @cindex article customization
8273 A slew of functions for customizing how the articles are to look like
8274 exist. You can call these functions interactively, or you can have them
8275 called automatically when you select the articles.
8277 To have them called automatically, you should set the corresponding
8278 ``treatment'' variable. For instance, to have headers hidden, you'd set
8279 @code{gnus-treat-hide-headers}. Below is a list of variables that can
8280 be set, but first we discuss the values these variables can have.
8284 @code{nil}: Don't do this treatment.
8287 @code{t}: Do this treatment on all body parts.
8290 @code{head}: Do the treatment on the headers.
8293 @code{last}: Do this treatment on the last part.
8296 An integer: Do this treatment on all body parts that have a length less
8302 The list is evaluated recursively. The first element of the list is a
8303 predicate. The following predicates are recognized: @code{or},
8304 @code{and}, @code{not} and @code{typep}. Here's an example:
8308 (typep "text/x-vcard"))
8313 You may have noticed that the word @dfn{part} is used here. This refers
8314 to the fact that some messages are @sc{mime} multipart articles that may
8315 be divided into several parts. Articles that are not multiparts are
8316 considered to contain just a single part.
8318 @vindex gnus-article-treat-types
8319 Are the treatments applied to all sorts of multipart parts? Yes, if you
8320 want to, but by default, only @samp{text/plain} parts are given the
8321 treatment. This is controlled by the @code{gnus-article-treat-types}
8322 variable, which is a list of regular expressions that are matched to the
8323 type of the part. This variable is ignored if the value of the
8324 controlling variable is a predicate list, as described above.
8326 The following treatment options are available. The easiest way to
8327 customize this is to examine the @code{gnus-article-treat} customization
8331 @item gnus-treat-highlight-signature
8332 @item gnus-treat-buttonize
8333 @item gnus-treat-buttonize-head
8334 @item gnus-treat-emphasize
8335 @item gnus-treat-fill-article
8336 @item gnus-treat-strip-cr
8337 @item gnus-treat-hide-headers
8338 @item gnus-treat-hide-boring-headers
8339 @item gnus-treat-hide-signature
8340 @item gnus-treat-hide-citation
8341 @item gnus-treat-strip-pgp
8342 @item gnus-treat-strip-pem
8343 @item gnus-treat-highlight-headers
8344 @item gnus-treat-highlight-citation
8345 @item gnus-treat-highlight-signature
8346 @item gnus-treat-date-ut
8347 @item gnus-treat-date-local
8348 @item gnus-treat-date-lapsed
8349 @item gnus-treat-date-original
8350 @item gnus-treat-strip-trailing-blank-lines
8351 @item gnus-treat-strip-leading-blank-lines
8352 @item gnus-treat-strip-multiple-blank-lines
8353 @item gnus-treat-strip-blank-lines
8354 @item gnus-treat-overstrike
8355 @item gnus-treat-display-xface
8356 @item gnus-treat-display-smileys
8357 @item gnus-treat-display-picons
8360 @vindex gnus-part-display-hook
8361 You can, of course, write your own functions to be called from
8362 @code{gnus-part-display-hook}. The functions are called narrowed to the
8363 part, and you can do anything you like, pretty much. There is no
8364 information that you have to keep in the buffer---you can change
8365 everything. However, you shouldn't delete any headers. Instead make
8366 them invisible if you want to make them go away.
8369 @node Article Keymap
8370 @section Article Keymap
8372 Most of the keystrokes in the summary buffer can also be used in the
8373 article buffer. They should behave as if you typed them in the summary
8374 buffer, which means that you don't actually have to have a summary
8375 buffer displayed while reading. You can do it all from the article
8378 A few additional keystrokes are available:
8383 @kindex SPACE (Article)
8384 @findex gnus-article-next-page
8385 Scroll forwards one page (@code{gnus-article-next-page}).
8388 @kindex DEL (Article)
8389 @findex gnus-article-prev-page
8390 Scroll backwards one page (@code{gnus-article-prev-page}).
8393 @kindex C-c ^ (Article)
8394 @findex gnus-article-refer-article
8395 If point is in the neighborhood of a @code{Message-ID} and you press
8396 @kbd{C-c ^}, Gnus will try to get that article from the server
8397 (@code{gnus-article-refer-article}).
8400 @kindex C-c C-m (Article)
8401 @findex gnus-article-mail
8402 Send a reply to the address near point (@code{gnus-article-mail}). If
8403 given a prefix, include the mail.
8407 @findex gnus-article-show-summary
8408 Reconfigure the buffers so that the summary buffer becomes visible
8409 (@code{gnus-article-show-summary}).
8413 @findex gnus-article-describe-briefly
8414 Give a very brief description of the available keystrokes
8415 (@code{gnus-article-describe-briefly}).
8418 @kindex TAB (Article)
8419 @findex gnus-article-next-button
8420 Go to the next button, if any (@code{gnus-article-next-button}). This
8421 only makes sense if you have buttonizing turned on.
8424 @kindex M-TAB (Article)
8425 @findex gnus-article-prev-button
8426 Go to the previous button, if any (@code{gnus-article-prev-button}).
8432 @section Misc Article
8436 @item gnus-single-article-buffer
8437 @vindex gnus-single-article-buffer
8438 If non-@code{nil}, use the same article buffer for all the groups.
8439 (This is the default.) If @code{nil}, each group will have its own
8442 @vindex gnus-article-decode-hook
8443 @item gnus-article-decode-hook
8445 Hook used to decode @sc{mime} articles. The default value is
8446 @code{(article-decode-charset article-decode-encoded-words)}
8448 @vindex gnus-article-prepare-hook
8449 @item gnus-article-prepare-hook
8450 This hook is called right after the article has been inserted into the
8451 article buffer. It is mainly intended for functions that do something
8452 depending on the contents; it should probably not be used for changing
8453 the contents of the article buffer.
8455 @item gnus-article-mode-hook
8456 @vindex gnus-article-mode-hook
8457 Hook called in article mode buffers.
8459 @item gnus-article-mode-syntax-table
8460 @vindex gnus-article-mode-syntax-table
8461 Syntax table used in article buffers. It is initialized from
8462 @code{text-mode-syntax-table}.
8464 @vindex gnus-article-mode-line-format
8465 @item gnus-article-mode-line-format
8466 This variable is a format string along the same lines as
8467 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
8468 accepts the same format specifications as that variable, with one
8473 The @dfn{wash status} of the article. This is a short string with one
8474 character for each possible article wash operation that may have been
8477 The number of @sc{mime} parts in the article.
8480 @vindex gnus-break-pages
8482 @item gnus-break-pages
8483 Controls whether @dfn{page breaking} is to take place. If this variable
8484 is non-@code{nil}, the articles will be divided into pages whenever a
8485 page delimiter appears in the article. If this variable is @code{nil},
8486 paging will not be done.
8488 @item gnus-page-delimiter
8489 @vindex gnus-page-delimiter
8490 This is the delimiter mentioned above. By default, it is @samp{^L}
8495 @node Composing Messages
8496 @chapter Composing Messages
8497 @cindex composing messages
8500 @cindex sending mail
8505 @kindex C-c C-c (Post)
8506 All commands for posting and mailing will put you in a message buffer
8507 where you can edit the article all you like, before you send the article
8508 by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The Message
8509 Manual}. If you are in a foreign news group, and you wish to post the
8510 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
8511 to make Gnus try to post using the foreign server.
8514 * Mail:: Mailing and replying.
8515 * Post:: Posting and following up.
8516 * Posting Server:: What server should you post via?
8517 * Mail and Post:: Mailing and posting at the same time.
8518 * Archived Messages:: Where Gnus stores the messages you've sent.
8519 * Posting Styles:: An easier way to specify who you are.
8520 * Drafts:: Postponing messages and rejected messages.
8521 * Rejected Articles:: What happens if the server doesn't like your article?
8524 Also see @pxref{Canceling and Superseding} for information on how to
8525 remove articles you shouldn't have posted.
8531 Variables for customizing outgoing mail:
8534 @item gnus-uu-digest-headers
8535 @vindex gnus-uu-digest-headers
8536 List of regexps to match headers included in digested messages. The
8537 headers will be included in the sequence they are matched.
8539 @item gnus-add-to-list
8540 @vindex gnus-add-to-list
8541 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8542 that have none when you do a @kbd{a}.
8550 Variables for composing news articles:
8553 @item gnus-sent-message-ids-file
8554 @vindex gnus-sent-message-ids-file
8555 Gnus will keep a @code{Message-ID} history file of all the mails it has
8556 sent. If it discovers that it has already sent a mail, it will ask the
8557 user whether to re-send the mail. (This is primarily useful when
8558 dealing with @sc{soup} packets and the like where one is apt to send the
8559 same packet multiple times.) This variable says what the name of this
8560 history file is. It is @file{~/News/Sent-Message-IDs} by default. Set
8561 this variable to @code{nil} if you don't want Gnus to keep a history
8564 @item gnus-sent-message-ids-length
8565 @vindex gnus-sent-message-ids-length
8566 This variable says how many @code{Message-ID}s to keep in the history
8567 file. It is 1000 by default.
8572 @node Posting Server
8573 @section Posting Server
8575 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8576 (extremely intelligent, of course) article, where does it go?
8578 Thank you for asking. I hate you.
8580 @vindex gnus-post-method
8582 It can be quite complicated. Normally, Gnus will use the same native
8583 server. However. If your native server doesn't allow posting, just
8584 reading, you probably want to use some other server to post your
8585 (extremely intelligent and fabulously interesting) articles. You can
8586 then set the @code{gnus-post-method} to some other method:
8589 (setq gnus-post-method '(nnspool ""))
8592 Now, if you've done this, and then this server rejects your article, or
8593 this server is down, what do you do then? To override this variable you
8594 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8595 the ``current'' server for posting.
8597 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8598 Gnus will prompt you for what method to use for posting.
8600 You can also set @code{gnus-post-method} to a list of select methods.
8601 If that's the case, Gnus will always prompt you for what method to use
8604 Finally, if you want to always post using the same select method as
8605 you're reading from (which might be convenient if you're reading lots of
8606 groups from different private servers), you can set this variable to
8611 @section Mail and Post
8613 Here's a list of variables relevant to both mailing and
8617 @item gnus-mailing-list-groups
8618 @findex gnus-mailing-list-groups
8619 @cindex mailing lists
8621 If your news server offers groups that are really mailing lists
8622 gatewayed to the @sc{nntp} server, you can read those groups without
8623 problems, but you can't post/followup to them without some difficulty.
8624 One solution is to add a @code{to-address} to the group parameters
8625 (@pxref{Group Parameters}). An easier thing to do is set the
8626 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8627 really are mailing lists. Then, at least, followups to the mailing
8628 lists will work most of the time. Posting to these groups (@kbd{a}) is
8629 still a pain, though.
8633 You may want to do spell-checking on messages that you send out. Or, if
8634 you don't want to spell-check by hand, you could add automatic
8635 spell-checking via the @code{ispell} package:
8638 @findex ispell-message
8640 (add-hook 'message-send-hook 'ispell-message)
8644 @node Archived Messages
8645 @section Archived Messages
8646 @cindex archived messages
8647 @cindex sent messages
8649 Gnus provides a few different methods for storing the mail and news you
8650 send. The default method is to use the @dfn{archive virtual server} to
8651 store the messages. If you want to disable this completely, the
8652 @code{gnus-message-archive-group} variable should be @code{nil}, which
8655 @vindex gnus-message-archive-method
8656 @code{gnus-message-archive-method} says what virtual server Gnus is to
8657 use to store sent messages. The default is:
8661 (nnfolder-directory "~/Mail/archive")
8662 (nnfolder-active-file "~/Mail/archive/active")
8663 (nnfolder-get-new-mail nil)
8664 (nnfolder-inhibit-expiry t))
8667 You can, however, use any mail select method (@code{nnml},
8668 @code{nnmbox}, etc.). @code{nnfolder} is a quite likeable select method
8669 for doing this sort of thing, though. If you don't like the default
8670 directory chosen, you could say something like:
8673 (setq gnus-message-archive-method
8674 '(nnfolder "archive"
8675 (nnfolder-inhibit-expiry t)
8676 (nnfolder-active-file "~/News/sent-mail/active")
8677 (nnfolder-directory "~/News/sent-mail/")))
8680 @vindex gnus-message-archive-group
8682 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8683 to one or more group(s) on that server. Which group to use is
8684 determined by the @code{gnus-message-archive-group} variable.
8686 This variable can be used to do the following:
8690 Messages will be saved in that group.
8691 @item a list of strings
8692 Messages will be saved in all those groups.
8693 @item an alist of regexps, functions and forms
8694 When a key ``matches'', the result is used.
8696 No message archiving will take place. This is the default.
8701 Just saving to a single group called @samp{MisK}:
8703 (setq gnus-message-archive-group "MisK")
8706 Saving to two groups, @samp{MisK} and @samp{safe}:
8708 (setq gnus-message-archive-group '("MisK" "safe"))
8711 Save to different groups based on what group you are in:
8713 (setq gnus-message-archive-group
8714 '(("^alt" "sent-to-alt")
8715 ("mail" "sent-to-mail")
8716 (".*" "sent-to-misc")))
8721 (setq gnus-message-archive-group
8722 '((if (message-news-p)
8727 How about storing all news messages in one file, but storing all mail
8728 messages in one file per month:
8731 (setq gnus-message-archive-group
8732 '((if (message-news-p)
8734 (concat "mail." (format-time-string
8735 "%Y-%m" (current-time))))))
8738 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8739 use a different value for @code{gnus-message-archive-group} there.)
8741 Now, when you send a message off, it will be stored in the appropriate
8742 group. (If you want to disable storing for just one particular message,
8743 you can just remove the @code{Gcc} header that has been inserted.) The
8744 archive group will appear in the group buffer the next time you start
8745 Gnus, or the next time you press @kbd{F} in the group buffer. You can
8746 enter it and read the articles in it just like you'd read any other
8747 group. If the group gets really big and annoying, you can simply rename
8748 if (using @kbd{G r} in the group buffer) to something
8749 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
8750 continue to be stored in the old (now empty) group.
8752 That's the default method of archiving sent messages. Gnus offers a
8753 different way for the people who don't like the default method. In that
8754 case you should set @code{gnus-message-archive-group} to @code{nil};
8755 this will disable archiving.
8758 @item gnus-outgoing-message-group
8759 @vindex gnus-outgoing-message-group
8760 All outgoing messages will be put in this group. If you want to store
8761 all your outgoing mail and articles in the group @samp{nnml:archive},
8762 you set this variable to that value. This variable can also be a list of
8765 If you want to have greater control over what group to put each
8766 message in, you can set this variable to a function that checks the
8767 current newsgroup name and then returns a suitable group name (or list
8770 This variable can be used instead of @code{gnus-message-archive-group},
8771 but the latter is the preferred method.
8775 @node Posting Styles
8776 @section Posting Styles
8777 @cindex posting styles
8780 All them variables, they make my head swim.
8782 So what if you want a different @code{Organization} and signature based
8783 on what groups you post to? And you post both from your home machine
8784 and your work machine, and you want different @code{From} lines, and so
8787 @vindex gnus-posting-styles
8788 One way to do stuff like that is to write clever hooks that change the
8789 variables you need to have changed. That's a bit boring, so somebody
8790 came up with the bright idea of letting the user specify these things in
8791 a handy alist. Here's an example of a @code{gnus-posting-styles}
8796 (signature "Peace and happiness")
8797 (organization "What me?"))
8799 (signature "Death to everybody"))
8800 ("comp.emacs.i-love-it"
8801 (organization "Emacs is it")))
8804 As you might surmise from this example, this alist consists of several
8805 @dfn{styles}. Each style will be applicable if the first element
8806 ``matches'', in some form or other. The entire alist will be iterated
8807 over, from the beginning towards the end, and each match will be
8808 applied, which means that attributes in later styles that match override
8809 the same attributes in earlier matching styles. So
8810 @samp{comp.programming.literate} will have the @samp{Death to everybody}
8811 signature and the @samp{What me?} @code{Organization} header.
8813 The first element in each style is called the @code{match}. If it's a
8814 string, then Gnus will try to regexp match it against the group name.
8815 If it's a function symbol, that function will be called with no
8816 arguments. If it's a variable symbol, then the variable will be
8817 referenced. If it's a list, then that list will be @code{eval}ed. In
8818 any case, if this returns a non-@code{nil} value, then the style is said
8821 Each style may contain a arbitrary amount of @dfn{attributes}. Each
8822 attribute consists of a @var{(name . value)} pair. The attribute name
8823 can be one of @code{signature}, @code{signature-file},
8824 @code{organization}, @code{address}, @code{name} or @code{body}. The
8825 attribute name can also be a string. In that case, this will be used as
8826 a header name, and the value will be inserted in the headers of the
8829 The attribute value can be a string (used verbatim), a function (the
8830 return value will be used), a variable (its value will be used) or a
8831 list (it will be @code{eval}ed and the return value will be used).
8833 If you wish to check whether the message you are about to compose is
8834 meant to be a news article or a mail message, you can check the values
8835 of the two dynamically bound variables @code{message-this-is-news} and
8836 @code{message-this-is-mail}.
8838 @vindex message-this-is-mail
8839 @vindex message-this-is-news
8841 So here's a new example:
8844 (setq gnus-posting-styles
8846 (signature-file "~/.signature")
8848 ("X-Home-Page" (getenv "WWW_HOME"))
8849 (organization "People's Front Against MWM"))
8851 (signature my-funny-signature-randomizer))
8852 ((equal (system-name) "gnarly")
8853 (signature my-quote-randomizer))
8854 (message-this-is-news
8855 (signature my-news-signature))
8856 (posting-from-work-p
8857 (signature-file "~/.work-signature")
8858 (address "user@@bar.foo")
8859 (body "You are fired.\n\nSincerely, your boss.")
8860 (organization "Important Work, Inc"))
8862 (signature-file "~/.mail-signature"))))
8870 If you are writing a message (mail or news) and suddenly remember that
8871 you have a steak in the oven (or some pesto in the food processor, you
8872 craaazy vegetarians), you'll probably wish there was a method to save
8873 the message you are writing so that you can continue editing it some
8874 other day, and send it when you feel its finished.
8876 Well, don't worry about it. Whenever you start composing a message of
8877 some sort using the Gnus mail and post commands, the buffer you get will
8878 automatically associate to an article in a special @dfn{draft} group.
8879 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
8880 article will be saved there. (Auto-save files also go to the draft
8884 @vindex nndraft-directory
8885 The draft group is a special group (which is implemented as an
8886 @code{nndraft} group, if you absolutely have to know) called
8887 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
8888 @code{nndraft} is to store its files. What makes this group special is
8889 that you can't tick any articles in it or mark any articles as
8890 read---all articles in the group are permanently unread.
8892 If the group doesn't exist, it will be created and you'll be subscribed
8893 to it. The only way to make it disappear from the Group buffer is to
8896 @c @findex gnus-dissociate-buffer-from-draft
8897 @c @kindex C-c M-d (Mail)
8898 @c @kindex C-c M-d (Post)
8899 @c @findex gnus-associate-buffer-with-draft
8900 @c @kindex C-c C-d (Mail)
8901 @c @kindex C-c C-d (Post)
8902 @c If you're writing some super-secret message that you later want to
8903 @c encode with PGP before sending, you may wish to turn the auto-saving
8904 @c (and association with the draft group) off. You never know who might be
8905 @c interested in reading all your extremely valuable and terribly horrible
8906 @c and interesting secrets. The @kbd{C-c M-d}
8907 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
8908 @c If you change your mind and want to turn the auto-saving back on again,
8909 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
8911 @c @vindex gnus-use-draft
8912 @c To leave association with the draft group off by default, set
8913 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
8915 @findex gnus-draft-edit-message
8917 When you want to continue editing the article, you simply enter the
8918 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
8919 that. You will be placed in a buffer where you left off.
8921 Rejected articles will also be put in this draft group (@pxref{Rejected
8924 @findex gnus-draft-send-all-messages
8925 @findex gnus-draft-send-message
8926 If you have lots of rejected messages you want to post (or mail) without
8927 doing further editing, you can use the @kbd{D s} command
8928 (@code{gnus-draft-send-message}). This command understands the
8929 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
8930 command (@code{gnus-draft-send-all-messages}) will ship off all messages
8933 If you have some messages that you wish not to send, you can use the
8934 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
8935 as unsendable. This is a toggling command.
8938 @node Rejected Articles
8939 @section Rejected Articles
8940 @cindex rejected articles
8942 Sometimes a news server will reject an article. Perhaps the server
8943 doesn't like your face. Perhaps it just feels miserable. Perhaps
8944 @emph{there be demons}. Perhaps you have included too much cited text.
8945 Perhaps the disk is full. Perhaps the server is down.
8947 These situations are, of course, totally beyond the control of Gnus.
8948 (Gnus, of course, loves the way you look, always feels great, has angels
8949 fluttering around inside of it, doesn't care about how much cited text
8950 you include, never runs full and never goes down.) So Gnus saves these
8951 articles until some later time when the server feels better.
8953 The rejected articles will automatically be put in a special draft group
8954 (@pxref{Drafts}). When the server comes back up again, you'd then
8955 typically enter that group and send all the articles off.
8958 @node Select Methods
8959 @chapter Select Methods
8960 @cindex foreign groups
8961 @cindex select methods
8963 A @dfn{foreign group} is a group not read by the usual (or
8964 default) means. It could be, for instance, a group from a different
8965 @sc{nntp} server, it could be a virtual group, or it could be your own
8966 personal mail group.
8968 A foreign group (or any group, really) is specified by a @dfn{name} and
8969 a @dfn{select method}. To take the latter first, a select method is a
8970 list where the first element says what backend to use (e.g. @code{nntp},
8971 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
8972 name}. There may be additional elements in the select method, where the
8973 value may have special meaning for the backend in question.
8975 One could say that a select method defines a @dfn{virtual server}---so
8976 we do just that (@pxref{The Server Buffer}).
8978 The @dfn{name} of the group is the name the backend will recognize the
8981 For instance, the group @samp{soc.motss} on the @sc{nntp} server
8982 @samp{some.where.edu} will have the name @samp{soc.motss} and select
8983 method @code{(nntp "some.where.edu")}. Gnus will call this group
8984 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
8985 backend just knows this group as @samp{soc.motss}.
8987 The different methods all have their peculiarities, of course.
8990 * The Server Buffer:: Making and editing virtual servers.
8991 * Getting News:: Reading USENET news with Gnus.
8992 * Getting Mail:: Reading your personal mail with Gnus.
8993 * Other Sources:: Reading directories, files, SOUP packets.
8994 * Combined Groups:: Combining groups into one group.
8995 * Gnus Unplugged:: Reading news and mail offline.
8999 @node The Server Buffer
9000 @section The Server Buffer
9002 Traditionally, a @dfn{server} is a machine or a piece of software that
9003 one connects to, and then requests information from. Gnus does not
9004 connect directly to any real servers, but does all transactions through
9005 one backend or other. But that's just putting one layer more between
9006 the actual media and Gnus, so we might just as well say that each
9007 backend represents a virtual server.
9009 For instance, the @code{nntp} backend may be used to connect to several
9010 different actual @sc{nntp} servers, or, perhaps, to many different ports
9011 on the same actual @sc{nntp} server. You tell Gnus which backend to
9012 use, and what parameters to set by specifying a @dfn{select method}.
9014 These select method specifications can sometimes become quite
9015 complicated---say, for instance, that you want to read from the
9016 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
9017 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
9018 Anyways, if you had to specify that for each group that used this
9019 server, that would be too much work, so Gnus offers a way of naming
9020 select methods, which is what you do in the server buffer.
9022 To enter the server buffer, use the @kbd{^}
9023 (@code{gnus-group-enter-server-mode}) command in the group buffer.
9026 * Server Buffer Format:: You can customize the look of this buffer.
9027 * Server Commands:: Commands to manipulate servers.
9028 * Example Methods:: Examples server specifications.
9029 * Creating a Virtual Server:: An example session.
9030 * Server Variables:: Which variables to set.
9031 * Servers and Methods:: You can use server names as select methods.
9032 * Unavailable Servers:: Some servers you try to contact may be down.
9035 @vindex gnus-server-mode-hook
9036 @code{gnus-server-mode-hook} is run when creating the server buffer.
9039 @node Server Buffer Format
9040 @subsection Server Buffer Format
9041 @cindex server buffer format
9043 @vindex gnus-server-line-format
9044 You can change the look of the server buffer lines by changing the
9045 @code{gnus-server-line-format} variable. This is a @code{format}-like
9046 variable, with some simple extensions:
9051 How the news is fetched---the backend name.
9054 The name of this server.
9057 Where the news is to be fetched from---the address.
9060 The opened/closed/denied status of the server.
9063 @vindex gnus-server-mode-line-format
9064 The mode line can also be customized by using the
9065 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
9066 Formatting}). The following specs are understood:
9076 Also @pxref{Formatting Variables}.
9079 @node Server Commands
9080 @subsection Server Commands
9081 @cindex server commands
9087 @findex gnus-server-add-server
9088 Add a new server (@code{gnus-server-add-server}).
9092 @findex gnus-server-edit-server
9093 Edit a server (@code{gnus-server-edit-server}).
9096 @kindex SPACE (Server)
9097 @findex gnus-server-read-server
9098 Browse the current server (@code{gnus-server-read-server}).
9102 @findex gnus-server-exit
9103 Return to the group buffer (@code{gnus-server-exit}).
9107 @findex gnus-server-kill-server
9108 Kill the current server (@code{gnus-server-kill-server}).
9112 @findex gnus-server-yank-server
9113 Yank the previously killed server (@code{gnus-server-yank-server}).
9117 @findex gnus-server-copy-server
9118 Copy the current server (@code{gnus-server-copy-server}).
9122 @findex gnus-server-list-servers
9123 List all servers (@code{gnus-server-list-servers}).
9127 @findex gnus-server-scan-server
9128 Request that the server scan its sources for new articles
9129 (@code{gnus-server-scan-server}). This is mainly sensible with mail
9134 @findex gnus-server-regenerate-server
9135 Request that the server regenerate all its data structures
9136 (@code{gnus-server-regenerate-server}). This can be useful if you have
9137 a mail backend that has gotten out of synch.
9142 @node Example Methods
9143 @subsection Example Methods
9145 Most select methods are pretty simple and self-explanatory:
9148 (nntp "news.funet.fi")
9151 Reading directly from the spool is even simpler:
9157 As you can see, the first element in a select method is the name of the
9158 backend, and the second is the @dfn{address}, or @dfn{name}, if you
9161 After these two elements, there may be an arbitrary number of
9162 @var{(variable form)} pairs.
9164 To go back to the first example---imagine that you want to read from
9165 port 15 on that machine. This is what the select method should
9169 (nntp "news.funet.fi" (nntp-port-number 15))
9172 You should read the documentation to each backend to find out what
9173 variables are relevant, but here's an @code{nnmh} example:
9175 @code{nnmh} is a mail backend that reads a spool-like structure. Say
9176 you have two structures that you wish to access: One is your private
9177 mail spool, and the other is a public one. Here's the possible spec for
9181 (nnmh "private" (nnmh-directory "~/private/mail/"))
9184 (This server is then called @samp{private}, but you may have guessed
9187 Here's the method for a public spool:
9191 (nnmh-directory "/usr/information/spool/")
9192 (nnmh-get-new-mail nil))
9195 If you are behind a firewall and only have access to the @sc{nntp}
9196 server from the firewall machine, you can instruct Gnus to @code{rlogin}
9197 on the firewall machine and telnet from there to the @sc{nntp} server.
9198 Doing this can be rather fiddly, but your virtual server definition
9199 should probably look something like this:
9203 (nntp-address "the.firewall.machine")
9204 (nntp-open-connection-function nntp-open-rlogin)
9205 (nntp-end-of-line "\n")
9206 (nntp-rlogin-parameters
9207 ("telnet" "the.real.nntp.host" "nntp")))
9210 If you want to use the wonderful @code{ssh} program to provide a
9211 compressed connection over the modem line, you could create a virtual
9212 server that would look something like this:
9216 (nntp-address "copper.uio.no")
9217 (nntp-rlogin-program "ssh")
9218 (nntp-open-connection-function nntp-open-rlogin)
9219 (nntp-end-of-line "\n")
9220 (nntp-rlogin-parameters
9221 ("telnet" "news.uio.no" "nntp")))
9224 This means that you have to have set up @code{ssh-agent} correctly to
9225 provide automatic authorization, of course. And to get a compressed
9226 connection, you have to have the @samp{Compression} option in the
9227 @code{ssh} @file{config} file.
9230 @node Creating a Virtual Server
9231 @subsection Creating a Virtual Server
9233 If you're saving lots of articles in the cache by using persistent
9234 articles, you may want to create a virtual server to read the cache.
9236 First you need to add a new server. The @kbd{a} command does that. It
9237 would probably be best to use @code{nnspool} to read the cache. You
9238 could also use @code{nnml} or @code{nnmh}, though.
9240 Type @kbd{a nnspool RET cache RET}.
9242 You should now have a brand new @code{nnspool} virtual server called
9243 @samp{cache}. You now need to edit it to have the right definitions.
9244 Type @kbd{e} to edit the server. You'll be entered into a buffer that
9245 will contain the following:
9255 (nnspool-spool-directory "~/News/cache/")
9256 (nnspool-nov-directory "~/News/cache/")
9257 (nnspool-active-file "~/News/cache/active"))
9260 Type @kbd{C-c C-c} to return to the server buffer. If you now press
9261 @kbd{RET} over this virtual server, you should be entered into a browse
9262 buffer, and you should be able to enter any of the groups displayed.
9265 @node Server Variables
9266 @subsection Server Variables
9268 One sticky point when defining variables (both on backends and in Emacs
9269 in general) is that some variables are typically initialized from other
9270 variables when the definition of the variables is being loaded. If you
9271 change the "base" variable after the variables have been loaded, you
9272 won't change the "derived" variables.
9274 This typically affects directory and file variables. For instance,
9275 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
9276 directory variables are initialized from that variable, so
9277 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
9278 new virtual @code{nnml} server, it will @emph{not} suffice to set just
9279 @code{nnml-directory}---you have to explicitly set all the file
9280 variables to be what you want them to be. For a complete list of
9281 variables for each backend, see each backend's section later in this
9282 manual, but here's an example @code{nnml} definition:
9286 (nnml-directory "~/my-mail/")
9287 (nnml-active-file "~/my-mail/active")
9288 (nnml-newsgroups-file "~/my-mail/newsgroups"))
9292 @node Servers and Methods
9293 @subsection Servers and Methods
9295 Wherever you would normally use a select method
9296 (e.g. @code{gnus-secondary-select-method}, in the group select method,
9297 when browsing a foreign server) you can use a virtual server name
9298 instead. This could potentially save lots of typing. And it's nice all
9302 @node Unavailable Servers
9303 @subsection Unavailable Servers
9305 If a server seems to be unreachable, Gnus will mark that server as
9306 @code{denied}. That means that any subsequent attempt to make contact
9307 with that server will just be ignored. ``It can't be opened,'' Gnus
9308 will tell you, without making the least effort to see whether that is
9309 actually the case or not.
9311 That might seem quite naughty, but it does make sense most of the time.
9312 Let's say you have 10 groups subscribed to on server
9313 @samp{nephelococcygia.com}. This server is located somewhere quite far
9314 away from you and the machine is quite slow, so it takes 1 minute just
9315 to find out that it refuses connection to you today. If Gnus were to
9316 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
9317 attempt to do that. Once it has gotten a single ``connection refused'',
9318 it will regard that server as ``down''.
9320 So, what happens if the machine was only feeling unwell temporarily?
9321 How do you test to see whether the machine has come up again?
9323 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
9324 with the following commands:
9330 @findex gnus-server-open-server
9331 Try to establish connection to the server on the current line
9332 (@code{gnus-server-open-server}).
9336 @findex gnus-server-close-server
9337 Close the connection (if any) to the server
9338 (@code{gnus-server-close-server}).
9342 @findex gnus-server-deny-server
9343 Mark the current server as unreachable
9344 (@code{gnus-server-deny-server}).
9347 @kindex M-o (Server)
9348 @findex gnus-server-open-all-servers
9349 Open the connections to all servers in the buffer
9350 (@code{gnus-server-open-all-servers}).
9353 @kindex M-c (Server)
9354 @findex gnus-server-close-all-servers
9355 Close the connections to all servers in the buffer
9356 (@code{gnus-server-close-all-servers}).
9360 @findex gnus-server-remove-denials
9361 Remove all marks to whether Gnus was denied connection from any servers
9362 (@code{gnus-server-remove-denials}).
9368 @section Getting News
9369 @cindex reading news
9370 @cindex news backends
9372 A newsreader is normally used for reading news. Gnus currently provides
9373 only two methods of getting news---it can read from an @sc{nntp} server,
9374 or it can read from a local spool.
9377 * NNTP:: Reading news from an @sc{nntp} server.
9378 * News Spool:: Reading news from the local spool.
9383 @subsection @sc{nntp}
9386 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
9387 You just specify @code{nntp} as method and the address of the @sc{nntp}
9388 server as the, uhm, address.
9390 If the @sc{nntp} server is located at a non-standard port, setting the
9391 third element of the select method to this port number should allow you
9392 to connect to the right port. You'll have to edit the group info for
9393 that (@pxref{Foreign Groups}).
9395 The name of the foreign group can be the same as a native group. In
9396 fact, you can subscribe to the same group from as many different servers
9397 you feel like. There will be no name collisions.
9399 The following variables can be used to create a virtual @code{nntp}
9404 @item nntp-server-opened-hook
9405 @vindex nntp-server-opened-hook
9406 @cindex @sc{mode reader}
9408 @cindex authentification
9409 @cindex nntp authentification
9410 @findex nntp-send-authinfo
9411 @findex nntp-send-mode-reader
9412 is run after a connection has been made. It can be used to send
9413 commands to the @sc{nntp} server after it has been contacted. By
9414 default it sends the command @code{MODE READER} to the server with the
9415 @code{nntp-send-mode-reader} function. This function should always be
9416 present in this hook.
9418 @item nntp-authinfo-function
9419 @vindex nntp-authinfo-function
9420 @findex nntp-send-authinfo
9421 @vindex nntp-authinfo-file
9422 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
9423 server. The default function is @code{nntp-send-authinfo}, which looks
9424 through your @file{~/.authinfo} (or whatever you've set the
9425 @code{nntp-authinfo-file} variable to) for applicable entries. If none
9426 are found, it will prompt you for a login name and a password. The
9427 format of the @file{~/.authinfo} file is (almost) the same as the
9428 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
9429 manual page, but here are the salient facts:
9433 The file contains one or more line, each of which define one server.
9436 Each line may contain an arbitrary number of token/value pairs. The
9437 valid tokens include @samp{machine}, @samp{login}, @samp{password},
9438 @samp{default} and @samp{force}. (The latter is not a valid
9439 @file{.netrc}/@code{ftp} token, which is the only way the
9440 @file{.authinfo} file format deviates from the @file{.netrc} file
9445 Here's an example file:
9448 machine news.uio.no login larsi password geheimnis
9449 machine nntp.ifi.uio.no login larsi force yes
9452 The token/value pairs may appear in any order; @samp{machine} doesn't
9453 have to be first, for instance.
9455 In this example, both login name and password have been supplied for the
9456 former server, while the latter has only the login name listed, and the
9457 user will be prompted for the password. The latter also has the
9458 @samp{force} tag, which means that the authinfo will be sent to the
9459 @var{nntp} server upon connection; the default (i.e., when there is not
9460 @samp{force} tag) is to not send authinfo to the @var{nntp} server
9461 until the @var{nntp} server asks for it.
9463 You can also add @samp{default} lines that will apply to all servers
9464 that don't have matching @samp{machine} lines.
9470 This will force sending @samp{AUTHINFO} commands to all servers not
9471 previously mentioned.
9473 Remember to not leave the @file{~/.authinfo} file world-readable.
9475 @item nntp-server-action-alist
9476 @vindex nntp-server-action-alist
9477 This is a list of regexps to match on server types and actions to be
9478 taken when matches are made. For instance, if you want Gnus to beep
9479 every time you connect to innd, you could say something like:
9482 (setq nntp-server-action-alist
9486 You probably don't want to do that, though.
9488 The default value is
9491 '(("nntpd 1\\.5\\.11t"
9492 (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
9495 This ensures that Gnus doesn't send the @code{MODE READER} command to
9496 nntpd 1.5.11t, since that command chokes that server, I've been told.
9498 @item nntp-maximum-request
9499 @vindex nntp-maximum-request
9500 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
9501 will collect headers by sending a series of @code{head} commands. To
9502 speed things up, the backend sends lots of these commands without
9503 waiting for reply, and then reads all the replies. This is controlled
9504 by the @code{nntp-maximum-request} variable, and is 400 by default. If
9505 your network is buggy, you should set this to 1.
9507 @item nntp-connection-timeout
9508 @vindex nntp-connection-timeout
9509 If you have lots of foreign @code{nntp} groups that you connect to
9510 regularly, you're sure to have problems with @sc{nntp} servers not
9511 responding properly, or being too loaded to reply within reasonable
9512 time. This is can lead to awkward problems, which can be helped
9513 somewhat by setting @code{nntp-connection-timeout}. This is an integer
9514 that says how many seconds the @code{nntp} backend should wait for a
9515 connection before giving up. If it is @code{nil}, which is the default,
9516 no timeouts are done.
9518 @c @item nntp-command-timeout
9519 @c @vindex nntp-command-timeout
9520 @c @cindex PPP connections
9521 @c @cindex dynamic IP addresses
9522 @c If you're running Gnus on a machine that has a dynamically assigned
9523 @c address, Gnus may become confused. If the address of your machine
9524 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
9525 @c waiting forever for replies from the server. To help with this
9526 @c unfortunate problem, you can set this command to a number. Gnus will
9527 @c then, if it sits waiting for a reply from the server longer than that
9528 @c number of seconds, shut down the connection, start a new one, and resend
9529 @c the command. This should hopefully be transparent to the user. A
9530 @c likely number is 30 seconds.
9532 @c @item nntp-retry-on-break
9533 @c @vindex nntp-retry-on-break
9534 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
9535 @c hangs. This will have much the same effect as the command timeout
9538 @item nntp-server-hook
9539 @vindex nntp-server-hook
9540 This hook is run as the last step when connecting to an @sc{nntp}
9543 @findex nntp-open-rlogin
9544 @findex nntp-open-telnet
9545 @findex nntp-open-network-stream
9546 @item nntp-open-connection-function
9547 @vindex nntp-open-connection-function
9548 This function is used to connect to the remote system. Four pre-made
9549 functions are supplied:
9552 @item nntp-open-network-stream
9553 This is the default, and simply connects to some port or other on the
9556 @item nntp-open-rlogin
9557 Does an @samp{rlogin} on the
9558 remote system, and then does a @samp{telnet} to the @sc{nntp} server
9561 @code{nntp-open-rlogin}-related variables:
9565 @item nntp-rlogin-program
9566 @vindex nntp-rlogin-program
9567 Program used to log in on remote machines. The default is @samp{rsh},
9568 but @samp{ssh} is a popular alternative.
9570 @item nntp-rlogin-parameters
9571 @vindex nntp-rlogin-parameters
9572 This list will be used as the parameter list given to @code{rsh}.
9574 @item nntp-rlogin-user-name
9575 @vindex nntp-rlogin-user-name
9576 User name on the remote system.
9580 @item nntp-open-telnet
9581 Does a @samp{telnet} to the remote system and then another @samp{telnet}
9582 to get to the @sc{nntp} server.
9584 @code{nntp-open-telnet}-related variables:
9587 @item nntp-telnet-command
9588 @vindex nntp-telnet-command
9589 Command used to start @code{telnet}.
9591 @item nntp-telnet-switches
9592 @vindex nntp-telnet-switches
9593 List of strings to be used as the switches to the @code{telnet} command.
9595 @item nntp-telnet-user-name
9596 @vindex nntp-telnet-user-name
9597 User name for log in on the remote system.
9599 @item nntp-telnet-passwd
9600 @vindex nntp-telnet-passwd
9601 Password to use when logging in.
9603 @item nntp-telnet-parameters
9604 @vindex nntp-telnet-parameters
9605 A list of strings executed as a command after logging in
9608 @item nntp-telnet-shell-prompt
9609 @vindex nntp-telnet-shell-prompt
9610 Regexp matching the shell prompt on the remote machine. The default is
9611 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9613 @item nntp-open-telnet-envuser
9614 @vindex nntp-open-telnet-envuser
9615 If non-@code{nil}, the @code{telnet} session (client and server both)
9616 will support the @code{ENVIRON} option and not prompt for login name.
9617 This works for Solaris @code{telnet}, for instance.
9621 @findex nntp-open-ssl-stream
9622 @item nntp-open-ssl-stream
9623 Opens a connection to a server over a @dfn{secure} channel. To use this
9624 you must have SSLay installed
9625 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
9626 @file{ssl.el} (from the W3 distributeion, for instance). You then
9627 define a server as follows:
9630 ;; Type `C-c C-c' after you've finished editing.
9632 ;; "snews" is port 563 and is predefined in our /etc/services
9634 (nntp "snews.bar.com"
9635 (nntp-open-connection-function nntp-open-ssl-stream)
9636 (nntp-port-number "snews")
9637 (nntp-address "snews.bar.com"))
9642 @item nntp-end-of-line
9643 @vindex nntp-end-of-line
9644 String to use as end-of-line marker when talking to the @sc{nntp}
9645 server. This is @samp{\r\n} by default, but should be @samp{\n} when
9646 using @code{rlogin} to talk to the server.
9648 @item nntp-rlogin-user-name
9649 @vindex nntp-rlogin-user-name
9650 User name on the remote system when using the @code{rlogin} connect
9654 @vindex nntp-address
9655 The address of the remote system running the @sc{nntp} server.
9657 @item nntp-port-number
9658 @vindex nntp-port-number
9659 Port number to connect to when using the @code{nntp-open-network-stream}
9662 @item nntp-buggy-select
9663 @vindex nntp-buggy-select
9664 Set this to non-@code{nil} if your select routine is buggy.
9666 @item nntp-nov-is-evil
9667 @vindex nntp-nov-is-evil
9668 If the @sc{nntp} server does not support @sc{nov}, you could set this
9669 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9672 @item nntp-xover-commands
9673 @vindex nntp-xover-commands
9676 List of strings used as commands to fetch @sc{nov} lines from a
9677 server. The default value of this variable is @code{("XOVER"
9681 @vindex nntp-nov-gap
9682 @code{nntp} normally sends just one big request for @sc{nov} lines to
9683 the server. The server responds with one huge list of lines. However,
9684 if you have read articles 2-5000 in the group, and only want to read
9685 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9686 lines that you will not need. This variable says how
9687 big a gap between two consecutive articles is allowed to be before the
9688 @code{XOVER} request is split into several request. Note that if your
9689 network is fast, setting this variable to a really small number means
9690 that fetching will probably be slower. If this variable is @code{nil},
9691 @code{nntp} will never split requests. The default is 5.
9693 @item nntp-prepare-server-hook
9694 @vindex nntp-prepare-server-hook
9695 A hook run before attempting to connect to an @sc{nntp} server.
9697 @item nntp-warn-about-losing-connection
9698 @vindex nntp-warn-about-losing-connection
9699 If this variable is non-@code{nil}, some noise will be made when a
9700 server closes connection.
9702 @item nntp-record-commands
9703 @vindex nntp-record-commands
9704 If non-@code{nil}, @code{nntp} will log all commands it sends to the
9705 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
9706 buffer. This is useful if you are debugging a Gnus/@sc{nntp} connection
9707 that doesn't seem to work.
9713 @subsection News Spool
9717 Subscribing to a foreign group from the local spool is extremely easy,
9718 and might be useful, for instance, to speed up reading groups that
9719 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9722 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9723 anything else) as the address.
9725 If you have access to a local spool, you should probably use that as the
9726 native select method (@pxref{Finding the News}). It is normally faster
9727 than using an @code{nntp} select method, but might not be. It depends.
9728 You just have to try to find out what's best at your site.
9732 @item nnspool-inews-program
9733 @vindex nnspool-inews-program
9734 Program used to post an article.
9736 @item nnspool-inews-switches
9737 @vindex nnspool-inews-switches
9738 Parameters given to the inews program when posting an article.
9740 @item nnspool-spool-directory
9741 @vindex nnspool-spool-directory
9742 Where @code{nnspool} looks for the articles. This is normally
9743 @file{/usr/spool/news/}.
9745 @item nnspool-nov-directory
9746 @vindex nnspool-nov-directory
9747 Where @code{nnspool} will look for @sc{nov} files. This is normally
9748 @file{/usr/spool/news/over.view/}.
9750 @item nnspool-lib-dir
9751 @vindex nnspool-lib-dir
9752 Where the news lib dir is (@file{/usr/lib/news/} by default).
9754 @item nnspool-active-file
9755 @vindex nnspool-active-file
9756 The path to the active file.
9758 @item nnspool-newsgroups-file
9759 @vindex nnspool-newsgroups-file
9760 The path to the group descriptions file.
9762 @item nnspool-history-file
9763 @vindex nnspool-history-file
9764 The path to the news history file.
9766 @item nnspool-active-times-file
9767 @vindex nnspool-active-times-file
9768 The path to the active date file.
9770 @item nnspool-nov-is-evil
9771 @vindex nnspool-nov-is-evil
9772 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9775 @item nnspool-sift-nov-with-sed
9776 @vindex nnspool-sift-nov-with-sed
9778 If non-@code{nil}, which is the default, use @code{sed} to get the
9779 relevant portion from the overview file. If nil, @code{nnspool} will
9780 load the entire file into a buffer and process it there.
9786 @section Getting Mail
9787 @cindex reading mail
9790 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9794 * Getting Started Reading Mail:: A simple cookbook example.
9795 * Splitting Mail:: How to create mail groups.
9796 * Mail Sources:: How to tell Gnus where to get mail from.
9797 * Mail Backend Variables:: Variables for customizing mail handling.
9798 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
9799 * Incorporating Old Mail:: What about the old mail you have?
9800 * Expiring Mail:: Getting rid of unwanted mail.
9801 * Washing Mail:: Removing gruft from the mail you get.
9802 * Duplicates:: Dealing with duplicated mail.
9803 * Not Reading Mail:: Using mail backends for reading other files.
9804 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
9808 @node Getting Started Reading Mail
9809 @subsection Getting Started Reading Mail
9811 It's quite easy to use Gnus to read your new mail. You just plonk the
9812 mail backend of your choice into @code{gnus-secondary-select-methods},
9813 and things will happen automatically.
9815 For instance, if you want to use @code{nnml} (which is a "one file per
9816 mail" backend), you could put the following in your @file{.gnus} file:
9819 (setq gnus-secondary-select-methods
9820 '((nnml "private")))
9823 Now, the next time you start Gnus, this backend will be queried for new
9824 articles, and it will move all the messages in your spool file to its
9825 directory, which is @code{~/Mail/} by default. The new group that will
9826 be created (@samp{mail.misc}) will be subscribed, and you can read it
9827 like any other group.
9829 You will probably want to split the mail into several groups, though:
9832 (setq nnmail-split-methods
9833 '(("junk" "^From:.*Lars Ingebrigtsen")
9834 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
9838 This will result in three new @code{nnml} mail groups being created:
9839 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
9840 mail that doesn't fit into the first two groups will be placed in the
9843 This should be sufficient for reading mail with Gnus. You might want to
9844 give the other sections in this part of the manual a perusal, though.
9845 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
9848 @node Splitting Mail
9849 @subsection Splitting Mail
9850 @cindex splitting mail
9851 @cindex mail splitting
9853 @vindex nnmail-split-methods
9854 The @code{nnmail-split-methods} variable says how the incoming mail is
9855 to be split into groups.
9858 (setq nnmail-split-methods
9859 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
9860 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
9864 This variable is a list of lists, where the first element of each of
9865 these lists is the name of the mail group (they do not have to be called
9866 something beginning with @samp{mail}, by the way), and the second
9867 element is a regular expression used on the header of each mail to
9868 determine if it belongs in this mail group. The first string may
9869 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
9870 insert sub-expressions from the matched text. For instance:
9873 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
9876 The second element can also be a function. In that case, it will be
9877 called narrowed to the headers with the first element of the rule as the
9878 argument. It should return a non-@code{nil} value if it thinks that the
9879 mail belongs in that group.
9881 The last of these groups should always be a general one, and the regular
9882 expression should @emph{always} be @samp{} so that it matches any mails
9883 that haven't been matched by any of the other regexps. (These rules are
9884 processed from the beginning of the alist toward the end. The first
9885 rule to make a match will "win", unless you have crossposting enabled.
9886 In that case, all matching rules will "win".)
9888 If you like to tinker with this yourself, you can set this variable to a
9889 function of your choice. This function will be called without any
9890 arguments in a buffer narrowed to the headers of an incoming mail
9891 message. The function should return a list of group names that it
9892 thinks should carry this mail message.
9894 Note that the mail backends are free to maul the poor, innocent,
9895 incoming headers all they want to. They all add @code{Lines} headers;
9896 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
9897 @code{From<SPACE>} line to something else.
9899 @vindex nnmail-crosspost
9900 The mail backends all support cross-posting. If several regexps match,
9901 the mail will be ``cross-posted'' to all those groups.
9902 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
9903 that no articles are crossposted to the general (@samp{}) group.
9905 @vindex nnmail-crosspost-link-function
9908 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
9909 the crossposted articles. However, not all file systems support hard
9910 links. If that's the case for you, set
9911 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
9912 variable is @code{add-name-to-file} by default.)
9914 @findex nnmail-split-header-length-limit
9915 Header lines may be arbitrarily long. However, the longer a line is,
9916 the longer it takes to match them. Very long lines may lead to Gnus
9917 taking forever to split the mail, so Gnus excludes lines that are longer
9918 than @code{nnmail-split-header-length-limit} (which defaults to 1024).
9920 @kindex M-x nnmail-split-history
9921 @kindex nnmail-split-history
9922 If you wish to see where the previous mail split put the messages, you
9923 can use the @kbd{M-x nnmail-split-history} command.
9925 Gnus gives you all the opportunity you could possibly want for shooting
9926 yourself in the foot. Let's say you create a group that will contain
9927 all the mail you get from your boss. And then you accidentally
9928 unsubscribe from the group. Gnus will still put all the mail from your
9929 boss in the unsubscribed group, and so, when your boss mails you ``Have
9930 that report ready by Monday or you're fired!'', you'll never see it and,
9931 come Tuesday, you'll still believe that you're gainfully employed while
9932 you really should be out collecting empty bottles to save up for next
9937 @subsection Mail Sources
9939 Mail can be gotten from many different sources---the mail spool, from a
9940 POP mail server, or from a procmail directory, for instance.
9943 * Mail Source Specifiers:: How to specify what a mail source is.
9944 * Mail Source Customization:: Some variables that influence things.
9945 * Fetching Mail:: Using the mail source specifiers.
9949 @node Mail Source Specifiers
9950 @subsubsection Mail Source Specifiers
9957 You tell Gnus how to fetch mail by creating a @dfn{mail source
9963 (pop :server "pop3.mailserver.com" :user "myname")
9966 As can be observed, a mail source specifier is a list where the first
9967 element is a @dfn{mail source type}, followed by an arbitrary number of
9968 @dfn{keywords}. Keywords that are not explicitly specified are given
9971 The following mail source types are available:
9975 Get mail from a single file; typically from the mail spool.
9981 The path of the file. Defaults to the value of the @code{MAIL}
9982 environment variable or @file{/usr/mail/spool/user-name}.
9985 An example file mail source:
9988 (file :path "/usr/spool/mail/user-name")
9991 Or using the default path:
9998 Get mail from several files in a directory. This is typically used when
9999 you have procmail split the incoming mail into several files.
10005 The path of the directory where the files are. There is no default
10009 Only files ending with this suffix are used. The default is
10013 Only files that have this predicate return non-@code{nil} are returned.
10014 The default is @code{identity}. This is used as an additional
10015 filter---only files that have the right suffix @emph{and} satisfy this
10016 predicate are considered.
10020 An example directory mail source:
10023 (directory :path "/home/user-name/procmail-dir/"
10028 Get mail from a POP server.
10034 The name of the POP server. The default is taken from the
10035 @code{MAILHOST} environment variable.
10038 The port number of the POP server. The default is @samp{pop3}.
10041 The user name to give to the POP server. The default is the login
10045 The password to give to the POP server. If not specified, the user is
10049 The program to use to fetch mail from the POP server. This is should be
10050 a @code{format}-like string. Here's an example:
10053 fetchmail %u@@%s -P %p %t
10056 The valid format specifier characters are:
10060 The name of the file the mail is to be moved to. This must always be
10061 included in this string.
10064 The name of the server.
10067 The port number of the server.
10070 The user name to use.
10073 The password to use.
10076 The values used for these specs are taken from the values you give the
10077 corresponding keywords.
10080 A script to be run before fetching the mail. The syntax is the same as
10081 the @code{:program} keyword. This can also be a function to be run.
10084 A script to be run after fetching the mail. The syntax is the same as
10085 the @code{:program} keyword. This can also be a function to be run.
10088 The function to use to fetch mail from the POP server. The function is
10089 called with one parameter---the name of the file where the mail should
10092 @item :authentication
10093 This can be either the symbol @code{password} or the symbol @code{apop}
10094 and says what authentication scheme to use. The default is
10099 If the @code{:program} and @code{:function} keywords aren't specified,
10100 @code{pop3-movemail} will be used.
10102 Here are some examples. Fetch from the default POP server, using the
10103 default user name, and default fetcher:
10109 Fetch from a named server with a named user and password:
10112 (pop :server "my.pop.server"
10113 :user "user-name" :password "secret")
10116 Use @samp{movemail} to move the mail:
10119 (pop :program "movemail po:%u %t %p")
10123 Get mail from a maildir. This is a type of mailbox currently only
10124 supported by qmail, where each file in a special directory contains
10131 The path of the directory where the mails are stored. The default is
10132 @samp{~/Maildir/new}.
10134 If you sometimes look at your mail through a pop3 daemon before fetching
10135 them with Gnus, you may also have to fetch your mails from the
10136 @code{cur} directory inside the maildir, like in the following example.
10140 An example maildir mail source:
10143 (maildir :path "/home/user-name/Maildir/cur")
10149 @node Mail Source Customization
10150 @subsubsection Mail Source Customization
10152 The following is a list of variables that influence how the mail is
10153 fetched. You would normally not need to set or change any of these
10157 @item mail-source-movemail-program
10158 @vindex mail-source-movemail-program
10159 A command to be executed to move mail from the inbox. The default is
10162 This can also be a function. In that case, the function will be
10163 called with two parameters -- the name of the INBOX file, and the file
10166 @item mail-source-movemail-args
10167 @vindex mail-source-movemail-args
10168 Extra arguments to give to the command described above.
10170 @item mail-source-crash-box
10171 @vindex mail-source-crash-box
10172 File where mail will be stored while processing it. The default is
10173 @file{~/.emacs-mail-crash-box}.
10175 @item mail-source-delete-incoming
10176 @vindex mail-source-delete-incoming
10177 If non-@code{nil}, delete incoming files after handling them.
10179 @item mail-source-directory
10180 @vindex mail-source-directory
10181 Directory where files (if any) will be stored. The default is
10182 @file{~/Mail/}. At present, the only thing this is used for is to say
10183 where the incoming files will be stored if the previous variable is
10186 @item mail-source-default-file-modes
10187 @vindex mail-source-default-file-modes
10188 All new mail files will get this file mode. The default is 384.
10193 @node Fetching Mail
10194 @subsubsection Fetching Mail
10196 The way to actually tell Gnus where to get new mail from is to set
10197 @code{nnmail-spool-file} to a list of mail source specifiers
10198 (@pxref{Mail Source Specifiers}).
10200 If this variable is @code{nil}, the mail backends will never attempt to
10201 fetch mail by themselves.
10203 If you want to fetch mail both from your local spool as well as a POP
10204 mail server, you'd say something like:
10207 (setq nnmail-spool-file
10209 (pop :server "pop3.mail.server"
10210 :password "secret")))
10213 Or, if you don't want to use any of the keyword defaults:
10216 (setq nnmail-spool-file
10217 '((file :path "/var/spool/mail/user-name")
10218 (pop :server "pop3.mail.server"
10221 :password "secret")))
10225 When you use a mail backend, Gnus will slurp all your mail from your
10226 inbox and plonk it down in your home directory. Gnus doesn't move any
10227 mail if you're not using a mail backend---you have to do a lot of magic
10228 invocations first. At the time when you have finished drawing the
10229 pentagram, lightened the candles, and sacrificed the goat, you really
10230 shouldn't be too surprised when Gnus moves your mail.
10234 @node Mail Backend Variables
10235 @subsection Mail Backend Variables
10237 These variables are (for the most part) pertinent to all the various
10241 @vindex nnmail-read-incoming-hook
10242 @item nnmail-read-incoming-hook
10243 The mail backends all call this hook after reading new mail. You can
10244 use this hook to notify any mail watch programs, if you want to.
10246 @vindex nnmail-split-hook
10247 @item nnmail-split-hook
10248 @findex article-decode-encoded-words
10249 @findex RFC1522 decoding
10250 @findex RFC2047 decoding
10251 Hook run in the buffer where the mail headers of each message is kept
10252 just before the splitting based on these headers is done. The hook is
10253 free to modify the buffer contents in any way it sees fit---the buffer
10254 is discarded after the splitting has been done, and no changes performed
10255 in the buffer will show up in any files.
10256 @code{gnus-article-decode-encoded-words} is one likely function to add
10259 @vindex nnmail-pre-get-new-mail-hook
10260 @vindex nnmail-post-get-new-mail-hook
10261 @item nnmail-pre-get-new-mail-hook
10262 @itemx nnmail-post-get-new-mail-hook
10263 These are two useful hooks executed when treating new incoming
10264 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
10265 starting to handle the new mail) and
10266 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
10267 is done). Here's and example of using these two hooks to change the
10268 default file modes the new mail files get:
10271 (add-hook 'gnus-pre-get-new-mail-hook
10272 (lambda () (set-default-file-modes 511)))
10274 (add-hook 'gnus-post-get-new-mail-hook
10275 (lambda () (set-default-file-modes 551)))
10278 @item nnmail-use-long-file-names
10279 @vindex nnmail-use-long-file-names
10280 If non-@code{nil}, the mail backends will use long file and directory
10281 names. Groups like @samp{mail.misc} will end up in directories
10282 (assuming use of @code{nnml} backend) or files (assuming use of
10283 @code{nnfolder} backend) like @file{mail.misc}. If it is @code{nil},
10284 the same group will end up in @file{mail/misc}.
10286 @item nnmail-delete-file-function
10287 @vindex nnmail-delete-file-function
10288 @findex delete-file
10289 Function called to delete files. It is @code{delete-file} by default.
10291 @item nnmail-cache-accepted-message-ids
10292 @vindex nnmail-cache-accepted-message-ids
10293 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
10294 the backend (via @code{Gcc}, for instance) into the mail duplication
10295 discovery cache. The default is @code{nil}.
10300 @node Fancy Mail Splitting
10301 @subsection Fancy Mail Splitting
10302 @cindex mail splitting
10303 @cindex fancy mail splitting
10305 @vindex nnmail-split-fancy
10306 @findex nnmail-split-fancy
10307 If the rather simple, standard method for specifying how to split mail
10308 doesn't allow you to do what you want, you can set
10309 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
10310 play with the @code{nnmail-split-fancy} variable.
10312 Let's look at an example value of this variable first:
10315 ;; Messages from the mailer daemon are not crossposted to any of
10316 ;; the ordinary groups. Warnings are put in a separate group
10317 ;; from real errors.
10318 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
10320 ;; Non-error messages are crossposted to all relevant
10321 ;; groups, but we don't crosspost between the group for the
10322 ;; (ding) list and the group for other (ding) related mail.
10323 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
10324 ("subject" "ding" "ding.misc"))
10325 ;; Other mailing lists...
10326 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
10327 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
10329 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
10330 ;; Unmatched mail goes to the catch all group.
10334 This variable has the format of a @dfn{split}. A split is a (possibly)
10335 recursive structure where each split may contain other splits. Here are
10336 the five possible split syntaxes:
10341 @samp{group}: If the split is a string, that will be taken as a group
10342 name. Normal regexp match expansion will be done. See below for
10346 @var{(FIELD VALUE SPLIT)}: If the split is a list, the first element of
10347 which is a string, then store the message as specified by SPLIT, if
10348 header FIELD (a regexp) contains VALUE (also a regexp).
10351 @var{(| SPLIT...)}: If the split is a list, and the first element is
10352 @code{|} (vertical bar), then process each SPLIT until one of them
10353 matches. A SPLIT is said to match if it will cause the mail message to
10354 be stored in one or more groups.
10357 @var{(& SPLIT...)}: If the split is a list, and the first element is
10358 @code{&}, then process all SPLITs in the list.
10361 @code{junk}: If the split is the symbol @code{junk}, then don't save
10362 this message. Use with extreme caution.
10365 @var{(: function arg1 arg2 ...)}: If the split is a list, and the first
10366 element is @code{:}, then the second element will be called as a
10367 function with @var{args} given as arguments. The function should return
10371 @var{(! FUNC SPLIT)}: If the split is a list, and the first element
10372 is @code{!}, then SPLIT will be processed, and FUNC will be called as a
10373 function with the result of SPLIT as argument. FUNC should return a split.
10376 @code{nil}: If the split is @code{nil}, it is ignored.
10380 In these splits, @var{FIELD} must match a complete field name.
10381 @var{VALUE} must match a complete word according to the fundamental mode
10382 syntax table. You can use @code{.*} in the regexps to match partial
10383 field names or words. In other words, all @var{VALUE}'s are wrapped in
10384 @samp{\<} and @samp{\>} pairs.
10386 @vindex nnmail-split-abbrev-alist
10387 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
10388 are expanded as specified by the variable
10389 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
10390 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
10393 @vindex nnmail-split-fancy-syntax-table
10394 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
10395 when all this splitting is performed.
10397 If you want to have Gnus create groups dynamically based on some
10398 information in the headers (i.e., do @code{replace-match}-like
10399 substitutions in the group names), you can say things like:
10402 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
10405 If the string contains the element @samp{\&}, then the previously
10406 matched string will be substituted. Similarly, the elements @samp{\\1}
10407 up to @samp{\\9} will be substituted with the text matched by the
10408 groupings 1 through 9.
10411 @node Incorporating Old Mail
10412 @subsection Incorporating Old Mail
10414 Most people have lots of old mail stored in various file formats. If
10415 you have set up Gnus to read mail using one of the spiffy Gnus mail
10416 backends, you'll probably wish to have that old mail incorporated into
10419 Doing so can be quite easy.
10421 To take an example: You're reading mail using @code{nnml}
10422 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
10423 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
10424 file filled with important, but old, mail. You want to move it into
10425 your @code{nnml} groups.
10431 Go to the group buffer.
10434 Type `G f' and give the path to the mbox file when prompted to create an
10435 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
10438 Type `SPACE' to enter the newly created group.
10441 Type `M P b' to process-mark all articles in this group's buffer
10442 (@pxref{Setting Process Marks}).
10445 Type `B r' to respool all the process-marked articles, and answer
10446 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
10449 All the mail messages in the mbox file will now also be spread out over
10450 all your @code{nnml} groups. Try entering them and check whether things
10451 have gone without a glitch. If things look ok, you may consider
10452 deleting the mbox file, but I wouldn't do that unless I was absolutely
10453 sure that all the mail has ended up where it should be.
10455 Respooling is also a handy thing to do if you're switching from one mail
10456 backend to another. Just respool all the mail in the old mail groups
10457 using the new mail backend.
10460 @node Expiring Mail
10461 @subsection Expiring Mail
10462 @cindex article expiry
10464 Traditional mail readers have a tendency to remove mail articles when
10465 you mark them as read, in some way. Gnus takes a fundamentally
10466 different approach to mail reading.
10468 Gnus basically considers mail just to be news that has been received in
10469 a rather peculiar manner. It does not think that it has the power to
10470 actually change the mail, or delete any mail messages. If you enter a
10471 mail group, and mark articles as ``read'', or kill them in some other
10472 fashion, the mail articles will still exist on the system. I repeat:
10473 Gnus will not delete your old, read mail. Unless you ask it to, of
10476 To make Gnus get rid of your unwanted mail, you have to mark the
10477 articles as @dfn{expirable}. This does not mean that the articles will
10478 disappear right away, however. In general, a mail article will be
10479 deleted from your system if, 1) it is marked as expirable, AND 2) it is
10480 more than one week old. If you do not mark an article as expirable, it
10481 will remain on your system until hell freezes over. This bears
10482 repeating one more time, with some spurious capitalizations: IF you do
10483 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
10485 @vindex gnus-auto-expirable-newsgroups
10486 You do not have to mark articles as expirable by hand. Groups that
10487 match the regular expression @code{gnus-auto-expirable-newsgroups} will
10488 have all articles that you read marked as expirable automatically. All
10489 articles marked as expirable have an @samp{E} in the first
10490 column in the summary buffer.
10492 By default, if you have auto expiry switched on, Gnus will mark all the
10493 articles you read as expirable, no matter if they were read or unread
10494 before. To avoid having articles marked as read marked as expirable
10495 automatically, you can put something like the following in your
10498 @vindex gnus-mark-article-hook
10500 (remove-hook 'gnus-mark-article-hook
10501 'gnus-summary-mark-read-and-unread-as-read)
10502 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
10505 Note that making a group auto-expirable doesn't mean that all read
10506 articles are expired---only the articles marked as expirable
10507 will be expired. Also note that using the @kbd{d} command won't make
10508 groups expirable---only semi-automatic marking of articles as read will
10509 mark the articles as expirable in auto-expirable groups.
10511 Let's say you subscribe to a couple of mailing lists, and you want the
10512 articles you have read to disappear after a while:
10515 (setq gnus-auto-expirable-newsgroups
10516 "mail.nonsense-list\\|mail.nice-list")
10519 Another way to have auto-expiry happen is to have the element
10520 @code{auto-expire} in the group parameters of the group.
10522 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
10523 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
10524 don't really mix very well.
10526 @vindex nnmail-expiry-wait
10527 The @code{nnmail-expiry-wait} variable supplies the default time an
10528 expirable article has to live. Gnus starts counting days from when the
10529 message @emph{arrived}, not from when it was sent. The default is seven
10532 Gnus also supplies a function that lets you fine-tune how long articles
10533 are to live, based on what group they are in. Let's say you want to
10534 have one month expiry period in the @samp{mail.private} group, a one day
10535 expiry period in the @samp{mail.junk} group, and a six day expiry period
10538 @vindex nnmail-expiry-wait-function
10540 (setq nnmail-expiry-wait-function
10542 (cond ((string= group "mail.private")
10544 ((string= group "mail.junk")
10546 ((string= group "important")
10552 The group names this function is fed are ``unadorned'' group
10553 names---no @samp{nnml:} prefixes and the like.
10555 The @code{nnmail-expiry-wait} variable and
10556 @code{nnmail-expiry-wait-function} function can either be a number (not
10557 necessarily an integer) or one of the symbols @code{immediate} or
10560 You can also use the @code{expiry-wait} group parameter to selectively
10561 change the expiry period (@pxref{Group Parameters}).
10563 @vindex nnmail-keep-last-article
10564 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
10565 expire the final article in a mail newsgroup. This is to make life
10566 easier for procmail users.
10568 @vindex gnus-total-expirable-newsgroups
10569 By the way: That line up there, about Gnus never expiring non-expirable
10570 articles, is a lie. If you put @code{total-expire} in the group
10571 parameters, articles will not be marked as expirable, but all read
10572 articles will be put through the expiry process. Use with extreme
10573 caution. Even more dangerous is the
10574 @code{gnus-total-expirable-newsgroups} variable. All groups that match
10575 this regexp will have all read articles put through the expiry process,
10576 which means that @emph{all} old mail articles in the groups in question
10577 will be deleted after a while. Use with extreme caution, and don't come
10578 crying to me when you discover that the regexp you used matched the
10579 wrong group and all your important mail has disappeared. Be a
10580 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
10583 Most people make most of their mail groups total-expirable, though.
10585 @vindex gnus-inhibit-user-auto-expire
10586 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
10587 commands will not mark an article as expirable, even if the group has
10588 auto-expire turned on.
10592 @subsection Washing Mail
10593 @cindex mail washing
10594 @cindex list server brain damage
10595 @cindex incoming mail treatment
10597 Mailers and list servers are notorious for doing all sorts of really,
10598 really stupid things with mail. ``Hey, RFC822 doesn't explicitly
10599 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
10600 end of all lines passing through our server, so let's do that!!!!1!''
10601 Yes, but RFC822 wasn't designed to be read by morons. Things that were
10602 considered to be self-evident were not discussed. So. Here we are.
10604 Case in point: The German version of Microsoft Exchange adds @samp{AW:
10605 } to the subjects of replies instead of @samp{Re: }. I could pretend to
10606 be shocked and dismayed by this, but I haven't got the energy. It is to
10609 Gnus provides a plethora of functions for washing articles while
10610 displaying them, but it might be nicer to do the filtering before
10611 storing the mail to disc. For that purpose, we have three hooks and
10612 various functions that can be put in these hooks.
10615 @item nnmail-prepare-incoming-hook
10616 @vindex nnmail-prepare-incoming-hook
10617 This hook is called before doing anything with the mail and is meant for
10618 grand, sweeping gestures. It is called in a buffer that contains all
10619 the new, incoming mail. Functions to be used include:
10622 @item nnheader-ms-strip-cr
10623 @findex nnheader-ms-strip-cr
10624 Remove trailing carriage returns from each line. This is default on
10625 Emacs running on MS machines.
10629 @item nnmail-prepare-incoming-header-hook
10630 @vindex nnmail-prepare-incoming-header-hook
10631 This hook is called narrowed to each header. It can be used when
10632 cleaning up the headers. Functions that can be used include:
10635 @item nnmail-remove-leading-whitespace
10636 @findex nnmail-remove-leading-whitespace
10637 Clear leading white space that ``helpful'' listservs have added to the
10638 headers to make them look nice. Aaah.
10640 @item nnmail-remove-list-identifiers
10641 @findex nnmail-remove-list-identifiers
10642 Some list servers add an identifier---for example, @samp{(idm)}---to the
10643 beginning of all @code{Subject} headers. I'm sure that's nice for
10644 people who use stone age mail readers. This function will remove
10645 strings that match the @code{nnmail-list-identifiers} regexp, which can
10646 also be a list of regexp.
10648 For instance, if you want to remove the @samp{(idm)} and the
10649 @samp{nagnagnag} identifiers:
10652 (setq nnmail-list-identifiers
10653 '("(idm)" "nagnagnag"))
10656 @item nnmail-remove-tabs
10657 @findex nnmail-remove-tabs
10658 Translate all @samp{TAB} characters into @samp{SPACE} characters.
10660 @item nnmail-fix-eudora-headers
10661 @findex nnmail-fix-eudora-headers
10663 Eudora produces broken @code{References} headers, but OK
10664 @code{In-Reply-To} headers. This function will get rid of the
10665 @code{References} headers.
10669 @item nnmail-prepare-incoming-message-hook
10670 @vindex nnmail-prepare-incoming-message-hook
10671 This hook is called narrowed to each message. Functions to be used
10675 @item article-de-quoted-unreadable
10676 @findex article-de-quoted-unreadable
10677 Decode Quoted Readable encoding.
10684 @subsection Duplicates
10686 @vindex nnmail-treat-duplicates
10687 @vindex nnmail-message-id-cache-length
10688 @vindex nnmail-message-id-cache-file
10689 @cindex duplicate mails
10690 If you are a member of a couple of mailing lists, you will sometimes
10691 receive two copies of the same mail. This can be quite annoying, so
10692 @code{nnmail} checks for and treats any duplicates it might find. To do
10693 this, it keeps a cache of old @code{Message-ID}s---
10694 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
10695 default. The approximate maximum number of @code{Message-ID}s stored
10696 there is controlled by the @code{nnmail-message-id-cache-length}
10697 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
10698 stored.) If all this sounds scary to you, you can set
10699 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
10700 default), and @code{nnmail} won't delete duplicate mails. Instead it
10701 will insert a warning into the head of the mail saying that it thinks
10702 that this is a duplicate of a different message.
10704 This variable can also be a function. If that's the case, the function
10705 will be called from a buffer narrowed to the message in question with
10706 the @code{Message-ID} as a parameter. The function must return either
10707 @code{nil}, @code{warn}, or @code{delete}.
10709 You can turn this feature off completely by setting the variable to
10712 If you want all the duplicate mails to be put into a special
10713 @dfn{duplicates} group, you could do that using the normal mail split
10717 (setq nnmail-split-fancy
10718 '(| ;; Messages duplicates go to a separate group.
10719 ("gnus-warning" "duplication of message" "duplicate")
10720 ;; Message from daemons, postmaster, and the like to another.
10721 (any mail "mail.misc")
10728 (setq nnmail-split-methods
10729 '(("duplicates" "^Gnus-Warning:")
10734 Here's a neat feature: If you know that the recipient reads her mail
10735 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
10736 @code{delete}, you can send her as many insults as you like, just by
10737 using a @code{Message-ID} of a mail that you know that she's already
10738 received. Think of all the fun! She'll never see any of it! Whee!
10741 @node Not Reading Mail
10742 @subsection Not Reading Mail
10744 If you start using any of the mail backends, they have the annoying
10745 habit of assuming that you want to read mail with them. This might not
10746 be unreasonable, but it might not be what you want.
10748 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
10749 will ever attempt to read incoming mail, which should help.
10751 @vindex nnbabyl-get-new-mail
10752 @vindex nnmbox-get-new-mail
10753 @vindex nnml-get-new-mail
10754 @vindex nnmh-get-new-mail
10755 @vindex nnfolder-get-new-mail
10756 This might be too much, if, for instance, you are reading mail quite
10757 happily with @code{nnml} and just want to peek at some old @sc{rmail}
10758 file you have stashed away with @code{nnbabyl}. All backends have
10759 variables called backend-@code{get-new-mail}. If you want to disable
10760 the @code{nnbabyl} mail reading, you edit the virtual server for the
10761 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
10763 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
10764 narrowed to the article to be saved before saving it when reading
10768 @node Choosing a Mail Backend
10769 @subsection Choosing a Mail Backend
10771 Gnus will read the mail spool when you activate a mail group. The mail
10772 file is first copied to your home directory. What happens after that
10773 depends on what format you want to store your mail in.
10776 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
10777 * Rmail Babyl:: Emacs programs use the rmail babyl format.
10778 * Mail Spool:: Store your mail in a private spool?
10779 * MH Spool:: An mhspool-like backend.
10780 * Mail Folders:: Having one file for each group.
10784 @node Unix Mail Box
10785 @subsubsection Unix Mail Box
10787 @cindex unix mail box
10789 @vindex nnmbox-active-file
10790 @vindex nnmbox-mbox-file
10791 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
10792 mail. @code{nnmbox} will add extra headers to each mail article to say
10793 which group it belongs in.
10795 Virtual server settings:
10798 @item nnmbox-mbox-file
10799 @vindex nnmbox-mbox-file
10800 The name of the mail box in the user's home directory.
10802 @item nnmbox-active-file
10803 @vindex nnmbox-active-file
10804 The name of the active file for the mail box.
10806 @item nnmbox-get-new-mail
10807 @vindex nnmbox-get-new-mail
10808 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
10814 @subsubsection Rmail Babyl
10818 @vindex nnbabyl-active-file
10819 @vindex nnbabyl-mbox-file
10820 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
10821 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
10822 article to say which group it belongs in.
10824 Virtual server settings:
10827 @item nnbabyl-mbox-file
10828 @vindex nnbabyl-mbox-file
10829 The name of the rmail mbox file.
10831 @item nnbabyl-active-file
10832 @vindex nnbabyl-active-file
10833 The name of the active file for the rmail box.
10835 @item nnbabyl-get-new-mail
10836 @vindex nnbabyl-get-new-mail
10837 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
10842 @subsubsection Mail Spool
10844 @cindex mail @sc{nov} spool
10846 The @dfn{nnml} spool mail format isn't compatible with any other known
10847 format. It should be used with some caution.
10849 @vindex nnml-directory
10850 If you use this backend, Gnus will split all incoming mail into files,
10851 one file for each mail, and put the articles into the corresponding
10852 directories under the directory specified by the @code{nnml-directory}
10853 variable. The default value is @file{~/Mail/}.
10855 You do not have to create any directories beforehand; Gnus will take
10858 If you have a strict limit as to how many files you are allowed to store
10859 in your account, you should not use this backend. As each mail gets its
10860 own file, you might very well occupy thousands of inodes within a few
10861 weeks. If this is no problem for you, and it isn't a problem for you
10862 having your friendly systems administrator walking around, madly,
10863 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
10864 know that this is probably the fastest format to use. You do not have
10865 to trudge through a big mbox file just to read your new mail.
10867 @code{nnml} is probably the slowest backend when it comes to article
10868 splitting. It has to create lots of files, and it also generates
10869 @sc{nov} databases for the incoming mails. This makes it the fastest
10870 backend when it comes to reading mail.
10872 Virtual server settings:
10875 @item nnml-directory
10876 @vindex nnml-directory
10877 All @code{nnml} directories will be placed under this directory.
10879 @item nnml-active-file
10880 @vindex nnml-active-file
10881 The active file for the @code{nnml} server.
10883 @item nnml-newsgroups-file
10884 @vindex nnml-newsgroups-file
10885 The @code{nnml} group descriptions file. @xref{Newsgroups File
10888 @item nnml-get-new-mail
10889 @vindex nnml-get-new-mail
10890 If non-@code{nil}, @code{nnml} will read incoming mail.
10892 @item nnml-nov-is-evil
10893 @vindex nnml-nov-is-evil
10894 If non-@code{nil}, this backend will ignore any @sc{nov} files.
10896 @item nnml-nov-file-name
10897 @vindex nnml-nov-file-name
10898 The name of the @sc{nov} files. The default is @file{.overview}.
10900 @item nnml-prepare-save-mail-hook
10901 @vindex nnml-prepare-save-mail-hook
10902 Hook run narrowed to an article before saving.
10906 @findex nnml-generate-nov-databases
10907 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
10908 you can do a complete update by typing @kbd{M-x
10909 nnml-generate-nov-databases}. This command will trawl through the
10910 entire @code{nnml} hierarchy, looking at each and every article, so it
10911 might take a while to complete. A better interface to this
10912 functionality can be found in the server buffer (@pxref{Server
10917 @subsubsection MH Spool
10919 @cindex mh-e mail spool
10921 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
10922 @sc{nov} databases and it doesn't keep an active file. This makes
10923 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
10924 makes it easier to write procmail scripts for.
10926 Virtual server settings:
10929 @item nnmh-directory
10930 @vindex nnmh-directory
10931 All @code{nnmh} directories will be located under this directory.
10933 @item nnmh-get-new-mail
10934 @vindex nnmh-get-new-mail
10935 If non-@code{nil}, @code{nnmh} will read incoming mail.
10938 @vindex nnmh-be-safe
10939 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
10940 sure that the articles in the folder are actually what Gnus thinks they
10941 are. It will check date stamps and stat everything in sight, so
10942 setting this to @code{t} will mean a serious slow-down. If you never
10943 use anything but Gnus to read the @code{nnmh} articles, you do not have
10944 to set this variable to @code{t}.
10949 @subsubsection Mail Folders
10951 @cindex mbox folders
10952 @cindex mail folders
10954 @code{nnfolder} is a backend for storing each mail group in a separate
10955 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
10956 will add extra headers to keep track of article numbers and arrival
10959 Virtual server settings:
10962 @item nnfolder-directory
10963 @vindex nnfolder-directory
10964 All the @code{nnfolder} mail boxes will be stored under this directory.
10966 @item nnfolder-active-file
10967 @vindex nnfolder-active-file
10968 The name of the active file.
10970 @item nnfolder-newsgroups-file
10971 @vindex nnfolder-newsgroups-file
10972 The name of the group descriptions file. @xref{Newsgroups File Format}.
10974 @item nnfolder-get-new-mail
10975 @vindex nnfolder-get-new-mail
10976 If non-@code{nil}, @code{nnfolder} will read incoming mail.
10978 @item nnfolder-save-buffer-hook
10979 @vindex nnfolder-save-buffer-hook
10980 @cindex backup files
10981 Hook run before saving the folders. Note that Emacs does the normal
10982 backup renaming of files even with the @code{nnfolder} buffers. If you
10983 wish to switch this off, you could say something like the following in
10984 your @file{.emacs} file:
10987 (defun turn-off-backup ()
10988 (set (make-local-variable 'backup-inhibited) t))
10990 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
10993 @item nnfolder-delete-mail-hook
10994 @vindex nnfolder-delete-mail-hook
10995 Hook run in a buffer narrowed to the message that is to be deleted.
10996 This function can be used to copy the message to somewhere else, or to
10997 extract some information from it before removing it.
11002 @findex nnfolder-generate-active-file
11003 @kindex M-x nnfolder-generate-active-file
11004 If you have lots of @code{nnfolder}-like files you'd like to read with
11005 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
11006 command to make @code{nnfolder} aware of all likely files in
11007 @code{nnfolder-directory}. This only works if you use long file names,
11011 @node Other Sources
11012 @section Other Sources
11014 Gnus can do more than just read news or mail. The methods described
11015 below allow Gnus to view directories and files as if they were
11019 * Directory Groups:: You can read a directory as if it was a newsgroup.
11020 * Anything Groups:: Dired? Who needs dired?
11021 * Document Groups:: Single files can be the basis of a group.
11022 * SOUP:: Reading @sc{SOUP} packets ``offline''.
11023 * Web Searches:: Creating groups from articles that match a string.
11024 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
11028 @node Directory Groups
11029 @subsection Directory Groups
11031 @cindex directory groups
11033 If you have a directory that has lots of articles in separate files in
11034 it, you might treat it as a newsgroup. The files have to have numerical
11037 This might be an opportune moment to mention @code{ange-ftp} (and its
11038 successor @code{efs}), that most wonderful of all wonderful Emacs
11039 packages. When I wrote @code{nndir}, I didn't think much about it---a
11040 backend to read directories. Big deal.
11042 @code{ange-ftp} changes that picture dramatically. For instance, if you
11043 enter the @code{ange-ftp} file name
11044 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
11045 @code{ange-ftp} or @code{efs} will actually allow you to read this
11046 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
11048 @code{nndir} will use @sc{nov} files if they are present.
11050 @code{nndir} is a ``read-only'' backend---you can't delete or expire
11051 articles with this method. You can use @code{nnmh} or @code{nnml} for
11052 whatever you use @code{nndir} for, so you could switch to any of those
11053 methods if you feel the need to have a non-read-only @code{nndir}.
11056 @node Anything Groups
11057 @subsection Anything Groups
11060 From the @code{nndir} backend (which reads a single spool-like
11061 directory), it's just a hop and a skip to @code{nneething}, which
11062 pretends that any arbitrary directory is a newsgroup. Strange, but
11065 When @code{nneething} is presented with a directory, it will scan this
11066 directory and assign article numbers to each file. When you enter such
11067 a group, @code{nneething} must create ``headers'' that Gnus can use.
11068 After all, Gnus is a newsreader, in case you're
11069 forgetting. @code{nneething} does this in a two-step process. First, it
11070 snoops each file in question. If the file looks like an article (i.e.,
11071 the first few lines look like headers), it will use this as the head.
11072 If this is just some arbitrary file without a head (e.g. a C source
11073 file), @code{nneething} will cobble up a header out of thin air. It
11074 will use file ownership, name and date and do whatever it can with these
11077 All this should happen automatically for you, and you will be presented
11078 with something that looks very much like a newsgroup. Totally like a
11079 newsgroup, to be precise. If you select an article, it will be displayed
11080 in the article buffer, just as usual.
11082 If you select a line that represents a directory, Gnus will pop you into
11083 a new summary buffer for this @code{nneething} group. And so on. You can
11084 traverse the entire disk this way, if you feel like, but remember that
11085 Gnus is not dired, really, and does not intend to be, either.
11087 There are two overall modes to this action---ephemeral or solid. When
11088 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
11089 will not store information on what files you have read, and what files
11090 are new, and so on. If you create a solid @code{nneething} group the
11091 normal way with @kbd{G m}, Gnus will store a mapping table between
11092 article numbers and file names, and you can treat this group like any
11093 other groups. When you activate a solid @code{nneething} group, you will
11094 be told how many unread articles it contains, etc., etc.
11099 @item nneething-map-file-directory
11100 @vindex nneething-map-file-directory
11101 All the mapping files for solid @code{nneething} groups will be stored
11102 in this directory, which defaults to @file{~/.nneething/}.
11104 @item nneething-exclude-files
11105 @vindex nneething-exclude-files
11106 All files that match this regexp will be ignored. Nice to use to exclude
11107 auto-save files and the like, which is what it does by default.
11109 @item nneething-include-files
11110 @vindex nneething-include-files
11111 Regexp saying what files to include in the group. If this variable is
11112 non-@code{nil}, only files matching this regexp will be included.
11114 @item nneething-map-file
11115 @vindex nneething-map-file
11116 Name of the map files.
11120 @node Document Groups
11121 @subsection Document Groups
11123 @cindex documentation group
11126 @code{nndoc} is a cute little thing that will let you read a single file
11127 as a newsgroup. Several files types are supported:
11134 The babyl (rmail) mail box.
11139 The standard Unix mbox file.
11141 @cindex MMDF mail box
11143 The MMDF mail box format.
11146 Several news articles appended into a file.
11149 @cindex rnews batch files
11150 The rnews batch transport format.
11151 @cindex forwarded messages
11154 Forwarded articles.
11157 MIME multipart messages.
11159 @item standard-digest
11160 The standard (RFC 1153) digest format.
11163 Non-standard digest format---matches most things, but does it badly.
11166 You can also use the special ``file type'' @code{guess}, which means
11167 that @code{nndoc} will try to guess what file type it is looking at.
11168 @code{digest} means that @code{nndoc} should guess what digest type the
11171 @code{nndoc} will not try to change the file or insert any extra headers into
11172 it---it will simply, like, let you use the file as the basis for a
11173 group. And that's it.
11175 If you have some old archived articles that you want to insert into your
11176 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
11177 that. Say you have an old @file{RMAIL} file with mail that you now want
11178 to split into your new @code{nnml} groups. You look at that file using
11179 @code{nndoc} (using the @kbd{G f} command in the group buffer
11180 (@pxref{Foreign Groups})), set the process mark on all the articles in
11181 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
11182 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
11183 file is now also stored in lots of @code{nnml} directories, and you can
11184 delete that pesky @file{RMAIL} file. If you have the guts!
11186 Virtual server variables:
11189 @item nndoc-article-type
11190 @vindex nndoc-article-type
11191 This should be one of @code{mbox}, @code{babyl}, @code{digest},
11192 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
11193 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
11194 @code{slack-digest}, @code{clari-briefs} or @code{guess}.
11196 @item nndoc-post-type
11197 @vindex nndoc-post-type
11198 This variable says whether Gnus is to consider the group a news group or
11199 a mail group. There are two valid values: @code{mail} (the default)
11204 * Document Server Internals:: How to add your own document types.
11208 @node Document Server Internals
11209 @subsubsection Document Server Internals
11211 Adding new document types to be recognized by @code{nndoc} isn't
11212 difficult. You just have to whip up a definition of what the document
11213 looks like, write a predicate function to recognize that document type,
11214 and then hook into @code{nndoc}.
11216 First, here's an example document type definition:
11220 (article-begin . "^\^A\^A\^A\^A\n")
11221 (body-end . "^\^A\^A\^A\^A\n"))
11224 The definition is simply a unique @dfn{name} followed by a series of
11225 regexp pseudo-variable settings. Below are the possible
11226 variables---don't be daunted by the number of variables; most document
11227 types can be defined with very few settings:
11230 @item first-article
11231 If present, @code{nndoc} will skip past all text until it finds
11232 something that match this regexp. All text before this will be
11235 @item article-begin
11236 This setting has to be present in all document type definitions. It
11237 says what the beginning of each article looks like.
11239 @item head-begin-function
11240 If present, this should be a function that moves point to the head of
11243 @item nndoc-head-begin
11244 If present, this should be a regexp that matches the head of the
11247 @item nndoc-head-end
11248 This should match the end of the head of the article. It defaults to
11249 @samp{^$}---the empty line.
11251 @item body-begin-function
11252 If present, this function should move point to the beginning of the body
11256 This should match the beginning of the body of the article. It defaults
11259 @item body-end-function
11260 If present, this function should move point to the end of the body of
11264 If present, this should match the end of the body of the article.
11267 If present, this should match the end of the file. All text after this
11268 regexp will be totally ignored.
11272 So, using these variables @code{nndoc} is able to dissect a document
11273 file into a series of articles, each with a head and a body. However, a
11274 few more variables are needed since not all document types are all that
11275 news-like---variables needed to transform the head or the body into
11276 something that's palatable for Gnus:
11279 @item prepare-body-function
11280 If present, this function will be called when requesting an article. It
11281 will be called with point at the start of the body, and is useful if the
11282 document has encoded some parts of its contents.
11284 @item article-transform-function
11285 If present, this function is called when requesting an article. It's
11286 meant to be used for more wide-ranging transformation of both head and
11287 body of the article.
11289 @item generate-head-function
11290 If present, this function is called to generate a head that Gnus can
11291 understand. It is called with the article number as a parameter, and is
11292 expected to generate a nice head for the article in question. It is
11293 called when requesting the headers of all articles.
11297 Let's look at the most complicated example I can come up with---standard
11302 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
11303 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
11304 (prepare-body-function . nndoc-unquote-dashes)
11305 (body-end-function . nndoc-digest-body-end)
11306 (head-end . "^ ?$")
11307 (body-begin . "^ ?\n")
11308 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
11309 (subtype digest guess))
11312 We see that all text before a 70-width line of dashes is ignored; all
11313 text after a line that starts with that @samp{^End of} is also ignored;
11314 each article begins with a 30-width line of dashes; the line separating
11315 the head from the body may contain a single space; and that the body is
11316 run through @code{nndoc-unquote-dashes} before being delivered.
11318 To hook your own document definition into @code{nndoc}, use the
11319 @code{nndoc-add-type} function. It takes two parameters---the first is
11320 the definition itself and the second (optional) parameter says where in
11321 the document type definition alist to put this definition. The alist is
11322 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
11323 is of @code{mmdf} type, and so on. These type predicates should return
11324 @code{nil} if the document is not of the correct type; @code{t} if it is
11325 of the correct type; and a number if the document might be of the
11326 correct type. A high number means high probability; a low number means
11327 low probability with @samp{0} being the lowest valid number.
11335 In the PC world people often talk about ``offline'' newsreaders. These
11336 are thingies that are combined reader/news transport monstrosities.
11337 With built-in modem programs. Yecchh!
11339 Of course, us Unix Weenie types of human beans use things like
11340 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
11341 transport things like Ghod intended. And then we just use normal
11344 However, it can sometimes be convenient to do something a that's a bit
11345 easier on the brain if you have a very slow modem, and you're not really
11346 that interested in doing things properly.
11348 A file format called @sc{soup} has been developed for transporting news
11349 and mail from servers to home machines and back again. It can be a bit
11352 First some terminology:
11357 This is the machine that is connected to the outside world and where you
11358 get news and/or mail from.
11361 This is the machine that you want to do the actual reading and responding
11362 on. It is typically not connected to the rest of the world in any way.
11365 Something that contains messages and/or commands. There are two kinds
11369 @item message packets
11370 These are packets made at the server, and typically contain lots of
11371 messages for you to read. These are called @file{SoupoutX.tgz} by
11372 default, where @var{X} is a number.
11374 @item response packets
11375 These are packets made at the home machine, and typically contains
11376 replies that you've written. These are called @file{SoupinX.tgz} by
11377 default, where @var{X} is a number.
11387 You log in on the server and create a @sc{soup} packet. You can either
11388 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
11389 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
11390 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
11393 You transfer the packet home. Rail, boat, car or modem will do fine.
11396 You put the packet in your home directory.
11399 You fire up Gnus on your home machine using the @code{nnsoup} backend as
11400 the native or secondary server.
11403 You read articles and mail and answer and followup to the things you
11404 want (@pxref{SOUP Replies}).
11407 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
11411 You transfer this packet to the server.
11414 You use Gnus to mail this packet out with the @kbd{G s s} command.
11417 You then repeat until you die.
11421 So you basically have a bipartite system---you use @code{nnsoup} for
11422 reading and Gnus for packing/sending these @sc{soup} packets.
11425 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
11426 * SOUP Groups:: A backend for reading @sc{soup} packets.
11427 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
11431 @node SOUP Commands
11432 @subsubsection SOUP Commands
11434 These are commands for creating and manipulating @sc{soup} packets.
11438 @kindex G s b (Group)
11439 @findex gnus-group-brew-soup
11440 Pack all unread articles in the current group
11441 (@code{gnus-group-brew-soup}). This command understands the
11442 process/prefix convention.
11445 @kindex G s w (Group)
11446 @findex gnus-soup-save-areas
11447 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
11450 @kindex G s s (Group)
11451 @findex gnus-soup-send-replies
11452 Send all replies from the replies packet
11453 (@code{gnus-soup-send-replies}).
11456 @kindex G s p (Group)
11457 @findex gnus-soup-pack-packet
11458 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
11461 @kindex G s r (Group)
11462 @findex nnsoup-pack-replies
11463 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
11466 @kindex O s (Summary)
11467 @findex gnus-soup-add-article
11468 This summary-mode command adds the current article to a @sc{soup} packet
11469 (@code{gnus-soup-add-article}). It understands the process/prefix
11470 convention (@pxref{Process/Prefix}).
11475 There are a few variables to customize where Gnus will put all these
11480 @item gnus-soup-directory
11481 @vindex gnus-soup-directory
11482 Directory where Gnus will save intermediate files while composing
11483 @sc{soup} packets. The default is @file{~/SoupBrew/}.
11485 @item gnus-soup-replies-directory
11486 @vindex gnus-soup-replies-directory
11487 This is what Gnus will use as a temporary directory while sending our
11488 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
11490 @item gnus-soup-prefix-file
11491 @vindex gnus-soup-prefix-file
11492 Name of the file where Gnus stores the last used prefix. The default is
11493 @samp{gnus-prefix}.
11495 @item gnus-soup-packer
11496 @vindex gnus-soup-packer
11497 A format string command for packing a @sc{soup} packet. The default is
11498 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
11500 @item gnus-soup-unpacker
11501 @vindex gnus-soup-unpacker
11502 Format string command for unpacking a @sc{soup} packet. The default is
11503 @samp{gunzip -c %s | tar xvf -}.
11505 @item gnus-soup-packet-directory
11506 @vindex gnus-soup-packet-directory
11507 Where Gnus will look for reply packets. The default is @file{~/}.
11509 @item gnus-soup-packet-regexp
11510 @vindex gnus-soup-packet-regexp
11511 Regular expression matching @sc{soup} reply packets in
11512 @code{gnus-soup-packet-directory}.
11518 @subsubsection @sc{soup} Groups
11521 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
11522 read incoming packets, unpack them, and put them in a directory where
11523 you can read them at leisure.
11525 These are the variables you can use to customize its behavior:
11529 @item nnsoup-tmp-directory
11530 @vindex nnsoup-tmp-directory
11531 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
11532 directory. (@file{/tmp/} by default.)
11534 @item nnsoup-directory
11535 @vindex nnsoup-directory
11536 @code{nnsoup} then moves each message and index file to this directory.
11537 The default is @file{~/SOUP/}.
11539 @item nnsoup-replies-directory
11540 @vindex nnsoup-replies-directory
11541 All replies will be stored in this directory before being packed into a
11542 reply packet. The default is @file{~/SOUP/replies/"}.
11544 @item nnsoup-replies-format-type
11545 @vindex nnsoup-replies-format-type
11546 The @sc{soup} format of the replies packets. The default is @samp{?n}
11547 (rnews), and I don't think you should touch that variable. I probably
11548 shouldn't even have documented it. Drats! Too late!
11550 @item nnsoup-replies-index-type
11551 @vindex nnsoup-replies-index-type
11552 The index type of the replies packet. The default is @samp{?n}, which
11553 means ``none''. Don't fiddle with this one either!
11555 @item nnsoup-active-file
11556 @vindex nnsoup-active-file
11557 Where @code{nnsoup} stores lots of information. This is not an ``active
11558 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
11559 this file or mess it up in any way, you're dead. The default is
11560 @file{~/SOUP/active}.
11562 @item nnsoup-packer
11563 @vindex nnsoup-packer
11564 Format string command for packing a reply @sc{soup} packet. The default
11565 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
11567 @item nnsoup-unpacker
11568 @vindex nnsoup-unpacker
11569 Format string command for unpacking incoming @sc{soup} packets. The
11570 default is @samp{gunzip -c %s | tar xvf -}.
11572 @item nnsoup-packet-directory
11573 @vindex nnsoup-packet-directory
11574 Where @code{nnsoup} will look for incoming packets. The default is
11577 @item nnsoup-packet-regexp
11578 @vindex nnsoup-packet-regexp
11579 Regular expression matching incoming @sc{soup} packets. The default is
11582 @item nnsoup-always-save
11583 @vindex nnsoup-always-save
11584 If non-@code{nil}, save the replies buffer after each posted message.
11590 @subsubsection SOUP Replies
11592 Just using @code{nnsoup} won't mean that your postings and mailings end
11593 up in @sc{soup} reply packets automagically. You have to work a bit
11594 more for that to happen.
11596 @findex nnsoup-set-variables
11597 The @code{nnsoup-set-variables} command will set the appropriate
11598 variables to ensure that all your followups and replies end up in the
11601 In specific, this is what it does:
11604 (setq message-send-news-function 'nnsoup-request-post)
11605 (setq message-send-mail-function 'nnsoup-request-mail)
11608 And that's it, really. If you only want news to go into the @sc{soup}
11609 system you just use the first line. If you only want mail to be
11610 @sc{soup}ed you use the second.
11614 @subsection Web Searches
11618 @cindex InReference
11619 @cindex Usenet searches
11620 @cindex searching the Usenet
11622 It's, like, too neat to search the Usenet for articles that match a
11623 string, but it, like, totally @emph{sucks}, like, totally, to use one of
11624 those, like, Web browsers, and you, like, have to, rilly, like, look at
11625 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
11626 searches without having to use a browser.
11628 The @code{nnweb} backend allows an easy interface to the mighty search
11629 engine. You create an @code{nnweb} group, enter a search pattern, and
11630 then enter the group and read the articles like you would any normal
11631 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
11632 Groups}) will do this in an easy-to-use fashion.
11634 @code{nnweb} groups don't really lend themselves to being solid
11635 groups---they have a very fleeting idea of article numbers. In fact,
11636 each time you enter an @code{nnweb} group (not even changing the search
11637 pattern), you are likely to get the articles ordered in a different
11638 manner. Not even using duplicate suppression (@pxref{Duplicate
11639 Suppression}) will help, since @code{nnweb} doesn't even know the
11640 @code{Message-ID} of the articles before reading them using some search
11641 engines (DejaNews, for instance). The only possible way to keep track
11642 of which articles you've read is by scoring on the @code{Date}
11643 header---mark all articles posted before the last date you read the
11646 If the search engine changes its output substantially, @code{nnweb}
11647 won't be able to parse it and will fail. One could hardly fault the Web
11648 providers if they were to do this---their @emph{raison d'être} is to
11649 make money off of advertisements, not to provide services to the
11650 community. Since @code{nnweb} washes the ads off all the articles, one
11651 might think that the providers might be somewhat miffed. We'll see.
11653 You must have the @code{url} and @code{w3} package installed to be able
11654 to use @code{nnweb}.
11656 Virtual server variables:
11661 What search engine type is being used. The currently supported types
11662 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
11666 @vindex nnweb-search
11667 The search string to feed to the search engine.
11669 @item nnweb-max-hits
11670 @vindex nnweb-max-hits
11671 Advisory maximum number of hits per search to display. The default is
11674 @item nnweb-type-definition
11675 @vindex nnweb-type-definition
11676 Type-to-definition alist. This alist says what @code{nnweb} should do
11677 with the various search engine types. The following elements must be
11682 Function to decode the article and provide something that Gnus
11686 Function to create an article number to message header and URL alist.
11689 Function to send the search string to the search engine.
11692 The address the aforementioned function should send the search string
11696 Format string URL to fetch an article by @code{Message-ID}.
11703 @node Mail-To-News Gateways
11704 @subsection Mail-To-News Gateways
11705 @cindex mail-to-news gateways
11708 If your local @code{nntp} server doesn't allow posting, for some reason
11709 or other, you can post using one of the numerous mail-to-news gateways.
11710 The @code{nngateway} backend provides the interface.
11712 Note that you can't read anything from this backend---it can only be
11718 @item nngateway-address
11719 @vindex nngateway-address
11720 This is the address of the mail-to-news gateway.
11722 @item nngateway-header-transformation
11723 @vindex nngateway-header-transformation
11724 News headers often have to be transformed in some odd way or other
11725 for the mail-to-news gateway to accept it. This variable says what
11726 transformation should be called, and defaults to
11727 @code{nngateway-simple-header-transformation}. The function is called
11728 narrowed to the headers to be transformed and with one parameter---the
11731 This default function just inserts a new @code{To} header based on the
11732 @code{Newsgroups} header and the gateway address.
11733 For instance, an article with this @code{Newsgroups} header:
11736 Newsgroups: alt.religion.emacs
11739 will get this @code{From} header inserted:
11742 To: alt-religion-emacs@@GATEWAY
11745 The following pre-defined functions exist:
11747 @findex nngateway-simple-header-transformation
11750 @item nngateway-simple-header-transformation
11751 Creates a @code{To} header that looks like
11752 @var{newsgroup}@@@code{nngateway-address}.
11754 @findex nngateway-mail2news-header-transformation
11756 @item nngateway-mail2news-header-transformation
11757 Creates a @code{To} header that looks like
11758 @code{nngateway-address}.
11763 (setq gnus-post-method
11764 '(nngateway "mail2news@@replay.com"
11765 (nngateway-header-transformation
11766 nngateway-mail2news-header-transformation)))
11774 So, to use this, simply say something like:
11777 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
11781 @node Combined Groups
11782 @section Combined Groups
11784 Gnus allows combining a mixture of all the other group types into bigger
11788 * Virtual Groups:: Combining articles from many groups.
11789 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
11793 @node Virtual Groups
11794 @subsection Virtual Groups
11796 @cindex virtual groups
11797 @cindex merging groups
11799 An @dfn{nnvirtual group} is really nothing more than a collection of
11802 For instance, if you are tired of reading many small groups, you can
11803 put them all in one big group, and then grow tired of reading one
11804 big, unwieldy group. The joys of computing!
11806 You specify @code{nnvirtual} as the method. The address should be a
11807 regexp to match component groups.
11809 All marks in the virtual group will stick to the articles in the
11810 component groups. So if you tick an article in a virtual group, the
11811 article will also be ticked in the component group from whence it came.
11812 (And vice versa---marks from the component groups will also be shown in
11813 the virtual group.)
11815 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
11816 newsgroups into one, big, happy newsgroup:
11819 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
11822 The component groups can be native or foreign; everything should work
11823 smoothly, but if your computer explodes, it was probably my fault.
11825 Collecting the same group from several servers might actually be a good
11826 idea if users have set the Distribution header to limit distribution.
11827 If you would like to read @samp{soc.motss} both from a server in Japan
11828 and a server in Norway, you could use the following as the group regexp:
11831 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
11834 (Remember, though, that if you're creating the group with @kbd{G m}, you
11835 shouldn't double the backslashes, and you should leave off the quote
11836 characters at the beginning and the end of the string.)
11838 This should work kinda smoothly---all articles from both groups should
11839 end up in this one, and there should be no duplicates. Threading (and
11840 the rest) will still work as usual, but there might be problems with the
11841 sequence of articles. Sorting on date might be an option here
11842 (@pxref{Selecting a Group}).
11844 One limitation, however---all groups included in a virtual
11845 group have to be alive (i.e., subscribed or unsubscribed). Killed or
11846 zombie groups can't be component groups for @code{nnvirtual} groups.
11848 @vindex nnvirtual-always-rescan
11849 If the @code{nnvirtual-always-rescan} is non-@code{nil},
11850 @code{nnvirtual} will always scan groups for unread articles when
11851 entering a virtual group. If this variable is @code{nil} (which is the
11852 default) and you read articles in a component group after the virtual
11853 group has been activated, the read articles from the component group
11854 will show up when you enter the virtual group. You'll also see this
11855 effect if you have two virtual groups that have a component group in
11856 common. If that's the case, you should set this variable to @code{t}.
11857 Or you can just tap @code{M-g} on the virtual group every time before
11858 you enter it---it'll have much the same effect.
11860 @code{nnvirtual} can have both mail and news groups as component groups.
11861 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
11862 has to ask the backend of the component group the article comes from
11863 whether it is a news or mail backend. However, when you do a @kbd{^},
11864 there is typically no sure way for the component backend to know this,
11865 and in that case @code{nnvirtual} tells Gnus that the article came from a
11866 not-news backend. (Just to be on the safe side.)
11868 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
11869 line from the article you respond to in these cases.
11873 @node Kibozed Groups
11874 @subsection Kibozed Groups
11878 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
11879 the news feed''. @code{nnkiboze} is a backend that will do this for
11880 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
11881 with useless requests! Oh happiness!
11883 @kindex G k (Group)
11884 To create a kibozed group, use the @kbd{G k} command in the group
11887 The address field of the @code{nnkiboze} method is, as with
11888 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
11889 @code{nnkiboze} group. That's where most similarities between @code{nnkiboze}
11890 and @code{nnvirtual} end.
11892 In addition to this regexp detailing component groups, an @code{nnkiboze} group
11893 must have a score file to say what articles are to be included in
11894 the group (@pxref{Scoring}).
11896 @kindex M-x nnkiboze-generate-groups
11897 @findex nnkiboze-generate-groups
11898 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
11899 @code{nnkiboze} groups you want to have. This command will take time. Lots of
11900 time. Oodles and oodles of time. Gnus has to fetch the headers from
11901 all the articles in all the component groups and run them through the
11902 scoring process to determine if there are any articles in the groups
11903 that are to be part of the @code{nnkiboze} groups.
11905 Please limit the number of component groups by using restrictive
11906 regexps. Otherwise your sysadmin may become annoyed with you, and the
11907 @sc{nntp} site may throw you off and never let you back in again.
11908 Stranger things have happened.
11910 @code{nnkiboze} component groups do not have to be alive---they can be dead,
11911 and they can be foreign. No restrictions.
11913 @vindex nnkiboze-directory
11914 The generation of an @code{nnkiboze} group means writing two files in
11915 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
11916 contains the @sc{nov} header lines for all the articles in the group,
11917 and the other is an additional @file{.newsrc} file to store information
11918 on what groups have been searched through to find component articles.
11920 Articles marked as read in the @code{nnkiboze} group will have
11921 their @sc{nov} lines removed from the @sc{nov} file.
11924 @node Gnus Unplugged
11925 @section Gnus Unplugged
11930 @cindex Gnus Unplugged
11932 In olden times (ca. February '88), people used to run their newsreaders
11933 on big machines with permanent connections to the net. News transport
11934 was dealt with by news servers, and all the newsreaders had to do was to
11935 read news. Believe it or not.
11937 Nowadays most people read news and mail at home, and use some sort of
11938 modem to connect to the net. To avoid running up huge phone bills, it
11939 would be nice to have a way to slurp down all the news and mail, hang up
11940 the phone, read for several hours, and then upload any responses you
11941 have to make. And then you repeat the procedure.
11943 Of course, you can use news servers for doing this as well. I've used
11944 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
11945 for some years, but doing that's a bore. Moving the news server
11946 functionality up to the newsreader makes sense if you're the only person
11947 reading news on a machine.
11949 Using Gnus as an ``offline'' newsreader is quite simple.
11953 First, set up Gnus as you would do if you were running it on a machine
11954 that has full connection to the net. Go ahead. I'll still be waiting
11958 Then, put the following magical incantation at the end of your
11959 @file{.gnus.el} file:
11966 That's it. Gnus is now an ``offline'' newsreader.
11968 Of course, to use it as such, you have to learn a few new commands.
11971 * Agent Basics:: How it all is supposed to work.
11972 * Agent Categories:: How to tell the Gnus Agent what to download.
11973 * Agent Commands:: New commands for all the buffers.
11974 * Agent Expiry:: How to make old articles go away.
11975 * Outgoing Messages:: What happens when you post/mail something?
11976 * Agent Variables:: Customizing is fun.
11977 * Example Setup:: An example @file{.gnus.el} file for offline people.
11978 * Batching Agents:: How to fetch news from a @code{cron} job.
11979 * Agent Caveats:: What you think it'll do and what it does.
11984 @subsection Agent Basics
11986 First, let's get some terminology out of the way.
11988 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
11989 connection to the net (and notified the Agent that this is the case).
11990 When the connection to the net is up again (and Gnus knows this), the
11991 Agent is @dfn{plugged}.
11993 The @dfn{local} machine is the one you're running on, and which isn't
11994 connected to the net continuously.
11996 @dfn{Downloading} means fetching things from the net to your local
11997 machine. @dfn{Uploading} is doing the opposite.
11999 Let's take a typical Gnus session using the Agent.
12004 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
12005 Agent in a disconnected state. You can read all the news that you have
12006 already fetched while in this mode.
12009 You then decide to see whether any new news has arrived. You connect
12010 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
12011 to make Gnus become @dfn{plugged}.
12014 You can then read the new news immediately, or you can download the news
12015 onto your local machine. If you want to do the latter, you press @kbd{J
12016 s} to fetch all the eligible articles in all the groups. (To let Gnus
12017 know which articles you want to download, @pxref{Agent Categories}.)
12020 After fetching the articles, you press @kbd{J j} to make Gnus become
12021 unplugged again, and you shut down the PPP thing (or whatever). And
12022 then you read the news offline.
12025 And then you go to step 2.
12028 Here are some things you should do the first time (or so) that you use
12034 Decide which servers should be covered by the Agent. If you have a mail
12035 backend, it would probably be nonsensical to have it covered by the
12036 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
12037 @kbd{J a} the server (or servers) that you wish to have covered by the
12038 Agent (@pxref{Server Agent Commands}). This will typically be only the
12039 primary select method, which is listed on the bottom in the buffer.
12042 Decide on download policy. @xref{Agent Categories}.
12049 @node Agent Categories
12050 @subsection Agent Categories
12052 One of the main reasons to integrate the news transport layer into the
12053 newsreader is to allow greater control over what articles to download.
12054 There's not much point in downloading huge amounts of articles, just to
12055 find out that you're not interested in reading any of them. It's better
12056 to be somewhat more conservative in choosing what to download, and then
12057 mark the articles for downloading manually if it should turn out that
12058 you're interested in the articles anyway.
12060 The main way to control what is to be downloaded is to create a
12061 @dfn{category} and then assign some (or all) groups to this category.
12062 Gnus has its own buffer for creating and managing categories.
12065 * Category Syntax:: What a category looks like.
12066 * The Category Buffer:: A buffer for maintaining categories.
12067 * Category Variables:: Customize'r'Us.
12071 @node Category Syntax
12072 @subsubsection Category Syntax
12074 A category consists of two things.
12078 A predicate which (generally) gives a rough outline of which articles
12079 are eligible for downloading; and
12082 a score rule which (generally) gives you a finer granularity when
12083 deciding what articles to download. (Note that this @dfn{download
12084 score} is not necessarily related to normal scores.)
12087 A predicate in its simplest form can be a single predicate such as
12088 @code{true} or @code{false}. These two will download every available
12089 article or nothing respectively. In the case of these two special
12090 predicates an additional score rule is superfluous.
12092 Predicates of @code{high} or @code{low} download articles in respect of
12093 their scores in relationship to @code{gnus-agent-high-score} and
12094 @code{gnus-agent-low-score} as descibed below.
12096 To gain even finer control of what is to be regarded eligible for
12097 download a predicate can consist of a number of predicates with logical
12098 operators sprinkled in between.
12100 Perhaps some examples are in order.
12102 Here's a simple predicate. (It's the default predicate, in fact, used
12103 for all groups that don't belong to any other category.)
12109 Quite simple, eh? This predicate is true if and only if the article is
12110 short (for some value of ``short'').
12112 Here's a more complex predicate:
12121 This means that an article should be downloaded if it has a high score,
12122 or if the score is not low and the article is not long. You get the
12125 The available logical operators are @code{or}, @code{and} and
12126 @code{not}. (If you prefer, you can use the more ``C''-ish operators
12127 @samp{|}, @code{&} and @code{!} instead.)
12129 The following predicates are pre-defined, but if none of these fit what
12130 you want to do, you can write your own.
12134 True iff the article is shorter than @code{gnus-agent-short-article}
12135 lines; default 100.
12138 True iff the article is longer than @code{gnus-agent-long-article}
12139 lines; default 200.
12142 True iff the article has a download score less than
12143 @code{gnus-agent-low-score}; default 0.
12146 True iff the article has a download score greater than
12147 @code{gnus-agent-high-score}; default 0.
12150 True iff the Gnus Agent guesses that the article is spam. The
12151 heuristics may change over time, but at present it just computes a
12152 checksum and sees whether articles match.
12161 If you want to create your own predicate function, here's what you have
12162 to know: The functions are called with no parameters, but the
12163 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
12166 For example, you could decide that you don't want to download articles
12167 that were posted more than a certain number of days ago (e.g. posted
12168 more than @code{gnus-agent-expire-days} ago) you might write a function
12169 something along the lines of the following:
12172 (defun my-article-old-p ()
12173 "Say whether an article is old."
12174 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
12175 (- (time-to-days (current-time)) gnus-agent-expire-days)))
12178 with the predicate then defined as:
12181 (not my-article-old-p)
12184 or you could append your predicate to the predefined
12185 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
12186 wherever. (Note: this would have to be at a point *after*
12187 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
12190 (defvar gnus-category-predicate-alist
12191 (append gnus-category-predicate-alist
12192 '((old . my-article-old-p))))
12195 and simply specify your predicate as:
12201 If/when using something like the above, be aware that there are many
12202 misconfigured systems/mailers out there and so an article's date is not
12203 always a reliable indication of when it was posted. Hell, some people
12204 just don't give a damm.
12207 The above predicates apply to *all* the groups which belong to the
12208 category. However, if you wish to have a specific predicate for an
12209 individual group within a category, or you're just too lazy to set up a
12210 new category, you can enter a group's individual predicate in it's group
12211 parameters like so:
12214 (agent-predicate . short)
12217 This is the group parameter equivalent of the agent category
12218 default. Note that when specifying a single word predicate like this,
12219 the @code{agent-predicate} specification must be in dotted pair
12222 The equivalent of the longer example from above would be:
12225 (agent-predicate or high (and (not low) (not long)))
12228 The outer parenthesis required in the category specification are not
12229 entered here as, not being in dotted pair notation, the value of the
12230 predicate is assumed to be a list.
12233 Now, the syntax of the download score is the same as the syntax of
12234 normal score files, except that all elements that require actually
12235 seeing the article itself are verboten. This means that only the
12236 following headers can be scored on: @code{Subject}, @code{From},
12237 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
12238 @code{Lines}, and @code{Xref}.
12240 As with predicates, the specification of the @code{download score rule}
12241 to use in respect of a group can be in either the category definition if
12242 it's to be applicable to all groups in therein, or a group's parameters
12243 if it's to be specific to that group.
12245 In both of these places the @code{download score rule} can take one of
12252 This has the same syntax as a normal gnus score file except only a
12253 subset of scoring keywords are available as mentioned above.
12259 Category specification
12263 ("Lars Ingebrigtsen" 1000000 nil s))
12269 Group Parameter specification
12272 (agent-score ("from"
12273 ("Lars Ingebrigtsen" 1000000 nil s))
12278 Again, note the omission of the outermost parenthesis here.
12284 These score files must *only* contain the permitted scoring keywords
12291 Category specification
12294 ("~/News/agent.SCORE")
12300 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
12304 Group Parameter specification
12307 (agent-score "~/News/agent.SCORE")
12310 Additional score files can be specified as above. Need I say anything
12315 Use @code{normal} score files
12317 If you dont want to maintain two sets of scoring rules for a group, and
12318 your desired @code{downloading} criteria for a group are the same as your
12319 @code{reading} criteria then you can tell the agent to refer to your
12320 @code{normal} score files when deciding what to download.
12322 These directives in either the category definition or a group's
12323 parameters will cause the agent to read in all the applicable score
12324 files for a group, *filtering out* those those sections that do not
12325 relate to one of the permitted subset of scoring keywords.
12329 Category Specification
12336 Group Parameter specification
12339 (agent-score . file)
12344 @node The Category Buffer
12345 @subsubsection The Category Buffer
12347 You'd normally do all category maintenance from the category buffer.
12348 When you enter it for the first time (with the @kbd{J c} command from
12349 the group buffer), you'll only see the @code{default} category.
12351 The following commands are available in this buffer:
12355 @kindex q (Category)
12356 @findex gnus-category-exit
12357 Return to the group buffer (@code{gnus-category-exit}).
12360 @kindex k (Category)
12361 @findex gnus-category-kill
12362 Kill the current category (@code{gnus-category-kill}).
12365 @kindex c (Category)
12366 @findex gnus-category-copy
12367 Copy the current category (@code{gnus-category-copy}).
12370 @kindex a (Category)
12371 @findex gnus-category-add
12372 Add a new category (@code{gnus-category-add}).
12375 @kindex p (Category)
12376 @findex gnus-category-edit-predicate
12377 Edit the predicate of the current category
12378 (@code{gnus-category-edit-predicate}).
12381 @kindex g (Category)
12382 @findex gnus-category-edit-groups
12383 Edit the list of groups belonging to the current category
12384 (@code{gnus-category-edit-groups}).
12387 @kindex s (Category)
12388 @findex gnus-category-edit-score
12389 Edit the download score rule of the current category
12390 (@code{gnus-category-edit-score}).
12393 @kindex l (Category)
12394 @findex gnus-category-list
12395 List all the categories (@code{gnus-category-list}).
12399 @node Category Variables
12400 @subsubsection Category Variables
12403 @item gnus-category-mode-hook
12404 @vindex gnus-category-mode-hook
12405 Hook run in category buffers.
12407 @item gnus-category-line-format
12408 @vindex gnus-category-line-format
12409 Format of the lines in the category buffer (@pxref{Formatting
12410 Variables}). Valid elements are:
12414 The name of the category.
12417 The number of groups in the category.
12420 @item gnus-category-mode-line-format
12421 @vindex gnus-category-mode-line-format
12422 Format of the category mode line (@pxref{Mode Line Formatting}).
12424 @item gnus-agent-short-article
12425 @vindex gnus-agent-short-article
12426 Articles that have fewer lines than this are short. Default 100.
12428 @item gnus-agent-long-article
12429 @vindex gnus-agent-long-article
12430 Articles that have more lines than this are long. Default 200.
12432 @item gnus-agent-low-score
12433 @vindex gnus-agent-low-score
12434 Articles that have a score lower than this have a low score. Default
12437 @item gnus-agent-high-score
12438 @vindex gnus-agent-high-score
12439 Articles that have a score higher than this have a high score. Default
12445 @node Agent Commands
12446 @subsection Agent Commands
12448 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
12449 (@code{gnus-agent-toggle-plugged} command works in all modes, and
12450 toggles the plugged/unplugged state of the Gnus Agent.
12454 * Group Agent Commands::
12455 * Summary Agent Commands::
12456 * Server Agent Commands::
12459 You can run a complete batch fetch from the command line with the
12460 following incantation:
12462 @cindex gnus-agent-batch-fetch
12464 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
12469 @node Group Agent Commands
12470 @subsubsection Group Agent Commands
12474 @kindex J u (Agent Group)
12475 @findex gnus-agent-fetch-groups
12476 Fetch all eligible articles in the current group
12477 (@code{gnus-agent-fetch-groups}).
12480 @kindex J c (Agent Group)
12481 @findex gnus-enter-category-buffer
12482 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
12485 @kindex J s (Agent Group)
12486 @findex gnus-agent-fetch-session
12487 Fetch all eligible articles in all groups
12488 (@code{gnus-agent-fetch-session}).
12491 @kindex J S (Agent Group)
12492 @findex gnus-group-send-drafts
12493 Send all sendable messages in the draft group
12494 (@code{gnus-agent-fetch-session}). @xref{Drafts}.
12497 @kindex J a (Agent Group)
12498 @findex gnus-agent-add-group
12499 Add the current group to an Agent category
12500 (@code{gnus-agent-add-group}). This command understands the
12501 process/prefix convention (@pxref{Process/Prefix}).
12504 @kindex J r (Agent Group)
12505 @findex gnus-agent-remove-group
12506 Remove the current group from its category, if any
12507 (@code{gnus-agent-remove-group}). This command understands the
12508 process/prefix convention (@pxref{Process/Prefix}).
12513 @node Summary Agent Commands
12514 @subsubsection Summary Agent Commands
12518 @kindex J # (Agent Summary)
12519 @findex gnus-agent-mark-article
12520 Mark the article for downloading (@code{gnus-agent-mark-article}).
12523 @kindex J M-# (Agent Summary)
12524 @findex gnus-agent-unmark-article
12525 Remove the downloading mark from the article
12526 (@code{gnus-agent-unmark-article}).
12529 @kindex @@ (Agent Summary)
12530 @findex gnus-agent-toggle-mark
12531 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
12534 @kindex J c (Agent Summary)
12535 @findex gnus-agent-catchup
12536 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
12541 @node Server Agent Commands
12542 @subsubsection Server Agent Commands
12546 @kindex J a (Agent Server)
12547 @findex gnus-agent-add-server
12548 Add the current server to the list of servers covered by the Gnus Agent
12549 (@code{gnus-agent-add-server}).
12552 @kindex J r (Agent Server)
12553 @findex gnus-agent-remove-server
12554 Remove the current server from the list of servers covered by the Gnus
12555 Agent (@code{gnus-agent-remove-server}).
12561 @subsection Agent Expiry
12563 @vindex gnus-agent-expire-days
12564 @findex gnus-agent-expire
12565 @kindex M-x gnus-agent-expire
12566 @cindex Agent expiry
12567 @cindex Gnus Agent expiry
12570 @code{nnagent} doesn't handle expiry. Instead, there's a special
12571 @code{gnus-agent-expire} command that will expire all read articles that
12572 are older than @code{gnus-agent-expire-days} days. It can be run
12573 whenever you feel that you're running out of space. It's not
12574 particularly fast or efficient, and it's not a particularly good idea to
12575 interrupt it (with @kbd{C-g} or anything else) once you've started it.
12577 @vindex gnus-agent-expire-all
12578 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
12579 expire all articles---unread, read, ticked and dormant. If @code{nil}
12580 (which is the default), only read articles are eligible for expiry, and
12581 unread, ticked and dormant articles will be kept indefinitely.
12584 @node Outgoing Messages
12585 @subsection Outgoing Messages
12587 When Gnus is unplugged, all outgoing messages (both mail and news) are
12588 stored in the draft groups (@pxref{Drafts}). You can view them there
12589 after posting, and edit them at will.
12591 When Gnus is plugged again, you can send the messages either from the
12592 draft group with the special commands available there, or you can use
12593 the @kbd{J S} command in the group buffer to send all the sendable
12594 messages in the draft group.
12598 @node Agent Variables
12599 @subsection Agent Variables
12602 @item gnus-agent-directory
12603 @vindex gnus-agent-directory
12604 Where the Gnus Agent will store its files. The default is
12605 @file{~/News/agent/}.
12607 @item gnus-agent-handle-level
12608 @vindex gnus-agent-handle-level
12609 Groups on levels (@pxref{Group Levels}) higher than this variable will
12610 be ignored by the Agent. The default is @code{gnus-level-subscribed},
12611 which means that only subscribed group will be considered by the Agent
12614 @item gnus-agent-plugged-hook
12615 @vindex gnus-agent-plugged-hook
12616 Hook run when connecting to the network.
12618 @item gnus-agent-unplugged-hook
12619 @vindex gnus-agent-unplugged-hook
12620 Hook run when disconnecting from the network.
12625 @node Example Setup
12626 @subsection Example Setup
12628 If you don't want to read this manual, and you have a fairly standard
12629 setup, you may be able to use something like the following as your
12630 @file{.gnus.el} file to get started.
12633 ;;; Define how Gnus is to fetch news. We do this over NNTP
12634 ;;; from your ISP's server.
12635 (setq gnus-select-method '(nntp "nntp.your-isp.com"))
12637 ;;; Define how Gnus is to read your mail. We read mail from
12638 ;;; your ISP's POP server.
12639 (setenv "MAILHOST" "pop.your-isp.com")
12640 (setq nnmail-spool-file "po:username")
12642 ;;; Say how Gnus is to store the mail. We use nnml groups.
12643 (setq gnus-secondary-select-methods '((nnml "")))
12645 ;;; Make Gnus into an offline newsreader.
12649 That should be it, basically. Put that in your @file{~/.gnus.el} file,
12650 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
12653 If this is the first time you've run Gnus, you will be subscribed
12654 automatically to a few default newsgroups. You'll probably want to
12655 subscribe to more groups, and to do that, you have to query the
12656 @sc{nntp} server for a complete list of groups with the @kbd{A A}
12657 command. This usually takes quite a while, but you only have to do it
12660 After reading and parsing a while, you'll be presented with a list of
12661 groups. Subscribe to the ones you want to read with the @kbd{u}
12662 command. @kbd{l} to make all the killed groups disappear after you've
12663 subscribe to all the groups you want to read. (@kbd{A k} will bring
12664 back all the killed groups.)
12666 You can now read the groups at once, or you can download the articles
12667 with the @kbd{J s} command. And then read the rest of this manual to
12668 find out which of the other gazillion things you want to customize.
12671 @node Batching Agents
12672 @subsection Batching Agents
12674 Having the Gnus Agent fetch articles (and post whatever messages you've
12675 written) is quite easy once you've gotten things set up properly. The
12676 following shell script will do everything that is necessary:
12680 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
12684 @node Agent Caveats
12685 @subsection Agent Caveats
12687 The Gnus Agent doesn't seem to work like most other offline
12688 newsreaders. Here are some common questions that some imaginary people
12692 @item If I read an article while plugged, do they get entered into the
12697 @item If I read an article while plugged, and the article already exists
12698 in the Agent, will it get downloaded once more?
12704 In short, when Gnus is unplugged, it only looks into the locally stored
12705 articles; when it's plugged, it only talks to your ISP.
12712 Other people use @dfn{kill files}, but we here at Gnus Towers like
12713 scoring better than killing, so we'd rather switch than fight. They do
12714 something completely different as well, so sit up straight and pay
12717 @vindex gnus-summary-mark-below
12718 All articles have a default score (@code{gnus-summary-default-score}),
12719 which is 0 by default. This score may be raised or lowered either
12720 interactively or by score files. Articles that have a score lower than
12721 @code{gnus-summary-mark-below} are marked as read.
12723 Gnus will read any @dfn{score files} that apply to the current group
12724 before generating the summary buffer.
12726 There are several commands in the summary buffer that insert score
12727 entries based on the current article. You can, for instance, ask Gnus to
12728 lower or increase the score of all articles with a certain subject.
12730 There are two sorts of scoring entries: Permanent and temporary.
12731 Temporary score entries are self-expiring entries. Any entries that are
12732 temporary and have not been used for, say, a week, will be removed
12733 silently to help keep the sizes of the score files down.
12736 * Summary Score Commands:: Adding score entries for the current group.
12737 * Group Score Commands:: General score commands.
12738 * Score Variables:: Customize your scoring. (My, what terminology).
12739 * Score File Format:: What a score file may contain.
12740 * Score File Editing:: You can edit score files by hand as well.
12741 * Adaptive Scoring:: Big Sister Gnus knows what you read.
12742 * Home Score File:: How to say where new score entries are to go.
12743 * Followups To Yourself:: Having Gnus notice when people answer you.
12744 * Scoring Tips:: How to score effectively.
12745 * Reverse Scoring:: That problem child of old is not problem.
12746 * Global Score Files:: Earth-spanning, ear-splitting score files.
12747 * Kill Files:: They are still here, but they can be ignored.
12748 * Converting Kill Files:: Translating kill files to score files.
12749 * GroupLens:: Getting predictions on what you like to read.
12750 * Advanced Scoring:: Using logical expressions to build score rules.
12751 * Score Decays:: It can be useful to let scores wither away.
12755 @node Summary Score Commands
12756 @section Summary Score Commands
12757 @cindex score commands
12759 The score commands that alter score entries do not actually modify real
12760 score files. That would be too inefficient. Gnus maintains a cache of
12761 previously loaded score files, one of which is considered the
12762 @dfn{current score file alist}. The score commands simply insert
12763 entries into this list, and upon group exit, this list is saved.
12765 The current score file is by default the group's local score file, even
12766 if no such score file actually exists. To insert score commands into
12767 some other score file (e.g. @file{all.SCORE}), you must first make this
12768 score file the current one.
12770 General score commands that don't actually change the score file:
12775 @kindex V s (Summary)
12776 @findex gnus-summary-set-score
12777 Set the score of the current article (@code{gnus-summary-set-score}).
12780 @kindex V S (Summary)
12781 @findex gnus-summary-current-score
12782 Display the score of the current article
12783 (@code{gnus-summary-current-score}).
12786 @kindex V t (Summary)
12787 @findex gnus-score-find-trace
12788 Display all score rules that have been used on the current article
12789 (@code{gnus-score-find-trace}).
12792 @kindex V R (Summary)
12793 @findex gnus-summary-rescore
12794 Run the current summary through the scoring process
12795 (@code{gnus-summary-rescore}). This might be useful if you're playing
12796 around with your score files behind Gnus' back and want to see the
12797 effect you're having.
12800 @kindex V c (Summary)
12801 @findex gnus-score-change-score-file
12802 Make a different score file the current
12803 (@code{gnus-score-change-score-file}).
12806 @kindex V e (Summary)
12807 @findex gnus-score-edit-current-scores
12808 Edit the current score file (@code{gnus-score-edit-current-scores}).
12809 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
12813 @kindex V f (Summary)
12814 @findex gnus-score-edit-file
12815 Edit a score file and make this score file the current one
12816 (@code{gnus-score-edit-file}).
12819 @kindex V F (Summary)
12820 @findex gnus-score-flush-cache
12821 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
12822 after editing score files.
12825 @kindex V C (Summary)
12826 @findex gnus-score-customize
12827 Customize a score file in a visually pleasing manner
12828 (@code{gnus-score-customize}).
12832 The rest of these commands modify the local score file.
12837 @kindex V m (Summary)
12838 @findex gnus-score-set-mark-below
12839 Prompt for a score, and mark all articles with a score below this as
12840 read (@code{gnus-score-set-mark-below}).
12843 @kindex V x (Summary)
12844 @findex gnus-score-set-expunge-below
12845 Prompt for a score, and add a score rule to the current score file to
12846 expunge all articles below this score
12847 (@code{gnus-score-set-expunge-below}).
12850 The keystrokes for actually making score entries follow a very regular
12851 pattern, so there's no need to list all the commands. (Hundreds of
12854 @findex gnus-summary-increase-score
12855 @findex gnus-summary-lower-score
12859 The first key is either @kbd{I} (upper case i) for increasing the score
12860 or @kbd{L} for lowering the score.
12862 The second key says what header you want to score on. The following
12863 keys are available:
12867 Score on the author name.
12870 Score on the subject line.
12873 Score on the @code{Xref} line---i.e., the cross-posting line.
12876 Score on the @code{References} line.
12882 Score on the number of lines.
12885 Score on the @code{Message-ID} header.
12888 Score on followups---this matches the author name, and adds scores to
12889 the followups to this author.
12903 The third key is the match type. Which match types are valid depends on
12904 what headers you are scoring on.
12916 Substring matching.
12919 Fuzzy matching (@pxref{Fuzzy Matching}).
12948 Greater than number.
12953 The fourth and final key says whether this is a temporary (i.e., expiring)
12954 score entry, or a permanent (i.e., non-expiring) score entry, or whether
12955 it is to be done immediately, without adding to the score file.
12959 Temporary score entry.
12962 Permanent score entry.
12965 Immediately scoring.
12970 So, let's say you want to increase the score on the current author with
12971 exact matching permanently: @kbd{I a e p}. If you want to lower the
12972 score based on the subject line, using substring matching, and make a
12973 temporary score entry: @kbd{L s s t}. Pretty easy.
12975 To make things a bit more complicated, there are shortcuts. If you use
12976 a capital letter on either the second or third keys, Gnus will use
12977 defaults for the remaining one or two keystrokes. The defaults are
12978 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
12979 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
12981 These functions take both the numerical prefix and the symbolic prefix
12982 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
12983 (or increase) the score of the article. A symbolic prefix of @code{a}
12984 says to use the @file{all.SCORE} file for the command instead of the
12985 current score file.
12987 @vindex gnus-score-mimic-keymap
12988 The @code{gnus-score-mimic-keymap} says whether these commands will
12989 pretend they are keymaps or not.
12992 @node Group Score Commands
12993 @section Group Score Commands
12994 @cindex group score commands
12996 There aren't many of these as yet, I'm afraid.
13001 @kindex W f (Group)
13002 @findex gnus-score-flush-cache
13003 Gnus maintains a cache of score alists to avoid having to reload them
13004 all the time. This command will flush the cache
13005 (@code{gnus-score-flush-cache}).
13009 You can do scoring from the command line by saying something like:
13011 @findex gnus-batch-score
13012 @cindex batch scoring
13014 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
13018 @node Score Variables
13019 @section Score Variables
13020 @cindex score variables
13024 @item gnus-use-scoring
13025 @vindex gnus-use-scoring
13026 If @code{nil}, Gnus will not check for score files, and will not, in
13027 general, do any score-related work. This is @code{t} by default.
13029 @item gnus-kill-killed
13030 @vindex gnus-kill-killed
13031 If this variable is @code{nil}, Gnus will never apply score files to
13032 articles that have already been through the kill process. While this
13033 may save you lots of time, it also means that if you apply a kill file
13034 to a group, and then change the kill file and want to run it over you
13035 group again to kill more articles, it won't work. You have to set this
13036 variable to @code{t} to do that. (It is @code{t} by default.)
13038 @item gnus-kill-files-directory
13039 @vindex gnus-kill-files-directory
13040 All kill and score files will be stored in this directory, which is
13041 initialized from the @code{SAVEDIR} environment variable by default.
13042 This is @file{~/News/} by default.
13044 @item gnus-score-file-suffix
13045 @vindex gnus-score-file-suffix
13046 Suffix to add to the group name to arrive at the score file name
13047 (@samp{SCORE} by default.)
13049 @item gnus-score-uncacheable-files
13050 @vindex gnus-score-uncacheable-files
13051 @cindex score cache
13052 All score files are normally cached to avoid excessive re-loading of
13053 score files. However, if this might make you Emacs grow big and
13054 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
13055 @file{all.SCORE}, while it might be a good idea to not cache
13056 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
13057 variable is @samp{ADAPT$} by default, so no adaptive score files will
13060 @item gnus-save-score
13061 @vindex gnus-save-score
13062 If you have really complicated score files, and do lots of batch
13063 scoring, then you might set this variable to @code{t}. This will make
13064 Gnus save the scores into the @file{.newsrc.eld} file.
13066 If you do not set this to @code{t}, then manual scores (like those set
13067 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
13068 across group visits.
13070 @item gnus-score-interactive-default-score
13071 @vindex gnus-score-interactive-default-score
13072 Score used by all the interactive raise/lower commands to raise/lower
13073 score with. Default is 1000, which may seem excessive, but this is to
13074 ensure that the adaptive scoring scheme gets enough room to play with.
13075 We don't want the small changes from the adaptive scoring to overwrite
13076 manually entered data.
13078 @item gnus-summary-default-score
13079 @vindex gnus-summary-default-score
13080 Default score of an article, which is 0 by default.
13082 @item gnus-summary-expunge-below
13083 @vindex gnus-summary-expunge-below
13084 Don't display the summary lines of articles that have scores lower than
13085 this variable. This is @code{nil} by default, which means that no
13086 articles will be hidden. This variable is local to the summary buffers,
13087 and has to be set from @code{gnus-summary-mode-hook}.
13089 @item gnus-score-over-mark
13090 @vindex gnus-score-over-mark
13091 Mark (in the third column) used for articles with a score over the
13092 default. Default is @samp{+}.
13094 @item gnus-score-below-mark
13095 @vindex gnus-score-below-mark
13096 Mark (in the third column) used for articles with a score below the
13097 default. Default is @samp{-}.
13099 @item gnus-score-find-score-files-function
13100 @vindex gnus-score-find-score-files-function
13101 Function used to find score files for the current group. This function
13102 is called with the name of the group as the argument.
13104 Predefined functions available are:
13107 @item gnus-score-find-single
13108 @findex gnus-score-find-single
13109 Only apply the group's own score file.
13111 @item gnus-score-find-bnews
13112 @findex gnus-score-find-bnews
13113 Apply all score files that match, using bnews syntax. This is the
13114 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
13115 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
13116 @file{gnu.all.SCORE} would all apply. In short, the instances of
13117 @samp{all} in the score file names are translated into @samp{.*}, and
13118 then a regexp match is done.
13120 This means that if you have some score entries that you want to apply to
13121 all groups, then you put those entries in the @file{all.SCORE} file.
13123 The score files are applied in a semi-random order, although Gnus will
13124 try to apply the more general score files before the more specific score
13125 files. It does this by looking at the number of elements in the score
13126 file names---discarding the @samp{all} elements.
13128 @item gnus-score-find-hierarchical
13129 @findex gnus-score-find-hierarchical
13130 Apply all score files from all the parent groups. This means that you
13131 can't have score files like @file{all.SCORE}, but you can have
13132 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
13135 This variable can also be a list of functions. In that case, all these
13136 functions will be called, and all the returned lists of score files will
13137 be applied. These functions can also return lists of score alists
13138 directly. In that case, the functions that return these non-file score
13139 alists should probably be placed before the ``real'' score file
13140 functions, to ensure that the last score file returned is the local
13143 @item gnus-score-expiry-days
13144 @vindex gnus-score-expiry-days
13145 This variable says how many days should pass before an unused score file
13146 entry is expired. If this variable is @code{nil}, no score file entries
13147 are expired. It's 7 by default.
13149 @item gnus-update-score-entry-dates
13150 @vindex gnus-update-score-entry-dates
13151 If this variable is non-@code{nil}, matching score entries will have
13152 their dates updated. (This is how Gnus controls expiry---all
13153 non-matching entries will become too old while matching entries will
13154 stay fresh and young.) However, if you set this variable to @code{nil},
13155 even matching entries will grow old and will have to face that oh-so
13158 @item gnus-score-after-write-file-function
13159 @vindex gnus-score-after-write-file-function
13160 Function called with the name of the score file just written.
13162 @item gnus-score-thread-simplify
13163 @vindex gnus-score-thread-simplify
13164 If this variable is non-@code{nil}, article subjects will be simplified
13165 for subject scoring purposes in the same manner as with
13166 threading---according to the current value of
13167 gnus-simplify-subject-functions. If the scoring entry uses
13168 @code{substring} or @code{exact} matching, the match will also be
13169 simplified in this manner.
13174 @node Score File Format
13175 @section Score File Format
13176 @cindex score file format
13178 A score file is an @code{emacs-lisp} file that normally contains just a
13179 single form. Casual users are not expected to edit these files;
13180 everything can be changed from the summary buffer.
13182 Anyway, if you'd like to dig into it yourself, here's an example:
13186 ("Lars Ingebrigtsen" -10000)
13188 ("larsi\\|lmi" -50000 nil R))
13190 ("Ding is Badd" nil 728373))
13192 ("alt.politics" -1000 728372 s))
13197 (mark-and-expunge -10)
13201 (files "/hom/larsi/News/gnu.SCORE")
13202 (exclude-files "all.SCORE")
13203 (local (gnus-newsgroup-auto-expire t)
13204 (gnus-summary-make-false-root empty))
13208 This example demonstrates most score file elements. For a different
13209 approach, see @pxref{Advanced Scoring}.
13211 Even though this looks much like lisp code, nothing here is actually
13212 @code{eval}ed. The lisp reader is used to read this form, though, so it
13213 has to be valid syntactically, if not semantically.
13215 Six keys are supported by this alist:
13220 If the key is a string, it is the name of the header to perform the
13221 match on. Scoring can only be performed on these eight headers:
13222 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
13223 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
13224 these headers, there are three strings to tell Gnus to fetch the entire
13225 article and do the match on larger parts of the article: @code{Body}
13226 will perform the match on the body of the article, @code{Head} will
13227 perform the match on the head of the article, and @code{All} will
13228 perform the match on the entire article. Note that using any of these
13229 last three keys will slow down group entry @emph{considerably}. The
13230 final ``header'' you can score on is @code{Followup}. These score
13231 entries will result in new score entries being added for all follow-ups
13232 to articles that matches these score entries.
13234 Following this key is a arbitrary number of score entries, where each
13235 score entry has one to four elements.
13239 The first element is the @dfn{match element}. On most headers this will
13240 be a string, but on the Lines and Chars headers, this must be an
13244 If the second element is present, it should be a number---the @dfn{score
13245 element}. This number should be an integer in the neginf to posinf
13246 interval. This number is added to the score of the article if the match
13247 is successful. If this element is not present, the
13248 @code{gnus-score-interactive-default-score} number will be used
13249 instead. This is 1000 by default.
13252 If the third element is present, it should be a number---the @dfn{date
13253 element}. This date says when the last time this score entry matched,
13254 which provides a mechanism for expiring the score entries. It this
13255 element is not present, the score entry is permanent. The date is
13256 represented by the number of days since December 31, 1 BCE.
13259 If the fourth element is present, it should be a symbol---the @dfn{type
13260 element}. This element specifies what function should be used to see
13261 whether this score entry matches the article. What match types that can
13262 be used depends on what header you wish to perform the match on.
13265 @item From, Subject, References, Xref, Message-ID
13266 For most header types, there are the @code{r} and @code{R} (regexp), as
13267 well as @code{s} and @code{S} (substring) types, and @code{e} and
13268 @code{E} (exact match), and @code{w} (word match) types. If this
13269 element is not present, Gnus will assume that substring matching should
13270 be used. @code{R}, @code{S}, and @code{E} differ from the others in
13271 that the matches will be done in a case-sensitive manner. All these
13272 one-letter types are really just abbreviations for the @code{regexp},
13273 @code{string}, @code{exact}, and @code{word} types, which you can use
13274 instead, if you feel like.
13277 These two headers use different match types: @code{<}, @code{>},
13278 @code{=}, @code{>=} and @code{<=}.
13280 These predicates are true if
13283 (PREDICATE HEADER MATCH)
13286 evaluates to non-@code{nil}. For instance, the advanced match
13287 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
13294 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
13295 the match, we get the score added if the article has less than 4 lines.
13296 (It's easy to get confused and think it's the other way around. But
13297 it's not. I think.)
13299 When matching on @code{Lines}, be careful because some backends (like
13300 @code{nndir}) do not generate @code{Lines} header, so every article ends
13301 up being marked as having 0 lines. This can lead to strange results if
13302 you happen to lower score of the articles with few lines.
13305 For the Date header we have three kinda silly match types:
13306 @code{before}, @code{at} and @code{after}. I can't really imagine this
13307 ever being useful, but, like, it would feel kinda silly not to provide
13308 this function. Just in case. You never know. Better safe than sorry.
13309 Once burnt, twice shy. Don't judge a book by its cover. Never not have
13310 sex on a first date. (I have been told that at least one person, and I
13311 quote, ``found this function indispensable'', however.)
13315 A more useful match type is @code{regexp}. With it, you can match the
13316 date string using a regular expression. The date is normalized to
13317 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
13318 you want to match all articles that have been posted on April 1st in
13319 every year, you could use @samp{....0401.........} as a match string,
13320 for instance. (Note that the date is kept in its original time zone, so
13321 this will match articles that were posted when it was April 1st where
13322 the article was posted from. Time zones are such wholesome fun for the
13325 @item Head, Body, All
13326 These three match keys use the same match types as the @code{From} (etc)
13330 This match key is somewhat special, in that it will match the
13331 @code{From} header, and affect the score of not only the matching
13332 articles, but also all followups to the matching articles. This allows
13333 you e.g. increase the score of followups to your own articles, or
13334 decrease the score of followups to the articles of some known
13335 trouble-maker. Uses the same match types as the @code{From} header
13336 uses. (Using this match key will lead to creation of @file{ADAPT}
13340 This match key works along the same lines as the @code{Followup} match
13341 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
13342 @samp{thread} match. This will add a new @samp{thread} match for each
13343 article that has @var{X} in its @code{References} header. (These new
13344 @samp{thread} matches will use the @code{Message-ID}s of these matching
13345 articles.) This will ensure that you can raise/lower the score of an
13346 entire thread, even though some articles in the thread may not have
13347 complete @code{References} headers. Note that using this may lead to
13348 undeterministic scores of the articles in the thread. (Using this match
13349 key will lead to creation of @file{ADAPT} files.)
13353 @cindex Score File Atoms
13355 The value of this entry should be a number. Any articles with a score
13356 lower than this number will be marked as read.
13359 The value of this entry should be a number. Any articles with a score
13360 lower than this number will be removed from the summary buffer.
13362 @item mark-and-expunge
13363 The value of this entry should be a number. Any articles with a score
13364 lower than this number will be marked as read and removed from the
13367 @item thread-mark-and-expunge
13368 The value of this entry should be a number. All articles that belong to
13369 a thread that has a total score below this number will be marked as read
13370 and removed from the summary buffer. @code{gnus-thread-score-function}
13371 says how to compute the total score for a thread.
13374 The value of this entry should be any number of file names. These files
13375 are assumed to be score files as well, and will be loaded the same way
13378 @item exclude-files
13379 The clue of this entry should be any number of files. These files will
13380 not be loaded, even though they would normally be so, for some reason or
13384 The value of this entry will be @code{eval}el. This element will be
13385 ignored when handling global score files.
13388 Read-only score files will not be updated or saved. Global score files
13389 should feature this atom (@pxref{Global Score Files}). (Note:
13390 @dfn{Global} here really means @dfn{global}; not your personal
13391 apply-to-all-groups score files.)
13394 The value of this entry should be a number. Articles that do not have
13395 parents will get this number added to their scores. Imagine you follow
13396 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
13397 will only follow a few of the threads, also want to see any new threads.
13399 You can do this with the following two score file entries:
13403 (mark-and-expunge -100)
13406 When you enter the group the first time, you will only see the new
13407 threads. You then raise the score of the threads that you find
13408 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
13409 rest. Next time you enter the group, you will see new articles in the
13410 interesting threads, plus any new threads.
13412 I.e.---the orphan score atom is for high-volume groups where there
13413 exist a few interesting threads which can't be found automatically by
13414 ordinary scoring rules.
13417 This entry controls the adaptive scoring. If it is @code{t}, the
13418 default adaptive scoring rules will be used. If it is @code{ignore}, no
13419 adaptive scoring will be performed on this group. If it is a list, this
13420 list will be used as the adaptive scoring rules. If it isn't present,
13421 or is something other than @code{t} or @code{ignore}, the default
13422 adaptive scoring rules will be used. If you want to use adaptive
13423 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
13424 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
13425 not want adaptive scoring. If you only want adaptive scoring in a few
13426 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
13427 insert @code{(adapt t)} in the score files of the groups where you want
13431 All adaptive score entries will go to the file named by this entry. It
13432 will also be applied when entering the group. This atom might be handy
13433 if you want to adapt on several groups at once, using the same adaptive
13434 file for a number of groups.
13437 @cindex local variables
13438 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
13439 Each @var{var} will be made buffer-local to the current summary buffer,
13440 and set to the value specified. This is a convenient, if somewhat
13441 strange, way of setting variables in some groups if you don't like hooks
13442 much. Note that the @var{value} won't be evaluated.
13446 @node Score File Editing
13447 @section Score File Editing
13449 You normally enter all scoring commands from the summary buffer, but you
13450 might feel the urge to edit them by hand as well, so we've supplied you
13451 with a mode for that.
13453 It's simply a slightly customized @code{emacs-lisp} mode, with these
13454 additional commands:
13459 @kindex C-c C-c (Score)
13460 @findex gnus-score-edit-done
13461 Save the changes you have made and return to the summary buffer
13462 (@code{gnus-score-edit-done}).
13465 @kindex C-c C-d (Score)
13466 @findex gnus-score-edit-insert-date
13467 Insert the current date in numerical format
13468 (@code{gnus-score-edit-insert-date}). This is really the day number, if
13469 you were wondering.
13472 @kindex C-c C-p (Score)
13473 @findex gnus-score-pretty-print
13474 The adaptive score files are saved in an unformatted fashion. If you
13475 intend to read one of these files, you want to @dfn{pretty print} it
13476 first. This command (@code{gnus-score-pretty-print}) does that for
13481 Type @kbd{M-x gnus-score-mode} to use this mode.
13483 @vindex gnus-score-mode-hook
13484 @code{gnus-score-menu-hook} is run in score mode buffers.
13486 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
13487 e} to begin editing score files.
13490 @node Adaptive Scoring
13491 @section Adaptive Scoring
13492 @cindex adaptive scoring
13494 If all this scoring is getting you down, Gnus has a way of making it all
13495 happen automatically---as if by magic. Or rather, as if by artificial
13496 stupidity, to be precise.
13498 @vindex gnus-use-adaptive-scoring
13499 When you read an article, or mark an article as read, or kill an
13500 article, you leave marks behind. On exit from the group, Gnus can sniff
13501 these marks and add score elements depending on what marks it finds.
13502 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
13503 @code{t} or @code{(line)}. If you want score adaptively on separate
13504 words appearing in the subjects, you should set this variable to
13505 @code{(word)}. If you want to use both adaptive methods, set this
13506 variable to @code{(word line)}.
13508 @vindex gnus-default-adaptive-score-alist
13509 To give you complete control over the scoring process, you can customize
13510 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
13511 might look something like this:
13514 (defvar gnus-default-adaptive-score-alist
13515 '((gnus-unread-mark)
13516 (gnus-ticked-mark (from 4))
13517 (gnus-dormant-mark (from 5))
13518 (gnus-del-mark (from -4) (subject -1))
13519 (gnus-read-mark (from 4) (subject 2))
13520 (gnus-expirable-mark (from -1) (subject -1))
13521 (gnus-killed-mark (from -1) (subject -3))
13522 (gnus-kill-file-mark)
13523 (gnus-ancient-mark)
13524 (gnus-low-score-mark)
13525 (gnus-catchup-mark (from -1) (subject -1))))
13528 As you see, each element in this alist has a mark as a key (either a
13529 variable name or a ``real'' mark---a character). Following this key is
13530 a arbitrary number of header/score pairs. If there are no header/score
13531 pairs following the key, no adaptive scoring will be done on articles
13532 that have that key as the article mark. For instance, articles with
13533 @code{gnus-unread-mark} in the example above will not get adaptive score
13536 Each article can have only one mark, so just a single of these rules
13537 will be applied to each article.
13539 To take @code{gnus-del-mark} as an example---this alist says that all
13540 articles that have that mark (i.e., are marked with @samp{D}) will have a
13541 score entry added to lower based on the @code{From} header by -4, and
13542 lowered by @code{Subject} by -1. Change this to fit your prejudices.
13544 If you have marked 10 articles with the same subject with
13545 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
13546 That means that that subject will get a score of ten times -1, which
13547 should be, unless I'm much mistaken, -10.
13549 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
13550 the read articles will be marked with the @samp{E} mark. This'll
13551 probably make adaptive scoring slightly impossible, so auto-expiring and
13552 adaptive scoring doesn't really mix very well.
13554 The headers you can score on are @code{from}, @code{subject},
13555 @code{message-id}, @code{references}, @code{xref}, @code{lines},
13556 @code{chars} and @code{date}. In addition, you can score on
13557 @code{followup}, which will create an adaptive score entry that matches
13558 on the @code{References} header using the @code{Message-ID} of the
13559 current article, thereby matching the following thread.
13561 You can also score on @code{thread}, which will try to score all
13562 articles that appear in a thread. @code{thread} matches uses a
13563 @code{Message-ID} to match on the @code{References} header of the
13564 article. If the match is made, the @code{Message-ID} of the article is
13565 added to the @code{thread} rule. (Think about it. I'd recommend two
13566 aspirins afterwards.)
13568 If you use this scheme, you should set the score file atom @code{mark}
13569 to something small---like -300, perhaps, to avoid having small random
13570 changes result in articles getting marked as read.
13572 After using adaptive scoring for a week or so, Gnus should start to
13573 become properly trained and enhance the authors you like best, and kill
13574 the authors you like least, without you having to say so explicitly.
13576 You can control what groups the adaptive scoring is to be performed on
13577 by using the score files (@pxref{Score File Format}). This will also
13578 let you use different rules in different groups.
13580 @vindex gnus-adaptive-file-suffix
13581 The adaptive score entries will be put into a file where the name is the
13582 group name with @code{gnus-adaptive-file-suffix} appended. The default
13585 @vindex gnus-score-exact-adapt-limit
13586 When doing adaptive scoring, substring or fuzzy matching would probably
13587 give you the best results in most cases. However, if the header one
13588 matches is short, the possibility for false positives is great, so if
13589 the length of the match is less than
13590 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
13591 this variable is @code{nil}, exact matching will always be used to avoid
13594 @vindex gnus-default-adaptive-word-score-alist
13595 As mentioned above, you can adapt either on individual words or entire
13596 headers. If you adapt on words, the
13597 @code{gnus-default-adaptive-word-score-alist} variable says what score
13598 each instance of a word should add given a mark.
13601 (setq gnus-default-adaptive-word-score-alist
13602 `((,gnus-read-mark . 30)
13603 (,gnus-catchup-mark . -10)
13604 (,gnus-killed-mark . -20)
13605 (,gnus-del-mark . -15)))
13608 This is the default value. If you have adaption on words enabled, every
13609 word that appears in subjects of articles marked with
13610 @code{gnus-read-mark} will result in a score rule that increase the
13611 score with 30 points.
13613 @vindex gnus-default-ignored-adaptive-words
13614 @vindex gnus-ignored-adaptive-words
13615 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
13616 will be ignored. If you wish to add more words to be ignored, use the
13617 @code{gnus-ignored-adaptive-words} list instead.
13619 @vindex gnus-adaptive-word-syntax-table
13620 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
13621 syntax table in effect. It is similar to the standard syntax table, but
13622 it considers numbers to be non-word-constituent characters.
13624 @vindex gnus-adaptive-word-minimum
13625 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
13626 word scoring process will never bring down the score of an article to
13627 below this number. The default is @code{nil}.
13629 @vindex gnus-adaptive-word-no-group-words
13630 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
13631 won't adaptively word score any of the words in the group name. Useful
13632 for groups like @samp{comp.editors.emacs}, where most of the subject
13633 lines contain the word @samp{emacs}.
13635 After using this scheme for a while, it might be nice to write a
13636 @code{gnus-psychoanalyze-user} command to go through the rules and see
13637 what words you like and what words you don't like. Or perhaps not.
13639 Note that the adaptive word scoring thing is highly experimental and is
13640 likely to change in the future. Initial impressions seem to indicate
13641 that it's totally useless as it stands. Some more work (involving more
13642 rigorous statistical methods) will have to be done to make this useful.
13645 @node Home Score File
13646 @section Home Score File
13648 The score file where new score file entries will go is called the
13649 @dfn{home score file}. This is normally (and by default) the score file
13650 for the group itself. For instance, the home score file for
13651 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
13653 However, this may not be what you want. It is often convenient to share
13654 a common home score file among many groups---all @samp{emacs} groups
13655 could perhaps use the same home score file.
13657 @vindex gnus-home-score-file
13658 The variable that controls this is @code{gnus-home-score-file}. It can
13663 A string. Then this file will be used as the home score file for all
13667 A function. The result of this function will be used as the home score
13668 file. The function will be called with the name of the group as the
13672 A list. The elements in this list can be:
13676 @var{(regexp file-name)}. If the @var{regexp} matches the group name,
13677 the @var{file-name} will will be used as the home score file.
13680 A function. If the function returns non-nil, the result will be used as
13681 the home score file.
13684 A string. Use the string as the home score file.
13687 The list will be traversed from the beginning towards the end looking
13692 So, if you want to use just a single score file, you could say:
13695 (setq gnus-home-score-file
13696 "my-total-score-file.SCORE")
13699 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
13700 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
13702 @findex gnus-hierarchial-home-score-file
13704 (setq gnus-home-score-file
13705 'gnus-hierarchial-home-score-file)
13708 This is a ready-made function provided for your convenience.
13709 Other functions include
13712 @item gnus-current-home-score-file
13713 @findex gnus-current-home-score-file
13714 Return the ``current'' regular score file. This will make scoring
13715 commands add entry to the ``innermost'' matching score file.
13719 If you want to have one score file for the @samp{emacs} groups and
13720 another for the @samp{comp} groups, while letting all other groups use
13721 their own home score files:
13724 (setq gnus-home-score-file
13725 ;; All groups that match the regexp "\\.emacs"
13726 '(("\\.emacs" "emacs.SCORE")
13727 ;; All the comp groups in one score file
13728 ("^comp" "comp.SCORE")))
13731 @vindex gnus-home-adapt-file
13732 @code{gnus-home-adapt-file} works exactly the same way as
13733 @code{gnus-home-score-file}, but says what the home adaptive score file
13734 is instead. All new adaptive file entries will go into the file
13735 specified by this variable, and the same syntax is allowed.
13737 In addition to using @code{gnus-home-score-file} and
13738 @code{gnus-home-adapt-file}, you can also use group parameters
13739 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
13740 Parameters}) to achieve much the same. Group and topic parameters take
13741 precedence over this variable.
13744 @node Followups To Yourself
13745 @section Followups To Yourself
13747 Gnus offers two commands for picking out the @code{Message-ID} header in
13748 the current buffer. Gnus will then add a score rule that scores using
13749 this @code{Message-ID} on the @code{References} header of other
13750 articles. This will, in effect, increase the score of all articles that
13751 respond to the article in the current buffer. Quite useful if you want
13752 to easily note when people answer what you've said.
13756 @item gnus-score-followup-article
13757 @findex gnus-score-followup-article
13758 This will add a score to articles that directly follow up your own
13761 @item gnus-score-followup-thread
13762 @findex gnus-score-followup-thread
13763 This will add a score to all articles that appear in a thread ``below''
13767 @vindex message-sent-hook
13768 These two functions are both primarily meant to be used in hooks like
13769 @code{message-sent-hook}.
13771 If you look closely at your own @code{Message-ID}, you'll notice that
13772 the first two or three characters are always the same. Here's two of
13776 <x6u3u47icf.fsf@@eyesore.no>
13777 <x6sp9o7ibw.fsf@@eyesore.no>
13780 So ``my'' ident on this machine is @samp{x6}. This can be
13781 exploited---the following rule will raise the score on all followups to
13786 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
13790 Whether it's the first two or first three characters that are ``yours''
13791 is system-dependent.
13795 @section Scoring Tips
13796 @cindex scoring tips
13802 @cindex scoring crossposts
13803 If you want to lower the score of crossposts, the line to match on is
13804 the @code{Xref} header.
13806 ("xref" (" talk.politics.misc:" -1000))
13809 @item Multiple crossposts
13810 If you want to lower the score of articles that have been crossposted to
13811 more than, say, 3 groups:
13813 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
13816 @item Matching on the body
13817 This is generally not a very good idea---it takes a very long time.
13818 Gnus actually has to fetch each individual article from the server. But
13819 you might want to anyway, I guess. Even though there are three match
13820 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
13821 and stick with it in each score file. If you use any two, each article
13822 will be fetched @emph{twice}. If you want to match a bit on the
13823 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
13826 @item Marking as read
13827 You will probably want to mark articles that has a score below a certain
13828 number as read. This is most easily achieved by putting the following
13829 in your @file{all.SCORE} file:
13833 You may also consider doing something similar with @code{expunge}.
13835 @item Negated character classes
13836 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
13837 That will match newlines, which might lead to, well, The Unknown. Say
13838 @code{[^abcd\n]*} instead.
13842 @node Reverse Scoring
13843 @section Reverse Scoring
13844 @cindex reverse scoring
13846 If you want to keep just articles that have @samp{Sex with Emacs} in the
13847 subject header, and expunge all other articles, you could put something
13848 like this in your score file:
13852 ("Sex with Emacs" 2))
13857 So, you raise all articles that match @samp{Sex with Emacs} and mark the
13858 rest as read, and expunge them to boot.
13861 @node Global Score Files
13862 @section Global Score Files
13863 @cindex global score files
13865 Sure, other newsreaders have ``global kill files''. These are usually
13866 nothing more than a single kill file that applies to all groups, stored
13867 in the user's home directory. Bah! Puny, weak newsreaders!
13869 What I'm talking about here are Global Score Files. Score files from
13870 all over the world, from users everywhere, uniting all nations in one
13871 big, happy score file union! Ange-score! New and untested!
13873 @vindex gnus-global-score-files
13874 All you have to do to use other people's score files is to set the
13875 @code{gnus-global-score-files} variable. One entry for each score file,
13876 or each score file directory. Gnus will decide by itself what score
13877 files are applicable to which group.
13879 Say you want to use the score file
13880 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
13881 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
13884 (setq gnus-global-score-files
13885 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
13886 "/ftp@@ftp.some-where:/pub/score/"))
13889 @findex gnus-score-search-global-directories
13890 Simple, eh? Directory names must end with a @samp{/}. These
13891 directories are typically scanned only once during each Gnus session.
13892 If you feel the need to manually re-scan the remote directories, you can
13893 use the @code{gnus-score-search-global-directories} command.
13895 Note that, at present, using this option will slow down group entry
13896 somewhat. (That is---a lot.)
13898 If you want to start maintaining score files for other people to use,
13899 just put your score file up for anonymous ftp and announce it to the
13900 world. Become a retro-moderator! Participate in the retro-moderator
13901 wars sure to ensue, where retro-moderators battle it out for the
13902 sympathy of the people, luring them to use their score files on false
13903 premises! Yay! The net is saved!
13905 Here are some tips for the would-be retro-moderator, off the top of my
13911 Articles heavily crossposted are probably junk.
13913 To lower a single inappropriate article, lower by @code{Message-ID}.
13915 Particularly brilliant authors can be raised on a permanent basis.
13917 Authors that repeatedly post off-charter for the group can safely be
13918 lowered out of existence.
13920 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
13921 articles completely.
13924 Use expiring score entries to keep the size of the file down. You
13925 should probably have a long expiry period, though, as some sites keep
13926 old articles for a long time.
13929 ... I wonder whether other newsreaders will support global score files
13930 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
13931 Wave, xrn and 1stReader are bound to implement scoring. Should we start
13932 holding our breath yet?
13936 @section Kill Files
13939 Gnus still supports those pesky old kill files. In fact, the kill file
13940 entries can now be expiring, which is something I wrote before Daniel
13941 Quinlan thought of doing score files, so I've left the code in there.
13943 In short, kill processing is a lot slower (and I do mean @emph{a lot})
13944 than score processing, so it might be a good idea to rewrite your kill
13945 files into score files.
13947 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
13948 forms into this file, which means that you can use kill files as some
13949 sort of primitive hook function to be run on group entry, even though
13950 that isn't a very good idea.
13952 Normal kill files look like this:
13955 (gnus-kill "From" "Lars Ingebrigtsen")
13956 (gnus-kill "Subject" "ding")
13960 This will mark every article written by me as read, and remove the
13961 marked articles from the summary buffer. Very useful, you'll agree.
13963 Other programs use a totally different kill file syntax. If Gnus
13964 encounters what looks like a @code{rn} kill file, it will take a stab at
13967 Two summary functions for editing a GNUS kill file:
13972 @kindex M-k (Summary)
13973 @findex gnus-summary-edit-local-kill
13974 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
13977 @kindex M-K (Summary)
13978 @findex gnus-summary-edit-global-kill
13979 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
13982 Two group mode functions for editing the kill files:
13987 @kindex M-k (Group)
13988 @findex gnus-group-edit-local-kill
13989 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
13992 @kindex M-K (Group)
13993 @findex gnus-group-edit-global-kill
13994 Edit the general kill file (@code{gnus-group-edit-global-kill}).
13997 Kill file variables:
14000 @item gnus-kill-file-name
14001 @vindex gnus-kill-file-name
14002 A kill file for the group @samp{soc.motss} is normally called
14003 @file{soc.motss.KILL}. The suffix appended to the group name to get
14004 this file name is detailed by the @code{gnus-kill-file-name} variable.
14005 The ``global'' kill file (not in the score file sense of ``global'', of
14006 course) is just called @file{KILL}.
14008 @vindex gnus-kill-save-kill-file
14009 @item gnus-kill-save-kill-file
14010 If this variable is non-@code{nil}, Gnus will save the
14011 kill file after processing, which is necessary if you use expiring
14014 @item gnus-apply-kill-hook
14015 @vindex gnus-apply-kill-hook
14016 @findex gnus-apply-kill-file-unless-scored
14017 @findex gnus-apply-kill-file
14018 A hook called to apply kill files to a group. It is
14019 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
14020 kill file if you have a score file for the same group, you can set this
14021 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
14022 kill files to be processed, you should set this variable to @code{nil}.
14024 @item gnus-kill-file-mode-hook
14025 @vindex gnus-kill-file-mode-hook
14026 A hook called in kill-file mode buffers.
14031 @node Converting Kill Files
14032 @section Converting Kill Files
14034 @cindex converting kill files
14036 If you have loads of old kill files, you may want to convert them into
14037 score files. If they are ``regular'', you can use
14038 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
14041 The kill to score conversion package isn't included in Gnus by default.
14042 You can fetch it from
14043 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
14045 If your old kill files are very complex---if they contain more
14046 non-@code{gnus-kill} forms than not, you'll have to convert them by
14047 hand. Or just let them be as they are. Gnus will still use them as
14055 GroupLens is a collaborative filtering system that helps you work
14056 together with other people to find the quality news articles out of the
14057 huge volume of news articles generated every day.
14059 To accomplish this the GroupLens system combines your opinions about
14060 articles you have already read with the opinions of others who have done
14061 likewise and gives you a personalized prediction for each unread news
14062 article. Think of GroupLens as a matchmaker. GroupLens watches how you
14063 rate articles, and finds other people that rate articles the same way.
14064 Once it has found some people you agree with it tells you, in the form
14065 of a prediction, what they thought of the article. You can use this
14066 prediction to help you decide whether or not you want to read the
14070 * Using GroupLens:: How to make Gnus use GroupLens.
14071 * Rating Articles:: Letting GroupLens know how you rate articles.
14072 * Displaying Predictions:: Displaying predictions given by GroupLens.
14073 * GroupLens Variables:: Customizing GroupLens.
14077 @node Using GroupLens
14078 @subsection Using GroupLens
14080 To use GroupLens you must register a pseudonym with your local Better
14082 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
14083 better bit in town at the moment.
14085 Once you have registered you'll need to set a couple of variables.
14089 @item gnus-use-grouplens
14090 @vindex gnus-use-grouplens
14091 Setting this variable to a non-@code{nil} value will make Gnus hook into
14092 all the relevant GroupLens functions.
14094 @item grouplens-pseudonym
14095 @vindex grouplens-pseudonym
14096 This variable should be set to the pseudonym you got when registering
14097 with the Better Bit Bureau.
14099 @item grouplens-newsgroups
14100 @vindex grouplens-newsgroups
14101 A list of groups that you want to get GroupLens predictions for.
14105 That's the minimum of what you need to get up and running with GroupLens.
14106 Once you've registered, GroupLens will start giving you scores for
14107 articles based on the average of what other people think. But, to get
14108 the real benefit of GroupLens you need to start rating articles
14109 yourself. Then the scores GroupLens gives you will be personalized for
14110 you, based on how the people you usually agree with have already rated.
14113 @node Rating Articles
14114 @subsection Rating Articles
14116 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
14117 Where 1 means something like this article is a waste of bandwidth and 5
14118 means that the article was really good. The basic question to ask
14119 yourself is, "on a scale from 1 to 5 would I like to see more articles
14122 There are four ways to enter a rating for an article in GroupLens.
14127 @kindex r (GroupLens)
14128 @findex bbb-summary-rate-article
14129 This function will prompt you for a rating on a scale of one to five.
14132 @kindex k (GroupLens)
14133 @findex grouplens-score-thread
14134 This function will prompt you for a rating, and rate all the articles in
14135 the thread. This is really useful for some of those long running giant
14136 threads in rec.humor.
14140 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
14141 the score of the article you're reading.
14146 @kindex n (GroupLens)
14147 @findex grouplens-next-unread-article
14148 Rate the article and go to the next unread article.
14151 @kindex , (GroupLens)
14152 @findex grouplens-best-unread-article
14153 Rate the article and go to the next unread article with the highest score.
14157 If you want to give the current article a score of 4 and then go to the
14158 next article, just type @kbd{4 n}.
14161 @node Displaying Predictions
14162 @subsection Displaying Predictions
14164 GroupLens makes a prediction for you about how much you will like a
14165 news article. The predictions from GroupLens are on a scale from 1 to
14166 5, where 1 is the worst and 5 is the best. You can use the predictions
14167 from GroupLens in one of three ways controlled by the variable
14168 @code{gnus-grouplens-override-scoring}.
14170 @vindex gnus-grouplens-override-scoring
14171 There are three ways to display predictions in grouplens. You may
14172 choose to have the GroupLens scores contribute to, or override the
14173 regular gnus scoring mechanism. override is the default; however, some
14174 people prefer to see the Gnus scores plus the grouplens scores. To get
14175 the separate scoring behavior you need to set
14176 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
14177 GroupLens predictions combined with the grouplens scores set it to
14178 @code{'override} and to combine the scores set
14179 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
14180 the combine option you will also want to set the values for
14181 @code{grouplens-prediction-offset} and
14182 @code{grouplens-score-scale-factor}.
14184 @vindex grouplens-prediction-display
14185 In either case, GroupLens gives you a few choices for how you would like
14186 to see your predictions displayed. The display of predictions is
14187 controlled by the @code{grouplens-prediction-display} variable.
14189 The following are valid values for that variable.
14192 @item prediction-spot
14193 The higher the prediction, the further to the right an @samp{*} is
14196 @item confidence-interval
14197 A numeric confidence interval.
14199 @item prediction-bar
14200 The higher the prediction, the longer the bar.
14202 @item confidence-bar
14203 Numerical confidence.
14205 @item confidence-spot
14206 The spot gets bigger with more confidence.
14208 @item prediction-num
14209 Plain-old numeric value.
14211 @item confidence-plus-minus
14212 Prediction +/- confidence.
14217 @node GroupLens Variables
14218 @subsection GroupLens Variables
14222 @item gnus-summary-grouplens-line-format
14223 The summary line format used in GroupLens-enhanced summary buffers. It
14224 accepts the same specs as the normal summary line format (@pxref{Summary
14225 Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
14228 @item grouplens-bbb-host
14229 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
14232 @item grouplens-bbb-port
14233 Port of the host running the bbbd server. The default is 9000.
14235 @item grouplens-score-offset
14236 Offset the prediction by this value. In other words, subtract the
14237 prediction value by this number to arrive at the effective score. The
14240 @item grouplens-score-scale-factor
14241 This variable allows the user to magnify the effect of GroupLens scores.
14242 The scale factor is applied after the offset. The default is 1.
14247 @node Advanced Scoring
14248 @section Advanced Scoring
14250 Scoring on Subjects and From headers is nice enough, but what if you're
14251 really interested in what a person has to say only when she's talking
14252 about a particular subject? Or what if you really don't want to
14253 read what person A has to say when she's following up to person B, but
14254 want to read what she says when she's following up to person C?
14256 By using advanced scoring rules you may create arbitrarily complex
14260 * Advanced Scoring Syntax:: A definition.
14261 * Advanced Scoring Examples:: What they look like.
14262 * Advanced Scoring Tips:: Getting the most out of it.
14266 @node Advanced Scoring Syntax
14267 @subsection Advanced Scoring Syntax
14269 Ordinary scoring rules have a string as the first element in the rule.
14270 Advanced scoring rules have a list as the first element. The second
14271 element is the score to be applied if the first element evaluated to a
14272 non-@code{nil} value.
14274 These lists may consist of three logical operators, one redirection
14275 operator, and various match operators.
14282 This logical operator will evaluate each of its arguments until it finds
14283 one that evaluates to @code{false}, and then it'll stop. If all arguments
14284 evaluate to @code{true} values, then this operator will return
14289 This logical operator will evaluate each of its arguments until it finds
14290 one that evaluates to @code{true}. If no arguments are @code{true},
14291 then this operator will return @code{false}.
14296 This logical operator only takes a single argument. It returns the
14297 logical negation of the value of its argument.
14301 There is an @dfn{indirection operator} that will make its arguments
14302 apply to the ancestors of the current article being scored. For
14303 instance, @code{1-} will make score rules apply to the parent of the
14304 current article. @code{2-} will make score rules apply to the
14305 grandparent of the current article. Alternatively, you can write
14306 @code{^^}, where the number of @code{^}s (carets) says how far back into
14307 the ancestry you want to go.
14309 Finally, we have the match operators. These are the ones that do the
14310 real work. Match operators are header name strings followed by a match
14311 and a match type. A typical match operator looks like @samp{("from"
14312 "Lars Ingebrigtsen" s)}. The header names are the same as when using
14313 simple scoring, and the match types are also the same.
14316 @node Advanced Scoring Examples
14317 @subsection Advanced Scoring Examples
14319 Let's say you want to increase the score of articles written by Lars
14320 when he's talking about Gnus:
14324 ("from" "Lars Ingebrigtsen")
14325 ("subject" "Gnus"))
14331 When he writes long articles, he sometimes has something nice to say:
14335 ("from" "Lars Ingebrigtsen")
14342 However, when he responds to things written by Reig Eigil Logge, you
14343 really don't want to read what he's written:
14347 ("from" "Lars Ingebrigtsen")
14348 (1- ("from" "Reig Eigir Logge")))
14352 Everybody that follows up Redmondo when he writes about disappearing
14353 socks should have their scores raised, but only when they talk about
14354 white socks. However, when Lars talks about socks, it's usually not
14361 ("from" "redmondo@@.*no" r)
14362 ("body" "disappearing.*socks" t)))
14363 (! ("from" "Lars Ingebrigtsen"))
14364 ("body" "white.*socks"))
14368 The possibilities are endless.
14371 @node Advanced Scoring Tips
14372 @subsection Advanced Scoring Tips
14374 The @code{&} and @code{|} logical operators do short-circuit logic.
14375 That is, they stop processing their arguments when it's clear what the
14376 result of the operation will be. For instance, if one of the arguments
14377 of an @code{&} evaluates to @code{false}, there's no point in evaluating
14378 the rest of the arguments. This means that you should put slow matches
14379 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
14380 @samp{subject}) first.
14382 The indirection arguments (@code{1-} and so on) will make their
14383 arguments work on previous generations of the thread. If you say
14394 Then that means "score on the from header of the grandparent of the
14395 current article". An indirection is quite fast, but it's better to say:
14401 ("subject" "Gnus")))
14408 (1- ("from" "Lars"))
14409 (1- ("subject" "Gnus")))
14414 @section Score Decays
14415 @cindex score decays
14418 You may find that your scores have a tendency to grow without
14419 bounds, especially if you're using adaptive scoring. If scores get too
14420 big, they lose all meaning---they simply max out and it's difficult to
14421 use them in any sensible way.
14423 @vindex gnus-decay-scores
14424 @findex gnus-decay-score
14425 @vindex gnus-decay-score-function
14426 Gnus provides a mechanism for decaying scores to help with this problem.
14427 When score files are loaded and @code{gnus-decay-scores} is
14428 non-@code{nil}, Gnus will run the score files through the decaying
14429 mechanism thereby lowering the scores of all non-permanent score rules.
14430 The decay itself if performed by the @code{gnus-decay-score-function}
14431 function, which is @code{gnus-decay-score} by default. Here's the
14432 definition of that function:
14435 (defun gnus-decay-score (score)
14437 This is done according to `gnus-score-decay-constant'
14438 and `gnus-score-decay-scale'."
14441 (* (if (< score 0) 1 -1)
14443 (max gnus-score-decay-constant
14445 gnus-score-decay-scale)))))))
14448 @vindex gnus-score-decay-scale
14449 @vindex gnus-score-decay-constant
14450 @code{gnus-score-decay-constant} is 3 by default and
14451 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
14455 Scores between -3 and 3 will be set to 0 when this function is called.
14458 Scores with magnitudes between 3 and 60 will be shrunk by 3.
14461 Scores with magnitudes greater than 60 will be shrunk by 5% of the
14465 If you don't like this decay function, write your own. It is called
14466 with the score to be decayed as its only parameter, and it should return
14467 the new score, which should be an integer.
14469 Gnus will try to decay scores once a day. If you haven't run Gnus for
14470 four days, Gnus will decay the scores four times, for instance.
14477 * Process/Prefix:: A convention used by many treatment commands.
14478 * Interactive:: Making Gnus ask you many questions.
14479 * Symbolic Prefixes:: How to supply some Gnus functions with options.
14480 * Formatting Variables:: You can specify what buffers should look like.
14481 * Windows Configuration:: Configuring the Gnus buffer windows.
14482 * Faces and Fonts:: How to change how faces look.
14483 * Compilation:: How to speed Gnus up.
14484 * Mode Lines:: Displaying information in the mode lines.
14485 * Highlighting and Menus:: Making buffers look all nice and cozy.
14486 * Buttons:: Get tendonitis in ten easy steps!
14487 * Daemons:: Gnus can do things behind your back.
14488 * NoCeM:: How to avoid spam and other fatty foods.
14489 * Undo:: Some actions can be undone.
14490 * Moderation:: What to do if you're a moderator.
14491 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
14492 * Fuzzy Matching:: What's the big fuzz?
14493 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
14494 * Various Various:: Things that are really various.
14498 @node Process/Prefix
14499 @section Process/Prefix
14500 @cindex process/prefix convention
14502 Many functions, among them functions for moving, decoding and saving
14503 articles, use what is known as the @dfn{Process/Prefix convention}.
14505 This is a method for figuring out what articles the user wants the
14506 command to be performed on.
14510 If the numeric prefix is N, perform the operation on the next N
14511 articles, starting with the current one. If the numeric prefix is
14512 negative, perform the operation on the previous N articles, starting
14513 with the current one.
14515 @vindex transient-mark-mode
14516 If @code{transient-mark-mode} in non-@code{nil} and the region is
14517 active, all articles in the region will be worked upon.
14519 If there is no numeric prefix, but some articles are marked with the
14520 process mark, perform the operation on the articles marked with
14523 If there is neither a numeric prefix nor any articles marked with the
14524 process mark, just perform the operation on the current article.
14526 Quite simple, really, but it needs to be made clear so that surprises
14529 Commands that react to the process mark will push the current list of
14530 process marked articles onto a stack and will then clear all process
14531 marked articles. You can restore the previous configuration with the
14532 @kbd{M P y} command (@pxref{Setting Process Marks}).
14534 @vindex gnus-summary-goto-unread
14535 One thing that seems to shock & horrify lots of people is that, for
14536 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
14537 Since each @kbd{d} (which marks the current article as read) by default
14538 goes to the next unread article after marking, this means that @kbd{3 d}
14539 will mark the next three unread articles as read, no matter what the
14540 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
14541 @code{nil} for a more straightforward action.
14545 @section Interactive
14546 @cindex interaction
14550 @item gnus-novice-user
14551 @vindex gnus-novice-user
14552 If this variable is non-@code{nil}, you are either a newcomer to the
14553 World of Usenet, or you are very cautious, which is a nice thing to be,
14554 really. You will be given questions of the type ``Are you sure you want
14555 to do this?'' before doing anything dangerous. This is @code{t} by
14558 @item gnus-expert-user
14559 @vindex gnus-expert-user
14560 If this variable is non-@code{nil}, you will seldom be asked any
14561 questions by Gnus. It will simply assume you know what you're doing, no
14562 matter how strange.
14564 @item gnus-interactive-catchup
14565 @vindex gnus-interactive-catchup
14566 Require confirmation before catching up a group if non-@code{nil}. It
14567 is @code{t} by default.
14569 @item gnus-interactive-exit
14570 @vindex gnus-interactive-exit
14571 Require confirmation before exiting Gnus. This variable is @code{t} by
14576 @node Symbolic Prefixes
14577 @section Symbolic Prefixes
14578 @cindex symbolic prefixes
14580 Quite a lot of Emacs commands react to the (numeric) prefix. For
14581 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
14582 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
14583 rule of 900 to the current article.
14585 This is all nice and well, but what if you want to give a command some
14586 additional information? Well, what most commands do is interpret the
14587 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
14588 doesn't want a backup file to be created when saving the current buffer,
14589 for instance. But what if you want to save without making a backup
14590 file, and you want Emacs to flash lights and play a nice tune at the
14591 same time? You can't, and you're probably perfectly happy that way.
14593 @kindex M-i (Summary)
14594 @findex gnus-symbolic-argument
14595 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
14596 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
14597 character typed in is the value. You can stack as many @kbd{M-i}
14598 prefixes as you want. @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
14599 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b M-C-u} means
14600 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
14601 @code{b}''. You get the drift.
14603 Typing in symbolic prefixes to commands that don't accept them doesn't
14604 hurt, but it doesn't do any good either. Currently not many Gnus
14605 functions make use of the symbolic prefix.
14607 If you're interested in how Gnus implements this, @pxref{Extended
14611 @node Formatting Variables
14612 @section Formatting Variables
14613 @cindex formatting variables
14615 Throughout this manual you've probably noticed lots of variables called
14616 things like @code{gnus-group-line-format} and
14617 @code{gnus-summary-mode-line-format}. These control how Gnus is to
14618 output lines in the various buffers. There's quite a lot of them.
14619 Fortunately, they all use the same syntax, so there's not that much to
14622 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
14623 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
14624 lots of percentages everywhere.
14627 * Formatting Basics:: A formatting variable is basically a format string.
14628 * Mode Line Formatting:: Some rules about mode line formatting variables.
14629 * Advanced Formatting:: Modifying output in various ways.
14630 * User-Defined Specs:: Having Gnus call your own functions.
14631 * Formatting Fonts:: Making the formatting look colorful and nice.
14634 Currently Gnus uses the following formatting variables:
14635 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
14636 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
14637 @code{gnus-group-mode-line-format},
14638 @code{gnus-summary-mode-line-format},
14639 @code{gnus-article-mode-line-format},
14640 @code{gnus-server-mode-line-format}, and
14641 @code{gnus-summary-pick-line-format}.
14643 All these format variables can also be arbitrary elisp forms. In that
14644 case, they will be @code{eval}ed to insert the required lines.
14646 @kindex M-x gnus-update-format
14647 @findex gnus-update-format
14648 Gnus includes a command to help you while creating your own format
14649 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
14650 update the spec in question and pop you to a buffer where you can
14651 examine the resulting lisp code to be run to generate the line.
14655 @node Formatting Basics
14656 @subsection Formatting Basics
14658 Each @samp{%} element will be replaced by some string or other when the
14659 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
14660 spec, and pad with spaces to get a 5-character field''.
14662 As with normal C and Emacs Lisp formatting strings, the numerical
14663 modifier between the @samp{%} and the formatting type character will
14664 @dfn{pad} the output so that it is always at least that long.
14665 @samp{%5y} will make the field always (at least) five characters wide by
14666 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
14669 You may also wish to limit the length of the field to protect against
14670 particularly wide values. For that you can say @samp{%4,6y}, which
14671 means that the field will never be more than 6 characters wide and never
14672 less than 4 characters wide.
14675 @node Mode Line Formatting
14676 @subsection Mode Line Formatting
14678 Mode line formatting variables (e.g.,
14679 @code{gnus-summary-mode-line-format}) follow the same rules as other,
14680 buffer line oriented formatting variables (@pxref{Formatting Basics})
14681 with the following two differences:
14686 There must be no newline (@samp{\n}) at the end.
14689 The special @samp{%%b} spec can be used to display the buffer name.
14690 Well, it's no spec at all, really---@samp{%%} is just a way to quote
14691 @samp{%} to allow it to pass through the formatting machinery unmangled,
14692 so that Emacs receives @samp{%b}, which is something the Emacs mode line
14693 display interprets to mean ``show the buffer name''. For a full list of
14694 mode line specs Emacs understands, see the documentation of the
14695 @code{mode-line-format} variable.
14700 @node Advanced Formatting
14701 @subsection Advanced Formatting
14703 It is frequently useful to post-process the fields in some way.
14704 Padding, limiting, cutting off parts and suppressing certain values can
14705 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
14706 look like @samp{%~(cut 3)~(ignore "0")y}.
14708 These are the valid modifiers:
14713 Pad the field to the left with spaces until it reaches the required
14717 Pad the field to the right with spaces until it reaches the required
14722 Cut off characters from the left until it reaches the specified length.
14725 Cut off characters from the right until it reaches the specified
14730 Cut off the specified number of characters from the left.
14733 Cut off the specified number of characters from the right.
14736 Return an empty string if the field is equal to the specified value.
14739 Use the specified form as the field value when the @samp{@@} spec is
14743 Let's take an example. The @samp{%o} spec in the summary mode lines
14744 will return a date in compact ISO8601 format---@samp{19960809T230410}.
14745 This is quite a mouthful, so we want to shave off the century number and
14746 the time, leaving us with a six-character date. That would be
14747 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
14748 maxing, and we need the padding to ensure that the date is never less
14749 than 6 characters to make it look nice in columns.)
14751 Ignoring is done first; then cutting; then maxing; and then as the very
14752 last operation, padding.
14754 If you use lots of these advanced thingies, you'll find that Gnus gets
14755 quite slow. This can be helped enormously by running @kbd{M-x
14756 gnus-compile} when you are satisfied with the look of your lines.
14757 @xref{Compilation}.
14760 @node User-Defined Specs
14761 @subsection User-Defined Specs
14763 All the specs allow for inserting user defined specifiers---@samp{u}.
14764 The next character in the format string should be a letter. Gnus
14765 will call the function @code{gnus-user-format-function-}@samp{X}, where
14766 @samp{X} is the letter following @samp{%u}. The function will be passed
14767 a single parameter---what the parameter means depends on what buffer
14768 it's being called from. The function should return a string, which will
14769 be inserted into the buffer just like information from any other
14770 specifier. This function may also be called with dummy values, so it
14771 should protect against that.
14773 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
14774 much the same without defining new functions. Here's an example:
14775 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
14776 given here will be evaluated to yield the current line number, and then
14780 @node Formatting Fonts
14781 @subsection Formatting Fonts
14783 There are specs for highlighting, and these are shared by all the format
14784 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
14785 the special @code{mouse-face} property set, which means that it will be
14786 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
14789 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
14790 normal faces set using @code{gnus-face-0}, which is @code{bold} by
14791 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
14792 and so on. Create as many faces as you wish. The same goes for the
14793 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
14794 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
14796 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
14797 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you say
14798 @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
14799 @code{gnus-balloon-face-*} variables should be either strings or
14800 symbols naming functions that return a string. Under @code{balloon-help-mode},
14801 when the mouse passes over text with this property set, a balloon window
14802 will appear and display the string. Please refer to the doc string of
14803 @code{balloon-help-mode} for more information on this.
14805 Here's an alternative recipe for the group buffer:
14808 ;; Create three face types.
14809 (setq gnus-face-1 'bold)
14810 (setq gnus-face-3 'italic)
14812 ;; We want the article count to be in
14813 ;; a bold and green face. So we create
14814 ;; a new face called `my-green-bold'.
14815 (copy-face 'bold 'my-green-bold)
14817 (set-face-foreground 'my-green-bold "ForestGreen")
14818 (setq gnus-face-2 'my-green-bold)
14820 ;; Set the new & fancy format.
14821 (setq gnus-group-line-format
14822 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
14825 I'm sure you'll be able to use this scheme to create totally unreadable
14826 and extremely vulgar displays. Have fun!
14828 Note that the @samp{%(} specs (and friends) do not make any sense on the
14829 mode-line variables.
14832 @node Windows Configuration
14833 @section Windows Configuration
14834 @cindex windows configuration
14836 No, there's nothing here about X, so be quiet.
14838 @vindex gnus-use-full-window
14839 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
14840 other windows and occupy the entire Emacs screen by itself. It is
14841 @code{t} by default.
14843 Setting this variable to @code{nil} kinda works, but there are
14844 glitches. Use at your own peril.
14846 @vindex gnus-buffer-configuration
14847 @code{gnus-buffer-configuration} describes how much space each Gnus
14848 buffer should be given. Here's an excerpt of this variable:
14851 ((group (vertical 1.0 (group 1.0 point)
14852 (if gnus-carpal (group-carpal 4))))
14853 (article (vertical 1.0 (summary 0.25 point)
14857 This is an alist. The @dfn{key} is a symbol that names some action or
14858 other. For instance, when displaying the group buffer, the window
14859 configuration function will use @code{group} as the key. A full list of
14860 possible names is listed below.
14862 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
14863 should occupy. To take the @code{article} split as an example -
14866 (article (vertical 1.0 (summary 0.25 point)
14870 This @dfn{split} says that the summary buffer should occupy 25% of upper
14871 half of the screen, and that it is placed over the article buffer. As
14872 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
14873 reaching for that calculator there). However, the special number
14874 @code{1.0} is used to signal that this buffer should soak up all the
14875 rest of the space available after the rest of the buffers have taken
14876 whatever they need. There should be only one buffer with the @code{1.0}
14877 size spec per split.
14879 Point will be put in the buffer that has the optional third element
14880 @code{point}. In a @code{frame} split, the last subsplit having a leaf
14881 split where the tag @code{frame-focus} is a member (i.e. is the third or
14882 fourth element in the list, depending on whether the @code{point} tag is
14883 present) gets focus.
14885 Here's a more complicated example:
14888 (article (vertical 1.0 (group 4)
14889 (summary 0.25 point)
14890 (if gnus-carpal (summary-carpal 4))
14894 If the size spec is an integer instead of a floating point number,
14895 then that number will be used to say how many lines a buffer should
14896 occupy, not a percentage.
14898 If the @dfn{split} looks like something that can be @code{eval}ed (to be
14899 precise---if the @code{car} of the split is a function or a subr), this
14900 split will be @code{eval}ed. If the result is non-@code{nil}, it will
14901 be used as a split. This means that there will be three buffers if
14902 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
14905 Not complicated enough for you? Well, try this on for size:
14908 (article (horizontal 1.0
14913 (summary 0.25 point)
14918 Whoops. Two buffers with the mystery 100% tag. And what's that
14919 @code{horizontal} thingie?
14921 If the first element in one of the split is @code{horizontal}, Gnus will
14922 split the window horizontally, giving you two windows side-by-side.
14923 Inside each of these strips you may carry on all you like in the normal
14924 fashion. The number following @code{horizontal} says what percentage of
14925 the screen is to be given to this strip.
14927 For each split, there @emph{must} be one element that has the 100% tag.
14928 The splitting is never accurate, and this buffer will eat any leftover
14929 lines from the splits.
14931 To be slightly more formal, here's a definition of what a valid split
14935 split = frame | horizontal | vertical | buffer | form
14936 frame = "(frame " size *split ")"
14937 horizontal = "(horizontal " size *split ")"
14938 vertical = "(vertical " size *split ")"
14939 buffer = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
14940 size = number | frame-params
14941 buffer-name = group | article | summary ...
14944 The limitations are that the @code{frame} split can only appear as the
14945 top-level split. @var{form} should be an Emacs Lisp form that should
14946 return a valid split. We see that each split is fully recursive, and
14947 may contain any number of @code{vertical} and @code{horizontal} splits.
14949 @vindex gnus-window-min-width
14950 @vindex gnus-window-min-height
14951 @cindex window height
14952 @cindex window width
14953 Finding the right sizes can be a bit complicated. No window may be less
14954 than @code{gnus-window-min-height} (default 1) characters high, and all
14955 windows must be at least @code{gnus-window-min-width} (default 1)
14956 characters wide. Gnus will try to enforce this before applying the
14957 splits. If you want to use the normal Emacs window width/height limit,
14958 you can just set these two variables to @code{nil}.
14960 If you're not familiar with Emacs terminology, @code{horizontal} and
14961 @code{vertical} splits may work the opposite way of what you'd expect.
14962 Windows inside a @code{horizontal} split are shown side-by-side, and
14963 windows within a @code{vertical} split are shown above each other.
14965 @findex gnus-configure-frame
14966 If you want to experiment with window placement, a good tip is to call
14967 @code{gnus-configure-frame} directly with a split. This is the function
14968 that does all the real work when splitting buffers. Below is a pretty
14969 nonsensical configuration with 5 windows; two for the group buffer and
14970 three for the article buffer. (I said it was nonsensical.) If you
14971 @code{eval} the statement below, you can get an idea of how that would
14972 look straight away, without going through the normal Gnus channels.
14973 Play with it until you're satisfied, and then use
14974 @code{gnus-add-configuration} to add your new creation to the buffer
14975 configuration list.
14978 (gnus-configure-frame
14982 (article 0.3 point))
14990 You might want to have several frames as well. No prob---just use the
14991 @code{frame} split:
14994 (gnus-configure-frame
14997 (summary 0.25 point frame-focus)
14999 (vertical ((height . 5) (width . 15)
15000 (user-position . t)
15001 (left . -1) (top . 1))
15006 This split will result in the familiar summary/article window
15007 configuration in the first (or ``main'') frame, while a small additional
15008 frame will be created where picons will be shown. As you can see,
15009 instead of the normal @code{1.0} top-level spec, each additional split
15010 should have a frame parameter alist as the size spec.
15011 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
15012 Reference Manual}. Under XEmacs, a frame property list will be
15013 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
15015 The list of all possible keys for @code{gnus-buffer-configuration} can
15016 be found in its default value.
15018 Note that the @code{message} key is used for both
15019 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
15020 it is desirable to distinguish between the two, something like this
15024 (message (horizontal 1.0
15025 (vertical 1.0 (message 1.0 point))
15027 (if (buffer-live-p gnus-summary-buffer)
15032 One common desire for a multiple frame split is to have a separate frame
15033 for composing mail and news while leaving the original frame intact. To
15034 accomplish that, something like the following can be done:
15037 (message (frame 1.0
15038 (if (not (buffer-live-p gnus-summary-buffer))
15039 (car (cdr (assoc 'group gnus-buffer-configuration)))
15040 (car (cdr (assoc 'summary gnus-buffer-configuration))))
15041 (vertical ((user-position . t) (top . 1) (left . 1)
15042 (name . "Message"))
15043 (message 1.0 point))))
15046 @findex gnus-add-configuration
15047 Since the @code{gnus-buffer-configuration} variable is so long and
15048 complicated, there's a function you can use to ease changing the config
15049 of a single setting: @code{gnus-add-configuration}. If, for instance,
15050 you want to change the @code{article} setting, you could say:
15053 (gnus-add-configuration
15054 '(article (vertical 1.0
15056 (summary .25 point)
15060 You'd typically stick these @code{gnus-add-configuration} calls in your
15061 @file{.gnus.el} file or in some startup hook---they should be run after
15062 Gnus has been loaded.
15064 @vindex gnus-always-force-window-configuration
15065 If all windows mentioned in the configuration are already visible, Gnus
15066 won't change the window configuration. If you always want to force the
15067 ``right'' window configuration, you can set
15068 @code{gnus-always-force-window-configuration} to non-@code{nil}.
15070 If you're using tree displays (@pxref{Tree Display}), and the tree
15071 window is displayed vertically next to another window, you may also want
15072 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
15076 @node Faces and Fonts
15077 @section Faces and Fonts
15082 Fiddling with fonts and faces used to be very difficult, but these days
15083 it is very simple. You simply say @kbd{M-x customize-face}, pick out
15084 the face you want to alter, and alter it via the standard Customize
15089 @section Compilation
15090 @cindex compilation
15091 @cindex byte-compilation
15093 @findex gnus-compile
15095 Remember all those line format specification variables?
15096 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
15097 on. Now, Gnus will of course heed whatever these variables are, but,
15098 unfortunately, changing them will mean a quite significant slow-down.
15099 (The default values of these variables have byte-compiled functions
15100 associated with them, while the user-generated versions do not, of
15103 To help with this, you can run @kbd{M-x gnus-compile} after you've
15104 fiddled around with the variables and feel that you're (kind of)
15105 satisfied. This will result in the new specs being byte-compiled, and
15106 you'll get top speed again. Gnus will save these compiled specs in the
15107 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
15108 this function, though---you should compile them yourself by sticking
15109 them into the @code{.gnus.el} file and byte-compiling that file.)
15113 @section Mode Lines
15116 @vindex gnus-updated-mode-lines
15117 @code{gnus-updated-mode-lines} says what buffers should keep their mode
15118 lines updated. It is a list of symbols. Supported symbols include
15119 @code{group}, @code{article}, @code{summary}, @code{server},
15120 @code{browse}, and @code{tree}. If the corresponding symbol is present,
15121 Gnus will keep that mode line updated with information that may be
15122 pertinent. If this variable is @code{nil}, screen refresh may be
15125 @cindex display-time
15127 @vindex gnus-mode-non-string-length
15128 By default, Gnus displays information on the current article in the mode
15129 lines of the summary and article buffers. The information Gnus wishes
15130 to display (e.g. the subject of the article) is often longer than the
15131 mode lines, and therefore have to be cut off at some point. The
15132 @code{gnus-mode-non-string-length} variable says how long the other
15133 elements on the line is (i.e., the non-info part). If you put
15134 additional elements on the mode line (e.g. a clock), you should modify
15137 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
15139 (add-hook 'display-time-hook
15140 (lambda () (setq gnus-mode-non-string-length
15142 (if line-number-mode 5 0)
15143 (if column-number-mode 4 0)
15144 (length display-time-string)))))
15147 If this variable is @code{nil} (which is the default), the mode line
15148 strings won't be chopped off, and they won't be padded either. Note
15149 that the default is unlikely to be desirable, as even the percentage
15150 complete in the buffer may be crowded off the mode line; the user should
15151 configure this variable appropriately for her configuration.
15154 @node Highlighting and Menus
15155 @section Highlighting and Menus
15157 @cindex highlighting
15160 @vindex gnus-visual
15161 The @code{gnus-visual} variable controls most of the Gnus-prettifying
15162 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
15163 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
15166 This variable can be a list of visual properties that are enabled. The
15167 following elements are valid, and are all included by default:
15170 @item group-highlight
15171 Do highlights in the group buffer.
15172 @item summary-highlight
15173 Do highlights in the summary buffer.
15174 @item article-highlight
15175 Do highlights in the article buffer.
15177 Turn on highlighting in all buffers.
15179 Create menus in the group buffer.
15181 Create menus in the summary buffers.
15183 Create menus in the article buffer.
15185 Create menus in the browse buffer.
15187 Create menus in the server buffer.
15189 Create menus in the score buffers.
15191 Create menus in all buffers.
15194 So if you only want highlighting in the article buffer and menus in all
15195 buffers, you could say something like:
15198 (setq gnus-visual '(article-highlight menu))
15201 If you want highlighting only and no menus whatsoever, you'd say:
15204 (setq gnus-visual '(highlight))
15207 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
15208 in all Gnus buffers.
15210 Other general variables that influence the look of all buffers include:
15213 @item gnus-mouse-face
15214 @vindex gnus-mouse-face
15215 This is the face (i.e., font) used for mouse highlighting in Gnus. No
15216 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
15220 There are hooks associated with the creation of all the different menus:
15224 @item gnus-article-menu-hook
15225 @vindex gnus-article-menu-hook
15226 Hook called after creating the article mode menu.
15228 @item gnus-group-menu-hook
15229 @vindex gnus-group-menu-hook
15230 Hook called after creating the group mode menu.
15232 @item gnus-summary-menu-hook
15233 @vindex gnus-summary-menu-hook
15234 Hook called after creating the summary mode menu.
15236 @item gnus-server-menu-hook
15237 @vindex gnus-server-menu-hook
15238 Hook called after creating the server mode menu.
15240 @item gnus-browse-menu-hook
15241 @vindex gnus-browse-menu-hook
15242 Hook called after creating the browse mode menu.
15244 @item gnus-score-menu-hook
15245 @vindex gnus-score-menu-hook
15246 Hook called after creating the score mode menu.
15257 Those new-fangled @dfn{mouse} contraptions is very popular with the
15258 young, hep kids who don't want to learn the proper way to do things
15259 these days. Why, I remember way back in the summer of '89, when I was
15260 using Emacs on a Tops 20 system. Three hundred users on one single
15261 machine, and every user was running Simula compilers. Bah!
15265 @vindex gnus-carpal
15266 Well, you can make Gnus display bufferfuls of buttons you can click to
15267 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
15268 really. Tell the chiropractor I sent you.
15273 @item gnus-carpal-mode-hook
15274 @vindex gnus-carpal-mode-hook
15275 Hook run in all carpal mode buffers.
15277 @item gnus-carpal-button-face
15278 @vindex gnus-carpal-button-face
15279 Face used on buttons.
15281 @item gnus-carpal-header-face
15282 @vindex gnus-carpal-header-face
15283 Face used on carpal buffer headers.
15285 @item gnus-carpal-group-buffer-buttons
15286 @vindex gnus-carpal-group-buffer-buttons
15287 Buttons in the group buffer.
15289 @item gnus-carpal-summary-buffer-buttons
15290 @vindex gnus-carpal-summary-buffer-buttons
15291 Buttons in the summary buffer.
15293 @item gnus-carpal-server-buffer-buttons
15294 @vindex gnus-carpal-server-buffer-buttons
15295 Buttons in the server buffer.
15297 @item gnus-carpal-browse-buffer-buttons
15298 @vindex gnus-carpal-browse-buffer-buttons
15299 Buttons in the browse buffer.
15302 All the @code{buttons} variables are lists. The elements in these list
15303 are either cons cells where the @code{car} contains a text to be displayed and
15304 the @code{cdr} contains a function symbol, or a simple string.
15312 Gnus, being larger than any program ever written (allegedly), does lots
15313 of strange stuff that you may wish to have done while you're not
15314 present. For instance, you may want it to check for new mail once in a
15315 while. Or you may want it to close down all connections to all servers
15316 when you leave Emacs idle. And stuff like that.
15318 Gnus will let you do stuff like that by defining various
15319 @dfn{handlers}. Each handler consists of three elements: A
15320 @var{function}, a @var{time}, and an @var{idle} parameter.
15322 Here's an example of a handler that closes connections when Emacs has
15323 been idle for thirty minutes:
15326 (gnus-demon-close-connections nil 30)
15329 Here's a handler that scans for PGP headers every hour when Emacs is
15333 (gnus-demon-scan-pgp 60 t)
15336 This @var{time} parameter and than @var{idle} parameter work together
15337 in a strange, but wonderful fashion. Basically, if @var{idle} is
15338 @code{nil}, then the function will be called every @var{time} minutes.
15340 If @var{idle} is @code{t}, then the function will be called after
15341 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
15342 the function will never be called. But once Emacs goes idle, the
15343 function will be called every @var{time} minutes.
15345 If @var{idle} is a number and @var{time} is a number, the function will
15346 be called every @var{time} minutes only when Emacs has been idle for
15347 @var{idle} minutes.
15349 If @var{idle} is a number and @var{time} is @code{nil}, the function
15350 will be called once every time Emacs has been idle for @var{idle}
15353 And if @var{time} is a string, it should look like @samp{07:31}, and
15354 the function will then be called once every day somewhere near that
15355 time. Modified by the @var{idle} parameter, of course.
15357 @vindex gnus-demon-timestep
15358 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
15359 seconds. This is 60 by default. If you change that variable,
15360 all the timings in the handlers will be affected.)
15362 So, if you want to add a handler, you could put something like this in
15363 your @file{.gnus} file:
15365 @findex gnus-demon-add-handler
15367 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
15370 @findex gnus-demon-add-nocem
15371 @findex gnus-demon-add-scanmail
15372 @findex gnus-demon-add-rescan
15373 @findex gnus-demon-add-scan-timestamps
15374 @findex gnus-demon-add-disconnection
15375 Some ready-made functions to do this have been created:
15376 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
15377 @code{gnus-demon-add-nntp-close-connection},
15378 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
15379 @code{gnus-demon-add-scanmail}. Just put those functions in your
15380 @file{.gnus} if you want those abilities.
15382 @findex gnus-demon-init
15383 @findex gnus-demon-cancel
15384 @vindex gnus-demon-handlers
15385 If you add handlers to @code{gnus-demon-handlers} directly, you should
15386 run @code{gnus-demon-init} to make the changes take hold. To cancel all
15387 daemons, you can use the @code{gnus-demon-cancel} function.
15389 Note that adding daemons can be pretty naughty if you over do it. Adding
15390 functions that scan all news and mail from all servers every two seconds
15391 is a sure-fire way of getting booted off any respectable system. So
15400 @dfn{Spamming} is posting the same article lots and lots of times.
15401 Spamming is bad. Spamming is evil.
15403 Spamming is usually canceled within a day or so by various anti-spamming
15404 agencies. These agencies usually also send out @dfn{NoCeM} messages.
15405 NoCeM is pronounced ``no see-'em'', and means what the name
15406 implies---these are messages that make the offending articles, like, go
15409 What use are these NoCeM messages if the articles are canceled anyway?
15410 Some sites do not honor cancel messages and some sites just honor cancels
15411 from a select few people. Then you may wish to make use of the NoCeM
15412 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
15414 Gnus can read and parse the messages in this group automatically, and
15415 this will make spam disappear.
15417 There are some variables to customize, of course:
15420 @item gnus-use-nocem
15421 @vindex gnus-use-nocem
15422 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
15425 @item gnus-nocem-groups
15426 @vindex gnus-nocem-groups
15427 Gnus will look for NoCeM messages in the groups in this list. The
15428 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
15429 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
15431 @item gnus-nocem-issuers
15432 @vindex gnus-nocem-issuers
15433 There are many people issuing NoCeM messages. This list says what
15434 people you want to listen to. The default is @code{("Automoose-1"
15435 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
15436 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
15437 (Richard E. Depew)")}; fine, upstanding citizens all of them.
15439 Known despammers that you can put in this list include:
15442 @item clewis@@ferret.ocunix.on.ca;
15443 @cindex Chris Lewis
15444 Chris Lewis---Major Canadian despammer who has probably canceled more
15445 usenet abuse than anybody else.
15448 @cindex CancelMoose[tm]
15449 The CancelMoose[tm] on autopilot. The CancelMoose[tm] is reputed to be
15450 Norwegian, and was the person(s) who invented NoCeM.
15452 @item jem@@xpat.com;
15454 John Milburn---despammer located in Korea who is getting very busy these
15457 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
15458 Richard E. Depew---lone American despammer. He mostly cancels binary
15459 postings to non-binary groups and removes spews (regurgitated articles).
15462 You do not have to heed NoCeM messages from all these people---just the
15463 ones you want to listen to. You also don't have to accept all NoCeM
15464 messages from the people you like. Each NoCeM message has a @dfn{type}
15465 header that gives the message a (more or less, usually less) rigorous
15466 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
15467 @samp{binary}, and @samp{troll}. To specify this, you have to use
15468 @var{(issuer conditions ...)} elements in the list. Each condition is
15469 either a string (which is a regexp that matches types you want to use)
15470 or a list on the form @code{(not STRING)}, where @var{string} is a
15471 regexp that matches types you don't want to use.
15473 For instance, if you want all NoCeM messages from Chris Lewis except his
15474 @samp{troll} messages, you'd say:
15477 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
15480 On the other hand, if you just want nothing but his @samp{spam} and
15481 @samp{spew} messages, you'd say:
15484 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
15487 The specs are applied left-to-right.
15490 @item gnus-nocem-verifyer
15491 @vindex gnus-nocem-verifyer
15493 This should be a function for verifying that the NoCeM issuer is who she
15494 says she is. The default is @code{mc-verify}, which is a Mailcrypt
15495 function. If this is too slow and you don't care for verification
15496 (which may be dangerous), you can set this variable to @code{nil}.
15498 If you want signed NoCeM messages to be verified and unsigned messages
15499 not to be verified (but used anyway), you could do something like:
15502 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
15504 (defun my-gnus-mc-verify ()
15512 This might be dangerous, though.
15514 @item gnus-nocem-directory
15515 @vindex gnus-nocem-directory
15516 This is where Gnus will store its NoCeM cache files. The default is
15517 @file{~/News/NoCeM/}.
15519 @item gnus-nocem-expiry-wait
15520 @vindex gnus-nocem-expiry-wait
15521 The number of days before removing old NoCeM entries from the cache.
15522 The default is 15. If you make it shorter Gnus will be faster, but you
15523 might then see old spam.
15527 Using NoCeM could potentially be a memory hog. If you have many living
15528 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
15529 big. If this is a problem, you should kill off all (or most) of your
15530 unsubscribed groups (@pxref{Subscription Commands}).
15537 It is very useful to be able to undo actions one has done. In normal
15538 Emacs buffers, it's easy enough---you just push the @code{undo} button.
15539 In Gnus buffers, however, it isn't that simple.
15541 The things Gnus displays in its buffer is of no value whatsoever to
15542 Gnus---it's all just data designed to look nice to the user.
15543 Killing a group in the group buffer with @kbd{C-k} makes the line
15544 disappear, but that's just a side-effect of the real action---the
15545 removal of the group in question from the internal Gnus structures.
15546 Undoing something like that can't be done by the normal Emacs
15547 @code{undo} function.
15549 Gnus tries to remedy this somewhat by keeping track of what the user
15550 does and coming up with actions that would reverse the actions the user
15551 takes. When the user then presses the @code{undo} key, Gnus will run
15552 the code to reverse the previous action, or the previous actions.
15553 However, not all actions are easily reversible, so Gnus currently offers
15554 a few key functions to be undoable. These include killing groups,
15555 yanking groups, and changing the list of read articles of groups.
15556 That's it, really. More functions may be added in the future, but each
15557 added function means an increase in data to be stored, so Gnus will
15558 never be totally undoable.
15560 @findex gnus-undo-mode
15561 @vindex gnus-use-undo
15563 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
15564 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
15565 default. The @kbd{M-C-_} key performs the @code{gnus-undo} command
15566 command, which should feel kinda like the normal Emacs @code{undo}
15571 @section Moderation
15574 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
15575 It is not included in the standard Gnus package. Write a mail to
15576 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
15579 The moderation package is implemented as a minor mode for summary
15583 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
15586 in your @file{.gnus.el} file.
15588 If you are the moderator of @samp{rec.zoofle}, this is how it's
15593 You split your incoming mail by matching on
15594 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
15595 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
15598 You enter that group once in a while and post articles using the @kbd{e}
15599 (edit-and-post) or @kbd{s} (just send unedited) commands.
15602 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
15603 articles that weren't approved by you, you can cancel them with the
15607 To use moderation mode in these two groups, say:
15610 (setq gnus-moderated-list
15611 "^nnml:rec.zoofle$\\|^rec.zoofle$")
15615 @node XEmacs Enhancements
15616 @section XEmacs Enhancements
15619 XEmacs is able to display pictures and stuff, so Gnus has taken
15623 * Picons:: How to display pictures of what your reading.
15624 * Smileys:: Show all those happy faces the way they were meant to be shown.
15625 * Toolbar:: Click'n'drool.
15626 * XVarious:: Other XEmacsy Gnusey variables.
15639 So... You want to slow down your news reader even more! This is a
15640 good way to do so. Its also a great way to impress people staring
15641 over your shoulder as you read news.
15644 * Picon Basics:: What are picons and How do I get them.
15645 * Picon Requirements:: Don't go further if you aren't using XEmacs.
15646 * Easy Picons:: Displaying Picons---the easy way.
15647 * Hard Picons:: The way you should do it. You'll learn something.
15648 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
15653 @subsubsection Picon Basics
15655 What are Picons? To quote directly from the Picons Web site:
15664 @dfn{Picons} is short for ``personal icons''. They're small,
15665 constrained images used to represent users and domains on the net,
15666 organized into databases so that the appropriate image for a given
15667 e-mail address can be found. Besides users and domains, there are picon
15668 databases for Usenet newsgroups and weather forecasts. The picons are
15669 in either monochrome @code{XBM} format or color @code{XPM} and
15670 @code{GIF} formats.
15673 @vindex gnus-picons-piconsearch-url
15674 If you have a permanent connection to the Internet you can use Steve
15675 Kinzler's Picons Search engine by setting
15676 @code{gnus-picons-piconsearch-url} to the string @*
15677 @file{http://www.cs.indiana.edu/picons/search.html}.
15679 @vindex gnus-picons-database
15680 Otherwise you need a local copy of his database. For instructions on
15681 obtaining and installing the picons databases, point your Web browser at @*
15682 @file{http://www.cs.indiana.edu/picons/ftp/index.html}. Gnus expects
15683 picons to be installed into a location pointed to by
15684 @code{gnus-picons-database}.
15687 @node Picon Requirements
15688 @subsubsection Picon Requirements
15690 To have Gnus display Picons for you, you must be running XEmacs
15691 19.13 or greater since all other versions of Emacs aren't yet able to
15694 Additionally, you must have @code{x} support compiled into XEmacs. To
15695 display color picons which are much nicer than the black & white one,
15696 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
15698 @vindex gnus-picons-convert-x-face
15699 If you want to display faces from @code{X-Face} headers, you should have
15700 the @code{xface} support compiled into XEmacs. Otherwise you must have
15701 the @code{netpbm} utilities installed, or munge the
15702 @code{gnus-picons-convert-x-face} variable to use something else.
15706 @subsubsection Easy Picons
15708 To enable displaying picons, simply put the following line in your
15709 @file{~/.gnus} file and start Gnus.
15712 (setq gnus-use-picons t)
15713 (setq gnus-treat-display-picons t)
15716 and make sure @code{gnus-picons-database} points to the directory
15717 containing the Picons databases.
15719 Alternatively if you want to use the web piconsearch engine add this:
15722 (setq gnus-picons-piconsearch-url
15723 "http://www.cs.indiana.edu:800/piconsearch")
15728 @subsubsection Hard Picons
15736 Gnus can display picons for you as you enter and leave groups and
15737 articles. It knows how to interact with three sections of the picons
15738 database. Namely, it can display the picons newsgroup pictures,
15739 author's face picture(s), and the authors domain. To enable this
15740 feature, you need to select where to get the picons from, and where to
15745 @item gnus-picons-database
15746 @vindex gnus-picons-database
15747 The location of the picons database. Should point to a directory
15748 containing the @file{news}, @file{domains}, @file{users} (and so on)
15749 subdirectories. This is only useful if
15750 @code{gnus-picons-piconsearch-url} is @code{nil}. Defaults to
15751 @file{/usr/local/faces/}.
15753 @item gnus-picons-piconsearch-url
15754 @vindex gnus-picons-piconsearch-url
15755 The URL for the web picons search engine. The only currently known
15756 engine is @file{http://www.cs.indiana.edu:800/piconsearch}. To
15757 workaround network delays, icons will be fetched in the background. If
15758 this is @code{nil} 'the default), then picons are fetched from local
15759 database indicated by @code{gnus-picons-database}.
15761 @item gnus-picons-display-where
15762 @vindex gnus-picons-display-where
15763 Where the picon images should be displayed. It is @code{picons} by
15764 default (which by default maps to the buffer @samp{*Picons*}). Other
15765 valid places could be @code{article}, @code{summary}, or
15766 @samp{*scratch*} for all I care. Just make sure that you've made the
15767 buffer visible using the standard Gnus window configuration
15768 routines---@pxref{Windows Configuration}.
15770 @item gnus-picons-group-excluded-groups
15771 @vindex gnus-picons-group-excluded-groups
15772 Groups that are matched by this regexp won't have their group icons
15777 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
15778 window configuration for you to include the @code{picons} buffer.
15780 Now that you've made those decision, you need to add the following
15781 functions to the appropriate hooks so these pictures will get displayed
15784 @vindex gnus-picons-display-where
15786 @item gnus-article-display-picons
15787 @findex gnus-article-display-picons
15788 Looks up and displays the picons for the author and the author's domain
15789 in the @code{gnus-picons-display-where} buffer.
15791 @item gnus-picons-article-display-x-face
15792 @findex gnus-article-display-picons
15793 Decodes and displays the X-Face header if present.
15799 @node Picon Useless Configuration
15800 @subsubsection Picon Useless Configuration
15808 The following variables offer further control over how things are
15809 done, where things are located, and other useless stuff you really
15810 don't need to worry about.
15814 @item gnus-picons-news-directories
15815 @vindex gnus-picons-news-directories
15816 List of subdirectories to search in @code{gnus-picons-database} for
15817 newsgroups faces. @code{("news")} is the default.
15819 @item gnus-picons-user-directories
15820 @vindex gnus-picons-user-directories
15821 List of subdirectories to search in @code{gnus-picons-database} for user
15822 faces. @code{("local" "users" "usenix" "misc")} is the default.
15824 @item gnus-picons-domain-directories
15825 @vindex gnus-picons-domain-directories
15826 List of subdirectories to search in @code{gnus-picons-database} for
15827 domain name faces. Defaults to @code{("domains")}. Some people may
15828 want to add @samp{"unknown"} to this list.
15830 @item gnus-picons-convert-x-face
15831 @vindex gnus-picons-convert-x-face
15832 If you don't have @code{xface} support builtin XEmacs, this is the
15833 command to use to convert the @code{X-Face} header to an X bitmap
15834 (@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48,
15835 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
15836 gnus-picons-x-face-file-name)}
15838 @item gnus-picons-x-face-file-name
15839 @vindex gnus-picons-x-face-file-name
15840 Names a temporary file to store the @code{X-Face} bitmap in. Defaults
15841 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
15843 @item gnus-picons-has-modeline-p
15844 @vindex gnus-picons-has-modeline-p
15845 If you have set @code{gnus-picons-display-where} to @code{picons}, your
15846 XEmacs frame will become really cluttered. To alleviate this a bit you
15847 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
15848 remove the mode line from the Picons buffer. This is only useful if
15849 @code{gnus-picons-display-where} is @code{picons}.
15851 @item gnus-picons-refresh-before-display
15852 @vindex gnus-picons-refresh-before-display
15853 If non-nil, display the article buffer before computing the picons.
15854 Defaults to @code{nil}.
15856 @item gnus-picons-display-as-address
15857 @vindex gnus-picons-display-as-address
15858 If @code{t} display textual email addresses along with pictures.
15859 Defaults to @code{t}.
15861 @item gnus-picons-file-suffixes
15862 @vindex gnus-picons-file-suffixes
15863 Ordered list of suffixes on picon file names to try. Defaults to
15864 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
15866 @item gnus-picons-setup-hook
15867 @vindex gnus-picons-setup-hook
15868 Hook run in the picon buffer, if that is displayed.
15870 @item gnus-picons-display-article-move-p
15871 @vindex gnus-picons-display-article-move-p
15872 Whether to move point to first empty line when displaying picons. This
15873 has only an effect if `gnus-picons-display-where' has value `article'.
15875 If @code{nil}, display the picons in the @code{From} and
15876 @code{Newsgroups} lines. This is the defailt.
15878 @item gnus-picons-clear-cache-on-shutdown
15879 @vindex gnus-picons-clear-cache-on-shutdown
15880 Whether to clear the picons cache when exiting gnus. Gnus caches every
15881 picons it finds while it is running. This saves some time in the search
15882 process but eats some memory. If this variable is set to @code{nil},
15883 Gnus will never clear the cache itself; you will have to manually call
15884 @code{gnus-picons-clear-cache} to clear it. Otherwise the cache will be
15885 cleared every time you exit Gnus. Defaults to @code{t}.
15896 @subsection Smileys
15901 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
15906 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
15907 currently the only package that uses Smiley, it is documented here.
15909 In short---to use Smiley in Gnus, put the following in your
15910 @file{.gnus.el} file:
15913 (setq gnus-treat-display-smiley t)
15916 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
15917 the like---to pictures and displays those instead of the text smiley
15918 faces. The conversion is controlled by a list of regexps that matches
15919 text and maps that to file names.
15921 @vindex smiley-nosey-regexp-alist
15922 @vindex smiley-deformed-regexp-alist
15923 Smiley supplies two example conversion alists by default:
15924 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
15925 and so on), and @code{smiley-nosey-regexp-alist} (which matches
15926 @samp{:-)}, @samp{:-(} and so on).
15928 The alist used is specified by the @code{smiley-regexp-alist} variable,
15929 which defaults to the value of @code{smiley-deformed-regexp-alist}.
15931 The first item in each element is the regexp to be matched; the second
15932 element is the regexp match group that is to be replaced by the picture;
15933 and the third element is the name of the file to be displayed.
15935 The following variables customize where Smiley will look for these
15936 files, as well as the color to be used and stuff:
15940 @item smiley-data-directory
15941 @vindex smiley-data-directory
15942 Where Smiley will look for smiley faces files.
15944 @item smiley-flesh-color
15945 @vindex smiley-flesh-color
15946 Skin color. The default is @samp{yellow}, which is really racist.
15948 @item smiley-features-color
15949 @vindex smiley-features-color
15950 Color of the features of the face. The default is @samp{black}.
15952 @item smiley-tongue-color
15953 @vindex smiley-tongue-color
15954 Color of the tongue. The default is @samp{red}.
15956 @item smiley-circle-color
15957 @vindex smiley-circle-color
15958 Color of the circle around the face. The default is @samp{black}.
15960 @item smiley-mouse-face
15961 @vindex smiley-mouse-face
15962 Face used for mouse highlighting over the smiley face.
15968 @subsection Toolbar
15978 @item gnus-use-toolbar
15979 @vindex gnus-use-toolbar
15980 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
15981 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
15982 @code{right-toolbar}, or @code{left-toolbar}.
15984 @item gnus-group-toolbar
15985 @vindex gnus-group-toolbar
15986 The toolbar in the group buffer.
15988 @item gnus-summary-toolbar
15989 @vindex gnus-summary-toolbar
15990 The toolbar in the summary buffer.
15992 @item gnus-summary-mail-toolbar
15993 @vindex gnus-summary-mail-toolbar
15994 The toolbar in the summary buffer of mail groups.
16000 @subsection Various XEmacs Variables
16003 @item gnus-xmas-glyph-directory
16004 @vindex gnus-xmas-glyph-directory
16005 This is where Gnus will look for pictures. Gnus will normally
16006 auto-detect this directory, but you may set it manually if you have an
16007 unusual directory structure.
16009 @item gnus-xmas-logo-color-alist
16010 @vindex gnus-xmas-logo-color-alist
16011 This is an alist where the key is a type symbol and the values are the
16012 foreground and background color of the splash page glyph.
16014 @item gnus-xmas-logo-color-style
16015 @vindex gnus-xmas-logo-color-style
16016 This is the key used to look up the color in the alist described above.
16017 Valid values include @code{flame}, @code{pine}, @code{moss},
16018 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
16019 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
16021 @item gnus-xmas-modeline-glyph
16022 @vindex gnus-xmas-modeline-glyph
16023 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
16037 @node Fuzzy Matching
16038 @section Fuzzy Matching
16039 @cindex fuzzy matching
16041 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
16042 things like scoring, thread gathering and thread comparison.
16044 As opposed to regular expression matching, fuzzy matching is very fuzzy.
16045 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
16046 means, and the implementation has changed over time.
16048 Basically, it tries to remove all noise from lines before comparing.
16049 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
16050 out of the strings before comparing the results. This often leads to
16051 adequate results---even when faced with strings generated by text
16052 manglers masquerading as newsreaders.
16055 @node Thwarting Email Spam
16056 @section Thwarting Email Spam
16060 @cindex unsolicited commercial email
16062 In these last days of the Usenet, commercial vultures are hanging about
16063 and grepping through news like crazy to find email addresses they can
16064 foist off their scams and products to. As a reaction to this, many
16065 people have started putting nonsense addresses into their @code{From}
16066 lines. I think this is counterproductive---it makes it difficult for
16067 people to send you legitimate mail in response to things you write, as
16068 well as making it difficult to see who wrote what. This rewriting may
16069 perhaps be a bigger menace than the unsolicited commercial email itself
16072 The biggest problem I have with email spam is that it comes in under
16073 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
16074 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
16075 mail group, only to find two pyramid schemes, seven advertisements
16076 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
16077 and one mail asking me to repent and find some god.
16081 The way to deal with this is having Gnus split out all spam into a
16082 @samp{spam} mail group (@pxref{Splitting Mail}).
16084 First, pick one (1) valid mail address that you can be reached at, and
16085 put it in your @code{From} header of all your news articles. (I've
16086 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
16087 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
16088 sysadm whether your sendmail installation accepts keywords in the local
16089 part of the mail address.)
16092 (setq message-default-news-headers
16093 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
16096 Then put the following split rule in @code{nnmail-split-fancy}
16097 (@pxref{Fancy Mail Splitting}):
16102 (to "larsi@@trym.ifi.uio.no"
16103 (| ("subject" "re:.*" "misc")
16104 ("references" ".*@@.*" "misc")
16110 This says that all mail to this address is suspect, but if it has a
16111 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
16112 header, it's probably ok. All the rest goes to the @samp{spam} group.
16113 (This idea probably comes from Tim Pierce.)
16115 In addition, many mail spammers talk directly to your @code{smtp} server
16116 and do not include your email address explicitly in the @code{To}
16117 header. Why they do this is unknown---perhaps it's to thwart this
16118 thwarting scheme? In any case, this is trivial to deal with---you just
16119 put anything not addressed to you in the @samp{spam} group by ending
16120 your fancy split rule in this way:
16125 (to "larsi" "misc")
16129 In my experience, this will sort virtually everything into the right
16130 group. You still have to check the @samp{spam} group from time to time to
16131 check for legitimate mail, though. If you feel like being a good net
16132 citizen, you can even send off complaints to the proper authorities on
16133 each unsolicited commercial email---at your leisure.
16135 If you are also a lazy net citizen, you will probably prefer complaining
16136 automatically with the @file{gnus-junk.el} package, available FOR FREE
16137 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
16138 Since most e-mail spam is sent automatically, this may reconcile the
16139 cosmic balance somewhat.
16141 This works for me. It allows people an easy way to contact me (they can
16142 just press @kbd{r} in the usual way), and I'm not bothered at all with
16143 spam. It's a win-win situation. Forging @code{From} headers to point
16144 to non-existent domains is yucky, in my opinion.
16147 @node Various Various
16148 @section Various Various
16154 @item gnus-home-directory
16155 All Gnus path variables will be initialized from this variable, which
16156 defaults to @file{~/}.
16158 @item gnus-directory
16159 @vindex gnus-directory
16160 Most Gnus storage path variables will be initialized from this variable,
16161 which defaults to the @samp{SAVEDIR} environment variable, or
16162 @file{~/News/} if that variable isn't set.
16164 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
16165 This means that other directory variables that are initialized from this
16166 variable won't be set properly if you set this variable in
16167 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
16169 @item gnus-default-directory
16170 @vindex gnus-default-directory
16171 Not related to the above variable at all---this variable says what the
16172 default directory of all Gnus buffers should be. If you issue commands
16173 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
16174 default directory. If this variable is @code{nil} (which is the
16175 default), the default directory will be the default directory of the
16176 buffer you were in when you started Gnus.
16179 @vindex gnus-verbose
16180 This variable is an integer between zero and ten. The higher the value,
16181 the more messages will be displayed. If this variable is zero, Gnus
16182 will never flash any messages, if it is seven (which is the default),
16183 most important messages will be shown, and if it is ten, Gnus won't ever
16184 shut up, but will flash so many messages it will make your head swim.
16186 @item gnus-verbose-backends
16187 @vindex gnus-verbose-backends
16188 This variable works the same way as @code{gnus-verbose}, but it applies
16189 to the Gnus backends instead of Gnus proper.
16191 @item nnheader-max-head-length
16192 @vindex nnheader-max-head-length
16193 When the backends read straight heads of articles, they all try to read
16194 as little as possible. This variable (default 4096) specifies
16195 the absolute max length the backends will try to read before giving up
16196 on finding a separator line between the head and the body. If this
16197 variable is @code{nil}, there is no upper read bound. If it is
16198 @code{t}, the backends won't try to read the articles piece by piece,
16199 but read the entire articles. This makes sense with some versions of
16200 @code{ange-ftp} or @code{efs}.
16202 @item nnheader-head-chop-length
16203 @vindex nnheader-head-chop-length
16204 This variable (default 2048) says how big a piece of each article to
16205 read when doing the operation described above.
16207 @item nnheader-file-name-translation-alist
16208 @vindex nnheader-file-name-translation-alist
16210 @cindex invalid characters in file names
16211 @cindex characters in file names
16212 This is an alist that says how to translate characters in file names.
16213 For instance, if @samp{:} is invalid as a file character in file names
16214 on your system (you OS/2 user you), you could say something like:
16217 (setq nnheader-file-name-translation-alist
16221 In fact, this is the default value for this variable on OS/2 and MS
16222 Windows (phooey) systems.
16224 @item gnus-hidden-properties
16225 @vindex gnus-hidden-properties
16226 This is a list of properties to use to hide ``invisible'' text. It is
16227 @code{(invisible t intangible t)} by default on most systems, which
16228 makes invisible text invisible and intangible.
16230 @item gnus-parse-headers-hook
16231 @vindex gnus-parse-headers-hook
16232 A hook called before parsing headers. It can be used, for instance, to
16233 gather statistics on the headers fetched, or perhaps you'd like to prune
16234 some headers. I don't see why you'd want that, though.
16236 @item gnus-shell-command-separator
16237 @vindex gnus-shell-command-separator
16238 String used to separate two shell commands. The default is @samp{;}.
16247 Well, that's the manual---you can get on with your life now. Keep in
16248 touch. Say hello to your cats from me.
16250 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
16252 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
16258 Not because of victories @*
16261 but for the common sunshine,@*
16263 the largess of the spring.
16267 but for the day's work done@*
16268 as well as I was able;@*
16269 not for a seat upon the dais@*
16270 but at the common table.@*
16275 @chapter Appendices
16278 * History:: How Gnus got where it is today.
16279 * Terminology:: We use really difficult, like, words here.
16280 * Customization:: Tailoring Gnus to your needs.
16281 * Troubleshooting:: What you might try if things do not work.
16282 * Gnus Reference Guide:: Rilly, rilly technical stuff.
16283 * Emacs for Heathens:: A short introduction to Emacsian terms.
16284 * Frequently Asked Questions:: A question-and-answer session.
16292 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
16293 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
16295 If you want to investigate the person responsible for this outrage, you
16296 can point your (feh!) web browser to
16297 @file{http://www.stud.ifi.uio.no/~larsi/}. This is also the primary
16298 distribution point for the new and spiffy versions of Gnus, and is known
16299 as The Site That Destroys Newsrcs And Drives People Mad.
16301 During the first extended alpha period of development, the new Gnus was
16302 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
16303 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
16304 (Besides, the ``Gnus'' in this abbreviation should probably be
16305 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
16306 appropriate name, don't you think?)
16308 In any case, after spending all that energy on coming up with a new and
16309 spunky name, we decided that the name was @emph{too} spunky, so we
16310 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
16311 ``@sc{gnus}''. New vs. old.
16313 The first ``proper'' release of Gnus 5 was done in November 1995 when it
16314 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
16315 plus 15 Gnus 5.0 releases).
16317 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
16318 releases)) was released under the name ``Gnus 5.2'' (40 releases).
16320 On July 28th 1996 work on Red Gnus was begun, and it was released on
16321 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
16323 On September 13th 1997, Quassia Gnus was started and lasted 37
16324 releases. If was released as ``Gnus 5.6 on March 8th 1998.
16326 If you happen upon a version of Gnus that has a prefixed name --
16327 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
16328 don't panic. Don't let it know that you're frightened. Back away.
16329 Slowly. Whatever you do, don't run. Walk away, calmly, until you're
16330 out of its reach. Find a proper released version of Gnus and snuggle up
16334 * Why?:: What's the point of Gnus?
16335 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
16336 * Conformity:: Gnus tries to conform to all standards.
16337 * Emacsen:: Gnus can be run on a few modern Emacsen.
16338 * Contributors:: Oodles of people.
16339 * New Features:: Pointers to some of the new stuff in Gnus.
16340 * Newest Features:: Features so new that they haven't been written yet.
16347 What's the point of Gnus?
16349 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
16350 newsreader, that lets you do anything you can think of. That was my
16351 original motivation, but while working on Gnus, it has become clear to
16352 me that this generation of newsreaders really belong in the stone age.
16353 Newsreaders haven't developed much since the infancy of the net. If the
16354 volume continues to rise with the current rate of increase, all current
16355 newsreaders will be pretty much useless. How do you deal with
16356 newsgroups that have thousands of new articles each day? How do you
16357 keep track of millions of people who post?
16359 Gnus offers no real solutions to these questions, but I would very much
16360 like to see Gnus being used as a testing ground for new methods of
16361 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
16362 to separate the newsreader from the backends, Gnus now offers a simple
16363 interface for anybody who wants to write new backends for fetching mail
16364 and news from different sources. I have added hooks for customizations
16365 everywhere I could imagine it being useful. By doing so, I'm inviting
16366 every one of you to explore and invent.
16368 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
16369 @kbd{C-u 100 M-x all-hail-xemacs}.
16372 @node Compatibility
16373 @subsection Compatibility
16375 @cindex compatibility
16376 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
16377 bindings have been kept. More key bindings have been added, of course,
16378 but only in one or two obscure cases have old bindings been changed.
16383 @center In a cloud bones of steel.
16387 All commands have kept their names. Some internal functions have changed
16390 The @code{gnus-uu} package has changed drastically. @xref{Decoding
16393 One major compatibility question is the presence of several summary
16394 buffers. All variables relevant while reading a group are
16395 buffer-local to the summary buffer they belong in. Although many
16396 important variables have their values copied into their global
16397 counterparts whenever a command is executed in the summary buffer, this
16398 change might lead to incorrect values being used unless you are careful.
16400 All code that relies on knowledge of @sc{gnus} internals will probably
16401 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
16402 changing it in any way, as a matter of fact) is strictly verboten. Gnus
16403 maintains a hash table that points to the entries in this alist (which
16404 speeds up many functions), and changing the alist directly will lead to
16408 @cindex highlighting
16409 Old hilit19 code does not work at all. In fact, you should probably
16410 remove all hilit code from all Gnus hooks
16411 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
16412 Gnus provides various integrated functions for highlighting. These are
16413 faster and more accurate. To make life easier for everybody, Gnus will
16414 by default remove all hilit calls from all hilit hooks. Uncleanliness!
16417 Packages like @code{expire-kill} will no longer work. As a matter of
16418 fact, you should probably remove all old @sc{gnus} packages (and other
16419 code) when you start using Gnus. More likely than not, Gnus already
16420 does what you have written code to make @sc{gnus} do. (Snicker.)
16422 Even though old methods of doing things are still supported, only the
16423 new methods are documented in this manual. If you detect a new method of
16424 doing something while reading this manual, that does not mean you have
16425 to stop doing it the old way.
16427 Gnus understands all @sc{gnus} startup files.
16429 @kindex M-x gnus-bug
16431 @cindex reporting bugs
16433 Overall, a casual user who hasn't written much code that depends on
16434 @sc{gnus} internals should suffer no problems. If problems occur,
16435 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
16437 @vindex gnus-bug-create-help-buffer
16438 If you are in the habit of sending bug reports @emph{very} often, you
16439 may find the helpful help buffer annoying after a while. If so, set
16440 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
16445 @subsection Conformity
16447 No rebels without a clue here, ma'am. We conform to all standards known
16448 to (wo)man. Except for those standards and/or conventions we disagree
16455 There are no known breaches of this standard.
16459 There are no known breaches of this standard, either.
16461 @item Son-of-RFC 1036
16462 @cindex Son-of-RFC 1036
16463 We do have some breaches to this one.
16469 These are considered to be ``vanity headers'', while I consider them
16470 to be consumer information. After seeing so many badly formatted
16471 articles coming from @code{tin} and @code{Netscape} I know not to use
16472 either of those for posting articles. I would not have known that if
16473 it wasn't for the @code{X-Newsreader} header.
16478 USEFOR is an IETF working group writing a successor to RFC 1036, based
16479 on Son-of-RFC 1036. They have produced a number of drafts proposing
16480 various changes to the format of news articles. The Gnus towers will
16481 look into implementing the changes when the draft is accepted as an RFC.
16485 If you ever notice Gnus acting non-compliant with regards to the texts
16486 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
16491 @subsection Emacsen
16497 Gnus should work on :
16505 XEmacs 20.4 and up.
16509 This Gnus version will absolutely not work on any Emacsen older than
16510 that. Not reliably, at least. Older versions of Gnus may work on older
16513 There are some vague differences between Gnus on the various
16514 platforms---XEmacs features more graphics (a logo and a toolbar)---but
16515 other than that, things should look pretty much the same under all
16520 @subsection Contributors
16521 @cindex contributors
16523 The new Gnus version couldn't have been done without the help of all the
16524 people on the (ding) mailing list. Every day for over a year I have
16525 gotten billions of nice bug reports from them, filling me with joy,
16526 every single one of them. Smooches. The people on the list have been
16527 tried beyond endurance, what with my ``oh, that's a neat idea <type
16528 type>, yup, I'll release it right away <ship off> no wait, that doesn't
16529 work at all <type type>, yup, I'll ship that one off right away <ship
16530 off> no, wait, that absolutely does not work'' policy for releases.
16531 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
16532 ``worser''? ``much worser''? ``worsest''?)
16534 I would like to take this opportunity to thank the Academy for... oops,
16540 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
16543 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
16544 well as numerous other things).
16547 Luis Fernandes---design and graphics.
16550 Erik Naggum---help, ideas, support, code and stuff.
16553 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el and many other things
16554 connected with @sc{mime} and other types of en/decoding.
16557 Wes Hardaker---@file{gnus-picon.el} and the manual section on
16558 @dfn{picons} (@pxref{Picons}).
16561 Kim-Minh Kaplan---further work on the picon code.
16564 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
16565 (@pxref{GroupLens}).
16568 Sudish Joseph---innumerable bug fixes.
16571 Ilja Weis---@file{gnus-topic.el}.
16574 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
16577 Vladimir Alexiev---the refcard and reference booklets.
16580 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
16581 distribution by Felix Lee and JWZ.
16584 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
16587 Peter Mutsaers---orphan article scoring code.
16590 Ken Raeburn---POP mail support.
16593 Hallvard B Furuseth---various bits and pieces, especially dealing with
16597 Brian Edmonds---@file{gnus-bbdb.el}.
16600 David Moore---rewrite of @file{nnvirtual.el} and many other things.
16603 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
16606 François Pinard---many, many interesting and thorough bug reports, as
16607 well as autoconf support.
16611 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
16612 Borges, and Jost Krieger proof-reading parts of the manual.
16614 The following people have contributed many patches and suggestions:
16623 Jason L. Tibbitts, III,
16627 Also thanks to the following for patches and stuff:
16650 Massimo Campostrini,
16658 Geoffrey T. Dairiki,
16664 Michael Welsh Duggan,
16668 Enami Tsugutomo, @c Enami
16672 Nelson Jose dos Santos Ferreira,
16679 Arne Georg Gleditsch,
16681 Michelangelo Grigni,
16685 Kenichi Handa, @c Handa
16687 Yoshiki Hayashi, @c ?
16689 Hisashige Kenji, @c Hisashige
16694 François Felix Ingrand,
16695 Ishikawa Ichiro, @c Ishikawa
16697 Iwamuro Motonori, @c Iwamuro
16706 Peter Skov Knudsen,
16707 Shuhei Kobayashi, @c Kobayashi
16708 Koseki Yoshinori, @c Koseki
16709 Thor Kristoffersen,
16712 Seokchan Lee, @c Lee
16730 Morioka Tomohiko, @c Morioka
16731 Erik Toubro Nielsen,
16738 Masaharu Onishi, @c Onishi
16742 Jens-Ulrik Holger Petersen,
16746 John McClary Prevost,
16752 Lars Balker Rasmussen,
16757 Christian von Roques,
16760 Wolfgang Rupprecht,
16767 Philippe Schnoebelen,
16769 Randal L. Schwartz,
16800 Katsumi Yamaoka @c Yamaoka
16805 For a full overview of what each person has done, the ChangeLogs
16806 included in the Gnus alpha distributions should give ample reading
16807 (550kB and counting).
16809 Apologies to everybody that I've forgotten, of which there are many, I'm
16812 Gee, that's quite a list of people. I guess that must mean that there
16813 actually are people who are using Gnus. Who'd'a thunk it!
16817 @subsection New Features
16818 @cindex new features
16821 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
16822 * September Gnus:: The Thing Formally Known As Gnus 5.3/5.3.
16823 * Red Gnus:: Third time best---Gnus 5.4/5.5.
16824 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
16827 These lists are, of course, just @emph{short} overviews of the
16828 @emph{most} important new features. No, really. There are tons more.
16829 Yes, we have feeping creaturism in full effect.
16833 @subsubsection (ding) Gnus
16835 New features in Gnus 5.0/5.1:
16840 The look of all buffers can be changed by setting format-like variables
16841 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
16844 Local spool and several @sc{nntp} servers can be used at once
16845 (@pxref{Select Methods}).
16848 You can combine groups into virtual groups (@pxref{Virtual Groups}).
16851 You can read a number of different mail formats (@pxref{Getting Mail}).
16852 All the mail backends implement a convenient mail expiry scheme
16853 (@pxref{Expiring Mail}).
16856 Gnus can use various strategies for gathering threads that have lost
16857 their roots (thereby gathering loose sub-threads into one thread) or it
16858 can go back and retrieve enough headers to build a complete thread
16859 (@pxref{Customizing Threading}).
16862 Killed groups can be displayed in the group buffer, and you can read
16863 them as well (@pxref{Listing Groups}).
16866 Gnus can do partial group updates---you do not have to retrieve the
16867 entire active file just to check for new articles in a few groups
16868 (@pxref{The Active File}).
16871 Gnus implements a sliding scale of subscribedness to groups
16872 (@pxref{Group Levels}).
16875 You can score articles according to any number of criteria
16876 (@pxref{Scoring}). You can even get Gnus to find out how to score
16877 articles for you (@pxref{Adaptive Scoring}).
16880 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
16881 manner, so it should be difficult to lose much data on what you have
16882 read if your machine should go down (@pxref{Auto Save}).
16885 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
16886 the @file{.emacs} file.
16889 You can set the process mark on both groups and articles and perform
16890 operations on all the marked items (@pxref{Process/Prefix}).
16893 You can grep through a subset of groups and create a group from the
16894 results (@pxref{Kibozed Groups}).
16897 You can list subsets of groups according to, well, anything
16898 (@pxref{Listing Groups}).
16901 You can browse foreign servers and subscribe to groups from those
16902 servers (@pxref{Browse Foreign Server}).
16905 Gnus can fetch articles, asynchronously, on a second connection to the
16906 server (@pxref{Asynchronous Fetching}).
16909 You can cache articles locally (@pxref{Article Caching}).
16912 The uudecode functions have been expanded and generalized
16913 (@pxref{Decoding Articles}).
16916 You can still post uuencoded articles, which was a little-known feature
16917 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
16920 Fetching parents (and other articles) now actually works without
16921 glitches (@pxref{Finding the Parent}).
16924 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
16927 Digests (and other files) can be used as the basis for groups
16928 (@pxref{Document Groups}).
16931 Articles can be highlighted and customized (@pxref{Customizing
16935 URLs and other external references can be buttonized (@pxref{Article
16939 You can do lots of strange stuff with the Gnus window & frame
16940 configuration (@pxref{Windows Configuration}).
16943 You can click on buttons instead of using the keyboard
16949 @node September Gnus
16950 @subsubsection September Gnus
16954 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
16958 New features in Gnus 5.2/5.3:
16963 A new message composition mode is used. All old customization variables
16964 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
16968 Gnus is now able to generate @dfn{sparse} threads---threads where
16969 missing articles are represented by empty nodes (@pxref{Customizing
16973 (setq gnus-build-sparse-threads 'some)
16977 Outgoing articles are stored on a special archive server
16978 (@pxref{Archived Messages}).
16981 Partial thread regeneration now happens when articles are
16985 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
16988 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
16991 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
16994 (setq gnus-use-trees t)
16998 An @code{nn}-like pick-and-read minor mode is available for the summary
16999 buffers (@pxref{Pick and Read}).
17002 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
17006 In binary groups you can use a special binary minor mode (@pxref{Binary
17010 Groups can be grouped in a folding topic hierarchy (@pxref{Group
17014 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
17018 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
17021 Groups can now have a score, and bubbling based on entry frequency
17022 is possible (@pxref{Group Score}).
17025 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
17029 Groups can be process-marked, and commands can be performed on
17030 groups of groups (@pxref{Marking Groups}).
17033 Caching is possible in virtual groups.
17036 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
17037 news batches, ClariNet briefs collections, and just about everything
17038 else (@pxref{Document Groups}).
17041 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
17045 The Gnus cache is much faster.
17048 Groups can be sorted according to many criteria (@pxref{Sorting
17052 New group parameters have been introduced to set list-addresses and
17053 expiry times (@pxref{Group Parameters}).
17056 All formatting specs allow specifying faces to be used
17057 (@pxref{Formatting Fonts}).
17060 There are several more commands for setting/removing/acting on process
17061 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
17064 The summary buffer can be limited to show parts of the available
17065 articles based on a wide range of criteria. These commands have been
17066 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
17069 Articles can be made persistent with the @kbd{*} command
17070 (@pxref{Persistent Articles}).
17073 All functions for hiding article elements are now toggles.
17076 Article headers can be buttonized (@pxref{Article Washing}).
17079 All mail backends support fetching articles by @code{Message-ID}.
17082 Duplicate mail can now be treated properly (@pxref{Duplicates}).
17085 All summary mode commands are available directly from the article
17086 buffer (@pxref{Article Keymap}).
17089 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
17093 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
17096 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
17101 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
17104 (setq gnus-use-nocem t)
17108 Groups can be made permanently visible (@pxref{Listing Groups}).
17111 (setq gnus-permanently-visible-groups "^nnml:")
17115 Many new hooks have been introduced to make customizing easier.
17118 Gnus respects the @code{Mail-Copies-To} header.
17121 Threads can be gathered by looking at the @code{References} header
17122 (@pxref{Customizing Threading}).
17125 (setq gnus-summary-thread-gathering-function
17126 'gnus-gather-threads-by-references)
17130 Read articles can be stored in a special backlog buffer to avoid
17131 refetching (@pxref{Article Backlog}).
17134 (setq gnus-keep-backlog 50)
17138 A clean copy of the current article is always stored in a separate
17139 buffer to allow easier treatment.
17142 Gnus can suggest where to save articles (@pxref{Saving Articles}).
17145 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
17149 (setq gnus-prompt-before-saving t)
17153 @code{gnus-uu} can view decoded files asynchronously while fetching
17154 articles (@pxref{Other Decode Variables}).
17157 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
17161 Filling in the article buffer now works properly on cited text
17162 (@pxref{Article Washing}).
17165 Hiding cited text adds buttons to toggle hiding, and how much
17166 cited text to hide is now customizable (@pxref{Article Hiding}).
17169 (setq gnus-cited-lines-visible 2)
17173 Boring headers can be hidden (@pxref{Article Hiding}).
17176 Default scoring values can now be set from the menu bar.
17179 Further syntax checking of outgoing articles have been added.
17185 @subsubsection Red Gnus
17187 New features in Gnus 5.4/5.5:
17191 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
17198 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
17201 Article prefetching functionality has been moved up into
17202 Gnus (@pxref{Asynchronous Fetching}).
17205 Scoring can now be performed with logical operators like @code{and},
17206 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
17210 Article washing status can be displayed in the
17211 article mode line (@pxref{Misc Article}).
17214 @file{gnus.el} has been split into many smaller files.
17217 Suppression of duplicate articles based on Message-ID can be done
17218 (@pxref{Duplicate Suppression}).
17221 (setq gnus-suppress-duplicates t)
17225 New variables for specifying what score and adapt files are to be
17226 considered home score and adapt files (@pxref{Home Score File}) have
17230 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
17231 Server Internals}).
17234 Groups can inherit group parameters from parent topics (@pxref{Topic
17238 Article editing has been revamped and is now actually usable.
17241 Signatures can be recognized in more intelligent fashions
17242 (@pxref{Article Signature}).
17245 Summary pick mode has been made to look more @code{nn}-like. Line
17246 numbers are displayed and the @kbd{.} command can be used to pick
17247 articles (@code{Pick and Read}).
17250 Commands for moving the @file{.newsrc.eld} from one server to
17251 another have been added (@pxref{Changing Servers}).
17254 There's a way now to specify that ``uninteresting'' fields be suppressed
17255 when generating lines in buffers (@pxref{Advanced Formatting}).
17258 Several commands in the group buffer can be undone with @kbd{M-C-_}
17262 Scoring can be done on words using the new score type @code{w}
17263 (@pxref{Score File Format}).
17266 Adaptive scoring can be done on a Subject word-by-word basis
17267 (@pxref{Adaptive Scoring}).
17270 (setq gnus-use-adaptive-scoring '(word))
17274 Scores can be decayed (@pxref{Score Decays}).
17277 (setq gnus-decay-scores t)
17281 Scoring can be performed using a regexp on the Date header. The Date is
17282 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
17285 A new command has been added to remove all data on articles from
17286 the native server (@pxref{Changing Servers}).
17289 A new command for reading collections of documents
17290 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
17291 (@pxref{Really Various Summary Commands}).
17294 Process mark sets can be pushed and popped (@pxref{Setting Process
17298 A new mail-to-news backend makes it possible to post even when the NNTP
17299 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
17302 A new backend for reading searches from Web search engines
17303 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
17304 (@pxref{Web Searches}).
17307 Groups inside topics can now be sorted using the standard sorting
17308 functions, and each topic can be sorted independently (@pxref{Topic
17312 Subsets of the groups can be sorted independently (@code{Sorting
17316 Cached articles can be pulled into the groups (@pxref{Summary Generation
17320 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
17325 Score files are now applied in a more reliable order (@pxref{Score
17329 Reports on where mail messages end up can be generated (@pxref{Splitting
17333 More hooks and functions have been added to remove junk from incoming
17334 mail before saving the mail (@pxref{Washing Mail}).
17337 Emphasized text can be properly fontisized:
17343 @subsubsection Quassia Gnus
17345 New features in Gnus 5.6:
17350 New functionality for using Gnus as an offline newsreader has been
17351 added. A plethora of new commands and modes have been added. See
17352 @pxref{Gnus Unplugged} for the full story.
17355 The @code{nndraft} backend has returned, but works differently than
17356 before. All Message buffers are now also articles in the @code{nndraft}
17357 group, which is created automatically.
17360 @code{gnus-alter-header-function} can now be used to alter header
17364 @code{gnus-summary-goto-article} now accept Message-ID's.
17367 A new Message command for deleting text in the body of a message
17368 outside the region: @kbd{C-c C-v}.
17371 You can now post to component group in @code{nnvirtual} groups with
17375 @code{nntp-rlogin-program}---new variable to ease customization.
17378 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
17379 re-highlighting of the article buffer.
17382 New element in @code{gnus-boring-article-headers}---@code{long-to}.
17385 @kbd{M-i} symbolic prefix command. See the section "Symbolic
17386 Prefixes" in the Gnus manual for details.
17389 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
17390 @kbd{a} to add the score rule to the "all.SCORE" file.
17393 @code{gnus-simplify-subject-functions} variable to allow greater
17394 control over simplification.
17397 @kbd{A T}---new command for fetching the current thread.
17400 @kbd{/ T}---new command for including the current thread in the
17404 @kbd{M-RET} is a new Message command for breaking cited text.
17407 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
17410 The @code{custom-face-lookup} function has been removed.
17411 If you used this function in your initialization files, you must
17412 rewrite them to use @code{face-spec-set} instead.
17415 Canceling now uses the current select method. Symbolic prefix
17416 @kbd{a} forces normal posting method.
17419 New command to translate M******** sm*rtq**t*s into proper
17423 For easier debugging of @code{nntp}, you can set
17424 @code{nntp-record-commands} to a non-@code{nil} value.
17427 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
17428 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
17431 A command for editing group parameters from the summary buffer
17435 A history of where mails have been split is available.
17438 A new article date command has been added---@code{article-date-iso8601}.
17441 Subjects can be simplified when threading by setting
17442 @code{gnus-score-thread-simplify}.
17445 A new function for citing in Message has been
17446 added---@code{message-cite-original-without-signature}.
17449 @code{article-strip-all-blank-lines}---new article command.
17452 A new Message command to kill to the end of the article has
17456 A minimum adaptive score can be specified by using the
17457 @code{gnus-adaptive-word-minimum} variable.
17460 The "lapsed date" article header can be kept continually
17461 updated by the @code{gnus-start-date-timer} command.
17464 Web listserv archives can be read with the @code{nnlistserv} backend.
17467 Old dejanews archives can now be read by @code{nnweb}.
17472 @node Newest Features
17473 @subsection Newest Features
17476 Also known as the @dfn{todo list}. Sure to be implemented before the
17479 Be afraid. Be very afraid.
17481 (That a feature appears in this list doesn't necessarily mean that I've
17482 decided to actually implement it. It just means that I think it sounds
17485 (Yes, this is the actual, up-to-the-second todo list.)
17490 I would like the zombie-page to contain an URL to the source of the
17491 latest version of gnus or some explanation on where to find it.
17494 A way to continue editing the latest Message composition.
17497 http://www.sonicnet.com/feature/ari3/
17500 facep is not declared.
17503 Include a section in the manual on why the number of articles
17504 isn't the same in the group buffer and on the SPC prompt.
17507 Interacting with rmail fcc isn't easy.
17512 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
17513 <URL:http://www.eit.com/software/hypermail/hypermail.html>
17514 <URL:http://homer.ncm.com/>
17515 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
17516 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
17517 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
17518 http://www.miranova.com/gnus-list/
17523 @samp{^-- } is made into - in LaTeX.
17526 gnus-kill is much slower than it was in GNUS 4.1.3.
17529 when expunging articles on low score, the sparse nodes keep hanging on?
17531 starting the first time seems to hang Gnus on some systems. Does
17532 NEWGROUPS answer too fast?
17534 nndir doesn't read gzipped files.
17536 FAQ doesn't have an up node?
17538 when moving mail from a procmail spool to the crash-box,
17539 the crash-box is only appropriate to one specific group.
17541 `t' `t' makes X-Faces disappear.
17543 nnmh-be-safe means that crossposted articles will
17544 be marked as unread.
17546 Orphan score entries don't show on "V t" score trace
17548 when clearing out data, the cache data should also be reset.
17550 rewrite gnus-summary-limit-children to be non-recursive
17551 to avoid exceeding lisp nesting on huge groups.
17553 expunged articles are counted when computing scores.
17555 implement gnus-batch-brew-soup
17557 ticked articles aren't easy to read in pick mode -- `n' and
17558 stuff just skips past them. Read articles are the same.
17560 topics that contain just groups with ticked
17561 articles aren't displayed.
17563 nndoc should always allocate unique Message-IDs.
17565 If there are mail groups the first time you use Gnus, Gnus'll
17566 make the mail groups killed.
17568 no "no news is good news" when using topics.
17570 when doing crosspost marking, the cache has to be consulted
17571 and articles have to be removed.
17573 nnweb should fetch complete articles when they are split into several
17576 scoring on head immediate doesn't work.
17578 finding short score file names takes forever.
17580 canceling articles in foreign groups.
17582 nntp-open-rlogin no longer works.
17584 C-u C-x C-s (Summary) switches to the group buffer.
17586 move nnmail-split-history out to the backends.
17588 nnweb doesn't work properly.
17590 using a virtual server name as `gnus-select-method' doesn't work?
17592 when killing/yanking a group from one topic to another in a slave, the
17593 master will yank it first to one topic and then add it to another.
17597 warn user about `=' redirection of a group in the active file?
17599 take over the XEmacs menubar and offer a toggle between the XEmacs
17600 bar and the Gnus bar.
17603 push active file and NOV file parsing down into C code.
17604 `(canonize-message-id id)'
17605 `(mail-parent-message-id references n)'
17606 `(parse-news-nov-line &optional dependency-hashtb)'
17607 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
17608 `(parse-news-active-region beg end hashtb)'
17613 nnml .overview directory with splits.
17617 postponed commands.
17619 the selected article show have its Subject displayed in its summary line.
17621 when entering groups, get the real number of unread articles from
17624 sort after gathering threads -- make false roots have the
17625 headers of the oldest orphan with a 0 article number?
17627 nndoc groups should inherit the score files of their parents? Also
17628 inherit copy prompts and save files.
17630 command to start up Gnus (if not running) and enter a mail mode buffer.
17632 allow editing the group description from the group buffer
17633 for backends that support that.
17635 gnus-hide,show-all-topics
17637 groups and sub-topics should be allowed to mingle inside each topic,
17638 and not just list all subtopics at the end.
17640 a command to remove all read articles that are not needed to connect
17641 threads -- `gnus-summary-limit-to-sparse-unread'?
17643 a variable to turn off limiting/cutting of threads in the tree buffer.
17645 a variable to limit how many files are uudecoded.
17647 add zombie groups to a special "New Groups" topic.
17649 server mode command: close/open all connections
17651 put a file date in gnus-score-alist and check whether the file
17652 has been changed before using it.
17654 on exit from a digest group, go to the next article in the parent group.
17656 hide (sub)threads with low score.
17658 when expiring, remove all marks from expired articles.
17660 gnus-summary-limit-to-body
17662 a regexp alist that says what level groups are to be subscribed
17663 on. Eg. -- `(("nnml:" . 1))'.
17665 easier interface to nnkiboze to create ephemeral groups that
17666 contain groups that match a regexp.
17668 allow newlines in <URL:> urls, but remove them before using
17671 If there is no From line, the mail backends should fudge one from the
17674 fuzzy simplifying should strip all non-alpha-numerical info
17675 from subject lines.
17677 gnus-soup-brew-soup-with-high-scores.
17679 nntp-ping-before-connect
17681 command to check whether NOV is evil. "list overview.fmt".
17683 when entering a group, Gnus should look through the score
17684 files very early for `local' atoms and set those local variables.
17686 message annotations.
17688 topics are always yanked before groups, and that's not good.
17690 (set-extent-property extent 'help-echo "String to display in minibuf")
17691 to display help in the minibuffer on buttons under XEmacs.
17693 allow group line format spec to say how many articles there
17698 support qmail maildir spools
17700 `run-with-idle-timer' in gnus-demon.
17702 stop using invisible text properties and start using overlays instead
17704 C-c C-f C-e to add an Expires header.
17706 go from one group to the next; everything is expunged; go to the
17707 next group instead of going to the group buffer.
17709 gnus-renumber-cache -- to renumber the cache using "low" numbers.
17711 record topic changes in the dribble buffer.
17713 `nnfolder-generate-active-file' should look at the folders it
17714 finds and generate proper active ranges.
17716 nneething-look-in-files-for-article-heads variable to control
17717 whether nneething should sniff all files in the directories.
17719 gnus-fetch-article -- start Gnus, enter group, display article
17721 gnus-dont-move-articles-to-same-group variable when respooling.
17723 when messages are crossposted between several auto-expirable groups,
17724 articles aren't properly marked as expirable.
17726 nneething should allow deletion/moving.
17728 TAB on the last button should go to the first button.
17730 if the car of an element in `mail-split-methods' is a function,
17731 and the function returns non-nil, use that as the name of the group(s) to
17734 command for listing all score files that have been applied.
17736 a command in the article buffer to return to `summary' config.
17738 `gnus-always-post-using-current-server' -- variable to override
17739 `C-c C-c' when posting.
17741 nnmail-group-spool-alist -- says where each group should use
17744 when an article is crossposted to an auto-expirable group, the article
17745 should be marker as expirable.
17747 article mode command/menu for "send region as URL to browser".
17749 on errors, jump to info nodes that explain the error. For instance,
17750 on invalid From headers, or on error messages from the nntp server.
17752 when gathering threads, make the article that has no "Re: " the parent.
17753 Also consult Date headers.
17755 a token in splits to call shrink-window-if-larger-than-buffer
17757 `1 0 A M' to do matches on the active hashtb.
17759 duplicates -- command to remove Gnus-Warning header, use the read
17760 Message-ID, delete the "original".
17762 when replying to several messages at once, put the "other" message-ids
17763 into a See-Also header.
17765 support setext: URL:http://www.bsdi.com/setext/
17767 support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
17769 when browsing a foreign server, the groups that are already subscribed
17770 should be listed as such and not as "K".
17772 generate font names dynamically.
17774 score file mode auto-alist.
17776 allow nndoc to change/add/delete things from documents. Implement
17777 methods for each format for adding an article to the document.
17779 `gnus-fetch-old-headers' `all' value to incorporate
17780 absolutely all headers there is.
17782 function like `|', but concatenate all marked articles
17783 and pipe them to the process.
17785 cache the list of killed (or active) groups in a separate file. Update
17786 the file whenever we read the active file or the list
17787 of killed groups in the .eld file reaches a certain length.
17789 function for starting to edit a file to put into
17790 the current mail group.
17792 score-find-trace should display the total score of the article.
17794 "ghettozie" -- score on Xref header and nix it out after using it
17795 to avoid marking as read in other groups it has been crossposted to.
17797 look at procmail splitting. The backends should create
17798 the groups automatically if a spool file exists for that group.
17800 function for backends to register themselves with Gnus.
17802 when replying to several process-marked articles,
17803 have all the From end up in Cc headers? Variable to toggle.
17805 command to delete a crossposted mail article from all
17806 groups it has been mailed to.
17808 `B c' and `B m' should be crosspost aware.
17810 hide-pgp should also hide PGP public key blocks.
17812 Command in the group buffer to respool process-marked groups.
17814 `gnus-summary-find-matching' should accept
17815 pseudo-"headers" like "body", "head" and "all"
17817 When buttifying <URL: > things, all white space (including
17818 newlines) should be ignored.
17820 Process-marking all groups in a topic should process-mark
17821 groups in subtopics as well.
17823 Add non-native groups to the list of killed groups when killing them.
17825 nntp-suggest-kewl-config to probe the nntp server and suggest
17828 add edit and forward secondary marks.
17830 nnml shouldn't visit its .overview files.
17832 allow customizing sorting within gathered threads.
17834 `B q' shouldn't select the current article.
17836 nnmbox should support a newsgroups file for descriptions.
17838 allow fetching mail from several pop servers.
17840 Be able to specify whether the saving commands save the original
17841 or the formatted article.
17843 a command to reparent with the child process-marked (cf. `T ^'.).
17845 I think the possibility to send a password with nntp-open-rlogin
17846 should be a feature in Red Gnus.
17848 The `Z n' command should be possible to execute from a mouse click.
17850 more limiting functions -- date, etc.
17852 be able to limit on a random header; on body; using reverse matches.
17854 a group parameter (`absofucking-total-expiry') that will make Gnus expire
17855 even unread articles.
17857 a command to print the article buffer as postscript.
17859 variable to disable password fetching when opening by nntp-open-telnet.
17861 manual: more example servers -- nntp with rlogin, telnet
17863 checking for bogus groups should clean topic alists as well.
17865 canceling articles in foreign groups.
17867 article number in folded topics isn't properly updated by
17870 Movement in the group buffer to the next unread group should go to the
17871 next closed topic with unread messages if no group can be found.
17873 Extensive info pages generated on the fly with help everywhere --
17874 in the "*Gnus edit*" buffers, for instance.
17876 Topic movement commands -- like thread movement. Up, down, forward, next.
17878 a way to tick/mark as read Gcc'd articles.
17880 a way to say that all groups within a specific topic comes
17881 from a particular server? Hm.
17883 `gnus-article-fill-if-long-lines' -- a function to fill
17884 the article buffer if there are any looong lines there.
17886 `T h' should jump to the parent topic and fold it.
17888 a command to create an ephemeral nndoc group out of a file,
17889 and then splitting it/moving it to some other group/backend.
17891 a group parameter for nnkiboze groups that says that
17892 all kibozed articles should be entered into the cache.
17894 It should also probably be possible to delimit what
17895 `gnus-jog-cache' does -- for instance, work on just some groups, or on
17896 some levels, and entering just articles that have a score higher than
17899 nnfolder should append to the folder instead of re-writing
17900 the entire folder to disk when accepting new messages.
17902 allow all backends to do the proper thing with .gz files.
17904 a backend for reading collections of babyl files nnbabylfolder?
17906 a command for making the native groups into foreign groups.
17908 server mode command for clearing read marks from all groups
17911 when following up multiple articles, include all To, Cc, etc headers
17914 a command for deciding what the total score of the current
17915 thread is. Also a way to highlight based on this.
17917 command to show and edit group scores
17919 a gnus-tree-minimize-horizontal to minimize tree buffers
17922 command to generate nnml overview file for one group.
17924 `C-u C-u a' -- prompt for many crossposted groups.
17926 keep track of which mail groups have received new articles (in this session).
17927 Be able to generate a report and perhaps do some marking in the group
17930 gnus-build-sparse-threads to a number -- build only sparse threads
17931 that are of that length.
17933 have nnmh respect mh's unseen sequence in .mh_profile.
17935 cache the newsgroups descriptions locally.
17937 asynchronous posting under nntp.
17939 be able to control word adaptive scoring from the score files.
17941 a variable to make `C-c C-c' post using the "current" select method.
17943 `limit-exclude-low-scored-articles'.
17945 if `gnus-summary-show-thread' is a number, hide threads that have
17946 a score lower than this number.
17948 split newsgroup subscription variable up into "order" and "method".
17950 buttonize ange-ftp file names.
17952 a command to make a duplicate copy of the current article
17953 so that each copy can be edited separately.
17955 nnweb should allow fetching from the local nntp server.
17957 record the sorting done in the summary buffer so that
17958 it can be repeated when limiting/regenerating the buffer.
17960 nnml-generate-nov-databses should generate for
17963 when the user does commands in the group buffer, check
17964 the modification time of the .newsrc.eld file and use
17965 ask-user-about-supersession-threat. Also warn when trying
17966 to save .newsrc.eld and it has changed.
17968 M-g on a topic will display all groups with 0 articles in
17971 command to remove all topic stuff.
17973 allow exploding incoming digests when reading incoming mail
17974 and splitting the resulting digests.
17976 nnsoup shouldn't set the `message-' variables.
17978 command to nix out all nnoo state information.
17980 nnmail-process-alist that calls functions if group names
17981 matches an alist -- before saving.
17983 use buffer-invisibility-spec everywhere for hiding text.
17985 variable to activate each group before entering them
17986 to get the (new) number of articles. `gnus-activate-before-entering'.
17988 command to fetch a Message-ID from any buffer, even
17989 starting Gnus first if necessary.
17991 when posting and checking whether a group exists or not, just
17992 ask the nntp server instead of relying on the active hashtb.
17994 buttonize the output of `C-c C-a' in an apropos-like way.
17996 `G p' should understand process/prefix, and allow editing
17997 of several groups at once.
17999 command to create an ephemeral nnvirtual group that
18000 matches some regexp(s).
18002 nndoc should understand "Content-Type: message/rfc822" forwarded messages.
18004 it should be possible to score "thread" on the From header.
18006 hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
18008 `B i' should display the article at once in the summary buffer.
18010 remove the "*" mark at once when unticking an article.
18012 `M-s' should highlight the matching text.
18014 when checking for duplicated mails, use Resent-Message-ID if present.
18016 killing and yanking groups in topics should be better. If killing one copy
18017 of a group that exists in multiple topics, only that copy should
18018 be removed. Yanking should insert the copy, and yanking topics
18019 should be possible to be interspersed with the other yankings.
18021 command for enter a group just to read the cached articles. A way to say
18022 "ignore the nntp connection; just read from the cache."
18024 `X u' should decode base64 articles.
18026 a way to hide all "inner" cited text, leaving just the most
18027 recently cited text.
18029 nnvirtual should be asynchronous.
18031 after editing an article, gnus-original-article-buffer should
18034 there should probably be a way to make Gnus not connect to the
18035 server and just read the articles in the server
18037 allow a `set-default' (or something) to change the default
18038 value of nnoo variables.
18040 a command to import group infos from a .newsrc.eld file.
18042 groups from secondary servers have the entire select method
18043 listed in each group info.
18045 a command for just switching from the summary buffer to the group
18048 a way to specify that some incoming mail washing functions
18049 should only be applied to some groups.
18051 Message `C-f C-t' should ask the user whether to heed
18052 mail-copies-to: never.
18054 new group parameter -- `post-to-server' that says to post
18055 using the current server. Also a variable to do the same.
18057 the slave dribble files should auto-save to the slave file names.
18059 a group parameter that says what articles to display on group entry, based
18062 a way to visually distinguish slave Gnusae from masters. (Whip instead
18065 Use DJ Bernstein "From " quoting/dequoting, where applicable.
18067 Why is hide-citation-maybe and hide-citation different? Also
18070 group user-defined meta-parameters.
18074 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
18076 I like the option for trying to retrieve the FAQ for a group and I was
18077 thinking it would be great if for those newsgroups that had archives
18078 you could also try to read the archive for that group. Part of the
18079 problem is that archives are spread all over the net, unlike FAQs.
18080 What would be best I suppose is to find the one closest to your site.
18082 In any case, there is a list of general news group archives at @*
18083 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
18090 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
18091 (add-hook 'gnus-select-group-hook
18093 (gnus-group-add-parameter group
18094 (cons 'gnus-group-date-last-entered (list (current-time-string))))))
18096 (defun gnus-user-format-function-d (headers)
18097 "Return the date the group was last read."
18098 (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
18103 tanken var at når du bruker `gnus-startup-file' som prefix (FOO) til å lete
18104 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
18105 liste hvor du bruker hvert element i listen som FOO, istedet. da kunne man
18106 hatt forskjellige serveres startup-filer forskjellige steder.
18110 LMI> Well, nnbabyl could alter the group info to heed labels like
18111 LMI> answered and read, I guess.
18113 It could also keep them updated (the same for the Status: header of
18116 They could be used like this:
18120 `M l <name> RET' add label <name> to current message.
18121 `M u <name> RET' remove label <name> from current message.
18122 `/ l <expr> RET' limit summary buffer according to <expr>.
18124 <expr> would be a boolean expression on the labels, e.g.
18126 `/ l bug & !fixed RET'
18129 would show all the messages which are labeled `bug' but not labeled
18132 One could also imagine the labels being used for highlighting, or
18133 affect the summary line format.
18137 Sender: abraham@@dina.kvl.dk
18139 I'd like a gnus-find-file which work like find file, except that it
18140 would recognize things that looks like messages or folders:
18142 - If it is a directory containing numbered files, create an nndir
18145 - For other directories, create a nneething summary buffer.
18147 - For files matching "\\`From ", create a nndoc/mbox summary.
18149 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
18151 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
18153 - For other files, just find them normally.
18155 I'd like `nneething' to use this function, so it would work on a
18156 directory potentially containing mboxes or babyl files.
18159 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
18160 tell him what you are doing.
18163 Currently, I get prompted:
18167 decend into sci.something ?
18171 The problem above is that since there is really only one subsection of
18172 science, shouldn't it prompt you for only descending sci.something? If
18173 there was a sci.somethingelse group or section, then it should prompt
18174 for sci? first the sci.something? then sci.somethingelse?...
18177 Ja, det burde være en måte å si slikt. Kanskje en ny variabel?
18178 `gnus-use-few-score-files'? SÃ¥ kunne score-regler legges til den
18179 "mest" lokale score-fila. F. eks. ville no-gruppene betjenes av
18180 "no.all.SCORE", osv.
18183 What i want is for Gnus to treat any sequence or combination of the following
18184 as a single spoiler warning and hide it all, replacing it with a "Next Page"
18190 more than n blank lines
18192 more than m identical lines
18193 (which should be replaced with button to show them)
18195 any whitespace surrounding any of the above
18199 Well, we could allow a new value to `gnus-thread-ignore-subject' --
18200 `spaces', or something. (We could even default to that.) And then
18201 subjects that differ in white space only could be considered the
18202 "same" subject for threading purposes.
18205 Modes to preprocess the contents (e.g. jka-compr) use the second form
18206 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
18207 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
18208 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
18211 Under XEmacs -- do funny article marks:
18214 soup - bowl of soup
18215 score below - dim light bulb
18216 score over - bright light bulb
18219 Yes. I think the algorithm is as follows:
18224 show-list-of-articles-in-group
18225 if (key-pressed == SPACE)
18226 if (no-more-articles-in-group-to-select)
18227 if (articles-selected)
18228 start-reading-selected-articles;
18229 junk-unread-articles;
18234 else if (key-pressed = '.')
18235 if (consolidated-menus) # same as hide-thread in Gnus
18236 select-thread-under-cursor;
18238 select-article-under-cursor;
18242 if (key-pressed == SPACE)
18243 if (more-pages-in-article)
18245 else if (more-selected-articles-to-read)
18252 My precise need here would have been to limit files to Incoming*.
18253 One could think of some `nneething-only-files' variable, but I guess
18254 it would have been unacceptable if one was using many unrelated such
18257 A more useful approach would be to, in response to the `G D' prompt, be
18258 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
18259 the top-level directory only (in case directories would be matched by
18260 the wildcard expression).
18263 It would be nice if it also handled
18265 <URL:news://sunsite.auc.dk/>
18267 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
18272 Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
18273 really well. Each menu is 'named' by a symbol that would be on a
18274 gnus-*-menus (where * would be whatever, but at least group, summary, and
18275 article versions) variable.
18277 So for gnus-summary-menus, I would set to '(sort mark dispose ...)
18279 A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
18280 the main menubar. This approach works really well for Emacs-W3 and VM.
18284 nndoc should take care to create unique Message-IDs for all its
18287 gnus-score-followup-article only works when you have a summary buffer
18288 active. Make it work when posting from the group buffer as well.
18289 (message-sent-hook).
18291 rewrite gnus-demon to use run-with-idle-timers.
18294 * Enhancements to Gnus:
18298 * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
18299 straight to the server buffer, without opening any connections to
18302 * gnus-server-read-server-newsrc--produces a buffer very similar to
18303 the group buffer, but with only groups from that server listed;
18304 quitting this buffer returns to the server buffer.
18307 add a command to check the integrity of an nnfolder folder --
18308 go through the article numbers and see that there are no duplicates,
18312 `unsmileyfy-buffer' to undo smileification.
18315 a command to give all relevant info on an article, including all
18319 when doing `-request-accept-article', the backends should do
18320 the nnmail duplicate checking.
18323 allow `message-signature-file' to be a function to return the
18324 value of the signature file.
18327 In addition, I would love it if I could configure message-tab so that it
18328 could call `bbdb-complete-name' in other headers. So, some sort of
18331 (setq message-tab-alist
18332 '((message-header-regexp message-expand-group)
18333 ("^\\(To\\|[cC]c\\|[bB]cc\\)" bbdb-complete-name)))
18335 then you could run the relevant function to complete the information in
18339 cache the newsgroups file locally to avoid reloading it all the time.
18342 a command to import a buffer into a group.
18345 nnweb should allow fetching by Message-ID from servers.
18348 point in the article buffer doesn't always go to the
18349 beginning of the buffer when selecting new articles.
18352 a command to process mark all unread articles.
18355 `gnus-gather-threads-by-references-and-subject' -- first
18356 do gathering by references, and then go through the dummy roots and
18357 do more gathering by subject.
18360 gnus-uu-mark-in-numerical-order -- process mark articles in
18361 article numerical order.
18364 (gnus-thread-total-score
18365 (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
18369 sorting by score is wrong when using sparse threads.
18372 a command to fetch an arbitrary article -- without having to be
18373 in the summary buffer.
18376 a new nncvs backend. Each group would show an article, using
18377 version branches as threading, checkin date as the date, etc.
18380 http://www.dejanews.com/forms/dnsetfilter_exp.html ?
18381 This filter allows one to construct advance queries on the Dejanews
18382 database such as specifying start and end dates, subject, author,
18383 and/or newsgroup name.
18386 new Date header scoring type -- older, newer
18389 use the summary toolbar in the article buffer.
18392 a command to fetch all articles that are less than X days old.
18395 in pick mode, `q' should save the list of selected articles in the
18396 group info. The next time the group is selected, these articles
18397 will automatically get the process mark.
18400 Isn't it possible to (also?) allow M-^ to automatically try the
18401 default server if it fails on the current server? (controlled by a
18402 user variable, (nil, t, 'ask)).
18405 make it possible to cancel articles using the select method for the
18409 `gnus-summary-select-article-on-entry' or something. It'll default
18410 to t and will select whatever article decided by `gnus-auto-select-first'.
18413 a new variable to control which selection commands should be unselecting.
18414 `first', `best', `next', `prev', `next-unread', `prev-unread' are
18418 be able to select groups that have no articles in them
18419 to be able to post in them (using the current select method).
18422 be able to post via DejaNews.
18425 `x' should retain any sortings that have been performed.
18428 allow the user to specify the precedence of the secondary marks. Also
18429 allow them to be displayed separately.
18432 gnus-summary-save-in-pipe should concatenate the results from
18433 the processes when doing a process marked pipe.
18436 a new match type, like Followup, but which adds Thread matches on all
18437 articles that match a certain From header.
18440 a function that can be read from kill-emacs-query-functions to offer
18441 saving living summary buffers.
18444 a function for selecting a particular group which will contain
18445 the articles listed in a list of article numbers/id's.
18448 a battery of character translation functions to translate common
18449 Mac, MS (etc) characters into ISO 8859-1.
18452 (defun article-fix-m$word ()
18453 "Fix M$Word smartquotes in an article."
18456 (let ((buffer-read-only nil))
18457 (goto-char (point-min))
18458 (while (search-forward "\221" nil t)
18459 (replace-match "`" t t))
18460 (goto-char (point-min))
18461 (while (search-forward "\222" nil t)
18462 (replace-match "'" t t))
18463 (goto-char (point-min))
18464 (while (search-forward "\223" nil t)
18465 (replace-match "\"" t t))
18466 (goto-char (point-min))
18467 (while (search-forward "\224" nil t)
18468 (replace-match "\"" t t)))))
18473 (add-hook 'gnus-exit-query-functions
18475 (if (and (file-exists-p nnmail-spool-file)
18476 (> (nnheader-file-size nnmail-spool-file) 0))
18477 (yes-or-no-p "New mail has arrived. Quit Gnus anyways? ")
18478 (y-or-n-p "Are you sure you want to quit Gnus? "))))
18482 allow message-default-headers to be a function.
18485 new Date score match types -- < > = (etc) that take floating point
18486 numbers and match on the age of the article.
18490 > > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
18491 > > > under xemacs-19.14, it's creating a new frame, but is erasing the
18492 > > > buffer in the frame that it was called from =:-O
18494 > > Hm. How do you start up Gnus? From the toolbar or with
18495 > > `M-x gnus-other-frame'?
18497 > I normally start it up from the toolbar; at
18498 > least that's the way I've caught it doing the
18503 all commands that react to the process mark should push
18504 the current process mark set onto the stack.
18507 gnus-article-hide-pgp
18508 Selv ville jeg nok ha valgt å slette den dersom teksten matcher
18510 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
18512 og det er maks hundre tegn mellom match-end og ----linja. Men -det-
18513 er min type heuristikk og langt fra alles.
18516 `gnus-subscribe-sorted' -- insert new groups where they would have been
18517 sorted to if `gnus-group-sort-function' were run.
18520 gnus-(group,summary)-highlight should respect any `face' text props set
18524 use run-with-idle-timer for gnus-demon instead of the
18525 home-brewed stuff for better reliability.
18528 add a way to select which NoCeM type to apply -- spam, troll, etc.
18531 nndraft-request-group should tally auto-save files.
18534 implement nntp-retry-on-break and nntp-command-timeout.
18537 gnus-article-highlight-limit that says when not to highlight (long)
18541 (nnoo-set SERVER VARIABLE VALUE)
18547 interrupitng agent fetching of articles should save articles.
18550 command to open a digest group, and copy all the articles there to the
18554 a variable to disable article body highlights if there's more than
18555 X characters in the body.
18558 handle 480/381 authinfo requests separately.
18561 include the texi/dir file in the distribution.
18564 format spec to "tab" to a position.
18567 Move all prompting to the new `M-n' default style.
18570 command to display all dormant articles.
18573 gnus-auto-select-next makeover -- list of things it should do.
18576 a score match type that adds scores matching on From if From has replied
18577 to something someone else has said.
18580 Read Netscape discussion groups:
18581 snews://secnews.netscape.com/netscape.communicator.unix
18584 One command to edit the original version if an article, and one to edit
18585 the displayed version.
18588 @kbd{T v} -- make all process-marked articles the children of the
18592 Switch from initial text to the new default text mechanism.
18595 How about making it possible to expire local articles? Will it be
18596 possible to make various constraints on when an article can be
18597 expired, e.g. (read), (age > 14 days), or the more interesting (read
18601 New limit command---limit to articles that have a certain string
18602 in the head or body.
18605 Allow breaking lengthy NNTP commands.
18608 gnus-article-highlight-limit, to disable highlighting in big articles.
18611 Editing an article should put the article to be edited
18612 in a special, unique buffer.
18615 A command to send a mail to the admin-address group param.
18618 A Date scoring type that will match if the article
18619 is less than a certain number of days old.
18622 New spec: %~(tab 56) to put point on column 56
18625 Allow Gnus Agent scoring to use normal score files.
18628 Rething the Agent active file thing. `M-g' doesn't update the active
18629 file, for instance.
18632 With dummy roots, `^' and then selecing the first article
18633 in any other dummy thread will make Gnus highlight the
18634 dummy root instead of the first article.
18637 Propagate all group properties (marks, article numbers, etc) up to the
18638 topics for displaying.
18641 `n' in the group buffer with topics should go to the next group
18642 with unread articles, even if that group is hidden in a topic.
18645 gnus-posting-styles doesn't work in drafts.
18648 gnus-summary-limit-include-cached is slow when there are
18649 many articles in the cache, since it regenerates big parts of the
18650 summary buffer for each article.
18653 Implement gnus-batch-brew-soup.
18656 Group parameters and summary commands for un/subscribing to mailing
18660 Introduce nnmail-home-directory.
18663 gnus-fetch-group and friends should exit Gnus when the user
18667 The jingle is only played on the second invocation of Gnus.
18670 Bouncing articles should do MIME.
18673 Crossposted articles should "inherit" the % or @ mark from the other
18674 groups it has been crossposted to, or something. (Agent.)
18677 `S D r' should allow expansion of aliases.
18680 If point is on a group that appears multiple times in topics, and
18681 you press `l', point will move to the first instance of the group.
18684 The documentation should mention pop3.el, fetchmail, smtpmail and why
18685 po:username often fails.
18688 Fetch by Message-ID from dejanews.
18690 <URL:http://search.dejanews.com/msgid.xp?MID=%3C62h9l9$hm4@@basement.replay.com%3E&fmt=raw>
18693 A spec for the group line format to display the number of
18694 agent-downloaded articles in the group.
18697 Some nntp servers never respond when posting, so there should be a
18698 timeout for all commands.
18701 When stading on a topic line and `t'-ing, point goes to the last line.
18702 It should go somewhere else.
18705 Solve the halting problem.
18714 @section The Manual
18718 This manual was generated from a TeXinfo file and then run through
18719 either @code{texi2dvi}
18721 or my own home-brewed TeXinfo to \LaTeX\ transformer,
18722 and then run through @code{latex} and @code{dvips}
18724 to get what you hold in your hands now.
18726 The following conventions have been used:
18731 This is a @samp{string}
18734 This is a @kbd{keystroke}
18737 This is a @file{file}
18740 This is a @code{symbol}
18744 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
18748 (setq flargnoze "yes")
18751 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
18754 (setq flumphel 'yes)
18757 @samp{yes} and @code{yes} are two @emph{very} different things---don't
18758 ever get them confused.
18762 Of course, everything in this manual is of vital interest, so you should
18763 read it all. Several times. However, if you feel like skimming the
18764 manual, look for that gnu head you should see in the margin over
18765 there---it means that what's being discussed is of more importance than
18766 the rest of the stuff. (On the other hand, if everything is infinitely
18767 important, how can anything be more important than that? Just one more
18768 of the mysteries of this world, I guess.)
18776 @section Terminology
18778 @cindex terminology
18783 This is what you are supposed to use this thing for---reading news.
18784 News is generally fetched from a nearby @sc{nntp} server, and is
18785 generally publicly available to everybody. If you post news, the entire
18786 world is likely to read just what you have written, and they'll all
18787 snigger mischievously. Behind your back.
18791 Everything that's delivered to you personally is mail. Some news/mail
18792 readers (like Gnus) blur the distinction between mail and news, but
18793 there is a difference. Mail is private. News is public. Mailing is
18794 not posting, and replying is not following up.
18798 Send a mail to the person who has written what you are reading.
18802 Post an article to the current newsgroup responding to the article you
18807 Gnus gets fed articles from a number of backends, both news and mail
18808 backends. Gnus does not handle the underlying media, so to speak---this
18809 is all done by the backends.
18813 Gnus will always use one method (and backend) as the @dfn{native}, or
18814 default, way of getting news.
18818 You can also have any number of foreign groups active at the same time.
18819 These are groups that use non-native non-secondary backends for getting
18824 Secondary backends are somewhere half-way between being native and being
18825 foreign, but they mostly act like they are native.
18829 A message that has been posted as news.
18832 @cindex mail message
18833 A message that has been mailed.
18837 A mail message or news article
18841 The top part of a message, where administrative information (etc.) is
18846 The rest of an article. Everything not in the head is in the
18851 A line from the head of an article.
18855 A collection of such lines, or a collection of heads. Or even a
18856 collection of @sc{nov} lines.
18860 When Gnus enters a group, it asks the backend for the headers of all
18861 unread articles in the group. Most servers support the News OverView
18862 format, which is more compact and much faster to read and parse than the
18863 normal @sc{head} format.
18867 Each group is subscribed at some @dfn{level} or other (1-9). The ones
18868 that have a lower level are ``more'' subscribed than the groups with a
18869 higher level. In fact, groups on levels 1-5 are considered
18870 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
18871 are @dfn{killed}. Commands for listing groups and scanning for new
18872 articles will all use the numeric prefix as @dfn{working level}.
18874 @item killed groups
18875 @cindex killed groups
18876 No information on killed groups is stored or updated, which makes killed
18877 groups much easier to handle than subscribed groups.
18879 @item zombie groups
18880 @cindex zombie groups
18881 Just like killed groups, only slightly less dead.
18884 @cindex active file
18885 The news server has to keep track of what articles it carries, and what
18886 groups exist. All this information in stored in the active file, which
18887 is rather large, as you might surmise.
18890 @cindex bogus groups
18891 A group that exists in the @file{.newsrc} file, but isn't known to the
18892 server (i.e., it isn't in the active file), is a @emph{bogus group}.
18893 This means that the group probably doesn't exist (any more).
18896 @cindex activating groups
18897 The act of asking the server for info on a group and computing the
18898 number of unread articles is called @dfn{activating the group}.
18899 Un-activated groups are listed with @samp{*} in the group buffer.
18903 A machine one can connect to and get news (or mail) from.
18905 @item select method
18906 @cindex select method
18907 A structure that specifies the backend, the server and the virtual
18910 @item virtual server
18911 @cindex virtual server
18912 A named select method. Since a select method defines all there is to
18913 know about connecting to a (physical) server, taking the thing as a
18914 whole is a virtual server.
18918 Taking a buffer and running it through a filter of some sort. The
18919 result will (more often than not) be cleaner and more pleasing than the
18922 @item ephemeral groups
18923 @cindex ephemeral groups
18924 Most groups store data on what articles you have read. @dfn{Ephemeral}
18925 groups are groups that will have no data stored---when you exit the
18926 group, it'll disappear into the aether.
18929 @cindex solid groups
18930 This is the opposite of ephemeral groups. All groups listed in the
18931 group buffer are solid groups.
18933 @item sparse articles
18934 @cindex sparse articles
18935 These are article placeholders shown in the summary buffer when
18936 @code{gnus-build-sparse-threads} has been switched on.
18940 To put responses to articles directly after the articles they respond
18941 to---in a hierarchical fashion.
18945 @cindex thread root
18946 The first article in a thread is the root. It is the ancestor of all
18947 articles in the thread.
18951 An article that has responses.
18955 An article that responds to a different article---its parent.
18959 A collection of messages in one file. The most common digest format is
18960 specified by RFC1153.
18966 @node Customization
18967 @section Customization
18968 @cindex general customization
18970 All variables are properly documented elsewhere in this manual. This
18971 section is designed to give general pointers on how to customize Gnus
18972 for some quite common situations.
18975 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
18976 * Slow Terminal Connection:: You run a remote Emacs.
18977 * Little Disk Space:: You feel that having large setup files is icky.
18978 * Slow Machine:: You feel like buying a faster machine.
18982 @node Slow/Expensive Connection
18983 @subsection Slow/Expensive @sc{nntp} Connection
18985 If you run Emacs on a machine locally, and get your news from a machine
18986 over some very thin strings, you want to cut down on the amount of data
18987 Gnus has to get from the @sc{nntp} server.
18991 @item gnus-read-active-file
18992 Set this to @code{nil}, which will inhibit Gnus from requesting the
18993 entire active file from the server. This file is often v. large. You
18994 also have to set @code{gnus-check-new-newsgroups} and
18995 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
18996 doesn't suddenly decide to fetch the active file anyway.
18998 @item gnus-nov-is-evil
18999 This one has to be @code{nil}. If not, grabbing article headers from
19000 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
19001 support @sc{xover}; Gnus will detect this by itself.
19005 @node Slow Terminal Connection
19006 @subsection Slow Terminal Connection
19008 Let's say you use your home computer for dialing up the system that runs
19009 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
19010 possible) the amount of data sent over the wires.
19014 @item gnus-auto-center-summary
19015 Set this to @code{nil} to inhibit Gnus from re-centering the summary
19016 buffer all the time. If it is @code{vertical}, do only vertical
19017 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
19018 horizontal and vertical recentering.
19020 @item gnus-visible-headers
19021 Cut down on the headers included in the articles to the
19022 minimum. You can, in fact, make do without them altogether---most of the
19023 useful data is in the summary buffer, anyway. Set this variable to
19024 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
19026 Set this hook to all the available hiding commands:
19028 (setq gnus-treat-hide-headers 'head
19029 gnus-treat-hide-signature t
19030 gnus-treat-hide-citation t)
19033 @item gnus-use-full-window
19034 By setting this to @code{nil}, you can make all the windows smaller.
19035 While this doesn't really cut down much generally, it means that you
19036 have to see smaller portions of articles before deciding that you didn't
19037 want to read them anyway.
19039 @item gnus-thread-hide-subtree
19040 If this is non-@code{nil}, all threads in the summary buffer will be
19043 @item gnus-updated-mode-lines
19044 If this is @code{nil}, Gnus will not put information in the buffer mode
19045 lines, which might save some time.
19049 @node Little Disk Space
19050 @subsection Little Disk Space
19053 The startup files can get rather large, so you may want to cut their
19054 sizes a bit if you are running out of space.
19058 @item gnus-save-newsrc-file
19059 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
19060 only save @file{.newsrc.eld}. This means that you will not be able to
19061 use any other newsreaders than Gnus. This variable is @code{t} by
19064 @item gnus-save-killed-list
19065 If this is @code{nil}, Gnus will not save the list of dead groups. You
19066 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
19067 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
19068 variable to @code{nil}. This variable is @code{t} by default.
19074 @subsection Slow Machine
19075 @cindex slow machine
19077 If you have a slow machine, or are just really impatient, there are a
19078 few things you can do to make Gnus run faster.
19080 Set @code{gnus-check-new-newsgroups} and
19081 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
19083 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
19084 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
19085 summary buffer faster.
19089 @node Troubleshooting
19090 @section Troubleshooting
19091 @cindex troubleshooting
19093 Gnus works @emph{so} well straight out of the box---I can't imagine any
19101 Make sure your computer is switched on.
19104 Make sure that you really load the current Gnus version. If you have
19105 been running @sc{gnus}, you need to exit Emacs and start it up again before
19109 Try doing an @kbd{M-x gnus-version}. If you get something that looks
19110 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded. If,
19111 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
19112 flee}, you have some old @file{.el} files lying around. Delete these.
19115 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
19119 @vindex max-lisp-eval-depth
19120 Gnus works on many recursive structures, and in some extreme (and very
19121 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
19122 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
19123 something like that.
19126 If all else fails, report the problem as a bug.
19129 @cindex reporting bugs
19131 @kindex M-x gnus-bug
19133 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
19134 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
19135 me the backtrace. I will fix bugs, but I can only fix them if you send
19136 me a precise description as to how to reproduce the bug.
19138 You really can never be too detailed in a bug report. Always use the
19139 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
19140 a 10Kb mail each time you use it, and even if you have sent me your
19141 environment 500 times before. I don't care. I want the full info each
19144 It is also important to remember that I have no memory whatsoever. If
19145 you send a bug report, and I send you a reply, and then you just send
19146 back ``No, it's not! Moron!'', I will have no idea what you are
19147 insulting me about. Always over-explain everything. It's much easier
19148 for all of us---if I don't have all the information I need, I will just
19149 mail you and ask for more info, and everything takes more time.
19151 If the problem you're seeing is very visual, and you can't quite explain
19152 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
19153 it somewhere it can be reached, and include the URL of the picture in
19156 If you just need help, you are better off asking on
19157 @samp{gnu.emacs.gnus}. I'm not very helpful.
19159 @cindex gnu.emacs.gnus
19160 @cindex ding mailing list
19161 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
19162 Write to @samp{ding-request@@gnus.org} to subscribe.
19166 @node Gnus Reference Guide
19167 @section Gnus Reference Guide
19169 It is my hope that other people will figure out smart stuff that Gnus
19170 can do, and that other people will write those smart things as well. To
19171 facilitate that I thought it would be a good idea to describe the inner
19172 workings of Gnus. And some of the not-so-inner workings, while I'm at
19175 You can never expect the internals of a program not to change, but I
19176 will be defining (in some details) the interface between Gnus and its
19177 backends (this is written in stone), the format of the score files
19178 (ditto), data structures (some are less likely to change than others)
19179 and general methods of operation.
19182 * Gnus Utility Functions:: Common functions and variable to use.
19183 * Backend Interface:: How Gnus communicates with the servers.
19184 * Score File Syntax:: A BNF definition of the score file standard.
19185 * Headers:: How Gnus stores headers internally.
19186 * Ranges:: A handy format for storing mucho numbers.
19187 * Group Info:: The group info format.
19188 * Extended Interactive:: Symbolic prefixes and stuff.
19189 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
19190 * Various File Formats:: Formats of files that Gnus use.
19194 @node Gnus Utility Functions
19195 @subsection Gnus Utility Functions
19196 @cindex Gnus utility functions
19197 @cindex utility functions
19199 @cindex internal variables
19201 When writing small functions to be run from hooks (and stuff), it's
19202 vital to have access to the Gnus internal functions and variables.
19203 Below is a list of the most common ones.
19207 @item gnus-newsgroup-name
19208 @vindex gnus-newsgroup-name
19209 This variable holds the name of the current newsgroup.
19211 @item gnus-find-method-for-group
19212 @findex gnus-find-method-for-group
19213 A function that returns the select method for @var{group}.
19215 @item gnus-group-real-name
19216 @findex gnus-group-real-name
19217 Takes a full (prefixed) Gnus group name, and returns the unprefixed
19220 @item gnus-group-prefixed-name
19221 @findex gnus-group-prefixed-name
19222 Takes an unprefixed group name and a select method, and returns the full
19223 (prefixed) Gnus group name.
19225 @item gnus-get-info
19226 @findex gnus-get-info
19227 Returns the group info list for @var{group}.
19229 @item gnus-group-unread
19230 @findex gnus-group-unread
19231 The number of unread articles in @var{group}, or @code{t} if that is
19235 @findex gnus-active
19236 The active entry for @var{group}.
19238 @item gnus-set-active
19239 @findex gnus-set-active
19240 Set the active entry for @var{group}.
19242 @item gnus-add-current-to-buffer-list
19243 @findex gnus-add-current-to-buffer-list
19244 Adds the current buffer to the list of buffers to be killed on Gnus
19247 @item gnus-continuum-version
19248 @findex gnus-continuum-version
19249 Takes a Gnus version string as a parameter and returns a floating point
19250 number. Earlier versions will always get a lower number than later
19253 @item gnus-group-read-only-p
19254 @findex gnus-group-read-only-p
19255 Says whether @var{group} is read-only or not.
19257 @item gnus-news-group-p
19258 @findex gnus-news-group-p
19259 Says whether @var{group} came from a news backend.
19261 @item gnus-ephemeral-group-p
19262 @findex gnus-ephemeral-group-p
19263 Says whether @var{group} is ephemeral or not.
19265 @item gnus-server-to-method
19266 @findex gnus-server-to-method
19267 Returns the select method corresponding to @var{server}.
19269 @item gnus-server-equal
19270 @findex gnus-server-equal
19271 Says whether two virtual servers are equal.
19273 @item gnus-group-native-p
19274 @findex gnus-group-native-p
19275 Says whether @var{group} is native or not.
19277 @item gnus-group-secondary-p
19278 @findex gnus-group-secondary-p
19279 Says whether @var{group} is secondary or not.
19281 @item gnus-group-foreign-p
19282 @findex gnus-group-foreign-p
19283 Says whether @var{group} is foreign or not.
19285 @item group-group-find-parameter
19286 @findex group-group-find-parameter
19287 Returns the parameter list of @var{group}. If given a second parameter,
19288 returns the value of that parameter for @var{group}.
19290 @item gnus-group-set-parameter
19291 @findex gnus-group-set-parameter
19292 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
19294 @item gnus-narrow-to-body
19295 @findex gnus-narrow-to-body
19296 Narrows the current buffer to the body of the article.
19298 @item gnus-check-backend-function
19299 @findex gnus-check-backend-function
19300 Takes two parameters, @var{function} and @var{group}. If the backend
19301 @var{group} comes from supports @var{function}, return non-@code{nil}.
19304 (gnus-check-backend-function "request-scan" "nnml:misc")
19308 @item gnus-read-method
19309 @findex gnus-read-method
19310 Prompts the user for a select method.
19315 @node Backend Interface
19316 @subsection Backend Interface
19318 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
19319 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
19320 server is a @dfn{backend} and some @dfn{backend variables}. As examples
19321 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
19322 examples of the latter we have @code{nntp-port-number} and
19323 @code{nnmbox-directory}.
19325 When Gnus asks for information from a backend---say @code{nntp}---on
19326 something, it will normally include a virtual server name in the
19327 function parameters. (If not, the backend should use the ``current''
19328 virtual server.) For instance, @code{nntp-request-list} takes a virtual
19329 server as its only (optional) parameter. If this virtual server hasn't
19330 been opened, the function should fail.
19332 Note that a virtual server name has no relation to some physical server
19333 name. Take this example:
19337 (nntp-address "ifi.uio.no")
19338 (nntp-port-number 4324))
19341 Here the virtual server name is @samp{odd-one} while the name of
19342 the physical server is @samp{ifi.uio.no}.
19344 The backends should be able to switch between several virtual servers.
19345 The standard backends implement this by keeping an alist of virtual
19346 server environments that they pull down/push up when needed.
19348 There are two groups of interface functions: @dfn{required functions},
19349 which must be present, and @dfn{optional functions}, which Gnus will
19350 always check for presence before attempting to call 'em.
19352 All these functions are expected to return data in the buffer
19353 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
19354 unfortunately named, but we'll have to live with it. When I talk about
19355 @dfn{resulting data}, I always refer to the data in that buffer. When I
19356 talk about @dfn{return value}, I talk about the function value returned by
19357 the function call. Functions that fail should return @code{nil} as the
19360 Some backends could be said to be @dfn{server-forming} backends, and
19361 some might be said not to be. The latter are backends that generally
19362 only operate on one group at a time, and have no concept of ``server''
19363 -- they have a group, and they deliver info on that group and nothing
19366 In the examples and definitions I will refer to the imaginary backend
19369 @cindex @code{nnchoke}
19372 * Required Backend Functions:: Functions that must be implemented.
19373 * Optional Backend Functions:: Functions that need not be implemented.
19374 * Error Messaging:: How to get messages and report errors.
19375 * Writing New Backends:: Extending old backends.
19376 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
19377 * Mail-like Backends:: Some tips on mail backends.
19381 @node Required Backend Functions
19382 @subsubsection Required Backend Functions
19386 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
19388 @var{articles} is either a range of article numbers or a list of
19389 @code{Message-ID}s. Current backends do not fully support either---only
19390 sequences (lists) of article numbers, and most backends do not support
19391 retrieval of @code{Message-ID}s. But they should try for both.
19393 The result data should either be HEADs or NOV lines, and the result
19394 value should either be @code{headers} or @code{nov} to reflect this.
19395 This might later be expanded to @code{various}, which will be a mixture
19396 of HEADs and NOV lines, but this is currently not supported by Gnus.
19398 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
19399 headers", in some meaning of the word. This is generally done by
19400 fetching (at most) @var{fetch-old} extra headers less than the smallest
19401 article number in @code{articles}, and filling the gaps as well. The
19402 presence of this parameter can be ignored if the backend finds it
19403 cumbersome to follow the request. If this is non-@code{nil} and not a
19404 number, do maximum fetches.
19406 Here's an example HEAD:
19409 221 1056 Article retrieved.
19410 Path: ifi.uio.no!sturles
19411 From: sturles@@ifi.uio.no (Sturle Sunde)
19412 Newsgroups: ifi.discussion
19413 Subject: Re: Something very droll
19414 Date: 27 Oct 1994 14:02:57 +0100
19415 Organization: Dept. of Informatics, University of Oslo, Norway
19417 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
19418 References: <38jdmq$4qu@@visbur.ifi.uio.no>
19419 NNTP-Posting-Host: holmenkollen.ifi.uio.no
19423 So a @code{headers} return value would imply that there's a number of
19424 these in the data buffer.
19426 Here's a BNF definition of such a buffer:
19430 head = error / valid-head
19431 error-message = [ "4" / "5" ] 2number " " <error message> eol
19432 valid-head = valid-message *header "." eol
19433 valid-message = "221 " <number> " Article retrieved." eol
19434 header = <text> eol
19437 If the return value is @code{nov}, the data buffer should contain
19438 @dfn{network overview database} lines. These are basically fields
19442 nov-buffer = *nov-line
19443 nov-line = 8*9 [ field <TAB> ] eol
19444 field = <text except TAB>
19447 For a closer look at what should be in those fields,
19451 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
19453 @var{server} is here the virtual server name. @var{definitions} is a
19454 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
19456 If the server can't be opened, no error should be signaled. The backend
19457 may then choose to refuse further attempts at connecting to this
19458 server. In fact, it should do so.
19460 If the server is opened already, this function should return a
19461 non-@code{nil} value. There should be no data returned.
19464 @item (nnchoke-close-server &optional SERVER)
19466 Close connection to @var{server} and free all resources connected
19467 to it. Return @code{nil} if the server couldn't be closed for some
19470 There should be no data returned.
19473 @item (nnchoke-request-close)
19475 Close connection to all servers and free all resources that the backend
19476 have reserved. All buffers that have been created by that backend
19477 should be killed. (Not the @code{nntp-server-buffer}, though.) This
19478 function is generally only called when Gnus is shutting down.
19480 There should be no data returned.
19483 @item (nnchoke-server-opened &optional SERVER)
19485 If @var{server} is the current virtual server, and the connection to the
19486 physical server is alive, then this function should return a
19487 non-@code{nil} vlue. This function should under no circumstances
19488 attempt to reconnect to a server we have lost connection to.
19490 There should be no data returned.
19493 @item (nnchoke-status-message &optional SERVER)
19495 This function should return the last error message from @var{server}.
19497 There should be no data returned.
19500 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
19502 The result data from this function should be the article specified by
19503 @var{article}. This might either be a @code{Message-ID} or a number.
19504 It is optional whether to implement retrieval by @code{Message-ID}, but
19505 it would be nice if that were possible.
19507 If @var{to-buffer} is non-@code{nil}, the result data should be returned
19508 in this buffer instead of the normal data buffer. This is to make it
19509 possible to avoid copying large amounts of data from one buffer to
19510 another, while Gnus mainly requests articles to be inserted directly
19511 into its article buffer.
19513 If it is at all possible, this function should return a cons cell where
19514 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
19515 the article number. This will enable Gnus to find out what the real
19516 group and article numbers are when fetching articles by
19517 @code{Message-ID}. If this isn't possible, @code{t} should be returned
19518 on successful article retrieval.
19521 @item (nnchoke-request-group GROUP &optional SERVER FAST)
19523 Get data on @var{group}. This function also has the side effect of
19524 making @var{group} the current group.
19526 If @var{FAST}, don't bother to return useful data, just make @var{group}
19529 Here's an example of some result data and a definition of the same:
19532 211 56 1000 1059 ifi.discussion
19535 The first number is the status, which should be 211. Next is the
19536 total number of articles in the group, the lowest article number, the
19537 highest article number, and finally the group name. Note that the total
19538 number of articles may be less than one might think while just
19539 considering the highest and lowest article numbers, but some articles
19540 may have been canceled. Gnus just discards the total-number, so
19541 whether one should take the bother to generate it properly (if that is a
19542 problem) is left as an exercise to the reader.
19545 group-status = [ error / info ] eol
19546 error = [ "4" / "5" ] 2<number> " " <Error message>
19547 info = "211 " 3* [ <number> " " ] <string>
19551 @item (nnchoke-close-group GROUP &optional SERVER)
19553 Close @var{group} and free any resources connected to it. This will be
19554 a no-op on most backends.
19556 There should be no data returned.
19559 @item (nnchoke-request-list &optional SERVER)
19561 Return a list of all groups available on @var{server}. And that means
19564 Here's an example from a server that only carries two groups:
19567 ifi.test 0000002200 0000002000 y
19568 ifi.discussion 3324 3300 n
19571 On each line we have a group name, then the highest article number in
19572 that group, the lowest article number, and finally a flag.
19575 active-file = *active-line
19576 active-line = name " " <number> " " <number> " " flags eol
19578 flags = "n" / "y" / "m" / "x" / "j" / "=" name
19581 The flag says whether the group is read-only (@samp{n}), is moderated
19582 (@samp{m}), is dead (@samp{x}), is aliased to some other group
19583 (@samp{=other-group}) or none of the above (@samp{y}).
19586 @item (nnchoke-request-post &optional SERVER)
19588 This function should post the current buffer. It might return whether
19589 the posting was successful or not, but that's not required. If, for
19590 instance, the posting is done asynchronously, it has generally not been
19591 completed by the time this function concludes. In that case, this
19592 function should set up some kind of sentinel to beep the user loud and
19593 clear if the posting could not be completed.
19595 There should be no result data from this function.
19600 @node Optional Backend Functions
19601 @subsubsection Optional Backend Functions
19605 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
19607 @var{groups} is a list of groups, and this function should request data
19608 on all those groups. How it does it is of no concern to Gnus, but it
19609 should attempt to do this in a speedy fashion.
19611 The return value of this function can be either @code{active} or
19612 @code{group}, which says what the format of the result data is. The
19613 former is in the same format as the data from
19614 @code{nnchoke-request-list}, while the latter is a buffer full of lines
19615 in the same format as @code{nnchoke-request-group} gives.
19618 group-buffer = *active-line / *group-status
19622 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
19624 A Gnus group info (@pxref{Group Info}) is handed to the backend for
19625 alterations. This comes in handy if the backend really carries all the
19626 information (as is the case with virtual and imap groups). This
19627 function should destructively alter the info to suit its needs, and
19628 should return the (altered) group info.
19630 There should be no result data from this function.
19633 @item (nnchoke-request-type GROUP &optional ARTICLE)
19635 When the user issues commands for ``sending news'' (@kbd{F} in the
19636 summary buffer, for instance), Gnus has to know whether the article the
19637 user is following up on is news or mail. This function should return
19638 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
19639 is mail and @code{unknown} if the type can't be decided. (The
19640 @var{article} parameter is necessary in @code{nnvirtual} groups which
19641 might very well combine mail groups and news groups.) Both @var{group}
19642 and @var{article} may be @code{nil}.
19644 There should be no result data from this function.
19647 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
19649 Set/remove/add marks on articles. Normally Gnus handles the article
19650 marks (such as read, ticked, expired etc) internally, and store them in
19651 @code{~/.newsrc.eld}. Some backends (such as IMAP) however carry all
19652 information about the articles on the server, so Gnus need to propagate
19653 the mark information to the server.
19655 ACTION is a list of mark setting requests, having this format:
19658 (RANGE ACTION MARK)
19661 Range is a range of articles you wish to update marks on. Action is
19662 @code{set}, @code{add} or @code{del}, respectively used for removing all
19663 existing marks and setting them as specified, adding (preserving the
19664 marks not mentioned) mark and removing (preserving the marks not
19665 mentioned) marks. Mark is a list of marks; where each mark is a
19666 symbol. Currently used marks are @code{read}, @code{tick}, @code{reply},
19667 @code{expire}, @code{killed}, @code{dormant}, @code{save},
19668 @code{download} and @code{unsend}, but your backend should, if possible,
19669 not limit itself to theese.
19671 Given contradictory actions, the last action in the list should be the
19672 effective one. That is, if your action contains a request to add the
19673 @code{tick} mark on article 1 and, later in the list, a request to
19674 remove the mark on the same article, the mark should in fact be removed.
19676 An example action list:
19679 (((5 12 30) 'del '(tick))
19680 ((10 . 90) 'add '(read expire))
19681 ((92 94) 'del '(read)))
19684 The function should return a range of articles it wasn't able to set the
19685 mark on (currently not used for anything).
19687 There should be no result data from this function.
19689 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
19691 If the user tries to set a mark that the backend doesn't like, this
19692 function may change the mark. Gnus will use whatever this function
19693 returns as the mark for @var{article} instead of the original
19694 @var{mark}. If the backend doesn't care, it must return the original
19695 @var{mark}, and not @code{nil} or any other type of garbage.
19697 The only use for this I can see is what @code{nnvirtual} does with
19698 it---if a component group is auto-expirable, marking an article as read
19699 in the virtual group should result in the article being marked as
19702 There should be no result data from this function.
19705 @item (nnchoke-request-scan &optional GROUP SERVER)
19707 This function may be called at any time (by Gnus or anything else) to
19708 request that the backend check for incoming articles, in one way or
19709 another. A mail backend will typically read the spool file or query the
19710 POP server when this function is invoked. The @var{group} doesn't have
19711 to be heeded---if the backend decides that it is too much work just
19712 scanning for a single group, it may do a total scan of all groups. It
19713 would be nice, however, to keep things local if that's practical.
19715 There should be no result data from this function.
19718 @item (nnchoke-request-group-description GROUP &optional SERVER)
19720 The result data from this function should be a description of
19724 description-line = name <TAB> description eol
19726 description = <text>
19729 @item (nnchoke-request-list-newsgroups &optional SERVER)
19731 The result data from this function should be the description of all
19732 groups available on the server.
19735 description-buffer = *description-line
19739 @item (nnchoke-request-newgroups DATE &optional SERVER)
19741 The result data from this function should be all groups that were
19742 created after @samp{date}, which is in normal human-readable date
19743 format. The data should be in the active buffer format.
19746 @item (nnchoke-request-create-group GROUP &optional SERVER)
19748 This function should create an empty group with name @var{group}.
19750 There should be no return data.
19753 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
19755 This function should run the expiry process on all articles in the
19756 @var{articles} range (which is currently a simple list of article
19757 numbers.) It is left up to the backend to decide how old articles
19758 should be before they are removed by this function. If @var{force} is
19759 non-@code{nil}, all @var{articles} should be deleted, no matter how new
19762 This function should return a list of articles that it did not/was not
19765 There should be no result data returned.
19768 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
19771 This function should move @var{article} (which is a number) from
19772 @var{group} by calling @var{accept-form}.
19774 This function should ready the article in question for moving by
19775 removing any header lines it has added to the article, and generally
19776 should ``tidy up'' the article. Then it should @code{eval}
19777 @var{accept-form} in the buffer where the ``tidy'' article is. This
19778 will do the actual copying. If this @code{eval} returns a
19779 non-@code{nil} value, the article should be removed.
19781 If @var{last} is @code{nil}, that means that there is a high likelihood
19782 that there will be more requests issued shortly, so that allows some
19785 The function should return a cons where the @code{car} is the group name and
19786 the @code{cdr} is the article number that the article was entered as.
19788 There should be no data returned.
19791 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
19793 This function takes the current buffer and inserts it into @var{group}.
19794 If @var{last} in @code{nil}, that means that there will be more calls to
19795 this function in short order.
19797 The function should return a cons where the @code{car} is the group name and
19798 the @code{cdr} is the article number that the article was entered as.
19800 There should be no data returned.
19803 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
19805 This function should remove @var{article} (which is a number) from
19806 @var{group} and insert @var{buffer} there instead.
19808 There should be no data returned.
19811 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
19813 This function should delete @var{group}. If @var{force}, it should
19814 really delete all the articles in the group, and then delete the group
19815 itself. (If there is such a thing as ``the group itself''.)
19817 There should be no data returned.
19820 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
19822 This function should rename @var{group} into @var{new-name}. All
19823 articles in @var{group} should move to @var{new-name}.
19825 There should be no data returned.
19830 @node Error Messaging
19831 @subsubsection Error Messaging
19833 @findex nnheader-report
19834 @findex nnheader-get-report
19835 The backends should use the function @code{nnheader-report} to report
19836 error conditions---they should not raise errors when they aren't able to
19837 perform a request. The first argument to this function is the backend
19838 symbol, and the rest are interpreted as arguments to @code{format} if
19839 there are multiple of them, or just a string if there is one of them.
19840 This function must always returns @code{nil}.
19843 (nnheader-report 'nnchoke "You did something totally bogus")
19845 (nnheader-report 'nnchoke "Could not request group %s" group)
19848 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
19849 @code{nil} back from a server, and this function returns the most
19850 recently reported message for the backend in question. This function
19851 takes one argument---the server symbol.
19853 Internally, these functions access @var{backend}@code{-status-string},
19854 so the @code{nnchoke} backend will have its error message stored in
19855 @code{nnchoke-status-string}.
19858 @node Writing New Backends
19859 @subsubsection Writing New Backends
19861 Many backends are quite similar. @code{nnml} is just like
19862 @code{nnspool}, but it allows you to edit the articles on the server.
19863 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
19864 and it doesn't maintain overview databases. @code{nndir} is just like
19865 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
19868 It would make sense if it were possible to ``inherit'' functions from
19869 backends when writing new backends. And, indeed, you can do that if you
19870 want to. (You don't have to if you don't want to, of course.)
19872 All the backends declare their public variables and functions by using a
19873 package called @code{nnoo}.
19875 To inherit functions from other backends (and allow other backends to
19876 inherit functions from the current backend), you should use the
19882 This macro declares the first parameter to be a child of the subsequent
19883 parameters. For instance:
19886 (nnoo-declare nndir
19890 @code{nndir} has declared here that it intends to inherit functions from
19891 both @code{nnml} and @code{nnmh}.
19894 This macro is equivalent to @code{defvar}, but registers the variable as
19895 a public server variable. Most state-oriented variables should be
19896 declared with @code{defvoo} instead of @code{defvar}.
19898 In addition to the normal @code{defvar} parameters, it takes a list of
19899 variables in the parent backends to map the variable to when executing
19900 a function in those backends.
19903 (defvoo nndir-directory nil
19904 "Where nndir will look for groups."
19905 nnml-current-directory nnmh-current-directory)
19908 This means that @code{nnml-current-directory} will be set to
19909 @code{nndir-directory} when an @code{nnml} function is called on behalf
19910 of @code{nndir}. (The same with @code{nnmh}.)
19912 @item nnoo-define-basics
19913 This macro defines some common functions that almost all backends should
19917 (nnoo-define-basics nndir)
19921 This macro is just like @code{defun} and takes the same parameters. In
19922 addition to doing the normal @code{defun} things, it registers the
19923 function as being public so that other backends can inherit it.
19925 @item nnoo-map-functions
19926 This macro allows mapping of functions from the current backend to
19927 functions from the parent backends.
19930 (nnoo-map-functions nndir
19931 (nnml-retrieve-headers 0 nndir-current-group 0 0)
19932 (nnmh-request-article 0 nndir-current-group 0 0))
19935 This means that when @code{nndir-retrieve-headers} is called, the first,
19936 third, and fourth parameters will be passed on to
19937 @code{nnml-retrieve-headers}, while the second parameter is set to the
19938 value of @code{nndir-current-group}.
19941 This macro allows importing functions from backends. It should be the
19942 last thing in the source file, since it will only define functions that
19943 haven't already been defined.
19949 nnmh-request-newgroups)
19953 This means that calls to @code{nndir-request-list} should just be passed
19954 on to @code{nnmh-request-list}, while all public functions from
19955 @code{nnml} that haven't been defined in @code{nndir} yet should be
19960 Below is a slightly shortened version of the @code{nndir} backend.
19963 ;;; nndir.el --- single directory newsgroup access for Gnus
19964 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
19968 (require 'nnheader)
19972 (eval-when-compile (require 'cl))
19974 (nnoo-declare nndir
19977 (defvoo nndir-directory nil
19978 "Where nndir will look for groups."
19979 nnml-current-directory nnmh-current-directory)
19981 (defvoo nndir-nov-is-evil nil
19982 "*Non-nil means that nndir will never retrieve NOV headers."
19985 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
19986 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
19987 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
19989 (defvoo nndir-status-string "" nil nnmh-status-string)
19990 (defconst nndir-version "nndir 1.0")
19992 ;;; Interface functions.
19994 (nnoo-define-basics nndir)
19996 (deffoo nndir-open-server (server &optional defs)
19997 (setq nndir-directory
19998 (or (cadr (assq 'nndir-directory defs))
20000 (unless (assq 'nndir-directory defs)
20001 (push `(nndir-directory ,server) defs))
20002 (push `(nndir-current-group
20003 ,(file-name-nondirectory (directory-file-name nndir-directory)))
20005 (push `(nndir-top-directory
20006 ,(file-name-directory (directory-file-name nndir-directory)))
20008 (nnoo-change-server 'nndir server defs))
20010 (nnoo-map-functions nndir
20011 (nnml-retrieve-headers 0 nndir-current-group 0 0)
20012 (nnmh-request-article 0 nndir-current-group 0 0)
20013 (nnmh-request-group nndir-current-group 0 0)
20014 (nnmh-close-group nndir-current-group 0))
20018 nnmh-status-message
20020 nnmh-request-newgroups))
20026 @node Hooking New Backends Into Gnus
20027 @subsubsection Hooking New Backends Into Gnus
20029 @vindex gnus-valid-select-methods
20030 Having Gnus start using your new backend is rather easy---you just
20031 declare it with the @code{gnus-declare-backend} functions. This will
20032 enter the backend into the @code{gnus-valid-select-methods} variable.
20034 @code{gnus-declare-backend} takes two parameters---the backend name and
20035 an arbitrary number of @dfn{abilities}.
20040 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
20043 The abilities can be:
20047 This is a mailish backend---followups should (probably) go via mail.
20049 This is a newsish backend---followups should (probably) go via news.
20051 This backend supports both mail and news.
20053 This is neither a post nor mail backend---it's something completely
20056 It supports respooling---or rather, it is able to modify its source
20057 articles and groups.
20059 The name of the server should be in the virtual server name. This is
20060 true for almost all backends.
20061 @item prompt-address
20062 The user should be prompted for an address when doing commands like
20063 @kbd{B} in the group buffer. This is true for backends like
20064 @code{nntp}, but not @code{nnmbox}, for instance.
20068 @node Mail-like Backends
20069 @subsubsection Mail-like Backends
20071 One of the things that separate the mail backends from the rest of the
20072 backends is the heavy dependence by the mail backends on common
20073 functions in @file{nnmail.el}. For instance, here's the definition of
20074 @code{nnml-request-scan}:
20077 (deffoo nnml-request-scan (&optional group server)
20078 (setq nnml-article-file-alist nil)
20079 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
20082 It simply calls @code{nnmail-get-new-mail} with a few parameters,
20083 and @code{nnmail} takes care of all the moving and splitting of the
20086 This function takes four parameters.
20090 This should be a symbol to designate which backend is responsible for
20093 @item exit-function
20094 This function should be called after the splitting has been performed.
20096 @item temp-directory
20097 Where the temporary files should be stored.
20100 This optional argument should be a group name if the splitting is to be
20101 performed for one group only.
20104 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
20105 save each article. @var{backend}@code{-active-number} will be called to
20106 find the article number assigned to this article.
20108 The function also uses the following variables:
20109 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
20110 this backend); and @var{backend}@code{-group-alist} and
20111 @var{backend}@code{-active-file} to generate the new active file.
20112 @var{backend}@code{-group-alist} should be a group-active alist, like
20116 (("a-group" (1 . 10))
20117 ("some-group" (34 . 39)))
20121 @node Score File Syntax
20122 @subsection Score File Syntax
20124 Score files are meant to be easily parseable, but yet extremely
20125 mallable. It was decided that something that had the same read syntax
20126 as an Emacs Lisp list would fit that spec.
20128 Here's a typical score file:
20132 ("win95" -10000 nil s)
20139 BNF definition of a score file:
20142 score-file = "" / "(" *element ")"
20143 element = rule / atom
20144 rule = string-rule / number-rule / date-rule
20145 string-rule = "(" quote string-header quote space *string-match ")"
20146 number-rule = "(" quote number-header quote space *number-match ")"
20147 date-rule = "(" quote date-header quote space *date-match ")"
20149 string-header = "subject" / "from" / "references" / "message-id" /
20150 "xref" / "body" / "head" / "all" / "followup"
20151 number-header = "lines" / "chars"
20152 date-header = "date"
20153 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
20154 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
20155 score = "nil" / <integer>
20156 date = "nil" / <natural number>
20157 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
20158 "r" / "regex" / "R" / "Regex" /
20159 "e" / "exact" / "E" / "Exact" /
20160 "f" / "fuzzy" / "F" / "Fuzzy"
20161 number-match = "(" <integer> [ "" / [ space score [ "" /
20162 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
20163 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
20164 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
20165 space date [ "" / [ space date-match-t ] ] ] ] ")"
20166 date-match-t = "nil" / "at" / "before" / "after"
20167 atom = "(" [ required-atom / optional-atom ] ")"
20168 required-atom = mark / expunge / mark-and-expunge / files /
20169 exclude-files / read-only / touched
20170 optional-atom = adapt / local / eval
20171 mark = "mark" space nil-or-number
20172 nil-or-number = "nil" / <integer>
20173 expunge = "expunge" space nil-or-number
20174 mark-and-expunge = "mark-and-expunge" space nil-or-number
20175 files = "files" *[ space <string> ]
20176 exclude-files = "exclude-files" *[ space <string> ]
20177 read-only = "read-only" [ space "nil" / space "t" ]
20178 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
20179 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
20180 local = "local" *[ space "(" <string> space <form> ")" ]
20181 eval = "eval" space <form>
20182 space = *[ " " / <TAB> / <NEWLINE> ]
20185 Any unrecognized elements in a score file should be ignored, but not
20188 As you can see, white space is needed, but the type and amount of white
20189 space is irrelevant. This means that formatting of the score file is
20190 left up to the programmer---if it's simpler to just spew it all out on
20191 one looong line, then that's ok.
20193 The meaning of the various atoms are explained elsewhere in this
20194 manual (@pxref{Score File Format}).
20198 @subsection Headers
20200 Internally Gnus uses a format for storing article headers that
20201 corresponds to the @sc{nov} format in a mysterious fashion. One could
20202 almost suspect that the author looked at the @sc{nov} specification and
20203 just shamelessly @emph{stole} the entire thing, and one would be right.
20205 @dfn{Header} is a severely overloaded term. ``Header'' is used in
20206 RFC1036 to talk about lines in the head of an article (e.g.,
20207 @code{From}). It is used by many people as a synonym for
20208 ``head''---``the header and the body''. (That should be avoided, in my
20209 opinion.) And Gnus uses a format internally that it calls ``header'',
20210 which is what I'm talking about here. This is a 9-element vector,
20211 basically, with each header (ouch) having one slot.
20213 These slots are, in order: @code{number}, @code{subject}, @code{from},
20214 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
20215 @code{xref}, and @code{extra}. There are macros for accessing and
20216 setting these slots---they all have predictable names beginning with
20217 @code{mail-header-} and @code{mail-header-set-}, respectively.
20219 All these slots contain strings, except the @code{extra} slot, which
20220 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
20226 @sc{gnus} introduced a concept that I found so useful that I've started
20227 using it a lot and have elaborated on it greatly.
20229 The question is simple: If you have a large amount of objects that are
20230 identified by numbers (say, articles, to take a @emph{wild} example)
20231 that you want to qualify as being ``included'', a normal sequence isn't
20232 very useful. (A 200,000 length sequence is a bit long-winded.)
20234 The solution is as simple as the question: You just collapse the
20238 (1 2 3 4 5 6 10 11 12)
20241 is transformed into
20244 ((1 . 6) (10 . 12))
20247 To avoid having those nasty @samp{(13 . 13)} elements to denote a
20248 lonesome object, a @samp{13} is a valid element:
20251 ((1 . 6) 7 (10 . 12))
20254 This means that comparing two ranges to find out whether they are equal
20255 is slightly tricky:
20258 ((1 . 5) 7 8 (10 . 12))
20264 ((1 . 5) (7 . 8) (10 . 12))
20267 are equal. In fact, any non-descending list is a range:
20273 is a perfectly valid range, although a pretty long-winded one. This is
20280 and is equal to the previous range.
20282 Here's a BNF definition of ranges. Of course, one must remember the
20283 semantic requirement that the numbers are non-descending. (Any number
20284 of repetition of the same number is allowed, but apt to disappear in
20288 range = simple-range / normal-range
20289 simple-range = "(" number " . " number ")"
20290 normal-range = "(" start-contents ")"
20291 contents = "" / simple-range *[ " " contents ] /
20292 number *[ " " contents ]
20295 Gnus currently uses ranges to keep track of read articles and article
20296 marks. I plan on implementing a number of range operators in C if The
20297 Powers That Be are willing to let me. (I haven't asked yet, because I
20298 need to do some more thinking on what operators I need to make life
20299 totally range-based without ever having to convert back to normal
20304 @subsection Group Info
20306 Gnus stores all permanent info on groups in a @dfn{group info} list.
20307 This list is from three to six elements (or more) long and exhaustively
20308 describes the group.
20310 Here are two example group infos; one is a very simple group while the
20311 second is a more complex one:
20314 ("no.group" 5 ((1 . 54324)))
20316 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
20317 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
20319 ((auto-expire . t) (to-address . "ding@@gnus.org")))
20322 The first element is the @dfn{group name}---as Gnus knows the group,
20323 anyway. The second element is the @dfn{subscription level}, which
20324 normally is a small integer. (It can also be the @dfn{rank}, which is a
20325 cons cell where the @code{car} is the level and the @code{cdr} is the
20326 score.) The third element is a list of ranges of read articles. The
20327 fourth element is a list of lists of article marks of various kinds.
20328 The fifth element is the select method (or virtual server, if you like).
20329 The sixth element is a list of @dfn{group parameters}, which is what
20330 this section is about.
20332 Any of the last three elements may be missing if they are not required.
20333 In fact, the vast majority of groups will normally only have the first
20334 three elements, which saves quite a lot of cons cells.
20336 Here's a BNF definition of the group info format:
20339 info = "(" group space ralevel space read
20340 [ "" / [ space marks-list [ "" / [ space method [ "" /
20341 space parameters ] ] ] ] ] ")"
20342 group = quote <string> quote
20343 ralevel = rank / level
20344 level = <integer in the range of 1 to inf>
20345 rank = "(" level "." score ")"
20346 score = <integer in the range of 1 to inf>
20348 marks-lists = nil / "(" *marks ")"
20349 marks = "(" <string> range ")"
20350 method = "(" <string> *elisp-forms ")"
20351 parameters = "(" *elisp-forms ")"
20354 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
20355 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
20358 If you have a Gnus info and want to access the elements, Gnus offers a
20359 series of macros for getting/setting these elements.
20362 @item gnus-info-group
20363 @itemx gnus-info-set-group
20364 @findex gnus-info-group
20365 @findex gnus-info-set-group
20366 Get/set the group name.
20368 @item gnus-info-rank
20369 @itemx gnus-info-set-rank
20370 @findex gnus-info-rank
20371 @findex gnus-info-set-rank
20372 Get/set the group rank (@pxref{Group Score}).
20374 @item gnus-info-level
20375 @itemx gnus-info-set-level
20376 @findex gnus-info-level
20377 @findex gnus-info-set-level
20378 Get/set the group level.
20380 @item gnus-info-score
20381 @itemx gnus-info-set-score
20382 @findex gnus-info-score
20383 @findex gnus-info-set-score
20384 Get/set the group score (@pxref{Group Score}).
20386 @item gnus-info-read
20387 @itemx gnus-info-set-read
20388 @findex gnus-info-read
20389 @findex gnus-info-set-read
20390 Get/set the ranges of read articles.
20392 @item gnus-info-marks
20393 @itemx gnus-info-set-marks
20394 @findex gnus-info-marks
20395 @findex gnus-info-set-marks
20396 Get/set the lists of ranges of marked articles.
20398 @item gnus-info-method
20399 @itemx gnus-info-set-method
20400 @findex gnus-info-method
20401 @findex gnus-info-set-method
20402 Get/set the group select method.
20404 @item gnus-info-params
20405 @itemx gnus-info-set-params
20406 @findex gnus-info-params
20407 @findex gnus-info-set-params
20408 Get/set the group parameters.
20411 All the getter functions take one parameter---the info list. The setter
20412 functions take two parameters---the info list and the new value.
20414 The last three elements in the group info aren't mandatory, so it may be
20415 necessary to extend the group info before setting the element. If this
20416 is necessary, you can just pass on a non-@code{nil} third parameter to
20417 the three final setter functions to have this happen automatically.
20420 @node Extended Interactive
20421 @subsection Extended Interactive
20422 @cindex interactive
20423 @findex gnus-interactive
20425 Gnus extends the standard Emacs @code{interactive} specification
20426 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
20427 Prefixes}). Here's an example of how this is used:
20430 (defun gnus-summary-increase-score (&optional score symp)
20431 (interactive (gnus-interactive "P\ny"))
20436 The best thing to do would have been to implement
20437 @code{gnus-interactive} as a macro which would have returned an
20438 @code{interactive} form, but this isn't possible since Emacs checks
20439 whether a function is interactive or not by simply doing an @code{assq}
20440 on the lambda form. So, instead we have @code{gnus-interactive}
20441 function that takes a string and returns values that are usable to
20442 @code{interactive}.
20444 This function accepts (almost) all normal @code{interactive} specs, but
20449 @vindex gnus-current-prefix-symbol
20450 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
20454 @vindex gnus-current-prefix-symbols
20455 A list of the current symbolic prefixes---the
20456 @code{gnus-current-prefix-symbol} variable.
20459 The current article number---the @code{gnus-summary-article-number}
20463 The current article header---the @code{gnus-summary-article-header}
20467 The current group name---the @code{gnus-group-group-name}
20473 @node Emacs/XEmacs Code
20474 @subsection Emacs/XEmacs Code
20478 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
20479 platforms must be the primary one. I chose Emacs. Not because I don't
20480 like XEmacs or Mule, but because it comes first alphabetically.
20482 This means that Gnus will byte-compile under Emacs with nary a warning,
20483 while XEmacs will pump out gigabytes of warnings while byte-compiling.
20484 As I use byte-compilation warnings to help me root out trivial errors in
20485 Gnus, that's very useful.
20487 I've also consistently used Emacs function interfaces, but have used
20488 Gnusey aliases for the functions. To take an example: Emacs defines a
20489 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
20490 function. I then define a function called @code{gnus-run-at-time} that
20491 takes the same parameters as the Emacs @code{run-at-time}. When running
20492 Gnus under Emacs, the former function is just an alias for the latter.
20493 However, when running under XEmacs, the former is an alias for the
20494 following function:
20497 (defun gnus-xmas-run-at-time (time repeat function &rest args)
20501 (,function ,@@args))
20505 This sort of thing has been done for bunches of functions. Gnus does
20506 not redefine any native Emacs functions while running under XEmacs---it
20507 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
20510 In the cases where the XEmacs function interface was obviously cleaner,
20511 I used it instead. For example @code{gnus-region-active-p} is an alias
20512 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
20514 Of course, I could have chosen XEmacs as my native platform and done
20515 mapping functions the other way around. But I didn't. The performance
20516 hit these indirections impose on Gnus under XEmacs should be slight.
20519 @node Various File Formats
20520 @subsection Various File Formats
20523 * Active File Format:: Information on articles and groups available.
20524 * Newsgroups File Format:: Group descriptions.
20528 @node Active File Format
20529 @subsubsection Active File Format
20531 The active file lists all groups available on the server in
20532 question. It also lists the highest and lowest current article numbers
20535 Here's an excerpt from a typical active file:
20538 soc.motss 296030 293865 y
20539 alt.binaries.pictures.fractals 3922 3913 n
20540 comp.sources.unix 1605 1593 m
20541 comp.binaries.ibm.pc 5097 5089 y
20542 no.general 1000 900 y
20545 Here's a pseudo-BNF definition of this file:
20548 active = *group-line
20549 group-line = group space high-number space low-number space flag <NEWLINE>
20550 group = <non-white-space string>
20552 high-number = <non-negative integer>
20553 low-number = <positive integer>
20554 flag = "y" / "n" / "m" / "j" / "x" / "=" group
20557 For a full description of this file, see the manual pages for
20558 @samp{innd}, in particular @samp{active(5)}.
20561 @node Newsgroups File Format
20562 @subsubsection Newsgroups File Format
20564 The newsgroups file lists groups along with their descriptions. Not all
20565 groups on the server have to be listed, and not all groups in the file
20566 have to exist on the server. The file is meant purely as information to
20569 The format is quite simple; a group name, a tab, and the description.
20570 Here's the definition:
20574 line = group tab description <NEWLINE>
20575 group = <non-white-space string>
20577 description = <string>
20582 @node Emacs for Heathens
20583 @section Emacs for Heathens
20585 Believe it or not, but some people who use Gnus haven't really used
20586 Emacs much before they embarked on their journey on the Gnus Love Boat.
20587 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
20588 region'', and ``set @code{gnus-flargblossen} to an alist where the key
20589 is a regexp that is used for matching on the group name'' are magical
20590 phrases with little or no meaning, then this appendix is for you. If
20591 you are already familiar with Emacs, just ignore this and go fondle your
20595 * Keystrokes:: Entering text and executing commands.
20596 * Emacs Lisp:: The built-in Emacs programming language.
20601 @subsection Keystrokes
20605 Q: What is an experienced Emacs user?
20608 A: A person who wishes that the terminal had pedals.
20611 Yes, when you use Emacs, you are apt to use the control key, the shift
20612 key and the meta key a lot. This is very annoying to some people
20613 (notably @code{vi}le users), and the rest of us just love the hell out
20614 of it. Just give up and submit. Emacs really does stand for
20615 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
20616 may have heard from other disreputable sources (like the Emacs author).
20618 The shift keys are normally located near your pinky fingers, and are
20619 normally used to get capital letters and stuff. You probably use it all
20620 the time. The control key is normally marked ``CTRL'' or something like
20621 that. The meta key is, funnily enough, never marked as such on any
20622 keyboard. The one I'm currently at has a key that's marked ``Alt'',
20623 which is the meta key on this keyboard. It's usually located somewhere
20624 to the left hand side of the keyboard, usually on the bottom row.
20626 Now, us Emacs people don't say ``press the meta-control-m key'',
20627 because that's just too inconvenient. We say ``press the @kbd{M-C-m}
20628 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
20629 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
20630 down the control key, and hold it down while you press @kbd{k}''.
20631 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
20632 the control key and then press @kbd{k}''. Simple, ay?
20634 This is somewhat complicated by the fact that not all keyboards have a
20635 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
20636 means ``press escape, release escape, press @kbd{k}''. That's much more
20637 work than if you have a meta key, so if that's the case, I respectfully
20638 suggest you get a real keyboard with a meta key. You can't live without
20644 @subsection Emacs Lisp
20646 Emacs is the King of Editors because it's really a Lisp interpreter.
20647 Each and every key you tap runs some Emacs Lisp code snippet, and since
20648 Emacs Lisp is an interpreted language, that means that you can configure
20649 any key to run any arbitrary code. You just, like, do it.
20651 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
20652 functions. (These are byte-compiled for speed, but it's still
20653 interpreted.) If you decide that you don't like the way Gnus does
20654 certain things, it's trivial to have it do something a different way.
20655 (Well, at least if you know how to write Lisp code.) However, that's
20656 beyond the scope of this manual, so we are simply going to talk about
20657 some common constructs that you normally use in your @file{.emacs} file
20660 If you want to set the variable @code{gnus-florgbnize} to four (4), you
20661 write the following:
20664 (setq gnus-florgbnize 4)
20667 This function (really ``special form'') @code{setq} is the one that can
20668 set a variable to some value. This is really all you need to know. Now
20669 you can go and fill your @code{.emacs} file with lots of these to change
20672 If you have put that thing in your @code{.emacs} file, it will be read
20673 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
20674 start Emacs. If you want to change the variable right away, simply say
20675 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
20676 previous ``form'', which is a simple @code{setq} statement here.
20678 Go ahead---just try it, if you're located at your Emacs. After you
20679 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
20680 is the return value of the form you @code{eval}ed.
20684 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
20688 (setq gnus-read-active-file 'some)
20691 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
20692 @samp{nntp.ifi.uio.no}'', that means:
20695 (setq gnus-nntp-server "nntp.ifi.uio.no")
20698 So be careful not to mix up strings (the latter) with symbols (the
20699 former). The manual is unambiguous, but it can be confusing.
20702 @include gnus-faq.texi