1 \input texinfo @c -*-texinfo-*-
4 @settitle Gnus 5.4.57 Manual
11 @setchapternewpage odd
15 \documentclass[twoside,a4paper,openright,11pt]{book}
16 \usepackage[latin1]{inputenc}
17 \usepackage{pagestyle}
24 \newcommand{\gnuschaptername}{}
25 \newcommand{\gnussectionname}{}
27 \newcommand{\gnusbackslash}{/}
29 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
30 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
32 \newcommand{\gnuskindex}[1]{\index{#1}}
33 \newcommand{\gnusindex}[1]{\index{#1}}
35 \newcommand{\gnustt}[1]{{\fontfamily{pfu}\fontsize{10pt}{10}\selectfont #1}}
36 \newcommand{\gnuscode}[1]{\gnustt{#1}}
37 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\fontfamily{pcr}\fontsize{10pt}{10}\selectfont #1}''}
38 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
39 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
40 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
41 \newcommand{\gnusdfn}[1]{\textit{#1}}
42 \newcommand{\gnusi}[1]{\textit{#1}}
43 \newcommand{\gnusstrong}[1]{\textbf{#1}}
44 \newcommand{\gnusemph}[1]{\textit{#1}}
45 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
46 \newcommand{\gnussc}[1]{\textsc{#1}}
47 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
48 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
50 \newcommand{\gnusbullet}{{${\bullet}$}}
51 \newcommand{\gnusdollar}{\$}
52 \newcommand{\gnusampersand}{\&}
53 \newcommand{\gnuspercent}{\%}
54 \newcommand{\gnushash}{\#}
55 \newcommand{\gnushat}{\symbol{"5E}}
56 \newcommand{\gnusunderline}{\symbol{"5F}}
57 \newcommand{\gnusnot}{$\neg$}
58 \newcommand{\gnustilde}{\symbol{"7E}}
59 \newcommand{\gnusless}{{$<$}}
60 \newcommand{\gnusgreater}{{$>$}}
62 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=gnus-head.eps,height=1cm}}}
63 \newcommand{\gnusinteresting}{
64 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
67 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
69 \newcommand{\gnuspagechapter}[1]{
76 \newcommand{\gnuschapter}[2]{
78 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
80 \renewcommand{\gnussectionname}{}
81 \renewcommand{\gnuschaptername}{#2}
84 \begin{picture}(500,500)(0,0)
85 \put(480,350){\makebox(0,0)[tr]{#1}}
86 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
91 \newcommand{\gnusfigure}[3]{
93 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
100 \newcommand{\gnusicon}[1]{
101 \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}}}
104 \newcommand{\gnuspicon}[1]{
105 \marginpar[\mbox{}\hfill\epsfig{figure=#1,height=1.5cm}]{\epsfig{figure=#1,height=1.5cm}}
108 \newcommand{\gnusxface}[1]{
109 \marginpar[\mbox{}\hfill\epsfig{figure=#1,height=1cm}]{\epsfig{figure=#1,height=1cm}}
113 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
115 \newcommand{\gnussection}[1]{
116 \renewcommand{\gnussectionname}{#1}
120 \newenvironment{codelist}%
125 \newenvironment{kbdlist}%
131 \newenvironment{dfnlist}%
136 \newenvironment{stronglist}%
141 \newenvironment{samplist}%
146 \newenvironment{varlist}%
151 \newenvironment{emphlist}%
156 \newlength\gnusheadtextwidth
157 \setlength{\gnusheadtextwidth}{\headtextwidth}
158 \addtolength{\gnusheadtextwidth}{1cm}
160 \newpagestyle{gnuspreamble}%
165 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
169 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
178 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
180 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
185 \newpagestyle{gnusindex}%
190 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
194 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
202 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
204 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
214 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
218 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
226 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
228 \raisebox{-0.5cm}{\epsfig{figure=gnus-big-logo.eps,height=1cm}}
233 \pagenumbering{roman}
234 \pagestyle{gnuspreamble}
244 %\addtolength{\oddsidemargin}{-5cm}
245 %\addtolength{\evensidemargin}{-5cm}
247 \addtolength{\textheight}{2cm}
249 \gnustitle{\gnustitlename}\\
252 \hspace*{0cm}\epsfig{figure=gnus-big-logo.eps,height=15cm}
255 \gnusauthor{by Lars Magne Ingebrigtsen}
262 \thispagestyle{empty}
264 Copyright \copyright{} 1995,96 Free Software Foundation, Inc.
266 Permission is granted to make and distribute verbatim copies of
267 this manual provided the copyright notice and this permission notice
268 are preserved on all copies.
270 Permission is granted to copy and distribute modified versions of this
271 manual under the conditions for verbatim copying, provided that the
272 entire resulting derived work is distributed under the terms of a
273 permission notice identical to this one.
275 Permission is granted to copy and distribute translations of this manual
276 into another language, under the above conditions for modified versions.
285 This file documents Gnus, the GNU Emacs newsreader.
287 Copyright (C) 1995,96 Free Software Foundation, Inc.
289 Permission is granted to make and distribute verbatim copies of
290 this manual provided the copyright notice and this permission notice
291 are preserved on all copies.
294 Permission is granted to process this file through Tex and print the
295 results, provided the printed document carries copying permission
296 notice identical to this one except for the removal of this paragraph
297 (this paragraph not being relevant to the printed manual).
300 Permission is granted to copy and distribute modified versions of this
301 manual under the conditions for verbatim copying, provided also that the
302 entire resulting derived work is distributed under the terms of a
303 permission notice identical to this one.
305 Permission is granted to copy and distribute translations of this manual
306 into another language, under the above conditions for modified versions.
312 @title Gnus 5.4.57 Manual
314 @author by Lars Magne Ingebrigtsen
317 @vskip 0pt plus 1filll
318 Copyright @copyright{} 1995,96,97 Free Software Foundation, Inc.
320 Permission is granted to make and distribute verbatim copies of
321 this manual provided the copyright notice and this permission notice
322 are preserved on all copies.
324 Permission is granted to copy and distribute modified versions of this
325 manual under the conditions for verbatim copying, provided that the
326 entire resulting derived work is distributed under the terms of a
327 permission notice identical to this one.
329 Permission is granted to copy and distribute translations of this manual
330 into another language, under the above conditions for modified versions.
339 @top The Gnus Newsreader
343 You can read news (and mail) from within Emacs by using Gnus. The news
344 can be gotten by any nefarious means you can think of---@sc{nntp}, local
345 spool or your mbox file. All at the same time, if you want to push your
348 This manual corresponds to Gnus 5.4.57.
359 Gnus is the advanced, self-documenting, customizable, extensible
360 unreal-time newsreader for GNU Emacs.
362 Oops. That sounds oddly familiar, so let's start over again to avoid
363 being accused of plagiarism:
365 Gnus is a message-reading laboratory. It will let you look at just
366 about anything as if it were a newsgroup. You can read mail with it,
367 you can browse directories with it, you can @code{ftp} with it---you can
368 even read news with it!
370 Gnus tries to empower people who read news the same way Emacs empowers
371 people who edit text. Gnus sets no limits to what the user should be
372 allowed to do. Users are encouraged to extend Gnus to make it behave
373 like they want it to behave. A program should not control people;
374 people should be empowered to do what they want by using (or abusing)
381 * Starting Up:: Finding news can be a pain.
382 * The Group Buffer:: Selecting, subscribing and killing groups.
383 * The Summary Buffer:: Reading, saving and posting articles.
384 * The Article Buffer:: Displaying and handling articles.
385 * Composing Messages:: Information on sending mail and news.
386 * Select Methods:: Gnus reads all messages from various select methods.
387 * Scoring:: Assigning values to articles.
388 * Various:: General purpose settings.
389 * The End:: Farewell and goodbye.
390 * Appendices:: Terminology, Emacs intro, FAQ, History, Internals.
391 * Index:: Variable, function and concept index.
392 * Key Index:: Key Index.
396 @chapter Starting Gnus
401 If your system administrator has set things up properly, starting Gnus
402 and reading news is extremely easy---you just type @kbd{M-x gnus} in
405 @findex gnus-other-frame
406 @kindex M-x gnus-other-frame
407 If you want to start Gnus in a different frame, you can use the command
408 @kbd{M-x gnus-other-frame} instead.
410 If things do not go smoothly at startup, you have to twiddle some
414 * Finding the News:: Choosing a method for getting news.
415 * The First Time:: What does Gnus do the first time you start it?
416 * The Server is Down:: How can I read my mail then?
417 * Slave Gnusae:: You can have more than one Gnus active at a time.
418 * Fetching a Group:: Starting Gnus just to read a group.
419 * New Groups:: What is Gnus supposed to do with new groups?
420 * Startup Files:: Those pesky startup files---@file{.newsrc}.
421 * Auto Save:: Recovering from a crash.
422 * The Active File:: Reading the active file over a slow line Takes Time.
423 * Changing Servers:: You may want to move from one server to another.
424 * Startup Variables:: Other variables you might change.
428 @node Finding the News
429 @section Finding the News
432 @vindex gnus-select-method
434 The @code{gnus-select-method} variable says where Gnus should look for
435 news. This variable should be a list where the first element says
436 @dfn{how} and the second element says @dfn{where}. This method is your
437 native method. All groups that are not fetched with this method are
440 For instance, if the @samp{news.somewhere.edu} @sc{nntp} server is where
441 you want to get your daily dosage of news from, you'd say:
444 (setq gnus-select-method '(nntp "news.somewhere.edu"))
447 If you want to read directly from the local spool, say:
450 (setq gnus-select-method '(nnspool ""))
453 If you can use a local spool, you probably should, as it will almost
454 certainly be much faster.
456 @vindex gnus-nntpserver-file
458 @cindex @sc{nntp} server
459 If this variable is not set, Gnus will take a look at the
460 @code{NNTPSERVER} environment variable. If that variable isn't set,
461 Gnus will see whether @code{gnus-nntpserver-file}
462 (@file{/etc/nntpserver} by default) has any opinions on the matter. If
463 that fails as well, Gnus will try to use the machine that is
464 running Emacs as an @sc{nntp} server. That's a long shot, though.
466 @vindex gnus-nntp-server
467 If @code{gnus-nntp-server} is set, this variable will override
468 @code{gnus-select-method}. You should therefore set
469 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
471 @vindex gnus-secondary-servers
472 You can also make Gnus prompt you interactively for the name of an
473 @sc{nntp} server. If you give a non-numerical prefix to @code{gnus}
474 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
475 in the @code{gnus-secondary-servers} list (if any). You can also just
476 type in the name of any server you feel like visiting.
478 @findex gnus-group-browse-foreign-server
480 However, if you use one @sc{nntp} server regularly and are just
481 interested in a couple of groups from a different server, you would be
482 better served by using the @kbd{B} command in the group buffer. It will
483 let you have a look at what groups are available, and you can subscribe
484 to any of the groups you want to. This also makes @file{.newsrc}
485 maintenance much tidier. @xref{Foreign Groups}.
487 @vindex gnus-secondary-select-methods
489 A slightly different approach to foreign groups is to set the
490 @code{gnus-secondary-select-methods} variable. The select methods
491 listed in this variable are in many ways just as native as the
492 @code{gnus-select-method} server. They will also be queried for active
493 files during startup (if that's required), and new newsgroups that
494 appear on these servers will be subscribed (or not) just as native
497 For instance, if you use the @code{nnmbox} backend to read your mail, you
498 would typically set this variable to
501 (setq gnus-secondary-select-methods '((nnmbox "")))
506 @section The First Time
507 @cindex first time usage
509 If no startup files exist, Gnus will try to determine what groups should
510 be subscribed by default.
512 @vindex gnus-default-subscribed-newsgroups
513 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
514 will subscribe you to just those groups in that list, leaving the rest
515 killed. Your system administrator should have set this variable to
518 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
519 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
520 here as @dfn{whatever Lars thinks you should read}.)
522 You'll also be subscribed to the Gnus documentation group, which should
523 help you with most common problems.
525 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
526 use the normal functions for handling new groups, and not do anything
530 @node The Server is Down
531 @section The Server is Down
532 @cindex server errors
534 If the default server is down, Gnus will understandably have some
535 problems starting. However, if you have some mail groups in addition to
536 the news groups, you may want to start Gnus anyway.
538 Gnus, being the trusting sort of program, will ask whether to proceed
539 without a native select method if that server can't be contacted. This
540 will happen whether the server doesn't actually exist (i.e., you have
541 given the wrong address) or the server has just momentarily taken ill
542 for some reason or other. If you decide to continue and have no foreign
543 groups, you'll find it difficult to actually do anything in the group
544 buffer. But, hey, that's your problem. Blllrph!
546 @findex gnus-no-server
547 @kindex M-x gnus-no-server
549 If you know that the server is definitely down, or you just want to read
550 your mail without bothering with the server at all, you can use the
551 @code{gnus-no-server} command to start Gnus. That might come in handy
552 if you're in a hurry as well. This command will not attempt to contact
553 your primary server---instead, it will just activate all groups on level
554 1 and 2. (You should preferably keep no native groups on those two
559 @section Slave Gnusae
562 You might want to run more than one Emacs with more than one Gnus at the
563 same time. If you are using different @file{.newsrc} files (e.g., if you
564 are using the two different Gnusae to read from two different servers),
565 that is no problem whatsoever. You just do it.
567 The problem appears when you want to run two Gnusae that use the same
570 To work around that problem some, we here at the Think-Tank at the Gnus
571 Towers have come up with a new concept: @dfn{Masters} and
572 @dfn{slaves}. (We have applied for a patent on this concept, and have
573 taken out a copyright on those words. If you wish to use those words in
574 conjunction with each other, you have to send $1 per usage instance to
575 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
576 Applications}) will be much more expensive, of course.)
578 Anyways, you start one Gnus up the normal way with @kbd{M-x gnus} (or
579 however you do it). Each subsequent slave Gnusae should be started with
580 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
581 files, but instead save @dfn{slave files} that contain information only
582 on what groups have been read in the slave session. When a master Gnus
583 starts, it will read (and delete) these slave files, incorporating all
584 information from them. (The slave files will be read in the sequence
585 they were created, so the latest changes will have precedence.)
587 Information from the slave files has, of course, precedence over the
588 information in the normal (i.e., master) @code{.newsrc} file.
591 @node Fetching a Group
592 @section Fetching a Group
593 @cindex fetching a group
595 @findex gnus-fetch-group
596 It is sometimes convenient to be able to just say ``I want to read this
597 group and I don't care whether Gnus has been started or not''. This is
598 perhaps more useful for people who write code than for users, but the
599 command @code{gnus-fetch-group} provides this functionality in any case.
600 It takes the group name as a parameter.
608 @vindex gnus-check-new-newsgroups
609 If you are satisfied that you really never want to see any new groups,
610 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
611 also save you some time at startup. Even if this variable is
612 @code{nil}, you can always subscribe to the new groups just by pressing
613 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
614 is @code{t} by default. If you set this variable to @code{always}, then
615 Gnus will query the backends for new groups even when you do the @kbd{g}
616 command (@pxref{Scanning New Messages}).
619 * Checking New Groups:: Determining what groups are new.
620 * Subscription Methods:: What Gnus should do with new groups.
621 * Filtering New Groups:: Making Gnus ignore certain new groups.
625 @node Checking New Groups
626 @subsection Checking New Groups
628 Gnus normally determines whether a group is new or not by comparing the
629 list of groups from the active file(s) with the lists of subscribed and
630 dead groups. This isn't a particularly fast method. If
631 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
632 server for new groups since the last time. This is both faster and
633 cheaper. This also means that you can get rid of the list of killed
634 groups altogether, so you may set @code{gnus-save-killed-list} to
635 @code{nil}, which will save time both at startup, at exit, and all over.
636 Saves disk space, too. Why isn't this the default, then?
637 Unfortunately, not all servers support this command.
639 I bet I know what you're thinking now: How do I find out whether my
640 server supports @code{ask-server}? No? Good, because I don't have a
641 fail-safe answer. I would suggest just setting this variable to
642 @code{ask-server} and see whether any new groups appear within the next
643 few days. If any do, then it works. If none do, then it doesn't
644 work. I could write a function to make Gnus guess whether the server
645 supports @code{ask-server}, but it would just be a guess. So I won't.
646 You could @code{telnet} to the server and say @code{HELP} and see
647 whether it lists @samp{NEWGROUPS} among the commands it understands. If
648 it does, then it might work. (But there are servers that lists
649 @samp{NEWGROUPS} without supporting the function properly.)
651 This variable can also be a list of select methods. If so, Gnus will
652 issue an @code{ask-server} command to each of the select methods, and
653 subscribe them (or not) using the normal methods. This might be handy
654 if you are monitoring a few servers for new groups. A side effect is
655 that startup will take much longer, so you can meditate while waiting.
656 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
659 @node Subscription Methods
660 @subsection Subscription Methods
662 @vindex gnus-subscribe-newsgroup-method
663 What Gnus does when it encounters a new group is determined by the
664 @code{gnus-subscribe-newsgroup-method} variable.
666 This variable should contain a function. This function will be called
667 with the name of the new group as the only parameter.
669 Some handy pre-fab functions are:
673 @item gnus-subscribe-zombies
674 @vindex gnus-subscribe-zombies
675 Make all new groups zombies. This is the default. You can browse the
676 zombies later (with @kbd{A z}) and either kill them all off properly
677 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
679 @item gnus-subscribe-randomly
680 @vindex gnus-subscribe-randomly
681 Subscribe all new groups randomly.
683 @item gnus-subscribe-alphabetically
684 @vindex gnus-subscribe-alphabetically
685 Subscribe all new groups alphabetically.
687 @item gnus-subscribe-hierarchically
688 @vindex gnus-subscribe-hierarchically
689 Subscribe all new groups hierarchically. The difference between this
690 function and @code{gnus-subscribe-alphabetically} is slight.
691 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
692 alphabetical fashion, while this function will enter groups into it's
693 hierarchy. So if you want to have the @samp{rec} hierarchy before the
694 @samp{comp} hierarchy, this function will not mess that configuration
695 up. Or something like that.
697 @item gnus-subscribe-interactively
698 @vindex gnus-subscribe-interactively
699 Subscribe new groups interactively. This means that Gnus will ask
700 you about @strong{all} new groups.
702 @item gnus-subscribe-killed
703 @vindex gnus-subscribe-killed
708 @vindex gnus-subscribe-hierarchical-interactive
709 A closely related variable is
710 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
711 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
712 hierarchical fashion whether to subscribe to new groups or not. Gnus
713 will ask you for each sub-hierarchy whether you want to descend the
716 One common mistake is to set the variable a few paragraphs above
717 (@code{gnus-subscribe-newsgroup-method}) to
718 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
719 will not work. This is ga-ga. So don't do it.
722 @node Filtering New Groups
723 @subsection Filtering New Groups
725 A nice and portable way to control which new newsgroups should be
726 subscribed (or ignored) is to put an @dfn{options} line at the start of
727 the @file{.newsrc} file. Here's an example:
730 options -n !alt.all !rec.all sci.all
733 @vindex gnus-subscribe-options-newsgroup-method
734 This line obviously belongs to a serious-minded intellectual scientific
735 person (or she may just be plain old boring), because it says that all
736 groups that have names beginning with @samp{alt} and @samp{rec} should
737 be ignored, and all groups with names beginning with @samp{sci} should
738 be subscribed. Gnus will not use the normal subscription method for
739 subscribing these groups.
740 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
741 variable defaults to @code{gnus-subscribe-alphabetically}.
743 @vindex gnus-options-not-subscribe
744 @vindex gnus-options-subscribe
745 If you don't want to mess with your @file{.newsrc} file, you can just
746 set the two variables @code{gnus-options-subscribe} and
747 @code{gnus-options-not-subscribe}. These two variables do exactly the
748 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
749 and if the new group matches the former, it will be unconditionally
750 subscribed, and if it matches the latter, it will be ignored.
752 @vindex gnus-auto-subscribed-groups
753 Yet another variable that meddles here is
754 @code{gnus-auto-subscribed-groups}. It works exactly like
755 @code{gnus-options-subscribe}, and is therefore really superfluous, but I
756 thought it would be nice to have two of these. This variable is more
757 meant for setting some ground rules, while the other variable is used
758 more for user fiddling. By default this variable makes all new groups
759 that come from mail backends (@code{nnml}, @code{nnbabyl},
760 @code{nnfolder}, @code{nnmbox}, and @code{nnmh}) subscribed. If you
761 don't like that, just set this variable to @code{nil}.
763 New groups that match this regexp are subscribed using
764 @code{gnus-subscribe-options-newsgroup-method}.
767 @node Changing Servers
768 @section Changing Servers
769 @cindex changing servers
771 Sometimes it is necessary to move from one @sc{nntp} server to another.
772 This happens very rarely, but perhaps you change jobs, or one server is
773 very flaky and you want to use another.
775 Changing the server is pretty easy, right? You just change
776 @code{gnus-select-method} to point to the new server?
780 Article numbers are not (in any way) kept synchronized between different
781 @sc{nntp} servers, and the only way Gnus keeps track of what articles
782 you have read is by keeping track of article numbers. So when you
783 change @code{gnus-select-method}, your @file{.newsrc} file becomes
786 Gnus provides a few functions to attempt to translate a @file{.newsrc}
787 file from one server to another. They all have one thing in
788 common---they take a looong time to run. You don't want to use these
789 functions more than absolutely necessary.
791 @kindex M-x gnus-change-server
792 @findex gnus-change-server
793 If you have access to both servers, Gnus can request the headers for all
794 the articles you have read and compare @code{Message-ID}s and map the
795 article numbers of the read articles and article marks. The @kbd{M-x
796 gnus-change-server} command will do this for all your native groups. It
797 will prompt for the method you want to move to.
799 @kindex M-x gnus-group-move-group-to-server
800 @findex gnus-group-move-group-to-server
801 You can also move individual groups with the @kbd{M-x
802 gnus-group-move-group-to-server} command. This is useful if you want to
803 move a (foreign) group from one server to another.
805 @kindex M-x gnus-group-clear-data-on-native-groups
806 @findex gnus-group-clear-data-on-native-groups
807 If you don't have access to both the old and new server, all your marks
808 and read ranges have become worthless. You can use the @kbd{M-x
809 gnus-group-clear-data-on-native-groups} command to clear out all data
810 that you have on your native groups. Use with caution.
814 @section Startup Files
815 @cindex startup files
820 Now, you all know about the @file{.newsrc} file. All subscription
821 information is traditionally stored in this file.
823 Things got a bit more complicated with @sc{gnus}. In addition to
824 keeping the @file{.newsrc} file updated, it also used a file called
825 @file{.newsrc.el} for storing all the information that didn't fit into
826 the @file{.newsrc} file. (Actually, it also duplicated everything in
827 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
828 files was the most recently saved, which enabled people to swap between
829 @sc{gnus} and other newsreaders.
831 That was kinda silly, so Gnus went one better: In addition to the
832 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
833 @file{.newsrc.eld}. It will read whichever of these files that are most
834 recent, but it will never write a @file{.newsrc.el} file.
836 @vindex gnus-save-newsrc-file
837 You can turn off writing the @file{.newsrc} file by setting
838 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
839 the file and save some space, as well as making exit from Gnus faster.
840 However, this will make it impossible to use other newsreaders than
841 Gnus. But hey, who would want to, right?
843 @vindex gnus-save-killed-list
844 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
845 will not save the list of killed groups to the startup file. This will
846 save both time (when starting and quitting) and space (on disk). It
847 will also mean that Gnus has no record of what groups are new or old,
848 so the automatic new groups subscription methods become meaningless.
849 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
850 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
851 Groups}). This variable can also be a regular expression. If that's
852 the case, remove all groups that do not match this regexp before
853 saving. This can be useful in certain obscure situations that involve
854 several servers where not all servers support @code{ask-server}.
856 @vindex gnus-startup-file
857 The @code{gnus-startup-file} variable says where the startup files are.
858 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
859 file being whatever that one is, with a @samp{.eld} appended.
861 @vindex gnus-save-newsrc-hook
862 @vindex gnus-save-quick-newsrc-hook
863 @vindex gnus-save-standard-newsrc-hook
864 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
865 files, while @code{gnus-save-quick-newsrc-hook} is called just before
866 saving the @file{.newsrc.eld} file, and
867 @code{gnus-save-standard-newsrc-hook} is called just before saving the
868 @file{.newsrc} file. The latter two are commonly used to turn version
869 control on or off. Version control is on by default when saving the
870 startup files. If you want to turn backup creation off, say something like:
873 (defun turn-off-backup ()
874 (set (make-local-variable 'backup-inhibited) t))
876 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
877 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
880 @vindex gnus-init-file
881 When Gnus starts, it will read the @code{gnus-site-init-file}
882 (@file{.../site-lisp/gnus} by default) and @code{gnus-init-file}
883 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
884 and can be used to avoid cluttering your @file{~/.emacs} and
885 @file{site-init} files with Gnus stuff. Gnus will also check for files
886 with the same names as these, but with @file{.elc} and @file{.el}
887 suffixes. In other words, if you have set @code{gnus-init-file} to
888 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
889 and finally @file{~/.gnus} (in this order).
898 Whenever you do something that changes the Gnus data (reading articles,
899 catching up, killing/subscribing groups), the change is added to a
900 special @dfn{dribble buffer}. This buffer is auto-saved the normal
901 Emacs way. If your Emacs should crash before you have saved the
902 @file{.newsrc} files, all changes you have made can be recovered from
905 If Gnus detects this file at startup, it will ask the user whether to
906 read it. The auto save file is deleted whenever the real startup file is
909 @vindex gnus-use-dribble-file
910 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
911 maintain a dribble buffer. The default is @code{t}.
913 @vindex gnus-dribble-directory
914 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
915 this variable is @code{nil}, which it is by default, Gnus will dribble
916 into the directory where the @file{.newsrc} file is located. (This is
917 normally the user's home directory.) The dribble file will get the same
918 file permissions as the @code{.newsrc} file.
921 @node The Active File
922 @section The Active File
924 @cindex ignored groups
926 When Gnus starts, or indeed whenever it tries to determine whether new
927 articles have arrived, it reads the active file. This is a very large
928 file that lists all the active groups and articles on the server.
930 @vindex gnus-ignored-newsgroups
931 Before examining the active file, Gnus deletes all lines that match the
932 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
933 any groups with bogus names, but you can use this variable to make Gnus
934 ignore hierarchies you aren't ever interested in. However, this is not
935 recommended. In fact, it's highly discouraged. Instead, @pxref{New
936 Groups} for an overview of other variables that can be used instead.
939 @c @code{nil} by default, and will slow down active file handling somewhat
940 @c if you set it to anything else.
942 @vindex gnus-read-active-file
944 The active file can be rather Huge, so if you have a slow network, you
945 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
946 reading the active file. This variable is @code{t} by default.
948 Gnus will try to make do by getting information just on the groups that
949 you actually subscribe to.
951 Note that if you subscribe to lots and lots of groups, setting this
952 variable to @code{nil} will probably make Gnus slower, not faster. At
953 present, having this variable @code{nil} will slow Gnus down
954 considerably, unless you read news over a 2400 baud modem.
956 This variable can also have the value @code{some}. Gnus will then
957 attempt to read active info only on the subscribed groups. On some
958 servers this is quite fast (on sparkling, brand new INN servers that
959 support the @code{LIST ACTIVE group} command), on others this isn't fast
960 at all. In any case, @code{some} should be faster than @code{nil}, and
961 is certainly faster than @code{t} over slow lines.
963 If this variable is @code{nil}, Gnus will ask for group info in total
964 lock-step, which isn't very fast. If it is @code{some} and you use an
965 @sc{nntp} server, Gnus will pump out commands as fast as it can, and
966 read all the replies in one swoop. This will normally result in better
967 performance, but if the server does not support the aforementioned
968 @code{LIST ACTIVE group} command, this isn't very nice to the server.
970 In any case, if you use @code{some} or @code{nil}, you should definitely
971 kill all groups that you aren't interested in to speed things up.
973 Note that this variable also affects active file retrieval from
974 secondary select methods.
977 @node Startup Variables
978 @section Startup Variables
983 @vindex gnus-load-hook
984 A hook that is run while Gnus is being loaded. Note that this hook will
985 normally be run just once in each Emacs session, no matter how many
986 times you start Gnus.
988 @item gnus-startup-hook
989 @vindex gnus-startup-hook
990 A hook that is run after starting up Gnus successfully.
992 @item gnus-started-hook
993 @vindex gnus-started-hook
994 A hook that is run as the very last thing after starting up Gnus
997 @item gnus-check-bogus-newsgroups
998 @vindex gnus-check-bogus-newsgroups
999 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1000 startup. A @dfn{bogus group} is a group that you have in your
1001 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1002 bogus groups can take quite a while, so to save time and resources it's
1003 best to leave this option off, and do the checking for bogus groups once
1004 in a while from the group buffer instead (@pxref{Group Maintenance}).
1006 @item gnus-inhibit-startup-message
1007 @vindex gnus-inhibit-startup-message
1008 If non-@code{nil}, the startup message won't be displayed. That way,
1009 your boss might not notice as easily that you are reading news instead
1010 of doing your job. Note that this variable is used before
1011 @file{.gnus.el} is loaded, so it should be set in @code{.emacs} instead.
1013 @item gnus-no-groups-message
1014 @vindex gnus-no-groups-message
1015 Message displayed by Gnus when no groups are available.
1017 @item gnus-play-startup-jingle
1018 @vindex gnus-play-startup-jingle
1019 If non-@code{nil}, play the Gnus jingle at startup.
1021 @item gnus-startup-jingle
1022 @vindex gnus-startup-jingle
1023 Jingle to be played if the above variable is non-@code{nil}. The
1024 default is @samp{Tuxedomoon.Jingle4.au}.
1029 @node The Group Buffer
1030 @chapter The Group Buffer
1031 @cindex group buffer
1033 The @dfn{group buffer} lists all (or parts) of the available groups. It
1034 is the first buffer shown when Gnus starts, and will never be killed as
1035 long as Gnus is active.
1039 \gnusfigure{The Group Buffer}{320}{
1040 \put(75,50){\epsfig{figure=tmp/group.ps,height=9cm}}
1041 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1042 \put(120,38){\vector(1,2){10}}
1043 \put(40,60){\makebox(0,0)[r]{Mode line}}
1044 \put(40,58){\vector(1,0){30}}
1045 \put(200,28){\makebox(0,0)[t]{Native select method}}
1046 \put(200,26){\vector(-1,2){15}}
1052 * Group Buffer Format:: Information listed and how you can change it.
1053 * Group Maneuvering:: Commands for moving in the group buffer.
1054 * Selecting a Group:: Actually reading news.
1055 * Group Data:: Changing the info for a group.
1056 * Subscription Commands:: Unsubscribing, killing, subscribing.
1057 * Group Levels:: Levels? What are those, then?
1058 * Group Score:: A mechanism for finding out what groups you like.
1059 * Marking Groups:: You can mark groups for later processing.
1060 * Foreign Groups:: Creating and editing groups.
1061 * Group Parameters:: Each group may have different parameters set.
1062 * Listing Groups:: Gnus can list various subsets of the groups.
1063 * Sorting Groups:: Re-arrange the group order.
1064 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1065 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1066 * Exiting Gnus:: Stop reading news and get some work done.
1067 * Group Topics:: A folding group mode divided into topics.
1068 * Misc Group Stuff:: Other stuff that you can to do.
1072 @node Group Buffer Format
1073 @section Group Buffer Format
1076 * Group Line Specification:: Deciding how the group buffer is to look.
1077 * Group Modeline Specification:: The group buffer modeline.
1078 * Group Highlighting:: Having nice colors in the group buffer.
1082 @node Group Line Specification
1083 @subsection Group Line Specification
1084 @cindex group buffer format
1086 The default format of the group buffer is nice and dull, but you can
1087 make it as exciting and ugly as you feel like.
1089 Here's a couple of example group lines:
1092 25: news.announce.newusers
1093 * 0: alt.fan.andrea-dworkin
1098 You can see that there are 25 unread articles in
1099 @samp{news.announce.newusers}. There are no unread articles, but some
1100 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1101 asterisk at the beginning of the line?).
1103 @vindex gnus-group-line-format
1104 You can change that format to whatever you want by fiddling with the
1105 @code{gnus-group-line-format} variable. This variable works along the
1106 lines of a @code{format} specification, which is pretty much the same as
1107 a @code{printf} specifications, for those of you who use (feh!) C.
1108 @xref{Formatting Variables}.
1110 @samp{%M%S%5y: %(%g%)\n} is the value that produced those lines above.
1112 There should always be a colon on the line; the cursor always moves to
1113 the colon after performing an operation. Nothing else is required---not
1114 even the group name. All displayed text is just window dressing, and is
1115 never examined by Gnus. Gnus stores all real information it needs using
1118 (Note that if you make a really strange, wonderful, spreadsheet-like
1119 layout, everybody will believe you are hard at work with the accounting
1120 instead of wasting time reading news.)
1122 Here's a list of all available format characters:
1127 An asterisk if the group only has marked articles.
1130 Whether the group is subscribed.
1133 Level of subscribedness.
1136 Number of unread articles.
1139 Number of dormant articles.
1142 Number of ticked articles.
1145 Number of read articles.
1148 Estimated total number of articles. (This is really @var{max-number}
1149 minus @var{min-number} plus 1.)
1152 Number of unread, unticked, non-dormant articles.
1155 Number of ticked and dormant articles.
1164 Newsgroup description.
1167 @samp{m} if moderated.
1170 @samp{(m)} if moderated.
1179 A string that looks like @samp{<%s:%n>} if a foreign select method is
1183 Indentation based on the level of the topic (@pxref{Group Topics}).
1186 @vindex gnus-group-uncollapsed-levels
1187 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1188 variable says how many levels to leave at the end of the group name.
1189 The default is 1---this will mean that group names like
1190 @samp{gnu.emacs.gnus} will be shortened to @samp{g.emacs.gnus}.
1193 @vindex gnus-new-mail-mark
1195 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1199 A string that says when you last read the group (@pxref{Group
1203 User defined specifier. The next character in the format string should
1204 be a letter. Gnus will call the function
1205 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1206 following @samp{%u}. The function will be passed a single dummy
1207 parameter as argument. The function should return a string, which will
1208 be inserted into the buffer just like information from any other
1213 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1214 if no info is available---for instance, if it is a non-activated foreign
1215 group, or a bogus native group.
1218 @node Group Modeline Specification
1219 @subsection Group Modeline Specification
1220 @cindex group modeline
1222 @vindex gnus-group-mode-line-format
1223 The mode line can be changed by setting
1224 @code{gnus-group-mode-line-format} (@pxref{Formatting Variables}). It
1225 doesn't understand that many format specifiers:
1229 The native news server.
1231 The native select method.
1235 @node Group Highlighting
1236 @subsection Group Highlighting
1237 @cindex highlighting
1238 @cindex group highlighting
1240 @vindex gnus-group-highlight
1241 Highlighting in the group buffer is controlled by the
1242 @code{gnus-group-highlight} variable. This is an alist with elements
1243 that look like @var{(form . face)}. If @var{form} evaluates to
1244 something non-@code{nil}, the @var{face} will be used on the line.
1246 Here's an example value for this variable that might look nice if the
1250 (setq gnus-group-highlight
1252 ,(custom-face-lookup "Red" nil nil t nil nil))
1253 ((and (< level 3) (zerop unread)) .
1254 ,(custom-face-lookup "SeaGreen" nil nil t nil nil))
1256 ,(custom-face-lookup "SpringGreen" nil nil t nil nil))
1258 ,(custom-face-lookup "SteelBlue" nil nil t nil nil))
1260 ,(custom-face-lookup "SkyBlue" nil nil t nil nil))))
1263 Variables that are dynamically bound when the forms are evaluated
1270 The number of unread articles in the group.
1274 Whether the group is a mail group.
1276 The level of the group.
1278 The score of the group.
1280 The number of ticked articles in the group.
1282 The total number of articles in the group. Or rather, MAX-NUMBER minus
1283 MIN-NUMBER plus one.
1285 When using the topic minor mode, this variable is bound to the current
1286 topic being inserted.
1289 When the forms are @code{eval}ed, point is at the beginning of the line
1290 of the group in question, so you can use many of the normal Gnus
1291 functions for snarfing info on the group.
1293 @vindex gnus-group-update-hook
1294 @findex gnus-group-highlight-line
1295 @code{gnus-group-update-hook} is called when a group line is changed.
1296 It will not be called when @code{gnus-visual} is @code{nil}. This hook
1297 calls @code{gnus-group-highlight-line} by default.
1300 @node Group Maneuvering
1301 @section Group Maneuvering
1302 @cindex group movement
1304 All movement commands understand the numeric prefix and will behave as
1305 expected, hopefully.
1311 @findex gnus-group-next-unread-group
1312 Go to the next group that has unread articles
1313 (@code{gnus-group-next-unread-group}).
1319 @findex gnus-group-prev-unread-group
1320 Go to the previous group that has unread articles
1321 (@code{gnus-group-prev-unread-group}).
1325 @findex gnus-group-next-group
1326 Go to the next group (@code{gnus-group-next-group}).
1330 @findex gnus-group-prev-group
1331 Go to the previous group (@code{gnus-group-prev-group}).
1335 @findex gnus-group-next-unread-group-same-level
1336 Go to the next unread group on the same (or lower) level
1337 (@code{gnus-group-next-unread-group-same-level}).
1341 @findex gnus-group-prev-unread-group-same-level
1342 Go to the previous unread group on the same (or lower) level
1343 (@code{gnus-group-prev-unread-group-same-level}).
1346 Three commands for jumping to groups:
1352 @findex gnus-group-jump-to-group
1353 Jump to a group (and make it visible if it isn't already)
1354 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
1359 @findex gnus-group-best-unread-group
1360 Jump to the unread group with the lowest level
1361 (@code{gnus-group-best-unread-group}).
1365 @findex gnus-group-first-unread-group
1366 Jump to the first group with unread articles
1367 (@code{gnus-group-first-unread-group}).
1370 @vindex gnus-group-goto-unread
1371 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
1372 commands will move to the next group, not the next unread group. Even
1373 the commands that say they move to the next unread group. The default
1377 @node Selecting a Group
1378 @section Selecting a Group
1379 @cindex group selection
1384 @kindex SPACE (Group)
1385 @findex gnus-group-read-group
1386 Select the current group, switch to the summary buffer and display the
1387 first unread article (@code{gnus-group-read-group}). If there are no
1388 unread articles in the group, or if you give a non-numerical prefix to
1389 this command, Gnus will offer to fetch all the old articles in this
1390 group from the server. If you give a numerical prefix @var{N}, @var{N}
1391 determines the number of articles Gnus will fetch. If @var{N} is
1392 positive, Gnus fetches the @var{N} newest articles, if @var{N} is
1393 negative, Gnus fetches the @var{abs(N)} oldest articles.
1397 @findex gnus-group-select-group
1398 Select the current group and switch to the summary buffer
1399 (@code{gnus-group-select-group}). Takes the same arguments as
1400 @code{gnus-group-read-group}---the only difference is that this command
1401 does not display the first unread article automatically upon group
1405 @kindex M-RET (Group)
1406 @findex gnus-group-quick-select-group
1407 This does the same as the command above, but tries to do it with the
1408 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
1409 scoring/killing will be performed, there will be no highlights and no
1410 expunging. This might be useful if you're in a real hurry and have to
1411 enter some humongous group. If you give a 0 prefix to this command
1412 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer.
1413 This might be useful if you want to toggle threading before entering the
1417 @kindex M-SPACE (Group)
1418 @findex gnus-group-visible-select-group
1419 This is yet one more command that does the same as the @kbd{RET}
1420 command, but this one does it without expunging and hiding dormants
1421 (@code{gnus-group-visible-select-group}).
1424 @kindex M-C-RET (Group)
1425 @findex gnus-group-select-group-ephemerally
1426 Finally, this command selects the current group ephemerally without
1427 doing any processing of its contents
1428 (@code{gnus-group-select-group-ephemerally}). Even threading has been
1429 turned off. Everything you do in the group after selecting it in this
1430 manner will have no permanent effects.
1434 @vindex gnus-large-newsgroup
1435 The @code{gnus-large-newsgroup} variable says what Gnus should consider
1436 to be a big group. This is 200 by default. If the group has more
1437 (unread and/or ticked) articles than this, Gnus will query the user
1438 before entering the group. The user can then specify how many articles
1439 should be fetched from the server. If the user specifies a negative
1440 number (@code{-n}), the @code{n} oldest articles will be fetched. If it
1441 is positive, the @code{n} articles that have arrived most recently will
1444 @vindex gnus-select-group-hook
1445 @vindex gnus-auto-select-first
1446 @code{gnus-auto-select-first} control whether any articles are selected
1447 automatically when entering a group with the @kbd{SPACE} command.
1452 Don't select any articles when entering the group. Just display the
1453 full summary buffer.
1456 Select the first unread article when entering the group.
1459 Select the most high-scored article in the group when entering the
1463 If you want to prevent automatic selection in some group (say, in a
1464 binary group with Huge articles) you can set this variable to @code{nil}
1465 in @code{gnus-select-group-hook}, which is called when a group is
1469 @node Subscription Commands
1470 @section Subscription Commands
1471 @cindex subscription
1479 @findex gnus-group-unsubscribe-current-group
1480 @c @icon{gnus-group-unsubscribe}
1481 Toggle subscription to the current group
1482 (@code{gnus-group-unsubscribe-current-group}).
1488 @findex gnus-group-unsubscribe-group
1489 Prompt for a group to subscribe, and then subscribe it. If it was
1490 subscribed already, unsubscribe it instead
1491 (@code{gnus-group-unsubscribe-group}).
1497 @findex gnus-group-kill-group
1498 @c @icon{gnus-group-kill-group}
1499 Kill the current group (@code{gnus-group-kill-group}).
1505 @findex gnus-group-yank-group
1506 Yank the last killed group (@code{gnus-group-yank-group}).
1509 @kindex C-x C-t (Group)
1510 @findex gnus-group-transpose-groups
1511 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
1512 really a subscription command, but you can use it instead of a
1513 kill-and-yank sequence sometimes.
1519 @findex gnus-group-kill-region
1520 Kill all groups in the region (@code{gnus-group-kill-region}).
1524 @findex gnus-group-kill-all-zombies
1525 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
1528 @kindex S C-k (Group)
1529 @findex gnus-group-kill-level
1530 Kill all groups on a certain level (@code{gnus-group-kill-level}).
1531 These groups can't be yanked back after killing, so this command should
1532 be used with some caution. The only time where this command comes in
1533 really handy is when you have a @file{.newsrc} with lots of unsubscribed
1534 groups that you want to get rid off. @kbd{S C-k} on level 7 will
1535 kill off all unsubscribed groups that do not have message numbers in the
1536 @file{.newsrc} file.
1540 Also @pxref{Group Levels}.
1550 @findex gnus-group-catchup-current
1551 @vindex gnus-group-catchup-group-hook
1552 @c @icon{gnus-group-catchup-current}
1553 Mark all unticked articles in this group as read
1554 (@code{gnus-group-catchup-current}).
1555 @code{gnus-group-catchup-group-hook} is called when catching up a group from
1560 @findex gnus-group-catchup-current-all
1561 Mark all articles in this group, even the ticked ones, as read
1562 (@code{gnus-group-catchup-current-all}).
1566 @findex gnus-group-clear-data
1567 Clear the data from the current group---nix out marks and the list of
1568 read articles (@code{gnus-group-clear-data}).
1570 @item M-x gnus-group-clear-data-on-native-groups
1571 @kindex M-x gnus-group-clear-data-on-native-groups
1572 @findex gnus-group-clear-data-on-native-groups
1573 If you have switched from one @sc{nntp} server to another, all your marks
1574 and read ranges have become worthless. You can use this command to
1575 clear out all data that you have on your native groups. Use with
1582 @section Group Levels
1586 All groups have a level of @dfn{subscribedness}. For instance, if a
1587 group is on level 2, it is more subscribed than a group on level 5. You
1588 can ask Gnus to just list groups on a given level or lower
1589 (@pxref{Listing Groups}), or to just check for new articles in groups on
1590 a given level or lower (@pxref{Scanning New Messages}).
1592 Remember: The higher the level of the group, the less important it is.
1598 @findex gnus-group-set-current-level
1599 Set the level of the current group. If a numeric prefix is given, the
1600 next @var{n} groups will have their levels set. The user will be
1601 prompted for a level.
1604 @vindex gnus-level-killed
1605 @vindex gnus-level-zombie
1606 @vindex gnus-level-unsubscribed
1607 @vindex gnus-level-subscribed
1608 Gnus considers groups from levels 1 to
1609 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
1610 @code{gnus-level-subscribed} (exclusive) and
1611 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
1612 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
1613 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
1614 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
1615 same, but zombie and killed groups have no information on what articles
1616 you have read, etc, stored. This distinction between dead and living
1617 groups isn't done because it is nice or clever, it is done purely for
1618 reasons of efficiency.
1620 It is recommended that you keep all your mail groups (if any) on quite
1621 low levels (e.g. 1 or 2).
1623 If you want to play with the level variables, you should show some care.
1624 Set them once, and don't touch them ever again. Better yet, don't touch
1625 them at all unless you know exactly what you're doing.
1627 @vindex gnus-level-default-unsubscribed
1628 @vindex gnus-level-default-subscribed
1629 Two closely related variables are @code{gnus-level-default-subscribed}
1630 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
1631 which are the levels that new groups will be put on if they are
1632 (un)subscribed. These two variables should, of course, be inside the
1633 relevant legal ranges.
1635 @vindex gnus-keep-same-level
1636 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
1637 will only move to groups that are of the same level (or lower). In
1638 particular, going from the last article in one group to the next group
1639 will go to the next group of the same level (or lower). This might be
1640 handy if you want to read the most important groups before you read the
1643 @vindex gnus-group-default-list-level
1644 All groups with a level less than or equal to
1645 @code{gnus-group-default-list-level} will be listed in the group buffer
1648 @vindex gnus-group-list-inactive-groups
1649 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
1650 groups will be listed along with the unread groups. This variable is
1651 @code{t} by default. If it is @code{nil}, inactive groups won't be
1654 @vindex gnus-group-use-permanent-levels
1655 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
1656 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
1657 use this level as the ``work'' level.
1659 @vindex gnus-activate-level
1660 Gnus will normally just activate groups that are on level
1661 @code{gnus-activate-level} or less. If you don't want to activate
1662 unsubscribed groups, for instance, you might set this variable to
1663 5. The default is 6.
1667 @section Group Score
1670 You would normally keep important groups on high levels, but that scheme
1671 is somewhat restrictive. Don't you wish you could have Gnus sort the
1672 group buffer according to how often you read groups, perhaps? Within
1675 This is what @dfn{group score} is for. You can assign a score to each
1676 group. You can then sort the group buffer based on this score.
1677 Alternatively, you can sort on score and then level. (Taken together,
1678 the level and the score is called the @dfn{rank} of the group. A group
1679 that is on level 4 and has a score of 1 has a higher rank than a group
1680 on level 5 that has a score of 300. (The level is the most significant
1681 part and the score is the least significant part.))
1683 @findex gnus-summary-bubble-group
1684 If you want groups you read often to get higher scores than groups you
1685 read seldom you can add the @code{gnus-summary-bubble-group} function to
1686 the @code{gnus-summary-exit-hook} hook. This will result (after
1687 sorting) in a bubbling sort of action. If you want to see that in
1688 action after each summary exit, you can add
1689 @code{gnus-group-sort-groups-by-rank} or
1690 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
1691 slow things down somewhat.
1694 @node Marking Groups
1695 @section Marking Groups
1696 @cindex marking groups
1698 If you want to perform some command on several groups, and they appear
1699 subsequently in the group buffer, you would normally just give a
1700 numerical prefix to the command. Most group commands will then do your
1701 bidding on those groups.
1703 However, if the groups are not in sequential order, you can still
1704 perform a command on several groups. You simply mark the groups first
1705 with the process mark and then execute the command.
1713 @findex gnus-group-mark-group
1714 Set the mark on the current group (@code{gnus-group-mark-group}).
1720 @findex gnus-group-unmark-group
1721 Remove the mark from the current group
1722 (@code{gnus-group-unmark-group}).
1726 @findex gnus-group-unmark-all-groups
1727 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
1731 @findex gnus-group-mark-region
1732 Mark all groups between point and mark (@code{gnus-group-mark-region}).
1736 @findex gnus-group-mark-buffer
1737 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
1741 @findex gnus-group-mark-regexp
1742 Mark all groups that match some regular expression
1743 (@code{gnus-group-mark-regexp}).
1746 Also @pxref{Process/Prefix}.
1748 @findex gnus-group-universal-argument
1749 If you want to execute some command on all groups that have been marked
1750 with the process mark, you can use the @kbd{M-&}
1751 (@code{gnus-group-universal-argument}) command. It will prompt you for
1752 the command to be executed.
1755 @node Foreign Groups
1756 @section Foreign Groups
1757 @cindex foreign groups
1759 Below are some group mode commands for making and editing general foreign
1760 groups, as well as commands to ease the creation of a few
1761 special-purpose groups. All these commands insert the newly created
1762 groups under point---@code{gnus-subscribe-newsgroup-method} is not
1769 @findex gnus-group-make-group
1770 @cindex making groups
1771 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
1772 for a name, a method and possibly an @dfn{address}. For an easier way
1773 to subscribe to @sc{nntp} groups, @pxref{Browse Foreign Server}.
1777 @findex gnus-group-rename-group
1778 @cindex renaming groups
1779 Rename the current group to something else
1780 (@code{gnus-group-rename-group}). This is legal only on some
1781 groups---mail groups mostly. This command might very well be quite slow
1787 @findex gnus-group-customize
1788 Customize the group parameters (@code{gnus-group-customize}).
1792 @findex gnus-group-edit-group-method
1793 @cindex renaming groups
1794 Enter a buffer where you can edit the select method of the current
1795 group (@code{gnus-group-edit-group-method}).
1799 @findex gnus-group-edit-group-parameters
1800 Enter a buffer where you can edit the group parameters
1801 (@code{gnus-group-edit-group-parameters}).
1805 @findex gnus-group-edit-group
1806 Enter a buffer where you can edit the group info
1807 (@code{gnus-group-edit-group}).
1811 @findex gnus-group-make-directory-group
1813 Make a directory group (@pxref{Directory Groups}). You will be prompted
1814 for a directory name (@code{gnus-group-make-directory-group}).
1819 @findex gnus-group-make-help-group
1820 Make the Gnus help group (@code{gnus-group-make-help-group}).
1824 @cindex (ding) archive
1825 @cindex archive group
1826 @findex gnus-group-make-archive-group
1827 @vindex gnus-group-archive-directory
1828 @vindex gnus-group-recent-archive-directory
1829 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
1830 default a group pointing to the most recent articles will be created
1831 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
1832 group will be created from @code{gnus-group-archive-directory}.
1836 @findex gnus-group-make-kiboze-group
1838 Make a kiboze group. You will be prompted for a name, for a regexp to
1839 match groups to be ``included'' in the kiboze group, and a series of
1840 strings to match on headers (@code{gnus-group-make-kiboze-group}).
1841 @xref{Kibozed Groups}.
1845 @findex gnus-group-enter-directory
1847 Read an arbitrary directory as if it were a newsgroup with the
1848 @code{nneething} backend (@code{gnus-group-enter-directory}).
1849 @xref{Anything Groups}.
1853 @findex gnus-group-make-doc-group
1854 @cindex ClariNet Briefs
1856 Make a group based on some file or other
1857 (@code{gnus-group-make-doc-group}). If you give a prefix to this
1858 command, you will be prompted for a file name and a file type.
1859 Currently supported types are @code{babyl}, @code{mbox}, @code{digest},
1860 @code{mmdf}, @code{news}, @code{rnews}, @code{clari-briefs},
1861 @code{rfc934}, @code{rfc822-forward}, and @code{forward}. If you run
1862 this command without a prefix, Gnus will guess at the file type.
1863 @xref{Document Groups}.
1867 @findex gnus-group-make-web-group
1872 Make an ephemeral group based on a web search
1873 (@code{gnus-group-make-web-group}). If you give a prefix to this
1874 command, make a solid group instead. You will be prompted for the
1875 search engine type and the search string. Legal search engine types
1876 include @code{dejanews}, @code{altavista} and @code{reference}.
1877 @xref{Web Searches}.
1880 @kindex G DEL (Group)
1881 @findex gnus-group-delete-group
1882 This function will delete the current group
1883 (@code{gnus-group-delete-group}). If given a prefix, this function will
1884 actually delete all the articles in the group, and forcibly remove the
1885 group itself from the face of the Earth. Use a prefix only if you are
1886 absolutely sure of what you are doing.
1890 @findex gnus-group-make-empty-virtual
1891 Make a new, fresh, empty @code{nnvirtual} group
1892 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
1896 @findex gnus-group-add-to-virtual
1897 Add the current group to an @code{nnvirtual} group
1898 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
1901 @xref{Select Methods} for more information on the various select
1904 @vindex gnus-activate-foreign-newsgroups
1905 If @code{gnus-activate-foreign-newsgroups} is a positive number,
1906 Gnus will check all foreign groups with this level or lower at startup.
1907 This might take quite a while, especially if you subscribe to lots of
1908 groups from different @sc{nntp} servers.
1911 @node Group Parameters
1912 @section Group Parameters
1913 @cindex group parameters
1915 The group parameters store information local to a particular group:
1920 If the group parameter list contains an element that looks like
1921 @code{(to-address . "some@@where.com")}, that address will be used by
1922 the backend when doing followups and posts. This is primarily useful in
1923 mail groups that represent closed mailing lists---mailing lists where
1924 it's expected that everybody that writes to the mailing list is
1925 subscribed to it. Since using this parameter ensures that the mail only
1926 goes to the mailing list itself, it means that members won't receive two
1927 copies of your followups.
1929 Using @code{to-address} will actually work whether the group is foreign
1930 or not. Let's say there's a group on the server that is called
1931 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
1932 the articles from a mail-to-news gateway. Posting directly to this
1933 group is therefore impossible---you have to send mail to the mailing
1934 list address instead.
1938 If the group parameter list has an element that looks like
1939 @code{(to-list . "some@@where.com")}, that address will be used when
1940 doing a @kbd{a} in that group. It is totally ignored when doing a
1941 followup---except that if it is present in a news group, you'll get mail
1942 group semantics when doing @kbd{f}.
1944 If you do an @kbd{a} command in a mail group and you don't have a
1945 @code{to-list} group parameter, one will be added automatically upon
1946 sending the message.
1950 If the group parameter list has the element @code{(visible . t)},
1951 that group will always be visible in the Group buffer, regardless
1952 of whether it has any unread articles.
1954 @item broken-reply-to
1955 @cindex broken-reply-to
1956 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
1957 headers in this group are to be ignored. This can be useful if you're
1958 reading a mailing list group where the listserv has inserted
1959 @code{Reply-To} headers that point back to the listserv itself. This is
1960 broken behavior. So there!
1964 Elements like @code{(to-group . "some.group.name")} means that all
1965 posts in that group will be sent to @code{some.group.name}.
1969 If this symbol is present in the group parameter list, Gnus will treat
1970 all responses as if they were responses to news articles. This can be
1971 useful if you have a mail group that's really a mirror of a news group.
1975 If this symbol is present in the group parameter list and set to
1976 @code{t}, newly composed messages will be @code{Gcc}'d to the current
1977 group. If it is present and set to @code{none}, no @code{Gcc:} header
1978 will be generated, if it is present and a string, this string will be
1979 inserted literally as a @code{gcc} header (this symbol takes precedence over
1980 any default @code{Gcc} rules as described later).
1984 If the group parameter has an element that looks like @code{(auto-expire
1985 . t)}, all articles that are read will be marked as expirable. For an
1986 alternative approach, @pxref{Expiring Mail}.
1989 @cindex total-expire
1990 If the group parameter has an element that looks like
1991 @code{(total-expire . t)}, all read articles will be put through the
1992 expiry process, even if they are not marked as expirable. Use with
1993 caution. Unread, ticked and dormant articles are not eligible for
1998 @vindex nnmail-expiry-wait-function
1999 If the group parameter has an element that looks like @code{(expiry-wait
2000 . 10)}, this value will override any @code{nnmail-expiry-wait} and
2001 @code{nnmail-expiry-wait-function} when expiring expirable messages.
2002 The value can either be a number of days (not necessarily an integer) or
2003 the symbols @code{never} or @code{immediate}.
2006 @cindex score file group parameter
2007 Elements that look like @code{(score-file . "file")} will make
2008 @file{file} into the current score file for the group in question. This
2009 means that all score commands you issue will end up in that file.
2012 @cindex adapt file group parameter
2013 Elements that look like @code{(adapt-file . "file")} will make
2014 @file{file} into the current adaptive score file for the group in
2015 question. All adaptive score entries will be put into this file.
2018 When unsubscribing from a mailing list you should never send the
2019 unsubscription notice to the mailing list itself. Instead, you'd send
2020 messages to the administrative address. This parameter allows you to
2021 put the admin address somewhere convenient.
2024 Elements that look like @code{(display . MODE)} say which articles to
2025 display on entering the group. Legal values are:
2029 Display all articles, both read and unread.
2032 Display the default visible articles, which normally includes unread and
2037 Elements that look like @code{(comment . "This is a comment")}
2038 are arbitrary comments on the group. They are currently ignored by
2039 Gnus, but provide a place for you to store information on particular
2042 @item @var{(variable form)}
2043 You can use the group parameters to set variables local to the group you
2044 are entering. If you want to turn threading off in @samp{news.answers},
2045 you could put @code{(gnus-show-threads nil)} in the group parameters of
2046 that group. @code{gnus-show-threads} will be made into a local variable
2047 in the summary buffer you enter, and the form @code{nil} will be
2048 @code{eval}ed there.
2050 This can also be used as a group-specific hook function, if you'd like.
2051 If you want to hear a beep when you enter a group, you could put
2052 something like @code{(dummy-variable (ding))} in the parameters of that
2053 group. @code{dummy-variable} will be set to the result of the
2054 @code{(ding)} form, but who cares?
2058 Use the @kbd{G p} command to edit group parameters of a group.
2060 @pxref{Topic Parameters}.
2062 Here's an example group parameter list:
2065 ((to-address . "ding@@gnus.org")
2070 @node Listing Groups
2071 @section Listing Groups
2072 @cindex group listing
2074 These commands all list various slices of the groups that are available.
2082 @findex gnus-group-list-groups
2083 List all groups that have unread articles
2084 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
2085 command will list only groups of level ARG and lower. By default, it
2086 only lists groups of level five (i. e.,
2087 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
2094 @findex gnus-group-list-all-groups
2095 List all groups, whether they have unread articles or not
2096 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
2097 this command will list only groups of level ARG and lower. By default,
2098 it lists groups of level seven or lower (i.e., just subscribed and
2099 unsubscribed groups).
2103 @findex gnus-group-list-level
2104 List all unread groups on a specific level
2105 (@code{gnus-group-list-level}). If given a prefix, also list the groups
2106 with no unread articles.
2110 @findex gnus-group-list-killed
2111 List all killed groups (@code{gnus-group-list-killed}). If given a
2112 prefix argument, really list all groups that are available, but aren't
2113 currently (un)subscribed. This could entail reading the active file
2118 @findex gnus-group-list-zombies
2119 List all zombie groups (@code{gnus-group-list-zombies}).
2123 @findex gnus-group-list-matching
2124 List all unread, subscribed groups with names that match a regexp
2125 (@code{gnus-group-list-matching}).
2129 @findex gnus-group-list-all-matching
2130 List groups that match a regexp (@code{gnus-group-list-all-matching}).
2134 @findex gnus-group-list-active
2135 List absolutely all groups that are in the active file(s) of the
2136 server(s) you are connected to (@code{gnus-group-list-active}). This
2137 might very well take quite a while. It might actually be a better idea
2138 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
2139 thing to match on. Also note that this command may list groups that
2140 don't exist (yet)---these will be listed as if they were killed groups.
2141 Take the output with some grains of salt.
2145 @findex gnus-group-apropos
2146 List all groups that have names that match a regexp
2147 (@code{gnus-group-apropos}).
2151 @findex gnus-group-description-apropos
2152 List all groups that have names or descriptions that match a regexp
2153 (@code{gnus-group-description-apropos}).
2157 @vindex gnus-permanently-visible-groups
2158 @cindex visible group parameter
2159 Groups that match the @code{gnus-permanently-visible-groups} regexp will
2160 always be shown, whether they have unread articles or not. You can also
2161 add the @code{visible} element to the group parameters in question to
2162 get the same effect.
2164 @vindex gnus-list-groups-with-ticked-articles
2165 Groups that have just ticked articles in it are normally listed in the
2166 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
2167 @code{nil}, these groups will be treated just like totally empty
2168 groups. It is @code{t} by default.
2171 @node Sorting Groups
2172 @section Sorting Groups
2173 @cindex sorting groups
2175 @kindex C-c C-s (Group)
2176 @findex gnus-group-sort-groups
2177 @vindex gnus-group-sort-function
2178 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
2179 group buffer according to the function(s) given by the
2180 @code{gnus-group-sort-function} variable. Available sorting functions
2185 @item gnus-group-sort-by-alphabet
2186 @findex gnus-group-sort-by-alphabet
2187 Sort the group names alphabetically. This is the default.
2189 @item gnus-group-sort-by-real-name
2190 @findex gnus-group-sort-by-real-name
2191 Sort the group alphabetically on the real (unprefixed) group names.
2193 @item gnus-group-sort-by-level
2194 @findex gnus-group-sort-by-level
2195 Sort by group level.
2197 @item gnus-group-sort-by-score
2198 @findex gnus-group-sort-by-score
2199 Sort by group score.
2201 @item gnus-group-sort-by-rank
2202 @findex gnus-group-sort-by-rank
2203 Sort by group score and then the group level. The level and the score
2204 are, when taken together, the group's @dfn{rank}.
2206 @item gnus-group-sort-by-unread
2207 @findex gnus-group-sort-by-unread
2208 Sort by number of unread articles.
2210 @item gnus-group-sort-by-method
2211 @findex gnus-group-sort-by-method
2212 Sort alphabetically on the select method.
2217 @code{gnus-group-sort-function} can also be a list of sorting
2218 functions. In that case, the most significant sort key function must be
2222 There are also a number of commands for sorting directly according to
2223 some sorting criteria:
2227 @kindex G S a (Group)
2228 @findex gnus-group-sort-groups-by-alphabet
2229 Sort the group buffer alphabetically by group name
2230 (@code{gnus-group-sort-groups-by-alphabet}).
2233 @kindex G S u (Group)
2234 @findex gnus-group-sort-groups-by-unread
2235 Sort the group buffer by the number of unread articles
2236 (@code{gnus-group-sort-groups-by-unread}).
2239 @kindex G S l (Group)
2240 @findex gnus-group-sort-groups-by-level
2241 Sort the group buffer by group level
2242 (@code{gnus-group-sort-groups-by-level}).
2245 @kindex G S v (Group)
2246 @findex gnus-group-sort-groups-by-score
2247 Sort the group buffer by group score
2248 (@code{gnus-group-sort-groups-by-score}).
2251 @kindex G S r (Group)
2252 @findex gnus-group-sort-groups-by-rank
2253 Sort the group buffer by group rank
2254 (@code{gnus-group-sort-groups-by-rank}).
2257 @kindex G S m (Group)
2258 @findex gnus-group-sort-groups-by-method
2259 Sort the group buffer alphabetically by backend name
2260 (@code{gnus-group-sort-groups-by-method}).
2264 When given a prefix, all these commands will sort in reverse order.
2266 You can also sort a subset of the groups:
2270 @kindex G P a (Group)
2271 @findex gnus-group-sort-selected-groups-by-alphabet
2272 Sort the process/prefixed groups in the group buffer alphabetically by
2273 group name (@code{gnus-group-sort-selected-groups-by-alphabet}).
2276 @kindex G P u (Group)
2277 @findex gnus-group-sort-selected-groups-by-unread
2278 Sort the process/prefixed groups in the group buffer by the number of
2279 unread articles (@code{gnus-group-sort-selected-groups-by-unread}).
2282 @kindex G P l (Group)
2283 @findex gnus-group-sort-selected-groups-by-level
2284 Sort the process/prefixed groups in the group buffer by group level
2285 (@code{gnus-group-sort-selected-groups-by-level}).
2288 @kindex G P v (Group)
2289 @findex gnus-group-sort-selected-groups-by-score
2290 Sort the process/prefixed groups in the group buffer by group score
2291 (@code{gnus-group-sort-selected-groups-by-score}).
2294 @kindex G P r (Group)
2295 @findex gnus-group-sort-selected-groups-by-rank
2296 Sort the process/prefixed groups in the group buffer by group rank
2297 (@code{gnus-group-sort-selected-groups-by-rank}).
2300 @kindex G P m (Group)
2301 @findex gnus-group-sort-selected-groups-by-method
2302 Sort the process/prefixed groups in the group buffer alphabetically by
2303 backend name (@code{gnus-group-sort-selected-groups-by-method}).
2309 @node Group Maintenance
2310 @section Group Maintenance
2311 @cindex bogus groups
2316 @findex gnus-group-check-bogus-groups
2317 Find bogus groups and delete them
2318 (@code{gnus-group-check-bogus-groups}).
2322 @findex gnus-group-find-new-groups
2323 Find new groups and process them (@code{gnus-group-find-new-groups}).
2324 If given a prefix, use the @code{ask-server} method to query the server
2328 @kindex C-c C-x (Group)
2329 @findex gnus-group-expire-articles
2330 Run all expirable articles in the current group through the expiry
2331 process (if any) (@code{gnus-group-expire-articles}).
2334 @kindex C-c M-C-x (Group)
2335 @findex gnus-group-expire-all-groups
2336 Run all articles in all groups through the expiry process
2337 (@code{gnus-group-expire-all-groups}).
2342 @node Browse Foreign Server
2343 @section Browse Foreign Server
2344 @cindex foreign servers
2345 @cindex browsing servers
2350 @findex gnus-group-browse-foreign-server
2351 You will be queried for a select method and a server name. Gnus will
2352 then attempt to contact this server and let you browse the groups there
2353 (@code{gnus-group-browse-foreign-server}).
2356 @findex gnus-browse-mode
2357 A new buffer with a list of available groups will appear. This buffer
2358 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
2359 a lot) like a normal group buffer.
2361 Here's a list of keystrokes available in the browse mode:
2366 @findex gnus-group-next-group
2367 Go to the next group (@code{gnus-group-next-group}).
2371 @findex gnus-group-prev-group
2372 Go to the previous group (@code{gnus-group-prev-group}).
2375 @kindex SPACE (Browse)
2376 @findex gnus-browse-read-group
2377 Enter the current group and display the first article
2378 (@code{gnus-browse-read-group}).
2381 @kindex RET (Browse)
2382 @findex gnus-browse-select-group
2383 Enter the current group (@code{gnus-browse-select-group}).
2387 @findex gnus-browse-unsubscribe-current-group
2388 Unsubscribe to the current group, or, as will be the case here,
2389 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
2395 @findex gnus-browse-exit
2396 Exit browse mode (@code{gnus-browse-exit}).
2400 @findex gnus-browse-describe-briefly
2401 Describe browse mode briefly (well, there's not much to describe, is
2402 there) (@code{gnus-browse-describe-briefly}).
2407 @section Exiting Gnus
2408 @cindex exiting Gnus
2410 Yes, Gnus is ex(c)iting.
2415 @findex gnus-group-suspend
2416 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
2417 but it kills all buffers except the Group buffer. I'm not sure why this
2418 is a gain, but then who am I to judge?
2422 @findex gnus-group-exit
2423 @c @icon{gnus-group-exit}
2424 Quit Gnus (@code{gnus-group-exit}).
2428 @findex gnus-group-quit
2429 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
2430 The dribble file will be saved, though (@pxref{Auto Save}).
2433 @vindex gnus-exit-gnus-hook
2434 @vindex gnus-suspend-gnus-hook
2435 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
2436 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
2437 @code{gnus-after-exiting-gnus-hook} is called as the final item when
2442 If you wish to completely unload Gnus and all its adherents, you can use
2443 the @code{gnus-unload} command. This command is also very handy when
2444 trying to customize meta-variables.
2449 Miss Lisa Cannifax, while sitting in English class, felt her feet go
2450 numbly heavy and herself fall into a hazy trance as the boy sitting
2451 behind her drew repeated lines with his pencil across the back of her
2457 @section Group Topics
2460 If you read lots and lots of groups, it might be convenient to group
2461 them hierarchically according to topics. You put your Emacs groups over
2462 here, your sex groups over there, and the rest (what, two groups or so?)
2463 you put in some misc section that you never bother with anyway. You can
2464 even group the Emacs sex groups as a sub-topic to either the Emacs
2465 groups or the sex groups---or both! Go wild!
2469 \gnusfigure{Group Topics}{400}{
2470 \put(75,50){\epsfig{figure=tmp/group-topic.ps,height=9cm}}
2481 2: alt.religion.emacs
2484 0: comp.talk.emacs.recovery
2486 8: comp.binaries.fractals
2487 13: comp.sources.unix
2490 @findex gnus-topic-mode
2492 To get this @emph{fab} functionality you simply turn on (ooh!) the
2493 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
2494 is a toggling command.)
2496 Go ahead, just try it. I'll still be here when you get back. La de
2497 dum... Nice tune, that... la la la... What, you're back? Yes, and now
2498 press @kbd{l}. There. All your groups are now listed under
2499 @samp{misc}. Doesn't that make you feel all warm and fuzzy? Hot and
2502 If you want this permanently enabled, you should add that minor mode to
2503 the hook for the group mode:
2506 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
2510 * Topic Variables:: How to customize the topics the Lisp Way.
2511 * Topic Commands:: Interactive E-Z commands.
2512 * Topic Sorting:: Sorting each topic individually.
2513 * Topic Topology:: A map of the world.
2514 * Topic Parameters:: Parameters that apply to all groups in a topic.
2518 @node Topic Variables
2519 @subsection Topic Variables
2520 @cindex topic variables
2522 Now, if you select a topic, it will fold/unfold that topic, which is
2523 really neat, I think.
2525 @vindex gnus-topic-line-format
2526 The topic lines themselves are created according to the
2527 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
2540 Number of groups in the topic.
2542 Number of unread articles in the topic.
2544 Number of unread articles in the topic and all its subtopics.
2547 @vindex gnus-topic-indent-level
2548 Each sub-topic (and the groups in the sub-topics) will be indented with
2549 @code{gnus-topic-indent-level} times the topic level number of spaces.
2552 @vindex gnus-topic-mode-hook
2553 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
2555 @vindex gnus-topic-display-empty-topics
2556 The @code{gnus-topic-display-empty-topics} says whether to display even
2557 topics that have no unread articles in them. The default is @code{t}.
2560 @node Topic Commands
2561 @subsection Topic Commands
2562 @cindex topic commands
2564 When the topic minor mode is turned on, a new @kbd{T} submap will be
2565 available. In addition, a few of the standard keys change their
2566 definitions slightly.
2572 @findex gnus-topic-create-topic
2573 Prompt for a new topic name and create it
2574 (@code{gnus-topic-create-topic}).
2578 @findex gnus-topic-move-group
2579 Move the current group to some other topic
2580 (@code{gnus-topic-move-group}). This command uses the process/prefix
2581 convention (@pxref{Process/Prefix}).
2585 @findex gnus-topic-copy-group
2586 Copy the current group to some other topic
2587 (@code{gnus-topic-copy-group}). This command uses the process/prefix
2588 convention (@pxref{Process/Prefix}).
2592 @findex gnus-topic-remove-group
2593 Remove a group from the current topic (@code{gnus-topic-remove-group}).
2594 This command uses the process/prefix convention
2595 (@pxref{Process/Prefix}).
2599 @findex gnus-topic-move-matching
2600 Move all groups that match some regular expression to a topic
2601 (@code{gnus-topic-move-matching}).
2605 @findex gnus-topic-copy-matching
2606 Copy all groups that match some regular expression to a topic
2607 (@code{gnus-topic-copy-matching}).
2611 @findex gnus-topic-toggle-display-empty-topics
2612 Toggle hiding empty topics
2613 (@code{gnus-topic-toggle-display-empty-topics}).
2617 @findex gnus-topic-mark-topic
2618 Mark all groups in the current topic with the process mark
2619 (@code{gnus-topic-mark-topic}).
2622 @kindex T M-# (Topic)
2623 @findex gnus-topic-unmark-topic
2624 Remove the process mark from all groups in the current topic
2625 (@code{gnus-topic-unmark-topic}).
2629 @findex gnus-topic-select-group
2631 Either select a group or fold a topic (@code{gnus-topic-select-group}).
2632 When you perform this command on a group, you'll enter the group, as
2633 usual. When done on a topic line, the topic will be folded (if it was
2634 visible) or unfolded (if it was folded already). So it's basically a
2635 toggling command on topics. In addition, if you give a numerical
2636 prefix, group on that level (and lower) will be displayed.
2639 @kindex T TAB (Topic)
2640 @findex gnus-topic-indent
2641 ``Indent'' the current topic so that it becomes a sub-topic of the
2642 previous topic (@code{gnus-topic-indent}). If given a prefix,
2643 ``un-indent'' the topic instead.
2647 @findex gnus-topic-kill-group
2648 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
2649 topic will be removed along with the topic.
2653 @findex gnus-topic-yank-group
2654 Yank the previously killed group or topic
2655 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
2660 @findex gnus-topic-rename
2661 Rename a topic (@code{gnus-topic-rename}).
2664 @kindex T DEL (Topic)
2665 @findex gnus-topic-delete
2666 Delete an empty topic (@code{gnus-topic-delete}).
2670 @findex gnus-topic-list-active
2671 List all groups that Gnus knows about in a topics-ified way
2672 (@code{gnus-topic-list-active}).
2676 @findex gnus-topic-edit-parameters
2677 @cindex group parameters
2678 @cindex topic parameters
2680 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
2681 @xref{Topic Parameters}.
2687 @subsection Topic Sorting
2688 @cindex topic sorting
2690 You can sort the groups in each topic individually with the following
2696 @kindex T S a (Topic)
2697 @findex gnus-topic-sort-groups-by-alphabet
2698 Sort the current topic alphabetically by group name
2699 (@code{gnus-topic-sort-groups-by-alphabet}).
2702 @kindex T S u (Topic)
2703 @findex gnus-topic-sort-groups-by-unread
2704 Sort the current topic by the number of unread articles
2705 (@code{gnus-topic-sort-groups-by-unread}).
2708 @kindex T S l (Topic)
2709 @findex gnus-topic-sort-groups-by-level
2710 Sort the current topic by group level
2711 (@code{gnus-topic-sort-groups-by-level}).
2714 @kindex T S v (Topic)
2715 @findex gnus-topic-sort-groups-by-score
2716 Sort the current topic by group score
2717 (@code{gnus-topic-sort-groups-by-score}).
2720 @kindex T S r (Topic)
2721 @findex gnus-topic-sort-groups-by-rank
2722 Sort the current topic by group rank
2723 (@code{gnus-topic-sort-groups-by-rank}).
2726 @kindex T S m (Topic)
2727 @findex gnus-topic-sort-groups-by-method
2728 Sort the current topic alphabetically by backend name
2729 (@code{gnus-topic-sort-groups-by-method}).
2733 @xref{Sorting Groups} for more information about group sorting.
2736 @node Topic Topology
2737 @subsection Topic Topology
2738 @cindex topic topology
2741 So, let's have a look at an example group buffer:
2747 2: alt.religion.emacs
2750 0: comp.talk.emacs.recovery
2752 8: comp.binaries.fractals
2753 13: comp.sources.unix
2756 So, here we have one top-level topic (@samp{Gnus}), two topics under
2757 that, and one sub-topic under one of the sub-topics. (There is always
2758 just one (1) top-level topic). This topology can be expressed as
2763 (("Emacs -- I wuw it!" visible)
2764 (("Naughty Emacs" visible)))
2768 @vindex gnus-topic-topology
2769 This is in fact how the variable @code{gnus-topic-topology} would look
2770 for the display above. That variable is saved in the @file{.newsrc.eld}
2771 file, and shouldn't be messed with manually---unless you really want
2772 to. Since this variable is read from the @file{.newsrc.eld} file,
2773 setting it in any other startup files will have no effect.
2775 This topology shows what topics are sub-topics of what topics (right),
2776 and which topics are visible. Two settings are currently
2777 allowed---@code{visible} and @code{invisible}.
2780 @node Topic Parameters
2781 @subsection Topic Parameters
2782 @cindex topic parameters
2784 All groups in a topic will inherit group parameters from the parent (and
2785 ancestor) topic parameters. All legal group parameters are legal topic
2786 parameters (@pxref{Group Parameters}).
2788 Group parameters (of course) override topic parameters, and topic
2789 parameters in sub-topics override topic parameters in super-topics. You
2790 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
2791 verb, although you may feel free to disagree with me here.)
2797 2: alt.religion.emacs
2801 0: comp.talk.emacs.recovery
2803 8: comp.binaries.fractals
2804 13: comp.sources.unix
2808 The @samp{Emacs} topic has the topic parameter @code{(score-file
2809 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
2810 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
2811 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
2812 @samp{alt.religion.emacs} has the group parameter @code{(score-file
2813 . "religion.SCORE")}.
2815 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
2816 will get the @file{relief.SCORE} home score file. If you enter the same
2817 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
2818 score file. If you enter the group @samp{alt.religion.emacs}, you'll
2819 get the @file{religion.SCORE} home score file.
2821 This seems rather simple and self-evident, doesn't it? Well, yes. But
2822 there are some problems, especially with the @code{total-expiry}
2823 parameter. Say you have a mail group in two topics; one with
2824 @code{total-expiry} and one without. What happens when you do @kbd{M-x
2825 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
2826 of these topics you mean to expire articles from, so anything may
2827 happen. In fact, I hereby declare that it is @dfn{undefined} what
2828 happens. You just have to be careful if you do stuff like that.
2831 @node Misc Group Stuff
2832 @section Misc Group Stuff
2835 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
2836 * Group Information:: Information and help on groups and Gnus.
2837 * Group Timestamp:: Making Gnus keep track of when you last read a group.
2838 * File Commands:: Reading and writing the Gnus files.
2845 @findex gnus-group-enter-server-mode
2846 Enter the server buffer (@code{gnus-group-enter-server-mode}).
2847 @xref{The Server Buffer}.
2851 @findex gnus-group-post-news
2852 Post an article to a group (@code{gnus-group-post-news}). The current
2853 group name will be used as the default.
2857 @findex gnus-group-mail
2858 Mail a message somewhere (@code{gnus-group-mail}).
2862 Variables for the group buffer:
2866 @item gnus-group-mode-hook
2867 @vindex gnus-group-mode-hook
2868 is called after the group buffer has been
2871 @item gnus-group-prepare-hook
2872 @vindex gnus-group-prepare-hook
2873 is called after the group buffer is
2874 generated. It may be used to modify the buffer in some strange,
2877 @item gnus-permanently-visible-groups
2878 @vindex gnus-permanently-visible-groups
2879 Groups matching this regexp will always be listed in the group buffer,
2880 whether they are empty or not.
2885 @node Scanning New Messages
2886 @subsection Scanning New Messages
2887 @cindex new messages
2888 @cindex scanning new news
2894 @findex gnus-group-get-new-news
2895 @c @icon{gnus-group-get-new-news}
2896 Check the server(s) for new articles. If the numerical prefix is used,
2897 this command will check only groups of level @var{arg} and lower
2898 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
2899 command will force a total re-reading of the active file(s) from the
2904 @findex gnus-group-get-new-news-this-group
2905 @vindex gnus-goto-next-group-when-activating
2906 @c @icon{gnus-group-get-new-news-this-group}
2907 Check whether new articles have arrived in the current group
2908 (@code{gnus-group-get-new-news-this-group}).
2909 @code{gnus-goto-next-group-when-activating} says whether this command is
2910 to move point to the next group or not. It is @code{t} by default.
2912 @findex gnus-activate-all-groups
2913 @cindex activating groups
2915 @kindex C-c M-g (Group)
2916 Activate absolutely all groups (@code{gnus-activate-all-groups}).
2921 @findex gnus-group-restart
2922 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
2923 file(s), closes the connection to all servers, clears up all run-time
2924 Gnus variables, and then starts Gnus all over again.
2928 @vindex gnus-get-new-news-hook
2929 @code{gnus-get-new-news-hook} is run just before checking for new news.
2931 @vindex gnus-after-getting-new-news-hook
2932 @code{gnus-after-getting-new-news-hook} is run after checking for new
2936 @node Group Information
2937 @subsection Group Information
2938 @cindex group information
2939 @cindex information on groups
2946 @findex gnus-group-fetch-faq
2947 @vindex gnus-group-faq-directory
2950 Try to fetch the FAQ for the current group
2951 (@code{gnus-group-fetch-faq}). Gnus will try to get the FAQ from
2952 @code{gnus-group-faq-directory}, which is usually a directory on a
2953 remote machine. This variable can also be a list of directories. In
2954 that case, giving a prefix to this command will allow you to choose
2955 between the various sites. @code{ange-ftp} (or @code{efs}) will be used
2956 for fetching the file.
2958 If fetching from the first site is unsuccessful, Gnus will attempt to go
2959 through @code{gnus-group-faq-directory} and try to open them one by one.
2963 @c @icon{gnus-group-describe-group}
2965 @kindex C-c C-d (Group)
2966 @cindex describing groups
2967 @cindex group description
2968 @findex gnus-group-describe-group
2969 Describe the current group (@code{gnus-group-describe-group}). If given
2970 a prefix, force Gnus to re-read the description from the server.
2974 @findex gnus-group-describe-all-groups
2975 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
2976 prefix, force Gnus to re-read the description file from the server.
2983 @findex gnus-version
2984 Display current Gnus version numbers (@code{gnus-version}).
2988 @findex gnus-group-describe-briefly
2989 Give a very short help message (@code{gnus-group-describe-briefly}).
2992 @kindex C-c C-i (Group)
2995 @findex gnus-info-find-node
2996 Go to the Gnus info node (@code{gnus-info-find-node}).
3000 @node Group Timestamp
3001 @subsection Group Timestamp
3003 @cindex group timestamps
3005 It can be convenient to let Gnus keep track of when you last read a
3006 group. To set the ball rolling, you should add
3007 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
3010 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
3013 After doing this, each time you enter a group, it'll be recorded.
3015 This information can be displayed in various ways---the easiest is to
3016 use the @samp{%d} spec in the group line format:
3019 (setq gnus-group-line-format
3020 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
3023 This will result in lines looking like:
3026 * 0: mail.ding 19961002T012943
3027 0: custom 19961002T012713
3030 As you can see, the date is displayed in compact ISO 8601 format. This
3031 may be a bit too much, so to just display the date, you could say
3035 (setq gnus-group-line-format
3036 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
3041 @subsection File Commands
3042 @cindex file commands
3048 @findex gnus-group-read-init-file
3049 @vindex gnus-init-file
3050 @cindex reading init file
3051 Re-read the init file (@code{gnus-init-file}, which defaults to
3052 @file{~/.gnus}) (@code{gnus-group-read-init-file}).
3056 @findex gnus-group-save-newsrc
3057 @cindex saving .newsrc
3058 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
3059 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
3060 file(s) whether Gnus thinks it is necessary or not.
3063 @c @kindex Z (Group)
3064 @c @findex gnus-group-clear-dribble
3065 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
3070 @node The Summary Buffer
3071 @chapter The Summary Buffer
3072 @cindex summary buffer
3074 A line for each article is displayed in the summary buffer. You can
3075 move around, read articles, post articles and reply to articles.
3077 The most common way to a summary buffer is to select a group from the
3078 group buffer (@pxref{Selecting a Group}).
3080 You can have as many summary buffers open as you wish.
3083 * Summary Buffer Format:: Deciding how the summary buffer is to look.
3084 * Summary Maneuvering:: Moving around the summary buffer.
3085 * Choosing Articles:: Reading articles.
3086 * Paging the Article:: Scrolling the current article.
3087 * Reply Followup and Post:: Posting articles.
3088 * Canceling and Superseding:: ``Whoops, I shouldn't have called him that.''
3089 * Marking Articles:: Marking articles as read, expirable, etc.
3090 * Limiting:: You can limit the summary buffer.
3091 * Threading:: How threads are made.
3092 * Sorting:: How articles and threads are sorted.
3093 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
3094 * Article Caching:: You may store articles in a cache.
3095 * Persistent Articles:: Making articles expiry-resistant.
3096 * Article Backlog:: Having already read articles hang around.
3097 * Saving Articles:: Ways of customizing article saving.
3098 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
3099 * Article Treatment:: The article buffer can be mangled at will.
3100 * Article Commands:: Doing various things with the article buffer.
3101 * Summary Sorting:: Sorting the summary buffer in various ways.
3102 * Finding the Parent:: No child support? Get the parent.
3103 * Alternative Approaches:: Reading using non-default summaries.
3104 * Tree Display:: A more visual display of threads.
3105 * Mail Group Commands:: Some commands can only be used in mail groups.
3106 * Various Summary Stuff:: What didn't fit anywhere else.
3107 * Exiting the Summary Buffer:: Returning to the Group buffer.
3108 * Crosspost Handling:: How crossposted articles are dealt with.
3109 * Duplicate Suppression:: An alternative when crosspost handling fails.
3113 @node Summary Buffer Format
3114 @section Summary Buffer Format
3115 @cindex summary buffer format
3119 \gnusfigure{The Summary Buffer}{180}{
3120 \put(0,0){\epsfig{figure=tmp/summary.ps,width=7.5cm}}
3121 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-article.ps,width=7.5cm}}}
3127 * Summary Buffer Lines:: You can specify how summary lines should look.
3128 * Summary Buffer Mode Line:: You can say how the mode line should look.
3129 * Summary Highlighting:: Making the summary buffer all pretty and nice.
3132 @findex mail-extract-address-components
3133 @findex gnus-extract-address-components
3134 @vindex gnus-extract-address-components
3135 Gnus will use the value of the @code{gnus-extract-address-components}
3136 variable as a function for getting the name and address parts of a
3137 @code{From} header. Two pre-defined functions exist:
3138 @code{gnus-extract-address-components}, which is the default, quite
3139 fast, and too simplistic solution; and
3140 @code{mail-extract-address-components}, which works very nicely, but is
3141 slower. The default function will return the wrong answer in 5% of the
3142 cases. If this is unacceptable to you, use the other function instead.
3144 @vindex gnus-summary-same-subject
3145 @code{gnus-summary-same-subject} is a string indicating that the current
3146 article has the same subject as the previous. This string will be used
3147 with those specs that require it. The default is @samp{}.
3150 @node Summary Buffer Lines
3151 @subsection Summary Buffer Lines
3153 @vindex gnus-summary-line-format
3154 You can change the format of the lines in the summary buffer by changing
3155 the @code{gnus-summary-line-format} variable. It works along the same
3156 lines as a normal @code{format} string, with some extensions
3157 (@pxref{Formatting Variables}).
3159 The default string is @samp{%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n}.
3161 The following format specification characters are understood:
3169 Subject if the article is the root or the previous article had a
3170 different subject, @code{gnus-summary-same-subject} otherwise.
3171 (@code{gnus-summary-same-subject} defaults to @samp{}.)
3173 Full @code{From} header.
3175 The name (from the @code{From} header).
3177 The name (from the @code{From} header). This differs from the @code{n}
3178 spec in that it uses the function designated by the
3179 @code{gnus-extract-address-components} variable, which is slower, but
3180 may be more thorough.
3182 The address (from the @code{From} header). This works the same way as
3185 Number of lines in the article.
3187 Number of characters in the article.
3189 Indentation based on thread level (@pxref{Customizing Threading}).
3191 Nothing if the article is a root and lots of spaces if it isn't (it
3192 pushes everything after it off the screen).
3194 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
3195 for adopted articles (@pxref{Customizing Threading}).
3197 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
3198 for adopted articles.
3200 One space for each thread level.
3202 Twenty minus thread level spaces.
3210 @vindex gnus-summary-zcore-fuzz
3211 Zcore, @samp{+} if above the default level and @samp{-} if below the
3212 default level. If the difference between
3213 @code{gnus-summary-default-level} and the score is less than
3214 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
3222 The @code{Date} in @code{DD-MMM} format.
3224 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
3230 Number of articles in the current sub-thread. Using this spec will slow
3231 down summary buffer generation somewhat.
3233 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
3234 article has any children.
3238 User defined specifier. The next character in the format string should
3239 be a letter. Gnus will call the function
3240 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
3241 following @samp{%u}. The function will be passed the current header as
3242 argument. The function should return a string, which will be inserted
3243 into the summary just like information from any other summary specifier.
3246 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
3247 have to be handled with care. For reasons of efficiency, Gnus will
3248 compute what column these characters will end up in, and ``hard-code''
3249 that. This means that it is illegal to have these specs after a
3250 variable-length spec. Well, you might not be arrested, but your summary
3251 buffer will look strange, which is bad enough.
3253 The smart choice is to have these specs as far to the left as possible.
3254 (Isn't that the case with everything, though? But I digress.)
3256 This restriction may disappear in later versions of Gnus.
3259 @node Summary Buffer Mode Line
3260 @subsection Summary Buffer Mode Line
3262 @vindex gnus-summary-mode-line-format
3263 You can also change the format of the summary mode bar. Set
3264 @code{gnus-summary-mode-line-format} to whatever you like. The default
3265 is @samp{Gnus: %%b [%A] %Z}.
3267 Here are the elements you can play with:
3273 Unprefixed group name.
3275 Current article number.
3279 Number of unread articles in this group.
3281 Number of unselected articles in this group.
3283 A string with the number of unread and unselected articles represented
3284 either as @samp{<%U(+%e) more>} if there are both unread and unselected
3285 articles, and just as @samp{<%U more>} if there are just unread articles
3286 and no unselected ones.
3288 Shortish group name. For instance, @samp{rec.arts.anime} will be
3289 shortened to @samp{r.a.anime}.
3291 Subject of the current article.
3295 Name of the current score file.
3297 Number of dormant articles.
3299 Number of ticked articles.
3301 Number of articles that have been marked as read in this session.
3303 Number of articles expunged by the score files.
3307 @node Summary Highlighting
3308 @subsection Summary Highlighting
3312 @item gnus-visual-mark-article-hook
3313 @vindex gnus-visual-mark-article-hook
3314 This hook is run after selecting an article. It is meant to be used for
3315 highlighting the article in some way. It is not run if
3316 @code{gnus-visual} is @code{nil}.
3318 @item gnus-summary-update-hook
3319 @vindex gnus-summary-update-hook
3320 This hook is called when a summary line is changed. It is not run if
3321 @code{gnus-visual} is @code{nil}.
3323 @item gnus-summary-selected-face
3324 @vindex gnus-summary-selected-face
3325 This is the face (or @dfn{font} as some people call it) that is used to
3326 highlight the current article in the summary buffer.
3328 @item gnus-summary-highlight
3329 @vindex gnus-summary-highlight
3330 Summary lines are highlighted according to this variable, which is a
3331 list where the elements are of the format @var{(FORM . FACE)}. If you
3332 would, for instance, like ticked articles to be italic and high-scored
3333 articles to be bold, you could set this variable to something like
3335 (((eq mark gnus-ticked-mark) . italic)
3336 ((> score default) . bold))
3338 As you may have guessed, if @var{FORM} returns a non-@code{nil} value,
3339 @var{FACE} will be applied to the line.
3343 @node Summary Maneuvering
3344 @section Summary Maneuvering
3345 @cindex summary movement
3347 All the straight movement commands understand the numeric prefix and
3348 behave pretty much as you'd expect.
3350 None of these commands select articles.
3355 @kindex M-n (Summary)
3356 @kindex G M-n (Summary)
3357 @findex gnus-summary-next-unread-subject
3358 Go to the next summary line of an unread article
3359 (@code{gnus-summary-next-unread-subject}).
3363 @kindex M-p (Summary)
3364 @kindex G M-p (Summary)
3365 @findex gnus-summary-prev-unread-subject
3366 Go to the previous summary line of an unread article
3367 (@code{gnus-summary-prev-unread-subject}).
3372 @kindex G j (Summary)
3373 @findex gnus-summary-goto-article
3374 Ask for an article number and then go to that article
3375 (@code{gnus-summary-goto-article}).
3378 @kindex G g (Summary)
3379 @findex gnus-summary-goto-subject
3380 Ask for an article number and then go to the summary line of that article
3381 without displaying the article (@code{gnus-summary-goto-subject}).
3384 If Gnus asks you to press a key to confirm going to the next group, you
3385 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
3386 buffer, searching for the next group to read without actually returning
3387 to the group buffer.
3389 Variables related to summary movement:
3393 @vindex gnus-auto-select-next
3394 @item gnus-auto-select-next
3395 If you issue one of the movement commands (like @kbd{n}) and there are
3396 no more unread articles after the current one, Gnus will offer to go to
3397 the next group. If this variable is @code{t} and the next group is
3398 empty, Gnus will exit summary mode and return to the group buffer. If
3399 this variable is neither @code{t} nor @code{nil}, Gnus will select the
3400 next group, no matter whether it has any unread articles or not. As a
3401 special case, if this variable is @code{quietly}, Gnus will select the
3402 next group without asking for confirmation. If this variable is
3403 @code{almost-quietly}, the same will happen only if you are located on
3404 the last article in the group. Finally, if this variable is
3405 @code{slightly-quietly}, the @kbd{Z n} command will go to the next group
3406 without confirmation. Also @pxref{Group Levels}.
3408 @item gnus-auto-select-same
3409 @vindex gnus-auto-select-same
3410 If non-@code{nil}, all the movement commands will try to go to the next
3411 article with the same subject as the current. (@dfn{Same} here might
3412 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
3413 for details (@pxref{Customizing Threading}).) This variable is not
3414 particularly useful if you use a threaded display.
3416 @item gnus-summary-check-current
3417 @vindex gnus-summary-check-current
3418 If non-@code{nil}, all the ``unread'' movement commands will not proceed
3419 to the next (or previous) article if the current article is unread.
3420 Instead, they will choose the current article.
3422 @item gnus-auto-center-summary
3423 @vindex gnus-auto-center-summary
3424 If non-@code{nil}, Gnus will keep the point in the summary buffer
3425 centered at all times. This makes things quite tidy, but if you have a
3426 slow network connection, or simply do not like this un-Emacsism, you can
3427 set this variable to @code{nil} to get the normal Emacs scrolling
3428 action. This will also inhibit horizontal re-centering of the summary
3429 buffer, which might make it more inconvenient to read extremely long
3435 @node Choosing Articles
3436 @section Choosing Articles
3437 @cindex selecting articles
3440 * Choosing Commands:: Commands for choosing articles.
3441 * Choosing Variables:: Variables that influence these commands.
3445 @node Choosing Commands
3446 @subsection Choosing Commands
3448 None of the following movement commands understand the numeric prefix,
3449 and they all select and display an article.
3453 @kindex SPACE (Summary)
3454 @findex gnus-summary-next-page
3455 Select the current article, or, if that one's read already, the next
3456 unread article (@code{gnus-summary-next-page}).
3461 @kindex G n (Summary)
3462 @findex gnus-summary-next-unread-article
3463 @c @icon{gnus-summary-next-unread}
3464 Go to next unread article (@code{gnus-summary-next-unread-article}).
3469 @findex gnus-summary-prev-unread-article
3470 @c @icon{gnus-summary-prev-unread}
3471 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
3476 @kindex G N (Summary)
3477 @findex gnus-summary-next-article
3478 Go to the next article (@code{gnus-summary-next-article}).
3483 @kindex G P (Summary)
3484 @findex gnus-summary-prev-article
3485 Go to the previous article (@code{gnus-summary-prev-article}).
3488 @kindex G C-n (Summary)
3489 @findex gnus-summary-next-same-subject
3490 Go to the next article with the same subject
3491 (@code{gnus-summary-next-same-subject}).
3494 @kindex G C-p (Summary)
3495 @findex gnus-summary-prev-same-subject
3496 Go to the previous article with the same subject
3497 (@code{gnus-summary-prev-same-subject}).
3501 @kindex G f (Summary)
3503 @findex gnus-summary-first-unread-article
3504 Go to the first unread article
3505 (@code{gnus-summary-first-unread-article}).
3509 @kindex G b (Summary)
3511 @findex gnus-summary-best-unread-article
3512 Go to the article with the highest score
3513 (@code{gnus-summary-best-unread-article}).
3518 @kindex G l (Summary)
3519 @findex gnus-summary-goto-last-article
3520 Go to the previous article read (@code{gnus-summary-goto-last-article}).
3523 @kindex G p (Summary)
3524 @findex gnus-summary-pop-article
3525 Pop an article off the summary history and go to this article
3526 (@code{gnus-summary-pop-article}). This command differs from the
3527 command above in that you can pop as many previous articles off the
3528 history as you like.
3532 @node Choosing Variables
3533 @subsection Choosing Variables
3535 Some variables that are relevant for moving and selecting articles:
3538 @item gnus-auto-extend-newsgroup
3539 @vindex gnus-auto-extend-newsgroup
3540 All the movement commands will try to go to the previous (or next)
3541 article, even if that article isn't displayed in the Summary buffer if
3542 this variable is non-@code{nil}. Gnus will then fetch the article from
3543 the server and display it in the article buffer.
3545 @item gnus-select-article-hook
3546 @vindex gnus-select-article-hook
3547 This hook is called whenever an article is selected. By default it
3548 exposes any threads hidden under the selected article.
3550 @item gnus-mark-article-hook
3551 @vindex gnus-mark-article-hook
3552 @findex gnus-summary-mark-unread-as-read
3553 @findex gnus-summary-mark-read-and-unread-as-read
3554 @findex gnus-unread-mark
3555 This hook is called whenever an article is selected. It is intended to
3556 be used for marking articles as read. The default value is
3557 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
3558 mark of almost any article you read to @code{gnus-unread-mark}. The
3559 only articles not affected by this function are ticked, dormant, and
3560 expirable articles. If you'd instead like to just have unread articles
3561 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
3562 instead. It will leave marks like @code{gnus-low-score-mark},
3563 @code{gnus-del-mark} (and so on) alone.
3568 @node Paging the Article
3569 @section Scrolling the Article
3570 @cindex article scrolling
3575 @kindex SPACE (Summary)
3576 @findex gnus-summary-next-page
3577 Pressing @kbd{SPACE} will scroll the current article forward one page,
3578 or, if you have come to the end of the current article, will choose the
3579 next article (@code{gnus-summary-next-page}).
3582 @kindex DEL (Summary)
3583 @findex gnus-summary-prev-page
3584 Scroll the current article back one page (@code{gnus-summary-prev-page}).
3587 @kindex RET (Summary)
3588 @findex gnus-summary-scroll-up
3589 Scroll the current article one line forward
3590 (@code{gnus-summary-scroll-up}).
3594 @kindex A g (Summary)
3596 @findex gnus-summary-show-article
3597 (Re)fetch the current article (@code{gnus-summary-show-article}). If
3598 given a prefix, fetch the current article, but don't run any of the
3599 article treatment functions. This will give you a ``raw'' article, just
3600 the way it came from the server.
3605 @kindex A < (Summary)
3606 @findex gnus-summary-beginning-of-article
3607 Scroll to the beginning of the article
3608 (@code{gnus-summary-beginning-of-article}).
3613 @kindex A > (Summary)
3614 @findex gnus-summary-end-of-article
3615 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
3619 @kindex A s (Summary)
3621 @findex gnus-summary-isearch-article
3622 Perform an isearch in the article buffer
3623 (@code{gnus-summary-isearch-article}).
3628 @node Reply Followup and Post
3629 @section Reply, Followup and Post
3632 * Summary Mail Commands:: Sending mail.
3633 * Summary Post Commands:: Sending news.
3637 @node Summary Mail Commands
3638 @subsection Summary Mail Commands
3640 @cindex composing mail
3642 Commands for composing a mail message:
3648 @kindex S r (Summary)
3650 @findex gnus-summary-reply
3651 @c @icon{gnus-summary-mail-reply}
3652 @c @icon{gnus-summary-reply}
3653 Mail a reply to the author of the current article
3654 (@code{gnus-summary-reply}).
3659 @kindex S R (Summary)
3660 @findex gnus-summary-reply-with-original
3661 @c @icon{gnus-summary-reply-with-original}
3662 Mail a reply to the author of the current article and include the
3663 original message (@code{gnus-summary-reply-with-original}). This
3664 command uses the process/prefix convention.
3667 @kindex S w (Summary)
3668 @findex gnus-summary-wide-reply
3669 Mail a wide reply to the author of the current article
3670 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
3671 goes out to all people listed in the @code{To}, @code{From} (or
3672 @code{Reply-to}) and @code{Cc} headers.
3675 @kindex S W (Summary)
3676 @findex gnus-summary-wide-reply-with-original
3677 Mail a wide reply to the current article and include the original
3678 message (@code{gnus-summary-reply-with-original}). This command uses
3679 the process/prefix convention.
3682 @kindex S o m (Summary)
3683 @findex gnus-summary-mail-forward
3684 @c @icon{gnus-summary-mail-forward}
3685 Forward the current article to some other person
3686 (@code{gnus-summary-mail-forward}). If given a prefix, include the full
3687 headers of the forwarded article.
3692 @kindex S m (Summary)
3693 @findex gnus-summary-mail-other-window
3694 @c @icon{gnus-summary-mail-originate}
3695 Send a mail to some other person
3696 (@code{gnus-summary-mail-other-window}).
3699 @kindex S D b (Summary)
3700 @findex gnus-summary-resend-bounced-mail
3701 @cindex bouncing mail
3702 If you have sent a mail, but the mail was bounced back to you for some
3703 reason (wrong address, transient failure), you can use this command to
3704 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
3705 will be popped into a mail buffer where you can edit the headers before
3706 sending the mail off again. If you give a prefix to this command, and
3707 the bounced mail is a reply to some other mail, Gnus will try to fetch
3708 that mail and display it for easy perusal of its headers. This might
3709 very well fail, though.
3712 @kindex S D r (Summary)
3713 @findex gnus-summary-resend-message
3714 Not to be confused with the previous command,
3715 @code{gnus-summary-resend-message} will prompt you for an address to
3716 send the current message off to, and then send it to that place. The
3717 headers of the message won't be altered---but lots of headers that say
3718 @code{Resent-To}, @code{Resent-From} and so on will be added. This
3719 means that you actually send a mail to someone that has a @code{To}
3720 header that (probably) points to yourself. This will confuse people.
3721 So, natcherly you'll only do that if you're really eVIl.
3723 This command is mainly used if you have several accounts and want to
3724 ship a mail to a different account of yours. (If you're both
3725 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
3726 to the @code{root} account, you may want to resend it to
3727 @code{postmaster}. Ordnung muß sein!
3729 This command understands the process/prefix convention
3730 (@pxref{Process/Prefix}).
3733 @kindex S O m (Summary)
3734 @findex gnus-uu-digest-mail-forward
3735 Digest the current series and forward the result using mail
3736 (@code{gnus-uu-digest-mail-forward}). This command uses the
3737 process/prefix convention (@pxref{Process/Prefix}).
3740 @kindex S M-c (Summary)
3741 @findex gnus-summary-mail-crosspost-complaint
3742 @cindex crossposting
3743 @cindex excessive crossposting
3744 Send a complaint about excessive crossposting to the author of the
3745 current article (@code{gnus-summary-mail-crosspost-complaint}).
3747 @findex gnus-crosspost-complaint
3748 This command is provided as a way to fight back agains the current
3749 crossposting pandemic that's sweeping Usenet. It will compose a reply
3750 using the @code{gnus-crosspost-complaint} variable as a preamble. This
3751 command understands the process/prefix convention
3752 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
3757 @node Summary Post Commands
3758 @subsection Summary Post Commands
3760 @cindex composing news
3762 Commands for posting a news article:
3768 @kindex S p (Summary)
3769 @findex gnus-summary-post-news
3770 @c @icon{gnus-summary-post-news}
3771 Post an article to the current group
3772 (@code{gnus-summary-post-news}).
3777 @kindex S f (Summary)
3778 @findex gnus-summary-followup
3779 @c @icon{gnus-summary-followup}
3780 Post a followup to the current article (@code{gnus-summary-followup}).
3784 @kindex S F (Summary)
3786 @c @icon{gnus-summary-followup-with-original}
3787 @findex gnus-summary-followup-with-original
3788 Post a followup to the current article and include the original message
3789 (@code{gnus-summary-followup-with-original}). This command uses the
3790 process/prefix convention.
3793 @kindex S n (Summary)
3794 @findex gnus-summary-followup-to-mail
3795 Post a followup to the current article via news, even if you got the
3796 message through mail (@code{gnus-summary-followup-to-mail}).
3799 @kindex S n (Summary)
3800 @findex gnus-summary-followup-to-mail
3801 Post a followup to the current article via news, even if you got the
3802 message through mail and include the original message
3803 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
3804 the process/prefix convention.
3807 @kindex S o p (Summary)
3808 @findex gnus-summary-post-forward
3809 Forward the current article to a newsgroup
3810 (@code{gnus-summary-post-forward}). If given a prefix, include the full
3811 headers of the forwarded article.
3814 @kindex S O p (Summary)
3815 @findex gnus-uu-digest-post-forward
3817 @cindex making digests
3818 Digest the current series and forward the result to a newsgroup
3819 (@code{gnus-uu-digest-mail-forward}). This command uses the
3820 process/prefix convention.
3823 @kindex S u (Summary)
3824 @findex gnus-uu-post-news
3825 @c @icon{gnus-uu-post-news}
3826 Uuencode a file, split it into parts, and post it as a series
3827 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
3831 @node Canceling and Superseding
3832 @section Canceling Articles
3833 @cindex canceling articles
3834 @cindex superseding articles
3836 Have you ever written something, and then decided that you really,
3837 really, really wish you hadn't posted that?
3839 Well, you can't cancel mail, but you can cancel posts.
3841 @findex gnus-summary-cancel-article
3843 @c @icon{gnus-summary-cancel-article}
3844 Find the article you wish to cancel (you can only cancel your own
3845 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
3846 c} (@code{gnus-summary-cancel-article}). Your article will be
3847 canceled---machines all over the world will be deleting your article.
3849 Be aware, however, that not all sites honor cancels, so your article may
3850 live on here and there, while most sites will delete the article in
3853 If you discover that you have made some mistakes and want to do some
3854 corrections, you can post a @dfn{superseding} article that will replace
3855 your original article.
3857 @findex gnus-summary-supersede-article
3859 Go to the original article and press @kbd{S s}
3860 (@code{gnus-summary-supersede-article}). You will be put in a buffer
3861 where you can edit the article all you want before sending it off the
3864 The same goes for superseding as for canceling, only more so: Some
3865 sites do not honor superseding. On those sites, it will appear that you
3866 have posted almost the same article twice.
3868 If you have just posted the article, and change your mind right away,
3869 there is a trick you can use to cancel/supersede the article without
3870 waiting for the article to appear on your site first. You simply return
3871 to the post buffer (which is called @code{*sent ...*}). There you will
3872 find the article you just posted, with all the headers intact. Change
3873 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
3874 header by substituting one of those words for the word
3875 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
3876 you would do normally. The previous article will be
3877 canceled/superseded.
3879 Just remember, kids: There is no 'c' in 'supersede'.
3882 @node Marking Articles
3883 @section Marking Articles
3884 @cindex article marking
3885 @cindex article ticking
3888 There are several marks you can set on an article.
3890 You have marks that decide the @dfn{readedness} (whoo, neato-keano
3891 neologism ohoy!) of the article. Alphabetic marks generally mean
3892 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
3894 In addition, you also have marks that do not affect readedness.
3897 * Unread Articles:: Marks for unread articles.
3898 * Read Articles:: Marks for read articles.
3899 * Other Marks:: Marks that do not affect readedness.
3903 There's a plethora of commands for manipulating these marks:
3907 * Setting Marks:: How to set and remove marks.
3908 * Setting Process Marks:: How to mark articles for later processing.
3912 @node Unread Articles
3913 @subsection Unread Articles
3915 The following marks mark articles as (kinda) unread, in one form or
3920 @vindex gnus-ticked-mark
3921 Marked as ticked (@code{gnus-ticked-mark}).
3923 @dfn{Ticked articles} are articles that will remain visible always. If
3924 you see an article that you find interesting, or you want to put off
3925 reading it, or replying to it, until sometime later, you'd typically
3926 tick it. However, articles can be expired, so if you want to keep an
3927 article forever, you'll have to make it persistent (@pxref{Persistent
3931 @vindex gnus-dormant-mark
3932 Marked as dormant (@code{gnus-dormant-mark}).
3934 @dfn{Dormant articles} will only appear in the summary buffer if there
3935 are followups to it.
3938 @vindex gnus-unread-mark
3939 Markes as unread (@code{gnus-unread-mark}).
3941 @dfn{Unread articles} are articles that haven't been read at all yet.
3946 @subsection Read Articles
3947 @cindex expirable mark
3949 All the following marks mark articles as read.
3954 @vindex gnus-del-mark
3955 These are articles that the user has marked as read with the @kbd{d}
3956 command manually, more or less (@code{gnus-del-mark}).
3959 @vindex gnus-read-mark
3960 Articles that have actually been read (@code{gnus-read-mark}).
3963 @vindex gnus-ancient-mark
3964 Articles that were marked as read in previous sessions and are now
3965 @dfn{old} (@code{gnus-ancient-mark}).
3968 @vindex gnus-killed-mark
3969 Marked as killed (@code{gnus-killed-mark}).
3972 @vindex gnus-kill-file-mark
3973 Marked as killed by kill files (@code{gnus-kill-file-mark}).
3976 @vindex gnus-low-score-mark
3977 Marked as read by having too low a score (@code{gnus-low-score-mark}).
3980 @vindex gnus-catchup-mark
3981 Marked as read by a catchup (@code{gnus-catchup-mark}).
3984 @vindex gnus-canceled-mark
3985 Canceled article (@code{gnus-canceled-mark})
3988 @vindex gnus-souped-mark
3989 @sc{SOUP}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
3992 @vindex gnus-sparse-mark
3993 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
3997 @vindex gnus-duplicate-mark
3998 Article marked as read by duplicate suppression
3999 (@code{gnus-duplicated-mark}). @xref{Duplicate Suppression}.
4003 All these marks just mean that the article is marked as read, really.
4004 They are interpreted differently when doing adaptive scoring, though.
4006 One more special mark, though:
4010 @vindex gnus-expirable-mark
4011 Marked as expirable (@code{gnus-expirable-mark}).
4013 Marking articles as @dfn{expirable} (or have them marked as such
4014 automatically) doesn't make much sense in normal groups---a user doesn't
4015 control expiring of news articles, but in mail groups, for instance,
4016 articles that are marked as @dfn{expirable} can be deleted by Gnus at
4022 @subsection Other Marks
4023 @cindex process mark
4026 There are some marks that have nothing to do with whether the article is
4032 You can set a bookmark in the current article. Say you are reading a
4033 long thesis on cats' urinary tracts, and have to go home for dinner
4034 before you've finished reading the thesis. You can then set a bookmark
4035 in the article, and Gnus will jump to this bookmark the next time it
4036 encounters the article. @xref{Setting Marks}
4039 @vindex gnus-replied-mark
4040 All articles that you have replied to or made a followup to (i.e., have
4041 answered) will be marked with an @samp{A} in the second column
4042 (@code{gnus-replied-mark}).
4045 @vindex gnus-cached-mark
4046 Articles that are stored in the article cache will be marked with an
4047 @samp{*} in the second column (@code{gnus-cached-mark}).
4050 @vindex gnus-saved-mark
4051 Articles that are ``saved'' (in some manner or other; not necessarily
4052 religiously) are marked with an @samp{S} in the second column
4053 (@code{gnus-saved-mark}).
4056 @vindex gnus-not-empty-thread-mark
4057 @vindex gnus-empty-thread-mark
4058 If the @samp{%e} spec is used, the presence of threads or not will be
4059 marked with @code{gnus-not-empty-thread-mark} and
4060 @code{gnus-empty-thread-mark} in the third column, respectively.
4063 @vindex gnus-process-mark
4064 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
4065 variety of commands react to the presence of the process mark. For
4066 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
4067 all articles that have been marked with the process mark. Articles
4068 marked with the process mark have a @samp{#} in the second column.
4072 You might have noticed that most of these ``non-readedness'' marks
4073 appear in the second column by default. So if you have a cached, saved,
4074 replied article that you have process-marked, what will that look like?
4076 Nothing much. The precedence rules go as follows: process -> cache ->
4077 replied -> saved. So if the article is in the cache and is replied,
4078 you'll only see the cache mark and not the replied mark.
4082 @subsection Setting Marks
4083 @cindex setting marks
4085 All the marking commands understand the numeric prefix.
4091 @kindex M t (Summary)
4092 @findex gnus-summary-tick-article-forward
4093 Tick the current article (@code{gnus-summary-tick-article-forward}).
4098 @kindex M ? (Summary)
4099 @findex gnus-summary-mark-as-dormant
4100 Mark the current article as dormant
4101 (@code{gnus-summary-mark-as-dormant}).
4105 @kindex M d (Summary)
4107 @findex gnus-summary-mark-as-read-forward
4108 Mark the current article as read
4109 (@code{gnus-summary-mark-as-read-forward}).
4113 @findex gnus-summary-mark-as-read-backward
4114 Mark the current article as read and move point to the previous line
4115 (@code{gnus-summary-mark-as-read-backward}).
4120 @kindex M k (Summary)
4121 @findex gnus-summary-kill-same-subject-and-select
4122 Mark all articles that have the same subject as the current one as read,
4123 and then select the next unread article
4124 (@code{gnus-summary-kill-same-subject-and-select}).
4128 @kindex M K (Summary)
4129 @kindex C-k (Summary)
4130 @findex gnus-summary-kill-same-subject
4131 Mark all articles that have the same subject as the current one as read
4132 (@code{gnus-summary-kill-same-subject}).
4135 @kindex M C (Summary)
4136 @findex gnus-summary-catchup
4137 @c @icon{gnus-summary-catchup}
4138 Mark all unread articles as read (@code{gnus-summary-catchup}).
4141 @kindex M C-c (Summary)
4142 @findex gnus-summary-catchup-all
4143 Mark all articles in the group as read---even the ticked and dormant
4144 articles (@code{gnus-summary-catchup-all}).
4147 @kindex M H (Summary)
4148 @findex gnus-summary-catchup-to-here
4149 Catchup the current group to point
4150 (@code{gnus-summary-catchup-to-here}).
4153 @kindex C-w (Summary)
4154 @findex gnus-summary-mark-region-as-read
4155 Mark all articles between point and mark as read
4156 (@code{gnus-summary-mark-region-as-read}).
4159 @kindex M V k (Summary)
4160 @findex gnus-summary-kill-below
4161 Kill all articles with scores below the default score (or below the
4162 numeric prefix) (@code{gnus-summary-kill-below}).
4166 @kindex M c (Summary)
4167 @kindex M-u (Summary)
4168 @findex gnus-summary-clear-mark-forward
4169 Clear all readedness-marks from the current article
4170 (@code{gnus-summary-clear-mark-forward}).
4174 @kindex M e (Summary)
4176 @findex gnus-summary-mark-as-expirable
4177 Mark the current article as expirable
4178 (@code{gnus-summary-mark-as-expirable}).
4181 @kindex M b (Summary)
4182 @findex gnus-summary-set-bookmark
4183 Set a bookmark in the current article
4184 (@code{gnus-summary-set-bookmark}).
4187 @kindex M B (Summary)
4188 @findex gnus-summary-remove-bookmark
4189 Remove the bookmark from the current article
4190 (@code{gnus-summary-remove-bookmark}).
4193 @kindex M V c (Summary)
4194 @findex gnus-summary-clear-above
4195 Clear all marks from articles with scores over the default score (or
4196 over the numeric prefix) (@code{gnus-summary-clear-above}).
4199 @kindex M V u (Summary)
4200 @findex gnus-summary-tick-above
4201 Tick all articles with scores over the default score (or over the
4202 numeric prefix) (@code{gnus-summary-tick-above}).
4205 @kindex M V m (Summary)
4206 @findex gnus-summary-mark-above
4207 Prompt for a mark, and mark all articles with scores over the default
4208 score (or over the numeric prefix) with this mark
4209 (@code{gnus-summary-clear-above}).
4212 @vindex gnus-summary-goto-unread
4213 The @code{gnus-summary-goto-unread} variable controls what action should
4214 be taken after setting a mark. If non-@code{nil}, point will move to
4215 the next/previous unread article. If @code{nil}, point will just move
4216 one line up or down. As a special case, if this variable is
4217 @code{never}, all the marking commands as well as other commands (like
4218 @kbd{SPACE}) will move to the next article, whether it is unread or not.
4219 The default is @code{t}.
4222 @node Setting Process Marks
4223 @subsection Setting Process Marks
4224 @cindex setting process marks
4231 @kindex M P p (Summary)
4232 @findex gnus-summary-mark-as-processable
4233 Mark the current article with the process mark
4234 (@code{gnus-summary-mark-as-processable}).
4235 @findex gnus-summary-unmark-as-processable
4239 @kindex M P u (Summary)
4240 @kindex M-# (Summary)
4241 Remove the process mark, if any, from the current article
4242 (@code{gnus-summary-unmark-as-processable}).
4245 @kindex M P U (Summary)
4246 @findex gnus-summary-unmark-all-processable
4247 Remove the process mark from all articles
4248 (@code{gnus-summary-unmark-all-processable}).
4251 @kindex M P i (Summary)
4252 @findex gnus-uu-invert-processable
4253 Invert the list of process marked articles
4254 (@code{gnus-uu-invert-processable}).
4257 @kindex M P R (Summary)
4258 @findex gnus-uu-mark-by-regexp
4259 Mark articles by a regular expression (@code{gnus-uu-mark-by-regexp}).
4262 @kindex M P r (Summary)
4263 @findex gnus-uu-mark-region
4264 Mark articles in region (@code{gnus-uu-mark-region}).
4267 @kindex M P t (Summary)
4268 @findex gnus-uu-mark-thread
4269 Mark all articles in the current (sub)thread
4270 (@code{gnus-uu-mark-thread}).
4273 @kindex M P T (Summary)
4274 @findex gnus-uu-unmark-thread
4275 Unmark all articles in the current (sub)thread
4276 (@code{gnus-uu-unmark-thread}).
4279 @kindex M P v (Summary)
4280 @findex gnus-uu-mark-over
4281 Mark all articles that have a score above the prefix argument
4282 (@code{gnus-uu-mark-over}).
4285 @kindex M P s (Summary)
4286 @findex gnus-uu-mark-series
4287 Mark all articles in the current series (@code{gnus-uu-mark-series}).
4290 @kindex M P S (Summary)
4291 @findex gnus-uu-mark-sparse
4292 Mark all series that have already had some articles marked
4293 (@code{gnus-uu-mark-sparse}).
4296 @kindex M P a (Summary)
4297 @findex gnus-uu-mark-all
4298 Mark all articles in series order (@code{gnus-uu-mark-series}).
4301 @kindex M P b (Summary)
4302 @findex gnus-uu-mark-buffer
4303 Mark all articles in the buffer in the order they appear
4304 (@code{gnus-uu-mark-buffer}).
4307 @kindex M P k (Summary)
4308 @findex gnus-summary-kill-process-mark
4309 Push the current process mark set onto the stack and unmark all articles
4310 (@code{gnus-summary-kill-process-mark}).
4313 @kindex M P y (Summary)
4314 @findex gnus-summary-yank-process-mark
4315 Pop the previous process mark set from the stack and restore it
4316 (@code{gnus-summary-yank-process-mark}).
4319 @kindex M P w (Summary)
4320 @findex gnus-summary-save-process-mark
4321 Push the current process mark set onto the stack
4322 (@code{gnus-summary-save-process-mark}).
4331 It can be convenient to limit the summary buffer to just show some
4332 subset of the articles currently in the group. The effect most limit
4333 commands have is to remove a few (or many) articles from the summary
4340 @kindex / / (Summary)
4341 @findex gnus-summary-limit-to-subject
4342 Limit the summary buffer to articles that match some subject
4343 (@code{gnus-summary-limit-to-subject}).
4346 @kindex / a (Summary)
4347 @findex gnus-summary-limit-to-author
4348 Limit the summary buffer to articles that match some author
4349 (@code{gnus-summary-limit-to-author}).
4353 @kindex / u (Summary)
4355 @findex gnus-summary-limit-to-unread
4356 Limit the summary buffer to articles that are not marked as read
4357 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
4358 buffer to articles that are strictly unread. This means that ticked and
4359 dormant articles will also be excluded.
4362 @kindex / m (Summary)
4363 @findex gnus-summary-limit-to-marks
4364 Ask for a mark and then limit to all articles that have not been marked
4365 with that mark (@code{gnus-summary-limit-to-marks}).
4368 @kindex / t (Summary)
4369 @findex gnus-summary-limit-to-age
4370 Ask for a number and then limit the summary buffer to articles that are
4371 older than (or equal to) that number of days
4372 (@code{gnus-summary-limit-to-marks}). If given a prefix, limit to
4373 articles that are younger than that number of days.
4376 @kindex / n (Summary)
4377 @findex gnus-summary-limit-to-articles
4378 Limit the summary buffer to the current article
4379 (@code{gnus-summary-limit-to-articles}). Uses the process/prefix
4380 convention (@pxref{Process/Prefix}).
4383 @kindex / w (Summary)
4384 @findex gnus-summary-pop-limit
4385 Pop the previous limit off the stack and restore it
4386 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
4390 @kindex / v (Summary)
4391 @findex gnus-summary-limit-to-score
4392 Limit the summary buffer to articles that have a score at or above some
4393 score (@code{gnus-summary-limit-to-score}).
4397 @kindex M S (Summary)
4398 @kindex / E (Summary)
4399 @findex gnus-summary-limit-include-expunged
4400 Display all expunged articles
4401 (@code{gnus-summary-limit-include-expunged}).
4404 @kindex / D (Summary)
4405 @findex gnus-summary-limit-include-dormant
4406 Display all dormant articles (@code{gnus-summary-limit-include-dormant}).
4409 @kindex / d (Summary)
4410 @findex gnus-summary-limit-exclude-dormant
4411 Hide all dormant articles (@code{gnus-summary-limit-exclude-dormant}).
4414 @kindex / c (Summary)
4415 @findex gnus-summary-limit-exclude-childless-dormant
4416 Hide all dormant articles that have no children
4417 (@code{gnus-summary-limit-exclude-childless-dormant}).
4420 @kindex / C (Summary)
4421 @findex gnus-summary-limit-mark-excluded-as-read
4422 Mark all excluded unread articles as read
4423 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
4424 also mark excluded ticked and dormant articles as read.
4432 @cindex article threading
4434 Gnus threads articles by default. @dfn{To thread} is to put responses
4435 to articles directly after the articles they respond to---in a
4436 hierarchical fashion.
4439 * Customizing Threading:: Variables you can change to affect the threading.
4440 * Thread Commands:: Thread based commands in the summary buffer.
4444 @node Customizing Threading
4445 @subsection Customizing Threading
4446 @cindex customizing threading
4452 @item gnus-show-threads
4453 @vindex gnus-show-threads
4454 If this variable is @code{nil}, no threading will be done, and all of
4455 the rest of the variables here will have no effect. Turning threading
4456 off will speed group selection up a bit, but it is sure to make reading
4457 slower and more awkward.
4459 @item gnus-fetch-old-headers
4460 @vindex gnus-fetch-old-headers
4461 If non-@code{nil}, Gnus will attempt to build old threads by fetching
4462 more old headers---headers to articles that are marked as read. If you
4463 would like to display as few summary lines as possible, but still
4464 connect as many loose threads as possible, you should set this variable
4465 to @code{some} or a number. If you set it to a number, no more than
4466 that number of extra old headers will be fetched. In either case,
4467 fetching old headers only works if the backend you are using carries
4468 overview files---this would normally be @code{nntp}, @code{nnspool} and
4469 @code{nnml}. Also remember that if the root of the thread has been
4470 expired by the server, there's not much Gnus can do about that.
4472 @item gnus-build-sparse-threads
4473 @vindex gnus-build-sparse-threads
4474 Fetching old headers can be slow. A low-rent similar effect can be
4475 gotten by setting this variable to @code{some}. Gnus will then look at
4476 the complete @code{References} headers of all articles and try to string
4477 together articles that belong in the same thread. This will leave
4478 @dfn{gaps} in the threading display where Gnus guesses that an article
4479 is missing from the thread. (These gaps appear like normal summary
4480 lines. If you select a gap, Gnus will try to fetch the article in
4481 question.) If this variable is @code{t}, Gnus will display all these
4482 ``gaps'' without regard for whether they are useful for completing the
4483 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
4484 off sparse leaf nodes that don't lead anywhere. This variable is
4485 @code{nil} by default.
4487 @item gnus-summary-gather-subject-limit
4488 @vindex gnus-summary-gather-subject-limit
4489 Loose threads are gathered by comparing subjects of articles. If this
4490 variable is @code{nil}, Gnus requires an exact match between the
4491 subjects of the loose threads before gathering them into one big
4492 super-thread. This might be too strict a requirement, what with the
4493 presence of stupid newsreaders that chop off long subject lines. If
4494 you think so, set this variable to, say, 20 to require that only the
4495 first 20 characters of the subjects have to match. If you set this
4496 variable to a really low number, you'll find that Gnus will gather
4497 everything in sight into one thread, which isn't very helpful.
4499 @cindex fuzzy article gathering
4500 If you set this variable to the special value @code{fuzzy}, Gnus will
4501 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
4504 @item gnus-simplify-subject-fuzzy-regexp
4505 @vindex gnus-simplify-subject-fuzzy-regexp
4506 This can either be a regular expression or list of regular expressions
4507 that match strings that will be removed from subjects if fuzzy subject
4508 simplification is used.
4510 @item gnus-simplify-ignored-prefixes
4511 @vindex gnus-simplify-ignored-prefixes
4512 If you set @code{gnus-summary-gather-subject-limit} to something as low
4513 as 10, you might consider setting this variable to something sensible:
4515 @c Written by Michael Ernst <mernst@cs.rice.edu>
4517 (setq gnus-simplify-ignored-prefixes
4523 "wanted" "followup" "summary\\( of\\)?"
4524 "help" "query" "problem" "question"
4525 "answer" "reference" "announce"
4526 "How can I" "How to" "Comparison of"
4531 (mapconcat 'identity
4532 '("for" "for reference" "with" "about")
4534 "\\)?\\]?:?[ \t]*"))
4537 All words that match this regexp will be removed before comparing two
4540 @item gnus-summary-gather-exclude-subject
4541 @vindex gnus-summary-gather-exclude-subject
4542 Since loose thread gathering is done on subjects only, that might lead
4543 to many false hits, especially with certain common subjects like
4544 @samp{} and @samp{(none)}. To make the situation slightly better,
4545 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
4546 what subjects should be excluded from the gathering process.@*
4547 The default is @samp{^ *$\\|^(none)$}.
4549 @item gnus-summary-thread-gathering-function
4550 @vindex gnus-summary-thread-gathering-function
4551 Gnus gathers threads by looking at @code{Subject} headers. This means
4552 that totally unrelated articles may end up in the same ``thread'', which
4553 is confusing. An alternate approach is to look at all the
4554 @code{Message-ID}s in all the @code{References} headers to find matches.
4555 This will ensure that no gathered threads ever include unrelated
4556 articles, but it also means that people who have posted with broken
4557 newsreaders won't be gathered properly. The choice is yours---plague or
4561 @item gnus-gather-threads-by-subject
4562 @findex gnus-gather-threads-by-subject
4563 This function is the default gathering function and looks at
4564 @code{Subject}s exclusively.
4566 @item gnus-gather-threads-by-references
4567 @findex gnus-gather-threads-by-references
4568 This function looks at @code{References} headers exclusively.
4571 If you want to test gathering by @code{References}, you could say
4575 (setq gnus-summary-thread-gathering-function
4576 'gnus-gather-threads-by-references)
4579 @item gnus-summary-make-false-root
4580 @vindex gnus-summary-make-false-root
4581 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
4582 and create a dummy root at the top. (Wait a minute. Root at the top?
4583 Yup.) Loose subtrees occur when the real root has expired, or you've
4584 read or killed the root in a previous session.
4586 When there is no real root of a thread, Gnus will have to fudge
4587 something. This variable says what fudging method Gnus should use.
4588 There are four possible values:
4592 \gnusfigure{The Summary Buffer}{390}{
4593 \put(0,0){\epsfig{figure=tmp/summary-adopt.ps,width=7.5cm}}
4594 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=tmp/summary-empty.ps,width=7.5cm}}}
4595 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=tmp/summary-none.ps,width=7.5cm}}}
4596 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=tmp/summary-dummy.ps,width=7.5cm}}}
4601 @cindex adopting articles
4606 Gnus will make the first of the orphaned articles the parent. This
4607 parent will adopt all the other articles. The adopted articles will be
4608 marked as such by pointy brackets (@samp{<>}) instead of the standard
4609 square brackets (@samp{[]}). This is the default method.
4612 @vindex gnus-summary-dummy-line-format
4613 Gnus will create a dummy summary line that will pretend to be the
4614 parent. This dummy line does not correspond to any real article, so
4615 selecting it will just select the first real article after the dummy
4616 article. @code{gnus-summary-dummy-line-format} is used to specify the
4617 format of the dummy roots. It accepts only one format spec: @samp{S},
4618 which is the subject of the article. @xref{Formatting Variables}.
4621 Gnus won't actually make any article the parent, but simply leave the
4622 subject field of all orphans except the first empty. (Actually, it will
4623 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
4627 Don't make any article parent at all. Just gather the threads and
4628 display them after one another.
4631 Don't gather loose threads.
4634 @item gnus-thread-hide-subtree
4635 @vindex gnus-thread-hide-subtree
4636 If non-@code{nil}, all threads will be hidden when the summary buffer is
4639 @item gnus-thread-expunge-below
4640 @vindex gnus-thread-expunge-below
4641 All threads that have a total score (as defined by
4642 @code{gnus-thread-score-function}) less than this number will be
4643 expunged. This variable is @code{nil} by default, which means that no
4644 threads are expunged.
4646 @item gnus-thread-hide-killed
4647 @vindex gnus-thread-hide-killed
4648 if you kill a thread and this variable is non-@code{nil}, the subtree
4651 @item gnus-thread-ignore-subject
4652 @vindex gnus-thread-ignore-subject
4653 Sometimes somebody changes the subject in the middle of a thread. If
4654 this variable is non-@code{nil}, the subject change is ignored. If it
4655 is @code{nil}, which is the default, a change in the subject will result
4658 @item gnus-thread-indent-level
4659 @vindex gnus-thread-indent-level
4660 This is a number that says how much each sub-thread should be indented.
4663 @item gnus-parse-headers-hook
4664 @vindex gnus-parse-headers-hook
4665 Hook run before parsing any headers. The default value is
4666 @code{(gnus-decode-rfc1522)}, which means that QPized headers will be
4667 slightly decoded in a hackish way. This is likely to change in the
4668 future when Gnus becomes @sc{MIME}ified.
4673 @node Thread Commands
4674 @subsection Thread Commands
4675 @cindex thread commands
4681 @kindex T k (Summary)
4682 @kindex M-C-k (Summary)
4683 @findex gnus-summary-kill-thread
4684 Mark all articles in the current (sub-)thread as read
4685 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
4686 remove all marks instead. If the prefix argument is negative, tick
4691 @kindex T l (Summary)
4692 @kindex M-C-l (Summary)
4693 @findex gnus-summary-lower-thread
4694 Lower the score of the current (sub-)thread
4695 (@code{gnus-summary-lower-thread}).
4698 @kindex T i (Summary)
4699 @findex gnus-summary-raise-thread
4700 Increase the score of the current (sub-)thread
4701 (@code{gnus-summary-raise-thread}).
4704 @kindex T # (Summary)
4705 @findex gnus-uu-mark-thread
4706 Set the process mark on the current (sub-)thread
4707 (@code{gnus-uu-mark-thread}).
4710 @kindex T M-# (Summary)
4711 @findex gnus-uu-unmark-thread
4712 Remove the process mark from the current (sub-)thread
4713 (@code{gnus-uu-unmark-thread}).
4716 @kindex T T (Summary)
4717 @findex gnus-summary-toggle-threads
4718 Toggle threading (@code{gnus-summary-toggle-threads}).
4721 @kindex T s (Summary)
4722 @findex gnus-summary-show-thread
4723 Expose the (sub-)thread hidden under the current article, if any
4724 (@code{gnus-summary-show-thread}).
4727 @kindex T h (Summary)
4728 @findex gnus-summary-hide-thread
4729 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
4732 @kindex T S (Summary)
4733 @findex gnus-summary-show-all-threads
4734 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
4737 @kindex T H (Summary)
4738 @findex gnus-summary-hide-all-threads
4739 Hide all threads (@code{gnus-summary-hide-all-threads}).
4742 @kindex T t (Summary)
4743 @findex gnus-summary-rethread-current
4744 Re-thread the current article's thread
4745 (@code{gnus-summary-rethread-current}). This works even when the
4746 summary buffer is otherwise unthreaded.
4749 @kindex T ^ (Summary)
4750 @findex gnus-summary-reparent-thread
4751 Make the current article the child of the marked (or previous) article
4752 (@code{gnus-summary-reparent-thread}).
4756 The following commands are thread movement commands. They all
4757 understand the numeric prefix.
4762 @kindex T n (Summary)
4763 @findex gnus-summary-next-thread
4764 Go to the next thread (@code{gnus-summary-next-thread}).
4767 @kindex T p (Summary)
4768 @findex gnus-summary-prev-thread
4769 Go to the previous thread (@code{gnus-summary-prev-thread}).
4772 @kindex T d (Summary)
4773 @findex gnus-summary-down-thread
4774 Descend the thread (@code{gnus-summary-down-thread}).
4777 @kindex T u (Summary)
4778 @findex gnus-summary-up-thread
4779 Ascend the thread (@code{gnus-summary-up-thread}).
4782 @kindex T o (Summary)
4783 @findex gnus-summary-top-thread
4784 Go to the top of the thread (@code{gnus-summary-top-thread}).
4787 @vindex gnus-thread-operation-ignore-subject
4788 If you ignore subject while threading, you'll naturally end up with
4789 threads that have several different subjects in them. If you then issue
4790 a command like `T k' (@code{gnus-summary-kill-thread}) you might not
4791 wish to kill the entire thread, but just those parts of the thread that
4792 have the same subject as the current article. If you like this idea,
4793 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
4794 is non-@code{nil} (which it is by default), subjects will be ignored
4795 when doing thread commands. If this variable is @code{nil}, articles in
4796 the same thread with different subjects will not be included in the
4797 operation in question. If this variable is @code{fuzzy}, only articles
4798 that have subjects that are fuzzily equal will be included (@pxref{Fuzzy
4805 @findex gnus-thread-sort-by-total-score
4806 @findex gnus-thread-sort-by-date
4807 @findex gnus-thread-sort-by-score
4808 @findex gnus-thread-sort-by-subject
4809 @findex gnus-thread-sort-by-author
4810 @findex gnus-thread-sort-by-number
4811 @vindex gnus-thread-sort-functions
4812 If you are using a threaded summary display, you can sort the threads by
4813 setting @code{gnus-thread-sort-functions}, which is a list of functions.
4814 By default, sorting is done on article numbers. Ready-made sorting
4815 predicate functions include @code{gnus-thread-sort-by-number},
4816 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-subject},
4817 @code{gnus-thread-sort-by-date}, @code{gnus-thread-sort-by-score}, and
4818 @code{gnus-thread-sort-by-total-score}.
4820 Each function takes two threads and returns non-@code{nil} if the first
4821 thread should be sorted before the other. Note that sorting really is
4822 normally done by looking only at the roots of each thread. If you use
4823 more than one function, the primary sort key should be the last function
4824 in the list. You should probably always include
4825 @code{gnus-thread-sort-by-number} in the list of sorting
4826 functions---preferably first. This will ensure that threads that are
4827 equal with respect to the other sort criteria will be displayed in
4828 ascending article order.
4830 If you would like to sort by score, then by subject, and finally by
4831 number, you could do something like:
4834 (setq gnus-thread-sort-functions
4835 '(gnus-thread-sort-by-number
4836 gnus-thread-sort-by-subject
4837 gnus-thread-sort-by-total-score))
4840 The threads that have highest score will be displayed first in the
4841 summary buffer. When threads have the same score, they will be sorted
4842 alphabetically. The threads that have the same score and the same
4843 subject will be sorted by number, which is (normally) the sequence in
4844 which the articles arrived.
4846 If you want to sort by score and then reverse arrival order, you could
4850 (setq gnus-thread-sort-functions
4852 (not (gnus-thread-sort-by-number t2 t1)))
4853 gnus-thread-sort-by-score))
4856 @vindex gnus-thread-score-function
4857 The function in the @code{gnus-thread-score-function} variable (default
4858 @code{+}) is used for calculating the total score of a thread. Useful
4859 functions might be @code{max}, @code{min}, or squared means, or whatever
4862 @findex gnus-article-sort-functions
4863 @findex gnus-article-sort-by-date
4864 @findex gnus-article-sort-by-score
4865 @findex gnus-article-sort-by-subject
4866 @findex gnus-article-sort-by-author
4867 @findex gnus-article-sort-by-number
4868 If you are using an unthreaded display for some strange reason or other,
4869 you have to fiddle with the @code{gnus-article-sort-functions} variable.
4870 It is very similar to the @code{gnus-thread-sort-functions}, except that
4871 is uses slightly different functions for article comparison. Available
4872 sorting predicate functions are @code{gnus-article-sort-by-number},
4873 @code{gnus-article-sort-by-author}, @code{gnus-article-sort-by-subject},
4874 @code{gnus-article-sort-by-date}, and @code{gnus-article-sort-by-score}.
4876 If you want to sort an unthreaded summary display by subject, you could
4880 (setq gnus-article-sort-functions
4881 '(gnus-article-sort-by-number
4882 gnus-article-sort-by-subject))
4887 @node Asynchronous Fetching
4888 @section Asynchronous Article Fetching
4889 @cindex asynchronous article fetching
4890 @cindex article pre-fetch
4893 If you read your news from an @sc{nntp} server that's far away, the
4894 network latencies may make reading articles a chore. You have to wait
4895 for a while after pressing @kbd{n} to go to the next article before the
4896 article appears. Why can't Gnus just go ahead and fetch the article
4897 while you are reading the previous one? Why not, indeed.
4899 First, some caveats. There are some pitfalls to using asynchronous
4900 article fetching, especially the way Gnus does it.
4902 Let's say you are reading article 1, which is short, and article 2 is
4903 quite long, and you are not interested in reading that. Gnus does not
4904 know this, so it goes ahead and fetches article 2. You decide to read
4905 article 3, but since Gnus is in the process of fetching article 2, the
4906 connection is blocked.
4908 To avoid these situations, Gnus will open two (count 'em two)
4909 connections to the server. Some people may think this isn't a very nice
4910 thing to do, but I don't see any real alternatives. Setting up that
4911 extra connection takes some time, so Gnus startup will be slower.
4913 Gnus will fetch more articles than you will read. This will mean that
4914 the link between your machine and the @sc{nntp} server will become more
4915 loaded than if you didn't use article pre-fetch. The server itself will
4916 also become more loaded---both with the extra article requests, and the
4919 Ok, so now you know that you shouldn't really use this thing... unless
4922 @vindex gnus-asynchronous
4923 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
4924 happen automatically.
4926 @vindex gnus-use-article-prefetch
4927 You can control how many articles are to be pre-fetched by setting
4928 @code{gnus-use-article-prefetch}. This is 30 by default, which means
4929 that when you read an article in the group, the backend will pre-fetch
4930 the next 30 articles. If this variable is @code{t}, the backend will
4931 pre-fetch all the articles it can without bound. If it is
4932 @code{nil}, no pre-fetching will be done.
4934 @vindex gnus-async-prefetch-article-p
4935 @findex gnus-async-read-p
4936 There are probably some articles that you don't want to pre-fetch---read
4937 articles, for instance. The @code{gnus-async-prefetch-article-p} variable controls whether an article is to be pre-fetched. This function should
4938 return non-@code{nil} when the article in question is to be
4939 pre-fetched. The default is @code{gnus-async-read-p}, which returns
4940 @code{nil} on read articles. The function is called with an article
4941 data structure as the only parameter.
4943 If, for instance, you wish to pre-fetch only unread articles that are
4944 shorter than 100 lines, you could say something like:
4947 (defun my-async-short-unread-p (data)
4948 "Return non-nil for short, unread articles."
4949 (and (gnus-data-unread-p data)
4950 (< (mail-header-lines (gnus-data-header data))
4953 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
4956 These functions will be called many, many times, so they should
4957 preferably be short and sweet to avoid slowing down Gnus too much.
4958 It's probably a good idea to byte-compile things like this.
4960 @vindex gnus-prefetched-article-deletion-strategy
4961 Articles have to be removed from the asynch buffer sooner or later. The
4962 @code{gnus-prefetched-article-deletion-strategy} says when to remove
4963 articles. This is a list that may contain the following elements:
4967 Remove articles when they are read.
4970 Remove articles when exiting the group.
4973 The default value is @code{(read exit)}.
4975 @vindex gnus-use-header-prefetch
4976 If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
4977 from the next group.
4980 @node Article Caching
4981 @section Article Caching
4982 @cindex article caching
4985 If you have an @emph{extremely} slow @sc{nntp} connection, you may
4986 consider turning article caching on. Each article will then be stored
4987 locally under your home directory. As you may surmise, this could
4988 potentially use @emph{huge} amounts of disk space, as well as eat up all
4989 your inodes so fast it will make your head swim. In vodka.
4991 Used carefully, though, it could be just an easier way to save articles.
4993 @vindex gnus-use-long-file-name
4994 @vindex gnus-cache-directory
4995 @vindex gnus-use-cache
4996 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
4997 all articles that are ticked or marked as dormant will then be copied
4998 over to your local cache (@code{gnus-cache-directory}). Whether this
4999 cache is flat or hierarchal is controlled by the
5000 @code{gnus-use-long-file-name} variable, as usual.
5002 When re-selecting a ticked or dormant article, it will be fetched from the
5003 cache instead of from the server. As articles in your cache will never
5004 expire, this might serve as a method of saving articles while still
5005 keeping them where they belong. Just mark all articles you want to save
5006 as dormant, and don't worry.
5008 When an article is marked as read, is it removed from the cache.
5010 @vindex gnus-cache-remove-articles
5011 @vindex gnus-cache-enter-articles
5012 The entering/removal of articles from the cache is controlled by the
5013 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
5014 variables. Both are lists of symbols. The first is @code{(ticked
5015 dormant)} by default, meaning that ticked and dormant articles will be
5016 put in the cache. The latter is @code{(read)} by default, meaning that
5017 articles that are marked as read are removed from the cache. Possibly
5018 symbols in these two lists are @code{ticked}, @code{dormant},
5019 @code{unread} and @code{read}.
5021 @findex gnus-jog-cache
5022 So where does the massive article-fetching and storing come into the
5023 picture? The @code{gnus-jog-cache} command will go through all
5024 subscribed newsgroups, request all unread articles, and store them in
5025 the cache. You should only ever, ever ever ever, use this command if 1)
5026 your connection to the @sc{nntp} server is really, really, really slow
5027 and 2) you have a really, really, really huge disk. Seriously.
5029 @vindex gnus-uncacheable-groups
5030 It is likely that you do not want caching on some groups. For instance,
5031 if your @code{nnml} mail is located under your home directory, it makes no
5032 sense to cache it somewhere else under your home directory. Unless you
5033 feel that it's neat to use twice as much space. To limit the caching,
5034 you could set the @code{gnus-uncacheable-groups} regexp to
5035 @samp{^nnml}, for instance. This variable is @code{nil} by
5038 @findex gnus-cache-generate-nov-databases
5039 @findex gnus-cache-generate-active
5040 @vindex gnus-cache-active-file
5041 The cache stores information on what articles it contains in its active
5042 file (@code{gnus-cache-active-file}). If this file (or any other parts
5043 of the cache) becomes all messed up for some reason or other, Gnus
5044 offers two functions that will try to set things right. @kbd{M-x
5045 gnus-cache-generate-nov-databases} will (re)build all the @sc{nov}
5046 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
5050 @node Persistent Articles
5051 @section Persistent Articles
5052 @cindex persistent articles
5054 Closely related to article caching, we have @dfn{persistent articles}.
5055 In fact, it's just a different way of looking at caching, and much more
5056 useful in my opinion.
5058 Say you're reading a newsgroup, and you happen on to some valuable gem
5059 that you want to keep and treasure forever. You'd normally just save it
5060 (using one of the many saving commands) in some file. The problem with
5061 that is that it's just, well, yucky. Ideally you'd prefer just having
5062 the article remain in the group where you found it forever; untouched by
5063 the expiry going on at the news server.
5065 This is what a @dfn{persistent article} is---an article that just won't
5066 be deleted. It's implemented using the normal cache functions, but
5067 you use two explicit commands for managing persistent articles:
5073 @findex gnus-cache-enter-article
5074 Make the current article persistent (@code{gnus-cache-enter-article}).
5077 @kindex M-* (Summary)
5078 @findex gnus-cache-remove-article
5079 Remove the current article from the persistent articles
5080 (@code{gnus-cache-remove-article}). This will normally delete the
5084 Both these commands understand the process/prefix convention.
5086 To avoid having all ticked articles (and stuff) entered into the cache,
5087 you should set @code{gnus-use-cache} to @code{passive} if you're just
5088 interested in persistent articles:
5091 (setq gnus-use-cache 'passive)
5095 @node Article Backlog
5096 @section Article Backlog
5098 @cindex article backlog
5100 If you have a slow connection, but the idea of using caching seems
5101 unappealing to you (and it is, really), you can help the situation some
5102 by switching on the @dfn{backlog}. This is where Gnus will buffer
5103 already read articles so that it doesn't have to re-fetch articles
5104 you've already read. This only helps if you are in the habit of
5105 re-selecting articles you've recently read, of course. If you never do
5106 that, turning the backlog on will slow Gnus down a little bit, and
5107 increase memory usage some.
5109 @vindex gnus-keep-backlog
5110 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
5111 at most @var{n} old articles in a buffer for later re-fetching. If this
5112 variable is non-@code{nil} and is not a number, Gnus will store
5113 @emph{all} read articles, which means that your Emacs will grow without
5114 bound before exploding and taking your machine down with you. I put
5115 that in there just to keep y'all on your toes.
5117 This variable is @code{nil} by default.
5120 @node Saving Articles
5121 @section Saving Articles
5122 @cindex saving articles
5124 Gnus can save articles in a number of ways. Below is the documentation
5125 for saving articles in a fairly straight-forward fashion (i.e., little
5126 processing of the article is done before it is saved). For a different
5127 approach (uudecoding, unsharing) you should use @code{gnus-uu}
5128 (@pxref{Decoding Articles}).
5130 @vindex gnus-save-all-headers
5131 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
5132 unwanted headers before saving the article.
5134 @vindex gnus-saved-headers
5135 If the preceding variable is @code{nil}, all headers that match the
5136 @code{gnus-saved-headers} regexp will be kept, while the rest will be
5137 deleted before saving.
5143 @kindex O o (Summary)
5145 @findex gnus-summary-save-article
5146 @c @icon{gnus-summary-save-article}
5147 Save the current article using the default article saver
5148 (@code{gnus-summary-save-article}).
5151 @kindex O m (Summary)
5152 @findex gnus-summary-save-article-mail
5153 Save the current article in mail format
5154 (@code{gnus-summary-save-article-mail}).
5157 @kindex O r (Summary)
5158 @findex gnus-summary-save-article-rmail
5159 Save the current article in rmail format
5160 (@code{gnus-summary-save-article-rmail}).
5163 @kindex O f (Summary)
5164 @findex gnus-summary-save-article-file
5165 @c @icon{gnus-summary-save-article-file}
5166 Save the current article in plain file format
5167 (@code{gnus-summary-save-article-file}).
5170 @kindex O F (Summary)
5171 @findex gnus-summary-write-article-file
5172 Write the current article in plain file format, overwriting any previous
5173 file contents (@code{gnus-summary-write-article-file}).
5176 @kindex O b (Summary)
5177 @findex gnus-summary-save-article-body-file
5178 Save the current article body in plain file format
5179 (@code{gnus-summary-save-article-body-file}).
5182 @kindex O h (Summary)
5183 @findex gnus-summary-save-article-folder
5184 Save the current article in mh folder format
5185 (@code{gnus-summary-save-article-folder}).
5188 @kindex O v (Summary)
5189 @findex gnus-summary-save-article-vm
5190 Save the current article in a VM folder
5191 (@code{gnus-summary-save-article-vm}).
5194 @kindex O p (Summary)
5195 @findex gnus-summary-pipe-output
5196 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
5197 the current article to a process (@code{gnus-summary-pipe-output}).
5200 @vindex gnus-prompt-before-saving
5201 All these commands use the process/prefix convention
5202 (@pxref{Process/Prefix}). If you save bunches of articles using these
5203 functions, you might get tired of being prompted for files to save each
5204 and every article in. The prompting action is controlled by
5205 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
5206 default, giving you that excessive prompting action you know and
5207 loathe. If you set this variable to @code{t} instead, you'll be prompted
5208 just once for each series of articles you save. If you like to really
5209 have Gnus do all your thinking for you, you can even set this variable
5210 to @code{nil}, which means that you will never be prompted for files to
5211 save articles in. Gnus will simply save all the articles in the default
5215 @vindex gnus-default-article-saver
5216 You can customize the @code{gnus-default-article-saver} variable to make
5217 Gnus do what you want it to. You can use any of the four ready-made
5218 functions below, or you can create your own.
5222 @item gnus-summary-save-in-rmail
5223 @findex gnus-summary-save-in-rmail
5224 @vindex gnus-rmail-save-name
5225 @findex gnus-plain-save-name
5226 This is the default format, @dfn{babyl}. Uses the function in the
5227 @code{gnus-rmail-save-name} variable to get a file name to save the
5228 article in. The default is @code{gnus-plain-save-name}.
5230 @item gnus-summary-save-in-mail
5231 @findex gnus-summary-save-in-mail
5232 @vindex gnus-mail-save-name
5233 Save in a Unix mail (mbox) file. Uses the function in the
5234 @code{gnus-mail-save-name} variable to get a file name to save the
5235 article in. The default is @code{gnus-plain-save-name}.
5237 @item gnus-summary-save-in-file
5238 @findex gnus-summary-save-in-file
5239 @vindex gnus-file-save-name
5240 @findex gnus-numeric-save-name
5241 Append the article straight to an ordinary file. Uses the function in
5242 the @code{gnus-file-save-name} variable to get a file name to save the
5243 article in. The default is @code{gnus-numeric-save-name}.
5245 @item gnus-summary-save-body-in-file
5246 @findex gnus-summary-save-body-in-file
5247 Append the article body to an ordinary file. Uses the function in the
5248 @code{gnus-file-save-name} variable to get a file name to save the
5249 article in. The default is @code{gnus-numeric-save-name}.
5251 @item gnus-summary-save-in-folder
5252 @findex gnus-summary-save-in-folder
5253 @findex gnus-folder-save-name
5254 @findex gnus-Folder-save-name
5255 @vindex gnus-folder-save-name
5258 Save the article to an MH folder using @code{rcvstore} from the MH
5259 library. Uses the function in the @code{gnus-folder-save-name} variable
5260 to get a file name to save the article in. The default is
5261 @code{gnus-folder-save-name}, but you can also use
5262 @code{gnus-Folder-save-name}, which creates capitalized names.
5264 @item gnus-summary-save-in-vm
5265 @findex gnus-summary-save-in-vm
5266 Save the article in a VM folder. You have to have the VM mail
5267 reader to use this setting.
5270 @vindex gnus-article-save-directory
5271 All of these functions, except for the last one, will save the article
5272 in the @code{gnus-article-save-directory}, which is initialized from the
5273 @code{SAVEDIR} environment variable. This is @file{~/News/} by
5276 As you can see above, the functions use different functions to find a
5277 suitable name of a file to save the article in. Below is a list of
5278 available functions that generate names:
5282 @item gnus-Numeric-save-name
5283 @findex gnus-Numeric-save-name
5284 File names like @file{~/News/Alt.andrea-dworkin/45}.
5286 @item gnus-numeric-save-name
5287 @findex gnus-numeric-save-name
5288 File names like @file{~/News/alt.andrea-dworkin/45}.
5290 @item gnus-Plain-save-name
5291 @findex gnus-Plain-save-name
5292 File names like @file{~/News/Alt.andrea-dworkin}.
5294 @item gnus-plain-save-name
5295 @findex gnus-plain-save-name
5296 File names like @file{~/News/alt.andrea-dworkin}.
5299 @vindex gnus-split-methods
5300 You can have Gnus suggest where to save articles by plonking a regexp into
5301 the @code{gnus-split-methods} alist. For instance, if you would like to
5302 save articles related to Gnus in the file @file{gnus-stuff}, and articles
5303 related to VM in @code{vm-stuff}, you could set this variable to something
5307 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
5308 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
5309 (my-choosing-function "../other-dir/my-stuff")
5310 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
5313 We see that this is a list where each element is a list that has two
5314 elements---the @dfn{match} and the @dfn{file}. The match can either be
5315 a string (in which case it is used as a regexp to match on the article
5316 head); it can be a symbol (which will be called as a function with the
5317 group name as a parameter); or it can be a list (which will be
5318 @code{eval}ed). If any of these actions have a non-@code{nil} result,
5319 the @dfn{file} will be used as a default prompt. In addition, the
5320 result of the operation itself will be used if the function or form
5321 called returns a string or a list of strings.
5323 You basically end up with a list of file names that might be used when
5324 saving the current article. (All ``matches'' will be used.) You will
5325 then be prompted for what you really want to use as a name, with file
5326 name completion over the results from applying this variable.
5328 This variable is @code{((gnus-article-archive-name))} by default, which
5329 means that Gnus will look at the articles it saves for an
5330 @code{Archive-name} line and use that as a suggestion for the file
5333 Here's an example function to clean up file names somewhat. If you have
5334 lots of mail groups that are called things like
5335 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
5336 these group names before creating the file name to save to. The
5337 following will do just that:
5340 (defun my-save-name (group)
5341 (when (string-match "^nnml:mail." group)
5342 (substring group (match-end 0))))
5344 (setq gnus-split-methods
5345 '((gnus-article-archive-name)
5350 @vindex gnus-use-long-file-name
5351 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
5352 @code{nil}, all the preceding functions will replace all periods
5353 (@samp{.}) in the group names with slashes (@samp{/})---which means that
5354 the functions will generate hierarchies of directories instead of having
5355 all the files in the toplevel directory
5356 (@file{~/News/alt/andrea-dworkin} instead of
5357 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
5358 on most systems. However, for historical reasons, this is @code{nil} on
5359 Xenix and usg-unix-v machines by default.
5361 This function also affects kill and score file names. If this variable
5362 is a list, and the list contains the element @code{not-score}, long file
5363 names will not be used for score files, if it contains the element
5364 @code{not-save}, long file names will not be used for saving, and if it
5365 contains the element @code{not-kill}, long file names will not be used
5368 If you'd like to save articles in a hierarchy that looks something like
5372 (setq gnus-use-long-file-name '(not-save)) ; to get a hierarchy
5373 (setq gnus-default-article-save 'gnus-summary-save-in-file) ; no encoding
5376 Then just save with @kbd{o}. You'd then read this hierarchy with
5377 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
5378 the toplevel directory as the argument (@file{~/News/}). Then just walk
5379 around to the groups/directories with @code{nneething}.
5382 @node Decoding Articles
5383 @section Decoding Articles
5384 @cindex decoding articles
5386 Sometime users post articles (or series of articles) that have been
5387 encoded in some way or other. Gnus can decode them for you.
5390 * Uuencoded Articles:: Uudecode articles.
5391 * Shared Articles:: Unshar articles.
5392 * PostScript Files:: Split PostScript.
5393 * Decoding Variables:: Variables for a happy decoding.
5394 * Viewing Files:: You want to look at the result of the decoding?
5397 All these functions use the process/prefix convention
5398 (@pxref{Process/Prefix}) for finding out what articles to work on, with
5399 the extension that a ``single article'' means ``a single series''. Gnus
5400 can find out by itself what articles belong to a series, decode all the
5401 articles and unpack/view/save the resulting file(s).
5403 Gnus guesses what articles are in the series according to the following
5404 simplish rule: The subjects must be (nearly) identical, except for the
5405 last two numbers of the line. (Spaces are largely ignored, however.)
5407 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
5408 will find all the articles that match the regexp @samp{^cat.gif
5409 ([0-9]+/[0-9]+).*$}.
5411 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
5412 series}, will not be properly recognized by any of the automatic viewing
5413 commands, and you have to mark the articles manually with @kbd{#}.
5416 @node Uuencoded Articles
5417 @subsection Uuencoded Articles
5419 @cindex uuencoded articles
5424 @kindex X u (Summary)
5425 @findex gnus-uu-decode-uu
5426 @c @icon{gnus-uu-decode-uu}
5427 Uudecodes the current series (@code{gnus-uu-decode-uu}).
5430 @kindex X U (Summary)
5431 @findex gnus-uu-decode-uu-and-save
5432 Uudecodes and saves the current series
5433 (@code{gnus-uu-decode-uu-and-save}).
5436 @kindex X v u (Summary)
5437 @findex gnus-uu-decode-uu-view
5438 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
5441 @kindex X v U (Summary)
5442 @findex gnus-uu-decode-uu-and-save-view
5443 Uudecodes, views and saves the current series
5444 (@code{gnus-uu-decode-uu-and-save-view}).
5447 Remember that these all react to the presence of articles marked with
5448 the process mark. If, for instance, you'd like to decode and save an
5449 entire newsgroup, you'd typically do @kbd{M P a}
5450 (@code{gnus-uu-mark-all}) and then @kbd{X U}
5451 (@code{gnus-uu-decode-uu-and-save}).
5453 All this is very much different from how @code{gnus-uu} worked with
5454 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
5455 the sun. This version of @code{gnus-uu} generally assumes that you mark
5456 articles in some way (@pxref{Setting Process Marks}) and then press
5459 @vindex gnus-uu-notify-files
5460 Note: When trying to decode articles that have names matching
5461 @code{gnus-uu-notify-files}, which is hard-coded to
5462 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
5463 automatically post an article on @samp{comp.unix.wizards} saying that
5464 you have just viewed the file in question. This feature can't be turned
5468 @node Shared Articles
5469 @subsection Shared Articles
5471 @cindex shared articles
5476 @kindex X s (Summary)
5477 @findex gnus-uu-decode-unshar
5478 Unshars the current series (@code{gnus-uu-decode-unshar}).
5481 @kindex X S (Summary)
5482 @findex gnus-uu-decode-unshar-and-save
5483 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
5486 @kindex X v s (Summary)
5487 @findex gnus-uu-decode-unshar-view
5488 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
5491 @kindex X v S (Summary)
5492 @findex gnus-uu-decode-unshar-and-save-view
5493 Unshars, views and saves the current series
5494 (@code{gnus-uu-decode-unshar-and-save-view}).
5498 @node PostScript Files
5499 @subsection PostScript Files
5505 @kindex X p (Summary)
5506 @findex gnus-uu-decode-postscript
5507 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
5510 @kindex X P (Summary)
5511 @findex gnus-uu-decode-postscript-and-save
5512 Unpack and save the current PostScript series
5513 (@code{gnus-uu-decode-postscript-and-save}).
5516 @kindex X v p (Summary)
5517 @findex gnus-uu-decode-postscript-view
5518 View the current PostScript series
5519 (@code{gnus-uu-decode-postscript-view}).
5522 @kindex X v P (Summary)
5523 @findex gnus-uu-decode-postscript-and-save-view
5524 View and save the current PostScript series
5525 (@code{gnus-uu-decode-postscript-and-save-view}).
5529 @node Decoding Variables
5530 @subsection Decoding Variables
5532 Adjective, not verb.
5535 * Rule Variables:: Variables that say how a file is to be viewed.
5536 * Other Decode Variables:: Other decode variables.
5537 * Uuencoding and Posting:: Variables for customizing uuencoding.
5541 @node Rule Variables
5542 @subsubsection Rule Variables
5543 @cindex rule variables
5545 Gnus uses @dfn{rule variables} to decide how to view a file. All these
5546 variables are of the form
5549 (list '(regexp1 command2)
5556 @item gnus-uu-user-view-rules
5557 @vindex gnus-uu-user-view-rules
5559 This variable is consulted first when viewing files. If you wish to use,
5560 for instance, @code{sox} to convert an @samp{.au} sound file, you could
5563 (setq gnus-uu-user-view-rules
5564 (list '(\"\\\\.au$\" \"sox %s -t .aiff > /dev/audio\")))
5567 @item gnus-uu-user-view-rules-end
5568 @vindex gnus-uu-user-view-rules-end
5569 This variable is consulted if Gnus couldn't make any matches from the
5570 user and default view rules.
5572 @item gnus-uu-user-archive-rules
5573 @vindex gnus-uu-user-archive-rules
5574 This variable can be used to say what commands should be used to unpack
5579 @node Other Decode Variables
5580 @subsubsection Other Decode Variables
5583 @vindex gnus-uu-grabbed-file-functions
5585 @item gnus-uu-grabbed-file-functions
5586 All functions in this list will be called right after each file has been
5587 successfully decoded---so that you can move or view files right away,
5588 and don't have to wait for all files to be decoded before you can do
5589 anything. Ready-made functions you can put in this list are:
5593 @item gnus-uu-grab-view
5594 @findex gnus-uu-grab-view
5597 @item gnus-uu-grab-move
5598 @findex gnus-uu-grab-move
5599 Move the file (if you're using a saving function.)
5602 @item gnus-uu-be-dangerous
5603 @vindex gnus-uu-be-dangerous
5604 Specifies what to do if unusual situations arise during decoding. If
5605 @code{nil}, be as conservative as possible. If @code{t}, ignore things
5606 that didn't work, and overwrite existing files. Otherwise, ask each
5609 @item gnus-uu-ignore-files-by-name
5610 @vindex gnus-uu-ignore-files-by-name
5611 Files with name matching this regular expression won't be viewed.
5613 @item gnus-uu-ignore-files-by-type
5614 @vindex gnus-uu-ignore-files-by-type
5615 Files with a @sc{mime} type matching this variable won't be viewed.
5616 Note that Gnus tries to guess what type the file is based on the name.
5617 @code{gnus-uu} is not a @sc{mime} package (yet), so this is slightly
5620 @item gnus-uu-tmp-dir
5621 @vindex gnus-uu-tmp-dir
5622 Where @code{gnus-uu} does its work.
5624 @item gnus-uu-do-not-unpack-archives
5625 @vindex gnus-uu-do-not-unpack-archives
5626 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
5627 looking for files to display.
5629 @item gnus-uu-view-and-save
5630 @vindex gnus-uu-view-and-save
5631 Non-@code{nil} means that the user will always be asked to save a file
5634 @item gnus-uu-ignore-default-view-rules
5635 @vindex gnus-uu-ignore-default-view-rules
5636 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
5639 @item gnus-uu-ignore-default-archive-rules
5640 @vindex gnus-uu-ignore-default-archive-rules
5641 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
5644 @item gnus-uu-kill-carriage-return
5645 @vindex gnus-uu-kill-carriage-return
5646 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
5649 @item gnus-uu-unmark-articles-not-decoded
5650 @vindex gnus-uu-unmark-articles-not-decoded
5651 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
5652 decoded articles as unread.
5654 @item gnus-uu-correct-stripped-uucode
5655 @vindex gnus-uu-correct-stripped-uucode
5656 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
5657 uuencoded files that have had trailing spaces deleted.
5659 @item gnus-uu-view-with-metamail
5660 @vindex gnus-uu-view-with-metamail
5662 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
5663 commands defined by the rule variables and just fudge a @sc{mime}
5664 content type based on the file name. The result will be fed to
5665 @code{metamail} for viewing.
5667 @item gnus-uu-save-in-digest
5668 @vindex gnus-uu-save-in-digest
5669 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
5670 decoding, will save in digests. If this variable is @code{nil},
5671 @code{gnus-uu} will just save everything in a file without any
5672 embellishments. The digesting almost conforms to RFC1153---no easy way
5673 to specify any meaningful volume and issue numbers were found, so I
5674 simply dropped them.
5679 @node Uuencoding and Posting
5680 @subsubsection Uuencoding and Posting
5684 @item gnus-uu-post-include-before-composing
5685 @vindex gnus-uu-post-include-before-composing
5686 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
5687 before you compose the article. If this variable is @code{t}, you can
5688 either include an encoded file with @kbd{C-c C-i} or have one included
5689 for you when you post the article.
5691 @item gnus-uu-post-length
5692 @vindex gnus-uu-post-length
5693 Maximum length of an article. The encoded file will be split into how
5694 many articles it takes to post the entire file.
5696 @item gnus-uu-post-threaded
5697 @vindex gnus-uu-post-threaded
5698 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
5699 thread. This may not be smart, as no other decoder I have seen is able
5700 to follow threads when collecting uuencoded articles. (Well, I have
5701 seen one package that does that---@code{gnus-uu}, but somehow, I don't
5702 think that counts...) Default is @code{nil}.
5704 @item gnus-uu-post-separate-description
5705 @vindex gnus-uu-post-separate-description
5706 Non-@code{nil} means that the description will be posted in a separate
5707 article. The first article will typically be numbered (0/x). If this
5708 variable is @code{nil}, the description the user enters will be included
5709 at the beginning of the first article, which will be numbered (1/x).
5710 Default is @code{t}.
5716 @subsection Viewing Files
5717 @cindex viewing files
5718 @cindex pseudo-articles
5720 After decoding, if the file is some sort of archive, Gnus will attempt
5721 to unpack the archive and see if any of the files in the archive can be
5722 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
5723 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
5724 uncompress and de-tar the main file, and then view the two pictures.
5725 This unpacking process is recursive, so if the archive contains archives
5726 of archives, it'll all be unpacked.
5728 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
5729 extracted file into the summary buffer. If you go to these
5730 ``articles'', you will be prompted for a command to run (usually Gnus
5731 will make a suggestion), and then the command will be run.
5733 @vindex gnus-view-pseudo-asynchronously
5734 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
5735 until the viewing is done before proceeding.
5737 @vindex gnus-view-pseudos
5738 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
5739 the pseudo-articles into the summary buffer, but view them
5740 immediately. If this variable is @code{not-confirm}, the user won't even
5741 be asked for a confirmation before viewing is done.
5743 @vindex gnus-view-pseudos-separately
5744 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
5745 pseudo-article will be created for each file to be viewed. If
5746 @code{nil}, all files that use the same viewing command will be given as
5747 a list of parameters to that command.
5749 @vindex gnus-insert-pseudo-articles
5750 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
5751 pseudo-articles when decoding. It is @code{t} by default.
5753 So; there you are, reading your @emph{pseudo-articles} in your
5754 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
5755 Why isn't anything real anymore? How did we get here?
5758 @node Article Treatment
5759 @section Article Treatment
5761 Reading through this huge manual, you may have quite forgotten that the
5762 object of newsreaders is to actually, like, read what people have
5763 written. Reading articles. Unfortunately, people are quite bad at
5764 writing, so there are tons of functions and variables to make reading
5765 these articles easier.
5768 * Article Highlighting:: You want to make the article look like fruit salad.
5769 * Article Fontisizing:: Making emphasized text look niced.
5770 * Article Hiding:: You also want to make certain info go away.
5771 * Article Washing:: Lots of way-neat functions to make life better.
5772 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
5773 * Article Date:: Grumble, UT!
5774 * Article Signature:: What is a signature?
5778 @node Article Highlighting
5779 @subsection Article Highlighting
5782 Not only do you want your article buffer to look like fruit salad, but
5783 you want it to look like technicolor fruit salad.
5788 @kindex W H a (Summary)
5789 @findex gnus-article-highlight
5790 Highlight the current article (@code{gnus-article-highlight}).
5793 @kindex W H h (Summary)
5794 @findex gnus-article-highlight-headers
5795 @vindex gnus-header-face-alist
5796 Highlight the headers (@code{gnus-article-highlight-headers}). The
5797 highlighting will be done according to the @code{gnus-header-face-alist}
5798 variable, which is a list where each element has the form @var{(regexp
5799 name content)}. @var{regexp} is a regular expression for matching the
5800 header, @var{name} is the face used for highlighting the header name and
5801 @var{content} is the face for highlighting the header value. The first
5802 match made will be used. Note that @var{regexp} shouldn't have @samp{^}
5803 prepended---Gnus will add one.
5806 @kindex W H c (Summary)
5807 @findex gnus-article-highlight-citation
5808 Highlight cited text (@code{gnus-article-highlight-citation}).
5810 Some variables to customize the citation highlights:
5813 @vindex gnus-cite-parse-max-size
5815 @item gnus-cite-parse-max-size
5816 If the article size if bigger than this variable (which is 25000 by
5817 default), no citation highlighting will be performed.
5819 @item gnus-cite-prefix-regexp
5820 @vindex gnus-cite-prefix-regexp
5821 Regexp matching the longest possible citation prefix on a line.
5823 @item gnus-cite-max-prefix
5824 @vindex gnus-cite-max-prefix
5825 Maximum possible length for a citation prefix (default 20).
5827 @item gnus-cite-face-list
5828 @vindex gnus-cite-face-list
5829 List of faces used for highlighting citations. When there are citations
5830 from multiple articles in the same message, Gnus will try to give each
5831 citation from each article its own face. This should make it easier to
5834 @item gnus-supercite-regexp
5835 @vindex gnus-supercite-regexp
5836 Regexp matching normal Supercite attribution lines.
5838 @item gnus-supercite-secondary-regexp
5839 @vindex gnus-supercite-secondary-regexp
5840 Regexp matching mangled Supercite attribution lines.
5842 @item gnus-cite-minimum-match-count
5843 @vindex gnus-cite-minimum-match-count
5844 Minimum number of identical prefixes we have to see before we believe
5845 that it's a citation.
5847 @item gnus-cite-attribution-prefix
5848 @vindex gnus-cite-attribution-prefix
5849 Regexp matching the beginning of an attribution line.
5851 @item gnus-cite-attribution-suffix
5852 @vindex gnus-cite-attribution-suffix
5853 Regexp matching the end of an attribution line.
5855 @item gnus-cite-attribution-face
5856 @vindex gnus-cite-attribution-face
5857 Face used for attribution lines. It is merged with the face for the
5858 cited text belonging to the attribution.
5864 @kindex W H s (Summary)
5865 @vindex gnus-signature-separator
5866 @vindex gnus-signature-face
5867 @findex gnus-article-highlight-signature
5868 Highlight the signature (@code{gnus-article-highlight-signature}).
5869 Everything after @code{gnus-signature-separator} (@pxref{Article
5870 Signature}) in an article will be considered a signature and will be
5871 highlighted with @code{gnus-signature-face}, which is @code{italic} by
5877 @node Article Fontisizing
5878 @subsection Article Fontisizing
5880 @cindex article emphasis
5882 @findex gnus-article-emphasize
5883 @kindex W e (Summary)
5884 People commonly add emphasis to words in news articles by writing things
5885 like @samp{_this_} or @samp{*this*}. Gnus can make this look nicer by
5886 running the article through the @kbd{W e}
5887 (@code{gnus-article-emphasize}) command.
5889 @vindex gnus-article-emphasis
5890 How the emphasis is computed is controlled by the
5891 @code{gnus-article-emphasis} variable. This is an alist where the first
5892 element is a regular expression to be matched. The second is a number
5893 that says what regular expression grouping is used to find the entire
5894 emphasized word. The third is a number that says what regexp grouping
5895 should be displayed and highlighted. (The text between these two
5896 groupings will be hidden.) The fourth is the face used for
5900 (setq gnus-article-emphasis
5901 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
5902 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
5905 @vindex gnus-emphasis-underline
5906 @vindex gnus-emphasis-bold
5907 @vindex gnus-emphasis-italic
5908 @vindex gnus-emphasis-underline-bold
5909 @vindex gnus-emphasis-underline-italic
5910 @vindex gnus-emphasis-bold-italic
5911 @vindex gnus-emphasis-underline-bold-italic
5912 By default, there are seven rules, and they use the following faces:
5913 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
5914 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
5915 @code{gnus-emphasis-underline-italic},
5916 @code{gnus-emphasis-underline-bold}, and
5917 @code{gnus-emphasis-underline-bold-italic}.
5919 If you want to change these faces, you can either use @kbd{M-x
5920 customize}, or you can use @code{copy-face}. For instance, if you want
5921 to make @code{gnus-emphasis-italic} use a red face instead, you could
5925 (copy-face 'red 'gnus-emphasis-italic)
5929 @node Article Hiding
5930 @subsection Article Hiding
5931 @cindex article hiding
5933 Or rather, hiding certain things in each article. There usually is much
5934 too much cruft in most articles.
5939 @kindex W W a (Summary)
5940 @findex gnus-article-hide
5941 Do maximum hiding on the summary buffer (@kbd{gnus-article-hide}).
5944 @kindex W W h (Summary)
5945 @findex gnus-article-hide-headers
5946 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
5950 @kindex W W b (Summary)
5951 @findex gnus-article-hide-boring-headers
5952 Hide headers that aren't particularly interesting
5953 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
5956 @kindex W W s (Summary)
5957 @findex gnus-article-hide-signature
5958 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
5962 @kindex W W p (Summary)
5963 @findex gnus-article-hide-pgp
5964 @vindex gnus-article-hide-pgp-hook
5965 Hide @sc{pgp} signatures (@code{gnus-article-hide-pgp}). The
5966 @code{gnus-article-hide-pgp-hook} hook will be run after a @sc{pgp}
5967 signature has been hidden.
5970 @kindex W W P (Summary)
5971 @findex gnus-article-hide-pem
5972 Hide @sc{pem} (privacy enhanced messages) cruft
5973 (@code{gnus-article-hide-pem}).
5976 @kindex W W c (Summary)
5977 @findex gnus-article-hide-citation
5978 Hide citation (@code{gnus-article-hide-citation}). Some variables for
5979 customizing the hiding:
5983 @item gnus-cite-hide-percentage
5984 @vindex gnus-cite-hide-percentage
5985 If the cited text is of a bigger percentage than this variable (default
5986 50), hide the cited text.
5988 @item gnus-cite-hide-absolute
5989 @vindex gnus-cite-hide-absolute
5990 The cited text must have at least this length (default 10) before it
5993 @item gnus-cited-text-button-line-format
5994 @vindex gnus-cited-text-button-line-format
5995 Gnus adds buttons to show where the cited text has been hidden, and to
5996 allow toggle hiding the text. The format of the variable is specified
5997 by this format-like variable (@pxref{Formatting Variables}). These
6002 Start point of the hidden text.
6004 End point of the hidden text.
6006 Length of the hidden text.
6009 @item gnus-cited-lines-visible
6010 @vindex gnus-cited-lines-visible
6011 The number of lines at the beginning of the cited text to leave shown.
6016 @kindex W W C (Summary)
6017 @findex gnus-article-hide-citation-in-followups
6018 Hide cited text in articles that aren't roots
6019 (@code{gnus-article-hide-citation-in-followups}). This isn't very
6020 useful as an interactive command, but might be a handy function to stick
6021 in @code{gnus-article-display-hook} (@pxref{Customizing Articles}).
6025 All these ``hiding'' commands are toggles, but if you give a negative
6026 prefix to these commands, they will show what they have previously
6027 hidden. If you give a positive prefix, they will always hide.
6029 Also @pxref{Article Highlighting} for further variables for
6030 citation customization.
6033 @node Article Washing
6034 @subsection Article Washing
6036 @cindex article washing
6038 We call this ``article washing'' for a really good reason. Namely, the
6039 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
6041 @dfn{Washing} is defined by us as ``changing something from something to
6042 something else'', but normally results in something looking better.
6048 @kindex W l (Summary)
6049 @findex gnus-summary-stop-page-breaking
6050 Remove page breaks from the current article
6051 (@code{gnus-summary-stop-page-breaking}).
6054 @kindex W r (Summary)
6055 @findex gnus-summary-caesar-message
6056 @c @icon{gnus-summary-caesar-message}
6057 Do a Caesar rotate (rot13) on the article buffer
6058 (@code{gnus-summary-caesar-message}).
6061 @kindex W t (Summary)
6062 @findex gnus-summary-toggle-header
6063 Toggle whether to display all headers in the article buffer
6064 (@code{gnus-summary-toggle-header}).
6067 @kindex W v (Summary)
6068 @findex gnus-summary-verbose-header
6069 Toggle whether to display all headers in the article buffer permanently
6070 (@code{gnus-summary-verbose-header}).
6073 @kindex W m (Summary)
6074 @findex gnus-summary-toggle-mime
6075 Toggle whether to run the article through @sc{mime} before displaying
6076 (@code{gnus-summary-toggle-mime}).
6079 @kindex W o (Summary)
6080 @findex gnus-article-treat-overstrike
6081 Treat overstrike (@code{gnus-article-treat-overstrike}).
6084 @kindex W w (Summary)
6085 @findex gnus-article-fill-cited-article
6086 Do word wrap (@code{gnus-article-fill-cited-article}). If you use this
6087 function in @code{gnus-article-display-hook}, it should be run fairly
6088 late and certainly after any highlighting.
6090 You can give the command a numerical prefix to specify the width to use
6094 @kindex W c (Summary)
6095 @findex gnus-article-remove-cr
6096 Remove CR (@code{gnus-article-remove-cr}).
6099 @kindex W q (Summary)
6100 @findex gnus-article-de-quoted-unreadable
6101 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
6104 @kindex W f (Summary)
6106 @findex gnus-article-display-x-face
6107 @findex gnus-article-x-face-command
6108 @vindex gnus-article-x-face-command
6109 @vindex gnus-article-x-face-too-ugly
6112 \gnusxface{tmp/xface-karlheg.ps}
6113 \gnusxface{tmp/xface-kyle.ps}
6114 \gnusxface{tmp/xface-smb.ps}
6117 Look for and display any X-Face headers
6118 (@code{gnus-article-display-x-face}). The command executed by this
6119 function is given by the @code{gnus-article-x-face-command} variable.
6120 If this variable is a string, this string will be executed in a
6121 sub-shell. If it is a function, this function will be called with the
6122 face as the argument. If the @code{gnus-article-x-face-too-ugly} (which
6123 is a regexp) matches the @code{From} header, the face will not be shown.
6124 The default action under Emacs is to fork off an @code{xv} to view the
6125 face; under XEmacs the default action is to display the face before the
6126 @code{From} header. (It's nicer if XEmacs has been compiled with X-Face
6127 support---that will make display somewhat faster. If there's no native
6128 X-Face support, Gnus will try to convert the @code{X-Face} header using
6129 external programs from the @code{pbmplus} package and friends.) If you
6130 want to have this function in the display hook, it should probably come
6134 @kindex W b (Summary)
6135 @findex gnus-article-add-buttons
6136 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
6139 @kindex W B (Summary)
6140 @findex gnus-article-add-buttons-to-head
6141 Add clickable buttons to the article headers
6142 (@code{gnus-article-add-buttons-to-head}).
6145 @kindex W E l (Summary)
6146 @findex gnus-article-strip-leading-blank-lines
6147 Remove all blank lines from the beginning of the article
6148 (@code{gnus-article-strip-leading-blank-lines}).
6151 @kindex W E m (Summary)
6152 @findex gnus-article-strip-multiple-blank-lines
6153 Replace all blank lines with empty lines and then all multiple empty
6154 lines with a single empty line.
6155 (@code{gnus-article-strip-multiple-blank-lines}).
6158 @kindex W E t (Summary)
6159 @findex gnus-article-remove-trailing-blank-lines
6160 Remove all blank lines at the end of the article
6161 (@code{gnus-article-remove-trailing-blank-lines}).
6164 @kindex W E a (Summary)
6165 @findex gnus-article-strip-blank-lines
6166 Do all the three commands above
6167 (@code{gnus-article-strip-blank-lines}).
6170 @kindex W E s (Summary)
6171 @findex gnus-article-strip-leading-space
6172 Remove all white space from the beginning of all lines of the article
6173 body (@code{gnus-article-strip-leading-space}).
6178 @node Article Buttons
6179 @subsection Article Buttons
6182 People often include references to other stuff in articles, and it would
6183 be nice if Gnus could just fetch whatever it is that people talk about
6184 with the minimum of fuzz.
6186 Gnus adds @dfn{buttons} to certain standard references by default:
6187 Well-formed URLs, mail addresses and Message-IDs. This is controlled by
6188 two variables, one that handles article bodies and one that handles
6193 @item gnus-button-alist
6194 @vindex gnus-button-alist
6195 This is an alist where each entry has this form:
6198 (REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6204 All text that match this regular expression will be considered an
6205 external reference. Here's a typical regexp that matches embedded URLs:
6206 @samp{<URL:\\([^\n\r>]*\\)>}.
6209 Gnus has to know which parts of the matches is to be highlighted. This
6210 is a number that says what sub-expression of the regexp is to be
6211 highlighted. If you want it all highlighted, you use 0 here.
6214 This form will be @code{eval}ed, and if the result is non-@code{nil},
6215 this is considered a match. This is useful if you want extra sifting to
6216 avoid false matches.
6219 This function will be called when you click on this button.
6222 As with @var{button-par}, this is a sub-expression number, but this one
6223 says which part of the match is to be sent as data to @var{function}.
6227 So the full entry for buttonizing URLs is then
6230 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
6233 @item gnus-header-button-alist
6234 @vindex gnus-header-button-alist
6235 This is just like the other alist, except that it is applied to the
6236 article head only, and that each entry has an additional element that is
6237 used to say what headers to apply the buttonize coding to:
6240 (HEADER REGEXP BUTTON-PAR USE-P FUNCTION DATA-PAR)
6243 @var{HEADER} is a regular expression.
6245 @item gnus-button-url-regexp
6246 @vindex gnus-button-url-regexp
6247 A regular expression that matches embedded URLs. It is used in the
6248 default values of the variables above.
6250 @item gnus-article-button-face
6251 @vindex gnus-article-button-face
6252 Face used on buttons.
6254 @item gnus-article-mouse-face
6255 @vindex gnus-article-mouse-face
6256 Face used when the mouse cursor is over a button.
6262 @subsection Article Date
6264 The date is most likely generated in some obscure timezone you've never
6265 heard of, so it's quite nice to be able to find out what the time was
6266 when the article was sent.
6271 @kindex W T u (Summary)
6272 @findex gnus-article-date-ut
6273 Display the date in UT (aka. GMT, aka ZULU)
6274 (@code{gnus-article-date-ut}).
6277 @kindex W T l (Summary)
6278 @findex gnus-article-date-local
6279 Display the date in the local timezone (@code{gnus-article-date-local}).
6282 @kindex W T s (Summary)
6283 @vindex gnus-article-time-format
6284 @findex gnus-article-date-user
6285 @findex format-time-string
6286 Display the date using a user-defined format
6287 (@code{gnus-article-date-user}). The format is specified by the
6288 @code{gnus-article-time-format} variable, and is a string that's passed
6289 to @code{format-time-string}. See the documentation of that variable
6290 for a list of possible format specs.
6293 @kindex W T e (Summary)
6294 @findex gnus-article-date-lapsed
6295 Say how much time has elapsed between the article was posted and now
6296 (@code{gnus-article-date-lapsed}).
6299 @kindex W T o (Summary)
6300 @findex gnus-article-date-original
6301 Display the original date (@code{gnus-article-date-original}). This can
6302 be useful if you normally use some other conversion function and are
6303 worried that it might be doing something totally wrong. Say, claiming
6304 that the article was posted in 1854. Although something like that is
6305 @emph{totally} impossible. Don't you trust me? *titter*
6310 @node Article Signature
6311 @subsection Article Signature
6313 @cindex article signature
6315 @vindex gnus-signature-separator
6316 Each article is divided into two parts---the head and the body. The
6317 body can be divided into a signature part and a text part. The variable
6318 that says what is to be considered a signature is
6319 @code{gnus-signature-separator}. This is normally the standard
6320 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
6321 non-standard signature separators, so this variable can also be a list
6322 of regular expressions to be tested, one by one. (Searches are done
6323 from the end of the body towards the beginning.) One likely value is:
6326 (setq gnus-signature-separator
6327 '("^-- $" ; The standard
6328 "^-- *$" ; A common mangling
6329 "^-------*$" ; Many people just use a looong
6330 ; line of dashes. Shame!
6331 "^ *--------*$" ; Double-shame!
6332 "^________*$" ; Underscores are also popular
6333 "^========*$")) ; Pervert!
6336 The more permissive you are, the more likely it is that you'll get false
6339 @vindex gnus-signature-limit
6340 @code{gnus-signature-limit} provides a limit to what is considered a
6345 If it is an integer, no signature may be longer (in characters) than
6348 If it is a floating point number, no signature may be longer (in lines)
6351 If it is a function, the function will be called without any parameters,
6352 and if it returns @code{nil}, there is no signature in the buffer.
6354 If it is a string, it will be used as a regexp. If it matches, the text
6355 in question is not a signature.
6358 This variable can also be a list where the elements may be of the types
6362 @node Article Commands
6363 @section Article Commands
6370 @kindex A P (Summary)
6371 @vindex gnus-ps-print-hook
6372 @findex gnus-summary-print-article
6373 Generate and print a PostScript image of the article buffer
6374 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will be
6375 run just before printing the buffer.
6380 @node Summary Sorting
6381 @section Summary Sorting
6382 @cindex summary sorting
6384 You can have the summary buffer sorted in various ways, even though I
6385 can't really see why you'd want that.
6390 @kindex C-c C-s C-n (Summary)
6391 @findex gnus-summary-sort-by-number
6392 Sort by article number (@code{gnus-summary-sort-by-number}).
6395 @kindex C-c C-s C-a (Summary)
6396 @findex gnus-summary-sort-by-author
6397 Sort by author (@code{gnus-summary-sort-by-author}).
6400 @kindex C-c C-s C-s (Summary)
6401 @findex gnus-summary-sort-by-subject
6402 Sort by subject (@code{gnus-summary-sort-by-subject}).
6405 @kindex C-c C-s C-d (Summary)
6406 @findex gnus-summary-sort-by-date
6407 Sort by date (@code{gnus-summary-sort-by-date}).
6410 @kindex C-c C-s C-l (Summary)
6411 @findex gnus-summary-sort-by-lines
6412 Sort by lines (@code{gnus-summary-sort-by-lines}).
6415 @kindex C-c C-s C-i (Summary)
6416 @findex gnus-summary-sort-by-score
6417 Sort by score (@code{gnus-summary-sort-by-score}).
6420 These functions will work both when you use threading and when you don't
6421 use threading. In the latter case, all summary lines will be sorted,
6422 line by line. In the former case, sorting will be done on a
6423 root-by-root basis, which might not be what you were looking for. To
6424 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
6428 @node Finding the Parent
6429 @section Finding the Parent
6430 @cindex parent articles
6431 @cindex referring articles
6433 @findex gnus-summary-refer-parent-article
6435 If you'd like to read the parent of the current article, and it is not
6436 displayed in the summary buffer, you might still be able to. That is,
6437 if the current group is fetched by @sc{nntp}, the parent hasn't expired
6438 and the @code{References} in the current article are not mangled, you
6439 can just press @kbd{^} or @kbd{A r}
6440 (@code{gnus-summary-refer-parent-article}). If everything goes well,
6441 you'll get the parent. If the parent is already displayed in the
6442 summary buffer, point will just move to this article.
6444 If given a positive numerical prefix, fetch that many articles back into
6445 the ancestry. If given a negative numerical prefix, fetch just that
6446 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
6447 grandparent and the grandgrandparent of the current article. If you say
6448 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
6451 @findex gnus-summary-refer-references
6452 @kindex A R (Summary)
6453 You can have Gnus fetch all articles mentioned in the @code{References}
6454 header of the article by pushing @kbd{A R}
6455 (@code{gnus-summary-refer-references}).
6457 @findex gnus-summary-refer-article
6458 @kindex M-^ (Summary)
6460 @cindex fetching by Message-ID
6461 You can also ask the @sc{nntp} server for an arbitrary article, no
6462 matter what group it belongs to. @kbd{M-^}
6463 (@code{gnus-summary-refer-article}) will ask you for a
6464 @code{Message-ID}, which is one of those long, hard-to-read thingies
6465 that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}. You
6466 have to get it all exactly right. No fuzzy searches, I'm afraid.
6468 The current select method will be used when fetching by
6469 @code{Message-ID} from non-news select method, but you can override this
6470 by giving this command a prefix.
6472 @vindex gnus-refer-article-method
6473 If the group you are reading is located on a backend that does not
6474 support fetching by @code{Message-ID} very well (like @code{nnspool}),
6475 you can set @code{gnus-refer-article-method} to an @sc{nntp} method. It
6476 would, perhaps, be best if the @sc{nntp} server you consult is the one
6477 updating the spool you are reading from, but that's not really
6480 Most of the mail backends support fetching by @code{Message-ID}, but do
6481 not do a particularly excellent job at it. That is, @code{nnmbox} and
6482 @code{nnbabyl} are able to locate articles from any groups, while
6483 @code{nnml} and @code{nnfolder} are only able to locate articles that
6484 have been posted to the current group. (Anything else would be too time
6485 consuming.) @code{nnmh} does not support this at all.
6488 @node Alternative Approaches
6489 @section Alternative Approaches
6491 Different people like to read news using different methods. This being
6492 Gnus, we offer a small selection of minor modes for the summary buffers.
6495 * Pick and Read:: First mark articles and then read them.
6496 * Binary Groups:: Auto-decode all articles.
6501 @subsection Pick and Read
6502 @cindex pick and read
6504 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
6505 a two-phased reading interface. The user first marks in a summary
6506 buffer the articles she wants to read. Then she starts reading the
6507 articles with just an article buffer displayed.
6509 @findex gnus-pick-mode
6510 @kindex M-x gnus-pick-mode
6511 Gnus provides a summary buffer minor mode that allows
6512 this---@code{gnus-pick-mode}. This basically means that a few process
6513 mark commands become one-keystroke commands to allow easy marking, and
6514 it provides one additional command for switching to the summary buffer.
6516 Here are the available keystrokes when using pick mode:
6521 @findex gnus-summary-mark-as-processable
6522 Pick the article on the current line
6523 (@code{gnus-summary-mark-as-processable}). If given a numerical prefix,
6524 go to that article and pick it. (The line number is normally displayed
6525 at the beginning of the summary pick lines.)
6528 @kindex SPACE (Pick)
6529 @findex gnus-pick-next-page
6530 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
6531 at the end of the buffer, start reading the picked articles.
6535 @findex gnus-summary-unmark-as-processable
6536 Unpick the article (@code{gnus-summary-unmark-as-processable}).
6540 @findex gnus-summary-unmark-all-processable
6541 Unpick all articles (@code{gnus-summary-unmark-all-processable}).
6545 @findex gnus-uu-mark-thread
6546 Pick the thread (@code{gnus-uu-mark-thread}).
6550 @findex gnus-uu-unmark-thread
6551 Unpick the thread (@code{gnus-uu-unmark-thread}).
6555 @findex gnus-uu-mark-region
6556 Pick the region (@code{gnus-uu-mark-region}).
6560 @findex gnus-uu-unmark-region
6561 Unpick the region (@code{gnus-uu-unmark-region}).
6565 @findex gnus-uu-mark-by-regexp
6566 Pick articles that match a regexp (@code{gnus-uu-mark-by-regexp}).
6570 @findex gnus-uu-unmark-by-regexp
6571 Unpick articles that match a regexp (@code{gnus-uu-unmark-by-regexp}).
6575 @findex gnus-uu-mark-buffer
6576 Pick the buffer (@code{gnus-uu-mark-buffer}).
6580 @findex gnus-uu-unmark-buffer
6581 Unpick the buffer (@code{gnus-uu-unmark-buffer}).
6585 @findex gnus-pick-start-reading
6586 @vindex gnus-pick-display-summary
6587 Start reading the picked articles (@code{gnus-pick-start-reading}). If
6588 given a prefix, mark all unpicked articles as read first. If
6589 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
6590 will still be visible when you are reading.
6594 If this sounds like a good idea to you, you could say:
6597 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
6600 @vindex gnus-pick-mode-hook
6601 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
6603 @vindex gnus-mark-unpicked-articles-as-read
6604 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
6605 all unpicked articles as read. The default is @code{nil}.
6607 @vindex gnus-summary-pick-line-format
6608 The summary line format in pick mode is slightly different from the
6609 standard format. At the beginning of each line the line number is
6610 displayed. The pick mode line format is controlled by the
6611 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
6612 Variables}). It accepts the same format specs that
6613 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
6617 @subsection Binary Groups
6618 @cindex binary groups
6620 @findex gnus-binary-mode
6621 @kindex M-x gnus-binary-mode
6622 If you spend much time in binary groups, you may grow tired of hitting
6623 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
6624 is a minor mode for summary buffers that makes all ordinary Gnus article
6625 selection functions uudecode series of articles and display the result
6626 instead of just displaying the articles the normal way.
6629 @findex gnus-binary-show-article
6630 The only way, in fact, to see the actual articles is the @kbd{g}
6631 command, when you have turned on this mode
6632 (@code{gnus-binary-show-article}).
6634 @vindex gnus-binary-mode-hook
6635 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
6639 @section Tree Display
6642 @vindex gnus-use-trees
6643 If you don't like the normal Gnus summary display, you might try setting
6644 @code{gnus-use-trees} to @code{t}. This will create (by default) an
6645 additional @dfn{tree buffer}. You can execute all summary mode commands
6648 There are a few variables to customize the tree display, of course:
6651 @item gnus-tree-mode-hook
6652 @vindex gnus-tree-mode-hook
6653 A hook called in all tree mode buffers.
6655 @item gnus-tree-mode-line-format
6656 @vindex gnus-tree-mode-line-format
6657 A format string for the mode bar in the tree mode buffers. The default
6658 is @samp{Gnus: %%b [%A] %Z}. For a list of legal specs, @pxref{Summary
6661 @item gnus-selected-tree-face
6662 @vindex gnus-selected-tree-face
6663 Face used for highlighting the selected article in the tree buffer. The
6664 default is @code{modeline}.
6666 @item gnus-tree-line-format
6667 @vindex gnus-tree-line-format
6668 A format string for the tree nodes. The name is a bit of a misnomer,
6669 though---it doesn't define a line, but just the node. The default value
6670 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
6671 the name of the poster. It is vital that all nodes are of the same
6672 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
6678 The name of the poster.
6680 The @code{From} header.
6682 The number of the article.
6684 The opening bracket.
6686 The closing bracket.
6691 @xref{Formatting Variables}.
6693 Variables related to the display are:
6696 @item gnus-tree-brackets
6697 @vindex gnus-tree-brackets
6698 This is used for differentiating between ``real'' articles and
6699 ``sparse'' articles. The format is @var{((real-open . real-close)
6700 (sparse-open . sparse-close) (dummy-open . dummy-close))}, and the
6701 default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}))}.
6703 @item gnus-tree-parent-child-edges
6704 @vindex gnus-tree-parent-child-edges
6705 This is a list that contains the characters used for connecting parent
6706 nodes to their children. The default is @code{(?- ?\\ ?|)}.
6710 @item gnus-tree-minimize-window
6711 @vindex gnus-tree-minimize-window
6712 If this variable is non-@code{nil}, Gnus will try to keep the tree
6713 buffer as small as possible to allow more room for the other Gnus
6714 windows. If this variable is a number, the tree buffer will never be
6715 higher than that number. The default is @code{t}. Note that if you
6716 have several windows displayed side-by-side in a frame and the tree
6717 buffer is one of these, minimizing the tree window will also resize all
6718 other windows displayed next to it.
6720 @item gnus-generate-tree-function
6721 @vindex gnus-generate-tree-function
6722 @findex gnus-generate-horizontal-tree
6723 @findex gnus-generate-vertical-tree
6724 The function that actually generates the thread tree. Two predefined
6725 functions are available: @code{gnus-generate-horizontal-tree} and
6726 @code{gnus-generate-vertical-tree} (which is the default).
6730 Here's an example from a horizontal tree buffer:
6733 @{***@}-(***)-[odd]-[Gun]
6743 Here's the same thread displayed in a vertical tree buffer:
6747 |--------------------------\-----\-----\
6748 (***) [Bjo] [Gun] [Gun]
6750 [odd] [Jan] [odd] (***) [Jor]
6752 [Gun] [Eri] [Eri] [odd]
6758 @node Mail Group Commands
6759 @section Mail Group Commands
6760 @cindex mail group commands
6762 Some commands only make sense in mail groups. If these commands are
6763 illegal in the current group, they will raise hell and let you know.
6765 All these commands (except the expiry and edit commands) use the
6766 process/prefix convention (@pxref{Process/Prefix}).
6771 @kindex B e (Summary)
6772 @findex gnus-summary-expire-articles
6773 Expire all expirable articles in the group
6774 (@code{gnus-summary-expire-articles}).
6777 @kindex B M-C-e (Summary)
6778 @findex gnus-summary-expire-articles-now
6779 Delete all the expirable articles in the group
6780 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
6781 articles that are eligible for expiry in the current group will
6782 disappear forever into that big @file{/dev/null} in the sky.
6785 @kindex B DEL (Summary)
6786 @findex gnus-summary-delete-article
6787 @c @icon{gnus-summary-mail-delete}
6788 Delete the mail article. This is ``delete'' as in ``delete it from your
6789 disk forever and ever, never to return again.'' Use with caution.
6790 (@code{gnus-summary-delete-article}).
6793 @kindex B m (Summary)
6795 @findex gnus-summary-move-article
6796 Move the article from one mail group to another
6797 (@code{gnus-summary-move-article}).
6800 @kindex B c (Summary)
6802 @findex gnus-summary-copy-article
6803 @c @icon{gnus-summary-mail-copy}
6804 Copy the article from one group (mail group or not) to a mail group
6805 (@code{gnus-summary-copy-article}).
6808 @kindex B C (Summary)
6809 @cindex crosspost mail
6810 @findex gnus-summary-crosspost-article
6811 Crosspost the current article to some other group
6812 (@code{gnus-summary-crosspost-article}). This will create a new copy of
6813 the article in the other group, and the Xref headers of the article will
6814 be properly updated.
6817 @kindex B i (Summary)
6818 @findex gnus-summary-import-article
6819 Import an arbitrary file into the current mail newsgroup
6820 (@code{gnus-summary-import-article}). You will be prompted for a file
6821 name, a @code{From} header and a @code{Subject} header.
6824 @kindex B r (Summary)
6825 @findex gnus-summary-respool-article
6826 Respool the mail article (@code{gnus-summary-move-article}).
6827 @code{gnus-summary-respool-default-method} will be used as the default
6828 select method when respooling. This variable is @code{nil} by default,
6829 which means that the current group select method will be used instead.
6833 @kindex B w (Summary)
6835 @findex gnus-summary-edit-article
6836 @kindex C-c C-c (Article)
6837 Edit the current article (@code{gnus-summary-edit-article}). To finish
6838 editing and make the changes permanent, type @kbd{C-c C-c}
6839 (@kbd{gnus-summary-edit-article-done}).
6842 @kindex B q (Summary)
6843 @findex gnus-summary-respool-query
6844 If you want to re-spool an article, you might be curious as to what group
6845 the article will end up in before you do the re-spooling. This command
6846 will tell you (@code{gnus-summary-respool-query}).
6849 @kindex B p (Summary)
6850 @findex gnus-summary-article-posted-p
6851 Some people have a tendency to send you "courtesy" copies when they
6852 follow up to articles you have posted. These usually have a
6853 @code{Newsgroups} header in them, but not always. This command
6854 (@code{gnus-summary-article-posted-p}) will try to fetch the current
6855 article from your news server (or rather, from
6856 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
6857 report back whether it found the article or not. Even if it says that
6858 it didn't find the article, it may have been posted anyway---mail
6859 propagation is much faster than news propagation, and the news copy may
6860 just not have arrived yet.
6864 @vindex gnus-move-split-methods
6865 @cindex moving articles
6866 If you move (or copy) articles regularly, you might wish to have Gnus
6867 suggest where to put the articles. @code{gnus-move-split-methods} is a
6868 variable that uses the same syntax as @code{gnus-split-methods}
6869 (@pxref{Saving Articles}). You may customize that variable to create
6870 suggestions you find reasonable.
6873 (setq gnus-move-split-methods
6874 '(("^From:.*Lars Magne" "nnml:junk")
6875 ("^Subject:.*gnus" "nnfolder:important")
6876 (".*" "nnml:misc")))
6880 @node Various Summary Stuff
6881 @section Various Summary Stuff
6884 * Summary Group Information:: Information oriented commands.
6885 * Searching for Articles:: Multiple article commands.
6886 * Summary Generation Commands:: (Re)generating the summary buffer.
6887 * Really Various Summary Commands:: Those pesky non-conformant commands.
6891 @vindex gnus-summary-mode-hook
6892 @item gnus-summary-mode-hook
6893 This hook is called when creating a summary mode buffer.
6895 @vindex gnus-summary-generate-hook
6896 @item gnus-summary-generate-hook
6897 This is called as the last thing before doing the threading and the
6898 generation of the summary buffer. It's quite convenient for customizing
6899 the threading variables based on what data the newsgroup has. This hook
6900 is called from the summary buffer after most summary buffer variables
6903 @vindex gnus-summary-prepare-hook
6904 @item gnus-summary-prepare-hook
6905 It is called after the summary buffer has been generated. You might use
6906 it to, for instance, highlight lines or modify the look of the buffer in
6907 some other ungodly manner. I don't care.
6909 @vindex gnus-summary-ignore-duplicates
6910 @item gnus-summary-ignore-duplicates
6911 When Gnus discovers two articles that have the same @code{Message-ID},
6912 it has to do something drastic. No articles are allowed to have the
6913 same @code{Message-ID}, but this may happen when reading mail from some
6914 sources. Gnus allows you to customize what happens with this variable.
6915 If it is @code{nil} (which is the default), Gnus will rename the
6916 @code{Message-ID} (for display purposes only) and display the article as
6917 any other article. If this variable is @code{t}, it won't display the
6918 article---it'll be as if it never existed.
6923 @node Summary Group Information
6924 @subsection Summary Group Information
6929 @kindex H f (Summary)
6930 @findex gnus-summary-fetch-faq
6931 @vindex gnus-group-faq-directory
6932 Try to fetch the FAQ (list of frequently asked questions) for the
6933 current group (@code{gnus-summary-fetch-faq}). Gnus will try to get the
6934 FAQ from @code{gnus-group-faq-directory}, which is usually a directory
6935 on a remote machine. This variable can also be a list of directories.
6936 In that case, giving a prefix to this command will allow you to choose
6937 between the various sites. @code{ange-ftp} or @code{efs} will probably
6938 be used for fetching the file.
6941 @kindex H d (Summary)
6942 @findex gnus-summary-describe-group
6943 Give a brief description of the current group
6944 (@code{gnus-summary-describe-group}). If given a prefix, force
6945 rereading the description from the server.
6948 @kindex H h (Summary)
6949 @findex gnus-summary-describe-briefly
6950 Give an extremely brief description of the most important summary
6951 keystrokes (@code{gnus-summary-describe-briefly}).
6954 @kindex H i (Summary)
6955 @findex gnus-info-find-node
6956 Go to the Gnus info node (@code{gnus-info-find-node}).
6960 @node Searching for Articles
6961 @subsection Searching for Articles
6966 @kindex M-s (Summary)
6967 @findex gnus-summary-search-article-forward
6968 Search through all subsequent articles for a regexp
6969 (@code{gnus-summary-search-article-forward}).
6972 @kindex M-r (Summary)
6973 @findex gnus-summary-search-article-backward
6974 Search through all previous articles for a regexp
6975 (@code{gnus-summary-search-article-backward}).
6979 @findex gnus-summary-execute-command
6980 This command will prompt you for a header field, a regular expression to
6981 match on this field, and a command to be executed if the match is made
6982 (@code{gnus-summary-execute-command}). If given a prefix, search
6986 @kindex M-& (Summary)
6987 @findex gnus-summary-universal-argument
6988 Perform any operation on all articles that have been marked with
6989 the process mark (@code{gnus-summary-universal-argument}).
6992 @node Summary Generation Commands
6993 @subsection Summary Generation Commands
6998 @kindex Y g (Summary)
6999 @findex gnus-summary-prepare
7000 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
7003 @kindex Y c (Summary)
7004 @findex gnus-summary-insert-cached-articles
7005 Pull all cached articles (for the current group) into the summary buffer
7006 (@code{gnus-summary-insert-cached-articles}).
7011 @node Really Various Summary Commands
7012 @subsection Really Various Summary Commands
7017 @kindex C-d (Summary)
7018 @findex gnus-summary-enter-digest-group
7019 If the current article is a collection of other articles (for instance,
7020 a digest), you might use this command to enter a group based on the that
7021 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
7022 guess what article type is currently displayed unless you give a prefix
7023 to this command, which forces a ``digest'' interpretation. Basically,
7024 whenever you see a message that is a collection of other messages of
7025 some format, you @kbd{C-d} and read these messages in a more convenient
7029 @kindex M-C-d (Summary)
7030 @findex gnus-summary-read-document
7031 This command is very similar to the one above, but lets you gather
7032 several documents into one biiig group
7033 (@code{gnus-summary-read-document}). It does this by opening several
7034 @code{nndoc} groups for each document, and then opening an
7035 @code{nnvirtual} group on top of these @code{nndoc} groups. This
7036 command understands the process/prefix convention
7037 (@pxref{Process/Prefix}).
7040 @kindex C-t (Summary)
7041 @findex gnus-summary-toggle-truncation
7042 Toggle truncation of summary lines
7043 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
7044 line centering function in the summary buffer, so it's not a good idea
7045 to have truncation switched off while reading articles.
7049 @findex gnus-summary-expand-window
7050 Expand the summary buffer window (@code{gnus-summary-expand-window}).
7051 If given a prefix, force an @code{article} window configuration.
7056 @node Exiting the Summary Buffer
7057 @section Exiting the Summary Buffer
7058 @cindex summary exit
7059 @cindex exiting groups
7061 Exiting from the summary buffer will normally update all info on the
7062 group and return you to the group buffer.
7068 @kindex Z Z (Summary)
7070 @findex gnus-summary-exit
7071 @vindex gnus-summary-exit-hook
7072 @vindex gnus-summary-prepare-exit-hook
7073 @c @icon{gnus-summary-exit}
7074 Exit the current group and update all information on the group
7075 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
7076 called before doing much of the exiting, which calls
7077 @code{gnus-summary-expire-articles} by default.
7078 @code{gnus-summary-exit-hook} is called after finishing the exit
7079 process. @code{gnus-group-no-more-groups-hook} is run when returning to
7080 group mode having no more (unread) groups.
7084 @kindex Z E (Summary)
7086 @findex gnus-summary-exit-no-update
7087 Exit the current group without updating any information on the group
7088 (@code{gnus-summary-exit-no-update}).
7092 @kindex Z c (Summary)
7094 @findex gnus-summary-catchup-and-exit
7095 @c @icon{gnus-summary-catchup-and-exit}
7096 Mark all unticked articles in the group as read and then exit
7097 (@code{gnus-summary-catchup-and-exit}).
7100 @kindex Z C (Summary)
7101 @findex gnus-summary-catchup-all-and-exit
7102 Mark all articles, even the ticked ones, as read and then exit
7103 (@code{gnus-summary-catchup-all-and-exit}).
7106 @kindex Z n (Summary)
7107 @findex gnus-summary-catchup-and-goto-next-group
7108 Mark all articles as read and go to the next group
7109 (@code{gnus-summary-catchup-and-goto-next-group}).
7112 @kindex Z R (Summary)
7113 @findex gnus-summary-reselect-current-group
7114 Exit this group, and then enter it again
7115 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
7116 all articles, both read and unread.
7120 @kindex Z G (Summary)
7121 @kindex M-g (Summary)
7122 @findex gnus-summary-rescan-group
7123 @c @icon{gnus-summary-mail-get}
7124 Exit the group, check for new articles in the group, and select the
7125 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
7126 articles, both read and unread.
7129 @kindex Z N (Summary)
7130 @findex gnus-summary-next-group
7131 Exit the group and go to the next group
7132 (@code{gnus-summary-next-group}).
7135 @kindex Z P (Summary)
7136 @findex gnus-summary-prev-group
7137 Exit the group and go to the previous group
7138 (@code{gnus-summary-prev-group}).
7141 @kindex Z s (Summary)
7142 @findex gnus-summary-save-newsrc
7143 Save the current number of read/marked articles in the dribble buffer
7144 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
7145 given a prefix, also save the @file{.newsrc} file(s). Using this
7146 command will make exit without updating (the @kbd{Q} command) worthless.
7149 @vindex gnus-exit-group-hook
7150 @code{gnus-exit-group-hook} is called when you exit the current
7153 @findex gnus-summary-wake-up-the-dead
7154 @findex gnus-dead-summary-mode
7155 @vindex gnus-kill-summary-on-exit
7156 If you're in the habit of exiting groups, and then changing your mind
7157 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
7158 If you do that, Gnus won't kill the summary buffer when you exit it.
7159 (Quelle surprise!) Instead it will change the name of the buffer to
7160 something like @samp{*Dead Summary ... *} and install a minor mode
7161 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
7162 buffer, you'll find that all keys are mapped to a function called
7163 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
7164 summary buffer will result in a live, normal summary buffer.
7166 There will never be more than one dead summary buffer at any one time.
7168 @vindex gnus-use-cross-reference
7169 The data on the current group will be updated (which articles you have
7170 read, which articles you have replied to, etc.) when you exit the
7171 summary buffer. If the @code{gnus-use-cross-reference} variable is
7172 @code{t} (which is the default), articles that are cross-referenced to
7173 this group and are marked as read, will also be marked as read in the
7174 other subscribed groups they were cross-posted to. If this variable is
7175 neither @code{nil} nor @code{t}, the article will be marked as read in
7176 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
7179 @node Crosspost Handling
7180 @section Crosspost Handling
7184 Marking cross-posted articles as read ensures that you'll never have to
7185 read the same article more than once. Unless, of course, somebody has
7186 posted it to several groups separately. Posting the same article to
7187 several groups (not cross-posting) is called @dfn{spamming}, and you are
7188 by law required to send nasty-grams to anyone who perpetrates such a
7189 heinous crime. You may want to try NoCeM handling to filter out spam
7192 Remember: Cross-posting is kinda ok, but posting the same article
7193 separately to several groups is not. Massive cross-posting (aka.
7194 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
7195 @code{gnus-summary-mail-crosspost-complaint} command to complain about
7196 excessive crossposting (@pxref{Summary Mail Commands}).
7198 @cindex cross-posting
7201 One thing that may cause Gnus to not do the cross-posting thing
7202 correctly is if you use an @sc{nntp} server that supports @sc{xover}
7203 (which is very nice, because it speeds things up considerably) which
7204 does not include the @code{Xref} header in its @sc{nov} lines. This is
7205 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
7206 even with @sc{xover} by registering the @code{Xref} lines of all
7207 articles you actually read, but if you kill the articles, or just mark
7208 them as read without reading them, Gnus will not get a chance to snoop
7209 the @code{Xref} lines out of these articles, and will be unable to use
7210 the cross reference mechanism.
7212 @cindex LIST overview.fmt
7213 @cindex overview.fmt
7214 To check whether your @sc{nntp} server includes the @code{Xref} header
7215 in its overview files, try @samp{telnet your.nntp.server nntp},
7216 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
7217 overview.fmt}. This may not work, but if it does, and the last line you
7218 get does not read @samp{Xref:full}, then you should shout and whine at
7219 your news admin until she includes the @code{Xref} header in the
7222 @vindex gnus-nov-is-evil
7223 If you want Gnus to get the @code{Xref}s right all the time, you have to
7224 set @code{gnus-nov-is-evil} to @code{t}, which slows things down
7229 For an alternative approach, @pxref{Duplicate Suppression}.
7232 @node Duplicate Suppression
7233 @section Duplicate Suppression
7235 By default, Gnus tries to make sure that you don't have to read the same
7236 article more than once by utilizing the crossposting mechanism
7237 (@pxref{Crosspost Handling}). However, that simple and efficient
7238 approach may not work satisfactory for some users for various
7243 The @sc{nntp} server may fail to generate the @code{Xref} header. This
7244 is evil and not very common.
7247 The @sc{nntp} server may fail to include the @code{Xref} header in the
7248 @file{.overview} data bases. This is evil and all too common, alas.
7251 You may be reading the same group (or several related groups) from
7252 different @sc{nntp} servers.
7255 You may be getting mail that duplicates articles posted to groups.
7258 I'm sure there are other situations where @code{Xref} handling fails as
7259 well, but these four are the most common situations.
7261 If, and only if, @code{Xref} handling fails for you, then you may
7262 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
7263 will remember the @code{Message-ID}s of all articles you have read or
7264 otherwise marked as read, and then, as if by magic, mark them as read
7265 all subsequent times you see them---in @emph{all} groups. Using this
7266 mechanism is quite likely to be somewhat inefficient, but not overly
7267 so. It's certainly preferable to reading the same articles more than
7270 Duplicate suppression is not a very subtle instrument. It's more like a
7271 sledge hammer than anything else. It works in a very simple
7272 fashion---if you have marked an article as read, it adds this Message-ID
7273 to a cache. The next time it sees this Message-ID, it will mark the
7274 article as read with the @samp{M} mark. It doesn't care what group it
7278 @item gnus-suppress-duplicates
7279 @vindex gnus-suppress-duplicates
7280 If non-@code{nil}, suppress duplicates.
7282 @item gnus-save-duplicate-list
7283 @vindex gnus-save-duplicate-list
7284 If non-@code{nil}, save the list of duplicates to a file. This will
7285 make startup and shutdown take longer, so the default is @code{nil}.
7286 However, this means that only duplicate articles read in a single Gnus
7287 session are suppressed.
7289 @item gnus-duplicate-list-length
7290 @vindex gnus-duplicate-list-length
7291 This variable says how many @code{Message-ID}s to keep in the duplicate
7292 suppression list. The default is 10000.
7294 @item gnus-duplicate-file
7295 @vindex gnus-duplicate-file
7296 The name of the file to store the duplicate suppression list in. The
7297 default is @file{~/News/suppression}.
7300 If you have a tendency to stop and start Gnus often, setting
7301 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
7302 you leave Gnus running for weeks on end, you may have it @code{nil}. On
7303 the other hand, saving the list makes startup and shutdown much slower,
7304 so that means that if you stop and start Gnus often, you should set
7305 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
7306 to you to figure out, I think.
7309 @node The Article Buffer
7310 @chapter The Article Buffer
7311 @cindex article buffer
7313 The articles are displayed in the article buffer, of which there is only
7314 one. All the summary buffers share the same article buffer unless you
7315 tell Gnus otherwise.
7318 * Hiding Headers:: Deciding what headers should be displayed.
7319 * Using MIME:: Pushing articles through @sc{mime} before reading them.
7320 * Customizing Articles:: Tailoring the look of the articles.
7321 * Article Keymap:: Keystrokes available in the article buffer.
7322 * Misc Article:: Other stuff.
7326 @node Hiding Headers
7327 @section Hiding Headers
7328 @cindex hiding headers
7329 @cindex deleting headers
7331 The top section of each article is the @dfn{head}. (The rest is the
7332 @dfn{body}, but you may have guessed that already.)
7334 @vindex gnus-show-all-headers
7335 There is a lot of useful information in the head: the name of the person
7336 who wrote the article, the date it was written and the subject of the
7337 article. That's well and nice, but there's also lots of information
7338 most people do not want to see---what systems the article has passed
7339 through before reaching you, the @code{Message-ID}, the
7340 @code{References}, etc. ad nauseum---and you'll probably want to get rid
7341 of some of those lines. If you want to keep all those lines in the
7342 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
7344 Gnus provides you with two variables for sifting headers:
7348 @item gnus-visible-headers
7349 @vindex gnus-visible-headers
7350 If this variable is non-@code{nil}, it should be a regular expression
7351 that says what headers you wish to keep in the article buffer. All
7352 headers that do not match this variable will be hidden.
7354 For instance, if you only want to see the name of the person who wrote
7355 the article and the subject, you'd say:
7358 (setq gnus-visible-headers "^From:\\|^Subject:")
7361 This variable can also be a list of regexps to match headers that are to
7364 @item gnus-ignored-headers
7365 @vindex gnus-ignored-headers
7366 This variable is the reverse of @code{gnus-visible-headers}. If this
7367 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
7368 should be a regular expression that matches all lines that you want to
7369 hide. All lines that do not match this variable will remain visible.
7371 For instance, if you just want to get rid of the @code{References} line
7372 and the @code{Xref} line, you might say:
7375 (setq gnus-ignored-headers "^References:\\|^Xref:")
7378 This variable can also be a list of regexps to match headers that are to
7381 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
7382 variable will have no effect.
7386 @vindex gnus-sorted-header-list
7387 Gnus can also sort the headers for you. (It does this by default.) You
7388 can control the sorting by setting the @code{gnus-sorted-header-list}
7389 variable. It is a list of regular expressions that says in what order
7390 the headers are to be displayed.
7392 For instance, if you want the name of the author of the article first,
7393 and then the subject, you might say something like:
7396 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
7399 Any headers that are to remain visible, but are not listed in this
7400 variable, will be displayed in random order after all the headers that
7401 are listed in this variable.
7403 @findex gnus-article-hide-boring-headers
7404 @vindex gnus-article-display-hook
7405 @vindex gnus-boring-article-headers
7406 You can hide further boring headers by entering
7407 @code{gnus-article-hide-boring-headers} into
7408 @code{gnus-article-display-hook}. What this function does depends on
7409 the @code{gnus-boring-article-headers} variable. It's a list, but this
7410 list doesn't actually contain header names. Instead is lists various
7411 @dfn{boring conditions} that Gnus can check and remove from sight.
7413 These conditions are:
7416 Remove all empty headers.
7418 Remove the @code{Newsgroups} header if it only contains the current group
7421 Remove the @code{Followup-To} header if it is identical to the
7422 @code{Newsgroups} header.
7424 Remove the @code{Reply-To} header if it lists the same address as the
7427 Remove the @code{Date} header if the article is less than three days
7431 To include the four first elements, you could say something like;
7434 (setq gnus-boring-article-headers
7435 '(empty newsgroups followup-to reply-to))
7438 This is also the default value for this variable.
7442 @section Using @sc{mime}
7445 Mime is a standard for waving your hands through the air, aimlessly,
7446 while people stand around yawning.
7448 @sc{mime}, however, is a standard for encoding your articles, aimlessly,
7449 while all newsreaders die of fear.
7451 @sc{mime} may specify what character set the article uses, the encoding
7452 of the characters, and it also makes it possible to embed pictures and
7453 other naughty stuff in innocent-looking articles.
7455 @vindex gnus-show-mime
7456 @vindex gnus-show-mime-method
7457 @vindex gnus-strict-mime
7458 @findex metamail-buffer
7459 Gnus handles @sc{mime} by pushing the articles through
7460 @code{gnus-show-mime-method}, which is @code{metamail-buffer} by
7461 default. Set @code{gnus-show-mime} to @code{t} if you want to use
7462 @sc{mime} all the time. However, if @code{gnus-strict-mime} is
7463 non-@code{nil}, the @sc{mime} method will only be used if there are
7464 @sc{mime} headers in the article. If you have @code{gnus-show-mime}
7465 set, then you'll see some unfortunate display glitches in the article
7466 buffer. These can't be avoided.
7468 It might be best to just use the toggling functions from the summary
7469 buffer to avoid getting nasty surprises. (For instance, you enter the
7470 group @samp{alt.sing-a-long} and, before you know it, @sc{mime} has
7471 decoded the sound file in the article and some horrible sing-a-long song
7472 comes screaming out your speakers, and you can't find the volume
7473 button, because there isn't one, and people are starting to look at you,
7474 and you try to stop the program, but you can't, and you can't find the
7475 program to control the volume, and everybody else in the room suddenly
7476 decides to look at you disdainfully, and you'll feel rather stupid.)
7478 Any similarity to real events and people is purely coincidental. Ahem.
7481 @node Customizing Articles
7482 @section Customizing Articles
7483 @cindex article customization
7485 @vindex gnus-article-display-hook
7486 The @code{gnus-article-display-hook} is called after the article has
7487 been inserted into the article buffer. It is meant to handle all
7488 treatment of the article before it is displayed.
7490 @findex gnus-article-maybe-highlight
7491 By default this hook just contains @code{gnus-article-hide-headers},
7492 @code{gnus-article-treat-overstrike}, and
7493 @code{gnus-article-maybe-highlight}, but there are thousands, nay
7494 millions, of functions you can put in this hook. For an overview of
7495 functions @pxref{Article Highlighting}, @pxref{Article Hiding},
7496 @pxref{Article Washing}, @pxref{Article Buttons} and @pxref{Article
7497 Date}. Note that the order of functions in this hook might affect
7498 things, so you may have to fiddle a bit to get the desired results.
7500 You can, of course, write your own functions. The functions are called
7501 from the article buffer, and you can do anything you like, pretty much.
7502 There is no information that you have to keep in the buffer---you can
7503 change everything. However, you shouldn't delete any headers. Instead
7504 make them invisible if you want to make them go away.
7507 @node Article Keymap
7508 @section Article Keymap
7510 Most of the keystrokes in the summary buffer can also be used in the
7511 article buffer. They should behave as if you typed them in the summary
7512 buffer, which means that you don't actually have to have a summary
7513 buffer displayed while reading. You can do it all from the article
7516 A few additional keystrokes are available:
7521 @kindex SPACE (Article)
7522 @findex gnus-article-next-page
7523 Scroll forwards one page (@code{gnus-article-next-page}).
7526 @kindex DEL (Article)
7527 @findex gnus-article-prev-page
7528 Scroll backwards one page (@code{gnus-article-prev-page}).
7531 @kindex C-c ^ (Article)
7532 @findex gnus-article-refer-article
7533 If point is in the neighborhood of a @code{Message-ID} and you press
7534 @kbd{r}, Gnus will try to get that article from the server
7535 (@code{gnus-article-refer-article}).
7538 @kindex C-c C-m (Article)
7539 @findex gnus-article-mail
7540 Send a reply to the address near point (@code{gnus-article-mail}). If
7541 given a prefix, include the mail.
7545 @findex gnus-article-show-summary
7546 Reconfigure the buffers so that the summary buffer becomes visible
7547 (@code{gnus-article-show-summary}).
7551 @findex gnus-article-describe-briefly
7552 Give a very brief description of the available keystrokes
7553 (@code{gnus-article-describe-briefly}).
7556 @kindex TAB (Article)
7557 @findex gnus-article-next-button
7558 Go to the next button, if any (@code{gnus-article-next-button}). This
7559 only makes sense if you have buttonizing turned on.
7562 @kindex M-TAB (Article)
7563 @findex gnus-article-prev-button
7564 Go to the previous button, if any (@code{gnus-article-prev-button}).
7570 @section Misc Article
7574 @item gnus-single-article-buffer
7575 @vindex gnus-single-article-buffer
7576 If non-@code{nil}, use the same article buffer for all the groups.
7577 (This is the default.) If @code{nil}, each group will have its own
7580 @vindex gnus-article-prepare-hook
7581 @item gnus-article-prepare-hook
7582 This hook is called right after the article has been inserted into the
7583 article buffer. It is mainly intended for functions that do something
7584 depending on the contents; it should probably not be used for changing
7585 the contents of the article buffer.
7587 @vindex gnus-article-display-hook
7588 @item gnus-article-display-hook
7589 This hook is called as the last thing when displaying an article, and is
7590 intended for modifying the contents of the buffer, doing highlights,
7591 hiding headers, and the like.
7593 @item gnus-article-mode-hook
7594 @vindex gnus-article-mode-hook
7595 Hook called in article mode buffers.
7597 @item gnus-article-mode-syntax-table
7598 @vindex gnus-article-mode-syntax-table
7599 Syntax table used in article buffers. It is initialized from
7600 @code{text-mode-syntax-table}.
7602 @vindex gnus-article-mode-line-format
7603 @item gnus-article-mode-line-format
7604 This variable is a format string along the same lines as
7605 @code{gnus-summary-mode-line-format}. It accepts the same
7606 format specifications as that variable, with one extension:
7610 The @dfn{wash status} of the article. This is a short string with one
7611 character for each possible article wash operation that may have been
7615 @vindex gnus-break-pages
7617 @item gnus-break-pages
7618 Controls whether @dfn{page breaking} is to take place. If this variable
7619 is non-@code{nil}, the articles will be divided into pages whenever a
7620 page delimiter appears in the article. If this variable is @code{nil},
7621 paging will not be done.
7623 @item gnus-page-delimiter
7624 @vindex gnus-page-delimiter
7625 This is the delimiter mentioned above. By default, it is @samp{^L}
7630 @node Composing Messages
7631 @chapter Composing Messages
7636 @kindex C-c C-c (Post)
7637 All commands for posting and mailing will put you in a message buffer
7638 where you can edit the article all you like, before you send the article
7639 by pressing @kbd{C-c C-c}. @xref{Top, , Top, message, The Message
7640 Manual}. If you are in a foreign news group, and you wish to post the
7641 article using the foreign server, you can give a prefix to @kbd{C-c C-c}
7642 to make Gnus try to post using the foreign server.
7645 * Mail:: Mailing and replying.
7646 * Post:: Posting and following up.
7647 * Posting Server:: What server should you post via?
7648 * Mail and Post:: Mailing and posting at the same time.
7649 * Archived Messages:: Where Gnus stores the messages you've sent.
7650 @c * Posting Styles:: An easier way to configure some key elements.
7651 @c * Drafts:: Postponing messages and rejected messages.
7652 @c * Rejected Articles:: What happens if the server doesn't like your article?
7655 Also see @pxref{Canceling and Superseding} for information on how to
7656 remove articles you shouldn't have posted.
7662 Variables for customizing outgoing mail:
7665 @item gnus-uu-digest-headers
7666 @vindex gnus-uu-digest-headers
7667 List of regexps to match headers included in digested messages. The
7668 headers will be included in the sequence they are matched.
7670 @item gnus-add-to-list
7671 @vindex gnus-add-to-list
7672 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
7673 that have none when you do a @kbd{a}.
7681 Variables for composing news articles:
7684 @item gnus-sent-message-ids-file
7685 @vindex gnus-sent-message-ids-file
7686 Gnus will keep a @code{Message-ID} history file of all the mails it has
7687 sent. If it discovers that it has already sent a mail, it will ask the
7688 user whether to re-send the mail. (This is primarily useful when
7689 dealing with @sc{soup} packets and the like where one is apt to send the
7690 same packet multiple times.) This variable says what the name of this
7691 history file is. It is @file{~/News/Sent-Message-IDs} by default. Set
7692 this variable to @code{nil} if you don't want Gnus to keep a history
7695 @item gnus-sent-message-ids-length
7696 @vindex gnus-sent-message-ids-length
7697 This variable says how many @code{Message-ID}s to keep in the history
7698 file. It is 1000 by default.
7703 @node Posting Server
7704 @section Posting Server
7706 When you press those magical @kbd{C-c C-c} keys to ship off your latest
7707 (extremely intelligent, of course) article, where does it go?
7709 Thank you for asking. I hate you.
7711 @vindex gnus-post-method
7713 It can be quite complicated. Normally, Gnus will use the same native
7714 server. However. If your native server doesn't allow posting, just
7715 reading, you probably want to use some other server to post your
7716 (extremely intelligent and fabulously interesting) articles. You can
7717 then set the @code{gnus-post-method} to some other method:
7720 (setq gnus-post-method '(nnspool ""))
7723 Now, if you've done this, and then this server rejects your article, or
7724 this server is down, what do you do then? To override this variable you
7725 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
7726 the ``current'' server for posting.
7728 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
7729 Gnus will prompt you for what method to use for posting.
7731 You can also set @code{gnus-post-method} to a list of select methods.
7732 If that's the case, Gnus will always prompt you for what method to use
7737 @section Mail and Post
7739 Here's a list of variables that are relevant to both mailing and
7743 @item gnus-mailing-list-groups
7744 @findex gnus-mailing-list-groups
7745 @cindex mailing lists
7747 If your news server offers groups that are really mailing lists
7748 gatewayed to the @sc{nntp} server, you can read those groups without
7749 problems, but you can't post/followup to them without some difficulty.
7750 One solution is to add a @code{to-address} to the group parameters
7751 (@pxref{Group Parameters}). An easier thing to do is set the
7752 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
7753 really are mailing lists. Then, at least, followups to the mailing
7754 lists will work most of the time. Posting to these groups (@kbd{a}) is
7755 still a pain, though.
7759 You may want to do spell-checking on messages that you send out. Or, if
7760 you don't want to spell-check by hand, you could add automatic
7761 spell-checking via the @code{ispell} package:
7764 @findex ispell-message
7766 (add-hook 'message-send-hook 'ispell-message)
7770 @node Archived Messages
7771 @section Archived Messages
7772 @cindex archived messages
7773 @cindex sent messages
7775 Gnus provides a few different methods for storing the mail and news you
7776 send. The default method is to use the @dfn{archive virtual server} to
7777 store the messages. If you want to disable this completely, the
7778 @code{gnus-message-archive-group} variable should be @code{nil}, which
7781 @vindex gnus-message-archive-method
7782 @code{gnus-message-archive-method} says what virtual server Gnus is to
7783 use to store sent messages. The default is:
7787 (nnfolder-directory "~/Mail/archive/"))
7790 You can, however, use any mail select method (@code{nnml},
7791 @code{nnmbox}, etc.). @code{nnfolder} is a quite likeable select method
7792 for doing this sort of thing, though. If you don't like the default
7793 directory chosen, you could say something like:
7796 (setq gnus-message-archive-method
7797 '(nnfolder "archive"
7798 (nnfolder-inhibit-expiry t)
7799 (nnfolder-active-file "~/News/sent-mail/active")
7800 (nnfolder-directory "~/News/sent-mail/")))
7803 @vindex gnus-message-archive-group
7805 Gnus will insert @code{Gcc} headers in all outgoing messages that point
7806 to one or more group(s) on that server. Which group to use is
7807 determined by the @code{gnus-message-archive-group} variable.
7809 This variable can be used to do the following:
7813 Messages will be saved in that group.
7814 @item a list of strings
7815 Messages will be saved in all those groups.
7816 @item an alist of regexps, functions and forms
7817 When a key ``matches'', the result is used.
7819 No message archiving will take place. This is the default.
7824 Just saving to a single group called @samp{MisK}:
7826 (setq gnus-message-archive-group "MisK")
7829 Saving to two groups, @samp{MisK} and @samp{safe}:
7831 (setq gnus-message-archive-group '("MisK" "safe"))
7834 Save to different groups based on what group you are in:
7836 (setq gnus-message-archive-group
7837 '(("^alt" "sent-to-alt")
7838 ("mail" "sent-to-mail")
7839 (".*" "sent-to-misc")))
7844 (setq gnus-message-archive-group
7845 '((if (message-news-p)
7850 How about storing all news messages in one file, but storing all mail
7851 messages in one file per month:
7854 (setq gnus-message-archive-group
7855 '((if (message-news-p)
7857 (concat "mail." (format-time-string
7858 "%Y-%m" (current-time))))))
7861 (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
7862 use a different value for @code{gnus-message-archive-group} there.)
7864 Now, when you send a message off, it will be stored in the appropriate
7865 group. (If you want to disable storing for just one particular message,
7866 you can just remove the @code{Gcc} header that has been inserted.) The
7867 archive group will appear in the group buffer the next time you start
7868 Gnus, or the next time you press @kbd{F} in the group buffer. You can
7869 enter it and read the articles in it just like you'd read any other
7870 group. If the group gets really big and annoying, you can simply rename
7871 if (using @kbd{G r} in the group buffer) to something
7872 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
7873 continue to be stored in the old (now empty) group.
7875 That's the default method of archiving sent messages. Gnus offers a
7876 different way for the people who don't like the default method. In that
7877 case you should set @code{gnus-message-archive-group} to @code{nil};
7878 this will disable archiving.
7881 @item gnus-outgoing-message-group
7882 @vindex gnus-outgoing-message-group
7883 All outgoing messages will be put in this group. If you want to store
7884 all your outgoing mail and articles in the group @samp{nnml:archive},
7885 you set this variable to that value. This variable can also be a list of
7888 If you want to have greater control over what group to put each
7889 message in, you can set this variable to a function that checks the
7890 current newsgroup name and then returns a suitable group name (or list
7893 This variable can be used instead of @code{gnus-message-archive-group},
7894 but the latter is the preferred method.
7898 @c @node Posting Styles
7899 @c @section Posting Styles
7900 @c @cindex posting styles
7903 @c All them variables, they make my head swim.
7905 @c So what if you want a different @code{Organization} and signature based
7906 @c on what groups you post to? And you post both from your home machine
7907 @c and your work machine, and you want different @code{From} lines, and so
7910 @c @vindex gnus-posting-styles
7911 @c One way to do stuff like that is to write clever hooks that change the
7912 @c variables you need to have changed. That's a bit boring, so somebody
7913 @c came up with the bright idea of letting the user specify these things in
7914 @c a handy alist. Here's an example of a @code{gnus-posting-styles}
7919 @c (signature . "Peace and happiness")
7920 @c (organization . "What me?"))
7922 @c (signature . "Death to everybody"))
7923 @c ("comp.emacs.i-love-it"
7924 @c (organization . "Emacs is it")))
7927 @c As you might surmise from this example, this alist consists of several
7928 @c @dfn{styles}. Each style will be applicable if the first element
7929 @c ``matches'', in some form or other. The entire alist will be iterated
7930 @c over, from the beginning towards the end, and each match will be
7931 @c applied, which means that attributes in later styles that match override
7932 @c the same attributes in earlier matching styles. So
7933 @c @samp{comp.programming.literate} will have the @samp{Death to everybody}
7934 @c signature and the @samp{What me?} @code{Organization} header.
7936 @c The first element in each style is called the @code{match}. If it's a
7937 @c string, then Gnus will try to regexp match it against the group name.
7938 @c If it's a function symbol, that function will be called with no
7939 @c arguments. If it's a variable symbol, then the variable will be
7940 @c referenced. If it's a list, then that list will be @code{eval}ed. In
7941 @c any case, if this returns a non-@code{nil} value, then the style is said
7944 @c Each style may contain a arbitrary amount of @dfn{attributes}. Each
7945 @c attribute consists of a @var{(name . value)} pair. The attribute name
7946 @c can be one of @code{signature}, @code{organization} or @code{from}. The
7947 @c attribute name can also be a string. In that case, this will be used as
7948 @c a header name, and the value will be inserted in the headers of the
7951 @c The attribute value can be a string (used verbatim), a function (the
7952 @c return value will be used), a variable (its value will be used) or a
7953 @c list (it will be @code{eval}ed and the return value will be used).
7955 @c So here's a new example:
7958 @c (setq gnus-posting-styles
7960 @c (signature . "~/.signature")
7961 @c (from . "user@@foo (user)")
7962 @c ("X-Home-Page" . (getenv "WWW_HOME"))
7963 @c (organization . "People's Front Against MWM"))
7965 @c (signature . my-funny-signature-randomizer))
7966 @c ((equal (system-name) "gnarly")
7967 @c (signature . my-quote-randomizer))
7968 @c (posting-from-work-p
7969 @c (signature . "~/.work-signature")
7970 @c (from . "user@@bar.foo (user)")
7971 @c (organization . "Important Work, Inc"))
7973 @c (signature . "~/.mail-signature"))))
7980 @c If you are writing a message (mail or news) and suddenly remember that
7981 @c you have a steak in the oven (or some pesto in the food processor, you
7982 @c craazy vegetarians), you'll probably wish there was a method to save the
7983 @c message you are writing so that you can continue editing it some other
7984 @c day, and send it when you feel its finished.
7986 @c Well, don't worry about it. Whenever you start composing a message of
7987 @c some sort using the Gnus mail and post commands, the buffer you get will
7988 @c automatically associate to an article in a special @dfn{draft} group.
7989 @c If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
7990 @c article will be saved there. (Auto-save files also go to the draft
7994 @c @vindex gnus-draft-group-directory
7995 @c The draft group is a special group (which is implemented as an
7996 @c @code{nndraft} group, if you absolutely have to know) called
7997 @c @samp{nndraft:drafts}. The variable @code{gnus-draft-group-directory}
7998 @c controls both the name of the group and the location---the leaf element
7999 @c in the path will be used as the name of the group. What makes this
8000 @c group special is that you can't tick any articles in it or mark any
8001 @c articles as read---all articles in the group are permanently unread.
8003 @c If the group doesn't exist, it will be created and you'll be subscribed
8006 @c @findex gnus-dissociate-buffer-from-draft
8007 @c @kindex C-c M-d (Mail)
8008 @c @kindex C-c M-d (Post)
8009 @c @findex gnus-associate-buffer-with-draft
8010 @c @kindex C-c C-d (Mail)
8011 @c @kindex C-c C-d (Post)
8012 @c If you're writing some super-secret message that you later want to
8013 @c encode with PGP before sending, you may wish to turn the auto-saving
8014 @c (and association with the draft group) off. You never know who might be
8015 @c interested in reading all your extremely valuable and terribly horrible
8016 @c and interesting secrets. The @kbd{C-c M-d}
8017 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
8018 @c If you change your mind and want to turn the auto-saving back on again,
8019 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
8021 @c @vindex gnus-use-draft
8022 @c To leave association with the draft group off by default, set
8023 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
8025 @c @findex gnus-summary-send-draft
8026 @c @kindex S D c (Summary)
8027 @c When you want to continue editing the article, you simply enter the
8028 @c draft group and push @kbd{S D c} (@code{gnus-summary-send-draft}) to do
8029 @c that. You will be placed in a buffer where you left off.
8031 @c Rejected articles will also be put in this draft group (@pxref{Rejected
8034 @c @findex gnus-summary-send-all-drafts
8035 @c If you have lots of rejected messages you want to post (or mail) without
8036 @c doing further editing, you can use the @kbd{S D a} command
8037 @c (@code{gnus-summary-send-all-drafts}). This command understands the
8038 @c process/prefix convention (@pxref{Process/Prefix}).
8041 @c @node Rejected Articles
8042 @c @section Rejected Articles
8043 @c @cindex rejected articles
8045 @c Sometimes a news server will reject an article. Perhaps the server
8046 @c doesn't like your face. Perhaps it just feels miserable. Perhaps
8047 @c @emph{there be demons}. Perhaps you have included too much cited text.
8048 @c Perhaps the disk is full. Perhaps the server is down.
8050 @c These situations are, of course, totally beyond the control of Gnus.
8051 @c (Gnus, of course, loves the way you look, always feels great, has angels
8052 @c fluttering around inside of it, doesn't care about how much cited text
8053 @c you include, never runs full and never goes down.) So Gnus saves these
8054 @c articles until some later time when the server feels better.
8056 @c The rejected articles will automatically be put in a special draft group
8057 @c (@pxref{Drafts}). When the server comes back up again, you'd then
8058 @c typically enter that group and send all the articles off.
8061 @node Select Methods
8062 @chapter Select Methods
8063 @cindex foreign groups
8064 @cindex select methods
8066 A @dfn{foreign group} is a group that is not read by the usual (or
8067 default) means. It could be, for instance, a group from a different
8068 @sc{nntp} server, it could be a virtual group, or it could be your own
8069 personal mail group.
8071 A foreign group (or any group, really) is specified by a @dfn{name} and
8072 a @dfn{select method}. To take the latter first, a select method is a
8073 list where the first element says what backend to use (e.g. @code{nntp},
8074 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
8075 name}. There may be additional elements in the select method, where the
8076 value may have special meaning for the backend in question.
8078 One could say that a select method defines a @dfn{virtual server}---so
8079 we do just that (@pxref{The Server Buffer}).
8081 The @dfn{name} of the group is the name the backend will recognize the
8084 For instance, the group @samp{soc.motss} on the @sc{nntp} server
8085 @samp{some.where.edu} will have the name @samp{soc.motss} and select
8086 method @code{(nntp "some.where.edu")}. Gnus will call this group
8087 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
8088 backend just knows this group as @samp{soc.motss}.
8090 The different methods all have their peculiarities, of course.
8093 * The Server Buffer:: Making and editing virtual servers.
8094 * Getting News:: Reading USENET news with Gnus.
8095 * Getting Mail:: Reading your personal mail with Gnus.
8096 * Other Sources:: Reading directories, files, SOUP packets.
8097 * Combined Groups:: Combining groups into one group.
8101 @node The Server Buffer
8102 @section The Server Buffer
8104 Traditionally, a @dfn{server} is a machine or a piece of software that
8105 one connects to, and then requests information from. Gnus does not
8106 connect directly to any real servers, but does all transactions through
8107 one backend or other. But that's just putting one layer more between
8108 the actual media and Gnus, so we might just as well say that each
8109 backend represents a virtual server.
8111 For instance, the @code{nntp} backend may be used to connect to several
8112 different actual @sc{nntp} servers, or, perhaps, to many different ports
8113 on the same actual @sc{nntp} server. You tell Gnus which backend to
8114 use, and what parameters to set by specifying a @dfn{select method}.
8116 These select method specifications can sometimes become quite
8117 complicated---say, for instance, that you want to read from the
8118 @sc{nntp} server @samp{news.funet.fi} on port number 13, which
8119 hangs if queried for @sc{nov} headers and has a buggy select. Ahem.
8120 Anyways, if you had to specify that for each group that used this
8121 server, that would be too much work, so Gnus offers a way of naming
8122 select methods, which is what you do in the server buffer.
8124 To enter the server buffer, user the @kbd{^}
8125 (@code{gnus-group-enter-server-mode}) command in the group buffer.
8128 * Server Buffer Format:: You can customize the look of this buffer.
8129 * Server Commands:: Commands to manipulate servers.
8130 * Example Methods:: Examples server specifications.
8131 * Creating a Virtual Server:: An example session.
8132 * Server Variables:: Which variables to set.
8133 * Servers and Methods:: You can use server names as select methods.
8134 * Unavailable Servers:: Some servers you try to contact may be down.
8137 @vindex gnus-server-mode-hook
8138 @code{gnus-server-mode-hook} is run when creating the server buffer.
8141 @node Server Buffer Format
8142 @subsection Server Buffer Format
8143 @cindex server buffer format
8145 @vindex gnus-server-line-format
8146 You can change the look of the server buffer lines by changing the
8147 @code{gnus-server-line-format} variable. This is a @code{format}-like
8148 variable, with some simple extensions:
8153 How the news is fetched---the backend name.
8156 The name of this server.
8159 Where the news is to be fetched from---the address.
8162 The opened/closed/denied status of the server.
8165 @vindex gnus-server-mode-line-format
8166 The mode line can also be customized by using the
8167 @code{gnus-server-mode-line-format} variable. The following specs are
8178 Also @pxref{Formatting Variables}.
8181 @node Server Commands
8182 @subsection Server Commands
8183 @cindex server commands
8189 @findex gnus-server-add-server
8190 Add a new server (@code{gnus-server-add-server}).
8194 @findex gnus-server-edit-server
8195 Edit a server (@code{gnus-server-edit-server}).
8198 @kindex SPACE (Server)
8199 @findex gnus-server-read-server
8200 Browse the current server (@code{gnus-server-read-server}).
8204 @findex gnus-server-exit
8205 Return to the group buffer (@code{gnus-server-exit}).
8209 @findex gnus-server-kill-server
8210 Kill the current server (@code{gnus-server-kill-server}).
8214 @findex gnus-server-yank-server
8215 Yank the previously killed server (@code{gnus-server-yank-server}).
8219 @findex gnus-server-copy-server
8220 Copy the current server (@code{gnus-server-copy-server}).
8224 @findex gnus-server-list-servers
8225 List all servers (@code{gnus-server-list-servers}).
8229 @findex gnus-server-scan-server
8230 Request that the server scan its sources for new articles
8231 (@code{gnus-server-scan-server}). This is mainly sensible with mail
8236 @findex gnus-server-regenerate-server
8237 Request that the server regenerate all its data structures
8238 (@code{gnus-server-regenerate-server}). This can be useful if you have
8239 a mail backend that has gotten out of synch.
8244 @node Example Methods
8245 @subsection Example Methods
8247 Most select methods are pretty simple and self-explanatory:
8250 (nntp "news.funet.fi")
8253 Reading directly from the spool is even simpler:
8259 As you can see, the first element in a select method is the name of the
8260 backend, and the second is the @dfn{address}, or @dfn{name}, if you
8263 After these two elements, there may be an arbitrary number of
8264 @var{(variable form)} pairs.
8266 To go back to the first example---imagine that you want to read from
8267 port 15 on that machine. This is what the select method should
8271 (nntp "news.funet.fi" (nntp-port-number 15))
8274 You should read the documentation to each backend to find out what
8275 variables are relevant, but here's an @code{nnmh} example:
8277 @code{nnmh} is a mail backend that reads a spool-like structure. Say
8278 you have two structures that you wish to access: One is your private
8279 mail spool, and the other is a public one. Here's the possible spec for
8283 (nnmh "private" (nnmh-directory "~/private/mail/"))
8286 (This server is then called @samp{private}, but you may have guessed
8289 Here's the method for a public spool:
8293 (nnmh-directory "/usr/information/spool/")
8294 (nnmh-get-new-mail nil))
8297 If you are behind a firewall and only have access to the @sc{nntp}
8298 server from the firewall machine, you can instruct Gnus to @code{rlogin}
8299 on the firewall machine and telnet from there to the @sc{nntp} server.
8300 Doing this can be rather fiddly, but your virtual server definition
8301 should probably look something like this:
8305 (nntp-address "the.firewall.machine")
8306 (nntp-open-connection-function nntp-open-rlogin)
8307 (nntp-end-of-line "\n")
8308 (nntp-rlogin-parameters
8309 ("telnet" "the.real.nntp.host" "nntp")))
8314 @node Creating a Virtual Server
8315 @subsection Creating a Virtual Server
8317 If you're saving lots of articles in the cache by using persistent
8318 articles, you may want to create a virtual server to read the cache.
8320 First you need to add a new server. The @kbd{a} command does that. It
8321 would probably be best to use @code{nnspool} to read the cache. You
8322 could also use @code{nnml} or @code{nnmh}, though.
8324 Type @kbd{a nnspool RET cache RET}.
8326 You should now have a brand new @code{nnspool} virtual server called
8327 @samp{cache}. You now need to edit it to have the right definitions.
8328 Type @kbd{e} to edit the server. You'll be entered into a buffer that
8329 will contain the following:
8339 (nnspool-spool-directory "~/News/cache/")
8340 (nnspool-nov-directory "~/News/cache/")
8341 (nnspool-active-file "~/News/cache/active"))
8344 Type @kbd{C-c C-c} to return to the server buffer. If you now press
8345 @kbd{RET} over this virtual server, you should be entered into a browse
8346 buffer, and you should be able to enter any of the groups displayed.
8349 @node Server Variables
8350 @subsection Server Variables
8352 One sticky point when defining variables (both on backends and in Emacs
8353 in general) is that some variables are typically initialized from other
8354 variables when the definition of the variables is being loaded. If you
8355 change the "base" variable after the variables have been loaded, you
8356 won't change the "derived" variables.
8358 This typically affects directory and file variables. For instance,
8359 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
8360 directory variables are initialized from that variable, so
8361 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
8362 new virtual @code{nnml} server, it will @emph{not} suffice to set just
8363 @code{nnml-directory}---you have to explicitly set all the file
8364 variables to be what you want them to be. For a complete list of
8365 variables for each backend, see each backend's section later in this
8366 manual, but here's an example @code{nnml} definition:
8370 (nnml-directory "~/my-mail/")
8371 (nnml-active-file "~/my-mail/active")
8372 (nnml-newsgroups-file "~/my-mail/newsgroups"))
8376 @node Servers and Methods
8377 @subsection Servers and Methods
8379 Wherever you would normally use a select method
8380 (e.g. @code{gnus-secondary-select-method}, in the group select method,
8381 when browsing a foreign server) you can use a virtual server name
8382 instead. This could potentially save lots of typing. And it's nice all
8386 @node Unavailable Servers
8387 @subsection Unavailable Servers
8389 If a server seems to be unreachable, Gnus will mark that server as
8390 @code{denied}. That means that any subsequent attempt to make contact
8391 with that server will just be ignored. ``It can't be opened,'' Gnus
8392 will tell you, without making the least effort to see whether that is
8393 actually the case or not.
8395 That might seem quite naughty, but it does make sense most of the time.
8396 Let's say you have 10 groups subscribed to on server
8397 @samp{nephelococcygia.com}. This server is located somewhere quite far
8398 away from you and the machine is quite slow, so it takes 1 minute just
8399 to find out that it refuses connection to you today. If Gnus were to
8400 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
8401 attempt to do that. Once it has gotten a single ``connection refused'',
8402 it will regard that server as ``down''.
8404 So, what happens if the machine was only feeling unwell temporarily?
8405 How do you test to see whether the machine has come up again?
8407 You jump to the server buffer (@pxref{The Server Buffer}) and poke it
8408 with the following commands:
8414 @findex gnus-server-open-server
8415 Try to establish connection to the server on the current line
8416 (@code{gnus-server-open-server}).
8420 @findex gnus-server-close-server
8421 Close the connection (if any) to the server
8422 (@code{gnus-server-close-server}).
8426 @findex gnus-server-deny-server
8427 Mark the current server as unreachable
8428 (@code{gnus-server-deny-server}).
8431 @kindex M-o (Server)
8432 @findex gnus-server-open-all-servers
8433 Open the connections to all servers in the buffer
8434 (@code{gnus-server-open-all-servers}).
8437 @kindex M-c (Server)
8438 @findex gnus-server-close-all-servers
8439 Close the connections to all servers in the buffer
8440 (@code{gnus-server-close-all-servers}).
8444 @findex gnus-server-remove-denials
8445 Remove all marks to whether Gnus was denied connection from any servers
8446 (@code{gnus-server-remove-denials}).
8452 @section Getting News
8453 @cindex reading news
8454 @cindex news backends
8456 A newsreader is normally used for reading news. Gnus currently provides
8457 only two methods of getting news---it can read from an @sc{nntp} server,
8458 or it can read from a local spool.
8461 * NNTP:: Reading news from an @sc{nntp} server.
8462 * News Spool:: Reading news from the local spool.
8467 @subsection @sc{nntp}
8470 Subscribing to a foreign group from an @sc{nntp} server is rather easy.
8471 You just specify @code{nntp} as method and the address of the @sc{nntp}
8472 server as the, uhm, address.
8474 If the @sc{nntp} server is located at a non-standard port, setting the
8475 third element of the select method to this port number should allow you
8476 to connect to the right port. You'll have to edit the group info for
8477 that (@pxref{Foreign Groups}).
8479 The name of the foreign group can be the same as a native group. In
8480 fact, you can subscribe to the same group from as many different servers
8481 you feel like. There will be no name collisions.
8483 The following variables can be used to create a virtual @code{nntp}
8488 @item nntp-server-opened-hook
8489 @vindex nntp-server-opened-hook
8490 @cindex @sc{mode reader}
8492 @cindex authentification
8493 @cindex nntp authentification
8494 @findex nntp-send-authinfo
8495 @findex nntp-send-mode-reader
8496 is run after a connection has been made. It can be used to send
8497 commands to the @sc{nntp} server after it has been contacted. By
8498 default it sends the command @code{MODE READER} to the server with the
8499 @code{nntp-send-mode-reader} function.
8501 @item nntp-authinfo-function
8502 @vindex nntp-authinfo-function
8503 This function will be used to send @samp{AUTHINFO} to the @sc{nntp}
8504 server. Available functions include:
8507 @item nntp-send-authinfo
8508 @findex nntp-send-authinfo
8509 This function will use your current login name as the user name and will
8510 prompt you for the password. This is the default.
8512 @item nntp-send-nosy-authinfo
8513 @findex nntp-send-nosy-authinfo
8514 This function will prompt you for both user name and password.
8516 @item nntp-send-authinfo-from-file
8517 @findex nntp-send-authinfo-from-file
8518 This function will use your current login name as the user name and will
8519 read the @sc{nntp} password from @file{~/.nntp-authinfo}.
8522 @item nntp-server-action-alist
8523 @vindex nntp-server-action-alist
8524 This is a list of regexps to match on server types and actions to be
8525 taken when matches are made. For instance, if you want Gnus to beep
8526 every time you connect to innd, you could say something like:
8529 (setq nntp-server-action-alist
8533 You probably don't want to do that, though.
8535 The default value is
8538 '(("nntpd 1\\.5\\.11t"
8539 (remove-hook 'nntp-server-opened-hook nntp-send-mode-reader)))
8542 This ensures that Gnus doesn't send the @code{MODE READER} command to
8543 nntpd 1.5.11t, since that command chokes that server, I've been told.
8545 @item nntp-maximum-request
8546 @vindex nntp-maximum-request
8547 If the @sc{nntp} server doesn't support @sc{nov} headers, this backend
8548 will collect headers by sending a series of @code{head} commands. To
8549 speed things up, the backend sends lots of these commands without
8550 waiting for reply, and then reads all the replies. This is controlled
8551 by the @code{nntp-maximum-request} variable, and is 400 by default. If
8552 your network is buggy, you should set this to 1.
8554 @item nntp-connection-timeout
8555 @vindex nntp-connection-timeout
8556 If you have lots of foreign @code{nntp} groups that you connect to
8557 regularly, you're sure to have problems with @sc{nntp} servers not
8558 responding properly, or being too loaded to reply within reasonable
8559 time. This is can lead to awkward problems, which can be helped
8560 somewhat by setting @code{nntp-connection-timeout}. This is an integer
8561 that says how many seconds the @code{nntp} backend should wait for a
8562 connection before giving up. If it is @code{nil}, which is the default,
8563 no timeouts are done.
8565 @item nntp-command-timeout
8566 @vindex nntp-command-timeout
8567 @cindex PPP connections
8568 @cindex dynamic IP addresses
8569 If you're running Gnus on a machine that has a dynamically assigned
8570 address, Gnus may become confused. If the address of your machine
8571 changes after connecting to the @sc{nntp} server, Gnus will simply sit
8572 waiting forever for replies from the server. To help with this
8573 unfortunate problem, you can set this command to a number. Gnus will
8574 then, if it sits waiting for a reply from the server longer than that
8575 number of seconds, shut down the connection, start a new one, and resend
8576 the command. This should hopefully be transparent to the user. A
8577 likely number is 30 seconds.
8579 @item nntp-retry-on-break
8580 @vindex nntp-retry-on-break
8581 If this variable is non-@code{nil}, you can also @kbd{C-g} if Gnus
8582 hangs. This will have much the same effect as the command timeout
8585 @item nntp-server-hook
8586 @vindex nntp-server-hook
8587 This hook is run as the last step when connecting to an @sc{nntp}
8590 @findex nntp-open-rlogin
8591 @findex nntp-open-telnet
8592 @findex nntp-open-network-stream
8593 @item nntp-open-connection-function
8594 @vindex nntp-open-connection-function
8595 This function is used to connect to the remote system. Three pre-made
8596 functions are @code{nntp-open-network-stream}, which is the default, and
8597 simply connects to some port or other on the remote system. The other
8598 two are @code{nntp-open-rlogin}, which does an @samp{rlogin} on the
8599 remote system, and then does a @samp{telnet} to the @sc{nntp} server
8600 available there, and @code{nntp-open-telnet}, which does a @samp{telnet}
8601 to the remote system and then another @samp{telnet} to get to the
8604 @code{nntp-open-rlogin}-related variables:
8608 @item nntp-rlogin-parameters
8609 @vindex nntp-rlogin-parameters
8610 This list will be used as the parameter list given to @code{rsh}.
8612 @item nntp-rlogin-user-name
8613 @vindex nntp-rlogin-user-name
8614 User name on the remote system.
8618 @code{nntp-open-telnet}-related variables:
8621 @item nntp-telnet-command
8622 @vindex nntp-telnet-command
8623 Command used to start @code{telnet}.
8625 @item nntp-telnet-switches
8626 @vindex nntp-telnet-switches
8627 List of strings to be used as the switches to the @code{telnet} command.
8629 @item nntp-telnet-user-name
8630 @vindex nntp-telnet-user-name
8631 User name for log in on the remote system.
8633 @item nntp-telnet-passwd
8634 @vindex nntp-telnet-passwd
8635 Password to use when logging in.
8637 @item nntp-telnet-parameters
8638 @vindex nntp-telnet-parameters
8639 A list of strings executed as a command after logging in
8644 @item nntp-end-of-line
8645 @vindex nntp-end-of-line
8646 String to use as end-of-line marker when talking to the @sc{nntp}
8647 server. This is @samp{\r\n} by default, but should be @samp{\n} when
8648 using @code{rlogin} to talk to the server.
8650 @item nntp-rlogin-user-name
8651 @vindex nntp-rlogin-user-name
8652 User name on the remote system when using the @code{rlogin} connect
8656 @vindex nntp-address
8657 The address of the remote system running the @sc{nntp} server.
8659 @item nntp-port-number
8660 @vindex nntp-port-number
8661 Port number to connect to when using the @code{nntp-open-network-stream}
8664 @item nntp-buggy-select
8665 @vindex nntp-buggy-select
8666 Set this to non-@code{nil} if your select routine is buggy.
8668 @item nntp-nov-is-evil
8669 @vindex nntp-nov-is-evil
8670 If the @sc{nntp} server does not support @sc{nov}, you could set this
8671 variable to @code{t}, but @code{nntp} usually checks automatically whether @sc{nov}
8674 @item nntp-xover-commands
8675 @vindex nntp-xover-commands
8678 List of strings that are used as commands to fetch @sc{nov} lines from a
8679 server. The default value of this variable is @code{("XOVER"
8683 @vindex nntp-nov-gap
8684 @code{nntp} normally sends just one big request for @sc{nov} lines to
8685 the server. The server responds with one huge list of lines. However,
8686 if you have read articles 2-5000 in the group, and only want to read
8687 article 1 and 5001, that means that @code{nntp} will fetch 4999 @sc{nov}
8688 lines that you will not need. This variable says how
8689 big a gap between two consecutive articles is allowed to be before the
8690 @code{XOVER} request is split into several request. Note that if your
8691 network is fast, setting this variable to a really small number means
8692 that fetching will probably be slower. If this variable is @code{nil},
8693 @code{nntp} will never split requests.
8695 @item nntp-prepare-server-hook
8696 @vindex nntp-prepare-server-hook
8697 A hook run before attempting to connect to an @sc{nntp} server.
8699 @item nntp-warn-about-losing-connection
8700 @vindex nntp-warn-about-losing-connection
8701 If this variable is non-@code{nil}, some noise will be made when a
8702 server closes connection.
8708 @subsection News Spool
8712 Subscribing to a foreign group from the local spool is extremely easy,
8713 and might be useful, for instance, to speed up reading groups that
8714 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
8717 Anyways, you just specify @code{nnspool} as the method and @samp{} (or
8718 anything else) as the address.
8720 If you have access to a local spool, you should probably use that as the
8721 native select method (@pxref{Finding the News}). It is normally faster
8722 than using an @code{nntp} select method, but might not be. It depends.
8723 You just have to try to find out what's best at your site.
8727 @item nnspool-inews-program
8728 @vindex nnspool-inews-program
8729 Program used to post an article.
8731 @item nnspool-inews-switches
8732 @vindex nnspool-inews-switches
8733 Parameters given to the inews program when posting an article.
8735 @item nnspool-spool-directory
8736 @vindex nnspool-spool-directory
8737 Where @code{nnspool} looks for the articles. This is normally
8738 @file{/usr/spool/news/}.
8740 @item nnspool-nov-directory
8741 @vindex nnspool-nov-directory
8742 Where @code{nnspool} will look for @sc{nov} files. This is normally
8743 @file{/usr/spool/news/over.view/}.
8745 @item nnspool-lib-dir
8746 @vindex nnspool-lib-dir
8747 Where the news lib dir is (@file{/usr/lib/news/} by default).
8749 @item nnspool-active-file
8750 @vindex nnspool-active-file
8751 The path to the active file.
8753 @item nnspool-newsgroups-file
8754 @vindex nnspool-newsgroups-file
8755 The path to the group descriptions file.
8757 @item nnspool-history-file
8758 @vindex nnspool-history-file
8759 The path to the news history file.
8761 @item nnspool-active-times-file
8762 @vindex nnspool-active-times-file
8763 The path to the active date file.
8765 @item nnspool-nov-is-evil
8766 @vindex nnspool-nov-is-evil
8767 If non-@code{nil}, @code{nnspool} won't try to use any @sc{nov} files
8770 @item nnspool-sift-nov-with-sed
8771 @vindex nnspool-sift-nov-with-sed
8773 If non-@code{nil}, which is the default, use @code{sed} to get the
8774 relevant portion from the overview file. If nil, @code{nnspool} will
8775 load the entire file into a buffer and process it there.
8781 @section Getting Mail
8782 @cindex reading mail
8785 Reading mail with a newsreader---isn't that just plain WeIrD? But of
8789 * Getting Started Reading Mail:: A simple cookbook example.
8790 * Splitting Mail:: How to create mail groups.
8791 * Mail Backend Variables:: Variables for customizing mail handling.
8792 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
8793 * Mail and Procmail:: Reading mail groups that procmail create.
8794 * Incorporating Old Mail:: What about the old mail you have?
8795 * Expiring Mail:: Getting rid of unwanted mail.
8796 * Washing Mail:: Removing gruft from the mail you get.
8797 * Duplicates:: Dealing with duplicated mail.
8798 * Not Reading Mail:: Using mail backends for reading other files.
8799 * Choosing a Mail Backend:: Gnus can read a variety of mail formats.
8803 @node Getting Started Reading Mail
8804 @subsection Getting Started Reading Mail
8806 It's quite easy to use Gnus to read your new mail. You just plonk the
8807 mail backend of your choice into @code{gnus-secondary-select-methods},
8808 and things will happen automatically.
8810 For instance, if you want to use @code{nnml} (which is a "one file per
8811 mail" backend), you could put the following in your @file{.gnus} file:
8814 (setq gnus-secondary-select-methods
8815 '((nnml "private")))
8818 Now, the next time you start Gnus, this backend will be queried for new
8819 articles, and it will move all the messages in your spool file to its
8820 directory, which is @code{~/Mail/} by default. The new group that will
8821 be created (@samp{mail.misc}) will be subscribed, and you can read it
8822 like any other group.
8824 You will probably want to split the mail into several groups, though:
8827 (setq nnmail-split-methods
8828 '(("junk" "^From:.*Lars Ingebrigtsen")
8829 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
8833 This will result in three new @code{nnml} mail groups being created:
8834 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
8835 mail that doesn't fit into the first two groups will be placed in the
8838 This should be sufficient for reading mail with Gnus. You might want to
8839 give the other sections in this part of the manual a perusal, though.
8840 Especially @pxref{Choosing a Mail Backend} and @pxref{Expiring Mail}.
8843 @node Splitting Mail
8844 @subsection Splitting Mail
8845 @cindex splitting mail
8846 @cindex mail splitting
8848 @vindex nnmail-split-methods
8849 The @code{nnmail-split-methods} variable says how the incoming mail is
8850 to be split into groups.
8853 (setq nnmail-split-methods
8854 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
8855 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
8859 This variable is a list of lists, where the first element of each of
8860 these lists is the name of the mail group (they do not have to be called
8861 something beginning with @samp{mail}, by the way), and the second
8862 element is a regular expression used on the header of each mail to
8863 determine if it belongs in this mail group.
8865 If the first element is the special symbol @code{junk}, then messages
8866 that match the regexp will disappear into the aether. Use with
8869 The second element can also be a function. In that case, it will be
8870 called narrowed to the headers with the first element of the rule as the
8871 argument. It should return a non-@code{nil} value if it thinks that the
8872 mail belongs in that group.
8874 The last of these groups should always be a general one, and the regular
8875 expression should @emph{always} be @samp{} so that it matches any mails
8876 that haven't been matched by any of the other regexps. (These rules are
8877 processed from the beginning of the alist toward the end. The first
8878 rule to make a match will "win", unless you have crossposting enabled.
8879 In that case, all matching rules will "win".)
8881 If you like to tinker with this yourself, you can set this variable to a
8882 function of your choice. This function will be called without any
8883 arguments in a buffer narrowed to the headers of an incoming mail
8884 message. The function should return a list of group names that it
8885 thinks should carry this mail message.
8887 Note that the mail backends are free to maul the poor, innocent,
8888 incoming headers all they want to. They all add @code{Lines} headers;
8889 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
8890 @code{From<SPACE>} line to something else.
8892 @vindex nnmail-crosspost
8893 The mail backends all support cross-posting. If several regexps match,
8894 the mail will be ``cross-posted'' to all those groups.
8895 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
8896 that no articles are crossposted to the general (@samp{}) group.
8898 @vindex nnmail-crosspost-link-function
8901 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
8902 the crossposted articles. However, not all file systems support hard
8903 links. If that's the case for you, set
8904 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
8905 variable is @code{add-name-to-file} by default.)
8907 @kindex M-x nnmail-split-history
8908 @kindex nnmail-split-history
8909 If you wish to see where the previous mail split put the messages, you
8910 can use the @kbd{M-x nnmail-split-history} command.
8912 Gnus gives you all the opportunity you could possibly want for shooting
8913 yourself in the foot. Let's say you create a group that will contain
8914 all the mail you get from your boss. And then you accidentally
8915 unsubscribe from the group. Gnus will still put all the mail from your
8916 boss in the unsubscribed group, and so, when your boss mails you ``Have
8917 that report ready by Monday or you're fired!'', you'll never see it and,
8918 come Tuesday, you'll still believe that you're gainfully employed while
8919 you really should be out collecting empty bottles to save up for next
8923 @node Mail Backend Variables
8924 @subsection Mail Backend Variables
8926 These variables are (for the most part) pertinent to all the various
8930 @vindex nnmail-read-incoming-hook
8931 @item nnmail-read-incoming-hook
8932 The mail backends all call this hook after reading new mail. You can
8933 use this hook to notify any mail watch programs, if you want to.
8935 @vindex nnmail-spool-file
8936 @item nnmail-spool-file
8940 @vindex nnmail-pop-password
8941 @vindex nnmail-pop-password-required
8942 The backends will look for new mail in this file. If this variable is
8943 @code{nil}, the mail backends will never attempt to fetch mail by
8944 themselves. If you are using a POP mail server and your name is
8945 @samp{larsi}, you should set this variable to @samp{po:larsi}. If
8946 your name is not @samp{larsi}, you should probably modify that
8947 slightly, but you may have guessed that already, you smart & handsome
8948 devil! You can also set this variable to @code{pop}, and Gnus will try
8949 to figure out the POP mail string by itself. In any case, Gnus will
8950 call @code{movemail} which will contact the POP server named in the
8951 @code{MAILHOST} environment variable. If the POP server needs a
8952 password, you can either set @code{nnmail-pop-password-required} to
8953 @code{t} and be prompted for the password, or set
8954 @code{nnmail-pop-password} to the password itself.
8956 @code{nnmail-spool-file} can also be a list of mailboxes.
8958 Your Emacs has to have been configured with @samp{--with-pop} before
8959 compilation. This is the default, but some installations have it
8962 When you use a mail backend, Gnus will slurp all your mail from your
8963 inbox and plonk it down in your home directory. Gnus doesn't move any
8964 mail if you're not using a mail backend---you have to do a lot of magic
8965 invocations first. At the time when you have finished drawing the
8966 pentagram, lightened the candles, and sacrificed the goat, you really
8967 shouldn't be too surprised when Gnus moves your mail.
8969 @vindex nnmail-use-procmail
8970 @vindex nnmail-procmail-suffix
8971 @item nnmail-use-procmail
8972 If non-@code{nil}, the mail backends will look in
8973 @code{nnmail-procmail-directory} for incoming mail. All the files in
8974 that directory that have names ending in @code{nnmail-procmail-suffix}
8975 will be considered incoming mailboxes, and will be searched for new
8978 @vindex nnmail-crash-box
8979 @item nnmail-crash-box
8980 When a mail backend reads a spool file, mail is first moved to this
8981 file, which is @file{~/.gnus-crash-box} by default. If this file
8982 already exists, it will always be read (and incorporated) before any
8985 @vindex nnmail-prepare-incoming-hook
8986 @item nnmail-prepare-incoming-hook
8987 This is run in a buffer that holds all the new incoming mail, and can be
8988 used for, well, anything, really.
8990 @vindex nnmail-split-hook
8991 @item nnmail-split-hook
8992 @findex article-decode-rfc1522
8993 @findex RFC1522 decoding
8994 Hook run in the buffer where the mail headers of each message is kept
8995 just before the splitting based on these headers is done. The hook is
8996 free to modify the buffer contents in any way it sees fit---the buffer
8997 is discarded after the splitting has been done, and no changes performed
8998 in the buffer will show up in any files. @code{gnus-article-decode-rfc1522}
8999 is one likely function to add to this hook.
9001 @vindex nnmail-pre-get-new-mail-hook
9002 @vindex nnmail-post-get-new-mail-hook
9003 @item nnmail-pre-get-new-mail-hook
9004 @itemx nnmail-post-get-new-mail-hook
9005 These are two useful hooks executed when treating new incoming
9006 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
9007 starting to handle the new mail) and
9008 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
9009 is done). Here's and example of using these two hooks to change the
9010 default file modes the new mail files get:
9013 (add-hook 'gnus-pre-get-new-mail-hook
9014 (lambda () (set-default-file-modes 511)))
9016 (add-hook 'gnus-post-get-new-mail-hook
9017 (lambda () (set-default-file-modes 551)))
9020 @item nnmail-tmp-directory
9021 @vindex nnmail-tmp-directory
9022 This variable says where to move incoming mail to -- while processing
9023 it. This is usually done in the same directory that the mail backend
9024 inhabits (e.g., @file{~/Mail/}), but if this variable is non-@code{nil},
9025 it will be used instead.
9027 @item nnmail-movemail-program
9028 @vindex nnmail-movemail-program
9029 This program is executed to move mail from the user's inbox to her home
9030 directory. The default is @samp{movemail}.
9032 This can also be a function. In that case, the function will be called
9033 with two parameters -- the name of the inbox, and the file to be moved
9036 @item nnmail-delete-incoming
9037 @vindex nnmail-delete-incoming
9038 @cindex incoming mail files
9039 @cindex deleting incoming files
9040 If non-@code{nil}, the mail backends will delete the temporary incoming
9041 file after splitting mail into the proper groups. This is @code{t} by
9044 @c This is @code{nil} by
9045 @c default for reasons of security.
9047 @c Since Red Gnus is an alpha release, it is to be expected to lose mail.
9048 (No Gnus release since (ding) Gnus 0.10 (or something like that) have
9049 lost mail, I think, but that's not the point. (Except certain versions
9050 of Red Gnus.)) By not deleting the Incoming* files, one can be sure not
9051 to lose mail -- if Gnus totally whacks out, one can always recover what
9054 You may delete the @file{Incoming*} files at will.
9056 @item nnmail-use-long-file-names
9057 @vindex nnmail-use-long-file-names
9058 If non-@code{nil}, the mail backends will use long file and directory
9059 names. Groups like @samp{mail.misc} will end up in directories
9060 (assuming use of @code{nnml} backend) or files (assuming use of
9061 @code{nnfolder} backend) like @file{mail.misc}. If it is @code{nil},
9062 the same group will end up in @file{mail/misc}.
9064 @item nnmail-delete-file-function
9065 @vindex nnmail-delete-file-function
9067 Function called to delete files. It is @code{delete-file} by default.
9069 @item nnmail-cache-accepted-message-ids
9070 @vindex nnmail-cache-accepted-message-ids
9071 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
9072 the backend (via @code{Gcc}, for instance) into the mail duplication
9073 discovery cache. The default is @code{nil}.
9078 @node Fancy Mail Splitting
9079 @subsection Fancy Mail Splitting
9080 @cindex mail splitting
9081 @cindex fancy mail splitting
9083 @vindex nnmail-split-fancy
9084 @findex nnmail-split-fancy
9085 If the rather simple, standard method for specifying how to split mail
9086 doesn't allow you to do what you want, you can set
9087 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
9088 play with the @code{nnmail-split-fancy} variable.
9090 Let's look at an example value of this variable first:
9093 ;; Messages from the mailer daemon are not crossposted to any of
9094 ;; the ordinary groups. Warnings are put in a separate group
9095 ;; from real errors.
9096 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
9098 ;; Non-error messages are crossposted to all relevant
9099 ;; groups, but we don't crosspost between the group for the
9100 ;; (ding) list and the group for other (ding) related mail.
9101 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
9102 ("subject" "ding" "ding.misc"))
9103 ;; Other mailing lists...
9104 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
9105 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
9107 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
9108 ;; Unmatched mail goes to the catch all group.
9112 This variable has the format of a @dfn{split}. A split is a (possibly)
9113 recursive structure where each split may contain other splits. Here are
9114 the five possible split syntaxes:
9119 @samp{group}: If the split is a string, that will be taken as a group name.
9122 @var{(FIELD VALUE SPLIT)}: If the split is a list, the first element of
9123 which is a string, then store the message as specified by SPLIT, if
9124 header FIELD (a regexp) contains VALUE (also a regexp).
9127 @var{(| SPLIT...)}: If the split is a list, and the first element is
9128 @code{|} (vertical bar), then process each SPLIT until one of them
9129 matches. A SPLIT is said to match if it will cause the mail message to
9130 be stored in one or more groups.
9133 @var{(& SPLIT...)}: If the split is a list, and the first element is
9134 @code{&}, then process all SPLITs in the list.
9137 @code{junk}: If the split is the symbol @code{junk}, then don't save
9138 this message anywhere.
9141 @var{(: function arg1 arg2 ...)}: If the split is a list, and the first
9142 element is @code{:}, then the second element will be called as a
9143 function with @var{args} given as arguments. The function should return
9148 In these splits, @var{FIELD} must match a complete field name.
9149 @var{VALUE} must match a complete word according to the fundamental mode
9150 syntax table. You can use @code{.*} in the regexps to match partial
9151 field names or words. In other words, all @var{VALUE}'s are wrapped in
9152 @samp{\<} and @samp{\>} pairs.
9154 @vindex nnmail-split-abbrev-alist
9155 @var{FIELD} and @var{VALUE} can also be lisp symbols, in that case they
9156 are expanded as specified by the variable
9157 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells, where
9158 the car of a cell contains the key, and the cdr contains the associated
9161 @vindex nnmail-split-fancy-syntax-table
9162 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
9163 when all this splitting is performed.
9165 If you want to have Gnus create groups dynamically based on some
9166 information in the headers (i.e., do @code{replace-match}-like
9167 substitions in the group names), you can say things like:
9170 (any "debian-\(\\w*\\)@@lists.debian.org" "mail.debian.\\1")
9173 @node Mail and Procmail
9174 @subsection Mail and Procmail
9179 Many people use @code{procmail} (or some other mail filter program or
9180 external delivery agent---@code{slocal}, @code{elm}, etc) to split
9181 incoming mail into groups. If you do that, you should set
9182 @code{nnmail-spool-file} to @code{procmail} to ensure that the mail
9183 backends never ever try to fetch mail by themselves.
9185 This also means that you probably don't want to set
9186 @code{nnmail-split-methods} either, which has some, perhaps, unexpected
9189 When a mail backend is queried for what groups it carries, it replies
9190 with the contents of that variable, along with any groups it has figured
9191 out that it carries by other means. None of the backends, except
9192 @code{nnmh}, actually go out to the disk and check what groups actually
9193 exist. (It's not trivial to distinguish between what the user thinks is
9194 a basis for a newsgroup and what is just a plain old file or directory.)
9196 This means that you have to tell Gnus (and the backends) by hand what
9199 Let's take the @code{nnmh} backend as an example:
9201 The folders are located in @code{nnmh-directory}, say, @file{~/Mail/}.
9202 There are three folders, @file{foo}, @file{bar} and @file{mail.baz}.
9204 Go to the group buffer and type @kbd{G m}. When prompted, answer
9205 @samp{foo} for the name and @samp{nnmh} for the method. Repeat
9206 twice for the two other groups, @samp{bar} and @samp{mail.baz}. Be sure
9207 to include all your mail groups.
9209 That's it. You are now set to read your mail. An active file for this
9210 method will be created automatically.
9212 @vindex nnmail-procmail-suffix
9213 @vindex nnmail-procmail-directory
9214 If you use @code{nnfolder} or any other backend that store more than a
9215 single article in each file, you should never have procmail add mails to
9216 the file that Gnus sees. Instead, procmail should put all incoming mail
9217 in @code{nnmail-procmail-directory}. To arrive at the file name to put
9218 the incoming mail in, append @code{nnmail-procmail-suffix} to the group
9219 name. The mail backends will read the mail from these files.
9221 @vindex nnmail-resplit-incoming
9222 When Gnus reads a file called @file{mail.misc.spool}, this mail will be
9223 put in the @code{mail.misc}, as one would expect. However, if you want
9224 Gnus to split the mail the normal way, you could set
9225 @code{nnmail-resplit-incoming} to @code{t}.
9227 @vindex nnmail-keep-last-article
9228 If you use @code{procmail} to split things directly into an @code{nnmh}
9229 directory (which you shouldn't do), you should set
9230 @code{nnmail-keep-last-article} to non-@code{nil} to prevent Gnus from
9231 ever expiring the final article (i.e., the article with the highest
9232 article number) in a mail newsgroup. This is quite, quite important.
9234 Here's an example setup: The incoming spools are located in
9235 @file{~/incoming/} and have @samp{""} as suffixes (i.e., the incoming
9236 spool files have the same names as the equivalent groups). The
9237 @code{nnfolder} backend is to be used as the mail interface, and the
9238 @code{nnfolder} directory is @file{~/fMail/}.
9241 (setq nnfolder-directory "~/fMail/")
9242 (setq nnmail-spool-file 'procmail)
9243 (setq nnmail-procmail-directory "~/incoming/")
9244 (setq gnus-secondary-select-methods '((nnfolder "")))
9245 (setq nnmail-procmail-suffix "")
9249 @node Incorporating Old Mail
9250 @subsection Incorporating Old Mail
9252 Most people have lots of old mail stored in various file formats. If
9253 you have set up Gnus to read mail using one of the spiffy Gnus mail
9254 backends, you'll probably wish to have that old mail incorporated into
9257 Doing so can be quite easy.
9259 To take an example: You're reading mail using @code{nnml}
9260 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
9261 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
9262 file filled with important, but old, mail. You want to move it into
9263 your @code{nnml} groups.
9269 Go to the group buffer.
9272 Type `G f' and give the path to the mbox file when prompted to create an
9273 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
9276 Type `SPACE' to enter the newly created group.
9279 Type `M P b' to process-mark all articles in this group's buffer
9280 (@pxref{Setting Process Marks}).
9283 Type `B r' to respool all the process-marked articles, and answer
9284 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
9287 All the mail messages in the mbox file will now also be spread out over
9288 all your @code{nnml} groups. Try entering them and check whether things
9289 have gone without a glitch. If things look ok, you may consider
9290 deleting the mbox file, but I wouldn't do that unless I was absolutely
9291 sure that all the mail has ended up where it should be.
9293 Respooling is also a handy thing to do if you're switching from one mail
9294 backend to another. Just respool all the mail in the old mail groups
9295 using the new mail backend.
9299 @subsection Expiring Mail
9300 @cindex article expiry
9302 Traditional mail readers have a tendency to remove mail articles when
9303 you mark them as read, in some way. Gnus takes a fundamentally
9304 different approach to mail reading.
9306 Gnus basically considers mail just to be news that has been received in
9307 a rather peculiar manner. It does not think that it has the power to
9308 actually change the mail, or delete any mail messages. If you enter a
9309 mail group, and mark articles as ``read'', or kill them in some other
9310 fashion, the mail articles will still exist on the system. I repeat:
9311 Gnus will not delete your old, read mail. Unless you ask it to, of
9314 To make Gnus get rid of your unwanted mail, you have to mark the
9315 articles as @dfn{expirable}. This does not mean that the articles will
9316 disappear right away, however. In general, a mail article will be
9317 deleted from your system if, 1) it is marked as expirable, AND 2) it is
9318 more than one week old. If you do not mark an article as expirable, it
9319 will remain on your system until hell freezes over. This bears
9320 repeating one more time, with some spurious capitalizations: IF you do
9321 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
9323 @vindex gnus-auto-expirable-newsgroups
9324 You do not have to mark articles as expirable by hand. Groups that
9325 match the regular expression @code{gnus-auto-expirable-newsgroups} will
9326 have all articles that you read marked as expirable automatically. All
9327 articles that are marked as expirable have an @samp{E} in the first
9328 column in the summary buffer.
9330 By default, if you have auto expiry switched on, Gnus will mark all the
9331 articles you read as expirable, no matter if they were read or unread
9332 before. To avoid having articles marked as read marked as expirable
9333 automatically, you can put something like the following in your
9336 @vindex gnus-mark-article-hook
9338 (remove-hook 'gnus-mark-article-hook
9339 'gnus-summary-mark-read-and-unread-as-read)
9340 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
9343 Note that making a group auto-expirable doesn't mean that all read
9344 articles are expired---only the articles that are marked as expirable
9345 will be expired. Also note that using the @kbd{d} command won't make
9346 groups expirable---only semi-automatic marking of articles as read will
9347 mark the articles as expirable in auto-expirable groups.
9349 Let's say you subscribe to a couple of mailing lists, and you want the
9350 articles you have read to disappear after a while:
9353 (setq gnus-auto-expirable-newsgroups
9354 "mail.nonsense-list\\|mail.nice-list")
9357 Another way to have auto-expiry happen is to have the element
9358 @code{auto-expire} in the group parameters of the group.
9360 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
9361 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
9362 don't really mix very well.
9364 @vindex nnmail-expiry-wait
9365 The @code{nnmail-expiry-wait} variable supplies the default time an
9366 expirable article has to live. Gnus starts counting days from when the
9367 message @emph{arrived}, not from when it was sent. The default is seven
9370 Gnus also supplies a function that lets you fine-tune how long articles
9371 are to live, based on what group they are in. Let's say you want to
9372 have one month expiry period in the @samp{mail.private} group, a one day
9373 expiry period in the @samp{mail.junk} group, and a six day expiry period
9376 @vindex nnmail-expiry-wait-function
9378 (setq nnmail-expiry-wait-function
9380 (cond ((string= group "mail.private")
9382 ((string= group "mail.junk")
9384 ((string= group "important")
9390 The group names this function is fed are ``unadorned'' group
9391 names---no @samp{nnml:} prefixes and the like.
9393 The @code{nnmail-expiry-wait} variable and
9394 @code{nnmail-expiry-wait-function} function can either be a number (not
9395 necessarily an integer) or one of the symbols @code{immediate} or
9398 You can also use the @code{expiry-wait} group parameter to selectively
9399 change the expiry period (@pxref{Group Parameters}).
9401 @vindex nnmail-keep-last-article
9402 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
9403 expire the final article in a mail newsgroup. This is to make life
9404 easier for procmail users.
9406 @vindex gnus-total-expirable-newsgroups
9407 By the way: That line up there, about Gnus never expiring non-expirable
9408 articles, is a lie. If you put @code{total-expire} in the group
9409 parameters, articles will not be marked as expirable, but all read
9410 articles will be put through the expiry process. Use with extreme
9411 caution. Even more dangerous is the
9412 @code{gnus-total-expirable-newsgroups} variable. All groups that match
9413 this regexp will have all read articles put through the expiry process,
9414 which means that @emph{all} old mail articles in the groups in question
9415 will be deleted after a while. Use with extreme caution, and don't come
9416 crying to me when you discover that the regexp you used matched the
9417 wrong group and all your important mail has disappeared. Be a
9418 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
9421 Most people make most of their mail groups total-expirable, though.
9425 @subsection Washing Mail
9426 @cindex mail washing
9427 @cindex list server brain damage
9428 @cindex incoming mail treatment
9430 Mailers and list servers are notorious for doing all sorts of really,
9431 really stupid things with mail. ``Hey, RFC822 doesn't explicitly
9432 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
9433 end of all lines passing through our server, so let's do that!!!!1!''
9434 Yes, but RFC822 wasn't designed to be read by morons. Things that were
9435 considered to be self-evident were not discussed. So. Here we are.
9437 Case in point: The German version of Microsoft Exchange adds @samp{AW:
9438 } to the subjects of replies instead of @samp{Re: }. I could pretend to
9439 be shocked and dismayed by this, but I haven't got the energy. It is to
9442 Gnus provides a plethora of functions for washing articles while
9443 displaying them, but it might be nicer to do the filtering before
9444 storing the mail to disc. For that purpose, we have three hooks and
9445 various functions that can be put in these hooks.
9448 @item nnmail-prepare-incoming-hook
9449 @vindex nnmail-prepare-incoming-hook
9450 This hook is called before doing anything with the mail and is meant for
9451 grand, sweeping gestures. Functions to be used include:
9454 @item nnheader-ms-strip-cr
9455 @findex nnheader-ms-strip-cr
9456 Remove trailing carriage returns from each line. This is default on
9457 Emacs running on MS machines.
9461 @item nnmail-prepare-incoming-header-hook
9462 @vindex nnmail-prepare-incoming-header-hook
9463 This hook is called narrowed to each header. It can be used when
9464 cleaning up the headers. Functions that can be used include:
9467 @item nnmail-remove-leading-whitespace
9468 @findex nnmail-remove-leading-whitespace
9469 Clear leading white space that ``helpful'' listservs have added to the
9470 headers to make them look nice. Aaah.
9472 @item nnmail-remove-list-identifiers
9473 @findex nnmail-remove-list-identifiers
9474 Some list servers add an identifier---for example, @samp{(idm)}---to the
9475 beginning of all @code{Subject} headers. I'm sure that's nice for
9476 people who use stone age mail readers. This function will remove
9477 strings that match the @code{nnmail-list-identifiers} regexp, which can
9478 also be a list of regexp.
9480 For instance, if you want to remove the @samp{(idm)} and the
9481 @samp{nagnagnag} identifiers:
9484 (setq nnmail-list-identifiers
9485 '("(idm)" "nagnagnag"))
9488 @item nnmail-remove-tabs
9489 @findex nnmail-remove-tabs
9490 Translate all @samp{TAB} characters into @samp{SPACE} characters.
9494 @item nnmail-prepare-incoming-message-hook
9495 @vindex nnmail-prepare-incoming-message-hook
9496 This hook is called narrowed to each message. Functions to be used
9500 @item article-de-quoted-unreadable
9501 @findex article-de-quoted-unreadable
9502 Decode Quoted Readable encoding.
9509 @subsection Duplicates
9511 @vindex nnmail-treat-duplicates
9512 @vindex nnmail-message-id-cache-length
9513 @vindex nnmail-message-id-cache-file
9514 @cindex duplicate mails
9515 If you are a member of a couple of mailing lists, you will sometimes
9516 receive two copies of the same mail. This can be quite annoying, so
9517 @code{nnmail} checks for and treats any duplicates it might find. To do
9518 this, it keeps a cache of old @code{Message-ID}s---
9519 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
9520 default. The approximate maximum number of @code{Message-ID}s stored
9521 there is controlled by the @code{nnmail-message-id-cache-length}
9522 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
9523 stored.) If all this sounds scary to you, you can set
9524 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
9525 default), and @code{nnmail} won't delete duplicate mails. Instead it
9526 will insert a warning into the head of the mail saying that it thinks
9527 that this is a duplicate of a different message.
9529 This variable can also be a function. If that's the case, the function
9530 will be called from a buffer narrowed to the message in question with
9531 the @code{Message-ID} as a parameter. The function must return either
9532 @code{nil}, @code{warn}, or @code{delete}.
9534 You can turn this feature off completely by setting the variable to
9537 If you want all the duplicate mails to be put into a special
9538 @dfn{duplicates} group, you could do that using the normal mail split
9542 (setq nnmail-split-fancy
9543 '(| ;; Messages duplicates go to a separate group.
9544 ("gnus-warning" "duplication of message" "duplicate")
9545 ;; Message from daemons, postmaster, and the like to another.
9546 (any mail "mail.misc")
9553 (setq nnmail-split-methods
9554 '(("duplicates" "^Gnus-Warning:")
9559 Here's a neat feature: If you know that the recipient reads her mail
9560 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
9561 @code{delete}, you can send her as many insults as you like, just by
9562 using a @code{Message-ID} of a mail that you know that she's already
9563 received. Think of all the fun! She'll never see any of it! Whee!
9566 @node Not Reading Mail
9567 @subsection Not Reading Mail
9569 If you start using any of the mail backends, they have the annoying
9570 habit of assuming that you want to read mail with them. This might not
9571 be unreasonable, but it might not be what you want.
9573 If you set @code{nnmail-spool-file} to @code{nil}, none of the backends
9574 will ever attempt to read incoming mail, which should help.
9576 @vindex nnbabyl-get-new-mail
9577 @vindex nnmbox-get-new-mail
9578 @vindex nnml-get-new-mail
9579 @vindex nnmh-get-new-mail
9580 @vindex nnfolder-get-new-mail
9581 This might be too much, if, for instance, you are reading mail quite
9582 happily with @code{nnml} and just want to peek at some old @sc{rmail}
9583 file you have stashed away with @code{nnbabyl}. All backends have
9584 variables called backend-@code{get-new-mail}. If you want to disable
9585 the @code{nnbabyl} mail reading, you edit the virtual server for the
9586 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
9588 All the mail backends will call @code{nn}*@code{-prepare-save-mail-hook}
9589 narrowed to the article to be saved before saving it when reading
9593 @node Choosing a Mail Backend
9594 @subsection Choosing a Mail Backend
9596 Gnus will read the mail spool when you activate a mail group. The mail
9597 file is first copied to your home directory. What happens after that
9598 depends on what format you want to store your mail in.
9601 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
9602 * Rmail Babyl:: Emacs programs use the rmail babyl format.
9603 * Mail Spool:: Store your mail in a private spool?
9604 * MH Spool:: An mhspool-like backend.
9605 * Mail Folders:: Having one file for each group.
9610 @subsubsection Unix Mail Box
9612 @cindex unix mail box
9614 @vindex nnmbox-active-file
9615 @vindex nnmbox-mbox-file
9616 The @dfn{nnmbox} backend will use the standard Un*x mbox file to store
9617 mail. @code{nnmbox} will add extra headers to each mail article to say
9618 which group it belongs in.
9620 Virtual server settings:
9623 @item nnmbox-mbox-file
9624 @vindex nnmbox-mbox-file
9625 The name of the mail box in the user's home directory.
9627 @item nnmbox-active-file
9628 @vindex nnmbox-active-file
9629 The name of the active file for the mail box.
9631 @item nnmbox-get-new-mail
9632 @vindex nnmbox-get-new-mail
9633 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
9639 @subsubsection Rmail Babyl
9643 @vindex nnbabyl-active-file
9644 @vindex nnbabyl-mbox-file
9645 The @dfn{nnbabyl} backend will use a babyl mail box (aka. @dfn{rmail
9646 mbox}) to store mail. @code{nnbabyl} will add extra headers to each mail
9647 article to say which group it belongs in.
9649 Virtual server settings:
9652 @item nnbabyl-mbox-file
9653 @vindex nnbabyl-mbox-file
9654 The name of the rmail mbox file.
9656 @item nnbabyl-active-file
9657 @vindex nnbabyl-active-file
9658 The name of the active file for the rmail box.
9660 @item nnbabyl-get-new-mail
9661 @vindex nnbabyl-get-new-mail
9662 If non-@code{nil}, @code{nnbabyl} will read incoming mail.
9667 @subsubsection Mail Spool
9669 @cindex mail @sc{nov} spool
9671 The @dfn{nnml} spool mail format isn't compatible with any other known
9672 format. It should be used with some caution.
9674 @vindex nnml-directory
9675 If you use this backend, Gnus will split all incoming mail into files,
9676 one file for each mail, and put the articles into the corresponding
9677 directories under the directory specified by the @code{nnml-directory}
9678 variable. The default value is @file{~/Mail/}.
9680 You do not have to create any directories beforehand; Gnus will take
9683 If you have a strict limit as to how many files you are allowed to store
9684 in your account, you should not use this backend. As each mail gets its
9685 own file, you might very well occupy thousands of inodes within a few
9686 weeks. If this is no problem for you, and it isn't a problem for you
9687 having your friendly systems administrator walking around, madly,
9688 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
9689 know that this is probably the fastest format to use. You do not have
9690 to trudge through a big mbox file just to read your new mail.
9692 @code{nnml} is probably the slowest backend when it comes to article
9693 splitting. It has to create lots of files, and it also generates
9694 @sc{nov} databases for the incoming mails. This makes it the fastest
9695 backend when it comes to reading mail.
9697 Virtual server settings:
9700 @item nnml-directory
9701 @vindex nnml-directory
9702 All @code{nnml} directories will be placed under this directory.
9704 @item nnml-active-file
9705 @vindex nnml-active-file
9706 The active file for the @code{nnml} server.
9708 @item nnml-newsgroups-file
9709 @vindex nnml-newsgroups-file
9710 The @code{nnml} group descriptions file. @xref{Newsgroups File
9713 @item nnml-get-new-mail
9714 @vindex nnml-get-new-mail
9715 If non-@code{nil}, @code{nnml} will read incoming mail.
9717 @item nnml-nov-is-evil
9718 @vindex nnml-nov-is-evil
9719 If non-@code{nil}, this backend will ignore any @sc{nov} files.
9721 @item nnml-nov-file-name
9722 @vindex nnml-nov-file-name
9723 The name of the @sc{nov} files. The default is @file{.overview}.
9725 @item nnml-prepare-save-mail-hook
9726 @vindex nnml-prepare-save-mail-hook
9727 Hook run narrowed to an article before saving.
9731 @findex nnml-generate-nov-databases
9732 If your @code{nnml} groups and @sc{nov} files get totally out of whack,
9733 you can do a complete update by typing @kbd{M-x
9734 nnml-generate-nov-databases}. This command will trawl through the
9735 entire @code{nnml} hierarchy, looking at each and every article, so it
9736 might take a while to complete. A better interface to this
9737 functionality can be found in the server buffer (@pxref{Server
9742 @subsubsection MH Spool
9744 @cindex mh-e mail spool
9746 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
9747 @sc{nov} databases and it doesn't keep an active file. This makes
9748 @code{nnmh} a @emph{much} slower backend than @code{nnml}, but it also
9749 makes it easier to write procmail scripts for.
9751 Virtual server settings:
9754 @item nnmh-directory
9755 @vindex nnmh-directory
9756 All @code{nnmh} directories will be located under this directory.
9758 @item nnmh-get-new-mail
9759 @vindex nnmh-get-new-mail
9760 If non-@code{nil}, @code{nnmh} will read incoming mail.
9763 @vindex nnmh-be-safe
9764 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
9765 sure that the articles in the folder are actually what Gnus thinks they
9766 are. It will check date stamps and stat everything in sight, so
9767 setting this to @code{t} will mean a serious slow-down. If you never
9768 use anything but Gnus to read the @code{nnmh} articles, you do not have
9769 to set this variable to @code{t}.
9774 @subsubsection Mail Folders
9776 @cindex mbox folders
9777 @cindex mail folders
9779 @code{nnfolder} is a backend for storing each mail group in a separate
9780 file. Each file is in the standard Un*x mbox format. @code{nnfolder}
9781 will add extra headers to keep track of article numbers and arrival
9784 Virtual server settings:
9787 @item nnfolder-directory
9788 @vindex nnfolder-directory
9789 All the @code{nnfolder} mail boxes will be stored under this directory.
9791 @item nnfolder-active-file
9792 @vindex nnfolder-active-file
9793 The name of the active file.
9795 @item nnfolder-newsgroups-file
9796 @vindex nnfolder-newsgroups-file
9797 The name of the group descriptions file. @xref{Newsgroups File Format}.
9799 @item nnfolder-get-new-mail
9800 @vindex nnfolder-get-new-mail
9801 If non-@code{nil}, @code{nnfolder} will read incoming mail.
9804 @findex nnfolder-generate-active-file
9805 @kindex M-x nnfolder-generate-active-file
9806 If you have lots of @code{nnfolder}-like files you'd like to read with
9807 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
9808 command to make @code{nnfolder} aware of all likely files in
9809 @code{nnfolder-directory}.
9813 @section Other Sources
9815 Gnus can do more than just read news or mail. The methods described
9816 below allow Gnus to view directories and files as if they were
9820 * Directory Groups:: You can read a directory as if it was a newsgroup.
9821 * Anything Groups:: Dired? Who needs dired?
9822 * Document Groups:: Single files can be the basis of a group.
9823 * SOUP:: Reading @sc{SOUP} packets ``offline''.
9824 * Web Searches:: Creating groups from articles that match a string.
9825 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
9829 @node Directory Groups
9830 @subsection Directory Groups
9832 @cindex directory groups
9834 If you have a directory that has lots of articles in separate files in
9835 it, you might treat it as a newsgroup. The files have to have numerical
9838 This might be an opportune moment to mention @code{ange-ftp}, that most
9839 wonderful of all wonderful Emacs packages. When I wrote @code{nndir}, I
9840 didn't think much about it---a backend to read directories. Big deal.
9842 @code{ange-ftp} changes that picture dramatically. For instance, if you
9843 enter the @code{ange-ftp} file name
9844 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
9845 @code{ange-ftp} or @code{efs} will actually allow you to read this directory over at
9846 @samp{sina} as a newsgroup. Distributed news ahoy!
9848 @code{nndir} will use @sc{nov} files if they are present.
9850 @code{nndir} is a ``read-only'' backend---you can't delete or expire
9851 articles with this method. You can use @code{nnmh} or @code{nnml} for
9852 whatever you use @code{nndir} for, so you could switch to any of those
9853 methods if you feel the need to have a non-read-only @code{nndir}.
9856 @node Anything Groups
9857 @subsection Anything Groups
9860 From the @code{nndir} backend (which reads a single spool-like
9861 directory), it's just a hop and a skip to @code{nneething}, which
9862 pretends that any arbitrary directory is a newsgroup. Strange, but
9865 When @code{nneething} is presented with a directory, it will scan this
9866 directory and assign article numbers to each file. When you enter such
9867 a group, @code{nneething} must create ``headers'' that Gnus can use.
9868 After all, Gnus is a newsreader, in case you're
9869 forgetting. @code{nneething} does this in a two-step process. First, it
9870 snoops each file in question. If the file looks like an article (i.e.,
9871 the first few lines look like headers), it will use this as the head.
9872 If this is just some arbitrary file without a head (e.g. a C source
9873 file), @code{nneething} will cobble up a header out of thin air. It
9874 will use file ownership, name and date and do whatever it can with these
9877 All this should happen automatically for you, and you will be presented
9878 with something that looks very much like a newsgroup. Totally like a
9879 newsgroup, to be precise. If you select an article, it will be displayed
9880 in the article buffer, just as usual.
9882 If you select a line that represents a directory, Gnus will pop you into
9883 a new summary buffer for this @code{nneething} group. And so on. You can
9884 traverse the entire disk this way, if you feel like, but remember that
9885 Gnus is not dired, really, and does not intend to be, either.
9887 There are two overall modes to this action---ephemeral or solid. When
9888 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
9889 will not store information on what files you have read, and what files
9890 are new, and so on. If you create a solid @code{nneething} group the
9891 normal way with @kbd{G m}, Gnus will store a mapping table between
9892 article numbers and file names, and you can treat this group like any
9893 other groups. When you activate a solid @code{nneething} group, you will
9894 be told how many unread articles it contains, etc., etc.
9899 @item nneething-map-file-directory
9900 @vindex nneething-map-file-directory
9901 All the mapping files for solid @code{nneething} groups will be stored
9902 in this directory, which defaults to @file{~/.nneething/}.
9904 @item nneething-exclude-files
9905 @vindex nneething-exclude-files
9906 All files that match this regexp will be ignored. Nice to use to exclude
9907 auto-save files and the like, which is what it does by default.
9909 @item nneething-map-file
9910 @vindex nneething-map-file
9911 Name of the map files.
9915 @node Document Groups
9916 @subsection Document Groups
9918 @cindex documentation group
9921 @code{nndoc} is a cute little thing that will let you read a single file
9922 as a newsgroup. Several files types are supported:
9929 The babyl (rmail) mail box.
9934 The standard Unix mbox file.
9936 @cindex MMDF mail box
9938 The MMDF mail box format.
9941 Several news articles appended into a file.
9944 @cindex rnews batch files
9945 The rnews batch transport format.
9946 @cindex forwarded messages
9955 @cindex RFC 1153 digest
9956 @cindex RFC 341 digest
9957 MIME (RFC 1341) digest format.
9959 @item standard-digest
9960 The standard (RFC 1153) digest format.
9963 Non-standard digest format---matches most things, but does it badly.
9966 You can also use the special ``file type'' @code{guess}, which means
9967 that @code{nndoc} will try to guess what file type it is looking at.
9968 @code{digest} means that @code{nndoc} should guess what digest type the
9971 @code{nndoc} will not try to change the file or insert any extra headers into
9972 it---it will simply, like, let you use the file as the basis for a
9973 group. And that's it.
9975 If you have some old archived articles that you want to insert into your
9976 new & spiffy Gnus mail backend, @code{nndoc} can probably help you with
9977 that. Say you have an old @file{RMAIL} file with mail that you now want
9978 to split into your new @code{nnml} groups. You look at that file using
9979 @code{nndoc} (using the @kbd{G f} command in the group buffer
9980 (@pxref{Foreign Groups})), set the process mark on all the articles in
9981 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
9982 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
9983 file is now also stored in lots of @code{nnml} directories, and you can
9984 delete that pesky @file{RMAIL} file. If you have the guts!
9986 Virtual server variables:
9989 @item nndoc-article-type
9990 @vindex nndoc-article-type
9991 This should be one of @code{mbox}, @code{babyl}, @code{digest},
9992 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
9993 @code{rfc822-forward}, @code{mime-digest}, @code{standard-digest},
9994 @code{slack-digest}, @code{clari-briefs} or @code{guess}.
9996 @item nndoc-post-type
9997 @vindex nndoc-post-type
9998 This variable says whether Gnus is to consider the group a news group or
9999 a mail group. There are two legal values: @code{mail} (the default)
10004 * Document Server Internals:: How to add your own document types.
10008 @node Document Server Internals
10009 @subsubsection Document Server Internals
10011 Adding new document types to be recognized by @code{nndoc} isn't
10012 difficult. You just have to whip up a definition of what the document
10013 looks like, write a predicate function to recognize that document type,
10014 and then hook into @code{nndoc}.
10016 First, here's an example document type definition:
10020 (article-begin . "^\^A\^A\^A\^A\n")
10021 (body-end . "^\^A\^A\^A\^A\n"))
10024 The definition is simply a unique @dfn{name} followed by a series of
10025 regexp pseudo-variable settings. Below are the possible
10026 variables---don't be daunted by the number of variables; most document
10027 types can be defined with very few settings:
10030 @item first-article
10031 If present, @code{nndoc} will skip past all text until it finds
10032 something that match this regexp. All text before this will be
10035 @item article-begin
10036 This setting has to be present in all document type definitions. It
10037 says what the beginning of each article looks like.
10039 @item head-begin-function
10040 If present, this should be a function that moves point to the head of
10043 @item nndoc-head-begin
10044 If present, this should be a regexp that matches the head of the
10047 @item nndoc-head-end
10048 This should match the end of the head of the article. It defaults to
10049 @samp{^$}---the empty line.
10051 @item body-begin-function
10052 If present, this function should move point to the beginning of the body
10056 This should match the beginning of the body of the article. It defaults
10059 @item body-end-function
10060 If present, this function should move point to the end of the body of
10064 If present, this should match the end of the body of the article.
10067 If present, this should match the end of the file. All text after this
10068 regexp will be totally ignored.
10072 So, using these variables @code{nndoc} is able to dissect a document
10073 file into a series of articles, each with a head and a body. However, a
10074 few more variables are needed since not all document types are all that
10075 news-like---variables needed to transform the head or the body into
10076 something that's palatable for Gnus:
10079 @item prepare-body-function
10080 If present, this function will be called when requesting an article. It
10081 will be called with point at the start of the body, and is useful if the
10082 document has encoded some parts of its contents.
10084 @item article-transform-function
10085 If present, this function is called when requesting an article. It's
10086 meant to be used for more wide-ranging transformation of both head and
10087 body of the article.
10089 @item generate-head-function
10090 If present, this function is called to generate a head that Gnus can
10091 understand. It is called with the article number as a parameter, and is
10092 expected to generate a nice head for the article in question. It is
10093 called when requesting the headers of all articles.
10097 Let's look at the most complicated example I can come up with---standard
10102 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
10103 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
10104 (prepare-body-function . nndoc-unquote-dashes)
10105 (body-end-function . nndoc-digest-body-end)
10106 (head-end . "^ ?$")
10107 (body-begin . "^ ?\n")
10108 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
10109 (subtype digest guess))
10112 We see that all text before a 70-width line of dashes is ignored; all
10113 text after a line that starts with that @samp{^End of} is also ignored;
10114 each article begins with a 30-width line of dashes; the line separating
10115 the head from the body may contain a single space; and that the body is
10116 run through @code{nndoc-unquote-dashes} before being delivered.
10118 To hook your own document definition into @code{nndoc}, use the
10119 @code{nndoc-add-type} function. It takes two parameters---the first is
10120 the definition itself and the second (optional) parameter says where in
10121 the document type definition alist to put this definition. The alist is
10122 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
10123 is of @code{mmdf} type, and so on. These type predicates should return
10124 @code{nil} if the document is not of the correct type; @code{t} if it is
10125 of the correct type; and a number if the document might be of the
10126 correct type. A high number means high probability; a low number means
10127 low probability with @samp{0} being the lowest legal number.
10135 In the PC world people often talk about ``offline'' newsreaders. These
10136 are thingies that are combined reader/news transport monstrosities.
10137 With built-in modem programs. Yecchh!
10139 Of course, us Unix Weenie types of human beans use things like
10140 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
10141 transport things like Ghod intended. And then we just use normal
10144 However, it can sometimes be convenient to do something a that's a bit
10145 easier on the brain if you have a very slow modem, and you're not really
10146 that interested in doing things properly.
10148 A file format called @sc{soup} has been developed for transporting news
10149 and mail from servers to home machines and back again. It can be a bit
10152 First some terminology:
10157 This is the machine that is connected to the outside world and where you
10158 get news and/or mail from.
10161 This is the machine that you want to do the actual reading and responding
10162 on. It is typically not connected to the rest of the world in any way.
10165 Something that contains messages and/or commands. There are two kinds
10169 @item message packets
10170 These are packets made at the server, and typically contain lots of
10171 messages for you to read. These are called @file{SoupoutX.tgz} by
10172 default, where @var{X} is a number.
10174 @item response packets
10175 These are packets made at the home machine, and typically contains
10176 replies that you've written. These are called @file{SoupinX.tgz} by
10177 default, where @var{X} is a number.
10187 You log in on the server and create a @sc{soup} packet. You can either
10188 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
10189 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
10190 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
10193 You transfer the packet home. Rail, boat, car or modem will do fine.
10196 You put the packet in your home directory.
10199 You fire up Gnus on your home machine using the @code{nnsoup} backend as
10200 the native or secondary server.
10203 You read articles and mail and answer and followup to the things you
10204 want (@pxref{SOUP Replies}).
10207 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
10211 You transfer this packet to the server.
10214 You use Gnus to mail this packet out with the @kbd{G s s} command.
10217 You then repeat until you die.
10221 So you basically have a bipartite system---you use @code{nnsoup} for
10222 reading and Gnus for packing/sending these @sc{soup} packets.
10225 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
10226 * SOUP Groups:: A backend for reading @sc{soup} packets.
10227 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
10231 @node SOUP Commands
10232 @subsubsection SOUP Commands
10234 These are commands for creating and manipulating @sc{soup} packets.
10238 @kindex G s b (Group)
10239 @findex gnus-group-brew-soup
10240 Pack all unread articles in the current group
10241 (@code{gnus-group-brew-soup}). This command understands the
10242 process/prefix convention.
10245 @kindex G s w (Group)
10246 @findex gnus-soup-save-areas
10247 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
10250 @kindex G s s (Group)
10251 @findex gnus-soup-send-replies
10252 Send all replies from the replies packet
10253 (@code{gnus-soup-send-replies}).
10256 @kindex G s p (Group)
10257 @findex gnus-soup-pack-packet
10258 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
10261 @kindex G s r (Group)
10262 @findex nnsoup-pack-replies
10263 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
10266 @kindex O s (Summary)
10267 @findex gnus-soup-add-article
10268 This summary-mode command adds the current article to a @sc{soup} packet
10269 (@code{gnus-soup-add-article}). It understands the process/prefix
10270 convention (@pxref{Process/Prefix}).
10275 There are a few variables to customize where Gnus will put all these
10280 @item gnus-soup-directory
10281 @vindex gnus-soup-directory
10282 Directory where Gnus will save intermediate files while composing
10283 @sc{soup} packets. The default is @file{~/SoupBrew/}.
10285 @item gnus-soup-replies-directory
10286 @vindex gnus-soup-replies-directory
10287 This is what Gnus will use as a temporary directory while sending our
10288 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
10290 @item gnus-soup-prefix-file
10291 @vindex gnus-soup-prefix-file
10292 Name of the file where Gnus stores the last used prefix. The default is
10293 @samp{gnus-prefix}.
10295 @item gnus-soup-packer
10296 @vindex gnus-soup-packer
10297 A format string command for packing a @sc{soup} packet. The default is
10298 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
10300 @item gnus-soup-unpacker
10301 @vindex gnus-soup-unpacker
10302 Format string command for unpacking a @sc{soup} packet. The default is
10303 @samp{gunzip -c %s | tar xvf -}.
10305 @item gnus-soup-packet-directory
10306 @vindex gnus-soup-packet-directory
10307 Where Gnus will look for reply packets. The default is @file{~/}.
10309 @item gnus-soup-packet-regexp
10310 @vindex gnus-soup-packet-regexp
10311 Regular expression matching @sc{soup} reply packets in
10312 @code{gnus-soup-packet-directory}.
10318 @subsubsection @sc{soup} Groups
10321 @code{nnsoup} is the backend for reading @sc{soup} packets. It will
10322 read incoming packets, unpack them, and put them in a directory where
10323 you can read them at leisure.
10325 These are the variables you can use to customize its behavior:
10329 @item nnsoup-tmp-directory
10330 @vindex nnsoup-tmp-directory
10331 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
10332 directory. (@file{/tmp/} by default.)
10334 @item nnsoup-directory
10335 @vindex nnsoup-directory
10336 @code{nnsoup} then moves each message and index file to this directory.
10337 The default is @file{~/SOUP/}.
10339 @item nnsoup-replies-directory
10340 @vindex nnsoup-replies-directory
10341 All replies will be stored in this directory before being packed into a
10342 reply packet. The default is @file{~/SOUP/replies/"}.
10344 @item nnsoup-replies-format-type
10345 @vindex nnsoup-replies-format-type
10346 The @sc{soup} format of the replies packets. The default is @samp{?n}
10347 (rnews), and I don't think you should touch that variable. I probably
10348 shouldn't even have documented it. Drats! Too late!
10350 @item nnsoup-replies-index-type
10351 @vindex nnsoup-replies-index-type
10352 The index type of the replies packet. The default is @samp{?n}, which
10353 means ``none''. Don't fiddle with this one either!
10355 @item nnsoup-active-file
10356 @vindex nnsoup-active-file
10357 Where @code{nnsoup} stores lots of information. This is not an ``active
10358 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
10359 this file or mess it up in any way, you're dead. The default is
10360 @file{~/SOUP/active}.
10362 @item nnsoup-packer
10363 @vindex nnsoup-packer
10364 Format string command for packing a reply @sc{soup} packet. The default
10365 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
10367 @item nnsoup-unpacker
10368 @vindex nnsoup-unpacker
10369 Format string command for unpacking incoming @sc{soup} packets. The
10370 default is @samp{gunzip -c %s | tar xvf -}.
10372 @item nnsoup-packet-directory
10373 @vindex nnsoup-packet-directory
10374 Where @code{nnsoup} will look for incoming packets. The default is
10377 @item nnsoup-packet-regexp
10378 @vindex nnsoup-packet-regexp
10379 Regular expression matching incoming @sc{soup} packets. The default is
10386 @subsubsection SOUP Replies
10388 Just using @code{nnsoup} won't mean that your postings and mailings end
10389 up in @sc{soup} reply packets automagically. You have to work a bit
10390 more for that to happen.
10392 @findex nnsoup-set-variables
10393 The @code{nnsoup-set-variables} command will set the appropriate
10394 variables to ensure that all your followups and replies end up in the
10397 In specific, this is what it does:
10400 (setq message-send-news-function 'nnsoup-request-post)
10401 (setq message-send-mail-function 'nnsoup-request-mail)
10404 And that's it, really. If you only want news to go into the @sc{soup}
10405 system you just use the first line. If you only want mail to be
10406 @sc{soup}ed you use the second.
10410 @subsection Web Searches
10414 @cindex InReference
10415 @cindex Usenet searches
10416 @cindex searching the Usenet
10418 It's, like, too neat to search the Usenet for articles that match a
10419 string, but it, like, totally @emph{sucks}, like, totally, to use one of
10420 those, like, Web browsers, and you, like, have to, rilly, like, look at
10421 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
10422 searches without having to use a browser.
10424 The @code{nnweb} backend allows an easy interface to the mighty search
10425 engine. You create an @code{nnweb} group, enter a search pattern, and
10426 then enter the group and read the articles like you would any normal
10427 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
10428 Groups}) will do this in an easy-to-use fashion.
10430 @code{nnweb} groups don't really lend themselves to being solid
10431 groups---they have a very fleeting idea of article numbers. In fact,
10432 each time you enter an @code{nnweb} group (not even changing the search
10433 pattern), you are likely to get the articles ordered in a different
10434 manner. Not even using duplicate suppression (@pxref{Duplicate
10435 Suppression}) will help, since @code{nnweb} doesn't even know the
10436 @code{Message-ID} of the articles before reading them using some search
10437 engines (DejaNews, for instance). The only possible way to keep track
10438 of which articles you've read is by scoring on the @code{Date}
10439 header---mark all articles posted before the last date you read the
10442 If the search engine changes its output substantially, @code{nnweb}
10443 won't be able to parse it and will fail. One could hardly fault the Web
10444 providers if they were to do this---their @emph{raison d'être} is to
10445 make money off of advertisements, not to provide services to the
10446 community. Since @code{nnweb} washes the ads off all the articles, one
10447 might think that the providers might be somewhat miffed. We'll see.
10449 You must have the @code{url} and @code{w3} package installed to be able
10450 to use @code{nnweb}.
10452 Virtual server variables:
10457 What search engine type is being used. The currently supported types
10458 are @code{dejanews}, @code{altavista} and @code{reference}.
10461 @vindex nnweb-search
10462 The search string to feed to the search engine.
10464 @item nnweb-max-hits
10465 @vindex nnweb-max-hits
10466 Advisory maximum number of hits per search to display. The default is
10469 @item nnweb-type-definition
10470 @vindex nnweb-type-definition
10471 Type-to-definition alist. This alist says what @code{nnweb} should do
10472 with the various search engine types. The following elements must be
10477 Function to decode the article and provide something that Gnus
10481 Function to create an article number to message header and URL alist.
10484 Function to send the search string to the search engine.
10487 The address the aforementioned function should send the search string
10491 Format string URL to fetch an article by @code{Message-ID}.
10498 @node Mail-To-News Gateways
10499 @subsection Mail-To-News Gateways
10500 @cindex mail-to-news gateways
10503 If your local @code{nntp} server doesn't allow posting, for some reason
10504 or other, you can post using one of the numerous mail-to-news gateways.
10505 The @code{nngateway} backend provides the interface.
10507 Note that you can't read anything from this backend---it can only be
10513 @item nngateway-address
10514 @vindex nngateway-address
10515 This is the address of the mail-to-news gateway.
10517 @item nngateway-header-transformation
10518 @vindex nngateway-header-transformation
10519 News headers often have to be transformed in some odd way or other
10520 for the mail-to-news gateway to accept it. This variable says what
10521 transformation should be called, and defaults to
10522 @code{nngateway-simple-header-transformation}. The function is called
10523 narrowed to the headers to be transformed and with one parameter---the
10526 This default function just inserts a new @code{To} header based on the
10527 @code{Newsgroups} header and the gateway address.
10528 For instance, an article with this @code{Newsgroups} header:
10531 Newsgroups: alt.religion.emacs
10534 will get this @code{From} header inserted:
10537 To: alt-religion-emacs@@GATEWAY
10542 So, to use this, simply say something like:
10545 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
10549 @node Combined Groups
10550 @section Combined Groups
10552 Gnus allows combining a mixture of all the other group types into bigger
10556 * Virtual Groups:: Combining articles from many groups.
10557 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
10561 @node Virtual Groups
10562 @subsection Virtual Groups
10564 @cindex virtual groups
10566 An @dfn{nnvirtual group} is really nothing more than a collection of
10569 For instance, if you are tired of reading many small groups, you can
10570 put them all in one big group, and then grow tired of reading one
10571 big, unwieldy group. The joys of computing!
10573 You specify @code{nnvirtual} as the method. The address should be a
10574 regexp to match component groups.
10576 All marks in the virtual group will stick to the articles in the
10577 component groups. So if you tick an article in a virtual group, the
10578 article will also be ticked in the component group from whence it came.
10579 (And vice versa---marks from the component groups will also be shown in
10580 the virtual group.)
10582 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
10583 newsgroups into one, big, happy newsgroup:
10586 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
10589 The component groups can be native or foreign; everything should work
10590 smoothly, but if your computer explodes, it was probably my fault.
10592 Collecting the same group from several servers might actually be a good
10593 idea if users have set the Distribution header to limit distribution.
10594 If you would like to read @samp{soc.motss} both from a server in Japan
10595 and a server in Norway, you could use the following as the group regexp:
10598 "^nntp+some.server.jp:soc.motss$\\|^nntp+some.server.no:soc.motss$"
10601 This should work kinda smoothly---all articles from both groups should
10602 end up in this one, and there should be no duplicates. Threading (and
10603 the rest) will still work as usual, but there might be problems with the
10604 sequence of articles. Sorting on date might be an option here
10605 (@pxref{Selecting a Group}).
10607 One limitation, however---all groups that are included in a virtual
10608 group have to be alive (i.e., subscribed or unsubscribed). Killed or
10609 zombie groups can't be component groups for @code{nnvirtual} groups.
10611 @vindex nnvirtual-always-rescan
10612 If the @code{nnvirtual-always-rescan} is non-@code{nil},
10613 @code{nnvirtual} will always scan groups for unread articles when
10614 entering a virtual group. If this variable is @code{nil} (which is the
10615 default) and you read articles in a component group after the virtual
10616 group has been activated, the read articles from the component group
10617 will show up when you enter the virtual group. You'll also see this
10618 effect if you have two virtual groups that have a component group in
10619 common. If that's the case, you should set this variable to @code{t}.
10620 Or you can just tap @code{M-g} on the virtual group every time before
10621 you enter it---it'll have much the same effect.
10624 @node Kibozed Groups
10625 @subsection Kibozed Groups
10629 @dfn{Kibozing} is defined by @sc{oed} as ``grepping through (parts of)
10630 the news feed''. @code{nnkiboze} is a backend that will do this for
10631 you. Oh joy! Now you can grind any @sc{nntp} server down to a halt
10632 with useless requests! Oh happiness!
10634 @kindex G k (Group)
10635 To create a kibozed group, use the @kbd{G k} command in the group
10638 The address field of the @code{nnkiboze} method is, as with
10639 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
10640 @code{nnkiboze} group. That's where most similarities between @code{nnkiboze}
10641 and @code{nnvirtual} end.
10643 In addition to this regexp detailing component groups, an @code{nnkiboze} group
10644 must have a score file to say what articles are to be included in
10645 the group (@pxref{Scoring}).
10647 @kindex M-x nnkiboze-generate-groups
10648 @findex nnkiboze-generate-groups
10649 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
10650 @code{nnkiboze} groups you want to have. This command will take time. Lots of
10651 time. Oodles and oodles of time. Gnus has to fetch the headers from
10652 all the articles in all the component groups and run them through the
10653 scoring process to determine if there are any articles in the groups
10654 that are to be part of the @code{nnkiboze} groups.
10656 Please limit the number of component groups by using restrictive
10657 regexps. Otherwise your sysadmin may become annoyed with you, and the
10658 @sc{nntp} site may throw you off and never let you back in again.
10659 Stranger things have happened.
10661 @code{nnkiboze} component groups do not have to be alive---they can be dead,
10662 and they can be foreign. No restrictions.
10664 @vindex nnkiboze-directory
10665 The generation of an @code{nnkiboze} group means writing two files in
10666 @code{nnkiboze-directory}, which is @file{~/News/} by default. One
10667 contains the @sc{nov} header lines for all the articles in the group,
10668 and the other is an additional @file{.newsrc} file to store information
10669 on what groups have been searched through to find component articles.
10671 Articles that are marked as read in the @code{nnkiboze} group will have
10672 their @sc{nov} lines removed from the @sc{nov} file.
10679 Other people use @dfn{kill files}, but we here at Gnus Towers like
10680 scoring better than killing, so we'd rather switch than fight. They do
10681 something completely different as well, so sit up straight and pay
10684 @vindex gnus-summary-mark-below
10685 All articles have a default score (@code{gnus-summary-default-score}),
10686 which is 0 by default. This score may be raised or lowered either
10687 interactively or by score files. Articles that have a score lower than
10688 @code{gnus-summary-mark-below} are marked as read.
10690 Gnus will read any @dfn{score files} that apply to the current group
10691 before generating the summary buffer.
10693 There are several commands in the summary buffer that insert score
10694 entries based on the current article. You can, for instance, ask Gnus to
10695 lower or increase the score of all articles with a certain subject.
10697 There are two sorts of scoring entries: Permanent and temporary.
10698 Temporary score entries are self-expiring entries. Any entries that are
10699 temporary and have not been used for, say, a week, will be removed
10700 silently to help keep the sizes of the score files down.
10703 * Summary Score Commands:: Adding score entries for the current group.
10704 * Group Score Commands:: General score commands.
10705 * Score Variables:: Customize your scoring. (My, what terminology).
10706 * Score File Format:: What a score file may contain.
10707 * Score File Editing:: You can edit score files by hand as well.
10708 * Adaptive Scoring:: Big Sister Gnus knows what you read.
10709 * Home Score File:: How to say where new score entries are to go.
10710 * Followups To Yourself:: Having Gnus notice when people answer you.
10711 * Scoring Tips:: How to score effectively.
10712 * Reverse Scoring:: That problem child of old is not problem.
10713 * Global Score Files:: Earth-spanning, ear-splitting score files.
10714 * Kill Files:: They are still here, but they can be ignored.
10715 * Converting Kill Files:: Translating kill files to score files.
10716 * GroupLens:: Getting predictions on what you like to read.
10717 * Advanced Scoring:: Using logical expressions to build score rules.
10718 * Score Decays:: It can be useful to let scores wither away.
10722 @node Summary Score Commands
10723 @section Summary Score Commands
10724 @cindex score commands
10726 The score commands that alter score entries do not actually modify real
10727 score files. That would be too inefficient. Gnus maintains a cache of
10728 previously loaded score files, one of which is considered the
10729 @dfn{current score file alist}. The score commands simply insert
10730 entries into this list, and upon group exit, this list is saved.
10732 The current score file is by default the group's local score file, even
10733 if no such score file actually exists. To insert score commands into
10734 some other score file (e.g. @file{all.SCORE}), you must first make this
10735 score file the current one.
10737 General score commands that don't actually change the score file:
10742 @kindex V s (Summary)
10743 @findex gnus-summary-set-score
10744 Set the score of the current article (@code{gnus-summary-set-score}).
10747 @kindex V S (Summary)
10748 @findex gnus-summary-current-score
10749 Display the score of the current article
10750 (@code{gnus-summary-current-score}).
10753 @kindex V t (Summary)
10754 @findex gnus-score-find-trace
10755 Display all score rules that have been used on the current article
10756 (@code{gnus-score-find-trace}).
10759 @kindex V R (Summary)
10760 @findex gnus-summary-rescore
10761 Run the current summary through the scoring process
10762 (@code{gnus-summary-rescore}). This might be useful if you're playing
10763 around with your score files behind Gnus' back and want to see the
10764 effect you're having.
10767 @kindex V a (Summary)
10768 @findex gnus-summary-score-entry
10769 Add a new score entry, and allow specifying all elements
10770 (@code{gnus-summary-score-entry}).
10773 @kindex V c (Summary)
10774 @findex gnus-score-change-score-file
10775 Make a different score file the current
10776 (@code{gnus-score-change-score-file}).
10779 @kindex V e (Summary)
10780 @findex gnus-score-edit-current-scores
10781 Edit the current score file (@code{gnus-score-edit-current-scores}).
10782 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
10786 @kindex V f (Summary)
10787 @findex gnus-score-edit-file
10788 Edit a score file and make this score file the current one
10789 (@code{gnus-score-edit-file}).
10792 @kindex V F (Summary)
10793 @findex gnus-score-flush-cache
10794 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
10795 after editing score files.
10798 @kindex V C (Summary)
10799 @findex gnus-score-customize
10800 Customize a score file in a visually pleasing manner
10801 (@code{gnus-score-customize}).
10804 @kindex I C-i (Summary)
10805 @findex gnus-summary-raise-score
10806 Increase the score of the current article
10807 (@code{gnus-summary-raise-score}).
10810 @kindex L C-l (Summary)
10811 @findex gnus-summary-lower-score
10812 Lower the score of the current article
10813 (@code{gnus-summary-lower-score}).
10816 The rest of these commands modify the local score file.
10821 @kindex V m (Summary)
10822 @findex gnus-score-set-mark-below
10823 Prompt for a score, and mark all articles with a score below this as
10824 read (@code{gnus-score-set-mark-below}).
10827 @kindex V x (Summary)
10828 @findex gnus-score-set-expunge-below
10829 Prompt for a score, and add a score rule to the current score file to
10830 expunge all articles below this score
10831 (@code{gnus-score-set-expunge-below}).
10834 The keystrokes for actually making score entries follow a very regular
10835 pattern, so there's no need to list all the commands. (Hundreds of
10840 The first key is either @kbd{I} (upper case i) for increasing the score
10841 or @kbd{L} for lowering the score.
10843 The second key says what header you want to score on. The following
10844 keys are available:
10848 Score on the author name.
10851 Score on the subject line.
10854 Score on the Xref line---i.e., the cross-posting line.
10857 Score on thread---the References line.
10863 Score on the number of lines.
10866 Score on the Message-ID.
10869 Score on followups.
10879 The third key is the match type. Which match types are legal depends on
10880 what headers you are scoring on.
10892 Substring matching.
10895 Fuzzy matching (@pxref{Fuzzy Matching}).
10924 Greater than number.
10929 The fourth and final key says whether this is a temporary (i.e., expiring)
10930 score entry, or a permanent (i.e., non-expiring) score entry, or whether
10931 it is to be done immediately, without adding to the score file.
10935 Temporary score entry.
10938 Permanent score entry.
10941 Immediately scoring.
10946 So, let's say you want to increase the score on the current author with
10947 exact matching permanently: @kbd{I a e p}. If you want to lower the
10948 score based on the subject line, using substring matching, and make a
10949 temporary score entry: @kbd{L s s t}. Pretty easy.
10951 To make things a bit more complicated, there are shortcuts. If you use
10952 a capital letter on either the second or third keys, Gnus will use
10953 defaults for the remaining one or two keystrokes. The defaults are
10954 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
10955 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
10957 @vindex gnus-score-mimic-keymap
10958 The @code{gnus-score-mimic-keymap} says whether these commands will
10959 pretend they are keymaps or not.
10962 @node Group Score Commands
10963 @section Group Score Commands
10964 @cindex group score commands
10966 There aren't many of these as yet, I'm afraid.
10971 @kindex W f (Group)
10972 @findex gnus-score-flush-cache
10973 Gnus maintains a cache of score alists to avoid having to reload them
10974 all the time. This command will flush the cache
10975 (@code{gnus-score-flush-cache}).
10980 @node Score Variables
10981 @section Score Variables
10982 @cindex score variables
10986 @item gnus-use-scoring
10987 @vindex gnus-use-scoring
10988 If @code{nil}, Gnus will not check for score files, and will not, in
10989 general, do any score-related work. This is @code{t} by default.
10991 @item gnus-kill-killed
10992 @vindex gnus-kill-killed
10993 If this variable is @code{nil}, Gnus will never apply score files to
10994 articles that have already been through the kill process. While this
10995 may save you lots of time, it also means that if you apply a kill file
10996 to a group, and then change the kill file and want to run it over you
10997 group again to kill more articles, it won't work. You have to set this
10998 variable to @code{t} to do that. (It is @code{t} by default.)
11000 @item gnus-kill-files-directory
11001 @vindex gnus-kill-files-directory
11002 All kill and score files will be stored in this directory, which is
11003 initialized from the @code{SAVEDIR} environment variable by default.
11004 This is @file{~/News/} by default.
11006 @item gnus-score-file-suffix
11007 @vindex gnus-score-file-suffix
11008 Suffix to add to the group name to arrive at the score file name
11009 (@samp{SCORE} by default.)
11011 @item gnus-score-uncacheable-files
11012 @vindex gnus-score-uncacheable-files
11013 @cindex score cache
11014 All score files are normally cached to avoid excessive re-loading of
11015 score files. However, if this might make you Emacs grow big and
11016 bloated, so this regexp can be used to weed out score files that are
11017 unlikely to be needed again. It would be a bad idea to deny caching of
11018 @file{all.SCORE}, while it might be a good idea to not cache
11019 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
11020 variable is @samp{ADAPT$} by default, so no adaptive score files will
11023 @item gnus-save-score
11024 @vindex gnus-save-score
11025 If you have really complicated score files, and do lots of batch
11026 scoring, then you might set this variable to @code{t}. This will make
11027 Gnus save the scores into the @file{.newsrc.eld} file.
11029 @item gnus-score-interactive-default-score
11030 @vindex gnus-score-interactive-default-score
11031 Score used by all the interactive raise/lower commands to raise/lower
11032 score with. Default is 1000, which may seem excessive, but this is to
11033 ensure that the adaptive scoring scheme gets enough room to play with.
11034 We don't want the small changes from the adaptive scoring to overwrite
11035 manually entered data.
11037 @item gnus-summary-default-score
11038 @vindex gnus-summary-default-score
11039 Default score of an article, which is 0 by default.
11041 @item gnus-summary-expunge-below
11042 @vindex gnus-summary-expunge-below
11043 Don't display the summary lines of articles that have scores lower than
11044 this variable. This is @code{nil} by default, which means that no
11045 articles will be hidden.
11047 @item gnus-score-over-mark
11048 @vindex gnus-score-over-mark
11049 Mark (in the third column) used for articles with a score over the
11050 default. Default is @samp{+}.
11052 @item gnus-score-below-mark
11053 @vindex gnus-score-below-mark
11054 Mark (in the third column) used for articles with a score below the
11055 default. Default is @samp{-}.
11057 @item gnus-score-find-score-files-function
11058 @vindex gnus-score-find-score-files-function
11059 Function used to find score files for the current group. This function
11060 is called with the name of the group as the argument.
11062 Predefined functions available are:
11065 @item gnus-score-find-single
11066 @findex gnus-score-find-single
11067 Only apply the group's own score file.
11069 @item gnus-score-find-bnews
11070 @findex gnus-score-find-bnews
11071 Apply all score files that match, using bnews syntax. This is the
11072 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
11073 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
11074 @file{gnu.all.SCORE} would all apply. In short, the instances of
11075 @samp{all} in the score file names are translated into @samp{.*}, and
11076 then a regexp match is done.
11078 This means that if you have some score entries that you want to apply to
11079 all groups, then you put those entries in the @file{all.SCORE} file.
11081 The score files are applied in a semi-random order, although Gnus will
11082 try to apply the more general score files before the more specific score
11083 files. It does this by looking at the number of elements in the score
11084 file names---discarding the @samp{all} elements.
11086 @item gnus-score-find-hierarchical
11087 @findex gnus-score-find-hierarchical
11088 Apply all score files from all the parent groups. This means that you
11089 can't have score files like @file{all.SCORE}, but you can have
11090 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE}.
11093 This variable can also be a list of functions. In that case, all these
11094 functions will be called, and all the returned lists of score files will
11095 be applied. These functions can also return lists of score alists
11096 directly. In that case, the functions that return these non-file score
11097 alists should probably be placed before the ``real'' score file
11098 functions, to ensure that the last score file returned is the local
11101 @item gnus-score-expiry-days
11102 @vindex gnus-score-expiry-days
11103 This variable says how many days should pass before an unused score file
11104 entry is expired. If this variable is @code{nil}, no score file entries
11105 are expired. It's 7 by default.
11107 @item gnus-update-score-entry-dates
11108 @vindex gnus-update-score-entry-dates
11109 If this variable is non-@code{nil}, matching score entries will have
11110 their dates updated. (This is how Gnus controls expiry---all
11111 non-matching entries will become too old while matching entries will
11112 stay fresh and young.) However, if you set this variable to @code{nil},
11113 even matching entries will grow old and will have to face that oh-so
11116 @item gnus-score-after-write-file-function
11117 @vindex gnus-score-after-write-file-function
11118 Function called with the name of the score file just written.
11123 @node Score File Format
11124 @section Score File Format
11125 @cindex score file format
11127 A score file is an @code{emacs-lisp} file that normally contains just a
11128 single form. Casual users are not expected to edit these files;
11129 everything can be changed from the summary buffer.
11131 Anyway, if you'd like to dig into it yourself, here's an example:
11135 ("Lars Ingebrigtsen" -10000)
11137 ("larsi\\|lmi" -50000 nil R))
11139 ("Ding is Badd" nil 728373))
11141 ("alt.politics" -1000 728372 s))
11146 (mark-and-expunge -10)
11150 (files "/hom/larsi/News/gnu.SCORE")
11151 (exclude-files "all.SCORE")
11152 (local (gnus-newsgroup-auto-expire t)
11153 (gnus-summary-make-false-root 'empty))
11157 This example demonstrates most score file elements. For a different
11158 approach, see @pxref{Advanced Scoring}.
11160 Even though this looks much like lisp code, nothing here is actually
11161 @code{eval}ed. The lisp reader is used to read this form, though, so it
11162 has to be legal syntactically, if not semantically.
11164 Six keys are supported by this alist:
11169 If the key is a string, it is the name of the header to perform the
11170 match on. Scoring can only be performed on these eight headers:
11171 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
11172 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
11173 these headers, there are three strings to tell Gnus to fetch the entire
11174 article and do the match on larger parts of the article: @code{Body}
11175 will perform the match on the body of the article, @code{Head} will
11176 perform the match on the head of the article, and @code{All} will
11177 perform the match on the entire article. Note that using any of these
11178 last three keys will slow down group entry @emph{considerably}. The
11179 final ``header'' you can score on is @code{Followup}. These score
11180 entries will result in new score entries being added for all follow-ups
11181 to articles that matches these score entries.
11183 Following this key is a arbitrary number of score entries, where each
11184 score entry has one to four elements.
11188 The first element is the @dfn{match element}. On most headers this will
11189 be a string, but on the Lines and Chars headers, this must be an
11193 If the second element is present, it should be a number---the @dfn{score
11194 element}. This number should be an integer in the neginf to posinf
11195 interval. This number is added to the score of the article if the match
11196 is successful. If this element is not present, the
11197 @code{gnus-score-interactive-default-score} number will be used
11198 instead. This is 1000 by default.
11201 If the third element is present, it should be a number---the @dfn{date
11202 element}. This date says when the last time this score entry matched,
11203 which provides a mechanism for expiring the score entries. It this
11204 element is not present, the score entry is permanent. The date is
11205 represented by the number of days since December 31, 1 BCE.
11208 If the fourth element is present, it should be a symbol---the @dfn{type
11209 element}. This element specifies what function should be used to see
11210 whether this score entry matches the article. What match types that can
11211 be used depends on what header you wish to perform the match on.
11214 @item From, Subject, References, Xref, Message-ID
11215 For most header types, there are the @code{r} and @code{R} (regexp), as
11216 well as @code{s} and @code{S} (substring) types, and @code{e} and
11217 @code{E} (exact match), and @code{w} (word match) types. If this
11218 element is not present, Gnus will assume that substring matching should
11219 be used. @code{R}, @code{S}, and @code{E} differ from the others in
11220 that the matches will be done in a case-sensitive manner. All these
11221 one-letter types are really just abbreviations for the @code{regexp},
11222 @code{string}, @code{exact}, and @code{word} types, which you can use
11223 instead, if you feel like.
11226 These two headers use different match types: @code{<}, @code{>},
11227 @code{=}, @code{>=} and @code{<=}. When matching on @code{Lines}, be
11228 careful because some backends (like @code{nndir}) do not generate
11229 @code{Lines} header, so every article ends up being marked as having 0
11230 lines. This can lead to strange results if you happen to lower score of
11231 the articles with few lines.
11234 For the Date header we have three kinda silly match types:
11235 @code{before}, @code{at} and @code{after}. I can't really imagine this
11236 ever being useful, but, like, it would feel kinda silly not to provide
11237 this function. Just in case. You never know. Better safe than sorry.
11238 Once burnt, twice shy. Don't judge a book by its cover. Never not have
11239 sex on a first date. (I have been told that at least one person, and I
11240 quote, ``found this function indispensable'', however.)
11244 A more useful match type is @code{regexp}. With it, you can match the
11245 date string using a regular expression. The date is normalized to
11246 ISO8601 compact format first---@samp{YYYYMMDDTHHMMSS}. If you want to
11247 match all articles that have been posted on April 1st in every year, you
11248 could use @samp{....0401.........} as a match string, for instance.
11249 (Note that the date is kept in its original time zone, so this will
11250 match articles that were posted when it was April 1st where the article
11251 was posted from. Time zones are such wholesome fun for the whole
11254 @item Head, Body, All
11255 These three match keys use the same match types as the @code{From} (etc)
11259 This match key is somewhat special, in that it will match the
11260 @code{From} header, and affect the score of not only the matching
11261 articles, but also all followups to the matching articles. This allows
11262 you e.g. increase the score of followups to your own articles, or
11263 decrease the score of followups to the articles of some known
11264 trouble-maker. Uses the same match types as the @code{From} header
11265 uses. (Using this match key will lead to creation of @file{ADAPT}
11269 This match key works along the same lines as the @code{Followup} match
11270 key. If you say that you want to score on a (sub-)thread that is
11271 started by an article with a @code{Message-ID} @var{X}, then you add a
11272 @samp{thread} match. This will add a new @samp{thread} match for each
11273 article that has @var{X} in its @code{References} header. (These new
11274 @samp{thread} matches will use the @code{Message-ID}s of these matching
11275 articles.) This will ensure that you can raise/lower the score of an
11276 entire thread, even though some articles in the thread may not have
11277 complete @code{References} headers. Note that using this may lead to
11278 undeterministic scores of the articles in the thread. (Using this match
11279 key will lead to creation of @file{ADAPT} files.)
11284 The value of this entry should be a number. Any articles with a score
11285 lower than this number will be marked as read.
11288 The value of this entry should be a number. Any articles with a score
11289 lower than this number will be removed from the summary buffer.
11291 @item mark-and-expunge
11292 The value of this entry should be a number. Any articles with a score
11293 lower than this number will be marked as read and removed from the
11296 @item thread-mark-and-expunge
11297 The value of this entry should be a number. All articles that belong to
11298 a thread that has a total score below this number will be marked as read
11299 and removed from the summary buffer. @code{gnus-thread-score-function}
11300 says how to compute the total score for a thread.
11303 The value of this entry should be any number of file names. These files
11304 are assumed to be score files as well, and will be loaded the same way
11307 @item exclude-files
11308 The clue of this entry should be any number of files. These files will
11309 not be loaded, even though they would normally be so, for some reason or
11313 The value of this entry will be @code{eval}el. This element will be
11314 ignored when handling global score files.
11317 Read-only score files will not be updated or saved. Global score files
11318 should feature this atom (@pxref{Global Score Files}).
11321 The value of this entry should be a number. Articles that do not have
11322 parents will get this number added to their scores. Imagine you follow
11323 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
11324 will only follow a few of the threads, also want to see any new threads.
11326 You can do this with the following two score file entries:
11330 (mark-and-expunge -100)
11333 When you enter the group the first time, you will only see the new
11334 threads. You then raise the score of the threads that you find
11335 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
11336 rest. Next time you enter the group, you will see new articles in the
11337 interesting threads, plus any new threads.
11339 I.e.---the orphan score atom is for high-volume groups where there
11340 exist a few interesting threads which can't be found automatically by
11341 ordinary scoring rules.
11344 This entry controls the adaptive scoring. If it is @code{t}, the
11345 default adaptive scoring rules will be used. If it is @code{ignore}, no
11346 adaptive scoring will be performed on this group. If it is a list, this
11347 list will be used as the adaptive scoring rules. If it isn't present,
11348 or is something other than @code{t} or @code{ignore}, the default
11349 adaptive scoring rules will be used. If you want to use adaptive
11350 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
11351 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
11352 not want adaptive scoring. If you only want adaptive scoring in a few
11353 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
11354 insert @code{(adapt t)} in the score files of the groups where you want
11358 All adaptive score entries will go to the file named by this entry. It
11359 will also be applied when entering the group. This atom might be handy
11360 if you want to adapt on several groups at once, using the same adaptive
11361 file for a number of groups.
11364 @cindex local variables
11365 The value of this entry should be a list of @code{(VAR VALUE)} pairs.
11366 Each @var{var} will be made buffer-local to the current summary buffer,
11367 and set to the value specified. This is a convenient, if somewhat
11368 strange, way of setting variables in some groups if you don't like hooks
11373 @node Score File Editing
11374 @section Score File Editing
11376 You normally enter all scoring commands from the summary buffer, but you
11377 might feel the urge to edit them by hand as well, so we've supplied you
11378 with a mode for that.
11380 It's simply a slightly customized @code{emacs-lisp} mode, with these
11381 additional commands:
11386 @kindex C-c C-c (Score)
11387 @findex gnus-score-edit-done
11388 Save the changes you have made and return to the summary buffer
11389 (@code{gnus-score-edit-done}).
11392 @kindex C-c C-d (Score)
11393 @findex gnus-score-edit-insert-date
11394 Insert the current date in numerical format
11395 (@code{gnus-score-edit-insert-date}). This is really the day number, if
11396 you were wondering.
11399 @kindex C-c C-p (Score)
11400 @findex gnus-score-pretty-print
11401 The adaptive score files are saved in an unformatted fashion. If you
11402 intend to read one of these files, you want to @dfn{pretty print} it
11403 first. This command (@code{gnus-score-pretty-print}) does that for
11408 Type @kbd{M-x gnus-score-mode} to use this mode.
11410 @vindex gnus-score-mode-hook
11411 @code{gnus-score-menu-hook} is run in score mode buffers.
11413 In the summary buffer you can use commands like @kbd{V f} and @kbd{V
11414 e} to begin editing score files.
11417 @node Adaptive Scoring
11418 @section Adaptive Scoring
11419 @cindex adaptive scoring
11421 If all this scoring is getting you down, Gnus has a way of making it all
11422 happen automatically---as if by magic. Or rather, as if by artificial
11423 stupidity, to be precise.
11425 @vindex gnus-use-adaptive-scoring
11426 When you read an article, or mark an article as read, or kill an
11427 article, you leave marks behind. On exit from the group, Gnus can sniff
11428 these marks and add score elements depending on what marks it finds.
11429 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
11430 @code{t} or @code{(line)}. If you want score adaptively on separate
11431 words appearing in the subjects, you should set this variable to
11432 @code{(word)}. If you want to use both adaptive methods, set this
11433 variable to @code{(word line)}.
11435 @vindex gnus-default-adaptive-score-alist
11436 To give you complete control over the scoring process, you can customize
11437 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
11438 might look something like this:
11441 (defvar gnus-default-adaptive-score-alist
11442 '((gnus-unread-mark)
11443 (gnus-ticked-mark (from 4))
11444 (gnus-dormant-mark (from 5))
11445 (gnus-del-mark (from -4) (subject -1))
11446 (gnus-read-mark (from 4) (subject 2))
11447 (gnus-expirable-mark (from -1) (subject -1))
11448 (gnus-killed-mark (from -1) (subject -3))
11449 (gnus-kill-file-mark)
11450 (gnus-ancient-mark)
11451 (gnus-low-score-mark)
11452 (gnus-catchup-mark (from -1) (subject -1))))
11455 As you see, each element in this alist has a mark as a key (either a
11456 variable name or a ``real'' mark---a character). Following this key is
11457 a arbitrary number of header/score pairs. If there are no header/score
11458 pairs following the key, no adaptive scoring will be done on articles
11459 that have that key as the article mark. For instance, articles with
11460 @code{gnus-unread-mark} in the example above will not get adaptive score
11463 Each article can have only one mark, so just a single of these rules
11464 will be applied to each article.
11466 To take @code{gnus-del-mark} as an example---this alist says that all
11467 articles that have that mark (i.e., are marked with @samp{D}) will have a
11468 score entry added to lower based on the @code{From} header by -4, and
11469 lowered by @code{Subject} by -1. Change this to fit your prejudices.
11471 If you have marked 10 articles with the same subject with
11472 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
11473 That means that that subject will get a score of ten times -1, which
11474 should be, unless I'm much mistaken, -10.
11476 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
11477 the read articles will be marked with the @samp{E} mark. This'll
11478 probably make adaptive scoring slightly impossible, so auto-expiring and
11479 adaptive scoring doesn't really mix very well.
11481 The headers you can score on are @code{from}, @code{subject},
11482 @code{message-id}, @code{references}, @code{xref}, @code{lines},
11483 @code{chars} and @code{date}. In addition, you can score on
11484 @code{followup}, which will create an adaptive score entry that matches
11485 on the @code{References} header using the @code{Message-ID} of the
11486 current article, thereby matching the following thread.
11488 You can also score on @code{thread}, which will try to score all
11489 articles that appear in a thread. @code{thread} matches uses a
11490 @code{Message-ID} to match on the @code{References} header of the
11491 article. If the match is made, the @code{Message-ID} of the article is
11492 added to the @code{thread} rule. (Think about it. I'd recommend two
11493 aspirins afterwards.)
11495 If you use this scheme, you should set the score file atom @code{mark}
11496 to something small---like -300, perhaps, to avoid having small random
11497 changes result in articles getting marked as read.
11499 After using adaptive scoring for a week or so, Gnus should start to
11500 become properly trained and enhance the authors you like best, and kill
11501 the authors you like least, without you having to say so explicitly.
11503 You can control what groups the adaptive scoring is to be performed on
11504 by using the score files (@pxref{Score File Format}). This will also
11505 let you use different rules in different groups.
11507 @vindex gnus-adaptive-file-suffix
11508 The adaptive score entries will be put into a file where the name is the
11509 group name with @code{gnus-adaptive-file-suffix} appended. The default
11512 @vindex gnus-score-exact-adapt-limit
11513 When doing adaptive scoring, substring or fuzzy matching would probably
11514 give you the best results in most cases. However, if the header one
11515 matches is short, the possibility for false positives is great, so if
11516 the length of the match is less than
11517 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
11518 this variable is @code{nil}, exact matching will always be used to avoid
11521 @vindex gnus-default-adaptive-word-score-alist
11522 As mentioned above, you can adapt either on individual words or entire
11523 headers. If you adapt on words, the
11524 @code{gnus-default-adaptive-word-score-alist} variable says what score
11525 each instance of a word should add given a mark.
11528 (setq gnus-default-adaptive-word-score-alist
11529 `((,gnus-read-mark . 30)
11530 (,gnus-catchup-mark . -10)
11531 (,gnus-killed-mark . -20)
11532 (,gnus-del-mark . -15)))
11535 This is the default value. If you have adaption on words enabled, every
11536 word that appears in subjects of articles that are marked with
11537 @code{gnus-read-mark} will result in a score rule that increase the
11538 score with 30 points.
11540 @vindex gnus-default-ignored-adaptive-words
11541 @vindex gnus-ignored-adaptive-words
11542 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
11543 will be ignored. If you wish to add more words to be ignored, use the
11544 @code{gnus-ignored-adaptive-words} list instead.
11546 @vindex gnus-adaptive-word-syntax-table
11547 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
11548 syntax table in effect. It is similar to the standard syntax table, but
11549 it considers numbers to be non-word-constituent characters.
11551 After using this scheme for a while, it might be nice to write a
11552 @code{gnus-psychoanalyze-user} command to go through the rules and see
11553 what words you like and what words you don't like. Or perhaps not.
11555 Note that the adaptive word scoring thing is highly experimental and is
11556 likely to change in the future. Initial impressions seem to indicate
11557 that it's totally useless as it stands. Some more work (involving more
11558 rigorous statistical methods) will have to be done to make this useful.
11561 @node Home Score File
11562 @section Home Score File
11564 The score file where new score file entries will go is called the
11565 @dfn{home score file}. This is normally (and by default) the score file
11566 for the group itself. For instance, the home score file for
11567 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
11569 However, this may not be what you want. It is often convenient to share
11570 a common home score file among many groups---all @samp{emacs} groups
11571 could perhaps use the same home score file.
11573 @vindex gnus-home-score-file
11574 The variable that controls this is @code{gnus-home-score-file}. It can
11579 A string. Then this file will be used as the home score file for all
11583 A function. The result of this function will be used as the home score
11584 file. The function will be called with the name of the group as the
11588 A list. The elements in this list can be:
11592 @var{(regexp file-name)}. If the @var{regexp} matches the group name,
11593 the @var{file-name} will will be used as the home score file.
11596 A function. If the function returns non-nil, the result will be used as
11597 the home score file.
11600 A string. Use the string as the home score file.
11603 The list will be traversed from the beginning towards the end looking
11608 So, if you want to use just a single score file, you could say:
11611 (setq gnus-home-score-file
11612 "my-total-score-file.SCORE")
11615 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
11616 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
11619 (setq gnus-home-score-file
11620 'gnus-hierarchial-home-score-file)
11623 This is a ready-made function provided for your convenience.
11625 If you want to have one score file for the @samp{emacs} groups and
11626 another for the @samp{comp} groups, while letting all other groups use
11627 their own home score files:
11630 (setq gnus-home-score-file
11631 ;; All groups that match the regexp "\\.emacs"
11632 '("\\.emacs" "emacs.SCORE")
11633 ;; All the comp groups in one score file
11634 ("^comp" "comp.SCORE"))
11637 @vindex gnus-home-adapt-file
11638 @code{gnus-home-adapt-file} works exactly the same way as
11639 @code{gnus-home-score-file}, but says what the home adaptive score file
11640 is instead. All new adaptive file entries will go into the file
11641 specified by this variable, and the same syntax is allowed.
11643 In addition to using @code{gnus-home-score-file} and
11644 @code{gnus-home-adapt-file}, you can also use group parameters
11645 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
11646 Parameters}) to achieve much the same. Group and topic parameters take
11647 precedence over this variable.
11650 @node Followups To Yourself
11651 @section Followups To Yourself
11653 Gnus offers two commands for picking out the @code{Message-ID} header in
11654 the current buffer. Gnus will then add a score rule that scores using
11655 this @code{Message-ID} on the @code{References} header of other
11656 articles. This will, in effect, increase the score of all articles that
11657 respond to the article in the current buffer. Quite useful if you want
11658 to easily note when people answer what you've said.
11662 @item gnus-score-followup-article
11663 @findex gnus-score-followup-article
11664 This will add a score to articles that directly follow up your own
11667 @item gnus-score-followup-thread
11668 @findex gnus-score-followup-thread
11669 This will add a score to all articles that appear in a thread ``below''
11673 @vindex message-sent-hook
11674 These two functions are both primarily meant to be used in hooks like
11675 @code{message-sent-hook}.
11677 If you look closely at your own @code{Message-ID}, you'll notice that
11678 the first two or three characters are always the same. Here's two of
11682 <x6u3u47icf.fsf@@eyesore.no>
11683 <x6sp9o7ibw.fsf@@eyesore.no>
11686 So ``my'' ident on this machine is @samp{x6}. This can be
11687 exploited---the following rule will raise the score on all followups to
11692 ("<x6[0-9a-z]+\\.fsf@@.*eyesore.no>" 1000 nil r))
11695 Whether it's the first two or first three characters that are ``yours''
11696 is system-dependent.
11700 @section Scoring Tips
11701 @cindex scoring tips
11707 @cindex scoring crossposts
11708 If you want to lower the score of crossposts, the line to match on is
11709 the @code{Xref} header.
11711 ("xref" (" talk.politics.misc:" -1000))
11714 @item Multiple crossposts
11715 If you want to lower the score of articles that have been crossposted to
11716 more than, say, 3 groups:
11718 ("xref" ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+" -1000 nil r))
11721 @item Matching on the body
11722 This is generally not a very good idea---it takes a very long time.
11723 Gnus actually has to fetch each individual article from the server. But
11724 you might want to anyway, I guess. Even though there are three match
11725 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
11726 and stick with it in each score file. If you use any two, each article
11727 will be fetched @emph{twice}. If you want to match a bit on the
11728 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
11731 @item Marking as read
11732 You will probably want to mark articles that has a score below a certain
11733 number as read. This is most easily achieved by putting the following
11734 in your @file{all.SCORE} file:
11738 You may also consider doing something similar with @code{expunge}.
11740 @item Negated character classes
11741 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
11742 That will match newlines, which might lead to, well, The Unknown. Say
11743 @code{[^abcd\n]*} instead.
11747 @node Reverse Scoring
11748 @section Reverse Scoring
11749 @cindex reverse scoring
11751 If you want to keep just articles that have @samp{Sex with Emacs} in the
11752 subject header, and expunge all other articles, you could put something
11753 like this in your score file:
11757 ("Sex with Emacs" 2))
11762 So, you raise all articles that match @samp{Sex with Emacs} and mark the
11763 rest as read, and expunge them to boot.
11766 @node Global Score Files
11767 @section Global Score Files
11768 @cindex global score files
11770 Sure, other newsreaders have ``global kill files''. These are usually
11771 nothing more than a single kill file that applies to all groups, stored
11772 in the user's home directory. Bah! Puny, weak newsreaders!
11774 What I'm talking about here are Global Score Files. Score files from
11775 all over the world, from users everywhere, uniting all nations in one
11776 big, happy score file union! Ange-score! New and untested!
11778 @vindex gnus-global-score-files
11779 All you have to do to use other people's score files is to set the
11780 @code{gnus-global-score-files} variable. One entry for each score file,
11781 or each score file directory. Gnus will decide by itself what score
11782 files are applicable to which group.
11784 Say you want to use the score file
11785 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
11786 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory:
11789 (setq gnus-global-score-files
11790 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
11791 "/ftp@@ftp.some-where:/pub/score/"))
11794 @findex gnus-score-search-global-directories
11795 Simple, eh? Directory names must end with a @samp{/}. These
11796 directories are typically scanned only once during each Gnus session.
11797 If you feel the need to manually re-scan the remote directories, you can
11798 use the @code{gnus-score-search-global-directories} command.
11800 Note that, at present, using this option will slow down group entry
11801 somewhat. (That is---a lot.)
11803 If you want to start maintaining score files for other people to use,
11804 just put your score file up for anonymous ftp and announce it to the
11805 world. Become a retro-moderator! Participate in the retro-moderator
11806 wars sure to ensue, where retro-moderators battle it out for the
11807 sympathy of the people, luring them to use their score files on false
11808 premises! Yay! The net is saved!
11810 Here are some tips for the would-be retro-moderator, off the top of my
11816 Articles that are heavily crossposted are probably junk.
11818 To lower a single inappropriate article, lower by @code{Message-ID}.
11820 Particularly brilliant authors can be raised on a permanent basis.
11822 Authors that repeatedly post off-charter for the group can safely be
11823 lowered out of existence.
11825 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
11826 articles completely.
11829 Use expiring score entries to keep the size of the file down. You
11830 should probably have a long expiry period, though, as some sites keep
11831 old articles for a long time.
11834 ... I wonder whether other newsreaders will support global score files
11835 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
11836 Wave, xrn and 1stReader are bound to implement scoring. Should we start
11837 holding our breath yet?
11841 @section Kill Files
11844 Gnus still supports those pesky old kill files. In fact, the kill file
11845 entries can now be expiring, which is something I wrote before Daniel
11846 Quinlan thought of doing score files, so I've left the code in there.
11848 In short, kill processing is a lot slower (and I do mean @emph{a lot})
11849 than score processing, so it might be a good idea to rewrite your kill
11850 files into score files.
11852 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
11853 forms into this file, which means that you can use kill files as some
11854 sort of primitive hook function to be run on group entry, even though
11855 that isn't a very good idea.
11857 Normal kill files look like this:
11860 (gnus-kill "From" "Lars Ingebrigtsen")
11861 (gnus-kill "Subject" "ding")
11865 This will mark every article written by me as read, and remove them from
11866 the summary buffer. Very useful, you'll agree.
11868 Other programs use a totally different kill file syntax. If Gnus
11869 encounters what looks like a @code{rn} kill file, it will take a stab at
11872 Two summary functions for editing a GNUS kill file:
11877 @kindex M-k (Summary)
11878 @findex gnus-summary-edit-local-kill
11879 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
11882 @kindex M-K (Summary)
11883 @findex gnus-summary-edit-global-kill
11884 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
11887 Two group mode functions for editing the kill files:
11892 @kindex M-k (Group)
11893 @findex gnus-group-edit-local-kill
11894 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
11897 @kindex M-K (Group)
11898 @findex gnus-group-edit-global-kill
11899 Edit the general kill file (@code{gnus-group-edit-global-kill}).
11902 Kill file variables:
11905 @item gnus-kill-file-name
11906 @vindex gnus-kill-file-name
11907 A kill file for the group @samp{soc.motss} is normally called
11908 @file{soc.motss.KILL}. The suffix appended to the group name to get
11909 this file name is detailed by the @code{gnus-kill-file-name} variable.
11910 The ``global'' kill file (not in the score file sense of ``global'', of
11911 course) is called just @file{KILL}.
11913 @vindex gnus-kill-save-kill-file
11914 @item gnus-kill-save-kill-file
11915 If this variable is non-@code{nil}, Gnus will save the
11916 kill file after processing, which is necessary if you use expiring
11919 @item gnus-apply-kill-hook
11920 @vindex gnus-apply-kill-hook
11921 @findex gnus-apply-kill-file-unless-scored
11922 @findex gnus-apply-kill-file
11923 A hook called to apply kill files to a group. It is
11924 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
11925 kill file if you have a score file for the same group, you can set this
11926 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
11927 kill files to be processed, you should set this variable to @code{nil}.
11929 @item gnus-kill-file-mode-hook
11930 @vindex gnus-kill-file-mode-hook
11931 A hook called in kill-file mode buffers.
11936 @node Converting Kill Files
11937 @section Converting Kill Files
11939 @cindex converting kill files
11941 If you have loads of old kill files, you may want to convert them into
11942 score files. If they are ``regular'', you can use
11943 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
11946 The kill to score conversion package isn't included in Gnus by default.
11947 You can fetch it from
11948 @file{http://www.ifi.uio.no/~larsi/ding-other/gnus-kill-to-score}.
11950 If your old kill files are very complex---if they contain more
11951 non-@code{gnus-kill} forms than not, you'll have to convert them by
11952 hand. Or just let them be as they are. Gnus will still use them as
11960 GroupLens is a collaborative filtering system that helps you work
11961 together with other people to find the quality news articles out of the
11962 huge volume of news articles generated every day.
11964 To accomplish this the GroupLens system combines your opinions about
11965 articles you have already read with the opinions of others who have done
11966 likewise and gives you a personalized prediction for each unread news
11967 article. Think of GroupLens as a matchmaker. GroupLens watches how you
11968 rate articles, and finds other people that rate articles the same way.
11969 Once it has found for you some people you agree with it tells you, in
11970 the form of a prediction, what they thought of the article. You can use
11971 this prediction to help you decide whether or not you want to read the
11975 * Using GroupLens:: How to make Gnus use GroupLens.
11976 * Rating Articles:: Letting GroupLens know how you rate articles.
11977 * Displaying Predictions:: Displaying predictions given by GroupLens.
11978 * GroupLens Variables:: Customizing GroupLens.
11982 @node Using GroupLens
11983 @subsection Using GroupLens
11985 To use GroupLens you must register a pseudonym with your local Better
11987 @samp{http://www.cs.umn.edu/Research/GroupLens/bbb.html} is the only
11988 better bit in town is at the moment.
11990 Once you have registered you'll need to set a couple of variables.
11994 @item gnus-use-grouplens
11995 @vindex gnus-use-grouplens
11996 Setting this variable to a non-@code{nil} value will make Gnus hook into
11997 all the relevant GroupLens functions.
11999 @item grouplens-pseudonym
12000 @vindex grouplens-pseudonym
12001 This variable should be set to the pseudonym you got when registering
12002 with the Better Bit Bureau.
12004 @item grouplens-newsgroups
12005 @vindex grouplens-newsgroups
12006 A list of groups that you want to get GroupLens predictions for.
12010 Thats the minimum of what you need to get up and running with GroupLens.
12011 Once you've registered, GroupLens will start giving you scores for
12012 articles based on the average of what other people think. But, to get
12013 the real benefit of GroupLens you need to start rating articles
12014 yourself. Then the scores GroupLens gives you will be personalized for
12015 you, based on how the people you usually agree with have already rated.
12018 @node Rating Articles
12019 @subsection Rating Articles
12021 In GroupLens, an article is rated on a scale from 1 to 5, inclusive.
12022 Where 1 means something like this article is a waste of bandwidth and 5
12023 means that the article was really good. The basic question to ask
12024 yourself is, "on a scale from 1 to 5 would I like to see more articles
12027 There are four ways to enter a rating for an article in GroupLens.
12032 @kindex r (GroupLens)
12033 @findex bbb-summary-rate-article
12034 This function will prompt you for a rating on a scale of one to five.
12037 @kindex k (GroupLens)
12038 @findex grouplens-score-thread
12039 This function will prompt you for a rating, and rate all the articles in
12040 the thread. This is really useful for some of those long running giant
12041 threads in rec.humor.
12045 The next two commands, @kbd{n} and @kbd{,} take a numerical prefix to be
12046 the score of the article you're reading.
12051 @kindex n (GroupLens)
12052 @findex grouplens-next-unread-article
12053 Rate the article and go to the next unread article.
12056 @kindex , (GroupLens)
12057 @findex grouplens-best-unread-article
12058 Rate the article and go to the next unread article with the highest score.
12062 If you want to give the current article a score of 4 and then go to the
12063 next article, just type @kbd{4 n}.
12066 @node Displaying Predictions
12067 @subsection Displaying Predictions
12069 GroupLens makes a prediction for you about how much you will like a
12070 news article. The predictions from GroupLens are on a scale from 1 to
12071 5, where 1 is the worst and 5 is the best. You can use the predictions
12072 from GroupLens in one of three ways controlled by the variable
12073 @code{gnus-grouplens-override-scoring}.
12075 @vindex gnus-grouplens-override-scoring
12076 There are three ways to display predictions in grouplens. You may
12077 choose to have the GroupLens scores contribute to, or override the
12078 regular gnus scoring mechanism. override is the default; however, some
12079 people prefer to see the Gnus scores plus the grouplens scores. To get
12080 the separate scoring behavior you need to set
12081 @code{gnus-grouplens-override-scoring} to @code{'separate}. To have the
12082 GroupLens predictions combined with the grouplens scores set it to
12083 @code{'override} and to combine the scores set
12084 @code{gnus-grouplens-override-scoring} to @code{'combine}. When you use
12085 the combine option you will also want to set the values for
12086 @code{grouplens-prediction-offset} and
12087 @code{grouplens-score-scale-factor}.
12089 @vindex grouplens-prediction-display
12090 In either case, GroupLens gives you a few choices for how you would like
12091 to see your predictions displayed. The display of predictions is
12092 controlled by the @code{grouplens-prediction-display} variable.
12094 The following are legal values for that variable.
12097 @item prediction-spot
12098 The higher the prediction, the further to the right an @samp{*} is
12101 @item confidence-interval
12102 A numeric confidence interval.
12104 @item prediction-bar
12105 The higher the prediction, the longer the bar.
12107 @item confidence-bar
12108 Numerical confidence.
12110 @item confidence-spot
12111 The spot gets bigger with more confidence.
12113 @item prediction-num
12114 Plain-old numeric value.
12116 @item confidence-plus-minus
12117 Prediction +/i confidence.
12122 @node GroupLens Variables
12123 @subsection GroupLens Variables
12127 @item gnus-summary-grouplens-line-format
12128 The summary line format used in summary buffers that are GroupLens
12129 enhanced. It accepts the same specs as the normal summary line format
12130 (@pxref{Summary Buffer Lines}). The default is
12131 @samp{%U%R%z%l%I%(%[%4L: %-20,20n%]%) %s\n}.
12133 @item grouplens-bbb-host
12134 Host running the bbbd server. @samp{grouplens.cs.umn.edu} is the
12137 @item grouplens-bbb-port
12138 Port of the host running the bbbd server. The default is 9000.
12140 @item grouplens-score-offset
12141 Offset the prediction by this value. In other words, subtract the
12142 prediction value by this number to arrive at the effective score. The
12145 @item grouplens-score-scale-factor
12146 This variable allows the user to magnify the effect of GroupLens scores.
12147 The scale factor is applied after the offset. The default is 1.
12152 @node Advanced Scoring
12153 @section Advanced Scoring
12155 Scoring on Subjects and From headers is nice enough, but what if you're
12156 really interested in what a person has to say only when she's talking
12157 about a particular subject? Or what about if you really don't want to
12158 read what person A has to say when she's following up to person B, but
12159 want to read what she says when she's following up to person C?
12161 By using advanced scoring rules you may create arbitrarily complex
12165 * Advanced Scoring Syntax:: A definition.
12166 * Advanced Scoring Examples:: What they look like.
12167 * Advanced Scoring Tips:: Getting the most out of it.
12171 @node Advanced Scoring Syntax
12172 @subsection Advanced Scoring Syntax
12174 Ordinary scoring rules have a string as the first element in the rule.
12175 Advanced scoring rules have a list as the first element. The second
12176 element is the score to be applied if the first element evaluated to a
12177 non-@code{nil} value.
12179 These lists may consist of three logical operators, one redirection
12180 operator, and various match operators.
12187 This logical operator will evaluate each of its arguments until it finds
12188 one that evaluates to @code{false}, and then it'll stop. If all arguments
12189 evaluate to @code{true} values, then this operator will return
12194 This logical operator will evaluate each of its arguments until it finds
12195 one that evaluates to @code{true}. If no arguments are @code{true},
12196 then this operator will return @code{false}.
12201 This logical operator only takes a single argument. It returns the
12202 inverse of the value of its argument.
12206 There is an @dfn{indirection operator} that will make its arguments
12207 apply to the ancestors of the current article being scored. For
12208 instance, @code{1-} will make score rules apply to the parent of the
12209 current article. @code{2-} will make score fules apply to the
12210 grandparent of the current article. Alternatively, you can write
12211 @code{^^}, where the number of @code{^}s (carets) say how far back into
12212 the ancestry you want to go.
12214 Finally, we have the match operators. These are the ones that do the
12215 real work. Match operators are header name strings followed by a match
12216 and a match type. A typical match operator looks like @samp{("from"
12217 "Lars Ingebrigtsen" s)}. The header names are the same as when using
12218 simple scoring, and the match types are also the same.
12221 @node Advanced Scoring Examples
12222 @subsection Advanced Scoring Examples
12224 Let's say you want to increase the score of articles written by Lars
12225 when he's talking about Gnus:
12229 ("from" "Lars Ingebrigtsen")
12230 ("subject" "Gnus"))
12236 When he writes long articles, he sometimes has something nice to say:
12240 ("from" "Lars Ingebrigtsen")
12247 However, when he responds to things written by Reig Eigil Logge, you
12248 really don't want to read what he's written:
12252 ("from" "Lars Ingebrigtsen")
12253 (1- ("from" "Reig Eigir Logge")))
12257 Everybody that follows up Redmondo when he writes about disappearing
12258 socks should have their scores raised, but only when they talk about
12259 white socks. However, when Lars talks about socks, it's usually not
12266 ("from" "redmondo@@.*no" r)
12267 ("body" "disappearing.*socks" t)))
12268 (! ("from" "Lars Ingebrigtsen"))
12269 ("body" "white.*socks"))
12273 The possibilities are endless.
12276 @node Advanced Scoring Tips
12277 @subsection Advanced Scoring Tips
12279 The @code{&} and @code{|} logical operators do short-circuit logic.
12280 That is, they stop processing their arguments when it's clear what the
12281 result of the operation will be. For instance, if one of the arguments
12282 of an @code{&} evaluates to @code{false}, there's no point in evaluating
12283 the rest of the arguments. This means that you should put slow matches
12284 (@samp{body}, @code{header}) last and quick matches (@samp{from},
12285 @samp{subject}) first.
12287 The indirection arguments (@code{1-} and so on) will make their
12288 arguments work on previous generations of the thread. If you say
12299 Then that means "score on the from header of the grandparent of the
12300 current article". An indirection is quite fast, but it's better to say:
12306 ("subject" "Gnus")))
12313 (1- ("from" "Lars"))
12314 (1- ("subject" "Gnus")))
12319 @section Score Decays
12320 @cindex score decays
12323 You may find that your scores have a tendency to grow without
12324 bounds, especially if you're using adaptive scoring. If scores get too
12325 big, they lose all meaning---they simply max out and it's difficult to
12326 use them in any sensible way.
12328 @vindex gnus-decay-scores
12329 @findex gnus-decay-score
12330 @vindex gnus-score-decay-function
12331 Gnus provides a mechanism for decaying scores to help with this problem.
12332 When score files are loaded and @code{gnus-decay-scores} is
12333 non-@code{nil}, Gnus will run the score files through the decaying
12334 mechanism thereby lowering the scores of all non-permanent score rules.
12335 The decay itself if performed by the @code{gnus-score-decay-function}
12336 function, which is @code{gnus-decay-score} by default. Here's the
12337 definition of that function:
12340 (defun gnus-decay-score (score)
12341 "Decay SCORE according to `gnus-score-decay-constant' and `gnus-score-decay-scale'."
12344 (* (if (< score 0) 1 -1)
12346 (max gnus-score-decay-constant
12348 gnus-score-decay-scale)))))))
12351 @vindex gnus-score-decay-scale
12352 @vindex gnus-score-decay-constant
12353 @code{gnus-score-decay-constant} is 3 by default and
12354 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
12358 Scores between -3 and 3 will be set to 0 when this function is called.
12361 Scores with magnitudes between 3 and 60 will be shrunk by 3.
12364 Scores with magnitudes greater than 60 will be shrunk by 5% of the
12368 If you don't like this decay function, write your own. It is called
12369 with the score to be decayed as its only parameter, and it should return
12370 the new score, which should be an integer.
12372 Gnus will try to decay scores once a day. If you haven't run Gnus for
12373 four days, Gnus will decay the scores four times, for instance.
12380 * Process/Prefix:: A convention used by many treatment commands.
12381 * Interactive:: Making Gnus ask you many questions.
12382 * Formatting Variables:: You can specify what buffers should look like.
12383 * Windows Configuration:: Configuring the Gnus buffer windows.
12384 * Compilation:: How to speed Gnus up.
12385 * Mode Lines:: Displaying information in the mode lines.
12386 * Highlighting and Menus:: Making buffers look all nice and cozy.
12387 * Buttons:: Get tendonitis in ten easy steps!
12388 * Daemons:: Gnus can do things behind your back.
12389 * NoCeM:: How to avoid spam and other fatty foods.
12390 * Picons:: How to display pictures of what your reading.
12391 * Undo:: Some actions can be undone.
12392 * Moderation:: What to do if you're a moderator.
12393 * XEmacs Enhancements:: There are more pictures and stuff under XEmacs.
12394 * Fuzzy Matching:: What's the big fuzz?
12395 * Thwarting Email Spam:: A how-to on avoiding unsolited commercial email.
12396 * Various Various:: Things that are really various.
12400 @node Process/Prefix
12401 @section Process/Prefix
12402 @cindex process/prefix convention
12404 Many functions, among them functions for moving, decoding and saving
12405 articles, use what is known as the @dfn{Process/Prefix convention}.
12407 This is a method for figuring out what articles that the user wants the
12408 command to be performed on.
12412 If the numeric prefix is N, perform the operation on the next N
12413 articles, starting with the current one. If the numeric prefix is
12414 negative, perform the operation on the previous N articles, starting
12415 with the current one.
12417 @vindex transient-mark-mode
12418 If @code{transient-mark-mode} in non-@code{nil} and the region is
12419 active, all articles in the region will be worked upon.
12421 If there is no numeric prefix, but some articles are marked with the
12422 process mark, perform the operation on the articles that are marked with
12425 If there is neither a numeric prefix nor any articles marked with the
12426 process mark, just perform the operation on the current article.
12428 Quite simple, really, but it needs to be made clear so that surprises
12431 Commands that react to the process mark will push the current list of
12432 process marked articles onto a stack and will then clear all process
12433 marked articles. You can restore the previous configuration with the
12434 @kbd{M P y} command (@pxref{Setting Process Marks}).
12436 @vindex gnus-summary-goto-unread
12437 One thing that seems to shock & horrify lots of people is that, for
12438 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
12439 Since each @kbd{d} (which marks the current article as read) by default
12440 goes to the next unread article after marking, this means that @kbd{3 d}
12441 will mark the next three unread articles as read, no matter what the
12442 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
12443 @code{nil} for a more straightforward action.
12447 @section Interactive
12448 @cindex interaction
12452 @item gnus-novice-user
12453 @vindex gnus-novice-user
12454 If this variable is non-@code{nil}, you are either a newcomer to the
12455 World of Usenet, or you are very cautious, which is a nice thing to be,
12456 really. You will be given questions of the type ``Are you sure you want
12457 to do this?'' before doing anything dangerous. This is @code{t} by
12460 @item gnus-expert-user
12461 @vindex gnus-expert-user
12462 If this variable is non-@code{nil}, you will never ever be asked any
12463 questions by Gnus. It will simply assume you know what you're doing, no
12464 matter how strange.
12466 @item gnus-interactive-catchup
12467 @vindex gnus-interactive-catchup
12468 Require confirmation before catching up a group if non-@code{nil}. It
12469 is @code{t} by default.
12471 @item gnus-interactive-exit
12472 @vindex gnus-interactive-exit
12473 Require confirmation before exiting Gnus. This variable is @code{t} by
12478 @node Formatting Variables
12479 @section Formatting Variables
12480 @cindex formatting variables
12482 Throughout this manual you've probably noticed lots of variables that
12483 are called things like @code{gnus-group-line-format} and
12484 @code{gnus-summary-mode-line-format}. These control how Gnus is to
12485 output lines in the various buffers. There's quite a lot of them.
12486 Fortunately, they all use the same syntax, so there's not that much to
12489 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
12490 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
12491 lots of percentages everywhere.
12494 * Formatting Basics:: A formatting variable is basically a format string.
12495 * Advanced Formatting:: Modifying output in various ways.
12496 * User-Defined Specs:: Having Gnus call your own functions.
12497 * Formatting Fonts:: Making the formatting look colorful and nice.
12500 Currently Gnus uses the following formatting variables:
12501 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
12502 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
12503 @code{gnus-group-mode-line-format},
12504 @code{gnus-summary-mode-line-format},
12505 @code{gnus-article-mode-line-format},
12506 @code{gnus-server-mode-line-format}, and
12507 @code{gnus-summary-pick-line-format}.
12509 All these format variables can also be arbitrary elisp forms. In that
12510 case, they will be @code{eval}ed to insert the required lines.
12512 @kindex M-x gnus-update-format
12513 @findex gnus-update-format
12514 Gnus includes a command to help you while creating your own format
12515 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
12516 update the spec in question and pop you to a buffer where you can
12517 examine the resulting lisp code to be run to generate the line.
12521 @node Formatting Basics
12522 @subsection Formatting Basics
12524 Each @samp{%} element will be replaced by some string or other when the
12525 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
12526 spec, and pad with spaces to get a 5-character field''.
12528 As with normal C and Emacs Lisp formatting strings, the numerical
12529 modifier between the @samp{%} and the formatting type character will
12530 @dfn{pad} the output so that it is always at least that long.
12531 @samp{%5y} will make the field always (at least) five characters wide by
12532 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
12535 You may also wish to limit the length of the field to protect against
12536 particularly wide values. For that you can say @samp{%4,6y}, which
12537 means that the field will never be more than 6 characters wide and never
12538 less than 4 characters wide.
12541 @node Advanced Formatting
12542 @subsection Advanced Formatting
12544 It is frequently useful to post-process the fields in some way.
12545 Padding, limiting, cutting off parts and suppressing certain values can
12546 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
12547 look like @samp{%~(cut 3)~(ignore "0")y}.
12549 These are the legal modifiers:
12554 Pad the field to the left with spaces until it reaches the required
12558 Pad the field to the right with spaces until it reaches the required
12563 Cut off characters from the left until it reaches the specified length.
12566 Cut off characters from the right until it reaches the specified
12571 Cut off the specified number of characters from the left.
12574 Cut off the specified number of characters from the right.
12577 Return an empty string if the field is equal to the specified value.
12580 Use the specified form as the field value when the @samp{@@} spec is
12584 Let's take an example. The @samp{%o} spec in the summary mode lines
12585 will return a date in compact ISO8601 format---@samp{19960809T230410}.
12586 This is quite a mouthful, so we want to shave off the century number and
12587 the time, leaving us with a six-character date. That would be
12588 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
12589 maxing, and we need the padding to ensure that the date is never less
12590 than 6 characters to make it look nice in columns.)
12592 Ignoring is done first; then cutting; then maxing; and then as the very
12593 last operation, padding.
12595 If you use lots of these advanced thingies, you'll find that Gnus gets
12596 quite slow. This can be helped enormously by running @kbd{M-x
12597 gnus-compile} when you are satisfied with the look of your lines.
12598 @xref{Compilation}.
12601 @node User-Defined Specs
12602 @subsection User-Defined Specs
12604 All the specs allow for inserting user defined specifiers---@samp{u}.
12605 The next character in the format string should be a letter. Gnus
12606 will call the function @code{gnus-user-format-function-}@samp{X}, where
12607 @samp{X} is the letter following @samp{%u}. The function will be passed
12608 a single parameter---what the parameter means depends on what buffer
12609 it's being called from. The function should return a string, which will
12610 be inserted into the buffer just like information from any other
12611 specifier. This function may also be called with dummy values, so it
12612 should protect against that.
12614 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
12615 much the same without defining new functions. Here's an example:
12616 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
12617 given here will be evaluated to yield the current line number, and then
12621 @node Formatting Fonts
12622 @subsection Formatting Fonts
12624 There are specs for highlighting, and these are shared by all the format
12625 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
12626 the special @code{mouse-face} property set, which means that it will be
12627 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
12630 Text inside the @samp{%[} and @samp{%]} specifiers will have their
12631 normal faces set using @code{gnus-face-0}, which is @code{bold} by
12632 default. If you say @samp{%1[} instead, you'll get @code{gnus-face-1}
12633 instead, and so on. Create as many faces as you wish. The same goes
12634 for the @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
12635 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
12637 Here's an alternative recipe for the group buffer:
12640 ;; Create three face types.
12641 (setq gnus-face-1 'bold)
12642 (setq gnus-face-3 'italic)
12644 ;; We want the article count to be in
12645 ;; a bold and green face. So we create
12646 ;; a new face called `my-green-bold'.
12647 (copy-face 'bold 'my-green-bold)
12649 (set-face-foreground 'my-green-bold "ForestGreen")
12650 (setq gnus-face-2 'my-green-bold)
12652 ;; Set the new & fancy format.
12653 (setq gnus-group-line-format
12654 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
12657 I'm sure you'll be able to use this scheme to create totally unreadable
12658 and extremely vulgar displays. Have fun!
12660 Note that the @samp{%(} specs (and friends) do not make any sense on the
12661 mode-line variables.
12664 @node Windows Configuration
12665 @section Windows Configuration
12666 @cindex windows configuration
12668 No, there's nothing here about X, so be quiet.
12670 @vindex gnus-use-full-window
12671 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
12672 other windows and occupy the entire Emacs screen by itself. It is
12673 @code{t} by default.
12675 @vindex gnus-buffer-configuration
12676 @code{gnus-buffer-configuration} describes how much space each Gnus
12677 buffer should be given. Here's an excerpt of this variable:
12680 ((group (vertical 1.0 (group 1.0 point)
12681 (if gnus-carpal (group-carpal 4))))
12682 (article (vertical 1.0 (summary 0.25 point)
12686 This is an alist. The @dfn{key} is a symbol that names some action or
12687 other. For instance, when displaying the group buffer, the window
12688 configuration function will use @code{group} as the key. A full list of
12689 possible names is listed below.
12691 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
12692 should occupy. To take the @code{article} split as an example -
12695 (article (vertical 1.0 (summary 0.25 point)
12699 This @dfn{split} says that the summary buffer should occupy 25% of upper
12700 half of the screen, and that it is placed over the article buffer. As
12701 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
12702 reaching for that calculator there). However, the special number
12703 @code{1.0} is used to signal that this buffer should soak up all the
12704 rest of the space available after the rest of the buffers have taken
12705 whatever they need. There should be only one buffer with the @code{1.0}
12706 size spec per split.
12708 Point will be put in the buffer that has the optional third element
12711 Here's a more complicated example:
12714 (article (vertical 1.0 (group 4)
12715 (summary 0.25 point)
12716 (if gnus-carpal (summary-carpal 4))
12720 If the size spec is an integer instead of a floating point number,
12721 then that number will be used to say how many lines a buffer should
12722 occupy, not a percentage.
12724 If the @dfn{split} looks like something that can be @code{eval}ed (to be
12725 precise---if the @code{car} of the split is a function or a subr), this
12726 split will be @code{eval}ed. If the result is non-@code{nil}, it will
12727 be used as a split. This means that there will be three buffers if
12728 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
12731 Not complicated enough for you? Well, try this on for size:
12734 (article (horizontal 1.0
12739 (summary 0.25 point)
12744 Whoops. Two buffers with the mystery 100% tag. And what's that
12745 @code{horizontal} thingie?
12747 If the first element in one of the split is @code{horizontal}, Gnus will
12748 split the window horizontally, giving you two windows side-by-side.
12749 Inside each of these strips you may carry on all you like in the normal
12750 fashion. The number following @code{horizontal} says what percentage of
12751 the screen is to be given to this strip.
12753 For each split, there @emph{must} be one element that has the 100% tag.
12754 The splitting is never accurate, and this buffer will eat any leftover
12755 lines from the splits.
12757 To be slightly more formal, here's a definition of what a legal split
12761 split = frame | horizontal | vertical | buffer | form
12762 frame = "(frame " size *split ")"
12763 horizontal = "(horizontal " size *split ")"
12764 vertical = "(vertical " size *split ")"
12765 buffer = "(" buffer-name " " size *[ "point" ] ")"
12766 size = number | frame-params
12767 buffer-name = group | article | summary ...
12770 The limitations are that the @code{frame} split can only appear as the
12771 top-level split. @var{form} should be an Emacs Lisp form that should
12772 return a valid split. We see that each split is fully recursive, and
12773 may contain any number of @code{vertical} and @code{horizontal} splits.
12775 @vindex gnus-window-min-width
12776 @vindex gnus-window-min-height
12777 @cindex window height
12778 @cindex window width
12779 Finding the right sizes can be a bit complicated. No window may be less
12780 than @code{gnus-window-min-height} (default 1) characters high, and all
12781 windows must be at least @code{gnus-window-min-width} (default 1)
12782 characters wide. Gnus will try to enforce this before applying the
12783 splits. If you want to use the normal Emacs window width/height limit,
12784 you can just set these two variables to @code{nil}.
12786 If you're not familiar with Emacs terminology, @code{horizontal} and
12787 @code{vertical} splits may work the opposite way of what you'd expect.
12788 Windows inside a @code{horizontal} split are shown side-by-side, and
12789 windows within a @code{vertical} split are shown above each other.
12791 @findex gnus-configure-frame
12792 If you want to experiment with window placement, a good tip is to call
12793 @code{gnus-configure-frame} directly with a split. This is the function
12794 that does all the real work when splitting buffers. Below is a pretty
12795 nonsensical configuration with 5 windows; two for the group buffer and
12796 three for the article buffer. (I said it was nonsensical.) If you
12797 @code{eval} the statement below, you can get an idea of how that would
12798 look straight away, without going through the normal Gnus channels.
12799 Play with it until you're satisfied, and then use
12800 @code{gnus-add-configuration} to add your new creation to the buffer
12801 configuration list.
12804 (gnus-configure-frame
12808 (article 0.3 point))
12816 You might want to have several frames as well. No prob---just use the
12817 @code{frame} split:
12820 (gnus-configure-frame
12823 (summary 0.25 point)
12825 (vertical ((height . 5) (width . 15)
12826 (user-position . t)
12827 (left . -1) (top . 1))
12832 This split will result in the familiar summary/article window
12833 configuration in the first (or ``main'') frame, while a small additional
12834 frame will be created where picons will be shown. As you can see,
12835 instead of the normal @code{1.0} top-level spec, each additional split
12836 should have a frame parameter alist as the size spec.
12837 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
12840 Here's a list of all possible keys for
12841 @code{gnus-buffer-configuration}:
12843 @code{group}, @code{summary}, @code{article}, @code{server},
12844 @code{browse}, @code{message}, @code{pick}, @code{info},
12845 @code{summary-faq}, @code{edit-group}, @code{edit-server},
12846 @code{edit-score}, @code{post}, @code{reply}, @code{forward},
12847 @code{reply-yank}, @code{mail-bounce}, @code{draft}, @code{pipe},
12848 @code{bug}, @code{compose-bounce}.
12850 Note that the @code{message} key is used for both
12851 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
12852 it is desirable to distinguish between the two, something like this
12856 (message (horizontal 1.0
12857 (vertical 1.0 (message 1.0 point))
12859 (if (buffer-live-p gnus-summary-buffer)
12864 @findex gnus-add-configuration
12865 Since the @code{gnus-buffer-configuration} variable is so long and
12866 complicated, there's a function you can use to ease changing the config
12867 of a single setting: @code{gnus-add-configuration}. If, for instance,
12868 you want to change the @code{article} setting, you could say:
12871 (gnus-add-configuration
12872 '(article (vertical 1.0
12874 (summary .25 point)
12878 You'd typically stick these @code{gnus-add-configuration} calls in your
12879 @file{.gnus.el} file or in some startup hook---they should be run after
12880 Gnus has been loaded.
12882 @vindex gnus-always-force-window-configuration
12883 If all windows mentioned in the configuration are already visible, Gnus
12884 won't change the window configuration. If you always want to force the
12885 ``right'' window configuration, you can set
12886 @code{gnus-always-force-window-configuration} to non-@code{nil}.
12890 @section Compilation
12891 @cindex compilation
12892 @cindex byte-compilation
12894 @findex gnus-compile
12896 Remember all those line format specification variables?
12897 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
12898 on. Now, Gnus will of course heed whatever these variables are, but,
12899 unfortunately, changing them will mean a quite significant slow-down.
12900 (The default values of these variables have byte-compiled functions
12901 associated with them, while the user-generated versions do not, of
12904 To help with this, you can run @kbd{M-x gnus-compile} after you've
12905 fiddled around with the variables and feel that you're (kind of)
12906 satisfied. This will result in the new specs being byte-compiled, and
12907 you'll get top speed again. Gnus will save these compiled specs in the
12908 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
12909 this function, though---you should compile them yourself by sticking
12910 them into the @code{.gnus.el} file and byte-compiling that file.)
12914 @section Mode Lines
12917 @vindex gnus-updated-mode-lines
12918 @code{gnus-updated-mode-lines} says what buffers should keep their mode
12919 lines updated. It is a list of symbols. Supported symbols include
12920 @code{group}, @code{article}, @code{summary}, @code{server},
12921 @code{browse}, and @code{tree}. If the corresponding symbol is present,
12922 Gnus will keep that mode line updated with information that may be
12923 pertinent. If this variable is @code{nil}, screen refresh may be
12926 @cindex display-time
12928 @vindex gnus-mode-non-string-length
12929 By default, Gnus displays information on the current article in the mode
12930 lines of the summary and article buffers. The information Gnus wishes
12931 to display (e.g. the subject of the article) is often longer than the
12932 mode lines, and therefore have to be cut off at some point. The
12933 @code{gnus-mode-non-string-length} variable says how long the other
12934 elements on the line is (i.e., the non-info part). If you put
12935 additional elements on the mode line (e.g. a clock), you should modify
12938 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
12940 (add-hook 'display-time-hook
12941 (lambda () (setq gnus-mode-non-string-length
12943 (if line-number-mode 5 0)
12944 (if column-number-mode 4 0)
12945 (length display-time-string)))))
12948 If this variable is @code{nil} (which is the default), the mode line
12949 strings won't be chopped off, and they won't be padded either.
12950 Note that the default is unlikely to be desirable, as even the
12951 percentage complete in the buffer may be crowded off the mode line;
12952 the user should configure this variable appropriately for their
12956 @node Highlighting and Menus
12957 @section Highlighting and Menus
12959 @cindex highlighting
12962 @vindex gnus-visual
12963 The @code{gnus-visual} variable controls most of the prettifying Gnus
12964 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
12965 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
12968 This variable can be a list of visual properties that are enabled. The
12969 following elements are legal, and are all included by default:
12972 @item group-highlight
12973 Do highlights in the group buffer.
12974 @item summary-highlight
12975 Do highlights in the summary buffer.
12976 @item article-highlight
12977 Do highlights in the article buffer.
12979 Turn on highlighting in all buffers.
12981 Create menus in the group buffer.
12983 Create menus in the summary buffers.
12985 Create menus in the article buffer.
12987 Create menus in the browse buffer.
12989 Create menus in the server buffer.
12991 Create menus in the score buffers.
12993 Create menus in all buffers.
12996 So if you only want highlighting in the article buffer and menus in all
12997 buffers, you could say something like:
13000 (setq gnus-visual '(article-highlight menu))
13003 If you want only highlighting and no menus whatsoever, you'd say:
13006 (setq gnus-visual '(highlight))
13009 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
13010 in all Gnus buffers.
13012 Other general variables that influence the look of all buffers include:
13015 @item gnus-mouse-face
13016 @vindex gnus-mouse-face
13017 This is the face (i.e., font) used for mouse highlighting in Gnus. No
13018 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
13022 There are hooks associated with the creation of all the different menus:
13026 @item gnus-article-menu-hook
13027 @vindex gnus-article-menu-hook
13028 Hook called after creating the article mode menu.
13030 @item gnus-group-menu-hook
13031 @vindex gnus-group-menu-hook
13032 Hook called after creating the group mode menu.
13034 @item gnus-summary-menu-hook
13035 @vindex gnus-summary-menu-hook
13036 Hook called after creating the summary mode menu.
13038 @item gnus-server-menu-hook
13039 @vindex gnus-server-menu-hook
13040 Hook called after creating the server mode menu.
13042 @item gnus-browse-menu-hook
13043 @vindex gnus-browse-menu-hook
13044 Hook called after creating the browse mode menu.
13046 @item gnus-score-menu-hook
13047 @vindex gnus-score-menu-hook
13048 Hook called after creating the score mode menu.
13059 Those new-fangled @dfn{mouse} contraptions is very popular with the
13060 young, hep kids who don't want to learn the proper way to do things
13061 these days. Why, I remember way back in the summer of '89, when I was
13062 using Emacs on a Tops 20 system. Three hundred users on one single
13063 machine, and every user was running Simula compilers. Bah!
13067 @vindex gnus-carpal
13068 Well, you can make Gnus display bufferfuls of buttons you can click to
13069 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
13070 really. Tell the chiropractor I sent you.
13075 @item gnus-carpal-mode-hook
13076 @vindex gnus-carpal-mode-hook
13077 Hook run in all carpal mode buffers.
13079 @item gnus-carpal-button-face
13080 @vindex gnus-carpal-button-face
13081 Face used on buttons.
13083 @item gnus-carpal-header-face
13084 @vindex gnus-carpal-header-face
13085 Face used on carpal buffer headers.
13087 @item gnus-carpal-group-buffer-buttons
13088 @vindex gnus-carpal-group-buffer-buttons
13089 Buttons in the group buffer.
13091 @item gnus-carpal-summary-buffer-buttons
13092 @vindex gnus-carpal-summary-buffer-buttons
13093 Buttons in the summary buffer.
13095 @item gnus-carpal-server-buffer-buttons
13096 @vindex gnus-carpal-server-buffer-buttons
13097 Buttons in the server buffer.
13099 @item gnus-carpal-browse-buffer-buttons
13100 @vindex gnus-carpal-browse-buffer-buttons
13101 Buttons in the browse buffer.
13104 All the @code{buttons} variables are lists. The elements in these list
13105 is either a cons cell where the car contains a text to be displayed and
13106 the cdr contains a function symbol, or a simple string.
13114 Gnus, being larger than any program ever written (allegedly), does lots
13115 of strange stuff that you may wish to have done while you're not
13116 present. For instance, you may want it to check for new mail once in a
13117 while. Or you may want it to close down all connections to all servers
13118 when you leave Emacs idle. And stuff like that.
13120 Gnus will let you do stuff like that by defining various
13121 @dfn{handlers}. Each handler consists of three elements: A
13122 @var{function}, a @var{time}, and an @var{idle} parameter.
13124 Here's an example of a handler that closes connections when Emacs has
13125 been idle for thirty minutes:
13128 (gnus-demon-close-connections nil 30)
13131 Here's a handler that scans for PGP headers every hour when Emacs is
13135 (gnus-demon-scan-pgp 60 t)
13138 This @var{time} parameter and than @var{idle} parameter work together
13139 in a strange, but wonderful fashion. Basically, if @var{idle} is
13140 @code{nil}, then the function will be called every @var{time} minutes.
13142 If @var{idle} is @code{t}, then the function will be called after
13143 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
13144 the function will never be called. But once Emacs goes idle, the
13145 function will be called every @var{time} minutes.
13147 If @var{idle} is a number and @var{time} is a number, the function will
13148 be called every @var{time} minutes only when Emacs has been idle for
13149 @var{idle} minutes.
13151 If @var{idle} is a number and @var{time} is @code{nil}, the function
13152 will be called once every time Emacs has been idle for @var{idle}
13155 And if @var{time} is a string, it should look like @samp{07:31}, and
13156 the function will then be called once every day somewhere near that
13157 time. Modified by the @var{idle} parameter, of course.
13159 @vindex gnus-demon-timestep
13160 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
13161 seconds. This is 60 by default. If you change that variable,
13162 all the timings in the handlers will be affected.)
13164 @vindex gnus-use-demon
13165 To set the whole thing in motion, though, you have to set
13166 @code{gnus-use-demon} to @code{t}.
13168 So, if you want to add a handler, you could put something like this in
13169 your @file{.gnus} file:
13171 @findex gnus-demon-add-handler
13173 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
13176 @findex gnus-demon-add-nocem
13177 @findex gnus-demon-add-scanmail
13178 @findex gnus-demon-add-rescan
13179 @findex gnus-demon-add-scan-timestamps
13180 @findex gnus-demon-add-disconnection
13181 Some ready-made functions to do this has been created:
13182 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
13183 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
13184 @code{gnus-demon-add-scanmail}. Just put those functions in your
13185 @file{.gnus} if you want those abilities.
13187 @findex gnus-demon-init
13188 @findex gnus-demon-cancel
13189 @vindex gnus-demon-handlers
13190 If you add handlers to @code{gnus-demon-handlers} directly, you should
13191 run @code{gnus-demon-init} to make the changes take hold. To cancel all
13192 daemons, you can use the @code{gnus-demon-cancel} function.
13194 Note that adding daemons can be pretty naughty if you overdo it. Adding
13195 functions that scan all news and mail from all servers every two seconds
13196 is a sure-fire way of getting booted off any respectable system. So
13205 @dfn{Spamming} is posting the same article lots and lots of times.
13206 Spamming is bad. Spamming is evil.
13208 Spamming is usually canceled within a day or so by various anti-spamming
13209 agencies. These agencies usually also send out @dfn{NoCeM} messages.
13210 NoCeM is pronounced ``no see-'em'', and means what the name
13211 implies---these are messages that make the offending articles, like, go
13214 What use are these NoCeM messages if the articles are canceled anyway?
13215 Some sites do not honor cancel messages and some sites just honor cancels
13216 from a select few people. Then you may wish to make use of the NoCeM
13217 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
13219 Gnus can read and parse the messages in this group automatically, and
13220 this will make spam disappear.
13222 There are some variables to customize, of course:
13225 @item gnus-use-nocem
13226 @vindex gnus-use-nocem
13227 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
13230 @item gnus-nocem-groups
13231 @vindex gnus-nocem-groups
13232 Gnus will look for NoCeM messages in the groups in this list. The
13233 default is @code{("news.lists.filters" "news.admin.net-abuse.bulletins"
13234 "alt.nocem.misc" "news.admin.net-abuse.announce")}.
13236 @item gnus-nocem-issuers
13237 @vindex gnus-nocem-issuers
13238 There are many people issuing NoCeM messages. This list says what
13239 people you want to listen to. The default is @code{("Automoose-1"
13240 "clewis@@ferret.ocunix.on.ca;" "jem@@xpat.com;" "red@@redpoll.mrfs.oh.us
13241 (Richard E. Depew)")}; fine, upstanding citizens all of them.
13243 Known despammers that you can put in this list include:
13246 @item clewis@@ferret.ocunix.on.ca;
13247 @cindex Chris Lewis
13248 Chris Lewis---Major Canadian despammer who has probably canceled more
13249 usenet abuse than anybody else.
13252 @cindex CancelMoose[tm]
13253 The CancelMoose[tm] on autopilot. The CancelMoose[tm] is reputed to be
13254 Norwegian, and was the person(s) who invented NoCeM.
13256 @item jem@@xpat.com;
13258 John Milburn---despammer located in Korea who is getting very busy these
13261 @item red@@redpoll.mrfs.oh.us (Richard E. Depew)
13262 Richard E. Depew---lone American despammer. He mostly cancels binary
13263 postings to non-binary groups and removes spews (regurgitated articles).
13266 You do not have to heed NoCeM messages from all these people---just the
13267 ones you want to listen to.
13269 @item gnus-nocem-verifyer
13270 @vindex gnus-nocem-verifyer
13272 This should be a function for verifying that the NoCeM issuer is who she
13273 says she is. The default is @code{mc-verify}, which is a Mailcrypt
13274 function. If this is too slow and you don't care for verification
13275 (which may be dangerous), you can set this variable to @code{nil}.
13277 If you want signed NoCeM messages to be verified and unsigned messages
13278 not to be verified (but used anyway), you could do something like:
13281 (setq gnus-nocem-verifyer 'my-gnus-mc-verify)
13283 (defun my-gnus-mc-verify ()
13291 This might be dangerous, though.
13293 @item gnus-nocem-directory
13294 @vindex gnus-nocem-directory
13295 This is where Gnus will store its NoCeM cache files. The default is
13296 @file{~/News/NoCeM/}.
13298 @item gnus-nocem-expiry-wait
13299 @vindex gnus-nocem-expiry-wait
13300 The number of days before removing old NoCeM entries from the cache.
13301 The default is 15. If you make it shorter Gnus will be faster, but you
13302 might then see old spam.
13306 Using NoCeM could potentially be a memory hog. If you have many living
13307 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
13308 big. If this is a problem, you should kill off all (or most) of your
13309 unsubscribed groups (@pxref{Subscription Commands}).
13317 \gnuspicon{tmp/picons-att.ps}
13318 \gnuspicon{tmp/picons-berkeley.ps}
13319 \gnuspicon{tmp/picons-caltech.ps}
13320 \gnuspicon{tmp/picons-canada.ps}
13321 \gnuspicon{tmp/picons-cr.ps}
13322 \gnuspicon{tmp/picons-cygnus.ps}
13323 \gnuspicon{tmp/picons-gov.ps}
13324 \gnuspicon{tmp/picons-mit.ps}
13325 \gnuspicon{tmp/picons-nasa.ps}
13326 \gnuspicon{tmp/picons-qmw.ps}
13327 \gnuspicon{tmp/picons-rms.ps}
13328 \gnuspicon{tmp/picons-ruu.ps}
13332 So... You want to slow down your news reader even more! This is a
13333 good way to do so. Its also a great way to impress people staring
13334 over your shoulder as you read news.
13337 * Picon Basics:: What are picons and How do I get them.
13338 * Picon Requirements:: Don't go further if you aren't using XEmacs.
13339 * Easy Picons:: Displaying Picons---the easy way.
13340 * Hard Picons:: The way you should do it. You'll learn something.
13341 * Picon Configuration:: Other variables you can trash/tweak/munge/play with.
13346 @subsection Picon Basics
13348 What are Picons? To quote directly from the Picons Web site:
13351 @dfn{Picons} is short for ``personal icons''. They're small,
13352 constrained images used to represent users and domains on the net,
13353 organized into databases so that the appropriate image for a given
13354 e-mail address can be found. Besides users and domains, there are picon
13355 databases for Usenet newsgroups and weather forecasts. The picons are
13356 in either monochrome @code{XBM} format or color @code{XPM} and
13357 @code{GIF} formats.
13360 For instructions on obtaining and installing the picons databases, point
13361 your Web browser at
13362 @file{http://www.cs.indiana.edu/picons/ftp/index.html}.
13364 @vindex gnus-picons-database
13365 Gnus expects picons to be installed into a location pointed to by
13366 @code{gnus-picons-database}.
13369 @node Picon Requirements
13370 @subsection Picon Requirements
13372 To use have Gnus display Picons for you, you must be running XEmacs
13373 19.13 or greater since all other versions of Emacs aren't yet able to
13376 Additionally, you must have @code{xpm} support compiled into XEmacs.
13378 @vindex gnus-picons-convert-x-face
13379 If you want to display faces from @code{X-Face} headers, you must have
13380 the @code{netpbm} utilities installed, or munge the
13381 @code{gnus-picons-convert-x-face} variable to use something else.
13385 @subsection Easy Picons
13387 To enable displaying picons, simply put the following line in your
13388 @file{~/.gnus} file and start Gnus.
13391 (setq gnus-use-picons t)
13392 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13393 (add-hook 'gnus-summary-prepare-hook 'gnus-group-display-picons t)
13394 (add-hook 'gnus-article-display-hook 'gnus-picons-article-display-x-face)
13399 @subsection Hard Picons
13401 Gnus can display picons for you as you enter and leave groups and
13402 articles. It knows how to interact with three sections of the picons
13403 database. Namely, it can display the picons newsgroup pictures,
13404 author's face picture(s), and the authors domain. To enable this
13405 feature, you need to first decide where to display them.
13409 @item gnus-picons-display-where
13410 @vindex gnus-picons-display-where
13411 Where the picon images should be displayed. It is @code{picons} by
13412 default (which by default maps to the buffer @samp{*Picons*}). Other
13413 valid places could be @code{article}, @code{summary}, or
13414 @samp{*scratch*} for all I care. Just make sure that you've made the
13415 buffer visible using the standard Gnus window configuration
13416 routines---@pxref{Windows Configuration}.
13422 \gnuspicon{tmp/picons-seuu.ps}
13423 \gnuspicon{tmp/picons-stanford.ps}
13424 \gnuspicon{tmp/picons-sun.ps}
13425 \gnuspicon{tmp/picons-ubc.ps}
13426 \gnuspicon{tmp/picons-ufl.ps}
13427 \gnuspicon{tmp/picons-uio.ps}
13428 \gnuspicon{tmp/picons-unit.ps}
13429 \gnuspicon{tmp/picons-upenn.ps}
13430 \gnuspicon{tmp/picons-wesleyan.ps}
13434 Note: If you set @code{gnus-use-picons} to @code{t}, it will set up your
13435 window configuration for you to include the @code{picons} buffer.
13437 Now that you've made that decision, you need to add the following
13438 functions to the appropriate hooks so these pictures will get
13439 displayed at the right time.
13441 @vindex gnus-article-display-hook
13442 @vindex gnus-picons-display-where
13444 @item gnus-article-display-picons
13445 @findex gnus-article-display-picons
13446 Looks up and display the picons for the author and the author's domain
13447 in the @code{gnus-picons-display-where} buffer. Should be added to
13448 the @code{gnus-article-display-hook}.
13450 @item gnus-group-display-picons
13451 @findex gnus-article-display-picons
13452 Displays picons representing the current group. This function should
13453 be added to the @code{gnus-summary-prepare-hook} or to the
13454 @code{gnus-article-display-hook} if @code{gnus-picons-display-where}
13455 is set to @code{article}.
13457 @item gnus-picons-article-display-x-face
13458 @findex gnus-article-display-picons
13459 Decodes and displays the X-Face header if present. This function
13460 should be added to @code{gnus-article-display-hook}.
13464 Note: You must append them to the hook, so make sure to specify 't'
13465 to the append flag of @code{add-hook}:
13468 (add-hook 'gnus-article-display-hook 'gnus-article-display-picons t)
13472 @node Picon Configuration
13473 @subsection Picon Configuration
13475 The following variables offer further control over how things are
13476 done, where things are located, and other useless stuff you really
13477 don't need to worry about.
13480 @item gnus-picons-database
13481 @vindex gnus-picons-database
13482 The location of the picons database. Should point to a directory
13483 containing the @file{news}, @file{domains}, @file{users} (and so on)
13484 subdirectories. Defaults to @file{/usr/local/faces}.
13486 @item gnus-picons-news-directory
13487 @vindex gnus-picons-news-directory
13488 Sub-directory of the faces database containing the icons for
13491 @item gnus-picons-user-directories
13492 @vindex gnus-picons-user-directories
13493 List of subdirectories to search in @code{gnus-picons-database} for user
13494 faces. @code{("local" "users" "usenix" "misc/MISC")} is the default.
13496 @item gnus-picons-domain-directories
13497 @vindex gnus-picons-domain-directories
13498 List of subdirectories to search in @code{gnus-picons-database} for
13499 domain name faces. Defaults to @code{("domains")}. Some people may
13500 want to add @samp{unknown} to this list.
13502 @item gnus-picons-convert-x-face
13503 @vindex gnus-picons-convert-x-face
13504 The command to use to convert the @code{X-Face} header to an X bitmap
13505 (@code{xbm}). Defaults to @code{(format "@{ echo '/* Width=48,
13506 Height=48 */'; uncompface; @} | icontopbm | pbmtoxbm > %s"
13507 gnus-picons-x-face-file-name)}
13509 @item gnus-picons-x-face-file-name
13510 @vindex gnus-picons-x-face-file-name
13511 Names a temporary file to store the @code{X-Face} bitmap in. Defaults
13512 to @code{(format "/tmp/picon-xface.%s.xbm" (user-login-name))}.
13514 @item gnus-picons-buffer
13515 @vindex gnus-picons-buffer
13516 The name of the buffer that @code{picons} points to. Defaults to
13517 @samp{*Icon Buffer*}.
13526 It is very useful to be able to undo actions one has done. In normal
13527 Emacs buffers, it's easy enough---you just push the @code{undo} button.
13528 In Gnus buffers, however, it isn't that simple.
13530 The things Gnus displays in its buffer is of no value whatsoever to
13531 Gnus---it's all just data that is designed to look nice to the user.
13532 Killing a group in the group buffer with @kbd{C-k} makes the line
13533 disappear, but that's just a side-effect of the real action---the
13534 removal of the group in question from the internal Gnus structures.
13535 Undoing something like that can't be done by the normal Emacs
13536 @code{undo} function.
13538 Gnus tries to remedy this somewhat by keeping track of what the user
13539 does and coming up with actions that would reverse the actions the user
13540 takes. When the user then presses the @code{undo} key, Gnus will run
13541 the code to reverse the previous action, or the previous actions.
13542 However, not all actions are easily reversible, so Gnus currently offers
13543 a few key functions to be undoable. These include killing groups,
13544 yanking groups, and changing the list of read articles of groups.
13545 That's it, really. More functions may be added in the future, but each
13546 added function means an increase in data to be stored, so Gnus will
13547 never be totally undoable.
13549 @findex gnus-undo-mode
13550 @vindex gnus-use-undo
13552 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
13553 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
13554 default. The @kbd{M-C-_} key performs the @code{gnus-undo} command
13555 command, which should feel kinda like the normal Emacs @code{undo}
13560 @section Moderation
13563 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
13564 It is not included in the standard Gnus package. Write a mail to
13565 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
13568 The moderation package is implemented as a minor mode for summary
13572 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
13575 in your @file{.gnus.el} file.
13577 If you are the moderation of @samp{rec.zoofle}, this is how it's
13582 You split your incoming mail by matching on
13583 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
13584 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
13587 You enter that group once in a while and post articles using the @kbd{e}
13588 (edit-and-post) or @kbd{s} (just send unedited) commands.
13591 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
13592 articles that weren't approved by you, you can cancel them with the
13596 To use moderation mode in these two groups, say:
13599 (setq gnus-moderated-list
13600 "^nnml:rec.zoofle$\\|^rec.zoofle$")
13604 @node XEmacs Enhancements
13605 @section XEmacs Enhancements
13608 XEmacs is able to display pictures and stuff, so Gnus has taken
13609 advantage of that. Relevant variables include:
13612 @item gnus-xmas-glyph-directory
13613 @vindex gnus-xmas-glyph-directory
13614 This is where Gnus will look for pictures. Gnus will normally
13615 auto-detect this directory, but you may set it manually if you have an
13616 unusual directory structure.
13618 @item gnus-xmas-logo-color-alist
13619 @vindex gnus-xmas-logo-color-alist
13620 This is an alist where the key is a type symbol and the values are the
13621 foreground and background color of the splash page glyph.
13623 @item gnus-xmas-logo-color-style
13624 @vindex gnus-xmas-logo-color-style
13625 This is the key used to look up the color in the alist described above.
13626 Legal values include @code{flame}, @code{pine}, @code{moss},
13627 @code{irish}, @code{sky}, @code{tin}, @code{velvet}, @code{grape},
13628 @code{labia}, @code{berry}, @code{neutral}, and @code{september}.
13630 @item gnus-use-toolbar
13631 @vindex gnus-use-toolbar
13632 If @code{nil}, don't display toolbars. If non-@code{nil}, it should be
13633 one of @code{default-toolbar}, @code{top-toolbar}, @code{bottom-toolbar},
13634 @code{right-toolbar}, or @code{left-toolbar}.
13636 @item gnus-group-toolbar
13637 @vindex gnus-group-toolbar
13638 The toolbar in the group buffer.
13640 @item gnus-summary-toolbar
13641 @vindex gnus-summary-toolbar
13642 The toolbar in the summary buffer.
13644 @item gnus-summary-mail-toolbar
13645 @vindex gnus-summary-mail-toolbar
13646 The toolbar in the summary buffer of mail groups.
13648 @item gnus-xmas-modeline-glyph
13649 @vindex gnus-xmas-modeline-glyph
13650 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
13656 @node Fuzzy Matching
13657 @section Fuzzy Matching
13658 @cindex fuzzy matching
13660 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
13661 things like scoring, thread gathering and thread comparison.
13663 As opposed to regular expression matching, fuzzy matching is very fuzzy.
13664 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
13665 means, and the implementation has changed over time.
13667 Basically, it tries to remove all noise from lines before comparing.
13668 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
13669 out of the strings before comparing the results. This often leads to
13670 adequate results---even when faced with strings generated by text
13671 manglers masquerading as newsreaders.
13674 @node Thwarting Email Spam
13675 @section Thwarting Email Spam
13679 @cindex unsolicited commercial email
13681 In these last days of the Usenet, commercial vultures are hanging about
13682 and grepping through news like crazy to find email addresses they can
13683 foist off their scams and products to. As a reaction to this, many
13684 people have started putting nonsense addresses into their @code{From}
13685 lines. I think this is counterproductive---it makes it difficult for
13686 people to send you legitimate mail in response to things you write, as
13687 well as making it difficult to see who wrote what. This rewriting may
13688 perhaps be a bigger menace than the unsolicited commercial email itself
13691 The biggest problem I have with email spam is that it comes in under
13692 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
13693 have 10 new emails. I say ``Golly gee! Happy is me!'' and selects the
13694 mail group, only to find two pyramid schemes, seven advertisements
13695 (``New! Miracle tonic for growing full, lustrouos hair on your toes!'')
13696 and one mail asking me to repent and find some god.
13700 The way to deal with this is having Gnus split out all spam into a
13701 @samp{spam} mail group (@pxref{Splitting Mail}).
13703 First, pick one (1) legal mail address that you can be reached at, and
13704 put it in your @code{From} header of all your news articles. (I've
13705 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
13706 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
13707 sysadm whether your sendmail installation accepts keywords in the local
13708 part of the mail address.)
13711 (setq message-default-news-headers
13712 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
13715 Then put the following split rule in @code{nnmail-split-fancy}
13716 (@pxref{Fancy Mail Splitting}):
13721 (to "larsi@@trym.ifi.uio.no"
13722 (| ("subject" "re:.*" "misc")
13723 ("references" ".*@@.*" "misc")
13729 This says that all mail to this address is suspect, but if it has a
13730 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
13731 header, it's probably ok. All the rest goes to the @samp{spam} group.
13732 (This idea probably comes from Tim Pierce.)
13734 In addition, many mail spammers talk directly to your @code{smtp} server
13735 and do not include your email address explicitly in the @code{To}
13736 header. Why they do this is unknown---perhaps it's to thwart this
13737 twarting scheme? In any case, this is trivial to deal with---you just
13738 put anything not addressed to you in the @samp{spam} group by ending
13739 your fancy split rule in this way:
13744 (to "larsi" "misc")
13748 In my experience, this will sort virtually everything into the right
13749 group. You still have to check the @samp{spam} group from time to time to
13750 check for legitimate mail, though. If you feel like being a good net
13751 citizen, you can even send off complaints to the proper authorities on
13752 each unsolicited commercial email---at your leisure.
13754 If you are also a lazy net citizen, you will probably prefer complaining
13755 automatically with the @file{gnus-junk.el} package, availiable FOR FREE
13756 at @file{<URL:http://stud2.tuwien.ac.at/~e9426626/gnus-junk.html>}.
13757 Since most e-mail spam is sent automatically, this may reconcile the
13758 cosmic balance somewhat.
13760 This works for me. It allows people an easy way to contact me (they can
13761 just press @kbd{r} in the usual way), and I'm not bothered at all with
13762 spam. It's a win-win situation. Forging @code{From} headers to point
13763 to non-existant domains is yucky, in my opinion.
13766 @node Various Various
13767 @section Various Various
13773 @item gnus-home-directory
13774 All Gnus path variables will be initialized from this variable, which
13775 defaults to @file{~/}.
13777 @item gnus-directory
13778 @vindex gnus-directory
13779 Most Gnus storage path variables will be initialized from this variable,
13780 which defaults to the @samp{SAVEDIR} environment variable, or
13781 @file{~/News/} if that variable isn't set.
13783 @item gnus-default-directory
13784 @vindex gnus-default-directory
13785 Not related to the above variable at all---this variable says what the
13786 default directory of all Gnus buffers should be. If you issue commands
13787 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
13788 default directory. If this variable is @code{nil} (which is the
13789 default), the default directory will be the default directory of the
13790 buffer you were in when you started Gnus.
13793 @vindex gnus-verbose
13794 This variable is an integer between zero and ten. The higher the value,
13795 the more messages will be displayed. If this variable is zero, Gnus
13796 will never flash any messages, if it is seven (which is the default),
13797 most important messages will be shown, and if it is ten, Gnus won't ever
13798 shut up, but will flash so many messages it will make your head swim.
13800 @item gnus-verbose-backends
13801 @vindex gnus-verbose-backends
13802 This variable works the same way as @code{gnus-verbose}, but it applies
13803 to the Gnus backends instead of Gnus proper.
13805 @item nnheader-max-head-length
13806 @vindex nnheader-max-head-length
13807 When the backends read straight heads of articles, they all try to read
13808 as little as possible. This variable (default 4096) specifies
13809 the absolute max length the backends will try to read before giving up
13810 on finding a separator line between the head and the body. If this
13811 variable is @code{nil}, there is no upper read bound. If it is
13812 @code{t}, the backends won't try to read the articles piece by piece,
13813 but read the entire articles. This makes sense with some versions of
13816 @item nnheader-head-chop-length
13817 @vindex nnheader-head-chop-length
13818 This variable says how big a piece of each article to read when doing
13819 the operation described above.
13821 @item nnheader-file-name-translation-alist
13822 @vindex nnheader-file-name-translation-alist
13824 @cindex illegal characters in file names
13825 @cindex characters in file names
13826 This is an alist that says how to translate characters in file names.
13827 For instance, if @samp{:} is illegal as a file character in file names
13828 on your system (you OS/2 user you), you could say something like:
13831 (setq nnheader-file-name-translation-alist
13835 In fact, this is the default value for this variable on OS/2 and MS
13836 Windows (phooey) systems.
13838 @item gnus-hidden-properties
13839 @vindex gnus-hidden-properties
13840 This is a list of properties to use to hide ``invisible'' text. It is
13841 @code{(invisible t intangible t)} by default on most systems, which
13842 makes invisible text invisible and intangible.
13844 @item gnus-parse-headers-hook
13845 @vindex gnus-parse-headers-hook
13846 A hook called before parsing headers. It can be used, for instance, to
13847 gather statistics on the headers fetched, or perhaps you'd like to prune
13848 some headers. I don't see why you'd want that, though.
13850 @item gnus-shell-command-separator
13851 @vindex gnus-shell-command-separator
13852 String used to separate to shell commands. The default is @samp{;}.
13861 Well, that's the manual---you can get on with your life now. Keep in
13862 touch. Say hello to your cats from me.
13864 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
13866 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
13872 Not because of victories @*
13875 but for the common sunshine,@*
13877 the largess of the spring.
13881 but for the day's work done@*
13882 as well as I was able;@*
13883 not for a seat upon the dais@*
13884 but at the common table.@*
13889 @chapter Appendices
13892 * History:: How Gnus got where it is today.
13893 * Terminology:: We use really difficult, like, words here.
13894 * Customization:: Tailoring Gnus to your needs.
13895 * Troubleshooting:: What you might try if things do not work.
13896 * A Programmers Guide to Gnus:: Rilly, rilly technical stuff.
13897 * Emacs for Heathens:: A short introduction to Emacsian terms.
13898 * Frequently Asked Questions:: A question-and-answer session.
13906 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
13907 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
13909 If you want to investigate the person responsible for this outrage, you
13910 can point your (feh!) web browser to
13911 @file{http://www.ifi.uio.no/~larsi/}. This is also the primary
13912 distribution point for the new and spiffy versions of Gnus, and is known
13913 as The Site That Destroys Newsrcs And Drives People Mad.
13915 During the first extended alpha period of development, the new Gnus was
13916 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
13917 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
13918 (Besides, the ``Gnus'' in this abbreviation should probably be
13919 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
13920 appropriate name, don't you think?)
13922 In any case, after spending all that energy on coming up with a new and
13923 spunky name, we decided that the name was @emph{too} spunky, so we
13924 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
13925 ``@sc{gnus}''. New vs. old.
13927 The first ``proper'' release of Gnus 5 was done in November 1995 when it
13928 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
13929 plus 15 Gnus 5.0 releases).
13931 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
13932 releases)) was released under the name ``Gnus 5.2'' (40 releases).
13934 On July 28th 1996 work on Red Gnus was begun, and it was released on
13935 January 25th 1997 (after 84 releases) as ``Gnus 5.4''.
13937 If you happen upon a version of Gnus that has a name that is prefixed --
13938 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'' --
13939 don't panic. Don't let it know that you're frightened. Back away.
13940 Slowly. Whatever you do, don't run. Walk away, calmly, until you're
13941 out of its reach. Find a proper released version of Gnus and snuggle up
13945 * Why?:: What's the point of Gnus?
13946 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
13947 * Conformity:: Gnus tries to conform to all standards.
13948 * Emacsen:: Gnus can be run on a few modern Emacsen.
13949 * Contributors:: Oodles of people.
13950 * New Features:: Pointers to some of the new stuff in Gnus.
13951 * Newest Features:: Features so new that they haven't been written yet.
13958 What's the point of Gnus?
13960 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
13961 newsreader, that lets you do anything you can think of. That was my
13962 original motivation, but while working on Gnus, it has become clear to
13963 me that this generation of newsreaders really belong in the stone age.
13964 Newsreaders haven't developed much since the infancy of the net. If the
13965 volume continues to rise with the current rate of increase, all current
13966 newsreaders will be pretty much useless. How do you deal with
13967 newsgroups that have thousands of new articles each day? How do you
13968 keep track of millions of people who post?
13970 Gnus offers no real solutions to these questions, but I would very much
13971 like to see Gnus being used as a testing ground for new methods of
13972 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
13973 to separate the newsreader from the backends, Gnus now offers a simple
13974 interface for anybody who wants to write new backends for fetching mail
13975 and news from different sources. I have added hooks for customizations
13976 everywhere I could imagine useful. By doing so, I'm inviting every one
13977 of you to explore and invent.
13979 May Gnus never be complete. @kbd{C-u 100 M-x hail-emacs}.
13982 @node Compatibility
13983 @subsection Compatibility
13985 @cindex compatibility
13986 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
13987 bindings have been kept. More key bindings have been added, of course,
13988 but only in one or two obscure cases have old bindings been changed.
13993 @center In a cloud bones of steel.
13997 All commands have kept their names. Some internal functions have changed
14000 The @code{gnus-uu} package has changed drastically. @pxref{Decoding
14003 One major compatibility question is the presence of several summary
14004 buffers. All variables that are relevant while reading a group are
14005 buffer-local to the summary buffer they belong in. Although many
14006 important variables have their values copied into their global
14007 counterparts whenever a command is executed in the summary buffer, this
14008 change might lead to incorrect values being used unless you are careful.
14010 All code that relies on knowledge of @sc{gnus} internals will probably
14011 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
14012 changing it in any way, as a matter of fact) is strictly verboten. Gnus
14013 maintains a hash table that points to the entries in this alist (which
14014 speeds up many functions), and changing the alist directly will lead to
14018 @cindex highlighting
14019 Old hilit19 code does not work at all. In fact, you should probably
14020 remove all hilit code from all Gnus hooks
14021 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
14022 Gnus provides various integrated functions for highlighting. These are
14023 faster and more accurate. To make life easier for everybody, Gnus will
14024 by default remove all hilit calls from all hilit hooks. Uncleanliness!
14027 Packages like @code{expire-kill} will no longer work. As a matter of
14028 fact, you should probably remove all old @sc{gnus} packages (and other
14029 code) when you start using Gnus. More likely than not, Gnus already
14030 does what you have written code to make @sc{gnus} do. (Snicker.)
14032 Even though old methods of doing things are still supported, only the
14033 new methods are documented in this manual. If you detect a new method of
14034 doing something while reading this manual, that does not mean you have
14035 to stop doing it the old way.
14037 Gnus understands all @sc{gnus} startup files.
14039 @kindex M-x gnus-bug
14041 @cindex reporting bugs
14043 Overall, a casual user who hasn't written much code that depends on
14044 @sc{gnus} internals should suffer no problems. If problems occur,
14045 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
14049 @subsection Conformity
14051 No rebels without a clue here, ma'am. We conform to all standards known
14052 to (wo)man. Except for those standards and/or conventions we disagree
14059 There are no known breaches of this standard.
14063 There are no known breaches of this standard, either.
14065 @item Good Net-Keeping Seal of Approval
14066 @cindex Good Net-Keeping Seal of Approval
14067 Gnus has been through the Seal process and failed. I think it'll pass
14068 the next inspection.
14070 @item Son-of-RFC 1036
14071 @cindex Son-of-RFC 1036
14072 We do have some breaches to this one.
14077 Gnus does no MIME handling, and this standard-to-be seems to think that
14078 MIME is the bees' knees, so we have major breakage here.
14081 This is considered to be a ``vanity header'', while I consider it to be
14082 consumer information. After seeing so many badly formatted articles
14083 coming from @code{tin} and @code{Netscape} I know not to use either of
14084 those for posting articles. I would not have known that if it wasn't
14085 for the @code{X-Newsreader} header.
14090 If you ever notice Gnus acting non-compliantly with regards to the texts
14091 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
14096 @subsection Emacsen
14102 Gnus should work on :
14107 Emacs 19.32 and up.
14110 XEmacs 19.14 and up.
14113 Mule versions based on Emacs 19.32 and up.
14117 Gnus will absolutely not work on any Emacsen older than that. Not
14118 reliably, at least.
14120 There are some vague differences between Gnus on the various
14121 platforms---XEmacs features more graphics (a logo and a toolbar)---but
14122 other than that, things should look pretty much the same under all
14127 @subsection Contributors
14128 @cindex contributors
14130 The new Gnus version couldn't have been done without the help of all the
14131 people on the (ding) mailing list. Every day for over a year I have
14132 gotten billions of nice bug reports from them, filling me with joy,
14133 every single one of them. Smooches. The people on the list have been
14134 tried beyond endurance, what with my ``oh, that's a neat idea <type
14135 type>, yup, I'll release it right away <ship off> no wait, that doesn't
14136 work at all <type type>, yup, I'll ship that one off right away <ship
14137 off> no, wait, that absolutely does not work'' policy for releases.
14138 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
14139 ``worser''? ``much worser''? ``worsest''?)
14141 I would like to take this opportunity to thank the Academy for... oops,
14147 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
14150 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
14151 well as numerous other things).
14154 Luis Fernandes---design and graphics.
14157 Erik Naggum---help, ideas, support, code and stuff.
14160 Wes Hardaker---@file{gnus-picon.el} and the manual section on
14161 @dfn{picons} (@pxref{Picons}).
14164 Kim-Minh Kaplan---further work on the picon code.
14167 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section
14168 (@pxref{GroupLens}).
14171 Sudish Joseph---innumerable bug fixes.
14174 Ilja Weis---@file{gnus-topic.el}.
14177 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
14180 Vladimir Alexiev---the refcard and reference booklets.
14183 Felix Lee & Jamie Zawinsky---I stole some pieces from the XGnus
14184 distribution by Felix Lee and JWZ.
14187 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
14190 Peter Mutsaers---orphan article scoring code.
14193 Ken Raeburn---POP mail support.
14196 Hallvard B Furuseth---various bits and pieces, especially dealing with
14200 Brian Edmonds---@file{gnus-bbdb.el}.
14203 David Moore---rewrite of @file{nnvirtual.el} and many other things.
14206 Ricardo Nassif, Mark Borges, and Jost Krieger---proof-reading.
14209 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
14212 François Pinard---many, many interesting and thorough bug reports.
14216 The following people have contributed many patches and suggestions:
14225 Jason L. Tibbitts, III,
14229 Also thanks to the following for patches and stuff:
14244 Massimo Campostrini,
14249 Geoffrey T. Dairiki,
14254 Michael Welsh Duggan,
14261 Arne Georg Gleditsch,
14266 Hisashige Kenji, @c Hisashige
14270 François Felix Ingrand,
14271 Ishikawa Ichiro, @c Ishikawa
14278 Peter Skov Knudsen,
14279 Shuhei Kobayashi, @c Kobayashi
14280 Thor Kristoffersen,
14295 Morioka Tomohiko, @c Morioka
14296 Erik Toubro Nielsen,
14302 Masaharu Onishi, @c Onishi
14307 John McClary Prevost,
14315 Philippe Schnoebelen,
14316 Randal L. Schwartz,
14337 Katsumi Yamaoka. @c Yamaoka
14339 For a full overview of what each person has done, the ChangeLogs
14340 included in the Gnus alpha distributions should give ample reading
14341 (550kB and counting).
14343 Apologies to everybody that I've forgotten, of which there are many, I'm
14346 Gee, that's quite a list of people. I guess that must mean that there
14347 actually are people who are using Gnus. Who'd'a thunk it!
14351 @subsection New Features
14352 @cindex new features
14355 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
14356 * September Gnus:: The Thing Formally Known As Gnus 5.3/5.3.
14357 * Red Gnus:: Third time best---Gnus 5.4/5.5.
14360 These lists are, of course, just @emph{short} overviews of the
14361 @emph{most} important new features. No, really. There are tons more.
14362 Yes, we have feeping creaturism in full effect.
14366 @subsubsection (ding) Gnus
14368 New features in Gnus 5.0/5.1:
14373 The look of all buffers can be changed by setting format-like variables
14374 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
14377 Local spool and several @sc{nntp} servers can be used at once
14378 (@pxref{Select Methods}).
14381 You can combine groups into virtual groups (@pxref{Virtual Groups}).
14384 You can read a number of different mail formats (@pxref{Getting Mail}).
14385 All the mail backends implement a convenient mail expiry scheme
14386 (@pxref{Expiring Mail}).
14389 Gnus can use various strategies for gathering threads that have lost
14390 their roots (thereby gathering loose sub-threads into one thread) or it
14391 can go back and retrieve enough headers to build a complete thread
14392 (@pxref{Customizing Threading}).
14395 Killed groups can be displayed in the group buffer, and you can read
14396 them as well (@pxref{Listing Groups}).
14399 Gnus can do partial group updates---you do not have to retrieve the
14400 entire active file just to check for new articles in a few groups
14401 (@pxref{The Active File}).
14404 Gnus implements a sliding scale of subscribedness to groups
14405 (@pxref{Group Levels}).
14408 You can score articles according to any number of criteria
14409 (@pxref{Scoring}). You can even get Gnus to find out how to score
14410 articles for you (@pxref{Adaptive Scoring}).
14413 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
14414 manner, so it should be difficult to lose much data on what you have
14415 read if your machine should go down (@pxref{Auto Save}).
14418 Gnus now has its own startup file (@file{.gnus}) to avoid cluttering up
14419 the @file{.emacs} file.
14422 You can set the process mark on both groups and articles and perform
14423 operations on all the marked items (@pxref{Process/Prefix}).
14426 You can grep through a subset of groups and create a group from the
14427 results (@pxref{Kibozed Groups}).
14430 You can list subsets of groups according to, well, anything
14431 (@pxref{Listing Groups}).
14434 You can browse foreign servers and subscribe to groups from those
14435 servers (@pxref{Browse Foreign Server}).
14438 Gnus can fetch articles asynchronously on a second connection to the
14439 server (@pxref{Asynchronous Fetching}).
14442 You can cache articles locally (@pxref{Article Caching}).
14445 The uudecode functions have been expanded and generalized
14446 (@pxref{Decoding Articles}).
14449 You can still post uuencoded articles, which was a little-known feature
14450 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
14453 Fetching parents (and other articles) now actually works without
14454 glitches (@pxref{Finding the Parent}).
14457 Gnus can fetch FAQs and group descriptions (@pxref{Group Information}).
14460 Digests (and other files) can be used as the basis for groups
14461 (@pxref{Document Groups}).
14464 Articles can be highlighted and customized (@pxref{Customizing
14468 URLs and other external references can be buttonized (@pxref{Article
14472 You can do lots of strange stuff with the Gnus window & frame
14473 configuration (@pxref{Windows Configuration}).
14476 You can click on buttons instead of using the keyboard
14482 @node September Gnus
14483 @subsubsection September Gnus
14485 New features in Gnus 5.2/5.3:
14490 A new message composition mode is used. All old customization variables
14491 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
14495 Gnus is now able to generate @dfn{sparse} threads---threads where
14496 missing articles are represented by empty nodes (@pxref{Customizing
14500 (setq gnus-build-sparse-threads 'some)
14504 Outgoing articles are stored on a special archive server
14505 (@pxref{Archived Messages}).
14508 Partial thread regeneration now happens when articles are
14512 Gnus can make use of GroupLens predictions (@pxref{GroupLens}).
14515 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
14518 A @code{trn}-line tree buffer can be displayed (@pxref{Tree Display}).
14521 (setq gnus-use-trees t)
14525 An @code{nn}-like pick-and-read minor mode is available for the summary
14526 buffers (@pxref{Pick and Read}).
14529 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
14533 In binary groups you can use a special binary minor mode (@pxref{Binary
14537 Groups can be grouped in a folding topic hierarchy (@pxref{Group
14541 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
14545 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
14548 Groups can now have a score, and bubbling based on entry frequency
14549 is possible (@pxref{Group Score}).
14552 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
14556 Groups can be process-marked, and commands can be performed on
14557 groups of groups (@pxref{Marking Groups}).
14560 Caching is possible in virtual groups.
14563 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
14564 news batches, ClariNet briefs collections, and just about everything
14565 else (@pxref{Document Groups}).
14568 Gnus has a new backend (@code{nnsoup}) to create/read SOUP packets
14572 The Gnus cache is much faster.
14575 Groups can be sorted according to many criteria (@pxref{Sorting
14579 New group parameters have been introduced to set list-address and
14580 expiry times (@pxref{Group Parameters}).
14583 All formatting specs allow specifying faces to be used
14584 (@pxref{Formatting Fonts}).
14587 There are several more commands for setting/removing/acting on process
14588 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
14591 The summary buffer can be limited to show parts of the available
14592 articles based on a wide range of criteria. These commands have been
14593 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
14596 Articles can be made persistent with the @kbd{*} command
14597 (@pxref{Persistent Articles}).
14600 All functions for hiding article elements are now toggles.
14603 Article headers can be buttonized (@pxref{Article Washing}).
14606 (add-hook 'gnus-article-display-hook
14607 'gnus-article-add-buttons-to-head)
14611 All mail backends support fetching articles by @code{Message-ID}.
14614 Duplicate mail can now be treated properly (@pxref{Duplicates}).
14617 All summary mode commands are available directly from the article
14618 buffer (@pxref{Article Keymap}).
14621 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Windows
14625 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
14628 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
14631 (setq gnus-use-nocem t)
14635 Groups can be made permanently visible (@pxref{Listing Groups}).
14638 (setq gnus-permanently-visible-groups "^nnml:")
14642 Many new hooks have been introduced to make customizing easier.
14645 Gnus respects the @code{Mail-Copies-To} header.
14648 Threads can be gathered by looking at the @code{References} header
14649 (@pxref{Customizing Threading}).
14652 (setq gnus-summary-thread-gathering-function
14653 'gnus-gather-threads-by-references)
14657 Read articles can be stored in a special backlog buffer to avoid
14658 refetching (@pxref{Article Backlog}).
14661 (setq gnus-keep-backlog 50)
14665 A clean copy of the current article is always stored in a separate
14666 buffer to allow easier treatment.
14669 Gnus can suggest where to save articles (@pxref{Saving Articles}).
14672 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
14676 (setq gnus-prompt-before-saving t)
14680 @code{gnus-uu} can view decoded files asynchronously while fetching
14681 articles (@pxref{Other Decode Variables}).
14684 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
14688 Filling in the article buffer now works properly on cited text
14689 (@pxref{Article Washing}).
14692 Hiding cited text adds buttons to toggle hiding, and how much
14693 cited text to hide is now customizable (@pxref{Article Hiding}).
14696 (setq gnus-cited-lines-visible 2)
14700 Boring headers can be hidden (@pxref{Article Hiding}).
14703 (add-hook 'gnus-article-display-hook
14704 'gnus-article-hide-boring-headers t)
14708 Default scoring values can now be set from the menu bar.
14711 Further syntax checking of outgoing articles have been added.
14717 @subsubsection Red Gnus
14719 New features in Gnus 5.4/5.5:
14724 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
14727 Article prefetching functionality has been moved up into
14728 Gnus (@pxref{Asynchronous Fetching}).
14731 Scoring can now be performed with logical operators like @code{and},
14732 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
14736 Article washing status can be displayed in the
14737 article mode line (@pxref{Misc Article}).
14740 @file{gnus.el} has been split into many smaller files.
14743 Suppression of duplicate articles based on Message-ID can be done
14744 (@pxref{Duplicate Suppression}).
14747 (setq gnus-suppress-duplicates t)
14751 New variables for specifying what score and adapt files are to be
14752 considered home score and adapt files (@pxref{Home Score File}).
14755 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
14756 Server Internals}).
14759 Groups can inherit group parameters from parent topics (@pxref{Topic
14763 Article editing has been revamped and is now actually usable.
14766 Signatures can be recognized in more intelligent fashions
14767 (@pxref{Article Signature}).
14770 Summary pick mode has been made to look more @code{nn}-like. Line
14771 numbers are displayed and the @kbd{.} command can be used to pick
14772 articles (@code{Pick and Read}).
14775 Commands for moving the @file{.newsrc.eld} from one server to
14776 another have been added (@pxref{Changing Servers}).
14779 A way to specify that ``uninteresting'' fields be suppressed when
14780 generating lines in buffers (@pxref{Advanced Formatting}).
14783 Several commands in the group buffer can be undone with @kbd{M-C-_}
14787 Scoring can be done on words using the new score type @code{w}
14788 (@pxref{Score File Format}).
14791 Adaptive scoring can be done on a Subject word-by-word basis
14792 (@pxref{Adaptive Scoring}).
14795 (setq gnus-use-adaptive-scoring '(word))
14799 Scores can be decayed (@pxref{Score Decays}).
14802 (setq gnus-decay-scores t)
14806 Scoring can be performed using a regexp on the Date header. The Date is
14807 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
14810 A new command has been added to remove all data on articles from
14811 the native server (@pxref{Changing Servers}).
14814 A new command for reading collections of documents
14815 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{M-C-d}
14816 (@pxref{Really Various Summary Commands}).
14819 Process mark sets can be pushed and popped (@pxref{Setting Process
14823 A new mail-to-news backend makes it possible to post even when the NNTP
14824 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
14827 A new backend for reading searches from Web search engines
14828 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
14829 (@pxref{Web Searches}).
14832 Groups inside topics can now be sorted using the standard sorting
14833 functions, and each topic can be sorted independently (@pxref{Topic
14837 Subsets of the groups can be sorted independently (@code{Sorting
14841 Cached articles can be pulled into the groups (@pxref{Summary Generation
14845 Score files are now applied in a more reliable order (@pxref{Score
14849 Reports on where mail messages end up can be generated (@pxref{Splitting
14853 More hooks and functions have been added to remove junk from incoming
14854 mail before saving the mail (@pxref{Washing Mail}).
14857 Emphasized text can be properly fontisized:
14860 (add-hook 'gnus-article-display-hook 'gnus-article-emphasize)
14866 @node Newest Features
14867 @subsection Newest Features
14870 Also known as the @dfn{todo list}. Sure to be implemented before the
14873 Be afraid. Be very afraid.
14877 Native @sc{mime} support is something that should be done.
14879 Really do unbinhexing.
14882 And much, much, much more. There is more to come than has already been
14883 implemented. (But that's always true, isn't it?)
14885 @file{<URL:http://www.ifi.uio.no/~larsi/rgnus/todo>} is where the actual
14886 up-to-the-second todo list is located, so if you're really curious, you
14887 could point your Web browser over that-a-way.
14892 @section The Manual
14896 This manual was generated from a TeXinfo file and then run through
14897 either @code{texi2dvi}
14899 or my own home-brewed TeXinfo to \LaTeX\ transformer,
14900 and then run through @code{latex} and @code{dvips}
14902 to get what you hold in your hands now.
14904 The following conventions have been used:
14909 This is a @samp{string}
14912 This is a @kbd{keystroke}
14915 This is a @file{file}
14918 This is a @code{symbol}
14922 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
14926 (setq flargnoze "yes")
14929 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
14932 (setq flumphel 'yes)
14935 @samp{yes} and @code{yes} are two @emph{very} different things---don't
14936 ever get them confused.
14940 Of course, everything in this manual is of vital interest, so you should
14941 read it all. Several times. However, if you feel like skimming the
14942 manual, look for that gnu head you should see in the margin over
14943 there---it means that what's being discussed is of more importance than
14944 the rest of the stuff. (On the other hand, if everything is infinitely
14945 important, how can anything be more important than that? Just one more
14946 of the mysteries of this world, I guess.)
14953 @section Terminology
14955 @cindex terminology
14960 This is what you are supposed to use this thing for---reading news.
14961 News is generally fetched from a nearby @sc{nntp} server, and is
14962 generally publicly available to everybody. If you post news, the entire
14963 world is likely to read just what you have written, and they'll all
14964 snigger mischievously. Behind your back.
14968 Everything that's delivered to you personally is mail. Some news/mail
14969 readers (like Gnus) blur the distinction between mail and news, but
14970 there is a difference. Mail is private. News is public. Mailing is
14971 not posting, and replying is not following up.
14975 Send a mail to the person who has written what you are reading.
14979 Post an article to the current newsgroup responding to the article you
14984 Gnus gets fed articles from a number of backends, both news and mail
14985 backends. Gnus does not handle the underlying media, so to speak---this
14986 is all done by the backends.
14990 Gnus will always use one method (and backend) as the @dfn{native}, or
14991 default, way of getting news.
14995 You can also have any number of foreign groups active at the same time.
14996 These are groups that use non-native non-secondary backends for getting
15001 Secondary backends are somewhere half-way between being native and being
15002 foreign, but they mostly act like they are native.
15006 A message that has been posted as news.
15009 @cindex mail message
15010 A message that has been mailed.
15014 A mail message or news article
15018 The top part of a message, where administrative information (etc.) is
15023 The rest of an article. Everything that is not in the head is in the
15028 A line from the head of an article.
15032 A collection of such lines, or a collection of heads. Or even a
15033 collection of @sc{nov} lines.
15037 When Gnus enters a group, it asks the backend for the headers of all
15038 unread articles in the group. Most servers support the News OverView
15039 format, which is more compact and much faster to read and parse than the
15040 normal @sc{head} format.
15044 Each group is subscribed at some @dfn{level} or other (1-9). The ones
15045 that have a lower level are ``more'' subscribed than the groups with a
15046 higher level. In fact, groups on levels 1-5 are considered
15047 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
15048 are @dfn{killed}. Commands for listing groups and scanning for new
15049 articles will all use the numeric prefix as @dfn{working level}.
15051 @item killed groups
15052 @cindex killed groups
15053 No information on killed groups is stored or updated, which makes killed
15054 groups much easier to handle than subscribed groups.
15056 @item zombie groups
15057 @cindex zombie groups
15058 Just like killed groups, only slightly less dead.
15061 @cindex active file
15062 The news server has to keep track of what articles it carries, and what
15063 groups exist. All this information in stored in the active file, which
15064 is rather large, as you might surmise.
15067 @cindex bogus groups
15068 A group that exists in the @file{.newsrc} file, but isn't known to the
15069 server (i.e., it isn't in the active file), is a @emph{bogus group}.
15070 This means that the group probably doesn't exist (any more).
15074 A machine than one can connect to and get news (or mail) from.
15076 @item select method
15077 @cindex select method
15078 A structure that specifies the backend, the server and the virtual
15081 @item virtual server
15082 @cindex virtual server
15083 A named select method. Since a select methods defines all there is to
15084 know about connecting to a (physical) server, taking the things as a
15085 whole is a virtual server.
15089 Taking a buffer and running it through a filter of some sort. The
15090 result will (more often than not) be cleaner and more pleasing than the
15093 @item ephemeral groups
15094 @cindex ephemeral groups
15095 Most groups store data on what articles you have read. @dfn{Ephemeral}
15096 groups are groups that will have no data stored---when you exit the
15097 group, it'll disappear into the aether.
15100 @cindex solid groups
15101 This is the opposite of ephemeral groups. All groups listed in the
15102 group buffer are solid groups.
15104 @item sparse articles
15105 @cindex sparse articles
15106 These are article placeholders shown in the summary buffer when
15107 @code{gnus-build-sparse-threads} has been switched on.
15112 @node Customization
15113 @section Customization
15114 @cindex general customization
15116 All variables are properly documented elsewhere in this manual. This
15117 section is designed to give general pointers on how to customize Gnus
15118 for some quite common situations.
15121 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
15122 * Slow Terminal Connection:: You run a remote Emacs.
15123 * Little Disk Space:: You feel that having large setup files is icky.
15124 * Slow Machine:: You feel like buying a faster machine.
15128 @node Slow/Expensive Connection
15129 @subsection Slow/Expensive @sc{nntp} Connection
15131 If you run Emacs on a machine locally, and get your news from a machine
15132 over some very thin strings, you want to cut down on the amount of data
15133 Gnus has to get from the @sc{nntp} server.
15137 @item gnus-read-active-file
15138 Set this to @code{nil}, which will inhibit Gnus from requesting the
15139 entire active file from the server. This file is often v. large. You
15140 also have to set @code{gnus-check-new-newsgroups} and
15141 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
15142 doesn't suddenly decide to fetch the active file anyway.
15144 @item gnus-nov-is-evil
15145 This one has to be @code{nil}. If not, grabbing article headers from
15146 the @sc{nntp} server will not be very fast. Not all @sc{nntp} servers
15147 support @sc{xover}; Gnus will detect this by itself.
15151 @node Slow Terminal Connection
15152 @subsection Slow Terminal Connection
15154 Let's say you use your home computer for dialing up the system that
15155 runs Emacs and Gnus. If your modem is slow, you want to reduce the
15156 amount of data that is sent over the wires as much as possible.
15160 @item gnus-auto-center-summary
15161 Set this to @code{nil} to inhibit Gnus from re-centering the summary
15162 buffer all the time. If it is @code{vertical}, do only vertical
15163 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
15164 horizontal and vertical recentering.
15166 @item gnus-visible-headers
15167 Cut down on the headers that are included in the articles to the
15168 minimum. You can, in fact, make do without them altogether---most of the
15169 useful data is in the summary buffer, anyway. Set this variable to
15170 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
15172 @item gnus-article-display-hook
15173 Set this hook to all the available hiding commands:
15175 (setq gnus-article-display-hook
15176 '(gnus-article-hide-headers gnus-article-hide-signature
15177 gnus-article-hide-citation))
15180 @item gnus-use-full-window
15181 By setting this to @code{nil}, you can make all the windows smaller.
15182 While this doesn't really cut down much generally, it means that you
15183 have to see smaller portions of articles before deciding that you didn't
15184 want to read them anyway.
15186 @item gnus-thread-hide-subtree
15187 If this is non-@code{nil}, all threads in the summary buffer will be
15190 @item gnus-updated-mode-lines
15191 If this is @code{nil}, Gnus will not put information in the buffer mode
15192 lines, which might save some time.
15196 @node Little Disk Space
15197 @subsection Little Disk Space
15200 The startup files can get rather large, so you may want to cut their
15201 sizes a bit if you are running out of space.
15205 @item gnus-save-newsrc-file
15206 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
15207 only save @file{.newsrc.eld}. This means that you will not be able to
15208 use any other newsreaders than Gnus. This variable is @code{t} by
15211 @item gnus-save-killed-list
15212 If this is @code{nil}, Gnus will not save the list of dead groups. You
15213 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
15214 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
15215 variable to @code{nil}. This variable is @code{t} by default.
15221 @subsection Slow Machine
15222 @cindex slow machine
15224 If you have a slow machine, or are just really impatient, there are a
15225 few things you can do to make Gnus run faster.
15227 Set@code{gnus-check-new-newsgroups} and
15228 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
15230 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
15231 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
15232 summary buffer faster.
15234 Set @code{gnus-article-display-hook} to @code{nil} to make article
15235 processing a bit faster.
15238 @node Troubleshooting
15239 @section Troubleshooting
15240 @cindex troubleshooting
15242 Gnus works @emph{so} well straight out of the box---I can't imagine any
15250 Make sure your computer is switched on.
15253 Make sure that you really load the current Gnus version. If you have
15254 been running @sc{gnus}, you need to exit Emacs and start it up again before
15258 Try doing an @kbd{M-x gnus-version}. If you get something that looks
15259 like @samp{Gnus v5.46; nntp 4.0} you have the right files loaded. If,
15260 on the other hand, you get something like @samp{NNTP 3.x} or @samp{nntp
15261 flee}, you have some old @file{.el} files lying around. Delete these.
15264 Read the help group (@kbd{G h} in the group buffer) for a FAQ and a
15268 @vindex max-lisp-eval-depth
15269 Gnus works on many recursive structures, and in some extreme (and very
15270 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
15271 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
15272 something like that.
15275 If all else fails, report the problem as a bug.
15278 @cindex reporting bugs
15280 @kindex M-x gnus-bug
15282 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
15283 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
15284 me the backtrace. I will fix bugs, but I can only fix them if you send
15285 me a precise description as to how to reproduce the bug.
15287 You really can never be too detailed in a bug report. Always use the
15288 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
15289 a 10Kb mail each time you use it, and even if you have sent me your
15290 environment 500 times before. I don't care. I want the full info each
15293 It is also important to remember that I have no memory whatsoever. If
15294 you send a bug report, and I send you a reply, and then you send back
15295 just ``No, it's not! Moron!'', I will have no idea what you are
15296 insulting me about. Always over-explain everything. It's much easier
15297 for all of us---if I don't have all the information I need, I will just
15298 mail you and ask for more info, and everything takes more time.
15300 If the problem you're seeing is very visual, and you can't quite explain
15301 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
15302 it somewhere it can be reached, and include the URL of the picture in
15305 If you just need help, you are better off asking on
15306 @samp{gnu.emacs.gnus}. I'm not very helpful.
15308 @cindex gnu.emacs.gnus
15309 @cindex ding mailing list
15310 You can also ask on the ding mailing list---@samp{ding@@gnus.org}.
15311 Write to @samp{ding-request@@gnus.org} to subscribe.
15314 @node A Programmers Guide to Gnus
15315 @section A Programmer@'s Guide to Gnus
15317 It is my hope that other people will figure out smart stuff that Gnus
15318 can do, and that other people will write those smart things as well. To
15319 facilitate that I thought it would be a good idea to describe the inner
15320 workings of Gnus. And some of the not-so-inner workings, while I'm at
15323 You can never expect the internals of a program not to change, but I
15324 will be defining (in some details) the interface between Gnus and its
15325 backends (this is written in stone), the format of the score files
15326 (ditto), data structures (some are less likely to change than others)
15327 and general method of operations.
15330 * Gnus Utility Functions:: Common functions and variable to use.
15331 * Backend Interface:: How Gnus communicates with the servers.
15332 * Score File Syntax:: A BNF definition of the score file standard.
15333 * Headers:: How Gnus stores headers internally.
15334 * Ranges:: A handy format for storing mucho numbers.
15335 * Group Info:: The group info format.
15336 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
15337 * Various File Formats:: Formats of files that Gnus use.
15341 @node Gnus Utility Functions
15342 @subsection Gnus Utility Functions
15343 @cindex Gnus utility functions
15344 @cindex utility functions
15346 @cindex internal variables
15348 When writing small functions to be run from hooks (and stuff), it's
15349 vital to have access to the Gnus internal functions and variables.
15350 Below is a list of the most common ones.
15354 @item gnus-newsgroup-name
15355 @vindex gnus-newsgroup-name
15356 This variable holds the name of the current newsgroup.
15358 @item gnus-find-method-for-group
15359 @findex gnus-find-method-for-group
15360 A function that returns the select method for @var{group}.
15362 @item gnus-group-real-name
15363 @findex gnus-group-real-name
15364 Takes a full (prefixed) Gnus group name, and returns the unprefixed
15367 @item gnus-group-prefixed-name
15368 @findex gnus-group-prefixed-name
15369 Takes an unprefixed group name and a select method, and returns the full
15370 (prefixed) Gnus group name.
15372 @item gnus-get-info
15373 @findex gnus-get-info
15374 Return the group info list for @var{group}.
15376 @item gnus-add-current-to-buffer-list
15377 @findex gnus-add-current-to-buffer-list
15378 Add the current buffer to the list of buffers to be killed on Gnus
15381 @item gnus-continuum-version
15382 @findex gnus-continuum-version
15383 Take a Gnus version string as a parameter and returns a floating point
15384 number. Earlier versions will always get a lower number than later
15387 @item gnus-group-read-only-p
15388 @findex gnus-group-read-only-p
15389 Say whether @var{group} is read-only or not.
15391 @item gnus-news-group-p
15392 @findex gnus-news-group-p
15393 Say whether @var{group} came from a news backend.
15395 @item gnus-ephemeral-group-p
15396 @findex gnus-ephemeral-group-p
15397 Say whether @var{group} is ephemeral or not.
15399 @item gnus-server-to-method
15400 @findex gnus-server-to-method
15401 Return the select method corresponding to @var{server}.
15403 @item gnus-server-equal
15404 @findex gnus-server-equal
15405 Say whether two virtual servers are equal.
15407 @item gnus-group-native-p
15408 @findex gnus-group-native-p
15409 Say whether @var{group} is native or not.
15411 @item gnus-group-secondary-p
15412 @findex gnus-group-secondary-p
15413 Say whether @var{group} is secondary or not.
15415 @item gnus-group-foreign-p
15416 @findex gnus-group-foreign-p
15417 Say whether @var{group} is foreign or not.
15419 @item group-group-find-parameter
15420 @findex group-group-find-parameter
15421 Return the parameter list of @var{group}. If given a second parameter,
15422 return the value of that parameter for @var{group}.
15424 @item gnus-group-set-parameter
15425 @findex gnus-group-set-parameter
15426 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
15428 @item gnus-narrow-to-body
15429 @findex gnus-narrow-to-body
15430 Narrow the current buffer to the body of the article.
15432 @item gnus-check-backend-function
15433 @findex gnus-check-backend-function
15434 Takes two parameters, @var{function} and @var{group}. If the backend
15435 @var{group} comes from supports @var{function}, return non-@code{nil}.
15438 (gnus-check-backend-function "request-scan" "nnml:misc")
15442 @item gnus-read-method
15443 @findex gnus-read-method
15444 Prompt the user for a select method.
15449 @node Backend Interface
15450 @subsection Backend Interface
15452 Gnus doesn't know anything about @sc{nntp}, spools, mail or virtual
15453 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
15454 server is a @dfn{backend} and some @dfn{backend variables}. As examples
15455 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
15456 examples of the latter we have @code{nntp-port-number} and
15457 @code{nnmbox-directory}.
15459 When Gnus asks for information from a backend---say @code{nntp}---on
15460 something, it will normally include a virtual server name in the
15461 function parameters. (If not, the backend should use the ``current''
15462 virtual server.) For instance, @code{nntp-request-list} takes a virtual
15463 server as its only (optional) parameter. If this virtual server hasn't
15464 been opened, the function should fail.
15466 Note that a virtual server name has no relation to some physical server
15467 name. Take this example:
15471 (nntp-address "ifi.uio.no")
15472 (nntp-port-number 4324))
15475 Here the virtual server name is @samp{odd-one} while the name of
15476 the physical server is @samp{ifi.uio.no}.
15478 The backends should be able to switch between several virtual servers.
15479 The standard backends implement this by keeping an alist of virtual
15480 server environments that it pulls down/pushes up when needed.
15482 There are two groups of interface functions: @dfn{required functions},
15483 which must be present, and @dfn{optional functions}, which Gnus will
15484 always check whether are present before attempting to call.
15486 All these functions are expected to return data in the buffer
15487 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
15488 unfortunately named, but we'll have to live with it. When I talk about
15489 @dfn{resulting data}, I always refer to the data in that buffer. When I
15490 talk about @dfn{return value}, I talk about the function value returned by
15491 the function call. Functions that fail should return @code{nil} as the
15494 Some backends could be said to be @dfn{server-forming} backends, and
15495 some might be said to not be. The latter are backends that generally
15496 only operate on one group at a time, and have no concept of ``server''
15497 -- they have a group, and they deliver info on that group and nothing
15500 In the examples and definitions I will refer to the imaginary backend
15503 @cindex @code{nnchoke}
15506 * Required Backend Functions:: Functions that must be implemented.
15507 * Optional Backend Functions:: Functions that need not be implemented.
15508 * Error Messaging:: How to get messages and report errors.
15509 * Writing New Backends:: Extending old backends.
15510 * Hooking New Backends Into Gnus:: What has to be done on the Gnus end.
15511 * Mail-like Backends:: Some tips on mail backends.
15515 @node Required Backend Functions
15516 @subsubsection Required Backend Functions
15520 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
15522 @var{articles} is either a range of article numbers or a list of
15523 @code{Message-ID}s. Current backends do not fully support either---only
15524 sequences (lists) of article numbers, and most backends do not support
15525 retrieval of @code{Message-ID}s. But they should try for both.
15527 The result data should either be HEADs or NOV lines, and the result
15528 value should either be @code{headers} or @code{nov} to reflect this.
15529 This might later be expanded to @code{various}, which will be a mixture
15530 of HEADs and NOV lines, but this is currently not supported by Gnus.
15532 If @var{fetch-old} is non-@code{nil} it says to try to fetch "extra
15533 headers, in some meaning of the word. This is generally done by
15534 fetching (at most) @var{fetch-old} extra headers less than the smallest
15535 article number in @code{articles}, and fill in the gaps as well. The
15536 presence of this parameter can be ignored if the backend finds it
15537 cumbersome to follow the request. If this is non-@code{nil} and not a
15538 number, do maximum fetches.
15540 Here's an example HEAD:
15543 221 1056 Article retrieved.
15544 Path: ifi.uio.no!sturles
15545 From: sturles@@ifi.uio.no (Sturle Sunde)
15546 Newsgroups: ifi.discussion
15547 Subject: Re: Something very droll
15548 Date: 27 Oct 1994 14:02:57 +0100
15549 Organization: Dept. of Informatics, University of Oslo, Norway
15551 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
15552 References: <38jdmq$4qu@@visbur.ifi.uio.no>
15553 NNTP-Posting-Host: holmenkollen.ifi.uio.no
15557 So a @code{headers} return value would imply that there's a number of
15558 these in the data buffer.
15560 Here's a BNF definition of such a buffer:
15564 head = error / valid-head
15565 error-message = [ "4" / "5" ] 2number " " <error message> eol
15566 valid-head = valid-message *header "." eol
15567 valid-message = "221 " <number> " Article retrieved." eol
15568 header = <text> eol
15571 If the return value is @code{nov}, the data buffer should contain
15572 @dfn{network overview database} lines. These are basically fields
15576 nov-buffer = *nov-line
15577 nov-line = 8*9 [ field <TAB> ] eol
15578 field = <text except TAB>
15581 For a closer explanation what should be in those fields,
15585 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
15587 @var{server} is here the virtual server name. @var{definitions} is a
15588 list of @code{(VARIABLE VALUE)} pairs that defines this virtual server.
15590 If the server can't be opened, no error should be signaled. The backend
15591 may then choose to refuse further attempts at connecting to this
15592 server. In fact, it should do so.
15594 If the server is opened already, this function should return a
15595 non-@code{nil} value. There should be no data returned.
15598 @item (nnchoke-close-server &optional SERVER)
15600 Close connection to @var{server} and free all resources connected
15601 to it. Return @code{nil} if the server couldn't be closed for some
15604 There should be no data returned.
15607 @item (nnchoke-request-close)
15609 Close connection to all servers and free all resources that the backend
15610 have reserved. All buffers that have been created by that backend
15611 should be killed. (Not the @code{nntp-server-buffer}, though.) This
15612 function is generally only called when Gnus is shutting down.
15614 There should be no data returned.
15617 @item (nnchoke-server-opened &optional SERVER)
15619 If @var{server} is the current virtual server, and the connection to the
15620 physical server is alive, then this function should return a
15621 non-@code{nil} vlue. This function should under no circumstances
15622 attempt to reconnect to a server that is has lost connection to.
15624 There should be no data returned.
15627 @item (nnchoke-status-message &optional SERVER)
15629 This function should return the last error message from @var{server}.
15631 There should be no data returned.
15634 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
15636 The result data from this function should be the article specified by
15637 @var{article}. This might either be a @code{Message-ID} or a number.
15638 It is optional whether to implement retrieval by @code{Message-ID}, but
15639 it would be nice if that were possible.
15641 If @var{to-buffer} is non-@code{nil}, the result data should be returned
15642 in this buffer instead of the normal data buffer. This is to make it
15643 possible to avoid copying large amounts of data from one buffer to
15644 another, and Gnus mainly request articles to be inserted directly into
15645 its article buffer.
15647 If it is at all possible, this function should return a cons cell where
15648 the car is the group name the article was fetched from, and the cdr is
15649 the article number. This will enable Gnus to find out what the real
15650 group and article numbers are when fetching articles by
15651 @code{Message-ID}. If this isn't possible, @code{t} should be returned
15652 on successful article retrievement.
15655 @item (nnchoke-request-group GROUP &optional SERVER FAST)
15657 Get data on @var{group}. This function also has the side effect of
15658 making @var{group} the current group.
15660 If @var{FAST}, don't bother to return useful data, just make @var{group}
15663 Here's an example of some result data and a definition of the same:
15666 211 56 1000 1059 ifi.discussion
15669 The first number is the status, which should be 211. Next is the
15670 total number of articles in the group, the lowest article number, the
15671 highest article number, and finally the group name. Note that the total
15672 number of articles may be less than one might think while just
15673 considering the highest and lowest article numbers, but some articles
15674 may have been canceled. Gnus just discards the total-number, so
15675 whether one should take the bother to generate it properly (if that is a
15676 problem) is left as an exercise to the reader.
15679 group-status = [ error / info ] eol
15680 error = [ "4" / "5" ] 2<number> " " <Error message>
15681 info = "211 " 3* [ <number> " " ] <string>
15685 @item (nnchoke-close-group GROUP &optional SERVER)
15687 Close @var{group} and free any resources connected to it. This will be
15688 a no-op on most backends.
15690 There should be no data returned.
15693 @item (nnchoke-request-list &optional SERVER)
15695 Return a list of all groups available on @var{server}. And that means
15698 Here's an example from a server that only carries two groups:
15701 ifi.test 0000002200 0000002000 y
15702 ifi.discussion 3324 3300 n
15705 On each line we have a group name, then the highest article number in
15706 that group, the lowest article number, and finally a flag.
15709 active-file = *active-line
15710 active-line = name " " <number> " " <number> " " flags eol
15712 flags = "n" / "y" / "m" / "x" / "j" / "=" name
15715 The flag says whether the group is read-only (@samp{n}), is moderated
15716 (@samp{m}), is dead (@samp{x}), is aliased to some other group
15717 (@samp{=other-group} or none of the above (@samp{y}).
15720 @item (nnchoke-request-post &optional SERVER)
15722 This function should post the current buffer. It might return whether
15723 the posting was successful or not, but that's not required. If, for
15724 instance, the posting is done asynchronously, it has generally not been
15725 completed by the time this function concludes. In that case, this
15726 function should set up some kind of sentinel to beep the user loud and
15727 clear if the posting could not be completed.
15729 There should be no result data from this function.
15734 @node Optional Backend Functions
15735 @subsubsection Optional Backend Functions
15739 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
15741 @var{groups} is a list of groups, and this function should request data
15742 on all those groups. How it does it is of no concern to Gnus, but it
15743 should attempt to do this in a speedy fashion.
15745 The return value of this function can be either @code{active} or
15746 @code{group}, which says what the format of the result data is. The
15747 former is in the same format as the data from
15748 @code{nnchoke-request-list}, while the latter is a buffer full of lines
15749 in the same format as @code{nnchoke-request-group} gives.
15752 group-buffer = *active-line / *group-status
15756 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
15758 A Gnus group info (@pxref{Group Info}) is handed to the backend for
15759 alterations. This comes in handy if the backend really carries all the
15760 information (as is the case with virtual and imap groups). This
15761 function should destructively alter the info to suit its needs, and
15762 should return the (altered) group info.
15764 There should be no result data from this function.
15767 @item (nnchoke-request-type GROUP &optional ARTICLE)
15769 When the user issues commands for ``sending news'' (@kbd{F} in the
15770 summary buffer, for instance), Gnus has to know whether the article the
15771 user is following up is news or mail. This function should return
15772 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
15773 is mail and @code{unknown} if the type can't be decided. (The
15774 @var{article} parameter is necessary in @code{nnvirtual} groups which
15775 might very well combine mail groups and news groups.) Both @var{group}
15776 and @var{article} may be @code{nil}.
15778 There should be no result data from this function.
15781 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
15783 If the user tries to set a mark that the backend doesn't like, this
15784 function may change the mark. Gnus will use whatever this function
15785 returns as the mark for @var{article} instead of the original
15786 @var{mark}. If the backend doesn't care, it must return the original
15787 @var{mark}, and not @code{nil} or any other type of garbage.
15789 The only use for this that I can see is what @code{nnvirtual} does with
15790 it---if a component group is auto-expirable, marking an article as read
15791 in the virtual group should result in the article being marked as
15794 There should be no result data from this function.
15797 @item (nnchoke-request-scan &optional GROUP SERVER)
15799 This function may be called at any time (by Gnus or anything else) to
15800 request that the backend check for incoming articles, in one way or
15801 another. A mail backend will typically read the spool file or query the
15802 POP server when this function is invoked. The @var{group} doesn't have
15803 to be heeded---if the backend decides that it is too much work just
15804 scanning for a single group, it may do a total scan of all groups. It
15805 would be nice, however, to keep things local if that's practical.
15807 There should be no result data from this function.
15810 @item (nnchoke-request-group-description GROUP &optional SERVER)
15812 The result data from this function should be a description of
15816 description-line = name <TAB> description eol
15818 description = <text>
15821 @item (nnchoke-request-list-newsgroups &optional SERVER)
15823 The result data from this function should be the description of all
15824 groups available on the server.
15827 description-buffer = *description-line
15831 @item (nnchoke-request-newgroups DATE &optional SERVER)
15833 The result data from this function should be all groups that were
15834 created after @samp{date}, which is in normal human-readable date
15835 format. The data should be in the active buffer format.
15838 @item (nnchoke-request-create-group GROUP &optional SERVER)
15840 This function should create an empty group with name @var{group}.
15842 There should be no return data.
15845 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
15847 This function should run the expiry process on all articles in the
15848 @var{articles} range (which is currently a simple list of article
15849 numbers.) It is left up to the backend to decide how old articles
15850 should be before they are removed by this function. If @var{force} is
15851 non-@code{nil}, all @var{articles} should be deleted, no matter how new
15854 This function should return a list of articles that it did not/was not
15857 There should be no result data returned.
15860 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM
15863 This function should move @var{article} (which is a number) from
15864 @var{group} by calling @var{accept-form}.
15866 This function should ready the article in question for moving by
15867 removing any header lines it has added to the article, and generally
15868 should ``tidy up'' the article. Then it should @code{eval}
15869 @var{accept-form} in the buffer where the ``tidy'' article is. This
15870 will do the actual copying. If this @code{eval} returns a
15871 non-@code{nil} value, the article should be removed.
15873 If @var{last} is @code{nil}, that means that there is a high likelihood
15874 that there will be more requests issued shortly, so that allows some
15877 The function should return a cons where the car is the group name and
15878 the cdr is the article number that the article was entered as.
15880 There should be no data returned.
15883 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
15885 This function takes the current buffer and inserts it into @var{group}.
15886 If @var{last} in @code{nil}, that means that there will be more calls to
15887 this function in short order.
15889 The function should return a cons where the car is the group name and
15890 the cdr is the article number that the article was entered as.
15892 There should be no data returned.
15895 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
15897 This function should remove @var{article} (which is a number) from
15898 @var{group} and insert @var{buffer} there instead.
15900 There should be no data returned.
15903 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
15905 This function should delete @var{group}. If @var{force}, it should
15906 really delete all the articles in the group, and then delete the group
15907 itself. (If there is such a thing as ``the group itself''.)
15909 There should be no data returned.
15912 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
15914 This function should rename @var{group} into @var{new-name}. All
15915 articles that are in @var{group} should move to @var{new-name}.
15917 There should be no data returned.
15922 @node Error Messaging
15923 @subsubsection Error Messaging
15925 @findex nnheader-report
15926 @findex nnheader-get-report
15927 The backends should use the function @code{nnheader-report} to report
15928 error conditions---they should not raise errors when they aren't able to
15929 perform a request. The first argument to this function is the backend
15930 symbol, and the rest are interpreted as arguments to @code{format} if
15931 there are many of them, or just a string if there is one of them.
15932 This function always returns @code{nil}.
15935 (nnheader-report 'nnchoke "You did something totally bogus")
15937 (nnheader-report 'nnchoke "Could not request group %s" group)
15940 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
15941 @code{nil} back from a server, and this function returns the most
15942 recently reported message for the backend in question. This function
15943 takes one argument---the server symbol.
15945 Internally, these function access @var{backend}@code{-status-string}, so
15946 the @code{nnchoke} backend will have its error message stored in
15947 @code{nnchoke-status-string}.
15950 @node Writing New Backends
15951 @subsubsection Writing New Backends
15953 Many backends are quite similar. @code{nnml} is just like
15954 @code{nnspool}, but it allows you to edit the articles on the server.
15955 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
15956 and it doesn't maintain overview databases. @code{nndir} is just like
15957 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
15960 It would make sense if it were possible to ``inherit'' functions from
15961 backends when writing new backends. And, indeed, you can do that if you
15962 want to. (You don't have to if you don't want to, of course.)
15964 All the backends declare their public variables and functions by using a
15965 package called @code{nnoo}.
15967 To inherit functions from other backends (and allow other backends to
15968 inherit functions from the current backend), you should use the
15975 This macro declares the first parameter to be a child of the subsequent
15976 parameters. For instance:
15979 (nnoo-declare nndir
15983 @code{nndir} has here declared that it intends to inherit functions from
15984 both @code{nnml} and @code{nnmh}.
15987 This macro is equivalent to @code{defvar}, but registers the variable as
15988 a public server variable. Most state-oriented variables should be
15989 declared with @code{defvoo} instead of @code{defvar}.
15991 In addition to the normal @code{defvar} parameters, it takes a list of
15992 variables in the parent backends to map the variable to when executing
15993 a function in those backends.
15996 (defvoo nndir-directory nil
15997 "Where nndir will look for groups."
15998 nnml-current-directory nnmh-current-directory)
16001 This means that @code{nnml-current-directory} will be set to
16002 @code{nndir-directory} when an @code{nnml} function is called on behalf
16003 of @code{nndir}. (The same with @code{nnmh}.)
16005 @item nnoo-define-basics
16006 This macro defines some common functions that almost all backends should
16010 (nnoo-define-basics nndir)
16014 This macro is just like @code{defun} and takes the same parameters. In
16015 addition to doing the normal @code{defun} things, it registers the
16016 function as being public so that other backends can inherit it.
16018 @item nnoo-map-functions
16019 This macro allows mapping of functions from the current backend to
16020 functions from the parent backends.
16023 (nnoo-map-functions nndir
16024 (nnml-retrieve-headers 0 nndir-current-group 0 0)
16025 (nnmh-request-article 0 nndir-current-group 0 0))
16028 This means that when @code{nndir-retrieve-headers} is called, the first,
16029 third, and fourth parameters will be passed on to
16030 @code{nnml-retrieve-headers}, while the second parameter is set to the
16031 value of @code{nndir-current-group}.
16034 This macro allows importing functions from backends. It should be the
16035 last thing in the source file, since it will only define functions that
16036 haven't already been defined.
16042 nnmh-request-newgroups)
16046 This means that calls to @code{nndir-request-list} should just be passed
16047 on to @code{nnmh-request-list}, while all public functions from
16048 @code{nnml} that haven't been defined in @code{nndir} yet should be
16053 Below is a slightly shortened version of the @code{nndir} backend.
16056 ;;; nndir.el --- single directory newsgroup access for Gnus
16057 ;; Copyright (C) 1995,96 Free Software Foundation, Inc.
16061 (require 'nnheader)
16065 (eval-when-compile (require 'cl))
16067 (nnoo-declare nndir
16070 (defvoo nndir-directory nil
16071 "Where nndir will look for groups."
16072 nnml-current-directory nnmh-current-directory)
16074 (defvoo nndir-nov-is-evil nil
16075 "*Non-nil means that nndir will never retrieve NOV headers."
16078 (defvoo nndir-current-group "" nil nnml-current-group nnmh-current-group)
16079 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
16080 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
16082 (defvoo nndir-status-string "" nil nnmh-status-string)
16083 (defconst nndir-version "nndir 1.0")
16085 ;;; Interface functions.
16087 (nnoo-define-basics nndir)
16089 (deffoo nndir-open-server (server &optional defs)
16090 (setq nndir-directory
16091 (or (cadr (assq 'nndir-directory defs))
16093 (unless (assq 'nndir-directory defs)
16094 (push `(nndir-directory ,server) defs))
16095 (push `(nndir-current-group
16096 ,(file-name-nondirectory (directory-file-name nndir-directory)))
16098 (push `(nndir-top-directory
16099 ,(file-name-directory (directory-file-name nndir-directory)))
16101 (nnoo-change-server 'nndir server defs))
16103 (nnoo-map-functions nndir
16104 (nnml-retrieve-headers 0 nndir-current-group 0 0)
16105 (nnmh-request-article 0 nndir-current-group 0 0)
16106 (nnmh-request-group nndir-current-group 0 0)
16107 (nnmh-close-group nndir-current-group 0))
16111 nnmh-status-message
16113 nnmh-request-newgroups))
16119 @node Hooking New Backends Into Gnus
16120 @subsubsection Hooking New Backends Into Gnus
16122 @vindex gnus-valid-select-methods
16123 Having Gnus start using your new backend is rather easy---you just
16124 declare it with the @code{gnus-declare-backend} functions. This will
16125 enter the backend into the @code{gnus-valid-select-methods} variable.
16127 @code{gnus-declare-backend} takes two parameters---the backend name and
16128 an arbitrary number of @dfn{abilities}.
16133 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
16136 The abilities can be:
16140 This is a mailish backend---followups should (probably) go via mail.
16142 This is a newsish backend---followups should (probably) go via news.
16144 This backend supports both mail and news.
16146 This is neither a post or mail backend---it's something completely
16149 It supports respooling---or rather, it is able to modify its source
16150 articles and groups.
16152 The name of the server should be in the virtual server name. This is
16153 true for almost all backends.
16154 @item prompt-address
16155 The user should be prompted for an address when doing commands like
16156 @kbd{B} in the group buffer. This is true for backends like
16157 @code{nntp}, but not @code{nnmbox}, for instance.
16161 @node Mail-like Backends
16162 @subsubsection Mail-like Backends
16164 One of the things that separate the mail backends from the rest of the
16165 backends is the heavy dependence by the mail backends on common
16166 functions in @file{nnmail.el}. For instance, here's the definition of
16167 @code{nnml-request-scan}:
16170 (deffoo nnml-request-scan (&optional group server)
16171 (setq nnml-article-file-alist nil)
16172 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
16175 It simply just calls @code{nnmail-get-new-mail} will a few parameters,
16176 and @code{nnmail} takes care of all the moving and splitting of the
16179 This function takes four parameters.
16183 This should be a symbol to designate which backend is responsible for
16186 @item exit-function
16187 This function should be called after the splitting has been performed.
16189 @item temp-directory
16190 Where the temporary files should be stored.
16193 This optional argument should be a group name if the splitting is to be
16194 performed for one group only.
16197 @code{nnmail-get-new-mail} will call @var{backend}@code{-save-mail} to
16198 save each article. @var{backend}@code{-active-number} will be called to
16199 find the article number assigned to this article.
16201 The function also uses the following variables:
16202 @var{backend}@code{-get-new-mail} (to see whether to get new mail for
16203 this backend); and @var{backend}@code{-group-alist} and
16204 @var{backend}@code{-active-file} to generate the new active file.
16205 @var{backend}@code{-group-alist} should be a group-active alist, like
16209 (("a-group" (1 . 10))
16210 ("some-group" (34 . 39)))
16214 @node Score File Syntax
16215 @subsection Score File Syntax
16217 Score files are meant to be easily parsable, but yet extremely
16218 mallable. It was decided that something that had the same read syntax
16219 as an Emacs Lisp list would fit that spec.
16221 Here's a typical score file:
16225 ("win95" -10000 nil s)
16232 BNF definition of a score file:
16235 score-file = "" / "(" *element ")"
16236 element = rule / atom
16237 rule = string-rule / number-rule / date-rule
16238 string-rule = "(" quote string-header quote space *string-match ")"
16239 number-rule = "(" quote number-header quote space *number-match ")"
16240 date-rule = "(" quote date-header quote space *date-match ")"
16242 string-header = "subject" / "from" / "references" / "message-id" /
16243 "xref" / "body" / "head" / "all" / "followup"
16244 number-header = "lines" / "chars"
16245 date-header = "date"
16246 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
16247 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
16248 score = "nil" / <integer>
16249 date = "nil" / <natural number>
16250 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
16251 "r" / "regex" / "R" / "Regex" /
16252 "e" / "exact" / "E" / "Exact" /
16253 "f" / "fuzzy" / "F" / "Fuzzy"
16254 number-match = "(" <integer> [ "" / [ space score [ "" /
16255 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
16256 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
16257 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
16258 space date [ "" / [ space date-match-t ] ] ] ] ")"
16259 date-match-t = "nil" / "at" / "before" / "after"
16260 atom = "(" [ required-atom / optional-atom ] ")"
16261 required-atom = mark / expunge / mark-and-expunge / files /
16262 exclude-files / read-only / touched
16263 optional-atom = adapt / local / eval
16264 mark = "mark" space nil-or-number
16265 nil-or-number = "nil" / <integer>
16266 expunge = "expunge" space nil-or-number
16267 mark-and-expunge = "mark-and-expunge" space nil-or-number
16268 files = "files" *[ space <string> ]
16269 exclude-files = "exclude-files" *[ space <string> ]
16270 read-only = "read-only" [ space "nil" / space "t" ]
16271 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
16272 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
16273 local = "local" *[ space "(" <string> space <form> ")" ]
16274 eval = "eval" space <form>
16275 space = *[ " " / <TAB> / <NEWLINE> ]
16278 Any unrecognized elements in a score file should be ignored, but not
16281 As you can see, white space is needed, but the type and amount of white
16282 space is irrelevant. This means that formatting of the score file is
16283 left up to the programmer---if it's simpler to just spew it all out on
16284 one looong line, then that's ok.
16286 The meaning of the various atoms are explained elsewhere in this
16291 @subsection Headers
16293 Gnus uses internally a format for storing article headers that
16294 corresponds to the @sc{nov} format in a mysterious fashion. One could
16295 almost suspect that the author looked at the @sc{nov} specification and
16296 just shamelessly @emph{stole} the entire thing, and one would be right.
16298 @dfn{Header} is a severely overloaded term. ``Header'' is used in
16299 RFC1036 to talk about lines in the head of an article (e.g.,
16300 @code{From}). It is used by many people as a synonym for
16301 ``head''---``the header and the body''. (That should be avoided, in my
16302 opinion.) And Gnus uses a format internally that it calls ``header'',
16303 which is what I'm talking about here. This is a 9-element vector,
16304 basically, with each header (ouch) having one slot.
16306 These slots are, in order: @code{number}, @code{subject}, @code{from},
16307 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
16308 @code{xref}. There are macros for accessing and setting these
16309 slots---they all have predictable names beginning with
16310 @code{mail-header-} and @code{mail-header-set-}, respectively.
16312 The @code{xref} slot is really a @code{misc} slot. Any extra info will
16319 @sc{gnus} introduced a concept that I found so useful that I've started
16320 using it a lot and have elaborated on it greatly.
16322 The question is simple: If you have a large amount of objects that are
16323 identified by numbers (say, articles, to take a @emph{wild} example)
16324 that you want to qualify as being ``included'', a normal sequence isn't
16325 very useful. (A 200,000 length sequence is a bit long-winded.)
16327 The solution is as simple as the question: You just collapse the
16331 (1 2 3 4 5 6 10 11 12)
16334 is transformed into
16337 ((1 . 6) (10 . 12))
16340 To avoid having those nasty @samp{(13 . 13)} elements to denote a
16341 lonesome object, a @samp{13} is a valid element:
16344 ((1 . 6) 7 (10 . 12))
16347 This means that comparing two ranges to find out whether they are equal
16348 is slightly tricky:
16351 ((1 . 5) 7 8 (10 . 12))
16357 ((1 . 5) (7 . 8) (10 . 12))
16360 are equal. In fact, any non-descending list is a range:
16366 is a perfectly valid range, although a pretty long-winded one. This is
16373 and is equal to the previous range.
16375 Here's a BNF definition of ranges. Of course, one must remember the
16376 semantic requirement that the numbers are non-descending. (Any number
16377 of repetition of the same number is allowed, but apt to disappear in
16381 range = simple-range / normal-range
16382 simple-range = "(" number " . " number ")"
16383 normal-range = "(" start-contents ")"
16384 contents = "" / simple-range *[ " " contents ] /
16385 number *[ " " contents ]
16388 Gnus currently uses ranges to keep track of read articles and article
16389 marks. I plan on implementing a number of range operators in C if The
16390 Powers That Be are willing to let me. (I haven't asked yet, because I
16391 need to do some more thinking on what operators I need to make life
16392 totally range-based without ever having to convert back to normal
16397 @subsection Group Info
16399 Gnus stores all permanent info on groups in a @dfn{group info} list.
16400 This list is from three to six elements (or more) long and exhaustively
16401 describes the group.
16403 Here are two example group infos; one is a very simple group while the
16404 second is a more complex one:
16407 ("no.group" 5 (1 . 54324))
16409 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
16410 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
16412 (auto-expire (to-address "ding@@gnus.org")))
16415 The first element is the @dfn{group name}---as Gnus knows the group,
16416 anyway. The second element is the @dfn{subscription level}, which
16417 normally is a small integer. The third element is a list of ranges of
16418 read articles. The fourth element is a list of lists of article marks
16419 of various kinds. The fifth element is the select method (or virtual
16420 server, if you like). The sixth element is a list of @dfn{group
16421 parameters}, which is what this section is about.
16423 Any of the last three elements may be missing if they are not required.
16424 In fact, the vast majority of groups will normally only have the first
16425 three elements, which saves quite a lot of cons cells.
16427 Here's a BNF definition of the group info format:
16430 info = "(" group space level space read
16431 [ "" / [ space marks-list [ "" / [ space method [ "" /
16432 space parameters ] ] ] ] ] ")"
16433 group = quote <string> quote
16434 level = <integer in the range of 1 to inf>
16436 marks-lists = nil / "(" *marks ")"
16437 marks = "(" <string> range ")"
16438 method = "(" <string> *elisp-forms ")"
16439 parameters = "(" *elisp-forms ")"
16442 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
16443 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
16446 If you have a Gnus info and want to access the elements, Gnus offers a
16447 series of macros for getting/setting these elements.
16450 @item gnus-info-group
16451 @itemx gnus-info-set-group
16452 @findex gnus-info-group
16453 @findex gnus-info-set-group
16454 Get/set the group name.
16456 @item gnus-info-rank
16457 @itemx gnus-info-set-rank
16458 @findex gnus-info-rank
16459 @findex gnus-info-set-rank
16460 Get/set the group rank.
16462 @item gnus-info-level
16463 @itemx gnus-info-set-level
16464 @findex gnus-info-level
16465 @findex gnus-info-set-level
16466 Get/set the group level.
16468 @item gnus-info-score
16469 @itemx gnus-info-set-score
16470 @findex gnus-info-score
16471 @findex gnus-info-set-score
16472 Get/set the group score.
16474 @item gnus-info-read
16475 @itemx gnus-info-set-read
16476 @findex gnus-info-read
16477 @findex gnus-info-set-read
16478 Get/set the ranges of read articles.
16480 @item gnus-info-marks
16481 @itemx gnus-info-set-marks
16482 @findex gnus-info-marks
16483 @findex gnus-info-set-marks
16484 Get/set the lists of ranges of marked articles.
16486 @item gnus-info-method
16487 @itemx gnus-info-set-method
16488 @findex gnus-info-method
16489 @findex gnus-info-set-method
16490 Get/set the group select method.
16492 @item gnus-info-params
16493 @itemx gnus-info-set-params
16494 @findex gnus-info-params
16495 @findex gnus-info-set-params
16496 Get/set the group parameters.
16499 All the getter functions take one parameter---the info list. The setter
16500 functions take two parameters---the info list and the new value.
16502 The last three elements in the group info aren't mandatory, so it may be
16503 necessary to extend the group info before setting the element. If this
16504 is necessary, you can just pass on a non-@code{nil} third parameter to
16505 the three final setter functions to have this happen automatically.
16508 @node Emacs/XEmacs Code
16509 @subsection Emacs/XEmacs Code
16513 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
16514 platforms must be the primary one. I chose Emacs. Not because I don't
16515 like XEmacs or Mule, but because it comes first alphabetically.
16517 This means that Gnus will byte-compile under Emacs with nary a warning,
16518 while XEmacs will pump out gigabytes of warnings while byte-compiling.
16519 As I use byte-compilation warnings to help me root out trivial errors in
16520 Gnus, that's very useful.
16522 I've also consistently used Emacs function interfaces, but have used
16523 Gnusey aliases for the functions. To take an example: Emacs defines a
16524 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
16525 function. I then define a function called @code{gnus-run-at-time} that
16526 takes the same parameters as the Emacs @code{run-at-time}. When running
16527 Gnus under Emacs, the former function is just an alias for the latter.
16528 However, when running under XEmacs, the former is an alias for the
16529 following function:
16532 (defun gnus-xmas-run-at-time (time repeat function &rest args)
16536 (,function ,@@args))
16540 This sort of thing has been done for bunches of functions. Gnus does
16541 not redefine any native Emacs functions while running under XEmacs---it
16542 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
16545 In the cases when the XEmacs function interface was obviously
16546 cleaner, I used it instead. For example @code{gnus-region-active-p}
16547 is an alias for @code{region-active-p} in XEmacs, whereas in Emacs
16550 Of course, I could have chosen XEmacs as my native platform and done
16551 mapping functions the other way around. But I didn't. The performance
16552 hit these indirections impose on Gnus under XEmacs should be slight.
16555 @node Various File Formats
16556 @subsection Various File Formats
16559 * Active File Format:: Information on articles and groups available.
16560 * Newsgroups File Format:: Group descriptions.
16564 @node Active File Format
16565 @subsubsection Active File Format
16567 The active file lists all groups that are available on the server in
16568 question. It also lists the highest and lowest current article numbers
16571 Here's an excerpt from a typical active file:
16574 soc.motss 296030 293865 y
16575 alt.binaries.pictures.fractals 3922 3913 n
16576 comp.sources.unix 1605 1593 m
16577 comp.binaries.ibm.pc 5097 5089 y
16578 no.general 1000 900 y
16581 Here's a pseudo-BNF definition of this file:
16584 active = *group-line
16585 group-line = group space high-number space low-number space flag <NEWLINE>
16586 group = <non-white-space string>
16588 high-number = <non-negative integer>
16589 low-number = <positive integer>
16590 flag = "y" / "n" / "m" / "j" / "x" / "=" group
16594 @node Newsgroups File Format
16595 @subsubsection Newsgroups File Format
16597 The newsgroups file lists groups along with their descriptions. Not all
16598 groups on the server have to be listed, and not all groups in the file
16599 have to exist on the server. The file is meant purely as information to
16602 The format is quite simple; a group name, a tab, and the description.
16603 Here's the definition:
16607 line = group tab description <NEWLINE>
16608 group = <non-white-space string>
16610 description = <string>
16614 @node Emacs for Heathens
16615 @section Emacs for Heathens
16617 Believe it or not, but some people who use Gnus haven't really used
16618 Emacs much before they embarked on their journey on the Gnus Love Boat.
16619 If you are one of those unfortunates whom ``@kbd{M-C-a}'', ``kill the
16620 region'', and ``set @code{gnus-flargblossen} to an alist where the key
16621 is a regexp that is used for matching on the group name'' are magical
16622 phrases with little or no meaning, then this appendix is for you. If
16623 you are already familiar with Emacs, just ignore this and go fondle your
16627 * Keystrokes:: Entering text and executing commands.
16628 * Emacs Lisp:: The built-in Emacs programming language.
16633 @subsection Keystrokes
16637 Q: What is an experienced Emacs user?
16640 A: A person who wishes that the terminal had pedals.
16643 Yes, when you use Emacs, you are apt to use the control key, the shift
16644 key and the meta key a lot. This is very annoying to some people
16645 (notably @code{vi}le users), and the rest of us just love the hell out
16646 of it. Just give up and submit. Emacs really does stand for
16647 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
16648 may have heard from other disreputable sources (like the Emacs author).
16650 The shift key is normally located near your pinky fingers, and are
16651 normally used to get capital letters and stuff. You probably use it all
16652 the time. The control key is normally marked ``CTRL'' or something like
16653 that. The meta key is, funnily enough, never marked as such on any
16654 keyboards. The one I'm currently at has a key that's marked ``Alt'',
16655 which is the meta key on this keyboard. It's usually located somewhere
16656 to the left hand side of the keyboard, usually on the bottom row.
16658 Now, us Emacs people doesn't say ``press the meta-control-m key'',
16659 because that's just too inconvenient. We say ``press the @kbd{M-C-m}
16660 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
16661 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
16662 down the control key, and hold it down while you press @kbd{k}''.
16663 ``Press @kbd{M-C-k}'' means ``press down and hold down the meta key and
16664 the control key and then press @kbd{k}''. Simple, ay?
16666 This is somewhat complicated by the fact that not all keyboards have a
16667 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
16668 means ``press escape, release escape, press @kbd{k}''. That's much more
16669 work than if you have a meta key, so if that's the case, I respectfully
16670 suggest you get a real keyboard with a meta key. You can't live without
16676 @subsection Emacs Lisp
16678 Emacs is the King of Editors because it's really a Lisp interpreter.
16679 Each and every key you tap runs some Emacs Lisp code snippet, and since
16680 Emacs Lisp is an interpreted language, that means that you can configure
16681 any key to run any arbitrary code. You just, like, do it.
16683 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
16684 functions. (These are byte-compiled for speed, but it's still
16685 interpreted.) If you decide that you don't like the way Gnus does
16686 certain things, it's trivial to have it do something a different way.
16687 (Well, at least if you know how to write Lisp code.) However, that's
16688 beyond the scope of this manual, so we are simply going to talk about
16689 some common constructs that you normally use in your @file{.emacs} file
16692 If you want to set the variable @code{gnus-florgbnize} to four (4), you
16693 write the following:
16696 (setq gnus-florgbnize 4)
16699 This function (really ``special form'') @code{setq} is the one that can
16700 set a variable to some value. This is really all you need to know. Now
16701 you can go and fill your @code{.emacs} file with lots of these to change
16704 If you have put that thing in your @code{.emacs} file, it will be read
16705 and @code{eval}ed (which is lisp-ese for ``run'') the next time you
16706 start Emacs. If you want to change the variable right away, simply say
16707 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
16708 previous ``form'', which here is a simple @code{setq} statement.
16710 Go ahead---just try it, if you're located at your Emacs. After you
16711 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
16712 is the return value of the form you @code{eval}ed.
16716 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
16720 (setq gnus-read-active-file 'some)
16723 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
16724 @samp{nntp.ifi.uio.no}'', that means:
16727 (setq gnus-nntp-server "nntp.ifi.uio.no")
16730 So be careful not to mix up strings (the latter) with symbols (the
16731 former). The manual is unambiguous, but it can be confusing.
16734 @include gnus-faq.texi