1 \input texinfo @c -*-texinfo-*-
4 @settitle Pterodactyl Gnus 0.73 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 Free Software Foundation, Inc.
275 Permission is granted to make and distribute verbatim copies of
276 this manual provided the copyright notice and this permission notice
277 are preserved on all copies.
279 Permission is granted to copy and distribute modified versions of this
280 manual under the conditions for verbatim copying, provided that the
281 entire resulting derived work is distributed under the terms of a
282 permission notice identical to this one.
284 Permission is granted to copy and distribute translations of this manual
285 into another language, under the above conditions for modified versions.
294 This file documents Gnus, the GNU Emacs newsreader.
296 Copyright (C) 1995,96 Free Software Foundation, Inc.
298 Permission is granted to make and distribute verbatim copies of
299 this manual provided the copyright notice and this permission notice
300 are preserved on all copies.
303 Permission is granted to process this file through Tex and print the
304 results, provided the printed document carries copying permission
305 notice identical to this one except for the removal of this paragraph
306 (this paragraph not being relevant to the printed manual).
309 Permission is granted to copy and distribute modified versions of this
310 manual under the conditions for verbatim copying, provided also that the
311 entire resulting derived work is distributed under the terms of a
312 permission notice identical to this one.
314 Permission is granted to copy and distribute translations of this manual
315 into another language, under the above conditions for modified versions.
321 @title Pterodactyl Gnus 0.73 Manual
323 @author by Lars Magne Ingebrigtsen
326 @vskip 0pt plus 1filll
327 Copyright @copyright{} 1995,96,97 Free Software Foundation, Inc.
329 Permission is granted to make and distribute verbatim copies of
330 this manual provided the copyright notice and this permission notice
331 are preserved on all copies.
333 Permission is granted to copy and distribute modified versions of this
334 manual under the conditions for verbatim copying, provided that the
335 entire resulting derived work is distributed under the terms of a
336 permission notice identical to this one.
338 Permission is granted to copy and distribute translations of this manual
339 into another language, under the above conditions for modified versions.
348 @top The Gnus Newsreader
352 You can read news (and mail) from within Emacs by using Gnus. The news
353 can be gotten by any nefarious means you can think of---@sc{nntp}, local
354 spool or your mbox file. All at the same time, if you want to push your
357 This manual corresponds to Pterodactyl Gnus 0.73.
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 * Article Commands:: Doing various things with the article buffer.
3256 * Summary Sorting:: Sorting the summary buffer in various ways.
3257 * Finding the Parent:: No child support? Get the parent.
3258 * Alternative Approaches:: Reading using non-default summaries.
3259 * Tree Display:: A more visual display of threads.
3260 * Mail Group Commands:: Some commands can only be used in mail groups.
3261 * Various Summary Stuff:: What didn't fit anywhere else.
3262 * Exiting the Summary Buffer:: Returning to the Group buffer.
3263 * Crosspost Handling:: How crossposted articles are dealt with.
3264 * Duplicate Suppression:: An alternative when crosspost handling fails.
3268 @node Summary Buffer Format
3269 @section Summary Buffer Format
3270 @cindex summary buffer format
3274 \gnusfigure{The Summary Buffer}{180}{
3275 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3276 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3282 * Summary Buffer Lines:: You can specify how summary lines should look.
3283 * To From Newsgroups:: How to not display your own name.
3284 * Summary Buffer Mode Line:: You can say how the mode line should look.
3285 * Summary Highlighting:: Making the summary buffer all pretty and nice.
3288 @findex mail-extract-address-components
3289 @findex gnus-extract-address-components
3290 @vindex gnus-extract-address-components
3291 Gnus will use the value of the @code{gnus-extract-address-components}
3292 variable as a function for getting the name and address parts of a
3293 @code{From} header. Two pre-defined functions exist:
3294 @code{gnus-extract-address-components}, which is the default, quite
3295 fast, and too simplistic solution; and
3296 @code{mail-extract-address-components}, which works very nicely, but is
3297 slower. The default function will return the wrong answer in 5% of the
3298 cases. If this is unacceptable to you, use the other function instead:
3301 (setq gnus-extract-address-components
3302 'mail-extract-address-components)
3305 @vindex gnus-summary-same-subject
3306 @code{gnus-summary-same-subject} is a string indicating that the current
3307 article has the same subject as the previous. This string will be used
3308 with those specs that require it. The default is @code{""}.
3311 @node Summary Buffer Lines
3312 @subsection Summary Buffer Lines
3314 @vindex gnus-summary-line-format
3315 You can change the format of the lines in the summary buffer by changing
3316 the @code{gnus-summary-line-format} variable. It works along the same
3317 lines as a normal @code{format} string, with some extensions
3318 (@pxref{Formatting Variables}).
3320 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3322 The following format specification characters are understood:
3330 Subject if the article is the root of the thread or the previous article
3331 had a different subject, @code{gnus-summary-same-subject} otherwise.
3332 (@code{gnus-summary-same-subject} defaults to @code{""}.)
3334 Full @code{From} header.
3336 The name (from the @code{From} header).
3338 The name, code @code{To} header or the @code{Newsgroups} header
3339 (@pxref{To From Newsgroups}).
3341 The name (from the @code{From} header). This differs from the @code{n}
3342 spec in that it uses the function designated by the
3343 @code{gnus-extract-address-components} variable, which is slower, but
3344 may be more thorough.
3346 The address (from the @code{From} header). This works the same way as
3349 Number of lines in the article.
3351 Number of characters in the article.
3353 Indentation based on thread level (@pxref{Customizing Threading}).
3355 Nothing if the article is a root and lots of spaces if it isn't (it
3356 pushes everything after it off the screen).
3358 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3359 for adopted articles (@pxref{Customizing Threading}).
3361 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3362 for adopted articles.
3364 One space for each thread level.
3366 Twenty minus thread level spaces.
3371 This misleadingly named specifier is the @dfn{secondary mark}. This
3372 mark will say whether the article has been replied to, has been cached,
3376 Score as a number (@pxref{Scoring}).
3378 @vindex gnus-summary-zcore-fuzz
3379 Zcore, @samp{+} if above the default level and @samp{-} if below the
3380 default level. If the difference between
3381 @code{gnus-summary-default-score} and the score is less than
3382 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3390 The @code{Date} in @code{DD-MMM} format.
3392 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3398 Number of articles in the current sub-thread. Using this spec will slow
3399 down summary buffer generation somewhat.
3401 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3402 article has any children.
3408 User defined specifier. The next character in the format string should
3409 be a letter. Gnus will call the function
3410 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3411 following @samp{%u}. The function will be passed the current header as
3412 argument. The function should return a string, which will be inserted
3413 into the summary just like information from any other summary specifier.
3416 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3417 have to be handled with care. For reasons of efficiency, Gnus will
3418 compute what column these characters will end up in, and ``hard-code''
3419 that. This means that it is invalid to have these specs after a
3420 variable-length spec. Well, you might not be arrested, but your summary
3421 buffer will look strange, which is bad enough.
3423 The smart choice is to have these specs as far to the left as possible.
3424 (Isn't that the case with everything, though? But I digress.)
3426 This restriction may disappear in later versions of Gnus.
3429 @node To From Newsgroups
3430 @subsection To From Newsgroups
3434 In some groups (particularly in archive groups), the @code{From} header
3435 isn't very interesting, since all the articles there are written by
3436 you. To display the information in the @code{To} or @code{Newsgroups}
3437 headers instead, you need to decide three things: What information to
3438 gather; where to display it; and when to display it.
3442 @vindex gnus-extra-headers
3443 The reading of extra header information is controlled by the
3444 @code{gnus-extra-headers}. This is a list of header symbols. For
3448 (setq gnus-extra-headers
3449 '(To Newsgroups X-Newsreader))
3452 This will result in Gnus trying to obtain these three headers, and
3453 storing it in header structures for later easy retrieval.
3456 @findex gnus-extra-header
3457 The value of these extra headers can be accessed via the
3458 @code{gnus-extra-header} function. Here's a format line spec that will
3459 access the @code{X-Newsreader} header:
3462 "%~(form (gnus-extra-header 'X-Newsreader))@@"
3466 @vindex gnus-ignored-from-addresses
3467 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
3468 summary line spec returns the @code{To}, @code{Newsreader} or
3469 @code{From} header. If this regexp matches the contents of the
3470 @code{From} header, the value of the @code{To} or @code{Newsreader}
3471 headers are used instead.
3475 @vindex nnmail-extra-headers
3476 A related variable is @code{nnmail-extra-headers}, which controls when
3477 to include extra headers when generating overview (@sc{nov}) files. If
3478 you have old overview files, you should regenerate them after changing
3481 @vindex gnus-summary-line-format
3482 You also have to instruct Gnus to display the data by changing the
3483 @code{%n} spec to the @code{%f} spec in the
3484 @code{gnus-summary-line-format} variable.
3486 In summary, you'd typically do something like the following:
3489 (setq gnus-extra-headers
3491 (setq nnmail-extra-headers gnus-extra-headers)
3492 (setq gnus-summary-line-format
3493 "%U%R%z%I%(%[%4L: %-20,20f%]%) %s\n")
3494 (setq gnus-ignored-from-addresses
3498 Now, this is mostly useful for mail groups, where you have control over
3499 the @sc{nov} files that are created. However, if you can persuade your
3506 to the end of her @file{overview.fmt} file, then you can use that just
3507 as you would the extra headers from the mail groups.
3510 @node Summary Buffer Mode Line
3511 @subsection Summary Buffer Mode Line
3513 @vindex gnus-summary-mode-line-format
3514 You can also change the format of the summary mode bar (@pxref{Mode Line
3515 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
3516 like. The default is @samp{Gnus: %%b [%A] %Z}.
3518 Here are the elements you can play with:
3524 Unprefixed group name.
3526 Current article number.
3528 Current article score.
3532 Number of unread articles in this group.
3534 Number of unread articles in this group that aren't displayed in the
3537 A string with the number of unread and unselected articles represented
3538 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3539 articles, and just as @samp{<%U more>} if there are just unread articles
3540 and no unselected ones.
3542 Shortish group name. For instance, @samp{rec.arts.anime} will be
3543 shortened to @samp{r.a.anime}.
3545 Subject of the current article.
3547 User-defined spec (@pxref{User-Defined Specs}).
3549 Name of the current score file (@pxref{Scoring}).
3551 Number of dormant articles (@pxref{Unread Articles}).
3553 Number of ticked articles (@pxref{Unread Articles}).
3555 Number of articles that have been marked as read in this session.
3557 Number of articles expunged by the score files.
3561 @node Summary Highlighting
3562 @subsection Summary Highlighting
3566 @item gnus-visual-mark-article-hook
3567 @vindex gnus-visual-mark-article-hook
3568 This hook is run after selecting an article. It is meant to be used for
3569 highlighting the article in some way. It is not run if
3570 @code{gnus-visual} is @code{nil}.
3572 @item gnus-summary-update-hook
3573 @vindex gnus-summary-update-hook
3574 This hook is called when a summary line is changed. It is not run if
3575 @code{gnus-visual} is @code{nil}.
3577 @item gnus-summary-selected-face
3578 @vindex gnus-summary-selected-face
3579 This is the face (or @dfn{font} as some people call it) used to
3580 highlight the current article in the summary buffer.
3582 @item gnus-summary-highlight
3583 @vindex gnus-summary-highlight
3584 Summary lines are highlighted according to this variable, which is a
3585 list where the elements are of the format @var{(FORM . FACE)}. If you
3586 would, for instance, like ticked articles to be italic and high-scored
3587 articles to be bold, you could set this variable to something like
3589 (((eq mark gnus-ticked-mark) . italic)
3590 ((> score default) . bold))
3592 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3593 @var{FACE} will be applied to the line.
3597 @node Summary Maneuvering
3598 @section Summary Maneuvering
3599 @cindex summary movement
3601 All the straight movement commands understand the numeric prefix and
3602 behave pretty much as you'd expect.
3604 None of these commands select articles.
3609 @kindex M-n (Summary)
3610 @kindex G M-n (Summary)
3611 @findex gnus-summary-next-unread-subject
3612 Go to the next summary line of an unread article
3613 (@code{gnus-summary-next-unread-subject}).
3617 @kindex M-p (Summary)
3618 @kindex G M-p (Summary)
3619 @findex gnus-summary-prev-unread-subject
3620 Go to the previous summary line of an unread article
3621 (@code{gnus-summary-prev-unread-subject}).
3626 @kindex G j (Summary)
3627 @findex gnus-summary-goto-article
3628 Ask for an article number or @code{Message-ID}, and then go to that
3629 article (@code{gnus-summary-goto-article}).
3632 @kindex G g (Summary)
3633 @findex gnus-summary-goto-subject
3634 Ask for an article number and then go to the summary line of that article
3635 without displaying the article (@code{gnus-summary-goto-subject}).
3638 If Gnus asks you to press a key to confirm going to the next group, you
3639 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3640 buffer, searching for the next group to read without actually returning
3641 to the group buffer.
3643 Variables related to summary movement:
3647 @vindex gnus-auto-select-next
3648 @item gnus-auto-select-next
3649 If you issue one of the movement commands (like @kbd{n}) and there are
3650 no more unread articles after the current one, Gnus will offer to go to
3651 the next group. If this variable is @code{t} and the next group is
3652 empty, Gnus will exit summary mode and return to the group buffer. If
3653 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3654 next group, no matter whether it has any unread articles or not. As a
3655 special case, if this variable is @code{quietly}, Gnus will select the
3656 next group without asking for confirmation. If this variable is
3657 @code{almost-quietly}, the same will happen only if you are located on
3658 the last article in the group. Finally, if this variable is
3659 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3660 without confirmation. Also @pxref{Group Levels}.
3662 @item gnus-auto-select-same
3663 @vindex gnus-auto-select-same
3664 If non-@code{nil}, all the movement commands will try to go to the next
3665 article with the same subject as the current. (@dfn{Same} here might
3666 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
3667 for details (@pxref{Customizing Threading}).) If there are no more
3668 articles with the same subject, go to the first unread article.
3670 This variable is not particularly useful if you use a threaded display.
3672 @item gnus-summary-check-current
3673 @vindex gnus-summary-check-current
3674 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3675 to the next (or previous) article if the current article is unread.
3676 Instead, they will choose the current article.
3678 @item gnus-auto-center-summary
3679 @vindex gnus-auto-center-summary
3680 If non-@code{nil}, Gnus will keep the point in the summary buffer
3681 centered at all times. This makes things quite tidy, but if you have a
3682 slow network connection, or simply do not like this un-Emacsism, you can
3683 set this variable to @code{nil} to get the normal Emacs scrolling
3684 action. This will also inhibit horizontal re-centering of the summary
3685 buffer, which might make it more inconvenient to read extremely long
3688 This variable can also be a number. In that case, center the window at
3689 the given number of lines from the top.
3694 @node Choosing Articles
3695 @section Choosing Articles
3696 @cindex selecting articles
3699 * Choosing Commands:: Commands for choosing articles.
3700 * Choosing Variables:: Variables that influence these commands.
3704 @node Choosing Commands
3705 @subsection Choosing Commands
3707 None of the following movement commands understand the numeric prefix,
3708 and they all select and display an article.
3712 @kindex SPACE (Summary)
3713 @findex gnus-summary-next-page
3714 Select the current article, or, if that one's read already, the next
3715 unread article (@code{gnus-summary-next-page}).
3720 @kindex G n (Summary)
3721 @findex gnus-summary-next-unread-article
3722 @c @icon{gnus-summary-next-unread}
3723 Go to next unread article (@code{gnus-summary-next-unread-article}).
3728 @findex gnus-summary-prev-unread-article
3729 @c @icon{gnus-summary-prev-unread}
3730 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3735 @kindex G N (Summary)
3736 @findex gnus-summary-next-article
3737 Go to the next article (@code{gnus-summary-next-article}).
3742 @kindex G P (Summary)
3743 @findex gnus-summary-prev-article
3744 Go to the previous article (@code{gnus-summary-prev-article}).
3747 @kindex G C-n (Summary)
3748 @findex gnus-summary-next-same-subject
3749 Go to the next article with the same subject
3750 (@code{gnus-summary-next-same-subject}).
3753 @kindex G C-p (Summary)
3754 @findex gnus-summary-prev-same-subject
3755 Go to the previous article with the same subject
3756 (@code{gnus-summary-prev-same-subject}).
3760 @kindex G f (Summary)
3762 @findex gnus-summary-first-unread-article
3763 Go to the first unread article
3764 (@code{gnus-summary-first-unread-article}).
3768 @kindex G b (Summary)
3770 @findex gnus-summary-best-unread-article
3771 Go to the article with the highest score
3772 (@code{gnus-summary-best-unread-article}).
3777 @kindex G l (Summary)
3778 @findex gnus-summary-goto-last-article
3779 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3782 @kindex G o (Summary)
3783 @findex gnus-summary-pop-article
3785 @cindex article history
3786 Pop an article off the summary history and go to this article
3787 (@code{gnus-summary-pop-article}). This command differs from the
3788 command above in that you can pop as many previous articles off the
3789 history as you like, while @kbd{l} toggles the two last read articles.
3790 For a somewhat related issue (if you use these commands a lot),
3791 @pxref{Article Backlog}.
3795 @node Choosing Variables
3796 @subsection Choosing Variables
3798 Some variables relevant for moving and selecting articles:
3801 @item gnus-auto-extend-newsgroup
3802 @vindex gnus-auto-extend-newsgroup
3803 All the movement commands will try to go to the previous (or next)
3804 article, even if that article isn't displayed in the Summary buffer if
3805 this variable is non-@code{nil}. Gnus will then fetch the article from
3806 the server and display it in the article buffer.
3808 @item gnus-select-article-hook
3809 @vindex gnus-select-article-hook
3810 This hook is called whenever an article is selected. By default it
3811 exposes any threads hidden under the selected article.
3813 @item gnus-mark-article-hook
3814 @vindex gnus-mark-article-hook
3815 @findex gnus-summary-mark-unread-as-read
3816 @findex gnus-summary-mark-read-and-unread-as-read
3817 @findex gnus-unread-mark
3818 This hook is called whenever an article is selected. It is intended to
3819 be used for marking articles as read. The default value is
3820 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3821 mark of almost any article you read to @code{gnus-unread-mark}. The
3822 only articles not affected by this function are ticked, dormant, and
3823 expirable articles. If you'd instead like to just have unread articles
3824 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3825 instead. It will leave marks like @code{gnus-low-score-mark},
3826 @code{gnus-del-mark} (and so on) alone.
3831 @node Paging the Article
3832 @section Scrolling the Article
3833 @cindex article scrolling
3838 @kindex SPACE (Summary)
3839 @findex gnus-summary-next-page
3840 Pressing @kbd{SPACE} will scroll the current article forward one page,
3841 or, if you have come to the end of the current article, will choose the
3842 next article (@code{gnus-summary-next-page}).
3845 @kindex DEL (Summary)
3846 @findex gnus-summary-prev-page
3847 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3850 @kindex RET (Summary)
3851 @findex gnus-summary-scroll-up
3852 Scroll the current article one line forward
3853 (@code{gnus-summary-scroll-up}).
3856 @kindex M-RET (Summary)
3857 @findex gnus-summary-scroll-down
3858 Scroll the current article one line backward
3859 (@code{gnus-summary-scroll-down}).
3863 @kindex A g (Summary)
3865 @findex gnus-summary-show-article
3866 (Re)fetch the current article (@code{gnus-summary-show-article}). If
3867 given a prefix, fetch the current article, but don't run any of the
3868 article treatment functions. This will give you a ``raw'' article, just
3869 the way it came from the server.
3874 @kindex A < (Summary)
3875 @findex gnus-summary-beginning-of-article
3876 Scroll to the beginning of the article
3877 (@code{gnus-summary-beginning-of-article}).
3882 @kindex A > (Summary)
3883 @findex gnus-summary-end-of-article
3884 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3888 @kindex A s (Summary)
3890 @findex gnus-summary-isearch-article
3891 Perform an isearch in the article buffer
3892 (@code{gnus-summary-isearch-article}).
3896 @findex gnus-summary-select-article-buffer
3897 Select the article buffer (@code{gnus-summary-select-article-buffer}).
3902 @node Reply Followup and Post
3903 @section Reply, Followup and Post
3906 * Summary Mail Commands:: Sending mail.
3907 * Summary Post Commands:: Sending news.
3911 @node Summary Mail Commands
3912 @subsection Summary Mail Commands
3914 @cindex composing mail
3916 Commands for composing a mail message:
3922 @kindex S r (Summary)
3924 @findex gnus-summary-reply
3925 @c @icon{gnus-summary-mail-reply}
3926 @c @icon{gnus-summary-reply}
3927 Mail a reply to the author of the current article
3928 (@code{gnus-summary-reply}).
3933 @kindex S R (Summary)
3934 @findex gnus-summary-reply-with-original
3935 @c @icon{gnus-summary-reply-with-original}
3936 Mail a reply to the author of the current article and include the
3937 original message (@code{gnus-summary-reply-with-original}). This
3938 command uses the process/prefix convention.
3941 @kindex S w (Summary)
3942 @findex gnus-summary-wide-reply
3943 Mail a wide reply to the author of the current article
3944 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
3945 goes out to all people listed in the @code{To}, @code{From} (or
3946 @code{Reply-to}) and @code{Cc} headers.
3949 @kindex S W (Summary)
3950 @findex gnus-summary-wide-reply-with-original
3951 Mail a wide reply to the current article and include the original
3952 message (@code{gnus-summary-wide-reply-with-original}). This command uses
3953 the process/prefix convention.
3956 @kindex S o m (Summary)
3957 @findex gnus-summary-mail-forward
3958 @c @icon{gnus-summary-mail-forward}
3959 Forward the current article to some other person
3960 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
3961 headers of the forwarded article.
3966 @kindex S m (Summary)
3967 @findex gnus-summary-mail-other-window
3968 @c @icon{gnus-summary-mail-originate}
3969 Send a mail to some other person
3970 (@code{gnus-summary-mail-other-window}).
3973 @kindex S D b (Summary)
3974 @findex gnus-summary-resend-bounced-mail
3975 @cindex bouncing mail
3976 If you have sent a mail, but the mail was bounced back to you for some
3977 reason (wrong address, transient failure), you can use this command to
3978 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
3979 will be popped into a mail buffer where you can edit the headers before
3980 sending the mail off again. If you give a prefix to this command, and
3981 the bounced mail is a reply to some other mail, Gnus will try to fetch
3982 that mail and display it for easy perusal of its headers. This might
3983 very well fail, though.
3986 @kindex S D r (Summary)
3987 @findex gnus-summary-resend-message
3988 Not to be confused with the previous command,
3989 @code{gnus-summary-resend-message} will prompt you for an address to
3990 send the current message off to, and then send it to that place. The
3991 headers of the message won't be altered---but lots of headers that say
3992 @code{Resent-To}, @code{Resent-From} and so on will be added. This
3993 means that you actually send a mail to someone that has a @code{To}
3994 header that (probably) points to yourself. This will confuse people.
3995 So, natcherly you'll only do that if you're really eVIl.
3997 This command is mainly used if you have several accounts and want to
3998 ship a mail to a different account of yours. (If you're both
3999 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
4000 to the @code{root} account, you may want to resend it to
4001 @code{postmaster}. Ordnung muß sein!
4003 This command understands the process/prefix convention
4004 (@pxref{Process/Prefix}).
4007 @kindex S O m (Summary)
4008 @findex gnus-uu-digest-mail-forward
4009 Digest the current series (@pxref{Decoding Articles}) and forward the
4010 result using mail (@code{gnus-uu-digest-mail-forward}). This command
4011 uses the process/prefix convention (@pxref{Process/Prefix}).
4014 @kindex S M-c (Summary)
4015 @findex gnus-summary-mail-crosspost-complaint
4016 @cindex crossposting
4017 @cindex excessive crossposting
4018 Send a complaint about excessive crossposting to the author of the
4019 current article (@code{gnus-summary-mail-crosspost-complaint}).
4021 @findex gnus-crosspost-complaint
4022 This command is provided as a way to fight back against the current
4023 crossposting pandemic that's sweeping Usenet. It will compose a reply
4024 using the @code{gnus-crosspost-complaint} variable as a preamble. This
4025 command understands the process/prefix convention
4026 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
4030 Also @pxref{(message)Header Commands} for more information.
4033 @node Summary Post Commands
4034 @subsection Summary Post Commands
4036 @cindex composing news
4038 Commands for posting a news article:
4044 @kindex S p (Summary)
4045 @findex gnus-summary-post-news
4046 @c @icon{gnus-summary-post-news}
4047 Post an article to the current group
4048 (@code{gnus-summary-post-news}).
4053 @kindex S f (Summary)
4054 @findex gnus-summary-followup
4055 @c @icon{gnus-summary-followup}
4056 Post a followup to the current article (@code{gnus-summary-followup}).
4060 @kindex S F (Summary)
4062 @c @icon{gnus-summary-followup-with-original}
4063 @findex gnus-summary-followup-with-original
4064 Post a followup to the current article and include the original message
4065 (@code{gnus-summary-followup-with-original}). This command uses the
4066 process/prefix convention.
4069 @kindex S n (Summary)
4070 @findex gnus-summary-followup-to-mail
4071 Post a followup to the current article via news, even if you got the
4072 message through mail (@code{gnus-summary-followup-to-mail}).
4075 @kindex S N (Summary)
4076 @findex gnus-summary-followup-to-mail-with-original
4077 Post a followup to the current article via news, even if you got the
4078 message through mail and include the original message
4079 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
4080 the process/prefix convention.
4083 @kindex S o p (Summary)
4084 @findex gnus-summary-post-forward
4085 Forward the current article to a newsgroup
4086 (@code{gnus-summary-post-forward}). If given a prefix, include the full
4087 headers of the forwarded article.
4090 @kindex S O p (Summary)
4091 @findex gnus-uu-digest-post-forward
4093 @cindex making digests
4094 Digest the current series and forward the result to a newsgroup
4095 (@code{gnus-uu-digest-mail-forward}). This command uses the
4096 process/prefix convention.
4099 @kindex S u (Summary)
4100 @findex gnus-uu-post-news
4101 @c @icon{gnus-uu-post-news}
4102 Uuencode a file, split it into parts, and post it as a series
4103 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
4106 Also @pxref{(message)Header Commands} for more information.
4109 @node Canceling and Superseding
4110 @section Canceling Articles
4111 @cindex canceling articles
4112 @cindex superseding articles
4114 Have you ever written something, and then decided that you really,
4115 really, really wish you hadn't posted that?
4117 Well, you can't cancel mail, but you can cancel posts.
4119 @findex gnus-summary-cancel-article
4121 @c @icon{gnus-summary-cancel-article}
4122 Find the article you wish to cancel (you can only cancel your own
4123 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
4124 c} (@code{gnus-summary-cancel-article}). Your article will be
4125 canceled---machines all over the world will be deleting your article.
4126 This command uses the process/prefix convention (@pxref{Process/Prefix}).
4128 Be aware, however, that not all sites honor cancels, so your article may
4129 live on here and there, while most sites will delete the article in
4132 Gnus will use the ``current'' select method when canceling. If you
4133 want to use the standard posting method, use the @samp{a} symbolic
4134 prefix (@pxref{Symbolic Prefixes}).
4136 If you discover that you have made some mistakes and want to do some
4137 corrections, you can post a @dfn{superseding} article that will replace
4138 your original article.
4140 @findex gnus-summary-supersede-article
4142 Go to the original article and press @kbd{S s}
4143 (@code{gnus-summary-supersede-article}). You will be put in a buffer
4144 where you can edit the article all you want before sending it off the
4147 The same goes for superseding as for canceling, only more so: Some
4148 sites do not honor superseding. On those sites, it will appear that you
4149 have posted almost the same article twice.
4151 If you have just posted the article, and change your mind right away,
4152 there is a trick you can use to cancel/supersede the article without
4153 waiting for the article to appear on your site first. You simply return
4154 to the post buffer (which is called @code{*sent ...*}). There you will
4155 find the article you just posted, with all the headers intact. Change
4156 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
4157 header by substituting one of those words for the word
4158 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
4159 you would do normally. The previous article will be
4160 canceled/superseded.
4162 Just remember, kids: There is no 'c' in 'supersede'.
4165 @node Marking Articles
4166 @section Marking Articles
4167 @cindex article marking
4168 @cindex article ticking
4171 There are several marks you can set on an article.
4173 You have marks that decide the @dfn{readedness} (whoo, neato-keano
4174 neologism ohoy!) of the article. Alphabetic marks generally mean
4175 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
4177 In addition, you also have marks that do not affect readedness.
4180 * Unread Articles:: Marks for unread articles.
4181 * Read Articles:: Marks for read articles.
4182 * Other Marks:: Marks that do not affect readedness.
4186 There's a plethora of commands for manipulating these marks:
4190 * Setting Marks:: How to set and remove marks.
4191 * Setting Process Marks:: How to mark articles for later processing.
4195 @node Unread Articles
4196 @subsection Unread Articles
4198 The following marks mark articles as (kinda) unread, in one form or
4203 @vindex gnus-ticked-mark
4204 Marked as ticked (@code{gnus-ticked-mark}).
4206 @dfn{Ticked articles} are articles that will remain visible always. If
4207 you see an article that you find interesting, or you want to put off
4208 reading it, or replying to it, until sometime later, you'd typically
4209 tick it. However, articles can be expired, so if you want to keep an
4210 article forever, you'll have to make it persistent (@pxref{Persistent
4214 @vindex gnus-dormant-mark
4215 Marked as dormant (@code{gnus-dormant-mark}).
4217 @dfn{Dormant articles} will only appear in the summary buffer if there
4218 are followups to it. If you want to see them even if they don't have
4219 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
4222 @vindex gnus-unread-mark
4223 Marked as unread (@code{gnus-unread-mark}).
4225 @dfn{Unread articles} are articles that haven't been read at all yet.
4230 @subsection Read Articles
4231 @cindex expirable mark
4233 All the following marks mark articles as read.
4238 @vindex gnus-del-mark
4239 These are articles that the user has marked as read with the @kbd{d}
4240 command manually, more or less (@code{gnus-del-mark}).
4243 @vindex gnus-read-mark
4244 Articles that have actually been read (@code{gnus-read-mark}).
4247 @vindex gnus-ancient-mark
4248 Articles that were marked as read in previous sessions and are now
4249 @dfn{old} (@code{gnus-ancient-mark}).
4252 @vindex gnus-killed-mark
4253 Marked as killed (@code{gnus-killed-mark}).
4256 @vindex gnus-kill-file-mark
4257 Marked as killed by kill files (@code{gnus-kill-file-mark}).
4260 @vindex gnus-low-score-mark
4261 Marked as read by having too low a score (@code{gnus-low-score-mark}).
4264 @vindex gnus-catchup-mark
4265 Marked as read by a catchup (@code{gnus-catchup-mark}).
4268 @vindex gnus-canceled-mark
4269 Canceled article (@code{gnus-canceled-mark})
4272 @vindex gnus-souped-mark
4273 @sc{SOUP}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
4276 @vindex gnus-sparse-mark
4277 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
4281 @vindex gnus-duplicate-mark
4282 Article marked as read by duplicate suppression
4283 (@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}.
4287 All these marks just mean that the article is marked as read, really.
4288 They are interpreted differently when doing adaptive scoring, though.
4290 One more special mark, though:
4294 @vindex gnus-expirable-mark
4295 Marked as expirable (@code{gnus-expirable-mark}).
4297 Marking articles as @dfn{expirable} (or have them marked as such
4298 automatically) doesn't make much sense in normal groups---a user doesn't
4299 control expiring of news articles, but in mail groups, for instance,
4300 articles marked as @dfn{expirable} can be deleted by Gnus at
4306 @subsection Other Marks
4307 @cindex process mark
4310 There are some marks that have nothing to do with whether the article is
4316 You can set a bookmark in the current article. Say you are reading a
4317 long thesis on cats' urinary tracts, and have to go home for dinner
4318 before you've finished reading the thesis. You can then set a bookmark
4319 in the article, and Gnus will jump to this bookmark the next time it
4320 encounters the article. @xref{Setting Marks}.
4323 @vindex gnus-replied-mark
4324 All articles that you have replied to or made a followup to (i.e., have
4325 answered) will be marked with an @samp{A} in the second column
4326 (@code{gnus-replied-mark}).
4329 @vindex gnus-cached-mark
4330 Articles stored in the article cache will be marked with an @samp{*} in
4331 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
4334 @vindex gnus-saved-mark
4335 Articles ``saved'' (in some manner or other; not necessarily
4336 religiously) are marked with an @samp{S} in the second column
4337 (@code{gnus-saved-mark}).
4340 @vindex gnus-not-empty-thread-mark
4341 @vindex gnus-empty-thread-mark
4342 If the @samp{%e} spec is used, the presence of threads or not will be
4343 marked with @code{gnus-not-empty-thread-mark} and
4344 @code{gnus-empty-thread-mark} in the third column, respectively.
4347 @vindex gnus-process-mark
4348 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
4349 variety of commands react to the presence of the process mark. For
4350 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4351 all articles that have been marked with the process mark. Articles
4352 marked with the process mark have a @samp{#} in the second column.
4356 You might have noticed that most of these ``non-readedness'' marks
4357 appear in the second column by default. So if you have a cached, saved,
4358 replied article that you have process-marked, what will that look like?
4360 Nothing much. The precedence rules go as follows: process -> cache ->
4361 replied -> saved. So if the article is in the cache and is replied,
4362 you'll only see the cache mark and not the replied mark.
4366 @subsection Setting Marks
4367 @cindex setting marks
4369 All the marking commands understand the numeric prefix.
4374 @kindex M c (Summary)
4375 @kindex M-u (Summary)
4376 @findex gnus-summary-clear-mark-forward
4377 @cindex mark as unread
4378 Clear all readedness-marks from the current article
4379 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
4385 @kindex M t (Summary)
4386 @findex gnus-summary-tick-article-forward
4387 Tick the current article (@code{gnus-summary-tick-article-forward}).
4388 @xref{Article Caching}.
4393 @kindex M ? (Summary)
4394 @findex gnus-summary-mark-as-dormant
4395 Mark the current article as dormant
4396 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
4400 @kindex M d (Summary)
4402 @findex gnus-summary-mark-as-read-forward
4403 Mark the current article as read
4404 (@code{gnus-summary-mark-as-read-forward}).
4408 @findex gnus-summary-mark-as-read-backward
4409 Mark the current article as read and move point to the previous line
4410 (@code{gnus-summary-mark-as-read-backward}).
4415 @kindex M k (Summary)
4416 @findex gnus-summary-kill-same-subject-and-select
4417 Mark all articles that have the same subject as the current one as read,
4418 and then select the next unread article
4419 (@code{gnus-summary-kill-same-subject-and-select}).
4423 @kindex M K (Summary)
4424 @kindex C-k (Summary)
4425 @findex gnus-summary-kill-same-subject
4426 Mark all articles that have the same subject as the current one as read
4427 (@code{gnus-summary-kill-same-subject}).
4430 @kindex M C (Summary)
4431 @findex gnus-summary-catchup
4432 @c @icon{gnus-summary-catchup}
4433 Mark all unread articles as read (@code{gnus-summary-catchup}).
4436 @kindex M C-c (Summary)
4437 @findex gnus-summary-catchup-all
4438 Mark all articles in the group as read---even the ticked and dormant
4439 articles (@code{gnus-summary-catchup-all}).
4442 @kindex M H (Summary)
4443 @findex gnus-summary-catchup-to-here
4444 Catchup the current group to point
4445 (@code{gnus-summary-catchup-to-here}).
4448 @kindex C-w (Summary)
4449 @findex gnus-summary-mark-region-as-read
4450 Mark all articles between point and mark as read
4451 (@code{gnus-summary-mark-region-as-read}).
4454 @kindex M V k (Summary)
4455 @findex gnus-summary-kill-below
4456 Kill all articles with scores below the default score (or below the
4457 numeric prefix) (@code{gnus-summary-kill-below}).
4461 @kindex M e (Summary)
4463 @findex gnus-summary-mark-as-expirable
4464 Mark the current article as expirable
4465 (@code{gnus-summary-mark-as-expirable}).
4468 @kindex M b (Summary)
4469 @findex gnus-summary-set-bookmark
4470 Set a bookmark in the current article
4471 (@code{gnus-summary-set-bookmark}).
4474 @kindex M B (Summary)
4475 @findex gnus-summary-remove-bookmark
4476 Remove the bookmark from the current article
4477 (@code{gnus-summary-remove-bookmark}).
4480 @kindex M V c (Summary)
4481 @findex gnus-summary-clear-above
4482 Clear all marks from articles with scores over the default score (or
4483 over the numeric prefix) (@code{gnus-summary-clear-above}).
4486 @kindex M V u (Summary)
4487 @findex gnus-summary-tick-above
4488 Tick all articles with scores over the default score (or over the
4489 numeric prefix) (@code{gnus-summary-tick-above}).
4492 @kindex M V m (Summary)
4493 @findex gnus-summary-mark-above
4494 Prompt for a mark, and mark all articles with scores over the default
4495 score (or over the numeric prefix) with this mark
4496 (@code{gnus-summary-clear-above}).
4499 @vindex gnus-summary-goto-unread
4500 The @code{gnus-summary-goto-unread} variable controls what action should
4501 be taken after setting a mark. If non-@code{nil}, point will move to
4502 the next/previous unread article. If @code{nil}, point will just move
4503 one line up or down. As a special case, if this variable is
4504 @code{never}, all the marking commands as well as other commands (like
4505 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4506 The default is @code{t}.
4509 @node Setting Process Marks
4510 @subsection Setting Process Marks
4511 @cindex setting process marks
4518 @kindex M P p (Summary)
4519 @findex gnus-summary-mark-as-processable
4520 Mark the current article with the process mark
4521 (@code{gnus-summary-mark-as-processable}).
4522 @findex gnus-summary-unmark-as-processable
4526 @kindex M P u (Summary)
4527 @kindex M-# (Summary)
4528 Remove the process mark, if any, from the current article
4529 (@code{gnus-summary-unmark-as-processable}).
4532 @kindex M P U (Summary)
4533 @findex gnus-summary-unmark-all-processable
4534 Remove the process mark from all articles
4535 (@code{gnus-summary-unmark-all-processable}).
4538 @kindex M P i (Summary)
4539 @findex gnus-uu-invert-processable
4540 Invert the list of process marked articles
4541 (@code{gnus-uu-invert-processable}).
4544 @kindex M P R (Summary)
4545 @findex gnus-uu-mark-by-regexp
4546 Mark articles that have a @code{Subject} header that matches a regular
4547 expression (@code{gnus-uu-mark-by-regexp}).
4550 @kindex M P r (Summary)
4551 @findex gnus-uu-mark-region
4552 Mark articles in region (@code{gnus-uu-mark-region}).
4555 @kindex M P t (Summary)
4556 @findex gnus-uu-mark-thread
4557 Mark all articles in the current (sub)thread
4558 (@code{gnus-uu-mark-thread}).
4561 @kindex M P T (Summary)
4562 @findex gnus-uu-unmark-thread
4563 Unmark all articles in the current (sub)thread
4564 (@code{gnus-uu-unmark-thread}).
4567 @kindex M P v (Summary)
4568 @findex gnus-uu-mark-over
4569 Mark all articles that have a score above the prefix argument
4570 (@code{gnus-uu-mark-over}).
4573 @kindex M P s (Summary)
4574 @findex gnus-uu-mark-series
4575 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4578 @kindex M P S (Summary)
4579 @findex gnus-uu-mark-sparse
4580 Mark all series that have already had some articles marked
4581 (@code{gnus-uu-mark-sparse}).
4584 @kindex M P a (Summary)
4585 @findex gnus-uu-mark-all
4586 Mark all articles in series order (@code{gnus-uu-mark-series}).
4589 @kindex M P b (Summary)
4590 @findex gnus-uu-mark-buffer
4591 Mark all articles in the buffer in the order they appear
4592 (@code{gnus-uu-mark-buffer}).
4595 @kindex M P k (Summary)
4596 @findex gnus-summary-kill-process-mark
4597 Push the current process mark set onto the stack and unmark all articles
4598 (@code{gnus-summary-kill-process-mark}).
4601 @kindex M P y (Summary)
4602 @findex gnus-summary-yank-process-mark
4603 Pop the previous process mark set from the stack and restore it
4604 (@code{gnus-summary-yank-process-mark}).
4607 @kindex M P w (Summary)
4608 @findex gnus-summary-save-process-mark
4609 Push the current process mark set onto the stack
4610 (@code{gnus-summary-save-process-mark}).
4619 It can be convenient to limit the summary buffer to just show some
4620 subset of the articles currently in the group. The effect most limit
4621 commands have is to remove a few (or many) articles from the summary
4624 All limiting commands work on subsets of the articles already fetched
4625 from the servers. None of these commands query the server for
4626 additional articles.
4632 @kindex / / (Summary)
4633 @findex gnus-summary-limit-to-subject
4634 Limit the summary buffer to articles that match some subject
4635 (@code{gnus-summary-limit-to-subject}).
4638 @kindex / a (Summary)
4639 @findex gnus-summary-limit-to-author
4640 Limit the summary buffer to articles that match some author
4641 (@code{gnus-summary-limit-to-author}).
4645 @kindex / u (Summary)
4647 @findex gnus-summary-limit-to-unread
4648 Limit the summary buffer to articles not marked as read
4649 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
4650 buffer to articles strictly unread. This means that ticked and
4651 dormant articles will also be excluded.
4654 @kindex / m (Summary)
4655 @findex gnus-summary-limit-to-marks
4656 Ask for a mark and then limit to all articles that have been marked
4657 with that mark (@code{gnus-summary-limit-to-marks}).
4660 @kindex / t (Summary)
4661 @findex gnus-summary-limit-to-age
4662 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
4663 (@code{gnus-summary-limit-to-marks}). If given a prefix, limit to
4664 articles younger than that number of days.
4667 @kindex / n (Summary)
4668 @findex gnus-summary-limit-to-articles
4669 Limit the summary buffer to the current article
4670 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
4671 convention (@pxref{Process/Prefix}).
4674 @kindex / w (Summary)
4675 @findex gnus-summary-pop-limit
4676 Pop the previous limit off the stack and restore it
4677 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
4681 @kindex / v (Summary)
4682 @findex gnus-summary-limit-to-score
4683 Limit the summary buffer to articles that have a score at or above some
4684 score (@code{gnus-summary-limit-to-score}).
4688 @kindex M S (Summary)
4689 @kindex / E (Summary)
4690 @findex gnus-summary-limit-include-expunged
4691 Include all expunged articles in the limit
4692 (@code{gnus-summary-limit-include-expunged}).
4695 @kindex / D (Summary)
4696 @findex gnus-summary-limit-include-dormant
4697 Include all dormant articles in the limit
4698 (@code{gnus-summary-limit-include-dormant}).
4701 @kindex / * (Summary)
4702 @findex gnus-summary-limit-include-cached
4703 Include all cached articles in the limit
4704 (@code{gnus-summary-limit-include-cached}).
4707 @kindex / d (Summary)
4708 @findex gnus-summary-limit-exclude-dormant
4709 Exclude all dormant articles from the limit
4710 (@code{gnus-summary-limit-exclude-dormant}).
4713 @kindex / T (Summary)
4714 @findex gnus-summary-limit-include-thread
4715 Include all the articles in the current thread in the limit.
4718 @kindex / c (Summary)
4719 @findex gnus-summary-limit-exclude-childless-dormant
4720 Exclude all dormant articles that have no children from the limit
4721 (@code{gnus-summary-limit-exclude-childless-dormant}).
4724 @kindex / C (Summary)
4725 @findex gnus-summary-limit-mark-excluded-as-read
4726 Mark all excluded unread articles as read
4727 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
4728 also mark excluded ticked and dormant articles as read.
4736 @cindex article threading
4738 Gnus threads articles by default. @dfn{To thread} is to put responses
4739 to articles directly after the articles they respond to---in a
4740 hierarchical fashion.
4742 Threading is done by looking at the @code{References} headers of the
4743 articles. In a perfect world, this would be enough to build pretty
4744 trees, but unfortunately, the @code{References} header is often broken
4745 or simply missing. Weird news propagation excarcerbates the problem,
4746 so one has to employ other heuristics to get pleasing results. A
4747 plethora of approaches exists, as detailed in horrible detail in
4748 @pxref{Customizing Threading}.
4750 First, a quick overview of the concepts:
4754 The top-most article in a thread; the first article in the thread.
4757 A tree-like article structure.
4760 A small(er) section of this tree-like structure.
4763 Threads often lose their roots due to article expiry, or due to the root
4764 already having been read in a previous session, and not displayed in the
4765 summary buffer. We then typically have many sub-threads that really
4766 belong to one thread, but are without connecting roots. These are
4767 called loose threads.
4769 @item thread gathering
4770 An attempt to gather loose threads into bigger threads.
4772 @item sparse threads
4773 A thread where the missing articles have been ``guessed'' at, and are
4774 displayed as empty lines in the summary buffer.
4780 * Customizing Threading:: Variables you can change to affect the threading.
4781 * Thread Commands:: Thread based commands in the summary buffer.
4785 @node Customizing Threading
4786 @subsection Customizing Threading
4787 @cindex customizing threading
4790 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
4791 * Filling In Threads:: Making the threads displayed look fuller.
4792 * More Threading:: Even more variables for fiddling with threads.
4793 * Low-Level Threading:: You thought it was over... but you were wrong!
4798 @subsubsection Loose Threads
4801 @cindex loose threads
4804 @item gnus-summary-make-false-root
4805 @vindex gnus-summary-make-false-root
4806 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4807 and create a dummy root at the top. (Wait a minute. Root at the top?
4808 Yup.) Loose subtrees occur when the real root has expired, or you've
4809 read or killed the root in a previous session.
4811 When there is no real root of a thread, Gnus will have to fudge
4812 something. This variable says what fudging method Gnus should use.
4813 There are four possible values:
4817 \gnusfigure{The Summary Buffer}{390}{
4818 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4819 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4820 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4821 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4826 @cindex adopting articles
4831 Gnus will make the first of the orphaned articles the parent. This
4832 parent will adopt all the other articles. The adopted articles will be
4833 marked as such by pointy brackets (@samp{<>}) instead of the standard
4834 square brackets (@samp{[]}). This is the default method.
4837 @vindex gnus-summary-dummy-line-format
4838 Gnus will create a dummy summary line that will pretend to be the
4839 parent. This dummy line does not correspond to any real article, so
4840 selecting it will just select the first real article after the dummy
4841 article. @code{gnus-summary-dummy-line-format} is used to specify the
4842 format of the dummy roots. It accepts only one format spec: @samp{S},
4843 which is the subject of the article. @xref{Formatting Variables}.
4846 Gnus won't actually make any article the parent, but simply leave the
4847 subject field of all orphans except the first empty. (Actually, it will
4848 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4852 Don't make any article parent at all. Just gather the threads and
4853 display them after one another.
4856 Don't gather loose threads.
4859 @item gnus-summary-gather-subject-limit
4860 @vindex gnus-summary-gather-subject-limit
4861 Loose threads are gathered by comparing subjects of articles. If this
4862 variable is @code{nil}, Gnus requires an exact match between the
4863 subjects of the loose threads before gathering them into one big
4864 super-thread. This might be too strict a requirement, what with the
4865 presence of stupid newsreaders that chop off long subject lines. If
4866 you think so, set this variable to, say, 20 to require that only the
4867 first 20 characters of the subjects have to match. If you set this
4868 variable to a really low number, you'll find that Gnus will gather
4869 everything in sight into one thread, which isn't very helpful.
4871 @cindex fuzzy article gathering
4872 If you set this variable to the special value @code{fuzzy}, Gnus will
4873 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4876 @item gnus-simplify-subject-fuzzy-regexp
4877 @vindex gnus-simplify-subject-fuzzy-regexp
4878 This can either be a regular expression or list of regular expressions
4879 that match strings that will be removed from subjects if fuzzy subject
4880 simplification is used.
4882 @item gnus-simplify-ignored-prefixes
4883 @vindex gnus-simplify-ignored-prefixes
4884 If you set @code{gnus-summary-gather-subject-limit} to something as low
4885 as 10, you might consider setting this variable to something sensible:
4887 @c Written by Michael Ernst <mernst@cs.rice.edu>
4889 (setq gnus-simplify-ignored-prefixes
4895 "wanted" "followup" "summary\\( of\\)?"
4896 "help" "query" "problem" "question"
4897 "answer" "reference" "announce"
4898 "How can I" "How to" "Comparison of"
4903 (mapconcat 'identity
4904 '("for" "for reference" "with" "about")
4906 "\\)?\\]?:?[ \t]*"))
4909 All words that match this regexp will be removed before comparing two
4912 @item gnus-simplify-subject-functions
4913 @vindex gnus-simplify-subject-functions
4914 If non-@code{nil}, this variable overrides
4915 @code{gnus-summary-gather-subject-limit}. This variable should be a
4916 list of functions to apply to the @code{Subject} string iteratively to
4917 arrive at the simplified version of the string.
4919 Useful functions to put in this list include:
4922 @item gnus-simplify-subject-re
4923 @findex gnus-simplify-subject-re
4924 Strip the leading @samp{Re:}.
4926 @item gnus-simplify-subject-fuzzy
4927 @findex gnus-simplify-subject-fuzzy
4930 @item gnus-simplify-whitespace
4931 @findex gnus-simplify-whitespace
4932 Remove excessive whitespace.
4935 You may also write your own functions, of course.
4938 @item gnus-summary-gather-exclude-subject
4939 @vindex gnus-summary-gather-exclude-subject
4940 Since loose thread gathering is done on subjects only, that might lead
4941 to many false hits, especially with certain common subjects like
4942 @samp{} and @samp{(none)}. To make the situation slightly better,
4943 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4944 what subjects should be excluded from the gathering process.@*
4945 The default is @samp{^ *$\\|^(none)$}.
4947 @item gnus-summary-thread-gathering-function
4948 @vindex gnus-summary-thread-gathering-function
4949 Gnus gathers threads by looking at @code{Subject} headers. This means
4950 that totally unrelated articles may end up in the same ``thread'', which
4951 is confusing. An alternate approach is to look at all the
4952 @code{Message-ID}s in all the @code{References} headers to find matches.
4953 This will ensure that no gathered threads ever include unrelated
4954 articles, but it also means that people who have posted with broken
4955 newsreaders won't be gathered properly. The choice is yours---plague or
4959 @item gnus-gather-threads-by-subject
4960 @findex gnus-gather-threads-by-subject
4961 This function is the default gathering function and looks at
4962 @code{Subject}s exclusively.
4964 @item gnus-gather-threads-by-references
4965 @findex gnus-gather-threads-by-references
4966 This function looks at @code{References} headers exclusively.
4969 If you want to test gathering by @code{References}, you could say
4973 (setq gnus-summary-thread-gathering-function
4974 'gnus-gather-threads-by-references)
4980 @node Filling In Threads
4981 @subsubsection Filling In Threads
4984 @item gnus-fetch-old-headers
4985 @vindex gnus-fetch-old-headers
4986 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4987 more old headers---headers to articles marked as read. If you
4988 would like to display as few summary lines as possible, but still
4989 connect as many loose threads as possible, you should set this variable
4990 to @code{some} or a number. If you set it to a number, no more than
4991 that number of extra old headers will be fetched. In either case,
4992 fetching old headers only works if the backend you are using carries
4993 overview files---this would normally be @code{nntp}, @code{nnspool} and
4994 @code{nnml}. Also remember that if the root of the thread has been
4995 expired by the server, there's not much Gnus can do about that.
4997 This variable can also be set to @code{invisible}. This won't have any
4998 visible effects, but is useful if you use the @kbd{A T} command a lot
4999 (@pxref{Finding the Parent}).
5001 @item gnus-build-sparse-threads
5002 @vindex gnus-build-sparse-threads
5003 Fetching old headers can be slow. A low-rent similar effect can be
5004 gotten by setting this variable to @code{some}. Gnus will then look at
5005 the complete @code{References} headers of all articles and try to string
5006 together articles that belong in the same thread. This will leave
5007 @dfn{gaps} in the threading display where Gnus guesses that an article
5008 is missing from the thread. (These gaps appear like normal summary
5009 lines. If you select a gap, Gnus will try to fetch the article in
5010 question.) If this variable is @code{t}, Gnus will display all these
5011 ``gaps'' without regard for whether they are useful for completing the
5012 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
5013 off sparse leaf nodes that don't lead anywhere. This variable is
5014 @code{nil} by default.
5019 @node More Threading
5020 @subsubsection More Threading
5023 @item gnus-show-threads
5024 @vindex gnus-show-threads
5025 If this variable is @code{nil}, no threading will be done, and all of
5026 the rest of the variables here will have no effect. Turning threading
5027 off will speed group selection up a bit, but it is sure to make reading
5028 slower and more awkward.
5030 @item gnus-thread-hide-subtree
5031 @vindex gnus-thread-hide-subtree
5032 If non-@code{nil}, all threads will be hidden when the summary buffer is
5035 @item gnus-thread-expunge-below
5036 @vindex gnus-thread-expunge-below
5037 All threads that have a total score (as defined by
5038 @code{gnus-thread-score-function}) less than this number will be
5039 expunged. This variable is @code{nil} by default, which means that no
5040 threads are expunged.
5042 @item gnus-thread-hide-killed
5043 @vindex gnus-thread-hide-killed
5044 if you kill a thread and this variable is non-@code{nil}, the subtree
5047 @item gnus-thread-ignore-subject
5048 @vindex gnus-thread-ignore-subject
5049 Sometimes somebody changes the subject in the middle of a thread. If
5050 this variable is non-@code{nil}, the subject change is ignored. If it
5051 is @code{nil}, which is the default, a change in the subject will result
5054 @item gnus-thread-indent-level
5055 @vindex gnus-thread-indent-level
5056 This is a number that says how much each sub-thread should be indented.
5062 @node Low-Level Threading
5063 @subsubsection Low-Level Threading
5067 @item gnus-parse-headers-hook
5068 @vindex gnus-parse-headers-hook
5069 Hook run before parsing any headers.
5071 @item gnus-alter-header-function
5072 @vindex gnus-alter-header-function
5073 If non-@code{nil}, this function will be called to allow alteration of
5074 article header structures. The function is called with one parameter,
5075 the article header vector, which it may alter in any way. For instance,
5076 if you have a mail-to-news gateway which alters the @code{Message-ID}s
5077 in systematic ways (by adding prefixes and such), you can use this
5078 variable to un-scramble the @code{Message-ID}s so that they are more
5079 meaningful. Here's one example:
5082 (setq gnus-alter-header-function 'my-alter-message-id)
5084 (defun my-alter-message-id (header)
5085 (let ((id (mail-header-id header)))
5087 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
5089 (concat (match-string 1 id) "@@" (match-string 2 id))
5096 @node Thread Commands
5097 @subsection Thread Commands
5098 @cindex thread commands
5104 @kindex T k (Summary)
5105 @kindex M-C-k (Summary)
5106 @findex gnus-summary-kill-thread
5107 Mark all articles in the current (sub-)thread as read
5108 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
5109 remove all marks instead. If the prefix argument is negative, tick
5114 @kindex T l (Summary)
5115 @kindex M-C-l (Summary)
5116 @findex gnus-summary-lower-thread
5117 Lower the score of the current (sub-)thread
5118 (@code{gnus-summary-lower-thread}).
5121 @kindex T i (Summary)
5122 @findex gnus-summary-raise-thread
5123 Increase the score of the current (sub-)thread
5124 (@code{gnus-summary-raise-thread}).
5127 @kindex T # (Summary)
5128 @findex gnus-uu-mark-thread
5129 Set the process mark on the current (sub-)thread
5130 (@code{gnus-uu-mark-thread}).
5133 @kindex T M-# (Summary)
5134 @findex gnus-uu-unmark-thread
5135 Remove the process mark from the current (sub-)thread
5136 (@code{gnus-uu-unmark-thread}).
5139 @kindex T T (Summary)
5140 @findex gnus-summary-toggle-threads
5141 Toggle threading (@code{gnus-summary-toggle-threads}).
5144 @kindex T s (Summary)
5145 @findex gnus-summary-show-thread
5146 Expose the (sub-)thread hidden under the current article, if any
5147 (@code{gnus-summary-show-thread}).
5150 @kindex T h (Summary)
5151 @findex gnus-summary-hide-thread
5152 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
5155 @kindex T S (Summary)
5156 @findex gnus-summary-show-all-threads
5157 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
5160 @kindex T H (Summary)
5161 @findex gnus-summary-hide-all-threads
5162 Hide all threads (@code{gnus-summary-hide-all-threads}).
5165 @kindex T t (Summary)
5166 @findex gnus-summary-rethread-current
5167 Re-thread the current article's thread
5168 (@code{gnus-summary-rethread-current}). This works even when the
5169 summary buffer is otherwise unthreaded.
5172 @kindex T ^ (Summary)
5173 @findex gnus-summary-reparent-thread
5174 Make the current article the child of the marked (or previous) article
5175 (@code{gnus-summary-reparent-thread}).
5179 The following commands are thread movement commands. They all
5180 understand the numeric prefix.
5185 @kindex T n (Summary)
5186 @findex gnus-summary-next-thread
5187 Go to the next thread (@code{gnus-summary-next-thread}).
5190 @kindex T p (Summary)
5191 @findex gnus-summary-prev-thread
5192 Go to the previous thread (@code{gnus-summary-prev-thread}).
5195 @kindex T d (Summary)
5196 @findex gnus-summary-down-thread
5197 Descend the thread (@code{gnus-summary-down-thread}).
5200 @kindex T u (Summary)
5201 @findex gnus-summary-up-thread
5202 Ascend the thread (@code{gnus-summary-up-thread}).
5205 @kindex T o (Summary)
5206 @findex gnus-summary-top-thread
5207 Go to the top of the thread (@code{gnus-summary-top-thread}).
5210 @vindex gnus-thread-operation-ignore-subject
5211 If you ignore subject while threading, you'll naturally end up with
5212 threads that have several different subjects in them. If you then issue
5213 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
5214 wish to kill the entire thread, but just those parts of the thread that
5215 have the same subject as the current article. If you like this idea,
5216 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
5217 is non-@code{nil} (which it is by default), subjects will be ignored
5218 when doing thread commands. If this variable is @code{nil}, articles in
5219 the same thread with different subjects will not be included in the
5220 operation in question. If this variable is @code{fuzzy}, only articles
5221 that have subjects fuzzily equal will be included (@pxref{Fuzzy
5228 @findex gnus-thread-sort-by-total-score
5229 @findex gnus-thread-sort-by-date
5230 @findex gnus-thread-sort-by-score
5231 @findex gnus-thread-sort-by-subject
5232 @findex gnus-thread-sort-by-author
5233 @findex gnus-thread-sort-by-number
5234 @vindex gnus-thread-sort-functions
5235 If you are using a threaded summary display, you can sort the threads by
5236 setting @code{gnus-thread-sort-functions}, which can be either a single
5237 function, a list of functions, or a list containing functions and
5238 @code{(not some-function)} elements.
5240 By default, sorting is done on article numbers. Ready-made sorting
5241 predicate functions include @code{gnus-thread-sort-by-number},
5242 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
5243 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
5244 @code{gnus-thread-sort-by-total-score}.
5246 Each function takes two threads and returns non-@code{nil} if the first
5247 thread should be sorted before the other. Note that sorting really is
5248 normally done by looking only at the roots of each thread.
5250 If you use more than one function, the primary sort key should be the
5251 last function in the list. You should probably always include
5252 @code{gnus-thread-sort-by-number} in the list of sorting
5253 functions---preferably first. This will ensure that threads that are
5254 equal with respect to the other sort criteria will be displayed in
5255 ascending article order.
5257 If you would like to sort by reverse score, then by subject, and finally
5258 by number, you could do something like:
5261 (setq gnus-thread-sort-functions
5262 '(gnus-thread-sort-by-number
5263 gnus-thread-sort-by-subject
5264 (reverse gnus-thread-sort-by-total-score)))
5267 The threads that have highest score will be displayed first in the
5268 summary buffer. When threads have the same score, they will be sorted
5269 alphabetically. The threads that have the same score and the same
5270 subject will be sorted by number, which is (normally) the sequence in
5271 which the articles arrived.
5273 If you want to sort by score and then reverse arrival order, you could
5277 (setq gnus-thread-sort-functions
5279 (not (gnus-thread-sort-by-number t1 t2)))
5280 gnus-thread-sort-by-score))
5283 @vindex gnus-thread-score-function
5284 The function in the @code{gnus-thread-score-function} variable (default
5285 @code{+}) is used for calculating the total score of a thread. Useful
5286 functions might be @code{max}, @code{min}, or squared means, or whatever
5289 @findex gnus-article-sort-functions
5290 @findex gnus-article-sort-by-date
5291 @findex gnus-article-sort-by-score
5292 @findex gnus-article-sort-by-subject
5293 @findex gnus-article-sort-by-author
5294 @findex gnus-article-sort-by-number
5295 If you are using an unthreaded display for some strange reason or other,
5296 you have to fiddle with the @code{gnus-article-sort-functions} variable.
5297 It is very similar to the @code{gnus-thread-sort-functions}, except that
5298 it uses slightly different functions for article comparison. Available
5299 sorting predicate functions are @code{gnus-article-sort-by-number},
5300 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
5301 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
5303 If you want to sort an unthreaded summary display by subject, you could
5307 (setq gnus-article-sort-functions
5308 '(gnus-article-sort-by-number
5309 gnus-article-sort-by-subject))
5314 @node Asynchronous Fetching
5315 @section Asynchronous Article Fetching
5316 @cindex asynchronous article fetching
5317 @cindex article pre-fetch
5320 If you read your news from an @sc{nntp} server that's far away, the
5321 network latencies may make reading articles a chore. You have to wait
5322 for a while after pressing @kbd{n} to go to the next article before the
5323 article appears. Why can't Gnus just go ahead and fetch the article
5324 while you are reading the previous one? Why not, indeed.
5326 First, some caveats. There are some pitfalls to using asynchronous
5327 article fetching, especially the way Gnus does it.
5329 Let's say you are reading article 1, which is short, and article 2 is
5330 quite long, and you are not interested in reading that. Gnus does not
5331 know this, so it goes ahead and fetches article 2. You decide to read
5332 article 3, but since Gnus is in the process of fetching article 2, the
5333 connection is blocked.
5335 To avoid these situations, Gnus will open two (count 'em two)
5336 connections to the server. Some people may think this isn't a very nice
5337 thing to do, but I don't see any real alternatives. Setting up that
5338 extra connection takes some time, so Gnus startup will be slower.
5340 Gnus will fetch more articles than you will read. This will mean that
5341 the link between your machine and the @sc{nntp} server will become more
5342 loaded than if you didn't use article pre-fetch. The server itself will
5343 also become more loaded---both with the extra article requests, and the
5346 Ok, so now you know that you shouldn't really use this thing... unless
5349 @vindex gnus-asynchronous
5350 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
5351 happen automatically.
5353 @vindex gnus-use-article-prefetch
5354 You can control how many articles are to be pre-fetched by setting
5355 @code{gnus-use-article-prefetch}. This is 30 by default, which means
5356 that when you read an article in the group, the backend will pre-fetch
5357 the next 30 articles. If this variable is @code{t}, the backend will
5358 pre-fetch all the articles it can without bound. If it is
5359 @code{nil}, no pre-fetching will be done.
5361 @vindex gnus-async-prefetch-article-p
5362 @findex gnus-async-read-p
5363 There are probably some articles that you don't want to pre-fetch---read
5364 articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should
5365 return non-@code{nil} when the article in question is to be
5366 pre-fetched. The default is @code{gnus-async-read-p}, which returns
5367 @code{nil} on read articles. The function is called with an article
5368 data structure as the only parameter.
5370 If, for instance, you wish to pre-fetch only unread articles shorter than 100 lines, you could say something like:
5373 (defun my-async-short-unread-p (data)
5374 "Return non-nil for short, unread articles."
5375 (and (gnus-data-unread-p data)
5376 (< (mail-header-lines (gnus-data-header data))
5379 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
5382 These functions will be called many, many times, so they should
5383 preferably be short and sweet to avoid slowing down Gnus too much.
5384 It's probably a good idea to byte-compile things like this.
5386 @vindex gnus-prefetched-article-deletion-strategy
5387 Articles have to be removed from the asynch buffer sooner or later. The
5388 @code{gnus-prefetched-article-deletion-strategy} says when to remove
5389 articles. This is a list that may contain the following elements:
5393 Remove articles when they are read.
5396 Remove articles when exiting the group.
5399 The default value is @code{(read exit)}.
5401 @c @vindex gnus-use-header-prefetch
5402 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
5403 @c from the next group.
5406 @node Article Caching
5407 @section Article Caching
5408 @cindex article caching
5411 If you have an @emph{extremely} slow @sc{nntp} connection, you may
5412 consider turning article caching on. Each article will then be stored
5413 locally under your home directory. As you may surmise, this could
5414 potentially use @emph{huge} amounts of disk space, as well as eat up all
5415 your inodes so fast it will make your head swim. In vodka.
5417 Used carefully, though, it could be just an easier way to save articles.
5419 @vindex gnus-use-long-file-name
5420 @vindex gnus-cache-directory
5421 @vindex gnus-use-cache
5422 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
5423 all articles ticked or marked as dormant will then be copied
5424 over to your local cache (@code{gnus-cache-directory}). Whether this
5425 cache is flat or hierarchal is controlled by the
5426 @code{gnus-use-long-file-name} variable, as usual.
5428 When re-selecting a ticked or dormant article, it will be fetched from the
5429 cache instead of from the server. As articles in your cache will never
5430 expire, this might serve as a method of saving articles while still
5431 keeping them where they belong. Just mark all articles you want to save
5432 as dormant, and don't worry.
5434 When an article is marked as read, is it removed from the cache.
5436 @vindex gnus-cache-remove-articles
5437 @vindex gnus-cache-enter-articles
5438 The entering/removal of articles from the cache is controlled by the
5439 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5440 variables. Both are lists of symbols. The first is @code{(ticked
5441 dormant)} by default, meaning that ticked and dormant articles will be
5442 put in the cache. The latter is @code{(read)} by default, meaning that
5443 articles marked as read are removed from the cache. Possibly
5444 symbols in these two lists are @code{ticked}, @code{dormant},
5445 @code{unread} and @code{read}.
5447 @findex gnus-jog-cache
5448 So where does the massive article-fetching and storing come into the
5449 picture? The @code{gnus-jog-cache} command will go through all
5450 subscribed newsgroups, request all unread articles, score them, and
5451 store them in the cache. You should only ever, ever ever ever, use this
5452 command if 1) your connection to the @sc{nntp} server is really, really,
5453 really slow and 2) you have a really, really, really huge disk.
5454 Seriously. One way to cut down on the number of articles downloaded is
5455 to score unwanted articles down and have them marked as read. They will
5456 not then be downloaded by this command.
5458 @vindex gnus-uncacheable-groups
5459 @vindex gnus-cacheable-groups
5460 It is likely that you do not want caching on all groups. For instance,
5461 if your @code{nnml} mail is located under your home directory, it makes no
5462 sense to cache it somewhere else under your home directory. Unless you
5463 feel that it's neat to use twice as much space.
5465 To limit the caching, you could set @code{gnus-cacheable-groups} to a
5466 regexp of groups to cache, @samp{^nntp} for instance, or set the
5467 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
5468 Both variables are @code{nil} by default. If a group matches both
5469 variables, the group is not cached.
5471 @findex gnus-cache-generate-nov-databases
5472 @findex gnus-cache-generate-active
5473 @vindex gnus-cache-active-file
5474 The cache stores information on what articles it contains in its active
5475 file (@code{gnus-cache-active-file}). If this file (or any other parts
5476 of the cache) becomes all messed up for some reason or other, Gnus
5477 offers two functions that will try to set things right. @kbd{M-x
5478 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5479 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5483 @node Persistent Articles
5484 @section Persistent Articles
5485 @cindex persistent articles
5487 Closely related to article caching, we have @dfn{persistent articles}.
5488 In fact, it's just a different way of looking at caching, and much more
5489 useful in my opinion.
5491 Say you're reading a newsgroup, and you happen on to some valuable gem
5492 that you want to keep and treasure forever. You'd normally just save it
5493 (using one of the many saving commands) in some file. The problem with
5494 that is that it's just, well, yucky. Ideally you'd prefer just having
5495 the article remain in the group where you found it forever; untouched by
5496 the expiry going on at the news server.
5498 This is what a @dfn{persistent article} is---an article that just won't
5499 be deleted. It's implemented using the normal cache functions, but
5500 you use two explicit commands for managing persistent articles:
5506 @findex gnus-cache-enter-article
5507 Make the current article persistent (@code{gnus-cache-enter-article}).
5510 @kindex M-* (Summary)
5511 @findex gnus-cache-remove-article
5512 Remove the current article from the persistent articles
5513 (@code{gnus-cache-remove-article}). This will normally delete the
5517 Both these commands understand the process/prefix convention.
5519 To avoid having all ticked articles (and stuff) entered into the cache,
5520 you should set @code{gnus-use-cache} to @code{passive} if you're just
5521 interested in persistent articles:
5524 (setq gnus-use-cache 'passive)
5528 @node Article Backlog
5529 @section Article Backlog
5531 @cindex article backlog
5533 If you have a slow connection, but the idea of using caching seems
5534 unappealing to you (and it is, really), you can help the situation some
5535 by switching on the @dfn{backlog}. This is where Gnus will buffer
5536 already read articles so that it doesn't have to re-fetch articles
5537 you've already read. This only helps if you are in the habit of
5538 re-selecting articles you've recently read, of course. If you never do
5539 that, turning the backlog on will slow Gnus down a little bit, and
5540 increase memory usage some.
5542 @vindex gnus-keep-backlog
5543 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5544 at most @var{n} old articles in a buffer for later re-fetching. If this
5545 variable is non-@code{nil} and is not a number, Gnus will store
5546 @emph{all} read articles, which means that your Emacs will grow without
5547 bound before exploding and taking your machine down with you. I put
5548 that in there just to keep y'all on your toes.
5550 This variable is @code{nil} by default.
5553 @node Saving Articles
5554 @section Saving Articles
5555 @cindex saving articles
5557 Gnus can save articles in a number of ways. Below is the documentation
5558 for saving articles in a fairly straight-forward fashion (i.e., little
5559 processing of the article is done before it is saved). For a different
5560 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5561 (@pxref{Decoding Articles}).
5563 @vindex gnus-save-all-headers
5564 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5565 unwanted headers before saving the article.
5567 @vindex gnus-saved-headers
5568 If the preceding variable is @code{nil}, all headers that match the
5569 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5570 deleted before saving.
5576 @kindex O o (Summary)
5578 @findex gnus-summary-save-article
5579 @c @icon{gnus-summary-save-article}
5580 Save the current article using the default article saver
5581 (@code{gnus-summary-save-article}).
5584 @kindex O m (Summary)
5585 @findex gnus-summary-save-article-mail
5586 Save the current article in mail format
5587 (@code{gnus-summary-save-article-mail}).
5590 @kindex O r (Summary)
5591 @findex gnus-summary-save-article-rmail
5592 Save the current article in rmail format
5593 (@code{gnus-summary-save-article-rmail}).
5596 @kindex O f (Summary)
5597 @findex gnus-summary-save-article-file
5598 @c @icon{gnus-summary-save-article-file}
5599 Save the current article in plain file format
5600 (@code{gnus-summary-save-article-file}).
5603 @kindex O F (Summary)
5604 @findex gnus-summary-write-article-file
5605 Write the current article in plain file format, overwriting any previous
5606 file contents (@code{gnus-summary-write-article-file}).
5609 @kindex O b (Summary)
5610 @findex gnus-summary-save-article-body-file
5611 Save the current article body in plain file format
5612 (@code{gnus-summary-save-article-body-file}).
5615 @kindex O h (Summary)
5616 @findex gnus-summary-save-article-folder
5617 Save the current article in mh folder format
5618 (@code{gnus-summary-save-article-folder}).
5621 @kindex O v (Summary)
5622 @findex gnus-summary-save-article-vm
5623 Save the current article in a VM folder
5624 (@code{gnus-summary-save-article-vm}).
5627 @kindex O p (Summary)
5628 @findex gnus-summary-pipe-output
5629 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
5630 the current article to a process (@code{gnus-summary-pipe-output}).
5633 @vindex gnus-prompt-before-saving
5634 All these commands use the process/prefix convention
5635 (@pxref{Process/Prefix}). If you save bunches of articles using these
5636 functions, you might get tired of being prompted for files to save each
5637 and every article in. The prompting action is controlled by
5638 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5639 default, giving you that excessive prompting action you know and
5640 loathe. If you set this variable to @code{t} instead, you'll be prompted
5641 just once for each series of articles you save. If you like to really
5642 have Gnus do all your thinking for you, you can even set this variable
5643 to @code{nil}, which means that you will never be prompted for files to
5644 save articles in. Gnus will simply save all the articles in the default
5648 @vindex gnus-default-article-saver
5649 You can customize the @code{gnus-default-article-saver} variable to make
5650 Gnus do what you want it to. You can use any of the six ready-made
5651 functions below, or you can create your own.
5655 @item gnus-summary-save-in-rmail
5656 @findex gnus-summary-save-in-rmail
5657 @vindex gnus-rmail-save-name
5658 @findex gnus-plain-save-name
5659 This is the default format, @dfn{babyl}. Uses the function in the
5660 @code{gnus-rmail-save-name} variable to get a file name to save the
5661 article in. The default is @code{gnus-plain-save-name}.
5663 @item gnus-summary-save-in-mail
5664 @findex gnus-summary-save-in-mail
5665 @vindex gnus-mail-save-name
5666 Save in a Unix mail (mbox) file. Uses the function in the
5667 @code{gnus-mail-save-name} variable to get a file name to save the
5668 article in. The default is @code{gnus-plain-save-name}.
5670 @item gnus-summary-save-in-file
5671 @findex gnus-summary-save-in-file
5672 @vindex gnus-file-save-name
5673 @findex gnus-numeric-save-name
5674 Append the article straight to an ordinary file. Uses the function in
5675 the @code{gnus-file-save-name} variable to get a file name to save the
5676 article in. The default is @code{gnus-numeric-save-name}.
5678 @item gnus-summary-save-body-in-file
5679 @findex gnus-summary-save-body-in-file
5680 Append the article body to an ordinary file. Uses the function in the
5681 @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-in-folder
5685 @findex gnus-summary-save-in-folder
5686 @findex gnus-folder-save-name
5687 @findex gnus-Folder-save-name
5688 @vindex gnus-folder-save-name
5691 Save the article to an MH folder using @code{rcvstore} from the MH
5692 library. Uses the function in the @code{gnus-folder-save-name} variable
5693 to get a file name to save the article in. The default is
5694 @code{gnus-folder-save-name}, but you can also use
5695 @code{gnus-Folder-save-name}, which creates capitalized names.
5697 @item gnus-summary-save-in-vm
5698 @findex gnus-summary-save-in-vm
5699 Save the article in a VM folder. You have to have the VM mail
5700 reader to use this setting.
5703 @vindex gnus-article-save-directory
5704 All of these functions, except for the last one, will save the article
5705 in the @code{gnus-article-save-directory}, which is initialized from the
5706 @code{SAVEDIR} environment variable. This is @file{~/News/} by
5709 As you can see above, the functions use different functions to find a
5710 suitable name of a file to save the article in. Below is a list of
5711 available functions that generate names:
5715 @item gnus-Numeric-save-name
5716 @findex gnus-Numeric-save-name
5717 File names like @file{~/News/Alt.andrea-dworkin/45}.
5719 @item gnus-numeric-save-name
5720 @findex gnus-numeric-save-name
5721 File names like @file{~/News/alt.andrea-dworkin/45}.
5723 @item gnus-Plain-save-name
5724 @findex gnus-Plain-save-name
5725 File names like @file{~/News/Alt.andrea-dworkin}.
5727 @item gnus-plain-save-name
5728 @findex gnus-plain-save-name
5729 File names like @file{~/News/alt.andrea-dworkin}.
5732 @vindex gnus-split-methods
5733 You can have Gnus suggest where to save articles by plonking a regexp into
5734 the @code{gnus-split-methods} alist. For instance, if you would like to
5735 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5736 related to VM in @code{vm-stuff}, you could set this variable to something
5740 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5741 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5742 (my-choosing-function "../other-dir/my-stuff")
5743 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5746 We see that this is a list where each element is a list that has two
5747 elements---the @dfn{match} and the @dfn{file}. The match can either be
5748 a string (in which case it is used as a regexp to match on the article
5749 head); it can be a symbol (which will be called as a function with the
5750 group name as a parameter); or it can be a list (which will be
5751 @code{eval}ed). If any of these actions have a non-@code{nil} result,
5752 the @dfn{file} will be used as a default prompt. In addition, the
5753 result of the operation itself will be used if the function or form
5754 called returns a string or a list of strings.
5756 You basically end up with a list of file names that might be used when
5757 saving the current article. (All ``matches'' will be used.) You will
5758 then be prompted for what you really want to use as a name, with file
5759 name completion over the results from applying this variable.
5761 This variable is @code{((gnus-article-archive-name))} by default, which
5762 means that Gnus will look at the articles it saves for an
5763 @code{Archive-name} line and use that as a suggestion for the file
5766 Here's an example function to clean up file names somewhat. If you have
5767 lots of mail groups called things like
5768 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5769 these group names before creating the file name to save to. The
5770 following will do just that:
5773 (defun my-save-name (group)
5774 (when (string-match "^nnml:mail." group)
5775 (substring group (match-end 0))))
5777 (setq gnus-split-methods
5778 '((gnus-article-archive-name)
5783 @vindex gnus-use-long-file-name
5784 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
5785 @code{nil}, all the preceding functions will replace all periods
5786 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5787 the functions will generate hierarchies of directories instead of having
5788 all the files in the top level directory
5789 (@file{~/News/alt/andrea-dworkin} instead of
5790 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
5791 on most systems. However, for historical reasons, this is @code{nil} on
5792 Xenix and usg-unix-v machines by default.
5794 This function also affects kill and score file names. If this variable
5795 is a list, and the list contains the element @code{not-score}, long file
5796 names will not be used for score files, if it contains the element
5797 @code{not-save}, long file names will not be used for saving, and if it
5798 contains the element @code{not-kill}, long file names will not be used
5801 If you'd like to save articles in a hierarchy that looks something like
5805 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5806 (setq gnus-default-article-saver 'gnus-summary-save-in-file) ; no encoding
5809 Then just save with @kbd{o}. You'd then read this hierarchy with
5810 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5811 the top level directory as the argument (@file{~/News/}). Then just walk
5812 around to the groups/directories with @code{nneething}.
5815 @node Decoding Articles
5816 @section Decoding Articles
5817 @cindex decoding articles
5819 Sometime users post articles (or series of articles) that have been
5820 encoded in some way or other. Gnus can decode them for you.
5823 * Uuencoded Articles:: Uudecode articles.
5824 * Shell Archives:: Unshar articles.
5825 * PostScript Files:: Split PostScript.
5826 * Other Files:: Plain save and binhex.
5827 * Decoding Variables:: Variables for a happy decoding.
5828 * Viewing Files:: You want to look at the result of the decoding?
5832 @cindex article series
5833 All these functions use the process/prefix convention
5834 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5835 the extension that a ``single article'' means ``a single series''. Gnus
5836 can find out by itself what articles belong to a series, decode all the
5837 articles and unpack/view/save the resulting file(s).
5839 Gnus guesses what articles are in the series according to the following
5840 simplish rule: The subjects must be (nearly) identical, except for the
5841 last two numbers of the line. (Spaces are largely ignored, however.)
5843 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5844 will find all the articles that match the regexp @samp{^cat.gif
5845 ([0-9]+/[0-9]+).*$}.
5847 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5848 series}, will not be properly recognized by any of the automatic viewing
5849 commands, and you have to mark the articles manually with @kbd{#}.
5852 @node Uuencoded Articles
5853 @subsection Uuencoded Articles
5855 @cindex uuencoded articles
5860 @kindex X u (Summary)
5861 @findex gnus-uu-decode-uu
5862 @c @icon{gnus-uu-decode-uu}
5863 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5866 @kindex X U (Summary)
5867 @findex gnus-uu-decode-uu-and-save
5868 Uudecodes and saves the current series
5869 (@code{gnus-uu-decode-uu-and-save}).
5872 @kindex X v u (Summary)
5873 @findex gnus-uu-decode-uu-view
5874 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5877 @kindex X v U (Summary)
5878 @findex gnus-uu-decode-uu-and-save-view
5879 Uudecodes, views and saves the current series
5880 (@code{gnus-uu-decode-uu-and-save-view}).
5884 Remember that these all react to the presence of articles marked with
5885 the process mark. If, for instance, you'd like to decode and save an
5886 entire newsgroup, you'd typically do @kbd{M P a}
5887 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5888 (@code{gnus-uu-decode-uu-and-save}).
5890 All this is very much different from how @code{gnus-uu} worked with
5891 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5892 the sun. This version of @code{gnus-uu} generally assumes that you mark
5893 articles in some way (@pxref{Setting Process Marks}) and then press
5896 @vindex gnus-uu-notify-files
5897 Note: When trying to decode articles that have names matching
5898 @code{gnus-uu-notify-files}, which is hard-coded to
5899 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5900 automatically post an article on @samp{comp.unix.wizards} saying that
5901 you have just viewed the file in question. This feature can't be turned
5905 @node Shell Archives
5906 @subsection Shell Archives
5908 @cindex shell archives
5909 @cindex shared articles
5911 Shell archives (``shar files'') used to be a popular way to distribute
5912 sources, but it isn't used all that much today. In any case, we have
5913 some commands to deal with these:
5918 @kindex X s (Summary)
5919 @findex gnus-uu-decode-unshar
5920 Unshars the current series (@code{gnus-uu-decode-unshar}).
5923 @kindex X S (Summary)
5924 @findex gnus-uu-decode-unshar-and-save
5925 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5928 @kindex X v s (Summary)
5929 @findex gnus-uu-decode-unshar-view
5930 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5933 @kindex X v S (Summary)
5934 @findex gnus-uu-decode-unshar-and-save-view
5935 Unshars, views and saves the current series
5936 (@code{gnus-uu-decode-unshar-and-save-view}).
5940 @node PostScript Files
5941 @subsection PostScript Files
5947 @kindex X p (Summary)
5948 @findex gnus-uu-decode-postscript
5949 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5952 @kindex X P (Summary)
5953 @findex gnus-uu-decode-postscript-and-save
5954 Unpack and save the current PostScript series
5955 (@code{gnus-uu-decode-postscript-and-save}).
5958 @kindex X v p (Summary)
5959 @findex gnus-uu-decode-postscript-view
5960 View the current PostScript series
5961 (@code{gnus-uu-decode-postscript-view}).
5964 @kindex X v P (Summary)
5965 @findex gnus-uu-decode-postscript-and-save-view
5966 View and save the current PostScript series
5967 (@code{gnus-uu-decode-postscript-and-save-view}).
5972 @subsection Other Files
5976 @kindex X o (Summary)
5977 @findex gnus-uu-decode-save
5978 Save the current series
5979 (@code{gnus-uu-decode-save}).
5982 @kindex X b (Summary)
5983 @findex gnus-uu-decode-binhex
5984 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
5985 doesn't really work yet.
5989 @node Decoding Variables
5990 @subsection Decoding Variables
5992 Adjective, not verb.
5995 * Rule Variables:: Variables that say how a file is to be viewed.
5996 * Other Decode Variables:: Other decode variables.
5997 * Uuencoding and Posting:: Variables for customizing uuencoding.
6001 @node Rule Variables
6002 @subsubsection Rule Variables
6003 @cindex rule variables
6005 Gnus uses @dfn{rule variables} to decide how to view a file. All these
6006 variables are of the form
6009 (list '(regexp1 command2)
6016 @item gnus-uu-user-view-rules
6017 @vindex gnus-uu-user-view-rules
6019 This variable is consulted first when viewing files. If you wish to use,
6020 for instance, @code{sox} to convert an @samp{.au} sound file, you could
6023 (setq gnus-uu-user-view-rules
6024 (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
6027 @item gnus-uu-user-view-rules-end
6028 @vindex gnus-uu-user-view-rules-end
6029 This variable is consulted if Gnus couldn't make any matches from the
6030 user and default view rules.
6032 @item gnus-uu-user-archive-rules
6033 @vindex gnus-uu-user-archive-rules
6034 This variable can be used to say what commands should be used to unpack
6039 @node Other Decode Variables
6040 @subsubsection Other Decode Variables
6043 @vindex gnus-uu-grabbed-file-functions
6045 @item gnus-uu-grabbed-file-functions
6046 All functions in this list will be called right after each file has been
6047 successfully decoded---so that you can move or view files right away,
6048 and don't have to wait for all files to be decoded before you can do
6049 anything. Ready-made functions you can put in this list are:
6053 @item gnus-uu-grab-view
6054 @findex gnus-uu-grab-view
6057 @item gnus-uu-grab-move
6058 @findex gnus-uu-grab-move
6059 Move the file (if you're using a saving function.)
6062 @item gnus-uu-be-dangerous
6063 @vindex gnus-uu-be-dangerous
6064 Specifies what to do if unusual situations arise during decoding. If
6065 @code{nil}, be as conservative as possible. If @code{t}, ignore things
6066 that didn't work, and overwrite existing files. Otherwise, ask each
6069 @item gnus-uu-ignore-files-by-name
6070 @vindex gnus-uu-ignore-files-by-name
6071 Files with name matching this regular expression won't be viewed.
6073 @item gnus-uu-ignore-files-by-type
6074 @vindex gnus-uu-ignore-files-by-type
6075 Files with a @sc{mime} type matching this variable won't be viewed.
6076 Note that Gnus tries to guess what type the file is based on the name.
6077 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
6080 @item gnus-uu-tmp-dir
6081 @vindex gnus-uu-tmp-dir
6082 Where @code{gnus-uu} does its work.
6084 @item gnus-uu-do-not-unpack-archives
6085 @vindex gnus-uu-do-not-unpack-archives
6086 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
6087 looking for files to display.
6089 @item gnus-uu-view-and-save
6090 @vindex gnus-uu-view-and-save
6091 Non-@code{nil} means that the user will always be asked to save a file
6094 @item gnus-uu-ignore-default-view-rules
6095 @vindex gnus-uu-ignore-default-view-rules
6096 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
6099 @item gnus-uu-ignore-default-archive-rules
6100 @vindex gnus-uu-ignore-default-archive-rules
6101 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
6104 @item gnus-uu-kill-carriage-return
6105 @vindex gnus-uu-kill-carriage-return
6106 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
6109 @item gnus-uu-unmark-articles-not-decoded
6110 @vindex gnus-uu-unmark-articles-not-decoded
6111 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
6112 decoded articles as unread.
6114 @item gnus-uu-correct-stripped-uucode
6115 @vindex gnus-uu-correct-stripped-uucode
6116 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
6117 uuencoded files that have had trailing spaces deleted.
6119 @item gnus-uu-pre-uudecode-hook
6120 @vindex gnus-uu-pre-uudecode-hook
6121 Hook run before sending a message to @code{uudecode}.
6123 @item gnus-uu-view-with-metamail
6124 @vindex gnus-uu-view-with-metamail
6126 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
6127 commands defined by the rule variables and just fudge a @sc{mime}
6128 content type based on the file name. The result will be fed to
6129 @code{metamail} for viewing.
6131 @item gnus-uu-save-in-digest
6132 @vindex gnus-uu-save-in-digest
6133 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
6134 decoding, will save in digests. If this variable is @code{nil},
6135 @code{gnus-uu} will just save everything in a file without any
6136 embellishments. The digesting almost conforms to RFC1153---no easy way
6137 to specify any meaningful volume and issue numbers were found, so I
6138 simply dropped them.
6143 @node Uuencoding and Posting
6144 @subsubsection Uuencoding and Posting
6148 @item gnus-uu-post-include-before-composing
6149 @vindex gnus-uu-post-include-before-composing
6150 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
6151 before you compose the article. If this variable is @code{t}, you can
6152 either include an encoded file with @kbd{C-c C-i} or have one included
6153 for you when you post the article.
6155 @item gnus-uu-post-length
6156 @vindex gnus-uu-post-length
6157 Maximum length of an article. The encoded file will be split into how
6158 many articles it takes to post the entire file.
6160 @item gnus-uu-post-threaded
6161 @vindex gnus-uu-post-threaded
6162 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
6163 thread. This may not be smart, as no other decoder I have seen is able
6164 to follow threads when collecting uuencoded articles. (Well, I have
6165 seen one package that does that---@code{gnus-uu}, but somehow, I don't
6166 think that counts...) Default is @code{nil}.
6168 @item gnus-uu-post-separate-description
6169 @vindex gnus-uu-post-separate-description
6170 Non-@code{nil} means that the description will be posted in a separate
6171 article. The first article will typically be numbered (0/x). If this
6172 variable is @code{nil}, the description the user enters will be included
6173 at the beginning of the first article, which will be numbered (1/x).
6174 Default is @code{t}.
6180 @subsection Viewing Files
6181 @cindex viewing files
6182 @cindex pseudo-articles
6184 After decoding, if the file is some sort of archive, Gnus will attempt
6185 to unpack the archive and see if any of the files in the archive can be
6186 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
6187 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
6188 uncompress and de-tar the main file, and then view the two pictures.
6189 This unpacking process is recursive, so if the archive contains archives
6190 of archives, it'll all be unpacked.
6192 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
6193 extracted file into the summary buffer. If you go to these
6194 ``articles'', you will be prompted for a command to run (usually Gnus
6195 will make a suggestion), and then the command will be run.
6197 @vindex gnus-view-pseudo-asynchronously
6198 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
6199 until the viewing is done before proceeding.
6201 @vindex gnus-view-pseudos
6202 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
6203 the pseudo-articles into the summary buffer, but view them
6204 immediately. If this variable is @code{not-confirm}, the user won't even
6205 be asked for a confirmation before viewing is done.
6207 @vindex gnus-view-pseudos-separately
6208 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
6209 pseudo-article will be created for each file to be viewed. If
6210 @code{nil}, all files that use the same viewing command will be given as
6211 a list of parameters to that command.
6213 @vindex gnus-insert-pseudo-articles
6214 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
6215 pseudo-articles when decoding. It is @code{t} by default.
6217 So; there you are, reading your @emph{pseudo-articles} in your
6218 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
6219 Why isn't anything real anymore? How did we get here?
6222 @node Article Treatment
6223 @section Article Treatment
6225 Reading through this huge manual, you may have quite forgotten that the
6226 object of newsreaders is to actually, like, read what people have
6227 written. Reading articles. Unfortunately, people are quite bad at
6228 writing, so there are tons of functions and variables to make reading
6229 these articles easier.
6232 * Article Highlighting:: You want to make the article look like fruit salad.
6233 * Article Fontisizing:: Making emphasized text look nice.
6234 * Article Hiding:: You also want to make certain info go away.
6235 * Article Washing:: Lots of way-neat functions to make life better.
6236 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
6237 * Article Date:: Grumble, UT!
6238 * Article Signature:: What is a signature?
6242 @node Article Highlighting
6243 @subsection Article Highlighting
6244 @cindex highlighting
6246 Not only do you want your article buffer to look like fruit salad, but
6247 you want it to look like technicolor fruit salad.
6252 @kindex W H a (Summary)
6253 @findex gnus-article-highlight
6254 @findex gnus-article-maybe-highlight
6255 Do much highlighting of the current article
6256 (@code{gnus-article-highlight}). This function highlights header, cited
6257 text, the signature, and adds buttons to the body and the head.
6260 @kindex W H h (Summary)
6261 @findex gnus-article-highlight-headers
6262 @vindex gnus-header-face-alist
6263 Highlight the headers (@code{gnus-article-highlight-headers}). The
6264 highlighting will be done according to the @code{gnus-header-face-alist}
6265 variable, which is a list where each element has the form @var{(regexp
6266 name content)}. @var{regexp} is a regular expression for matching the
6267 header, @var{name} is the face used for highlighting the header name
6268 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
6269 the header value. The first match made will be used. Note that
6270 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
6273 @kindex W H c (Summary)
6274 @findex gnus-article-highlight-citation
6275 Highlight cited text (@code{gnus-article-highlight-citation}).
6277 Some variables to customize the citation highlights:
6280 @vindex gnus-cite-parse-max-size
6282 @item gnus-cite-parse-max-size
6283 If the article size if bigger than this variable (which is 25000 by
6284 default), no citation highlighting will be performed.
6286 @item gnus-cite-prefix-regexp
6287 @vindex gnus-cite-prefix-regexp
6288 Regexp matching the longest possible citation prefix on a line.
6290 @item gnus-cite-max-prefix
6291 @vindex gnus-cite-max-prefix
6292 Maximum possible length for a citation prefix (default 20).
6294 @item gnus-cite-face-list
6295 @vindex gnus-cite-face-list
6296 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
6297 When there are citations from multiple articles in the same message,
6298 Gnus will try to give each citation from each article its own face.
6299 This should make it easier to see who wrote what.
6301 @item gnus-supercite-regexp
6302 @vindex gnus-supercite-regexp
6303 Regexp matching normal Supercite attribution lines.
6305 @item gnus-supercite-secondary-regexp
6306 @vindex gnus-supercite-secondary-regexp
6307 Regexp matching mangled Supercite attribution lines.
6309 @item gnus-cite-minimum-match-count
6310 @vindex gnus-cite-minimum-match-count
6311 Minimum number of identical prefixes we have to see before we believe
6312 that it's a citation.
6314 @item gnus-cite-attribution-prefix
6315 @vindex gnus-cite-attribution-prefix
6316 Regexp matching the beginning of an attribution line.
6318 @item gnus-cite-attribution-suffix
6319 @vindex gnus-cite-attribution-suffix
6320 Regexp matching the end of an attribution line.
6322 @item gnus-cite-attribution-face
6323 @vindex gnus-cite-attribution-face
6324 Face used for attribution lines. It is merged with the face for the
6325 cited text belonging to the attribution.
6331 @kindex W H s (Summary)
6332 @vindex gnus-signature-separator
6333 @vindex gnus-signature-face
6334 @findex gnus-article-highlight-signature
6335 Highlight the signature (@code{gnus-article-highlight-signature}).
6336 Everything after @code{gnus-signature-separator} (@pxref{Article
6337 Signature}) in an article will be considered a signature and will be
6338 highlighted with @code{gnus-signature-face}, which is @code{italic} by
6343 @xref{Customizing Articles} for how to highlight articles automatically.
6346 @node Article Fontisizing
6347 @subsection Article Fontisizing
6349 @cindex article emphasis
6351 @findex gnus-article-emphasize
6352 @kindex W e (Summary)
6353 People commonly add emphasis to words in news articles by writing things
6354 like @samp{_this_} or @samp{*this*}. Gnus can make this look nicer by
6355 running the article through the @kbd{W e}
6356 (@code{gnus-article-emphasize}) command.
6358 @vindex gnus-emphasis-alist
6359 How the emphasis is computed is controlled by the
6360 @code{gnus-emphasis-alist} variable. This is an alist where the first
6361 element is a regular expression to be matched. The second is a number
6362 that says what regular expression grouping is used to find the entire
6363 emphasized word. The third is a number that says what regexp grouping
6364 should be displayed and highlighted. (The text between these two
6365 groupings will be hidden.) The fourth is the face used for
6369 (setq gnus-article-emphasis
6370 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
6371 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
6374 @vindex gnus-emphasis-underline
6375 @vindex gnus-emphasis-bold
6376 @vindex gnus-emphasis-italic
6377 @vindex gnus-emphasis-underline-bold
6378 @vindex gnus-emphasis-underline-italic
6379 @vindex gnus-emphasis-bold-italic
6380 @vindex gnus-emphasis-underline-bold-italic
6381 By default, there are seven rules, and they use the following faces:
6382 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
6383 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
6384 @code{gnus-emphasis-underline-italic},
6385 @code{gnus-emphasis-underline-bold}, and
6386 @code{gnus-emphasis-underline-bold-italic}.
6388 If you want to change these faces, you can either use @kbd{M-x
6389 customize}, or you can use @code{copy-face}. For instance, if you want
6390 to make @code{gnus-emphasis-italic} use a red face instead, you could
6394 (copy-face 'red 'gnus-emphasis-italic)
6397 @xref{Customizing Articles} for how to fontize articles automatically.
6400 @node Article Hiding
6401 @subsection Article Hiding
6402 @cindex article hiding
6404 Or rather, hiding certain things in each article. There usually is much
6405 too much cruft in most articles.
6410 @kindex W W a (Summary)
6411 @findex gnus-article-hide
6412 Do quite a lot of hiding on the article buffer
6413 (@kbd{gnus-article-hide}). In particular, this function will hide
6414 headers, PGP, cited text and the signature.
6417 @kindex W W h (Summary)
6418 @findex gnus-article-hide-headers
6419 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
6423 @kindex W W b (Summary)
6424 @findex gnus-article-hide-boring-headers
6425 Hide headers that aren't particularly interesting
6426 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
6429 @kindex W W s (Summary)
6430 @findex gnus-article-hide-signature
6431 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
6435 @kindex W W p (Summary)
6436 @findex gnus-article-hide-pgp
6437 @vindex gnus-article-hide-pgp-hook
6438 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). The
6439 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
6440 signature has been hidden. For example, to automatically verify
6441 articles that have signatures in them do:
6443 ;;; Hide pgp cruft if any.
6445 (setq gnus-treat-strip-pgp t)
6447 ;;; After hiding pgp, verify the message;
6448 ;;; only happens if pgp signature is found.
6450 (add-hook 'gnus-article-hide-pgp-hook
6453 (set-buffer gnus-original-article-buffer)
6458 @kindex W W P (Summary)
6459 @findex gnus-article-hide-pem
6460 Hide @sc{pem} (privacy enhanced messages) cruft
6461 (@code{gnus-article-hide-pem}).
6464 @kindex W W c (Summary)
6465 @findex gnus-article-hide-citation
6466 Hide citation (@code{gnus-article-hide-citation}). Some variables for
6467 customizing the hiding:
6471 @item gnus-cited-opened-text-button-line-format
6472 @itemx gnus-cited-closed-text-button-line-format
6473 @vindex gnus-cited-closed-text-button-line-format
6474 @vindex gnus-cited-opened-text-button-line-format
6475 Gnus adds buttons to show where the cited text has been hidden, and to
6476 allow toggle hiding the text. The format of the variable is specified
6477 by these format-like variable (@pxref{Formatting Variables}). These
6482 Starting point of the hidden text.
6484 Ending point of the hidden text.
6486 Number of characters in the hidden region.
6488 Number of lines of hidden text.
6491 @item gnus-cited-lines-visible
6492 @vindex gnus-cited-lines-visible
6493 The number of lines at the beginning of the cited text to leave shown.
6498 @kindex W W C-c (Summary)
6499 @findex gnus-article-hide-citation-maybe
6501 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
6502 following two variables:
6505 @item gnus-cite-hide-percentage
6506 @vindex gnus-cite-hide-percentage
6507 If the cited text is of a bigger percentage than this variable (default
6508 50), hide the cited text.
6510 @item gnus-cite-hide-absolute
6511 @vindex gnus-cite-hide-absolute
6512 The cited text must have at least this length (default 10) before it
6517 @kindex W W C (Summary)
6518 @findex gnus-article-hide-citation-in-followups
6519 Hide cited text in articles that aren't roots
6520 (@code{gnus-article-hide-citation-in-followups}). This isn't very
6521 useful as an interactive command, but might be a handy function to stick
6522 have happen automatically (@pxref{Customizing Articles}).
6526 All these ``hiding'' commands are toggles, but if you give a negative
6527 prefix to these commands, they will show what they have previously
6528 hidden. If you give a positive prefix, they will always hide.
6530 Also @pxref{Article Highlighting} for further variables for
6531 citation customization.
6533 @xref{Customizing Articles} for how to hide article elements
6537 @node Article Washing
6538 @subsection Article Washing
6540 @cindex article washing
6542 We call this ``article washing'' for a really good reason. Namely, the
6543 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6545 @dfn{Washing} is defined by us as ``changing something from something to
6546 something else'', but normally results in something looking better.
6552 @kindex W l (Summary)
6553 @findex gnus-summary-stop-page-breaking
6554 Remove page breaks from the current article
6555 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article} for page
6559 @kindex W r (Summary)
6560 @findex gnus-summary-caesar-message
6561 @c @icon{gnus-summary-caesar-message}
6562 Do a Caesar rotate (rot13) on the article buffer
6563 (@code{gnus-summary-caesar-message}).
6564 Unreadable articles that tell you to read them with Caesar rotate or rot13.
6565 (Typically offensive jokes and such.)
6567 It's commonly called ``rot13'' because each letter is rotated 13
6568 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
6569 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
6570 is rumored to have employed this form of, uh, somewhat weak encryption.
6573 @kindex W t (Summary)
6574 @findex gnus-summary-toggle-header
6575 Toggle whether to display all headers in the article buffer
6576 (@code{gnus-summary-toggle-header}).
6579 @kindex W v (Summary)
6580 @findex gnus-summary-verbose-header
6581 Toggle whether to display all headers in the article buffer permanently
6582 (@code{gnus-summary-verbose-header}).
6585 @kindex W o (Summary)
6586 @findex gnus-article-treat-overstrike
6587 Treat overstrike (@code{gnus-article-treat-overstrike}).
6590 @kindex W d (Summary)
6591 @findex gnus-article-treat-dumbquotes
6592 @vindex gnus-article-dumbquotes-map
6594 @cindex M******** sm*rtq**t*s
6596 Treat M******** sm*rtq**t*s according to
6597 @code{gnus-article-dumbquotes-map}
6598 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
6599 whether a character is a sm*rtq**t* or not, so it should only be used
6603 @kindex W w (Summary)
6604 @findex gnus-article-fill-cited-article
6605 Do word wrap (@code{gnus-article-fill-cited-article}).
6607 You can give the command a numerical prefix to specify the width to use
6611 @kindex W c (Summary)
6612 @findex gnus-article-remove-cr
6613 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
6614 (this takes care of DOS line endings), and then translate any remaining
6615 CRs into LF (this takes care of Mac line endings)
6616 (@code{gnus-article-remove-cr}).
6619 @kindex W q (Summary)
6620 @findex gnus-article-de-quoted-unreadable
6621 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
6622 Quoted-Printable is one common @sc{mime} encoding employed when sending
6623 non-ASCII (i. e., 8-bit) articles. It typically makes strings like
6624 @samp{déjà vu} look like @samp{d=E9j=E0 vu}, which doesn't look very
6625 readable to me. Note that the this is usually done automatically by
6626 Gnus if the message in question has a @code{Content-Transfer-Encoding}
6627 header that says that this encoding has been done.
6630 @kindex W f (Summary)
6632 @findex gnus-article-display-x-face
6633 @findex gnus-article-x-face-command
6634 @vindex gnus-article-x-face-command
6635 @vindex gnus-article-x-face-too-ugly
6641 Look for and display any X-Face headers
6642 (@code{gnus-article-display-x-face}). The command executed by this
6643 function is given by the @code{gnus-article-x-face-command} variable.
6644 If this variable is a string, this string will be executed in a
6645 sub-shell. If it is a function, this function will be called with the
6646 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
6647 is a regexp) matches the @code{From} header, the face will not be shown.
6648 The default action under Emacs is to fork off an @code{xv} to view the
6649 face; under XEmacs the default action is to display the face before the
6650 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
6651 support---that will make display somewhat faster. If there's no native
6652 X-Face support, Gnus will try to convert the @code{X-Face} header using
6653 external programs from the @code{pbmplus} package and friends.) If you
6654 want to have this function in the display hook, it should probably come
6658 @kindex W b (Summary)
6659 @findex gnus-article-add-buttons
6660 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6661 @xref{Article Buttons}.
6664 @kindex W B (Summary)
6665 @findex gnus-article-add-buttons-to-head
6666 Add clickable buttons to the article headers
6667 (@code{gnus-article-add-buttons-to-head}).
6670 @kindex W E l (Summary)
6671 @findex gnus-article-strip-leading-blank-lines
6672 Remove all blank lines from the beginning of the article
6673 (@code{gnus-article-strip-leading-blank-lines}).
6676 @kindex W E m (Summary)
6677 @findex gnus-article-strip-multiple-blank-lines
6678 Replace all blank lines with empty lines and then all multiple empty
6679 lines with a single empty line.
6680 (@code{gnus-article-strip-multiple-blank-lines}).
6683 @kindex W E t (Summary)
6684 @findex gnus-article-remove-trailing-blank-lines
6685 Remove all blank lines at the end of the article
6686 (@code{gnus-article-remove-trailing-blank-lines}).
6689 @kindex W E a (Summary)
6690 @findex gnus-article-strip-blank-lines
6691 Do all the three commands above
6692 (@code{gnus-article-strip-blank-lines}).
6695 @kindex W E A (Summary)
6696 @findex gnus-article-strip-all-blank-lines
6697 Remove all blank lines
6698 (@code{gnus-article-strip-all-blank-lines}).
6701 @kindex W E s (Summary)
6702 @findex gnus-article-strip-leading-space
6703 Remove all white space from the beginning of all lines of the article
6704 body (@code{gnus-article-strip-leading-space}).
6707 @kindex W E e (Summary)
6708 @findex gnus-article-strip-trailing-space
6709 Remove all white space from the end of all lines of the article
6710 body (@code{gnus-article-strip-trailing-space}).
6714 @xref{Customizing Articles} for how to wash articles automatically.
6717 @node Article Buttons
6718 @subsection Article Buttons
6721 People often include references to other stuff in articles, and it would
6722 be nice if Gnus could just fetch whatever it is that people talk about
6723 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
6724 button on these references.
6726 Gnus adds @dfn{buttons} to certain standard references by default:
6727 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
6728 two variables, one that handles article bodies and one that handles
6733 @item gnus-button-alist
6734 @vindex gnus-button-alist
6735 This is an alist where each entry has this form:
6738 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6744 All text that match this regular expression will be considered an
6745 external reference. Here's a typical regexp that matches embedded URLs:
6746 @samp{<URL:\\([^\n\r>]*\\)>}.
6749 Gnus has to know which parts of the matches is to be highlighted. This
6750 is a number that says what sub-expression of the regexp is to be
6751 highlighted. If you want it all highlighted, you use 0 here.
6754 This form will be @code{eval}ed, and if the result is non-@code{nil},
6755 this is considered a match. This is useful if you want extra sifting to
6756 avoid false matches.
6759 This function will be called when you click on this button.
6762 As with @var{button-par}, this is a sub-expression number, but this one
6763 says which part of the match is to be sent as data to @var{function}.
6767 So the full entry for buttonizing URLs is then
6770 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6773 @item gnus-header-button-alist
6774 @vindex gnus-header-button-alist
6775 This is just like the other alist, except that it is applied to the
6776 article head only, and that each entry has an additional element that is
6777 used to say what headers to apply the buttonize coding to:
6780 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6783 @var{HEADER} is a regular expression.
6785 @item gnus-button-url-regexp
6786 @vindex gnus-button-url-regexp
6787 A regular expression that matches embedded URLs. It is used in the
6788 default values of the variables above.
6790 @item gnus-article-button-face
6791 @vindex gnus-article-button-face
6792 Face used on buttons.
6794 @item gnus-article-mouse-face
6795 @vindex gnus-article-mouse-face
6796 Face used when the mouse cursor is over a button.
6800 @xref{Customizing Articles} for how to buttonize articles automatically.
6804 @subsection Article Date
6806 The date is most likely generated in some obscure timezone you've never
6807 heard of, so it's quite nice to be able to find out what the time was
6808 when the article was sent.
6813 @kindex W T u (Summary)
6814 @findex gnus-article-date-ut
6815 Display the date in UT (aka. GMT, aka ZULU)
6816 (@code{gnus-article-date-ut}).
6819 @kindex W T i (Summary)
6820 @findex gnus-article-date-iso8601
6822 Display the date in international format, aka. ISO 8601
6823 (@code{gnus-article-date-iso8601}).
6826 @kindex W T l (Summary)
6827 @findex gnus-article-date-local
6828 Display the date in the local timezone (@code{gnus-article-date-local}).
6831 @kindex W T s (Summary)
6832 @vindex gnus-article-time-format
6833 @findex gnus-article-date-user
6834 @findex format-time-string
6835 Display the date using a user-defined format
6836 (@code{gnus-article-date-user}). The format is specified by the
6837 @code{gnus-article-time-format} variable, and is a string that's passed
6838 to @code{format-time-string}. See the documentation of that variable
6839 for a list of possible format specs.
6842 @kindex W T e (Summary)
6843 @findex gnus-article-date-lapsed
6844 @findex gnus-start-date-timer
6845 @findex gnus-stop-date-timer
6846 Say how much time has elapsed between the article was posted and now
6847 (@code{gnus-article-date-lapsed}). If you want to have this line
6848 updated continually, you can put
6851 (gnus-start-date-timer)
6854 in your @file{.gnus.el} file, or you can run it off of some hook. If
6855 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
6859 @kindex W T o (Summary)
6860 @findex gnus-article-date-original
6861 Display the original date (@code{gnus-article-date-original}). This can
6862 be useful if you normally use some other conversion function and are
6863 worried that it might be doing something totally wrong. Say, claiming
6864 that the article was posted in 1854. Although something like that is
6865 @emph{totally} impossible. Don't you trust me? *titter*
6869 @xref{Customizing Articles} for how to display the date in your
6870 preferred format automatically.
6873 @node Article Signature
6874 @subsection Article Signature
6876 @cindex article signature
6878 @vindex gnus-signature-separator
6879 Each article is divided into two parts---the head and the body. The
6880 body can be divided into a signature part and a text part. The variable
6881 that says what is to be considered a signature is
6882 @code{gnus-signature-separator}. This is normally the standard
6883 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
6884 non-standard signature separators, so this variable can also be a list
6885 of regular expressions to be tested, one by one. (Searches are done
6886 from the end of the body towards the beginning.) One likely value is:
6889 (setq gnus-signature-separator
6890 '("^-- $" ; The standard
6891 "^-- *$" ; A common mangling
6892 "^-------*$" ; Many people just use a looong
6893 ; line of dashes. Shame!
6894 "^ *--------*$" ; Double-shame!
6895 "^________*$" ; Underscores are also popular
6896 "^========*$")) ; Pervert!
6899 The more permissive you are, the more likely it is that you'll get false
6902 @vindex gnus-signature-limit
6903 @code{gnus-signature-limit} provides a limit to what is considered a
6908 If it is an integer, no signature may be longer (in characters) than
6911 If it is a floating point number, no signature may be longer (in lines)
6914 If it is a function, the function will be called without any parameters,
6915 and if it returns @code{nil}, there is no signature in the buffer.
6917 If it is a string, it will be used as a regexp. If it matches, the text
6918 in question is not a signature.
6921 This variable can also be a list where the elements may be of the types
6922 listed above. Here's an example:
6925 (setq gnus-signature-limit
6926 '(200.0 "^---*Forwarded article"))
6929 This means that if there are more than 200 lines after the signature
6930 separator, or the text after the signature separator is matched by
6931 the regular expression @samp{^---*Forwarded article}, then it isn't a
6932 signature after all.
6936 @section MIME Commands
6937 @cindex MIME decoding
6941 @kindex M-t (Summary)
6942 @findex gnus-summary-display-buttonized
6943 Toggle the buttonized display of the article buffer
6944 (@code{gnus-summary-toggle-display-buttonized}).
6947 @kindex W M w (Summary)
6948 Decode RFC2047-encoded words in the article headers
6949 (@code{gnus-article-decode-mime-words}).
6952 @kindex W M c (Summary)
6953 Decode encoded article bodies as well as charsets
6954 (@code{gnus-article-decode-charset}).
6956 This command looks in the @code{Content-Type} header to determine the
6957 charset. If there is no such header in the article, you can give it a
6958 prefix, which will prompt for the charset to decode as. In regional
6959 groups where people post using some common encoding (but do not include
6960 MIME headers), you can set the @code{charset} group/topic parameter to
6961 the required charset (@pxref{Group Parameters}).
6964 @kindex W M v (Summary)
6965 View all the @sc{mime} parts in the current article
6966 (@code{gnus-mime-view-all-parts}).
6973 @item gnus-ignored-mime-types
6974 @vindex gnus-ignored-mime-types
6975 This is a list of regexps. @sc{mime} types that match a regexp from
6976 this list will be completely ignored by Gnus. The default value is
6979 To have all Vcards be ignored, you'd say something like this:
6982 (setq gnus-ignored-mime-types
6986 @item gnus-unbuttonized-mime-types
6987 @vindex gnus-unbuttonized-mime-types
6988 This is a list of regexps. @sc{mime} types that match a regexp from
6989 this list won't have @sc{mime} buttons inserted unless they aren't
6990 displayed. The default value is @code{(".*/.*")}.
6992 @item gnus-article-mime-part-function
6993 @vindex gnus-article-mime-part-function
6994 For each @sc{mime} part, this function will be called with the @sc{mime}
6995 handle as the parameter. The function is meant to be used to allow
6996 users to gather information from the article (e. g., add Vcard info to
6997 the bbdb database) or to do actions based on parts (e. g., automatically
6998 save all jpegs into some directory).
7000 Here's an example function the does the latter:
7003 (defun my-save-all-jpeg-parts (handle)
7004 (when (equal (car (mm-handle-type handle)) "image/jpeg")
7006 (insert (mm-get-part handle))
7007 (write-region (point-min) (point-max)
7008 (read-file-name "Save jpeg to: ")))))
7009 (setq gnus-article-mime-part-function
7010 'my-save-all-jpeg-parts)
7016 @node Article Commands
7017 @section Article Commands
7024 @kindex A P (Summary)
7025 @vindex gnus-ps-print-hook
7026 @findex gnus-summary-print-article
7027 Generate and print a PostScript image of the article buffer
7028 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
7029 run just before printing the buffer.
7034 @node Summary Sorting
7035 @section Summary Sorting
7036 @cindex summary sorting
7038 You can have the summary buffer sorted in various ways, even though I
7039 can't really see why you'd want that.
7044 @kindex C-c C-s C-n (Summary)
7045 @findex gnus-summary-sort-by-number
7046 Sort by article number (@code{gnus-summary-sort-by-number}).
7049 @kindex C-c C-s C-a (Summary)
7050 @findex gnus-summary-sort-by-author
7051 Sort by author (@code{gnus-summary-sort-by-author}).
7054 @kindex C-c C-s C-s (Summary)
7055 @findex gnus-summary-sort-by-subject
7056 Sort by subject (@code{gnus-summary-sort-by-subject}).
7059 @kindex C-c C-s C-d (Summary)
7060 @findex gnus-summary-sort-by-date
7061 Sort by date (@code{gnus-summary-sort-by-date}).
7064 @kindex C-c C-s C-l (Summary)
7065 @findex gnus-summary-sort-by-lines
7066 Sort by lines (@code{gnus-summary-sort-by-lines}).
7069 @kindex C-c C-s C-i (Summary)
7070 @findex gnus-summary-sort-by-score
7071 Sort by score (@code{gnus-summary-sort-by-score}).
7074 These functions will work both when you use threading and when you don't
7075 use threading. In the latter case, all summary lines will be sorted,
7076 line by line. In the former case, sorting will be done on a
7077 root-by-root basis, which might not be what you were looking for. To
7078 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
7082 @node Finding the Parent
7083 @section Finding the Parent
7084 @cindex parent articles
7085 @cindex referring articles
7090 @findex gnus-summary-refer-parent-article
7091 If you'd like to read the parent of the current article, and it is not
7092 displayed in the summary buffer, you might still be able to. That is,
7093 if the current group is fetched by @sc{nntp}, the parent hasn't expired
7094 and the @code{References} in the current article are not mangled, you
7095 can just press @kbd{^} or @kbd{A r}
7096 (@code{gnus-summary-refer-parent-article}). If everything goes well,
7097 you'll get the parent. If the parent is already displayed in the
7098 summary buffer, point will just move to this article.
7100 If given a positive numerical prefix, fetch that many articles back into
7101 the ancestry. If given a negative numerical prefix, fetch just that
7102 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
7103 grandparent and the grandgrandparent of the current article. If you say
7104 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
7108 @findex gnus-summary-refer-references
7109 @kindex A R (Summary)
7110 Fetch all articles mentioned in the @code{References} header of the
7111 article (@code{gnus-summary-refer-references}).
7114 @findex gnus-summary-refer-thread
7115 @kindex A T (Summary)
7116 Display the full thread where the current article appears
7117 (@code{gnus-summary-refer-thread}). This command has to fetch all the
7118 headers in the current group to work, so it usually takes a while. If
7119 you do it often, you may consider setting @code{gnus-fetch-old-headers}
7120 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
7121 visible effects normally, but it'll make this command work a whole lot
7122 faster. Of course, it'll make group entry somewhat slow.
7124 @vindex gnus-refer-thread-limit
7125 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
7126 articles before the first displayed in the current group) headers to
7127 fetch when doing this command. The default is 200. If @code{t}, all
7128 the available headers will be fetched. This variable can be overridden
7129 by giving the @kbd{A T} command a numerical prefix.
7132 @findex gnus-summary-refer-article
7133 @kindex M-^ (Summary)
7135 @cindex fetching by Message-ID
7136 You can also ask the @sc{nntp} server for an arbitrary article, no
7137 matter what group it belongs to. @kbd{M-^}
7138 (@code{gnus-summary-refer-article}) will ask you for a
7139 @code{Message-ID}, which is one of those long, hard-to-read thingies
7140 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
7141 have to get it all exactly right. No fuzzy searches, I'm afraid.
7144 The current select method will be used when fetching by
7145 @code{Message-ID} from non-news select method, but you can override this
7146 by giving this command a prefix.
7148 @vindex gnus-refer-article-method
7149 If the group you are reading is located on a backend that does not
7150 support fetching by @code{Message-ID} very well (like @code{nnspool}),
7151 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
7152 would, perhaps, be best if the @sc{nntp} server you consult is the one
7153 updating the spool you are reading from, but that's not really
7156 Most of the mail backends support fetching by @code{Message-ID}, but do
7157 not do a particularly excellent job at it. That is, @code{nnmbox} and
7158 @code{nnbabyl} are able to locate articles from any groups, while
7159 @code{nnml} and @code{nnfolder} are only able to locate articles that
7160 have been posted to the current group. (Anything else would be too time
7161 consuming.) @code{nnmh} does not support this at all.
7164 @node Alternative Approaches
7165 @section Alternative Approaches
7167 Different people like to read news using different methods. This being
7168 Gnus, we offer a small selection of minor modes for the summary buffers.
7171 * Pick and Read:: First mark articles and then read them.
7172 * Binary Groups:: Auto-decode all articles.
7177 @subsection Pick and Read
7178 @cindex pick and read
7180 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
7181 a two-phased reading interface. The user first marks in a summary
7182 buffer the articles she wants to read. Then she starts reading the
7183 articles with just an article buffer displayed.
7185 @findex gnus-pick-mode
7186 @kindex M-x gnus-pick-mode
7187 Gnus provides a summary buffer minor mode that allows
7188 this---@code{gnus-pick-mode}. This basically means that a few process
7189 mark commands become one-keystroke commands to allow easy marking, and
7190 it provides one additional command for switching to the summary buffer.
7192 Here are the available keystrokes when using pick mode:
7197 @findex gnus-pick-article-or-thread
7198 Pick the article or thread on the current line
7199 (@code{gnus-pick-article-or-thread}). If the variable
7200 @code{gnus-thread-hide-subtree} is true, then this key selects the
7201 entire thread when used at the first article of the thread. Otherwise,
7202 it selects just the article. If given a numerical prefix, go to that
7203 thread or article and pick it. (The line number is normally displayed
7204 at the beginning of the summary pick lines.)
7207 @kindex SPACE (Pick)
7208 @findex gnus-pick-next-page
7209 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
7210 at the end of the buffer, start reading the picked articles.
7214 @findex gnus-pick-unmark-article-or-thread.
7215 Unpick the thread or article
7216 (@code{gnus-pick-unmark-article-or-thread}). If the variable
7217 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
7218 thread if used at the first article of the thread. Otherwise it unpicks
7219 just the article. You can give this key a numerical prefix to unpick
7220 the thread or article at that line.
7224 @findex gnus-pick-start-reading
7225 @vindex gnus-pick-display-summary
7226 Start reading the picked articles (@code{gnus-pick-start-reading}). If
7227 given a prefix, mark all unpicked articles as read first. If
7228 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
7229 will still be visible when you are reading.
7233 All the normal summary mode commands are still available in the
7234 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
7235 which is mapped to the same function
7236 @code{gnus-summary-tick-article-forward}.
7238 If this sounds like a good idea to you, you could say:
7241 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
7244 @vindex gnus-pick-mode-hook
7245 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
7247 @vindex gnus-mark-unpicked-articles-as-read
7248 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
7249 all unpicked articles as read. The default is @code{nil}.
7251 @vindex gnus-summary-pick-line-format
7252 The summary line format in pick mode is slightly different from the
7253 standard format. At the beginning of each line the line number is
7254 displayed. The pick mode line format is controlled by the
7255 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
7256 Variables}). It accepts the same format specs that
7257 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
7261 @subsection Binary Groups
7262 @cindex binary groups
7264 @findex gnus-binary-mode
7265 @kindex M-x gnus-binary-mode
7266 If you spend much time in binary groups, you may grow tired of hitting
7267 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
7268 is a minor mode for summary buffers that makes all ordinary Gnus article
7269 selection functions uudecode series of articles and display the result
7270 instead of just displaying the articles the normal way.
7273 @findex gnus-binary-show-article
7274 The only way, in fact, to see the actual articles is the @kbd{g}
7275 command, when you have turned on this mode
7276 (@code{gnus-binary-show-article}).
7278 @vindex gnus-binary-mode-hook
7279 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
7283 @section Tree Display
7286 @vindex gnus-use-trees
7287 If you don't like the normal Gnus summary display, you might try setting
7288 @code{gnus-use-trees} to @code{t}. This will create (by default) an
7289 additional @dfn{tree buffer}. You can execute all summary mode commands
7292 There are a few variables to customize the tree display, of course:
7295 @item gnus-tree-mode-hook
7296 @vindex gnus-tree-mode-hook
7297 A hook called in all tree mode buffers.
7299 @item gnus-tree-mode-line-format
7300 @vindex gnus-tree-mode-line-format
7301 A format string for the mode bar in the tree mode buffers (@pxref{Mode
7302 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
7303 of valid specs, @pxref{Summary Buffer Mode Line}.
7305 @item gnus-selected-tree-face
7306 @vindex gnus-selected-tree-face
7307 Face used for highlighting the selected article in the tree buffer. The
7308 default is @code{modeline}.
7310 @item gnus-tree-line-format
7311 @vindex gnus-tree-line-format
7312 A format string for the tree nodes. The name is a bit of a misnomer,
7313 though---it doesn't define a line, but just the node. The default value
7314 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
7315 the name of the poster. It is vital that all nodes are of the same
7316 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
7322 The name of the poster.
7324 The @code{From} header.
7326 The number of the article.
7328 The opening bracket.
7330 The closing bracket.
7335 @xref{Formatting Variables}.
7337 Variables related to the display are:
7340 @item gnus-tree-brackets
7341 @vindex gnus-tree-brackets
7342 This is used for differentiating between ``real'' articles and
7343 ``sparse'' articles. The format is @var{((real-open . real-close)
7344 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
7345 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
7347 @item gnus-tree-parent-child-edges
7348 @vindex gnus-tree-parent-child-edges
7349 This is a list that contains the characters used for connecting parent
7350 nodes to their children. The default is @code{(?- ?\\ ?|)}.
7354 @item gnus-tree-minimize-window
7355 @vindex gnus-tree-minimize-window
7356 If this variable is non-@code{nil}, Gnus will try to keep the tree
7357 buffer as small as possible to allow more room for the other Gnus
7358 windows. If this variable is a number, the tree buffer will never be
7359 higher than that number. The default is @code{t}. Note that if you
7360 have several windows displayed side-by-side in a frame and the tree
7361 buffer is one of these, minimizing the tree window will also resize all
7362 other windows displayed next to it.
7364 @item gnus-generate-tree-function
7365 @vindex gnus-generate-tree-function
7366 @findex gnus-generate-horizontal-tree
7367 @findex gnus-generate-vertical-tree
7368 The function that actually generates the thread tree. Two predefined
7369 functions are available: @code{gnus-generate-horizontal-tree} and
7370 @code{gnus-generate-vertical-tree} (which is the default).
7374 Here's an example from a horizontal tree buffer:
7377 @{***@}-(***)-[odd]-[Gun]
7387 Here's the same thread displayed in a vertical tree buffer:
7391 |--------------------------\-----\-----\
7392 (***) [Bjo] [Gun] [Gun]
7394 [odd] [Jan] [odd] (***) [Jor]
7396 [Gun] [Eri] [Eri] [odd]
7401 If you're using horizontal trees, it might be nice to display the trees
7402 side-by-side with the summary buffer. You could add something like the
7403 following to your @file{.gnus.el} file:
7406 (setq gnus-use-trees t
7407 gnus-generate-tree-function 'gnus-generate-horizontal-tree
7408 gnus-tree-minimize-window nil)
7409 (gnus-add-configuration
7413 (summary 0.75 point)
7418 @xref{Windows Configuration}.
7421 @node Mail Group Commands
7422 @section Mail Group Commands
7423 @cindex mail group commands
7425 Some commands only make sense in mail groups. If these commands are
7426 invalid in the current group, they will raise a hell and let you know.
7428 All these commands (except the expiry and edit commands) use the
7429 process/prefix convention (@pxref{Process/Prefix}).
7434 @kindex B e (Summary)
7435 @findex gnus-summary-expire-articles
7436 Expire all expirable articles in the group
7437 (@code{gnus-summary-expire-articles}).
7440 @kindex B M-C-e (Summary)
7441 @findex gnus-summary-expire-articles-now
7442 Delete all the expirable articles in the group
7443 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
7444 articles eligible for expiry in the current group will
7445 disappear forever into that big @file{/dev/null} in the sky.
7448 @kindex B DEL (Summary)
7449 @findex gnus-summary-delete-article
7450 @c @icon{gnus-summary-mail-delete}
7451 Delete the mail article. This is ``delete'' as in ``delete it from your
7452 disk forever and ever, never to return again.'' Use with caution.
7453 (@code{gnus-summary-delete-article}).
7456 @kindex B m (Summary)
7458 @findex gnus-summary-move-article
7459 Move the article from one mail group to another
7460 (@code{gnus-summary-move-article}).
7463 @kindex B c (Summary)
7465 @findex gnus-summary-copy-article
7466 @c @icon{gnus-summary-mail-copy}
7467 Copy the article from one group (mail group or not) to a mail group
7468 (@code{gnus-summary-copy-article}).
7471 @kindex B B (Summary)
7472 @cindex crosspost mail
7473 @findex gnus-summary-crosspost-article
7474 Crosspost the current article to some other group
7475 (@code{gnus-summary-crosspost-article}). This will create a new copy of
7476 the article in the other group, and the Xref headers of the article will
7477 be properly updated.
7480 @kindex B i (Summary)
7481 @findex gnus-summary-import-article
7482 Import an arbitrary file into the current mail newsgroup
7483 (@code{gnus-summary-import-article}). You will be prompted for a file
7484 name, a @code{From} header and a @code{Subject} header.
7487 @kindex B r (Summary)
7488 @findex gnus-summary-respool-article
7489 Respool the mail article (@code{gnus-summary-respool-article}).
7490 @code{gnus-summary-respool-default-method} will be used as the default
7491 select method when respooling. This variable is @code{nil} by default,
7492 which means that the current group select method will be used instead.
7496 @kindex B w (Summary)
7498 @findex gnus-summary-edit-article
7499 @kindex C-c C-c (Article)
7500 Edit the current article (@code{gnus-summary-edit-article}). To finish
7501 editing and make the changes permanent, type @kbd{C-c C-c}
7502 (@kbd{gnus-summary-edit-article-done}). If you give a prefix to the
7503 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
7506 @kindex B q (Summary)
7507 @findex gnus-summary-respool-query
7508 If you want to re-spool an article, you might be curious as to what group
7509 the article will end up in before you do the re-spooling. This command
7510 will tell you (@code{gnus-summary-respool-query}).
7513 @kindex B t (Summary)
7514 @findex gnus-summary-respool-trace
7515 Similarly, this command will display all fancy splitting patterns used
7516 when repooling, if any (@code{gnus-summary-respool-trace}).
7519 @kindex B p (Summary)
7520 @findex gnus-summary-article-posted-p
7521 Some people have a tendency to send you "courtesy" copies when they
7522 follow up to articles you have posted. These usually have a
7523 @code{Newsgroups} header in them, but not always. This command
7524 (@code{gnus-summary-article-posted-p}) will try to fetch the current
7525 article from your news server (or rather, from
7526 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
7527 report back whether it found the article or not. Even if it says that
7528 it didn't find the article, it may have been posted anyway---mail
7529 propagation is much faster than news propagation, and the news copy may
7530 just not have arrived yet.
7534 @vindex gnus-move-split-methods
7535 @cindex moving articles
7536 If you move (or copy) articles regularly, you might wish to have Gnus
7537 suggest where to put the articles. @code{gnus-move-split-methods} is a
7538 variable that uses the same syntax as @code{gnus-split-methods}
7539 (@pxref{Saving Articles}). You may customize that variable to create
7540 suggestions you find reasonable.
7543 (setq gnus-move-split-methods
7544 '(("^From:.*Lars Magne" "nnml:junk")
7545 ("^Subject:.*gnus" "nnfolder:important")
7546 (".*" "nnml:misc")))
7550 @node Various Summary Stuff
7551 @section Various Summary Stuff
7554 * Summary Group Information:: Information oriented commands.
7555 * Searching for Articles:: Multiple article commands.
7556 * Summary Generation Commands:: (Re)generating the summary buffer.
7557 * Really Various Summary Commands:: Those pesky non-conformant commands.
7561 @vindex gnus-summary-mode-hook
7562 @item gnus-summary-mode-hook
7563 This hook is called when creating a summary mode buffer.
7565 @vindex gnus-summary-generate-hook
7566 @item gnus-summary-generate-hook
7567 This is called as the last thing before doing the threading and the
7568 generation of the summary buffer. It's quite convenient for customizing
7569 the threading variables based on what data the newsgroup has. This hook
7570 is called from the summary buffer after most summary buffer variables
7573 @vindex gnus-summary-prepare-hook
7574 @item gnus-summary-prepare-hook
7575 It is called after the summary buffer has been generated. You might use
7576 it to, for instance, highlight lines or modify the look of the buffer in
7577 some other ungodly manner. I don't care.
7579 @vindex gnus-summary-prepared-hook
7580 @item gnus-summary-prepared-hook
7581 A hook called as the very last thing after the summary buffer has been
7584 @vindex gnus-summary-ignore-duplicates
7585 @item gnus-summary-ignore-duplicates
7586 When Gnus discovers two articles that have the same @code{Message-ID},
7587 it has to do something drastic. No articles are allowed to have the
7588 same @code{Message-ID}, but this may happen when reading mail from some
7589 sources. Gnus allows you to customize what happens with this variable.
7590 If it is @code{nil} (which is the default), Gnus will rename the
7591 @code{Message-ID} (for display purposes only) and display the article as
7592 any other article. If this variable is @code{t}, it won't display the
7593 article---it'll be as if it never existed.
7598 @node Summary Group Information
7599 @subsection Summary Group Information
7604 @kindex H f (Summary)
7605 @findex gnus-summary-fetch-faq
7606 @vindex gnus-group-faq-directory
7607 Try to fetch the FAQ (list of frequently asked questions) for the
7608 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
7609 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
7610 on a remote machine. This variable can also be a list of directories.
7611 In that case, giving a prefix to this command will allow you to choose
7612 between the various sites. @code{ange-ftp} or @code{efs} will probably
7613 be used for fetching the file.
7616 @kindex H d (Summary)
7617 @findex gnus-summary-describe-group
7618 Give a brief description of the current group
7619 (@code{gnus-summary-describe-group}). If given a prefix, force
7620 rereading the description from the server.
7623 @kindex H h (Summary)
7624 @findex gnus-summary-describe-briefly
7625 Give an extremely brief description of the most important summary
7626 keystrokes (@code{gnus-summary-describe-briefly}).
7629 @kindex H i (Summary)
7630 @findex gnus-info-find-node
7631 Go to the Gnus info node (@code{gnus-info-find-node}).
7635 @node Searching for Articles
7636 @subsection Searching for Articles
7641 @kindex M-s (Summary)
7642 @findex gnus-summary-search-article-forward
7643 Search through all subsequent articles for a regexp
7644 (@code{gnus-summary-search-article-forward}).
7647 @kindex M-r (Summary)
7648 @findex gnus-summary-search-article-backward
7649 Search through all previous articles for a regexp
7650 (@code{gnus-summary-search-article-backward}).
7654 @findex gnus-summary-execute-command
7655 This command will prompt you for a header field, a regular expression to
7656 match on this field, and a command to be executed if the match is made
7657 (@code{gnus-summary-execute-command}). If given a prefix, search
7661 @kindex M-& (Summary)
7662 @findex gnus-summary-universal-argument
7663 Perform any operation on all articles that have been marked with
7664 the process mark (@code{gnus-summary-universal-argument}).
7667 @node Summary Generation Commands
7668 @subsection Summary Generation Commands
7673 @kindex Y g (Summary)
7674 @findex gnus-summary-prepare
7675 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7678 @kindex Y c (Summary)
7679 @findex gnus-summary-insert-cached-articles
7680 Pull all cached articles (for the current group) into the summary buffer
7681 (@code{gnus-summary-insert-cached-articles}).
7686 @node Really Various Summary Commands
7687 @subsection Really Various Summary Commands
7692 @kindex C-d (Summary)
7693 @findex gnus-summary-enter-digest-group
7694 If the current article is a collection of other articles (for instance,
7695 a digest), you might use this command to enter a group based on the that
7696 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
7697 guess what article type is currently displayed unless you give a prefix
7698 to this command, which forces a ``digest'' interpretation. Basically,
7699 whenever you see a message that is a collection of other messages of
7700 some format, you @kbd{C-d} and read these messages in a more convenient
7704 @kindex M-C-d (Summary)
7705 @findex gnus-summary-read-document
7706 This command is very similar to the one above, but lets you gather
7707 several documents into one biiig group
7708 (@code{gnus-summary-read-document}). It does this by opening several
7709 @code{nndoc} groups for each document, and then opening an
7710 @code{nnvirtual} group on top of these @code{nndoc} groups. This
7711 command understands the process/prefix convention
7712 (@pxref{Process/Prefix}).
7715 @kindex C-t (Summary)
7716 @findex gnus-summary-toggle-truncation
7717 Toggle truncation of summary lines
7718 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
7719 line centering function in the summary buffer, so it's not a good idea
7720 to have truncation switched off while reading articles.
7724 @findex gnus-summary-expand-window
7725 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7726 If given a prefix, force an @code{article} window configuration.
7729 @kindex M-C-e (Summary)
7730 @findex gnus-summary-edit-parameters
7731 Edit the group parameters (@pxref{Group Parameters}) of the current
7732 group (@code{gnus-summary-edit-parameters}).
7735 @kindex M-C-g (Summary)
7736 @findex gnus-summary-customize-parameters
7737 Customize the group parameters (@pxref{Group Parameters}) of the current
7738 group (@code{gnus-summary-customize-parameters}).
7743 @node Exiting the Summary Buffer
7744 @section Exiting the Summary Buffer
7745 @cindex summary exit
7746 @cindex exiting groups
7748 Exiting from the summary buffer will normally update all info on the
7749 group and return you to the group buffer.
7755 @kindex Z Z (Summary)
7757 @findex gnus-summary-exit
7758 @vindex gnus-summary-exit-hook
7759 @vindex gnus-summary-prepare-exit-hook
7760 @c @icon{gnus-summary-exit}
7761 Exit the current group and update all information on the group
7762 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7763 called before doing much of the exiting, which calls
7764 @code{gnus-summary-expire-articles} by default.
7765 @code{gnus-summary-exit-hook} is called after finishing the exit
7766 process. @code{gnus-group-no-more-groups-hook} is run when returning to
7767 group mode having no more (unread) groups.
7771 @kindex Z E (Summary)
7773 @findex gnus-summary-exit-no-update
7774 Exit the current group without updating any information on the group
7775 (@code{gnus-summary-exit-no-update}).
7779 @kindex Z c (Summary)
7781 @findex gnus-summary-catchup-and-exit
7782 @c @icon{gnus-summary-catchup-and-exit}
7783 Mark all unticked articles in the group as read and then exit
7784 (@code{gnus-summary-catchup-and-exit}).
7787 @kindex Z C (Summary)
7788 @findex gnus-summary-catchup-all-and-exit
7789 Mark all articles, even the ticked ones, as read and then exit
7790 (@code{gnus-summary-catchup-all-and-exit}).
7793 @kindex Z n (Summary)
7794 @findex gnus-summary-catchup-and-goto-next-group
7795 Mark all articles as read and go to the next group
7796 (@code{gnus-summary-catchup-and-goto-next-group}).
7799 @kindex Z R (Summary)
7800 @findex gnus-summary-reselect-current-group
7801 Exit this group, and then enter it again
7802 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
7803 all articles, both read and unread.
7807 @kindex Z G (Summary)
7808 @kindex M-g (Summary)
7809 @findex gnus-summary-rescan-group
7810 @c @icon{gnus-summary-mail-get}
7811 Exit the group, check for new articles in the group, and select the
7812 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
7813 articles, both read and unread.
7816 @kindex Z N (Summary)
7817 @findex gnus-summary-next-group
7818 Exit the group and go to the next group
7819 (@code{gnus-summary-next-group}).
7822 @kindex Z P (Summary)
7823 @findex gnus-summary-prev-group
7824 Exit the group and go to the previous group
7825 (@code{gnus-summary-prev-group}).
7828 @kindex Z s (Summary)
7829 @findex gnus-summary-save-newsrc
7830 Save the current number of read/marked articles in the dribble buffer
7831 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
7832 given a prefix, also save the @file{.newsrc} file(s). Using this
7833 command will make exit without updating (the @kbd{Q} command) worthless.
7836 @vindex gnus-exit-group-hook
7837 @code{gnus-exit-group-hook} is called when you exit the current
7840 @findex gnus-summary-wake-up-the-dead
7841 @findex gnus-dead-summary-mode
7842 @vindex gnus-kill-summary-on-exit
7843 If you're in the habit of exiting groups, and then changing your mind
7844 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
7845 If you do that, Gnus won't kill the summary buffer when you exit it.
7846 (Quelle surprise!) Instead it will change the name of the buffer to
7847 something like @samp{*Dead Summary ... *} and install a minor mode
7848 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
7849 buffer, you'll find that all keys are mapped to a function called
7850 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
7851 summary buffer will result in a live, normal summary buffer.
7853 There will never be more than one dead summary buffer at any one time.
7855 @vindex gnus-use-cross-reference
7856 The data on the current group will be updated (which articles you have
7857 read, which articles you have replied to, etc.) when you exit the
7858 summary buffer. If the @code{gnus-use-cross-reference} variable is
7859 @code{t} (which is the default), articles that are cross-referenced to
7860 this group and are marked as read, will also be marked as read in the
7861 other subscribed groups they were cross-posted to. If this variable is
7862 neither @code{nil} nor @code{t}, the article will be marked as read in
7863 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7866 @node Crosspost Handling
7867 @section Crosspost Handling
7871 Marking cross-posted articles as read ensures that you'll never have to
7872 read the same article more than once. Unless, of course, somebody has
7873 posted it to several groups separately. Posting the same article to
7874 several groups (not cross-posting) is called @dfn{spamming}, and you are
7875 by law required to send nasty-grams to anyone who perpetrates such a
7876 heinous crime. You may want to try NoCeM handling to filter out spam
7879 Remember: Cross-posting is kinda ok, but posting the same article
7880 separately to several groups is not. Massive cross-posting (aka.
7881 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7882 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7883 excessive crossposting (@pxref{Summary Mail Commands}).
7885 @cindex cross-posting
7888 One thing that may cause Gnus to not do the cross-posting thing
7889 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7890 (which is very nice, because it speeds things up considerably) which
7891 does not include the @code{Xref} header in its @sc{nov} lines. This is
7892 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
7893 even with @sc{xover} by registering the @code{Xref} lines of all
7894 articles you actually read, but if you kill the articles, or just mark
7895 them as read without reading them, Gnus will not get a chance to snoop
7896 the @code{Xref} lines out of these articles, and will be unable to use
7897 the cross reference mechanism.
7899 @cindex LIST overview.fmt
7900 @cindex overview.fmt
7901 To check whether your @sc{nntp} server includes the @code{Xref} header
7902 in its overview files, try @samp{telnet your.nntp.server nntp},
7903 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7904 overview.fmt}. This may not work, but if it does, and the last line you
7905 get does not read @samp{Xref:full}, then you should shout and whine at
7906 your news admin until she includes the @code{Xref} header in the
7909 @vindex gnus-nov-is-evil
7910 If you want Gnus to get the @code{Xref}s right all the time, you have to
7911 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7916 For an alternative approach, @pxref{Duplicate Suppression}.
7919 @node Duplicate Suppression
7920 @section Duplicate Suppression
7922 By default, Gnus tries to make sure that you don't have to read the same
7923 article more than once by utilizing the crossposting mechanism
7924 (@pxref{Crosspost Handling}). However, that simple and efficient
7925 approach may not work satisfactory for some users for various
7930 The @sc{nntp} server may fail to generate the @code{Xref} header. This
7931 is evil and not very common.
7934 The @sc{nntp} server may fail to include the @code{Xref} header in the
7935 @file{.overview} data bases. This is evil and all too common, alas.
7938 You may be reading the same group (or several related groups) from
7939 different @sc{nntp} servers.
7942 You may be getting mail that duplicates articles posted to groups.
7945 I'm sure there are other situations where @code{Xref} handling fails as
7946 well, but these four are the most common situations.
7948 If, and only if, @code{Xref} handling fails for you, then you may
7949 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
7950 will remember the @code{Message-ID}s of all articles you have read or
7951 otherwise marked as read, and then, as if by magic, mark them as read
7952 all subsequent times you see them---in @emph{all} groups. Using this
7953 mechanism is quite likely to be somewhat inefficient, but not overly
7954 so. It's certainly preferable to reading the same articles more than
7957 Duplicate suppression is not a very subtle instrument. It's more like a
7958 sledge hammer than anything else. It works in a very simple
7959 fashion---if you have marked an article as read, it adds this Message-ID
7960 to a cache. The next time it sees this Message-ID, it will mark the
7961 article as read with the @samp{M} mark. It doesn't care what group it
7965 @item gnus-suppress-duplicates
7966 @vindex gnus-suppress-duplicates
7967 If non-@code{nil}, suppress duplicates.
7969 @item gnus-save-duplicate-list
7970 @vindex gnus-save-duplicate-list
7971 If non-@code{nil}, save the list of duplicates to a file. This will
7972 make startup and shutdown take longer, so the default is @code{nil}.
7973 However, this means that only duplicate articles read in a single Gnus
7974 session are suppressed.
7976 @item gnus-duplicate-list-length
7977 @vindex gnus-duplicate-list-length
7978 This variable says how many @code{Message-ID}s to keep in the duplicate
7979 suppression list. The default is 10000.
7981 @item gnus-duplicate-file
7982 @vindex gnus-duplicate-file
7983 The name of the file to store the duplicate suppression list in. The
7984 default is @file{~/News/suppression}.
7987 If you have a tendency to stop and start Gnus often, setting
7988 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
7989 you leave Gnus running for weeks on end, you may have it @code{nil}. On
7990 the other hand, saving the list makes startup and shutdown much slower,
7991 so that means that if you stop and start Gnus often, you should set
7992 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
7993 to you to figure out, I think.
7996 @node The Article Buffer
7997 @chapter The Article Buffer
7998 @cindex article buffer
8000 The articles are displayed in the article buffer, of which there is only
8001 one. All the summary buffers share the same article buffer unless you
8002 tell Gnus otherwise.
8005 * Hiding Headers:: Deciding what headers should be displayed.
8006 * Using MIME:: Pushing articles through @sc{mime} before reading them.
8007 * Customizing Articles:: Tailoring the look of the articles.
8008 * Article Keymap:: Keystrokes available in the article buffer.
8009 * Misc Article:: Other stuff.
8013 @node Hiding Headers
8014 @section Hiding Headers
8015 @cindex hiding headers
8016 @cindex deleting headers
8018 The top section of each article is the @dfn{head}. (The rest is the
8019 @dfn{body}, but you may have guessed that already.)
8021 @vindex gnus-show-all-headers
8022 There is a lot of useful information in the head: the name of the person
8023 who wrote the article, the date it was written and the subject of the
8024 article. That's well and nice, but there's also lots of information
8025 most people do not want to see---what systems the article has passed
8026 through before reaching you, the @code{Message-ID}, the
8027 @code{References}, etc. ad nauseum---and you'll probably want to get rid
8028 of some of those lines. If you want to keep all those lines in the
8029 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
8031 Gnus provides you with two variables for sifting headers:
8035 @item gnus-visible-headers
8036 @vindex gnus-visible-headers
8037 If this variable is non-@code{nil}, it should be a regular expression
8038 that says what headers you wish to keep in the article buffer. All
8039 headers that do not match this variable will be hidden.
8041 For instance, if you only want to see the name of the person who wrote
8042 the article and the subject, you'd say:
8045 (setq gnus-visible-headers "^From:\\|^Subject:")
8048 This variable can also be a list of regexps to match headers to
8051 @item gnus-ignored-headers
8052 @vindex gnus-ignored-headers
8053 This variable is the reverse of @code{gnus-visible-headers}. If this
8054 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
8055 should be a regular expression that matches all lines that you want to
8056 hide. All lines that do not match this variable will remain visible.
8058 For instance, if you just want to get rid of the @code{References} line
8059 and the @code{Xref} line, you might say:
8062 (setq gnus-ignored-headers "^References:\\|^Xref:")
8065 This variable can also be a list of regexps to match headers to
8068 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
8069 variable will have no effect.
8073 @vindex gnus-sorted-header-list
8074 Gnus can also sort the headers for you. (It does this by default.) You
8075 can control the sorting by setting the @code{gnus-sorted-header-list}
8076 variable. It is a list of regular expressions that says in what order
8077 the headers are to be displayed.
8079 For instance, if you want the name of the author of the article first,
8080 and then the subject, you might say something like:
8083 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
8086 Any headers that are to remain visible, but are not listed in this
8087 variable, will be displayed in random order after all the headers listed in this variable.
8089 @findex gnus-article-hide-boring-headers
8090 @vindex gnus-boring-article-headers
8091 You can hide further boring headers by setting
8092 @code{gnus-treat-hide-boring-header} to @code{head}. What this function
8093 does depends on the @code{gnus-boring-article-headers} variable. It's a
8094 list, but this list doesn't actually contain header names. Instead is
8095 lists various @dfn{boring conditions} that Gnus can check and remove
8098 These conditions are:
8101 Remove all empty headers.
8103 Remove the @code{Followup-To} header if it is identical to the
8104 @code{Newsgroups} header.
8106 Remove the @code{Reply-To} header if it lists the same address as the
8109 Remove the @code{Newsgroups} header if it only contains the current group
8112 Remove the @code{Date} header if the article is less than three days
8115 Remove the @code{To} header if it is very long.
8117 Remove all @code{To} headers if there are more than one.
8120 To include the four three elements, you could say something like;
8123 (setq gnus-boring-article-headers
8124 '(empty followup-to reply-to))
8127 This is also the default value for this variable.
8131 @section Using @sc{mime}
8134 Mime is a standard for waving your hands through the air, aimlessly,
8135 while people stand around yawning.
8137 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
8138 while all newsreaders die of fear.
8140 @sc{mime} may specify what character set the article uses, the encoding
8141 of the characters, and it also makes it possible to embed pictures and
8142 other naughty stuff in innocent-looking articles.
8144 @vindex gnus-display-mime-function
8145 @findex gnus-display-mime
8146 Gnus pushes @sc{mime} articles through @code{gnus-display-mime-function}
8147 to display the @sc{mime} parts. This is @code{gnus-display-mime} by
8148 default, which creates a bundle of clickable buttons that can be used to
8149 display, save and manipulate the @sc{mime} objects.
8151 The following commands are available when you have placed point over a
8155 @findex gnus-article-press-button
8157 @itemx BUTTON-2 (Article)
8158 Toggle displaying of the @sc{mime} object
8159 (@code{gnus-article-press-button}).
8161 @findex gnus-mime-view-part
8162 @item M-RET (Article)
8164 Prompt for a method, and then view the @sc{mime} object using this
8165 method (@code{gnus-mime-view-part}).
8167 @findex gnus-mime-save-part
8169 Prompt for a file name, and then save the @sc{mime} object
8170 (@code{gnus-mime-save-part}).
8172 @findex gnus-mime-copy-part
8174 Copy the @sc{mime} object to a fresh buffer and display this buffer
8175 (@code{gnus-mime-copy-part}).
8177 @findex gnus-mime-pipe-part
8179 Output the @sc{mime} object to a process (@code{gnus-mime-pipe-part}).
8182 Gnus will display some @sc{mime} objects automatically. The way Gnus
8183 determines which parts to do this with is described in the Emacs MIME
8186 It might be best to just use the toggling functions from the article
8187 buffer to avoid getting nasty surprises. (For instance, you enter the
8188 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
8189 decoded the sound file in the article and some horrible sing-a-long song
8190 comes screaming out your speakers, and you can't find the volume button,
8191 because there isn't one, and people are starting to look at you, and you
8192 try to stop the program, but you can't, and you can't find the program
8193 to control the volume, and everybody else in the room suddenly decides
8194 to look at you disdainfully, and you'll feel rather stupid.)
8196 Any similarity to real events and people is purely coincidental. Ahem.
8199 @node Customizing Articles
8200 @section Customizing Articles
8201 @cindex article customization
8203 A slew of functions for customizing how the articles are to look like
8204 exist. You can call these functions interactively, or you can have them
8205 called automatically when you select the articles.
8207 To have them called automatically, you should set the corresponding
8208 ``treatment'' variable. For instance, to have headers hidden, you'd set
8209 @code{gnus-treat-hide-headers}. Below is a list of variables that can
8210 be set, but first we discuss the values these variables can have.
8214 @code{nil}: Don't do this treatment.
8217 @code{t}: Do this treatment on all body parts.
8220 @code{head}: Do the treatment on the headers.
8223 @code{last}: Do this treatment on the last part.
8226 An integer: Do this treatment on all body parts that have a length less
8230 A sexp: Do this treatment on all body parts where the sexp evals to a
8231 non-@code{nil} value.
8235 You may have noticed that the word @dfn{part} is used here. This refers
8236 to the fact that some messages are @sc{mime} multipart articles that may
8237 be divided into several parts. Articles that are not multiparts are
8238 considered to contain just a single part.
8240 @vindex gnus-article-treat-types
8241 Are the treatments applied to all sorts of multipart parts? Yes, if you
8242 want to, but by default, only @samp{text/plain} parts are given the
8243 treatment. This is controlled by the @code{gnus-article-treat-types}
8244 variable, which is a list of regular expressions that are matched to the
8247 The following treatment options are available. The easiest way to
8248 customize this is to examine the @code{gnus-article-treat} customization
8252 @item gnus-treat-highlight-signature
8253 @item gnus-treat-buttonize
8254 @item gnus-treat-buttonize-head
8255 @item gnus-treat-emphasize
8256 @item gnus-treat-fill-article
8257 @item gnus-treat-strip-cr
8258 @item gnus-treat-hide-headers
8259 @item gnus-treat-hide-boring-headers
8260 @item gnus-treat-hide-signature
8261 @item gnus-treat-hide-citation
8262 @item gnus-treat-strip-pgp
8263 @item gnus-treat-strip-pem
8264 @item gnus-treat-highlight-headers
8265 @item gnus-treat-highlight-citation
8266 @item gnus-treat-highlight-signature
8267 @item gnus-treat-date-ut
8268 @item gnus-treat-date-local
8269 @item gnus-treat-date-lapsed
8270 @item gnus-treat-date-original
8271 @item gnus-treat-strip-trailing-blank-lines
8272 @item gnus-treat-strip-leading-blank-lines
8273 @item gnus-treat-strip-multiple-blank-lines
8274 @item gnus-treat-strip-blank-lines
8275 @item gnus-treat-overstrike
8276 @item gnus-treat-display-xface
8277 @item gnus-treat-display-smileys
8278 @item gnus-treat-display-picons
8281 @vindex gnus-part-display-hook
8282 You can, of course, write your own functions to be called from
8283 @code{gnus-part-display-hook}. The functions are called narrowed to the
8284 part, and you can do anything you like, pretty much. There is no
8285 information that you have to keep in the buffer---you can change
8286 everything. However, you shouldn't delete any headers. Instead make
8287 them invisible if you want to make them go away.
8290 @node Article Keymap
8291 @section Article Keymap
8293 Most of the keystrokes in the summary buffer can also be used in the
8294 article buffer. They should behave as if you typed them in the summary
8295 buffer, which means that you don't actually have to have a summary
8296 buffer displayed while reading. You can do it all from the article
8299 A few additional keystrokes are available:
8304 @kindex SPACE (Article)
8305 @findex gnus-article-next-page
8306 Scroll forwards one page (@code{gnus-article-next-page}).
8309 @kindex DEL (Article)
8310 @findex gnus-article-prev-page
8311 Scroll backwards one page (@code{gnus-article-prev-page}).
8314 @kindex C-c ^ (Article)
8315 @findex gnus-article-refer-article
8316 If point is in the neighborhood of a @code{Message-ID} and you press
8317 @kbd{C-c ^}, Gnus will try to get that article from the server
8318 (@code{gnus-article-refer-article}).
8321 @kindex C-c C-m (Article)
8322 @findex gnus-article-mail
8323 Send a reply to the address near point (@code{gnus-article-mail}). If
8324 given a prefix, include the mail.
8328 @findex gnus-article-show-summary
8329 Reconfigure the buffers so that the summary buffer becomes visible
8330 (@code{gnus-article-show-summary}).
8334 @findex gnus-article-describe-briefly
8335 Give a very brief description of the available keystrokes
8336 (@code{gnus-article-describe-briefly}).
8339 @kindex TAB (Article)
8340 @findex gnus-article-next-button
8341 Go to the next button, if any (@code{gnus-article-next-button}). This
8342 only makes sense if you have buttonizing turned on.
8345 @kindex M-TAB (Article)
8346 @findex gnus-article-prev-button
8347 Go to the previous button, if any (@code{gnus-article-prev-button}).
8353 @section Misc Article
8357 @item gnus-single-article-buffer
8358 @vindex gnus-single-article-buffer
8359 If non-@code{nil}, use the same article buffer for all the groups.
8360 (This is the default.) If @code{nil}, each group will have its own
8363 @vindex gnus-article-decode-hook
8364 @item gnus-article-decode-hook
8366 Hook used to decode @sc{mime} articles. The default value is
8367 @code{(article-decode-charset article-decode-encoded-words)}
8369 @vindex gnus-article-prepare-hook
8370 @item gnus-article-prepare-hook
8371 This hook is called right after the article has been inserted into the
8372 article buffer. It is mainly intended for functions that do something
8373 depending on the contents; it should probably not be used for changing
8374 the contents of the article buffer.
8376 @item gnus-article-mode-hook
8377 @vindex gnus-article-mode-hook
8378 Hook called in article mode buffers.
8380 @item gnus-article-mode-syntax-table
8381 @vindex gnus-article-mode-syntax-table
8382 Syntax table used in article buffers. It is initialized from
8383 @code{text-mode-syntax-table}.
8385 @vindex gnus-article-mode-line-format
8386 @item gnus-article-mode-line-format
8387 This variable is a format string along the same lines as
8388 @code{gnus-summary-mode-line-format} (@pxref{Mode Line Formatting}). It
8389 accepts the same format specifications as that variable, with one
8394 The @dfn{wash status} of the article. This is a short string with one
8395 character for each possible article wash operation that may have been
8398 The number of @sc{mime} parts in the article.
8401 @vindex gnus-break-pages
8403 @item gnus-break-pages
8404 Controls whether @dfn{page breaking} is to take place. If this variable
8405 is non-@code{nil}, the articles will be divided into pages whenever a
8406 page delimiter appears in the article. If this variable is @code{nil},
8407 paging will not be done.
8409 @item gnus-page-delimiter
8410 @vindex gnus-page-delimiter
8411 This is the delimiter mentioned above. By default, it is @samp{^L}
8416 @node Composing Messages
8417 @chapter Composing Messages
8418 @cindex composing messages
8421 @cindex sending mail
8426 @kindex C-c C-c (Post)
8427 All commands for posting and mailing will put you in a message buffer
8428 where you can edit the article all you like, before you send the article
8429 by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The Message
8430 Manual}. If you are in a foreign news group, and you wish to post the
8431 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
8432 to make Gnus try to post using the foreign server.
8435 * Mail:: Mailing and replying.
8436 * Post:: Posting and following up.
8437 * Posting Server:: What server should you post via?
8438 * Mail and Post:: Mailing and posting at the same time.
8439 * Archived Messages:: Where Gnus stores the messages you've sent.
8440 * Posting Styles:: An easier way to specify who you are.
8441 * Drafts:: Postponing messages and rejected messages.
8442 * Rejected Articles:: What happens if the server doesn't like your article?
8445 Also see @pxref{Canceling and Superseding} for information on how to
8446 remove articles you shouldn't have posted.
8452 Variables for customizing outgoing mail:
8455 @item gnus-uu-digest-headers
8456 @vindex gnus-uu-digest-headers
8457 List of regexps to match headers included in digested messages. The
8458 headers will be included in the sequence they are matched.
8460 @item gnus-add-to-list
8461 @vindex gnus-add-to-list
8462 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
8463 that have none when you do a @kbd{a}.
8471 Variables for composing news articles:
8474 @item gnus-sent-message-ids-file
8475 @vindex gnus-sent-message-ids-file
8476 Gnus will keep a @code{Message-ID} history file of all the mails it has
8477 sent. If it discovers that it has already sent a mail, it will ask the
8478 user whether to re-send the mail. (This is primarily useful when
8479 dealing with @sc{soup} packets and the like where one is apt to send the
8480 same packet multiple times.) This variable says what the name of this
8481 history file is. It is @file{~/News/Sent-Message-IDs} by default. Set
8482 this variable to @code{nil} if you don't want Gnus to keep a history
8485 @item gnus-sent-message-ids-length
8486 @vindex gnus-sent-message-ids-length
8487 This variable says how many @code{Message-ID}s to keep in the history
8488 file. It is 1000 by default.
8493 @node Posting Server
8494 @section Posting Server
8496 When you press those magical @kbd{C-c C-c} keys to ship off your latest
8497 (extremely intelligent, of course) article, where does it go?
8499 Thank you for asking. I hate you.
8501 @vindex gnus-post-method
8503 It can be quite complicated. Normally, Gnus will use the same native
8504 server. However. If your native server doesn't allow posting, just
8505 reading, you probably want to use some other server to post your
8506 (extremely intelligent and fabulously interesting) articles. You can
8507 then set the @code{gnus-post-method} to some other method:
8510 (setq gnus-post-method '(nnspool ""))
8513 Now, if you've done this, and then this server rejects your article, or
8514 this server is down, what do you do then? To override this variable you
8515 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
8516 the ``current'' server for posting.
8518 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
8519 Gnus will prompt you for what method to use for posting.
8521 You can also set @code{gnus-post-method} to a list of select methods.
8522 If that's the case, Gnus will always prompt you for what method to use
8525 Finally, if you want to always post using the same select method as
8526 you're reading from (which might be convenient if you're reading lots of
8527 groups from different private servers), you can set this variable to
8532 @section Mail and Post
8534 Here's a list of variables relevant to both mailing and
8538 @item gnus-mailing-list-groups
8539 @findex gnus-mailing-list-groups
8540 @cindex mailing lists
8542 If your news server offers groups that are really mailing lists
8543 gatewayed to the @sc{nntp} server, you can read those groups without
8544 problems, but you can't post/followup to them without some difficulty.
8545 One solution is to add a @code{to-address} to the group parameters
8546 (@pxref{Group Parameters}). An easier thing to do is set the
8547 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
8548 really are mailing lists. Then, at least, followups to the mailing
8549 lists will work most of the time. Posting to these groups (@kbd{a}) is
8550 still a pain, though.
8554 You may want to do spell-checking on messages that you send out. Or, if
8555 you don't want to spell-check by hand, you could add automatic
8556 spell-checking via the @code{ispell} package:
8559 @findex ispell-message
8561 (add-hook 'message-send-hook 'ispell-message)
8565 @node Archived Messages
8566 @section Archived Messages
8567 @cindex archived messages
8568 @cindex sent messages
8570 Gnus provides a few different methods for storing the mail and news you
8571 send. The default method is to use the @dfn{archive virtual server} to
8572 store the messages. If you want to disable this completely, the
8573 @code{gnus-message-archive-group} variable should be @code{nil}, which
8576 @vindex gnus-message-archive-method
8577 @code{gnus-message-archive-method} says what virtual server Gnus is to
8578 use to store sent messages. The default is:
8582 (nnfolder-directory "~/Mail/archive")
8583 (nnfolder-active-file "~/Mail/archive/active")
8584 (nnfolder-get-new-mail nil)
8585 (nnfolder-inhibit-expiry t))
8588 You can, however, use any mail select method (@code{nnml},
8589 @code{nnmbox}, etc.). @code{nnfolder} is a quite likeable select method
8590 for doing this sort of thing, though. If you don't like the default
8591 directory chosen, you could say something like:
8594 (setq gnus-message-archive-method
8595 '(nnfolder "archive"
8596 (nnfolder-inhibit-expiry t)
8597 (nnfolder-active-file "~/News/sent-mail/active")
8598 (nnfolder-directory "~/News/sent-mail/")))
8601 @vindex gnus-message-archive-group
8603 Gnus will insert @code{Gcc} headers in all outgoing messages that point
8604 to one or more group(s) on that server. Which group to use is
8605 determined by the @code{gnus-message-archive-group} variable.
8607 This variable can be used to do the following:
8611 Messages will be saved in that group.
8612 @item a list of strings
8613 Messages will be saved in all those groups.
8614 @item an alist of regexps, functions and forms
8615 When a key ``matches'', the result is used.
8617 No message archiving will take place. This is the default.
8622 Just saving to a single group called @samp{MisK}:
8624 (setq gnus-message-archive-group "MisK")
8627 Saving to two groups, @samp{MisK} and @samp{safe}:
8629 (setq gnus-message-archive-group '("MisK" "safe"))
8632 Save to different groups based on what group you are in:
8634 (setq gnus-message-archive-group
8635 '(("^alt" "sent-to-alt")
8636 ("mail" "sent-to-mail")
8637 (".*" "sent-to-misc")))
8642 (setq gnus-message-archive-group
8643 '((if (message-news-p)
8648 How about storing all news messages in one file, but storing all mail
8649 messages in one file per month:
8652 (setq gnus-message-archive-group
8653 '((if (message-news-p)
8655 (concat "mail." (format-time-string
8656 "%Y-%m" (current-time))))))
8659 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
8660 use a different value for @code{gnus-message-archive-group} there.)
8662 Now, when you send a message off, it will be stored in the appropriate
8663 group. (If you want to disable storing for just one particular message,
8664 you can just remove the @code{Gcc} header that has been inserted.) The
8665 archive group will appear in the group buffer the next time you start
8666 Gnus, or the next time you press @kbd{F} in the group buffer. You can
8667 enter it and read the articles in it just like you'd read any other
8668 group. If the group gets really big and annoying, you can simply rename
8669 if (using @kbd{G r} in the group buffer) to something
8670 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
8671 continue to be stored in the old (now empty) group.
8673 That's the default method of archiving sent messages. Gnus offers a
8674 different way for the people who don't like the default method. In that
8675 case you should set @code{gnus-message-archive-group} to @code{nil};
8676 this will disable archiving.
8679 @item gnus-outgoing-message-group
8680 @vindex gnus-outgoing-message-group
8681 All outgoing messages will be put in this group. If you want to store
8682 all your outgoing mail and articles in the group @samp{nnml:archive},
8683 you set this variable to that value. This variable can also be a list of
8686 If you want to have greater control over what group to put each
8687 message in, you can set this variable to a function that checks the
8688 current newsgroup name and then returns a suitable group name (or list
8691 This variable can be used instead of @code{gnus-message-archive-group},
8692 but the latter is the preferred method.
8696 @node Posting Styles
8697 @section Posting Styles
8698 @cindex posting styles
8701 All them variables, they make my head swim.
8703 So what if you want a different @code{Organization} and signature based
8704 on what groups you post to? And you post both from your home machine
8705 and your work machine, and you want different @code{From} lines, and so
8708 @vindex gnus-posting-styles
8709 One way to do stuff like that is to write clever hooks that change the
8710 variables you need to have changed. That's a bit boring, so somebody
8711 came up with the bright idea of letting the user specify these things in
8712 a handy alist. Here's an example of a @code{gnus-posting-styles}
8717 (signature "Peace and happiness")
8718 (organization "What me?"))
8720 (signature "Death to everybody"))
8721 ("comp.emacs.i-love-it"
8722 (organization "Emacs is it")))
8725 As you might surmise from this example, this alist consists of several
8726 @dfn{styles}. Each style will be applicable if the first element
8727 ``matches'', in some form or other. The entire alist will be iterated
8728 over, from the beginning towards the end, and each match will be
8729 applied, which means that attributes in later styles that match override
8730 the same attributes in earlier matching styles. So
8731 @samp{comp.programming.literate} will have the @samp{Death to everybody}
8732 signature and the @samp{What me?} @code{Organization} header.
8734 The first element in each style is called the @code{match}. If it's a
8735 string, then Gnus will try to regexp match it against the group name.
8736 If it's a function symbol, that function will be called with no
8737 arguments. If it's a variable symbol, then the variable will be
8738 referenced. If it's a list, then that list will be @code{eval}ed. In
8739 any case, if this returns a non-@code{nil} value, then the style is said
8742 Each style may contain a arbitrary amount of @dfn{attributes}. Each
8743 attribute consists of a @var{(name . value)} pair. The attribute name
8744 can be one of @code{signature}, @code{signature-file},
8745 @code{organization}, @code{address}, @code{name} or @code{body}. The
8746 attribute name can also be a string. In that case, this will be used as
8747 a header name, and the value will be inserted in the headers of the
8750 The attribute value can be a string (used verbatim), a function (the
8751 return value will be used), a variable (its value will be used) or a
8752 list (it will be @code{eval}ed and the return value will be used).
8754 If you wish to check whether the message you are about to compose is
8755 meant to be a news article or a mail message, you can check the values
8756 of the two dynamically bound variables @code{message-this-is-news} and
8757 @code{message-this-is-mail}.
8759 @vindex message-this-is-mail
8760 @vindex message-this-is-news
8762 So here's a new example:
8765 (setq gnus-posting-styles
8767 (signature-file "~/.signature")
8769 ("X-Home-Page" (getenv "WWW_HOME"))
8770 (organization "People's Front Against MWM"))
8772 (signature my-funny-signature-randomizer))
8773 ((equal (system-name) "gnarly")
8774 (signature my-quote-randomizer))
8775 (message-this-is-news
8776 (signature my-news-signature))
8777 (posting-from-work-p
8778 (signature-file "~/.work-signature")
8779 (address "user@@bar.foo")
8780 (body "You are fired.\n\nSincerely, your boss.")
8781 (organization "Important Work, Inc"))
8783 (signature-file "~/.mail-signature"))))
8791 If you are writing a message (mail or news) and suddenly remember that
8792 you have a steak in the oven (or some pesto in the food processor, you
8793 craaazy vegetarians), you'll probably wish there was a method to save
8794 the message you are writing so that you can continue editing it some
8795 other day, and send it when you feel its finished.
8797 Well, don't worry about it. Whenever you start composing a message of
8798 some sort using the Gnus mail and post commands, the buffer you get will
8799 automatically associate to an article in a special @dfn{draft} group.
8800 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
8801 article will be saved there. (Auto-save files also go to the draft
8805 @vindex nndraft-directory
8806 The draft group is a special group (which is implemented as an
8807 @code{nndraft} group, if you absolutely have to know) called
8808 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
8809 @code{nndraft} is to store its files. What makes this group special is
8810 that you can't tick any articles in it or mark any articles as
8811 read---all articles in the group are permanently unread.
8813 If the group doesn't exist, it will be created and you'll be subscribed
8814 to it. The only way to make it disappear from the Group buffer is to
8817 @c @findex gnus-dissociate-buffer-from-draft
8818 @c @kindex C-c M-d (Mail)
8819 @c @kindex C-c M-d (Post)
8820 @c @findex gnus-associate-buffer-with-draft
8821 @c @kindex C-c C-d (Mail)
8822 @c @kindex C-c C-d (Post)
8823 @c If you're writing some super-secret message that you later want to
8824 @c encode with PGP before sending, you may wish to turn the auto-saving
8825 @c (and association with the draft group) off. You never know who might be
8826 @c interested in reading all your extremely valuable and terribly horrible
8827 @c and interesting secrets. The @kbd{C-c M-d}
8828 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
8829 @c If you change your mind and want to turn the auto-saving back on again,
8830 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
8832 @c @vindex gnus-use-draft
8833 @c To leave association with the draft group off by default, set
8834 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
8836 @findex gnus-draft-edit-message
8838 When you want to continue editing the article, you simply enter the
8839 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
8840 that. You will be placed in a buffer where you left off.
8842 Rejected articles will also be put in this draft group (@pxref{Rejected
8845 @findex gnus-draft-send-all-messages
8846 @findex gnus-draft-send-message
8847 If you have lots of rejected messages you want to post (or mail) without
8848 doing further editing, you can use the @kbd{D s} command
8849 (@code{gnus-draft-send-message}). This command understands the
8850 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
8851 command (@code{gnus-draft-send-all-messages}) will ship off all messages
8854 If you have some messages that you wish not to send, you can use the
8855 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
8856 as unsendable. This is a toggling command.
8859 @node Rejected Articles
8860 @section Rejected Articles
8861 @cindex rejected articles
8863 Sometimes a news server will reject an article. Perhaps the server
8864 doesn't like your face. Perhaps it just feels miserable. Perhaps
8865 @emph{there be demons}. Perhaps you have included too much cited text.
8866 Perhaps the disk is full. Perhaps the server is down.
8868 These situations are, of course, totally beyond the control of Gnus.
8869 (Gnus, of course, loves the way you look, always feels great, has angels
8870 fluttering around inside of it, doesn't care about how much cited text
8871 you include, never runs full and never goes down.) So Gnus saves these
8872 articles until some later time when the server feels better.
8874 The rejected articles will automatically be put in a special draft group
8875 (@pxref{Drafts}). When the server comes back up again, you'd then
8876 typically enter that group and send all the articles off.
8879 @node Select Methods
8880 @chapter Select Methods
8881 @cindex foreign groups
8882 @cindex select methods
8884 A @dfn{foreign group} is a group not read by the usual (or
8885 default) means. It could be, for instance, a group from a different
8886 @sc{nntp} server, it could be a virtual group, or it could be your own
8887 personal mail group.
8889 A foreign group (or any group, really) is specified by a @dfn{name} and
8890 a @dfn{select method}. To take the latter first, a select method is a
8891 list where the first element says what backend to use (e.g. @code{nntp},
8892 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
8893 name}. There may be additional elements in the select method, where the
8894 value may have special meaning for the backend in question.
8896 One could say that a select method defines a @dfn{virtual server}---so
8897 we do just that (@pxref{The Server Buffer}).
8899 The @dfn{name} of the group is the name the backend will recognize the
8902 For instance, the group @samp{soc.motss} on the @sc{nntp} server
8903 @samp{some.where.edu} will have the name @samp{soc.motss} and select
8904 method @code{(nntp "some.where.edu")}. Gnus will call this group
8905 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
8906 backend just knows this group as @samp{soc.motss}.
8908 The different methods all have their peculiarities, of course.
8911 * The Server Buffer:: Making and editing virtual servers.
8912 * Getting News:: Reading USENET news with Gnus.
8913 * Getting Mail:: Reading your personal mail with Gnus.
8914 * Other Sources:: Reading directories, files, SOUP packets.
8915 * Combined Groups:: Combining groups into one group.
8916 * Gnus Unplugged:: Reading news and mail offline.
8920 @node The Server Buffer
8921 @section The Server Buffer
8923 Traditionally, a @dfn{server} is a machine or a piece of software that
8924 one connects to, and then requests information from. Gnus does not
8925 connect directly to any real servers, but does all transactions through
8926 one backend or other. But that's just putting one layer more between
8927 the actual media and Gnus, so we might just as well say that each
8928 backend represents a virtual server.
8930 For instance, the @code{nntp} backend may be used to connect to several
8931 different actual @sc{nntp} servers, or, perhaps, to many different ports
8932 on the same actual @sc{nntp} server. You tell Gnus which backend to
8933 use, and what parameters to set by specifying a @dfn{select method}.
8935 These select method specifications can sometimes become quite
8936 complicated---say, for instance, that you want to read from the
8937 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
8938 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
8939 Anyways, if you had to specify that for each group that used this
8940 server, that would be too much work, so Gnus offers a way of naming
8941 select methods, which is what you do in the server buffer.
8943 To enter the server buffer, use the @kbd{^}
8944 (@code{gnus-group-enter-server-mode}) command in the group buffer.
8947 * Server Buffer Format:: You can customize the look of this buffer.
8948 * Server Commands:: Commands to manipulate servers.
8949 * Example Methods:: Examples server specifications.
8950 * Creating a Virtual Server:: An example session.
8951 * Server Variables:: Which variables to set.
8952 * Servers and Methods:: You can use server names as select methods.
8953 * Unavailable Servers:: Some servers you try to contact may be down.
8956 @vindex gnus-server-mode-hook
8957 @code{gnus-server-mode-hook} is run when creating the server buffer.
8960 @node Server Buffer Format
8961 @subsection Server Buffer Format
8962 @cindex server buffer format
8964 @vindex gnus-server-line-format
8965 You can change the look of the server buffer lines by changing the
8966 @code{gnus-server-line-format} variable. This is a @code{format}-like
8967 variable, with some simple extensions:
8972 How the news is fetched---the backend name.
8975 The name of this server.
8978 Where the news is to be fetched from---the address.
8981 The opened/closed/denied status of the server.
8984 @vindex gnus-server-mode-line-format
8985 The mode line can also be customized by using the
8986 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
8987 Formatting}). The following specs are understood:
8997 Also @pxref{Formatting Variables}.
9000 @node Server Commands
9001 @subsection Server Commands
9002 @cindex server commands
9008 @findex gnus-server-add-server
9009 Add a new server (@code{gnus-server-add-server}).
9013 @findex gnus-server-edit-server
9014 Edit a server (@code{gnus-server-edit-server}).
9017 @kindex SPACE (Server)
9018 @findex gnus-server-read-server
9019 Browse the current server (@code{gnus-server-read-server}).
9023 @findex gnus-server-exit
9024 Return to the group buffer (@code{gnus-server-exit}).
9028 @findex gnus-server-kill-server
9029 Kill the current server (@code{gnus-server-kill-server}).
9033 @findex gnus-server-yank-server
9034 Yank the previously killed server (@code{gnus-server-yank-server}).
9038 @findex gnus-server-copy-server
9039 Copy the current server (@code{gnus-server-copy-server}).
9043 @findex gnus-server-list-servers
9044 List all servers (@code{gnus-server-list-servers}).
9048 @findex gnus-server-scan-server
9049 Request that the server scan its sources for new articles
9050 (@code{gnus-server-scan-server}). This is mainly sensible with mail
9055 @findex gnus-server-regenerate-server
9056 Request that the server regenerate all its data structures
9057 (@code{gnus-server-regenerate-server}). This can be useful if you have
9058 a mail backend that has gotten out of synch.
9063 @node Example Methods
9064 @subsection Example Methods
9066 Most select methods are pretty simple and self-explanatory:
9069 (nntp "news.funet.fi")
9072 Reading directly from the spool is even simpler:
9078 As you can see, the first element in a select method is the name of the
9079 backend, and the second is the @dfn{address}, or @dfn{name}, if you
9082 After these two elements, there may be an arbitrary number of
9083 @var{(variable form)} pairs.
9085 To go back to the first example---imagine that you want to read from
9086 port 15 on that machine. This is what the select method should
9090 (nntp "news.funet.fi" (nntp-port-number 15))
9093 You should read the documentation to each backend to find out what
9094 variables are relevant, but here's an @code{nnmh} example:
9096 @code{nnmh} is a mail backend that reads a spool-like structure. Say
9097 you have two structures that you wish to access: One is your private
9098 mail spool, and the other is a public one. Here's the possible spec for
9102 (nnmh "private" (nnmh-directory "~/private/mail/"))
9105 (This server is then called @samp{private}, but you may have guessed
9108 Here's the method for a public spool:
9112 (nnmh-directory "/usr/information/spool/")
9113 (nnmh-get-new-mail nil))
9116 If you are behind a firewall and only have access to the @sc{nntp}
9117 server from the firewall machine, you can instruct Gnus to @code{rlogin}
9118 on the firewall machine and telnet from there to the @sc{nntp} server.
9119 Doing this can be rather fiddly, but your virtual server definition
9120 should probably look something like this:
9124 (nntp-address "the.firewall.machine")
9125 (nntp-open-connection-function nntp-open-rlogin)
9126 (nntp-end-of-line "\n")
9127 (nntp-rlogin-parameters
9128 ("telnet" "the.real.nntp.host" "nntp")))
9131 If you want to use the wonderful @code{ssh} program to provide a
9132 compressed connection over the modem line, you could create a virtual
9133 server that would look something like this:
9137 (nntp-address "copper.uio.no")
9138 (nntp-rlogin-program "ssh")
9139 (nntp-open-connection-function nntp-open-rlogin)
9140 (nntp-end-of-line "\n")
9141 (nntp-rlogin-parameters
9142 ("telnet" "news.uio.no" "nntp")))
9145 This means that you have to have set up @code{ssh-agent} correctly to
9146 provide automatic authorization, of course. And to get a compressed
9147 connection, you have to have the @samp{Compression} option in the
9148 @code{ssh} @file{config} file.
9151 @node Creating a Virtual Server
9152 @subsection Creating a Virtual Server
9154 If you're saving lots of articles in the cache by using persistent
9155 articles, you may want to create a virtual server to read the cache.
9157 First you need to add a new server. The @kbd{a} command does that. It
9158 would probably be best to use @code{nnspool} to read the cache. You
9159 could also use @code{nnml} or @code{nnmh}, though.
9161 Type @kbd{a nnspool RET cache RET}.
9163 You should now have a brand new @code{nnspool} virtual server called
9164 @samp{cache}. You now need to edit it to have the right definitions.
9165 Type @kbd{e} to edit the server. You'll be entered into a buffer that
9166 will contain the following:
9176 (nnspool-spool-directory "~/News/cache/")
9177 (nnspool-nov-directory "~/News/cache/")
9178 (nnspool-active-file "~/News/cache/active"))
9181 Type @kbd{C-c C-c} to return to the server buffer. If you now press
9182 @kbd{RET} over this virtual server, you should be entered into a browse
9183 buffer, and you should be able to enter any of the groups displayed.
9186 @node Server Variables
9187 @subsection Server Variables
9189 One sticky point when defining variables (both on backends and in Emacs
9190 in general) is that some variables are typically initialized from other
9191 variables when the definition of the variables is being loaded. If you
9192 change the "base" variable after the variables have been loaded, you
9193 won't change the "derived" variables.
9195 This typically affects directory and file variables. For instance,
9196 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
9197 directory variables are initialized from that variable, so
9198 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
9199 new virtual @code{nnml} server, it will @emph{not} suffice to set just
9200 @code{nnml-directory}---you have to explicitly set all the file
9201 variables to be what you want them to be. For a complete list of
9202 variables for each backend, see each backend's section later in this
9203 manual, but here's an example @code{nnml} definition:
9207 (nnml-directory "~/my-mail/")
9208 (nnml-active-file "~/my-mail/active")
9209 (nnml-newsgroups-file "~/my-mail/newsgroups"))
9213 @node Servers and Methods
9214 @subsection Servers and Methods
9216 Wherever you would normally use a select method
9217 (e.g. @code{gnus-secondary-select-method}, in the group select method,
9218 when browsing a foreign server) you can use a virtual server name
9219 instead. This could potentially save lots of typing. And it's nice all
9223 @node Unavailable Servers
9224 @subsection Unavailable Servers
9226 If a server seems to be unreachable, Gnus will mark that server as
9227 @code{denied}. That means that any subsequent attempt to make contact
9228 with that server will just be ignored. ``It can't be opened,'' Gnus
9229 will tell you, without making the least effort to see whether that is
9230 actually the case or not.
9232 That might seem quite naughty, but it does make sense most of the time.
9233 Let's say you have 10 groups subscribed to on server
9234 @samp{nephelococcygia.com}. This server is located somewhere quite far
9235 away from you and the machine is quite slow, so it takes 1 minute just
9236 to find out that it refuses connection to you today. If Gnus were to
9237 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
9238 attempt to do that. Once it has gotten a single ``connection refused'',
9239 it will regard that server as ``down''.
9241 So, what happens if the machine was only feeling unwell temporarily?
9242 How do you test to see whether the machine has come up again?
9244 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
9245 with the following commands:
9251 @findex gnus-server-open-server
9252 Try to establish connection to the server on the current line
9253 (@code{gnus-server-open-server}).
9257 @findex gnus-server-close-server
9258 Close the connection (if any) to the server
9259 (@code{gnus-server-close-server}).
9263 @findex gnus-server-deny-server
9264 Mark the current server as unreachable
9265 (@code{gnus-server-deny-server}).
9268 @kindex M-o (Server)
9269 @findex gnus-server-open-all-servers
9270 Open the connections to all servers in the buffer
9271 (@code{gnus-server-open-all-servers}).
9274 @kindex M-c (Server)
9275 @findex gnus-server-close-all-servers
9276 Close the connections to all servers in the buffer
9277 (@code{gnus-server-close-all-servers}).
9281 @findex gnus-server-remove-denials
9282 Remove all marks to whether Gnus was denied connection from any servers
9283 (@code{gnus-server-remove-denials}).
9289 @section Getting News
9290 @cindex reading news
9291 @cindex news backends
9293 A newsreader is normally used for reading news. Gnus currently provides
9294 only two methods of getting news---it can read from an @sc{nntp} server,
9295 or it can read from a local spool.
9298 * NNTP:: Reading news from an @sc{nntp} server.
9299 * News Spool:: Reading news from the local spool.
9304 @subsection @sc{nntp}
9307 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
9308 You just specify @code{nntp} as method and the address of the @sc{nntp}
9309 server as the, uhm, address.
9311 If the @sc{nntp} server is located at a non-standard port, setting the
9312 third element of the select method to this port number should allow you
9313 to connect to the right port. You'll have to edit the group info for
9314 that (@pxref{Foreign Groups}).
9316 The name of the foreign group can be the same as a native group. In
9317 fact, you can subscribe to the same group from as many different servers
9318 you feel like. There will be no name collisions.
9320 The following variables can be used to create a virtual @code{nntp}
9325 @item nntp-server-opened-hook
9326 @vindex nntp-server-opened-hook
9327 @cindex @sc{mode reader}
9329 @cindex authentification
9330 @cindex nntp authentification
9331 @findex nntp-send-authinfo
9332 @findex nntp-send-mode-reader
9333 is run after a connection has been made. It can be used to send
9334 commands to the @sc{nntp} server after it has been contacted. By
9335 default it sends the command @code{MODE READER} to the server with the
9336 @code{nntp-send-mode-reader} function. This function should always be
9337 present in this hook.
9339 @item nntp-authinfo-function
9340 @vindex nntp-authinfo-function
9341 @findex nntp-send-authinfo
9342 @vindex nntp-authinfo-file
9343 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
9344 server. The default function is @code{nntp-send-authinfo}, which looks
9345 through your @file{~/.authinfo} (or whatever you've set the
9346 @code{nntp-authinfo-file} variable to) for applicable entries. If none
9347 are found, it will prompt you for a login name and a password. The
9348 format of the @file{~/.authinfo} file is (almost) the same as the
9349 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
9350 manual page, but here are the salient facts:
9354 The file contains one or more line, each of which define one server.
9357 Each line may contain an arbitrary number of token/value pairs. The
9358 valid tokens include @samp{machine}, @samp{login}, @samp{password},
9359 @samp{default} and @samp{force}. (The latter is not a valid
9360 @file{.netrc}/@code{ftp} token, which is the only way the
9361 @file{.authinfo} file format deviates from the @file{.netrc} file
9366 Here's an example file:
9369 machine news.uio.no login larsi password geheimnis
9370 machine nntp.ifi.uio.no login larsi force yes
9373 The token/value pairs may appear in any order; @samp{machine} doesn't
9374 have to be first, for instance.
9376 In this example, both login name and password have been supplied for the
9377 former server, while the latter has only the login name listed, and the
9378 user will be prompted for the password. The latter also has the
9379 @samp{force} tag, which means that the authinfo will be sent to the
9380 @var{nntp} server upon connection; the default (i.e., when there is not
9381 @samp{force} tag) is to not send authinfo to the @var{nntp} server
9382 until the @var{nntp} server asks for it.
9384 You can also add @samp{default} lines that will apply to all servers
9385 that don't have matching @samp{machine} lines.
9391 This will force sending @samp{AUTHINFO} commands to all servers not
9392 previously mentioned.
9394 Remember to not leave the @file{~/.authinfo} file world-readable.
9396 @item nntp-server-action-alist
9397 @vindex nntp-server-action-alist
9398 This is a list of regexps to match on server types and actions to be
9399 taken when matches are made. For instance, if you want Gnus to beep
9400 every time you connect to innd, you could say something like:
9403 (setq nntp-server-action-alist
9407 You probably don't want to do that, though.
9409 The default value is
9412 '(("nntpd 1\\.5\\.11t"
9413 (remove-hook 'nntp-server-opened-hook 'nntp-send-mode-reader)))
9416 This ensures that Gnus doesn't send the @code{MODE READER} command to
9417 nntpd 1.5.11t, since that command chokes that server, I've been told.
9419 @item nntp-maximum-request
9420 @vindex nntp-maximum-request
9421 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
9422 will collect headers by sending a series of @code{head} commands. To
9423 speed things up, the backend sends lots of these commands without
9424 waiting for reply, and then reads all the replies. This is controlled
9425 by the @code{nntp-maximum-request} variable, and is 400 by default. If
9426 your network is buggy, you should set this to 1.
9428 @item nntp-connection-timeout
9429 @vindex nntp-connection-timeout
9430 If you have lots of foreign @code{nntp} groups that you connect to
9431 regularly, you're sure to have problems with @sc{nntp} servers not
9432 responding properly, or being too loaded to reply within reasonable
9433 time. This is can lead to awkward problems, which can be helped
9434 somewhat by setting @code{nntp-connection-timeout}. This is an integer
9435 that says how many seconds the @code{nntp} backend should wait for a
9436 connection before giving up. If it is @code{nil}, which is the default,
9437 no timeouts are done.
9439 @c @item nntp-command-timeout
9440 @c @vindex nntp-command-timeout
9441 @c @cindex PPP connections
9442 @c @cindex dynamic IP addresses
9443 @c If you're running Gnus on a machine that has a dynamically assigned
9444 @c address, Gnus may become confused. If the address of your machine
9445 @c changes after connecting to the @sc{nntp} server, Gnus will simply sit
9446 @c waiting forever for replies from the server. To help with this
9447 @c unfortunate problem, you can set this command to a number. Gnus will
9448 @c then, if it sits waiting for a reply from the server longer than that
9449 @c number of seconds, shut down the connection, start a new one, and resend
9450 @c the command. This should hopefully be transparent to the user. A
9451 @c likely number is 30 seconds.
9453 @c @item nntp-retry-on-break
9454 @c @vindex nntp-retry-on-break
9455 @c If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
9456 @c hangs. This will have much the same effect as the command timeout
9459 @item nntp-server-hook
9460 @vindex nntp-server-hook
9461 This hook is run as the last step when connecting to an @sc{nntp}
9464 @findex nntp-open-rlogin
9465 @findex nntp-open-telnet
9466 @findex nntp-open-network-stream
9467 @item nntp-open-connection-function
9468 @vindex nntp-open-connection-function
9469 This function is used to connect to the remote system. Four pre-made
9470 functions are supplied:
9473 @item nntp-open-network-stream
9474 This is the default, and simply connects to some port or other on the
9477 @item nntp-open-rlogin
9478 Does an @samp{rlogin} on the
9479 remote system, and then does a @samp{telnet} to the @sc{nntp} server
9482 @code{nntp-open-rlogin}-related variables:
9486 @item nntp-rlogin-program
9487 @vindex nntp-rlogin-program
9488 Program used to log in on remote machines. The default is @samp{rsh},
9489 but @samp{ssh} is a popular alternative.
9491 @item nntp-rlogin-parameters
9492 @vindex nntp-rlogin-parameters
9493 This list will be used as the parameter list given to @code{rsh}.
9495 @item nntp-rlogin-user-name
9496 @vindex nntp-rlogin-user-name
9497 User name on the remote system.
9501 @item nntp-open-telnet
9502 Does a @samp{telnet} to the remote system and then another @samp{telnet}
9503 to get to the @sc{nntp} server.
9505 @code{nntp-open-telnet}-related variables:
9508 @item nntp-telnet-command
9509 @vindex nntp-telnet-command
9510 Command used to start @code{telnet}.
9512 @item nntp-telnet-switches
9513 @vindex nntp-telnet-switches
9514 List of strings to be used as the switches to the @code{telnet} command.
9516 @item nntp-telnet-user-name
9517 @vindex nntp-telnet-user-name
9518 User name for log in on the remote system.
9520 @item nntp-telnet-passwd
9521 @vindex nntp-telnet-passwd
9522 Password to use when logging in.
9524 @item nntp-telnet-parameters
9525 @vindex nntp-telnet-parameters
9526 A list of strings executed as a command after logging in
9529 @item nntp-telnet-shell-prompt
9530 @vindex nntp-telnet-shell-prompt
9531 Regexp matching the shell prompt on the remote machine. The default is
9532 @samp{bash\\|\$ *\r?$\\|> *\r?}.
9534 @item nntp-open-telnet-envuser
9535 @vindex nntp-open-telnet-envuser
9536 If non-@code{nil}, the @code{telnet} session (client and server both)
9537 will support the @code{ENVIRON} option and not prompt for login name.
9538 This works for Solaris @code{telnet}, for instance.
9542 @findex nntp-open-ssl-stream
9543 @item nntp-open-ssl-stream
9544 Opens a connection to a server over a @dfn{secure} channel. To use this
9545 you must have SSLay installed
9546 (@file{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL}, and you also need
9547 @file{ssl.el} (from the W3 distributeion, for instance). You then
9548 define a server as follows:
9551 ;; Type `C-c C-c' after you've finished editing.
9553 ;; "snews" is port 563 and is predefined in our /etc/services
9555 (nntp "snews.bar.com"
9556 (nntp-open-connection-function nntp-open-ssl-stream)
9557 (nntp-port-number "snews")
9558 (nntp-address "snews.bar.com"))
9563 @item nntp-end-of-line
9564 @vindex nntp-end-of-line
9565 String to use as end-of-line marker when talking to the @sc{nntp}
9566 server. This is @samp{\r\n} by default, but should be @samp{\n} when
9567 using @code{rlogin} to talk to the server.
9569 @item nntp-rlogin-user-name
9570 @vindex nntp-rlogin-user-name
9571 User name on the remote system when using the @code{rlogin} connect
9575 @vindex nntp-address
9576 The address of the remote system running the @sc{nntp} server.
9578 @item nntp-port-number
9579 @vindex nntp-port-number
9580 Port number to connect to when using the @code{nntp-open-network-stream}
9583 @item nntp-buggy-select
9584 @vindex nntp-buggy-select
9585 Set this to non-@code{nil} if your select routine is buggy.
9587 @item nntp-nov-is-evil
9588 @vindex nntp-nov-is-evil
9589 If the @sc{nntp} server does not support @sc{nov}, you could set this
9590 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
9593 @item nntp-xover-commands
9594 @vindex nntp-xover-commands
9597 List of strings used as commands to fetch @sc{nov} lines from a
9598 server. The default value of this variable is @code{("XOVER"
9602 @vindex nntp-nov-gap
9603 @code{nntp} normally sends just one big request for @sc{nov} lines to
9604 the server. The server responds with one huge list of lines. However,
9605 if you have read articles 2-5000 in the group, and only want to read
9606 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
9607 lines that you will not need. This variable says how
9608 big a gap between two consecutive articles is allowed to be before the
9609 @code{XOVER} request is split into several request. Note that if your
9610 network is fast, setting this variable to a really small number means
9611 that fetching will probably be slower. If this variable is @code{nil},
9612 @code{nntp} will never split requests. The default is 5.
9614 @item nntp-prepare-server-hook
9615 @vindex nntp-prepare-server-hook
9616 A hook run before attempting to connect to an @sc{nntp} server.
9618 @item nntp-warn-about-losing-connection
9619 @vindex nntp-warn-about-losing-connection
9620 If this variable is non-@code{nil}, some noise will be made when a
9621 server closes connection.
9623 @item nntp-record-commands
9624 @vindex nntp-record-commands
9625 If non-@code{nil}, @code{nntp} will log all commands it sends to the
9626 @sc{nntp} server (along with a timestep) in the @samp{*nntp-log*}
9627 buffer. This is useful if you are debugging a Gnus/@sc{nntp} connection
9628 that doesn't seem to work.
9634 @subsection News Spool
9638 Subscribing to a foreign group from the local spool is extremely easy,
9639 and might be useful, for instance, to speed up reading groups that
9640 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
9643 Anyways, you just specify @code{nnspool} as the method and @code{""} (or
9644 anything else) as the address.
9646 If you have access to a local spool, you should probably use that as the
9647 native select method (@pxref{Finding the News}). It is normally faster
9648 than using an @code{nntp} select method, but might not be. It depends.
9649 You just have to try to find out what's best at your site.
9653 @item nnspool-inews-program
9654 @vindex nnspool-inews-program
9655 Program used to post an article.
9657 @item nnspool-inews-switches
9658 @vindex nnspool-inews-switches
9659 Parameters given to the inews program when posting an article.
9661 @item nnspool-spool-directory
9662 @vindex nnspool-spool-directory
9663 Where @code{nnspool} looks for the articles. This is normally
9664 @file{/usr/spool/news/}.
9666 @item nnspool-nov-directory
9667 @vindex nnspool-nov-directory
9668 Where @code{nnspool} will look for @sc{nov} files. This is normally
9669 @file{/usr/spool/news/over.view/}.
9671 @item nnspool-lib-dir
9672 @vindex nnspool-lib-dir
9673 Where the news lib dir is (@file{/usr/lib/news/} by default).
9675 @item nnspool-active-file
9676 @vindex nnspool-active-file
9677 The path to the active file.
9679 @item nnspool-newsgroups-file
9680 @vindex nnspool-newsgroups-file
9681 The path to the group descriptions file.
9683 @item nnspool-history-file
9684 @vindex nnspool-history-file
9685 The path to the news history file.
9687 @item nnspool-active-times-file
9688 @vindex nnspool-active-times-file
9689 The path to the active date file.
9691 @item nnspool-nov-is-evil
9692 @vindex nnspool-nov-is-evil
9693 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
9696 @item nnspool-sift-nov-with-sed
9697 @vindex nnspool-sift-nov-with-sed
9699 If non-@code{nil}, which is the default, use @code{sed} to get the
9700 relevant portion from the overview file. If nil, @code{nnspool} will
9701 load the entire file into a buffer and process it there.
9707 @section Getting Mail
9708 @cindex reading mail
9711 Reading mail with a newsreader---isn't that just plain WeIrD? But of
9715 * Getting Started Reading Mail:: A simple cookbook example.
9716 * Splitting Mail:: How to create mail groups.
9717 * Mail Backend Variables:: Variables for customizing mail handling.
9718 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
9719 * Mail and Procmail:: Reading mail groups that procmail create.
9720 * Incorporating Old Mail:: What about the old mail you have?
9721 * Expiring Mail:: Getting rid of unwanted mail.
9722 * Washing Mail:: Removing gruft from the mail you get.
9723 * Duplicates:: Dealing with duplicated mail.
9724 * Not Reading Mail:: Using mail backends for reading other files.
9725 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
9729 @node Getting Started Reading Mail
9730 @subsection Getting Started Reading Mail
9732 It's quite easy to use Gnus to read your new mail. You just plonk the
9733 mail backend of your choice into @code{gnus-secondary-select-methods},
9734 and things will happen automatically.
9736 For instance, if you want to use @code{nnml} (which is a "one file per
9737 mail" backend), you could put the following in your @file{.gnus} file:
9740 (setq gnus-secondary-select-methods
9741 '((nnml "private")))
9744 Now, the next time you start Gnus, this backend will be queried for new
9745 articles, and it will move all the messages in your spool file to its
9746 directory, which is @code{~/Mail/} by default. The new group that will
9747 be created (@samp{mail.misc}) will be subscribed, and you can read it
9748 like any other group.
9750 You will probably want to split the mail into several groups, though:
9753 (setq nnmail-split-methods
9754 '(("junk" "^From:.*Lars Ingebrigtsen")
9755 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
9759 This will result in three new @code{nnml} mail groups being created:
9760 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
9761 mail that doesn't fit into the first two groups will be placed in the
9764 This should be sufficient for reading mail with Gnus. You might want to
9765 give the other sections in this part of the manual a perusal, though.
9766 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
9769 @node Splitting Mail
9770 @subsection Splitting Mail
9771 @cindex splitting mail
9772 @cindex mail splitting
9774 @vindex nnmail-split-methods
9775 The @code{nnmail-split-methods} variable says how the incoming mail is
9776 to be split into groups.
9779 (setq nnmail-split-methods
9780 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
9781 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
9785 This variable is a list of lists, where the first element of each of
9786 these lists is the name of the mail group (they do not have to be called
9787 something beginning with @samp{mail}, by the way), and the second
9788 element is a regular expression used on the header of each mail to
9789 determine if it belongs in this mail group. The first string may
9790 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
9791 insert sub-expressions from the matched text. For instance:
9794 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
9797 The second element can also be a function. In that case, it will be
9798 called narrowed to the headers with the first element of the rule as the
9799 argument. It should return a non-@code{nil} value if it thinks that the
9800 mail belongs in that group.
9802 The last of these groups should always be a general one, and the regular
9803 expression should @emph{always} be @samp{} so that it matches any mails
9804 that haven't been matched by any of the other regexps. (These rules are
9805 processed from the beginning of the alist toward the end. The first
9806 rule to make a match will "win", unless you have crossposting enabled.
9807 In that case, all matching rules will "win".)
9809 If you like to tinker with this yourself, you can set this variable to a
9810 function of your choice. This function will be called without any
9811 arguments in a buffer narrowed to the headers of an incoming mail
9812 message. The function should return a list of group names that it
9813 thinks should carry this mail message.
9815 Note that the mail backends are free to maul the poor, innocent,
9816 incoming headers all they want to. They all add @code{Lines} headers;
9817 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
9818 @code{From<SPACE>} line to something else.
9820 @vindex nnmail-crosspost
9821 The mail backends all support cross-posting. If several regexps match,
9822 the mail will be ``cross-posted'' to all those groups.
9823 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
9824 that no articles are crossposted to the general (@samp{}) group.
9826 @vindex nnmail-crosspost-link-function
9829 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
9830 the crossposted articles. However, not all file systems support hard
9831 links. If that's the case for you, set
9832 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
9833 variable is @code{add-name-to-file} by default.)
9835 @findex nnmail-split-header-length-limit
9836 Header lines may be arbitrarily long. However, the longer a line is,
9837 the longer it takes to match them. Very long lines may lead to Gnus
9838 taking forever to split the mail, so Gnus excludes lines that are longer
9839 than @code{nnmail-split-header-length-limit} (which defaults to 1024).
9841 @kindex M-x nnmail-split-history
9842 @kindex nnmail-split-history
9843 If you wish to see where the previous mail split put the messages, you
9844 can use the @kbd{M-x nnmail-split-history} command.
9846 Gnus gives you all the opportunity you could possibly want for shooting
9847 yourself in the foot. Let's say you create a group that will contain
9848 all the mail you get from your boss. And then you accidentally
9849 unsubscribe from the group. Gnus will still put all the mail from your
9850 boss in the unsubscribed group, and so, when your boss mails you ``Have
9851 that report ready by Monday or you're fired!'', you'll never see it and,
9852 come Tuesday, you'll still believe that you're gainfully employed while
9853 you really should be out collecting empty bottles to save up for next
9857 @node Mail Backend Variables
9858 @subsection Mail Backend Variables
9860 These variables are (for the most part) pertinent to all the various
9864 @vindex nnmail-read-incoming-hook
9865 @item nnmail-read-incoming-hook
9866 The mail backends all call this hook after reading new mail. You can
9867 use this hook to notify any mail watch programs, if you want to.
9869 @vindex nnmail-spool-file
9870 @item nnmail-spool-file
9874 @vindex nnmail-pop-password
9875 @vindex nnmail-pop-password-required
9876 The backends will look for new mail in this file. If this variable is
9877 @code{nil}, the mail backends will never attempt to fetch mail by
9878 themselves. If you are using a POP mail server and your name is
9879 @samp{larsi}, you should set this variable to @samp{po:larsi}. If
9880 your name is not @samp{larsi}, you should probably modify that
9881 slightly, but you may have guessed that already, you smart & handsome
9882 devil! You can also set this variable to @code{pop}, and Gnus will try
9883 to figure out the POP mail string by itself. In any case, Gnus will
9884 call @code{movemail} which will contact the POP server named in the
9885 @code{MAILHOST} environment variable. If the POP server needs a
9886 password, you can either set @code{nnmail-pop-password-required} to
9887 @code{t} and be prompted for the password, or set
9888 @code{nnmail-pop-password} to the password itself.
9890 @code{nnmail-spool-file} can also be a list of mailboxes.
9892 Your Emacs has to have been configured with @samp{--with-pop} before
9893 compilation. This is the default, but some installations have it
9896 When you use a mail backend, Gnus will slurp all your mail from your
9897 inbox and plonk it down in your home directory. Gnus doesn't move any
9898 mail if you're not using a mail backend---you have to do a lot of magic
9899 invocations first. At the time when you have finished drawing the
9900 pentagram, lightened the candles, and sacrificed the goat, you really
9901 shouldn't be too surprised when Gnus moves your mail.
9903 @vindex nnmail-use-procmail
9904 @vindex nnmail-procmail-suffix
9905 @item nnmail-use-procmail
9906 If non-@code{nil}, the mail backends will look in
9907 @code{nnmail-procmail-directory} for incoming mail. All the files in
9908 that directory that have names ending in @code{nnmail-procmail-suffix}
9909 will be considered incoming mailboxes, and will be searched for new
9912 @vindex nnmail-crash-box
9913 @item nnmail-crash-box
9914 When a mail backend reads a spool file, mail is first moved to this
9915 file, which is @file{~/.gnus-crash-box} by default. If this file
9916 already exists, it will always be read (and incorporated) before any
9919 @vindex nnmail-split-hook
9920 @item nnmail-split-hook
9921 @findex article-decode-encoded-words
9922 @findex RFC1522 decoding
9923 @findex RFC2047 decoding
9924 Hook run in the buffer where the mail headers of each message is kept
9925 just before the splitting based on these headers is done. The hook is
9926 free to modify the buffer contents in any way it sees fit---the buffer
9927 is discarded after the splitting has been done, and no changes performed
9928 in the buffer will show up in any files.
9929 @code{gnus-article-decode-encoded-words} is one likely function to add
9932 @vindex nnmail-pre-get-new-mail-hook
9933 @vindex nnmail-post-get-new-mail-hook
9934 @item nnmail-pre-get-new-mail-hook
9935 @itemx nnmail-post-get-new-mail-hook
9936 These are two useful hooks executed when treating new incoming
9937 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
9938 starting to handle the new mail) and
9939 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
9940 is done). Here's and example of using these two hooks to change the
9941 default file modes the new mail files get:
9944 (add-hook 'gnus-pre-get-new-mail-hook
9945 (lambda () (set-default-file-modes 511)))
9947 (add-hook 'gnus-post-get-new-mail-hook
9948 (lambda () (set-default-file-modes 551)))
9951 @item nnmail-tmp-directory
9952 @vindex nnmail-tmp-directory
9953 This variable says where to move incoming mail to -- while processing
9954 it. This is usually done in the same directory that the mail backend
9955 inhabits (e.g., @file{~/Mail/}), but if this variable is non-@code{nil},
9956 it will be used instead.
9958 @item nnmail-movemail-program
9959 @vindex nnmail-movemail-program
9960 This program is executed to move mail from the user's inbox to her home
9961 directory. The default is @samp{movemail}.
9963 This can also be a function. In that case, the function will be called
9964 with two parameters -- the name of the inbox, and the file to be moved
9967 @item nnmail-delete-incoming
9968 @vindex nnmail-delete-incoming
9969 @cindex incoming mail files
9970 @cindex deleting incoming files
9971 If non-@code{nil}, the mail backends will delete the temporary incoming
9972 file after splitting mail into the proper groups. This is @code{t} by
9975 @c This is @code{nil} by
9976 @c default for reasons of security.
9978 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
9979 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
9980 lost mail, I think, but that's not the point. (Except certain versions
9981 of Red Gnus.)) By not deleting the Incoming* files, one can be sure not
9982 to lose mail -- if Gnus totally whacks out, one can always recover what
9985 You may delete the @file{Incoming*} files at will.
9987 @item nnmail-use-long-file-names
9988 @vindex nnmail-use-long-file-names
9989 If non-@code{nil}, the mail backends will use long file and directory
9990 names. Groups like @samp{mail.misc} will end up in directories
9991 (assuming use of @code{nnml} backend) or files (assuming use of
9992 @code{nnfolder} backend) like @file{mail.misc}. If it is @code{nil},
9993 the same group will end up in @file{mail/misc}.
9995 @item nnmail-delete-file-function
9996 @vindex nnmail-delete-file-function
9998 Function called to delete files. It is @code{delete-file} by default.
10000 @item nnmail-cache-accepted-message-ids
10001 @vindex nnmail-cache-accepted-message-ids
10002 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
10003 the backend (via @code{Gcc}, for instance) into the mail duplication
10004 discovery cache. The default is @code{nil}.
10009 @node Fancy Mail Splitting
10010 @subsection Fancy Mail Splitting
10011 @cindex mail splitting
10012 @cindex fancy mail splitting
10014 @vindex nnmail-split-fancy
10015 @findex nnmail-split-fancy
10016 If the rather simple, standard method for specifying how to split mail
10017 doesn't allow you to do what you want, you can set
10018 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
10019 play with the @code{nnmail-split-fancy} variable.
10021 Let's look at an example value of this variable first:
10024 ;; Messages from the mailer daemon are not crossposted to any of
10025 ;; the ordinary groups. Warnings are put in a separate group
10026 ;; from real errors.
10027 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
10029 ;; Non-error messages are crossposted to all relevant
10030 ;; groups, but we don't crosspost between the group for the
10031 ;; (ding) list and the group for other (ding) related mail.
10032 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
10033 ("subject" "ding" "ding.misc"))
10034 ;; Other mailing lists...
10035 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
10036 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
10038 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
10039 ;; Unmatched mail goes to the catch all group.
10043 This variable has the format of a @dfn{split}. A split is a (possibly)
10044 recursive structure where each split may contain other splits. Here are
10045 the five possible split syntaxes:
10050 @samp{group}: If the split is a string, that will be taken as a group
10051 name. Normal regexp match expansion will be done. See below for
10055 @var{(FIELD VALUE SPLIT)}: If the split is a list, the first element of
10056 which is a string, then store the message as specified by SPLIT, if
10057 header FIELD (a regexp) contains VALUE (also a regexp).
10060 @var{(| SPLIT...)}: If the split is a list, and the first element is
10061 @code{|} (vertical bar), then process each SPLIT until one of them
10062 matches. A SPLIT is said to match if it will cause the mail message to
10063 be stored in one or more groups.
10066 @var{(& SPLIT...)}: If the split is a list, and the first element is
10067 @code{&}, then process all SPLITs in the list.
10070 @code{junk}: If the split is the symbol @code{junk}, then don't save
10071 this message. Use with extreme caution.
10074 @var{(: function arg1 arg2 ...)}: If the split is a list, and the first
10075 element is @code{:}, then the second element will be called as a
10076 function with @var{args} given as arguments. The function should return
10080 @code{nil}: If the split is @code{nil}, it is ignored.
10084 In these splits, @var{FIELD} must match a complete field name.
10085 @var{VALUE} must match a complete word according to the fundamental mode
10086 syntax table. You can use @code{.*} in the regexps to match partial
10087 field names or words. In other words, all @var{VALUE}'s are wrapped in
10088 @samp{\<} and @samp{\>} pairs.
10090 @vindex nnmail-split-abbrev-alist
10091 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
10092 are expanded as specified by the variable
10093 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
10094 the @code{car} of a cell contains the key, and the @code{cdr} contains the associated
10097 @vindex nnmail-split-fancy-syntax-table
10098 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
10099 when all this splitting is performed.
10101 If you want to have Gnus create groups dynamically based on some
10102 information in the headers (i.e., do @code{replace-match}-like
10103 substitutions in the group names), you can say things like:
10106 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
10109 If the string contains the element @samp{\&}, then the previously
10110 matched string will be substituted. Similarly, the elements @samp{\\1}
10111 up to @samp{\\9} will be substituted with the text matched by the
10112 groupings 1 through 9.
10115 @node Mail and Procmail
10116 @subsection Mail and Procmail
10121 Many people use @code{procmail} (or some other mail filter program or
10122 external delivery agent---@code{slocal}, @code{elm}, etc) to split
10123 incoming mail into groups. If you do that, you should set
10124 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
10125 backends never ever try to fetch mail by themselves.
10127 If you have a combined @code{procmail}/POP/mailbox setup, you can do
10128 something like the following:
10130 @vindex nnmail-use-procmail
10132 (setq nnmail-use-procmail t)
10133 (setq nnmail-spool-file
10134 '("/usr/spool/mail/my-name" "po:my-name"))
10137 This also means that you probably don't want to set
10138 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
10141 When a mail backend is queried for what groups it carries, it replies
10142 with the contents of that variable, along with any groups it has figured
10143 out that it carries by other means. None of the backends, except
10144 @code{nnmh}, actually go out to the disk and check what groups actually
10145 exist. (It's not trivial to distinguish between what the user thinks is
10146 a basis for a newsgroup and what is just a plain old file or directory.)
10148 This means that you have to tell Gnus (and the backends) by hand what
10151 Let's take the @code{nnmh} backend as an example:
10153 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
10154 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
10156 Go to the group buffer and type @kbd{G m}. When prompted, answer
10157 @samp{foo} for the name and @samp{nnmh} for the method. Repeat
10158 twice for the two other groups, @samp{bar} and @samp{mail.baz}. Be sure
10159 to include all your mail groups.
10161 That's it. You are now set to read your mail. An active file for this
10162 method will be created automatically.
10164 @vindex nnmail-procmail-suffix
10165 @vindex nnmail-procmail-directory
10166 If you use @code{nnfolder} or any other backend that store more than a
10167 single article in each file, you should never have procmail add mails to
10168 the file that Gnus sees. Instead, procmail should put all incoming mail
10169 in @code{nnmail-procmail-directory}. To arrive at the file name to put
10170 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
10171 name. The mail backends will read the mail from these files.
10173 @vindex nnmail-resplit-incoming
10174 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
10175 put in the @code{mail.misc}, as one would expect. However, if you want
10176 Gnus to split the mail the normal way, you could set
10177 @code{nnmail-resplit-incoming} to @code{t}.
10179 @vindex nnmail-keep-last-article
10180 If you use @code{procmail} to split things directly into an @code{nnmh}
10181 directory (which you shouldn't do), you should set
10182 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
10183 ever expiring the final article (i.e., the article with the highest
10184 article number) in a mail newsgroup. This is quite, quite important.
10186 Here's an example setup: The incoming spools are located in
10187 @file{~/incoming/} and have @samp{""} as suffixes (i.e., the incoming
10188 spool files have the same names as the equivalent groups). The
10189 @code{nnfolder} backend is to be used as the mail interface, and the
10190 @code{nnfolder} directory is @file{~/fMail/}.
10193 (setq nnfolder-directory "~/fMail/")
10194 (setq nnmail-spool-file 'procmail)
10195 (setq nnmail-procmail-directory "~/incoming/")
10196 (setq gnus-secondary-select-methods '((nnfolder "")))
10197 (setq nnmail-procmail-suffix "")
10201 @node Incorporating Old Mail
10202 @subsection Incorporating Old Mail
10204 Most people have lots of old mail stored in various file formats. If
10205 you have set up Gnus to read mail using one of the spiffy Gnus mail
10206 backends, you'll probably wish to have that old mail incorporated into
10209 Doing so can be quite easy.
10211 To take an example: You're reading mail using @code{nnml}
10212 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
10213 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
10214 file filled with important, but old, mail. You want to move it into
10215 your @code{nnml} groups.
10221 Go to the group buffer.
10224 Type `G f' and give the path to the mbox file when prompted to create an
10225 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
10228 Type `SPACE' to enter the newly created group.
10231 Type `M P b' to process-mark all articles in this group's buffer
10232 (@pxref{Setting Process Marks}).
10235 Type `B r' to respool all the process-marked articles, and answer
10236 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
10239 All the mail messages in the mbox file will now also be spread out over
10240 all your @code{nnml} groups. Try entering them and check whether things
10241 have gone without a glitch. If things look ok, you may consider
10242 deleting the mbox file, but I wouldn't do that unless I was absolutely
10243 sure that all the mail has ended up where it should be.
10245 Respooling is also a handy thing to do if you're switching from one mail
10246 backend to another. Just respool all the mail in the old mail groups
10247 using the new mail backend.
10250 @node Expiring Mail
10251 @subsection Expiring Mail
10252 @cindex article expiry
10254 Traditional mail readers have a tendency to remove mail articles when
10255 you mark them as read, in some way. Gnus takes a fundamentally
10256 different approach to mail reading.
10258 Gnus basically considers mail just to be news that has been received in
10259 a rather peculiar manner. It does not think that it has the power to
10260 actually change the mail, or delete any mail messages. If you enter a
10261 mail group, and mark articles as ``read'', or kill them in some other
10262 fashion, the mail articles will still exist on the system. I repeat:
10263 Gnus will not delete your old, read mail. Unless you ask it to, of
10266 To make Gnus get rid of your unwanted mail, you have to mark the
10267 articles as @dfn{expirable}. This does not mean that the articles will
10268 disappear right away, however. In general, a mail article will be
10269 deleted from your system if, 1) it is marked as expirable, AND 2) it is
10270 more than one week old. If you do not mark an article as expirable, it
10271 will remain on your system until hell freezes over. This bears
10272 repeating one more time, with some spurious capitalizations: IF you do
10273 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
10275 @vindex gnus-auto-expirable-newsgroups
10276 You do not have to mark articles as expirable by hand. Groups that
10277 match the regular expression @code{gnus-auto-expirable-newsgroups} will
10278 have all articles that you read marked as expirable automatically. All
10279 articles marked as expirable have an @samp{E} in the first
10280 column in the summary buffer.
10282 By default, if you have auto expiry switched on, Gnus will mark all the
10283 articles you read as expirable, no matter if they were read or unread
10284 before. To avoid having articles marked as read marked as expirable
10285 automatically, you can put something like the following in your
10288 @vindex gnus-mark-article-hook
10290 (remove-hook 'gnus-mark-article-hook
10291 'gnus-summary-mark-read-and-unread-as-read)
10292 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
10295 Note that making a group auto-expirable doesn't mean that all read
10296 articles are expired---only the articles marked as expirable
10297 will be expired. Also note that using the @kbd{d} command won't make
10298 groups expirable---only semi-automatic marking of articles as read will
10299 mark the articles as expirable in auto-expirable groups.
10301 Let's say you subscribe to a couple of mailing lists, and you want the
10302 articles you have read to disappear after a while:
10305 (setq gnus-auto-expirable-newsgroups
10306 "mail.nonsense-list\\|mail.nice-list")
10309 Another way to have auto-expiry happen is to have the element
10310 @code{auto-expire} in the group parameters of the group.
10312 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
10313 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
10314 don't really mix very well.
10316 @vindex nnmail-expiry-wait
10317 The @code{nnmail-expiry-wait} variable supplies the default time an
10318 expirable article has to live. Gnus starts counting days from when the
10319 message @emph{arrived}, not from when it was sent. The default is seven
10322 Gnus also supplies a function that lets you fine-tune how long articles
10323 are to live, based on what group they are in. Let's say you want to
10324 have one month expiry period in the @samp{mail.private} group, a one day
10325 expiry period in the @samp{mail.junk} group, and a six day expiry period
10328 @vindex nnmail-expiry-wait-function
10330 (setq nnmail-expiry-wait-function
10332 (cond ((string= group "mail.private")
10334 ((string= group "mail.junk")
10336 ((string= group "important")
10342 The group names this function is fed are ``unadorned'' group
10343 names---no @samp{nnml:} prefixes and the like.
10345 The @code{nnmail-expiry-wait} variable and
10346 @code{nnmail-expiry-wait-function} function can either be a number (not
10347 necessarily an integer) or one of the symbols @code{immediate} or
10350 You can also use the @code{expiry-wait} group parameter to selectively
10351 change the expiry period (@pxref{Group Parameters}).
10353 @vindex nnmail-keep-last-article
10354 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
10355 expire the final article in a mail newsgroup. This is to make life
10356 easier for procmail users.
10358 @vindex gnus-total-expirable-newsgroups
10359 By the way: That line up there, about Gnus never expiring non-expirable
10360 articles, is a lie. If you put @code{total-expire} in the group
10361 parameters, articles will not be marked as expirable, but all read
10362 articles will be put through the expiry process. Use with extreme
10363 caution. Even more dangerous is the
10364 @code{gnus-total-expirable-newsgroups} variable. All groups that match
10365 this regexp will have all read articles put through the expiry process,
10366 which means that @emph{all} old mail articles in the groups in question
10367 will be deleted after a while. Use with extreme caution, and don't come
10368 crying to me when you discover that the regexp you used matched the
10369 wrong group and all your important mail has disappeared. Be a
10370 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
10373 Most people make most of their mail groups total-expirable, though.
10375 @vindex gnus-inhibit-user-auto-expire
10376 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
10377 commands will not mark an article as expirable, even if the group has
10378 auto-expire turned on.
10382 @subsection Washing Mail
10383 @cindex mail washing
10384 @cindex list server brain damage
10385 @cindex incoming mail treatment
10387 Mailers and list servers are notorious for doing all sorts of really,
10388 really stupid things with mail. ``Hey, RFC822 doesn't explicitly
10389 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
10390 end of all lines passing through our server, so let's do that!!!!1!''
10391 Yes, but RFC822 wasn't designed to be read by morons. Things that were
10392 considered to be self-evident were not discussed. So. Here we are.
10394 Case in point: The German version of Microsoft Exchange adds @samp{AW:
10395 } to the subjects of replies instead of @samp{Re: }. I could pretend to
10396 be shocked and dismayed by this, but I haven't got the energy. It is to
10399 Gnus provides a plethora of functions for washing articles while
10400 displaying them, but it might be nicer to do the filtering before
10401 storing the mail to disc. For that purpose, we have three hooks and
10402 various functions that can be put in these hooks.
10405 @item nnmail-prepare-incoming-hook
10406 @vindex nnmail-prepare-incoming-hook
10407 This hook is called before doing anything with the mail and is meant for
10408 grand, sweeping gestures. It is called in a buffer that contains all
10409 the new, incoming mail. Functions to be used include:
10412 @item nnheader-ms-strip-cr
10413 @findex nnheader-ms-strip-cr
10414 Remove trailing carriage returns from each line. This is default on
10415 Emacs running on MS machines.
10419 @item nnmail-prepare-incoming-header-hook
10420 @vindex nnmail-prepare-incoming-header-hook
10421 This hook is called narrowed to each header. It can be used when
10422 cleaning up the headers. Functions that can be used include:
10425 @item nnmail-remove-leading-whitespace
10426 @findex nnmail-remove-leading-whitespace
10427 Clear leading white space that ``helpful'' listservs have added to the
10428 headers to make them look nice. Aaah.
10430 @item nnmail-remove-list-identifiers
10431 @findex nnmail-remove-list-identifiers
10432 Some list servers add an identifier---for example, @samp{(idm)}---to the
10433 beginning of all @code{Subject} headers. I'm sure that's nice for
10434 people who use stone age mail readers. This function will remove
10435 strings that match the @code{nnmail-list-identifiers} regexp, which can
10436 also be a list of regexp.
10438 For instance, if you want to remove the @samp{(idm)} and the
10439 @samp{nagnagnag} identifiers:
10442 (setq nnmail-list-identifiers
10443 '("(idm)" "nagnagnag"))
10446 @item nnmail-remove-tabs
10447 @findex nnmail-remove-tabs
10448 Translate all @samp{TAB} characters into @samp{SPACE} characters.
10452 @item nnmail-prepare-incoming-message-hook
10453 @vindex nnmail-prepare-incoming-message-hook
10454 This hook is called narrowed to each message. Functions to be used
10458 @item article-de-quoted-unreadable
10459 @findex article-de-quoted-unreadable
10460 Decode Quoted Readable encoding.
10467 @subsection Duplicates
10469 @vindex nnmail-treat-duplicates
10470 @vindex nnmail-message-id-cache-length
10471 @vindex nnmail-message-id-cache-file
10472 @cindex duplicate mails
10473 If you are a member of a couple of mailing lists, you will sometimes
10474 receive two copies of the same mail. This can be quite annoying, so
10475 @code{nnmail} checks for and treats any duplicates it might find. To do
10476 this, it keeps a cache of old @code{Message-ID}s---
10477 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
10478 default. The approximate maximum number of @code{Message-ID}s stored
10479 there is controlled by the @code{nnmail-message-id-cache-length}
10480 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
10481 stored.) If all this sounds scary to you, you can set
10482 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
10483 default), and @code{nnmail} won't delete duplicate mails. Instead it
10484 will insert a warning into the head of the mail saying that it thinks
10485 that this is a duplicate of a different message.
10487 This variable can also be a function. If that's the case, the function
10488 will be called from a buffer narrowed to the message in question with
10489 the @code{Message-ID} as a parameter. The function must return either
10490 @code{nil}, @code{warn}, or @code{delete}.
10492 You can turn this feature off completely by setting the variable to
10495 If you want all the duplicate mails to be put into a special
10496 @dfn{duplicates} group, you could do that using the normal mail split
10500 (setq nnmail-split-fancy
10501 '(| ;; Messages duplicates go to a separate group.
10502 ("gnus-warning" "duplication of message" "duplicate")
10503 ;; Message from daemons, postmaster, and the like to another.
10504 (any mail "mail.misc")
10511 (setq nnmail-split-methods
10512 '(("duplicates" "^Gnus-Warning:")
10517 Here's a neat feature: If you know that the recipient reads her mail
10518 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
10519 @code{delete}, you can send her as many insults as you like, just by
10520 using a @code{Message-ID} of a mail that you know that she's already
10521 received. Think of all the fun! She'll never see any of it! Whee!
10524 @node Not Reading Mail
10525 @subsection Not Reading Mail
10527 If you start using any of the mail backends, they have the annoying
10528 habit of assuming that you want to read mail with them. This might not
10529 be unreasonable, but it might not be what you want.
10531 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
10532 will ever attempt to read incoming mail, which should help.
10534 @vindex nnbabyl-get-new-mail
10535 @vindex nnmbox-get-new-mail
10536 @vindex nnml-get-new-mail
10537 @vindex nnmh-get-new-mail
10538 @vindex nnfolder-get-new-mail
10539 This might be too much, if, for instance, you are reading mail quite
10540 happily with @code{nnml} and just want to peek at some old @sc{rmail}
10541 file you have stashed away with @code{nnbabyl}. All backends have
10542 variables called backend-@code{get-new-mail}. If you want to disable
10543 the @code{nnbabyl} mail reading, you edit the virtual server for the
10544 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
10546 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
10547 narrowed to the article to be saved before saving it when reading
10551 @node Choosing a Mail Backend
10552 @subsection Choosing a Mail Backend
10554 Gnus will read the mail spool when you activate a mail group. The mail
10555 file is first copied to your home directory. What happens after that
10556 depends on what format you want to store your mail in.
10559 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
10560 * Rmail Babyl:: Emacs programs use the rmail babyl format.
10561 * Mail Spool:: Store your mail in a private spool?
10562 * MH Spool:: An mhspool-like backend.
10563 * Mail Folders:: Having one file for each group.
10567 @node Unix Mail Box
10568 @subsubsection Unix Mail Box
10570 @cindex unix mail box
10572 @vindex nnmbox-active-file
10573 @vindex nnmbox-mbox-file
10574 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
10575 mail. @code{nnmbox} will add extra headers to each mail article to say
10576 which group it belongs in.
10578 Virtual server settings:
10581 @item nnmbox-mbox-file
10582 @vindex nnmbox-mbox-file
10583 The name of the mail box in the user's home directory.
10585 @item nnmbox-active-file
10586 @vindex nnmbox-active-file
10587 The name of the active file for the mail box.
10589 @item nnmbox-get-new-mail
10590 @vindex nnmbox-get-new-mail
10591 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
10597 @subsubsection Rmail Babyl
10601 @vindex nnbabyl-active-file
10602 @vindex nnbabyl-mbox-file
10603 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
10604 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
10605 article to say which group it belongs in.
10607 Virtual server settings:
10610 @item nnbabyl-mbox-file
10611 @vindex nnbabyl-mbox-file
10612 The name of the rmail mbox file.
10614 @item nnbabyl-active-file
10615 @vindex nnbabyl-active-file
10616 The name of the active file for the rmail box.
10618 @item nnbabyl-get-new-mail
10619 @vindex nnbabyl-get-new-mail
10620 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
10625 @subsubsection Mail Spool
10627 @cindex mail @sc{nov} spool
10629 The @dfn{nnml} spool mail format isn't compatible with any other known
10630 format. It should be used with some caution.
10632 @vindex nnml-directory
10633 If you use this backend, Gnus will split all incoming mail into files,
10634 one file for each mail, and put the articles into the corresponding
10635 directories under the directory specified by the @code{nnml-directory}
10636 variable. The default value is @file{~/Mail/}.
10638 You do not have to create any directories beforehand; Gnus will take
10641 If you have a strict limit as to how many files you are allowed to store
10642 in your account, you should not use this backend. As each mail gets its
10643 own file, you might very well occupy thousands of inodes within a few
10644 weeks. If this is no problem for you, and it isn't a problem for you
10645 having your friendly systems administrator walking around, madly,
10646 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
10647 know that this is probably the fastest format to use. You do not have
10648 to trudge through a big mbox file just to read your new mail.
10650 @code{nnml} is probably the slowest backend when it comes to article
10651 splitting. It has to create lots of files, and it also generates
10652 @sc{nov} databases for the incoming mails. This makes it the fastest
10653 backend when it comes to reading mail.
10655 Virtual server settings:
10658 @item nnml-directory
10659 @vindex nnml-directory
10660 All @code{nnml} directories will be placed under this directory.
10662 @item nnml-active-file
10663 @vindex nnml-active-file
10664 The active file for the @code{nnml} server.
10666 @item nnml-newsgroups-file
10667 @vindex nnml-newsgroups-file
10668 The @code{nnml} group descriptions file. @xref{Newsgroups File
10671 @item nnml-get-new-mail
10672 @vindex nnml-get-new-mail
10673 If non-@code{nil}, @code{nnml} will read incoming mail.
10675 @item nnml-nov-is-evil
10676 @vindex nnml-nov-is-evil
10677 If non-@code{nil}, this backend will ignore any @sc{nov} files.
10679 @item nnml-nov-file-name
10680 @vindex nnml-nov-file-name
10681 The name of the @sc{nov} files. The default is @file{.overview}.
10683 @item nnml-prepare-save-mail-hook
10684 @vindex nnml-prepare-save-mail-hook
10685 Hook run narrowed to an article before saving.
10689 @findex nnml-generate-nov-databases
10690 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
10691 you can do a complete update by typing @kbd{M-x
10692 nnml-generate-nov-databases}. This command will trawl through the
10693 entire @code{nnml} hierarchy, looking at each and every article, so it
10694 might take a while to complete. A better interface to this
10695 functionality can be found in the server buffer (@pxref{Server
10700 @subsubsection MH Spool
10702 @cindex mh-e mail spool
10704 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
10705 @sc{nov} databases and it doesn't keep an active file. This makes
10706 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
10707 makes it easier to write procmail scripts for.
10709 Virtual server settings:
10712 @item nnmh-directory
10713 @vindex nnmh-directory
10714 All @code{nnmh} directories will be located under this directory.
10716 @item nnmh-get-new-mail
10717 @vindex nnmh-get-new-mail
10718 If non-@code{nil}, @code{nnmh} will read incoming mail.
10721 @vindex nnmh-be-safe
10722 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
10723 sure that the articles in the folder are actually what Gnus thinks they
10724 are. It will check date stamps and stat everything in sight, so
10725 setting this to @code{t} will mean a serious slow-down. If you never
10726 use anything but Gnus to read the @code{nnmh} articles, you do not have
10727 to set this variable to @code{t}.
10732 @subsubsection Mail Folders
10734 @cindex mbox folders
10735 @cindex mail folders
10737 @code{nnfolder} is a backend for storing each mail group in a separate
10738 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
10739 will add extra headers to keep track of article numbers and arrival
10742 Virtual server settings:
10745 @item nnfolder-directory
10746 @vindex nnfolder-directory
10747 All the @code{nnfolder} mail boxes will be stored under this directory.
10749 @item nnfolder-active-file
10750 @vindex nnfolder-active-file
10751 The name of the active file.
10753 @item nnfolder-newsgroups-file
10754 @vindex nnfolder-newsgroups-file
10755 The name of the group descriptions file. @xref{Newsgroups File Format}.
10757 @item nnfolder-get-new-mail
10758 @vindex nnfolder-get-new-mail
10759 If non-@code{nil}, @code{nnfolder} will read incoming mail.
10761 @item nnfolder-save-buffer-hook
10762 @vindex nnfolder-save-buffer-hook
10763 @cindex backup files
10764 Hook run before saving the folders. Note that Emacs does the normal
10765 backup renaming of files even with the @code{nnfolder} buffers. If you
10766 wish to switch this off, you could say something like the following in
10767 your @file{.emacs} file:
10770 (defun turn-off-backup ()
10771 (set (make-local-variable 'backup-inhibited) t))
10773 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
10776 @item nnfolder-delete-mail-hook
10777 @vindex nnfolder-delete-mail-hook
10778 Hook run in a buffer narrowed to the message that is to be deleted.
10779 This function can be used to copy the message to somewhere else, or to
10780 extract some information from it before removing it.
10785 @findex nnfolder-generate-active-file
10786 @kindex M-x nnfolder-generate-active-file
10787 If you have lots of @code{nnfolder}-like files you'd like to read with
10788 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
10789 command to make @code{nnfolder} aware of all likely files in
10790 @code{nnfolder-directory}.
10793 @node Other Sources
10794 @section Other Sources
10796 Gnus can do more than just read news or mail. The methods described
10797 below allow Gnus to view directories and files as if they were
10801 * Directory Groups:: You can read a directory as if it was a newsgroup.
10802 * Anything Groups:: Dired? Who needs dired?
10803 * Document Groups:: Single files can be the basis of a group.
10804 * SOUP:: Reading @sc{SOUP} packets ``offline''.
10805 * Web Searches:: Creating groups from articles that match a string.
10806 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
10810 @node Directory Groups
10811 @subsection Directory Groups
10813 @cindex directory groups
10815 If you have a directory that has lots of articles in separate files in
10816 it, you might treat it as a newsgroup. The files have to have numerical
10819 This might be an opportune moment to mention @code{ange-ftp} (and its
10820 successor @code{efs}), that most wonderful of all wonderful Emacs
10821 packages. When I wrote @code{nndir}, I didn't think much about it---a
10822 backend to read directories. Big deal.
10824 @code{ange-ftp} changes that picture dramatically. For instance, if you
10825 enter the @code{ange-ftp} file name
10826 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
10827 @code{ange-ftp} or @code{efs} will actually allow you to read this
10828 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
10830 @code{nndir} will use @sc{nov} files if they are present.
10832 @code{nndir} is a ``read-only'' backend---you can't delete or expire
10833 articles with this method. You can use @code{nnmh} or @code{nnml} for
10834 whatever you use @code{nndir} for, so you could switch to any of those
10835 methods if you feel the need to have a non-read-only @code{nndir}.
10838 @node Anything Groups
10839 @subsection Anything Groups
10842 From the @code{nndir} backend (which reads a single spool-like
10843 directory), it's just a hop and a skip to @code{nneething}, which
10844 pretends that any arbitrary directory is a newsgroup. Strange, but
10847 When @code{nneething} is presented with a directory, it will scan this
10848 directory and assign article numbers to each file. When you enter such
10849 a group, @code{nneething} must create ``headers'' that Gnus can use.
10850 After all, Gnus is a newsreader, in case you're
10851 forgetting. @code{nneething} does this in a two-step process. First, it
10852 snoops each file in question. If the file looks like an article (i.e.,
10853 the first few lines look like headers), it will use this as the head.
10854 If this is just some arbitrary file without a head (e.g. a C source
10855 file), @code{nneething} will cobble up a header out of thin air. It
10856 will use file ownership, name and date and do whatever it can with these
10859 All this should happen automatically for you, and you will be presented
10860 with something that looks very much like a newsgroup. Totally like a
10861 newsgroup, to be precise. If you select an article, it will be displayed
10862 in the article buffer, just as usual.
10864 If you select a line that represents a directory, Gnus will pop you into
10865 a new summary buffer for this @code{nneething} group. And so on. You can
10866 traverse the entire disk this way, if you feel like, but remember that
10867 Gnus is not dired, really, and does not intend to be, either.
10869 There are two overall modes to this action---ephemeral or solid. When
10870 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
10871 will not store information on what files you have read, and what files
10872 are new, and so on. If you create a solid @code{nneething} group the
10873 normal way with @kbd{G m}, Gnus will store a mapping table between
10874 article numbers and file names, and you can treat this group like any
10875 other groups. When you activate a solid @code{nneething} group, you will
10876 be told how many unread articles it contains, etc., etc.
10881 @item nneething-map-file-directory
10882 @vindex nneething-map-file-directory
10883 All the mapping files for solid @code{nneething} groups will be stored
10884 in this directory, which defaults to @file{~/.nneething/}.
10886 @item nneething-exclude-files
10887 @vindex nneething-exclude-files
10888 All files that match this regexp will be ignored. Nice to use to exclude
10889 auto-save files and the like, which is what it does by default.
10891 @item nneething-include-files
10892 @vindex nneething-include-files
10893 Regexp saying what files to include in the group. If this variable is
10894 non-@code{nil}, only files matching this regexp will be included.
10896 @item nneething-map-file
10897 @vindex nneething-map-file
10898 Name of the map files.
10902 @node Document Groups
10903 @subsection Document Groups
10905 @cindex documentation group
10908 @code{nndoc} is a cute little thing that will let you read a single file
10909 as a newsgroup. Several files types are supported:
10916 The babyl (rmail) mail box.
10921 The standard Unix mbox file.
10923 @cindex MMDF mail box
10925 The MMDF mail box format.
10928 Several news articles appended into a file.
10931 @cindex rnews batch files
10932 The rnews batch transport format.
10933 @cindex forwarded messages
10936 Forwarded articles.
10939 MIME multipart messages, besides digests.
10943 @cindex MIME digest
10944 @cindex 1153 digest
10945 @cindex RFC 1153 digest
10946 @cindex RFC 341 digest
10947 MIME (RFC 1341) digest format.
10949 @item standard-digest
10950 The standard (RFC 1153) digest format.
10953 Non-standard digest format---matches most things, but does it badly.
10956 You can also use the special ``file type'' @code{guess}, which means
10957 that @code{nndoc} will try to guess what file type it is looking at.
10958 @code{digest} means that @code{nndoc} should guess what digest type the
10961 @code{nndoc} will not try to change the file or insert any extra headers into
10962 it---it will simply, like, let you use the file as the basis for a
10963 group. And that's it.
10965 If you have some old archived articles that you want to insert into your
10966 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
10967 that. Say you have an old @file{RMAIL} file with mail that you now want
10968 to split into your new @code{nnml} groups. You look at that file using
10969 @code{nndoc} (using the @kbd{G f} command in the group buffer
10970 (@pxref{Foreign Groups})), set the process mark on all the articles in
10971 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
10972 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
10973 file is now also stored in lots of @code{nnml} directories, and you can
10974 delete that pesky @file{RMAIL} file. If you have the guts!
10976 Virtual server variables:
10979 @item nndoc-article-type
10980 @vindex nndoc-article-type
10981 This should be one of @code{mbox}, @code{babyl}, @code{digest},
10982 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
10983 @code{rfc822-forward}, @code{mime-parts}, @code{mime-digest},
10984 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs} or
10987 @item nndoc-post-type
10988 @vindex nndoc-post-type
10989 This variable says whether Gnus is to consider the group a news group or
10990 a mail group. There are two valid values: @code{mail} (the default)
10995 * Document Server Internals:: How to add your own document types.
10999 @node Document Server Internals
11000 @subsubsection Document Server Internals
11002 Adding new document types to be recognized by @code{nndoc} isn't
11003 difficult. You just have to whip up a definition of what the document
11004 looks like, write a predicate function to recognize that document type,
11005 and then hook into @code{nndoc}.
11007 First, here's an example document type definition:
11011 (article-begin . "^\^A\^A\^A\^A\n")
11012 (body-end . "^\^A\^A\^A\^A\n"))
11015 The definition is simply a unique @dfn{name} followed by a series of
11016 regexp pseudo-variable settings. Below are the possible
11017 variables---don't be daunted by the number of variables; most document
11018 types can be defined with very few settings:
11021 @item first-article
11022 If present, @code{nndoc} will skip past all text until it finds
11023 something that match this regexp. All text before this will be
11026 @item article-begin
11027 This setting has to be present in all document type definitions. It
11028 says what the beginning of each article looks like.
11030 @item head-begin-function
11031 If present, this should be a function that moves point to the head of
11034 @item nndoc-head-begin
11035 If present, this should be a regexp that matches the head of the
11038 @item nndoc-head-end
11039 This should match the end of the head of the article. It defaults to
11040 @samp{^$}---the empty line.
11042 @item body-begin-function
11043 If present, this function should move point to the beginning of the body
11047 This should match the beginning of the body of the article. It defaults
11050 @item body-end-function
11051 If present, this function should move point to the end of the body of
11055 If present, this should match the end of the body of the article.
11058 If present, this should match the end of the file. All text after this
11059 regexp will be totally ignored.
11063 So, using these variables @code{nndoc} is able to dissect a document
11064 file into a series of articles, each with a head and a body. However, a
11065 few more variables are needed since not all document types are all that
11066 news-like---variables needed to transform the head or the body into
11067 something that's palatable for Gnus:
11070 @item prepare-body-function
11071 If present, this function will be called when requesting an article. It
11072 will be called with point at the start of the body, and is useful if the
11073 document has encoded some parts of its contents.
11075 @item article-transform-function
11076 If present, this function is called when requesting an article. It's
11077 meant to be used for more wide-ranging transformation of both head and
11078 body of the article.
11080 @item generate-head-function
11081 If present, this function is called to generate a head that Gnus can
11082 understand. It is called with the article number as a parameter, and is
11083 expected to generate a nice head for the article in question. It is
11084 called when requesting the headers of all articles.
11088 Let's look at the most complicated example I can come up with---standard
11093 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
11094 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
11095 (prepare-body-function . nndoc-unquote-dashes)
11096 (body-end-function . nndoc-digest-body-end)
11097 (head-end . "^ ?$")
11098 (body-begin . "^ ?\n")
11099 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
11100 (subtype digest guess))
11103 We see that all text before a 70-width line of dashes is ignored; all
11104 text after a line that starts with that @samp{^End of} is also ignored;
11105 each article begins with a 30-width line of dashes; the line separating
11106 the head from the body may contain a single space; and that the body is
11107 run through @code{nndoc-unquote-dashes} before being delivered.
11109 To hook your own document definition into @code{nndoc}, use the
11110 @code{nndoc-add-type} function. It takes two parameters---the first is
11111 the definition itself and the second (optional) parameter says where in
11112 the document type definition alist to put this definition. The alist is
11113 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
11114 is of @code{mmdf} type, and so on. These type predicates should return
11115 @code{nil} if the document is not of the correct type; @code{t} if it is
11116 of the correct type; and a number if the document might be of the
11117 correct type. A high number means high probability; a low number means
11118 low probability with @samp{0} being the lowest valid number.
11126 In the PC world people often talk about ``offline'' newsreaders. These
11127 are thingies that are combined reader/news transport monstrosities.
11128 With built-in modem programs. Yecchh!
11130 Of course, us Unix Weenie types of human beans use things like
11131 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
11132 transport things like Ghod intended. And then we just use normal
11135 However, it can sometimes be convenient to do something a that's a bit
11136 easier on the brain if you have a very slow modem, and you're not really
11137 that interested in doing things properly.
11139 A file format called @sc{soup} has been developed for transporting news
11140 and mail from servers to home machines and back again. It can be a bit
11143 First some terminology:
11148 This is the machine that is connected to the outside world and where you
11149 get news and/or mail from.
11152 This is the machine that you want to do the actual reading and responding
11153 on. It is typically not connected to the rest of the world in any way.
11156 Something that contains messages and/or commands. There are two kinds
11160 @item message packets
11161 These are packets made at the server, and typically contain lots of
11162 messages for you to read. These are called @file{SoupoutX.tgz} by
11163 default, where @var{X} is a number.
11165 @item response packets
11166 These are packets made at the home machine, and typically contains
11167 replies that you've written. These are called @file{SoupinX.tgz} by
11168 default, where @var{X} is a number.
11178 You log in on the server and create a @sc{soup} packet. You can either
11179 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
11180 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
11181 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
11184 You transfer the packet home. Rail, boat, car or modem will do fine.
11187 You put the packet in your home directory.
11190 You fire up Gnus on your home machine using the @code{nnsoup} backend as
11191 the native or secondary server.
11194 You read articles and mail and answer and followup to the things you
11195 want (@pxref{SOUP Replies}).
11198 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
11202 You transfer this packet to the server.
11205 You use Gnus to mail this packet out with the @kbd{G s s} command.
11208 You then repeat until you die.
11212 So you basically have a bipartite system---you use @code{nnsoup} for
11213 reading and Gnus for packing/sending these @sc{soup} packets.
11216 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
11217 * SOUP Groups:: A backend for reading @sc{soup} packets.
11218 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
11222 @node SOUP Commands
11223 @subsubsection SOUP Commands
11225 These are commands for creating and manipulating @sc{soup} packets.
11229 @kindex G s b (Group)
11230 @findex gnus-group-brew-soup
11231 Pack all unread articles in the current group
11232 (@code{gnus-group-brew-soup}). This command understands the
11233 process/prefix convention.
11236 @kindex G s w (Group)
11237 @findex gnus-soup-save-areas
11238 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
11241 @kindex G s s (Group)
11242 @findex gnus-soup-send-replies
11243 Send all replies from the replies packet
11244 (@code{gnus-soup-send-replies}).
11247 @kindex G s p (Group)
11248 @findex gnus-soup-pack-packet
11249 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
11252 @kindex G s r (Group)
11253 @findex nnsoup-pack-replies
11254 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
11257 @kindex O s (Summary)
11258 @findex gnus-soup-add-article
11259 This summary-mode command adds the current article to a @sc{soup} packet
11260 (@code{gnus-soup-add-article}). It understands the process/prefix
11261 convention (@pxref{Process/Prefix}).
11266 There are a few variables to customize where Gnus will put all these
11271 @item gnus-soup-directory
11272 @vindex gnus-soup-directory
11273 Directory where Gnus will save intermediate files while composing
11274 @sc{soup} packets. The default is @file{~/SoupBrew/}.
11276 @item gnus-soup-replies-directory
11277 @vindex gnus-soup-replies-directory
11278 This is what Gnus will use as a temporary directory while sending our
11279 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
11281 @item gnus-soup-prefix-file
11282 @vindex gnus-soup-prefix-file
11283 Name of the file where Gnus stores the last used prefix. The default is
11284 @samp{gnus-prefix}.
11286 @item gnus-soup-packer
11287 @vindex gnus-soup-packer
11288 A format string command for packing a @sc{soup} packet. The default is
11289 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
11291 @item gnus-soup-unpacker
11292 @vindex gnus-soup-unpacker
11293 Format string command for unpacking a @sc{soup} packet. The default is
11294 @samp{gunzip -c %s | tar xvf -}.
11296 @item gnus-soup-packet-directory
11297 @vindex gnus-soup-packet-directory
11298 Where Gnus will look for reply packets. The default is @file{~/}.
11300 @item gnus-soup-packet-regexp
11301 @vindex gnus-soup-packet-regexp
11302 Regular expression matching @sc{soup} reply packets in
11303 @code{gnus-soup-packet-directory}.
11309 @subsubsection @sc{soup} Groups
11312 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
11313 read incoming packets, unpack them, and put them in a directory where
11314 you can read them at leisure.
11316 These are the variables you can use to customize its behavior:
11320 @item nnsoup-tmp-directory
11321 @vindex nnsoup-tmp-directory
11322 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
11323 directory. (@file{/tmp/} by default.)
11325 @item nnsoup-directory
11326 @vindex nnsoup-directory
11327 @code{nnsoup} then moves each message and index file to this directory.
11328 The default is @file{~/SOUP/}.
11330 @item nnsoup-replies-directory
11331 @vindex nnsoup-replies-directory
11332 All replies will be stored in this directory before being packed into a
11333 reply packet. The default is @file{~/SOUP/replies/"}.
11335 @item nnsoup-replies-format-type
11336 @vindex nnsoup-replies-format-type
11337 The @sc{soup} format of the replies packets. The default is @samp{?n}
11338 (rnews), and I don't think you should touch that variable. I probably
11339 shouldn't even have documented it. Drats! Too late!
11341 @item nnsoup-replies-index-type
11342 @vindex nnsoup-replies-index-type
11343 The index type of the replies packet. The default is @samp{?n}, which
11344 means ``none''. Don't fiddle with this one either!
11346 @item nnsoup-active-file
11347 @vindex nnsoup-active-file
11348 Where @code{nnsoup} stores lots of information. This is not an ``active
11349 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
11350 this file or mess it up in any way, you're dead. The default is
11351 @file{~/SOUP/active}.
11353 @item nnsoup-packer
11354 @vindex nnsoup-packer
11355 Format string command for packing a reply @sc{soup} packet. The default
11356 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
11358 @item nnsoup-unpacker
11359 @vindex nnsoup-unpacker
11360 Format string command for unpacking incoming @sc{soup} packets. The
11361 default is @samp{gunzip -c %s | tar xvf -}.
11363 @item nnsoup-packet-directory
11364 @vindex nnsoup-packet-directory
11365 Where @code{nnsoup} will look for incoming packets. The default is
11368 @item nnsoup-packet-regexp
11369 @vindex nnsoup-packet-regexp
11370 Regular expression matching incoming @sc{soup} packets. The default is
11373 @item nnsoup-always-save
11374 @vindex nnsoup-always-save
11375 If non-@code{nil}, save the replies buffer after each posted message.
11381 @subsubsection SOUP Replies
11383 Just using @code{nnsoup} won't mean that your postings and mailings end
11384 up in @sc{soup} reply packets automagically. You have to work a bit
11385 more for that to happen.
11387 @findex nnsoup-set-variables
11388 The @code{nnsoup-set-variables} command will set the appropriate
11389 variables to ensure that all your followups and replies end up in the
11392 In specific, this is what it does:
11395 (setq message-send-news-function 'nnsoup-request-post)
11396 (setq message-send-mail-function 'nnsoup-request-mail)
11399 And that's it, really. If you only want news to go into the @sc{soup}
11400 system you just use the first line. If you only want mail to be
11401 @sc{soup}ed you use the second.
11405 @subsection Web Searches
11409 @cindex InReference
11410 @cindex Usenet searches
11411 @cindex searching the Usenet
11413 It's, like, too neat to search the Usenet for articles that match a
11414 string, but it, like, totally @emph{sucks}, like, totally, to use one of
11415 those, like, Web browsers, and you, like, have to, rilly, like, look at
11416 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
11417 searches without having to use a browser.
11419 The @code{nnweb} backend allows an easy interface to the mighty search
11420 engine. You create an @code{nnweb} group, enter a search pattern, and
11421 then enter the group and read the articles like you would any normal
11422 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
11423 Groups}) will do this in an easy-to-use fashion.
11425 @code{nnweb} groups don't really lend themselves to being solid
11426 groups---they have a very fleeting idea of article numbers. In fact,
11427 each time you enter an @code{nnweb} group (not even changing the search
11428 pattern), you are likely to get the articles ordered in a different
11429 manner. Not even using duplicate suppression (@pxref{Duplicate
11430 Suppression}) will help, since @code{nnweb} doesn't even know the
11431 @code{Message-ID} of the articles before reading them using some search
11432 engines (DejaNews, for instance). The only possible way to keep track
11433 of which articles you've read is by scoring on the @code{Date}
11434 header---mark all articles posted before the last date you read the
11437 If the search engine changes its output substantially, @code{nnweb}
11438 won't be able to parse it and will fail. One could hardly fault the Web
11439 providers if they were to do this---their @emph{raison d'être} is to
11440 make money off of advertisements, not to provide services to the
11441 community. Since @code{nnweb} washes the ads off all the articles, one
11442 might think that the providers might be somewhat miffed. We'll see.
11444 You must have the @code{url} and @code{w3} package installed to be able
11445 to use @code{nnweb}.
11447 Virtual server variables:
11452 What search engine type is being used. The currently supported types
11453 are @code{dejanews}, @code{dejanewsold}, @code{altavista} and
11457 @vindex nnweb-search
11458 The search string to feed to the search engine.
11460 @item nnweb-max-hits
11461 @vindex nnweb-max-hits
11462 Advisory maximum number of hits per search to display. The default is
11465 @item nnweb-type-definition
11466 @vindex nnweb-type-definition
11467 Type-to-definition alist. This alist says what @code{nnweb} should do
11468 with the various search engine types. The following elements must be
11473 Function to decode the article and provide something that Gnus
11477 Function to create an article number to message header and URL alist.
11480 Function to send the search string to the search engine.
11483 The address the aforementioned function should send the search string
11487 Format string URL to fetch an article by @code{Message-ID}.
11494 @node Mail-To-News Gateways
11495 @subsection Mail-To-News Gateways
11496 @cindex mail-to-news gateways
11499 If your local @code{nntp} server doesn't allow posting, for some reason
11500 or other, you can post using one of the numerous mail-to-news gateways.
11501 The @code{nngateway} backend provides the interface.
11503 Note that you can't read anything from this backend---it can only be
11509 @item nngateway-address
11510 @vindex nngateway-address
11511 This is the address of the mail-to-news gateway.
11513 @item nngateway-header-transformation
11514 @vindex nngateway-header-transformation
11515 News headers often have to be transformed in some odd way or other
11516 for the mail-to-news gateway to accept it. This variable says what
11517 transformation should be called, and defaults to
11518 @code{nngateway-simple-header-transformation}. The function is called
11519 narrowed to the headers to be transformed and with one parameter---the
11522 This default function just inserts a new @code{To} header based on the
11523 @code{Newsgroups} header and the gateway address.
11524 For instance, an article with this @code{Newsgroups} header:
11527 Newsgroups: alt.religion.emacs
11530 will get this @code{From} header inserted:
11533 To: alt-religion-emacs@@GATEWAY
11536 The following pre-defined functions exist:
11538 @findex nngateway-simple-header-transformation
11541 @item nngateway-simple-header-transformation
11542 Creates a @code{To} header that looks like
11543 @var{newsgroup}@@@code{nngateway-address}.
11545 @findex nngateway-mail2news-header-transformation
11547 @item nngateway-mail2news-header-transformation
11548 Creates a @code{To} header that looks like
11549 @code{nngateway-address}.
11554 (setq gnus-post-method
11555 '(nngateway "mail2news@@replay.com"
11556 (nngateway-header-transformation
11557 nngateway-mail2news-header-transformation)))
11565 So, to use this, simply say something like:
11568 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
11572 @node Combined Groups
11573 @section Combined Groups
11575 Gnus allows combining a mixture of all the other group types into bigger
11579 * Virtual Groups:: Combining articles from many groups.
11580 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
11584 @node Virtual Groups
11585 @subsection Virtual Groups
11587 @cindex virtual groups
11588 @cindex merging groups
11590 An @dfn{nnvirtual group} is really nothing more than a collection of
11593 For instance, if you are tired of reading many small groups, you can
11594 put them all in one big group, and then grow tired of reading one
11595 big, unwieldy group. The joys of computing!
11597 You specify @code{nnvirtual} as the method. The address should be a
11598 regexp to match component groups.
11600 All marks in the virtual group will stick to the articles in the
11601 component groups. So if you tick an article in a virtual group, the
11602 article will also be ticked in the component group from whence it came.
11603 (And vice versa---marks from the component groups will also be shown in
11604 the virtual group.)
11606 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
11607 newsgroups into one, big, happy newsgroup:
11610 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
11613 The component groups can be native or foreign; everything should work
11614 smoothly, but if your computer explodes, it was probably my fault.
11616 Collecting the same group from several servers might actually be a good
11617 idea if users have set the Distribution header to limit distribution.
11618 If you would like to read @samp{soc.motss} both from a server in Japan
11619 and a server in Norway, you could use the following as the group regexp:
11622 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
11625 (Remember, though, that if you're creating the group with @kbd{G m}, you
11626 shouldn't double the backslashes, and you should leave off the quote
11627 characters at the beginning and the end of the string.)
11629 This should work kinda smoothly---all articles from both groups should
11630 end up in this one, and there should be no duplicates. Threading (and
11631 the rest) will still work as usual, but there might be problems with the
11632 sequence of articles. Sorting on date might be an option here
11633 (@pxref{Selecting a Group}).
11635 One limitation, however---all groups included in a virtual
11636 group have to be alive (i.e., subscribed or unsubscribed). Killed or
11637 zombie groups can't be component groups for @code{nnvirtual} groups.
11639 @vindex nnvirtual-always-rescan
11640 If the @code{nnvirtual-always-rescan} is non-@code{nil},
11641 @code{nnvirtual} will always scan groups for unread articles when
11642 entering a virtual group. If this variable is @code{nil} (which is the
11643 default) and you read articles in a component group after the virtual
11644 group has been activated, the read articles from the component group
11645 will show up when you enter the virtual group. You'll also see this
11646 effect if you have two virtual groups that have a component group in
11647 common. If that's the case, you should set this variable to @code{t}.
11648 Or you can just tap @code{M-g} on the virtual group every time before
11649 you enter it---it'll have much the same effect.
11651 @code{nnvirtual} can have both mail and news groups as component groups.
11652 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
11653 has to ask the backend of the component group the article comes from
11654 whether it is a news or mail backend. However, when you do a @kbd{^},
11655 there is typically no sure way for the component backend to know this,
11656 and in that case @code{nnvirtual} tells Gnus that the article came from a
11657 not-news backend. (Just to be on the safe side.)
11659 @kbd{C-c C-t} in the message buffer will insert the @code{Newsgroups}
11660 line from the article you respond to in these cases.
11664 @node Kibozed Groups
11665 @subsection Kibozed Groups
11669 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
11670 the news feed''. @code{nnkiboze} is a backend that will do this for
11671 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
11672 with useless requests! Oh happiness!
11674 @kindex G k (Group)
11675 To create a kibozed group, use the @kbd{G k} command in the group
11678 The address field of the @code{nnkiboze} method is, as with
11679 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
11680 @code{nnkiboze} group. That's where most similarities between @code{nnkiboze}
11681 and @code{nnvirtual} end.
11683 In addition to this regexp detailing component groups, an @code{nnkiboze} group
11684 must have a score file to say what articles are to be included in
11685 the group (@pxref{Scoring}).
11687 @kindex M-x nnkiboze-generate-groups
11688 @findex nnkiboze-generate-groups
11689 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
11690 @code{nnkiboze} groups you want to have. This command will take time. Lots of
11691 time. Oodles and oodles of time. Gnus has to fetch the headers from
11692 all the articles in all the component groups and run them through the
11693 scoring process to determine if there are any articles in the groups
11694 that are to be part of the @code{nnkiboze} groups.
11696 Please limit the number of component groups by using restrictive
11697 regexps. Otherwise your sysadmin may become annoyed with you, and the
11698 @sc{nntp} site may throw you off and never let you back in again.
11699 Stranger things have happened.
11701 @code{nnkiboze} component groups do not have to be alive---they can be dead,
11702 and they can be foreign. No restrictions.
11704 @vindex nnkiboze-directory
11705 The generation of an @code{nnkiboze} group means writing two files in
11706 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
11707 contains the @sc{nov} header lines for all the articles in the group,
11708 and the other is an additional @file{.newsrc} file to store information
11709 on what groups have been searched through to find component articles.
11711 Articles marked as read in the @code{nnkiboze} group will have
11712 their @sc{nov} lines removed from the @sc{nov} file.
11715 @node Gnus Unplugged
11716 @section Gnus Unplugged
11721 @cindex Gnus Unplugged
11723 In olden times (ca. February '88), people used to run their newsreaders
11724 on big machines with permanent connections to the net. News transport
11725 was dealt with by news servers, and all the newsreaders had to do was to
11726 read news. Believe it or not.
11728 Nowadays most people read news and mail at home, and use some sort of
11729 modem to connect to the net. To avoid running up huge phone bills, it
11730 would be nice to have a way to slurp down all the news and mail, hang up
11731 the phone, read for several hours, and then upload any responses you
11732 have to make. And then you repeat the procedure.
11734 Of course, you can use news servers for doing this as well. I've used
11735 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
11736 for some years, but doing that's a bore. Moving the news server
11737 functionality up to the newsreader makes sense if you're the only person
11738 reading news on a machine.
11740 Using Gnus as an ``offline'' newsreader is quite simple.
11744 First, set up Gnus as you would do if you were running it on a machine
11745 that has full connection to the net. Go ahead. I'll still be waiting
11749 Then, put the following magical incantation at the end of your
11750 @file{.gnus.el} file:
11757 That's it. Gnus is now an ``offline'' newsreader.
11759 Of course, to use it as such, you have to learn a few new commands.
11762 * Agent Basics:: How it all is supposed to work.
11763 * Agent Categories:: How to tell the Gnus Agent what to download.
11764 * Agent Commands:: New commands for all the buffers.
11765 * Agent Expiry:: How to make old articles go away.
11766 * Outgoing Messages:: What happens when you post/mail something?
11767 * Agent Variables:: Customizing is fun.
11768 * Example Setup:: An example @file{.gnus.el} file for offline people.
11769 * Batching Agents:: How to fetch news from a @code{cron} job.
11770 * Agent Caveats:: What you think it'll do and what it does.
11775 @subsection Agent Basics
11777 First, let's get some terminology out of the way.
11779 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
11780 connection to the net (and notified the Agent that this is the case).
11781 When the connection to the net is up again (and Gnus knows this), the
11782 Agent is @dfn{plugged}.
11784 The @dfn{local} machine is the one you're running on, and which isn't
11785 connected to the net continuously.
11787 @dfn{Downloading} means fetching things from the net to your local
11788 machine. @dfn{Uploading} is doing the opposite.
11790 Let's take a typical Gnus session using the Agent.
11795 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
11796 Agent in a disconnected state. You can read all the news that you have
11797 already fetched while in this mode.
11800 You then decide to see whether any new news has arrived. You connect
11801 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
11802 to make Gnus become @dfn{plugged}.
11805 You can then read the new news immediately, or you can download the news
11806 onto your local machine. If you want to do the latter, you press @kbd{J
11807 s} to fetch all the eligible articles in all the groups. (To let Gnus
11808 know which articles you want to download, @pxref{Agent Categories}.)
11811 After fetching the articles, you press @kbd{J j} to make Gnus become
11812 unplugged again, and you shut down the PPP thing (or whatever). And
11813 then you read the news offline.
11816 And then you go to step 2.
11819 Here are some things you should do the first time (or so) that you use
11825 Decide which servers should be covered by the Agent. If you have a mail
11826 backend, it would probably be nonsensical to have it covered by the
11827 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
11828 @kbd{J a} the server (or servers) that you wish to have covered by the
11829 Agent (@pxref{Server Agent Commands}). This will typically be only the
11830 primary select method, which is listed on the bottom in the buffer.
11833 Decide on download policy. @xref{Agent Categories}.
11840 @node Agent Categories
11841 @subsection Agent Categories
11843 One of the main reasons to integrate the news transport layer into the
11844 newsreader is to allow greater control over what articles to download.
11845 There's not much point in downloading huge amounts of articles, just to
11846 find out that you're not interested in reading any of them. It's better
11847 to be somewhat more conservative in choosing what to download, and then
11848 mark the articles for downloading manually if it should turn out that
11849 you're interested in the articles anyway.
11851 The main way to control what is to be downloaded is to create a
11852 @dfn{category} and then assign some (or all) groups to this category.
11853 Gnus has its own buffer for creating and managing categories.
11856 * Category Syntax:: What a category looks like.
11857 * The Category Buffer:: A buffer for maintaining categories.
11858 * Category Variables:: Customize'r'Us.
11862 @node Category Syntax
11863 @subsubsection Category Syntax
11865 A category consists of two things.
11869 A predicate which (generally) gives a rough outline of which articles
11870 are eligible for downloading; and
11873 a score rule which (generally) gives you a finer granularity when
11874 deciding what articles to download. (Note that this @dfn{download
11875 score} is not necessarily related to normal scores.)
11878 A predicate in its simplest form can be a single predicate such as
11879 @code{true} or @code{false}. These two will download every available
11880 article or nothing respectively. In the case of these two special
11881 predicates an additional score rule is superfluous.
11883 Predicates of @code{high} or @code{low} download articles in respect of
11884 their scores in relationship to @code{gnus-agent-high-score} and
11885 @code{gnus-agent-low-score} as descibed below.
11887 To gain even finer control of what is to be regarded eligible for
11888 download a predicate can consist of a number of predicates with logical
11889 operators sprinkled in between.
11891 Perhaps some examples are in order.
11893 Here's a simple predicate. (It's the default predicate, in fact, used
11894 for all groups that don't belong to any other category.)
11900 Quite simple, eh? This predicate is true if and only if the article is
11901 short (for some value of ``short'').
11903 Here's a more complex predicate:
11912 This means that an article should be downloaded if it has a high score,
11913 or if the score is not low and the article is not long. You get the
11916 The available logical operators are @code{or}, @code{and} and
11917 @code{not}. (If you prefer, you can use the more ``C''-ish operators
11918 @samp{|}, @code{&} and @code{!} instead.)
11920 The following predicates are pre-defined, but if none of these fit what
11921 you want to do, you can write your own.
11925 True iff the article is shorter than @code{gnus-agent-short-article}
11926 lines; default 100.
11929 True iff the article is longer than @code{gnus-agent-long-article}
11930 lines; default 200.
11933 True iff the article has a download score less than
11934 @code{gnus-agent-low-score}; default 0.
11937 True iff the article has a download score greater than
11938 @code{gnus-agent-high-score}; default 0.
11941 True iff the Gnus Agent guesses that the article is spam. The
11942 heuristics may change over time, but at present it just computes a
11943 checksum and sees whether articles match.
11952 If you want to create your own predicate function, here's what you have
11953 to know: The functions are called with no parameters, but the
11954 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
11957 For example, you could decide that you don't want to download articles
11958 that were posted more than a certain number of days ago (e.g. posted
11959 more than @code{gnus-agent-expire-days} ago) you might write a function
11960 something along the lines of the following:
11963 (defun my-article-old-p ()
11964 "Say whether an article is old."
11965 (< (time-to-day (date-to-time (mail-header-date gnus-headers)))
11966 (- (time-to-day (current-time)) gnus-agent-expire-days)))
11969 with the predicate then defined as:
11972 (not my-article-old-p)
11975 or you could append your predicate to the predefined
11976 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
11977 wherever. (Note: this would have to be at a point *after*
11978 @code{gnus-agent} has been loaded via @code{(gnus-agentize)})
11981 (defvar gnus-category-predicate-alist
11982 (append gnus-category-predicate-alist
11983 '((old . my-article-old-p))))
11986 and simply specify your predicate as:
11992 If/when using something like the above, be aware that there are many
11993 misconfigured systems/mailers out there and so an article's date is not
11994 always a reliable indication of when it was posted. Hell, some people
11995 just don't give a damm.
11998 The above predicates apply to *all* the groups which belong to the
11999 category. However, if you wish to have a specific predicate for an
12000 individual group within a category, or you're just too lazy to set up a
12001 new category, you can enter a group's individual predicate in it's group
12002 parameters like so:
12005 (agent-predicate . short)
12008 This is the group parameter equivalent of the agent category
12009 default. Note that when specifying a single word predicate like this,
12010 the @code{agent-predicate} specification must be in dotted pair
12013 The equivalent of the longer example from above would be:
12016 (agent-predicate or high (and (not low) (not long)))
12019 The outer parenthesis required in the category specification are not
12020 entered here as, not being in dotted pair notation, the value of the
12021 predicate is assumed to be a list.
12024 Now, the syntax of the download score is the same as the syntax of
12025 normal score files, except that all elements that require actually
12026 seeing the article itself are verboten. This means that only the
12027 following headers can be scored on: @code{Subject}, @code{From},
12028 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
12029 @code{Lines}, and @code{Xref}.
12031 As with predicates, the specification of the @code{download score rule}
12032 to use in respect of a group can be in either the category definition if
12033 it's to be applicable to all groups in therein, or a group's parameters
12034 if it's to be specific to that group.
12036 In both of these places the @code{download score rule} can take one of
12043 This has the same syntax as a normal gnus score file except only a
12044 subset of scoring keywords are available as mentioned above.
12050 Category specification
12054 ("Lars Ingebrigtsen" 1000000 nil s))
12060 Group Parameter specification
12063 (agent-score ("from"
12064 ("Lars Ingebrigtsen" 1000000 nil s))
12069 Again, note the omission of the outermost parenthesis here.
12075 These score files must *only* contain the permitted scoring keywords
12082 Category specification
12085 ("~/News/agent.SCORE")
12091 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
12095 Group Parameter specification
12098 (agent-score "~/News/agent.SCORE")
12101 Additional score files can be specified as above. Need I say anything
12106 Use @code{normal} score files
12108 If you dont want to maintain two sets of scoring rules for a group, and
12109 your desired @code{downloading} criteria for a group are the same as your
12110 @code{reading} criteria then you can tell the agent to refer to your
12111 @code{normal} score files when deciding what to download.
12113 These directives in either the category definition or a group's
12114 parameters will cause the agent to read in all the applicable score
12115 files for a group, *filtering out* those those sections that do not
12116 relate to one of the permitted subset of scoring keywords.
12120 Category Specification
12127 Group Parameter specification
12130 (agent-score . file)
12135 @node The Category Buffer
12136 @subsubsection The Category Buffer
12138 You'd normally do all category maintenance from the category buffer.
12139 When you enter it for the first time (with the @kbd{J c} command from
12140 the group buffer), you'll only see the @code{default} category.
12142 The following commands are available in this buffer:
12146 @kindex q (Category)
12147 @findex gnus-category-exit
12148 Return to the group buffer (@code{gnus-category-exit}).
12151 @kindex k (Category)
12152 @findex gnus-category-kill
12153 Kill the current category (@code{gnus-category-kill}).
12156 @kindex c (Category)
12157 @findex gnus-category-copy
12158 Copy the current category (@code{gnus-category-copy}).
12161 @kindex a (Category)
12162 @findex gnus-category-add
12163 Add a new category (@code{gnus-category-add}).
12166 @kindex p (Category)
12167 @findex gnus-category-edit-predicate
12168 Edit the predicate of the current category
12169 (@code{gnus-category-edit-predicate}).
12172 @kindex g (Category)
12173 @findex gnus-category-edit-groups
12174 Edit the list of groups belonging to the current category
12175 (@code{gnus-category-edit-groups}).
12178 @kindex s (Category)
12179 @findex gnus-category-edit-score
12180 Edit the download score rule of the current category
12181 (@code{gnus-category-edit-score}).
12184 @kindex l (Category)
12185 @findex gnus-category-list
12186 List all the categories (@code{gnus-category-list}).
12190 @node Category Variables
12191 @subsubsection Category Variables
12194 @item gnus-category-mode-hook
12195 @vindex gnus-category-mode-hook
12196 Hook run in category buffers.
12198 @item gnus-category-line-format
12199 @vindex gnus-category-line-format
12200 Format of the lines in the category buffer (@pxref{Formatting
12201 Variables}). Valid elements are:
12205 The name of the category.
12208 The number of groups in the category.
12211 @item gnus-category-mode-line-format
12212 @vindex gnus-category-mode-line-format
12213 Format of the category mode line (@pxref{Mode Line Formatting}).
12215 @item gnus-agent-short-article
12216 @vindex gnus-agent-short-article
12217 Articles that have fewer lines than this are short. Default 100.
12219 @item gnus-agent-long-article
12220 @vindex gnus-agent-long-article
12221 Articles that have more lines than this are long. Default 200.
12223 @item gnus-agent-low-score
12224 @vindex gnus-agent-low-score
12225 Articles that have a score lower than this have a low score. Default
12228 @item gnus-agent-high-score
12229 @vindex gnus-agent-high-score
12230 Articles that have a score higher than this have a high score. Default
12236 @node Agent Commands
12237 @subsection Agent Commands
12239 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
12240 (@code{gnus-agent-toggle-plugged} command works in all modes, and
12241 toggles the plugged/unplugged state of the Gnus Agent.
12245 * Group Agent Commands::
12246 * Summary Agent Commands::
12247 * Server Agent Commands::
12250 You can run a complete batch fetch from the command line with the
12251 following incantation:
12253 @cindex gnus-agent-batch-fetch
12255 $ emacs -batch -l ~/.gnus.el -f gnus-agent-batch-fetch
12260 @node Group Agent Commands
12261 @subsubsection Group Agent Commands
12265 @kindex J u (Agent Group)
12266 @findex gnus-agent-fetch-groups
12267 Fetch all eligible articles in the current group
12268 (@code{gnus-agent-fetch-groups}).
12271 @kindex J c (Agent Group)
12272 @findex gnus-enter-category-buffer
12273 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
12276 @kindex J s (Agent Group)
12277 @findex gnus-agent-fetch-session
12278 Fetch all eligible articles in all groups
12279 (@code{gnus-agent-fetch-session}).
12282 @kindex J S (Agent Group)
12283 @findex gnus-group-send-drafts
12284 Send all sendable messages in the draft group
12285 (@code{gnus-agent-fetch-session}). @xref{Drafts}.
12288 @kindex J a (Agent Group)
12289 @findex gnus-agent-add-group
12290 Add the current group to an Agent category
12291 (@code{gnus-agent-add-group}). This command understands the
12292 process/prefix convention (@pxref{Process/Prefix}).
12295 @kindex J r (Agent Group)
12296 @findex gnus-agent-remove-group
12297 Remove the current group from its category, if any
12298 (@code{gnus-agent-remove-group}). This command understands the
12299 process/prefix convention (@pxref{Process/Prefix}).
12304 @node Summary Agent Commands
12305 @subsubsection Summary Agent Commands
12309 @kindex J # (Agent Summary)
12310 @findex gnus-agent-mark-article
12311 Mark the article for downloading (@code{gnus-agent-mark-article}).
12314 @kindex J M-# (Agent Summary)
12315 @findex gnus-agent-unmark-article
12316 Remove the downloading mark from the article
12317 (@code{gnus-agent-unmark-article}).
12320 @kindex @@ (Agent Summary)
12321 @findex gnus-agent-toggle-mark
12322 Toggle whether to download the article (@code{gnus-agent-toggle-mark}).
12325 @kindex J c (Agent Summary)
12326 @findex gnus-agent-catchup
12327 Mark all undownloaded articles as read (@code{gnus-agent-catchup}).
12332 @node Server Agent Commands
12333 @subsubsection Server Agent Commands
12337 @kindex J a (Agent Server)
12338 @findex gnus-agent-add-server
12339 Add the current server to the list of servers covered by the Gnus Agent
12340 (@code{gnus-agent-add-server}).
12343 @kindex J r (Agent Server)
12344 @findex gnus-agent-remove-server
12345 Remove the current server from the list of servers covered by the Gnus
12346 Agent (@code{gnus-agent-remove-server}).
12352 @subsection Agent Expiry
12354 @vindex gnus-agent-expire-days
12355 @findex gnus-agent-expire
12356 @kindex M-x gnus-agent-expire
12357 @cindex Agent expiry
12358 @cindex Gnus Agent expiry
12361 @code{nnagent} doesn't handle expiry. Instead, there's a special
12362 @code{gnus-agent-expire} command that will expire all read articles that
12363 are older than @code{gnus-agent-expire-days} days. It can be run
12364 whenever you feel that you're running out of space. It's not
12365 particularly fast or efficient, and it's not a particularly good idea to
12366 interrupt it (with @kbd{C-g} or anything else) once you've started it.
12368 @vindex gnus-agent-expire-all
12369 if @code{gnus-agent-expire-all} is non-@code{nil}, this command will
12370 expire all articles---unread, read, ticked and dormant. If @code{nil}
12371 (which is the default), only read articles are eligible for expiry, and
12372 unread, ticked and dormant articles will be kept indefinitely.
12375 @node Outgoing Messages
12376 @subsection Outgoing Messages
12378 When Gnus is unplugged, all outgoing messages (both mail and news) are
12379 stored in the draft groups (@pxref{Drafts}). You can view them there
12380 after posting, and edit them at will.
12382 When Gnus is plugged again, you can send the messages either from the
12383 draft group with the special commands available there, or you can use
12384 the @kbd{J S} command in the group buffer to send all the sendable
12385 messages in the draft group.
12389 @node Agent Variables
12390 @subsection Agent Variables
12393 @item gnus-agent-directory
12394 @vindex gnus-agent-directory
12395 Where the Gnus Agent will store its files. The default is
12396 @file{~/News/agent/}.
12398 @item gnus-agent-handle-level
12399 @vindex gnus-agent-handle-level
12400 Groups on levels (@pxref{Group Levels}) higher than this variable will
12401 be ignored by the Agent. The default is @code{gnus-level-subscribed},
12402 which means that only subscribed group will be considered by the Agent
12405 @item gnus-agent-plugged-hook
12406 @vindex gnus-agent-plugged-hook
12407 Hook run when connecting to the network.
12409 @item gnus-agent-unplugged-hook
12410 @vindex gnus-agent-unplugged-hook
12411 Hook run when disconnecting from the network.
12416 @node Example Setup
12417 @subsection Example Setup
12419 If you don't want to read this manual, and you have a fairly standard
12420 setup, you may be able to use something like the following as your
12421 @file{.gnus.el} file to get started.
12424 ;;; Define how Gnus is to fetch news. We do this over NNTP
12425 ;;; from your ISP's server.
12426 (setq gnus-select-method '(nntp "nntp.your-isp.com"))
12428 ;;; Define how Gnus is to read your mail. We read mail from
12429 ;;; your ISP's POP server.
12430 (setenv "MAILHOST" "pop.your-isp.com")
12431 (setq nnmail-spool-file "po:username")
12433 ;;; Say how Gnus is to store the mail. We use nnml groups.
12434 (setq gnus-secondary-select-methods '((nnml "")))
12436 ;;; Make Gnus into an offline newsreader.
12440 That should be it, basically. Put that in your @file{~/.gnus.el} file,
12441 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
12444 If this is the first time you've run Gnus, you will be subscribed
12445 automatically to a few default newsgroups. You'll probably want to
12446 subscribe to more groups, and to do that, you have to query the
12447 @sc{nntp} server for a complete list of groups with the @kbd{A A}
12448 command. This usually takes quite a while, but you only have to do it
12451 After reading and parsing a while, you'll be presented with a list of
12452 groups. Subscribe to the ones you want to read with the @kbd{u}
12453 command. @kbd{l} to make all the killed groups disappear after you've
12454 subscribe to all the groups you want to read. (@kbd{A k} will bring
12455 back all the killed groups.)
12457 You can now read the groups at once, or you can download the articles
12458 with the @kbd{J s} command. And then read the rest of this manual to
12459 find out which of the other gazillion things you want to customize.
12462 @node Batching Agents
12463 @subsection Batching Agents
12465 Having the Gnus Agent fetch articles (and post whatever messages you've
12466 written) is quite easy once you've gotten things set up properly. The
12467 following shell script will do everything that is necessary:
12471 emacs -batch -l ~/.emacs -f gnus-agent-batch >/dev/null
12475 @node Agent Caveats
12476 @subsection Agent Caveats
12478 The Gnus Agent doesn't seem to work like most other offline
12479 newsreaders. Here are some common questions that some imaginary people
12483 @item If I read an article while plugged, do they get entered into the
12488 @item If I read an article while plugged, and the article already exists
12489 in the Agent, will it get downloaded once more?
12495 In short, when Gnus is unplugged, it only looks into the locally stored
12496 articles; when it's plugged, it only talks to your ISP.
12503 Other people use @dfn{kill files}, but we here at Gnus Towers like
12504 scoring better than killing, so we'd rather switch than fight. They do
12505 something completely different as well, so sit up straight and pay
12508 @vindex gnus-summary-mark-below
12509 All articles have a default score (@code{gnus-summary-default-score}),
12510 which is 0 by default. This score may be raised or lowered either
12511 interactively or by score files. Articles that have a score lower than
12512 @code{gnus-summary-mark-below} are marked as read.
12514 Gnus will read any @dfn{score files} that apply to the current group
12515 before generating the summary buffer.
12517 There are several commands in the summary buffer that insert score
12518 entries based on the current article. You can, for instance, ask Gnus to
12519 lower or increase the score of all articles with a certain subject.
12521 There are two sorts of scoring entries: Permanent and temporary.
12522 Temporary score entries are self-expiring entries. Any entries that are
12523 temporary and have not been used for, say, a week, will be removed
12524 silently to help keep the sizes of the score files down.
12527 * Summary Score Commands:: Adding score entries for the current group.
12528 * Group Score Commands:: General score commands.
12529 * Score Variables:: Customize your scoring. (My, what terminology).
12530 * Score File Format:: What a score file may contain.
12531 * Score File Editing:: You can edit score files by hand as well.
12532 * Adaptive Scoring:: Big Sister Gnus knows what you read.
12533 * Home Score File:: How to say where new score entries are to go.
12534 * Followups To Yourself:: Having Gnus notice when people answer you.
12535 * Scoring Tips:: How to score effectively.
12536 * Reverse Scoring:: That problem child of old is not problem.
12537 * Global Score Files:: Earth-spanning, ear-splitting score files.
12538 * Kill Files:: They are still here, but they can be ignored.
12539 * Converting Kill Files:: Translating kill files to score files.
12540 * GroupLens:: Getting predictions on what you like to read.
12541 * Advanced Scoring:: Using logical expressions to build score rules.
12542 * Score Decays:: It can be useful to let scores wither away.
12546 @node Summary Score Commands
12547 @section Summary Score Commands
12548 @cindex score commands
12550 The score commands that alter score entries do not actually modify real
12551 score files. That would be too inefficient. Gnus maintains a cache of
12552 previously loaded score files, one of which is considered the
12553 @dfn{current score file alist}. The score commands simply insert
12554 entries into this list, and upon group exit, this list is saved.
12556 The current score file is by default the group's local score file, even
12557 if no such score file actually exists. To insert score commands into
12558 some other score file (e.g. @file{all.SCORE}), you must first make this
12559 score file the current one.
12561 General score commands that don't actually change the score file:
12566 @kindex V s (Summary)
12567 @findex gnus-summary-set-score
12568 Set the score of the current article (@code{gnus-summary-set-score}).
12571 @kindex V S (Summary)
12572 @findex gnus-summary-current-score
12573 Display the score of the current article
12574 (@code{gnus-summary-current-score}).
12577 @kindex V t (Summary)
12578 @findex gnus-score-find-trace
12579 Display all score rules that have been used on the current article
12580 (@code{gnus-score-find-trace}).
12583 @kindex V R (Summary)
12584 @findex gnus-summary-rescore
12585 Run the current summary through the scoring process
12586 (@code{gnus-summary-rescore}). This might be useful if you're playing
12587 around with your score files behind Gnus' back and want to see the
12588 effect you're having.
12591 @kindex V c (Summary)
12592 @findex gnus-score-change-score-file
12593 Make a different score file the current
12594 (@code{gnus-score-change-score-file}).
12597 @kindex V e (Summary)
12598 @findex gnus-score-edit-current-scores
12599 Edit the current score file (@code{gnus-score-edit-current-scores}).
12600 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
12604 @kindex V f (Summary)
12605 @findex gnus-score-edit-file
12606 Edit a score file and make this score file the current one
12607 (@code{gnus-score-edit-file}).
12610 @kindex V F (Summary)
12611 @findex gnus-score-flush-cache
12612 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
12613 after editing score files.
12616 @kindex V C (Summary)
12617 @findex gnus-score-customize
12618 Customize a score file in a visually pleasing manner
12619 (@code{gnus-score-customize}).
12623 The rest of these commands modify the local score file.
12628 @kindex V m (Summary)
12629 @findex gnus-score-set-mark-below
12630 Prompt for a score, and mark all articles with a score below this as
12631 read (@code{gnus-score-set-mark-below}).
12634 @kindex V x (Summary)
12635 @findex gnus-score-set-expunge-below
12636 Prompt for a score, and add a score rule to the current score file to
12637 expunge all articles below this score
12638 (@code{gnus-score-set-expunge-below}).
12641 The keystrokes for actually making score entries follow a very regular
12642 pattern, so there's no need to list all the commands. (Hundreds of
12645 @findex gnus-summary-increase-score
12646 @findex gnus-summary-lower-score
12650 The first key is either @kbd{I} (upper case i) for increasing the score
12651 or @kbd{L} for lowering the score.
12653 The second key says what header you want to score on. The following
12654 keys are available:
12658 Score on the author name.
12661 Score on the subject line.
12664 Score on the Xref line---i.e., the cross-posting line.
12667 Score on the References line.
12673 Score on the number of lines.
12676 Score on the Message-ID.
12679 Score on followups.
12693 The third key is the match type. Which match types are valid depends on
12694 what headers you are scoring on.
12706 Substring matching.
12709 Fuzzy matching (@pxref{Fuzzy Matching}).
12738 Greater than number.
12743 The fourth and final key says whether this is a temporary (i.e., expiring)
12744 score entry, or a permanent (i.e., non-expiring) score entry, or whether
12745 it is to be done immediately, without adding to the score file.
12749 Temporary score entry.
12752 Permanent score entry.
12755 Immediately scoring.
12760 So, let's say you want to increase the score on the current author with
12761 exact matching permanently: @kbd{I a e p}. If you want to lower the
12762 score based on the subject line, using substring matching, and make a
12763 temporary score entry: @kbd{L s s t}. Pretty easy.
12765 To make things a bit more complicated, there are shortcuts. If you use
12766 a capital letter on either the second or third keys, Gnus will use
12767 defaults for the remaining one or two keystrokes. The defaults are
12768 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
12769 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
12771 These functions take both the numerical prefix and the symbolic prefix
12772 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
12773 (or increase) the score of the article. A symbolic prefix of @code{a}
12774 says to use the @file{all.SCORE} file for the command instead of the
12775 current score file.
12777 @vindex gnus-score-mimic-keymap
12778 The @code{gnus-score-mimic-keymap} says whether these commands will
12779 pretend they are keymaps or not.
12782 @node Group Score Commands
12783 @section Group Score Commands
12784 @cindex group score commands
12786 There aren't many of these as yet, I'm afraid.
12791 @kindex W f (Group)
12792 @findex gnus-score-flush-cache
12793 Gnus maintains a cache of score alists to avoid having to reload them
12794 all the time. This command will flush the cache
12795 (@code{gnus-score-flush-cache}).
12799 You can do scoring from the command line by saying something like:
12801 @findex gnus-batch-score
12802 @cindex batch scoring
12804 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
12808 @node Score Variables
12809 @section Score Variables
12810 @cindex score variables
12814 @item gnus-use-scoring
12815 @vindex gnus-use-scoring
12816 If @code{nil}, Gnus will not check for score files, and will not, in
12817 general, do any score-related work. This is @code{t} by default.
12819 @item gnus-kill-killed
12820 @vindex gnus-kill-killed
12821 If this variable is @code{nil}, Gnus will never apply score files to
12822 articles that have already been through the kill process. While this
12823 may save you lots of time, it also means that if you apply a kill file
12824 to a group, and then change the kill file and want to run it over you
12825 group again to kill more articles, it won't work. You have to set this
12826 variable to @code{t} to do that. (It is @code{t} by default.)
12828 @item gnus-kill-files-directory
12829 @vindex gnus-kill-files-directory
12830 All kill and score files will be stored in this directory, which is
12831 initialized from the @code{SAVEDIR} environment variable by default.
12832 This is @file{~/News/} by default.
12834 @item gnus-score-file-suffix
12835 @vindex gnus-score-file-suffix
12836 Suffix to add to the group name to arrive at the score file name
12837 (@samp{SCORE} by default.)
12839 @item gnus-score-uncacheable-files
12840 @vindex gnus-score-uncacheable-files
12841 @cindex score cache
12842 All score files are normally cached to avoid excessive re-loading of
12843 score files. However, if this might make you Emacs grow big and
12844 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
12845 @file{all.SCORE}, while it might be a good idea to not cache
12846 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
12847 variable is @samp{ADAPT$} by default, so no adaptive score files will
12850 @item gnus-save-score
12851 @vindex gnus-save-score
12852 If you have really complicated score files, and do lots of batch
12853 scoring, then you might set this variable to @code{t}. This will make
12854 Gnus save the scores into the @file{.newsrc.eld} file.
12856 @item gnus-score-interactive-default-score
12857 @vindex gnus-score-interactive-default-score
12858 Score used by all the interactive raise/lower commands to raise/lower
12859 score with. Default is 1000, which may seem excessive, but this is to
12860 ensure that the adaptive scoring scheme gets enough room to play with.
12861 We don't want the small changes from the adaptive scoring to overwrite
12862 manually entered data.
12864 @item gnus-summary-default-score
12865 @vindex gnus-summary-default-score
12866 Default score of an article, which is 0 by default.
12868 @item gnus-summary-expunge-below
12869 @vindex gnus-summary-expunge-below
12870 Don't display the summary lines of articles that have scores lower than
12871 this variable. This is @code{nil} by default, which means that no
12872 articles will be hidden. This variable is local to the summary buffers,
12873 and has to be set from @code{gnus-summary-mode-hook}.
12875 @item gnus-score-over-mark
12876 @vindex gnus-score-over-mark
12877 Mark (in the third column) used for articles with a score over the
12878 default. Default is @samp{+}.
12880 @item gnus-score-below-mark
12881 @vindex gnus-score-below-mark
12882 Mark (in the third column) used for articles with a score below the
12883 default. Default is @samp{-}.
12885 @item gnus-score-find-score-files-function
12886 @vindex gnus-score-find-score-files-function
12887 Function used to find score files for the current group. This function
12888 is called with the name of the group as the argument.
12890 Predefined functions available are:
12893 @item gnus-score-find-single
12894 @findex gnus-score-find-single
12895 Only apply the group's own score file.
12897 @item gnus-score-find-bnews
12898 @findex gnus-score-find-bnews
12899 Apply all score files that match, using bnews syntax. This is the
12900 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
12901 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
12902 @file{gnu.all.SCORE} would all apply. In short, the instances of
12903 @samp{all} in the score file names are translated into @samp{.*}, and
12904 then a regexp match is done.
12906 This means that if you have some score entries that you want to apply to
12907 all groups, then you put those entries in the @file{all.SCORE} file.
12909 The score files are applied in a semi-random order, although Gnus will
12910 try to apply the more general score files before the more specific score
12911 files. It does this by looking at the number of elements in the score
12912 file names---discarding the @samp{all} elements.
12914 @item gnus-score-find-hierarchical
12915 @findex gnus-score-find-hierarchical
12916 Apply all score files from all the parent groups. This means that you
12917 can't have score files like @file{all.SCORE}, but you can have
12918 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
12921 This variable can also be a list of functions. In that case, all these
12922 functions will be called, and all the returned lists of score files will
12923 be applied. These functions can also return lists of score alists
12924 directly. In that case, the functions that return these non-file score
12925 alists should probably be placed before the ``real'' score file
12926 functions, to ensure that the last score file returned is the local
12929 @item gnus-score-expiry-days
12930 @vindex gnus-score-expiry-days
12931 This variable says how many days should pass before an unused score file
12932 entry is expired. If this variable is @code{nil}, no score file entries
12933 are expired. It's 7 by default.
12935 @item gnus-update-score-entry-dates
12936 @vindex gnus-update-score-entry-dates
12937 If this variable is non-@code{nil}, matching score entries will have
12938 their dates updated. (This is how Gnus controls expiry---all
12939 non-matching entries will become too old while matching entries will
12940 stay fresh and young.) However, if you set this variable to @code{nil},
12941 even matching entries will grow old and will have to face that oh-so
12944 @item gnus-score-after-write-file-function
12945 @vindex gnus-score-after-write-file-function
12946 Function called with the name of the score file just written.
12948 @item gnus-score-thread-simplify
12949 @vindex gnus-score-thread-simplify
12950 If this variable is non-@code{nil}, article subjects will be simplified
12951 for subject scoring purposes in the same manner as with
12952 threading---according to the current value of
12953 gnus-simplify-subject-functions. If the scoring entry uses
12954 @code{substring} or @code{exact} matching, the match will also be
12955 simplified in this manner.
12960 @node Score File Format
12961 @section Score File Format
12962 @cindex score file format
12964 A score file is an @code{emacs-lisp} file that normally contains just a
12965 single form. Casual users are not expected to edit these files;
12966 everything can be changed from the summary buffer.
12968 Anyway, if you'd like to dig into it yourself, here's an example:
12972 ("Lars Ingebrigtsen" -10000)
12974 ("larsi\\|lmi" -50000 nil R))
12976 ("Ding is Badd" nil 728373))
12978 ("alt.politics" -1000 728372 s))
12983 (mark-and-expunge -10)
12987 (files "/hom/larsi/News/gnu.SCORE")
12988 (exclude-files "all.SCORE")
12989 (local (gnus-newsgroup-auto-expire t)
12990 (gnus-summary-make-false-root empty))
12994 This example demonstrates most score file elements. For a different
12995 approach, see @pxref{Advanced Scoring}.
12997 Even though this looks much like lisp code, nothing here is actually
12998 @code{eval}ed. The lisp reader is used to read this form, though, so it
12999 has to be valid syntactically, if not semantically.
13001 Six keys are supported by this alist:
13006 If the key is a string, it is the name of the header to perform the
13007 match on. Scoring can only be performed on these eight headers:
13008 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
13009 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
13010 these headers, there are three strings to tell Gnus to fetch the entire
13011 article and do the match on larger parts of the article: @code{Body}
13012 will perform the match on the body of the article, @code{Head} will
13013 perform the match on the head of the article, and @code{All} will
13014 perform the match on the entire article. Note that using any of these
13015 last three keys will slow down group entry @emph{considerably}. The
13016 final ``header'' you can score on is @code{Followup}. These score
13017 entries will result in new score entries being added for all follow-ups
13018 to articles that matches these score entries.
13020 Following this key is a arbitrary number of score entries, where each
13021 score entry has one to four elements.
13025 The first element is the @dfn{match element}. On most headers this will
13026 be a string, but on the Lines and Chars headers, this must be an
13030 If the second element is present, it should be a number---the @dfn{score
13031 element}. This number should be an integer in the neginf to posinf
13032 interval. This number is added to the score of the article if the match
13033 is successful. If this element is not present, the
13034 @code{gnus-score-interactive-default-score} number will be used
13035 instead. This is 1000 by default.
13038 If the third element is present, it should be a number---the @dfn{date
13039 element}. This date says when the last time this score entry matched,
13040 which provides a mechanism for expiring the score entries. It this
13041 element is not present, the score entry is permanent. The date is
13042 represented by the number of days since December 31, 1 BCE.
13045 If the fourth element is present, it should be a symbol---the @dfn{type
13046 element}. This element specifies what function should be used to see
13047 whether this score entry matches the article. What match types that can
13048 be used depends on what header you wish to perform the match on.
13051 @item From, Subject, References, Xref, Message-ID
13052 For most header types, there are the @code{r} and @code{R} (regexp), as
13053 well as @code{s} and @code{S} (substring) types, and @code{e} and
13054 @code{E} (exact match), and @code{w} (word match) types. If this
13055 element is not present, Gnus will assume that substring matching should
13056 be used. @code{R}, @code{S}, and @code{E} differ from the others in
13057 that the matches will be done in a case-sensitive manner. All these
13058 one-letter types are really just abbreviations for the @code{regexp},
13059 @code{string}, @code{exact}, and @code{word} types, which you can use
13060 instead, if you feel like.
13063 These two headers use different match types: @code{<}, @code{>},
13064 @code{=}, @code{>=} and @code{<=}.
13066 These predicates are true if
13069 (PREDICATE HEADER MATCH)
13072 evaluates to non-@code{nil}. For instance, the advanced match
13073 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
13080 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
13081 the match, we get the score added if the article has less than 4 lines.
13082 (It's easy to get confused and think it's the other way around. But
13083 it's not. I think.)
13085 When matching on @code{Lines}, be careful because some backends (like
13086 @code{nndir}) do not generate @code{Lines} header, so every article ends
13087 up being marked as having 0 lines. This can lead to strange results if
13088 you happen to lower score of the articles with few lines.
13091 For the Date header we have three kinda silly match types:
13092 @code{before}, @code{at} and @code{after}. I can't really imagine this
13093 ever being useful, but, like, it would feel kinda silly not to provide
13094 this function. Just in case. You never know. Better safe than sorry.
13095 Once burnt, twice shy. Don't judge a book by its cover. Never not have
13096 sex on a first date. (I have been told that at least one person, and I
13097 quote, ``found this function indispensable'', however.)
13101 A more useful match type is @code{regexp}. With it, you can match the
13102 date string using a regular expression. The date is normalized to
13103 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
13104 you want to match all articles that have been posted on April 1st in
13105 every year, you could use @samp{....0401.........} as a match string,
13106 for instance. (Note that the date is kept in its original time zone, so
13107 this will match articles that were posted when it was April 1st where
13108 the article was posted from. Time zones are such wholesome fun for the
13111 @item Head, Body, All
13112 These three match keys use the same match types as the @code{From} (etc)
13116 This match key is somewhat special, in that it will match the
13117 @code{From} header, and affect the score of not only the matching
13118 articles, but also all followups to the matching articles. This allows
13119 you e.g. increase the score of followups to your own articles, or
13120 decrease the score of followups to the articles of some known
13121 trouble-maker. Uses the same match types as the @code{From} header
13122 uses. (Using this match key will lead to creation of @file{ADAPT}
13126 This match key works along the same lines as the @code{Followup} match
13127 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
13128 @samp{thread} match. This will add a new @samp{thread} match for each
13129 article that has @var{X} in its @code{References} header. (These new
13130 @samp{thread} matches will use the @code{Message-ID}s of these matching
13131 articles.) This will ensure that you can raise/lower the score of an
13132 entire thread, even though some articles in the thread may not have
13133 complete @code{References} headers. Note that using this may lead to
13134 undeterministic scores of the articles in the thread. (Using this match
13135 key will lead to creation of @file{ADAPT} files.)
13139 @cindex Score File Atoms
13141 The value of this entry should be a number. Any articles with a score
13142 lower than this number will be marked as read.
13145 The value of this entry should be a number. Any articles with a score
13146 lower than this number will be removed from the summary buffer.
13148 @item mark-and-expunge
13149 The value of this entry should be a number. Any articles with a score
13150 lower than this number will be marked as read and removed from the
13153 @item thread-mark-and-expunge
13154 The value of this entry should be a number. All articles that belong to
13155 a thread that has a total score below this number will be marked as read
13156 and removed from the summary buffer. @code{gnus-thread-score-function}
13157 says how to compute the total score for a thread.
13160 The value of this entry should be any number of file names. These files
13161 are assumed to be score files as well, and will be loaded the same way
13164 @item exclude-files
13165 The clue of this entry should be any number of files. These files will
13166 not be loaded, even though they would normally be so, for some reason or
13170 The value of this entry will be @code{eval}el. This element will be
13171 ignored when handling global score files.
13174 Read-only score files will not be updated or saved. Global score files
13175 should feature this atom (@pxref{Global Score Files}). (Note:
13176 @dfn{Global} here really means @dfn{global}; not your personal
13177 apply-to-all-groups score files.)
13180 The value of this entry should be a number. Articles that do not have
13181 parents will get this number added to their scores. Imagine you follow
13182 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
13183 will only follow a few of the threads, also want to see any new threads.
13185 You can do this with the following two score file entries:
13189 (mark-and-expunge -100)
13192 When you enter the group the first time, you will only see the new
13193 threads. You then raise the score of the threads that you find
13194 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
13195 rest. Next time you enter the group, you will see new articles in the
13196 interesting threads, plus any new threads.
13198 I.e.---the orphan score atom is for high-volume groups where there
13199 exist a few interesting threads which can't be found automatically by
13200 ordinary scoring rules.
13203 This entry controls the adaptive scoring. If it is @code{t}, the
13204 default adaptive scoring rules will be used. If it is @code{ignore}, no
13205 adaptive scoring will be performed on this group. If it is a list, this
13206 list will be used as the adaptive scoring rules. If it isn't present,
13207 or is something other than @code{t} or @code{ignore}, the default
13208 adaptive scoring rules will be used. If you want to use adaptive
13209 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
13210 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
13211 not want adaptive scoring. If you only want adaptive scoring in a few
13212 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
13213 insert @code{(adapt t)} in the score files of the groups where you want
13217 All adaptive score entries will go to the file named by this entry. It
13218 will also be applied when entering the group. This atom might be handy
13219 if you want to adapt on several groups at once, using the same adaptive
13220 file for a number of groups.
13223 @cindex local variables
13224 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
13225 Each @var{var} will be made buffer-local to the current summary buffer,
13226 and set to the value specified. This is a convenient, if somewhat
13227 strange, way of setting variables in some groups if you don't like hooks
13228 much. Note that the @var{value} won't be evaluated.
13232 @node Score File Editing
13233 @section Score File Editing
13235 You normally enter all scoring commands from the summary buffer, but you
13236 might feel the urge to edit them by hand as well, so we've supplied you
13237 with a mode for that.
13239 It's simply a slightly customized @code{emacs-lisp} mode, with these
13240 additional commands:
13245 @kindex C-c C-c (Score)
13246 @findex gnus-score-edit-done
13247 Save the changes you have made and return to the summary buffer
13248 (@code{gnus-score-edit-done}).
13251 @kindex C-c C-d (Score)
13252 @findex gnus-score-edit-insert-date
13253 Insert the current date in numerical format
13254 (@code{gnus-score-edit-insert-date}). This is really the day number, if
13255 you were wondering.
13258 @kindex C-c C-p (Score)
13259 @findex gnus-score-pretty-print
13260 The adaptive score files are saved in an unformatted fashion. If you
13261 intend to read one of these files, you want to @dfn{pretty print} it
13262 first. This command (@code{gnus-score-pretty-print}) does that for
13267 Type @kbd{M-x gnus-score-mode} to use this mode.
13269 @vindex gnus-score-mode-hook
13270 @code{gnus-score-menu-hook} is run in score mode buffers.
13272 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
13273 e} to begin editing score files.
13276 @node Adaptive Scoring
13277 @section Adaptive Scoring
13278 @cindex adaptive scoring
13280 If all this scoring is getting you down, Gnus has a way of making it all
13281 happen automatically---as if by magic. Or rather, as if by artificial
13282 stupidity, to be precise.
13284 @vindex gnus-use-adaptive-scoring
13285 When you read an article, or mark an article as read, or kill an
13286 article, you leave marks behind. On exit from the group, Gnus can sniff
13287 these marks and add score elements depending on what marks it finds.
13288 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
13289 @code{t} or @code{(line)}. If you want score adaptively on separate
13290 words appearing in the subjects, you should set this variable to
13291 @code{(word)}. If you want to use both adaptive methods, set this
13292 variable to @code{(word line)}.
13294 @vindex gnus-default-adaptive-score-alist
13295 To give you complete control over the scoring process, you can customize
13296 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
13297 might look something like this:
13300 (defvar gnus-default-adaptive-score-alist
13301 '((gnus-unread-mark)
13302 (gnus-ticked-mark (from 4))
13303 (gnus-dormant-mark (from 5))
13304 (gnus-del-mark (from -4) (subject -1))
13305 (gnus-read-mark (from 4) (subject 2))
13306 (gnus-expirable-mark (from -1) (subject -1))
13307 (gnus-killed-mark (from -1) (subject -3))
13308 (gnus-kill-file-mark)
13309 (gnus-ancient-mark)
13310 (gnus-low-score-mark)
13311 (gnus-catchup-mark (from -1) (subject -1))))
13314 As you see, each element in this alist has a mark as a key (either a
13315 variable name or a ``real'' mark---a character). Following this key is
13316 a arbitrary number of header/score pairs. If there are no header/score
13317 pairs following the key, no adaptive scoring will be done on articles
13318 that have that key as the article mark. For instance, articles with
13319 @code{gnus-unread-mark} in the example above will not get adaptive score
13322 Each article can have only one mark, so just a single of these rules
13323 will be applied to each article.
13325 To take @code{gnus-del-mark} as an example---this alist says that all
13326 articles that have that mark (i.e., are marked with @samp{D}) will have a
13327 score entry added to lower based on the @code{From} header by -4, and
13328 lowered by @code{Subject} by -1. Change this to fit your prejudices.
13330 If you have marked 10 articles with the same subject with
13331 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
13332 That means that that subject will get a score of ten times -1, which
13333 should be, unless I'm much mistaken, -10.
13335 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
13336 the read articles will be marked with the @samp{E} mark. This'll
13337 probably make adaptive scoring slightly impossible, so auto-expiring and
13338 adaptive scoring doesn't really mix very well.
13340 The headers you can score on are @code{from}, @code{subject},
13341 @code{message-id}, @code{references}, @code{xref}, @code{lines},
13342 @code{chars} and @code{date}. In addition, you can score on
13343 @code{followup}, which will create an adaptive score entry that matches
13344 on the @code{References} header using the @code{Message-ID} of the
13345 current article, thereby matching the following thread.
13347 You can also score on @code{thread}, which will try to score all
13348 articles that appear in a thread. @code{thread} matches uses a
13349 @code{Message-ID} to match on the @code{References} header of the
13350 article. If the match is made, the @code{Message-ID} of the article is
13351 added to the @code{thread} rule. (Think about it. I'd recommend two
13352 aspirins afterwards.)
13354 If you use this scheme, you should set the score file atom @code{mark}
13355 to something small---like -300, perhaps, to avoid having small random
13356 changes result in articles getting marked as read.
13358 After using adaptive scoring for a week or so, Gnus should start to
13359 become properly trained and enhance the authors you like best, and kill
13360 the authors you like least, without you having to say so explicitly.
13362 You can control what groups the adaptive scoring is to be performed on
13363 by using the score files (@pxref{Score File Format}). This will also
13364 let you use different rules in different groups.
13366 @vindex gnus-adaptive-file-suffix
13367 The adaptive score entries will be put into a file where the name is the
13368 group name with @code{gnus-adaptive-file-suffix} appended. The default
13371 @vindex gnus-score-exact-adapt-limit
13372 When doing adaptive scoring, substring or fuzzy matching would probably
13373 give you the best results in most cases. However, if the header one
13374 matches is short, the possibility for false positives is great, so if
13375 the length of the match is less than
13376 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
13377 this variable is @code{nil}, exact matching will always be used to avoid
13380 @vindex gnus-default-adaptive-word-score-alist
13381 As mentioned above, you can adapt either on individual words or entire
13382 headers. If you adapt on words, the
13383 @code{gnus-default-adaptive-word-score-alist} variable says what score
13384 each instance of a word should add given a mark.
13387 (setq gnus-default-adaptive-word-score-alist
13388 `((,gnus-read-mark . 30)
13389 (,gnus-catchup-mark . -10)
13390 (,gnus-killed-mark . -20)
13391 (,gnus-del-mark . -15)))
13394 This is the default value. If you have adaption on words enabled, every
13395 word that appears in subjects of articles marked with
13396 @code{gnus-read-mark} will result in a score rule that increase the
13397 score with 30 points.
13399 @vindex gnus-default-ignored-adaptive-words
13400 @vindex gnus-ignored-adaptive-words
13401 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
13402 will be ignored. If you wish to add more words to be ignored, use the
13403 @code{gnus-ignored-adaptive-words} list instead.
13405 @vindex gnus-adaptive-word-syntax-table
13406 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
13407 syntax table in effect. It is similar to the standard syntax table, but
13408 it considers numbers to be non-word-constituent characters.
13410 @vindex gnus-adaptive-word-minimum
13411 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
13412 word scoring process will never bring down the score of an article to
13413 below this number. The default is @code{nil}.
13415 @vindex gnus-adaptive-word-no-group-words
13416 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
13417 won't adaptively word score any of the words in the group name. Useful
13418 for groups like @samp{comp.editors.emacs}, where most of the subject
13419 lines contain the word @samp{emacs}.
13421 After using this scheme for a while, it might be nice to write a
13422 @code{gnus-psychoanalyze-user} command to go through the rules and see
13423 what words you like and what words you don't like. Or perhaps not.
13425 Note that the adaptive word scoring thing is highly experimental and is
13426 likely to change in the future. Initial impressions seem to indicate
13427 that it's totally useless as it stands. Some more work (involving more
13428 rigorous statistical methods) will have to be done to make this useful.
13431 @node Home Score File
13432 @section Home Score File
13434 The score file where new score file entries will go is called the
13435 @dfn{home score file}. This is normally (and by default) the score file
13436 for the group itself. For instance, the home score file for
13437 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
13439 However, this may not be what you want. It is often convenient to share
13440 a common home score file among many groups---all @samp{emacs} groups
13441 could perhaps use the same home score file.
13443 @vindex gnus-home-score-file
13444 The variable that controls this is @code{gnus-home-score-file}. It can
13449 A string. Then this file will be used as the home score file for all
13453 A function. The result of this function will be used as the home score
13454 file. The function will be called with the name of the group as the
13458 A list. The elements in this list can be:
13462 @var{(regexp file-name)}. If the @var{regexp} matches the group name,
13463 the @var{file-name} will will be used as the home score file.
13466 A function. If the function returns non-nil, the result will be used as
13467 the home score file.
13470 A string. Use the string as the home score file.
13473 The list will be traversed from the beginning towards the end looking
13478 So, if you want to use just a single score file, you could say:
13481 (setq gnus-home-score-file
13482 "my-total-score-file.SCORE")
13485 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
13486 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
13488 @findex gnus-hierarchial-home-score-file
13490 (setq gnus-home-score-file
13491 'gnus-hierarchial-home-score-file)
13494 This is a ready-made function provided for your convenience.
13495 Other functions include
13498 @item gnus-current-home-score-file
13499 @findex gnus-current-home-score-file
13500 Return the ``current'' regular score file. This will make scoring
13501 commands add entry to the ``innermost'' matching score file.
13505 If you want to have one score file for the @samp{emacs} groups and
13506 another for the @samp{comp} groups, while letting all other groups use
13507 their own home score files:
13510 (setq gnus-home-score-file
13511 ;; All groups that match the regexp "\\.emacs"
13512 '(("\\.emacs" "emacs.SCORE")
13513 ;; All the comp groups in one score file
13514 ("^comp" "comp.SCORE")))
13517 @vindex gnus-home-adapt-file
13518 @code{gnus-home-adapt-file} works exactly the same way as
13519 @code{gnus-home-score-file}, but says what the home adaptive score file
13520 is instead. All new adaptive file entries will go into the file
13521 specified by this variable, and the same syntax is allowed.
13523 In addition to using @code{gnus-home-score-file} and
13524 @code{gnus-home-adapt-file}, you can also use group parameters
13525 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
13526 Parameters}) to achieve much the same. Group and topic parameters take
13527 precedence over this variable.
13530 @node Followups To Yourself
13531 @section Followups To Yourself
13533 Gnus offers two commands for picking out the @code{Message-ID} header in
13534 the current buffer. Gnus will then add a score rule that scores using
13535 this @code{Message-ID} on the @code{References} header of other
13536 articles. This will, in effect, increase the score of all articles that
13537 respond to the article in the current buffer. Quite useful if you want
13538 to easily note when people answer what you've said.
13542 @item gnus-score-followup-article
13543 @findex gnus-score-followup-article
13544 This will add a score to articles that directly follow up your own
13547 @item gnus-score-followup-thread
13548 @findex gnus-score-followup-thread
13549 This will add a score to all articles that appear in a thread ``below''
13553 @vindex message-sent-hook
13554 These two functions are both primarily meant to be used in hooks like
13555 @code{message-sent-hook}.
13557 If you look closely at your own @code{Message-ID}, you'll notice that
13558 the first two or three characters are always the same. Here's two of
13562 <x6u3u47icf.fsf@@eyesore.no>
13563 <x6sp9o7ibw.fsf@@eyesore.no>
13566 So ``my'' ident on this machine is @samp{x6}. This can be
13567 exploited---the following rule will raise the score on all followups to
13572 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore.no>"
13576 Whether it's the first two or first three characters that are ``yours''
13577 is system-dependent.
13581 @section Scoring Tips
13582 @cindex scoring tips
13588 @cindex scoring crossposts
13589 If you want to lower the score of crossposts, the line to match on is
13590 the @code{Xref} header.
13592 ("xref" (" talk.politics.misc:" -1000))
13595 @item Multiple crossposts
13596 If you want to lower the score of articles that have been crossposted to
13597 more than, say, 3 groups:
13599 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
13602 @item Matching on the body
13603 This is generally not a very good idea---it takes a very long time.
13604 Gnus actually has to fetch each individual article from the server. But
13605 you might want to anyway, I guess. Even though there are three match
13606 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
13607 and stick with it in each score file. If you use any two, each article
13608 will be fetched @emph{twice}. If you want to match a bit on the
13609 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
13612 @item Marking as read
13613 You will probably want to mark articles that has a score below a certain
13614 number as read. This is most easily achieved by putting the following
13615 in your @file{all.SCORE} file:
13619 You may also consider doing something similar with @code{expunge}.
13621 @item Negated character classes
13622 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
13623 That will match newlines, which might lead to, well, The Unknown. Say
13624 @code{[^abcd\n]*} instead.
13628 @node Reverse Scoring
13629 @section Reverse Scoring
13630 @cindex reverse scoring
13632 If you want to keep just articles that have @samp{Sex with Emacs} in the
13633 subject header, and expunge all other articles, you could put something
13634 like this in your score file:
13638 ("Sex with Emacs" 2))
13643 So, you raise all articles that match @samp{Sex with Emacs} and mark the
13644 rest as read, and expunge them to boot.
13647 @node Global Score Files
13648 @section Global Score Files
13649 @cindex global score files
13651 Sure, other newsreaders have ``global kill files''. These are usually
13652 nothing more than a single kill file that applies to all groups, stored
13653 in the user's home directory. Bah! Puny, weak newsreaders!
13655 What I'm talking about here are Global Score Files. Score files from
13656 all over the world, from users everywhere, uniting all nations in one
13657 big, happy score file union! Ange-score! New and untested!
13659 @vindex gnus-global-score-files
13660 All you have to do to use other people's score files is to set the
13661 @code{gnus-global-score-files} variable. One entry for each score file,
13662 or each score file directory. Gnus will decide by itself what score
13663 files are applicable to which group.
13665 Say you want to use the score file
13666 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
13667 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
13670 (setq gnus-global-score-files
13671 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
13672 "/ftp@@ftp.some-where:/pub/score/"))
13675 @findex gnus-score-search-global-directories
13676 Simple, eh? Directory names must end with a @samp{/}. These
13677 directories are typically scanned only once during each Gnus session.
13678 If you feel the need to manually re-scan the remote directories, you can
13679 use the @code{gnus-score-search-global-directories} command.
13681 Note that, at present, using this option will slow down group entry
13682 somewhat. (That is---a lot.)
13684 If you want to start maintaining score files for other people to use,
13685 just put your score file up for anonymous ftp and announce it to the
13686 world. Become a retro-moderator! Participate in the retro-moderator
13687 wars sure to ensue, where retro-moderators battle it out for the
13688 sympathy of the people, luring them to use their score files on false
13689 premises! Yay! The net is saved!
13691 Here are some tips for the would-be retro-moderator, off the top of my
13697 Articles heavily crossposted are probably junk.
13699 To lower a single inappropriate article, lower by @code{Message-ID}.
13701 Particularly brilliant authors can be raised on a permanent basis.
13703 Authors that repeatedly post off-charter for the group can safely be
13704 lowered out of existence.
13706 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
13707 articles completely.
13710 Use expiring score entries to keep the size of the file down. You
13711 should probably have a long expiry period, though, as some sites keep
13712 old articles for a long time.
13715 ... I wonder whether other newsreaders will support global score files
13716 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
13717 Wave, xrn and 1stReader are bound to implement scoring. Should we start
13718 holding our breath yet?
13722 @section Kill Files
13725 Gnus still supports those pesky old kill files. In fact, the kill file
13726 entries can now be expiring, which is something I wrote before Daniel
13727 Quinlan thought of doing score files, so I've left the code in there.
13729 In short, kill processing is a lot slower (and I do mean @emph{a lot})
13730 than score processing, so it might be a good idea to rewrite your kill
13731 files into score files.
13733 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
13734 forms into this file, which means that you can use kill files as some
13735 sort of primitive hook function to be run on group entry, even though
13736 that isn't a very good idea.
13738 Normal kill files look like this:
13741 (gnus-kill "From" "Lars Ingebrigtsen")
13742 (gnus-kill "Subject" "ding")
13746 This will mark every article written by me as read, and remove the
13747 marked articles from the summary buffer. Very useful, you'll agree.
13749 Other programs use a totally different kill file syntax. If Gnus
13750 encounters what looks like a @code{rn} kill file, it will take a stab at
13753 Two summary functions for editing a GNUS kill file:
13758 @kindex M-k (Summary)
13759 @findex gnus-summary-edit-local-kill
13760 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
13763 @kindex M-K (Summary)
13764 @findex gnus-summary-edit-global-kill
13765 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
13768 Two group mode functions for editing the kill files:
13773 @kindex M-k (Group)
13774 @findex gnus-group-edit-local-kill
13775 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
13778 @kindex M-K (Group)
13779 @findex gnus-group-edit-global-kill
13780 Edit the general kill file (@code{gnus-group-edit-global-kill}).
13783 Kill file variables:
13786 @item gnus-kill-file-name
13787 @vindex gnus-kill-file-name
13788 A kill file for the group @samp{soc.motss} is normally called
13789 @file{soc.motss.KILL}. The suffix appended to the group name to get
13790 this file name is detailed by the @code{gnus-kill-file-name} variable.
13791 The ``global'' kill file (not in the score file sense of ``global'', of
13792 course) is just called @file{KILL}.
13794 @vindex gnus-kill-save-kill-file
13795 @item gnus-kill-save-kill-file
13796 If this variable is non-@code{nil}, Gnus will save the
13797 kill file after processing, which is necessary if you use expiring
13800 @item gnus-apply-kill-hook
13801 @vindex gnus-apply-kill-hook
13802 @findex gnus-apply-kill-file-unless-scored
13803 @findex gnus-apply-kill-file
13804 A hook called to apply kill files to a group. It is
13805 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
13806 kill file if you have a score file for the same group, you can set this
13807 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
13808 kill files to be processed, you should set this variable to @code{nil}.
13810 @item gnus-kill-file-mode-hook
13811 @vindex gnus-kill-file-mode-hook
13812 A hook called in kill-file mode buffers.
13817 @node Converting Kill Files
13818 @section Converting Kill Files
13820 @cindex converting kill files
13822 If you have loads of old kill files, you may want to convert them into
13823 score files. If they are ``regular'', you can use
13824 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
13827 The kill to score conversion package isn't included in Gnus by default.
13828 You can fetch it from
13829 @file{http://www.stud.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
13831 If your old kill files are very complex---if they contain more
13832 non-@code{gnus-kill} forms than not, you'll have to convert them by
13833 hand. Or just let them be as they are. Gnus will still use them as
13841 GroupLens is a collaborative filtering system that helps you work
13842 together with other people to find the quality news articles out of the
13843 huge volume of news articles generated every day.
13845 To accomplish this the GroupLens system combines your opinions about
13846 articles you have already read with the opinions of others who have done
13847 likewise and gives you a personalized prediction for each unread news
13848 article. Think of GroupLens as a matchmaker. GroupLens watches how you
13849 rate articles, and finds other people that rate articles the same way.
13850 Once it has found some people you agree with it tells you, in the form
13851 of a prediction, what they thought of the article. You can use this
13852 prediction to help you decide whether or not you want to read the
13856 * Using GroupLens:: How to make Gnus use GroupLens.
13857 * Rating Articles:: Letting GroupLens know how you rate articles.
13858 * Displaying Predictions:: Displaying predictions given by GroupLens.
13859 * GroupLens Variables:: Customizing GroupLens.
13863 @node Using GroupLens
13864 @subsection Using GroupLens
13866 To use GroupLens you must register a pseudonym with your local Better
13868 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
13869 better bit in town at the moment.
13871 Once you have registered you'll need to set a couple of variables.
13875 @item gnus-use-grouplens
13876 @vindex gnus-use-grouplens
13877 Setting this variable to a non-@code{nil} value will make Gnus hook into
13878 all the relevant GroupLens functions.
13880 @item grouplens-pseudonym
13881 @vindex grouplens-pseudonym
13882 This variable should be set to the pseudonym you got when registering
13883 with the Better Bit Bureau.
13885 @item grouplens-newsgroups
13886 @vindex grouplens-newsgroups
13887 A list of groups that you want to get GroupLens predictions for.
13891 That's the minimum of what you need to get up and running with GroupLens.
13892 Once you've registered, GroupLens will start giving you scores for
13893 articles based on the average of what other people think. But, to get
13894 the real benefit of GroupLens you need to start rating articles
13895 yourself. Then the scores GroupLens gives you will be personalized for
13896 you, based on how the people you usually agree with have already rated.
13899 @node Rating Articles
13900 @subsection Rating Articles
13902 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
13903 Where 1 means something like this article is a waste of bandwidth and 5
13904 means that the article was really good. The basic question to ask
13905 yourself is, "on a scale from 1 to 5 would I like to see more articles
13908 There are four ways to enter a rating for an article in GroupLens.
13913 @kindex r (GroupLens)
13914 @findex bbb-summary-rate-article
13915 This function will prompt you for a rating on a scale of one to five.
13918 @kindex k (GroupLens)
13919 @findex grouplens-score-thread
13920 This function will prompt you for a rating, and rate all the articles in
13921 the thread. This is really useful for some of those long running giant
13922 threads in rec.humor.
13926 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
13927 the score of the article you're reading.
13932 @kindex n (GroupLens)
13933 @findex grouplens-next-unread-article
13934 Rate the article and go to the next unread article.
13937 @kindex , (GroupLens)
13938 @findex grouplens-best-unread-article
13939 Rate the article and go to the next unread article with the highest score.
13943 If you want to give the current article a score of 4 and then go to the
13944 next article, just type @kbd{4 n}.
13947 @node Displaying Predictions
13948 @subsection Displaying Predictions
13950 GroupLens makes a prediction for you about how much you will like a
13951 news article. The predictions from GroupLens are on a scale from 1 to
13952 5, where 1 is the worst and 5 is the best. You can use the predictions
13953 from GroupLens in one of three ways controlled by the variable
13954 @code{gnus-grouplens-override-scoring}.
13956 @vindex gnus-grouplens-override-scoring
13957 There are three ways to display predictions in grouplens. You may
13958 choose to have the GroupLens scores contribute to, or override the
13959 regular gnus scoring mechanism. override is the default; however, some
13960 people prefer to see the Gnus scores plus the grouplens scores. To get
13961 the separate scoring behavior you need to set
13962 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
13963 GroupLens predictions combined with the grouplens scores set it to
13964 @code{'override} and to combine the scores set
13965 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
13966 the combine option you will also want to set the values for
13967 @code{grouplens-prediction-offset} and
13968 @code{grouplens-score-scale-factor}.
13970 @vindex grouplens-prediction-display
13971 In either case, GroupLens gives you a few choices for how you would like
13972 to see your predictions displayed. The display of predictions is
13973 controlled by the @code{grouplens-prediction-display} variable.
13975 The following are valid values for that variable.
13978 @item prediction-spot
13979 The higher the prediction, the further to the right an @samp{*} is
13982 @item confidence-interval
13983 A numeric confidence interval.
13985 @item prediction-bar
13986 The higher the prediction, the longer the bar.
13988 @item confidence-bar
13989 Numerical confidence.
13991 @item confidence-spot
13992 The spot gets bigger with more confidence.
13994 @item prediction-num
13995 Plain-old numeric value.
13997 @item confidence-plus-minus
13998 Prediction +/- confidence.
14003 @node GroupLens Variables
14004 @subsection GroupLens Variables
14008 @item gnus-summary-grouplens-line-format
14009 The summary line format used in GroupLens-enhanced summary buffers. It
14010 accepts the same specs as the normal summary line format (@pxref{Summary
14011 Buffer Lines}). The default is @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%)
14014 @item grouplens-bbb-host
14015 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
14018 @item grouplens-bbb-port
14019 Port of the host running the bbbd server. The default is 9000.
14021 @item grouplens-score-offset
14022 Offset the prediction by this value. In other words, subtract the
14023 prediction value by this number to arrive at the effective score. The
14026 @item grouplens-score-scale-factor
14027 This variable allows the user to magnify the effect of GroupLens scores.
14028 The scale factor is applied after the offset. The default is 1.
14033 @node Advanced Scoring
14034 @section Advanced Scoring
14036 Scoring on Subjects and From headers is nice enough, but what if you're
14037 really interested in what a person has to say only when she's talking
14038 about a particular subject? Or what if you really don't want to
14039 read what person A has to say when she's following up to person B, but
14040 want to read what she says when she's following up to person C?
14042 By using advanced scoring rules you may create arbitrarily complex
14046 * Advanced Scoring Syntax:: A definition.
14047 * Advanced Scoring Examples:: What they look like.
14048 * Advanced Scoring Tips:: Getting the most out of it.
14052 @node Advanced Scoring Syntax
14053 @subsection Advanced Scoring Syntax
14055 Ordinary scoring rules have a string as the first element in the rule.
14056 Advanced scoring rules have a list as the first element. The second
14057 element is the score to be applied if the first element evaluated to a
14058 non-@code{nil} value.
14060 These lists may consist of three logical operators, one redirection
14061 operator, and various match operators.
14068 This logical operator will evaluate each of its arguments until it finds
14069 one that evaluates to @code{false}, and then it'll stop. If all arguments
14070 evaluate to @code{true} values, then this operator will return
14075 This logical operator will evaluate each of its arguments until it finds
14076 one that evaluates to @code{true}. If no arguments are @code{true},
14077 then this operator will return @code{false}.
14082 This logical operator only takes a single argument. It returns the
14083 logical negation of the value of its argument.
14087 There is an @dfn{indirection operator} that will make its arguments
14088 apply to the ancestors of the current article being scored. For
14089 instance, @code{1-} will make score rules apply to the parent of the
14090 current article. @code{2-} will make score rules apply to the
14091 grandparent of the current article. Alternatively, you can write
14092 @code{^^}, where the number of @code{^}s (carets) says how far back into
14093 the ancestry you want to go.
14095 Finally, we have the match operators. These are the ones that do the
14096 real work. Match operators are header name strings followed by a match
14097 and a match type. A typical match operator looks like @samp{("from"
14098 "Lars Ingebrigtsen" s)}. The header names are the same as when using
14099 simple scoring, and the match types are also the same.
14102 @node Advanced Scoring Examples
14103 @subsection Advanced Scoring Examples
14105 Let's say you want to increase the score of articles written by Lars
14106 when he's talking about Gnus:
14110 ("from" "Lars Ingebrigtsen")
14111 ("subject" "Gnus"))
14117 When he writes long articles, he sometimes has something nice to say:
14121 ("from" "Lars Ingebrigtsen")
14128 However, when he responds to things written by Reig Eigil Logge, you
14129 really don't want to read what he's written:
14133 ("from" "Lars Ingebrigtsen")
14134 (1- ("from" "Reig Eigir Logge")))
14138 Everybody that follows up Redmondo when he writes about disappearing
14139 socks should have their scores raised, but only when they talk about
14140 white socks. However, when Lars talks about socks, it's usually not
14147 ("from" "redmondo@@.*no" r)
14148 ("body" "disappearing.*socks" t)))
14149 (! ("from" "Lars Ingebrigtsen"))
14150 ("body" "white.*socks"))
14154 The possibilities are endless.
14157 @node Advanced Scoring Tips
14158 @subsection Advanced Scoring Tips
14160 The @code{&} and @code{|} logical operators do short-circuit logic.
14161 That is, they stop processing their arguments when it's clear what the
14162 result of the operation will be. For instance, if one of the arguments
14163 of an @code{&} evaluates to @code{false}, there's no point in evaluating
14164 the rest of the arguments. This means that you should put slow matches
14165 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
14166 @samp{subject}) first.
14168 The indirection arguments (@code{1-} and so on) will make their
14169 arguments work on previous generations of the thread. If you say
14180 Then that means "score on the from header of the grandparent of the
14181 current article". An indirection is quite fast, but it's better to say:
14187 ("subject" "Gnus")))
14194 (1- ("from" "Lars"))
14195 (1- ("subject" "Gnus")))
14200 @section Score Decays
14201 @cindex score decays
14204 You may find that your scores have a tendency to grow without
14205 bounds, especially if you're using adaptive scoring. If scores get too
14206 big, they lose all meaning---they simply max out and it's difficult to
14207 use them in any sensible way.
14209 @vindex gnus-decay-scores
14210 @findex gnus-decay-score
14211 @vindex gnus-decay-score-function
14212 Gnus provides a mechanism for decaying scores to help with this problem.
14213 When score files are loaded and @code{gnus-decay-scores} is
14214 non-@code{nil}, Gnus will run the score files through the decaying
14215 mechanism thereby lowering the scores of all non-permanent score rules.
14216 The decay itself if performed by the @code{gnus-decay-score-function}
14217 function, which is @code{gnus-decay-score} by default. Here's the
14218 definition of that function:
14221 (defun gnus-decay-score (score)
14223 This is done according to `gnus-score-decay-constant'
14224 and `gnus-score-decay-scale'."
14227 (* (if (< score 0) 1 -1)
14229 (max gnus-score-decay-constant
14231 gnus-score-decay-scale)))))))
14234 @vindex gnus-score-decay-scale
14235 @vindex gnus-score-decay-constant
14236 @code{gnus-score-decay-constant} is 3 by default and
14237 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
14241 Scores between -3 and 3 will be set to 0 when this function is called.
14244 Scores with magnitudes between 3 and 60 will be shrunk by 3.
14247 Scores with magnitudes greater than 60 will be shrunk by 5% of the
14251 If you don't like this decay function, write your own. It is called
14252 with the score to be decayed as its only parameter, and it should return
14253 the new score, which should be an integer.
14255 Gnus will try to decay scores once a day. If you haven't run Gnus for
14256 four days, Gnus will decay the scores four times, for instance.
14263 * Process/Prefix:: A convention used by many treatment commands.
14264 * Interactive:: Making Gnus ask you many questions.
14265 * Symbolic Prefixes:: How to supply some Gnus functions with options.
14266 * Formatting Variables:: You can specify what buffers should look like.
14267 * Windows Configuration:: Configuring the Gnus buffer windows.
14268 * Faces and Fonts:: How to change how faces look.
14269 * Compilation:: How to speed Gnus up.
14270 * Mode Lines:: Displaying information in the mode lines.
14271 * Highlighting and Menus:: Making buffers look all nice and cozy.
14272 * Buttons:: Get tendonitis in ten easy steps!
14273 * Daemons:: Gnus can do things behind your back.
14274 * NoCeM:: How to avoid spam and other fatty foods.
14275 * Undo:: Some actions can be undone.
14276 * Moderation:: What to do if you're a moderator.
14277 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
14278 * Fuzzy Matching:: What's the big fuzz?
14279 * Thwarting Email Spam:: A how-to on avoiding unsolicited commercial email.
14280 * Various Various:: Things that are really various.
14284 @node Process/Prefix
14285 @section Process/Prefix
14286 @cindex process/prefix convention
14288 Many functions, among them functions for moving, decoding and saving
14289 articles, use what is known as the @dfn{Process/Prefix convention}.
14291 This is a method for figuring out what articles the user wants the
14292 command to be performed on.
14296 If the numeric prefix is N, perform the operation on the next N
14297 articles, starting with the current one. If the numeric prefix is
14298 negative, perform the operation on the previous N articles, starting
14299 with the current one.
14301 @vindex transient-mark-mode
14302 If @code{transient-mark-mode} in non-@code{nil} and the region is
14303 active, all articles in the region will be worked upon.
14305 If there is no numeric prefix, but some articles are marked with the
14306 process mark, perform the operation on the articles marked with
14309 If there is neither a numeric prefix nor any articles marked with the
14310 process mark, just perform the operation on the current article.
14312 Quite simple, really, but it needs to be made clear so that surprises
14315 Commands that react to the process mark will push the current list of
14316 process marked articles onto a stack and will then clear all process
14317 marked articles. You can restore the previous configuration with the
14318 @kbd{M P y} command (@pxref{Setting Process Marks}).
14320 @vindex gnus-summary-goto-unread
14321 One thing that seems to shock & horrify lots of people is that, for
14322 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
14323 Since each @kbd{d} (which marks the current article as read) by default
14324 goes to the next unread article after marking, this means that @kbd{3 d}
14325 will mark the next three unread articles as read, no matter what the
14326 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
14327 @code{nil} for a more straightforward action.
14331 @section Interactive
14332 @cindex interaction
14336 @item gnus-novice-user
14337 @vindex gnus-novice-user
14338 If this variable is non-@code{nil}, you are either a newcomer to the
14339 World of Usenet, or you are very cautious, which is a nice thing to be,
14340 really. You will be given questions of the type ``Are you sure you want
14341 to do this?'' before doing anything dangerous. This is @code{t} by
14344 @item gnus-expert-user
14345 @vindex gnus-expert-user
14346 If this variable is non-@code{nil}, you will seldom be asked any
14347 questions by Gnus. It will simply assume you know what you're doing, no
14348 matter how strange.
14350 @item gnus-interactive-catchup
14351 @vindex gnus-interactive-catchup
14352 Require confirmation before catching up a group if non-@code{nil}. It
14353 is @code{t} by default.
14355 @item gnus-interactive-exit
14356 @vindex gnus-interactive-exit
14357 Require confirmation before exiting Gnus. This variable is @code{t} by
14362 @node Symbolic Prefixes
14363 @section Symbolic Prefixes
14364 @cindex symbolic prefixes
14366 Quite a lot of Emacs commands react to the (numeric) prefix. For
14367 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
14368 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
14369 rule of 900 to the current article.
14371 This is all nice and well, but what if you want to give a command some
14372 additional information? Well, what most commands do is interpret the
14373 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
14374 doesn't want a backup file to be created when saving the current buffer,
14375 for instance. But what if you want to save without making a backup
14376 file, and you want Emacs to flash lights and play a nice tune at the
14377 same time? You can't, and you're probably perfectly happy that way.
14379 @kindex M-i (Summary)
14380 @findex gnus-symbolic-argument
14381 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
14382 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
14383 character typed in is the value. You can stack as many @kbd{M-i}
14384 prefixes as you want. @kbd{M-i a M-C-u} means ``feed the @kbd{M-C-u}
14385 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b M-C-u} means
14386 ``feed the @kbd{M-C-u} command the symbolic prefixes @code{a} and
14387 @code{b}''. You get the drift.
14389 Typing in symbolic prefixes to commands that don't accept them doesn't
14390 hurt, but it doesn't do any good either. Currently not many Gnus
14391 functions make use of the symbolic prefix.
14393 If you're interested in how Gnus implements this, @pxref{Extended
14397 @node Formatting Variables
14398 @section Formatting Variables
14399 @cindex formatting variables
14401 Throughout this manual you've probably noticed lots of variables called
14402 things like @code{gnus-group-line-format} and
14403 @code{gnus-summary-mode-line-format}. These control how Gnus is to
14404 output lines in the various buffers. There's quite a lot of them.
14405 Fortunately, they all use the same syntax, so there's not that much to
14408 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
14409 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
14410 lots of percentages everywhere.
14413 * Formatting Basics:: A formatting variable is basically a format string.
14414 * Mode Line Formatting:: Some rules about mode line formatting variables.
14415 * Advanced Formatting:: Modifying output in various ways.
14416 * User-Defined Specs:: Having Gnus call your own functions.
14417 * Formatting Fonts:: Making the formatting look colorful and nice.
14420 Currently Gnus uses the following formatting variables:
14421 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
14422 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
14423 @code{gnus-group-mode-line-format},
14424 @code{gnus-summary-mode-line-format},
14425 @code{gnus-article-mode-line-format},
14426 @code{gnus-server-mode-line-format}, and
14427 @code{gnus-summary-pick-line-format}.
14429 All these format variables can also be arbitrary elisp forms. In that
14430 case, they will be @code{eval}ed to insert the required lines.
14432 @kindex M-x gnus-update-format
14433 @findex gnus-update-format
14434 Gnus includes a command to help you while creating your own format
14435 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
14436 update the spec in question and pop you to a buffer where you can
14437 examine the resulting lisp code to be run to generate the line.
14441 @node Formatting Basics
14442 @subsection Formatting Basics
14444 Each @samp{%} element will be replaced by some string or other when the
14445 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
14446 spec, and pad with spaces to get a 5-character field''.
14448 As with normal C and Emacs Lisp formatting strings, the numerical
14449 modifier between the @samp{%} and the formatting type character will
14450 @dfn{pad} the output so that it is always at least that long.
14451 @samp{%5y} will make the field always (at least) five characters wide by
14452 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
14455 You may also wish to limit the length of the field to protect against
14456 particularly wide values. For that you can say @samp{%4,6y}, which
14457 means that the field will never be more than 6 characters wide and never
14458 less than 4 characters wide.
14461 @node Mode Line Formatting
14462 @subsection Mode Line Formatting
14464 Mode line formatting variables (e.g.,
14465 @code{gnus-summary-mode-line-format}) follow the same rules as other,
14466 buffer line oriented formatting variables (@pxref{Formatting Basics})
14467 with the following two differences:
14472 There must be no newline (@samp{\n}) at the end.
14475 The special @samp{%%b} spec can be used to display the buffer name.
14476 Well, it's no spec at all, really---@samp{%%} is just a way to quote
14477 @samp{%} to allow it to pass through the formatting machinery unmangled,
14478 so that Emacs receives @samp{%b}, which is something the Emacs mode line
14479 display interprets to mean ``show the buffer name''. For a full list of
14480 mode line specs Emacs understands, see the documentation of the
14481 @code{mode-line-format} variable.
14486 @node Advanced Formatting
14487 @subsection Advanced Formatting
14489 It is frequently useful to post-process the fields in some way.
14490 Padding, limiting, cutting off parts and suppressing certain values can
14491 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
14492 look like @samp{%~(cut 3)~(ignore "0")y}.
14494 These are the valid modifiers:
14499 Pad the field to the left with spaces until it reaches the required
14503 Pad the field to the right with spaces until it reaches the required
14508 Cut off characters from the left until it reaches the specified length.
14511 Cut off characters from the right until it reaches the specified
14516 Cut off the specified number of characters from the left.
14519 Cut off the specified number of characters from the right.
14522 Return an empty string if the field is equal to the specified value.
14525 Use the specified form as the field value when the @samp{@@} spec is
14529 Let's take an example. The @samp{%o} spec in the summary mode lines
14530 will return a date in compact ISO8601 format---@samp{19960809T230410}.
14531 This is quite a mouthful, so we want to shave off the century number and
14532 the time, leaving us with a six-character date. That would be
14533 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
14534 maxing, and we need the padding to ensure that the date is never less
14535 than 6 characters to make it look nice in columns.)
14537 Ignoring is done first; then cutting; then maxing; and then as the very
14538 last operation, padding.
14540 If you use lots of these advanced thingies, you'll find that Gnus gets
14541 quite slow. This can be helped enormously by running @kbd{M-x
14542 gnus-compile} when you are satisfied with the look of your lines.
14543 @xref{Compilation}.
14546 @node User-Defined Specs
14547 @subsection User-Defined Specs
14549 All the specs allow for inserting user defined specifiers---@samp{u}.
14550 The next character in the format string should be a letter. Gnus
14551 will call the function @code{gnus-user-format-function-}@samp{X}, where
14552 @samp{X} is the letter following @samp{%u}. The function will be passed
14553 a single parameter---what the parameter means depends on what buffer
14554 it's being called from. The function should return a string, which will
14555 be inserted into the buffer just like information from any other
14556 specifier. This function may also be called with dummy values, so it
14557 should protect against that.
14559 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
14560 much the same without defining new functions. Here's an example:
14561 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
14562 given here will be evaluated to yield the current line number, and then
14566 @node Formatting Fonts
14567 @subsection Formatting Fonts
14569 There are specs for highlighting, and these are shared by all the format
14570 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
14571 the special @code{mouse-face} property set, which means that it will be
14572 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
14575 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
14576 normal faces set using @code{gnus-face-0}, which is @code{bold} by
14577 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
14578 and so on. Create as many faces as you wish. The same goes for the
14579 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
14580 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
14582 Text inside the @samp{%<} and @samp{%>} specifiers will get the special
14583 @code{balloon-help} property set to @code{gnus-balloon-face-0}. If you say
14584 @samp{%1<}, you'll get @code{gnus-balloon-face-1} and so on. The
14585 @code{gnus-balloon-face-*} variables should be either strings or
14586 symbols naming functions that return a string. Under @code{balloon-help-mode},
14587 when the mouse passes over text with this property set, a balloon window
14588 will appear and display the string. Please refer to the doc string of
14589 @code{balloon-help-mode} for more information on this.
14591 Here's an alternative recipe for the group buffer:
14594 ;; Create three face types.
14595 (setq gnus-face-1 'bold)
14596 (setq gnus-face-3 'italic)
14598 ;; We want the article count to be in
14599 ;; a bold and green face. So we create
14600 ;; a new face called `my-green-bold'.
14601 (copy-face 'bold 'my-green-bold)
14603 (set-face-foreground 'my-green-bold "ForestGreen")
14604 (setq gnus-face-2 'my-green-bold)
14606 ;; Set the new & fancy format.
14607 (setq gnus-group-line-format
14608 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
14611 I'm sure you'll be able to use this scheme to create totally unreadable
14612 and extremely vulgar displays. Have fun!
14614 Note that the @samp{%(} specs (and friends) do not make any sense on the
14615 mode-line variables.
14618 @node Windows Configuration
14619 @section Windows Configuration
14620 @cindex windows configuration
14622 No, there's nothing here about X, so be quiet.
14624 @vindex gnus-use-full-window
14625 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
14626 other windows and occupy the entire Emacs screen by itself. It is
14627 @code{t} by default.
14629 Setting this variable to @code{nil} kinda works, but there are
14630 glitches. Use at your own peril.
14632 @vindex gnus-buffer-configuration
14633 @code{gnus-buffer-configuration} describes how much space each Gnus
14634 buffer should be given. Here's an excerpt of this variable:
14637 ((group (vertical 1.0 (group 1.0 point)
14638 (if gnus-carpal (group-carpal 4))))
14639 (article (vertical 1.0 (summary 0.25 point)
14643 This is an alist. The @dfn{key} is a symbol that names some action or
14644 other. For instance, when displaying the group buffer, the window
14645 configuration function will use @code{group} as the key. A full list of
14646 possible names is listed below.
14648 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
14649 should occupy. To take the @code{article} split as an example -
14652 (article (vertical 1.0 (summary 0.25 point)
14656 This @dfn{split} says that the summary buffer should occupy 25% of upper
14657 half of the screen, and that it is placed over the article buffer. As
14658 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
14659 reaching for that calculator there). However, the special number
14660 @code{1.0} is used to signal that this buffer should soak up all the
14661 rest of the space available after the rest of the buffers have taken
14662 whatever they need. There should be only one buffer with the @code{1.0}
14663 size spec per split.
14665 Point will be put in the buffer that has the optional third element
14666 @code{point}. In a @code{frame} split, the last subsplit having a leaf
14667 split where the tag @code{frame-focus} is a member (i.e. is the third or
14668 fourth element in the list, depending on whether the @code{point} tag is
14669 present) gets focus.
14671 Here's a more complicated example:
14674 (article (vertical 1.0 (group 4)
14675 (summary 0.25 point)
14676 (if gnus-carpal (summary-carpal 4))
14680 If the size spec is an integer instead of a floating point number,
14681 then that number will be used to say how many lines a buffer should
14682 occupy, not a percentage.
14684 If the @dfn{split} looks like something that can be @code{eval}ed (to be
14685 precise---if the @code{car} of the split is a function or a subr), this
14686 split will be @code{eval}ed. If the result is non-@code{nil}, it will
14687 be used as a split. This means that there will be three buffers if
14688 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
14691 Not complicated enough for you? Well, try this on for size:
14694 (article (horizontal 1.0
14699 (summary 0.25 point)
14704 Whoops. Two buffers with the mystery 100% tag. And what's that
14705 @code{horizontal} thingie?
14707 If the first element in one of the split is @code{horizontal}, Gnus will
14708 split the window horizontally, giving you two windows side-by-side.
14709 Inside each of these strips you may carry on all you like in the normal
14710 fashion. The number following @code{horizontal} says what percentage of
14711 the screen is to be given to this strip.
14713 For each split, there @emph{must} be one element that has the 100% tag.
14714 The splitting is never accurate, and this buffer will eat any leftover
14715 lines from the splits.
14717 To be slightly more formal, here's a definition of what a valid split
14721 split = frame | horizontal | vertical | buffer | form
14722 frame = "(frame " size *split ")"
14723 horizontal = "(horizontal " size *split ")"
14724 vertical = "(vertical " size *split ")"
14725 buffer = "(" buffer-name " " size *[ "point" ] *[ "frame-focus"] ")"
14726 size = number | frame-params
14727 buffer-name = group | article | summary ...
14730 The limitations are that the @code{frame} split can only appear as the
14731 top-level split. @var{form} should be an Emacs Lisp form that should
14732 return a valid split. We see that each split is fully recursive, and
14733 may contain any number of @code{vertical} and @code{horizontal} splits.
14735 @vindex gnus-window-min-width
14736 @vindex gnus-window-min-height
14737 @cindex window height
14738 @cindex window width
14739 Finding the right sizes can be a bit complicated. No window may be less
14740 than @code{gnus-window-min-height} (default 1) characters high, and all
14741 windows must be at least @code{gnus-window-min-width} (default 1)
14742 characters wide. Gnus will try to enforce this before applying the
14743 splits. If you want to use the normal Emacs window width/height limit,
14744 you can just set these two variables to @code{nil}.
14746 If you're not familiar with Emacs terminology, @code{horizontal} and
14747 @code{vertical} splits may work the opposite way of what you'd expect.
14748 Windows inside a @code{horizontal} split are shown side-by-side, and
14749 windows within a @code{vertical} split are shown above each other.
14751 @findex gnus-configure-frame
14752 If you want to experiment with window placement, a good tip is to call
14753 @code{gnus-configure-frame} directly with a split. This is the function
14754 that does all the real work when splitting buffers. Below is a pretty
14755 nonsensical configuration with 5 windows; two for the group buffer and
14756 three for the article buffer. (I said it was nonsensical.) If you
14757 @code{eval} the statement below, you can get an idea of how that would
14758 look straight away, without going through the normal Gnus channels.
14759 Play with it until you're satisfied, and then use
14760 @code{gnus-add-configuration} to add your new creation to the buffer
14761 configuration list.
14764 (gnus-configure-frame
14768 (article 0.3 point))
14776 You might want to have several frames as well. No prob---just use the
14777 @code{frame} split:
14780 (gnus-configure-frame
14783 (summary 0.25 point frame-focus)
14785 (vertical ((height . 5) (width . 15)
14786 (user-position . t)
14787 (left . -1) (top . 1))
14792 This split will result in the familiar summary/article window
14793 configuration in the first (or ``main'') frame, while a small additional
14794 frame will be created where picons will be shown. As you can see,
14795 instead of the normal @code{1.0} top-level spec, each additional split
14796 should have a frame parameter alist as the size spec.
14797 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
14798 Reference Manual}. Under XEmacs, a frame property list will be
14799 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
14801 The list of all possible keys for @code{gnus-buffer-configuration} can
14802 be found in its default value.
14804 Note that the @code{message} key is used for both
14805 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
14806 it is desirable to distinguish between the two, something like this
14810 (message (horizontal 1.0
14811 (vertical 1.0 (message 1.0 point))
14813 (if (buffer-live-p gnus-summary-buffer)
14818 One common desire for a multiple frame split is to have a separate frame
14819 for composing mail and news while leaving the original frame intact. To
14820 accomplish that, something like the following can be done:
14823 (message (frame 1.0
14824 (if (not (buffer-live-p gnus-summary-buffer))
14825 (car (cdr (assoc 'group gnus-buffer-configuration)))
14826 (car (cdr (assoc 'summary gnus-buffer-configuration))))
14827 (vertical ((user-position . t) (top . 1) (left . 1)
14828 (name . "Message"))
14829 (message 1.0 point))))
14832 @findex gnus-add-configuration
14833 Since the @code{gnus-buffer-configuration} variable is so long and
14834 complicated, there's a function you can use to ease changing the config
14835 of a single setting: @code{gnus-add-configuration}. If, for instance,
14836 you want to change the @code{article} setting, you could say:
14839 (gnus-add-configuration
14840 '(article (vertical 1.0
14842 (summary .25 point)
14846 You'd typically stick these @code{gnus-add-configuration} calls in your
14847 @file{.gnus.el} file or in some startup hook---they should be run after
14848 Gnus has been loaded.
14850 @vindex gnus-always-force-window-configuration
14851 If all windows mentioned in the configuration are already visible, Gnus
14852 won't change the window configuration. If you always want to force the
14853 ``right'' window configuration, you can set
14854 @code{gnus-always-force-window-configuration} to non-@code{nil}.
14856 If you're using tree displays (@pxref{Tree Display}), and the tree
14857 window is displayed vertically next to another window, you may also want
14858 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
14862 @node Faces and Fonts
14863 @section Faces and Fonts
14868 Fiddling with fonts and faces used to be very difficult, but these days
14869 it is very simple. You simply say @kbd{M-x customize-face}, pick out
14870 the face you want to alter, and alter it via the standard Customize
14875 @section Compilation
14876 @cindex compilation
14877 @cindex byte-compilation
14879 @findex gnus-compile
14881 Remember all those line format specification variables?
14882 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
14883 on. Now, Gnus will of course heed whatever these variables are, but,
14884 unfortunately, changing them will mean a quite significant slow-down.
14885 (The default values of these variables have byte-compiled functions
14886 associated with them, while the user-generated versions do not, of
14889 To help with this, you can run @kbd{M-x gnus-compile} after you've
14890 fiddled around with the variables and feel that you're (kind of)
14891 satisfied. This will result in the new specs being byte-compiled, and
14892 you'll get top speed again. Gnus will save these compiled specs in the
14893 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
14894 this function, though---you should compile them yourself by sticking
14895 them into the @code{.gnus.el} file and byte-compiling that file.)
14899 @section Mode Lines
14902 @vindex gnus-updated-mode-lines
14903 @code{gnus-updated-mode-lines} says what buffers should keep their mode
14904 lines updated. It is a list of symbols. Supported symbols include
14905 @code{group}, @code{article}, @code{summary}, @code{server},
14906 @code{browse}, and @code{tree}. If the corresponding symbol is present,
14907 Gnus will keep that mode line updated with information that may be
14908 pertinent. If this variable is @code{nil}, screen refresh may be
14911 @cindex display-time
14913 @vindex gnus-mode-non-string-length
14914 By default, Gnus displays information on the current article in the mode
14915 lines of the summary and article buffers. The information Gnus wishes
14916 to display (e.g. the subject of the article) is often longer than the
14917 mode lines, and therefore have to be cut off at some point. The
14918 @code{gnus-mode-non-string-length} variable says how long the other
14919 elements on the line is (i.e., the non-info part). If you put
14920 additional elements on the mode line (e.g. a clock), you should modify
14923 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
14925 (add-hook 'display-time-hook
14926 (lambda () (setq gnus-mode-non-string-length
14928 (if line-number-mode 5 0)
14929 (if column-number-mode 4 0)
14930 (length display-time-string)))))
14933 If this variable is @code{nil} (which is the default), the mode line
14934 strings won't be chopped off, and they won't be padded either. Note
14935 that the default is unlikely to be desirable, as even the percentage
14936 complete in the buffer may be crowded off the mode line; the user should
14937 configure this variable appropriately for her configuration.
14940 @node Highlighting and Menus
14941 @section Highlighting and Menus
14943 @cindex highlighting
14946 @vindex gnus-visual
14947 The @code{gnus-visual} variable controls most of the Gnus-prettifying
14948 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
14949 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
14952 This variable can be a list of visual properties that are enabled. The
14953 following elements are valid, and are all included by default:
14956 @item group-highlight
14957 Do highlights in the group buffer.
14958 @item summary-highlight
14959 Do highlights in the summary buffer.
14960 @item article-highlight
14961 Do highlights in the article buffer.
14963 Turn on highlighting in all buffers.
14965 Create menus in the group buffer.
14967 Create menus in the summary buffers.
14969 Create menus in the article buffer.
14971 Create menus in the browse buffer.
14973 Create menus in the server buffer.
14975 Create menus in the score buffers.
14977 Create menus in all buffers.
14980 So if you only want highlighting in the article buffer and menus in all
14981 buffers, you could say something like:
14984 (setq gnus-visual '(article-highlight menu))
14987 If you want highlighting only and no menus whatsoever, you'd say:
14990 (setq gnus-visual '(highlight))
14993 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
14994 in all Gnus buffers.
14996 Other general variables that influence the look of all buffers include:
14999 @item gnus-mouse-face
15000 @vindex gnus-mouse-face
15001 This is the face (i.e., font) used for mouse highlighting in Gnus. No
15002 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
15006 There are hooks associated with the creation of all the different menus:
15010 @item gnus-article-menu-hook
15011 @vindex gnus-article-menu-hook
15012 Hook called after creating the article mode menu.
15014 @item gnus-group-menu-hook
15015 @vindex gnus-group-menu-hook
15016 Hook called after creating the group mode menu.
15018 @item gnus-summary-menu-hook
15019 @vindex gnus-summary-menu-hook
15020 Hook called after creating the summary mode menu.
15022 @item gnus-server-menu-hook
15023 @vindex gnus-server-menu-hook
15024 Hook called after creating the server mode menu.
15026 @item gnus-browse-menu-hook
15027 @vindex gnus-browse-menu-hook
15028 Hook called after creating the browse mode menu.
15030 @item gnus-score-menu-hook
15031 @vindex gnus-score-menu-hook
15032 Hook called after creating the score mode menu.
15043 Those new-fangled @dfn{mouse} contraptions is very popular with the
15044 young, hep kids who don't want to learn the proper way to do things
15045 these days. Why, I remember way back in the summer of '89, when I was
15046 using Emacs on a Tops 20 system. Three hundred users on one single
15047 machine, and every user was running Simula compilers. Bah!
15051 @vindex gnus-carpal
15052 Well, you can make Gnus display bufferfuls of buttons you can click to
15053 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
15054 really. Tell the chiropractor I sent you.
15059 @item gnus-carpal-mode-hook
15060 @vindex gnus-carpal-mode-hook
15061 Hook run in all carpal mode buffers.
15063 @item gnus-carpal-button-face
15064 @vindex gnus-carpal-button-face
15065 Face used on buttons.
15067 @item gnus-carpal-header-face
15068 @vindex gnus-carpal-header-face
15069 Face used on carpal buffer headers.
15071 @item gnus-carpal-group-buffer-buttons
15072 @vindex gnus-carpal-group-buffer-buttons
15073 Buttons in the group buffer.
15075 @item gnus-carpal-summary-buffer-buttons
15076 @vindex gnus-carpal-summary-buffer-buttons
15077 Buttons in the summary buffer.
15079 @item gnus-carpal-server-buffer-buttons
15080 @vindex gnus-carpal-server-buffer-buttons
15081 Buttons in the server buffer.
15083 @item gnus-carpal-browse-buffer-buttons
15084 @vindex gnus-carpal-browse-buffer-buttons
15085 Buttons in the browse buffer.
15088 All the @code{buttons} variables are lists. The elements in these list
15089 are either cons cells where the @code{car} contains a text to be displayed and
15090 the @code{cdr} contains a function symbol, or a simple string.
15098 Gnus, being larger than any program ever written (allegedly), does lots
15099 of strange stuff that you may wish to have done while you're not
15100 present. For instance, you may want it to check for new mail once in a
15101 while. Or you may want it to close down all connections to all servers
15102 when you leave Emacs idle. And stuff like that.
15104 Gnus will let you do stuff like that by defining various
15105 @dfn{handlers}. Each handler consists of three elements: A
15106 @var{function}, a @var{time}, and an @var{idle} parameter.
15108 Here's an example of a handler that closes connections when Emacs has
15109 been idle for thirty minutes:
15112 (gnus-demon-close-connections nil 30)
15115 Here's a handler that scans for PGP headers every hour when Emacs is
15119 (gnus-demon-scan-pgp 60 t)
15122 This @var{time} parameter and than @var{idle} parameter work together
15123 in a strange, but wonderful fashion. Basically, if @var{idle} is
15124 @code{nil}, then the function will be called every @var{time} minutes.
15126 If @var{idle} is @code{t}, then the function will be called after
15127 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
15128 the function will never be called. But once Emacs goes idle, the
15129 function will be called every @var{time} minutes.
15131 If @var{idle} is a number and @var{time} is a number, the function will
15132 be called every @var{time} minutes only when Emacs has been idle for
15133 @var{idle} minutes.
15135 If @var{idle} is a number and @var{time} is @code{nil}, the function
15136 will be called once every time Emacs has been idle for @var{idle}
15139 And if @var{time} is a string, it should look like @samp{07:31}, and
15140 the function will then be called once every day somewhere near that
15141 time. Modified by the @var{idle} parameter, of course.
15143 @vindex gnus-demon-timestep
15144 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
15145 seconds. This is 60 by default. If you change that variable,
15146 all the timings in the handlers will be affected.)
15148 So, if you want to add a handler, you could put something like this in
15149 your @file{.gnus} file:
15151 @findex gnus-demon-add-handler
15153 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
15156 @findex gnus-demon-add-nocem
15157 @findex gnus-demon-add-scanmail
15158 @findex gnus-demon-add-rescan
15159 @findex gnus-demon-add-scan-timestamps
15160 @findex gnus-demon-add-disconnection
15161 Some ready-made functions to do this have been created:
15162 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
15163 @code{gnus-demon-add-nntp-close-connection},
15164 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
15165 @code{gnus-demon-add-scanmail}. Just put those functions in your
15166 @file{.gnus} if you want those abilities.
15168 @findex gnus-demon-init
15169 @findex gnus-demon-cancel
15170 @vindex gnus-demon-handlers
15171 If you add handlers to @code{gnus-demon-handlers} directly, you should
15172 run @code{gnus-demon-init} to make the changes take hold. To cancel all
15173 daemons, you can use the @code{gnus-demon-cancel} function.
15175 Note that adding daemons can be pretty naughty if you over do it. Adding
15176 functions that scan all news and mail from all servers every two seconds
15177 is a sure-fire way of getting booted off any respectable system. So
15186 @dfn{Spamming} is posting the same article lots and lots of times.
15187 Spamming is bad. Spamming is evil.
15189 Spamming is usually canceled within a day or so by various anti-spamming
15190 agencies. These agencies usually also send out @dfn{NoCeM} messages.
15191 NoCeM is pronounced ``no see-'em'', and means what the name
15192 implies---these are messages that make the offending articles, like, go
15195 What use are these NoCeM messages if the articles are canceled anyway?
15196 Some sites do not honor cancel messages and some sites just honor cancels
15197 from a select few people. Then you may wish to make use of the NoCeM
15198 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
15200 Gnus can read and parse the messages in this group automatically, and
15201 this will make spam disappear.
15203 There are some variables to customize, of course:
15206 @item gnus-use-nocem
15207 @vindex gnus-use-nocem
15208 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
15211 @item gnus-nocem-groups
15212 @vindex gnus-nocem-groups
15213 Gnus will look for NoCeM messages in the groups in this list. The
15214 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
15215 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
15217 @item gnus-nocem-issuers
15218 @vindex gnus-nocem-issuers
15219 There are many people issuing NoCeM messages. This list says what
15220 people you want to listen to. The default is @code{("Automoose-1"
15221 "rbraver@@ohww.norman.ok.us" "clewis@@ferret.ocunix.on.ca"
15222 "jem@@xpat.com" "snowhare@@xmission.com" "red@@redpoll.mrfs.oh.us
15223 (Richard E. Depew)")}; fine, upstanding citizens all of them.
15225 Known despammers that you can put in this list include:
15228 @item clewis@@ferret.ocunix.on.ca;
15229 @cindex Chris Lewis
15230 Chris Lewis---Major Canadian despammer who has probably canceled more
15231 usenet abuse than anybody else.
15234 @cindex CancelMoose[tm]
15235 The CancelMoose[tm] on autopilot. The CancelMoose[tm] is reputed to be
15236 Norwegian, and was the person(s) who invented NoCeM.
15238 @item jem@@xpat.com;
15240 John Milburn---despammer located in Korea who is getting very busy these
15243 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
15244 Richard E. Depew---lone American despammer. He mostly cancels binary
15245 postings to non-binary groups and removes spews (regurgitated articles).
15248 You do not have to heed NoCeM messages from all these people---just the
15249 ones you want to listen to. You also don't have to accept all NoCeM
15250 messages from the people you like. Each NoCeM message has a @dfn{type}
15251 header that gives the message a (more or less, usually less) rigorous
15252 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
15253 @samp{binary}, and @samp{troll}. To specify this, you have to use
15254 @var{(issuer conditions ...)} elements in the list. Each condition is
15255 either a string (which is a regexp that matches types you want to use)
15256 or a list on the form @code{(not STRING)}, where @var{string} is a
15257 regexp that matches types you don't want to use.
15259 For instance, if you want all NoCeM messages from Chris Lewis except his
15260 @samp{troll} messages, you'd say:
15263 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
15266 On the other hand, if you just want nothing but his @samp{spam} and
15267 @samp{spew} messages, you'd say:
15270 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
15273 The specs are applied left-to-right.
15276 @item gnus-nocem-verifyer
15277 @vindex gnus-nocem-verifyer
15279 This should be a function for verifying that the NoCeM issuer is who she
15280 says she is. The default is @code{mc-verify}, which is a Mailcrypt
15281 function. If this is too slow and you don't care for verification
15282 (which may be dangerous), you can set this variable to @code{nil}.
15284 If you want signed NoCeM messages to be verified and unsigned messages
15285 not to be verified (but used anyway), you could do something like:
15288 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
15290 (defun my-gnus-mc-verify ()
15298 This might be dangerous, though.
15300 @item gnus-nocem-directory
15301 @vindex gnus-nocem-directory
15302 This is where Gnus will store its NoCeM cache files. The default is
15303 @file{~/News/NoCeM/}.
15305 @item gnus-nocem-expiry-wait
15306 @vindex gnus-nocem-expiry-wait
15307 The number of days before removing old NoCeM entries from the cache.
15308 The default is 15. If you make it shorter Gnus will be faster, but you
15309 might then see old spam.
15313 Using NoCeM could potentially be a memory hog. If you have many living
15314 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
15315 big. If this is a problem, you should kill off all (or most) of your
15316 unsubscribed groups (@pxref{Subscription Commands}).
15323 It is very useful to be able to undo actions one has done. In normal
15324 Emacs buffers, it's easy enough---you just push the @code{undo} button.
15325 In Gnus buffers, however, it isn't that simple.
15327 The things Gnus displays in its buffer is of no value whatsoever to
15328 Gnus---it's all just data designed to look nice to the user.
15329 Killing a group in the group buffer with @kbd{C-k} makes the line
15330 disappear, but that's just a side-effect of the real action---the
15331 removal of the group in question from the internal Gnus structures.
15332 Undoing something like that can't be done by the normal Emacs
15333 @code{undo} function.
15335 Gnus tries to remedy this somewhat by keeping track of what the user
15336 does and coming up with actions that would reverse the actions the user
15337 takes. When the user then presses the @code{undo} key, Gnus will run
15338 the code to reverse the previous action, or the previous actions.
15339 However, not all actions are easily reversible, so Gnus currently offers
15340 a few key functions to be undoable. These include killing groups,
15341 yanking groups, and changing the list of read articles of groups.
15342 That's it, really. More functions may be added in the future, but each
15343 added function means an increase in data to be stored, so Gnus will
15344 never be totally undoable.
15346 @findex gnus-undo-mode
15347 @vindex gnus-use-undo
15349 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
15350 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
15351 default. The @kbd{M-C-_} key performs the @code{gnus-undo} command
15352 command, which should feel kinda like the normal Emacs @code{undo}
15357 @section Moderation
15360 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
15361 It is not included in the standard Gnus package. Write a mail to
15362 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
15365 The moderation package is implemented as a minor mode for summary
15369 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
15372 in your @file{.gnus.el} file.
15374 If you are the moderator of @samp{rec.zoofle}, this is how it's
15379 You split your incoming mail by matching on
15380 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
15381 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
15384 You enter that group once in a while and post articles using the @kbd{e}
15385 (edit-and-post) or @kbd{s} (just send unedited) commands.
15388 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
15389 articles that weren't approved by you, you can cancel them with the
15393 To use moderation mode in these two groups, say:
15396 (setq gnus-moderated-list
15397 "^nnml:rec.zoofle$\\|^rec.zoofle$")
15401 @node XEmacs Enhancements
15402 @section XEmacs Enhancements
15405 XEmacs is able to display pictures and stuff, so Gnus has taken
15409 * Picons:: How to display pictures of what your reading.
15410 * Smileys:: Show all those happy faces the way they were meant to be shown.
15411 * Toolbar:: Click'n'drool.
15412 * XVarious:: Other XEmacsy Gnusey variables.
15425 So... You want to slow down your news reader even more! This is a
15426 good way to do so. Its also a great way to impress people staring
15427 over your shoulder as you read news.
15430 * Picon Basics:: What are picons and How do I get them.
15431 * Picon Requirements:: Don't go further if you aren't using XEmacs.
15432 * Easy Picons:: Displaying Picons---the easy way.
15433 * Hard Picons:: The way you should do it. You'll learn something.
15434 * Picon Useless Configuration:: Other variables you can trash/tweak/munge/play with.
15439 @subsubsection Picon Basics
15441 What are Picons? To quote directly from the Picons Web site:
15450 @dfn{Picons} is short for ``personal icons''. They're small,
15451 constrained images used to represent users and domains on the net,
15452 organized into databases so that the appropriate image for a given
15453 e-mail address can be found. Besides users and domains, there are picon
15454 databases for Usenet newsgroups and weather forecasts. The picons are
15455 in either monochrome @code{XBM} format or color @code{XPM} and
15456 @code{GIF} formats.
15459 @vindex gnus-picons-piconsearch-url
15460 If you have a permanent connection to the Internet you can use Steve
15461 Kinzler's Picons Search engine by setting
15462 @code{gnus-picons-piconsearch-url} to the string @*
15463 @file{http://www.cs.indiana.edu/picons/search.html}.
15465 @vindex gnus-picons-database
15466 Otherwise you need a local copy of his database. For instructions on
15467 obtaining and installing the picons databases, point your Web browser at @*
15468 @file{http://www.cs.indiana.edu/picons/ftp/index.html}. Gnus expects
15469 picons to be installed into a location pointed to by
15470 @code{gnus-picons-database}.
15473 @node Picon Requirements
15474 @subsubsection Picon Requirements
15476 To have Gnus display Picons for you, you must be running XEmacs
15477 19.13 or greater since all other versions of Emacs aren't yet able to
15480 Additionally, you must have @code{x} support compiled into XEmacs. To
15481 display color picons which are much nicer than the black & white one,
15482 you also need one of @code{xpm} or @code{gif} compiled into XEmacs.
15484 @vindex gnus-picons-convert-x-face
15485 If you want to display faces from @code{X-Face} headers, you should have
15486 the @code{xface} support compiled into XEmacs. Otherwise you must have
15487 the @code{netpbm} utilities installed, or munge the
15488 @code{gnus-picons-convert-x-face} variable to use something else.
15492 @subsubsection Easy Picons
15494 To enable displaying picons, simply put the following line in your
15495 @file{~/.gnus} file and start Gnus.
15498 (setq gnus-use-picons t)
15499 (setq gnus-treat-display-picons t)
15502 and make sure @code{gnus-picons-database} points to the directory
15503 containing the Picons databases.
15505 Alternatively if you want to use the web piconsearch engine add this:
15508 (setq gnus-picons-piconsearch-url
15509 "http://www.cs.indiana.edu:800/piconsearch")
15514 @subsubsection Hard Picons
15522 Gnus can display picons for you as you enter and leave groups and
15523 articles. It knows how to interact with three sections of the picons
15524 database. Namely, it can display the picons newsgroup pictures,
15525 author's face picture(s), and the authors domain. To enable this
15526 feature, you need to select where to get the picons from, and where to
15531 @item gnus-picons-database
15532 @vindex gnus-picons-database
15533 The location of the picons database. Should point to a directory
15534 containing the @file{news}, @file{domains}, @file{users} (and so on)
15535 subdirectories. This is only useful if
15536 @code{gnus-picons-piconsearch-url} is @code{nil}. Defaults to
15537 @file{/usr/local/faces/}.
15539 @item gnus-picons-piconsearch-url
15540 @vindex gnus-picons-piconsearch-url
15541 The URL for the web picons search engine. The only currently known
15542 engine is @file{http://www.cs.indiana.edu:800/piconsearch}. To
15543 workaround network delays, icons will be fetched in the background. If
15544 this is @code{nil} 'the default), then picons are fetched from local
15545 database indicated by @code{gnus-picons-database}.
15547 @item gnus-picons-display-where
15548 @vindex gnus-picons-display-where
15549 Where the picon images should be displayed. It is @code{picons} by
15550 default (which by default maps to the buffer @samp{*Picons*}). Other
15551 valid places could be @code{article}, @code{summary}, or
15552 @samp{*scratch*} for all I care. Just make sure that you've made the
15553 buffer visible using the standard Gnus window configuration
15554 routines---@pxref{Windows Configuration}.
15556 @item gnus-picons-group-excluded-groups
15557 @vindex gnus-picons-group-excluded-groups
15558 Groups that are matched by this regexp won't have their group icons
15563 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
15564 window configuration for you to include the @code{picons} buffer.
15566 Now that you've made those decision, you need to add the following
15567 functions to the appropriate hooks so these pictures will get displayed
15570 @vindex gnus-picons-display-where
15572 @item gnus-article-display-picons
15573 @findex gnus-article-display-picons
15574 Looks up and displays the picons for the author and the author's domain
15575 in the @code{gnus-picons-display-where} buffer.
15577 @item gnus-picons-article-display-x-face
15578 @findex gnus-article-display-picons
15579 Decodes and displays the X-Face header if present.
15585 @node Picon Useless Configuration
15586 @subsubsection Picon Useless Configuration
15594 The following variables offer further control over how things are
15595 done, where things are located, and other useless stuff you really
15596 don't need to worry about.
15600 @item gnus-picons-news-directories
15601 @vindex gnus-picons-news-directories
15602 List of subdirectories to search in @code{gnus-picons-database} for
15603 newsgroups faces. @code{("news")} is the default.
15605 @item gnus-picons-user-directories
15606 @vindex gnus-picons-user-directories
15607 List of subdirectories to search in @code{gnus-picons-database} for user
15608 faces. @code{("local" "users" "usenix" "misc")} is the default.
15610 @item gnus-picons-domain-directories
15611 @vindex gnus-picons-domain-directories
15612 List of subdirectories to search in @code{gnus-picons-database} for
15613 domain name faces. Defaults to @code{("domains")}. Some people may
15614 want to add @samp{"unknown"} to this list.
15616 @item gnus-picons-convert-x-face
15617 @vindex gnus-picons-convert-x-face
15618 If you don't have @code{xface} support builtin XEmacs, this is the
15619 command to use to convert the @code{X-Face} header to an X bitmap
15620 (@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48,
15621 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
15622 gnus-picons-x-face-file-name)}
15624 @item gnus-picons-x-face-file-name
15625 @vindex gnus-picons-x-face-file-name
15626 Names a temporary file to store the @code{X-Face} bitmap in. Defaults
15627 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
15629 @item gnus-picons-has-modeline-p
15630 @vindex gnus-picons-has-modeline-p
15631 If you have set @code{gnus-picons-display-where} to @code{picons}, your
15632 XEmacs frame will become really cluttered. To alleviate this a bit you
15633 can set @code{gnus-picons-has-modeline-p} to @code{nil}; this will
15634 remove the mode line from the Picons buffer. This is only useful if
15635 @code{gnus-picons-display-where} is @code{picons}.
15637 @item gnus-picons-refresh-before-display
15638 @vindex gnus-picons-refresh-before-display
15639 If non-nil, display the article buffer before computing the picons.
15640 Defaults to @code{nil}.
15642 @item gnus-picons-display-as-address
15643 @vindex gnus-picons-display-as-address
15644 If @code{t} display textual email addresses along with pictures.
15645 Defaults to @code{t}.
15647 @item gnus-picons-file-suffixes
15648 @vindex gnus-picons-file-suffixes
15649 Ordered list of suffixes on picon file names to try. Defaults to
15650 @code{("xpm" "gif" "xbm")} minus those not builtin your XEmacs.
15652 @item gnus-picons-setup-hook
15653 @vindex gnus-picons-setup-hook
15654 Hook run in the picon buffer, if that is displayed.
15656 @item gnus-picons-display-article-move-p
15657 @vindex gnus-picons-display-article-move-p
15658 Whether to move point to first empty line when displaying picons. This
15659 has only an effect if `gnus-picons-display-where' has value `article'.
15661 If @code{nil}, display the picons in the @code{From} and
15662 @code{Newsgroups} lines. This is the defailt.
15664 @item gnus-picons-clear-cache-on-shutdown
15665 @vindex gnus-picons-clear-cache-on-shutdown
15666 Whether to clear the picons cache when exiting gnus. Gnus caches every
15667 picons it finds while it is running. This saves some time in the search
15668 process but eats some memory. If this variable is set to @code{nil},
15669 Gnus will never clear the cache itself; you will have to manually call
15670 @code{gnus-picons-clear-cache} to clear it. Otherwise the cache will be
15671 cleared every time you exit Gnus. Defaults to @code{t}.
15682 @subsection Smileys
15687 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=tmp/BigFace.ps,height=20cm}}
15692 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
15693 currently the only package that uses Smiley, it is documented here.
15695 In short---to use Smiley in Gnus, put the following in your
15696 @file{.gnus.el} file:
15699 (setq gnus-treat-display-smiley t)
15702 Smiley maps text smiley faces---@samp{:-)}, @samp{:-=}, @samp{:-(} and
15703 the like---to pictures and displays those instead of the text smiley
15704 faces. The conversion is controlled by a list of regexps that matches
15705 text and maps that to file names.
15707 @vindex smiley-nosey-regexp-alist
15708 @vindex smiley-deformed-regexp-alist
15709 Smiley supplies two example conversion alists by default:
15710 @code{smiley-deformed-regexp-alist} (which matches @samp{:)}, @samp{:(}
15711 and so on), and @code{smiley-nosey-regexp-alist} (which matches
15712 @samp{:-)}, @samp{:-(} and so on).
15714 The alist used is specified by the @code{smiley-regexp-alist} variable,
15715 which defaults to the value of @code{smiley-deformed-regexp-alist}.
15717 The first item in each element is the regexp to be matched; the second
15718 element is the regexp match group that is to be replaced by the picture;
15719 and the third element is the name of the file to be displayed.
15721 The following variables customize where Smiley will look for these
15722 files, as well as the color to be used and stuff:
15726 @item smiley-data-directory
15727 @vindex smiley-data-directory
15728 Where Smiley will look for smiley faces files.
15730 @item smiley-flesh-color
15731 @vindex smiley-flesh-color
15732 Skin color. The default is @samp{yellow}, which is really racist.
15734 @item smiley-features-color
15735 @vindex smiley-features-color
15736 Color of the features of the face. The default is @samp{black}.
15738 @item smiley-tongue-color
15739 @vindex smiley-tongue-color
15740 Color of the tongue. The default is @samp{red}.
15742 @item smiley-circle-color
15743 @vindex smiley-circle-color
15744 Color of the circle around the face. The default is @samp{black}.
15746 @item smiley-mouse-face
15747 @vindex smiley-mouse-face
15748 Face used for mouse highlighting over the smiley face.
15754 @subsection Toolbar
15764 @item gnus-use-toolbar
15765 @vindex gnus-use-toolbar
15766 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
15767 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
15768 @code{right-toolbar}, or @code{left-toolbar}.
15770 @item gnus-group-toolbar
15771 @vindex gnus-group-toolbar
15772 The toolbar in the group buffer.
15774 @item gnus-summary-toolbar
15775 @vindex gnus-summary-toolbar
15776 The toolbar in the summary buffer.
15778 @item gnus-summary-mail-toolbar
15779 @vindex gnus-summary-mail-toolbar
15780 The toolbar in the summary buffer of mail groups.
15786 @subsection Various XEmacs Variables
15789 @item gnus-xmas-glyph-directory
15790 @vindex gnus-xmas-glyph-directory
15791 This is where Gnus will look for pictures. Gnus will normally
15792 auto-detect this directory, but you may set it manually if you have an
15793 unusual directory structure.
15795 @item gnus-xmas-logo-color-alist
15796 @vindex gnus-xmas-logo-color-alist
15797 This is an alist where the key is a type symbol and the values are the
15798 foreground and background color of the splash page glyph.
15800 @item gnus-xmas-logo-color-style
15801 @vindex gnus-xmas-logo-color-style
15802 This is the key used to look up the color in the alist described above.
15803 Valid values include @code{flame}, @code{pine}, @code{moss},
15804 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
15805 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
15807 @item gnus-xmas-modeline-glyph
15808 @vindex gnus-xmas-modeline-glyph
15809 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
15823 @node Fuzzy Matching
15824 @section Fuzzy Matching
15825 @cindex fuzzy matching
15827 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
15828 things like scoring, thread gathering and thread comparison.
15830 As opposed to regular expression matching, fuzzy matching is very fuzzy.
15831 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
15832 means, and the implementation has changed over time.
15834 Basically, it tries to remove all noise from lines before comparing.
15835 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
15836 out of the strings before comparing the results. This often leads to
15837 adequate results---even when faced with strings generated by text
15838 manglers masquerading as newsreaders.
15841 @node Thwarting Email Spam
15842 @section Thwarting Email Spam
15846 @cindex unsolicited commercial email
15848 In these last days of the Usenet, commercial vultures are hanging about
15849 and grepping through news like crazy to find email addresses they can
15850 foist off their scams and products to. As a reaction to this, many
15851 people have started putting nonsense addresses into their @code{From}
15852 lines. I think this is counterproductive---it makes it difficult for
15853 people to send you legitimate mail in response to things you write, as
15854 well as making it difficult to see who wrote what. This rewriting may
15855 perhaps be a bigger menace than the unsolicited commercial email itself
15858 The biggest problem I have with email spam is that it comes in under
15859 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
15860 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
15861 mail group, only to find two pyramid schemes, seven advertisements
15862 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
15863 and one mail asking me to repent and find some god.
15867 The way to deal with this is having Gnus split out all spam into a
15868 @samp{spam} mail group (@pxref{Splitting Mail}).
15870 First, pick one (1) valid mail address that you can be reached at, and
15871 put it in your @code{From} header of all your news articles. (I've
15872 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
15873 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
15874 sysadm whether your sendmail installation accepts keywords in the local
15875 part of the mail address.)
15878 (setq message-default-news-headers
15879 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
15882 Then put the following split rule in @code{nnmail-split-fancy}
15883 (@pxref{Fancy Mail Splitting}):
15888 (to "larsi@@trym.ifi.uio.no"
15889 (| ("subject" "re:.*" "misc")
15890 ("references" ".*@@.*" "misc")
15896 This says that all mail to this address is suspect, but if it has a
15897 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
15898 header, it's probably ok. All the rest goes to the @samp{spam} group.
15899 (This idea probably comes from Tim Pierce.)
15901 In addition, many mail spammers talk directly to your @code{smtp} server
15902 and do not include your email address explicitly in the @code{To}
15903 header. Why they do this is unknown---perhaps it's to thwart this
15904 thwarting scheme? In any case, this is trivial to deal with---you just
15905 put anything not addressed to you in the @samp{spam} group by ending
15906 your fancy split rule in this way:
15911 (to "larsi" "misc")
15915 In my experience, this will sort virtually everything into the right
15916 group. You still have to check the @samp{spam} group from time to time to
15917 check for legitimate mail, though. If you feel like being a good net
15918 citizen, you can even send off complaints to the proper authorities on
15919 each unsolicited commercial email---at your leisure.
15921 If you are also a lazy net citizen, you will probably prefer complaining
15922 automatically with the @file{gnus-junk.el} package, available FOR FREE
15923 at @* @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
15924 Since most e-mail spam is sent automatically, this may reconcile the
15925 cosmic balance somewhat.
15927 This works for me. It allows people an easy way to contact me (they can
15928 just press @kbd{r} in the usual way), and I'm not bothered at all with
15929 spam. It's a win-win situation. Forging @code{From} headers to point
15930 to non-existent domains is yucky, in my opinion.
15933 @node Various Various
15934 @section Various Various
15940 @item gnus-home-directory
15941 All Gnus path variables will be initialized from this variable, which
15942 defaults to @file{~/}.
15944 @item gnus-directory
15945 @vindex gnus-directory
15946 Most Gnus storage path variables will be initialized from this variable,
15947 which defaults to the @samp{SAVEDIR} environment variable, or
15948 @file{~/News/} if that variable isn't set.
15950 Note that Gnus is mostly loaded when the @file{.gnus.el} file is read.
15951 This means that other directory variables that are initialized from this
15952 variable won't be set properly if you set this variable in
15953 @file{.gnus.el}. Set this variable in @file{.emacs} instead.
15955 @item gnus-default-directory
15956 @vindex gnus-default-directory
15957 Not related to the above variable at all---this variable says what the
15958 default directory of all Gnus buffers should be. If you issue commands
15959 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
15960 default directory. If this variable is @code{nil} (which is the
15961 default), the default directory will be the default directory of the
15962 buffer you were in when you started Gnus.
15965 @vindex gnus-verbose
15966 This variable is an integer between zero and ten. The higher the value,
15967 the more messages will be displayed. If this variable is zero, Gnus
15968 will never flash any messages, if it is seven (which is the default),
15969 most important messages will be shown, and if it is ten, Gnus won't ever
15970 shut up, but will flash so many messages it will make your head swim.
15972 @item gnus-verbose-backends
15973 @vindex gnus-verbose-backends
15974 This variable works the same way as @code{gnus-verbose}, but it applies
15975 to the Gnus backends instead of Gnus proper.
15977 @item nnheader-max-head-length
15978 @vindex nnheader-max-head-length
15979 When the backends read straight heads of articles, they all try to read
15980 as little as possible. This variable (default 4096) specifies
15981 the absolute max length the backends will try to read before giving up
15982 on finding a separator line between the head and the body. If this
15983 variable is @code{nil}, there is no upper read bound. If it is
15984 @code{t}, the backends won't try to read the articles piece by piece,
15985 but read the entire articles. This makes sense with some versions of
15986 @code{ange-ftp} or @code{efs}.
15988 @item nnheader-head-chop-length
15989 @vindex nnheader-head-chop-length
15990 This variable (default 2048) says how big a piece of each article to
15991 read when doing the operation described above.
15993 @item nnheader-file-name-translation-alist
15994 @vindex nnheader-file-name-translation-alist
15996 @cindex invalid characters in file names
15997 @cindex characters in file names
15998 This is an alist that says how to translate characters in file names.
15999 For instance, if @samp{:} is invalid as a file character in file names
16000 on your system (you OS/2 user you), you could say something like:
16003 (setq nnheader-file-name-translation-alist
16007 In fact, this is the default value for this variable on OS/2 and MS
16008 Windows (phooey) systems.
16010 @item gnus-hidden-properties
16011 @vindex gnus-hidden-properties
16012 This is a list of properties to use to hide ``invisible'' text. It is
16013 @code{(invisible t intangible t)} by default on most systems, which
16014 makes invisible text invisible and intangible.
16016 @item gnus-parse-headers-hook
16017 @vindex gnus-parse-headers-hook
16018 A hook called before parsing headers. It can be used, for instance, to
16019 gather statistics on the headers fetched, or perhaps you'd like to prune
16020 some headers. I don't see why you'd want that, though.
16022 @item gnus-shell-command-separator
16023 @vindex gnus-shell-command-separator
16024 String used to separate two shell commands. The default is @samp{;}.
16033 Well, that's the manual---you can get on with your life now. Keep in
16034 touch. Say hello to your cats from me.
16036 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
16038 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
16044 Not because of victories @*
16047 but for the common sunshine,@*
16049 the largess of the spring.
16053 but for the day's work done@*
16054 as well as I was able;@*
16055 not for a seat upon the dais@*
16056 but at the common table.@*
16061 @chapter Appendices
16064 * History:: How Gnus got where it is today.
16065 * Terminology:: We use really difficult, like, words here.
16066 * Customization:: Tailoring Gnus to your needs.
16067 * Troubleshooting:: What you might try if things do not work.
16068 * Gnus Reference Guide:: Rilly, rilly technical stuff.
16069 * Emacs for Heathens:: A short introduction to Emacsian terms.
16070 * Frequently Asked Questions:: A question-and-answer session.
16078 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
16079 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
16081 If you want to investigate the person responsible for this outrage, you
16082 can point your (feh!) web browser to
16083 @file{http://www.stud.ifi.uio.no/~larsi/}. This is also the primary
16084 distribution point for the new and spiffy versions of Gnus, and is known
16085 as The Site That Destroys Newsrcs And Drives People Mad.
16087 During the first extended alpha period of development, the new Gnus was
16088 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
16089 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
16090 (Besides, the ``Gnus'' in this abbreviation should probably be
16091 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
16092 appropriate name, don't you think?)
16094 In any case, after spending all that energy on coming up with a new and
16095 spunky name, we decided that the name was @emph{too} spunky, so we
16096 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
16097 ``@sc{gnus}''. New vs. old.
16099 The first ``proper'' release of Gnus 5 was done in November 1995 when it
16100 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
16101 plus 15 Gnus 5.0 releases).
16103 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
16104 releases)) was released under the name ``Gnus 5.2'' (40 releases).
16106 On July 28th 1996 work on Red Gnus was begun, and it was released on
16107 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
16109 On September 13th 1997, Quassia Gnus was started and lasted 37
16110 releases. If was released as ``Gnus 5.6 on March 8th 1998.
16112 If you happen upon a version of Gnus that has a prefixed name --
16113 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
16114 don't panic. Don't let it know that you're frightened. Back away.
16115 Slowly. Whatever you do, don't run. Walk away, calmly, until you're
16116 out of its reach. Find a proper released version of Gnus and snuggle up
16120 * Why?:: What's the point of Gnus?
16121 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
16122 * Conformity:: Gnus tries to conform to all standards.
16123 * Emacsen:: Gnus can be run on a few modern Emacsen.
16124 * Contributors:: Oodles of people.
16125 * New Features:: Pointers to some of the new stuff in Gnus.
16126 * Newest Features:: Features so new that they haven't been written yet.
16133 What's the point of Gnus?
16135 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
16136 newsreader, that lets you do anything you can think of. That was my
16137 original motivation, but while working on Gnus, it has become clear to
16138 me that this generation of newsreaders really belong in the stone age.
16139 Newsreaders haven't developed much since the infancy of the net. If the
16140 volume continues to rise with the current rate of increase, all current
16141 newsreaders will be pretty much useless. How do you deal with
16142 newsgroups that have thousands of new articles each day? How do you
16143 keep track of millions of people who post?
16145 Gnus offers no real solutions to these questions, but I would very much
16146 like to see Gnus being used as a testing ground for new methods of
16147 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
16148 to separate the newsreader from the backends, Gnus now offers a simple
16149 interface for anybody who wants to write new backends for fetching mail
16150 and news from different sources. I have added hooks for customizations
16151 everywhere I could imagine it being useful. By doing so, I'm inviting
16152 every one of you to explore and invent.
16154 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
16155 @kbd{C-u 100 M-x all-hail-xemacs}.
16158 @node Compatibility
16159 @subsection Compatibility
16161 @cindex compatibility
16162 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
16163 bindings have been kept. More key bindings have been added, of course,
16164 but only in one or two obscure cases have old bindings been changed.
16169 @center In a cloud bones of steel.
16173 All commands have kept their names. Some internal functions have changed
16176 The @code{gnus-uu} package has changed drastically. @xref{Decoding
16179 One major compatibility question is the presence of several summary
16180 buffers. All variables relevant while reading a group are
16181 buffer-local to the summary buffer they belong in. Although many
16182 important variables have their values copied into their global
16183 counterparts whenever a command is executed in the summary buffer, this
16184 change might lead to incorrect values being used unless you are careful.
16186 All code that relies on knowledge of @sc{gnus} internals will probably
16187 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
16188 changing it in any way, as a matter of fact) is strictly verboten. Gnus
16189 maintains a hash table that points to the entries in this alist (which
16190 speeds up many functions), and changing the alist directly will lead to
16194 @cindex highlighting
16195 Old hilit19 code does not work at all. In fact, you should probably
16196 remove all hilit code from all Gnus hooks
16197 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
16198 Gnus provides various integrated functions for highlighting. These are
16199 faster and more accurate. To make life easier for everybody, Gnus will
16200 by default remove all hilit calls from all hilit hooks. Uncleanliness!
16203 Packages like @code{expire-kill} will no longer work. As a matter of
16204 fact, you should probably remove all old @sc{gnus} packages (and other
16205 code) when you start using Gnus. More likely than not, Gnus already
16206 does what you have written code to make @sc{gnus} do. (Snicker.)
16208 Even though old methods of doing things are still supported, only the
16209 new methods are documented in this manual. If you detect a new method of
16210 doing something while reading this manual, that does not mean you have
16211 to stop doing it the old way.
16213 Gnus understands all @sc{gnus} startup files.
16215 @kindex M-x gnus-bug
16217 @cindex reporting bugs
16219 Overall, a casual user who hasn't written much code that depends on
16220 @sc{gnus} internals should suffer no problems. If problems occur,
16221 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
16223 @vindex gnus-bug-create-help-buffer
16224 If you are in the habit of sending bug reports @emph{very} often, you
16225 may find the helpful help buffer annoying after a while. If so, set
16226 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
16231 @subsection Conformity
16233 No rebels without a clue here, ma'am. We conform to all standards known
16234 to (wo)man. Except for those standards and/or conventions we disagree
16241 There are no known breaches of this standard.
16245 There are no known breaches of this standard, either.
16247 @item Son-of-RFC 1036
16248 @cindex Son-of-RFC 1036
16249 We do have some breaches to this one.
16254 This is considered to be a ``vanity header'', while I consider it to be
16255 consumer information. After seeing so many badly formatted articles
16256 coming from @code{tin} and @code{Netscape} I know not to use either of
16257 those for posting articles. I would not have known that if it wasn't
16258 for the @code{X-Newsreader} header.
16263 USEFOR is an IETF working group writing a successor to RFC 1036, based
16264 on Son-of-RFC 1036. They have produced a number of drafts proposing
16265 various changes to the format of news articles. The Gnus towers will
16266 look into implementing the changes when the draft is accepted as an RFC.
16270 If you ever notice Gnus acting non-compliant with regards to the texts
16271 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
16276 @subsection Emacsen
16282 Gnus should work on :
16290 XEmacs 20.4 and up.
16294 This Gnus version will absolutely not work on any Emacsen older than
16295 that. Not reliably, at least. Older versions of Gnus may work on older
16298 There are some vague differences between Gnus on the various
16299 platforms---XEmacs features more graphics (a logo and a toolbar)---but
16300 other than that, things should look pretty much the same under all
16305 @subsection Contributors
16306 @cindex contributors
16308 The new Gnus version couldn't have been done without the help of all the
16309 people on the (ding) mailing list. Every day for over a year I have
16310 gotten billions of nice bug reports from them, filling me with joy,
16311 every single one of them. Smooches. The people on the list have been
16312 tried beyond endurance, what with my ``oh, that's a neat idea <type
16313 type>, yup, I'll release it right away <ship off> no wait, that doesn't
16314 work at all <type type>, yup, I'll ship that one off right away <ship
16315 off> no, wait, that absolutely does not work'' policy for releases.
16316 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
16317 ``worser''? ``much worser''? ``worsest''?)
16319 I would like to take this opportunity to thank the Academy for... oops,
16325 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
16328 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
16329 well as numerous other things).
16332 Luis Fernandes---design and graphics.
16335 Erik Naggum---help, ideas, support, code and stuff.
16338 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el and many other things
16339 connected with @sc{mime} and other types of en/decoding.
16342 Wes Hardaker---@file{gnus-picon.el} and the manual section on
16343 @dfn{picons} (@pxref{Picons}).
16346 Kim-Minh Kaplan---further work on the picon code.
16349 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
16350 (@pxref{GroupLens}).
16353 Sudish Joseph---innumerable bug fixes.
16356 Ilja Weis---@file{gnus-topic.el}.
16359 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
16362 Vladimir Alexiev---the refcard and reference booklets.
16365 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
16366 distribution by Felix Lee and JWZ.
16369 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
16372 Peter Mutsaers---orphan article scoring code.
16375 Ken Raeburn---POP mail support.
16378 Hallvard B Furuseth---various bits and pieces, especially dealing with
16382 Brian Edmonds---@file{gnus-bbdb.el}.
16385 David Moore---rewrite of @file{nnvirtual.el} and many other things.
16388 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
16391 François Pinard---many, many interesting and thorough bug reports, as
16392 well as autoconf support.
16396 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
16397 Borges, and Jost Krieger proof-reading parts of the manual.
16399 The following people have contributed many patches and suggestions:
16408 Jason L. Tibbitts, III,
16412 Also thanks to the following for patches and stuff:
16435 Massimo Campostrini,
16443 Geoffrey T. Dairiki,
16449 Michael Welsh Duggan,
16453 Enami Tsugutomo, @c Enami
16457 Nelson Jose dos Santos Ferreira,
16464 Arne Georg Gleditsch,
16466 Michelangelo Grigni,
16470 Kenichi Handa, @c Handa
16472 Yoshiki Hayashi, @c ?
16474 Hisashige Kenji, @c Hisashige
16479 François Felix Ingrand,
16480 Ishikawa Ichiro, @c Ishikawa
16482 Iwamuro Motonori, @c Iwamuro
16491 Peter Skov Knudsen,
16492 Shuhei Kobayashi, @c Kobayashi
16493 Koseki Yoshinori, @c Koseki
16494 Thor Kristoffersen,
16497 Seokchan Lee, @c Lee
16515 Morioka Tomohiko, @c Morioka
16516 Erik Toubro Nielsen,
16523 Masaharu Onishi, @c Onishi
16527 Jens-Ulrik Holger Petersen,
16531 John McClary Prevost,
16537 Lars Balker Rasmussen,
16542 Christian von Roques,
16545 Wolfgang Rupprecht,
16552 Philippe Schnoebelen,
16554 Randal L. Schwartz,
16585 Katsumi Yamaoka @c Yamaoka
16590 For a full overview of what each person has done, the ChangeLogs
16591 included in the Gnus alpha distributions should give ample reading
16592 (550kB and counting).
16594 Apologies to everybody that I've forgotten, of which there are many, I'm
16597 Gee, that's quite a list of people. I guess that must mean that there
16598 actually are people who are using Gnus. Who'd'a thunk it!
16602 @subsection New Features
16603 @cindex new features
16606 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
16607 * September Gnus:: The Thing Formally Known As Gnus 5.3/5.3.
16608 * Red Gnus:: Third time best---Gnus 5.4/5.5.
16609 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
16612 These lists are, of course, just @emph{short} overviews of the
16613 @emph{most} important new features. No, really. There are tons more.
16614 Yes, we have feeping creaturism in full effect.
16618 @subsubsection (ding) Gnus
16620 New features in Gnus 5.0/5.1:
16625 The look of all buffers can be changed by setting format-like variables
16626 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
16629 Local spool and several @sc{nntp} servers can be used at once
16630 (@pxref{Select Methods}).
16633 You can combine groups into virtual groups (@pxref{Virtual Groups}).
16636 You can read a number of different mail formats (@pxref{Getting Mail}).
16637 All the mail backends implement a convenient mail expiry scheme
16638 (@pxref{Expiring Mail}).
16641 Gnus can use various strategies for gathering threads that have lost
16642 their roots (thereby gathering loose sub-threads into one thread) or it
16643 can go back and retrieve enough headers to build a complete thread
16644 (@pxref{Customizing Threading}).
16647 Killed groups can be displayed in the group buffer, and you can read
16648 them as well (@pxref{Listing Groups}).
16651 Gnus can do partial group updates---you do not have to retrieve the
16652 entire active file just to check for new articles in a few groups
16653 (@pxref{The Active File}).
16656 Gnus implements a sliding scale of subscribedness to groups
16657 (@pxref{Group Levels}).
16660 You can score articles according to any number of criteria
16661 (@pxref{Scoring}). You can even get Gnus to find out how to score
16662 articles for you (@pxref{Adaptive Scoring}).
16665 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
16666 manner, so it should be difficult to lose much data on what you have
16667 read if your machine should go down (@pxref{Auto Save}).
16670 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
16671 the @file{.emacs} file.
16674 You can set the process mark on both groups and articles and perform
16675 operations on all the marked items (@pxref{Process/Prefix}).
16678 You can grep through a subset of groups and create a group from the
16679 results (@pxref{Kibozed Groups}).
16682 You can list subsets of groups according to, well, anything
16683 (@pxref{Listing Groups}).
16686 You can browse foreign servers and subscribe to groups from those
16687 servers (@pxref{Browse Foreign Server}).
16690 Gnus can fetch articles, asynchronously, on a second connection to the
16691 server (@pxref{Asynchronous Fetching}).
16694 You can cache articles locally (@pxref{Article Caching}).
16697 The uudecode functions have been expanded and generalized
16698 (@pxref{Decoding Articles}).
16701 You can still post uuencoded articles, which was a little-known feature
16702 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
16705 Fetching parents (and other articles) now actually works without
16706 glitches (@pxref{Finding the Parent}).
16709 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
16712 Digests (and other files) can be used as the basis for groups
16713 (@pxref{Document Groups}).
16716 Articles can be highlighted and customized (@pxref{Customizing
16720 URLs and other external references can be buttonized (@pxref{Article
16724 You can do lots of strange stuff with the Gnus window & frame
16725 configuration (@pxref{Windows Configuration}).
16728 You can click on buttons instead of using the keyboard
16734 @node September Gnus
16735 @subsubsection September Gnus
16739 \gnusfig{-28cm}{0cm}{\epsfig{figure=tmp/september.ps,height=20cm}}
16743 New features in Gnus 5.2/5.3:
16748 A new message composition mode is used. All old customization variables
16749 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
16753 Gnus is now able to generate @dfn{sparse} threads---threads where
16754 missing articles are represented by empty nodes (@pxref{Customizing
16758 (setq gnus-build-sparse-threads 'some)
16762 Outgoing articles are stored on a special archive server
16763 (@pxref{Archived Messages}).
16766 Partial thread regeneration now happens when articles are
16770 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
16773 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
16776 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
16779 (setq gnus-use-trees t)
16783 An @code{nn}-like pick-and-read minor mode is available for the summary
16784 buffers (@pxref{Pick and Read}).
16787 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
16791 In binary groups you can use a special binary minor mode (@pxref{Binary
16795 Groups can be grouped in a folding topic hierarchy (@pxref{Group
16799 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
16803 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
16806 Groups can now have a score, and bubbling based on entry frequency
16807 is possible (@pxref{Group Score}).
16810 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
16814 Groups can be process-marked, and commands can be performed on
16815 groups of groups (@pxref{Marking Groups}).
16818 Caching is possible in virtual groups.
16821 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
16822 news batches, ClariNet briefs collections, and just about everything
16823 else (@pxref{Document Groups}).
16826 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
16830 The Gnus cache is much faster.
16833 Groups can be sorted according to many criteria (@pxref{Sorting
16837 New group parameters have been introduced to set list-addresses and
16838 expiry times (@pxref{Group Parameters}).
16841 All formatting specs allow specifying faces to be used
16842 (@pxref{Formatting Fonts}).
16845 There are several more commands for setting/removing/acting on process
16846 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
16849 The summary buffer can be limited to show parts of the available
16850 articles based on a wide range of criteria. These commands have been
16851 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
16854 Articles can be made persistent with the @kbd{*} command
16855 (@pxref{Persistent Articles}).
16858 All functions for hiding article elements are now toggles.
16861 Article headers can be buttonized (@pxref{Article Washing}).
16864 All mail backends support fetching articles by @code{Message-ID}.
16867 Duplicate mail can now be treated properly (@pxref{Duplicates}).
16870 All summary mode commands are available directly from the article
16871 buffer (@pxref{Article Keymap}).
16874 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
16878 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
16881 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fseptember.ps,height=5cm}]{\epsfig{figure=tmp/fseptember.ps,height=5cm}}
16886 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
16889 (setq gnus-use-nocem t)
16893 Groups can be made permanently visible (@pxref{Listing Groups}).
16896 (setq gnus-permanently-visible-groups "^nnml:")
16900 Many new hooks have been introduced to make customizing easier.
16903 Gnus respects the @code{Mail-Copies-To} header.
16906 Threads can be gathered by looking at the @code{References} header
16907 (@pxref{Customizing Threading}).
16910 (setq gnus-summary-thread-gathering-function
16911 'gnus-gather-threads-by-references)
16915 Read articles can be stored in a special backlog buffer to avoid
16916 refetching (@pxref{Article Backlog}).
16919 (setq gnus-keep-backlog 50)
16923 A clean copy of the current article is always stored in a separate
16924 buffer to allow easier treatment.
16927 Gnus can suggest where to save articles (@pxref{Saving Articles}).
16930 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
16934 (setq gnus-prompt-before-saving t)
16938 @code{gnus-uu} can view decoded files asynchronously while fetching
16939 articles (@pxref{Other Decode Variables}).
16942 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
16946 Filling in the article buffer now works properly on cited text
16947 (@pxref{Article Washing}).
16950 Hiding cited text adds buttons to toggle hiding, and how much
16951 cited text to hide is now customizable (@pxref{Article Hiding}).
16954 (setq gnus-cited-lines-visible 2)
16958 Boring headers can be hidden (@pxref{Article Hiding}).
16961 Default scoring values can now be set from the menu bar.
16964 Further syntax checking of outgoing articles have been added.
16970 @subsubsection Red Gnus
16972 New features in Gnus 5.4/5.5:
16976 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=tmp/red.ps,height=20cm}}
16983 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
16986 Article prefetching functionality has been moved up into
16987 Gnus (@pxref{Asynchronous Fetching}).
16990 Scoring can now be performed with logical operators like @code{and},
16991 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
16995 Article washing status can be displayed in the
16996 article mode line (@pxref{Misc Article}).
16999 @file{gnus.el} has been split into many smaller files.
17002 Suppression of duplicate articles based on Message-ID can be done
17003 (@pxref{Duplicate Suppression}).
17006 (setq gnus-suppress-duplicates t)
17010 New variables for specifying what score and adapt files are to be
17011 considered home score and adapt files (@pxref{Home Score File}) have
17015 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
17016 Server Internals}).
17019 Groups can inherit group parameters from parent topics (@pxref{Topic
17023 Article editing has been revamped and is now actually usable.
17026 Signatures can be recognized in more intelligent fashions
17027 (@pxref{Article Signature}).
17030 Summary pick mode has been made to look more @code{nn}-like. Line
17031 numbers are displayed and the @kbd{.} command can be used to pick
17032 articles (@code{Pick and Read}).
17035 Commands for moving the @file{.newsrc.eld} from one server to
17036 another have been added (@pxref{Changing Servers}).
17039 There's a way now to specify that ``uninteresting'' fields be suppressed
17040 when generating lines in buffers (@pxref{Advanced Formatting}).
17043 Several commands in the group buffer can be undone with @kbd{M-C-_}
17047 Scoring can be done on words using the new score type @code{w}
17048 (@pxref{Score File Format}).
17051 Adaptive scoring can be done on a Subject word-by-word basis
17052 (@pxref{Adaptive Scoring}).
17055 (setq gnus-use-adaptive-scoring '(word))
17059 Scores can be decayed (@pxref{Score Decays}).
17062 (setq gnus-decay-scores t)
17066 Scoring can be performed using a regexp on the Date header. The Date is
17067 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
17070 A new command has been added to remove all data on articles from
17071 the native server (@pxref{Changing Servers}).
17074 A new command for reading collections of documents
17075 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
17076 (@pxref{Really Various Summary Commands}).
17079 Process mark sets can be pushed and popped (@pxref{Setting Process
17083 A new mail-to-news backend makes it possible to post even when the NNTP
17084 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
17087 A new backend for reading searches from Web search engines
17088 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
17089 (@pxref{Web Searches}).
17092 Groups inside topics can now be sorted using the standard sorting
17093 functions, and each topic can be sorted independently (@pxref{Topic
17097 Subsets of the groups can be sorted independently (@code{Sorting
17101 Cached articles can be pulled into the groups (@pxref{Summary Generation
17105 \marginpar[\mbox{}\hfill\epsfig{figure=tmp/fred.ps,width=3cm}]{\epsfig{figure=tmp/fred.ps,width=3cm}}
17110 Score files are now applied in a more reliable order (@pxref{Score
17114 Reports on where mail messages end up can be generated (@pxref{Splitting
17118 More hooks and functions have been added to remove junk from incoming
17119 mail before saving the mail (@pxref{Washing Mail}).
17122 Emphasized text can be properly fontisized:
17128 @subsubsection Quassia Gnus
17130 New features in Gnus 5.6:
17135 New functionality for using Gnus as an offline newsreader has been
17136 added. A plethora of new commands and modes have been added. See
17137 @pxref{Gnus Unplugged} for the full story.
17140 The @code{nndraft} backend has returned, but works differently than
17141 before. All Message buffers are now also articles in the @code{nndraft}
17142 group, which is created automatically.
17145 @code{gnus-alter-header-function} can now be used to alter header
17149 @code{gnus-summary-goto-article} now accept Message-ID's.
17152 A new Message command for deleting text in the body of a message
17153 outside the region: @kbd{C-c C-v}.
17156 You can now post to component group in @code{nnvirtual} groups with
17160 @code{nntp-rlogin-program}---new variable to ease customization.
17163 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
17164 re-highlighting of the article buffer.
17167 New element in @code{gnus-boring-article-headers}---@code{long-to}.
17170 @kbd{M-i} symbolic prefix command. See the section "Symbolic
17171 Prefixes" in the Gnus manual for details.
17174 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
17175 @kbd{a} to add the score rule to the "all.SCORE" file.
17178 @code{gnus-simplify-subject-functions} variable to allow greater
17179 control over simplification.
17182 @kbd{A T}---new command for fetching the current thread.
17185 @kbd{/ T}---new command for including the current thread in the
17189 @kbd{M-RET} is a new Message command for breaking cited text.
17192 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
17195 The @code{custom-face-lookup} function has been removed.
17196 If you used this function in your initialization files, you must
17197 rewrite them to use @code{face-spec-set} instead.
17200 Canceling now uses the current select method. Symbolic prefix
17201 @kbd{a} forces normal posting method.
17204 New command to translate M******** sm*rtq**t*s into proper
17208 For easier debugging of @code{nntp}, you can set
17209 @code{nntp-record-commands} to a non-@code{nil} value.
17212 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
17213 controlling where and how to send @sc{authinfo} to @sc{nntp} servers.
17216 A command for editing group parameters from the summary buffer
17220 A history of where mails have been split is available.
17223 A new article date command has been added---@code{article-date-iso8601}.
17226 Subjects can be simplified when threading by setting
17227 @code{gnus-score-thread-simplify}.
17230 A new function for citing in Message has been
17231 added---@code{message-cite-original-without-signature}.
17234 @code{article-strip-all-blank-lines}---new article command.
17237 A new Message command to kill to the end of the article has
17241 A minimum adaptive score can be specified by using the
17242 @code{gnus-adaptive-word-minimum} variable.
17245 The "lapsed date" article header can be kept continually
17246 updated by the @code{gnus-start-date-timer} command.
17249 Web listserv archives can be read with the @code{nnlistserv} backend.
17252 Old dejanews archives can now be read by @code{nnweb}.
17257 @node Newest Features
17258 @subsection Newest Features
17261 Also known as the @dfn{todo list}. Sure to be implemented before the
17264 Be afraid. Be very afraid.
17266 (That a feature appears in this list doesn't necessarily mean that I've
17267 decided to actually implement it. It just means that I think it sounds
17270 (Yes, this is the actual, up-to-the-second todo list.)
17275 I would like the zombie-page to contain an URL to the source of the
17276 latest version of gnus or some explanation on where to find it.
17279 A way to continue editing the latest Message composition.
17282 http://www.sonicnet.com/feature/ari3/
17285 facep is not declared.
17288 Include a section in the manual on why the number of articles
17289 isn't the same in the group buffer and on the SPC prompt.
17292 Interacting with rmail fcc isn't easy.
17297 <URL:http://www.falch.no/people/pepper/DSSSL-Lite/archives/>
17298 <URL:http://www.eit.com/software/hypermail/hypermail.html>
17299 <URL:http://homer.ncm.com/>
17300 <URL:http://www.yahoo.com/Computers_and_Internet/Internet/World_Wide_Web/HTML_Converters/>
17301 http://www.uwsg.indiana.edu/hypermail/linux/kernel/9610/index.html
17302 <URL:http://union.ncsa.uiuc.edu/HyperNews/get/www/html/converters.html>
17303 http://www.miranova.com/gnus-list/
17308 @samp{^-- } is made into - in LaTeX.
17311 gnus-kill is much slower than it was in GNUS 4.1.3.
17314 when expunging articles on low score, the sparse nodes keep hanging on?
17316 starting the first time seems to hang Gnus on some systems. Does
17317 NEWGROUPS answer too fast?
17319 nndir doesn't read gzipped files.
17321 FAQ doesn't have an up node?
17323 when moving mail from a procmail spool to the crash-box,
17324 the crash-box is only appropriate to one specific group.
17326 `t' `t' makes X-Faces disappear.
17328 nnmh-be-safe means that crossposted articles will
17329 be marked as unread.
17331 Orphan score entries don't show on "V t" score trace
17333 when clearing out data, the cache data should also be reset.
17335 rewrite gnus-summary-limit-children to be non-recursive
17336 to avoid exceeding lisp nesting on huge groups.
17338 expunged articles are counted when computing scores.
17340 implement gnus-batch-brew-soup
17342 ticked articles aren't easy to read in pick mode -- `n' and
17343 stuff just skips past them. Read articles are the same.
17345 topics that contain just groups with ticked
17346 articles aren't displayed.
17348 nndoc should always allocate unique Message-IDs.
17350 If there are mail groups the first time you use Gnus, Gnus'll
17351 make the mail groups killed.
17353 no "no news is good news" when using topics.
17355 when doing crosspost marking, the cache has to be consulted
17356 and articles have to be removed.
17358 nnweb should fetch complete articles when they are split into several
17361 scoring on head immediate doesn't work.
17363 finding short score file names takes forever.
17365 canceling articles in foreign groups.
17367 nntp-open-rlogin no longer works.
17369 C-u C-x C-s (Summary) switches to the group buffer.
17371 move nnmail-split-history out to the backends.
17373 nnweb doesn't work properly.
17375 using a virtual server name as `gnus-select-method' doesn't work?
17377 when killing/yanking a group from one topic to another in a slave, the
17378 master will yank it first to one topic and then add it to another.
17382 warn user about `=' redirection of a group in the active file?
17384 take over the XEmacs menubar and offer a toggle between the XEmacs
17385 bar and the Gnus bar.
17388 push active file and NOV file parsing down into C code.
17389 `(canonize-message-id id)'
17390 `(mail-parent-message-id references n)'
17391 `(parse-news-nov-line &optional dependency-hashtb)'
17392 `(parse-news-nov-region beg end &optional dependency-hashtb fullp)'
17393 `(parse-news-active-region beg end hashtb)'
17398 nnml .overview directory with splits.
17402 postponed commands.
17404 the selected article show have its Subject displayed in its summary line.
17406 when entering groups, get the real number of unread articles from
17409 sort after gathering threads -- make false roots have the
17410 headers of the oldest orphan with a 0 article number?
17412 nndoc groups should inherit the score files of their parents? Also
17413 inherit copy prompts and save files.
17415 command to start up Gnus (if not running) and enter a mail mode buffer.
17417 allow editing the group description from the group buffer
17418 for backends that support that.
17420 gnus-hide,show-all-topics
17422 groups and sub-topics should be allowed to mingle inside each topic,
17423 and not just list all subtopics at the end.
17425 a command to remove all read articles that are not needed to connect
17426 threads -- `gnus-summary-limit-to-sparse-unread'?
17428 a variable to turn off limiting/cutting of threads in the tree buffer.
17430 a variable to limit how many files are uudecoded.
17432 add zombie groups to a special "New Groups" topic.
17434 server mode command: close/open all connections
17436 put a file date in gnus-score-alist and check whether the file
17437 has been changed before using it.
17439 on exit from a digest group, go to the next article in the parent group.
17441 hide (sub)threads with low score.
17443 when expiring, remove all marks from expired articles.
17445 gnus-summary-limit-to-body
17447 a regexp alist that says what level groups are to be subscribed
17448 on. Eg. -- `(("nnml:" . 1))'.
17450 easier interface to nnkiboze to create ephemeral groups that
17451 contain groups that match a regexp.
17453 allow newlines in <URL:> urls, but remove them before using
17456 If there is no From line, the mail backends should fudge one from the
17459 fuzzy simplifying should strip all non-alpha-numerical info
17460 from subject lines.
17462 gnus-soup-brew-soup-with-high-scores.
17464 nntp-ping-before-connect
17466 command to check whether NOV is evil. "list overview.fmt".
17468 when entering a group, Gnus should look through the score
17469 files very early for `local' atoms and set those local variables.
17471 message annotations.
17473 topics are always yanked before groups, and that's not good.
17475 (set-extent-property extent 'help-echo "String to display in minibuf")
17476 to display help in the minibuffer on buttons under XEmacs.
17478 allow group line format spec to say how many articles there
17483 support qmail maildir spools
17485 `run-with-idle-timer' in gnus-demon.
17487 stop using invisible text properties and start using overlays instead
17489 C-c C-f C-e to add an Expires header.
17491 go from one group to the next; everything is expunged; go to the
17492 next group instead of going to the group buffer.
17494 gnus-renumber-cache -- to renumber the cache using "low" numbers.
17496 record topic changes in the dribble buffer.
17498 `nnfolder-generate-active-file' should look at the folders it
17499 finds and generate proper active ranges.
17501 nneething-look-in-files-for-article-heads variable to control
17502 whether nneething should sniff all files in the directories.
17504 gnus-fetch-article -- start Gnus, enter group, display article
17506 gnus-dont-move-articles-to-same-group variable when respooling.
17508 when messages are crossposted between several auto-expirable groups,
17509 articles aren't properly marked as expirable.
17511 nneething should allow deletion/moving.
17513 TAB on the last button should go to the first button.
17515 if the car of an element in `mail-split-methods' is a function,
17516 and the function returns non-nil, use that as the name of the group(s) to
17519 command for listing all score files that have been applied.
17521 a command in the article buffer to return to `summary' config.
17523 `gnus-always-post-using-current-server' -- variable to override
17524 `C-c C-c' when posting.
17526 nnmail-group-spool-alist -- says where each group should use
17529 when an article is crossposted to an auto-expirable group, the article
17530 should be marker as expirable.
17532 article mode command/menu for "send region as URL to browser".
17534 on errors, jump to info nodes that explain the error. For instance,
17535 on invalid From headers, or on error messages from the nntp server.
17537 when gathering threads, make the article that has no "Re: " the parent.
17538 Also consult Date headers.
17540 a token in splits to call shrink-window-if-larger-than-buffer
17542 `1 0 A M' to do matches on the active hashtb.
17544 duplicates -- command to remove Gnus-Warning header, use the read
17545 Message-ID, delete the "original".
17547 when replying to several messages at once, put the "other" message-ids
17548 into a See-Also header.
17550 support setext: URL:http://www.bsdi.com/setext/
17552 support ProleText: <URL:http://proletext.clari.net/prole/proletext.html>
17554 when browsing a foreign server, the groups that are already subscribed
17555 should be listed as such and not as "K".
17557 generate font names dynamically.
17559 score file mode auto-alist.
17561 allow nndoc to change/add/delete things from documents. Implement
17562 methods for each format for adding an article to the document.
17564 `gnus-fetch-old-headers' `all' value to incorporate
17565 absolutely all headers there is.
17567 function like `|', but concatenate all marked articles
17568 and pipe them to the process.
17570 cache the list of killed (or active) groups in a separate file. Update
17571 the file whenever we read the active file or the list
17572 of killed groups in the .eld file reaches a certain length.
17574 function for starting to edit a file to put into
17575 the current mail group.
17577 score-find-trace should display the total score of the article.
17579 "ghettozie" -- score on Xref header and nix it out after using it
17580 to avoid marking as read in other groups it has been crossposted to.
17582 look at procmail splitting. The backends should create
17583 the groups automatically if a spool file exists for that group.
17585 function for backends to register themselves with Gnus.
17587 when replying to several process-marked articles,
17588 have all the From end up in Cc headers? Variable to toggle.
17590 command to delete a crossposted mail article from all
17591 groups it has been mailed to.
17593 `B c' and `B m' should be crosspost aware.
17595 hide-pgp should also hide PGP public key blocks.
17597 Command in the group buffer to respool process-marked groups.
17599 `gnus-summary-find-matching' should accept
17600 pseudo-"headers" like "body", "head" and "all"
17602 When buttifying <URL: > things, all white space (including
17603 newlines) should be ignored.
17605 Process-marking all groups in a topic should process-mark
17606 groups in subtopics as well.
17608 Add non-native groups to the list of killed groups when killing them.
17610 nntp-suggest-kewl-config to probe the nntp server and suggest
17613 add edit and forward secondary marks.
17615 nnml shouldn't visit its .overview files.
17617 allow customizing sorting within gathered threads.
17619 `B q' shouldn't select the current article.
17621 nnmbox should support a newsgroups file for descriptions.
17623 allow fetching mail from several pop servers.
17625 Be able to specify whether the saving commands save the original
17626 or the formatted article.
17628 a command to reparent with the child process-marked (cf. `T ^'.).
17630 I think the possibility to send a password with nntp-open-rlogin
17631 should be a feature in Red Gnus.
17633 The `Z n' command should be possible to execute from a mouse click.
17635 more limiting functions -- date, etc.
17637 be able to limit on a random header; on body; using reverse matches.
17639 a group parameter (`absofucking-total-expiry') that will make Gnus expire
17640 even unread articles.
17642 a command to print the article buffer as postscript.
17644 variable to disable password fetching when opening by nntp-open-telnet.
17646 manual: more example servers -- nntp with rlogin, telnet
17648 checking for bogus groups should clean topic alists as well.
17650 canceling articles in foreign groups.
17652 article number in folded topics isn't properly updated by
17655 Movement in the group buffer to the next unread group should go to the
17656 next closed topic with unread messages if no group can be found.
17658 Extensive info pages generated on the fly with help everywhere --
17659 in the "*Gnus edit*" buffers, for instance.
17661 Topic movement commands -- like thread movement. Up, down, forward, next.
17663 a way to tick/mark as read Gcc'd articles.
17665 a way to say that all groups within a specific topic comes
17666 from a particular server? Hm.
17668 `gnus-article-fill-if-long-lines' -- a function to fill
17669 the article buffer if there are any looong lines there.
17671 `T h' should jump to the parent topic and fold it.
17673 a command to create an ephemeral nndoc group out of a file,
17674 and then splitting it/moving it to some other group/backend.
17676 a group parameter for nnkiboze groups that says that
17677 all kibozed articles should be entered into the cache.
17679 It should also probably be possible to delimit what
17680 `gnus-jog-cache' does -- for instance, work on just some groups, or on
17681 some levels, and entering just articles that have a score higher than
17684 nnfolder should append to the folder instead of re-writing
17685 the entire folder to disk when accepting new messages.
17687 allow all backends to do the proper thing with .gz files.
17689 a backend for reading collections of babyl files nnbabylfolder?
17691 a command for making the native groups into foreign groups.
17693 server mode command for clearing read marks from all groups
17696 when following up multiple articles, include all To, Cc, etc headers
17699 a command for deciding what the total score of the current
17700 thread is. Also a way to highlight based on this.
17702 command to show and edit group scores
17704 a gnus-tree-minimize-horizontal to minimize tree buffers
17707 command to generate nnml overview file for one group.
17709 `C-u C-u a' -- prompt for many crossposted groups.
17711 keep track of which mail groups have received new articles (in this session).
17712 Be able to generate a report and perhaps do some marking in the group
17715 gnus-build-sparse-threads to a number -- build only sparse threads
17716 that are of that length.
17718 have nnmh respect mh's unseen sequence in .mh_profile.
17720 cache the newsgroups descriptions locally.
17722 asynchronous posting under nntp.
17724 be able to control word adaptive scoring from the score files.
17726 a variable to make `C-c C-c' post using the "current" select method.
17728 `limit-exclude-low-scored-articles'.
17730 if `gnus-summary-show-thread' is a number, hide threads that have
17731 a score lower than this number.
17733 split newsgroup subscription variable up into "order" and "method".
17735 buttonize ange-ftp file names.
17737 a command to make a duplicate copy of the current article
17738 so that each copy can be edited separately.
17740 nnweb should allow fetching from the local nntp server.
17742 record the sorting done in the summary buffer so that
17743 it can be repeated when limiting/regenerating the buffer.
17745 nnml-generate-nov-databses should generate for
17748 when the user does commands in the group buffer, check
17749 the modification time of the .newsrc.eld file and use
17750 ask-user-about-supersession-threat. Also warn when trying
17751 to save .newsrc.eld and it has changed.
17753 M-g on a topic will display all groups with 0 articles in
17756 command to remove all topic stuff.
17758 allow exploding incoming digests when reading incoming mail
17759 and splitting the resulting digests.
17761 nnsoup shouldn't set the `message-' variables.
17763 command to nix out all nnoo state information.
17765 nnmail-process-alist that calls functions if group names
17766 matches an alist -- before saving.
17768 use buffer-invisibility-spec everywhere for hiding text.
17770 variable to activate each group before entering them
17771 to get the (new) number of articles. `gnus-activate-before-entering'.
17773 command to fetch a Message-ID from any buffer, even
17774 starting Gnus first if necessary.
17776 when posting and checking whether a group exists or not, just
17777 ask the nntp server instead of relying on the active hashtb.
17779 buttonize the output of `C-c C-a' in an apropos-like way.
17781 `G p' should understand process/prefix, and allow editing
17782 of several groups at once.
17784 command to create an ephemeral nnvirtual group that
17785 matches some regexp(s).
17787 nndoc should understand "Content-Type: message/rfc822" forwarded messages.
17789 it should be possible to score "thread" on the From header.
17791 hitting RET on a "gnus-uu-archive" pseudo article should unpack it.
17793 `B i' should display the article at once in the summary buffer.
17795 remove the "*" mark at once when unticking an article.
17797 `M-s' should highlight the matching text.
17799 when checking for duplicated mails, use Resent-Message-ID if present.
17801 killing and yanking groups in topics should be better. If killing one copy
17802 of a group that exists in multiple topics, only that copy should
17803 be removed. Yanking should insert the copy, and yanking topics
17804 should be possible to be interspersed with the other yankings.
17806 command for enter a group just to read the cached articles. A way to say
17807 "ignore the nntp connection; just read from the cache."
17809 `X u' should decode base64 articles.
17811 a way to hide all "inner" cited text, leaving just the most
17812 recently cited text.
17814 nnvirtual should be asynchronous.
17816 after editing an article, gnus-original-article-buffer should
17819 there should probably be a way to make Gnus not connect to the
17820 server and just read the articles in the server
17822 allow a `set-default' (or something) to change the default
17823 value of nnoo variables.
17825 a command to import group infos from a .newsrc.eld file.
17827 groups from secondary servers have the entire select method
17828 listed in each group info.
17830 a command for just switching from the summary buffer to the group
17833 a way to specify that some incoming mail washing functions
17834 should only be applied to some groups.
17836 Message `C-f C-t' should ask the user whether to heed
17837 mail-copies-to: never.
17839 new group parameter -- `post-to-server' that says to post
17840 using the current server. Also a variable to do the same.
17842 the slave dribble files should auto-save to the slave file names.
17844 a group parameter that says what articles to display on group entry, based
17847 a way to visually distinguish slave Gnusae from masters. (Whip instead
17850 Use DJ Bernstein "From " quoting/dequoting, where applicable.
17852 Why is hide-citation-maybe and hide-citation different? Also
17855 group user-defined meta-parameters.
17859 From: John Griffith <griffith@@sfs.nphil.uni-tuebingen.de>
17861 I like the option for trying to retrieve the FAQ for a group and I was
17862 thinking it would be great if for those newsgroups that had archives
17863 you could also try to read the archive for that group. Part of the
17864 problem is that archives are spread all over the net, unlike FAQs.
17865 What would be best I suppose is to find the one closest to your site.
17867 In any case, there is a list of general news group archives at @*
17868 ftp://ftp.neosoft.com/pub/users/claird/news.lists/newsgroup_archives.html
17875 From: Jason L Tibbitts III <tibbs@@hpc.uh.edu>
17876 (add-hook 'gnus-select-group-hook
17878 (gnus-group-add-parameter group
17879 (cons 'gnus-group-date-last-entered (list (current-time-string))))))
17881 (defun gnus-user-format-function-d (headers)
17882 "Return the date the group was last read."
17883 (cond ((car (gnus-group-get-parameter gnus-tmp-group 'gnus-group-date-last-entered)))
17888 tanken var at når du bruker `gnus-startup-file' som prefix (FOO) til å lete
17889 opp en fil FOO-SERVER, FOO-SERVER.el, FOO-SERVER.eld, kan du la den være en
17890 liste hvor du bruker hvert element i listen som FOO, istedet. da kunne man
17891 hatt forskjellige serveres startup-filer forskjellige steder.
17895 LMI> Well, nnbabyl could alter the group info to heed labels like
17896 LMI> answered and read, I guess.
17898 It could also keep them updated (the same for the Status: header of
17901 They could be used like this:
17905 `M l <name> RET' add label <name> to current message.
17906 `M u <name> RET' remove label <name> from current message.
17907 `/ l <expr> RET' limit summary buffer according to <expr>.
17909 <expr> would be a boolean expression on the labels, e.g.
17911 `/ l bug & !fixed RET'
17914 would show all the messages which are labeled `bug' but not labeled
17917 One could also imagine the labels being used for highlighting, or
17918 affect the summary line format.
17922 Sender: abraham@@dina.kvl.dk
17924 I'd like a gnus-find-file which work like find file, except that it
17925 would recognize things that looks like messages or folders:
17927 - If it is a directory containing numbered files, create an nndir
17930 - For other directories, create a nneething summary buffer.
17932 - For files matching "\\`From ", create a nndoc/mbox summary.
17934 - For files matching "\\`BABYL OPTIONS:", create a nndoc/baby summary.
17936 - For files matching "\\`[^ \t\n]+:", create an *Article* buffer.
17938 - For other files, just find them normally.
17940 I'd like `nneething' to use this function, so it would work on a
17941 directory potentially containing mboxes or babyl files.
17944 Please send a mail to bwarsaw@@cnri.reston.va.us (Barry A. Warsaw) and
17945 tell him what you are doing.
17948 Currently, I get prompted:
17952 decend into sci.something ?
17956 The problem above is that since there is really only one subsection of
17957 science, shouldn't it prompt you for only descending sci.something? If
17958 there was a sci.somethingelse group or section, then it should prompt
17959 for sci? first the sci.something? then sci.somethingelse?...
17962 Ja, det burde være en måte å si slikt. Kanskje en ny variabel?
17963 `gnus-use-few-score-files'? SÃ¥ kunne score-regler legges til den
17964 "mest" lokale score-fila. F. eks. ville no-gruppene betjenes av
17965 "no.all.SCORE", osv.
17968 What i want is for Gnus to treat any sequence or combination of the following
17969 as a single spoiler warning and hide it all, replacing it with a "Next Page"
17975 more than n blank lines
17977 more than m identical lines
17978 (which should be replaced with button to show them)
17980 any whitespace surrounding any of the above
17984 Well, we could allow a new value to `gnus-thread-ignore-subject' --
17985 `spaces', or something. (We could even default to that.) And then
17986 subjects that differ in white space only could be considered the
17987 "same" subject for threading purposes.
17990 Modes to preprocess the contents (e.g. jka-compr) use the second form
17991 "(REGEXP FUNCTION NON-NIL)" while ordinary modes (e.g. tex) use the first
17992 form "(REGEXP . FUNCTION)", so you could use it to distinguish between
17993 those two types of modes. (auto-modes-alist, insert-file-contents-literally.)
17996 Under XEmacs -- do funny article marks:
17999 soup - bowl of soup
18000 score below - dim light bulb
18001 score over - bright light bulb
18004 Yes. I think the algorithm is as follows:
18009 show-list-of-articles-in-group
18010 if (key-pressed == SPACE)
18011 if (no-more-articles-in-group-to-select)
18012 if (articles-selected)
18013 start-reading-selected-articles;
18014 junk-unread-articles;
18019 else if (key-pressed = '.')
18020 if (consolidated-menus) # same as hide-thread in Gnus
18021 select-thread-under-cursor;
18023 select-article-under-cursor;
18027 if (key-pressed == SPACE)
18028 if (more-pages-in-article)
18030 else if (more-selected-articles-to-read)
18037 My precise need here would have been to limit files to Incoming*.
18038 One could think of some `nneething-only-files' variable, but I guess
18039 it would have been unacceptable if one was using many unrelated such
18042 A more useful approach would be to, in response to the `G D' prompt, be
18043 allowed to say something like: `~/.mail/Incoming*', somewhat limiting
18044 the top-level directory only (in case directories would be matched by
18045 the wildcard expression).
18048 It would be nice if it also handled
18050 <URL:news://sunsite.auc.dk/>
18052 which should correspond to `B nntp RET sunsite.auc.dk' in *Group*.
18057 Take a look at w3-menu.el in the Emacs-W3 distribution - this works out
18058 really well. Each menu is 'named' by a symbol that would be on a
18059 gnus-*-menus (where * would be whatever, but at least group, summary, and
18060 article versions) variable.
18062 So for gnus-summary-menus, I would set to '(sort mark dispose ...)
18064 A value of '1' would just put _all_ the menus in a single 'GNUS' menu in
18065 the main menubar. This approach works really well for Emacs-W3 and VM.
18069 nndoc should take care to create unique Message-IDs for all its
18072 gnus-score-followup-article only works when you have a summary buffer
18073 active. Make it work when posting from the group buffer as well.
18074 (message-sent-hook).
18076 rewrite gnus-demon to use run-with-idle-timers.
18079 * Enhancements to Gnus:
18083 * gnus-servers (gnus-start-server-buffer?)--enters Gnus and goes
18084 straight to the server buffer, without opening any connections to
18087 * gnus-server-read-server-newsrc--produces a buffer very similar to
18088 the group buffer, but with only groups from that server listed;
18089 quitting this buffer returns to the server buffer.
18092 add a command to check the integrity of an nnfolder folder --
18093 go through the article numbers and see that there are no duplicates,
18097 `unsmileyfy-buffer' to undo smileification.
18100 a command to give all relevant info on an article, including all
18104 when doing `-request-accept-article', the backends should do
18105 the nnmail duplicate checking.
18108 allow `message-signature-file' to be a function to return the
18109 value of the signature file.
18112 In addition, I would love it if I could configure message-tab so that it
18113 could call `bbdb-complete-name' in other headers. So, some sort of
18116 (setq message-tab-alist
18117 '((message-header-regexp message-expand-group)
18118 ("^\\(To\\|[cC]c\\|[bB]cc\\)" bbdb-complete-name)))
18120 then you could run the relevant function to complete the information in
18124 cache the newsgroups file locally to avoid reloading it all the time.
18127 a command to import a buffer into a group.
18130 nnweb should allow fetching by Message-ID from servers.
18133 point in the article buffer doesn't always go to the
18134 beginning of the buffer when selecting new articles.
18137 a command to process mark all unread articles.
18140 `gnus-gather-threads-by-references-and-subject' -- first
18141 do gathering by references, and then go through the dummy roots and
18142 do more gathering by subject.
18145 gnus-uu-mark-in-numerical-order -- process mark articles in
18146 article numerical order.
18149 (gnus-thread-total-score
18150 (gnus-id-to-thread (mail-header-id (gnus-summary-article-header))))
18154 sorting by score is wrong when using sparse threads.
18157 a command to fetch an arbitrary article -- without having to be
18158 in the summary buffer.
18161 a new nncvs backend. Each group would show an article, using
18162 version branches as threading, checkin date as the date, etc.
18165 http://www.dejanews.com/forms/dnsetfilter_exp.html ?
18166 This filter allows one to construct advance queries on the Dejanews
18167 database such as specifying start and end dates, subject, author,
18168 and/or newsgroup name.
18171 new Date header scoring type -- older, newer
18174 use the summary toolbar in the article buffer.
18177 a command to fetch all articles that are less than X days old.
18180 in pick mode, `q' should save the list of selected articles in the
18181 group info. The next time the group is selected, these articles
18182 will automatically get the process mark.
18185 Isn't it possible to (also?) allow M-^ to automatically try the
18186 default server if it fails on the current server? (controlled by a
18187 user variable, (nil, t, 'ask)).
18190 make it possible to cancel articles using the select method for the
18194 `gnus-summary-select-article-on-entry' or something. It'll default
18195 to t and will select whatever article decided by `gnus-auto-select-first'.
18198 a new variable to control which selection commands should be unselecting.
18199 `first', `best', `next', `prev', `next-unread', `prev-unread' are
18203 be able to select groups that have no articles in them
18204 to be able to post in them (using the current select method).
18207 be able to post via DejaNews.
18210 `x' should retain any sortings that have been performed.
18213 allow the user to specify the precedence of the secondary marks. Also
18214 allow them to be displayed separately.
18217 gnus-summary-save-in-pipe should concatenate the results from
18218 the processes when doing a process marked pipe.
18221 a new match type, like Followup, but which adds Thread matches on all
18222 articles that match a certain From header.
18225 a function that can be read from kill-emacs-query-functions to offer
18226 saving living summary buffers.
18229 a function for selecting a particular group which will contain
18230 the articles listed in a list of article numbers/id's.
18233 a battery of character translation functions to translate common
18234 Mac, MS (etc) characters into ISO 8859-1.
18237 (defun article-fix-m$word ()
18238 "Fix M$Word smartquotes in an article."
18241 (let ((buffer-read-only nil))
18242 (goto-char (point-min))
18243 (while (search-forward "\221" nil t)
18244 (replace-match "`" t t))
18245 (goto-char (point-min))
18246 (while (search-forward "\222" nil t)
18247 (replace-match "'" t t))
18248 (goto-char (point-min))
18249 (while (search-forward "\223" nil t)
18250 (replace-match "\"" t t))
18251 (goto-char (point-min))
18252 (while (search-forward "\224" nil t)
18253 (replace-match "\"" t t)))))
18258 (add-hook 'gnus-exit-query-functions
18260 (if (and (file-exists-p nnmail-spool-file)
18261 (> (nnheader-file-size nnmail-spool-file) 0))
18262 (yes-or-no-p "New mail has arrived. Quit Gnus anyways? ")
18263 (y-or-n-p "Are you sure you want to quit Gnus? "))))
18267 allow message-default-headers to be a function.
18270 new Date score match types -- < > = (etc) that take floating point
18271 numbers and match on the age of the article.
18275 > > > If so, I've got one gripe: It seems that when I fire up gnus 5.2.25
18276 > > > under xemacs-19.14, it's creating a new frame, but is erasing the
18277 > > > buffer in the frame that it was called from =:-O
18279 > > Hm. How do you start up Gnus? From the toolbar or with
18280 > > `M-x gnus-other-frame'?
18282 > I normally start it up from the toolbar; at
18283 > least that's the way I've caught it doing the
18288 all commands that react to the process mark should push
18289 the current process mark set onto the stack.
18292 gnus-article-hide-pgp
18293 Selv ville jeg nok ha valgt å slette den dersom teksten matcher
18295 "\\(This\s+\\)?[^ ]+ has been automatically signed by"
18297 og det er maks hundre tegn mellom match-end og ----linja. Men -det-
18298 er min type heuristikk og langt fra alles.
18301 `gnus-subscribe-sorted' -- insert new groups where they would have been
18302 sorted to if `gnus-group-sort-function' were run.
18305 gnus-(group,summary)-highlight should respect any `face' text props set
18309 use run-with-idle-timer for gnus-demon instead of the
18310 home-brewed stuff for better reliability.
18313 add a way to select which NoCeM type to apply -- spam, troll, etc.
18316 nndraft-request-group should tally auto-save files.
18319 implement nntp-retry-on-break and nntp-command-timeout.
18322 gnus-article-highlight-limit that says when not to highlight (long)
18326 (nnoo-set SERVER VARIABLE VALUE)
18332 interrupitng agent fetching of articles should save articles.
18335 command to open a digest group, and copy all the articles there to the
18339 a variable to disable article body highlights if there's more than
18340 X characters in the body.
18343 handle 480/381 authinfo requests separately.
18346 include the texi/dir file in the distribution.
18349 format spec to "tab" to a position.
18352 Move all prompting to the new `M-n' default style.
18355 command to display all dormant articles.
18358 gnus-auto-select-next makeover -- list of things it should do.
18361 a score match type that adds scores matching on From if From has replied
18362 to something someone else has said.
18365 Read Netscape discussion groups:
18366 snews://secnews.netscape.com/netscape.communicator.unix
18369 One command to edit the original version if an article, and one to edit
18370 the displayed version.
18373 @kbd{T v} -- make all process-marked articles the children of the
18377 Switch from initial text to the new default text mechanism.
18380 How about making it possible to expire local articles? Will it be
18381 possible to make various constraints on when an article can be
18382 expired, e.g. (read), (age > 14 days), or the more interesting (read
18386 New limit command---limit to articles that have a certain string
18387 in the head or body.
18390 Allow breaking lengthy NNTP commands.
18393 gnus-article-highlight-limit, to disable highlighting in big articles.
18396 Editing an article should put the article to be edited
18397 in a special, unique buffer.
18400 A command to send a mail to the admin-address group param.
18403 A Date scoring type that will match if the article
18404 is less than a certain number of days old.
18407 New spec: %~(tab 56) to put point on column 56
18410 Allow Gnus Agent scoring to use normal score files.
18413 Rething the Agent active file thing. `M-g' doesn't update the active
18414 file, for instance.
18417 With dummy roots, `^' and then selecing the first article
18418 in any other dummy thread will make Gnus highlight the
18419 dummy root instead of the first article.
18422 Propagate all group properties (marks, article numbers, etc) up to the
18423 topics for displaying.
18426 `n' in the group buffer with topics should go to the next group
18427 with unread articles, even if that group is hidden in a topic.
18430 gnus-posting-styles doesn't work in drafts.
18433 gnus-summary-limit-include-cached is slow when there are
18434 many articles in the cache, since it regenerates big parts of the
18435 summary buffer for each article.
18438 Implement gnus-batch-brew-soup.
18441 Group parameters and summary commands for un/subscribing to mailing
18445 Introduce nnmail-home-directory.
18448 gnus-fetch-group and friends should exit Gnus when the user
18452 The jingle is only played on the second invocation of Gnus.
18455 Bouncing articles should do MIME.
18458 Crossposted articles should "inherit" the % or @ mark from the other
18459 groups it has been crossposted to, or something. (Agent.)
18462 `S D r' should allow expansion of aliases.
18465 If point is on a group that appears multiple times in topics, and
18466 you press `l', point will move to the first instance of the group.
18469 The documentation should mention pop3.el, fetchmail, smtpmail and why
18470 po:username often fails.
18473 Fetch by Message-ID from dejanews.
18475 <URL:http://search.dejanews.com/msgid.xp?MID=%3C62h9l9$hm4@@basement.replay.com%3E&fmt=raw>
18478 A spec for the group line format to display the number of
18479 agent-downloaded articles in the group.
18482 Some nntp servers never respond when posting, so there should be a
18483 timeout for all commands.
18486 Solve the halting problem.
18495 @section The Manual
18499 This manual was generated from a TeXinfo file and then run through
18500 either @code{texi2dvi}
18502 or my own home-brewed TeXinfo to \LaTeX\ transformer,
18503 and then run through @code{latex} and @code{dvips}
18505 to get what you hold in your hands now.
18507 The following conventions have been used:
18512 This is a @samp{string}
18515 This is a @kbd{keystroke}
18518 This is a @file{file}
18521 This is a @code{symbol}
18525 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
18529 (setq flargnoze "yes")
18532 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
18535 (setq flumphel 'yes)
18538 @samp{yes} and @code{yes} are two @emph{very} different things---don't
18539 ever get them confused.
18543 Of course, everything in this manual is of vital interest, so you should
18544 read it all. Several times. However, if you feel like skimming the
18545 manual, look for that gnu head you should see in the margin over
18546 there---it means that what's being discussed is of more importance than
18547 the rest of the stuff. (On the other hand, if everything is infinitely
18548 important, how can anything be more important than that? Just one more
18549 of the mysteries of this world, I guess.)
18557 @section Terminology
18559 @cindex terminology
18564 This is what you are supposed to use this thing for---reading news.
18565 News is generally fetched from a nearby @sc{nntp} server, and is
18566 generally publicly available to everybody. If you post news, the entire
18567 world is likely to read just what you have written, and they'll all
18568 snigger mischievously. Behind your back.
18572 Everything that's delivered to you personally is mail. Some news/mail
18573 readers (like Gnus) blur the distinction between mail and news, but
18574 there is a difference. Mail is private. News is public. Mailing is
18575 not posting, and replying is not following up.
18579 Send a mail to the person who has written what you are reading.
18583 Post an article to the current newsgroup responding to the article you
18588 Gnus gets fed articles from a number of backends, both news and mail
18589 backends. Gnus does not handle the underlying media, so to speak---this
18590 is all done by the backends.
18594 Gnus will always use one method (and backend) as the @dfn{native}, or
18595 default, way of getting news.
18599 You can also have any number of foreign groups active at the same time.
18600 These are groups that use non-native non-secondary backends for getting
18605 Secondary backends are somewhere half-way between being native and being
18606 foreign, but they mostly act like they are native.
18610 A message that has been posted as news.
18613 @cindex mail message
18614 A message that has been mailed.
18618 A mail message or news article
18622 The top part of a message, where administrative information (etc.) is
18627 The rest of an article. Everything not in the head is in the
18632 A line from the head of an article.
18636 A collection of such lines, or a collection of heads. Or even a
18637 collection of @sc{nov} lines.
18641 When Gnus enters a group, it asks the backend for the headers of all
18642 unread articles in the group. Most servers support the News OverView
18643 format, which is more compact and much faster to read and parse than the
18644 normal @sc{head} format.
18648 Each group is subscribed at some @dfn{level} or other (1-9). The ones
18649 that have a lower level are ``more'' subscribed than the groups with a
18650 higher level. In fact, groups on levels 1-5 are considered
18651 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
18652 are @dfn{killed}. Commands for listing groups and scanning for new
18653 articles will all use the numeric prefix as @dfn{working level}.
18655 @item killed groups
18656 @cindex killed groups
18657 No information on killed groups is stored or updated, which makes killed
18658 groups much easier to handle than subscribed groups.
18660 @item zombie groups
18661 @cindex zombie groups
18662 Just like killed groups, only slightly less dead.
18665 @cindex active file
18666 The news server has to keep track of what articles it carries, and what
18667 groups exist. All this information in stored in the active file, which
18668 is rather large, as you might surmise.
18671 @cindex bogus groups
18672 A group that exists in the @file{.newsrc} file, but isn't known to the
18673 server (i.e., it isn't in the active file), is a @emph{bogus group}.
18674 This means that the group probably doesn't exist (any more).
18677 @cindex activating groups
18678 The act of asking the server for info on a group and computing the
18679 number of unread articles is called @dfn{activating the group}.
18680 Un-activated groups are listed with @samp{*} in the group buffer.
18684 A machine one can connect to and get news (or mail) from.
18686 @item select method
18687 @cindex select method
18688 A structure that specifies the backend, the server and the virtual
18691 @item virtual server
18692 @cindex virtual server
18693 A named select method. Since a select method defines all there is to
18694 know about connecting to a (physical) server, taking the thing as a
18695 whole is a virtual server.
18699 Taking a buffer and running it through a filter of some sort. The
18700 result will (more often than not) be cleaner and more pleasing than the
18703 @item ephemeral groups
18704 @cindex ephemeral groups
18705 Most groups store data on what articles you have read. @dfn{Ephemeral}
18706 groups are groups that will have no data stored---when you exit the
18707 group, it'll disappear into the aether.
18710 @cindex solid groups
18711 This is the opposite of ephemeral groups. All groups listed in the
18712 group buffer are solid groups.
18714 @item sparse articles
18715 @cindex sparse articles
18716 These are article placeholders shown in the summary buffer when
18717 @code{gnus-build-sparse-threads} has been switched on.
18721 To put responses to articles directly after the articles they respond
18722 to---in a hierarchical fashion.
18726 @cindex thread root
18727 The first article in a thread is the root. It is the ancestor of all
18728 articles in the thread.
18732 An article that has responses.
18736 An article that responds to a different article---its parent.
18740 A collection of messages in one file. The most common digest format is
18741 specified by RFC1153.
18747 @node Customization
18748 @section Customization
18749 @cindex general customization
18751 All variables are properly documented elsewhere in this manual. This
18752 section is designed to give general pointers on how to customize Gnus
18753 for some quite common situations.
18756 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
18757 * Slow Terminal Connection:: You run a remote Emacs.
18758 * Little Disk Space:: You feel that having large setup files is icky.
18759 * Slow Machine:: You feel like buying a faster machine.
18763 @node Slow/Expensive Connection
18764 @subsection Slow/Expensive @sc{nntp} Connection
18766 If you run Emacs on a machine locally, and get your news from a machine
18767 over some very thin strings, you want to cut down on the amount of data
18768 Gnus has to get from the @sc{nntp} server.
18772 @item gnus-read-active-file
18773 Set this to @code{nil}, which will inhibit Gnus from requesting the
18774 entire active file from the server. This file is often v. large. You
18775 also have to set @code{gnus-check-new-newsgroups} and
18776 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
18777 doesn't suddenly decide to fetch the active file anyway.
18779 @item gnus-nov-is-evil
18780 This one has to be @code{nil}. If not, grabbing article headers from
18781 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
18782 support @sc{xover}; Gnus will detect this by itself.
18786 @node Slow Terminal Connection
18787 @subsection Slow Terminal Connection
18789 Let's say you use your home computer for dialing up the system that runs
18790 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
18791 possible) the amount of data sent over the wires.
18795 @item gnus-auto-center-summary
18796 Set this to @code{nil} to inhibit Gnus from re-centering the summary
18797 buffer all the time. If it is @code{vertical}, do only vertical
18798 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
18799 horizontal and vertical recentering.
18801 @item gnus-visible-headers
18802 Cut down on the headers included in the articles to the
18803 minimum. You can, in fact, make do without them altogether---most of the
18804 useful data is in the summary buffer, anyway. Set this variable to
18805 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
18807 Set this hook to all the available hiding commands:
18809 (setq gnus-treat-hide-headers 'head
18810 gnus-treat-hide-signature t
18811 gnus-treat-hide-citation t)
18814 @item gnus-use-full-window
18815 By setting this to @code{nil}, you can make all the windows smaller.
18816 While this doesn't really cut down much generally, it means that you
18817 have to see smaller portions of articles before deciding that you didn't
18818 want to read them anyway.
18820 @item gnus-thread-hide-subtree
18821 If this is non-@code{nil}, all threads in the summary buffer will be
18824 @item gnus-updated-mode-lines
18825 If this is @code{nil}, Gnus will not put information in the buffer mode
18826 lines, which might save some time.
18830 @node Little Disk Space
18831 @subsection Little Disk Space
18834 The startup files can get rather large, so you may want to cut their
18835 sizes a bit if you are running out of space.
18839 @item gnus-save-newsrc-file
18840 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
18841 only save @file{.newsrc.eld}. This means that you will not be able to
18842 use any other newsreaders than Gnus. This variable is @code{t} by
18845 @item gnus-save-killed-list
18846 If this is @code{nil}, Gnus will not save the list of dead groups. You
18847 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
18848 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
18849 variable to @code{nil}. This variable is @code{t} by default.
18855 @subsection Slow Machine
18856 @cindex slow machine
18858 If you have a slow machine, or are just really impatient, there are a
18859 few things you can do to make Gnus run faster.
18861 Set @code{gnus-check-new-newsgroups} and
18862 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
18864 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
18865 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
18866 summary buffer faster.
18870 @node Troubleshooting
18871 @section Troubleshooting
18872 @cindex troubleshooting
18874 Gnus works @emph{so} well straight out of the box---I can't imagine any
18882 Make sure your computer is switched on.
18885 Make sure that you really load the current Gnus version. If you have
18886 been running @sc{gnus}, you need to exit Emacs and start it up again before
18890 Try doing an @kbd{M-x gnus-version}. If you get something that looks
18891 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded. If,
18892 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
18893 flee}, you have some old @file{.el} files lying around. Delete these.
18896 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
18900 @vindex max-lisp-eval-depth
18901 Gnus works on many recursive structures, and in some extreme (and very
18902 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
18903 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
18904 something like that.
18907 If all else fails, report the problem as a bug.
18910 @cindex reporting bugs
18912 @kindex M-x gnus-bug
18914 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
18915 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
18916 me the backtrace. I will fix bugs, but I can only fix them if you send
18917 me a precise description as to how to reproduce the bug.
18919 You really can never be too detailed in a bug report. Always use the
18920 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
18921 a 10Kb mail each time you use it, and even if you have sent me your
18922 environment 500 times before. I don't care. I want the full info each
18925 It is also important to remember that I have no memory whatsoever. If
18926 you send a bug report, and I send you a reply, and then you just send
18927 back ``No, it's not! Moron!'', I will have no idea what you are
18928 insulting me about. Always over-explain everything. It's much easier
18929 for all of us---if I don't have all the information I need, I will just
18930 mail you and ask for more info, and everything takes more time.
18932 If the problem you're seeing is very visual, and you can't quite explain
18933 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
18934 it somewhere it can be reached, and include the URL of the picture in
18937 If you just need help, you are better off asking on
18938 @samp{gnu.emacs.gnus}. I'm not very helpful.
18940 @cindex gnu.emacs.gnus
18941 @cindex ding mailing list
18942 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
18943 Write to @samp{ding-request@@gnus.org} to subscribe.
18947 @node Gnus Reference Guide
18948 @section Gnus Reference Guide
18950 It is my hope that other people will figure out smart stuff that Gnus
18951 can do, and that other people will write those smart things as well. To
18952 facilitate that I thought it would be a good idea to describe the inner
18953 workings of Gnus. And some of the not-so-inner workings, while I'm at
18956 You can never expect the internals of a program not to change, but I
18957 will be defining (in some details) the interface between Gnus and its
18958 backends (this is written in stone), the format of the score files
18959 (ditto), data structures (some are less likely to change than others)
18960 and general methods of operation.
18963 * Gnus Utility Functions:: Common functions and variable to use.
18964 * Backend Interface:: How Gnus communicates with the servers.
18965 * Score File Syntax:: A BNF definition of the score file standard.
18966 * Headers:: How Gnus stores headers internally.
18967 * Ranges:: A handy format for storing mucho numbers.
18968 * Group Info:: The group info format.
18969 * Extended Interactive:: Symbolic prefixes and stuff.
18970 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
18971 * Various File Formats:: Formats of files that Gnus use.
18975 @node Gnus Utility Functions
18976 @subsection Gnus Utility Functions
18977 @cindex Gnus utility functions
18978 @cindex utility functions
18980 @cindex internal variables
18982 When writing small functions to be run from hooks (and stuff), it's
18983 vital to have access to the Gnus internal functions and variables.
18984 Below is a list of the most common ones.
18988 @item gnus-newsgroup-name
18989 @vindex gnus-newsgroup-name
18990 This variable holds the name of the current newsgroup.
18992 @item gnus-find-method-for-group
18993 @findex gnus-find-method-for-group
18994 A function that returns the select method for @var{group}.
18996 @item gnus-group-real-name
18997 @findex gnus-group-real-name
18998 Takes a full (prefixed) Gnus group name, and returns the unprefixed
19001 @item gnus-group-prefixed-name
19002 @findex gnus-group-prefixed-name
19003 Takes an unprefixed group name and a select method, and returns the full
19004 (prefixed) Gnus group name.
19006 @item gnus-get-info
19007 @findex gnus-get-info
19008 Returns the group info list for @var{group}.
19010 @item gnus-group-unread
19011 @findex gnus-group-unread
19012 The number of unread articles in @var{group}, or @code{t} if that is
19016 @findex gnus-active
19017 The active entry for @var{group}.
19019 @item gnus-set-active
19020 @findex gnus-set-active
19021 Set the active entry for @var{group}.
19023 @item gnus-add-current-to-buffer-list
19024 @findex gnus-add-current-to-buffer-list
19025 Adds the current buffer to the list of buffers to be killed on Gnus
19028 @item gnus-continuum-version
19029 @findex gnus-continuum-version
19030 Takes a Gnus version string as a parameter and returns a floating point
19031 number. Earlier versions will always get a lower number than later
19034 @item gnus-group-read-only-p
19035 @findex gnus-group-read-only-p
19036 Says whether @var{group} is read-only or not.
19038 @item gnus-news-group-p
19039 @findex gnus-news-group-p
19040 Says whether @var{group} came from a news backend.
19042 @item gnus-ephemeral-group-p
19043 @findex gnus-ephemeral-group-p
19044 Says whether @var{group} is ephemeral or not.
19046 @item gnus-server-to-method
19047 @findex gnus-server-to-method
19048 Returns the select method corresponding to @var{server}.
19050 @item gnus-server-equal
19051 @findex gnus-server-equal
19052 Says whether two virtual servers are equal.
19054 @item gnus-group-native-p
19055 @findex gnus-group-native-p
19056 Says whether @var{group} is native or not.
19058 @item gnus-group-secondary-p
19059 @findex gnus-group-secondary-p
19060 Says whether @var{group} is secondary or not.
19062 @item gnus-group-foreign-p
19063 @findex gnus-group-foreign-p
19064 Says whether @var{group} is foreign or not.
19066 @item group-group-find-parameter
19067 @findex group-group-find-parameter
19068 Returns the parameter list of @var{group}. If given a second parameter,
19069 returns the value of that parameter for @var{group}.
19071 @item gnus-group-set-parameter
19072 @findex gnus-group-set-parameter
19073 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
19075 @item gnus-narrow-to-body
19076 @findex gnus-narrow-to-body
19077 Narrows the current buffer to the body of the article.
19079 @item gnus-check-backend-function
19080 @findex gnus-check-backend-function
19081 Takes two parameters, @var{function} and @var{group}. If the backend
19082 @var{group} comes from supports @var{function}, return non-@code{nil}.
19085 (gnus-check-backend-function "request-scan" "nnml:misc")
19089 @item gnus-read-method
19090 @findex gnus-read-method
19091 Prompts the user for a select method.
19096 @node Backend Interface
19097 @subsection Backend Interface
19099 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
19100 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
19101 server is a @dfn{backend} and some @dfn{backend variables}. As examples
19102 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
19103 examples of the latter we have @code{nntp-port-number} and
19104 @code{nnmbox-directory}.
19106 When Gnus asks for information from a backend---say @code{nntp}---on
19107 something, it will normally include a virtual server name in the
19108 function parameters. (If not, the backend should use the ``current''
19109 virtual server.) For instance, @code{nntp-request-list} takes a virtual
19110 server as its only (optional) parameter. If this virtual server hasn't
19111 been opened, the function should fail.
19113 Note that a virtual server name has no relation to some physical server
19114 name. Take this example:
19118 (nntp-address "ifi.uio.no")
19119 (nntp-port-number 4324))
19122 Here the virtual server name is @samp{odd-one} while the name of
19123 the physical server is @samp{ifi.uio.no}.
19125 The backends should be able to switch between several virtual servers.
19126 The standard backends implement this by keeping an alist of virtual
19127 server environments that they pull down/push up when needed.
19129 There are two groups of interface functions: @dfn{required functions},
19130 which must be present, and @dfn{optional functions}, which Gnus will
19131 always check for presence before attempting to call 'em.
19133 All these functions are expected to return data in the buffer
19134 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
19135 unfortunately named, but we'll have to live with it. When I talk about
19136 @dfn{resulting data}, I always refer to the data in that buffer. When I
19137 talk about @dfn{return value}, I talk about the function value returned by
19138 the function call. Functions that fail should return @code{nil} as the
19141 Some backends could be said to be @dfn{server-forming} backends, and
19142 some might be said not to be. The latter are backends that generally
19143 only operate on one group at a time, and have no concept of ``server''
19144 -- they have a group, and they deliver info on that group and nothing
19147 In the examples and definitions I will refer to the imaginary backend
19150 @cindex @code{nnchoke}
19153 * Required Backend Functions:: Functions that must be implemented.
19154 * Optional Backend Functions:: Functions that need not be implemented.
19155 * Error Messaging:: How to get messages and report errors.
19156 * Writing New Backends:: Extending old backends.
19157 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
19158 * Mail-like Backends:: Some tips on mail backends.
19162 @node Required Backend Functions
19163 @subsubsection Required Backend Functions
19167 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
19169 @var{articles} is either a range of article numbers or a list of
19170 @code{Message-ID}s. Current backends do not fully support either---only
19171 sequences (lists) of article numbers, and most backends do not support
19172 retrieval of @code{Message-ID}s. But they should try for both.
19174 The result data should either be HEADs or NOV lines, and the result
19175 value should either be @code{headers} or @code{nov} to reflect this.
19176 This might later be expanded to @code{various}, which will be a mixture
19177 of HEADs and NOV lines, but this is currently not supported by Gnus.
19179 If @var{fetch-old} is non-@code{nil} it says to try fetching "extra
19180 headers", in some meaning of the word. This is generally done by
19181 fetching (at most) @var{fetch-old} extra headers less than the smallest
19182 article number in @code{articles}, and filling the gaps as well. The
19183 presence of this parameter can be ignored if the backend finds it
19184 cumbersome to follow the request. If this is non-@code{nil} and not a
19185 number, do maximum fetches.
19187 Here's an example HEAD:
19190 221 1056 Article retrieved.
19191 Path: ifi.uio.no!sturles
19192 From: sturles@@ifi.uio.no (Sturle Sunde)
19193 Newsgroups: ifi.discussion
19194 Subject: Re: Something very droll
19195 Date: 27 Oct 1994 14:02:57 +0100
19196 Organization: Dept. of Informatics, University of Oslo, Norway
19198 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
19199 References: <38jdmq$4qu@@visbur.ifi.uio.no>
19200 NNTP-Posting-Host: holmenkollen.ifi.uio.no
19204 So a @code{headers} return value would imply that there's a number of
19205 these in the data buffer.
19207 Here's a BNF definition of such a buffer:
19211 head = error / valid-head
19212 error-message = [ "4" / "5" ] 2number " " <error message> eol
19213 valid-head = valid-message *header "." eol
19214 valid-message = "221 " <number> " Article retrieved." eol
19215 header = <text> eol
19218 If the return value is @code{nov}, the data buffer should contain
19219 @dfn{network overview database} lines. These are basically fields
19223 nov-buffer = *nov-line
19224 nov-line = 8*9 [ field <TAB> ] eol
19225 field = <text except TAB>
19228 For a closer look at what should be in those fields,
19232 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
19234 @var{server} is here the virtual server name. @var{definitions} is a
19235 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
19237 If the server can't be opened, no error should be signaled. The backend
19238 may then choose to refuse further attempts at connecting to this
19239 server. In fact, it should do so.
19241 If the server is opened already, this function should return a
19242 non-@code{nil} value. There should be no data returned.
19245 @item (nnchoke-close-server &optional SERVER)
19247 Close connection to @var{server} and free all resources connected
19248 to it. Return @code{nil} if the server couldn't be closed for some
19251 There should be no data returned.
19254 @item (nnchoke-request-close)
19256 Close connection to all servers and free all resources that the backend
19257 have reserved. All buffers that have been created by that backend
19258 should be killed. (Not the @code{nntp-server-buffer}, though.) This
19259 function is generally only called when Gnus is shutting down.
19261 There should be no data returned.
19264 @item (nnchoke-server-opened &optional SERVER)
19266 If @var{server} is the current virtual server, and the connection to the
19267 physical server is alive, then this function should return a
19268 non-@code{nil} vlue. This function should under no circumstances
19269 attempt to reconnect to a server we have lost connection to.
19271 There should be no data returned.
19274 @item (nnchoke-status-message &optional SERVER)
19276 This function should return the last error message from @var{server}.
19278 There should be no data returned.
19281 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
19283 The result data from this function should be the article specified by
19284 @var{article}. This might either be a @code{Message-ID} or a number.
19285 It is optional whether to implement retrieval by @code{Message-ID}, but
19286 it would be nice if that were possible.
19288 If @var{to-buffer} is non-@code{nil}, the result data should be returned
19289 in this buffer instead of the normal data buffer. This is to make it
19290 possible to avoid copying large amounts of data from one buffer to
19291 another, while Gnus mainly requests articles to be inserted directly
19292 into its article buffer.
19294 If it is at all possible, this function should return a cons cell where
19295 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
19296 the article number. This will enable Gnus to find out what the real
19297 group and article numbers are when fetching articles by
19298 @code{Message-ID}. If this isn't possible, @code{t} should be returned
19299 on successful article retrieval.
19302 @item (nnchoke-request-group GROUP &optional SERVER FAST)
19304 Get data on @var{group}. This function also has the side effect of
19305 making @var{group} the current group.
19307 If @var{FAST}, don't bother to return useful data, just make @var{group}
19310 Here's an example of some result data and a definition of the same:
19313 211 56 1000 1059 ifi.discussion
19316 The first number is the status, which should be 211. Next is the
19317 total number of articles in the group, the lowest article number, the
19318 highest article number, and finally the group name. Note that the total
19319 number of articles may be less than one might think while just
19320 considering the highest and lowest article numbers, but some articles
19321 may have been canceled. Gnus just discards the total-number, so
19322 whether one should take the bother to generate it properly (if that is a
19323 problem) is left as an exercise to the reader.
19326 group-status = [ error / info ] eol
19327 error = [ "4" / "5" ] 2<number> " " <Error message>
19328 info = "211 " 3* [ <number> " " ] <string>
19332 @item (nnchoke-close-group GROUP &optional SERVER)
19334 Close @var{group} and free any resources connected to it. This will be
19335 a no-op on most backends.
19337 There should be no data returned.
19340 @item (nnchoke-request-list &optional SERVER)
19342 Return a list of all groups available on @var{server}. And that means
19345 Here's an example from a server that only carries two groups:
19348 ifi.test 0000002200 0000002000 y
19349 ifi.discussion 3324 3300 n
19352 On each line we have a group name, then the highest article number in
19353 that group, the lowest article number, and finally a flag.
19356 active-file = *active-line
19357 active-line = name " " <number> " " <number> " " flags eol
19359 flags = "n" / "y" / "m" / "x" / "j" / "=" name
19362 The flag says whether the group is read-only (@samp{n}), is moderated
19363 (@samp{m}), is dead (@samp{x}), is aliased to some other group
19364 (@samp{=other-group}) or none of the above (@samp{y}).
19367 @item (nnchoke-request-post &optional SERVER)
19369 This function should post the current buffer. It might return whether
19370 the posting was successful or not, but that's not required. If, for
19371 instance, the posting is done asynchronously, it has generally not been
19372 completed by the time this function concludes. In that case, this
19373 function should set up some kind of sentinel to beep the user loud and
19374 clear if the posting could not be completed.
19376 There should be no result data from this function.
19381 @node Optional Backend Functions
19382 @subsubsection Optional Backend Functions
19386 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
19388 @var{groups} is a list of groups, and this function should request data
19389 on all those groups. How it does it is of no concern to Gnus, but it
19390 should attempt to do this in a speedy fashion.
19392 The return value of this function can be either @code{active} or
19393 @code{group}, which says what the format of the result data is. The
19394 former is in the same format as the data from
19395 @code{nnchoke-request-list}, while the latter is a buffer full of lines
19396 in the same format as @code{nnchoke-request-group} gives.
19399 group-buffer = *active-line / *group-status
19403 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
19405 A Gnus group info (@pxref{Group Info}) is handed to the backend for
19406 alterations. This comes in handy if the backend really carries all the
19407 information (as is the case with virtual and imap groups). This
19408 function should destructively alter the info to suit its needs, and
19409 should return the (altered) group info.
19411 There should be no result data from this function.
19414 @item (nnchoke-request-type GROUP &optional ARTICLE)
19416 When the user issues commands for ``sending news'' (@kbd{F} in the
19417 summary buffer, for instance), Gnus has to know whether the article the
19418 user is following up on is news or mail. This function should return
19419 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
19420 is mail and @code{unknown} if the type can't be decided. (The
19421 @var{article} parameter is necessary in @code{nnvirtual} groups which
19422 might very well combine mail groups and news groups.) Both @var{group}
19423 and @var{article} may be @code{nil}.
19425 There should be no result data from this function.
19428 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
19430 Set/remove/add marks on articles. Normally Gnus handles the article
19431 marks (such as read, ticked, expired etc) internally, and store them in
19432 @code{~/.newsrc.eld}. Some backends (such as IMAP) however carry all
19433 information about the articles on the server, so Gnus need to propagate
19434 the mark information to the server.
19436 ACTION is a list of mark setting requests, having this format:
19439 (RANGE ACTION MARK)
19442 Range is a range of articles you wish to update marks on. Action is
19443 @code{set}, @code{add} or @code{del}, respectively used for removing all
19444 existing marks and setting them as specified, adding (preserving the
19445 marks not mentioned) mark and removing (preserving the marks not
19446 mentioned) marks. Mark is a list of marks; where each mark is a
19447 symbol. Currently used marks are @code{read}, @code{tick}, @code{reply},
19448 @code{expire}, @code{killed}, @code{dormant}, @code{save},
19449 @code{download} and @code{unsend}, but your backend should, if possible,
19450 not limit itself to theese.
19452 Given contradictory actions, the last action in the list should be the
19453 effective one. That is, if your action contains a request to add the
19454 @code{tick} mark on article 1 and, later in the list, a request to
19455 remove the mark on the same article, the mark should in fact be removed.
19457 An example action list:
19460 (((5 12 30) 'del '(tick))
19461 ((10 . 90) 'add '(read expire))
19462 ((92 94) 'del '(read)))
19465 The function should return a range of articles it wasn't able to set the
19466 mark on (currently not used for anything).
19468 There should be no result data from this function.
19470 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
19472 If the user tries to set a mark that the backend doesn't like, this
19473 function may change the mark. Gnus will use whatever this function
19474 returns as the mark for @var{article} instead of the original
19475 @var{mark}. If the backend doesn't care, it must return the original
19476 @var{mark}, and not @code{nil} or any other type of garbage.
19478 The only use for this I can see is what @code{nnvirtual} does with
19479 it---if a component group is auto-expirable, marking an article as read
19480 in the virtual group should result in the article being marked as
19483 There should be no result data from this function.
19486 @item (nnchoke-request-scan &optional GROUP SERVER)
19488 This function may be called at any time (by Gnus or anything else) to
19489 request that the backend check for incoming articles, in one way or
19490 another. A mail backend will typically read the spool file or query the
19491 POP server when this function is invoked. The @var{group} doesn't have
19492 to be heeded---if the backend decides that it is too much work just
19493 scanning for a single group, it may do a total scan of all groups. It
19494 would be nice, however, to keep things local if that's practical.
19496 There should be no result data from this function.
19499 @item (nnchoke-request-group-description GROUP &optional SERVER)
19501 The result data from this function should be a description of
19505 description-line = name <TAB> description eol
19507 description = <text>
19510 @item (nnchoke-request-list-newsgroups &optional SERVER)
19512 The result data from this function should be the description of all
19513 groups available on the server.
19516 description-buffer = *description-line
19520 @item (nnchoke-request-newgroups DATE &optional SERVER)
19522 The result data from this function should be all groups that were
19523 created after @samp{date}, which is in normal human-readable date
19524 format. The data should be in the active buffer format.
19527 @item (nnchoke-request-create-group GROUP &optional SERVER)
19529 This function should create an empty group with name @var{group}.
19531 There should be no return data.
19534 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
19536 This function should run the expiry process on all articles in the
19537 @var{articles} range (which is currently a simple list of article
19538 numbers.) It is left up to the backend to decide how old articles
19539 should be before they are removed by this function. If @var{force} is
19540 non-@code{nil}, all @var{articles} should be deleted, no matter how new
19543 This function should return a list of articles that it did not/was not
19546 There should be no result data returned.
19549 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
19552 This function should move @var{article} (which is a number) from
19553 @var{group} by calling @var{accept-form}.
19555 This function should ready the article in question for moving by
19556 removing any header lines it has added to the article, and generally
19557 should ``tidy up'' the article. Then it should @code{eval}
19558 @var{accept-form} in the buffer where the ``tidy'' article is. This
19559 will do the actual copying. If this @code{eval} returns a
19560 non-@code{nil} value, the article should be removed.
19562 If @var{last} is @code{nil}, that means that there is a high likelihood
19563 that there will be more requests issued shortly, so that allows some
19566 The function should return a cons where the @code{car} is the group name and
19567 the @code{cdr} is the article number that the article was entered as.
19569 There should be no data returned.
19572 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
19574 This function takes the current buffer and inserts it into @var{group}.
19575 If @var{last} in @code{nil}, that means that there will be more calls to
19576 this function in short order.
19578 The function should return a cons where the @code{car} is the group name and
19579 the @code{cdr} is the article number that the article was entered as.
19581 There should be no data returned.
19584 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
19586 This function should remove @var{article} (which is a number) from
19587 @var{group} and insert @var{buffer} there instead.
19589 There should be no data returned.
19592 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
19594 This function should delete @var{group}. If @var{force}, it should
19595 really delete all the articles in the group, and then delete the group
19596 itself. (If there is such a thing as ``the group itself''.)
19598 There should be no data returned.
19601 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
19603 This function should rename @var{group} into @var{new-name}. All
19604 articles in @var{group} should move to @var{new-name}.
19606 There should be no data returned.
19611 @node Error Messaging
19612 @subsubsection Error Messaging
19614 @findex nnheader-report
19615 @findex nnheader-get-report
19616 The backends should use the function @code{nnheader-report} to report
19617 error conditions---they should not raise errors when they aren't able to
19618 perform a request. The first argument to this function is the backend
19619 symbol, and the rest are interpreted as arguments to @code{format} if
19620 there are multiple of them, or just a string if there is one of them.
19621 This function must always returns @code{nil}.
19624 (nnheader-report 'nnchoke "You did something totally bogus")
19626 (nnheader-report 'nnchoke "Could not request group %s" group)
19629 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
19630 @code{nil} back from a server, and this function returns the most
19631 recently reported message for the backend in question. This function
19632 takes one argument---the server symbol.
19634 Internally, these functions access @var{backend}@code{-status-string},
19635 so the @code{nnchoke} backend will have its error message stored in
19636 @code{nnchoke-status-string}.
19639 @node Writing New Backends
19640 @subsubsection Writing New Backends
19642 Many backends are quite similar. @code{nnml} is just like
19643 @code{nnspool}, but it allows you to edit the articles on the server.
19644 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
19645 and it doesn't maintain overview databases. @code{nndir} is just like
19646 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
19649 It would make sense if it were possible to ``inherit'' functions from
19650 backends when writing new backends. And, indeed, you can do that if you
19651 want to. (You don't have to if you don't want to, of course.)
19653 All the backends declare their public variables and functions by using a
19654 package called @code{nnoo}.
19656 To inherit functions from other backends (and allow other backends to
19657 inherit functions from the current backend), you should use the
19663 This macro declares the first parameter to be a child of the subsequent
19664 parameters. For instance:
19667 (nnoo-declare nndir
19671 @code{nndir} has declared here that it intends to inherit functions from
19672 both @code{nnml} and @code{nnmh}.
19675 This macro is equivalent to @code{defvar}, but registers the variable as
19676 a public server variable. Most state-oriented variables should be
19677 declared with @code{defvoo} instead of @code{defvar}.
19679 In addition to the normal @code{defvar} parameters, it takes a list of
19680 variables in the parent backends to map the variable to when executing
19681 a function in those backends.
19684 (defvoo nndir-directory nil
19685 "Where nndir will look for groups."
19686 nnml-current-directory nnmh-current-directory)
19689 This means that @code{nnml-current-directory} will be set to
19690 @code{nndir-directory} when an @code{nnml} function is called on behalf
19691 of @code{nndir}. (The same with @code{nnmh}.)
19693 @item nnoo-define-basics
19694 This macro defines some common functions that almost all backends should
19698 (nnoo-define-basics nndir)
19702 This macro is just like @code{defun} and takes the same parameters. In
19703 addition to doing the normal @code{defun} things, it registers the
19704 function as being public so that other backends can inherit it.
19706 @item nnoo-map-functions
19707 This macro allows mapping of functions from the current backend to
19708 functions from the parent backends.
19711 (nnoo-map-functions nndir
19712 (nnml-retrieve-headers 0 nndir-current-group 0 0)
19713 (nnmh-request-article 0 nndir-current-group 0 0))
19716 This means that when @code{nndir-retrieve-headers} is called, the first,
19717 third, and fourth parameters will be passed on to
19718 @code{nnml-retrieve-headers}, while the second parameter is set to the
19719 value of @code{nndir-current-group}.
19722 This macro allows importing functions from backends. It should be the
19723 last thing in the source file, since it will only define functions that
19724 haven't already been defined.
19730 nnmh-request-newgroups)
19734 This means that calls to @code{nndir-request-list} should just be passed
19735 on to @code{nnmh-request-list}, while all public functions from
19736 @code{nnml} that haven't been defined in @code{nndir} yet should be
19741 Below is a slightly shortened version of the @code{nndir} backend.
19744 ;;; nndir.el --- single directory newsgroup access for Gnus
19745 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
19749 (require 'nnheader)
19753 (eval-when-compile (require 'cl))
19755 (nnoo-declare nndir
19758 (defvoo nndir-directory nil
19759 "Where nndir will look for groups."
19760 nnml-current-directory nnmh-current-directory)
19762 (defvoo nndir-nov-is-evil nil
19763 "*Non-nil means that nndir will never retrieve NOV headers."
19766 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
19767 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
19768 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
19770 (defvoo nndir-status-string "" nil nnmh-status-string)
19771 (defconst nndir-version "nndir 1.0")
19773 ;;; Interface functions.
19775 (nnoo-define-basics nndir)
19777 (deffoo nndir-open-server (server &optional defs)
19778 (setq nndir-directory
19779 (or (cadr (assq 'nndir-directory defs))
19781 (unless (assq 'nndir-directory defs)
19782 (push `(nndir-directory ,server) defs))
19783 (push `(nndir-current-group
19784 ,(file-name-nondirectory (directory-file-name nndir-directory)))
19786 (push `(nndir-top-directory
19787 ,(file-name-directory (directory-file-name nndir-directory)))
19789 (nnoo-change-server 'nndir server defs))
19791 (nnoo-map-functions nndir
19792 (nnml-retrieve-headers 0 nndir-current-group 0 0)
19793 (nnmh-request-article 0 nndir-current-group 0 0)
19794 (nnmh-request-group nndir-current-group 0 0)
19795 (nnmh-close-group nndir-current-group 0))
19799 nnmh-status-message
19801 nnmh-request-newgroups))
19807 @node Hooking New Backends Into Gnus
19808 @subsubsection Hooking New Backends Into Gnus
19810 @vindex gnus-valid-select-methods
19811 Having Gnus start using your new backend is rather easy---you just
19812 declare it with the @code{gnus-declare-backend} functions. This will
19813 enter the backend into the @code{gnus-valid-select-methods} variable.
19815 @code{gnus-declare-backend} takes two parameters---the backend name and
19816 an arbitrary number of @dfn{abilities}.
19821 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
19824 The abilities can be:
19828 This is a mailish backend---followups should (probably) go via mail.
19830 This is a newsish backend---followups should (probably) go via news.
19832 This backend supports both mail and news.
19834 This is neither a post nor mail backend---it's something completely
19837 It supports respooling---or rather, it is able to modify its source
19838 articles and groups.
19840 The name of the server should be in the virtual server name. This is
19841 true for almost all backends.
19842 @item prompt-address
19843 The user should be prompted for an address when doing commands like
19844 @kbd{B} in the group buffer. This is true for backends like
19845 @code{nntp}, but not @code{nnmbox}, for instance.
19849 @node Mail-like Backends
19850 @subsubsection Mail-like Backends
19852 One of the things that separate the mail backends from the rest of the
19853 backends is the heavy dependence by the mail backends on common
19854 functions in @file{nnmail.el}. For instance, here's the definition of
19855 @code{nnml-request-scan}:
19858 (deffoo nnml-request-scan (&optional group server)
19859 (setq nnml-article-file-alist nil)
19860 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
19863 It simply calls @code{nnmail-get-new-mail} with a few parameters,
19864 and @code{nnmail} takes care of all the moving and splitting of the
19867 This function takes four parameters.
19871 This should be a symbol to designate which backend is responsible for
19874 @item exit-function
19875 This function should be called after the splitting has been performed.
19877 @item temp-directory
19878 Where the temporary files should be stored.
19881 This optional argument should be a group name if the splitting is to be
19882 performed for one group only.
19885 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
19886 save each article. @var{backend}@code{-active-number} will be called to
19887 find the article number assigned to this article.
19889 The function also uses the following variables:
19890 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
19891 this backend); and @var{backend}@code{-group-alist} and
19892 @var{backend}@code{-active-file} to generate the new active file.
19893 @var{backend}@code{-group-alist} should be a group-active alist, like
19897 (("a-group" (1 . 10))
19898 ("some-group" (34 . 39)))
19902 @node Score File Syntax
19903 @subsection Score File Syntax
19905 Score files are meant to be easily parseable, but yet extremely
19906 mallable. It was decided that something that had the same read syntax
19907 as an Emacs Lisp list would fit that spec.
19909 Here's a typical score file:
19913 ("win95" -10000 nil s)
19920 BNF definition of a score file:
19923 score-file = "" / "(" *element ")"
19924 element = rule / atom
19925 rule = string-rule / number-rule / date-rule
19926 string-rule = "(" quote string-header quote space *string-match ")"
19927 number-rule = "(" quote number-header quote space *number-match ")"
19928 date-rule = "(" quote date-header quote space *date-match ")"
19930 string-header = "subject" / "from" / "references" / "message-id" /
19931 "xref" / "body" / "head" / "all" / "followup"
19932 number-header = "lines" / "chars"
19933 date-header = "date"
19934 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
19935 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
19936 score = "nil" / <integer>
19937 date = "nil" / <natural number>
19938 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
19939 "r" / "regex" / "R" / "Regex" /
19940 "e" / "exact" / "E" / "Exact" /
19941 "f" / "fuzzy" / "F" / "Fuzzy"
19942 number-match = "(" <integer> [ "" / [ space score [ "" /
19943 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
19944 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
19945 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
19946 space date [ "" / [ space date-match-t ] ] ] ] ")"
19947 date-match-t = "nil" / "at" / "before" / "after"
19948 atom = "(" [ required-atom / optional-atom ] ")"
19949 required-atom = mark / expunge / mark-and-expunge / files /
19950 exclude-files / read-only / touched
19951 optional-atom = adapt / local / eval
19952 mark = "mark" space nil-or-number
19953 nil-or-number = "nil" / <integer>
19954 expunge = "expunge" space nil-or-number
19955 mark-and-expunge = "mark-and-expunge" space nil-or-number
19956 files = "files" *[ space <string> ]
19957 exclude-files = "exclude-files" *[ space <string> ]
19958 read-only = "read-only" [ space "nil" / space "t" ]
19959 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
19960 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
19961 local = "local" *[ space "(" <string> space <form> ")" ]
19962 eval = "eval" space <form>
19963 space = *[ " " / <TAB> / <NEWLINE> ]
19966 Any unrecognized elements in a score file should be ignored, but not
19969 As you can see, white space is needed, but the type and amount of white
19970 space is irrelevant. This means that formatting of the score file is
19971 left up to the programmer---if it's simpler to just spew it all out on
19972 one looong line, then that's ok.
19974 The meaning of the various atoms are explained elsewhere in this
19975 manual (@pxref{Score File Format}).
19979 @subsection Headers
19981 Internally Gnus uses a format for storing article headers that
19982 corresponds to the @sc{nov} format in a mysterious fashion. One could
19983 almost suspect that the author looked at the @sc{nov} specification and
19984 just shamelessly @emph{stole} the entire thing, and one would be right.
19986 @dfn{Header} is a severely overloaded term. ``Header'' is used in
19987 RFC1036 to talk about lines in the head of an article (e.g.,
19988 @code{From}). It is used by many people as a synonym for
19989 ``head''---``the header and the body''. (That should be avoided, in my
19990 opinion.) And Gnus uses a format internally that it calls ``header'',
19991 which is what I'm talking about here. This is a 9-element vector,
19992 basically, with each header (ouch) having one slot.
19994 These slots are, in order: @code{number}, @code{subject}, @code{from},
19995 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
19996 @code{xref}, and @code{extra}. There are macros for accessing and
19997 setting these slots---they all have predictable names beginning with
19998 @code{mail-header-} and @code{mail-header-set-}, respectively.
20000 All these slots contain strings, except the @code{extra} slot, which
20001 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
20007 @sc{gnus} introduced a concept that I found so useful that I've started
20008 using it a lot and have elaborated on it greatly.
20010 The question is simple: If you have a large amount of objects that are
20011 identified by numbers (say, articles, to take a @emph{wild} example)
20012 that you want to qualify as being ``included'', a normal sequence isn't
20013 very useful. (A 200,000 length sequence is a bit long-winded.)
20015 The solution is as simple as the question: You just collapse the
20019 (1 2 3 4 5 6 10 11 12)
20022 is transformed into
20025 ((1 . 6) (10 . 12))
20028 To avoid having those nasty @samp{(13 . 13)} elements to denote a
20029 lonesome object, a @samp{13} is a valid element:
20032 ((1 . 6) 7 (10 . 12))
20035 This means that comparing two ranges to find out whether they are equal
20036 is slightly tricky:
20039 ((1 . 5) 7 8 (10 . 12))
20045 ((1 . 5) (7 . 8) (10 . 12))
20048 are equal. In fact, any non-descending list is a range:
20054 is a perfectly valid range, although a pretty long-winded one. This is
20061 and is equal to the previous range.
20063 Here's a BNF definition of ranges. Of course, one must remember the
20064 semantic requirement that the numbers are non-descending. (Any number
20065 of repetition of the same number is allowed, but apt to disappear in
20069 range = simple-range / normal-range
20070 simple-range = "(" number " . " number ")"
20071 normal-range = "(" start-contents ")"
20072 contents = "" / simple-range *[ " " contents ] /
20073 number *[ " " contents ]
20076 Gnus currently uses ranges to keep track of read articles and article
20077 marks. I plan on implementing a number of range operators in C if The
20078 Powers That Be are willing to let me. (I haven't asked yet, because I
20079 need to do some more thinking on what operators I need to make life
20080 totally range-based without ever having to convert back to normal
20085 @subsection Group Info
20087 Gnus stores all permanent info on groups in a @dfn{group info} list.
20088 This list is from three to six elements (or more) long and exhaustively
20089 describes the group.
20091 Here are two example group infos; one is a very simple group while the
20092 second is a more complex one:
20095 ("no.group" 5 ((1 . 54324)))
20097 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
20098 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
20100 ((auto-expire . t) (to-address . "ding@@gnus.org")))
20103 The first element is the @dfn{group name}---as Gnus knows the group,
20104 anyway. The second element is the @dfn{subscription level}, which
20105 normally is a small integer. (It can also be the @dfn{rank}, which is a
20106 cons cell where the @code{car} is the level and the @code{cdr} is the
20107 score.) The third element is a list of ranges of read articles. The
20108 fourth element is a list of lists of article marks of various kinds.
20109 The fifth element is the select method (or virtual server, if you like).
20110 The sixth element is a list of @dfn{group parameters}, which is what
20111 this section is about.
20113 Any of the last three elements may be missing if they are not required.
20114 In fact, the vast majority of groups will normally only have the first
20115 three elements, which saves quite a lot of cons cells.
20117 Here's a BNF definition of the group info format:
20120 info = "(" group space ralevel space read
20121 [ "" / [ space marks-list [ "" / [ space method [ "" /
20122 space parameters ] ] ] ] ] ")"
20123 group = quote <string> quote
20124 ralevel = rank / level
20125 level = <integer in the range of 1 to inf>
20126 rank = "(" level "." score ")"
20127 score = <integer in the range of 1 to inf>
20129 marks-lists = nil / "(" *marks ")"
20130 marks = "(" <string> range ")"
20131 method = "(" <string> *elisp-forms ")"
20132 parameters = "(" *elisp-forms ")"
20135 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
20136 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
20139 If you have a Gnus info and want to access the elements, Gnus offers a
20140 series of macros for getting/setting these elements.
20143 @item gnus-info-group
20144 @itemx gnus-info-set-group
20145 @findex gnus-info-group
20146 @findex gnus-info-set-group
20147 Get/set the group name.
20149 @item gnus-info-rank
20150 @itemx gnus-info-set-rank
20151 @findex gnus-info-rank
20152 @findex gnus-info-set-rank
20153 Get/set the group rank (@pxref{Group Score}).
20155 @item gnus-info-level
20156 @itemx gnus-info-set-level
20157 @findex gnus-info-level
20158 @findex gnus-info-set-level
20159 Get/set the group level.
20161 @item gnus-info-score
20162 @itemx gnus-info-set-score
20163 @findex gnus-info-score
20164 @findex gnus-info-set-score
20165 Get/set the group score (@pxref{Group Score}).
20167 @item gnus-info-read
20168 @itemx gnus-info-set-read
20169 @findex gnus-info-read
20170 @findex gnus-info-set-read
20171 Get/set the ranges of read articles.
20173 @item gnus-info-marks
20174 @itemx gnus-info-set-marks
20175 @findex gnus-info-marks
20176 @findex gnus-info-set-marks
20177 Get/set the lists of ranges of marked articles.
20179 @item gnus-info-method
20180 @itemx gnus-info-set-method
20181 @findex gnus-info-method
20182 @findex gnus-info-set-method
20183 Get/set the group select method.
20185 @item gnus-info-params
20186 @itemx gnus-info-set-params
20187 @findex gnus-info-params
20188 @findex gnus-info-set-params
20189 Get/set the group parameters.
20192 All the getter functions take one parameter---the info list. The setter
20193 functions take two parameters---the info list and the new value.
20195 The last three elements in the group info aren't mandatory, so it may be
20196 necessary to extend the group info before setting the element. If this
20197 is necessary, you can just pass on a non-@code{nil} third parameter to
20198 the three final setter functions to have this happen automatically.
20201 @node Extended Interactive
20202 @subsection Extended Interactive
20203 @cindex interactive
20204 @findex gnus-interactive
20206 Gnus extends the standard Emacs @code{interactive} specification
20207 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
20208 Prefixes}). Here's an example of how this is used:
20211 (defun gnus-summary-increase-score (&optional score symp)
20212 (interactive (gnus-interactive "P\ny"))
20217 The best thing to do would have been to implement
20218 @code{gnus-interactive} as a macro which would have returned an
20219 @code{interactive} form, but this isn't possible since Emacs checks
20220 whether a function is interactive or not by simply doing an @code{assq}
20221 on the lambda form. So, instead we have @code{gnus-interactive}
20222 function that takes a string and returns values that are usable to
20223 @code{interactive}.
20225 This function accepts (almost) all normal @code{interactive} specs, but
20230 @vindex gnus-current-prefix-symbol
20231 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
20235 @vindex gnus-current-prefix-symbols
20236 A list of the current symbolic prefixes---the
20237 @code{gnus-current-prefix-symbol} variable.
20240 The current article number---the @code{gnus-summary-article-number}
20244 The current article header---the @code{gnus-summary-article-header}
20248 The current group name---the @code{gnus-group-group-name}
20254 @node Emacs/XEmacs Code
20255 @subsection Emacs/XEmacs Code
20259 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
20260 platforms must be the primary one. I chose Emacs. Not because I don't
20261 like XEmacs or Mule, but because it comes first alphabetically.
20263 This means that Gnus will byte-compile under Emacs with nary a warning,
20264 while XEmacs will pump out gigabytes of warnings while byte-compiling.
20265 As I use byte-compilation warnings to help me root out trivial errors in
20266 Gnus, that's very useful.
20268 I've also consistently used Emacs function interfaces, but have used
20269 Gnusey aliases for the functions. To take an example: Emacs defines a
20270 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
20271 function. I then define a function called @code{gnus-run-at-time} that
20272 takes the same parameters as the Emacs @code{run-at-time}. When running
20273 Gnus under Emacs, the former function is just an alias for the latter.
20274 However, when running under XEmacs, the former is an alias for the
20275 following function:
20278 (defun gnus-xmas-run-at-time (time repeat function &rest args)
20282 (,function ,@@args))
20286 This sort of thing has been done for bunches of functions. Gnus does
20287 not redefine any native Emacs functions while running under XEmacs---it
20288 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
20291 In the cases where the XEmacs function interface was obviously cleaner,
20292 I used it instead. For example @code{gnus-region-active-p} is an alias
20293 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
20295 Of course, I could have chosen XEmacs as my native platform and done
20296 mapping functions the other way around. But I didn't. The performance
20297 hit these indirections impose on Gnus under XEmacs should be slight.
20300 @node Various File Formats
20301 @subsection Various File Formats
20304 * Active File Format:: Information on articles and groups available.
20305 * Newsgroups File Format:: Group descriptions.
20309 @node Active File Format
20310 @subsubsection Active File Format
20312 The active file lists all groups available on the server in
20313 question. It also lists the highest and lowest current article numbers
20316 Here's an excerpt from a typical active file:
20319 soc.motss 296030 293865 y
20320 alt.binaries.pictures.fractals 3922 3913 n
20321 comp.sources.unix 1605 1593 m
20322 comp.binaries.ibm.pc 5097 5089 y
20323 no.general 1000 900 y
20326 Here's a pseudo-BNF definition of this file:
20329 active = *group-line
20330 group-line = group space high-number space low-number space flag <NEWLINE>
20331 group = <non-white-space string>
20333 high-number = <non-negative integer>
20334 low-number = <positive integer>
20335 flag = "y" / "n" / "m" / "j" / "x" / "=" group
20338 For a full description of this file, see the manual pages for
20339 @samp{innd}, in particular @samp{active(5)}.
20342 @node Newsgroups File Format
20343 @subsubsection Newsgroups File Format
20345 The newsgroups file lists groups along with their descriptions. Not all
20346 groups on the server have to be listed, and not all groups in the file
20347 have to exist on the server. The file is meant purely as information to
20350 The format is quite simple; a group name, a tab, and the description.
20351 Here's the definition:
20355 line = group tab description <NEWLINE>
20356 group = <non-white-space string>
20358 description = <string>
20363 @node Emacs for Heathens
20364 @section Emacs for Heathens
20366 Believe it or not, but some people who use Gnus haven't really used
20367 Emacs much before they embarked on their journey on the Gnus Love Boat.
20368 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
20369 region'', and ``set @code{gnus-flargblossen} to an alist where the key
20370 is a regexp that is used for matching on the group name'' are magical
20371 phrases with little or no meaning, then this appendix is for you. If
20372 you are already familiar with Emacs, just ignore this and go fondle your
20376 * Keystrokes:: Entering text and executing commands.
20377 * Emacs Lisp:: The built-in Emacs programming language.
20382 @subsection Keystrokes
20386 Q: What is an experienced Emacs user?
20389 A: A person who wishes that the terminal had pedals.
20392 Yes, when you use Emacs, you are apt to use the control key, the shift
20393 key and the meta key a lot. This is very annoying to some people
20394 (notably @code{vi}le users), and the rest of us just love the hell out
20395 of it. Just give up and submit. Emacs really does stand for
20396 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
20397 may have heard from other disreputable sources (like the Emacs author).
20399 The shift keys are normally located near your pinky fingers, and are
20400 normally used to get capital letters and stuff. You probably use it all
20401 the time. The control key is normally marked ``CTRL'' or something like
20402 that. The meta key is, funnily enough, never marked as such on any
20403 keyboard. The one I'm currently at has a key that's marked ``Alt'',
20404 which is the meta key on this keyboard. It's usually located somewhere
20405 to the left hand side of the keyboard, usually on the bottom row.
20407 Now, us Emacs people don't say ``press the meta-control-m key'',
20408 because that's just too inconvenient. We say ``press the @kbd{M-C-m}
20409 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
20410 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
20411 down the control key, and hold it down while you press @kbd{k}''.
20412 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
20413 the control key and then press @kbd{k}''. Simple, ay?
20415 This is somewhat complicated by the fact that not all keyboards have a
20416 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
20417 means ``press escape, release escape, press @kbd{k}''. That's much more
20418 work than if you have a meta key, so if that's the case, I respectfully
20419 suggest you get a real keyboard with a meta key. You can't live without
20425 @subsection Emacs Lisp
20427 Emacs is the King of Editors because it's really a Lisp interpreter.
20428 Each and every key you tap runs some Emacs Lisp code snippet, and since
20429 Emacs Lisp is an interpreted language, that means that you can configure
20430 any key to run any arbitrary code. You just, like, do it.
20432 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
20433 functions. (These are byte-compiled for speed, but it's still
20434 interpreted.) If you decide that you don't like the way Gnus does
20435 certain things, it's trivial to have it do something a different way.
20436 (Well, at least if you know how to write Lisp code.) However, that's
20437 beyond the scope of this manual, so we are simply going to talk about
20438 some common constructs that you normally use in your @file{.emacs} file
20441 If you want to set the variable @code{gnus-florgbnize} to four (4), you
20442 write the following:
20445 (setq gnus-florgbnize 4)
20448 This function (really ``special form'') @code{setq} is the one that can
20449 set a variable to some value. This is really all you need to know. Now
20450 you can go and fill your @code{.emacs} file with lots of these to change
20453 If you have put that thing in your @code{.emacs} file, it will be read
20454 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
20455 start Emacs. If you want to change the variable right away, simply say
20456 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
20457 previous ``form'', which is a simple @code{setq} statement here.
20459 Go ahead---just try it, if you're located at your Emacs. After you
20460 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
20461 is the return value of the form you @code{eval}ed.
20465 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
20469 (setq gnus-read-active-file 'some)
20472 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
20473 @samp{nntp.ifi.uio.no}'', that means:
20476 (setq gnus-nntp-server "nntp.ifi.uio.no")
20479 So be careful not to mix up strings (the latter) with symbols (the
20480 former). The manual is unambiguous, but it can be confusing.
20483 @include gnus-faq.texi