9 @documentencoding ISO-8859-1
12 Copyright @copyright{} 1995, 1996, 1997, 1998, 1999, 2000, 2001,
13 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.2 or
18 any later version published by the Free Software Foundation; with no
19 Invariant Sections, with the Front-Cover texts being ``A GNU
20 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
21 license is included in the section entitled ``GNU Free Documentation
22 License'' in the Emacs manual.
24 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
25 this GNU Manual, like GNU software. Copies published by the Free
26 Software Foundation raise funds for GNU development.''
28 This document is part of a collection distributed under the GNU Free
29 Documentation License. If you want to distribute this document
30 separately from the collection, you can do so by adding a copy of the
31 license to the document, as described in section 6 of the license.
37 \documentclass[twoside,a4paper,openright,11pt]{book}
38 \usepackage[latin1]{inputenc}
39 \usepackage{pagestyle}
42 \input{gnusconfig.tex}
44 \ifx\pdfoutput\undefined
46 \usepackage[pdftex,bookmarks,colorlinks=true]{hyperref}
54 % Adjust ../Makefile.in if you change the following line:
55 \newcommand{\gnusversionname}{No Gnus v0.7}
56 \newcommand{\gnuschaptername}{}
57 \newcommand{\gnussectionname}{}
59 \newcommand{\gnusbackslash}{/}
61 \newcommand{\gnusref}[1]{``#1'' on page \pageref{#1}}
62 \ifx\pdfoutput\undefined
63 \newcommand{\gnusuref}[1]{\gnustt{#1}}
65 \newcommand{\gnusuref}[1]{\href{#1}{\gnustt{#1}}}
67 \newcommand{\gnusxref}[1]{See ``#1'' on page \pageref{#1}}
68 \newcommand{\gnuspxref}[1]{see ``#1'' on page \pageref{#1}}
70 \newcommand{\gnuskindex}[1]{\index{#1}}
71 \newcommand{\gnusindex}[1]{\index{#1}}
73 \newcommand{\gnustt}[1]{{\gnusselectttfont{}#1}}
74 \newcommand{\gnuscode}[1]{\gnustt{#1}}
75 \newcommand{\gnusasis}[1]{\gnustt{#1}}
76 \newcommand{\gnusurl}[1]{\gnustt{#1}}
77 \newcommand{\gnuscommand}[1]{\gnustt{#1}}
78 \newcommand{\gnusenv}[1]{\gnustt{#1}}
79 \newcommand{\gnussamp}[1]{``{\fontencoding{OT1}\gnusselectttfont{}#1}''}
80 \newcommand{\gnuslisp}[1]{\gnustt{#1}}
81 \newcommand{\gnuskbd}[1]{`\gnustt{#1}'}
82 \newcommand{\gnuskey}[1]{`\gnustt{#1}'}
83 \newcommand{\gnusfile}[1]{`\gnustt{#1}'}
84 \newcommand{\gnusdfn}[1]{\textit{#1}}
85 \newcommand{\gnusi}[1]{\textit{#1}}
86 \newcommand{\gnusr}[1]{\textrm{#1}}
87 \newcommand{\gnusstrong}[1]{\textbf{#1}}
88 \newcommand{\gnusemph}[1]{\textit{#1}}
89 \newcommand{\gnusvar}[1]{{\fontsize{10pt}{10}\selectfont\textsl{\textsf{#1}}}}
90 \newcommand{\gnussc}[1]{\textsc{#1}}
91 \newcommand{\gnustitle}[1]{{\huge\textbf{#1}}}
92 \newcommand{\gnusversion}[1]{{\small\textit{#1}}}
93 \newcommand{\gnusauthor}[1]{{\large\textbf{#1}}}
94 \newcommand{\gnusresult}[1]{\gnustt{=> #1}}
95 \newcommand{\gnusacronym}[1]{\textsc{#1}}
96 \newcommand{\gnusemail}[1]{\textit{#1}}
98 \newcommand{\gnusbullet}{{${\bullet}$}}
99 \newcommand{\gnusdollar}{\$}
100 \newcommand{\gnusampersand}{\&}
101 \newcommand{\gnuspercent}{\%}
102 \newcommand{\gnushash}{\#}
103 \newcommand{\gnushat}{\symbol{"5E}}
104 \newcommand{\gnusunderline}{\symbol{"5F}}
105 \newcommand{\gnusnot}{$\neg$}
106 \newcommand{\gnustilde}{\symbol{"7E}}
107 \newcommand{\gnusless}{{$<$}}
108 \newcommand{\gnusgreater}{{$>$}}
109 \newcommand{\gnusbraceleft}{{$>$}}
110 \newcommand{\gnusbraceright}{{$>$}}
112 \newcommand{\gnushead}{\raisebox{-1cm}{\epsfig{figure=ps/gnus-head,height=1cm}}}
113 \newcommand{\gnusinteresting}{
114 \marginpar[\mbox{}\hfill\gnushead]{\gnushead}
117 \newcommand{\gnuscleardoublepage}{\ifodd\count0\mbox{}\clearpage\thispagestyle{empty}\mbox{}\clearpage\else\clearpage\fi}
119 \newcommand{\gnuspagechapter}[1]{
123 \newdimen{\gnusdimen}
126 \newcommand{\gnuschapter}[2]{
128 \ifdim \gnusdimen = 0pt\setcounter{page}{1}\pagestyle{gnus}\pagenumbering{arabic} \gnusdimen 1pt\fi
130 \renewcommand{\gnussectionname}{}
131 \renewcommand{\gnuschaptername}{#2}
132 \thispagestyle{empty}
134 \begin{picture}(500,500)(0,0)
135 \put(480,350){\makebox(0,0)[tr]{#1}}
136 \put(40,300){\makebox(500,50)[bl]{{\Huge\bf{#2}}}}
141 \newcommand{\gnusfigure}[3]{
143 \mbox{}\ifodd\count0\hspace*{-0.8cm}\else\hspace*{-3cm}\fi\begin{picture}(440,#2)
150 \newcommand{\gnusicon}[1]{
151 \marginpar[\mbox{}\hfill\raisebox{-1.5cm}{\epsfig{figure=ps/#1-up,height=1.5cm}}]{\raisebox{-1cm}{\epsfig{figure=ps/#1-up,height=1cm}}}
154 \newcommand{\gnuspicon}[1]{
155 \margindex{\epsfig{figure=#1,width=2cm}}
158 \newcommand{\gnusxface}[2]{
159 \margindex{\epsfig{figure=#1,width=1cm}\epsfig{figure=#2,width=1cm}}
162 \newcommand{\gnussmiley}[2]{
163 \margindex{\makebox[2cm]{\hfill\epsfig{figure=#1,width=0.5cm}\hfill\epsfig{figure=#2,width=0.5cm}\hfill}}
166 \newcommand{\gnusitemx}[1]{\mbox{}\vspace*{-\itemsep}\vspace*{-\parsep}\item#1}
168 \newcommand{\gnussection}[1]{
169 \renewcommand{\gnussectionname}{#1}
173 \newenvironment{codelist}%
178 \newenvironment{asislist}%
183 \newenvironment{kbdlist}%
189 \newenvironment{dfnlist}%
194 \newenvironment{stronglist}%
199 \newenvironment{samplist}%
204 \newenvironment{varlist}%
209 \newenvironment{emphlist}%
214 \newlength\gnusheadtextwidth
215 \setlength{\gnusheadtextwidth}{\headtextwidth}
216 \addtolength{\gnusheadtextwidth}{1cm}
218 \newpagestyle{gnuspreamble}%
223 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\mbox{}}\textbf{\hfill\roman{page}}}
227 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\roman{page}\hfill\mbox{}}}
236 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
238 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
243 \newpagestyle{gnusindex}%
248 \hspace*{-0.23cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\gnuschaptername\hfill\arabic{page}}}}
252 \hspace*{-3.25cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}
260 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
262 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
272 \makebox[12cm]{\hspace*{3.1cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{chapter}.\arabic{section}} \textbf{\gnussectionname\hfill\arabic{page}}}}}
276 \makebox[12cm]{\hspace*{-2.95cm}\underline{\makebox[\gnusheadtextwidth]{\textbf{\arabic{page}\hfill\gnuschaptername}}}}
284 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
286 \raisebox{-0.5cm}{\epsfig{figure=ps/gnus-big-logo,height=1cm}}
291 \pagenumbering{roman}
292 \pagestyle{gnuspreamble}
303 %\addtolength{\oddsidemargin}{-5cm}
304 %\addtolength{\evensidemargin}{-5cm}
306 \addtolength{\textheight}{2cm}
308 \gnustitle{\gnustitlename}\hfill\gnusversion{\gnusversionname}\\
311 \hspace*{0cm}\epsfig{figure=ps/gnus-big-logo,height=15cm}
314 \gnusauthor{by Lars Magne Ingebrigtsen}
321 \thispagestyle{empty}
335 * Gnus: (gnus). The newsreader Gnus.
340 @setchapternewpage odd
347 @author by Lars Magne Ingebrigtsen
349 @vskip 0pt plus 1filll
355 @top The Gnus Newsreader
359 You can read news (and mail) from within Emacs by using Gnus. The news
360 can be gotten by any nefarious means you can think of---@acronym{NNTP}, local
361 spool or your mbox file. All at the same time, if you want to push your
364 @c Adjust ../Makefile.in if you change the following line:
365 This manual corresponds to No Gnus v0.7.
376 Gnus is the advanced, self-documenting, customizable, extensible
377 unreal-time newsreader for GNU Emacs.
379 Oops. That sounds oddly familiar, so let's start over again to avoid
380 being accused of plagiarism:
382 Gnus is a message-reading laboratory. It will let you look at just
383 about anything as if it were a newsgroup. You can read mail with it,
384 you can browse directories with it, you can @code{ftp} with it---you
385 can even read news with it!
387 Gnus tries to empower people who read news the same way Emacs empowers
388 people who edit text. Gnus sets no limits to what the user should be
389 allowed to do. Users are encouraged to extend Gnus to make it behave
390 like they want it to behave. A program should not control people;
391 people should be empowered to do what they want by using (or abusing)
397 * Starting Up:: Finding news can be a pain.
398 * Group Buffer:: Selecting, subscribing and killing groups.
399 * Summary Buffer:: Reading, saving and posting articles.
400 * Article Buffer:: Displaying and handling articles.
401 * Composing Messages:: Information on sending mail and news.
402 * Select Methods:: Gnus reads all messages from various select methods.
403 * Scoring:: Assigning values to articles.
404 * Various:: General purpose settings.
405 * The End:: Farewell and goodbye.
406 * Appendices:: Terminology, Emacs intro, @acronym{FAQ}, History, Internals.
407 * GNU Free Documentation License:: The license for this documentation.
408 * Index:: Variable, function and concept index.
409 * Key Index:: Key Index.
411 Other related manuals
413 * Message:(message). Composing messages.
414 * Emacs-MIME:(emacs-mime). Composing messages; @acronym{MIME}-specific parts.
415 * Sieve:(sieve). Managing Sieve scripts in Emacs.
416 * PGG:(pgg). @acronym{PGP/MIME} with Gnus.
417 * SASL:(sasl). @acronym{SASL} authentication in Emacs.
420 --- The Detailed Node Listing ---
424 * Finding the News:: Choosing a method for getting news.
425 * The First Time:: What does Gnus do the first time you start it?
426 * The Server is Down:: How can I read my mail then?
427 * Slave Gnusae:: You can have more than one Gnus active at a time.
428 * Fetching a Group:: Starting Gnus just to read a group.
429 * New Groups:: What is Gnus supposed to do with new groups?
430 * Changing Servers:: You may want to move from one server to another.
431 * Startup Files:: Those pesky startup files---@file{.newsrc}.
432 * Auto Save:: Recovering from a crash.
433 * The Active File:: Reading the active file over a slow line Takes Time.
434 * Startup Variables:: Other variables you might change.
438 * Checking New Groups:: Determining what groups are new.
439 * Subscription Methods:: What Gnus should do with new groups.
440 * Filtering New Groups:: Making Gnus ignore certain new groups.
444 * Group Buffer Format:: Information listed and how you can change it.
445 * Group Maneuvering:: Commands for moving in the group buffer.
446 * Selecting a Group:: Actually reading news.
447 * Subscription Commands:: Unsubscribing, killing, subscribing.
448 * Group Data:: Changing the info for a group.
449 * Group Levels:: Levels? What are those, then?
450 * Group Score:: A mechanism for finding out what groups you like.
451 * Marking Groups:: You can mark groups for later processing.
452 * Foreign Groups:: Creating and editing groups.
453 * Group Parameters:: Each group may have different parameters set.
454 * Listing Groups:: Gnus can list various subsets of the groups.
455 * Sorting Groups:: Re-arrange the group order.
456 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
457 * Browse Foreign Server:: You can browse a server. See what it has to offer.
458 * Exiting Gnus:: Stop reading news and get some work done.
459 * Group Topics:: A folding group mode divided into topics.
460 * Non-ASCII Group Names:: Accessing groups of non-English names.
461 * Misc Group Stuff:: Other stuff that you can to do.
465 * Group Line Specification:: Deciding how the group buffer is to look.
466 * Group Mode Line Specification:: The group buffer mode line.
467 * Group Highlighting:: Having nice colors in the group buffer.
471 * Topic Commands:: Interactive E-Z commands.
472 * Topic Variables:: How to customize the topics the Lisp Way.
473 * Topic Sorting:: Sorting each topic individually.
474 * Topic Topology:: A map of the world.
475 * Topic Parameters:: Parameters that apply to all groups in a topic.
479 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
480 * Group Information:: Information and help on groups and Gnus.
481 * Group Timestamp:: Making Gnus keep track of when you last read a group.
482 * File Commands:: Reading and writing the Gnus files.
483 * Sieve Commands:: Managing Sieve scripts.
487 * Summary Buffer Format:: Deciding how the summary buffer is to look.
488 * Summary Maneuvering:: Moving around the summary buffer.
489 * Choosing Articles:: Reading articles.
490 * Paging the Article:: Scrolling the current article.
491 * Reply Followup and Post:: Posting articles.
492 * Delayed Articles:: Send articles at a later time.
493 * Marking Articles:: Marking articles as read, expirable, etc.
494 * Limiting:: You can limit the summary buffer.
495 * Threading:: How threads are made.
496 * Sorting the Summary Buffer:: How articles and threads are sorted.
497 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
498 * Article Caching:: You may store articles in a cache.
499 * Persistent Articles:: Making articles expiry-resistant.
500 * Sticky Articles:: Article buffers that are not reused.
501 * Article Backlog:: Having already read articles hang around.
502 * Saving Articles:: Ways of customizing article saving.
503 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
504 * Article Treatment:: The article buffer can be mangled at will.
505 * MIME Commands:: Doing MIMEy things with the articles.
506 * Charsets:: Character set issues.
507 * Article Commands:: Doing various things with the article buffer.
508 * Summary Sorting:: Sorting the summary buffer in various ways.
509 * Finding the Parent:: No child support? Get the parent.
510 * Alternative Approaches:: Reading using non-default summaries.
511 * Tree Display:: A more visual display of threads.
512 * Mail Group Commands:: Some commands can only be used in mail groups.
513 * Various Summary Stuff:: What didn't fit anywhere else.
514 * Exiting the Summary Buffer:: Returning to the Group buffer,
515 or reselecting the current group.
516 * Crosspost Handling:: How crossposted articles are dealt with.
517 * Duplicate Suppression:: An alternative when crosspost handling fails.
518 * Security:: Decrypt and Verify.
519 * Mailing List:: Mailing list minor mode.
521 Summary Buffer Format
523 * Summary Buffer Lines:: You can specify how summary lines should look.
524 * To From Newsgroups:: How to not display your own name.
525 * Summary Buffer Mode Line:: You can say how the mode line should look.
526 * Summary Highlighting:: Making the summary buffer all pretty and nice.
530 * Choosing Commands:: Commands for choosing articles.
531 * Choosing Variables:: Variables that influence these commands.
533 Reply, Followup and Post
535 * Summary Mail Commands:: Sending mail.
536 * Summary Post Commands:: Sending news.
537 * Summary Message Commands:: Other Message-related commands.
538 * Canceling and Superseding::
542 * Unread Articles:: Marks for unread articles.
543 * Read Articles:: Marks for read articles.
544 * Other Marks:: Marks that do not affect readedness.
545 * Setting Marks:: How to set and remove marks.
546 * Generic Marking Commands:: How to customize the marking.
547 * Setting Process Marks:: How to mark articles for later processing.
551 * Customizing Threading:: Variables you can change to affect the threading.
552 * Thread Commands:: Thread based commands in the summary buffer.
554 Customizing Threading
556 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
557 * Filling In Threads:: Making the threads displayed look fuller.
558 * More Threading:: Even more variables for fiddling with threads.
559 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
563 * Uuencoded Articles:: Uudecode articles.
564 * Shell Archives:: Unshar articles.
565 * PostScript Files:: Split PostScript.
566 * Other Files:: Plain save and binhex.
567 * Decoding Variables:: Variables for a happy decoding.
568 * Viewing Files:: You want to look at the result of the decoding?
572 * Rule Variables:: Variables that say how a file is to be viewed.
573 * Other Decode Variables:: Other decode variables.
574 * Uuencoding and Posting:: Variables for customizing uuencoding.
578 * Article Highlighting:: You want to make the article look like fruit salad.
579 * Article Fontisizing:: Making emphasized text look nice.
580 * Article Hiding:: You also want to make certain info go away.
581 * Article Washing:: Lots of way-neat functions to make life better.
582 * Article Header:: Doing various header transformations.
583 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
584 * Article Button Levels:: Controlling appearance of buttons.
585 * Article Date:: Grumble, UT!
586 * Article Display:: Display various stuff---X-Face, Picons, Smileys
587 * Article Signature:: What is a signature?
588 * Article Miscellanea:: Various other stuff.
590 Alternative Approaches
592 * Pick and Read:: First mark articles and then read them.
593 * Binary Groups:: Auto-decode all articles.
595 Various Summary Stuff
597 * Summary Group Information:: Information oriented commands.
598 * Searching for Articles:: Multiple article commands.
599 * Summary Generation Commands::
600 * Really Various Summary Commands:: Those pesky non-conformant commands.
604 * Hiding Headers:: Deciding what headers should be displayed.
605 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
606 * Customizing Articles:: Tailoring the look of the articles.
607 * Article Keymap:: Keystrokes available in the article buffer.
608 * Misc Article:: Other stuff.
612 * Mail:: Mailing and replying.
613 * Posting Server:: What server should you post and mail via?
614 * POP before SMTP:: You cannot send a mail unless you read a mail.
615 * Mail and Post:: Mailing and posting at the same time.
616 * Archived Messages:: Where Gnus stores the messages you've sent.
617 * Posting Styles:: An easier way to specify who you are.
618 * Drafts:: Postponing messages and rejected messages.
619 * Rejected Articles:: What happens if the server doesn't like your article?
620 * Signing and encrypting:: How to compose secure messages.
624 * Server Buffer:: Making and editing virtual servers.
625 * Getting News:: Reading USENET news with Gnus.
626 * Getting Mail:: Reading your personal mail with Gnus.
627 * Browsing the Web:: Getting messages from a plethora of Web sources.
628 * IMAP:: Using Gnus as a @acronym{IMAP} client.
629 * Other Sources:: Reading directories, files, SOUP packets.
630 * Combined Groups:: Combining groups into one group.
631 * Email Based Diary:: Using mails to manage diary events in Gnus.
632 * Gnus Unplugged:: Reading news and mail offline.
636 * Server Buffer Format:: You can customize the look of this buffer.
637 * Server Commands:: Commands to manipulate servers.
638 * Example Methods:: Examples server specifications.
639 * Creating a Virtual Server:: An example session.
640 * Server Variables:: Which variables to set.
641 * Servers and Methods:: You can use server names as select methods.
642 * Unavailable Servers:: Some servers you try to contact may be down.
646 * NNTP:: Reading news from an @acronym{NNTP} server.
647 * News Spool:: Reading news from the local spool.
651 * Direct Functions:: Connecting directly to the server.
652 * Indirect Functions:: Connecting indirectly to the server.
653 * Common Variables:: Understood by several connection functions.
654 * NNTP marks:: Storing marks for @acronym{NNTP} servers.
658 * Mail in a Newsreader:: Important introductory notes.
659 * Getting Started Reading Mail:: A simple cookbook example.
660 * Splitting Mail:: How to create mail groups.
661 * Mail Sources:: How to tell Gnus where to get mail from.
662 * Mail Back End Variables:: Variables for customizing mail handling.
663 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
664 * Group Mail Splitting:: Use group customize to drive mail splitting.
665 * Incorporating Old Mail:: What about the old mail you have?
666 * Expiring Mail:: Getting rid of unwanted mail.
667 * Washing Mail:: Removing cruft from the mail you get.
668 * Duplicates:: Dealing with duplicated mail.
669 * Not Reading Mail:: Using mail back ends for reading other files.
670 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
674 * Mail Source Specifiers:: How to specify what a mail source is.
675 * Mail Source Customization:: Some variables that influence things.
676 * Fetching Mail:: Using the mail source specifiers.
678 Choosing a Mail Back End
680 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
681 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
682 * Mail Spool:: Store your mail in a private spool?
683 * MH Spool:: An mhspool-like back end.
684 * Maildir:: Another one-file-per-message format.
685 * Mail Folders:: Having one file for each group.
686 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
691 * Web Searches:: Creating groups from articles that match a string.
692 * Slashdot:: Reading the Slashdot comments.
693 * Ultimate:: The Ultimate Bulletin Board systems.
694 * Web Archive:: Reading mailing list archived on web.
695 * RSS:: Reading RDF site summary.
696 * Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
700 * Splitting in IMAP:: Splitting mail with nnimap.
701 * Expiring in IMAP:: Expiring mail with nnimap.
702 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
703 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
704 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
705 * Debugging IMAP:: What to do when things don't work.
709 * Directory Groups:: You can read a directory as if it was a newsgroup.
710 * Anything Groups:: Dired? Who needs dired?
711 * Document Groups:: Single files can be the basis of a group.
712 * SOUP:: Reading @sc{soup} packets ``offline''.
713 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
717 * Document Server Internals:: How to add your own document types.
721 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
722 * SOUP Groups:: A back end for reading @sc{soup} packets.
723 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
727 * Virtual Groups:: Combining articles from many groups.
728 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
732 * The NNDiary Back End:: Basic setup and usage.
733 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
734 * Sending or Not Sending:: A final note on sending diary messages.
738 * Diary Messages:: What makes a message valid for nndiary.
739 * Running NNDiary:: NNDiary has two modes of operation.
740 * Customizing NNDiary:: Bells and whistles.
742 The Gnus Diary Library
744 * Diary Summary Line Format:: A nicer summary buffer line format.
745 * Diary Articles Sorting:: A nicer way to sort messages.
746 * Diary Headers Generation:: Not doing it manually.
747 * Diary Group Parameters:: Not handling them manually.
751 * Agent Basics:: How it all is supposed to work.
752 * Agent Categories:: How to tell the Gnus Agent what to download.
753 * Agent Commands:: New commands for all the buffers.
754 * Agent Visuals:: Ways that the agent may effect your summary buffer.
755 * Agent as Cache:: The Agent is a big cache too.
756 * Agent Expiry:: How to make old articles go away.
757 * Agent Regeneration:: How to recover from lost connections and other accidents.
758 * Agent and flags:: How the Agent maintains flags.
759 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
760 * Outgoing Messages:: What happens when you post/mail something?
761 * Agent Variables:: Customizing is fun.
762 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
763 * Batching Agents:: How to fetch news from a @code{cron} job.
764 * Agent Caveats:: What you think it'll do and what it does.
768 * Category Syntax:: What a category looks like.
769 * Category Buffer:: A buffer for maintaining categories.
770 * Category Variables:: Customize'r'Us.
774 * Group Agent Commands:: Configure groups and fetch their contents.
775 * Summary Agent Commands:: Manually select then fetch specific articles.
776 * Server Agent Commands:: Select the servers that are supported by the agent.
780 * Summary Score Commands:: Adding score entries for the current group.
781 * Group Score Commands:: General score commands.
782 * Score Variables:: Customize your scoring. (My, what terminology).
783 * Score File Format:: What a score file may contain.
784 * Score File Editing:: You can edit score files by hand as well.
785 * Adaptive Scoring:: Big Sister Gnus knows what you read.
786 * Home Score File:: How to say where new score entries are to go.
787 * Followups To Yourself:: Having Gnus notice when people answer you.
788 * Scoring On Other Headers:: Scoring on non-standard headers.
789 * Scoring Tips:: How to score effectively.
790 * Reverse Scoring:: That problem child of old is not problem.
791 * Global Score Files:: Earth-spanning, ear-splitting score files.
792 * Kill Files:: They are still here, but they can be ignored.
793 * Converting Kill Files:: Translating kill files to score files.
794 * Advanced Scoring:: Using logical expressions to build score rules.
795 * Score Decays:: It can be useful to let scores wither away.
799 * Advanced Scoring Syntax:: A definition.
800 * Advanced Scoring Examples:: What they look like.
801 * Advanced Scoring Tips:: Getting the most out of it.
805 * Process/Prefix:: A convention used by many treatment commands.
806 * Interactive:: Making Gnus ask you many questions.
807 * Symbolic Prefixes:: How to supply some Gnus functions with options.
808 * Formatting Variables:: You can specify what buffers should look like.
809 * Window Layout:: Configuring the Gnus buffer windows.
810 * Faces and Fonts:: How to change how faces look.
811 * Compilation:: How to speed Gnus up.
812 * Mode Lines:: Displaying information in the mode lines.
813 * Highlighting and Menus:: Making buffers look all nice and cozy.
814 * Buttons:: Get tendinitis in ten easy steps!
815 * Daemons:: Gnus can do things behind your back.
816 * NoCeM:: How to avoid spam and other fatty foods.
817 * Undo:: Some actions can be undone.
818 * Predicate Specifiers:: Specifying predicates.
819 * Moderation:: What to do if you're a moderator.
820 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
821 * Fuzzy Matching:: What's the big fuzz?
822 * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email.
823 * Spam Package:: A package for filtering and processing spam.
824 * Other modes:: Interaction with other modes.
825 * Various Various:: Things that are really various.
829 * Formatting Basics:: A formatting variable is basically a format string.
830 * Mode Line Formatting:: Some rules about mode line formatting variables.
831 * Advanced Formatting:: Modifying output in various ways.
832 * User-Defined Specs:: Having Gnus call your own functions.
833 * Formatting Fonts:: Making the formatting look colorful and nice.
834 * Positioning Point:: Moving point to a position after an operation.
835 * Tabulation:: Tabulating your output.
836 * Wide Characters:: Dealing with wide characters.
840 * X-Face:: Display a funky, teensy black-and-white image.
841 * Face:: Display a funkier, teensier colored image.
842 * Smileys:: Show all those happy faces the way they were
844 * Picons:: How to display pictures of what you're reading.
845 * XVarious:: Other XEmacsy Gnusey variables.
849 * The problem of spam:: Some background, and some solutions
850 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
851 * SpamAssassin:: How to use external anti-spam tools.
852 * Hashcash:: Reduce spam by burning CPU time.
856 * Spam Package Introduction::
857 * Filtering Incoming Mail::
858 * Detecting Spam in Groups::
859 * Spam and Ham Processors::
860 * Spam Package Configuration Examples::
862 * Extending the Spam package::
863 * Spam Statistics Package::
865 Spam Statistics Package
867 * Creating a spam-stat dictionary::
868 * Splitting mail using spam-stat::
869 * Low-level interface to the spam-stat dictionary::
873 * XEmacs:: Requirements for installing under XEmacs.
874 * History:: How Gnus got where it is today.
875 * On Writing Manuals:: Why this is not a beginner's guide.
876 * Terminology:: We use really difficult, like, words here.
877 * Customization:: Tailoring Gnus to your needs.
878 * Troubleshooting:: What you might try if things do not work.
879 * Gnus Reference Guide:: Rilly, rilly technical stuff.
880 * Emacs for Heathens:: A short introduction to Emacsian terms.
881 * Frequently Asked Questions:: The Gnus FAQ
885 * Gnus Versions:: What Gnus versions have been released.
886 * Other Gnus Versions:: Other Gnus versions that also have been released.
887 * Why?:: What's the point of Gnus?
888 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
889 * Conformity:: Gnus tries to conform to all standards.
890 * Emacsen:: Gnus can be run on a few modern Emacsen.
891 * Gnus Development:: How Gnus is developed.
892 * Contributors:: Oodles of people.
893 * New Features:: Pointers to some of the new stuff in Gnus.
897 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
898 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
899 * Red Gnus:: Third time best---Gnus 5.4/5.5.
900 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
901 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
902 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
903 * No Gnus:: Very punny.
907 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
908 * Slow Terminal Connection:: You run a remote Emacs.
909 * Little Disk Space:: You feel that having large setup files is icky.
910 * Slow Machine:: You feel like buying a faster machine.
914 * Gnus Utility Functions:: Common functions and variable to use.
915 * Back End Interface:: How Gnus communicates with the servers.
916 * Score File Syntax:: A BNF definition of the score file standard.
917 * Headers:: How Gnus stores headers internally.
918 * Ranges:: A handy format for storing mucho numbers.
919 * Group Info:: The group info format.
920 * Extended Interactive:: Symbolic prefixes and stuff.
921 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
922 * Various File Formats:: Formats of files that Gnus use.
926 * Required Back End Functions:: Functions that must be implemented.
927 * Optional Back End Functions:: Functions that need not be implemented.
928 * Error Messaging:: How to get messages and report errors.
929 * Writing New Back Ends:: Extending old back ends.
930 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
931 * Mail-like Back Ends:: Some tips on mail back ends.
935 * Active File Format:: Information on articles and groups available.
936 * Newsgroups File Format:: Group descriptions.
940 * Keystrokes:: Entering text and executing commands.
941 * Emacs Lisp:: The built-in Emacs programming language.
947 @chapter Starting Gnus
950 If you haven't used Emacs much before using Gnus, read @ref{Emacs for
955 If your system administrator has set things up properly, starting Gnus
956 and reading news is extremely easy---you just type @kbd{M-x gnus} in
957 your Emacs. If not, you should customize the variable
958 @code{gnus-select-method} as described in @ref{Finding the News}. For a
959 minimal setup for posting should also customize the variables
960 @code{user-full-name} and @code{user-mail-address}.
962 @findex gnus-other-frame
963 @kindex M-x gnus-other-frame
964 If you want to start Gnus in a different frame, you can use the command
965 @kbd{M-x gnus-other-frame} instead.
967 If things do not go smoothly at startup, you have to twiddle some
968 variables in your @file{~/.gnus.el} file. This file is similar to
969 @file{~/.emacs}, but is read when Gnus starts.
971 If you puzzle at any terms used in this manual, please refer to the
972 terminology section (@pxref{Terminology}).
975 * Finding the News:: Choosing a method for getting news.
976 * The First Time:: What does Gnus do the first time you start it?
977 * The Server is Down:: How can I read my mail then?
978 * Slave Gnusae:: You can have more than one Gnus active at a time.
979 * New Groups:: What is Gnus supposed to do with new groups?
980 * Changing Servers:: You may want to move from one server to another.
981 * Startup Files:: Those pesky startup files---@file{.newsrc}.
982 * Auto Save:: Recovering from a crash.
983 * The Active File:: Reading the active file over a slow line Takes Time.
984 * Startup Variables:: Other variables you might change.
988 @node Finding the News
989 @section Finding the News
992 @vindex gnus-select-method
994 The @code{gnus-select-method} variable says where Gnus should look for
995 news. This variable should be a list where the first element says
996 @dfn{how} and the second element says @dfn{where}. This method is your
997 native method. All groups not fetched with this method are
1000 For instance, if the @samp{news.somewhere.edu} @acronym{NNTP} server is where
1001 you want to get your daily dosage of news from, you'd say:
1004 (setq gnus-select-method '(nntp "news.somewhere.edu"))
1007 If you want to read directly from the local spool, say:
1010 (setq gnus-select-method '(nnspool ""))
1013 If you can use a local spool, you probably should, as it will almost
1014 certainly be much faster. But do not use the local spool if your
1015 server is running Leafnode (which is a simple, standalone private news
1016 server); in this case, use @code{(nntp "localhost")}.
1018 @vindex gnus-nntpserver-file
1020 @cindex @acronym{NNTP} server
1021 If this variable is not set, Gnus will take a look at the
1022 @env{NNTPSERVER} environment variable. If that variable isn't set,
1023 Gnus will see whether @code{gnus-nntpserver-file}
1024 (@file{/etc/nntpserver} by default) has any opinions on the matter.
1025 If that fails as well, Gnus will try to use the machine running Emacs
1026 as an @acronym{NNTP} server. That's a long shot, though.
1028 @vindex gnus-nntp-server
1029 If @code{gnus-nntp-server} is set, this variable will override
1030 @code{gnus-select-method}. You should therefore set
1031 @code{gnus-nntp-server} to @code{nil}, which is what it is by default.
1033 @vindex gnus-secondary-servers
1034 @vindex gnus-nntp-server
1035 You can also make Gnus prompt you interactively for the name of an
1036 @acronym{NNTP} server. If you give a non-numerical prefix to @code{gnus}
1037 (i.e., @kbd{C-u M-x gnus}), Gnus will let you choose between the servers
1038 in the @code{gnus-secondary-servers} list (if any). You can also just
1039 type in the name of any server you feel like visiting. (Note that this
1040 will set @code{gnus-nntp-server}, which means that if you then @kbd{M-x
1041 gnus} later in the same Emacs session, Gnus will contact the same
1044 @findex gnus-group-browse-foreign-server
1046 However, if you use one @acronym{NNTP} server regularly and are just
1047 interested in a couple of groups from a different server, you would be
1048 better served by using the @kbd{B} command in the group buffer. It will
1049 let you have a look at what groups are available, and you can subscribe
1050 to any of the groups you want to. This also makes @file{.newsrc}
1051 maintenance much tidier. @xref{Foreign Groups}.
1053 @vindex gnus-secondary-select-methods
1055 A slightly different approach to foreign groups is to set the
1056 @code{gnus-secondary-select-methods} variable. The select methods
1057 listed in this variable are in many ways just as native as the
1058 @code{gnus-select-method} server. They will also be queried for active
1059 files during startup (if that's required), and new newsgroups that
1060 appear on these servers will be subscribed (or not) just as native
1063 For instance, if you use the @code{nnmbox} back end to read your mail,
1064 you would typically set this variable to
1067 (setq gnus-secondary-select-methods '((nnmbox "")))
1070 Note: the @acronym{NNTP} back end stores marks in marks files
1071 (@pxref{NNTP marks}). This feature makes it easy to share marks between
1072 several Gnus installations, but may slow down things a bit when fetching
1073 new articles. @xref{NNTP marks}, for more information.
1076 @node The First Time
1077 @section The First Time
1078 @cindex first time usage
1080 If no startup files exist (@pxref{Startup Files}), Gnus will try to
1081 determine what groups should be subscribed by default.
1083 @vindex gnus-default-subscribed-newsgroups
1084 If the variable @code{gnus-default-subscribed-newsgroups} is set, Gnus
1085 will subscribe you to just those groups in that list, leaving the rest
1086 killed. Your system administrator should have set this variable to
1089 Since she hasn't, Gnus will just subscribe you to a few arbitrarily
1090 picked groups (i.e., @samp{*.newusers}). (@dfn{Arbitrary} is defined
1091 here as @dfn{whatever Lars thinks you should read}.)
1093 You'll also be subscribed to the Gnus documentation group, which should
1094 help you with most common problems.
1096 If @code{gnus-default-subscribed-newsgroups} is @code{t}, Gnus will just
1097 use the normal functions for handling new groups, and not do anything
1101 @node The Server is Down
1102 @section The Server is Down
1103 @cindex server errors
1105 If the default server is down, Gnus will understandably have some
1106 problems starting. However, if you have some mail groups in addition to
1107 the news groups, you may want to start Gnus anyway.
1109 Gnus, being the trusting sort of program, will ask whether to proceed
1110 without a native select method if that server can't be contacted. This
1111 will happen whether the server doesn't actually exist (i.e., you have
1112 given the wrong address) or the server has just momentarily taken ill
1113 for some reason or other. If you decide to continue and have no foreign
1114 groups, you'll find it difficult to actually do anything in the group
1115 buffer. But, hey, that's your problem. Blllrph!
1117 @findex gnus-no-server
1118 @kindex M-x gnus-no-server
1120 If you know that the server is definitely down, or you just want to read
1121 your mail without bothering with the server at all, you can use the
1122 @code{gnus-no-server} command to start Gnus. That might come in handy
1123 if you're in a hurry as well. This command will not attempt to contact
1124 your primary server---instead, it will just activate all groups on level
1125 1 and 2. (You should preferably keep no native groups on those two
1126 levels.) Also @pxref{Group Levels}.
1130 @section Slave Gnusae
1133 You might want to run more than one Emacs with more than one Gnus at the
1134 same time. If you are using different @file{.newsrc} files (e.g., if you
1135 are using the two different Gnusae to read from two different servers),
1136 that is no problem whatsoever. You just do it.
1138 The problem appears when you want to run two Gnusae that use the same
1139 @file{.newsrc} file.
1141 To work around that problem some, we here at the Think-Tank at the Gnus
1142 Towers have come up with a new concept: @dfn{Masters} and
1143 @dfn{slaves}. (We have applied for a patent on this concept, and have
1144 taken out a copyright on those words. If you wish to use those words in
1145 conjunction with each other, you have to send $1 per usage instance to
1146 me. Usage of the patent (@dfn{Master/Slave Relationships In Computer
1147 Applications}) will be much more expensive, of course.)
1150 Anyway, you start one Gnus up the normal way with @kbd{M-x gnus} (or
1151 however you do it). Each subsequent slave Gnusae should be started with
1152 @kbd{M-x gnus-slave}. These slaves won't save normal @file{.newsrc}
1153 files, but instead save @dfn{slave files} that contain information only
1154 on what groups have been read in the slave session. When a master Gnus
1155 starts, it will read (and delete) these slave files, incorporating all
1156 information from them. (The slave files will be read in the sequence
1157 they were created, so the latest changes will have precedence.)
1159 Information from the slave files has, of course, precedence over the
1160 information in the normal (i.e., master) @file{.newsrc} file.
1162 If the @file{.newsrc*} files have not been saved in the master when the
1163 slave starts, you may be prompted as to whether to read an auto-save
1164 file. If you answer ``yes'', the unsaved changes to the master will be
1165 incorporated into the slave. If you answer ``no'', the slave may see some
1166 messages as unread that have been read in the master.
1173 @cindex subscription
1175 @vindex gnus-check-new-newsgroups
1176 If you are satisfied that you really never want to see any new groups,
1177 you can set @code{gnus-check-new-newsgroups} to @code{nil}. This will
1178 also save you some time at startup. Even if this variable is
1179 @code{nil}, you can always subscribe to the new groups just by pressing
1180 @kbd{U} in the group buffer (@pxref{Group Maintenance}). This variable
1181 is @code{ask-server} by default. If you set this variable to
1182 @code{always}, then Gnus will query the back ends for new groups even
1183 when you do the @kbd{g} command (@pxref{Scanning New Messages}).
1186 * Checking New Groups:: Determining what groups are new.
1187 * Subscription Methods:: What Gnus should do with new groups.
1188 * Filtering New Groups:: Making Gnus ignore certain new groups.
1192 @node Checking New Groups
1193 @subsection Checking New Groups
1195 Gnus normally determines whether a group is new or not by comparing the
1196 list of groups from the active file(s) with the lists of subscribed and
1197 dead groups. This isn't a particularly fast method. If
1198 @code{gnus-check-new-newsgroups} is @code{ask-server}, Gnus will ask the
1199 server for new groups since the last time. This is both faster and
1200 cheaper. This also means that you can get rid of the list of killed
1201 groups altogether, so you may set @code{gnus-save-killed-list} to
1202 @code{nil}, which will save time both at startup, at exit, and all over.
1203 Saves disk space, too. Why isn't this the default, then?
1204 Unfortunately, not all servers support this command.
1206 I bet I know what you're thinking now: How do I find out whether my
1207 server supports @code{ask-server}? No? Good, because I don't have a
1208 fail-safe answer. I would suggest just setting this variable to
1209 @code{ask-server} and see whether any new groups appear within the next
1210 few days. If any do, then it works. If none do, then it doesn't
1211 work. I could write a function to make Gnus guess whether the server
1212 supports @code{ask-server}, but it would just be a guess. So I won't.
1213 You could @code{telnet} to the server and say @code{HELP} and see
1214 whether it lists @samp{NEWGROUPS} among the commands it understands. If
1215 it does, then it might work. (But there are servers that lists
1216 @samp{NEWGROUPS} without supporting the function properly.)
1218 This variable can also be a list of select methods. If so, Gnus will
1219 issue an @code{ask-server} command to each of the select methods, and
1220 subscribe them (or not) using the normal methods. This might be handy
1221 if you are monitoring a few servers for new groups. A side effect is
1222 that startup will take much longer, so you can meditate while waiting.
1223 Use the mantra ``dingnusdingnusdingnus'' to achieve permanent bliss.
1226 @node Subscription Methods
1227 @subsection Subscription Methods
1229 @vindex gnus-subscribe-newsgroup-method
1230 What Gnus does when it encounters a new group is determined by the
1231 @code{gnus-subscribe-newsgroup-method} variable.
1233 This variable should contain a function. This function will be called
1234 with the name of the new group as the only parameter.
1236 Some handy pre-fab functions are:
1240 @item gnus-subscribe-zombies
1241 @vindex gnus-subscribe-zombies
1242 Make all new groups zombies. This is the default. You can browse the
1243 zombies later (with @kbd{A z}) and either kill them all off properly
1244 (with @kbd{S z}), or subscribe to them (with @kbd{u}).
1246 @item gnus-subscribe-randomly
1247 @vindex gnus-subscribe-randomly
1248 Subscribe all new groups in arbitrary order. This really means that all
1249 new groups will be added at ``the top'' of the group buffer.
1251 @item gnus-subscribe-alphabetically
1252 @vindex gnus-subscribe-alphabetically
1253 Subscribe all new groups in alphabetical order.
1255 @item gnus-subscribe-hierarchically
1256 @vindex gnus-subscribe-hierarchically
1257 Subscribe all new groups hierarchically. The difference between this
1258 function and @code{gnus-subscribe-alphabetically} is slight.
1259 @code{gnus-subscribe-alphabetically} will subscribe new groups in a strictly
1260 alphabetical fashion, while this function will enter groups into its
1261 hierarchy. So if you want to have the @samp{rec} hierarchy before the
1262 @samp{comp} hierarchy, this function will not mess that configuration
1263 up. Or something like that.
1265 @item gnus-subscribe-interactively
1266 @vindex gnus-subscribe-interactively
1267 Subscribe new groups interactively. This means that Gnus will ask
1268 you about @strong{all} new groups. The groups you choose to subscribe
1269 to will be subscribed hierarchically.
1271 @item gnus-subscribe-killed
1272 @vindex gnus-subscribe-killed
1273 Kill all new groups.
1275 @item gnus-subscribe-topics
1276 @vindex gnus-subscribe-topics
1277 Put the groups into the topic that has a matching @code{subscribe} topic
1278 parameter (@pxref{Topic Parameters}). For instance, a @code{subscribe}
1279 topic parameter that looks like
1285 will mean that all groups that match that regex will be subscribed under
1288 If no topics match the groups, the groups will be subscribed in the
1293 @vindex gnus-subscribe-hierarchical-interactive
1294 A closely related variable is
1295 @code{gnus-subscribe-hierarchical-interactive}. (That's quite a
1296 mouthful.) If this variable is non-@code{nil}, Gnus will ask you in a
1297 hierarchical fashion whether to subscribe to new groups or not. Gnus
1298 will ask you for each sub-hierarchy whether you want to descend the
1301 One common mistake is to set the variable a few paragraphs above
1302 (@code{gnus-subscribe-newsgroup-method}) to
1303 @code{gnus-subscribe-hierarchical-interactive}. This is an error. This
1304 will not work. This is ga-ga. So don't do it.
1307 @node Filtering New Groups
1308 @subsection Filtering New Groups
1310 A nice and portable way to control which new newsgroups should be
1311 subscribed (or ignored) is to put an @dfn{options} line at the start of
1312 the @file{.newsrc} file. Here's an example:
1315 options -n !alt.all !rec.all sci.all
1318 @vindex gnus-subscribe-options-newsgroup-method
1319 This line obviously belongs to a serious-minded intellectual scientific
1320 person (or she may just be plain old boring), because it says that all
1321 groups that have names beginning with @samp{alt} and @samp{rec} should
1322 be ignored, and all groups with names beginning with @samp{sci} should
1323 be subscribed. Gnus will not use the normal subscription method for
1324 subscribing these groups.
1325 @code{gnus-subscribe-options-newsgroup-method} is used instead. This
1326 variable defaults to @code{gnus-subscribe-alphabetically}.
1328 @vindex gnus-options-not-subscribe
1329 @vindex gnus-options-subscribe
1330 If you don't want to mess with your @file{.newsrc} file, you can just
1331 set the two variables @code{gnus-options-subscribe} and
1332 @code{gnus-options-not-subscribe}. These two variables do exactly the
1333 same as the @file{.newsrc} @samp{options -n} trick. Both are regexps,
1334 and if the new group matches the former, it will be unconditionally
1335 subscribed, and if it matches the latter, it will be ignored.
1337 @vindex gnus-auto-subscribed-groups
1338 Yet another variable that meddles here is
1339 @code{gnus-auto-subscribed-groups}. It works exactly like
1340 @code{gnus-options-subscribe}, and is therefore really superfluous,
1341 but I thought it would be nice to have two of these. This variable is
1342 more meant for setting some ground rules, while the other variable is
1343 used more for user fiddling. By default this variable makes all new
1344 groups that come from mail back ends (@code{nnml}, @code{nnbabyl},
1345 @code{nnfolder}, @code{nnmbox}, @code{nnmh}, and @code{nnmaildir})
1346 subscribed. If you don't like that, just set this variable to
1349 New groups that match this regexp are subscribed using
1350 @code{gnus-subscribe-options-newsgroup-method}.
1353 @node Changing Servers
1354 @section Changing Servers
1355 @cindex changing servers
1357 Sometimes it is necessary to move from one @acronym{NNTP} server to another.
1358 This happens very rarely, but perhaps you change jobs, or one server is
1359 very flaky and you want to use another.
1361 Changing the server is pretty easy, right? You just change
1362 @code{gnus-select-method} to point to the new server?
1366 Article numbers are not (in any way) kept synchronized between different
1367 @acronym{NNTP} servers, and the only way Gnus keeps track of what articles
1368 you have read is by keeping track of article numbers. So when you
1369 change @code{gnus-select-method}, your @file{.newsrc} file becomes
1372 Gnus provides a few functions to attempt to translate a @file{.newsrc}
1373 file from one server to another. They all have one thing in
1374 common---they take a looong time to run. You don't want to use these
1375 functions more than absolutely necessary.
1377 @kindex M-x gnus-change-server
1378 @findex gnus-change-server
1379 If you have access to both servers, Gnus can request the headers for all
1380 the articles you have read and compare @code{Message-ID}s and map the
1381 article numbers of the read articles and article marks. The @kbd{M-x
1382 gnus-change-server} command will do this for all your native groups. It
1383 will prompt for the method you want to move to.
1385 @kindex M-x gnus-group-move-group-to-server
1386 @findex gnus-group-move-group-to-server
1387 You can also move individual groups with the @kbd{M-x
1388 gnus-group-move-group-to-server} command. This is useful if you want to
1389 move a (foreign) group from one server to another.
1391 @kindex M-x gnus-group-clear-data-on-native-groups
1392 @findex gnus-group-clear-data-on-native-groups
1393 If you don't have access to both the old and new server, all your marks
1394 and read ranges have become worthless. You can use the @kbd{M-x
1395 gnus-group-clear-data-on-native-groups} command to clear out all data
1396 that you have on your native groups. Use with caution.
1398 @kindex M-x gnus-group-clear-data
1399 @findex gnus-group-clear-data
1400 Clear the data from the current group only---nix out marks and the
1401 list of read articles (@code{gnus-group-clear-data}).
1403 After changing servers, you @strong{must} move the cache hierarchy away,
1404 since the cached articles will have wrong article numbers, which will
1405 affect which articles Gnus thinks are read.
1406 @code{gnus-group-clear-data-on-native-groups} will ask you if you want
1407 to have it done automatically; for @code{gnus-group-clear-data}, you
1408 can use @kbd{M-x gnus-cache-move-cache} (but beware, it will move the
1409 cache for all groups).
1413 @section Startup Files
1414 @cindex startup files
1419 Most common Unix news readers use a shared startup file called
1420 @file{.newsrc}. This file contains all the information about what
1421 groups are subscribed, and which articles in these groups have been
1424 Things got a bit more complicated with @sc{gnus}. In addition to
1425 keeping the @file{.newsrc} file updated, it also used a file called
1426 @file{.newsrc.el} for storing all the information that didn't fit into
1427 the @file{.newsrc} file. (Actually, it also duplicated everything in
1428 the @file{.newsrc} file.) @sc{gnus} would read whichever one of these
1429 files was the most recently saved, which enabled people to swap between
1430 @sc{gnus} and other newsreaders.
1432 That was kinda silly, so Gnus went one better: In addition to the
1433 @file{.newsrc} and @file{.newsrc.el} files, Gnus also has a file called
1434 @file{.newsrc.eld}. It will read whichever of these files that are most
1435 recent, but it will never write a @file{.newsrc.el} file. You should
1436 never delete the @file{.newsrc.eld} file---it contains much information
1437 not stored in the @file{.newsrc} file.
1439 @vindex gnus-save-newsrc-file
1440 @vindex gnus-read-newsrc-file
1441 You can turn off writing the @file{.newsrc} file by setting
1442 @code{gnus-save-newsrc-file} to @code{nil}, which means you can delete
1443 the file and save some space, as well as exiting from Gnus faster.
1444 However, this will make it impossible to use other newsreaders than
1445 Gnus. But hey, who would want to, right? Similarly, setting
1446 @code{gnus-read-newsrc-file} to @code{nil} makes Gnus ignore the
1447 @file{.newsrc} file and any @file{.newsrc-SERVER} files, which can be
1448 convenient if you use a different news reader occasionally, and you
1449 want to read a different subset of the available groups with that
1452 @vindex gnus-save-killed-list
1453 If @code{gnus-save-killed-list} (default @code{t}) is @code{nil}, Gnus
1454 will not save the list of killed groups to the startup file. This will
1455 save both time (when starting and quitting) and space (on disk). It
1456 will also mean that Gnus has no record of what groups are new or old,
1457 so the automatic new groups subscription methods become meaningless.
1458 You should always set @code{gnus-check-new-newsgroups} to @code{nil} or
1459 @code{ask-server} if you set this variable to @code{nil} (@pxref{New
1460 Groups}). This variable can also be a regular expression. If that's
1461 the case, remove all groups that do not match this regexp before
1462 saving. This can be useful in certain obscure situations that involve
1463 several servers where not all servers support @code{ask-server}.
1465 @vindex gnus-startup-file
1466 @vindex gnus-backup-startup-file
1467 @vindex version-control
1468 The @code{gnus-startup-file} variable says where the startup files are.
1469 The default value is @file{~/.newsrc}, with the Gnus (El Dingo) startup
1470 file being whatever that one is, with a @samp{.eld} appended.
1471 If you want version control for this file, set
1472 @code{gnus-backup-startup-file}. It respects the same values as the
1473 @code{version-control} variable.
1475 @vindex gnus-save-newsrc-hook
1476 @vindex gnus-save-quick-newsrc-hook
1477 @vindex gnus-save-standard-newsrc-hook
1478 @code{gnus-save-newsrc-hook} is called before saving any of the newsrc
1479 files, while @code{gnus-save-quick-newsrc-hook} is called just before
1480 saving the @file{.newsrc.eld} file, and
1481 @code{gnus-save-standard-newsrc-hook} is called just before saving the
1482 @file{.newsrc} file. The latter two are commonly used to turn version
1483 control on or off. Version control is on by default when saving the
1484 startup files. If you want to turn backup creation off, say something like:
1487 (defun turn-off-backup ()
1488 (set (make-local-variable 'backup-inhibited) t))
1490 (add-hook 'gnus-save-quick-newsrc-hook 'turn-off-backup)
1491 (add-hook 'gnus-save-standard-newsrc-hook 'turn-off-backup)
1494 @vindex gnus-init-file
1495 @vindex gnus-site-init-file
1496 When Gnus starts, it will read the @code{gnus-site-init-file}
1497 (@file{.../site-lisp/gnus-init} by default) and @code{gnus-init-file}
1498 (@file{~/.gnus} by default) files. These are normal Emacs Lisp files
1499 and can be used to avoid cluttering your @file{~/.emacs} and
1500 @file{site-init} files with Gnus stuff. Gnus will also check for files
1501 with the same names as these, but with @file{.elc} and @file{.el}
1502 suffixes. In other words, if you have set @code{gnus-init-file} to
1503 @file{~/.gnus}, it will look for @file{~/.gnus.elc}, @file{~/.gnus.el},
1504 and finally @file{~/.gnus} (in this order). If Emacs was invoked with
1505 the @option{-q} or @option{--no-init-file} options (@pxref{Initial
1506 Options, ,Initial Options, emacs, The Emacs Manual}), Gnus doesn't read
1507 @code{gnus-init-file}.
1512 @cindex dribble file
1515 Whenever you do something that changes the Gnus data (reading articles,
1516 catching up, killing/subscribing groups), the change is added to a
1517 special @dfn{dribble buffer}. This buffer is auto-saved the normal
1518 Emacs way. If your Emacs should crash before you have saved the
1519 @file{.newsrc} files, all changes you have made can be recovered from
1522 If Gnus detects this file at startup, it will ask the user whether to
1523 read it. The auto save file is deleted whenever the real startup file is
1526 @vindex gnus-use-dribble-file
1527 If @code{gnus-use-dribble-file} is @code{nil}, Gnus won't create and
1528 maintain a dribble buffer. The default is @code{t}.
1530 @vindex gnus-dribble-directory
1531 Gnus will put the dribble file(s) in @code{gnus-dribble-directory}. If
1532 this variable is @code{nil}, which it is by default, Gnus will dribble
1533 into the directory where the @file{.newsrc} file is located. (This is
1534 normally the user's home directory.) The dribble file will get the same
1535 file permissions as the @file{.newsrc} file.
1537 @vindex gnus-always-read-dribble-file
1538 If @code{gnus-always-read-dribble-file} is non-@code{nil}, Gnus will
1539 read the dribble file on startup without querying the user.
1542 @node The Active File
1543 @section The Active File
1545 @cindex ignored groups
1547 When Gnus starts, or indeed whenever it tries to determine whether new
1548 articles have arrived, it reads the active file. This is a very large
1549 file that lists all the active groups and articles on the server.
1551 @vindex gnus-ignored-newsgroups
1552 Before examining the active file, Gnus deletes all lines that match the
1553 regexp @code{gnus-ignored-newsgroups}. This is done primarily to reject
1554 any groups with bogus names, but you can use this variable to make Gnus
1555 ignore hierarchies you aren't ever interested in. However, this is not
1556 recommended. In fact, it's highly discouraged. Instead, @pxref{New
1557 Groups} for an overview of other variables that can be used instead.
1560 @c @code{nil} by default, and will slow down active file handling somewhat
1561 @c if you set it to anything else.
1563 @vindex gnus-read-active-file
1565 The active file can be rather Huge, so if you have a slow network, you
1566 can set @code{gnus-read-active-file} to @code{nil} to prevent Gnus from
1567 reading the active file. This variable is @code{some} by default.
1569 Gnus will try to make do by getting information just on the groups that
1570 you actually subscribe to.
1572 Note that if you subscribe to lots and lots of groups, setting this
1573 variable to @code{nil} will probably make Gnus slower, not faster. At
1574 present, having this variable @code{nil} will slow Gnus down
1575 considerably, unless you read news over a 2400 baud modem.
1577 This variable can also have the value @code{some}. Gnus will then
1578 attempt to read active info only on the subscribed groups. On some
1579 servers this is quite fast (on sparkling, brand new INN servers that
1580 support the @code{LIST ACTIVE group} command), on others this isn't fast
1581 at all. In any case, @code{some} should be faster than @code{nil}, and
1582 is certainly faster than @code{t} over slow lines.
1584 Some news servers (old versions of Leafnode and old versions of INN, for
1585 instance) do not support the @code{LIST ACTIVE group}. For these
1586 servers, @code{nil} is probably the most efficient value for this
1589 If this variable is @code{nil}, Gnus will ask for group info in total
1590 lock-step, which isn't very fast. If it is @code{some} and you use an
1591 @acronym{NNTP} server, Gnus will pump out commands as fast as it can, and
1592 read all the replies in one swoop. This will normally result in better
1593 performance, but if the server does not support the aforementioned
1594 @code{LIST ACTIVE group} command, this isn't very nice to the server.
1596 If you think that starting up Gnus takes too long, try all the three
1597 different values for this variable and see what works best for you.
1599 In any case, if you use @code{some} or @code{nil}, you should definitely
1600 kill all groups that you aren't interested in to speed things up.
1602 Note that this variable also affects active file retrieval from
1603 secondary select methods.
1606 @node Startup Variables
1607 @section Startup Variables
1611 @item gnus-load-hook
1612 @vindex gnus-load-hook
1613 A hook run while Gnus is being loaded. Note that this hook will
1614 normally be run just once in each Emacs session, no matter how many
1615 times you start Gnus.
1617 @item gnus-before-startup-hook
1618 @vindex gnus-before-startup-hook
1619 A hook run after starting up Gnus successfully.
1621 @item gnus-startup-hook
1622 @vindex gnus-startup-hook
1623 A hook run as the very last thing after starting up Gnus
1625 @item gnus-started-hook
1626 @vindex gnus-started-hook
1627 A hook that is run as the very last thing after starting up Gnus
1630 @item gnus-setup-news-hook
1631 @vindex gnus-setup-news-hook
1632 A hook that is run after reading the @file{.newsrc} file(s), but before
1633 generating the group buffer.
1635 @item gnus-check-bogus-newsgroups
1636 @vindex gnus-check-bogus-newsgroups
1637 If non-@code{nil}, Gnus will check for and delete all bogus groups at
1638 startup. A @dfn{bogus group} is a group that you have in your
1639 @file{.newsrc} file, but doesn't exist on the news server. Checking for
1640 bogus groups can take quite a while, so to save time and resources it's
1641 best to leave this option off, and do the checking for bogus groups once
1642 in a while from the group buffer instead (@pxref{Group Maintenance}).
1644 @item gnus-inhibit-startup-message
1645 @vindex gnus-inhibit-startup-message
1646 If non-@code{nil}, the startup message won't be displayed. That way,
1647 your boss might not notice as easily that you are reading news instead
1648 of doing your job. Note that this variable is used before
1649 @file{~/.gnus.el} is loaded, so it should be set in @file{.emacs} instead.
1651 @item gnus-no-groups-message
1652 @vindex gnus-no-groups-message
1653 Message displayed by Gnus when no groups are available.
1655 @item gnus-play-startup-jingle
1656 @vindex gnus-play-startup-jingle
1657 If non-@code{nil}, play the Gnus jingle at startup.
1659 @item gnus-startup-jingle
1660 @vindex gnus-startup-jingle
1661 Jingle to be played if the above variable is non-@code{nil}. The
1662 default is @samp{Tuxedomoon.Jingle4.au}.
1668 @chapter Group Buffer
1669 @cindex group buffer
1671 @c Alex Schroeder suggests to rearrange this as follows:
1673 @c <kensanata> ok, just save it for reference. I'll go to bed in a minute.
1674 @c 1. Selecting a Group, 2. (new) Finding a Group, 3. Group Levels,
1675 @c 4. Subscription Commands, 5. Group Maneuvering, 6. Group Data,
1676 @c 7. Group Score, 8. Group Buffer Format
1677 @c <kensanata> Group Levels should have more information on levels 5 to 9. I
1678 @c suggest to split the 4th paragraph ("Gnus considers groups...") as follows:
1679 @c <kensanata> First, "Gnus considers groups... (default 9)."
1680 @c <kensanata> New, a table summarizing what levels 1 to 9 mean.
1681 @c <kensanata> Third, "Gnus treats subscribed ... reasons of efficiency"
1682 @c <kensanata> Then expand the next paragraph or add some more to it.
1683 @c This short one sentence explains levels 1 and 2, therefore I understand
1684 @c that I should keep important news at 3 and boring news at 4.
1685 @c Say so! Then go on to explain why I should bother with levels 6 to 9.
1686 @c Maybe keep those that you don't want to read temporarily at 6,
1687 @c those that you never want to read at 8, those that offend your
1688 @c human rights at 9...
1691 The @dfn{group buffer} lists all (or parts) of the available groups. It
1692 is the first buffer shown when Gnus starts, and will never be killed as
1693 long as Gnus is active.
1697 \gnusfigure{The Group Buffer}{320}{
1698 \put(75,50){\epsfig{figure=ps/group,height=9cm}}
1699 \put(120,37){\makebox(0,0)[t]{Buffer name}}
1700 \put(120,38){\vector(1,2){10}}
1701 \put(40,60){\makebox(0,0)[r]{Mode line}}
1702 \put(40,58){\vector(1,0){30}}
1703 \put(200,28){\makebox(0,0)[t]{Native select method}}
1704 \put(200,26){\vector(-1,2){15}}
1710 * Group Buffer Format:: Information listed and how you can change it.
1711 * Group Maneuvering:: Commands for moving in the group buffer.
1712 * Selecting a Group:: Actually reading news.
1713 * Subscription Commands:: Unsubscribing, killing, subscribing.
1714 * Group Data:: Changing the info for a group.
1715 * Group Levels:: Levels? What are those, then?
1716 * Group Score:: A mechanism for finding out what groups you like.
1717 * Marking Groups:: You can mark groups for later processing.
1718 * Foreign Groups:: Creating and editing groups.
1719 * Group Parameters:: Each group may have different parameters set.
1720 * Listing Groups:: Gnus can list various subsets of the groups.
1721 * Sorting Groups:: Re-arrange the group order.
1722 * Group Maintenance:: Maintaining a tidy @file{.newsrc} file.
1723 * Browse Foreign Server:: You can browse a server. See what it has to offer.
1724 * Exiting Gnus:: Stop reading news and get some work done.
1725 * Group Topics:: A folding group mode divided into topics.
1726 * Non-ASCII Group Names:: Accessing groups of non-English names.
1727 * Misc Group Stuff:: Other stuff that you can to do.
1731 @node Group Buffer Format
1732 @section Group Buffer Format
1735 * Group Line Specification:: Deciding how the group buffer is to look.
1736 * Group Mode Line Specification:: The group buffer mode line.
1737 * Group Highlighting:: Having nice colors in the group buffer.
1740 You can customize the Group Mode tool bar, see @kbd{M-x
1741 customize-apropos RET gnus-group-tool-bar}. This feature is only
1744 The tool bar icons are now (de)activated correctly depending on the
1745 cursor position. Therefore, moving around in the Group Buffer is
1746 slower. You can disable this via the variable
1747 @code{gnus-group-update-tool-bar}. Its default value depends on your
1750 @node Group Line Specification
1751 @subsection Group Line Specification
1752 @cindex group buffer format
1754 The default format of the group buffer is nice and dull, but you can
1755 make it as exciting and ugly as you feel like.
1757 Here's a couple of example group lines:
1760 25: news.announce.newusers
1761 * 0: alt.fan.andrea-dworkin
1766 You can see that there are 25 unread articles in
1767 @samp{news.announce.newusers}. There are no unread articles, but some
1768 ticked articles, in @samp{alt.fan.andrea-dworkin} (see that little
1769 asterisk at the beginning of the line?).
1771 @vindex gnus-group-line-format
1772 You can change that format to whatever you want by fiddling with the
1773 @code{gnus-group-line-format} variable. This variable works along the
1774 lines of a @code{format} specification, which is pretty much the same as
1775 a @code{printf} specifications, for those of you who use (feh!) C.
1776 @xref{Formatting Variables}.
1778 @samp{%M%S%5y:%B%(%g%)\n} is the value that produced those lines above.
1780 There should always be a colon on the line; the cursor always moves to
1781 the colon after performing an operation. @xref{Positioning
1782 Point}. Nothing else is required---not even the group name. All
1783 displayed text is just window dressing, and is never examined by Gnus.
1784 Gnus stores all real information it needs using text properties.
1786 (Note that if you make a really strange, wonderful, spreadsheet-like
1787 layout, everybody will believe you are hard at work with the accounting
1788 instead of wasting time reading news.)
1790 Here's a list of all available format characters:
1795 An asterisk if the group only has marked articles.
1798 Whether the group is subscribed.
1801 Level of subscribedness.
1804 Number of unread articles.
1807 Number of dormant articles.
1810 Number of ticked articles.
1813 Number of read articles.
1816 Number of unseen articles.
1819 Estimated total number of articles. (This is really @var{max-number}
1820 minus @var{min-number} plus 1.)
1822 Gnus uses this estimation because the @acronym{NNTP} protocol provides
1823 efficient access to @var{max-number} and @var{min-number} but getting
1824 the true unread message count is not possible efficiently. For
1825 hysterical raisins, even the mail back ends, where the true number of
1826 unread messages might be available efficiently, use the same limited
1827 interface. To remove this restriction from Gnus means that the back
1828 end interface has to be changed, which is not an easy job.
1830 The nnml backend (@pxref{Mail Spool}) has a feature called ``group
1831 compaction'' which circumvents this deficiency: the idea is to
1832 renumber all articles from 1, removing all gaps between numbers, hence
1833 getting a correct total count. Other backends may support this in the
1834 future. In order to keep your total article count relatively up to
1835 date, you might want to compact your groups (or even directly your
1836 server) from time to time. @xref{Misc Group Stuff}, @xref{Server Commands}.
1839 Number of unread, unticked, non-dormant articles.
1842 Number of ticked and dormant articles.
1851 Group comment (@pxref{Group Parameters}) or group name if there is no
1852 comment element in the group parameters.
1855 Newsgroup description. You need to read the group descriptions
1856 before these will appear, and to do that, you either have to set
1857 @code{gnus-read-active-file} or use the group buffer @kbd{M-d}
1861 @samp{m} if moderated.
1864 @samp{(m)} if moderated.
1870 If the summary buffer for the group is open or not.
1876 A string that looks like @samp{<%s:%n>} if a foreign select method is
1880 Indentation based on the level of the topic (@pxref{Group Topics}).
1883 @vindex gnus-group-uncollapsed-levels
1884 Short (collapsed) group name. The @code{gnus-group-uncollapsed-levels}
1885 variable says how many levels to leave at the end of the group name.
1886 The default is 1---this will mean that group names like
1887 @samp{gnu.emacs.gnus} will be shortened to @samp{g.e.gnus}.
1890 @vindex gnus-new-mail-mark
1892 @samp{%} (@code{gnus-new-mail-mark}) if there has arrived new mail to
1896 @samp{#} (@code{gnus-process-mark}) if the group is process marked.
1899 A string that says when you last read the group (@pxref{Group
1903 The disk space used by the articles fetched by both the cache and
1904 agent. The value is automatically scaled to bytes(B), kilobytes(K),
1905 megabytes(M), or gigabytes(G) to minimize the column width. A format
1906 of %7F is sufficient for a fixed-width column.
1909 User defined specifier. The next character in the format string should
1910 be a letter. Gnus will call the function
1911 @code{gnus-user-format-function-}@samp{X}, where @samp{X} is the letter
1912 following @samp{%u}. The function will be passed a single dummy
1913 parameter as argument. The function should return a string, which will
1914 be inserted into the buffer just like information from any other
1919 All the ``number-of'' specs will be filled with an asterisk (@samp{*})
1920 if no info is available---for instance, if it is a non-activated foreign
1921 group, or a bogus native group.
1924 @node Group Mode Line Specification
1925 @subsection Group Mode Line Specification
1926 @cindex group mode line
1928 @vindex gnus-group-mode-line-format
1929 The mode line can be changed by setting
1930 @code{gnus-group-mode-line-format} (@pxref{Mode Line Formatting}). It
1931 doesn't understand that many format specifiers:
1935 The native news server.
1937 The native select method.
1941 @node Group Highlighting
1942 @subsection Group Highlighting
1943 @cindex highlighting
1944 @cindex group highlighting
1946 @vindex gnus-group-highlight
1947 Highlighting in the group buffer is controlled by the
1948 @code{gnus-group-highlight} variable. This is an alist with elements
1949 that look like @code{(@var{form} . @var{face})}. If @var{form} evaluates to
1950 something non-@code{nil}, the @var{face} will be used on the line.
1952 Here's an example value for this variable that might look nice if the
1956 (cond (window-system
1957 (setq custom-background-mode 'light)
1958 (defface my-group-face-1
1959 '((t (:foreground "Red" :bold t))) "First group face")
1960 (defface my-group-face-2
1961 '((t (:foreground "DarkSeaGreen4" :bold t)))
1962 "Second group face")
1963 (defface my-group-face-3
1964 '((t (:foreground "Green4" :bold t))) "Third group face")
1965 (defface my-group-face-4
1966 '((t (:foreground "SteelBlue" :bold t))) "Fourth group face")
1967 (defface my-group-face-5
1968 '((t (:foreground "Blue" :bold t))) "Fifth group face")))
1970 (setq gnus-group-highlight
1971 '(((> unread 200) . my-group-face-1)
1972 ((and (< level 3) (zerop unread)) . my-group-face-2)
1973 ((< level 3) . my-group-face-3)
1974 ((zerop unread) . my-group-face-4)
1975 (t . my-group-face-5)))
1978 Also @pxref{Faces and Fonts}.
1980 Variables that are dynamically bound when the forms are evaluated
1987 The number of unread articles in the group.
1991 Whether the group is a mail group.
1993 The level of the group.
1995 The score of the group.
1997 The number of ticked articles in the group.
1999 The total number of articles in the group. Or rather,
2000 @var{max-number} minus @var{min-number} plus one.
2002 When using the topic minor mode, this variable is bound to the current
2003 topic being inserted.
2006 When the forms are @code{eval}ed, point is at the beginning of the line
2007 of the group in question, so you can use many of the normal Gnus
2008 functions for snarfing info on the group.
2010 @vindex gnus-group-update-hook
2011 @findex gnus-group-highlight-line
2012 @code{gnus-group-update-hook} is called when a group line is changed.
2013 It will not be called when @code{gnus-visual} is @code{nil}. This hook
2014 calls @code{gnus-group-highlight-line} by default.
2017 @node Group Maneuvering
2018 @section Group Maneuvering
2019 @cindex group movement
2021 All movement commands understand the numeric prefix and will behave as
2022 expected, hopefully.
2028 @findex gnus-group-next-unread-group
2029 Go to the next group that has unread articles
2030 (@code{gnus-group-next-unread-group}).
2036 @findex gnus-group-prev-unread-group
2037 Go to the previous group that has unread articles
2038 (@code{gnus-group-prev-unread-group}).
2042 @findex gnus-group-next-group
2043 Go to the next group (@code{gnus-group-next-group}).
2047 @findex gnus-group-prev-group
2048 Go to the previous group (@code{gnus-group-prev-group}).
2052 @findex gnus-group-next-unread-group-same-level
2053 Go to the next unread group on the same (or lower) level
2054 (@code{gnus-group-next-unread-group-same-level}).
2058 @findex gnus-group-prev-unread-group-same-level
2059 Go to the previous unread group on the same (or lower) level
2060 (@code{gnus-group-prev-unread-group-same-level}).
2063 Three commands for jumping to groups:
2069 @findex gnus-group-jump-to-group
2070 Jump to a group (and make it visible if it isn't already)
2071 (@code{gnus-group-jump-to-group}). Killed groups can be jumped to, just
2076 @findex gnus-group-best-unread-group
2077 Jump to the unread group with the lowest level
2078 (@code{gnus-group-best-unread-group}).
2082 @findex gnus-group-first-unread-group
2083 Jump to the first group with unread articles
2084 (@code{gnus-group-first-unread-group}).
2087 @vindex gnus-group-goto-unread
2088 If @code{gnus-group-goto-unread} is @code{nil}, all the movement
2089 commands will move to the next group, not the next unread group. Even
2090 the commands that say they move to the next unread group. The default
2093 @vindex gnus-summary-next-group-on-exit
2094 If @code{gnus-summary-next-group-on-exit} is @code{t}, when a summary is
2095 exited, the point in the group buffer is moved to the next unread group.
2096 Otherwise, the point is set to the group just exited. The default is
2099 @node Selecting a Group
2100 @section Selecting a Group
2101 @cindex group selection
2106 @kindex SPACE (Group)
2107 @findex gnus-group-read-group
2108 Select the current group, switch to the summary buffer and display the
2109 first unread article (@code{gnus-group-read-group}). If there are no
2110 unread articles in the group, or if you give a non-numerical prefix to
2111 this command, Gnus will offer to fetch all the old articles in this
2112 group from the server. If you give a numerical prefix @var{n}, @var{n}
2113 determines the number of articles Gnus will fetch. If @var{n} is
2114 positive, Gnus fetches the @var{n} newest articles, if @var{n} is
2115 negative, Gnus fetches the @code{abs(@var{n})} oldest articles.
2117 Thus, @kbd{SPC} enters the group normally, @kbd{C-u SPC} offers old
2118 articles, @kbd{C-u 4 2 SPC} fetches the 42 newest articles, and @kbd{C-u
2119 - 4 2 SPC} fetches the 42 oldest ones.
2121 When you are in the group (in the Summary buffer), you can type
2122 @kbd{M-g} to fetch new articles, or @kbd{C-u M-g} to also show the old
2127 @findex gnus-group-select-group
2128 Select the current group and switch to the summary buffer
2129 (@code{gnus-group-select-group}). Takes the same arguments as
2130 @code{gnus-group-read-group}---the only difference is that this command
2131 does not display the first unread article automatically upon group
2135 @kindex M-RET (Group)
2136 @findex gnus-group-quick-select-group
2137 This does the same as the command above, but tries to do it with the
2138 minimum amount of fuzz (@code{gnus-group-quick-select-group}). No
2139 scoring/killing will be performed, there will be no highlights and no
2140 expunging. This might be useful if you're in a real hurry and have to
2141 enter some humongous group. If you give a 0 prefix to this command
2142 (i.e., @kbd{0 M-RET}), Gnus won't even generate the summary buffer,
2143 which is useful if you want to toggle threading before generating the
2144 summary buffer (@pxref{Summary Generation Commands}).
2147 @kindex M-SPACE (Group)
2148 @findex gnus-group-visible-select-group
2149 This is yet one more command that does the same as the @kbd{RET}
2150 command, but this one does it without expunging and hiding dormants
2151 (@code{gnus-group-visible-select-group}).
2154 @kindex C-M-RET (Group)
2155 @findex gnus-group-select-group-ephemerally
2156 Finally, this command selects the current group ephemerally without
2157 doing any processing of its contents
2158 (@code{gnus-group-select-group-ephemerally}). Even threading has been
2159 turned off. Everything you do in the group after selecting it in this
2160 manner will have no permanent effects.
2164 @vindex gnus-large-newsgroup
2165 The @code{gnus-large-newsgroup} variable says what Gnus should
2166 consider to be a big group. If it is @code{nil}, no groups are
2167 considered big. The default value is 200. If the group has more
2168 (unread and/or ticked) articles than this, Gnus will query the user
2169 before entering the group. The user can then specify how many
2170 articles should be fetched from the server. If the user specifies a
2171 negative number (@var{-n}), the @var{n} oldest articles will be
2172 fetched. If it is positive, the @var{n} articles that have arrived
2173 most recently will be fetched.
2175 @vindex gnus-large-ephemeral-newsgroup
2176 @code{gnus-large-ephemeral-newsgroup} is the same as
2177 @code{gnus-large-newsgroup}, but is only used for ephemeral
2180 @vindex gnus-newsgroup-maximum-articles
2181 In groups in some news servers, there might be a big gap between a few
2182 very old articles that will never be expired and the recent ones. In
2183 such a case, the server will return the data like @code{(1 . 30000000)}
2184 for the @code{LIST ACTIVE group} command, for example. Even if there
2185 are actually only the articles 1-10 and 29999900-30000000, Gnus doesn't
2186 know it at first and prepares for getting 30000000 articles. However,
2187 it will consume hundreds megabytes of memories and might make Emacs get
2188 stuck as the case may be. If you use such news servers, set the
2189 variable @code{gnus-newsgroup-maximum-articles} to a positive number.
2190 The value means that Gnus ignores articles other than this number of the
2191 latest ones in every group. For instance, the value 10000 makes Gnus
2192 get only the articles 29990001-30000000 (if the latest article number is
2193 30000000 in a group). Note that setting this variable to a number might
2194 prevent you from reading very old articles. The default value of the
2195 variable @code{gnus-newsgroup-maximum-articles} is @code{nil}, which
2196 means Gnus never ignores old articles.
2198 @vindex gnus-select-group-hook
2199 @vindex gnus-auto-select-first
2200 @vindex gnus-auto-select-subject
2201 If @code{gnus-auto-select-first} is non-@code{nil}, select an article
2202 automatically when entering a group with the @kbd{SPACE} command.
2203 Which article this is is controlled by the
2204 @code{gnus-auto-select-subject} variable. Valid values for this
2210 Place point on the subject line of the first unread article.
2213 Place point on the subject line of the first article.
2216 Place point on the subject line of the first unseen article.
2218 @item unseen-or-unread
2219 Place point on the subject line of the first unseen article, and if
2220 there is no such article, place point on the subject line of the first
2224 Place point on the subject line of the highest-scored unread article.
2228 This variable can also be a function. In that case, that function
2229 will be called to place point on a subject line.
2231 If you want to prevent automatic selection in some group (say, in a
2232 binary group with Huge articles) you can set the
2233 @code{gnus-auto-select-first} variable to @code{nil} in
2234 @code{gnus-select-group-hook}, which is called when a group is
2238 @node Subscription Commands
2239 @section Subscription Commands
2240 @cindex subscription
2248 @findex gnus-group-unsubscribe-current-group
2249 @c @icon{gnus-group-unsubscribe}
2250 Toggle subscription to the current group
2251 (@code{gnus-group-unsubscribe-current-group}).
2257 @findex gnus-group-unsubscribe-group
2258 Prompt for a group to subscribe, and then subscribe it. If it was
2259 subscribed already, unsubscribe it instead
2260 (@code{gnus-group-unsubscribe-group}).
2266 @findex gnus-group-kill-group
2267 @c @icon{gnus-group-kill-group}
2268 Kill the current group (@code{gnus-group-kill-group}).
2274 @findex gnus-group-yank-group
2275 Yank the last killed group (@code{gnus-group-yank-group}).
2278 @kindex C-x C-t (Group)
2279 @findex gnus-group-transpose-groups
2280 Transpose two groups (@code{gnus-group-transpose-groups}). This isn't
2281 really a subscription command, but you can use it instead of a
2282 kill-and-yank sequence sometimes.
2288 @findex gnus-group-kill-region
2289 Kill all groups in the region (@code{gnus-group-kill-region}).
2293 @findex gnus-group-kill-all-zombies
2294 Kill all zombie groups (@code{gnus-group-kill-all-zombies}).
2297 @kindex S C-k (Group)
2298 @findex gnus-group-kill-level
2299 Kill all groups on a certain level (@code{gnus-group-kill-level}).
2300 These groups can't be yanked back after killing, so this command should
2301 be used with some caution. The only time where this command comes in
2302 really handy is when you have a @file{.newsrc} with lots of unsubscribed
2303 groups that you want to get rid off. @kbd{S C-k} on level 7 will
2304 kill off all unsubscribed groups that do not have message numbers in the
2305 @file{.newsrc} file.
2309 Also @pxref{Group Levels}.
2319 @findex gnus-group-catchup-current
2320 @vindex gnus-group-catchup-group-hook
2321 @c @icon{gnus-group-catchup-current}
2322 Mark all unticked articles in this group as read
2323 (@code{gnus-group-catchup-current}).
2324 @code{gnus-group-catchup-group-hook} is called when catching up a group from
2329 @findex gnus-group-catchup-current-all
2330 Mark all articles in this group, even the ticked ones, as read
2331 (@code{gnus-group-catchup-current-all}).
2335 @findex gnus-group-clear-data
2336 Clear the data from the current group---nix out marks and the list of
2337 read articles (@code{gnus-group-clear-data}).
2339 @item M-x gnus-group-clear-data-on-native-groups
2340 @kindex M-x gnus-group-clear-data-on-native-groups
2341 @findex gnus-group-clear-data-on-native-groups
2342 If you have switched from one @acronym{NNTP} server to another, all your marks
2343 and read ranges have become worthless. You can use this command to
2344 clear out all data that you have on your native groups. Use with
2351 @section Group Levels
2355 All groups have a level of @dfn{subscribedness}. For instance, if a
2356 group is on level 2, it is more subscribed than a group on level 5. You
2357 can ask Gnus to just list groups on a given level or lower
2358 (@pxref{Listing Groups}), or to just check for new articles in groups on
2359 a given level or lower (@pxref{Scanning New Messages}).
2361 Remember: The higher the level of the group, the less important it is.
2367 @findex gnus-group-set-current-level
2368 Set the level of the current group. If a numeric prefix is given, the
2369 next @var{n} groups will have their levels set. The user will be
2370 prompted for a level.
2373 @vindex gnus-level-killed
2374 @vindex gnus-level-zombie
2375 @vindex gnus-level-unsubscribed
2376 @vindex gnus-level-subscribed
2377 Gnus considers groups from levels 1 to
2378 @code{gnus-level-subscribed} (inclusive) (default 5) to be subscribed,
2379 @code{gnus-level-subscribed} (exclusive) and
2380 @code{gnus-level-unsubscribed} (inclusive) (default 7) to be
2381 unsubscribed, @code{gnus-level-zombie} to be zombies (walking dead)
2382 (default 8) and @code{gnus-level-killed} to be killed (completely dead)
2383 (default 9). Gnus treats subscribed and unsubscribed groups exactly the
2384 same, but zombie and killed groups have no information on what articles
2385 you have read, etc, stored. This distinction between dead and living
2386 groups isn't done because it is nice or clever, it is done purely for
2387 reasons of efficiency.
2389 It is recommended that you keep all your mail groups (if any) on quite
2390 low levels (e.g. 1 or 2).
2392 Maybe the following description of the default behavior of Gnus helps to
2393 understand what these levels are all about. By default, Gnus shows you
2394 subscribed nonempty groups, but by hitting @kbd{L} you can have it show
2395 empty subscribed groups and unsubscribed groups, too. Type @kbd{l} to
2396 go back to showing nonempty subscribed groups again. Thus, unsubscribed
2397 groups are hidden, in a way.
2399 Zombie and killed groups are similar to unsubscribed groups in that they
2400 are hidden by default. But they are different from subscribed and
2401 unsubscribed groups in that Gnus doesn't ask the news server for
2402 information (number of messages, number of unread messages) on zombie
2403 and killed groups. Normally, you use @kbd{C-k} to kill the groups you
2404 aren't interested in. If most groups are killed, Gnus is faster.
2406 Why does Gnus distinguish between zombie and killed groups? Well, when
2407 a new group arrives on the server, Gnus by default makes it a zombie
2408 group. This means that you are normally not bothered with new groups,
2409 but you can type @kbd{A z} to get a list of all new groups. Subscribe
2410 the ones you like and kill the ones you don't want. (@kbd{A k} shows a
2411 list of killed groups.)
2413 If you want to play with the level variables, you should show some care.
2414 Set them once, and don't touch them ever again. Better yet, don't touch
2415 them at all unless you know exactly what you're doing.
2417 @vindex gnus-level-default-unsubscribed
2418 @vindex gnus-level-default-subscribed
2419 Two closely related variables are @code{gnus-level-default-subscribed}
2420 (default 3) and @code{gnus-level-default-unsubscribed} (default 6),
2421 which are the levels that new groups will be put on if they are
2422 (un)subscribed. These two variables should, of course, be inside the
2423 relevant valid ranges.
2425 @vindex gnus-keep-same-level
2426 If @code{gnus-keep-same-level} is non-@code{nil}, some movement commands
2427 will only move to groups of the same level (or lower). In
2428 particular, going from the last article in one group to the next group
2429 will go to the next group of the same level (or lower). This might be
2430 handy if you want to read the most important groups before you read the
2433 If this variable is @code{best}, Gnus will make the next newsgroup the
2434 one with the best level.
2436 @vindex gnus-group-default-list-level
2437 All groups with a level less than or equal to
2438 @code{gnus-group-default-list-level} will be listed in the group buffer
2441 @vindex gnus-group-list-inactive-groups
2442 If @code{gnus-group-list-inactive-groups} is non-@code{nil}, non-active
2443 groups will be listed along with the unread groups. This variable is
2444 @code{t} by default. If it is @code{nil}, inactive groups won't be
2447 @vindex gnus-group-use-permanent-levels
2448 If @code{gnus-group-use-permanent-levels} is non-@code{nil}, once you
2449 give a level prefix to @kbd{g} or @kbd{l}, all subsequent commands will
2450 use this level as the ``work'' level.
2452 @vindex gnus-activate-level
2453 Gnus will normally just activate (i. e., query the server about) groups
2454 on level @code{gnus-activate-level} or less. If you don't want to
2455 activate unsubscribed groups, for instance, you might set this variable
2456 to 5. The default is 6.
2460 @section Group Score
2465 You would normally keep important groups on high levels, but that scheme
2466 is somewhat restrictive. Don't you wish you could have Gnus sort the
2467 group buffer according to how often you read groups, perhaps? Within
2470 This is what @dfn{group score} is for. You can have Gnus assign a score
2471 to each group through the mechanism described below. You can then sort
2472 the group buffer based on this score. Alternatively, you can sort on
2473 score and then level. (Taken together, the level and the score is
2474 called the @dfn{rank} of the group. A group that is on level 4 and has
2475 a score of 1 has a higher rank than a group on level 5 that has a score
2476 of 300. (The level is the most significant part and the score is the
2477 least significant part.))
2479 @findex gnus-summary-bubble-group
2480 If you want groups you read often to get higher scores than groups you
2481 read seldom you can add the @code{gnus-summary-bubble-group} function to
2482 the @code{gnus-summary-exit-hook} hook. This will result (after
2483 sorting) in a bubbling sort of action. If you want to see that in
2484 action after each summary exit, you can add
2485 @code{gnus-group-sort-groups-by-rank} or
2486 @code{gnus-group-sort-groups-by-score} to the same hook, but that will
2487 slow things down somewhat.
2490 @node Marking Groups
2491 @section Marking Groups
2492 @cindex marking groups
2494 If you want to perform some command on several groups, and they appear
2495 subsequently in the group buffer, you would normally just give a
2496 numerical prefix to the command. Most group commands will then do your
2497 bidding on those groups.
2499 However, if the groups are not in sequential order, you can still
2500 perform a command on several groups. You simply mark the groups first
2501 with the process mark and then execute the command.
2509 @findex gnus-group-mark-group
2510 Set the mark on the current group (@code{gnus-group-mark-group}).
2516 @findex gnus-group-unmark-group
2517 Remove the mark from the current group
2518 (@code{gnus-group-unmark-group}).
2522 @findex gnus-group-unmark-all-groups
2523 Remove the mark from all groups (@code{gnus-group-unmark-all-groups}).
2527 @findex gnus-group-mark-region
2528 Mark all groups between point and mark (@code{gnus-group-mark-region}).
2532 @findex gnus-group-mark-buffer
2533 Mark all groups in the buffer (@code{gnus-group-mark-buffer}).
2537 @findex gnus-group-mark-regexp
2538 Mark all groups that match some regular expression
2539 (@code{gnus-group-mark-regexp}).
2542 Also @pxref{Process/Prefix}.
2544 @findex gnus-group-universal-argument
2545 If you want to execute some command on all groups that have been marked
2546 with the process mark, you can use the @kbd{M-&}
2547 (@code{gnus-group-universal-argument}) command. It will prompt you for
2548 the command to be executed.
2551 @node Foreign Groups
2552 @section Foreign Groups
2553 @cindex foreign groups
2555 Below are some group mode commands for making and editing general foreign
2556 groups, as well as commands to ease the creation of a few
2557 special-purpose groups. All these commands insert the newly created
2558 groups under point---@code{gnus-subscribe-newsgroup-method} is not
2561 Changes from the group editing commands are stored in
2562 @file{~/.newsrc.eld} (@code{gnus-startup-file}). An alternative is the
2563 variable @code{gnus-parameters}, @xref{Group Parameters}.
2569 @findex gnus-group-make-group
2570 @cindex making groups
2571 Make a new group (@code{gnus-group-make-group}). Gnus will prompt you
2572 for a name, a method and possibly an @dfn{address}. For an easier way
2573 to subscribe to @acronym{NNTP} groups (@pxref{Browse Foreign Server}).
2577 @findex gnus-group-read-ephemeral-group
2578 Make an ephemeral group (@code{gnus-group-read-ephemeral-group}). Gnus
2579 will prompt you for a name, a method and an @dfn{address}.
2583 @findex gnus-group-rename-group
2584 @cindex renaming groups
2585 Rename the current group to something else
2586 (@code{gnus-group-rename-group}). This is valid only on some
2587 groups---mail groups mostly. This command might very well be quite slow
2593 @findex gnus-group-customize
2594 Customize the group parameters (@code{gnus-group-customize}).
2598 @findex gnus-group-edit-group-method
2599 @cindex renaming groups
2600 Enter a buffer where you can edit the select method of the current
2601 group (@code{gnus-group-edit-group-method}).
2605 @findex gnus-group-edit-group-parameters
2606 Enter a buffer where you can edit the group parameters
2607 (@code{gnus-group-edit-group-parameters}).
2611 @findex gnus-group-edit-group
2612 Enter a buffer where you can edit the group info
2613 (@code{gnus-group-edit-group}).
2617 @findex gnus-group-make-directory-group
2619 Make a directory group (@pxref{Directory Groups}). You will be prompted
2620 for a directory name (@code{gnus-group-make-directory-group}).
2625 @findex gnus-group-make-help-group
2626 Make the Gnus help group (@code{gnus-group-make-help-group}).
2630 @cindex (ding) archive
2631 @cindex archive group
2632 @findex gnus-group-make-archive-group
2633 @vindex gnus-group-archive-directory
2634 @vindex gnus-group-recent-archive-directory
2635 Make a Gnus archive group (@code{gnus-group-make-archive-group}). By
2636 default a group pointing to the most recent articles will be created
2637 (@code{gnus-group-recent-archive-directory}), but given a prefix, a full
2638 group will be created from @code{gnus-group-archive-directory}.
2642 @findex gnus-group-make-kiboze-group
2644 Make a kiboze group. You will be prompted for a name, for a regexp to
2645 match groups to be ``included'' in the kiboze group, and a series of
2646 strings to match on headers (@code{gnus-group-make-kiboze-group}).
2647 @xref{Kibozed Groups}.
2651 @findex gnus-group-enter-directory
2653 Read an arbitrary directory as if it were a newsgroup with the
2654 @code{nneething} back end (@code{gnus-group-enter-directory}).
2655 @xref{Anything Groups}.
2659 @findex gnus-group-make-doc-group
2660 @cindex ClariNet Briefs
2662 Make a group based on some file or other
2663 (@code{gnus-group-make-doc-group}). If you give a prefix to this
2664 command, you will be prompted for a file name and a file type.
2665 Currently supported types are @code{mbox}, @code{babyl},
2666 @code{digest}, @code{news}, @code{rnews}, @code{mmdf}, @code{forward},
2667 @code{rfc934}, @code{rfc822-forward}, @code{mime-parts},
2668 @code{standard-digest}, @code{slack-digest}, @code{clari-briefs},
2669 @code{nsmail}, @code{outlook}, @code{oe-dbx}, and @code{mailman}. If
2670 you run this command without a prefix, Gnus will guess at the file
2671 type. @xref{Document Groups}.
2675 @vindex gnus-useful-groups
2676 @findex gnus-group-make-useful-group
2677 Create one of the groups mentioned in @code{gnus-useful-groups}
2678 (@code{gnus-group-make-useful-group}).
2682 @findex gnus-group-make-web-group
2686 Make an ephemeral group based on a web search
2687 (@code{gnus-group-make-web-group}). If you give a prefix to this
2688 command, make a solid group instead. You will be prompted for the
2689 search engine type and the search string. Valid search engine types
2690 include @code{google}, @code{dejanews}, and @code{gmane}.
2691 @xref{Web Searches}.
2693 If you use the @code{google} search engine, you can limit the search
2694 to a particular group by using a match string like
2695 @samp{shaving group:alt.sysadmin.recovery}.
2699 @findex gnus-group-make-rss-group
2700 Make a group based on an @acronym{RSS} feed
2701 (@code{gnus-group-make-rss-group}). You will be prompted for an URL.
2705 @kindex G DEL (Group)
2706 @findex gnus-group-delete-group
2707 This function will delete the current group
2708 (@code{gnus-group-delete-group}). If given a prefix, this function will
2709 actually delete all the articles in the group, and forcibly remove the
2710 group itself from the face of the Earth. Use a prefix only if you are
2711 absolutely sure of what you are doing. This command can't be used on
2712 read-only groups (like @code{nntp} groups), though.
2716 @findex gnus-group-make-empty-virtual
2717 Make a new, fresh, empty @code{nnvirtual} group
2718 (@code{gnus-group-make-empty-virtual}). @xref{Virtual Groups}.
2722 @findex gnus-group-add-to-virtual
2723 Add the current group to an @code{nnvirtual} group
2724 (@code{gnus-group-add-to-virtual}). Uses the process/prefix convention.
2727 @xref{Select Methods}, for more information on the various select
2730 @vindex gnus-activate-foreign-newsgroups
2731 If @code{gnus-activate-foreign-newsgroups} is a positive number,
2732 Gnus will check all foreign groups with this level or lower at startup.
2733 This might take quite a while, especially if you subscribe to lots of
2734 groups from different @acronym{NNTP} servers. Also @pxref{Group Levels};
2735 @code{gnus-activate-level} also affects activation of foreign
2739 @node Group Parameters
2740 @section Group Parameters
2741 @cindex group parameters
2743 The group parameters store information local to a particular group.
2745 Use the @kbd{G p} or the @kbd{G c} command to edit group parameters of a
2746 group. (@kbd{G p} presents you with a Lisp-based interface, @kbd{G c}
2747 presents you with a Customize-like interface. The latter helps avoid
2748 silly Lisp errors.) You might also be interested in reading about topic
2749 parameters (@pxref{Topic Parameters}).
2750 Additionally, you can set group parameters via the
2751 @code{gnus-parameters} variable, see below.
2753 Here's an example group parameter list:
2756 ((to-address . "ding@@gnus.org")
2760 We see that each element consists of a ``dotted pair''---the thing before
2761 the dot is the key, while the thing after the dot is the value. All the
2762 parameters have this form @emph{except} local variable specs, which are
2763 not dotted pairs, but proper lists.
2765 Some parameters have correspondent customizable variables, each of which
2766 is an alist of regexps and values.
2768 The following group parameters can be used:
2773 Address used by when doing followups and new posts.
2776 (to-address . "some@@where.com")
2779 This is primarily useful in mail groups that represent closed mailing
2780 lists---mailing lists where it's expected that everybody that writes to
2781 the mailing list is subscribed to it. Since using this parameter
2782 ensures that the mail only goes to the mailing list itself, it means
2783 that members won't receive two copies of your followups.
2785 Using @code{to-address} will actually work whether the group is foreign
2786 or not. Let's say there's a group on the server that is called
2787 @samp{fa.4ad-l}. This is a real newsgroup, but the server has gotten
2788 the articles from a mail-to-news gateway. Posting directly to this
2789 group is therefore impossible---you have to send mail to the mailing
2790 list address instead.
2792 See also @code{gnus-parameter-to-address-alist}.
2796 Address used when doing @kbd{a} in that group.
2799 (to-list . "some@@where.com")
2802 It is totally ignored
2803 when doing a followup---except that if it is present in a news group,
2804 you'll get mail group semantics when doing @kbd{f}.
2806 If you do an @kbd{a} command in a mail group and you have neither a
2807 @code{to-list} group parameter nor a @code{to-address} group parameter,
2808 then a @code{to-list} group parameter will be added automatically upon
2809 sending the message if @code{gnus-add-to-list} is set to @code{t}.
2810 @vindex gnus-add-to-list
2812 @findex gnus-mailing-list-mode
2813 @cindex mail list groups
2814 If this variable is set, @code{gnus-mailing-list-mode} is turned on when
2815 entering summary buffer.
2817 See also @code{gnus-parameter-to-list-alist}.
2822 @cindex Mail-Followup-To
2823 @findex gnus-find-subscribed-addresses
2824 If this parameter is set to @code{t}, Gnus will consider the
2825 to-address and to-list parameters for this group as addresses of
2826 mailing lists you are subscribed to. Giving Gnus this information is
2827 (only) a first step in getting it to generate correct Mail-Followup-To
2828 headers for your posts to these lists. The second step is to put the
2829 following in your @file{.gnus.el}
2832 (setq message-subscribed-address-functions
2833 '(gnus-find-subscribed-addresses))
2836 @xref{Mailing Lists, ,Mailing Lists, message, The Message Manual}, for
2837 a complete treatment of available MFT support.
2841 If the group parameter list has the element @code{(visible . t)},
2842 that group will always be visible in the Group buffer, regardless
2843 of whether it has any unread articles.
2845 This parameter cannot be set via @code{gnus-parameters}. See
2846 @code{gnus-permanently-visible-groups} as an alternative.
2848 @item broken-reply-to
2849 @cindex broken-reply-to
2850 Elements like @code{(broken-reply-to . t)} signals that @code{Reply-To}
2851 headers in this group are to be ignored, and for the header to be hidden
2852 if @code{reply-to} is part of @code{gnus-boring-article-headers}. This
2853 can be useful if you're reading a mailing list group where the listserv
2854 has inserted @code{Reply-To} headers that point back to the listserv
2855 itself. That is broken behavior. So there!
2859 Elements like @code{(to-group . "some.group.name")} means that all
2860 posts in that group will be sent to @code{some.group.name}.
2864 If you have @code{(newsgroup . t)} in the group parameter list, Gnus
2865 will treat all responses as if they were responses to news articles.
2866 This can be useful if you have a mail group that's really a mirror of a
2871 If @code{(gcc-self . t)} is present in the group parameter list, newly
2872 composed messages will be @code{Gcc}'d to the current group. If
2873 @code{(gcc-self . none)} is present, no @code{Gcc:} header will be
2874 generated, if @code{(gcc-self . "string")} is present, this string will
2875 be inserted literally as a @code{gcc} header. This parameter takes
2876 precedence over any default @code{Gcc} rules as described later
2877 (@pxref{Archived Messages}).
2879 @strong{Caveat}: Adding @code{(gcc-self . t)} to the parameter list of
2880 @code{nntp} groups (or the like) isn't valid. An @code{nntp} server
2881 doesn't accept articles.
2885 @cindex expiring mail
2886 If the group parameter has an element that looks like @code{(auto-expire
2887 . t)}, all articles read will be marked as expirable. For an
2888 alternative approach, @pxref{Expiring Mail}.
2890 See also @code{gnus-auto-expirable-newsgroups}.
2893 @cindex total-expire
2894 @cindex expiring mail
2895 If the group parameter has an element that looks like
2896 @code{(total-expire . t)}, all read articles will be put through the
2897 expiry process, even if they are not marked as expirable. Use with
2898 caution. Unread, ticked and dormant articles are not eligible for
2901 See also @code{gnus-total-expirable-newsgroups}.
2905 @vindex nnmail-expiry-wait-function
2906 If the group parameter has an element that looks like
2907 @code{(expiry-wait . 10)}, this value will override any
2908 @code{nnmail-expiry-wait} and @code{nnmail-expiry-wait-function}
2909 (@pxref{Expiring Mail}) when expiring expirable messages. The value
2910 can either be a number of days (not necessarily an integer) or the
2911 symbols @code{never} or @code{immediate}.
2914 @cindex expiry-target
2915 Where expired messages end up. This parameter overrides
2916 @code{nnmail-expiry-target}.
2919 @cindex score file group parameter
2920 Elements that look like @code{(score-file . "file")} will make
2921 @file{file} into the current score file for the group in question. All
2922 interactive score entries will be put into this file.
2925 @cindex adapt file group parameter
2926 Elements that look like @code{(adapt-file . "file")} will make
2927 @file{file} into the current adaptive file for the group in question.
2928 All adaptive score entries will be put into this file.
2931 @cindex admin-address
2932 When unsubscribing from a mailing list you should never send the
2933 unsubscription notice to the mailing list itself. Instead, you'd send
2934 messages to the administrative address. This parameter allows you to
2935 put the admin address somewhere convenient.
2939 Elements that look like @code{(display . MODE)} say which articles to
2940 display on entering the group. Valid values are:
2944 Display all articles, both read and unread.
2947 Display the last @var{integer} articles in the group. This is the same as
2948 entering the group with @kbd{C-u @var{integer}}.
2951 Display the default visible articles, which normally includes unread and
2955 Display articles that satisfy a predicate.
2957 Here are some examples:
2961 Display only unread articles.
2964 Display everything except expirable articles.
2966 @item [and (not reply) (not expire)]
2967 Display everything except expirable and articles you've already
2971 The available operators are @code{not}, @code{and} and @code{or}.
2972 Predicates include @code{tick}, @code{unsend}, @code{undownload},
2973 @code{unread}, @code{dormant}, @code{expire}, @code{reply},
2974 @code{killed}, @code{bookmark}, @code{score}, @code{save},
2975 @code{cache}, @code{forward}, @code{unseen} and @code{recent}.
2979 The @code{display} parameter works by limiting the summary buffer to
2980 the subset specified. You can pop the limit by using the @kbd{/ w}
2981 command (@pxref{Limiting}).
2985 Elements that look like @code{(comment . "This is a comment")} are
2986 arbitrary comments on the group. You can display comments in the
2987 group line (@pxref{Group Line Specification}).
2991 Elements that look like @code{(charset . iso-8859-1)} will make
2992 @code{iso-8859-1} the default charset; that is, the charset that will be
2993 used for all articles that do not specify a charset.
2995 See also @code{gnus-group-charset-alist}.
2997 @item ignored-charsets
2998 @cindex ignored-charset
2999 Elements that look like @code{(ignored-charsets x-unknown iso-8859-1)}
3000 will make @code{iso-8859-1} and @code{x-unknown} ignored; that is, the
3001 default charset will be used for decoding articles.
3003 See also @code{gnus-group-ignored-charsets-alist}.
3006 @cindex posting-style
3007 You can store additional posting style information for this group
3008 here (@pxref{Posting Styles}). The format is that of an entry in the
3009 @code{gnus-posting-styles} alist, except that there's no regexp matching
3010 the group name (of course). Style elements in this group parameter will
3011 take precedence over the ones found in @code{gnus-posting-styles}.
3013 For instance, if you want a funky name and signature in this group only,
3014 instead of hacking @code{gnus-posting-styles}, you could put something
3015 like this in the group parameters:
3020 ("X-My-Header" "Funky Value")
3021 (signature "Funky Signature"))
3024 If you're using topics to organize your group buffer
3025 (@pxref{Group Topics}), note that posting styles can also be set in
3026 the topics parameters. Posting styles in topic parameters apply to all
3027 groups in this topic. More precisely, the posting-style settings for a
3028 group result from the hierarchical merging of all posting-style
3029 entries in the parameters of this group and all the topics it belongs
3035 If it is set, the value is used as the method for posting message
3036 instead of @code{gnus-post-method}.
3040 If it is set, and the setting of @code{mail-sources} includes a
3041 @code{group} mail source (@pxref{Mail Sources}), the value is a
3042 mail source for this group.
3046 An item like @code{(banner . @var{regexp})} causes any part of an article
3047 that matches the regular expression @var{regexp} to be stripped. Instead of
3048 @var{regexp}, you can also use the symbol @code{signature} which strips the
3049 last signature or any of the elements of the alist
3050 @code{gnus-article-banner-alist}.
3054 This parameter contains a Sieve test that should match incoming mail
3055 that should be placed in this group. From this group parameter, a
3056 Sieve @samp{IF} control structure is generated, having the test as the
3057 condition and @samp{fileinto "group.name";} as the body.
3059 For example, if the @samp{INBOX.list.sieve} group has the @code{(sieve
3060 address "sender" "sieve-admin@@extundo.com")} group parameter, when
3061 translating the group parameter into a Sieve script (@pxref{Sieve
3062 Commands}) the following Sieve code is generated:
3065 if address "sender" "sieve-admin@@extundo.com" @{
3066 fileinto "INBOX.list.sieve";
3070 To generate tests for multiple email-addresses use a group parameter
3071 like @code{(sieve address "sender" ("name@@one.org" else@@two.org"))}.
3072 When generating a sieve script (@pxref{Sieve Commands}) Sieve code
3073 like the following is generated:
3076 if address "sender" ["name@@one.org", "else@@two.org"] @{
3077 fileinto "INBOX.list.sieve";
3081 See @pxref{Sieve Commands} for commands and variables that might be of
3082 interest in relation to the sieve parameter.
3084 The Sieve language is described in RFC 3028. @xref{Top, Emacs Sieve,
3085 Top, sieve, Emacs Sieve}.
3087 @item (agent parameters)
3088 If the agent has been enabled, you can set any of the its parameters
3089 to control the behavior of the agent in individual groups. See Agent
3090 Parameters in @ref{Category Syntax}. Most users will choose to set
3091 agent parameters in either an agent category or group topic to
3092 minimize the configuration effort.
3094 @item (@var{variable} @var{form})
3095 You can use the group parameters to set variables local to the group you
3096 are entering. If you want to turn threading off in @samp{news.answers},
3097 you could put @code{(gnus-show-threads nil)} in the group parameters of
3098 that group. @code{gnus-show-threads} will be made into a local variable
3099 in the summary buffer you enter, and the form @code{nil} will be
3100 @code{eval}ed there.
3102 Note that this feature sets the variable locally to the summary buffer.
3103 But some variables are evaluated in the article buffer, or in the
3104 message buffer (of a reply or followup or otherwise newly created
3105 message). As a workaround, it might help to add the variable in
3106 question to @code{gnus-newsgroup-variables}. @xref{Various Summary
3107 Stuff}. So if you want to set @code{message-from-style} via the group
3108 parameters, then you may need the following statement elsewhere in your
3109 @file{~/.gnus} file:
3112 (add-to-list 'gnus-newsgroup-variables 'message-from-style)
3115 @vindex gnus-list-identifiers
3116 A use for this feature is to remove a mailing list identifier tag in
3117 the subject fields of articles. E.g. if the news group
3120 nntp+news.gnus.org:gmane.text.docbook.apps
3123 has the tag @samp{DOC-BOOK-APPS:} in the subject of all articles, this
3124 tag can be removed from the article subjects in the summary buffer for
3125 the group by putting @code{(gnus-list-identifiers "DOCBOOK-APPS:")}
3126 into the group parameters for the group.
3128 This can also be used as a group-specific hook function. If you want to
3129 hear a beep when you enter a group, you could put something like
3130 @code{(dummy-variable (ding))} in the parameters of that group.
3131 @code{dummy-variable} will be set to the (meaningless) result of the
3134 Alternatively, since the VARIABLE becomes local to the group, this
3135 pattern can be used to temporarily change a hook. For example, if the
3136 following is added to a group parameter
3139 (gnus-summary-prepared-hook
3140 '(lambda nil (local-set-key "d" (local-key-binding "n"))))
3143 when the group is entered, the 'd' key will not mark the article as
3148 @vindex gnus-parameters
3149 Group parameters can be set via the @code{gnus-parameters} variable too.
3150 But some variables, such as @code{visible}, have no effect (For this
3151 case see @code{gnus-permanently-visible-groups} as an alternative.).
3155 (setq gnus-parameters
3157 (gnus-show-threads nil)
3158 (gnus-use-scoring nil)
3159 (gnus-summary-line-format
3160 "%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\n")
3164 ("^nnimap:\\(foo.bar\\)$"
3168 (gnus-use-scoring t))
3172 (broken-reply-to . t))))
3175 String value of parameters will be subjected to regexp substitution, as
3176 the @code{to-group} example shows.
3178 @vindex gnus-parameters-case-fold-search
3179 By default, whether comparing the group name and one of those regexps
3180 specified in @code{gnus-parameters} is done in a case-sensitive manner
3181 or a case-insensitive manner depends on the value of
3182 @code{case-fold-search} at the time when the comparison is done. The
3183 value of @code{case-fold-search} is typically @code{t}; it means, for
3184 example, the element @code{("INBOX\\.FOO" (total-expire . t))} might be
3185 applied to both the @samp{INBOX.FOO} group and the @samp{INBOX.foo}
3186 group. If you want to make those regexps always case-sensitive, set the
3187 value of the @code{gnus-parameters-case-fold-search} variable to
3188 @code{nil}. Otherwise, set it to @code{t} if you want to compare them
3189 always in a case-insensitive manner.
3191 You can define different sorting to different groups via
3192 @code{gnus-parameters}. Here is an example to sort an @acronym{NNTP}
3193 group by reverse date to see the latest news at the top and an
3194 @acronym{RSS} group by subject. In this example, the first group is the
3195 Debian daily news group @code{gmane.linux.debian.user.news} from
3196 news.gmane.org. The @acronym{RSS} group corresponds to the Debian
3197 weekly news RSS feed
3198 @url{http://packages.debian.org/unstable/newpkg_main.en.rdf},
3204 '(("nntp.*gmane\\.debian\\.user\\.news"
3205 (gnus-show-threads nil)
3206 (gnus-article-sort-functions '((not gnus-article-sort-by-date)))
3207 (gnus-use-adaptive-scoring nil)
3208 (gnus-use-scoring nil))
3210 (gnus-show-threads nil)
3211 (gnus-article-sort-functions 'gnus-article-sort-by-subject)
3212 (gnus-use-adaptive-scoring nil)
3213 (gnus-use-scoring t)
3214 (gnus-score-find-score-files-function 'gnus-score-find-single)
3215 (gnus-summary-line-format "%U%R%z%d %I%(%[ %s %]%)\n"))))
3219 @node Listing Groups
3220 @section Listing Groups
3221 @cindex group listing
3223 These commands all list various slices of the groups available.
3231 @findex gnus-group-list-groups
3232 List all groups that have unread articles
3233 (@code{gnus-group-list-groups}). If the numeric prefix is used, this
3234 command will list only groups of level ARG and lower. By default, it
3235 only lists groups of level five (i.e.,
3236 @code{gnus-group-default-list-level}) or lower (i.e., just subscribed
3243 @findex gnus-group-list-all-groups
3244 List all groups, whether they have unread articles or not
3245 (@code{gnus-group-list-all-groups}). If the numeric prefix is used,
3246 this command will list only groups of level ARG and lower. By default,
3247 it lists groups of level seven or lower (i.e., just subscribed and
3248 unsubscribed groups).
3252 @findex gnus-group-list-level
3253 List all unread groups on a specific level
3254 (@code{gnus-group-list-level}). If given a prefix, also list the groups
3255 with no unread articles.
3259 @findex gnus-group-list-killed
3260 List all killed groups (@code{gnus-group-list-killed}). If given a
3261 prefix argument, really list all groups that are available, but aren't
3262 currently (un)subscribed. This could entail reading the active file
3267 @findex gnus-group-list-zombies
3268 List all zombie groups (@code{gnus-group-list-zombies}).
3272 @findex gnus-group-list-matching
3273 List all unread, subscribed groups with names that match a regexp
3274 (@code{gnus-group-list-matching}).
3278 @findex gnus-group-list-all-matching
3279 List groups that match a regexp (@code{gnus-group-list-all-matching}).
3283 @findex gnus-group-list-active
3284 List absolutely all groups in the active file(s) of the
3285 server(s) you are connected to (@code{gnus-group-list-active}). This
3286 might very well take quite a while. It might actually be a better idea
3287 to do a @kbd{A M} to list all matching, and just give @samp{.} as the
3288 thing to match on. Also note that this command may list groups that
3289 don't exist (yet)---these will be listed as if they were killed groups.
3290 Take the output with some grains of salt.
3294 @findex gnus-group-apropos
3295 List all groups that have names that match a regexp
3296 (@code{gnus-group-apropos}).
3300 @findex gnus-group-description-apropos
3301 List all groups that have names or descriptions that match a regexp
3302 (@code{gnus-group-description-apropos}).
3306 @findex gnus-group-list-cached
3307 List all groups with cached articles (@code{gnus-group-list-cached}).
3311 @findex gnus-group-list-dormant
3312 List all groups with dormant articles (@code{gnus-group-list-dormant}).
3316 @findex gnus-group-list-limit
3317 List groups limited within the current selection
3318 (@code{gnus-group-list-limit}).
3322 @findex gnus-group-list-flush
3323 Flush groups from the current selection (@code{gnus-group-list-flush}).
3327 @findex gnus-group-list-plus
3328 List groups plus the current selection (@code{gnus-group-list-plus}).
3332 @vindex gnus-permanently-visible-groups
3333 @cindex visible group parameter
3334 Groups that match the @code{gnus-permanently-visible-groups} regexp will
3335 always be shown, whether they have unread articles or not. You can also
3336 add the @code{visible} element to the group parameters in question to
3337 get the same effect.
3339 @vindex gnus-list-groups-with-ticked-articles
3340 Groups that have just ticked articles in it are normally listed in the
3341 group buffer. If @code{gnus-list-groups-with-ticked-articles} is
3342 @code{nil}, these groups will be treated just like totally empty
3343 groups. It is @code{t} by default.
3346 @node Sorting Groups
3347 @section Sorting Groups
3348 @cindex sorting groups
3350 @kindex C-c C-s (Group)
3351 @findex gnus-group-sort-groups
3352 @vindex gnus-group-sort-function
3353 The @kbd{C-c C-s} (@code{gnus-group-sort-groups}) command sorts the
3354 group buffer according to the function(s) given by the
3355 @code{gnus-group-sort-function} variable. Available sorting functions
3360 @item gnus-group-sort-by-alphabet
3361 @findex gnus-group-sort-by-alphabet
3362 Sort the group names alphabetically. This is the default.
3364 @item gnus-group-sort-by-real-name
3365 @findex gnus-group-sort-by-real-name
3366 Sort the group alphabetically on the real (unprefixed) group names.
3368 @item gnus-group-sort-by-level
3369 @findex gnus-group-sort-by-level
3370 Sort by group level.
3372 @item gnus-group-sort-by-score
3373 @findex gnus-group-sort-by-score
3374 Sort by group score. @xref{Group Score}.
3376 @item gnus-group-sort-by-rank
3377 @findex gnus-group-sort-by-rank
3378 Sort by group score and then the group level. The level and the score
3379 are, when taken together, the group's @dfn{rank}. @xref{Group Score}.
3381 @item gnus-group-sort-by-unread
3382 @findex gnus-group-sort-by-unread
3383 Sort by number of unread articles.
3385 @item gnus-group-sort-by-method
3386 @findex gnus-group-sort-by-method
3387 Sort alphabetically on the select method.
3389 @item gnus-group-sort-by-server
3390 @findex gnus-group-sort-by-server
3391 Sort alphabetically on the Gnus server name.
3396 @code{gnus-group-sort-function} can also be a list of sorting
3397 functions. In that case, the most significant sort key function must be
3401 There are also a number of commands for sorting directly according to
3402 some sorting criteria:
3406 @kindex G S a (Group)
3407 @findex gnus-group-sort-groups-by-alphabet
3408 Sort the group buffer alphabetically by group name
3409 (@code{gnus-group-sort-groups-by-alphabet}).
3412 @kindex G S u (Group)
3413 @findex gnus-group-sort-groups-by-unread
3414 Sort the group buffer by the number of unread articles
3415 (@code{gnus-group-sort-groups-by-unread}).
3418 @kindex G S l (Group)
3419 @findex gnus-group-sort-groups-by-level
3420 Sort the group buffer by group level
3421 (@code{gnus-group-sort-groups-by-level}).
3424 @kindex G S v (Group)
3425 @findex gnus-group-sort-groups-by-score
3426 Sort the group buffer by group score
3427 (@code{gnus-group-sort-groups-by-score}). @xref{Group Score}.
3430 @kindex G S r (Group)
3431 @findex gnus-group-sort-groups-by-rank
3432 Sort the group buffer by group rank
3433 (@code{gnus-group-sort-groups-by-rank}). @xref{Group Score}.
3436 @kindex G S m (Group)
3437 @findex gnus-group-sort-groups-by-method
3438 Sort the group buffer alphabetically by back end name@*
3439 (@code{gnus-group-sort-groups-by-method}).
3442 @kindex G S n (Group)
3443 @findex gnus-group-sort-groups-by-real-name
3444 Sort the group buffer alphabetically by real (unprefixed) group name
3445 (@code{gnus-group-sort-groups-by-real-name}).
3449 All the commands below obey the process/prefix convention
3450 (@pxref{Process/Prefix}).
3452 When given a symbolic prefix (@pxref{Symbolic Prefixes}), all these
3453 commands will sort in reverse order.
3455 You can also sort a subset of the groups:
3459 @kindex G P a (Group)
3460 @findex gnus-group-sort-selected-groups-by-alphabet
3461 Sort the groups alphabetically by group name
3462 (@code{gnus-group-sort-selected-groups-by-alphabet}).
3465 @kindex G P u (Group)
3466 @findex gnus-group-sort-selected-groups-by-unread
3467 Sort the groups by the number of unread articles
3468 (@code{gnus-group-sort-selected-groups-by-unread}).
3471 @kindex G P l (Group)
3472 @findex gnus-group-sort-selected-groups-by-level
3473 Sort the groups by group level
3474 (@code{gnus-group-sort-selected-groups-by-level}).
3477 @kindex G P v (Group)
3478 @findex gnus-group-sort-selected-groups-by-score
3479 Sort the groups by group score
3480 (@code{gnus-group-sort-selected-groups-by-score}). @xref{Group Score}.
3483 @kindex G P r (Group)
3484 @findex gnus-group-sort-selected-groups-by-rank
3485 Sort the groups by group rank
3486 (@code{gnus-group-sort-selected-groups-by-rank}). @xref{Group Score}.
3489 @kindex G P m (Group)
3490 @findex gnus-group-sort-selected-groups-by-method
3491 Sort the groups alphabetically by back end name@*
3492 (@code{gnus-group-sort-selected-groups-by-method}).
3495 @kindex G P n (Group)
3496 @findex gnus-group-sort-selected-groups-by-real-name
3497 Sort the groups alphabetically by real (unprefixed) group name
3498 (@code{gnus-group-sort-selected-groups-by-real-name}).
3501 @kindex G P s (Group)
3502 @findex gnus-group-sort-selected-groups
3503 Sort the groups according to @code{gnus-group-sort-function}.
3507 And finally, note that you can use @kbd{C-k} and @kbd{C-y} to manually
3511 @node Group Maintenance
3512 @section Group Maintenance
3513 @cindex bogus groups
3518 @findex gnus-group-check-bogus-groups
3519 Find bogus groups and delete them
3520 (@code{gnus-group-check-bogus-groups}).
3524 @findex gnus-group-find-new-groups
3525 Find new groups and process them (@code{gnus-group-find-new-groups}).
3526 With 1 @kbd{C-u}, use the @code{ask-server} method to query the server
3527 for new groups. With 2 @kbd{C-u}'s, use most complete method possible
3528 to query the server for new groups, and subscribe the new groups as
3532 @kindex C-c C-x (Group)
3533 @findex gnus-group-expire-articles
3534 @cindex expiring mail
3535 Run all expirable articles in the current group through the expiry
3536 process (if any) (@code{gnus-group-expire-articles}). That is, delete
3537 all expirable articles in the group that have been around for a while.
3538 (@pxref{Expiring Mail}).
3541 @kindex C-c C-M-x (Group)
3542 @findex gnus-group-expire-all-groups
3543 @cindex expiring mail
3544 Run all expirable articles in all groups through the expiry process
3545 (@code{gnus-group-expire-all-groups}).
3550 @node Browse Foreign Server
3551 @section Browse Foreign Server
3552 @cindex foreign servers
3553 @cindex browsing servers
3558 @findex gnus-group-browse-foreign-server
3559 You will be queried for a select method and a server name. Gnus will
3560 then attempt to contact this server and let you browse the groups there
3561 (@code{gnus-group-browse-foreign-server}).
3564 @findex gnus-browse-mode
3565 A new buffer with a list of available groups will appear. This buffer
3566 will use the @code{gnus-browse-mode}. This buffer looks a bit (well,
3567 a lot) like a normal group buffer.
3569 Here's a list of keystrokes available in the browse mode:
3574 @findex gnus-group-next-group
3575 Go to the next group (@code{gnus-group-next-group}).
3579 @findex gnus-group-prev-group
3580 Go to the previous group (@code{gnus-group-prev-group}).
3583 @kindex SPACE (Browse)
3584 @findex gnus-browse-read-group
3585 Enter the current group and display the first article
3586 (@code{gnus-browse-read-group}).
3589 @kindex RET (Browse)
3590 @findex gnus-browse-select-group
3591 Enter the current group (@code{gnus-browse-select-group}).
3595 @findex gnus-browse-unsubscribe-current-group
3596 Unsubscribe to the current group, or, as will be the case here,
3597 subscribe to it (@code{gnus-browse-unsubscribe-current-group}).
3603 @findex gnus-browse-exit
3604 Exit browse mode (@code{gnus-browse-exit}).
3608 @findex gnus-browse-describe-group
3609 Describe the current group (@code{gnus-browse-describe-group}).
3613 @findex gnus-browse-describe-briefly
3614 Describe browse mode briefly (well, there's not much to describe, is
3615 there) (@code{gnus-browse-describe-briefly}).
3620 @section Exiting Gnus
3621 @cindex exiting Gnus
3623 Yes, Gnus is ex(c)iting.
3628 @findex gnus-group-suspend
3629 Suspend Gnus (@code{gnus-group-suspend}). This doesn't really exit Gnus,
3630 but it kills all buffers except the Group buffer. I'm not sure why this
3631 is a gain, but then who am I to judge?
3635 @findex gnus-group-exit
3636 @c @icon{gnus-group-exit}
3637 Quit Gnus (@code{gnus-group-exit}).
3641 @findex gnus-group-quit
3642 Quit Gnus without saving the @file{.newsrc} files (@code{gnus-group-quit}).
3643 The dribble file will be saved, though (@pxref{Auto Save}).
3646 @vindex gnus-exit-gnus-hook
3647 @vindex gnus-suspend-gnus-hook
3648 @vindex gnus-after-exiting-gnus-hook
3649 @code{gnus-suspend-gnus-hook} is called when you suspend Gnus and
3650 @code{gnus-exit-gnus-hook} is called when you quit Gnus, while
3651 @code{gnus-after-exiting-gnus-hook} is called as the final item when
3657 Miss Lisa Cannifax, while sitting in English class, felt her feet go
3658 numbly heavy and herself fall into a hazy trance as the boy sitting
3659 behind her drew repeated lines with his pencil across the back of her
3665 @section Group Topics
3668 If you read lots and lots of groups, it might be convenient to group
3669 them hierarchically according to topics. You put your Emacs groups over
3670 here, your sex groups over there, and the rest (what, two groups or so?)
3671 you put in some misc section that you never bother with anyway. You can
3672 even group the Emacs sex groups as a sub-topic to either the Emacs
3673 groups or the sex groups---or both! Go wild!
3677 \gnusfigure{Group Topics}{400}{
3678 \put(75,50){\epsfig{figure=ps/group-topic,height=9cm}}
3689 2: alt.religion.emacs
3692 0: comp.talk.emacs.recovery
3694 8: comp.binaries.fractals
3695 13: comp.sources.unix
3698 @findex gnus-topic-mode
3700 To get this @emph{fab} functionality you simply turn on (ooh!) the
3701 @code{gnus-topic} minor mode---type @kbd{t} in the group buffer. (This
3702 is a toggling command.)
3704 Go ahead, just try it. I'll still be here when you get back. La de
3705 dum@dots{} Nice tune, that@dots{} la la la@dots{} What, you're back?
3706 Yes, and now press @kbd{l}. There. All your groups are now listed
3707 under @samp{misc}. Doesn't that make you feel all warm and fuzzy?
3710 If you want this permanently enabled, you should add that minor mode to
3711 the hook for the group mode. Put the following line in your
3712 @file{~/.gnus.el} file:
3715 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
3719 * Topic Commands:: Interactive E-Z commands.
3720 * Topic Variables:: How to customize the topics the Lisp Way.
3721 * Topic Sorting:: Sorting each topic individually.
3722 * Topic Topology:: A map of the world.
3723 * Topic Parameters:: Parameters that apply to all groups in a topic.
3727 @node Topic Commands
3728 @subsection Topic Commands
3729 @cindex topic commands
3731 When the topic minor mode is turned on, a new @kbd{T} submap will be
3732 available. In addition, a few of the standard keys change their
3733 definitions slightly.
3735 In general, the following kinds of operations are possible on topics.
3736 First of all, you want to create topics. Secondly, you want to put
3737 groups in topics and to move them around until you have an order you
3738 like. The third kind of operation is to show/hide parts of the whole
3739 shebang. You might want to hide a topic including its subtopics and
3740 groups, to get a better overview of the other groups.
3742 Here is a list of the basic keys that you might need to set up topics
3749 @findex gnus-topic-create-topic
3750 Prompt for a new topic name and create it
3751 (@code{gnus-topic-create-topic}).
3755 @kindex T TAB (Topic)
3757 @findex gnus-topic-indent
3758 ``Indent'' the current topic so that it becomes a sub-topic of the
3759 previous topic (@code{gnus-topic-indent}). If given a prefix,
3760 ``un-indent'' the topic instead.
3763 @kindex M-TAB (Topic)
3764 @findex gnus-topic-unindent
3765 ``Un-indent'' the current topic so that it becomes a sub-topic of the
3766 parent of its current parent (@code{gnus-topic-unindent}).
3770 The following two keys can be used to move groups and topics around.
3771 They work like the well-known cut and paste. @kbd{C-k} is like cut and
3772 @kbd{C-y} is like paste. Of course, this being Emacs, we use the terms
3773 kill and yank rather than cut and paste.
3779 @findex gnus-topic-kill-group
3780 Kill a group or topic (@code{gnus-topic-kill-group}). All groups in the
3781 topic will be removed along with the topic.
3785 @findex gnus-topic-yank-group
3786 Yank the previously killed group or topic
3787 (@code{gnus-topic-yank-group}). Note that all topics will be yanked
3790 So, to move a topic to the beginning of the list of topics, just hit
3791 @kbd{C-k} on it. This is like the ``cut'' part of cut and paste. Then,
3792 move the cursor to the beginning of the buffer (just below the ``Gnus''
3793 topic) and hit @kbd{C-y}. This is like the ``paste'' part of cut and
3794 paste. Like I said -- E-Z.
3796 You can use @kbd{C-k} and @kbd{C-y} on groups as well as on topics. So
3797 you can move topics around as well as groups.
3801 After setting up the topics the way you like them, you might wish to
3802 hide a topic, or to show it again. That's why we have the following
3809 @findex gnus-topic-select-group
3811 Either select a group or fold a topic (@code{gnus-topic-select-group}).
3812 When you perform this command on a group, you'll enter the group, as
3813 usual. When done on a topic line, the topic will be folded (if it was
3814 visible) or unfolded (if it was folded already). So it's basically a
3815 toggling command on topics. In addition, if you give a numerical
3816 prefix, group on that level (and lower) will be displayed.
3820 Now for a list of other commands, in no particular order.
3826 @findex gnus-topic-move-group
3827 Move the current group to some other topic
3828 (@code{gnus-topic-move-group}). This command uses the process/prefix
3829 convention (@pxref{Process/Prefix}).
3833 @findex gnus-topic-jump-to-topic
3834 Go to a topic (@code{gnus-topic-jump-to-topic}).
3838 @findex gnus-topic-copy-group
3839 Copy the current group to some other topic
3840 (@code{gnus-topic-copy-group}). This command uses the process/prefix
3841 convention (@pxref{Process/Prefix}).
3845 @findex gnus-topic-hide-topic
3846 Hide the current topic (@code{gnus-topic-hide-topic}). If given
3847 a prefix, hide the topic permanently.
3851 @findex gnus-topic-show-topic
3852 Show the current topic (@code{gnus-topic-show-topic}). If given
3853 a prefix, show the topic permanently.
3857 @findex gnus-topic-remove-group
3858 Remove a group from the current topic (@code{gnus-topic-remove-group}).
3859 This command is mainly useful if you have the same group in several
3860 topics and wish to remove it from one of the topics. You may also
3861 remove a group from all topics, but in that case, Gnus will add it to
3862 the root topic the next time you start Gnus. In fact, all new groups
3863 (which, naturally, don't belong to any topic) will show up in the root
3866 This command uses the process/prefix convention
3867 (@pxref{Process/Prefix}).
3871 @findex gnus-topic-move-matching
3872 Move all groups that match some regular expression to a topic
3873 (@code{gnus-topic-move-matching}).
3877 @findex gnus-topic-copy-matching
3878 Copy all groups that match some regular expression to a topic
3879 (@code{gnus-topic-copy-matching}).
3883 @findex gnus-topic-toggle-display-empty-topics
3884 Toggle hiding empty topics
3885 (@code{gnus-topic-toggle-display-empty-topics}).
3889 @findex gnus-topic-mark-topic
3890 Mark all groups in the current topic with the process mark
3891 (@code{gnus-topic-mark-topic}). This command works recursively on
3892 sub-topics unless given a prefix.
3895 @kindex T M-# (Topic)
3896 @findex gnus-topic-unmark-topic
3897 Remove the process mark from all groups in the current topic
3898 (@code{gnus-topic-unmark-topic}). This command works recursively on
3899 sub-topics unless given a prefix.
3902 @kindex C-c C-x (Topic)
3903 @findex gnus-topic-expire-articles
3904 @cindex expiring mail
3905 Run all expirable articles in the current group or topic through the
3906 expiry process (if any)
3907 (@code{gnus-topic-expire-articles}). (@pxref{Expiring Mail}).
3911 @findex gnus-topic-rename
3912 Rename a topic (@code{gnus-topic-rename}).
3915 @kindex T DEL (Topic)
3916 @findex gnus-topic-delete
3917 Delete an empty topic (@code{gnus-topic-delete}).
3921 @findex gnus-topic-list-active
3922 List all groups that Gnus knows about in a topics-ified way
3923 (@code{gnus-topic-list-active}).
3926 @kindex T M-n (Topic)
3927 @findex gnus-topic-goto-next-topic
3928 Go to the next topic (@code{gnus-topic-goto-next-topic}).
3931 @kindex T M-p (Topic)
3932 @findex gnus-topic-goto-previous-topic
3933 Go to the previous topic (@code{gnus-topic-goto-previous-topic}).
3937 @findex gnus-topic-edit-parameters
3938 @cindex group parameters
3939 @cindex topic parameters
3941 Edit the topic parameters (@code{gnus-topic-edit-parameters}).
3942 @xref{Topic Parameters}.
3947 @node Topic Variables
3948 @subsection Topic Variables
3949 @cindex topic variables
3951 The previous section told you how to tell Gnus which topics to display.
3952 This section explains how to tell Gnus what to display about each topic.
3954 @vindex gnus-topic-line-format
3955 The topic lines themselves are created according to the
3956 @code{gnus-topic-line-format} variable (@pxref{Formatting Variables}).
3969 Number of groups in the topic.
3971 Number of unread articles in the topic.
3973 Number of unread articles in the topic and all its subtopics.
3976 @vindex gnus-topic-indent-level
3977 Each sub-topic (and the groups in the sub-topics) will be indented with
3978 @code{gnus-topic-indent-level} times the topic level number of spaces.
3981 @vindex gnus-topic-mode-hook
3982 @code{gnus-topic-mode-hook} is called in topic minor mode buffers.
3984 @vindex gnus-topic-display-empty-topics
3985 The @code{gnus-topic-display-empty-topics} says whether to display even
3986 topics that have no unread articles in them. The default is @code{t}.
3990 @subsection Topic Sorting
3991 @cindex topic sorting
3993 You can sort the groups in each topic individually with the following
3999 @kindex T S a (Topic)
4000 @findex gnus-topic-sort-groups-by-alphabet
4001 Sort the current topic alphabetically by group name
4002 (@code{gnus-topic-sort-groups-by-alphabet}).
4005 @kindex T S u (Topic)
4006 @findex gnus-topic-sort-groups-by-unread
4007 Sort the current topic by the number of unread articles
4008 (@code{gnus-topic-sort-groups-by-unread}).
4011 @kindex T S l (Topic)
4012 @findex gnus-topic-sort-groups-by-level
4013 Sort the current topic by group level
4014 (@code{gnus-topic-sort-groups-by-level}).
4017 @kindex T S v (Topic)
4018 @findex gnus-topic-sort-groups-by-score
4019 Sort the current topic by group score
4020 (@code{gnus-topic-sort-groups-by-score}). @xref{Group Score}.
4023 @kindex T S r (Topic)
4024 @findex gnus-topic-sort-groups-by-rank
4025 Sort the current topic by group rank
4026 (@code{gnus-topic-sort-groups-by-rank}). @xref{Group Score}.
4029 @kindex T S m (Topic)
4030 @findex gnus-topic-sort-groups-by-method
4031 Sort the current topic alphabetically by back end name
4032 (@code{gnus-topic-sort-groups-by-method}).
4035 @kindex T S e (Topic)
4036 @findex gnus-topic-sort-groups-by-server
4037 Sort the current topic alphabetically by server name
4038 (@code{gnus-topic-sort-groups-by-server}).
4041 @kindex T S s (Topic)
4042 @findex gnus-topic-sort-groups
4043 Sort the current topic according to the function(s) given by the
4044 @code{gnus-group-sort-function} variable
4045 (@code{gnus-topic-sort-groups}).
4049 When given a prefix argument, all these commands will sort in reverse
4050 order. @xref{Sorting Groups}, for more information about group
4054 @node Topic Topology
4055 @subsection Topic Topology
4056 @cindex topic topology
4059 So, let's have a look at an example group buffer:
4066 2: alt.religion.emacs
4069 0: comp.talk.emacs.recovery
4071 8: comp.binaries.fractals
4072 13: comp.sources.unix
4076 So, here we have one top-level topic (@samp{Gnus}), two topics under
4077 that, and one sub-topic under one of the sub-topics. (There is always
4078 just one (1) top-level topic). This topology can be expressed as
4083 (("Emacs -- I wuw it!" visible)
4084 (("Naughty Emacs" visible)))
4088 @vindex gnus-topic-topology
4089 This is in fact how the variable @code{gnus-topic-topology} would look
4090 for the display above. That variable is saved in the @file{.newsrc.eld}
4091 file, and shouldn't be messed with manually---unless you really want
4092 to. Since this variable is read from the @file{.newsrc.eld} file,
4093 setting it in any other startup files will have no effect.
4095 This topology shows what topics are sub-topics of what topics (right),
4096 and which topics are visible. Two settings are currently
4097 allowed---@code{visible} and @code{invisible}.
4100 @node Topic Parameters
4101 @subsection Topic Parameters
4102 @cindex topic parameters
4104 All groups in a topic will inherit group parameters from the parent
4105 (and ancestor) topic parameters. All valid group parameters are valid
4106 topic parameters (@pxref{Group Parameters}). When the agent is
4107 enabled, all agent parameters (See Agent Parameters in @ref{Category
4108 Syntax}) are also valid topic parameters.
4110 In addition, the following parameters are only valid as topic
4115 When subscribing new groups by topic (@pxref{Subscription Methods}), the
4116 @code{subscribe} topic parameter says what groups go in what topic. Its
4117 value should be a regexp to match the groups that should go in that
4120 @item subscribe-level
4121 When subscribing new groups by topic (see the @code{subscribe} parameter),
4122 the group will be subscribed with the level specified in the
4123 @code{subscribe-level} instead of @code{gnus-level-default-subscribed}.
4127 Group parameters (of course) override topic parameters, and topic
4128 parameters in sub-topics override topic parameters in super-topics. You
4129 know. Normal inheritance rules. (@dfn{Rules} is here a noun, not a
4130 verb, although you may feel free to disagree with me here.)
4137 2: alt.religion.emacs
4141 0: comp.talk.emacs.recovery
4143 8: comp.binaries.fractals
4144 13: comp.sources.unix
4149 The @samp{Emacs} topic has the topic parameter @code{(score-file
4150 . "emacs.SCORE")}; the @samp{Relief} topic has the topic parameter
4151 @code{(score-file . "relief.SCORE")}; and the @samp{Misc} topic has the
4152 topic parameter @code{(score-file . "emacs.SCORE")}. In addition,
4153 @* @samp{alt.religion.emacs} has the group parameter @code{(score-file
4154 . "religion.SCORE")}.
4156 Now, when you enter @samp{alt.sex.emacs} in the @samp{Relief} topic, you
4157 will get the @file{relief.SCORE} home score file. If you enter the same
4158 group in the @samp{Emacs} topic, you'll get the @file{emacs.SCORE} home
4159 score file. If you enter the group @samp{alt.religion.emacs}, you'll
4160 get the @file{religion.SCORE} home score file.
4162 This seems rather simple and self-evident, doesn't it? Well, yes. But
4163 there are some problems, especially with the @code{total-expiry}
4164 parameter. Say you have a mail group in two topics; one with
4165 @code{total-expiry} and one without. What happens when you do @kbd{M-x
4166 gnus-expire-all-expirable-groups}? Gnus has no way of telling which one
4167 of these topics you mean to expire articles from, so anything may
4168 happen. In fact, I hereby declare that it is @dfn{undefined} what
4169 happens. You just have to be careful if you do stuff like that.
4172 @node Non-ASCII Group Names
4173 @section Accessing groups of non-English names
4174 @cindex non-ascii group names
4176 There are some news servers that provide groups of which the names are
4177 expressed with their native languages in the world. For instance, in a
4178 certain news server there are some newsgroups of which the names are
4179 spelled in Chinese, where people are talking in Chinese. You can, of
4180 course, subscribe to such news groups using Gnus. Currently Gnus
4181 supports non-@acronym{ASCII} group names not only with the @code{nntp}
4182 back end but also with the @code{nnml} back end and the @code{nnrss}
4185 Every such group name is encoded by a certain charset in the server
4186 side (in an @acronym{NNTP} server its administrator determines the
4187 charset, but for groups in the other back ends it is determined by you).
4188 Gnus has to display the decoded ones for you in the group buffer and the
4189 article buffer, and needs to use the encoded ones when communicating
4190 with servers. However, Gnus doesn't know what charset is used for each
4191 non-@acronym{ASCII} group name. The following two variables are just
4192 the ones for telling Gnus what charset should be used for each group:
4195 @item gnus-group-name-charset-method-alist
4196 @vindex gnus-group-name-charset-method-alist
4197 An alist of select methods and charsets. The default value is
4198 @code{nil}. The names of groups in the server specified by that select
4199 method are all supposed to use the corresponding charset. For example:
4202 (setq gnus-group-name-charset-method-alist
4203 '(((nntp "news.com.cn") . cn-gb-2312)))
4206 Charsets specified for groups with this variable are preferred to the
4207 ones specified for the same groups with the
4208 @code{gnus-group-name-charset-group-alist} variable (see below).
4210 A select method can be very long, like:
4214 (nntp-address "news.gmane.org")
4215 (nntp-end-of-line "\n")
4216 (nntp-open-connection-function
4217 nntp-open-via-rlogin-and-telnet)
4218 (nntp-via-rlogin-command "ssh")
4219 (nntp-via-rlogin-command-switches
4220 ("-C" "-t" "-e" "none"))
4221 (nntp-via-address @dots{}))
4224 In that case, you can truncate it into @code{(nntp "gmane")} in this
4225 variable. That is, it is enough to contain only the back end name and
4228 @item gnus-group-name-charset-group-alist
4229 @cindex UTF-8 group names
4230 @vindex gnus-group-name-charset-group-alist
4231 An alist of regexp of group name and the charset for group names.
4232 @code{((".*" . utf-8))} is the default value if UTF-8 is supported,
4233 otherwise the default is @code{nil}. For example:
4236 (setq gnus-group-name-charset-group-alist
4237 '(("\\.com\\.cn:" . cn-gb-2312)
4241 Note that this variable is ignored if the match is made with
4242 @code{gnus-group-name-charset-method-alist}.
4245 Those two variables are used also to determine the charset for encoding
4246 and decoding non-@acronym{ASCII} group names that are in the back ends
4247 other than @code{nntp}. It means that it is you who determine it. If
4248 you do nothing, the charset used for group names in those back ends will
4249 all be @code{utf-8} because of the last element of
4250 @code{gnus-group-name-charset-group-alist}.
4252 There is one more important variable for non-@acronym{ASCII} group
4253 names. @emph{XEmacs users must set this}. Emacs users necessarily need
4257 @item nnmail-pathname-coding-system
4258 The value of this variable should be a coding system or @code{nil}
4259 (which is the default). The @code{nnml} back end, the @code{nnrss} back
4260 end, the @acronym{NNTP} marks feature (@pxref{NNTP marks}), the agent,
4261 and the cache use non-@acronym{ASCII} group names in those files and
4262 directories. This variable overrides the value of
4263 @code{file-name-coding-system} which specifies the coding system used
4264 when encoding and decoding those file names and directory names.
4266 In XEmacs (with the @code{mule} feature), @code{file-name-coding-system}
4267 is the only means to specify the coding system used to encode and decode
4268 file names. Therefore, @emph{you, XEmacs users, have to set it} to the
4269 coding system that is suitable to encode and decode non-@acronym{ASCII}
4270 group names. On the other hand, Emacs uses the value of
4271 @code{default-file-name-coding-system} if @code{file-name-coding-system}
4272 is @code{nil}. Normally the value of
4273 @code{default-file-name-coding-system} is initialized according to the
4274 locale, so you will need to do nothing if the value is suitable to
4275 encode and decode non-@acronym{ASCII} group names.
4277 The value of this variable (or @code{default-file-name-coding-system})
4278 does not necessarily need to be the same value that is determined by
4279 @code{gnus-group-name-charset-method-alist} and
4280 @code{gnus-group-name-charset-group-alist}.
4282 If you want to subscribe to the groups spelled in Chinese but
4283 @code{default-file-name-coding-system} is initialized by default to
4284 @code{iso-latin-1} for example, that is the most typical case where you
4285 have to set @code{nnmail-pathname-coding-system} even if you are an
4286 Emacs user. The @code{utf-8} coding system is a good candidate for it.
4287 Otherwise, you may change the locale in your system so that
4288 @code{default-file-name-coding-system} may be initialized to an
4289 appropriate value, instead of specifying this variable.
4292 Note that when you copy or move articles from a non-@acronym{ASCII}
4293 group to another group, the charset used to encode and decode group
4294 names should be the same in both groups. Otherwise the Newsgroups
4295 header will be displayed incorrectly in the article buffer.
4298 @node Misc Group Stuff
4299 @section Misc Group Stuff
4302 * Scanning New Messages:: Asking Gnus to see whether new messages have arrived.
4303 * Group Information:: Information and help on groups and Gnus.
4304 * Group Timestamp:: Making Gnus keep track of when you last read a group.
4305 * File Commands:: Reading and writing the Gnus files.
4306 * Sieve Commands:: Managing Sieve scripts.
4313 @cindex keys, reserved for users (Group)
4314 The key @kbd{v} is reserved for users. You can bind it to some
4315 command or better use it as a prefix key. For example:
4318 (define-key gnus-group-mode-map (kbd "v j d")
4321 (gnus-group-jump-to-group "nndraft:drafts")))
4324 On keys reserved for users in Emacs and on keybindings in general
4325 @xref{Keymaps, Keymaps, , emacs, The Emacs Editor}.
4329 @findex gnus-group-enter-server-mode
4330 Enter the server buffer (@code{gnus-group-enter-server-mode}).
4331 @xref{Server Buffer}.
4335 @findex gnus-group-post-news
4336 Start composing a message (a news by default)
4337 (@code{gnus-group-post-news}). If given a prefix, post to the group
4338 under the point. If the prefix is 1, prompt for a group to post to.
4339 Contrary to what the name of this function suggests, the prepared
4340 article might be a mail instead of a news, if a mail group is specified
4341 with the prefix argument. @xref{Composing Messages}.
4345 @findex gnus-group-mail
4346 Mail a message somewhere (@code{gnus-group-mail}). If given a prefix,
4347 use the posting style of the group under the point. If the prefix is 1,
4348 prompt for a group name to find the posting style.
4349 @xref{Composing Messages}.
4353 @findex gnus-group-news
4354 Start composing a news (@code{gnus-group-news}). If given a prefix,
4355 post to the group under the point. If the prefix is 1, prompt
4356 for group to post to. @xref{Composing Messages}.
4358 This function actually prepares a news even when using mail groups.
4359 This is useful for ``posting'' messages to mail groups without actually
4360 sending them over the network: they're just saved directly to the group
4361 in question. The corresponding back end must have a request-post method
4362 for this to work though.
4366 @findex gnus-group-compact-group
4368 Compact the group under point (@code{gnus-group-compact-group}).
4369 Currently implemented only in nnml (@pxref{Mail Spool}). This removes
4370 gaps between article numbers, hence getting a correct total article
4375 Variables for the group buffer:
4379 @item gnus-group-mode-hook
4380 @vindex gnus-group-mode-hook
4381 is called after the group buffer has been
4384 @item gnus-group-prepare-hook
4385 @vindex gnus-group-prepare-hook
4386 is called after the group buffer is
4387 generated. It may be used to modify the buffer in some strange,
4390 @item gnus-group-prepared-hook
4391 @vindex gnus-group-prepare-hook
4392 is called as the very last thing after the group buffer has been
4393 generated. It may be used to move point around, for instance.
4395 @item gnus-permanently-visible-groups
4396 @vindex gnus-permanently-visible-groups
4397 Groups matching this regexp will always be listed in the group buffer,
4398 whether they are empty or not.
4402 @node Scanning New Messages
4403 @subsection Scanning New Messages
4404 @cindex new messages
4405 @cindex scanning new news
4411 @findex gnus-group-get-new-news
4412 @c @icon{gnus-group-get-new-news}
4413 Check the server(s) for new articles. If the numerical prefix is used,
4414 this command will check only groups of level @var{arg} and lower
4415 (@code{gnus-group-get-new-news}). If given a non-numerical prefix, this
4416 command will force a total re-reading of the active file(s) from the
4421 @findex gnus-group-get-new-news-this-group
4422 @vindex gnus-goto-next-group-when-activating
4423 @c @icon{gnus-group-get-new-news-this-group}
4424 Check whether new articles have arrived in the current group
4425 (@code{gnus-group-get-new-news-this-group}).
4426 @code{gnus-goto-next-group-when-activating} says whether this command is
4427 to move point to the next group or not. It is @code{t} by default.
4429 @findex gnus-activate-all-groups
4430 @cindex activating groups
4432 @kindex C-c M-g (Group)
4433 Activate absolutely all groups (@code{gnus-activate-all-groups}).
4438 @findex gnus-group-restart
4439 Restart Gnus (@code{gnus-group-restart}). This saves the @file{.newsrc}
4440 file(s), closes the connection to all servers, clears up all run-time
4441 Gnus variables, and then starts Gnus all over again.
4445 @vindex gnus-get-new-news-hook
4446 @code{gnus-get-new-news-hook} is run just before checking for new news.
4448 @vindex gnus-after-getting-new-news-hook
4449 @code{gnus-after-getting-new-news-hook} is run after checking for new
4453 @node Group Information
4454 @subsection Group Information
4455 @cindex group information
4456 @cindex information on groups
4463 @findex gnus-group-fetch-faq
4464 @vindex gnus-group-faq-directory
4467 Try to fetch the @acronym{FAQ} for the current group
4468 (@code{gnus-group-fetch-faq}). Gnus will try to get the @acronym{FAQ}
4469 from @code{gnus-group-faq-directory}, which is usually a directory on
4470 a remote machine. This variable can also be a list of directories.
4471 In that case, giving a prefix to this command will allow you to choose
4472 between the various sites. @code{ange-ftp} (or @code{efs}) will be
4473 used for fetching the file.
4475 If fetching from the first site is unsuccessful, Gnus will attempt to go
4476 through @code{gnus-group-faq-directory} and try to open them one by one.
4480 @findex gnus-group-fetch-charter
4481 @vindex gnus-group-charter-alist
4483 Try to open the charter for the current group in a web browser
4484 (@code{gnus-group-fetch-charter}). Query for a group if given a
4487 Gnus will use @code{gnus-group-charter-alist} to find the location of
4488 the charter. If no location is known, Gnus will fetch the control
4489 messages for the group, which in some cases includes the charter.
4493 @findex gnus-group-fetch-control
4494 @vindex gnus-group-fetch-control-use-browse-url
4495 @cindex control message
4496 Fetch the control messages for the group from the archive at
4497 @code{ftp.isc.org} (@code{gnus-group-fetch-control}). Query for a
4498 group if given a prefix argument.
4500 If @code{gnus-group-fetch-control-use-browse-url} is non-@code{nil},
4501 Gnus will open the control messages in a browser using
4502 @code{browse-url}. Otherwise they are fetched using @code{ange-ftp}
4503 and displayed in an ephemeral group.
4505 Note that the control messages are compressed. To use this command
4506 you need to turn on @code{auto-compression-mode} (@pxref{Compressed
4507 Files, ,Compressed Files, emacs, The Emacs Manual}).
4511 @c @icon{gnus-group-describe-group}
4513 @kindex C-c C-d (Group)
4514 @cindex describing groups
4515 @cindex group description
4516 @findex gnus-group-describe-group
4517 Describe the current group (@code{gnus-group-describe-group}). If given
4518 a prefix, force Gnus to re-read the description from the server.
4522 @findex gnus-group-describe-all-groups
4523 Describe all groups (@code{gnus-group-describe-all-groups}). If given a
4524 prefix, force Gnus to re-read the description file from the server.
4531 @findex gnus-version
4532 Display current Gnus version numbers (@code{gnus-version}).
4536 @findex gnus-group-describe-briefly
4537 Give a very short help message (@code{gnus-group-describe-briefly}).
4540 @kindex C-c C-i (Group)
4543 @findex gnus-info-find-node
4544 Go to the Gnus info node (@code{gnus-info-find-node}).
4548 @node Group Timestamp
4549 @subsection Group Timestamp
4551 @cindex group timestamps
4553 It can be convenient to let Gnus keep track of when you last read a
4554 group. To set the ball rolling, you should add
4555 @code{gnus-group-set-timestamp} to @code{gnus-select-group-hook}:
4558 (add-hook 'gnus-select-group-hook 'gnus-group-set-timestamp)
4561 After doing this, each time you enter a group, it'll be recorded.
4563 This information can be displayed in various ways---the easiest is to
4564 use the @samp{%d} spec in the group line format:
4567 (setq gnus-group-line-format
4568 "%M\%S\%p\%P\%5y: %(%-40,40g%) %d\n")
4571 This will result in lines looking like:
4574 * 0: mail.ding 19961002T012943
4575 0: custom 19961002T012713
4578 As you can see, the date is displayed in compact ISO 8601 format. This
4579 may be a bit too much, so to just display the date, you could say
4583 (setq gnus-group-line-format
4584 "%M\%S\%p\%P\%5y: %(%-40,40g%) %6,6~(cut 2)d\n")
4587 If you would like greater control of the time format, you can use a
4588 user-defined format spec. Something like the following should do the
4592 (setq gnus-group-line-format
4593 "%M\%S\%p\%P\%5y: %(%-40,40g%) %ud\n")
4594 (defun gnus-user-format-function-d (headers)
4595 (let ((time (gnus-group-timestamp gnus-tmp-group)))
4597 (format-time-string "%b %d %H:%M" time)
4603 @subsection File Commands
4604 @cindex file commands
4610 @findex gnus-group-read-init-file
4611 @vindex gnus-init-file
4612 @cindex reading init file
4613 Re-read the init file (@code{gnus-init-file}, which defaults to
4614 @file{~/.gnus.el}) (@code{gnus-group-read-init-file}).
4618 @findex gnus-group-save-newsrc
4619 @cindex saving .newsrc
4620 Save the @file{.newsrc.eld} file (and @file{.newsrc} if wanted)
4621 (@code{gnus-group-save-newsrc}). If given a prefix, force saving the
4622 file(s) whether Gnus thinks it is necessary or not.
4625 @c @kindex Z (Group)
4626 @c @findex gnus-group-clear-dribble
4627 @c Clear the dribble buffer (@code{gnus-group-clear-dribble}).
4632 @node Sieve Commands
4633 @subsection Sieve Commands
4634 @cindex group sieve commands
4636 Sieve is a server-side mail filtering language. In Gnus you can use
4637 the @code{sieve} group parameter (@pxref{Group Parameters}) to specify
4638 sieve rules that should apply to each group. Gnus provides two
4639 commands to translate all these group parameters into a proper Sieve
4640 script that can be transfered to the server somehow.
4642 @vindex gnus-sieve-file
4643 @vindex gnus-sieve-region-start
4644 @vindex gnus-sieve-region-end
4645 The generated Sieve script is placed in @code{gnus-sieve-file} (by
4646 default @file{~/.sieve}). The Sieve code that Gnus generate is placed
4647 between two delimiters, @code{gnus-sieve-region-start} and
4648 @code{gnus-sieve-region-end}, so you may write additional Sieve code
4649 outside these delimiters that will not be removed the next time you
4650 regenerate the Sieve script.
4652 @vindex gnus-sieve-crosspost
4653 The variable @code{gnus-sieve-crosspost} controls how the Sieve script
4654 is generated. If it is non-@code{nil} (the default) articles is
4655 placed in all groups that have matching rules, otherwise the article
4656 is only placed in the group with the first matching rule. For
4657 example, the group parameter @samp{(sieve address "sender"
4658 "owner-ding@@hpc.uh.edu")} will generate the following piece of Sieve
4659 code if @code{gnus-sieve-crosspost} is @code{nil}. (When
4660 @code{gnus-sieve-crosspost} is non-@code{nil}, it looks the same
4661 except that the line containing the call to @code{stop} is removed.)
4664 if address "sender" "owner-ding@@hpc.uh.edu" @{
4665 fileinto "INBOX.ding";
4670 @xref{Top, Emacs Sieve, Top, sieve, Emacs Sieve}.
4676 @findex gnus-sieve-generate
4677 @vindex gnus-sieve-file
4678 @cindex generating sieve script
4679 Regenerate a Sieve script from the @code{sieve} group parameters and
4680 put you into the @code{gnus-sieve-file} without saving it.
4684 @findex gnus-sieve-update
4685 @vindex gnus-sieve-file
4686 @cindex updating sieve script
4687 Regenerates the Gnus managed part of @code{gnus-sieve-file} using the
4688 @code{sieve} group parameters, save the file and upload it to the
4689 server using the @code{sieveshell} program.
4694 @node Summary Buffer
4695 @chapter Summary Buffer
4696 @cindex summary buffer
4698 A line for each article is displayed in the summary buffer. You can
4699 move around, read articles, post articles and reply to articles.
4701 The most common way to a summary buffer is to select a group from the
4702 group buffer (@pxref{Selecting a Group}).
4704 You can have as many summary buffers open as you wish.
4706 You can customize the Summary Mode tool bar, see @kbd{M-x
4707 customize-apropos RET gnus-summary-tool-bar}. This feature is only
4711 @cindex keys, reserved for users (Summary)
4712 The key @kbd{v} is reserved for users. You can bind it to some
4713 command or better use it as a prefix key. For example:
4715 (define-key gnus-summary-mode-map (kbd "v -") "LrS") ;; lower subthread
4719 * Summary Buffer Format:: Deciding how the summary buffer is to look.
4720 * Summary Maneuvering:: Moving around the summary buffer.
4721 * Choosing Articles:: Reading articles.
4722 * Paging the Article:: Scrolling the current article.
4723 * Reply Followup and Post:: Posting articles.
4724 * Delayed Articles:: Send articles at a later time.
4725 * Marking Articles:: Marking articles as read, expirable, etc.
4726 * Limiting:: You can limit the summary buffer.
4727 * Threading:: How threads are made.
4728 * Sorting the Summary Buffer:: How articles and threads are sorted.
4729 * Asynchronous Fetching:: Gnus might be able to pre-fetch articles.
4730 * Article Caching:: You may store articles in a cache.
4731 * Persistent Articles:: Making articles expiry-resistant.
4732 * Sticky Articles:: Article buffers that are not reused.
4733 * Article Backlog:: Having already read articles hang around.
4734 * Saving Articles:: Ways of customizing article saving.
4735 * Decoding Articles:: Gnus can treat series of (uu)encoded articles.
4736 * Article Treatment:: The article buffer can be mangled at will.
4737 * MIME Commands:: Doing MIMEy things with the articles.
4738 * Charsets:: Character set issues.
4739 * Article Commands:: Doing various things with the article buffer.
4740 * Summary Sorting:: Sorting the summary buffer in various ways.
4741 * Finding the Parent:: No child support? Get the parent.
4742 * Alternative Approaches:: Reading using non-default summaries.
4743 * Tree Display:: A more visual display of threads.
4744 * Mail Group Commands:: Some commands can only be used in mail groups.
4745 * Various Summary Stuff:: What didn't fit anywhere else.
4746 * Exiting the Summary Buffer:: Returning to the Group buffer,
4747 or reselecting the current group.
4748 * Crosspost Handling:: How crossposted articles are dealt with.
4749 * Duplicate Suppression:: An alternative when crosspost handling fails.
4750 * Security:: Decrypt and Verify.
4751 * Mailing List:: Mailing list minor mode.
4755 @node Summary Buffer Format
4756 @section Summary Buffer Format
4757 @cindex summary buffer format
4761 \gnusfigure{The Summary Buffer}{180}{
4762 \put(0,0){\epsfig{figure=ps/summary,width=7.5cm}}
4763 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-article,width=7.5cm}}}
4769 * Summary Buffer Lines:: You can specify how summary lines should look.
4770 * To From Newsgroups:: How to not display your own name.
4771 * Summary Buffer Mode Line:: You can say how the mode line should look.
4772 * Summary Highlighting:: Making the summary buffer all pretty and nice.
4775 @findex mail-extract-address-components
4776 @findex gnus-extract-address-components
4777 @vindex gnus-extract-address-components
4778 Gnus will use the value of the @code{gnus-extract-address-components}
4779 variable as a function for getting the name and address parts of a
4780 @code{From} header. Two pre-defined functions exist:
4781 @code{gnus-extract-address-components}, which is the default, quite
4782 fast, and too simplistic solution; and
4783 @code{mail-extract-address-components}, which works very nicely, but is
4784 slower. The default function will return the wrong answer in 5% of the
4785 cases. If this is unacceptable to you, use the other function instead:
4788 (setq gnus-extract-address-components
4789 'mail-extract-address-components)
4792 @vindex gnus-summary-same-subject
4793 @code{gnus-summary-same-subject} is a string indicating that the current
4794 article has the same subject as the previous. This string will be used
4795 with those specs that require it. The default is @code{""}.
4798 @node Summary Buffer Lines
4799 @subsection Summary Buffer Lines
4801 @vindex gnus-summary-line-format
4802 You can change the format of the lines in the summary buffer by changing
4803 the @code{gnus-summary-line-format} variable. It works along the same
4804 lines as a normal @code{format} string, with some extensions
4805 (@pxref{Formatting Variables}).
4807 There should always be a colon or a point position marker on the line;
4808 the cursor always moves to the point position marker or the colon after
4809 performing an operation. (Of course, Gnus wouldn't be Gnus if it wasn't
4810 possible to change this. Just write a new function
4811 @code{gnus-goto-colon} which does whatever you like with the cursor.)
4812 @xref{Positioning Point}.
4814 The default string is @samp{%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n}.
4816 The following format specification characters and extended format
4817 specification(s) are understood:
4823 Subject string. List identifiers stripped,
4824 @code{gnus-list-identifiers}. @xref{Article Hiding}.
4826 Subject if the article is the root of the thread or the previous article
4827 had a different subject, @code{gnus-summary-same-subject} otherwise.
4828 (@code{gnus-summary-same-subject} defaults to @code{""}.)
4830 Full @code{From} header.
4832 The name (from the @code{From} header).
4834 The name, @code{To} header or the @code{Newsgroups} header (@pxref{To
4837 The name (from the @code{From} header). This differs from the @code{n}
4838 spec in that it uses the function designated by the
4839 @code{gnus-extract-address-components} variable, which is slower, but
4840 may be more thorough.
4842 The address (from the @code{From} header). This works the same way as
4845 Number of lines in the article.
4847 Number of characters in the article. This specifier is not supported
4848 in some methods (like nnfolder).
4850 Pretty-printed version of the number of characters in the article;
4851 for example, @samp{1.2k} or @samp{0.4M}.
4853 Indentation based on thread level (@pxref{Customizing Threading}).
4855 A complex trn-style thread tree, showing response-connecting trace
4856 lines. A thread could be drawn like this:
4869 You can customize the appearance with the following options. Note
4870 that it is possible to make the thread display look really neat by
4871 replacing the default @acronym{ASCII} characters with graphic
4872 line-drawing glyphs.
4874 @item gnus-sum-thread-tree-root
4875 @vindex gnus-sum-thread-tree-root
4876 Used for the root of a thread. If @code{nil}, use subject
4877 instead. The default is @samp{> }.
4879 @item gnus-sum-thread-tree-false-root
4880 @vindex gnus-sum-thread-tree-false-root
4881 Used for the false root of a thread (@pxref{Loose Threads}). If
4882 @code{nil}, use subject instead. The default is @samp{> }.
4884 @item gnus-sum-thread-tree-single-indent
4885 @vindex gnus-sum-thread-tree-single-indent
4886 Used for a thread with just one message. If @code{nil}, use subject
4887 instead. The default is @samp{}.
4889 @item gnus-sum-thread-tree-vertical
4890 @vindex gnus-sum-thread-tree-vertical
4891 Used for drawing a vertical line. The default is @samp{| }.
4893 @item gnus-sum-thread-tree-indent
4894 @vindex gnus-sum-thread-tree-indent
4895 Used for indenting. The default is @samp{ }.
4897 @item gnus-sum-thread-tree-leaf-with-other
4898 @vindex gnus-sum-thread-tree-leaf-with-other
4899 Used for a leaf with brothers. The default is @samp{+-> }.
4901 @item gnus-sum-thread-tree-single-leaf
4902 @vindex gnus-sum-thread-tree-single-leaf
4903 Used for a leaf without brothers. The default is @samp{\-> }
4908 Nothing if the article is a root and lots of spaces if it isn't (it
4909 pushes everything after it off the screen).
4911 Opening bracket, which is normally @samp{[}, but can also be @samp{<}
4912 for adopted articles (@pxref{Customizing Threading}).
4914 Closing bracket, which is normally @samp{]}, but can also be @samp{>}
4915 for adopted articles.
4917 One space for each thread level.
4919 Twenty minus thread level spaces.
4921 Unread. @xref{Read Articles}.
4924 This misleadingly named specifier is the @dfn{secondary mark}. This
4925 mark will say whether the article has been replied to, has been cached,
4926 or has been saved. @xref{Other Marks}.
4929 Score as a number (@pxref{Scoring}).
4931 @vindex gnus-summary-zcore-fuzz
4932 Zcore, @samp{+} if above the default level and @samp{-} if below the
4933 default level. If the difference between
4934 @code{gnus-summary-default-score} and the score is less than
4935 @code{gnus-summary-zcore-fuzz}, this spec will not be used.
4943 The @code{Date} in @code{DD-MMM} format.
4945 The @code{Date} in @var{YYYYMMDD}@code{T}@var{HHMMSS} format.
4951 Number of articles in the current sub-thread. Using this spec will slow
4952 down summary buffer generation somewhat.
4954 An @samp{=} (@code{gnus-not-empty-thread-mark}) will be displayed if the
4955 article has any children.
4961 Desired cursor position (instead of after first colon).
4963 Age sensitive date format. Various date format is defined in
4964 @code{gnus-user-date-format-alist}.
4966 User defined specifier. The next character in the format string should
4967 be a letter. Gnus will call the function
4968 @code{gnus-user-format-function-@var{x}}, where @var{x} is the letter
4969 following @samp{%u}. The function will be passed the current header as
4970 argument. The function should return a string, which will be inserted
4971 into the summary just like information from any other summary specifier.
4974 Text between @samp{%(} and @samp{%)} will be highlighted with
4975 @code{gnus-mouse-face} when the mouse point is placed inside the area.
4976 There can only be one such area.
4978 The @samp{%U} (status), @samp{%R} (replied) and @samp{%z} (zcore) specs
4979 have to be handled with care. For reasons of efficiency, Gnus will
4980 compute what column these characters will end up in, and ``hard-code''
4981 that. This means that it is invalid to have these specs after a
4982 variable-length spec. Well, you might not be arrested, but your summary
4983 buffer will look strange, which is bad enough.
4985 The smart choice is to have these specs as far to the left as possible.
4986 (Isn't that the case with everything, though? But I digress.)
4988 This restriction may disappear in later versions of Gnus.
4991 @node To From Newsgroups
4992 @subsection To From Newsgroups
4996 In some groups (particularly in archive groups), the @code{From} header
4997 isn't very interesting, since all the articles there are written by
4998 you. To display the information in the @code{To} or @code{Newsgroups}
4999 headers instead, you need to decide three things: What information to
5000 gather; where to display it; and when to display it.
5004 @vindex gnus-extra-headers
5005 The reading of extra header information is controlled by the
5006 @code{gnus-extra-headers}. This is a list of header symbols. For
5010 (setq gnus-extra-headers
5011 '(To Newsgroups X-Newsreader))
5014 This will result in Gnus trying to obtain these three headers, and
5015 storing it in header structures for later easy retrieval.
5018 @findex gnus-extra-header
5019 The value of these extra headers can be accessed via the
5020 @code{gnus-extra-header} function. Here's a format line spec that will
5021 access the @code{X-Newsreader} header:
5024 "%~(form (gnus-extra-header 'X-Newsreader))@@"
5028 @vindex gnus-ignored-from-addresses
5029 The @code{gnus-ignored-from-addresses} variable says when the @samp{%f}
5030 summary line spec returns the @code{To}, @code{Newsreader} or
5031 @code{From} header. If this regexp matches the contents of the
5032 @code{From} header, the value of the @code{To} or @code{Newsreader}
5033 headers are used instead.
5035 To distinguish regular articles from those where the @code{From} field
5036 has been swapped, a string is prefixed to the @code{To} or
5037 @code{Newsgroups} header in the summary line. By default the string is
5038 @samp{-> } for @code{To} and @samp{=> } for @code{Newsgroups}, you can
5039 customize these strings with @code{gnus-summary-to-prefix} and
5040 @code{gnus-summary-newsgroup-prefix}.
5044 @vindex nnmail-extra-headers
5045 A related variable is @code{nnmail-extra-headers}, which controls when
5046 to include extra headers when generating overview (@acronym{NOV}) files.
5047 If you have old overview files, you should regenerate them after
5048 changing this variable, by entering the server buffer using @kbd{^},
5049 and then @kbd{g} on the appropriate mail server (e.g. nnml) to cause
5052 @vindex gnus-summary-line-format
5053 You also have to instruct Gnus to display the data by changing the
5054 @code{%n} spec to the @code{%f} spec in the
5055 @code{gnus-summary-line-format} variable.
5057 In summary, you'd typically put something like the following in
5061 (setq gnus-extra-headers
5063 (setq nnmail-extra-headers gnus-extra-headers)
5064 (setq gnus-summary-line-format
5065 "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n")
5066 (setq gnus-ignored-from-addresses
5070 (The values listed above are the default values in Gnus. Alter them
5073 A note for news server administrators, or for users who wish to try to
5074 convince their news server administrator to provide some additional
5077 The above is mostly useful for mail groups, where you have control over
5078 the @acronym{NOV} files that are created. However, if you can persuade your
5079 nntp admin to add (in the usual implementation, notably INN):
5085 to the end of her @file{overview.fmt} file, then you can use that just
5086 as you would the extra headers from the mail groups.
5089 @node Summary Buffer Mode Line
5090 @subsection Summary Buffer Mode Line
5092 @vindex gnus-summary-mode-line-format
5093 You can also change the format of the summary mode bar (@pxref{Mode Line
5094 Formatting}). Set @code{gnus-summary-mode-line-format} to whatever you
5095 like. The default is @samp{Gnus: %%b [%A] %Z}.
5097 Here are the elements you can play with:
5103 Unprefixed group name.
5105 Current article number.
5107 Current article score.
5111 Number of unread articles in this group.
5113 Number of unread articles in this group that aren't displayed in the
5116 A string with the number of unread and unselected articles represented
5117 either as @samp{<%U(+%e) more>} if there are both unread and unselected
5118 articles, and just as @samp{<%U more>} if there are just unread articles
5119 and no unselected ones.
5121 Shortish group name. For instance, @samp{rec.arts.anime} will be
5122 shortened to @samp{r.a.anime}.
5124 Subject of the current article.
5126 User-defined spec (@pxref{User-Defined Specs}).
5128 Name of the current score file (@pxref{Scoring}).
5130 Number of dormant articles (@pxref{Unread Articles}).
5132 Number of ticked articles (@pxref{Unread Articles}).
5134 Number of articles that have been marked as read in this session.
5136 Number of articles expunged by the score files.
5140 @node Summary Highlighting
5141 @subsection Summary Highlighting
5145 @item gnus-visual-mark-article-hook
5146 @vindex gnus-visual-mark-article-hook
5147 This hook is run after selecting an article. It is meant to be used for
5148 highlighting the article in some way. It is not run if
5149 @code{gnus-visual} is @code{nil}.
5151 @item gnus-summary-update-hook
5152 @vindex gnus-summary-update-hook
5153 This hook is called when a summary line is changed. It is not run if
5154 @code{gnus-visual} is @code{nil}.
5156 @item gnus-summary-selected-face
5157 @vindex gnus-summary-selected-face
5158 This is the face (or @dfn{font} as some people call it) used to
5159 highlight the current article in the summary buffer.
5161 @item gnus-summary-highlight
5162 @vindex gnus-summary-highlight
5163 Summary lines are highlighted according to this variable, which is a
5164 list where the elements are of the format @code{(@var{form}
5165 . @var{face})}. If you would, for instance, like ticked articles to be
5166 italic and high-scored articles to be bold, you could set this variable
5169 (((eq mark gnus-ticked-mark) . italic)
5170 ((> score default) . bold))
5172 As you may have guessed, if @var{form} returns a non-@code{nil} value,
5173 @var{face} will be applied to the line.
5177 @node Summary Maneuvering
5178 @section Summary Maneuvering
5179 @cindex summary movement
5181 All the straight movement commands understand the numeric prefix and
5182 behave pretty much as you'd expect.
5184 None of these commands select articles.
5189 @kindex M-n (Summary)
5190 @kindex G M-n (Summary)
5191 @findex gnus-summary-next-unread-subject
5192 Go to the next summary line of an unread article
5193 (@code{gnus-summary-next-unread-subject}).
5197 @kindex M-p (Summary)
5198 @kindex G M-p (Summary)
5199 @findex gnus-summary-prev-unread-subject
5200 Go to the previous summary line of an unread article
5201 (@code{gnus-summary-prev-unread-subject}).
5204 @kindex G g (Summary)
5205 @findex gnus-summary-goto-subject
5206 Ask for an article number and then go to the summary line of that article
5207 without displaying the article (@code{gnus-summary-goto-subject}).
5210 If Gnus asks you to press a key to confirm going to the next group, you
5211 can use the @kbd{C-n} and @kbd{C-p} keys to move around the group
5212 buffer, searching for the next group to read without actually returning
5213 to the group buffer.
5215 Variables related to summary movement:
5219 @vindex gnus-auto-select-next
5220 @item gnus-auto-select-next
5221 If you issue one of the movement commands (like @kbd{n}) and there are
5222 no more unread articles after the current one, Gnus will offer to go to
5223 the next group. If this variable is @code{t} and the next group is
5224 empty, Gnus will exit summary mode and return to the group buffer. If
5225 this variable is neither @code{t} nor @code{nil}, Gnus will select the
5226 next group with unread articles. As a special case, if this variable
5227 is @code{quietly}, Gnus will select the next group without asking for
5228 confirmation. If this variable is @code{almost-quietly}, the same
5229 will happen only if you are located on the last article in the group.
5230 Finally, if this variable is @code{slightly-quietly}, the @kbd{Z n}
5231 command will go to the next group without confirmation. Also
5232 @pxref{Group Levels}.
5234 @item gnus-auto-select-same
5235 @vindex gnus-auto-select-same
5236 If non-@code{nil}, all the movement commands will try to go to the next
5237 article with the same subject as the current. (@dfn{Same} here might
5238 mean @dfn{roughly equal}. See @code{gnus-summary-gather-subject-limit}
5239 for details (@pxref{Customizing Threading}).) If there are no more
5240 articles with the same subject, go to the first unread article.
5242 This variable is not particularly useful if you use a threaded display.
5244 @item gnus-summary-check-current
5245 @vindex gnus-summary-check-current
5246 If non-@code{nil}, all the ``unread'' movement commands will not proceed
5247 to the next (or previous) article if the current article is unread.
5248 Instead, they will choose the current article.
5250 @item gnus-auto-center-summary
5251 @vindex gnus-auto-center-summary
5252 If non-@code{nil}, Gnus will keep the point in the summary buffer
5253 centered at all times. This makes things quite tidy, but if you have a
5254 slow network connection, or simply do not like this un-Emacsism, you can
5255 set this variable to @code{nil} to get the normal Emacs scrolling
5256 action. This will also inhibit horizontal re-centering of the summary
5257 buffer, which might make it more inconvenient to read extremely long
5260 This variable can also be a number. In that case, center the window at
5261 the given number of lines from the top.
5266 @node Choosing Articles
5267 @section Choosing Articles
5268 @cindex selecting articles
5271 * Choosing Commands:: Commands for choosing articles.
5272 * Choosing Variables:: Variables that influence these commands.
5276 @node Choosing Commands
5277 @subsection Choosing Commands
5279 None of the following movement commands understand the numeric prefix,
5280 and they all select and display an article.
5282 If you want to fetch new articles or redisplay the group, see
5283 @ref{Exiting the Summary Buffer}.
5287 @kindex SPACE (Summary)
5288 @findex gnus-summary-next-page
5289 Select the current article, or, if that one's read already, the next
5290 unread article (@code{gnus-summary-next-page}).
5292 If you have an article window open already and you press @kbd{SPACE}
5293 again, the article will be scrolled. This lets you conveniently
5294 @kbd{SPACE} through an entire newsgroup. @xref{Paging the Article}.
5299 @kindex G n (Summary)
5300 @findex gnus-summary-next-unread-article
5301 @c @icon{gnus-summary-next-unread}
5302 Go to next unread article (@code{gnus-summary-next-unread-article}).
5307 @findex gnus-summary-prev-unread-article
5308 @c @icon{gnus-summary-prev-unread}
5309 Go to previous unread article (@code{gnus-summary-prev-unread-article}).
5314 @kindex G N (Summary)
5315 @findex gnus-summary-next-article
5316 Go to the next article (@code{gnus-summary-next-article}).
5321 @kindex G P (Summary)
5322 @findex gnus-summary-prev-article
5323 Go to the previous article (@code{gnus-summary-prev-article}).
5326 @kindex G C-n (Summary)
5327 @findex gnus-summary-next-same-subject
5328 Go to the next article with the same subject
5329 (@code{gnus-summary-next-same-subject}).
5332 @kindex G C-p (Summary)
5333 @findex gnus-summary-prev-same-subject
5334 Go to the previous article with the same subject
5335 (@code{gnus-summary-prev-same-subject}).
5339 @kindex G f (Summary)
5341 @findex gnus-summary-first-unread-article
5342 Go to the first unread article
5343 (@code{gnus-summary-first-unread-article}).
5347 @kindex G b (Summary)
5349 @findex gnus-summary-best-unread-article
5350 Go to the unread article with the highest score
5351 (@code{gnus-summary-best-unread-article}). If given a prefix argument,
5352 go to the first unread article that has a score over the default score.
5357 @kindex G l (Summary)
5358 @findex gnus-summary-goto-last-article
5359 Go to the previous article read (@code{gnus-summary-goto-last-article}).
5362 @kindex G o (Summary)
5363 @findex gnus-summary-pop-article
5365 @cindex article history
5366 Pop an article off the summary history and go to this article
5367 (@code{gnus-summary-pop-article}). This command differs from the
5368 command above in that you can pop as many previous articles off the
5369 history as you like, while @kbd{l} toggles the two last read articles.
5370 For a somewhat related issue (if you use these commands a lot),
5371 @pxref{Article Backlog}.
5376 @kindex G j (Summary)
5377 @findex gnus-summary-goto-article
5378 Ask for an article number or @code{Message-ID}, and then go to that
5379 article (@code{gnus-summary-goto-article}).
5384 @node Choosing Variables
5385 @subsection Choosing Variables
5387 Some variables relevant for moving and selecting articles:
5390 @item gnus-auto-extend-newsgroup
5391 @vindex gnus-auto-extend-newsgroup
5392 All the movement commands will try to go to the previous (or next)
5393 article, even if that article isn't displayed in the Summary buffer if
5394 this variable is non-@code{nil}. Gnus will then fetch the article from
5395 the server and display it in the article buffer.
5397 @item gnus-select-article-hook
5398 @vindex gnus-select-article-hook
5399 This hook is called whenever an article is selected. The default is
5400 @code{nil}. If you would like each article to be saved in the Agent as
5401 you read it, putting @code{gnus-agent-fetch-selected-article} on this
5404 @item gnus-mark-article-hook
5405 @vindex gnus-mark-article-hook
5406 @findex gnus-summary-mark-unread-as-read
5407 @findex gnus-summary-mark-read-and-unread-as-read
5408 @findex gnus-unread-mark
5409 This hook is called whenever an article is selected. It is intended to
5410 be used for marking articles as read. The default value is
5411 @code{gnus-summary-mark-read-and-unread-as-read}, and will change the
5412 mark of almost any article you read to @code{gnus-read-mark}. The only
5413 articles not affected by this function are ticked, dormant, and
5414 expirable articles. If you'd instead like to just have unread articles
5415 marked as read, you can use @code{gnus-summary-mark-unread-as-read}
5416 instead. It will leave marks like @code{gnus-low-score-mark},
5417 @code{gnus-del-mark} (and so on) alone.
5422 @node Paging the Article
5423 @section Scrolling the Article
5424 @cindex article scrolling
5429 @kindex SPACE (Summary)
5430 @findex gnus-summary-next-page
5431 Pressing @kbd{SPACE} will scroll the current article forward one page,
5432 or, if you have come to the end of the current article, will choose the
5433 next article (@code{gnus-summary-next-page}).
5435 @vindex gnus-article-boring-faces
5436 @vindex gnus-article-skip-boring
5437 If @code{gnus-article-skip-boring} is non-@code{nil} and the rest of
5438 the article consists only of citations and signature, then it will be
5439 skipped; the next article will be shown instead. You can customize
5440 what is considered uninteresting with
5441 @code{gnus-article-boring-faces}. You can manually view the article's
5442 pages, no matter how boring, using @kbd{C-M-v}.
5445 @kindex DEL (Summary)
5446 @findex gnus-summary-prev-page
5447 Scroll the current article back one page (@code{gnus-summary-prev-page}).
5450 @kindex RET (Summary)
5451 @findex gnus-summary-scroll-up
5452 Scroll the current article one line forward
5453 (@code{gnus-summary-scroll-up}).
5456 @kindex M-RET (Summary)
5457 @findex gnus-summary-scroll-down
5458 Scroll the current article one line backward
5459 (@code{gnus-summary-scroll-down}).
5463 @kindex A g (Summary)
5465 @findex gnus-summary-show-article
5466 @vindex gnus-summary-show-article-charset-alist
5467 (Re)fetch the current article (@code{gnus-summary-show-article}). If
5468 given a prefix, fetch the current article, but don't run any of the
5469 article treatment functions. This will give you a ``raw'' article, just
5470 the way it came from the server.
5472 If given a numerical prefix, you can do semi-manual charset stuff.
5473 @kbd{C-u 0 g cn-gb-2312 RET} will decode the message as if it were
5474 encoded in the @code{cn-gb-2312} charset. If you have
5477 (setq gnus-summary-show-article-charset-alist
5482 then you can say @kbd{C-u 1 g} to get the same effect.
5487 @kindex A < (Summary)
5488 @findex gnus-summary-beginning-of-article
5489 Scroll to the beginning of the article
5490 (@code{gnus-summary-beginning-of-article}).
5495 @kindex A > (Summary)
5496 @findex gnus-summary-end-of-article
5497 Scroll to the end of the article (@code{gnus-summary-end-of-article}).
5501 @kindex A s (Summary)
5503 @findex gnus-summary-isearch-article
5504 Perform an isearch in the article buffer
5505 (@code{gnus-summary-isearch-article}).
5509 @findex gnus-summary-select-article-buffer
5510 Select the article buffer (@code{gnus-summary-select-article-buffer}).
5515 @node Reply Followup and Post
5516 @section Reply, Followup and Post
5519 * Summary Mail Commands:: Sending mail.
5520 * Summary Post Commands:: Sending news.
5521 * Summary Message Commands:: Other Message-related commands.
5522 * Canceling and Superseding::
5526 @node Summary Mail Commands
5527 @subsection Summary Mail Commands
5529 @cindex composing mail
5531 Commands for composing a mail message:
5537 @kindex S r (Summary)
5539 @findex gnus-summary-reply
5540 @c @icon{gnus-summary-mail-reply}
5541 @c @icon{gnus-summary-reply}
5542 Mail a reply to the author of the current article
5543 (@code{gnus-summary-reply}).
5548 @kindex S R (Summary)
5549 @findex gnus-summary-reply-with-original
5550 @c @icon{gnus-summary-reply-with-original}
5551 Mail a reply to the author of the current article and include the
5552 original message (@code{gnus-summary-reply-with-original}). This
5553 command uses the process/prefix convention.
5556 @kindex S w (Summary)
5557 @findex gnus-summary-wide-reply
5558 Mail a wide reply to the author of the current article
5559 (@code{gnus-summary-wide-reply}). A @dfn{wide reply} is a reply that
5560 goes out to all people listed in the @code{To}, @code{From} (or
5561 @code{Reply-to}) and @code{Cc} headers. If @code{Mail-Followup-To} is
5562 present, that's used instead.
5565 @kindex S W (Summary)
5566 @findex gnus-summary-wide-reply-with-original
5567 Mail a wide reply to the current article and include the original
5568 message (@code{gnus-summary-wide-reply-with-original}). This command uses
5569 the process/prefix convention.
5572 @kindex S v (Summary)
5573 @findex gnus-summary-very-wide-reply
5574 Mail a very wide reply to the author of the current article
5575 (@code{gnus-summary-wide-reply}). A @dfn{very wide reply} is a reply
5576 that goes out to all people listed in the @code{To}, @code{From} (or
5577 @code{Reply-to}) and @code{Cc} headers in all the process/prefixed
5578 articles. This command uses the process/prefix convention.
5581 @kindex S V (Summary)
5582 @findex gnus-summary-very-wide-reply-with-original
5583 Mail a very wide reply to the author of the current article and include the
5584 original message (@code{gnus-summary-very-wide-reply-with-original}). This
5585 command uses the process/prefix convention.
5588 @kindex S B r (Summary)
5589 @findex gnus-summary-reply-broken-reply-to
5590 Mail a reply to the author of the current article but ignore the
5591 @code{Reply-To} field (@code{gnus-summary-reply-broken-reply-to}).
5592 If you need this because a mailing list incorrectly sets a
5593 @code{Reply-To} header pointing to the list, you probably want to set
5594 the @code{broken-reply-to} group parameter instead, so things will work
5595 correctly. @xref{Group Parameters}.
5598 @kindex S B R (Summary)
5599 @findex gnus-summary-reply-broken-reply-to-with-original
5600 Mail a reply to the author of the current article and include the
5601 original message but ignore the @code{Reply-To} field
5602 (@code{gnus-summary-reply-broken-reply-to-with-original}).
5606 @kindex S o m (Summary)
5607 @kindex C-c C-f (Summary)
5608 @findex gnus-summary-mail-forward
5609 @c @icon{gnus-summary-mail-forward}
5610 Forward the current article to some other person
5611 (@code{gnus-summary-mail-forward}). If no prefix is given, the message
5612 is forwarded according to the value of (@code{message-forward-as-mime})
5613 and (@code{message-forward-show-mml}); if the prefix is 1, decode the
5614 message and forward directly inline; if the prefix is 2, forward message
5615 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5616 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5617 directly inline; otherwise, the message is forwarded as no prefix given
5618 but use the flipped value of (@code{message-forward-as-mime}). By
5619 default, the message is decoded and forwarded as an rfc822 @acronym{MIME}
5625 @kindex S m (Summary)
5626 @findex gnus-summary-mail-other-window
5627 @c @icon{gnus-summary-mail-originate}
5628 Prepare a mail (@code{gnus-summary-mail-other-window}). By default, use
5629 the posting style of the current group. If given a prefix, disable that.
5630 If the prefix is 1, prompt for a group name to find the posting style.
5635 @kindex S i (Summary)
5636 @findex gnus-summary-news-other-window
5637 Prepare a news (@code{gnus-summary-news-other-window}). By default,
5638 post to the current group. If given a prefix, disable that. If the
5639 prefix is 1, prompt for a group to post to.
5641 This function actually prepares a news even when using mail groups.
5642 This is useful for ``posting'' messages to mail groups without actually
5643 sending them over the network: they're just saved directly to the group
5644 in question. The corresponding back end must have a request-post method
5645 for this to work though.
5648 @kindex S D b (Summary)
5649 @findex gnus-summary-resend-bounced-mail
5650 @cindex bouncing mail
5651 If you have sent a mail, but the mail was bounced back to you for some
5652 reason (wrong address, transient failure), you can use this command to
5653 resend that bounced mail (@code{gnus-summary-resend-bounced-mail}). You
5654 will be popped into a mail buffer where you can edit the headers before
5655 sending the mail off again. If you give a prefix to this command, and
5656 the bounced mail is a reply to some other mail, Gnus will try to fetch
5657 that mail and display it for easy perusal of its headers. This might
5658 very well fail, though.
5661 @kindex S D r (Summary)
5662 @findex gnus-summary-resend-message
5663 Not to be confused with the previous command,
5664 @code{gnus-summary-resend-message} will prompt you for an address to
5665 send the current message off to, and then send it to that place. The
5666 headers of the message won't be altered---but lots of headers that say
5667 @code{Resent-To}, @code{Resent-From} and so on will be added. This
5668 means that you actually send a mail to someone that has a @code{To}
5669 header that (probably) points to yourself. This will confuse people.
5670 So, natcherly you'll only do that if you're really eVIl.
5672 This command is mainly used if you have several accounts and want to
5673 ship a mail to a different account of yours. (If you're both
5674 @code{root} and @code{postmaster} and get a mail for @code{postmaster}
5675 to the @code{root} account, you may want to resend it to
5676 @code{postmaster}. Ordnung muss sein!
5678 This command understands the process/prefix convention
5679 (@pxref{Process/Prefix}).
5682 @kindex S D e (Summary)
5683 @findex gnus-summary-resend-message-edit
5685 Like the previous command, but will allow you to edit the message as
5686 if it were a new message before resending.
5689 @kindex S O m (Summary)
5690 @findex gnus-uu-digest-mail-forward
5691 Digest the current series (@pxref{Decoding Articles}) and forward the
5692 result using mail (@code{gnus-uu-digest-mail-forward}). This command
5693 uses the process/prefix convention (@pxref{Process/Prefix}).
5696 @kindex S M-c (Summary)
5697 @findex gnus-summary-mail-crosspost-complaint
5698 @cindex crossposting
5699 @cindex excessive crossposting
5700 Send a complaint about excessive crossposting to the author of the
5701 current article (@code{gnus-summary-mail-crosspost-complaint}).
5703 @findex gnus-crosspost-complaint
5704 This command is provided as a way to fight back against the current
5705 crossposting pandemic that's sweeping Usenet. It will compose a reply
5706 using the @code{gnus-crosspost-complaint} variable as a preamble. This
5707 command understands the process/prefix convention
5708 (@pxref{Process/Prefix}) and will prompt you before sending each mail.
5712 Also @xref{Header Commands, ,Header Commands, message, The Message
5713 Manual}, for more information.
5716 @node Summary Post Commands
5717 @subsection Summary Post Commands
5719 @cindex composing news
5721 Commands for posting a news article:
5727 @kindex S p (Summary)
5728 @findex gnus-summary-post-news
5729 @c @icon{gnus-summary-post-news}
5730 Prepare for posting an article (@code{gnus-summary-post-news}). By
5731 default, post to the current group. If given a prefix, disable that.
5732 If the prefix is 1, prompt for another group instead.
5737 @kindex S f (Summary)
5738 @findex gnus-summary-followup
5739 @c @icon{gnus-summary-followup}
5740 Post a followup to the current article (@code{gnus-summary-followup}).
5744 @kindex S F (Summary)
5746 @c @icon{gnus-summary-followup-with-original}
5747 @findex gnus-summary-followup-with-original
5748 Post a followup to the current article and include the original message
5749 (@code{gnus-summary-followup-with-original}). This command uses the
5750 process/prefix convention.
5753 @kindex S n (Summary)
5754 @findex gnus-summary-followup-to-mail
5755 Post a followup to the current article via news, even if you got the
5756 message through mail (@code{gnus-summary-followup-to-mail}).
5759 @kindex S N (Summary)
5760 @findex gnus-summary-followup-to-mail-with-original
5761 Post a followup to the current article via news, even if you got the
5762 message through mail and include the original message
5763 (@code{gnus-summary-followup-to-mail-with-original}). This command uses
5764 the process/prefix convention.
5767 @kindex S o p (Summary)
5768 @findex gnus-summary-post-forward
5769 Forward the current article to a newsgroup
5770 (@code{gnus-summary-post-forward}).
5771 If no prefix is given, the message is forwarded according to the value
5772 of (@code{message-forward-as-mime}) and
5773 (@code{message-forward-show-mml}); if the prefix is 1, decode the
5774 message and forward directly inline; if the prefix is 2, forward message
5775 as an rfc822 @acronym{MIME} section; if the prefix is 3, decode message and
5776 forward as an rfc822 @acronym{MIME} section; if the prefix is 4, forward message
5777 directly inline; otherwise, the message is forwarded as no prefix given
5778 but use the flipped value of (@code{message-forward-as-mime}). By
5779 default, the message is decoded and forwarded as an rfc822 @acronym{MIME} section.
5782 @kindex S O p (Summary)
5783 @findex gnus-uu-digest-post-forward
5785 @cindex making digests
5786 Digest the current series and forward the result to a newsgroup
5787 (@code{gnus-uu-digest-post-forward}). This command uses the
5788 process/prefix convention.
5791 @kindex S u (Summary)
5792 @findex gnus-uu-post-news
5793 @c @icon{gnus-uu-post-news}
5794 Uuencode a file, split it into parts, and post it as a series
5795 (@code{gnus-uu-post-news}). (@pxref{Uuencoding and Posting}).
5798 Also @xref{Header Commands, ,Header Commands, message, The Message
5799 Manual}, for more information.
5802 @node Summary Message Commands
5803 @subsection Summary Message Commands
5807 @kindex S y (Summary)
5808 @findex gnus-summary-yank-message
5809 Yank the current article into an already existing Message composition
5810 buffer (@code{gnus-summary-yank-message}). This command prompts for
5811 what message buffer you want to yank into, and understands the
5812 process/prefix convention (@pxref{Process/Prefix}).
5817 @node Canceling and Superseding
5818 @subsection Canceling Articles
5819 @cindex canceling articles
5820 @cindex superseding articles
5822 Have you ever written something, and then decided that you really,
5823 really, really wish you hadn't posted that?
5825 Well, you can't cancel mail, but you can cancel posts.
5827 @findex gnus-summary-cancel-article
5829 @c @icon{gnus-summary-cancel-article}
5830 Find the article you wish to cancel (you can only cancel your own
5831 articles, so don't try any funny stuff). Then press @kbd{C} or @kbd{S
5832 c} (@code{gnus-summary-cancel-article}). Your article will be
5833 canceled---machines all over the world will be deleting your article.
5834 This command uses the process/prefix convention (@pxref{Process/Prefix}).
5836 Be aware, however, that not all sites honor cancels, so your article may
5837 live on here and there, while most sites will delete the article in
5840 Gnus will use the ``current'' select method when canceling. If you
5841 want to use the standard posting method, use the @samp{a} symbolic
5842 prefix (@pxref{Symbolic Prefixes}).
5844 Gnus ensures that only you can cancel your own messages using a
5845 @code{Cancel-Lock} header (@pxref{Canceling News, Canceling News, ,
5846 message, Message Manual}).
5848 If you discover that you have made some mistakes and want to do some
5849 corrections, you can post a @dfn{superseding} article that will replace
5850 your original article.
5852 @findex gnus-summary-supersede-article
5854 Go to the original article and press @kbd{S s}
5855 (@code{gnus-summary-supersede-article}). You will be put in a buffer
5856 where you can edit the article all you want before sending it off the
5859 The same goes for superseding as for canceling, only more so: Some
5860 sites do not honor superseding. On those sites, it will appear that you
5861 have posted almost the same article twice.
5863 If you have just posted the article, and change your mind right away,
5864 there is a trick you can use to cancel/supersede the article without
5865 waiting for the article to appear on your site first. You simply return
5866 to the post buffer (which is called @code{*sent ...*}). There you will
5867 find the article you just posted, with all the headers intact. Change
5868 the @code{Message-ID} header to a @code{Cancel} or @code{Supersedes}
5869 header by substituting one of those words for the word
5870 @code{Message-ID}. Then just press @kbd{C-c C-c} to send the article as
5871 you would do normally. The previous article will be
5872 canceled/superseded.
5874 Just remember, kids: There is no 'c' in 'supersede'.
5876 @node Delayed Articles
5877 @section Delayed Articles
5878 @cindex delayed sending
5879 @cindex send delayed
5881 Sometimes, you might wish to delay the sending of a message. For
5882 example, you might wish to arrange for a message to turn up just in time
5883 to remind your about the birthday of your Significant Other. For this,
5884 there is the @code{gnus-delay} package. Setup is simple:
5887 (gnus-delay-initialize)
5890 @findex gnus-delay-article
5891 Normally, to send a message you use the @kbd{C-c C-c} command from
5892 Message mode. To delay a message, use @kbd{C-c C-j}
5893 (@code{gnus-delay-article}) instead. This will ask you for how long the
5894 message should be delayed. Possible answers are:
5898 A time span. Consists of an integer and a letter. For example,
5899 @code{42d} means to delay for 42 days. Available letters are @code{m}
5900 (minutes), @code{h} (hours), @code{d} (days), @code{w} (weeks), @code{M}
5901 (months) and @code{Y} (years).
5904 A specific date. Looks like @code{YYYY-MM-DD}. The message will be
5905 delayed until that day, at a specific time (eight o'clock by default).
5906 See also @code{gnus-delay-default-hour}.
5909 A specific time of day. Given in @code{hh:mm} format, 24h, no am/pm
5910 stuff. The deadline will be at that time today, except if that time has
5911 already passed, then it's at the given time tomorrow. So if it's ten
5912 o'clock in the morning and you specify @code{11:15}, then the deadline
5913 is one hour and fifteen minutes hence. But if you specify @code{9:20},
5914 that means a time tomorrow.
5917 The action of the @code{gnus-delay-article} command is influenced by a
5918 couple of variables:
5921 @item gnus-delay-default-hour
5922 @vindex gnus-delay-default-hour
5923 When you specify a specific date, the message will be due on that hour
5924 on the given date. Possible values are integers 0 through 23.
5926 @item gnus-delay-default-delay
5927 @vindex gnus-delay-default-delay
5928 This is a string and gives the default delay. It can be of any of the
5929 formats described above.
5931 @item gnus-delay-group
5932 @vindex gnus-delay-group
5933 Delayed articles will be kept in this group on the drafts server until
5934 they are due. You probably don't need to change this. The default
5935 value is @code{"delayed"}.
5937 @item gnus-delay-header
5938 @vindex gnus-delay-header
5939 The deadline for each article will be stored in a header. This variable
5940 is a string and gives the header name. You probably don't need to
5941 change this. The default value is @code{"X-Gnus-Delayed"}.
5944 The way delaying works is like this: when you use the
5945 @code{gnus-delay-article} command, you give a certain delay. Gnus
5946 calculates the deadline of the message and stores it in the
5947 @code{X-Gnus-Delayed} header and puts the message in the
5948 @code{nndraft:delayed} group.
5950 @findex gnus-delay-send-queue
5951 And whenever you get new news, Gnus looks through the group for articles
5952 which are due and sends them. It uses the @code{gnus-delay-send-queue}
5953 function for this. By default, this function is added to the hook
5954 @code{gnus-get-new-news-hook}. But of course, you can change this.
5955 Maybe you want to use the demon to send drafts? Just tell the demon to
5956 execute the @code{gnus-delay-send-queue} function.
5959 @item gnus-delay-initialize
5960 @findex gnus-delay-initialize
5961 By default, this function installs @code{gnus-delay-send-queue} in
5962 @code{gnus-get-new-news-hook}. But it accepts the optional second
5963 argument @code{no-check}. If it is non-@code{nil},
5964 @code{gnus-get-new-news-hook} is not changed. The optional first
5965 argument is ignored.
5967 For example, @code{(gnus-delay-initialize nil t)} means to do nothing.
5968 Presumably, you want to use the demon for sending due delayed articles.
5969 Just don't forget to set that up :-)
5973 @node Marking Articles
5974 @section Marking Articles
5975 @cindex article marking
5976 @cindex article ticking
5979 There are several marks you can set on an article.
5981 You have marks that decide the @dfn{readedness} (whoo, neato-keano
5982 neologism ohoy!) of the article. Alphabetic marks generally mean
5983 @dfn{read}, while non-alphabetic characters generally mean @dfn{unread}.
5985 In addition, you also have marks that do not affect readedness.
5988 There's a plethora of commands for manipulating these marks.
5992 * Unread Articles:: Marks for unread articles.
5993 * Read Articles:: Marks for read articles.
5994 * Other Marks:: Marks that do not affect readedness.
5995 * Setting Marks:: How to set and remove marks.
5996 * Generic Marking Commands:: How to customize the marking.
5997 * Setting Process Marks:: How to mark articles for later processing.
6001 @node Unread Articles
6002 @subsection Unread Articles
6004 The following marks mark articles as (kinda) unread, in one form or
6009 @vindex gnus-ticked-mark
6010 Marked as ticked (@code{gnus-ticked-mark}).
6012 @dfn{Ticked articles} are articles that will remain visible always. If
6013 you see an article that you find interesting, or you want to put off
6014 reading it, or replying to it, until sometime later, you'd typically
6015 tick it. However, articles can be expired (from news servers by the
6016 news server software, Gnus itself never expires ticked messages), so if
6017 you want to keep an article forever, you'll have to make it persistent
6018 (@pxref{Persistent Articles}).
6021 @vindex gnus-dormant-mark
6022 Marked as dormant (@code{gnus-dormant-mark}).
6024 @dfn{Dormant articles} will only appear in the summary buffer if there
6025 are followups to it. If you want to see them even if they don't have
6026 followups, you can use the @kbd{/ D} command (@pxref{Limiting}).
6027 Otherwise (except for the visibility issue), they are just like ticked
6031 @vindex gnus-unread-mark
6032 Marked as unread (@code{gnus-unread-mark}).
6034 @dfn{Unread articles} are articles that haven't been read at all yet.
6039 @subsection Read Articles
6040 @cindex expirable mark
6042 All the following marks mark articles as read.
6047 @vindex gnus-del-mark
6048 These are articles that the user has marked as read with the @kbd{d}
6049 command manually, more or less (@code{gnus-del-mark}).
6052 @vindex gnus-read-mark
6053 Articles that have actually been read (@code{gnus-read-mark}).
6056 @vindex gnus-ancient-mark
6057 Articles that were marked as read in previous sessions and are now
6058 @dfn{old} (@code{gnus-ancient-mark}).
6061 @vindex gnus-killed-mark
6062 Marked as killed (@code{gnus-killed-mark}).
6065 @vindex gnus-kill-file-mark
6066 Marked as killed by kill files (@code{gnus-kill-file-mark}).
6069 @vindex gnus-low-score-mark
6070 Marked as read by having too low a score (@code{gnus-low-score-mark}).
6073 @vindex gnus-catchup-mark
6074 Marked as read by a catchup (@code{gnus-catchup-mark}).
6077 @vindex gnus-canceled-mark
6078 Canceled article (@code{gnus-canceled-mark})
6081 @vindex gnus-souped-mark
6082 @sc{soup}ed article (@code{gnus-souped-mark}). @xref{SOUP}.
6085 @vindex gnus-sparse-mark
6086 Sparsely reffed article (@code{gnus-sparse-mark}). @xref{Customizing
6090 @vindex gnus-duplicate-mark
6091 Article marked as read by duplicate suppression
6092 (@code{gnus-duplicate-mark}). @xref{Duplicate Suppression}.
6096 All these marks just mean that the article is marked as read, really.
6097 They are interpreted differently when doing adaptive scoring, though.
6099 One more special mark, though:
6103 @vindex gnus-expirable-mark
6104 Marked as expirable (@code{gnus-expirable-mark}).
6106 Marking articles as @dfn{expirable} (or have them marked as such
6107 automatically) doesn't make much sense in normal groups---a user doesn't
6108 control expiring of news articles, but in mail groups, for instance,
6109 articles marked as @dfn{expirable} can be deleted by Gnus at
6115 @subsection Other Marks
6116 @cindex process mark
6119 There are some marks that have nothing to do with whether the article is
6125 You can set a bookmark in the current article. Say you are reading a
6126 long thesis on cats' urinary tracts, and have to go home for dinner
6127 before you've finished reading the thesis. You can then set a bookmark
6128 in the article, and Gnus will jump to this bookmark the next time it
6129 encounters the article. @xref{Setting Marks}.
6132 @vindex gnus-replied-mark
6133 All articles that you have replied to or made a followup to (i.e., have
6134 answered) will be marked with an @samp{A} in the second column
6135 (@code{gnus-replied-mark}).
6138 @vindex gnus-forwarded-mark
6139 All articles that you have forwarded will be marked with an @samp{F} in
6140 the second column (@code{gnus-forwarded-mark}).
6143 @vindex gnus-cached-mark
6144 Articles stored in the article cache will be marked with an @samp{*} in
6145 the second column (@code{gnus-cached-mark}). @xref{Article Caching}.
6148 @vindex gnus-saved-mark
6149 Articles ``saved'' (in some manner or other; not necessarily
6150 religiously) are marked with an @samp{S} in the second column
6151 (@code{gnus-saved-mark}).
6154 @vindex gnus-recent-mark
6155 Articles that according to the server haven't been shown to the user
6156 before are marked with a @samp{N} in the second column
6157 (@code{gnus-recent-mark}). Note that not all servers support this
6158 mark, in which case it simply never appears. Compare with
6159 @code{gnus-unseen-mark}.
6162 @vindex gnus-unseen-mark
6163 Articles that haven't been seen before in Gnus by the user are marked
6164 with a @samp{.} in the second column (@code{gnus-unseen-mark}).
6165 Compare with @code{gnus-recent-mark}.
6168 @vindex gnus-downloaded-mark
6169 When using the Gnus agent (@pxref{Agent Basics}), articles may be
6170 downloaded for unplugged (offline) viewing. If you are using the
6171 @samp{%O} spec, these articles get the @samp{+} mark in that spec.
6172 (The variable @code{gnus-downloaded-mark} controls which character to
6176 @vindex gnus-undownloaded-mark
6177 When using the Gnus agent (@pxref{Agent Basics}), some articles might
6178 not have been downloaded. Such articles cannot be viewed while you
6179 are unplugged (offline). If you are using the @samp{%O} spec, these
6180 articles get the @samp{-} mark in that spec. (The variable
6181 @code{gnus-undownloaded-mark} controls which character to use.)
6184 @vindex gnus-downloadable-mark
6185 The Gnus agent (@pxref{Agent Basics}) downloads some articles
6186 automatically, but it is also possible to explicitly mark articles for
6187 download, even if they would not be downloaded automatically. Such
6188 explicitly-marked articles get the @samp{%} mark in the first column.
6189 (The variable @code{gnus-downloadable-mark} controls which character to
6193 @vindex gnus-not-empty-thread-mark
6194 @vindex gnus-empty-thread-mark
6195 If the @samp{%e} spec is used, the presence of threads or not will be
6196 marked with @code{gnus-not-empty-thread-mark} and
6197 @code{gnus-empty-thread-mark} in the third column, respectively.
6200 @vindex gnus-process-mark
6201 Finally we have the @dfn{process mark} (@code{gnus-process-mark}). A
6202 variety of commands react to the presence of the process mark. For
6203 instance, @kbd{X u} (@code{gnus-uu-decode-uu}) will uudecode and view
6204 all articles that have been marked with the process mark. Articles
6205 marked with the process mark have a @samp{#} in the second column.
6209 You might have noticed that most of these ``non-readedness'' marks
6210 appear in the second column by default. So if you have a cached, saved,
6211 replied article that you have process-marked, what will that look like?
6213 Nothing much. The precedence rules go as follows: process -> cache ->
6214 replied -> saved. So if the article is in the cache and is replied,
6215 you'll only see the cache mark and not the replied mark.
6219 @subsection Setting Marks
6220 @cindex setting marks
6222 All the marking commands understand the numeric prefix.
6227 @kindex M c (Summary)
6228 @kindex M-u (Summary)
6229 @findex gnus-summary-clear-mark-forward
6230 @cindex mark as unread
6231 Clear all readedness-marks from the current article
6232 (@code{gnus-summary-clear-mark-forward}). In other words, mark the
6238 @kindex M t (Summary)
6239 @findex gnus-summary-tick-article-forward
6240 Tick the current article (@code{gnus-summary-tick-article-forward}).
6241 @xref{Article Caching}.
6246 @kindex M ? (Summary)
6247 @findex gnus-summary-mark-as-dormant
6248 Mark the current article as dormant
6249 (@code{gnus-summary-mark-as-dormant}). @xref{Article Caching}.
6253 @kindex M d (Summary)
6255 @findex gnus-summary-mark-as-read-forward
6256 Mark the current article as read
6257 (@code{gnus-summary-mark-as-read-forward}).
6261 @findex gnus-summary-mark-as-read-backward
6262 Mark the current article as read and move point to the previous line
6263 (@code{gnus-summary-mark-as-read-backward}).
6268 @kindex M k (Summary)
6269 @findex gnus-summary-kill-same-subject-and-select
6270 Mark all articles that have the same subject as the current one as read,
6271 and then select the next unread article
6272 (@code{gnus-summary-kill-same-subject-and-select}).
6276 @kindex M K (Summary)
6277 @kindex C-k (Summary)
6278 @findex gnus-summary-kill-same-subject
6279 Mark all articles that have the same subject as the current one as read
6280 (@code{gnus-summary-kill-same-subject}).
6283 @kindex M C (Summary)
6284 @findex gnus-summary-catchup
6285 @c @icon{gnus-summary-catchup}
6286 Mark all unread articles as read (@code{gnus-summary-catchup}).
6289 @kindex M C-c (Summary)
6290 @findex gnus-summary-catchup-all
6291 Mark all articles in the group as read---even the ticked and dormant
6292 articles (@code{gnus-summary-catchup-all}).
6295 @kindex M H (Summary)
6296 @findex gnus-summary-catchup-to-here
6297 Catchup the current group to point (before the point)
6298 (@code{gnus-summary-catchup-to-here}).
6301 @kindex M h (Summary)
6302 @findex gnus-summary-catchup-from-here
6303 Catchup the current group from point (after the point)
6304 (@code{gnus-summary-catchup-from-here}).
6307 @kindex C-w (Summary)
6308 @findex gnus-summary-mark-region-as-read
6309 Mark all articles between point and mark as read
6310 (@code{gnus-summary-mark-region-as-read}).
6313 @kindex M V k (Summary)
6314 @findex gnus-summary-kill-below
6315 Kill all articles with scores below the default score (or below the
6316 numeric prefix) (@code{gnus-summary-kill-below}).
6320 @kindex M e (Summary)
6322 @findex gnus-summary-mark-as-expirable
6323 Mark the current article as expirable
6324 (@code{gnus-summary-mark-as-expirable}).
6327 @kindex M b (Summary)
6328 @findex gnus-summary-set-bookmark
6329 Set a bookmark in the current article
6330 (@code{gnus-summary-set-bookmark}).
6333 @kindex M B (Summary)
6334 @findex gnus-summary-remove-bookmark
6335 Remove the bookmark from the current article
6336 (@code{gnus-summary-remove-bookmark}).
6339 @kindex M V c (Summary)
6340 @findex gnus-summary-clear-above
6341 Clear all marks from articles with scores over the default score (or
6342 over the numeric prefix) (@code{gnus-summary-clear-above}).
6345 @kindex M V u (Summary)
6346 @findex gnus-summary-tick-above
6347 Tick all articles with scores over the default score (or over the
6348 numeric prefix) (@code{gnus-summary-tick-above}).
6351 @kindex M V m (Summary)
6352 @findex gnus-summary-mark-above
6353 Prompt for a mark, and mark all articles with scores over the default
6354 score (or over the numeric prefix) with this mark
6355 (@code{gnus-summary-clear-above}).
6358 @vindex gnus-summary-goto-unread
6359 The @code{gnus-summary-goto-unread} variable controls what action should
6360 be taken after setting a mark. If non-@code{nil}, point will move to
6361 the next/previous unread article. If @code{nil}, point will just move
6362 one line up or down. As a special case, if this variable is
6363 @code{never}, all the marking commands as well as other commands (like
6364 @kbd{SPACE}) will move to the next article, whether it is unread or not.
6365 The default is @code{t}.
6368 @node Generic Marking Commands
6369 @subsection Generic Marking Commands
6371 Some people would like the command that ticks an article (@kbd{!}) go to
6372 the next article. Others would like it to go to the next unread
6373 article. Yet others would like it to stay on the current article. And
6374 even though I haven't heard of anybody wanting it to go to the
6375 previous (unread) article, I'm sure there are people that want that as
6378 Multiply these five behaviors with five different marking commands, and
6379 you get a potentially complex set of variable to control what each
6382 To sidestep that mess, Gnus provides commands that do all these
6383 different things. They can be found on the @kbd{M M} map in the summary
6384 buffer. Type @kbd{M M C-h} to see them all---there are too many of them
6385 to list in this manual.
6387 While you can use these commands directly, most users would prefer
6388 altering the summary mode keymap. For instance, if you would like the
6389 @kbd{!} command to go to the next article instead of the next unread
6390 article, you could say something like:
6394 (add-hook 'gnus-summary-mode-hook 'my-alter-summary-map)
6395 (defun my-alter-summary-map ()
6396 (local-set-key "!" 'gnus-summary-put-mark-as-ticked-next))
6404 (defun my-alter-summary-map ()
6405 (local-set-key "!" "MM!n"))
6409 @node Setting Process Marks
6410 @subsection Setting Process Marks
6411 @cindex setting process marks
6413 Process marks are displayed as @code{#} in the summary buffer, and are
6414 used for marking articles in such a way that other commands will
6415 process these articles. For instance, if you process mark four
6416 articles and then use the @kbd{*} command, Gnus will enter these four
6417 articles into the cache. For more information,
6418 @pxref{Process/Prefix}.
6425 @kindex M P p (Summary)
6426 @findex gnus-summary-mark-as-processable
6427 Mark the current article with the process mark
6428 (@code{gnus-summary-mark-as-processable}).
6429 @findex gnus-summary-unmark-as-processable
6433 @kindex M P u (Summary)
6434 @kindex M-# (Summary)
6435 Remove the process mark, if any, from the current article
6436 (@code{gnus-summary-unmark-as-processable}).
6439 @kindex M P U (Summary)
6440 @findex gnus-summary-unmark-all-processable
6441 Remove the process mark from all articles
6442 (@code{gnus-summary-unmark-all-processable}).
6445 @kindex M P i (Summary)
6446 @findex gnus-uu-invert-processable
6447 Invert the list of process marked articles
6448 (@code{gnus-uu-invert-processable}).
6451 @kindex M P R (Summary)
6452 @findex gnus-uu-mark-by-regexp
6453 Mark articles that have a @code{Subject} header that matches a regular
6454 expression (@code{gnus-uu-mark-by-regexp}).
6457 @kindex M P G (Summary)
6458 @findex gnus-uu-unmark-by-regexp
6459 Unmark articles that have a @code{Subject} header that matches a regular
6460 expression (@code{gnus-uu-unmark-by-regexp}).
6463 @kindex M P r (Summary)
6464 @findex gnus-uu-mark-region
6465 Mark articles in region (@code{gnus-uu-mark-region}).
6468 @kindex M P g (Summary)
6469 @findex gnus-uu-unmark-region
6470 Unmark articles in region (@code{gnus-uu-unmark-region}).
6473 @kindex M P t (Summary)
6474 @findex gnus-uu-mark-thread
6475 Mark all articles in the current (sub)thread
6476 (@code{gnus-uu-mark-thread}).
6479 @kindex M P T (Summary)
6480 @findex gnus-uu-unmark-thread
6481 Unmark all articles in the current (sub)thread
6482 (@code{gnus-uu-unmark-thread}).
6485 @kindex M P v (Summary)
6486 @findex gnus-uu-mark-over
6487 Mark all articles that have a score above the prefix argument
6488 (@code{gnus-uu-mark-over}).
6491 @kindex M P s (Summary)
6492 @findex gnus-uu-mark-series
6493 Mark all articles in the current series (@code{gnus-uu-mark-series}).
6496 @kindex M P S (Summary)
6497 @findex gnus-uu-mark-sparse
6498 Mark all series that have already had some articles marked
6499 (@code{gnus-uu-mark-sparse}).
6502 @kindex M P a (Summary)
6503 @findex gnus-uu-mark-all
6504 Mark all articles in series order (@code{gnus-uu-mark-all}).
6507 @kindex M P b (Summary)
6508 @findex gnus-uu-mark-buffer
6509 Mark all articles in the buffer in the order they appear
6510 (@code{gnus-uu-mark-buffer}).
6513 @kindex M P k (Summary)
6514 @findex gnus-summary-kill-process-mark
6515 Push the current process mark set onto the stack and unmark all articles
6516 (@code{gnus-summary-kill-process-mark}).
6519 @kindex M P y (Summary)
6520 @findex gnus-summary-yank-process-mark
6521 Pop the previous process mark set from the stack and restore it
6522 (@code{gnus-summary-yank-process-mark}).
6525 @kindex M P w (Summary)
6526 @findex gnus-summary-save-process-mark
6527 Push the current process mark set onto the stack
6528 (@code{gnus-summary-save-process-mark}).
6532 Also see the @kbd{&} command in @ref{Searching for Articles}, for how to
6533 set process marks based on article body contents.
6540 It can be convenient to limit the summary buffer to just show some
6541 subset of the articles currently in the group. The effect most limit
6542 commands have is to remove a few (or many) articles from the summary
6545 All limiting commands work on subsets of the articles already fetched
6546 from the servers. None of these commands query the server for
6547 additional articles.
6553 @kindex / / (Summary)
6554 @findex gnus-summary-limit-to-subject
6555 Limit the summary buffer to articles that match some subject
6556 (@code{gnus-summary-limit-to-subject}). If given a prefix, exclude
6560 @kindex / a (Summary)
6561 @findex gnus-summary-limit-to-author
6562 Limit the summary buffer to articles that match some author
6563 (@code{gnus-summary-limit-to-author}). If given a prefix, exclude
6567 @kindex / R (Summary)
6568 @findex gnus-summary-limit-to-recipient
6569 Limit the summary buffer to articles that match some recipient
6570 (@code{gnus-summary-limit-to-recipient}). If given a prefix, exclude
6574 @kindex / A (Summary)
6575 @findex gnus-summary-limit-to-address
6576 Limit the summary buffer to articles in which contents of From, To or Cc
6577 header match a given address (@code{gnus-summary-limit-to-address}). If
6578 given a prefix, exclude matching articles.
6581 @kindex / S (Summary)
6582 @findex gnus-summary-limit-to-singletons
6583 Limit the summary buffer to articles that aren't part of any displayed
6584 threads (@code{gnus-summary-limit-to-singletons}). If given a prefix,
6585 limit to articles that are part of displayed threads.
6588 @kindex / x (Summary)
6589 @findex gnus-summary-limit-to-extra
6590 Limit the summary buffer to articles that match one of the ``extra''
6591 headers (@pxref{To From Newsgroups})
6592 (@code{gnus-summary-limit-to-extra}). If given a prefix, exclude
6597 @kindex / u (Summary)
6599 @findex gnus-summary-limit-to-unread
6600 Limit the summary buffer to articles not marked as read
6601 (@code{gnus-summary-limit-to-unread}). If given a prefix, limit the
6602 buffer to articles strictly unread. This means that ticked and
6603 dormant articles will also be excluded.
6606 @kindex / m (Summary)
6607 @findex gnus-summary-limit-to-marks
6608 Ask for a mark and then limit to all articles that have been marked
6609 with that mark (@code{gnus-summary-limit-to-marks}).
6612 @kindex / t (Summary)
6613 @findex gnus-summary-limit-to-age
6614 Ask for a number and then limit the summary buffer to articles older than (or equal to) that number of days
6615 (@code{gnus-summary-limit-to-age}). If given a prefix, limit to
6616 articles younger than that number of days.
6619 @kindex / n (Summary)
6620 @findex gnus-summary-limit-to-articles
6621 With prefix @samp{n}, limit the summary buffer to the next @samp{n}
6622 articles. If not given a prefix, use the process marked articles
6623 instead. (@code{gnus-summary-limit-to-articles}).
6626 @kindex / w (Summary)
6627 @findex gnus-summary-pop-limit
6628 Pop the previous limit off the stack and restore it
6629 (@code{gnus-summary-pop-limit}). If given a prefix, pop all limits off
6633 @kindex / . (Summary)
6634 @findex gnus-summary-limit-to-unseen
6635 Limit the summary buffer to the unseen articles
6636 (@code{gnus-summary-limit-to-unseen}).
6639 @kindex / v (Summary)
6640 @findex gnus-summary-limit-to-score
6641 Limit the summary buffer to articles that have a score at or above some
6642 score (@code{gnus-summary-limit-to-score}).
6645 @kindex / p (Summary)
6646 @findex gnus-summary-limit-to-display-predicate
6647 Limit the summary buffer to articles that satisfy the @code{display}
6648 group parameter predicate
6649 (@code{gnus-summary-limit-to-display-predicate}). @xref{Group
6650 Parameters}, for more on this predicate.
6653 @kindex / r (Summary)
6654 @findex gnus-summary-limit-to-replied
6655 Limit the summary buffer to replied articles
6656 (@code{gnus-summary-limit-to-replied}). If given a prefix, exclude
6661 @kindex M S (Summary)
6662 @kindex / E (Summary)
6663 @findex gnus-summary-limit-include-expunged
6664 Include all expunged articles in the limit
6665 (@code{gnus-summary-limit-include-expunged}).
6668 @kindex / D (Summary)
6669 @findex gnus-summary-limit-include-dormant
6670 Include all dormant articles in the limit
6671 (@code{gnus-summary-limit-include-dormant}).
6674 @kindex / * (Summary)
6675 @findex gnus-summary-limit-include-cached
6676 Include all cached articles in the limit
6677 (@code{gnus-summary-limit-include-cached}).
6680 @kindex / d (Summary)
6681 @findex gnus-summary-limit-exclude-dormant
6682 Exclude all dormant articles from the limit
6683 (@code{gnus-summary-limit-exclude-dormant}).
6686 @kindex / M (Summary)
6687 @findex gnus-summary-limit-exclude-marks
6688 Exclude all marked articles (@code{gnus-summary-limit-exclude-marks}).
6691 @kindex / T (Summary)
6692 @findex gnus-summary-limit-include-thread
6693 Include all the articles in the current thread in the limit.
6696 @kindex / c (Summary)
6697 @findex gnus-summary-limit-exclude-childless-dormant
6698 Exclude all dormant articles that have no children from the limit@*
6699 (@code{gnus-summary-limit-exclude-childless-dormant}).
6702 @kindex / C (Summary)
6703 @findex gnus-summary-limit-mark-excluded-as-read
6704 Mark all excluded unread articles as read
6705 (@code{gnus-summary-limit-mark-excluded-as-read}). If given a prefix,
6706 also mark excluded ticked and dormant articles as read.
6709 @kindex / N (Summary)
6710 @findex gnus-summary-insert-new-articles
6711 Insert all new articles in the summary buffer. It scans for new emails
6712 if @var{back-end}@code{-get-new-mail} is non-@code{nil}.
6715 @kindex / o (Summary)
6716 @findex gnus-summary-insert-old-articles
6717 Insert all old articles in the summary buffer. If given a numbered
6718 prefix, fetch this number of articles.
6721 @kindex / b (Summary)
6722 @findex gnus-summary-limit-to-bodies
6723 Limit the summary buffer to articles that have bodies that match a
6724 certain regexp (@code{gnus-summary-limit-to-bodies}). If given a
6725 prefix, reverse the limit. This command is quite slow since it
6726 requires selecting each article to find the matches.
6729 @kindex / h (Summary)
6730 @findex gnus-summary-limit-to-headers
6731 Like the previous command, only limit to headers instead
6732 (@code{gnus-summary-limit-to-headers}).
6740 @cindex article threading
6742 Gnus threads articles by default. @dfn{To thread} is to put responses
6743 to articles directly after the articles they respond to---in a
6744 hierarchical fashion.
6746 Threading is done by looking at the @code{References} headers of the
6747 articles. In a perfect world, this would be enough to build pretty
6748 trees, but unfortunately, the @code{References} header is often broken
6749 or simply missing. Weird news propagation exacerbates the problem,
6750 so one has to employ other heuristics to get pleasing results. A
6751 plethora of approaches exists, as detailed in horrible detail in
6752 @ref{Customizing Threading}.
6754 First, a quick overview of the concepts:
6758 The top-most article in a thread; the first article in the thread.
6761 A tree-like article structure.
6764 A small(er) section of this tree-like structure.
6767 Threads often lose their roots due to article expiry, or due to the root
6768 already having been read in a previous session, and not displayed in the
6769 summary buffer. We then typically have many sub-threads that really
6770 belong to one thread, but are without connecting roots. These are
6771 called loose threads.
6773 @item thread gathering
6774 An attempt to gather loose threads into bigger threads.
6776 @item sparse threads
6777 A thread where the missing articles have been ``guessed'' at, and are
6778 displayed as empty lines in the summary buffer.
6784 * Customizing Threading:: Variables you can change to affect the threading.
6785 * Thread Commands:: Thread based commands in the summary buffer.
6789 @node Customizing Threading
6790 @subsection Customizing Threading
6791 @cindex customizing threading
6794 * Loose Threads:: How Gnus gathers loose threads into bigger threads.
6795 * Filling In Threads:: Making the threads displayed look fuller.
6796 * More Threading:: Even more variables for fiddling with threads.
6797 * Low-Level Threading:: You thought it was over@dots{} but you were wrong!
6802 @subsubsection Loose Threads
6805 @cindex loose threads
6808 @item gnus-summary-make-false-root
6809 @vindex gnus-summary-make-false-root
6810 If non-@code{nil}, Gnus will gather all loose subtrees into one big tree
6811 and create a dummy root at the top. (Wait a minute. Root at the top?
6812 Yup.) Loose subtrees occur when the real root has expired, or you've
6813 read or killed the root in a previous session.
6815 When there is no real root of a thread, Gnus will have to fudge
6816 something. This variable says what fudging method Gnus should use.
6817 There are four possible values:
6821 \gnusfigure{The Summary Buffer}{390}{
6822 \put(0,0){\epsfig{figure=ps/summary-adopt,width=7.5cm}}
6823 \put(445,0){\makebox(0,0)[br]{\epsfig{figure=ps/summary-empty,width=7.5cm}}}
6824 \put(0,400){\makebox(0,0)[tl]{\epsfig{figure=ps/summary-none,width=7.5cm}}}
6825 \put(445,400){\makebox(0,0)[tr]{\epsfig{figure=ps/summary-dummy,width=7.5cm}}}
6830 @cindex adopting articles
6835 Gnus will make the first of the orphaned articles the parent. This
6836 parent will adopt all the other articles. The adopted articles will be
6837 marked as such by pointy brackets (@samp{<>}) instead of the standard
6838 square brackets (@samp{[]}). This is the default method.
6841 @vindex gnus-summary-dummy-line-format
6842 @vindex gnus-summary-make-false-root-always
6843 Gnus will create a dummy summary line that will pretend to be the
6844 parent. This dummy line does not correspond to any real article, so
6845 selecting it will just select the first real article after the dummy
6846 article. @code{gnus-summary-dummy-line-format} is used to specify the
6847 format of the dummy roots. It accepts only one format spec: @samp{S},
6848 which is the subject of the article. @xref{Formatting Variables}.
6849 If you want all threads to have a dummy root, even the non-gathered
6850 ones, set @code{gnus-summary-make-false-root-always} to @code{t}.
6853 Gnus won't actually make any article the parent, but simply leave the
6854 subject field of all orphans except the first empty. (Actually, it will
6855 use @code{gnus-summary-same-subject} as the subject (@pxref{Summary
6859 Don't make any article parent at all. Just gather the threads and
6860 display them after one another.
6863 Don't gather loose threads.
6866 @item gnus-summary-gather-subject-limit
6867 @vindex gnus-summary-gather-subject-limit
6868 Loose threads are gathered by comparing subjects of articles. If this
6869 variable is @code{nil}, Gnus requires an exact match between the
6870 subjects of the loose threads before gathering them into one big
6871 super-thread. This might be too strict a requirement, what with the
6872 presence of stupid newsreaders that chop off long subject lines. If
6873 you think so, set this variable to, say, 20 to require that only the
6874 first 20 characters of the subjects have to match. If you set this
6875 variable to a really low number, you'll find that Gnus will gather
6876 everything in sight into one thread, which isn't very helpful.
6878 @cindex fuzzy article gathering
6879 If you set this variable to the special value @code{fuzzy}, Gnus will
6880 use a fuzzy string comparison algorithm on the subjects (@pxref{Fuzzy
6883 @item gnus-simplify-subject-fuzzy-regexp
6884 @vindex gnus-simplify-subject-fuzzy-regexp
6885 This can either be a regular expression or list of regular expressions
6886 that match strings that will be removed from subjects if fuzzy subject
6887 simplification is used.
6889 @item gnus-simplify-ignored-prefixes
6890 @vindex gnus-simplify-ignored-prefixes
6891 If you set @code{gnus-summary-gather-subject-limit} to something as low
6892 as 10, you might consider setting this variable to something sensible:
6894 @c Written by Michael Ernst <mernst@cs.rice.edu>
6896 (setq gnus-simplify-ignored-prefixes
6902 "wanted" "followup" "summary\\( of\\)?"
6903 "help" "query" "problem" "question"
6904 "answer" "reference" "announce"
6905 "How can I" "How to" "Comparison of"
6910 (mapconcat 'identity
6911 '("for" "for reference" "with" "about")
6913 "\\)?\\]?:?[ \t]*"))
6916 All words that match this regexp will be removed before comparing two
6919 @item gnus-simplify-subject-functions
6920 @vindex gnus-simplify-subject-functions
6921 If non-@code{nil}, this variable overrides
6922 @code{gnus-summary-gather-subject-limit}. This variable should be a
6923 list of functions to apply to the @code{Subject} string iteratively to
6924 arrive at the simplified version of the string.
6926 Useful functions to put in this list include:
6929 @item gnus-simplify-subject-re
6930 @findex gnus-simplify-subject-re
6931 Strip the leading @samp{Re:}.
6933 @item gnus-simplify-subject-fuzzy
6934 @findex gnus-simplify-subject-fuzzy
6937 @item gnus-simplify-whitespace
6938 @findex gnus-simplify-whitespace
6939 Remove excessive whitespace.
6941 @item gnus-simplify-all-whitespace
6942 @findex gnus-simplify-all-whitespace
6943 Remove all whitespace.
6946 You may also write your own functions, of course.
6949 @item gnus-summary-gather-exclude-subject
6950 @vindex gnus-summary-gather-exclude-subject
6951 Since loose thread gathering is done on subjects only, that might lead
6952 to many false hits, especially with certain common subjects like
6953 @samp{} and @samp{(none)}. To make the situation slightly better,
6954 you can use the regexp @code{gnus-summary-gather-exclude-subject} to say
6955 what subjects should be excluded from the gathering process.@*
6956 The default is @samp{^ *$\\|^(none)$}.
6958 @item gnus-summary-thread-gathering-function
6959 @vindex gnus-summary-thread-gathering-function
6960 Gnus gathers threads by looking at @code{Subject} headers. This means
6961 that totally unrelated articles may end up in the same ``thread'', which
6962 is confusing. An alternate approach is to look at all the
6963 @code{Message-ID}s in all the @code{References} headers to find matches.
6964 This will ensure that no gathered threads ever include unrelated
6965 articles, but it also means that people who have posted with broken
6966 newsreaders won't be gathered properly. The choice is yours---plague or
6970 @item gnus-gather-threads-by-subject
6971 @findex gnus-gather-threads-by-subject
6972 This function is the default gathering function and looks at
6973 @code{Subject}s exclusively.
6975 @item gnus-gather-threads-by-references
6976 @findex gnus-gather-threads-by-references
6977 This function looks at @code{References} headers exclusively.
6980 If you want to test gathering by @code{References}, you could say
6984 (setq gnus-summary-thread-gathering-function
6985 'gnus-gather-threads-by-references)
6991 @node Filling In Threads
6992 @subsubsection Filling In Threads
6995 @item gnus-fetch-old-headers
6996 @vindex gnus-fetch-old-headers
6997 If non-@code{nil}, Gnus will attempt to build old threads by fetching
6998 more old headers---headers to articles marked as read. If you would
6999 like to display as few summary lines as possible, but still connect as
7000 many loose threads as possible, you should set this variable to
7001 @code{some} or a number. If you set it to a number, no more than that
7002 number of extra old headers will be fetched. In either case, fetching
7003 old headers only works if the back end you are using carries overview
7004 files---this would normally be @code{nntp}, @code{nnspool},
7005 @code{nnml}, and @code{nnmaildir}. Also remember that if the root of
7006 the thread has been expired by the server, there's not much Gnus can
7009 This variable can also be set to @code{invisible}. This won't have any
7010 visible effects, but is useful if you use the @kbd{A T} command a lot
7011 (@pxref{Finding the Parent}).
7013 @item gnus-fetch-old-ephemeral-headers
7014 @vindex gnus-fetch-old-ephemeral-headers
7015 Same as @code{gnus-fetch-old-headers}, but only used for ephemeral
7018 @item gnus-build-sparse-threads
7019 @vindex gnus-build-sparse-threads
7020 Fetching old headers can be slow. A low-rent similar effect can be
7021 gotten by setting this variable to @code{some}. Gnus will then look at
7022 the complete @code{References} headers of all articles and try to string
7023 together articles that belong in the same thread. This will leave
7024 @dfn{gaps} in the threading display where Gnus guesses that an article
7025 is missing from the thread. (These gaps appear like normal summary
7026 lines. If you select a gap, Gnus will try to fetch the article in
7027 question.) If this variable is @code{t}, Gnus will display all these
7028 ``gaps'' without regard for whether they are useful for completing the
7029 thread or not. Finally, if this variable is @code{more}, Gnus won't cut
7030 off sparse leaf nodes that don't lead anywhere. This variable is
7031 @code{nil} by default.
7033 @item gnus-read-all-available-headers
7034 @vindex gnus-read-all-available-headers
7035 This is a rather obscure variable that few will find useful. It's
7036 intended for those non-news newsgroups where the back end has to fetch
7037 quite a lot to present the summary buffer, and where it's impossible to
7038 go back to parents of articles. This is mostly the case in the
7039 web-based groups, like the @code{nnultimate} groups.
7041 If you don't use those, then it's safe to leave this as the default
7042 @code{nil}. If you want to use this variable, it should be a regexp
7043 that matches the group name, or @code{t} for all groups.
7048 @node More Threading
7049 @subsubsection More Threading
7052 @item gnus-show-threads
7053 @vindex gnus-show-threads
7054 If this variable is @code{nil}, no threading will be done, and all of
7055 the rest of the variables here will have no effect. Turning threading
7056 off will speed group selection up a bit, but it is sure to make reading
7057 slower and more awkward.
7059 @item gnus-thread-hide-subtree
7060 @vindex gnus-thread-hide-subtree
7061 If non-@code{nil}, all threads will be hidden when the summary buffer is
7064 This can also be a predicate specifier (@pxref{Predicate Specifiers}).
7065 Available predicates are @code{gnus-article-unread-p} and
7066 @code{gnus-article-unseen-p}.
7071 (setq gnus-thread-hide-subtree
7072 '(or gnus-article-unread-p
7073 gnus-article-unseen-p))
7076 (It's a pretty nonsensical example, since all unseen articles are also
7077 unread, but you get my drift.)
7080 @item gnus-thread-expunge-below
7081 @vindex gnus-thread-expunge-below
7082 All threads that have a total score (as defined by
7083 @code{gnus-thread-score-function}) less than this number will be
7084 expunged. This variable is @code{nil} by default, which means that no
7085 threads are expunged.
7087 @item gnus-thread-hide-killed
7088 @vindex gnus-thread-hide-killed
7089 if you kill a thread and this variable is non-@code{nil}, the subtree
7092 @item gnus-thread-ignore-subject
7093 @vindex gnus-thread-ignore-subject
7094 Sometimes somebody changes the subject in the middle of a thread. If
7095 this variable is non-@code{nil}, which is the default, the subject
7096 change is ignored. If it is @code{nil}, a change in the subject will
7097 result in a new thread.
7099 @item gnus-thread-indent-level
7100 @vindex gnus-thread-indent-level
7101 This is a number that says how much each sub-thread should be indented.
7104 @item gnus-sort-gathered-threads-function
7105 @vindex gnus-sort-gathered-threads-function
7106 Sometimes, particularly with mailing lists, the order in which mails
7107 arrive locally is not necessarily the same as the order in which they
7108 arrived on the mailing list. Consequently, when sorting sub-threads
7109 using the default @code{gnus-thread-sort-by-number}, responses can end
7110 up appearing before the article to which they are responding to.
7111 Setting this variable to an alternate value
7112 (e.g. @code{gnus-thread-sort-by-date}), in a group's parameters or in an
7113 appropriate hook (e.g. @code{gnus-summary-generate-hook}) can produce a
7114 more logical sub-thread ordering in such instances.
7119 @node Low-Level Threading
7120 @subsubsection Low-Level Threading
7124 @item gnus-parse-headers-hook
7125 @vindex gnus-parse-headers-hook
7126 Hook run before parsing any headers.
7128 @item gnus-alter-header-function
7129 @vindex gnus-alter-header-function
7130 If non-@code{nil}, this function will be called to allow alteration of
7131 article header structures. The function is called with one parameter,
7132 the article header vector, which it may alter in any way. For instance,
7133 if you have a mail-to-news gateway which alters the @code{Message-ID}s
7134 in systematic ways (by adding prefixes and such), you can use this
7135 variable to un-scramble the @code{Message-ID}s so that they are more
7136 meaningful. Here's one example:
7139 (setq gnus-alter-header-function 'my-alter-message-id)
7141 (defun my-alter-message-id (header)
7142 (let ((id (mail-header-id header)))
7144 "\\(<[^<>@@]*\\)\\.?cygnus\\..*@@\\([^<>@@]*>\\)" id)
7146 (concat (match-string 1 id) "@@" (match-string 2 id))
7153 @node Thread Commands
7154 @subsection Thread Commands
7155 @cindex thread commands
7161 @kindex T k (Summary)
7162 @kindex C-M-k (Summary)
7163 @findex gnus-summary-kill-thread
7164 Mark all articles in the current (sub-)thread as read
7165 (@code{gnus-summary-kill-thread}). If the prefix argument is positive,
7166 remove all marks instead. If the prefix argument is negative, tick
7171 @kindex T l (Summary)
7172 @kindex C-M-l (Summary)
7173 @findex gnus-summary-lower-thread
7174 Lower the score of the current (sub-)thread
7175 (@code{gnus-summary-lower-thread}).
7178 @kindex T i (Summary)
7179 @findex gnus-summary-raise-thread
7180 Increase the score of the current (sub-)thread
7181 (@code{gnus-summary-raise-thread}).
7184 @kindex T # (Summary)
7185 @findex gnus-uu-mark-thread
7186 Set the process mark on the current (sub-)thread
7187 (@code{gnus-uu-mark-thread}).
7190 @kindex T M-# (Summary)
7191 @findex gnus-uu-unmark-thread
7192 Remove the process mark from the current (sub-)thread
7193 (@code{gnus-uu-unmark-thread}).
7196 @kindex T T (Summary)
7197 @findex gnus-summary-toggle-threads
7198 Toggle threading (@code{gnus-summary-toggle-threads}).
7201 @kindex T s (Summary)
7202 @findex gnus-summary-show-thread
7203 Expose the (sub-)thread hidden under the current article, if any@*
7204 (@code{gnus-summary-show-thread}).
7207 @kindex T h (Summary)
7208 @findex gnus-summary-hide-thread
7209 Hide the current (sub-)thread (@code{gnus-summary-hide-thread}).
7212 @kindex T S (Summary)
7213 @findex gnus-summary-show-all-threads
7214 Expose all hidden threads (@code{gnus-summary-show-all-threads}).
7217 @kindex T H (Summary)
7218 @findex gnus-summary-hide-all-threads
7219 Hide all threads (@code{gnus-summary-hide-all-threads}).
7222 @kindex T t (Summary)
7223 @findex gnus-summary-rethread-current
7224 Re-thread the current article's thread
7225 (@code{gnus-summary-rethread-current}). This works even when the
7226 summary buffer is otherwise unthreaded.
7229 @kindex T ^ (Summary)
7230 @findex gnus-summary-reparent-thread
7231 Make the current article the child of the marked (or previous) article
7232 (@code{gnus-summary-reparent-thread}).
7235 @kindex T M-^ (Summary)
7236 @findex gnus-summary-reparent-children
7237 Make the current article the parent of the marked articles
7238 (@code{gnus-summary-reparent-children}).
7242 The following commands are thread movement commands. They all
7243 understand the numeric prefix.
7248 @kindex T n (Summary)
7250 @kindex C-M-n (Summary)
7252 @kindex M-down (Summary)
7253 @findex gnus-summary-next-thread
7254 Go to the next thread (@code{gnus-summary-next-thread}).
7257 @kindex T p (Summary)
7259 @kindex C-M-p (Summary)
7261 @kindex M-up (Summary)
7262 @findex gnus-summary-prev-thread
7263 Go to the previous thread (@code{gnus-summary-prev-thread}).
7266 @kindex T d (Summary)
7267 @findex gnus-summary-down-thread
7268 Descend the thread (@code{gnus-summary-down-thread}).
7271 @kindex T u (Summary)
7272 @findex gnus-summary-up-thread
7273 Ascend the thread (@code{gnus-summary-up-thread}).
7276 @kindex T o (Summary)
7277 @findex gnus-summary-top-thread
7278 Go to the top of the thread (@code{gnus-summary-top-thread}).
7281 @vindex gnus-thread-operation-ignore-subject
7282 If you ignore subject while threading, you'll naturally end up with
7283 threads that have several different subjects in them. If you then issue
7284 a command like @kbd{T k} (@code{gnus-summary-kill-thread}) you might not
7285 wish to kill the entire thread, but just those parts of the thread that
7286 have the same subject as the current article. If you like this idea,
7287 you can fiddle with @code{gnus-thread-operation-ignore-subject}. If it
7288 is non-@code{nil} (which it is by default), subjects will be ignored
7289 when doing thread commands. If this variable is @code{nil}, articles in
7290 the same thread with different subjects will not be included in the
7291 operation in question. If this variable is @code{fuzzy}, only articles
7292 that have subjects fuzzily equal will be included (@pxref{Fuzzy
7296 @node Sorting the Summary Buffer
7297 @section Sorting the Summary Buffer
7299 @findex gnus-thread-sort-by-total-score
7300 @findex gnus-thread-sort-by-date
7301 @findex gnus-thread-sort-by-score
7302 @findex gnus-thread-sort-by-subject
7303 @findex gnus-thread-sort-by-author
7304 @findex gnus-thread-sort-by-recipient
7305 @findex gnus-thread-sort-by-number
7306 @findex gnus-thread-sort-by-random
7307 @vindex gnus-thread-sort-functions
7308 @findex gnus-thread-sort-by-most-recent-number
7309 @findex gnus-thread-sort-by-most-recent-date
7310 If you are using a threaded summary display, you can sort the threads by
7311 setting @code{gnus-thread-sort-functions}, which can be either a single
7312 function, a list of functions, or a list containing functions and
7313 @code{(not some-function)} elements.
7315 By default, sorting is done on article numbers. Ready-made sorting
7316 predicate functions include @code{gnus-thread-sort-by-number},
7317 @code{gnus-thread-sort-by-author}, @code{gnus-thread-sort-by-recipient},
7318 @code{gnus-thread-sort-by-subject},
7319 @code{gnus-thread-sort-by-date},
7320 @code{gnus-thread-sort-by-score},
7321 @code{gnus-thread-sort-by-most-recent-number},
7322 @code{gnus-thread-sort-by-most-recent-date},
7323 @code{gnus-thread-sort-by-random} and
7324 @code{gnus-thread-sort-by-total-score}.
7326 Each function takes two threads and returns non-@code{nil} if the first
7327 thread should be sorted before the other. Note that sorting really is
7328 normally done by looking only at the roots of each thread.
7330 If you use more than one function, the primary sort key should be the
7331 last function in the list. You should probably always include
7332 @code{gnus-thread-sort-by-number} in the list of sorting
7333 functions---preferably first. This will ensure that threads that are
7334 equal with respect to the other sort criteria will be displayed in
7335 ascending article order.
7337 If you would like to sort by reverse score, then by subject, and finally
7338 by number, you could do something like:
7341 (setq gnus-thread-sort-functions
7342 '(gnus-thread-sort-by-number
7343 gnus-thread-sort-by-subject
7344 (not gnus-thread-sort-by-total-score)))
7347 The threads that have highest score will be displayed first in the
7348 summary buffer. When threads have the same score, they will be sorted
7349 alphabetically. The threads that have the same score and the same
7350 subject will be sorted by number, which is (normally) the sequence in
7351 which the articles arrived.
7353 If you want to sort by score and then reverse arrival order, you could
7357 (setq gnus-thread-sort-functions
7358 '((not gnus-thread-sort-by-number)
7359 gnus-thread-sort-by-score))
7362 @vindex gnus-thread-score-function
7363 The function in the @code{gnus-thread-score-function} variable (default
7364 @code{+}) is used for calculating the total score of a thread. Useful
7365 functions might be @code{max}, @code{min}, or squared means, or whatever
7368 @findex gnus-article-sort-functions
7369 @findex gnus-article-sort-by-date
7370 @findex gnus-article-sort-by-score
7371 @findex gnus-article-sort-by-subject
7372 @findex gnus-article-sort-by-author
7373 @findex gnus-article-sort-by-random
7374 @findex gnus-article-sort-by-number
7375 If you are using an unthreaded display for some strange reason or
7376 other, you have to fiddle with the @code{gnus-article-sort-functions}
7377 variable. It is very similar to the
7378 @code{gnus-thread-sort-functions}, except that it uses slightly
7379 different functions for article comparison. Available sorting
7380 predicate functions are @code{gnus-article-sort-by-number},
7381 @code{gnus-article-sort-by-author},
7382 @code{gnus-article-sort-by-subject}, @code{gnus-article-sort-by-date},
7383 @code{gnus-article-sort-by-random}, and
7384 @code{gnus-article-sort-by-score}.
7386 If you want to sort an unthreaded summary display by subject, you could
7390 (setq gnus-article-sort-functions
7391 '(gnus-article-sort-by-number
7392 gnus-article-sort-by-subject))
7395 You can define group specific sorting via @code{gnus-parameters},
7396 @xref{Group Parameters}.
7399 @node Asynchronous Fetching
7400 @section Asynchronous Article Fetching
7401 @cindex asynchronous article fetching
7402 @cindex article pre-fetch
7405 If you read your news from an @acronym{NNTP} server that's far away, the
7406 network latencies may make reading articles a chore. You have to wait
7407 for a while after pressing @kbd{n} to go to the next article before the
7408 article appears. Why can't Gnus just go ahead and fetch the article
7409 while you are reading the previous one? Why not, indeed.
7411 First, some caveats. There are some pitfalls to using asynchronous
7412 article fetching, especially the way Gnus does it.
7414 Let's say you are reading article 1, which is short, and article 2 is
7415 quite long, and you are not interested in reading that. Gnus does not
7416 know this, so it goes ahead and fetches article 2. You decide to read
7417 article 3, but since Gnus is in the process of fetching article 2, the
7418 connection is blocked.
7420 To avoid these situations, Gnus will open two (count 'em two)
7421 connections to the server. Some people may think this isn't a very nice
7422 thing to do, but I don't see any real alternatives. Setting up that
7423 extra connection takes some time, so Gnus startup will be slower.
7425 Gnus will fetch more articles than you will read. This will mean that
7426 the link between your machine and the @acronym{NNTP} server will become more
7427 loaded than if you didn't use article pre-fetch. The server itself will
7428 also become more loaded---both with the extra article requests, and the
7431 Ok, so now you know that you shouldn't really use this thing@dots{} unless
7434 @vindex gnus-asynchronous
7435 Here's how: Set @code{gnus-asynchronous} to @code{t}. The rest should
7436 happen automatically.
7438 @vindex gnus-use-article-prefetch
7439 You can control how many articles are to be pre-fetched by setting
7440 @code{gnus-use-article-prefetch}. This is 30 by default, which means
7441 that when you read an article in the group, the back end will pre-fetch
7442 the next 30 articles. If this variable is @code{t}, the back end will
7443 pre-fetch all the articles it can without bound. If it is
7444 @code{nil}, no pre-fetching will be done.
7446 @vindex gnus-async-prefetch-article-p
7447 @findex gnus-async-unread-p
7448 There are probably some articles that you don't want to pre-fetch---read
7449 articles, for instance. The @code{gnus-async-prefetch-article-p}
7450 variable controls whether an article is to be pre-fetched. This
7451 function should return non-@code{nil} when the article in question is
7452 to be pre-fetched. The default is @code{gnus-async-unread-p}, which
7453 returns @code{nil} on read articles. The function is called with an
7454 article data structure as the only parameter.
7456 If, for instance, you wish to pre-fetch only unread articles shorter
7457 than 100 lines, you could say something like:
7460 (defun my-async-short-unread-p (data)
7461 "Return non-nil for short, unread articles."
7462 (and (gnus-data-unread-p data)
7463 (< (mail-header-lines (gnus-data-header data))
7466 (setq gnus-async-prefetch-article-p 'my-async-short-unread-p)
7469 These functions will be called many, many times, so they should
7470 preferably be short and sweet to avoid slowing down Gnus too much.
7471 It's probably a good idea to byte-compile things like this.
7473 @vindex gnus-prefetched-article-deletion-strategy
7474 Articles have to be removed from the asynch buffer sooner or later. The
7475 @code{gnus-prefetched-article-deletion-strategy} says when to remove
7476 articles. This is a list that may contain the following elements:
7480 Remove articles when they are read.
7483 Remove articles when exiting the group.
7486 The default value is @code{(read exit)}.
7488 @c @vindex gnus-use-header-prefetch
7489 @c If @code{gnus-use-header-prefetch} is non-@code{nil}, prefetch articles
7490 @c from the next group.
7493 @node Article Caching
7494 @section Article Caching
7495 @cindex article caching
7498 If you have an @emph{extremely} slow @acronym{NNTP} connection, you may
7499 consider turning article caching on. Each article will then be stored
7500 locally under your home directory. As you may surmise, this could
7501 potentially use @emph{huge} amounts of disk space, as well as eat up all
7502 your inodes so fast it will make your head swim. In vodka.
7504 Used carefully, though, it could be just an easier way to save articles.
7506 @vindex gnus-use-long-file-name
7507 @vindex gnus-cache-directory
7508 @vindex gnus-use-cache
7509 To turn caching on, set @code{gnus-use-cache} to @code{t}. By default,
7510 all articles ticked or marked as dormant will then be copied
7511 over to your local cache (@code{gnus-cache-directory}). Whether this
7512 cache is flat or hierarchical is controlled by the
7513 @code{gnus-use-long-file-name} variable, as usual.
7515 When re-selecting a ticked or dormant article, it will be fetched from the
7516 cache instead of from the server. As articles in your cache will never
7517 expire, this might serve as a method of saving articles while still
7518 keeping them where they belong. Just mark all articles you want to save
7519 as dormant, and don't worry.
7521 When an article is marked as read, is it removed from the cache.
7523 @vindex gnus-cache-remove-articles
7524 @vindex gnus-cache-enter-articles
7525 The entering/removal of articles from the cache is controlled by the
7526 @code{gnus-cache-enter-articles} and @code{gnus-cache-remove-articles}
7527 variables. Both are lists of symbols. The first is @code{(ticked
7528 dormant)} by default, meaning that ticked and dormant articles will be
7529 put in the cache. The latter is @code{(read)} by default, meaning that
7530 articles marked as read are removed from the cache. Possibly
7531 symbols in these two lists are @code{ticked}, @code{dormant},
7532 @code{unread} and @code{read}.
7534 @findex gnus-jog-cache
7535 So where does the massive article-fetching and storing come into the
7536 picture? The @code{gnus-jog-cache} command will go through all
7537 subscribed newsgroups, request all unread articles, score them, and
7538 store them in the cache. You should only ever, ever ever ever, use this
7539 command if 1) your connection to the @acronym{NNTP} server is really, really,
7540 really slow and 2) you have a really, really, really huge disk.
7541 Seriously. One way to cut down on the number of articles downloaded is
7542 to score unwanted articles down and have them marked as read. They will
7543 not then be downloaded by this command.
7545 @vindex gnus-uncacheable-groups
7546 @vindex gnus-cacheable-groups
7547 It is likely that you do not want caching on all groups. For instance,
7548 if your @code{nnml} mail is located under your home directory, it makes no
7549 sense to cache it somewhere else under your home directory. Unless you
7550 feel that it's neat to use twice as much space.
7552 To limit the caching, you could set @code{gnus-cacheable-groups} to a
7553 regexp of groups to cache, @samp{^nntp} for instance, or set the
7554 @code{gnus-uncacheable-groups} regexp to @samp{^nnml}, for instance.
7555 Both variables are @code{nil} by default. If a group matches both
7556 variables, the group is not cached.
7558 @findex gnus-cache-generate-nov-databases
7559 @findex gnus-cache-generate-active
7560 @vindex gnus-cache-active-file
7561 The cache stores information on what articles it contains in its active
7562 file (@code{gnus-cache-active-file}). If this file (or any other parts
7563 of the cache) becomes all messed up for some reason or other, Gnus
7564 offers two functions that will try to set things right. @kbd{M-x
7565 gnus-cache-generate-nov-databases} will (re)build all the @acronym{NOV}
7566 files, and @kbd{gnus-cache-generate-active} will (re)generate the active
7569 @findex gnus-cache-move-cache
7570 @code{gnus-cache-move-cache} will move your whole
7571 @code{gnus-cache-directory} to some other location. You get asked to
7572 where, isn't that cool?
7574 @node Persistent Articles
7575 @section Persistent Articles
7576 @cindex persistent articles
7578 Closely related to article caching, we have @dfn{persistent articles}.
7579 In fact, it's just a different way of looking at caching, and much more
7580 useful in my opinion.
7582 Say you're reading a newsgroup, and you happen on to some valuable gem
7583 that you want to keep and treasure forever. You'd normally just save it
7584 (using one of the many saving commands) in some file. The problem with
7585 that is that it's just, well, yucky. Ideally you'd prefer just having
7586 the article remain in the group where you found it forever; untouched by
7587 the expiry going on at the news server.
7589 This is what a @dfn{persistent article} is---an article that just won't
7590 be deleted. It's implemented using the normal cache functions, but
7591 you use two explicit commands for managing persistent articles:
7597 @findex gnus-cache-enter-article
7598 Make the current article persistent (@code{gnus-cache-enter-article}).
7601 @kindex M-* (Summary)
7602 @findex gnus-cache-remove-article
7603 Remove the current article from the persistent articles
7604 (@code{gnus-cache-remove-article}). This will normally delete the
7608 Both these commands understand the process/prefix convention.
7610 To avoid having all ticked articles (and stuff) entered into the cache,
7611 you should set @code{gnus-use-cache} to @code{passive} if you're just
7612 interested in persistent articles:
7615 (setq gnus-use-cache 'passive)
7618 @node Sticky Articles
7619 @section Sticky Articles
7620 @cindex sticky articles
7622 When you select an article the current article buffer will be reused
7623 according to the value of the variable
7624 @code{gnus-single-article-buffer}. If its value is non-@code{nil} (the
7625 default) all articles reuse the same article buffer. Else each group
7626 has its own article buffer.
7628 This implies that it's not possible to have more than one article buffer
7629 in a group at a time. But sometimes you might want to display all the
7630 latest emails from your mother, your father, your aunt, your uncle and
7631 your 17 cousins to coordinate the next christmas party.
7633 That's where sticky articles come in handy. A sticky article buffer
7634 basically is a normal article buffer, but it won't be reused when you
7635 select another article. You can make an article sticky with:
7639 @kindex A S (Summary)
7640 @findex gnus-sticky-article
7641 Make the current article sticky. If a prefix arg is given, ask for a
7642 name for this sticky article buffer.
7645 To close a sticky article buffer you can use these commands:
7651 Puts this sticky article buffer at the end of the list of all buffers.
7655 @findex gnus-kill-sticky-article-buffer
7656 Kills this sticky article buffer.
7659 To kill all sticky article buffers you can use:
7661 @defun gnus-kill-sticky-article-buffers ARG
7662 Kill all sticky article buffers.
7663 If a prefix ARG is given, ask for confirmation.
7666 @node Article Backlog
7667 @section Article Backlog
7669 @cindex article backlog
7671 If you have a slow connection, but the idea of using caching seems
7672 unappealing to you (and it is, really), you can help the situation some
7673 by switching on the @dfn{backlog}. This is where Gnus will buffer
7674 already read articles so that it doesn't have to re-fetch articles
7675 you've already read. This only helps if you are in the habit of
7676 re-selecting articles you've recently read, of course. If you never do
7677 that, turning the backlog on will slow Gnus down a little bit, and
7678 increase memory usage some.
7680 @vindex gnus-keep-backlog
7681 If you set @code{gnus-keep-backlog} to a number @var{n}, Gnus will store
7682 at most @var{n} old articles in a buffer for later re-fetching. If this
7683 variable is non-@code{nil} and is not a number, Gnus will store
7684 @emph{all} read articles, which means that your Emacs will grow without
7685 bound before exploding and taking your machine down with you. I put
7686 that in there just to keep y'all on your toes.
7688 The default value is 20.
7691 @node Saving Articles
7692 @section Saving Articles
7693 @cindex saving articles
7695 Gnus can save articles in a number of ways. Below is the documentation
7696 for saving articles in a fairly straight-forward fashion (i.e., little
7697 processing of the article is done before it is saved). For a different
7698 approach (uudecoding, unsharing) you should use @code{gnus-uu}
7699 (@pxref{Decoding Articles}).
7701 For the commands listed here, the target is a file. If you want to
7702 save to a group, see the @kbd{B c} (@code{gnus-summary-copy-article})
7703 command (@pxref{Mail Group Commands}).
7705 @vindex gnus-save-all-headers
7706 If @code{gnus-save-all-headers} is non-@code{nil}, Gnus will not delete
7707 unwanted headers before saving the article.
7709 @vindex gnus-saved-headers
7710 If the preceding variable is @code{nil}, all headers that match the
7711 @code{gnus-saved-headers} regexp will be kept, while the rest will be
7712 deleted before saving.
7718 @kindex O o (Summary)
7720 @findex gnus-summary-save-article
7721 @c @icon{gnus-summary-save-article}
7722 Save the current article using the default article saver
7723 (@code{gnus-summary-save-article}).
7726 @kindex O m (Summary)
7727 @findex gnus-summary-save-article-mail
7728 Save the current article in a Unix mail box (mbox) file
7729 (@code{gnus-summary-save-article-mail}).
7732 @kindex O r (Summary)
7733 @findex gnus-summary-save-article-rmail
7734 Save the current article in Rmail format
7735 (@code{gnus-summary-save-article-rmail}).
7738 @kindex O f (Summary)
7739 @findex gnus-summary-save-article-file
7740 @c @icon{gnus-summary-save-article-file}
7741 Save the current article in plain file format
7742 (@code{gnus-summary-save-article-file}).
7745 @kindex O F (Summary)
7746 @findex gnus-summary-write-article-file
7747 Write the current article in plain file format, overwriting any previous
7748 file contents (@code{gnus-summary-write-article-file}).
7751 @kindex O b (Summary)
7752 @findex gnus-summary-save-article-body-file
7753 Save the current article body in plain file format
7754 (@code{gnus-summary-save-article-body-file}).
7757 @kindex O h (Summary)
7758 @findex gnus-summary-save-article-folder
7759 Save the current article in mh folder format
7760 (@code{gnus-summary-save-article-folder}).
7763 @kindex O v (Summary)
7764 @findex gnus-summary-save-article-vm
7765 Save the current article in a VM folder
7766 (@code{gnus-summary-save-article-vm}).
7770 @kindex O p (Summary)
7772 @findex gnus-summary-pipe-output
7773 Save the current article in a pipe. Uhm, like, what I mean is---Pipe
7774 the current article to a process (@code{gnus-summary-pipe-output}).
7775 If given a symbolic prefix (@pxref{Symbolic Prefixes}), include the
7776 complete headers in the piped output.
7779 @kindex O P (Summary)
7780 @findex gnus-summary-muttprint
7781 @vindex gnus-summary-muttprint-program
7782 Save the current article into muttprint. That is, print it using the
7783 external program @uref{http://muttprint.sourceforge.net/,
7784 Muttprint}. The program name and options to use is controlled by the
7785 variable @code{gnus-summary-muttprint-program}.
7786 (@code{gnus-summary-muttprint}).
7790 @vindex gnus-prompt-before-saving
7791 All these commands use the process/prefix convention
7792 (@pxref{Process/Prefix}). If you save bunches of articles using these
7793 functions, you might get tired of being prompted for files to save each
7794 and every article in. The prompting action is controlled by
7795 the @code{gnus-prompt-before-saving} variable, which is @code{always} by
7796 default, giving you that excessive prompting action you know and
7797 loathe. If you set this variable to @code{t} instead, you'll be prompted
7798 just once for each series of articles you save. If you like to really
7799 have Gnus do all your thinking for you, you can even set this variable
7800 to @code{nil}, which means that you will never be prompted for files to
7801 save articles in. Gnus will simply save all the articles in the default
7805 @vindex gnus-default-article-saver
7806 You can customize the @code{gnus-default-article-saver} variable to make
7807 Gnus do what you want it to. You can use any of the eight ready-made
7808 functions below, or you can create your own.
7812 @item gnus-summary-save-in-rmail
7813 @findex gnus-summary-save-in-rmail
7814 @vindex gnus-rmail-save-name
7815 @findex gnus-plain-save-name
7816 This is the default format, @dfn{Babyl}. Uses the function in the
7817 @code{gnus-rmail-save-name} variable to get a file name to save the
7818 article in. The default is @code{gnus-plain-save-name}.
7820 @item gnus-summary-save-in-mail
7821 @findex gnus-summary-save-in-mail
7822 @vindex gnus-mail-save-name
7823 Save in a Unix mail (mbox) file. Uses the function in the
7824 @code{gnus-mail-save-name} variable to get a file name to save the
7825 article in. The default is @code{gnus-plain-save-name}.
7827 @item gnus-summary-save-in-file
7828 @findex gnus-summary-save-in-file
7829 @vindex gnus-file-save-name
7830 @findex gnus-numeric-save-name
7831 Append the article straight to an ordinary file. Uses the function in
7832 the @code{gnus-file-save-name} variable to get a file name to save the
7833 article in. The default is @code{gnus-numeric-save-name}.
7835 @item gnus-summary-write-to-file
7836 @findex gnus-summary-write-to-file
7837 Write the article straight to an ordinary file. The file is
7838 overwritten if it exists. Uses the function in the
7839 @code{gnus-file-save-name} variable to get a file name to save the
7840 article in. The default is @code{gnus-numeric-save-name}.
7842 @item gnus-summary-save-body-in-file
7843 @findex gnus-summary-save-body-in-file
7844 Append the article body to an ordinary file. Uses the function in the
7845 @code{gnus-file-save-name} variable to get a file name to save the
7846 article in. The default is @code{gnus-numeric-save-name}.
7848 @item gnus-summary-write-body-to-file
7849 @findex gnus-summary-write-body-to-file
7850 Write the article body straight to an ordinary file. The file is
7851 overwritten if it exists. Uses the function in the
7852 @code{gnus-file-save-name} variable to get a file name to save the
7853 article in. The default is @code{gnus-numeric-save-name}.
7855 @item gnus-summary-save-in-folder
7856 @findex gnus-summary-save-in-folder
7857 @findex gnus-folder-save-name
7858 @findex gnus-Folder-save-name
7859 @vindex gnus-folder-save-name
7862 Save the article to an MH folder using @code{rcvstore} from the MH
7863 library. Uses the function in the @code{gnus-folder-save-name} variable
7864 to get a file name to save the article in. The default is
7865 @code{gnus-folder-save-name}, but you can also use
7866 @code{gnus-Folder-save-name}, which creates capitalized names.
7868 @item gnus-summary-save-in-vm
7869 @findex gnus-summary-save-in-vm
7870 Save the article in a VM folder. You have to have the VM mail
7871 reader to use this setting.
7874 The symbol of each function may have the following properties:
7878 The value non-@code{nil} means save decoded articles. This is
7879 meaningful only with @code{gnus-summary-save-in-file},
7880 @code{gnus-summary-save-body-in-file},
7881 @code{gnus-summary-write-to-file}, and
7882 @code{gnus-summary-write-body-to-file}.
7885 The value specifies an alternative function which appends, not
7886 overwrites, articles to a file. This implies that when saving many
7887 articles at a time, @code{gnus-prompt-before-saving} is bound to
7888 @code{t} and all articles are saved in a single file. This is
7889 meaningful only with @code{gnus-summary-write-to-file} and
7890 @code{gnus-summary-write-body-to-file}.
7893 The value specifies the symbol of a variable of which the value
7894 specifies headers to be saved. If it is omitted,
7895 @code{gnus-save-all-headers} and @code{gnus-saved-headers} control what
7896 headers should be saved.
7899 @vindex gnus-article-save-directory
7900 All of these functions, except for the last one, will save the article
7901 in the @code{gnus-article-save-directory}, which is initialized from the
7902 @env{SAVEDIR} environment variable. This is @file{~/News/} by
7905 As you can see above, the functions use different functions to find a
7906 suitable name of a file to save the article in. Below is a list of
7907 available functions that generate names:
7911 @item gnus-Numeric-save-name
7912 @findex gnus-Numeric-save-name
7913 File names like @file{~/News/Alt.andrea-dworkin/45}.
7915 @item gnus-numeric-save-name
7916 @findex gnus-numeric-save-name
7917 File names like @file{~/News/alt.andrea-dworkin/45}.
7919 @item gnus-Plain-save-name
7920 @findex gnus-Plain-save-name
7921 File names like @file{~/News/Alt.andrea-dworkin}.
7923 @item gnus-plain-save-name
7924 @findex gnus-plain-save-name
7925 File names like @file{~/News/alt.andrea-dworkin}.
7927 @item gnus-sender-save-name
7928 @findex gnus-sender-save-name
7929 File names like @file{~/News/larsi}.
7932 @vindex gnus-split-methods
7933 You can have Gnus suggest where to save articles by plonking a regexp into
7934 the @code{gnus-split-methods} alist. For instance, if you would like to
7935 save articles related to Gnus in the file @file{gnus-stuff}, and articles
7936 related to VM in @file{vm-stuff}, you could set this variable to something
7940 (("^Subject:.*gnus\\|^Newsgroups:.*gnus" "gnus-stuff")
7941 ("^Subject:.*vm\\|^Xref:.*vm" "vm-stuff")
7942 (my-choosing-function "../other-dir/my-stuff")
7943 ((equal gnus-newsgroup-name "mail.misc") "mail-stuff"))
7946 We see that this is a list where each element is a list that has two
7947 elements---the @dfn{match} and the @dfn{file}. The match can either be
7948 a string (in which case it is used as a regexp to match on the article
7949 head); it can be a symbol (which will be called as a function with the
7950 group name as a parameter); or it can be a list (which will be
7951 @code{eval}ed). If any of these actions have a non-@code{nil} result,
7952 the @dfn{file} will be used as a default prompt. In addition, the
7953 result of the operation itself will be used if the function or form
7954 called returns a string or a list of strings.
7956 You basically end up with a list of file names that might be used when
7957 saving the current article. (All ``matches'' will be used.) You will
7958 then be prompted for what you really want to use as a name, with file
7959 name completion over the results from applying this variable.
7961 This variable is @code{((gnus-article-archive-name))} by default, which
7962 means that Gnus will look at the articles it saves for an
7963 @code{Archive-name} line and use that as a suggestion for the file
7966 Here's an example function to clean up file names somewhat. If you have
7967 lots of mail groups called things like
7968 @samp{nnml:mail.whatever}, you may want to chop off the beginning of
7969 these group names before creating the file name to save to. The
7970 following will do just that:
7973 (defun my-save-name (group)
7974 (when (string-match "^nnml:mail." group)
7975 (substring group (match-end 0))))
7977 (setq gnus-split-methods
7978 '((gnus-article-archive-name)
7983 @vindex gnus-use-long-file-name
7984 Finally, you have the @code{gnus-use-long-file-name} variable. If it is
7985 @code{nil}, all the preceding functions will replace all periods
7986 (@samp{.}) in the group names with slashes (@samp{/})---which means that
7987 the functions will generate hierarchies of directories instead of having
7988 all the files in the top level directory
7989 (@file{~/News/alt/andrea-dworkin} instead of
7990 @file{~/News/alt.andrea-dworkin}.) This variable is @code{t} by default
7991 on most systems. However, for historical reasons, this is @code{nil} on
7992 Xenix and usg-unix-v machines by default.
7994 This function also affects kill and score file names. If this variable
7995 is a list, and the list contains the element @code{not-score}, long file
7996 names will not be used for score files, if it contains the element
7997 @code{not-save}, long file names will not be used for saving, and if it
7998 contains the element @code{not-kill}, long file names will not be used
8001 If you'd like to save articles in a hierarchy that looks something like
8005 (setq gnus-use-long-file-name '(not-save)) ; @r{to get a hierarchy}
8006 (setq gnus-default-article-saver
8007 'gnus-summary-save-in-file) ; @r{no encoding}
8010 Then just save with @kbd{o}. You'd then read this hierarchy with
8011 ephemeral @code{nneething} groups---@kbd{G D} in the group buffer, and
8012 the top level directory as the argument (@file{~/News/}). Then just walk
8013 around to the groups/directories with @code{nneething}.
8016 @node Decoding Articles
8017 @section Decoding Articles
8018 @cindex decoding articles
8020 Sometime users post articles (or series of articles) that have been
8021 encoded in some way or other. Gnus can decode them for you.
8024 * Uuencoded Articles:: Uudecode articles.
8025 * Shell Archives:: Unshar articles.
8026 * PostScript Files:: Split PostScript.
8027 * Other Files:: Plain save and binhex.
8028 * Decoding Variables:: Variables for a happy decoding.
8029 * Viewing Files:: You want to look at the result of the decoding?
8033 @cindex article series
8034 All these functions use the process/prefix convention
8035 (@pxref{Process/Prefix}) for finding out what articles to work on, with
8036 the extension that a ``single article'' means ``a single series''. Gnus
8037 can find out by itself what articles belong to a series, decode all the
8038 articles and unpack/view/save the resulting file(s).
8040 Gnus guesses what articles are in the series according to the following
8041 simplish rule: The subjects must be (nearly) identical, except for the
8042 last two numbers of the line. (Spaces are largely ignored, however.)
8044 For example: If you choose a subject called @samp{cat.gif (2/3)}, Gnus
8045 will find all the articles that match the regexp @samp{^cat.gif
8046 ([0-9]+/[0-9]+).*$}.
8048 Subjects that are non-standard, like @samp{cat.gif (2/3) Part 6 of a
8049 series}, will not be properly recognized by any of the automatic viewing
8050 commands, and you have to mark the articles manually with @kbd{#}.
8053 @node Uuencoded Articles
8054 @subsection Uuencoded Articles
8056 @cindex uuencoded articles
8061 @kindex X u (Summary)
8062 @findex gnus-uu-decode-uu
8063 @c @icon{gnus-uu-decode-uu}
8064 Uudecodes the current series (@code{gnus-uu-decode-uu}).
8067 @kindex X U (Summary)
8068 @findex gnus-uu-decode-uu-and-save
8069 Uudecodes and saves the current series
8070 (@code{gnus-uu-decode-uu-and-save}).
8073 @kindex X v u (Summary)
8074 @findex gnus-uu-decode-uu-view
8075 Uudecodes and views the current series (@code{gnus-uu-decode-uu-view}).
8078 @kindex X v U (Summary)
8079 @findex gnus-uu-decode-uu-and-save-view
8080 Uudecodes, views and saves the current series
8081 (@code{gnus-uu-decode-uu-and-save-view}).
8085 Remember that these all react to the presence of articles marked with
8086 the process mark. If, for instance, you'd like to decode and save an
8087 entire newsgroup, you'd typically do @kbd{M P a}
8088 (@code{gnus-uu-mark-all}) and then @kbd{X U}
8089 (@code{gnus-uu-decode-uu-and-save}).
8091 All this is very much different from how @code{gnus-uu} worked with
8092 @sc{gnus 4.1}, where you had explicit keystrokes for everything under
8093 the sun. This version of @code{gnus-uu} generally assumes that you mark
8094 articles in some way (@pxref{Setting Process Marks}) and then press
8097 @vindex gnus-uu-notify-files
8098 Note: When trying to decode articles that have names matching
8099 @code{gnus-uu-notify-files}, which is hard-coded to
8100 @samp{[Cc][Ii][Nn][Dd][Yy][0-9]+.\\(gif\\|jpg\\)}, @code{gnus-uu} will
8101 automatically post an article on @samp{comp.unix.wizards} saying that
8102 you have just viewed the file in question. This feature can't be turned
8106 @node Shell Archives
8107 @subsection Shell Archives
8109 @cindex shell archives
8110 @cindex shared articles
8112 Shell archives (``shar files'') used to be a popular way to distribute
8113 sources, but it isn't used all that much today. In any case, we have
8114 some commands to deal with these:
8119 @kindex X s (Summary)
8120 @findex gnus-uu-decode-unshar
8121 Unshars the current series (@code{gnus-uu-decode-unshar}).
8124 @kindex X S (Summary)
8125 @findex gnus-uu-decode-unshar-and-save
8126 Unshars and saves the current series (@code{gnus-uu-decode-unshar-and-save}).
8129 @kindex X v s (Summary)
8130 @findex gnus-uu-decode-unshar-view
8131 Unshars and views the current series (@code{gnus-uu-decode-unshar-view}).
8134 @kindex X v S (Summary)
8135 @findex gnus-uu-decode-unshar-and-save-view
8136 Unshars, views and saves the current series
8137 (@code{gnus-uu-decode-unshar-and-save-view}).
8141 @node PostScript Files
8142 @subsection PostScript Files
8148 @kindex X p (Summary)
8149 @findex gnus-uu-decode-postscript
8150 Unpack the current PostScript series (@code{gnus-uu-decode-postscript}).
8153 @kindex X P (Summary)
8154 @findex gnus-uu-decode-postscript-and-save
8155 Unpack and save the current PostScript series
8156 (@code{gnus-uu-decode-postscript-and-save}).
8159 @kindex X v p (Summary)
8160 @findex gnus-uu-decode-postscript-view
8161 View the current PostScript series
8162 (@code{gnus-uu-decode-postscript-view}).
8165 @kindex X v P (Summary)
8166 @findex gnus-uu-decode-postscript-and-save-view
8167 View and save the current PostScript series
8168 (@code{gnus-uu-decode-postscript-and-save-view}).
8173 @subsection Other Files
8177 @kindex X o (Summary)
8178 @findex gnus-uu-decode-save
8179 Save the current series
8180 (@code{gnus-uu-decode-save}).
8183 @kindex X b (Summary)
8184 @findex gnus-uu-decode-binhex
8185 Unbinhex the current series (@code{gnus-uu-decode-binhex}). This
8186 doesn't really work yet.
8189 @kindex X Y (Summary)
8190 @findex gnus-uu-decode-yenc
8191 yEnc-decode the current series and save it (@code{gnus-uu-decode-yenc}).
8195 @node Decoding Variables
8196 @subsection Decoding Variables
8198 Adjective, not verb.
8201 * Rule Variables:: Variables that say how a file is to be viewed.
8202 * Other Decode Variables:: Other decode variables.
8203 * Uuencoding and Posting:: Variables for customizing uuencoding.
8207 @node Rule Variables
8208 @subsubsection Rule Variables
8209 @cindex rule variables
8211 Gnus uses @dfn{rule variables} to decide how to view a file. All these
8212 variables are of the form
8215 (list '(regexp1 command2)
8222 @item gnus-uu-user-view-rules
8223 @vindex gnus-uu-user-view-rules
8225 This variable is consulted first when viewing files. If you wish to use,
8226 for instance, @code{sox} to convert an @file{.au} sound file, you could
8229 (setq gnus-uu-user-view-rules
8230 (list '("\\\\.au$" "sox %s -t .aiff > /dev/audio")))
8233 @item gnus-uu-user-view-rules-end
8234 @vindex gnus-uu-user-view-rules-end
8235 This variable is consulted if Gnus couldn't make any matches from the
8236 user and default view rules.
8238 @item gnus-uu-user-archive-rules
8239 @vindex gnus-uu-user-archive-rules
8240 This variable can be used to say what commands should be used to unpack
8245 @node Other Decode Variables
8246 @subsubsection Other Decode Variables
8249 @vindex gnus-uu-grabbed-file-functions
8251 @item gnus-uu-grabbed-file-functions
8252 All functions in this list will be called right after each file has been
8253 successfully decoded---so that you can move or view files right away,
8254 and don't have to wait for all files to be decoded before you can do
8255 anything. Ready-made functions you can put in this list are:
8259 @item gnus-uu-grab-view
8260 @findex gnus-uu-grab-view
8263 @item gnus-uu-grab-move
8264 @findex gnus-uu-grab-move
8265 Move the file (if you're using a saving function.)
8268 @item gnus-uu-be-dangerous
8269 @vindex gnus-uu-be-dangerous
8270 Specifies what to do if unusual situations arise during decoding. If
8271 @code{nil}, be as conservative as possible. If @code{t}, ignore things
8272 that didn't work, and overwrite existing files. Otherwise, ask each
8275 @item gnus-uu-ignore-files-by-name
8276 @vindex gnus-uu-ignore-files-by-name
8277 Files with name matching this regular expression won't be viewed.
8279 @item gnus-uu-ignore-files-by-type
8280 @vindex gnus-uu-ignore-files-by-type
8281 Files with a @acronym{MIME} type matching this variable won't be viewed.
8282 Note that Gnus tries to guess what type the file is based on the name.
8283 @code{gnus-uu} is not a @acronym{MIME} package (yet), so this is slightly
8286 @item gnus-uu-tmp-dir
8287 @vindex gnus-uu-tmp-dir
8288 Where @code{gnus-uu} does its work.
8290 @item gnus-uu-do-not-unpack-archives
8291 @vindex gnus-uu-do-not-unpack-archives
8292 Non-@code{nil} means that @code{gnus-uu} won't peek inside archives
8293 looking for files to display.
8295 @item gnus-uu-view-and-save
8296 @vindex gnus-uu-view-and-save
8297 Non-@code{nil} means that the user will always be asked to save a file
8300 @item gnus-uu-ignore-default-view-rules
8301 @vindex gnus-uu-ignore-default-view-rules
8302 Non-@code{nil} means that @code{gnus-uu} will ignore the default viewing
8305 @item gnus-uu-ignore-default-archive-rules
8306 @vindex gnus-uu-ignore-default-archive-rules
8307 Non-@code{nil} means that @code{gnus-uu} will ignore the default archive
8310 @item gnus-uu-kill-carriage-return
8311 @vindex gnus-uu-kill-carriage-return
8312 Non-@code{nil} means that @code{gnus-uu} will strip all carriage returns
8315 @item gnus-uu-unmark-articles-not-decoded
8316 @vindex gnus-uu-unmark-articles-not-decoded
8317 Non-@code{nil} means that @code{gnus-uu} will mark unsuccessfully
8318 decoded articles as unread.
8320 @item gnus-uu-correct-stripped-uucode
8321 @vindex gnus-uu-correct-stripped-uucode
8322 Non-@code{nil} means that @code{gnus-uu} will @emph{try} to fix
8323 uuencoded files that have had trailing spaces deleted.
8325 @item gnus-uu-pre-uudecode-hook
8326 @vindex gnus-uu-pre-uudecode-hook
8327 Hook run before sending a message to @code{uudecode}.
8329 @item gnus-uu-view-with-metamail
8330 @vindex gnus-uu-view-with-metamail
8332 Non-@code{nil} means that @code{gnus-uu} will ignore the viewing
8333 commands defined by the rule variables and just fudge a @acronym{MIME}
8334 content type based on the file name. The result will be fed to
8335 @code{metamail} for viewing.
8337 @item gnus-uu-save-in-digest
8338 @vindex gnus-uu-save-in-digest
8339 Non-@code{nil} means that @code{gnus-uu}, when asked to save without
8340 decoding, will save in digests. If this variable is @code{nil},
8341 @code{gnus-uu} will just save everything in a file without any
8342 embellishments. The digesting almost conforms to RFC 1153---no easy way
8343 to specify any meaningful volume and issue numbers were found, so I
8344 simply dropped them.
8349 @node Uuencoding and Posting
8350 @subsubsection Uuencoding and Posting
8354 @item gnus-uu-post-include-before-composing
8355 @vindex gnus-uu-post-include-before-composing
8356 Non-@code{nil} means that @code{gnus-uu} will ask for a file to encode
8357 before you compose the article. If this variable is @code{t}, you can
8358 either include an encoded file with @kbd{C-c C-i} or have one included
8359 for you when you post the article.
8361 @item gnus-uu-post-length
8362 @vindex gnus-uu-post-length
8363 Maximum length of an article. The encoded file will be split into how
8364 many articles it takes to post the entire file.
8366 @item gnus-uu-post-threaded
8367 @vindex gnus-uu-post-threaded
8368 Non-@code{nil} means that @code{gnus-uu} will post the encoded file in a
8369 thread. This may not be smart, as no other decoder I have seen is able
8370 to follow threads when collecting uuencoded articles. (Well, I have
8371 seen one package that does that---@code{gnus-uu}, but somehow, I don't
8372 think that counts@dots{}) Default is @code{nil}.
8374 @item gnus-uu-post-separate-description
8375 @vindex gnus-uu-post-separate-description
8376 Non-@code{nil} means that the description will be posted in a separate
8377 article. The first article will typically be numbered (0/x). If this
8378 variable is @code{nil}, the description the user enters will be included
8379 at the beginning of the first article, which will be numbered (1/x).
8380 Default is @code{t}.
8386 @subsection Viewing Files
8387 @cindex viewing files
8388 @cindex pseudo-articles
8390 After decoding, if the file is some sort of archive, Gnus will attempt
8391 to unpack the archive and see if any of the files in the archive can be
8392 viewed. For instance, if you have a gzipped tar file @file{pics.tar.gz}
8393 containing the files @file{pic1.jpg} and @file{pic2.gif}, Gnus will
8394 uncompress and de-tar the main file, and then view the two pictures.
8395 This unpacking process is recursive, so if the archive contains archives
8396 of archives, it'll all be unpacked.
8398 Finally, Gnus will normally insert a @dfn{pseudo-article} for each
8399 extracted file into the summary buffer. If you go to these
8400 ``articles'', you will be prompted for a command to run (usually Gnus
8401 will make a suggestion), and then the command will be run.
8403 @vindex gnus-view-pseudo-asynchronously
8404 If @code{gnus-view-pseudo-asynchronously} is @code{nil}, Emacs will wait
8405 until the viewing is done before proceeding.
8407 @vindex gnus-view-pseudos
8408 If @code{gnus-view-pseudos} is @code{automatic}, Gnus will not insert
8409 the pseudo-articles into the summary buffer, but view them
8410 immediately. If this variable is @code{not-confirm}, the user won't even
8411 be asked for a confirmation before viewing is done.
8413 @vindex gnus-view-pseudos-separately
8414 If @code{gnus-view-pseudos-separately} is non-@code{nil}, one
8415 pseudo-article will be created for each file to be viewed. If
8416 @code{nil}, all files that use the same viewing command will be given as
8417 a list of parameters to that command.
8419 @vindex gnus-insert-pseudo-articles
8420 If @code{gnus-insert-pseudo-articles} is non-@code{nil}, insert
8421 pseudo-articles when decoding. It is @code{t} by default.
8423 So; there you are, reading your @emph{pseudo-articles} in your
8424 @emph{virtual newsgroup} from the @emph{virtual server}; and you think:
8425 Why isn't anything real anymore? How did we get here?
8428 @node Article Treatment
8429 @section Article Treatment
8431 Reading through this huge manual, you may have quite forgotten that the
8432 object of newsreaders is to actually, like, read what people have
8433 written. Reading articles. Unfortunately, people are quite bad at
8434 writing, so there are tons of functions and variables to make reading
8435 these articles easier.
8438 * Article Highlighting:: You want to make the article look like fruit salad.
8439 * Article Fontisizing:: Making emphasized text look nice.
8440 * Article Hiding:: You also want to make certain info go away.
8441 * Article Washing:: Lots of way-neat functions to make life better.
8442 * Article Header:: Doing various header transformations.
8443 * Article Buttons:: Click on URLs, Message-IDs, addresses and the like.
8444 * Article Button Levels:: Controlling appearance of buttons.
8445 * Article Date:: Grumble, UT!
8446 * Article Display:: Display various stuff---X-Face, Picons, Smileys
8447 * Article Signature:: What is a signature?
8448 * Article Miscellanea:: Various other stuff.
8452 @node Article Highlighting
8453 @subsection Article Highlighting
8454 @cindex highlighting
8456 Not only do you want your article buffer to look like fruit salad, but
8457 you want it to look like technicolor fruit salad.
8462 @kindex W H a (Summary)
8463 @findex gnus-article-highlight
8464 @findex gnus-article-maybe-highlight
8465 Do much highlighting of the current article
8466 (@code{gnus-article-highlight}). This function highlights header, cited
8467 text, the signature, and adds buttons to the body and the head.
8470 @kindex W H h (Summary)
8471 @findex gnus-article-highlight-headers
8472 @vindex gnus-header-face-alist
8473 Highlight the headers (@code{gnus-article-highlight-headers}). The
8474 highlighting will be done according to the @code{gnus-header-face-alist}
8475 variable, which is a list where each element has the form
8476 @code{(@var{regexp} @var{name} @var{content})}.
8477 @var{regexp} is a regular expression for matching the
8478 header, @var{name} is the face used for highlighting the header name
8479 (@pxref{Faces and Fonts}) and @var{content} is the face for highlighting
8480 the header value. The first match made will be used. Note that
8481 @var{regexp} shouldn't have @samp{^} prepended---Gnus will add one.
8484 @kindex W H c (Summary)
8485 @findex gnus-article-highlight-citation
8486 Highlight cited text (@code{gnus-article-highlight-citation}).
8488 Some variables to customize the citation highlights:
8491 @vindex gnus-cite-parse-max-size
8493 @item gnus-cite-parse-max-size
8494 If the article size in bytes is bigger than this variable (which is
8495 25000 by default), no citation highlighting will be performed.
8497 @item gnus-cite-max-prefix
8498 @vindex gnus-cite-max-prefix
8499 Maximum possible length for a citation prefix (default 20).
8501 @item gnus-cite-face-list
8502 @vindex gnus-cite-face-list
8503 List of faces used for highlighting citations (@pxref{Faces and Fonts}).
8504 When there are citations from multiple articles in the same message,
8505 Gnus will try to give each citation from each article its own face.
8506 This should make it easier to see who wrote what.
8508 @item gnus-supercite-regexp
8509 @vindex gnus-supercite-regexp
8510 Regexp matching normal Supercite attribution lines.
8512 @item gnus-supercite-secondary-regexp
8513 @vindex gnus-supercite-secondary-regexp
8514 Regexp matching mangled Supercite attribution lines.
8516 @item gnus-cite-minimum-match-count
8517 @vindex gnus-cite-minimum-match-count
8518 Minimum number of identical prefixes we have to see before we believe
8519 that it's a citation.
8521 @item gnus-cite-attribution-prefix
8522 @vindex gnus-cite-attribution-prefix
8523 Regexp matching the beginning of an attribution line.
8525 @item gnus-cite-attribution-suffix
8526 @vindex gnus-cite-attribution-suffix
8527 Regexp matching the end of an attribution line.
8529 @item gnus-cite-attribution-face
8530 @vindex gnus-cite-attribution-face
8531 Face used for attribution lines. It is merged with the face for the
8532 cited text belonging to the attribution.
8534 @item gnus-cite-ignore-quoted-from
8535 @vindex gnus-cite-ignore-quoted-from
8536 If non-@code{nil}, no citation highlighting will be performed on lines
8537 beginning with @samp{>From }. Those lines may have been quoted by MTAs
8538 in order not to mix up with the envelope From line. The default value
8545 @kindex W H s (Summary)
8546 @vindex gnus-signature-separator
8547 @vindex gnus-signature-face
8548 @findex gnus-article-highlight-signature
8549 Highlight the signature (@code{gnus-article-highlight-signature}).
8550 Everything after @code{gnus-signature-separator} (@pxref{Article
8551 Signature}) in an article will be considered a signature and will be
8552 highlighted with @code{gnus-signature-face}, which is @code{italic} by
8557 @xref{Customizing Articles}, for how to highlight articles automatically.
8560 @node Article Fontisizing
8561 @subsection Article Fontisizing
8563 @cindex article emphasis
8565 @findex gnus-article-emphasize
8566 @kindex W e (Summary)
8567 People commonly add emphasis to words in news articles by writing things
8568 like @samp{_this_} or @samp{*this*} or @samp{/this/}. Gnus can make
8569 this look nicer by running the article through the @kbd{W e}
8570 (@code{gnus-article-emphasize}) command.
8572 @vindex gnus-emphasis-alist
8573 How the emphasis is computed is controlled by the
8574 @code{gnus-emphasis-alist} variable. This is an alist where the first
8575 element is a regular expression to be matched. The second is a number
8576 that says what regular expression grouping is used to find the entire
8577 emphasized word. The third is a number that says what regexp grouping
8578 should be displayed and highlighted. (The text between these two
8579 groupings will be hidden.) The fourth is the face used for
8583 (setq gnus-emphasis-alist
8584 '(("_\\(\\w+\\)_" 0 1 gnus-emphasis-underline)
8585 ("\\*\\(\\w+\\)\\*" 0 1 gnus-emphasis-bold)))
8594 @vindex gnus-emphasis-underline
8595 @vindex gnus-emphasis-bold
8596 @vindex gnus-emphasis-italic
8597 @vindex gnus-emphasis-underline-bold
8598 @vindex gnus-emphasis-underline-italic
8599 @vindex gnus-emphasis-bold-italic
8600 @vindex gnus-emphasis-underline-bold-italic
8601 By default, there are seven rules, and they use the following faces:
8602 @code{gnus-emphasis-bold}, @code{gnus-emphasis-italic},
8603 @code{gnus-emphasis-underline}, @code{gnus-emphasis-bold-italic},
8604 @code{gnus-emphasis-underline-italic},
8605 @code{gnus-emphasis-underline-bold}, and
8606 @code{gnus-emphasis-underline-bold-italic}.
8608 If you want to change these faces, you can either use @kbd{M-x
8609 customize}, or you can use @code{copy-face}. For instance, if you want
8610 to make @code{gnus-emphasis-italic} use a red face instead, you could
8614 (copy-face 'red 'gnus-emphasis-italic)
8617 @vindex gnus-group-highlight-words-alist
8619 If you want to highlight arbitrary words, you can use the
8620 @code{gnus-group-highlight-words-alist} variable, which uses the same
8621 syntax as @code{gnus-emphasis-alist}. The @code{highlight-words} group
8622 parameter (@pxref{Group Parameters}) can also be used.
8624 @xref{Customizing Articles}, for how to fontize articles automatically.
8627 @node Article Hiding
8628 @subsection Article Hiding
8629 @cindex article hiding
8631 Or rather, hiding certain things in each article. There usually is much
8632 too much cruft in most articles.
8637 @kindex W W a (Summary)
8638 @findex gnus-article-hide
8639 Do quite a lot of hiding on the article buffer
8640 (@kbd{gnus-article-hide}). In particular, this function will hide
8641 headers, @acronym{PGP}, cited text and the signature.
8644 @kindex W W h (Summary)
8645 @findex gnus-article-hide-headers
8646 Hide headers (@code{gnus-article-hide-headers}). @xref{Hiding
8650 @kindex W W b (Summary)
8651 @findex gnus-article-hide-boring-headers
8652 Hide headers that aren't particularly interesting
8653 (@code{gnus-article-hide-boring-headers}). @xref{Hiding Headers}.
8656 @kindex W W s (Summary)
8657 @findex gnus-article-hide-signature
8658 Hide signature (@code{gnus-article-hide-signature}). @xref{Article
8662 @kindex W W l (Summary)
8663 @findex gnus-article-hide-list-identifiers
8664 @vindex gnus-list-identifiers
8665 Strip list identifiers specified in @code{gnus-list-identifiers}. These
8666 are strings some mailing list servers add to the beginning of all
8667 @code{Subject} headers---for example, @samp{[zebra 4711]}. Any leading
8668 @samp{Re: } is skipped before stripping. @code{gnus-list-identifiers}
8669 may not contain @code{\\(..\\)}.
8673 @item gnus-list-identifiers
8674 @vindex gnus-list-identifiers
8675 A regular expression that matches list identifiers to be removed from
8676 subject. This can also be a list of regular expressions.
8681 @kindex W W P (Summary)
8682 @findex gnus-article-hide-pem
8683 Hide @acronym{PEM} (privacy enhanced messages) cruft
8684 (@code{gnus-article-hide-pem}).
8687 @kindex W W B (Summary)
8688 @findex gnus-article-strip-banner
8689 @vindex gnus-article-banner-alist
8690 @vindex gnus-article-address-banner-alist
8693 @cindex stripping advertisements
8694 @cindex advertisements
8695 Strip the banner specified by the @code{banner} group parameter
8696 (@code{gnus-article-strip-banner}). This is mainly used to hide those
8697 annoying banners and/or signatures that some mailing lists and moderated
8698 groups adds to all the messages. The way to use this function is to add
8699 the @code{banner} group parameter (@pxref{Group Parameters}) to the
8700 group you want banners stripped from. The parameter either be a string,
8701 which will be interpreted as a regular expression matching text to be
8702 removed, or the symbol @code{signature}, meaning that the (last)
8703 signature should be removed, or other symbol, meaning that the
8704 corresponding regular expression in @code{gnus-article-banner-alist} is
8707 Regardless of a group, you can hide things like advertisements only when
8708 the sender of an article has a certain mail address specified in
8709 @code{gnus-article-address-banner-alist}.
8713 @item gnus-article-address-banner-alist
8714 @vindex gnus-article-address-banner-alist
8715 Alist of mail addresses and banners. Each element has the form
8716 @code{(@var{address} . @var{banner})}, where @var{address} is a regexp
8717 matching a mail address in the From header, @var{banner} is one of a
8718 symbol @code{signature}, an item in @code{gnus-article-banner-alist},
8719 a regexp and @code{nil}. If @var{address} matches author's mail
8720 address, it will remove things like advertisements. For example, if a
8721 sender has the mail address @samp{hail@@yoo-hoo.co.jp} and there is a
8722 banner something like @samp{Do You Yoo-hoo!?} in all articles he
8723 sends, you can use the following element to remove them:
8726 ("@@yoo-hoo\\.co\\.jp\\'" .
8727 "\n_+\nDo You Yoo-hoo!\\?\n.*\n.*\n")
8733 @kindex W W c (Summary)
8734 @findex gnus-article-hide-citation
8735 Hide citation (@code{gnus-article-hide-citation}). Some variables for
8736 customizing the hiding:
8740 @item gnus-cited-opened-text-button-line-format
8741 @itemx gnus-cited-closed-text-button-line-format
8742 @vindex gnus-cited-closed-text-button-line-format
8743 @vindex gnus-cited-opened-text-button-line-format
8744 Gnus adds buttons to show where the cited text has been hidden, and to
8745 allow toggle hiding the text. The format of the variable is specified
8746 by these format-like variable (@pxref{Formatting Variables}). These
8751 Starting point of the hidden text.
8753 Ending point of the hidden text.
8755 Number of characters in the hidden region.
8757 Number of lines of hidden text.
8760 @item gnus-cited-lines-visible
8761 @vindex gnus-cited-lines-visible
8762 The number of lines at the beginning of the cited text to leave
8763 shown. This can also be a cons cell with the number of lines at the top
8764 and bottom of the text, respectively, to remain visible.
8769 @kindex W W C-c (Summary)
8770 @findex gnus-article-hide-citation-maybe
8772 Hide citation (@code{gnus-article-hide-citation-maybe}) depending on the
8773 following two variables:
8776 @item gnus-cite-hide-percentage
8777 @vindex gnus-cite-hide-percentage
8778 If the cited text is of a bigger percentage than this variable (default
8779 50), hide the cited text.
8781 @item gnus-cite-hide-absolute
8782 @vindex gnus-cite-hide-absolute
8783 The cited text must have at least this length (default 10) before it
8788 @kindex W W C (Summary)
8789 @findex gnus-article-hide-citation-in-followups
8790 Hide cited text in articles that aren't roots
8791 (@code{gnus-article-hide-citation-in-followups}). This isn't very
8792 useful as an interactive command, but might be a handy function to stick
8793 have happen automatically (@pxref{Customizing Articles}).
8797 All these ``hiding'' commands are toggles, but if you give a negative
8798 prefix to these commands, they will show what they have previously
8799 hidden. If you give a positive prefix, they will always hide.
8801 Also @pxref{Article Highlighting} for further variables for
8802 citation customization.
8804 @xref{Customizing Articles}, for how to hide article elements
8808 @node Article Washing
8809 @subsection Article Washing
8811 @cindex article washing
8813 We call this ``article washing'' for a really good reason. Namely, the
8814 @kbd{A} key was taken, so we had to use the @kbd{W} key instead.
8816 @dfn{Washing} is defined by us as ``changing something from something to
8817 something else'', but normally results in something looking better.
8820 @xref{Customizing Articles}, if you want to change how Gnus displays
8821 articles by default.
8826 This is not really washing, it's sort of the opposite of washing. If
8827 you type this, you see the article exactly as it exists on disk or on
8831 Force redisplaying of the current article
8832 (@code{gnus-summary-show-article}). This is also not really washing.
8833 If you type this, you see the article without any previously applied
8834 interactive Washing functions but with all default treatments
8835 (@pxref{Customizing Articles}).
8838 @kindex W l (Summary)
8839 @findex gnus-summary-stop-page-breaking
8840 Remove page breaks from the current article
8841 (@code{gnus-summary-stop-page-breaking}). @xref{Misc Article}, for page
8845 @kindex W r (Summary)
8846 @findex gnus-summary-caesar-message
8847 @c @icon{gnus-summary-caesar-message}
8848 Do a Caesar rotate (rot13) on the article buffer
8849 (@code{gnus-summary-caesar-message}).
8850 Unreadable articles that tell you to read them with Caesar rotate or rot13.
8851 (Typically offensive jokes and such.)
8853 It's commonly called ``rot13'' because each letter is rotated 13
8854 positions in the alphabet, e. g. @samp{B} (letter #2) -> @samp{O} (letter
8855 #15). It is sometimes referred to as ``Caesar rotate'' because Caesar
8856 is rumored to have employed this form of, uh, somewhat weak encryption.
8859 @kindex W m (Summary)
8860 @findex gnus-summary-morse-message
8861 Morse decode the article buffer (@code{gnus-summary-morse-message}).
8864 @kindex W i (Summary)
8865 @findex gnus-summary-idna-message
8866 Decode IDNA encoded domain names in the current articles. IDNA
8867 encoded domain names looks like @samp{xn--bar}. If a string remain
8868 unencoded after running invoking this, it is likely an invalid IDNA
8869 string (@samp{xn--bar} is invalid). You must have GNU Libidn
8870 (@url{http://www.gnu.org/software/libidn/}) installed for this command
8875 @kindex W t (Summary)
8877 @findex gnus-summary-toggle-header
8878 Toggle whether to display all headers in the article buffer
8879 (@code{gnus-summary-toggle-header}).
8882 @kindex W v (Summary)
8883 @findex gnus-summary-verbose-headers
8884 Toggle whether to display all headers in the article buffer permanently
8885 (@code{gnus-summary-verbose-headers}).
8888 @kindex W o (Summary)
8889 @findex gnus-article-treat-overstrike
8890 Treat overstrike (@code{gnus-article-treat-overstrike}).
8893 @kindex W d (Summary)
8894 @findex gnus-article-treat-dumbquotes
8895 @vindex gnus-article-dumbquotes-map
8897 @cindex M****s*** sm*rtq**t*s
8899 Treat M****s*** sm*rtq**t*s according to
8900 @code{gnus-article-dumbquotes-map}
8901 (@code{gnus-article-treat-dumbquotes}). Note that this function guesses
8902 whether a character is a sm*rtq**t* or not, so it should only be used
8905 Sm*rtq**t*s are M****s***'s unilateral extension to the character map in
8906 an attempt to provide more quoting characters. If you see something
8907 like @code{\222} or @code{\264} where you're expecting some kind of
8908 apostrophe or quotation mark, then try this wash.
8911 @kindex W Y f (Summary)
8912 @findex gnus-article-outlook-deuglify-article
8913 @cindex Outlook Express
8914 Full deuglify of broken Outlook (Express) articles: Treat dumbquotes,
8915 unwrap lines, repair attribution and rearrange citation.
8916 (@code{gnus-article-outlook-deuglify-article}).
8919 @kindex W Y u (Summary)
8920 @findex gnus-article-outlook-unwrap-lines
8921 @vindex gnus-outlook-deuglify-unwrap-min
8922 @vindex gnus-outlook-deuglify-unwrap-max
8923 Unwrap lines that appear to be wrapped citation lines. You can control
8924 what lines will be unwrapped by frobbing
8925 @code{gnus-outlook-deuglify-unwrap-min} and
8926 @code{gnus-outlook-deuglify-unwrap-max}, indicating the minimum and
8927 maximum length of an unwrapped citation line.
8928 (@code{gnus-article-outlook-unwrap-lines}).
8931 @kindex W Y a (Summary)
8932 @findex gnus-article-outlook-repair-attribution
8933 Repair a broken attribution line.@*
8934 (@code{gnus-article-outlook-repair-attribution}).
8937 @kindex W Y c (Summary)
8938 @findex gnus-article-outlook-rearrange-citation
8939 Repair broken citations by rearranging the text.
8940 (@code{gnus-article-outlook-rearrange-citation}).
8943 @kindex W w (Summary)
8944 @findex gnus-article-fill-cited-article
8945 Do word wrap (@code{gnus-article-fill-cited-article}).
8947 You can give the command a numerical prefix to specify the width to use
8951 @kindex W Q (Summary)
8952 @findex gnus-article-fill-long-lines
8953 Fill long lines (@code{gnus-article-fill-long-lines}).
8956 @kindex W C (Summary)
8957 @findex gnus-article-capitalize-sentences
8958 Capitalize the first word in each sentence
8959 (@code{gnus-article-capitalize-sentences}).
8962 @kindex W c (Summary)
8963 @findex gnus-article-remove-cr
8964 Translate CRLF pairs (i. e., @samp{^M}s on the end of the lines) into LF
8965 (this takes care of DOS line endings), and then translate any remaining
8966 CRs into LF (this takes care of Mac line endings)
8967 (@code{gnus-article-remove-cr}).
8970 @kindex W q (Summary)
8971 @findex gnus-article-de-quoted-unreadable
8972 Treat quoted-printable (@code{gnus-article-de-quoted-unreadable}).
8973 Quoted-Printable is one common @acronym{MIME} encoding employed when
8974 sending non-@acronym{ASCII} (i.e., 8-bit) articles. It typically
8975 makes strings like @samp{d@'ej@`a vu} look like @samp{d=E9j=E0 vu},
8976 which doesn't look very readable to me. Note that this is usually
8977 done automatically by Gnus if the message in question has a
8978 @code{Content-Transfer-Encoding} header that says that this encoding
8979 has been done. If a prefix is given, a charset will be asked for.
8982 @kindex W 6 (Summary)
8983 @findex gnus-article-de-base64-unreadable
8984 Treat base64 (@code{gnus-article-de-base64-unreadable}). Base64 is
8985 one common @acronym{MIME} encoding employed when sending
8986 non-@acronym{ASCII} (i.e., 8-bit) articles. Note that this is
8987 usually done automatically by Gnus if the message in question has a
8988 @code{Content-Transfer-Encoding} header that says that this encoding
8989 has been done. If a prefix is given, a charset will be asked for.
8992 @kindex W Z (Summary)
8993 @findex gnus-article-decode-HZ
8994 Treat HZ or HZP (@code{gnus-article-decode-HZ}). HZ (or HZP) is one
8995 common encoding employed when sending Chinese articles. It typically
8996 makes strings look like @samp{~@{<:Ky2;S@{#,NpJ)l6HK!#~@}}.
8999 @kindex W A (Summary)
9000 @findex gnus-article-treat-ansi-sequences
9001 @cindex @acronym{ANSI} control sequences
9002 Translate @acronym{ANSI} SGR control sequences into overlays or
9003 extents (@code{gnus-article-treat-ansi-sequences}). @acronym{ANSI}
9004 sequences are used in some Chinese hierarchies for highlighting.
9007 @kindex W u (Summary)
9008 @findex gnus-article-unsplit-urls
9009 Remove newlines from within URLs. Some mailers insert newlines into
9010 outgoing email messages to keep lines short. This reformatting can
9011 split long URLs onto multiple lines. Repair those URLs by removing
9012 the newlines (@code{gnus-article-unsplit-urls}).
9015 @kindex W h (Summary)
9016 @findex gnus-article-wash-html
9017 Treat @acronym{HTML} (@code{gnus-article-wash-html}). Note that this is
9018 usually done automatically by Gnus if the message in question has a
9019 @code{Content-Type} header that says that the message is @acronym{HTML}.
9021 If a prefix is given, a charset will be asked for. If it is a number,
9022 the charset defined in @code{gnus-summary-show-article-charset-alist}
9023 (@pxref{Paging the Article}) will be used.
9025 @vindex gnus-article-wash-function
9026 The default is to use the function specified by
9027 @code{mm-text-html-renderer} (@pxref{Display Customization, ,Display
9028 Customization, emacs-mime, The Emacs MIME Manual}) to convert the
9029 @acronym{HTML}, but this is controlled by the
9030 @code{gnus-article-wash-function} variable. Pre-defined functions you
9038 Use @uref{http://emacs-w3m.namazu.org/, emacs-w3m}.
9040 @item w3m-standalone
9041 Use @uref{http://w3m.sourceforge.net/, w3m}.
9044 Use @uref{http://links.sf.net/, Links}.
9047 Use @uref{http://lynx.isc.org/, Lynx}.
9050 Use html2text---a simple @acronym{HTML} converter included with Gnus.
9055 @kindex W b (Summary)
9056 @findex gnus-article-add-buttons
9057 Add clickable buttons to the article (@code{gnus-article-add-buttons}).
9058 @xref{Article Buttons}.
9061 @kindex W B (Summary)
9062 @findex gnus-article-add-buttons-to-head
9063 Add clickable buttons to the article headers
9064 (@code{gnus-article-add-buttons-to-head}).
9067 @kindex W p (Summary)
9068 @findex gnus-article-verify-x-pgp-sig
9069 Verify a signed control message
9070 (@code{gnus-article-verify-x-pgp-sig}). Control messages such as
9071 @code{newgroup} and @code{checkgroups} are usually signed by the
9072 hierarchy maintainer. You need to add the @acronym{PGP} public key of
9073 the maintainer to your keyring to verify the
9074 message.@footnote{@acronym{PGP} keys for many hierarchies are
9075 available at @uref{ftp://ftp.isc.org/pub/pgpcontrol/README.html}}
9078 @kindex W s (Summary)
9079 @findex gnus-summary-force-verify-and-decrypt
9080 Verify a signed (@acronym{PGP}, @acronym{PGP/MIME} or
9081 @acronym{S/MIME}) message
9082 (@code{gnus-summary-force-verify-and-decrypt}). @xref{Security}.
9085 @kindex W a (Summary)
9086 @findex gnus-article-strip-headers-in-body
9087 Strip headers like the @code{X-No-Archive} header from the beginning of
9088 article bodies (@code{gnus-article-strip-headers-in-body}).
9091 @kindex W E l (Summary)
9092 @findex gnus-article-strip-leading-blank-lines
9093 Remove all blank lines from the beginning of the article
9094 (@code{gnus-article-strip-leading-blank-lines}).
9097 @kindex W E m (Summary)
9098 @findex gnus-article-strip-multiple-blank-lines
9099 Replace all blank lines with empty lines and then all multiple empty
9100 lines with a single empty line.
9101 (@code{gnus-article-strip-multiple-blank-lines}).
9104 @kindex W E t (Summary)
9105 @findex gnus-article-remove-trailing-blank-lines
9106 Remove all blank lines at the end of the article
9107 (@code{gnus-article-remove-trailing-blank-lines}).
9110 @kindex W E a (Summary)
9111 @findex gnus-article-strip-blank-lines
9112 Do all the three commands above
9113 (@code{gnus-article-strip-blank-lines}).
9116 @kindex W E A (Summary)
9117 @findex gnus-article-strip-all-blank-lines
9118 Remove all blank lines
9119 (@code{gnus-article-strip-all-blank-lines}).
9122 @kindex W E s (Summary)
9123 @findex gnus-article-strip-leading-space
9124 Remove all white space from the beginning of all lines of the article
9125 body (@code{gnus-article-strip-leading-space}).
9128 @kindex W E e (Summary)
9129 @findex gnus-article-strip-trailing-space
9130 Remove all white space from the end of all lines of the article
9131 body (@code{gnus-article-strip-trailing-space}).
9135 @xref{Customizing Articles}, for how to wash articles automatically.
9138 @node Article Header
9139 @subsection Article Header
9141 These commands perform various transformations of article header.
9146 @kindex W G u (Summary)
9147 @findex gnus-article-treat-unfold-headers
9148 Unfold folded header lines (@code{gnus-article-treat-unfold-headers}).
9151 @kindex W G n (Summary)
9152 @findex gnus-article-treat-fold-newsgroups
9153 Fold the @code{Newsgroups} and @code{Followup-To} headers
9154 (@code{gnus-article-treat-fold-newsgroups}).
9157 @kindex W G f (Summary)
9158 @findex gnus-article-treat-fold-headers
9159 Fold all the message headers
9160 (@code{gnus-article-treat-fold-headers}).
9163 @kindex W E w (Summary)
9164 @findex gnus-article-remove-leading-whitespace
9165 Remove excessive whitespace from all headers
9166 (@code{gnus-article-remove-leading-whitespace}).
9171 @node Article Buttons
9172 @subsection Article Buttons
9175 People often include references to other stuff in articles, and it would
9176 be nice if Gnus could just fetch whatever it is that people talk about
9177 with the minimum of fuzz when you hit @kbd{RET} or use the middle mouse
9178 button on these references.
9180 @vindex gnus-button-man-handler
9181 Gnus adds @dfn{buttons} to certain standard references by default:
9182 Well-formed URLs, mail addresses, Message-IDs, Info links, man pages and
9183 Emacs or Gnus related references. This is controlled by two variables,
9184 one that handles article bodies and one that handles article heads:
9188 @item gnus-button-alist
9189 @vindex gnus-button-alist
9190 This is an alist where each entry has this form:
9193 (@var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
9199 All text that match this regular expression (case insensitive) will be
9200 considered an external reference. Here's a typical regexp that matches
9201 embedded URLs: @samp{<URL:\\([^\n\r>]*\\)>}. This can also be a
9202 variable containing a regexp, useful variables to use include
9203 @code{gnus-button-url-regexp} and @code{gnus-button-mid-or-mail-regexp}.
9206 Gnus has to know which parts of the matches is to be highlighted. This
9207 is a number that says what sub-expression of the regexp is to be
9208 highlighted. If you want it all highlighted, you use 0 here.
9211 This form will be @code{eval}ed, and if the result is non-@code{nil},
9212 this is considered a match. This is useful if you want extra sifting to
9213 avoid false matches. Often variables named
9214 @code{gnus-button-@var{*}-level} are used here, @xref{Article Button
9215 Levels}, but any other form may be used too.
9217 @c @code{use-p} is @code{eval}ed only if @code{regexp} matches.
9220 This function will be called when you click on this button.
9223 As with @var{button-par}, this is a sub-expression number, but this one
9224 says which part of the match is to be sent as data to @var{function}.
9228 So the full entry for buttonizing URLs is then
9231 ("<URL:\\([^\n\r>]*\\)>" 0 t gnus-button-url 1)
9234 @item gnus-header-button-alist
9235 @vindex gnus-header-button-alist
9236 This is just like the other alist, except that it is applied to the
9237 article head only, and that each entry has an additional element that is
9238 used to say what headers to apply the buttonize coding to:
9241 (@var{header} @var{regexp} @var{button-par} @var{use-p} @var{function} @var{data-par})
9244 @var{header} is a regular expression.
9247 @subsubsection Related variables and functions
9250 @item gnus-button-@var{*}-level
9251 @xref{Article Button Levels}.
9253 @c Stuff related to gnus-button-browse-level
9255 @item gnus-button-url-regexp
9256 @vindex gnus-button-url-regexp
9257 A regular expression that matches embedded URLs. It is used in the
9258 default values of the variables above.
9260 @c Stuff related to gnus-button-man-level
9262 @item gnus-button-man-handler
9263 @vindex gnus-button-man-handler
9264 The function to use for displaying man pages. It must take at least one
9265 argument with a string naming the man page.
9267 @c Stuff related to gnus-button-message-level
9269 @item gnus-button-mid-or-mail-regexp
9270 @vindex gnus-button-mid-or-mail-regexp
9271 Regular expression that matches a message ID or a mail address.
9273 @item gnus-button-prefer-mid-or-mail
9274 @vindex gnus-button-prefer-mid-or-mail
9275 This variable determines what to do when the button on a string as
9276 @samp{foo123@@bar.invalid} is pushed. Strings like this can be either a
9277 message ID or a mail address. If it is one of the symbols @code{mid} or
9278 @code{mail}, Gnus will always assume that the string is a message ID or
9279 a mail address, respectively. If this variable is set to the symbol
9280 @code{ask}, always query the user what to do. If it is a function, this
9281 function will be called with the string as its only argument. The
9282 function must return @code{mid}, @code{mail}, @code{invalid} or
9283 @code{ask}. The default value is the function
9284 @code{gnus-button-mid-or-mail-heuristic}.
9286 @item gnus-button-mid-or-mail-heuristic
9287 @findex gnus-button-mid-or-mail-heuristic
9288 Function that guesses whether its argument is a message ID or a mail
9289 address. Returns @code{mid} if it's a message IDs, @code{mail} if
9290 it's a mail address, @code{ask} if unsure and @code{invalid} if the
9293 @item gnus-button-mid-or-mail-heuristic-alist
9294 @vindex gnus-button-mid-or-mail-heuristic-alist
9295 An alist of @code{(RATE . REGEXP)} pairs used by the function
9296 @code{gnus-button-mid-or-mail-heuristic}.
9298 @c Stuff related to gnus-button-tex-level
9300 @item gnus-button-ctan-handler
9301 @findex gnus-button-ctan-handler
9302 The function to use for displaying CTAN links. It must take one
9303 argument, the string naming the URL.
9306 @vindex gnus-ctan-url
9307 Top directory of a CTAN (Comprehensive TeX Archive Network) archive used
9308 by @code{gnus-button-ctan-handler}.
9312 @item gnus-article-button-face
9313 @vindex gnus-article-button-face
9314 Face used on buttons.
9316 @item gnus-article-mouse-face
9317 @vindex gnus-article-mouse-face
9318 Face used when the mouse cursor is over a button.
9322 @xref{Customizing Articles}, for how to buttonize articles automatically.
9325 @node Article Button Levels
9326 @subsection Article button levels
9327 @cindex button levels
9328 The higher the value of the variables @code{gnus-button-@var{*}-level},
9329 the more buttons will appear. If the level is zero, no corresponding
9330 buttons are displayed. With the default value (which is 5) you should
9331 already see quite a lot of buttons. With higher levels, you will see
9332 more buttons, but you may also get more false positives. To avoid them,
9333 you can set the variables @code{gnus-button-@var{*}-level} local to
9334 specific groups (@pxref{Group Parameters}). Here's an example for the
9335 variable @code{gnus-parameters}:
9338 ;; @r{increase @code{gnus-button-*-level} in some groups:}
9339 (setq gnus-parameters
9340 '(("\\<\\(emacs\\|gnus\\)\\>" (gnus-button-emacs-level 10))
9341 ("\\<unix\\>" (gnus-button-man-level 10))
9342 ("\\<tex\\>" (gnus-button-tex-level 10))))
9347 @item gnus-button-browse-level
9348 @vindex gnus-button-browse-level
9349 Controls the display of references to message IDs, mail addresses and
9350 news URLs. Related variables and functions include
9351 @code{gnus-button-url-regexp}, @code{browse-url}, and
9352 @code{browse-url-browser-function}.
9354 @item gnus-button-emacs-level
9355 @vindex gnus-button-emacs-level
9356 Controls the display of Emacs or Gnus references. Related functions are
9357 @code{gnus-button-handle-custom},
9358 @code{gnus-button-handle-describe-function},
9359 @code{gnus-button-handle-describe-variable},
9360 @code{gnus-button-handle-symbol},
9361 @code{gnus-button-handle-describe-key},
9362 @code{gnus-button-handle-apropos},
9363 @code{gnus-button-handle-apropos-command},
9364 @code{gnus-button-handle-apropos-variable},
9365 @code{gnus-button-handle-apropos-documentation}, and
9366 @code{gnus-button-handle-library}.
9368 @item gnus-button-man-level
9369 @vindex gnus-button-man-level
9370 Controls the display of references to (Unix) man pages.
9371 See @code{gnus-button-man-handler}.
9373 @item gnus-button-message-level
9374 @vindex gnus-button-message-level
9375 Controls the display of message IDs, mail addresses and news URLs.
9376 Related variables and functions include
9377 @code{gnus-button-mid-or-mail-regexp},
9378 @code{gnus-button-prefer-mid-or-mail},
9379 @code{gnus-button-mid-or-mail-heuristic}, and
9380 @code{gnus-button-mid-or-mail-heuristic-alist}.
9382 @item gnus-button-tex-level
9383 @vindex gnus-button-tex-level
9384 Controls the display of references to @TeX{} or LaTeX stuff, e.g. for CTAN
9385 URLs. See the variables @code{gnus-ctan-url},
9386 @code{gnus-button-ctan-handler},
9387 @code{gnus-button-ctan-directory-regexp}, and
9388 @code{gnus-button-handle-ctan-bogus-regexp}.
9394 @subsection Article Date
9396 The date is most likely generated in some obscure timezone you've never
9397 heard of, so it's quite nice to be able to find out what the time was
9398 when the article was sent.
9403 @kindex W T u (Summary)
9404 @findex gnus-article-date-ut
9405 Display the date in UT (aka. GMT, aka ZULU)
9406 (@code{gnus-article-date-ut}).
9409 @kindex W T i (Summary)
9410 @findex gnus-article-date-iso8601
9412 Display the date in international format, aka. ISO 8601
9413 (@code{gnus-article-date-iso8601}).
9416 @kindex W T l (Summary)
9417 @findex gnus-article-date-local
9418 Display the date in the local timezone (@code{gnus-article-date-local}).
9421 @kindex W T p (Summary)
9422 @findex gnus-article-date-english
9423 Display the date in a format that's easily pronounceable in English
9424 (@code{gnus-article-date-english}).
9427 @kindex W T s (Summary)
9428 @vindex gnus-article-time-format
9429 @findex gnus-article-date-user
9430 @findex format-time-string
9431 Display the date using a user-defined format
9432 (@code{gnus-article-date-user}). The format is specified by the
9433 @code{gnus-article-time-format} variable, and is a string that's passed
9434 to @code{format-time-string}. See the documentation of that variable
9435 for a list of possible format specs.
9438 @kindex W T e (Summary)
9439 @findex gnus-article-date-lapsed
9440 @findex gnus-start-date-timer
9441 @findex gnus-stop-date-timer
9442 Say how much time has elapsed between the article was posted and now
9443 (@code{gnus-article-date-lapsed}). It looks something like:
9446 X-Sent: 6 weeks, 4 days, 1 hour, 3 minutes, 8 seconds ago
9449 @vindex gnus-article-date-lapsed-new-header
9450 The value of @code{gnus-article-date-lapsed-new-header} determines
9451 whether this header will just be added below the old Date one, or will
9454 An advantage of using Gnus to read mail is that it converts simple bugs
9455 into wonderful absurdities.
9457 If you want to have this line updated continually, you can put
9460 (gnus-start-date-timer)
9463 in your @file{~/.gnus.el} file, or you can run it off of some hook. If
9464 you want to stop the timer, you can use the @code{gnus-stop-date-timer}
9468 @kindex W T o (Summary)
9469 @findex gnus-article-date-original
9470 Display the original date (@code{gnus-article-date-original}). This can
9471 be useful if you normally use some other conversion function and are
9472 worried that it might be doing something totally wrong. Say, claiming
9473 that the article was posted in 1854. Although something like that is
9474 @emph{totally} impossible. Don't you trust me? *titter*
9478 @xref{Customizing Articles}, for how to display the date in your
9479 preferred format automatically.
9482 @node Article Display
9483 @subsection Article Display
9488 These commands add various frivolous display gimmicks to the article
9489 buffer in Emacs versions that support them.
9491 @code{X-Face} headers are small black-and-white images supplied by the
9492 message headers (@pxref{X-Face}).
9494 @code{Face} headers are small colored images supplied by the message
9495 headers (@pxref{Face}).
9497 Smileys are those little @samp{:-)} symbols that people like to litter
9498 their messages with (@pxref{Smileys}).
9500 Picons, on the other hand, reside on your own system, and Gnus will
9501 try to match the headers to what you have (@pxref{Picons}).
9503 All these functions are toggles---if the elements already exist,
9508 @kindex W D x (Summary)
9509 @findex gnus-article-display-x-face
9510 Display an @code{X-Face} in the @code{From} header.
9511 (@code{gnus-article-display-x-face}).
9514 @kindex W D d (Summary)
9515 @findex gnus-article-display-face
9516 Display a @code{Face} in the @code{From} header.
9517 (@code{gnus-article-display-face}).
9520 @kindex W D s (Summary)
9521 @findex gnus-treat-smiley
9522 Display smileys (@code{gnus-treat-smiley}).
9525 @kindex W D f (Summary)
9526 @findex gnus-treat-from-picon
9527 Piconify the @code{From} header (@code{gnus-treat-from-picon}).
9530 @kindex W D m (Summary)
9531 @findex gnus-treat-mail-picon
9532 Piconify all mail headers (i. e., @code{Cc}, @code{To})
9533 (@code{gnus-treat-mail-picon}).
9536 @kindex W D n (Summary)
9537 @findex gnus-treat-newsgroups-picon
9538 Piconify all news headers (i. e., @code{Newsgroups} and
9539 @code{Followup-To}) (@code{gnus-treat-newsgroups-picon}).
9542 @kindex W D D (Summary)
9543 @findex gnus-article-remove-images
9544 Remove all images from the article buffer
9545 (@code{gnus-article-remove-images}).
9551 @node Article Signature
9552 @subsection Article Signature
9554 @cindex article signature
9556 @vindex gnus-signature-separator
9557 Each article is divided into two parts---the head and the body. The
9558 body can be divided into a signature part and a text part. The variable
9559 that says what is to be considered a signature is
9560 @code{gnus-signature-separator}. This is normally the standard
9561 @samp{^-- $} as mandated by son-of-RFC 1036. However, many people use
9562 non-standard signature separators, so this variable can also be a list
9563 of regular expressions to be tested, one by one. (Searches are done
9564 from the end of the body towards the beginning.) One likely value is:
9567 (setq gnus-signature-separator
9568 '("^-- $" ; @r{The standard}
9569 "^-- *$" ; @r{A common mangling}
9570 "^-------*$" ; @r{Many people just use a looong}
9571 ; @r{line of dashes. Shame!}
9572 "^ *--------*$" ; @r{Double-shame!}
9573 "^________*$" ; @r{Underscores are also popular}
9574 "^========*$")) ; @r{Pervert!}
9577 The more permissive you are, the more likely it is that you'll get false
9580 @vindex gnus-signature-limit
9581 @code{gnus-signature-limit} provides a limit to what is considered a
9582 signature when displaying articles.
9586 If it is an integer, no signature may be longer (in characters) than
9589 If it is a floating point number, no signature may be longer (in lines)
9592 If it is a function, the function will be called without any parameters,
9593 and if it returns @code{nil}, there is no signature in the buffer.
9595 If it is a string, it will be used as a regexp. If it matches, the text
9596 in question is not a signature.
9599 This variable can also be a list where the elements may be of the types
9600 listed above. Here's an example:
9603 (setq gnus-signature-limit
9604 '(200.0 "^---*Forwarded article"))
9607 This means that if there are more than 200 lines after the signature
9608 separator, or the text after the signature separator is matched by
9609 the regular expression @samp{^---*Forwarded article}, then it isn't a
9610 signature after all.
9613 @node Article Miscellanea
9614 @subsection Article Miscellanea
9618 @kindex A t (Summary)
9619 @findex gnus-article-babel
9620 Translate the article from one language to another
9621 (@code{gnus-article-babel}).
9627 @section MIME Commands
9628 @cindex MIME decoding
9630 @cindex viewing attachments
9632 The following commands all understand the numerical prefix. For
9633 instance, @kbd{3 K v} means ``view the third @acronym{MIME} part''.
9639 @kindex K v (Summary)
9640 View the @acronym{MIME} part.
9643 @kindex K o (Summary)
9644 Save the @acronym{MIME} part.
9647 @kindex K O (Summary)
9648 Prompt for a file name, then save the @acronym{MIME} part and strip it
9649 from the article. The stripped @acronym{MIME} object will be referred
9650 via the message/external-body @acronym{MIME} type.
9653 @kindex K r (Summary)
9654 Replace the @acronym{MIME} part with an external body.
9657 @kindex K d (Summary)
9658 Delete the @acronym{MIME} part and add some information about the
9662 @kindex K c (Summary)
9663 Copy the @acronym{MIME} part.
9666 @kindex K e (Summary)
9667 View the @acronym{MIME} part externally.
9670 @kindex K i (Summary)
9671 View the @acronym{MIME} part internally.
9674 @kindex K | (Summary)
9675 Pipe the @acronym{MIME} part to an external command.
9678 The rest of these @acronym{MIME} commands do not use the numerical prefix in
9683 @kindex K H (Summary)
9684 @findex gnus-article-browse-html-article
9685 View @samp{text/html} parts of the current article with a WWW browser.
9686 The message header is added to the beginning of every html part unless
9687 the prefix argument is given.
9689 Warning: Spammers use links to images in HTML articles to verify whether
9690 you have read the message. As this command passes the @acronym{HTML}
9691 content to the browser without eliminating these ``web bugs'' you should
9692 only use it for mails from trusted senders.
9694 If you always want to display @acronym{HTML} parts in the browser, set
9695 @code{mm-text-html-renderer} to @code{nil}.
9698 @kindex K b (Summary)
9699 Make all the @acronym{MIME} parts have buttons in front of them. This is
9700 mostly useful if you wish to save (or perform other actions) on inlined
9704 @kindex K m (Summary)
9705 @findex gnus-summary-repair-multipart
9706 Some multipart messages are transmitted with missing or faulty headers.
9707 This command will attempt to ``repair'' these messages so that they can
9708 be viewed in a more pleasant manner
9709 (@code{gnus-summary-repair-multipart}).
9712 @kindex X m (Summary)
9713 @findex gnus-summary-save-parts
9714 Save all parts matching a @acronym{MIME} type to a directory
9715 (@code{gnus-summary-save-parts}). Understands the process/prefix
9716 convention (@pxref{Process/Prefix}).
9719 @kindex M-t (Summary)
9720 @findex gnus-summary-toggle-display-buttonized
9721 Toggle the buttonized display of the article buffer
9722 (@code{gnus-summary-toggle-display-buttonized}).
9725 @kindex W M w (Summary)
9726 @findex gnus-article-decode-mime-words
9727 Decode RFC 2047-encoded words in the article headers
9728 (@code{gnus-article-decode-mime-words}).
9731 @kindex W M c (Summary)
9732 @findex gnus-article-decode-charset
9733 Decode encoded article bodies as well as charsets
9734 (@code{gnus-article-decode-charset}).
9736 This command looks in the @code{Content-Type} header to determine the
9737 charset. If there is no such header in the article, you can give it a
9738 prefix, which will prompt for the charset to decode as. In regional
9739 groups where people post using some common encoding (but do not
9740 include @acronym{MIME} headers), you can set the @code{charset} group/topic
9741 parameter to the required charset (@pxref{Group Parameters}).
9744 @kindex W M v (Summary)
9745 @findex gnus-mime-view-all-parts
9746 View all the @acronym{MIME} parts in the current article
9747 (@code{gnus-mime-view-all-parts}).
9754 @item gnus-ignored-mime-types
9755 @vindex gnus-ignored-mime-types
9756 This is a list of regexps. @acronym{MIME} types that match a regexp from
9757 this list will be completely ignored by Gnus. The default value is
9760 To have all Vcards be ignored, you'd say something like this:
9763 (setq gnus-ignored-mime-types
9767 @item gnus-article-loose-mime
9768 @vindex gnus-article-loose-mime
9769 If non-@code{nil}, Gnus won't require the @samp{MIME-Version} header
9770 before interpreting the message as a @acronym{MIME} message. This helps
9771 when reading messages from certain broken mail user agents. The
9772 default is @code{t}.
9774 @item gnus-article-emulate-mime
9775 @vindex gnus-article-emulate-mime
9778 There are other, non-@acronym{MIME} encoding methods used. The most common
9779 is @samp{uuencode}, but yEncode is also getting to be popular. If
9780 this variable is non-@code{nil}, Gnus will look in message bodies to
9781 see if it finds these encodings, and if so, it'll run them through the
9782 Gnus @acronym{MIME} machinery. The default is @code{t}. Only
9783 single-part yEnc encoded attachments can be decoded. There's no support
9784 for encoding in Gnus.
9786 @item gnus-unbuttonized-mime-types
9787 @vindex gnus-unbuttonized-mime-types
9788 This is a list of regexps. @acronym{MIME} types that match a regexp from
9789 this list won't have @acronym{MIME} buttons inserted unless they aren't
9790 displayed or this variable is overridden by
9791 @code{gnus-buttonized-mime-types}. The default value is
9792 @code{(".*/.*")}. This variable is only used when
9793 @code{gnus-inhibit-mime-unbuttonizing} is @code{nil}.
9795 @item gnus-buttonized-mime-types
9796 @vindex gnus-buttonized-mime-types
9797 This is a list of regexps. @acronym{MIME} types that match a regexp from
9798 this list will have @acronym{MIME} buttons inserted unless they aren't
9799 displayed. This variable overrides
9800 @code{gnus-unbuttonized-mime-types}. The default value is @code{nil}.
9801 This variable is only used when @code{gnus-inhibit-mime-unbuttonizing}
9804 To see e.g. security buttons but no other buttons, you could set this
9805 variable to @code{("multipart/signed")} and leave
9806 @code{gnus-unbuttonized-mime-types} at the default value.
9808 You could also add @code{"multipart/alternative"} to this list to
9809 display radio buttons that allow you to choose one of two media types
9810 those mails include. See also @code{mm-discouraged-alternatives}
9811 (@pxref{Display Customization, ,Display Customization, emacs-mime, The
9812 Emacs MIME Manual}).
9814 @item gnus-inhibit-mime-unbuttonizing
9815 @vindex gnus-inhibit-mime-unbuttonizing
9816 If this is non-@code{nil}, then all @acronym{MIME} parts get buttons. The
9817 default value is @code{nil}.
9819 @item gnus-article-mime-part-function
9820 @vindex gnus-article-mime-part-function
9821 For each @acronym{MIME} part, this function will be called with the @acronym{MIME}
9822 handle as the parameter. The function is meant to be used to allow
9823 users to gather information from the article (e. g., add Vcard info to
9824 the bbdb database) or to do actions based on parts (e. g., automatically
9825 save all jpegs into some directory).
9827 Here's an example function the does the latter:
9830 (defun my-save-all-jpeg-parts (handle)
9831 (when (equal (car (mm-handle-type handle)) "image/jpeg")
9833 (insert (mm-get-part handle))
9834 (write-region (point-min) (point-max)
9835 (read-file-name "Save jpeg to: ")))))
9836 (setq gnus-article-mime-part-function
9837 'my-save-all-jpeg-parts)
9840 @vindex gnus-mime-multipart-functions
9841 @item gnus-mime-multipart-functions
9842 Alist of @acronym{MIME} multipart types and functions to handle them.
9844 @vindex gnus-mime-display-multipart-alternative-as-mixed
9845 @item gnus-mime-display-multipart-alternative-as-mixed
9846 Display "multipart/alternative" parts as "multipart/mixed".
9848 @vindex gnus-mime-display-multipart-related-as-mixed
9849 @item gnus-mime-display-multipart-related-as-mixed
9850 Display "multipart/related" parts as "multipart/mixed".
9852 If displaying "text/html" is discouraged, see
9853 @code{mm-discouraged-alternatives}, images or other material inside a
9854 "multipart/related" part might be overlooked when this variable is
9855 @code{nil}. @ref{Display Customization, Display Customization, ,
9856 emacs-mime, Emacs-Mime Manual}.
9858 @vindex gnus-mime-display-multipart-as-mixed
9859 @item gnus-mime-display-multipart-as-mixed
9860 Display "multipart" parts as "multipart/mixed". If @code{t}, it
9861 overrides @code{nil} values of
9862 @code{gnus-mime-display-multipart-alternative-as-mixed} and
9863 @code{gnus-mime-display-multipart-related-as-mixed}.
9865 @vindex mm-file-name-rewrite-functions
9866 @item mm-file-name-rewrite-functions
9867 List of functions used for rewriting file names of @acronym{MIME} parts.
9868 Each function takes a file name as input and returns a file name.
9870 Ready-made functions include@*
9871 @code{mm-file-name-delete-whitespace},
9872 @code{mm-file-name-trim-whitespace},
9873 @code{mm-file-name-collapse-whitespace}, and
9874 @code{mm-file-name-replace-whitespace}. The later uses the value of
9875 the variable @code{mm-file-name-replace-whitespace} to replace each
9876 whitespace character in a file name with that string; default value
9877 is @code{"_"} (a single underscore).
9878 @findex mm-file-name-delete-whitespace
9879 @findex mm-file-name-trim-whitespace
9880 @findex mm-file-name-collapse-whitespace
9881 @findex mm-file-name-replace-whitespace
9882 @vindex mm-file-name-replace-whitespace
9884 The standard functions @code{capitalize}, @code{downcase},
9885 @code{upcase}, and @code{upcase-initials} may be useful, too.
9887 Everybody knows that whitespace characters in file names are evil,
9888 except those who don't know. If you receive lots of attachments from
9889 such unenlightened users, you can make live easier by adding
9892 (setq mm-file-name-rewrite-functions
9893 '(mm-file-name-trim-whitespace
9894 mm-file-name-collapse-whitespace
9895 mm-file-name-replace-whitespace))
9899 to your @file{~/.gnus.el} file.
9908 People use different charsets, and we have @acronym{MIME} to let us know what
9909 charsets they use. Or rather, we wish we had. Many people use
9910 newsreaders and mailers that do not understand or use @acronym{MIME}, and
9911 just send out messages without saying what character sets they use. To
9912 help a bit with this, some local news hierarchies have policies that say
9913 what character set is the default. For instance, the @samp{fj}
9914 hierarchy uses @code{iso-2022-jp}.
9916 @vindex gnus-group-charset-alist
9917 This knowledge is encoded in the @code{gnus-group-charset-alist}
9918 variable, which is an alist of regexps (use the first item to match full
9919 group names) and default charsets to be used when reading these groups.
9921 @vindex gnus-newsgroup-ignored-charsets
9922 In addition, some people do use soi-disant @acronym{MIME}-aware agents that
9923 aren't. These blithely mark messages as being in @code{iso-8859-1}
9924 even if they really are in @code{koi-8}. To help here, the
9925 @code{gnus-newsgroup-ignored-charsets} variable can be used. The
9926 charsets that are listed here will be ignored. The variable can be
9927 set on a group-by-group basis using the group parameters (@pxref{Group
9928 Parameters}). The default value is @code{(unknown-8bit x-unknown)},
9929 which includes values some agents insist on having in there.
9931 @vindex gnus-group-posting-charset-alist
9932 When posting, @code{gnus-group-posting-charset-alist} is used to
9933 determine which charsets should not be encoded using the @acronym{MIME}
9934 encodings. For instance, some hierarchies discourage using
9935 quoted-printable header encoding.
9937 This variable is an alist of regexps and permitted unencoded charsets
9938 for posting. Each element of the alist has the form @code{(}@var{test
9939 header body-list}@code{)}, where:
9943 is either a regular expression matching the newsgroup header or a
9946 is the charset which may be left unencoded in the header (@code{nil}
9947 means encode all charsets),
9949 is a list of charsets which may be encoded using 8bit content-transfer
9950 encoding in the body, or one of the special values @code{nil} (always
9951 encode using quoted-printable) or @code{t} (always use 8bit).
9958 @cindex coding system aliases
9959 @cindex preferred charset
9961 @xref{Encoding Customization, , Encoding Customization, emacs-mime,
9962 The Emacs MIME Manual}, for additional variables that control which
9963 MIME charsets are used when sending messages.
9965 Other charset tricks that may be useful, although not Gnus-specific:
9967 If there are several @acronym{MIME} charsets that encode the same Emacs
9968 charset, you can choose what charset to use by saying the following:
9971 (put-charset-property 'cyrillic-iso8859-5
9972 'preferred-coding-system 'koi8-r)
9975 This means that Russian will be encoded using @code{koi8-r} instead of
9976 the default @code{iso-8859-5} @acronym{MIME} charset.
9978 If you want to read messages in @code{koi8-u}, you can cheat and say
9981 (define-coding-system-alias 'koi8-u 'koi8-r)
9984 This will almost do the right thing.
9986 And finally, to read charsets like @code{windows-1251}, you can say
9990 (codepage-setup 1251)
9991 (define-coding-system-alias 'windows-1251 'cp1251)
9995 @node Article Commands
9996 @section Article Commands
10003 @kindex A P (Summary)
10004 @vindex gnus-ps-print-hook
10005 @findex gnus-summary-print-article
10006 Generate and print a PostScript image of the article buffer
10007 (@code{gnus-summary-print-article}). @code{gnus-ps-print-hook} will
10008 be run just before printing the buffer. An alternative way to print
10009 article is to use Muttprint (@pxref{Saving Articles}).
10014 @node Summary Sorting
10015 @section Summary Sorting
10016 @cindex summary sorting
10018 You can have the summary buffer sorted in various ways, even though I
10019 can't really see why you'd want that.
10024 @kindex C-c C-s C-n (Summary)
10025 @findex gnus-summary-sort-by-number
10026 Sort by article number (@code{gnus-summary-sort-by-number}).
10029 @kindex C-c C-s C-a (Summary)
10030 @findex gnus-summary-sort-by-author
10031 Sort by author (@code{gnus-summary-sort-by-author}).
10034 @kindex C-c C-s C-t (Summary)
10035 @findex gnus-summary-sort-by-recipient
10036 Sort by recipient (@code{gnus-summary-sort-by-recipient}).
10039 @kindex C-c C-s C-s (Summary)
10040 @findex gnus-summary-sort-by-subject
10041 Sort by subject (@code{gnus-summary-sort-by-subject}).
10044 @kindex C-c C-s C-d (Summary)
10045 @findex gnus-summary-sort-by-date
10046 Sort by date (@code{gnus-summary-sort-by-date}).
10049 @kindex C-c C-s C-l (Summary)
10050 @findex gnus-summary-sort-by-lines
10051 Sort by lines (@code{gnus-summary-sort-by-lines}).
10054 @kindex C-c C-s C-c (Summary)
10055 @findex gnus-summary-sort-by-chars
10056 Sort by article length (@code{gnus-summary-sort-by-chars}).
10059 @kindex C-c C-s C-i (Summary)
10060 @findex gnus-summary-sort-by-score
10061 Sort by score (@code{gnus-summary-sort-by-score}).
10064 @kindex C-c C-s C-r (Summary)
10065 @findex gnus-summary-sort-by-random
10066 Randomize (@code{gnus-summary-sort-by-random}).
10069 @kindex C-c C-s C-o (Summary)
10070 @findex gnus-summary-sort-by-original
10071 Sort using the default sorting method
10072 (@code{gnus-summary-sort-by-original}).
10075 These functions will work both when you use threading and when you don't
10076 use threading. In the latter case, all summary lines will be sorted,
10077 line by line. In the former case, sorting will be done on a
10078 root-by-root basis, which might not be what you were looking for. To
10079 toggle whether to use threading, type @kbd{T T} (@pxref{Thread
10083 @node Finding the Parent
10084 @section Finding the Parent
10085 @cindex parent articles
10086 @cindex referring articles
10090 @kindex ^ (Summary)
10091 @findex gnus-summary-refer-parent-article
10092 If you'd like to read the parent of the current article, and it is not
10093 displayed in the summary buffer, you might still be able to. That is,
10094 if the current group is fetched by @acronym{NNTP}, the parent hasn't expired
10095 and the @code{References} in the current article are not mangled, you
10096 can just press @kbd{^} or @kbd{A r}
10097 (@code{gnus-summary-refer-parent-article}). If everything goes well,
10098 you'll get the parent. If the parent is already displayed in the
10099 summary buffer, point will just move to this article.
10101 If given a positive numerical prefix, fetch that many articles back into
10102 the ancestry. If given a negative numerical prefix, fetch just that
10103 ancestor. So if you say @kbd{3 ^}, Gnus will fetch the parent, the
10104 grandparent and the grandgrandparent of the current article. If you say
10105 @kbd{-3 ^}, Gnus will only fetch the grandgrandparent of the current
10108 @item A R (Summary)
10109 @findex gnus-summary-refer-references
10110 @kindex A R (Summary)
10111 Fetch all articles mentioned in the @code{References} header of the
10112 article (@code{gnus-summary-refer-references}).
10114 @item A T (Summary)
10115 @findex gnus-summary-refer-thread
10116 @kindex A T (Summary)
10117 Display the full thread where the current article appears
10118 (@code{gnus-summary-refer-thread}). This command has to fetch all the
10119 headers in the current group to work, so it usually takes a while. If
10120 you do it often, you may consider setting @code{gnus-fetch-old-headers}
10121 to @code{invisible} (@pxref{Filling In Threads}). This won't have any
10122 visible effects normally, but it'll make this command work a whole lot
10123 faster. Of course, it'll make group entry somewhat slow.
10125 @vindex gnus-refer-thread-limit
10126 The @code{gnus-refer-thread-limit} variable says how many old (i. e.,
10127 articles before the first displayed in the current group) headers to
10128 fetch when doing this command. The default is 200. If @code{t}, all
10129 the available headers will be fetched. This variable can be overridden
10130 by giving the @kbd{A T} command a numerical prefix.
10132 @item M-^ (Summary)
10133 @findex gnus-summary-refer-article
10134 @kindex M-^ (Summary)
10136 @cindex fetching by Message-ID
10137 You can also ask Gnus for an arbitrary article, no matter what group it
10138 belongs to. @kbd{M-^} (@code{gnus-summary-refer-article}) will ask you
10139 for a @code{Message-ID}, which is one of those long, hard-to-read
10140 thingies that look something like @samp{<38o6up$6f2@@hymir.ifi.uio.no>}.
10141 You have to get it all exactly right. No fuzzy searches, I'm afraid.
10143 Gnus looks for the @code{Message-ID} in the headers that have already
10144 been fetched, but also tries all the select methods specified by
10145 @code{gnus-refer-article-method} if it is not found.
10148 @vindex gnus-refer-article-method
10149 If the group you are reading is located on a back end that does not
10150 support fetching by @code{Message-ID} very well (like @code{nnspool}),
10151 you can set @code{gnus-refer-article-method} to an @acronym{NNTP} method. It
10152 would, perhaps, be best if the @acronym{NNTP} server you consult is the one
10153 updating the spool you are reading from, but that's not really
10156 It can also be a list of select methods, as well as the special symbol
10157 @code{current}, which means to use the current select method. If it
10158 is a list, Gnus will try all the methods in the list until it finds a
10161 Here's an example setting that will first try the current method, and
10162 then ask Google if that fails:
10165 (setq gnus-refer-article-method
10167 (nnweb "google" (nnweb-type google))))
10170 Most of the mail back ends support fetching by @code{Message-ID}, but
10171 do not do a particularly excellent job at it. That is, @code{nnmbox},
10172 @code{nnbabyl}, @code{nnmaildir}, @code{nnml}, are able to locate
10173 articles from any groups, while @code{nnfolder}, and @code{nnimap} are
10174 only able to locate articles that have been posted to the current
10175 group. (Anything else would be too time consuming.) @code{nnmh} does
10176 not support this at all.
10179 @node Alternative Approaches
10180 @section Alternative Approaches
10182 Different people like to read news using different methods. This being
10183 Gnus, we offer a small selection of minor modes for the summary buffers.
10186 * Pick and Read:: First mark articles and then read them.
10187 * Binary Groups:: Auto-decode all articles.
10191 @node Pick and Read
10192 @subsection Pick and Read
10193 @cindex pick and read
10195 Some newsreaders (like @code{nn} and, uhm, @code{Netnews} on VM/CMS) use
10196 a two-phased reading interface. The user first marks in a summary
10197 buffer the articles she wants to read. Then she starts reading the
10198 articles with just an article buffer displayed.
10200 @findex gnus-pick-mode
10201 @kindex M-x gnus-pick-mode
10202 Gnus provides a summary buffer minor mode that allows
10203 this---@code{gnus-pick-mode}. This basically means that a few process
10204 mark commands become one-keystroke commands to allow easy marking, and
10205 it provides one additional command for switching to the summary buffer.
10207 Here are the available keystrokes when using pick mode:
10212 @findex gnus-pick-article-or-thread
10213 Pick the article or thread on the current line
10214 (@code{gnus-pick-article-or-thread}). If the variable
10215 @code{gnus-thread-hide-subtree} is true, then this key selects the
10216 entire thread when used at the first article of the thread. Otherwise,
10217 it selects just the article. If given a numerical prefix, go to that
10218 thread or article and pick it. (The line number is normally displayed
10219 at the beginning of the summary pick lines.)
10222 @kindex SPACE (Pick)
10223 @findex gnus-pick-next-page
10224 Scroll the summary buffer up one page (@code{gnus-pick-next-page}). If
10225 at the end of the buffer, start reading the picked articles.
10229 @findex gnus-pick-unmark-article-or-thread.
10230 Unpick the thread or article
10231 (@code{gnus-pick-unmark-article-or-thread}). If the variable
10232 @code{gnus-thread-hide-subtree} is true, then this key unpicks the
10233 thread if used at the first article of the thread. Otherwise it unpicks
10234 just the article. You can give this key a numerical prefix to unpick
10235 the thread or article at that line.
10239 @findex gnus-pick-start-reading
10240 @vindex gnus-pick-display-summary
10241 Start reading the picked articles (@code{gnus-pick-start-reading}). If
10242 given a prefix, mark all unpicked articles as read first. If
10243 @code{gnus-pick-display-summary} is non-@code{nil}, the summary buffer
10244 will still be visible when you are reading.
10248 All the normal summary mode commands are still available in the
10249 pick-mode, with the exception of @kbd{u}. However @kbd{!} is available
10250 which is mapped to the same function
10251 @code{gnus-summary-tick-article-forward}.
10253 If this sounds like a good idea to you, you could say:
10256 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
10259 @vindex gnus-pick-mode-hook
10260 @code{gnus-pick-mode-hook} is run in pick minor mode buffers.
10262 @vindex gnus-mark-unpicked-articles-as-read
10263 If @code{gnus-mark-unpicked-articles-as-read} is non-@code{nil}, mark
10264 all unpicked articles as read. The default is @code{nil}.
10266 @vindex gnus-summary-pick-line-format
10267 The summary line format in pick mode is slightly different from the
10268 standard format. At the beginning of each line the line number is
10269 displayed. The pick mode line format is controlled by the
10270 @code{gnus-summary-pick-line-format} variable (@pxref{Formatting
10271 Variables}). It accepts the same format specs that
10272 @code{gnus-summary-line-format} does (@pxref{Summary Buffer Lines}).
10275 @node Binary Groups
10276 @subsection Binary Groups
10277 @cindex binary groups
10279 @findex gnus-binary-mode
10280 @kindex M-x gnus-binary-mode
10281 If you spend much time in binary groups, you may grow tired of hitting
10282 @kbd{X u}, @kbd{n}, @kbd{RET} all the time. @kbd{M-x gnus-binary-mode}
10283 is a minor mode for summary buffers that makes all ordinary Gnus article
10284 selection functions uudecode series of articles and display the result
10285 instead of just displaying the articles the normal way.
10288 @findex gnus-binary-show-article
10289 The only way, in fact, to see the actual articles is the @kbd{g}
10290 command, when you have turned on this mode
10291 (@code{gnus-binary-show-article}).
10293 @vindex gnus-binary-mode-hook
10294 @code{gnus-binary-mode-hook} is called in binary minor mode buffers.
10298 @section Tree Display
10301 @vindex gnus-use-trees
10302 If you don't like the normal Gnus summary display, you might try setting
10303 @code{gnus-use-trees} to @code{t}. This will create (by default) an
10304 additional @dfn{tree buffer}. You can execute all summary mode commands
10305 in the tree buffer.
10307 There are a few variables to customize the tree display, of course:
10310 @item gnus-tree-mode-hook
10311 @vindex gnus-tree-mode-hook
10312 A hook called in all tree mode buffers.
10314 @item gnus-tree-mode-line-format
10315 @vindex gnus-tree-mode-line-format
10316 A format string for the mode bar in the tree mode buffers (@pxref{Mode
10317 Line Formatting}). The default is @samp{Gnus: %%b %S %Z}. For a list
10318 of valid specs, @pxref{Summary Buffer Mode Line}.
10320 @item gnus-selected-tree-face
10321 @vindex gnus-selected-tree-face
10322 Face used for highlighting the selected article in the tree buffer. The
10323 default is @code{modeline}.
10325 @item gnus-tree-line-format
10326 @vindex gnus-tree-line-format
10327 A format string for the tree nodes. The name is a bit of a misnomer,
10328 though---it doesn't define a line, but just the node. The default value
10329 is @samp{%(%[%3,3n%]%)}, which displays the first three characters of
10330 the name of the poster. It is vital that all nodes are of the same
10331 length, so you @emph{must} use @samp{%4,4n}-like specifiers.
10337 The name of the poster.
10339 The @code{From} header.
10341 The number of the article.
10343 The opening bracket.
10345 The closing bracket.
10350 @xref{Formatting Variables}.
10352 Variables related to the display are:
10355 @item gnus-tree-brackets
10356 @vindex gnus-tree-brackets
10357 This is used for differentiating between ``real'' articles and
10358 ``sparse'' articles. The format is
10360 ((@var{real-open} . @var{real-close})
10361 (@var{sparse-open} . @var{sparse-close})
10362 (@var{dummy-open} . @var{dummy-close}))
10364 and the default is @code{((?[ . ?]) (?( . ?)) (?@{ . ?@}) (?< . ?>))}.
10366 @item gnus-tree-parent-child-edges
10367 @vindex gnus-tree-parent-child-edges
10368 This is a list that contains the characters used for connecting parent
10369 nodes to their children. The default is @code{(?- ?\\ ?|)}.
10373 @item gnus-tree-minimize-window
10374 @vindex gnus-tree-minimize-window
10375 If this variable is non-@code{nil}, Gnus will try to keep the tree
10376 buffer as small as possible to allow more room for the other Gnus
10377 windows. If this variable is a number, the tree buffer will never be
10378 higher than that number. The default is @code{t}. Note that if you
10379 have several windows displayed side-by-side in a frame and the tree
10380 buffer is one of these, minimizing the tree window will also resize all
10381 other windows displayed next to it.
10383 You may also wish to add the following hook to keep the window minimized
10387 (add-hook 'gnus-configure-windows-hook
10388 'gnus-tree-perhaps-minimize)
10391 @item gnus-generate-tree-function
10392 @vindex gnus-generate-tree-function
10393 @findex gnus-generate-horizontal-tree
10394 @findex gnus-generate-vertical-tree
10395 The function that actually generates the thread tree. Two predefined
10396 functions are available: @code{gnus-generate-horizontal-tree} and
10397 @code{gnus-generate-vertical-tree} (which is the default).
10401 Here's an example from a horizontal tree buffer:
10404 @{***@}-(***)-[odd]-[Gun]
10414 Here's the same thread displayed in a vertical tree buffer:
10419 |--------------------------\-----\-----\
10420 (***) [Bjo] [Gun] [Gun]
10422 [odd] [Jan] [odd] (***) [Jor]
10424 [Gun] [Eri] [Eri] [odd]
10430 If you're using horizontal trees, it might be nice to display the trees
10431 side-by-side with the summary buffer. You could add something like the
10432 following to your @file{~/.gnus.el} file:
10435 (setq gnus-use-trees t
10436 gnus-generate-tree-function 'gnus-generate-horizontal-tree
10437 gnus-tree-minimize-window nil)
10438 (gnus-add-configuration
10442 (summary 0.75 point)
10447 @xref{Window Layout}.
10450 @node Mail Group Commands
10451 @section Mail Group Commands
10452 @cindex mail group commands
10454 Some commands only make sense in mail groups. If these commands are
10455 invalid in the current group, they will raise a hell and let you know.
10457 All these commands (except the expiry and edit commands) use the
10458 process/prefix convention (@pxref{Process/Prefix}).
10463 @kindex B e (Summary)
10464 @findex gnus-summary-expire-articles
10465 @cindex expiring mail
10466 Run all expirable articles in the current group through the expiry
10467 process (@code{gnus-summary-expire-articles}). That is, delete all
10468 expirable articles in the group that have been around for a while.
10469 (@pxref{Expiring Mail}).
10472 @kindex B C-M-e (Summary)
10473 @findex gnus-summary-expire-articles-now
10474 @cindex expiring mail
10475 Delete all the expirable articles in the group
10476 (@code{gnus-summary-expire-articles-now}). This means that @strong{all}
10477 articles eligible for expiry in the current group will
10478 disappear forever into that big @file{/dev/null} in the sky.
10481 @kindex B DEL (Summary)
10482 @findex gnus-summary-delete-article
10483 @c @icon{gnus-summary-mail-delete}
10484 Delete the mail article. This is ``delete'' as in ``delete it from your
10485 disk forever and ever, never to return again.'' Use with caution.
10486 (@code{gnus-summary-delete-article}).
10489 @kindex B m (Summary)
10491 @findex gnus-summary-move-article
10492 @vindex gnus-preserve-marks
10493 Move the article from one mail group to another
10494 (@code{gnus-summary-move-article}). Marks will be preserved if
10495 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10498 @kindex B c (Summary)
10500 @findex gnus-summary-copy-article
10501 @c @icon{gnus-summary-mail-copy}
10502 Copy the article from one group (mail group or not) to a mail group
10503 (@code{gnus-summary-copy-article}). Marks will be preserved if
10504 @code{gnus-preserve-marks} is non-@code{nil} (which is the default).
10507 @kindex B B (Summary)
10508 @cindex crosspost mail
10509 @findex gnus-summary-crosspost-article
10510 Crosspost the current article to some other group
10511 (@code{gnus-summary-crosspost-article}). This will create a new copy of
10512 the article in the other group, and the Xref headers of the article will
10513 be properly updated.
10516 @kindex B i (Summary)
10517 @findex gnus-summary-import-article
10518 Import an arbitrary file into the current mail newsgroup
10519 (@code{gnus-summary-import-article}). You will be prompted for a file
10520 name, a @code{From} header and a @code{Subject} header.
10523 @kindex B I (Summary)
10524 @findex gnus-summary-create-article
10525 Create an empty article in the current mail newsgroups
10526 (@code{gnus-summary-create-article}). You will be prompted for a
10527 @code{From} header and a @code{Subject} header.
10530 @kindex B r (Summary)
10531 @findex gnus-summary-respool-article
10532 @vindex gnus-summary-respool-default-method
10533 Respool the mail article (@code{gnus-summary-respool-article}).
10534 @code{gnus-summary-respool-default-method} will be used as the default
10535 select method when respooling. This variable is @code{nil} by default,
10536 which means that the current group select method will be used instead.
10537 Marks will be preserved if @code{gnus-preserve-marks} is non-@code{nil}
10538 (which is the default).
10542 @kindex B w (Summary)
10543 @kindex e (Summary)
10544 @findex gnus-summary-edit-article
10545 @kindex C-c C-c (Article)
10546 @findex gnus-summary-edit-article-done
10547 Edit the current article (@code{gnus-summary-edit-article}). To finish
10548 editing and make the changes permanent, type @kbd{C-c C-c}
10549 (@code{gnus-summary-edit-article-done}). If you give a prefix to the
10550 @kbd{C-c C-c} command, Gnus won't re-highlight the article.
10553 @kindex B q (Summary)
10554 @findex gnus-summary-respool-query
10555 If you want to re-spool an article, you might be curious as to what group
10556 the article will end up in before you do the re-spooling. This command
10557 will tell you (@code{gnus-summary-respool-query}).
10560 @kindex B t (Summary)
10561 @findex gnus-summary-respool-trace
10562 Similarly, this command will display all fancy splitting patterns used
10563 when respooling, if any (@code{gnus-summary-respool-trace}).
10566 @kindex B p (Summary)
10567 @findex gnus-summary-article-posted-p
10568 Some people have a tendency to send you ``courtesy'' copies when they
10569 follow up to articles you have posted. These usually have a
10570 @code{Newsgroups} header in them, but not always. This command
10571 (@code{gnus-summary-article-posted-p}) will try to fetch the current
10572 article from your news server (or rather, from
10573 @code{gnus-refer-article-method} or @code{gnus-select-method}) and will
10574 report back whether it found the article or not. Even if it says that
10575 it didn't find the article, it may have been posted anyway---mail
10576 propagation is much faster than news propagation, and the news copy may
10577 just not have arrived yet.
10580 @kindex K E (Summary)
10581 @findex gnus-article-encrypt-body
10582 @vindex gnus-article-encrypt-protocol
10583 Encrypt the body of an article (@code{gnus-article-encrypt-body}).
10584 The body is encrypted with the encryption protocol specified by the
10585 variable @code{gnus-article-encrypt-protocol}.
10589 @vindex gnus-move-split-methods
10590 @cindex moving articles
10591 If you move (or copy) articles regularly, you might wish to have Gnus
10592 suggest where to put the articles. @code{gnus-move-split-methods} is a
10593 variable that uses the same syntax as @code{gnus-split-methods}
10594 (@pxref{Saving Articles}). You may customize that variable to create
10595 suggestions you find reasonable. (Note that
10596 @code{gnus-move-split-methods} uses group names where
10597 @code{gnus-split-methods} uses file names.)
10600 (setq gnus-move-split-methods
10601 '(("^From:.*Lars Magne" "nnml:junk")
10602 ("^Subject:.*gnus" "nnfolder:important")
10603 (".*" "nnml:misc")))
10607 @node Various Summary Stuff
10608 @section Various Summary Stuff
10611 * Summary Group Information:: Information oriented commands.
10612 * Searching for Articles:: Multiple article commands.
10613 * Summary Generation Commands::
10614 * Really Various Summary Commands:: Those pesky non-conformant commands.
10618 @vindex gnus-summary-display-while-building
10619 @item gnus-summary-display-while-building
10620 If non-@code{nil}, show and update the summary buffer as it's being
10621 built. If @code{t}, update the buffer after every line is inserted.
10622 If the value is an integer, @var{n}, update the display every @var{n}
10623 lines. The default is @code{nil}.
10625 @vindex gnus-summary-display-arrow
10626 @item gnus-summary-display-arrow
10627 If non-@code{nil}, display an arrow in the fringe to indicate the
10630 @vindex gnus-summary-mode-hook
10631 @item gnus-summary-mode-hook
10632 This hook is called when creating a summary mode buffer.
10634 @vindex gnus-summary-generate-hook
10635 @item gnus-summary-generate-hook
10636 This is called as the last thing before doing the threading and the
10637 generation of the summary buffer. It's quite convenient for customizing
10638 the threading variables based on what data the newsgroup has. This hook
10639 is called from the summary buffer after most summary buffer variables
10642 @vindex gnus-summary-prepare-hook
10643 @item gnus-summary-prepare-hook
10644 It is called after the summary buffer has been generated. You might use
10645 it to, for instance, highlight lines or modify the look of the buffer in
10646 some other ungodly manner. I don't care.
10648 @vindex gnus-summary-prepared-hook
10649 @item gnus-summary-prepared-hook
10650 A hook called as the very last thing after the summary buffer has been
10653 @vindex gnus-summary-ignore-duplicates
10654 @item gnus-summary-ignore-duplicates
10655 When Gnus discovers two articles that have the same @code{Message-ID},
10656 it has to do something drastic. No articles are allowed to have the
10657 same @code{Message-ID}, but this may happen when reading mail from some
10658 sources. Gnus allows you to customize what happens with this variable.
10659 If it is @code{nil} (which is the default), Gnus will rename the
10660 @code{Message-ID} (for display purposes only) and display the article as
10661 any other article. If this variable is @code{t}, it won't display the
10662 article---it'll be as if it never existed.
10664 @vindex gnus-alter-articles-to-read-function
10665 @item gnus-alter-articles-to-read-function
10666 This function, which takes two parameters (the group name and the list
10667 of articles to be selected), is called to allow the user to alter the
10668 list of articles to be selected.
10670 For instance, the following function adds the list of cached articles to
10671 the list in one particular group:
10674 (defun my-add-cached-articles (group articles)
10675 (if (string= group "some.group")
10676 (append gnus-newsgroup-cached articles)
10680 @vindex gnus-newsgroup-variables
10681 @item gnus-newsgroup-variables
10682 A list of newsgroup (summary buffer) local variables, or cons of
10683 variables and their default expressions to be evalled (when the default
10684 values are not @code{nil}), that should be made global while the summary
10687 Note: The default expressions will be evaluated (using function
10688 @code{eval}) before assignment to the local variable rather than just
10689 assigned to it. If the default expression is the symbol @code{global},
10690 that symbol will not be evaluated but the global value of the local
10691 variable will be used instead.
10693 These variables can be used to set variables in the group parameters
10694 while still allowing them to affect operations done in other
10695 buffers. For example:
10698 (setq gnus-newsgroup-variables
10699 '(message-use-followup-to
10700 (gnus-visible-headers .
10701 "^From:\\|^Newsgroups:\\|^Subject:\\|^Date:\\|^To:")))
10704 Also @pxref{Group Parameters}.
10708 @node Summary Group Information
10709 @subsection Summary Group Information
10714 @kindex H f (Summary)
10715 @findex gnus-summary-fetch-faq
10716 @vindex gnus-group-faq-directory
10717 Try to fetch the @acronym{FAQ} (list of frequently asked questions)
10718 for the current group (@code{gnus-summary-fetch-faq}). Gnus will try
10719 to get the @acronym{FAQ} from @code{gnus-group-faq-directory}, which
10720 is usually a directory on a remote machine. This variable can also be
10721 a list of directories. In that case, giving a prefix to this command
10722 will allow you to choose between the various sites. @code{ange-ftp}
10723 or @code{efs} will probably be used for fetching the file.
10726 @kindex H d (Summary)
10727 @findex gnus-summary-describe-group
10728 Give a brief description of the current group
10729 (@code{gnus-summary-describe-group}). If given a prefix, force
10730 rereading the description from the server.
10733 @kindex H h (Summary)
10734 @findex gnus-summary-describe-briefly
10735 Give an extremely brief description of the most important summary
10736 keystrokes (@code{gnus-summary-describe-briefly}).
10739 @kindex H i (Summary)
10740 @findex gnus-info-find-node
10741 Go to the Gnus info node (@code{gnus-info-find-node}).
10745 @node Searching for Articles
10746 @subsection Searching for Articles
10751 @kindex M-s (Summary)
10752 @findex gnus-summary-search-article-forward
10753 Search through all subsequent (raw) articles for a regexp
10754 (@code{gnus-summary-search-article-forward}).
10757 @kindex M-r (Summary)
10758 @findex gnus-summary-search-article-backward
10759 Search through all previous (raw) articles for a regexp
10760 (@code{gnus-summary-search-article-backward}).
10763 @kindex M-S (Summary)
10764 @findex gnus-summary-repeat-search-article-forward
10765 Repeat the previous search forwards
10766 (@code{gnus-summary-repeat-search-article-forward}).
10769 @kindex M-R (Summary)
10770 @findex gnus-summary-repeat-search-article-backward
10771 Repeat the previous search backwards
10772 (@code{gnus-summary-repeat-search-article-backward}).
10775 @kindex & (Summary)
10776 @findex gnus-summary-execute-command
10777 This command will prompt you for a header, a regular expression to match
10778 on this field, and a command to be executed if the match is made
10779 (@code{gnus-summary-execute-command}). If the header is an empty
10780 string, the match is done on the entire article. If given a prefix,
10781 search backward instead.
10783 For instance, @kbd{& RET some.*string RET #} will put the process mark on
10784 all articles that have heads or bodies that match @samp{some.*string}.
10787 @kindex M-& (Summary)
10788 @findex gnus-summary-universal-argument
10789 Perform any operation on all articles that have been marked with
10790 the process mark (@code{gnus-summary-universal-argument}).
10793 @node Summary Generation Commands
10794 @subsection Summary Generation Commands
10799 @kindex Y g (Summary)
10800 @findex gnus-summary-prepare
10801 Regenerate the current summary buffer (@code{gnus-summary-prepare}).
10804 @kindex Y c (Summary)
10805 @findex gnus-summary-insert-cached-articles
10806 Pull all cached articles (for the current group) into the summary buffer
10807 (@code{gnus-summary-insert-cached-articles}).
10810 @kindex Y d (Summary)
10811 @findex gnus-summary-insert-dormant-articles
10812 Pull all dormant articles (for the current group) into the summary buffer
10813 (@code{gnus-summary-insert-dormant-articles}).
10816 @kindex Y t (Summary)
10817 @findex gnus-summary-insert-ticked-articles
10818 Pull all ticked articles (for the current group) into the summary buffer
10819 (@code{gnus-summary-insert-ticked-articles}).
10824 @node Really Various Summary Commands
10825 @subsection Really Various Summary Commands
10831 @kindex C-d (Summary)
10832 @kindex A D (Summary)
10833 @findex gnus-summary-enter-digest-group
10834 If the current article is a collection of other articles (for instance,
10835 a digest), you might use this command to enter a group based on the that
10836 article (@code{gnus-summary-enter-digest-group}). Gnus will try to
10837 guess what article type is currently displayed unless you give a prefix
10838 to this command, which forces a ``digest'' interpretation. Basically,
10839 whenever you see a message that is a collection of other messages of
10840 some format, you @kbd{C-d} and read these messages in a more convenient
10843 @vindex gnus-auto-select-on-ephemeral-exit
10844 The variable @code{gnus-auto-select-on-ephemeral-exit} controls what
10845 article should be selected after exiting a digest group. Valid values
10850 Select the next article.
10853 Select the next unread article.
10855 @item next-noselect
10856 Move the cursor to the next article. This is the default.
10858 @item next-unread-noselect
10859 Move the cursor to the next unread article.
10862 If it has any other value or there is no next (unread) article, the
10863 article selected before entering to the digest group will appear.
10866 @kindex C-M-d (Summary)
10867 @findex gnus-summary-read-document
10868 This command is very similar to the one above, but lets you gather
10869 several documents into one biiig group
10870 (@code{gnus-summary-read-document}). It does this by opening several
10871 @code{nndoc} groups for each document, and then opening an
10872 @code{nnvirtual} group on top of these @code{nndoc} groups. This
10873 command understands the process/prefix convention
10874 (@pxref{Process/Prefix}).
10877 @kindex C-t (Summary)
10878 @findex gnus-summary-toggle-truncation
10879 Toggle truncation of summary lines
10880 (@code{gnus-summary-toggle-truncation}). This will probably confuse the
10881 line centering function in the summary buffer, so it's not a good idea
10882 to have truncation switched off while reading articles.
10885 @kindex = (Summary)
10886 @findex gnus-summary-expand-window
10887 Expand the summary buffer window (@code{gnus-summary-expand-window}).
10888 If given a prefix, force an @code{article} window configuration.
10891 @kindex C-M-e (Summary)
10892 @findex gnus-summary-edit-parameters
10893 Edit the group parameters (@pxref{Group Parameters}) of the current
10894 group (@code{gnus-summary-edit-parameters}).
10897 @kindex C-M-a (Summary)
10898 @findex gnus-summary-customize-parameters
10899 Customize the group parameters (@pxref{Group Parameters}) of the current
10900 group (@code{gnus-summary-customize-parameters}).
10905 @node Exiting the Summary Buffer
10906 @section Exiting the Summary Buffer
10907 @cindex summary exit
10908 @cindex exiting groups
10910 Exiting from the summary buffer will normally update all info on the
10911 group and return you to the group buffer.
10918 @kindex Z Z (Summary)
10919 @kindex Z Q (Summary)
10920 @kindex q (Summary)
10921 @findex gnus-summary-exit
10922 @vindex gnus-summary-exit-hook
10923 @vindex gnus-summary-prepare-exit-hook
10924 @vindex gnus-group-no-more-groups-hook
10925 @c @icon{gnus-summary-exit}
10926 Exit the current group and update all information on the group
10927 (@code{gnus-summary-exit}). @code{gnus-summary-prepare-exit-hook} is
10928 called before doing much of the exiting, which calls
10929 @code{gnus-summary-expire-articles} by default.
10930 @code{gnus-summary-exit-hook} is called after finishing the exit
10931 process. @code{gnus-group-no-more-groups-hook} is run when returning to
10932 group mode having no more (unread) groups.
10936 @kindex Z E (Summary)
10937 @kindex Q (Summary)
10938 @findex gnus-summary-exit-no-update
10939 Exit the current group without updating any information on the group
10940 (@code{gnus-summary-exit-no-update}).
10944 @kindex Z c (Summary)
10945 @kindex c (Summary)
10946 @findex gnus-summary-catchup-and-exit
10947 @c @icon{gnus-summary-catchup-and-exit}
10948 Mark all unticked articles in the group as read and then exit
10949 (@code{gnus-summary-catchup-and-exit}).
10952 @kindex Z C (Summary)
10953 @findex gnus-summary-catchup-all-and-exit
10954 Mark all articles, even the ticked ones, as read and then exit
10955 (@code{gnus-summary-catchup-all-and-exit}).
10958 @kindex Z n (Summary)
10959 @findex gnus-summary-catchup-and-goto-next-group
10960 Mark all articles as read and go to the next group
10961 (@code{gnus-summary-catchup-and-goto-next-group}).
10964 @kindex Z p (Summary)
10965 @findex gnus-summary-catchup-and-goto-prev-group
10966 Mark all articles as read and go to the previous group
10967 (@code{gnus-summary-catchup-and-goto-prev-group}).
10971 @kindex Z R (Summary)
10972 @kindex C-x C-s (Summary)
10973 @findex gnus-summary-reselect-current-group
10974 Exit this group, and then enter it again
10975 (@code{gnus-summary-reselect-current-group}). If given a prefix, select
10976 all articles, both read and unread.
10980 @kindex Z G (Summary)
10981 @kindex M-g (Summary)
10982 @findex gnus-summary-rescan-group
10983 @c @icon{gnus-summary-mail-get}
10984 Exit the group, check for new articles in the group, and select the
10985 group (@code{gnus-summary-rescan-group}). If given a prefix, select all
10986 articles, both read and unread.
10989 @kindex Z N (Summary)
10990 @findex gnus-summary-next-group
10991 Exit the group and go to the next group
10992 (@code{gnus-summary-next-group}).
10995 @kindex Z P (Summary)
10996 @findex gnus-summary-prev-group
10997 Exit the group and go to the previous group
10998 (@code{gnus-summary-prev-group}).
11001 @kindex Z s (Summary)
11002 @findex gnus-summary-save-newsrc
11003 Save the current number of read/marked articles in the dribble buffer
11004 and then save the dribble buffer (@code{gnus-summary-save-newsrc}). If
11005 given a prefix, also save the @file{.newsrc} file(s). Using this
11006 command will make exit without updating (the @kbd{Q} command) worthless.
11009 @vindex gnus-exit-group-hook
11010 @code{gnus-exit-group-hook} is called when you exit the current group
11011 with an ``updating'' exit. For instance @kbd{Q}
11012 (@code{gnus-summary-exit-no-update}) does not call this hook.
11014 @findex gnus-summary-wake-up-the-dead
11015 @findex gnus-dead-summary-mode
11016 @vindex gnus-kill-summary-on-exit
11017 If you're in the habit of exiting groups, and then changing your mind
11018 about it, you might set @code{gnus-kill-summary-on-exit} to @code{nil}.
11019 If you do that, Gnus won't kill the summary buffer when you exit it.
11020 (Quelle surprise!) Instead it will change the name of the buffer to
11021 something like @samp{*Dead Summary ... *} and install a minor mode
11022 called @code{gnus-dead-summary-mode}. Now, if you switch back to this
11023 buffer, you'll find that all keys are mapped to a function called
11024 @code{gnus-summary-wake-up-the-dead}. So tapping any keys in a dead
11025 summary buffer will result in a live, normal summary buffer.
11027 There will never be more than one dead summary buffer at any one time.
11029 @vindex gnus-use-cross-reference
11030 The data on the current group will be updated (which articles you have
11031 read, which articles you have replied to, etc.) when you exit the
11032 summary buffer. If the @code{gnus-use-cross-reference} variable is
11033 @code{t} (which is the default), articles that are cross-referenced to
11034 this group and are marked as read, will also be marked as read in the
11035 other subscribed groups they were cross-posted to. If this variable is
11036 neither @code{nil} nor @code{t}, the article will be marked as read in
11037 both subscribed and unsubscribed groups (@pxref{Crosspost Handling}).
11040 @node Crosspost Handling
11041 @section Crosspost Handling
11045 Marking cross-posted articles as read ensures that you'll never have to
11046 read the same article more than once. Unless, of course, somebody has
11047 posted it to several groups separately. Posting the same article to
11048 several groups (not cross-posting) is called @dfn{spamming}, and you are
11049 by law required to send nasty-grams to anyone who perpetrates such a
11050 heinous crime. You may want to try NoCeM handling to filter out spam
11053 Remember: Cross-posting is kinda ok, but posting the same article
11054 separately to several groups is not. Massive cross-posting (aka.
11055 @dfn{velveeta}) is to be avoided at all costs, and you can even use the
11056 @code{gnus-summary-mail-crosspost-complaint} command to complain about
11057 excessive crossposting (@pxref{Summary Mail Commands}).
11059 @cindex cross-posting
11061 @cindex @acronym{NOV}
11062 One thing that may cause Gnus to not do the cross-posting thing
11063 correctly is if you use an @acronym{NNTP} server that supports @sc{xover}
11064 (which is very nice, because it speeds things up considerably) which
11065 does not include the @code{Xref} header in its @acronym{NOV} lines. This is
11066 Evil, but all too common, alas, alack. Gnus tries to Do The Right Thing
11067 even with @sc{xover} by registering the @code{Xref} lines of all
11068 articles you actually read, but if you kill the articles, or just mark
11069 them as read without reading them, Gnus will not get a chance to snoop
11070 the @code{Xref} lines out of these articles, and will be unable to use
11071 the cross reference mechanism.
11073 @cindex LIST overview.fmt
11074 @cindex overview.fmt
11075 To check whether your @acronym{NNTP} server includes the @code{Xref} header
11076 in its overview files, try @samp{telnet your.nntp.server nntp},
11077 @samp{MODE READER} on @code{inn} servers, and then say @samp{LIST
11078 overview.fmt}. This may not work, but if it does, and the last line you
11079 get does not read @samp{Xref:full}, then you should shout and whine at
11080 your news admin until she includes the @code{Xref} header in the
11083 If you want Gnus to get the @code{Xref}s right all the time, you have to
11084 set @code{nntp-nov-is-evil} to @code{t}, which slows things down
11085 considerably. Also @pxref{Slow/Expensive Connection}.
11089 For an alternative approach, @pxref{Duplicate Suppression}.
11092 @node Duplicate Suppression
11093 @section Duplicate Suppression
11095 By default, Gnus tries to make sure that you don't have to read the same
11096 article more than once by utilizing the crossposting mechanism
11097 (@pxref{Crosspost Handling}). However, that simple and efficient
11098 approach may not work satisfactory for some users for various
11103 The @acronym{NNTP} server may fail to generate the @code{Xref} header. This
11104 is evil and not very common.
11107 The @acronym{NNTP} server may fail to include the @code{Xref} header in the
11108 @file{.overview} data bases. This is evil and all too common, alas.
11111 You may be reading the same group (or several related groups) from
11112 different @acronym{NNTP} servers.
11115 You may be getting mail that duplicates articles posted to groups.
11118 I'm sure there are other situations where @code{Xref} handling fails as
11119 well, but these four are the most common situations.
11121 If, and only if, @code{Xref} handling fails for you, then you may
11122 consider switching on @dfn{duplicate suppression}. If you do so, Gnus
11123 will remember the @code{Message-ID}s of all articles you have read or
11124 otherwise marked as read, and then, as if by magic, mark them as read
11125 all subsequent times you see them---in @emph{all} groups. Using this
11126 mechanism is quite likely to be somewhat inefficient, but not overly
11127 so. It's certainly preferable to reading the same articles more than
11130 Duplicate suppression is not a very subtle instrument. It's more like a
11131 sledge hammer than anything else. It works in a very simple
11132 fashion---if you have marked an article as read, it adds this Message-ID
11133 to a cache. The next time it sees this Message-ID, it will mark the
11134 article as read with the @samp{M} mark. It doesn't care what group it
11135 saw the article in.
11138 @item gnus-suppress-duplicates
11139 @vindex gnus-suppress-duplicates
11140 If non-@code{nil}, suppress duplicates.
11142 @item gnus-save-duplicate-list
11143 @vindex gnus-save-duplicate-list
11144 If non-@code{nil}, save the list of duplicates to a file. This will
11145 make startup and shutdown take longer, so the default is @code{nil}.
11146 However, this means that only duplicate articles read in a single Gnus
11147 session are suppressed.
11149 @item gnus-duplicate-list-length
11150 @vindex gnus-duplicate-list-length
11151 This variable says how many @code{Message-ID}s to keep in the duplicate
11152 suppression list. The default is 10000.
11154 @item gnus-duplicate-file
11155 @vindex gnus-duplicate-file
11156 The name of the file to store the duplicate suppression list in. The
11157 default is @file{~/News/suppression}.
11160 If you have a tendency to stop and start Gnus often, setting
11161 @code{gnus-save-duplicate-list} to @code{t} is probably a good idea. If
11162 you leave Gnus running for weeks on end, you may have it @code{nil}. On
11163 the other hand, saving the list makes startup and shutdown much slower,
11164 so that means that if you stop and start Gnus often, you should set
11165 @code{gnus-save-duplicate-list} to @code{nil}. Uhm. I'll leave this up
11166 to you to figure out, I think.
11171 Gnus is able to verify signed messages or decrypt encrypted messages.
11172 The formats that are supported are @acronym{PGP}, @acronym{PGP/MIME}
11173 and @acronym{S/MIME}, however you need some external programs to get
11178 To handle @acronym{PGP} and @acronym{PGP/MIME} messages, you have to
11179 install an OpenPGP implementation such as GnuPG. The Lisp interface
11180 to GnuPG included with Gnus is called PGG (@pxref{Top, ,PGG, pgg, PGG
11181 Manual}), but Mailcrypt and gpg.el are also supported.
11184 To handle @acronym{S/MIME} message, you need to install OpenSSL. OpenSSL 0.9.6
11185 or newer is recommended.
11189 The variables that control security functionality on reading messages
11193 @item mm-verify-option
11194 @vindex mm-verify-option
11195 Option of verifying signed parts. @code{never}, not verify;
11196 @code{always}, always verify; @code{known}, only verify known
11197 protocols. Otherwise, ask user.
11199 @item mm-decrypt-option
11200 @vindex mm-decrypt-option
11201 Option of decrypting encrypted parts. @code{never}, no decryption;
11202 @code{always}, always decrypt; @code{known}, only decrypt known
11203 protocols. Otherwise, ask user.
11206 @vindex mml1991-use
11207 Symbol indicating elisp interface to OpenPGP implementation for
11208 @acronym{PGP} messages. The default is @code{pgg}, but
11209 @code{mailcrypt} and @code{gpg} are also supported although
11213 @vindex mml2015-use
11214 Symbol indicating elisp interface to OpenPGP implementation for
11215 @acronym{PGP/MIME} messages. The default is @code{pgg}, but
11216 @code{mailcrypt} and @code{gpg} are also supported although
11221 By default the buttons that display security information are not
11222 shown, because they clutter reading the actual e-mail. You can type
11223 @kbd{K b} manually to display the information. Use the
11224 @code{gnus-buttonized-mime-types} and
11225 @code{gnus-unbuttonized-mime-types} variables to control this
11226 permanently. @ref{MIME Commands} for further details, and hints on
11227 how to customize these variables to always display security
11230 @cindex snarfing keys
11231 @cindex importing PGP keys
11232 @cindex PGP key ring import
11233 Snarfing OpenPGP keys (i.e., importing keys from articles into your
11234 key ring) is not supported explicitly through a menu item or command,
11235 rather Gnus do detect and label keys as @samp{application/pgp-keys},
11236 allowing you to specify whatever action you think is appropriate
11237 through the usual @acronym{MIME} infrastructure. You can use a
11238 @file{~/.mailcap} entry (@pxref{mailcap, , mailcap, emacs-mime, The
11239 Emacs MIME Manual}) such as the following to import keys using GNU
11240 Privacy Guard when you click on the @acronym{MIME} button
11241 (@pxref{Using MIME}).
11244 application/pgp-keys; gpg --import --interactive --verbose; needsterminal
11247 This happens to also be the default action defined in
11248 @code{mailcap-mime-data}.
11250 More information on how to set things for sending outgoing signed and
11251 encrypted messages up can be found in the message manual
11252 (@pxref{Security, ,Security, message, Message Manual}).
11255 @section Mailing List
11256 @cindex mailing list
11259 @kindex A M (summary)
11260 @findex gnus-mailing-list-insinuate
11261 Gnus understands some mailing list fields of RFC 2369. To enable it,
11262 add a @code{to-list} group parameter (@pxref{Group Parameters}),
11263 possibly using @kbd{A M} (@code{gnus-mailing-list-insinuate}) in the
11266 That enables the following commands to the summary buffer:
11271 @kindex C-c C-n h (Summary)
11272 @findex gnus-mailing-list-help
11273 Send a message to fetch mailing list help, if List-Help field exists.
11276 @kindex C-c C-n s (Summary)
11277 @findex gnus-mailing-list-subscribe
11278 Send a message to subscribe the mailing list, if List-Subscribe field exists.
11281 @kindex C-c C-n u (Summary)
11282 @findex gnus-mailing-list-unsubscribe
11283 Send a message to unsubscribe the mailing list, if List-Unsubscribe
11287 @kindex C-c C-n p (Summary)
11288 @findex gnus-mailing-list-post
11289 Post to the mailing list, if List-Post field exists.
11292 @kindex C-c C-n o (Summary)
11293 @findex gnus-mailing-list-owner
11294 Send a message to the mailing list owner, if List-Owner field exists.
11297 @kindex C-c C-n a (Summary)
11298 @findex gnus-mailing-list-archive
11299 Browse the mailing list archive, if List-Archive field exists.
11304 @node Article Buffer
11305 @chapter Article Buffer
11306 @cindex article buffer
11308 The articles are displayed in the article buffer, of which there is only
11309 one. All the summary buffers share the same article buffer unless you
11310 tell Gnus otherwise.
11313 * Hiding Headers:: Deciding what headers should be displayed.
11314 * Using MIME:: Pushing articles through @acronym{MIME} before reading them.
11315 * Customizing Articles:: Tailoring the look of the articles.
11316 * Article Keymap:: Keystrokes available in the article buffer.
11317 * Misc Article:: Other stuff.
11321 @node Hiding Headers
11322 @section Hiding Headers
11323 @cindex hiding headers
11324 @cindex deleting headers
11326 The top section of each article is the @dfn{head}. (The rest is the
11327 @dfn{body}, but you may have guessed that already.)
11329 @vindex gnus-show-all-headers
11330 There is a lot of useful information in the head: the name of the person
11331 who wrote the article, the date it was written and the subject of the
11332 article. That's well and nice, but there's also lots of information
11333 most people do not want to see---what systems the article has passed
11334 through before reaching you, the @code{Message-ID}, the
11335 @code{References}, etc. ad nauseam---and you'll probably want to get rid
11336 of some of those lines. If you want to keep all those lines in the
11337 article buffer, you can set @code{gnus-show-all-headers} to @code{t}.
11339 Gnus provides you with two variables for sifting headers:
11343 @item gnus-visible-headers
11344 @vindex gnus-visible-headers
11345 If this variable is non-@code{nil}, it should be a regular expression
11346 that says what headers you wish to keep in the article buffer. All
11347 headers that do not match this variable will be hidden.
11349 For instance, if you only want to see the name of the person who wrote
11350 the article and the subject, you'd say:
11353 (setq gnus-visible-headers "^From:\\|^Subject:")
11356 This variable can also be a list of regexps to match headers to
11359 @item gnus-ignored-headers
11360 @vindex gnus-ignored-headers
11361 This variable is the reverse of @code{gnus-visible-headers}. If this
11362 variable is set (and @code{gnus-visible-headers} is @code{nil}), it
11363 should be a regular expression that matches all lines that you want to
11364 hide. All lines that do not match this variable will remain visible.
11366 For instance, if you just want to get rid of the @code{References} line
11367 and the @code{Xref} line, you might say:
11370 (setq gnus-ignored-headers "^References:\\|^Xref:")
11373 This variable can also be a list of regexps to match headers to
11376 Note that if @code{gnus-visible-headers} is non-@code{nil}, this
11377 variable will have no effect.
11381 @vindex gnus-sorted-header-list
11382 Gnus can also sort the headers for you. (It does this by default.) You
11383 can control the sorting by setting the @code{gnus-sorted-header-list}
11384 variable. It is a list of regular expressions that says in what order
11385 the headers are to be displayed.
11387 For instance, if you want the name of the author of the article first,
11388 and then the subject, you might say something like:
11391 (setq gnus-sorted-header-list '("^From:" "^Subject:"))
11394 Any headers that are to remain visible, but are not listed in this
11395 variable, will be displayed in random order after all the headers listed in this variable.
11397 @findex gnus-article-hide-boring-headers
11398 @vindex gnus-boring-article-headers
11399 You can hide further boring headers by setting
11400 @code{gnus-treat-hide-boring-headers} to @code{head}. What this function
11401 does depends on the @code{gnus-boring-article-headers} variable. It's a
11402 list, but this list doesn't actually contain header names. Instead it
11403 lists various @dfn{boring conditions} that Gnus can check and remove
11406 These conditions are:
11409 Remove all empty headers.
11411 Remove the @code{Followup-To} header if it is identical to the
11412 @code{Newsgroups} header.
11414 Remove the @code{Reply-To} header if it lists the same addresses as
11415 the @code{From} header, or if the @code{broken-reply-to} group
11418 Remove the @code{Newsgroups} header if it only contains the current group
11421 Remove the @code{To} header if it only contains the address identical to
11422 the current group's @code{to-address} parameter.
11424 Remove the @code{To} header if it only contains the address identical to
11425 the current group's @code{to-list} parameter.
11427 Remove the @code{Cc} header if it only contains the address identical to
11428 the current group's @code{to-list} parameter.
11430 Remove the @code{Date} header if the article is less than three days
11433 Remove the @code{To} and/or @code{Cc} header if it is very long.
11435 Remove all @code{To} and/or @code{Cc} headers if there are more than one.
11438 To include these three elements, you could say something like:
11441 (setq gnus-boring-article-headers
11442 '(empty followup-to reply-to))
11445 This is also the default value for this variable.
11449 @section Using MIME
11450 @cindex @acronym{MIME}
11452 Mime is a standard for waving your hands through the air, aimlessly,
11453 while people stand around yawning.
11455 @acronym{MIME}, however, is a standard for encoding your articles, aimlessly,
11456 while all newsreaders die of fear.
11458 @acronym{MIME} may specify what character set the article uses, the encoding
11459 of the characters, and it also makes it possible to embed pictures and
11460 other naughty stuff in innocent-looking articles.
11462 @vindex gnus-display-mime-function
11463 @findex gnus-display-mime
11464 Gnus pushes @acronym{MIME} articles through @code{gnus-display-mime-function}
11465 to display the @acronym{MIME} parts. This is @code{gnus-display-mime} by
11466 default, which creates a bundle of clickable buttons that can be used to
11467 display, save and manipulate the @acronym{MIME} objects.
11469 The following commands are available when you have placed point over a
11470 @acronym{MIME} button:
11473 @findex gnus-article-press-button
11474 @item RET (Article)
11475 @kindex RET (Article)
11476 @itemx BUTTON-2 (Article)
11477 Toggle displaying of the @acronym{MIME} object
11478 (@code{gnus-article-press-button}). If built-in viewers can not display
11479 the object, Gnus resorts to external viewers in the @file{mailcap}
11480 files. If a viewer has the @samp{copiousoutput} specification, the
11481 object is displayed inline.
11483 @findex gnus-mime-view-part
11484 @item M-RET (Article)
11485 @kindex M-RET (Article)
11487 Prompt for a method, and then view the @acronym{MIME} object using this
11488 method (@code{gnus-mime-view-part}).
11490 @findex gnus-mime-view-part-as-type
11492 @kindex t (Article)
11493 View the @acronym{MIME} object as if it were a different @acronym{MIME} media type
11494 (@code{gnus-mime-view-part-as-type}).
11496 @findex gnus-mime-view-part-as-charset
11498 @kindex C (Article)
11499 Prompt for a charset, and then view the @acronym{MIME} object using this
11500 charset (@code{gnus-mime-view-part-as-charset}).
11502 @findex gnus-mime-save-part
11504 @kindex o (Article)
11505 Prompt for a file name, and then save the @acronym{MIME} object
11506 (@code{gnus-mime-save-part}).
11508 @findex gnus-mime-save-part-and-strip
11509 @item C-o (Article)
11510 @kindex C-o (Article)
11511 Prompt for a file name, then save the @acronym{MIME} object and strip it from
11512 the article. Then proceed to article editing, where a reasonable
11513 suggestion is being made on how the altered article should look
11514 like. The stripped @acronym{MIME} object will be referred via the
11515 message/external-body @acronym{MIME} type.
11516 (@code{gnus-mime-save-part-and-strip}).
11518 @findex gnus-mime-replace-part
11520 @kindex r (Article)
11521 Prompt for a file name, replace the @acronym{MIME} object with an
11522 external body refering to the file via the message/external-body
11523 @acronym{MIME} type. (@code{gnus-mime-replace-part}).
11525 @findex gnus-mime-delete-part
11527 @kindex d (Article)
11528 Delete the @acronym{MIME} object from the article and replace it with some
11529 information about the removed @acronym{MIME} object
11530 (@code{gnus-mime-delete-part}).
11532 @c FIXME: gnus-auto-select-part should be documented here
11534 @findex gnus-mime-copy-part
11536 @kindex c (Article)
11537 Copy the @acronym{MIME} object to a fresh buffer and display this buffer
11538 (@code{gnus-mime-copy-part}). If given a prefix, copy the raw contents
11539 without decoding. If given a numerical prefix, you can do semi-manual
11540 charset stuff (see @code{gnus-summary-show-article-charset-alist} in
11541 @ref{Paging the Article}). Compressed files like @file{.gz} and
11542 @file{.bz2} are automatically decompressed if
11543 @code{auto-compression-mode} is enabled (@pxref{Compressed Files,,
11544 Accessing Compressed Files, emacs, The Emacs Editor}).
11546 @findex gnus-mime-print-part
11548 @kindex p (Article)
11549 Print the @acronym{MIME} object (@code{gnus-mime-print-part}). This
11550 command respects the @samp{print=} specifications in the
11551 @file{.mailcap} file.
11553 @findex gnus-mime-inline-part
11555 @kindex i (Article)
11556 Insert the contents of the @acronym{MIME} object into the buffer
11557 (@code{gnus-mime-inline-part}) as text/plain. If given a prefix, insert
11558 the raw contents without decoding. If given a numerical prefix, you can
11559 do semi-manual charset stuff (see
11560 @code{gnus-summary-show-article-charset-alist} in @ref{Paging the
11561 Article}). Compressed files like @file{.gz} and @file{.bz2} are
11562 automatically decompressed depending on @code{jka-compr} regardless of
11563 @code{auto-compression-mode} (@pxref{Compressed Files,, Accessing
11564 Compressed Files, emacs, The Emacs Editor}).
11566 @findex gnus-mime-view-part-internally
11568 @kindex E (Article)
11569 View the @acronym{MIME} object with an internal viewer. If no internal
11570 viewer is available, use an external viewer
11571 (@code{gnus-mime-view-part-internally}).
11573 @findex gnus-mime-view-part-externally
11575 @kindex e (Article)
11576 View the @acronym{MIME} object with an external viewer.
11577 (@code{gnus-mime-view-part-externally}).
11579 @findex gnus-mime-pipe-part
11581 @kindex | (Article)
11582 Output the @acronym{MIME} object to a process (@code{gnus-mime-pipe-part}).
11584 @findex gnus-mime-action-on-part
11586 @kindex . (Article)
11587 Interactively run an action on the @acronym{MIME} object
11588 (@code{gnus-mime-action-on-part}).
11592 Gnus will display some @acronym{MIME} objects automatically. The way Gnus
11593 determines which parts to do this with is described in the Emacs
11594 @acronym{MIME} manual.
11596 It might be best to just use the toggling functions from the article
11597 buffer to avoid getting nasty surprises. (For instance, you enter the
11598 group @samp{alt.sing-a-long} and, before you know it, @acronym{MIME} has
11599 decoded the sound file in the article and some horrible sing-a-long song
11600 comes screaming out your speakers, and you can't find the volume button,
11601 because there isn't one, and people are starting to look at you, and you
11602 try to stop the program, but you can't, and you can't find the program
11603 to control the volume, and everybody else in the room suddenly decides
11604 to look at you disdainfully, and you'll feel rather stupid.)
11606 Any similarity to real events and people is purely coincidental. Ahem.
11608 Also @pxref{MIME Commands}.
11611 @node Customizing Articles
11612 @section Customizing Articles
11613 @cindex article customization
11615 A slew of functions for customizing how the articles are to look like
11616 exist. You can call these functions interactively
11617 (@pxref{Article Washing}), or you can have them
11618 called automatically when you select the articles.
11620 To have them called automatically, you should set the corresponding
11621 ``treatment'' variable. For instance, to have headers hidden, you'd set
11622 @code{gnus-treat-hide-headers}. Below is a list of variables that can
11623 be set, but first we discuss the values these variables can have.
11625 Note: Some values, while valid, make little sense. Check the list below
11626 for sensible values.
11630 @code{nil}: Don't do this treatment.
11633 @code{t}: Do this treatment on all body parts.
11636 @code{head}: Do the treatment on the headers.
11639 @code{first}: Do this treatment on the first body part.
11642 @code{last}: Do this treatment on the last body part.
11645 An integer: Do this treatment on all body parts that have a length less
11649 A list of strings: Do this treatment on all body parts that are in
11650 articles that are read in groups that have names that match one of the
11651 regexps in the list.
11654 A list where the first element is not a string:
11656 The list is evaluated recursively. The first element of the list is a
11657 predicate. The following predicates are recognized: @code{or},
11658 @code{and}, @code{not} and @code{typep}. Here's an example:
11662 (typep "text/x-vcard"))
11667 You may have noticed that the word @dfn{part} is used here. This refers
11668 to the fact that some messages are @acronym{MIME} multipart articles that may
11669 be divided into several parts. Articles that are not multiparts are
11670 considered to contain just a single part.
11672 @vindex gnus-article-treat-types
11673 Are the treatments applied to all sorts of multipart parts? Yes, if you
11674 want to, but by default, only @samp{text/plain} parts are given the
11675 treatment. This is controlled by the @code{gnus-article-treat-types}
11676 variable, which is a list of regular expressions that are matched to the
11677 type of the part. This variable is ignored if the value of the
11678 controlling variable is a predicate list, as described above.
11681 @c Avoid sort of redundant entries in the same section for the printed
11682 @c manual, but add them in info to allow `i gnus-treat-foo-bar RET' or
11684 @vindex gnus-treat-buttonize
11685 @vindex gnus-treat-buttonize-head
11686 @vindex gnus-treat-capitalize-sentences
11687 @vindex gnus-treat-overstrike
11688 @vindex gnus-treat-strip-cr
11689 @vindex gnus-treat-strip-headers-in-body
11690 @vindex gnus-treat-strip-leading-blank-lines
11691 @vindex gnus-treat-strip-multiple-blank-lines
11692 @vindex gnus-treat-strip-pem
11693 @vindex gnus-treat-strip-trailing-blank-lines
11694 @vindex gnus-treat-unsplit-urls
11695 @vindex gnus-treat-wash-html
11696 @vindex gnus-treat-date-english
11697 @vindex gnus-treat-date-iso8601
11698 @vindex gnus-treat-date-lapsed
11699 @vindex gnus-treat-date-local
11700 @vindex gnus-treat-date-original
11701 @vindex gnus-treat-date-user-defined
11702 @vindex gnus-treat-date-ut
11703 @vindex gnus-treat-from-picon
11704 @vindex gnus-treat-mail-picon
11705 @vindex gnus-treat-newsgroups-picon
11706 @vindex gnus-treat-display-smileys
11707 @vindex gnus-treat-body-boundary
11708 @vindex gnus-treat-display-x-face
11709 @vindex gnus-treat-display-face
11710 @vindex gnus-treat-emphasize
11711 @vindex gnus-treat-fill-article
11712 @vindex gnus-treat-fill-long-lines
11713 @vindex gnus-treat-hide-boring-headers
11714 @vindex gnus-treat-hide-citation
11715 @vindex gnus-treat-hide-citation-maybe
11716 @vindex gnus-treat-hide-headers
11717 @vindex gnus-treat-hide-signature
11718 @vindex gnus-treat-strip-banner
11719 @vindex gnus-treat-strip-list-identifiers
11720 @vindex gnus-treat-highlight-citation
11721 @vindex gnus-treat-highlight-headers
11722 @vindex gnus-treat-highlight-signature
11723 @vindex gnus-treat-play-sounds
11724 @vindex gnus-treat-translate
11725 @vindex gnus-treat-x-pgp-sig
11726 @vindex gnus-treat-unfold-headers
11727 @vindex gnus-treat-fold-headers
11728 @vindex gnus-treat-fold-newsgroups
11729 @vindex gnus-treat-leading-whitespace
11732 The following treatment options are available. The easiest way to
11733 customize this is to examine the @code{gnus-article-treat} customization
11734 group. Values in parenthesis are suggested sensible values. Others are
11735 possible but those listed are probably sufficient for most people.
11738 @item gnus-treat-buttonize (t, integer)
11739 @item gnus-treat-buttonize-head (head)
11741 @xref{Article Buttons}.
11743 @item gnus-treat-capitalize-sentences (t, integer)
11744 @item gnus-treat-overstrike (t, integer)
11745 @item gnus-treat-strip-cr (t, integer)
11746 @item gnus-treat-strip-headers-in-body (t, integer)
11747 @item gnus-treat-strip-leading-blank-lines (t, first, integer)
11748 @item gnus-treat-strip-multiple-blank-lines (t, integer)
11749 @item gnus-treat-strip-pem (t, last, integer)
11750 @item gnus-treat-strip-trailing-blank-lines (t, last, integer)
11751 @item gnus-treat-unsplit-urls (t, integer)
11752 @item gnus-treat-wash-html (t, integer)
11754 @xref{Article Washing}.
11756 @item gnus-treat-date-english (head)
11757 @item gnus-treat-date-iso8601 (head)
11758 @item gnus-treat-date-lapsed (head)
11759 @item gnus-treat-date-local (head)
11760 @item gnus-treat-date-original (head)
11761 @item gnus-treat-date-user-defined (head)
11762 @item gnus-treat-date-ut (head)
11764 @xref{Article Date}.
11766 @item gnus-treat-from-picon (head)
11767 @item gnus-treat-mail-picon (head)
11768 @item gnus-treat-newsgroups-picon (head)
11772 @item gnus-treat-display-smileys (t, integer)
11774 @item gnus-treat-body-boundary (head)
11776 @vindex gnus-body-boundary-delimiter
11777 Adds a delimiter between header and body, the string used as delimiter
11778 is controlled by @code{gnus-body-boundary-delimiter}.
11782 @vindex gnus-treat-display-x-face
11783 @item gnus-treat-display-x-face (head)
11787 @vindex gnus-treat-display-face
11788 @item gnus-treat-display-face (head)
11792 @vindex gnus-treat-emphasize
11793 @item gnus-treat-emphasize (t, head, integer)
11794 @vindex gnus-treat-fill-article
11795 @item gnus-treat-fill-article (t, integer)
11796 @vindex gnus-treat-fill-long-lines
11797 @item gnus-treat-fill-long-lines (t, integer)
11798 @vindex gnus-treat-hide-boring-headers
11799 @item gnus-treat-hide-boring-headers (head)
11800 @vindex gnus-treat-hide-citation
11801 @item gnus-treat-hide-citation (t, integer)
11802 @vindex gnus-treat-hide-citation-maybe
11803 @item gnus-treat-hide-citation-maybe (t, integer)
11804 @vindex gnus-treat-hide-headers
11805 @item gnus-treat-hide-headers (head)
11806 @vindex gnus-treat-hide-signature
11807 @item gnus-treat-hide-signature (t, last)
11808 @vindex gnus-treat-strip-banner
11809 @item gnus-treat-strip-banner (t, last)
11810 @vindex gnus-treat-strip-list-identifiers
11811 @item gnus-treat-strip-list-identifiers (head)
11813 @xref{Article Hiding}.
11815 @vindex gnus-treat-highlight-citation
11816 @item gnus-treat-highlight-citation (t, integer)
11817 @vindex gnus-treat-highlight-headers
11818 @item gnus-treat-highlight-headers (head)
11819 @vindex gnus-treat-highlight-signature
11820 @item gnus-treat-highlight-signature (t, last, integer)
11822 @xref{Article Highlighting}.
11824 @vindex gnus-treat-play-sounds
11825 @item gnus-treat-play-sounds
11826 @vindex gnus-treat-translate
11827 @item gnus-treat-translate
11828 @item gnus-treat-ansi-sequences (t)
11829 @vindex gnus-treat-x-pgp-sig
11830 @item gnus-treat-x-pgp-sig (head)
11832 @vindex gnus-treat-unfold-headers
11833 @item gnus-treat-unfold-headers (head)
11834 @vindex gnus-treat-fold-headers
11835 @item gnus-treat-fold-headers (head)
11836 @vindex gnus-treat-fold-newsgroups
11837 @item gnus-treat-fold-newsgroups (head)
11838 @vindex gnus-treat-leading-whitespace
11839 @item gnus-treat-leading-whitespace (head)
11841 @xref{Article Header}.
11846 @vindex gnus-part-display-hook
11847 You can, of course, write your own functions to be called from
11848 @code{gnus-part-display-hook}. The functions are called narrowed to the
11849 part, and you can do anything you like, pretty much. There is no
11850 information that you have to keep in the buffer---you can change
11854 @node Article Keymap
11855 @section Article Keymap
11857 Most of the keystrokes in the summary buffer can also be used in the
11858 article buffer. They should behave as if you typed them in the summary
11859 buffer, which means that you don't actually have to have a summary
11860 buffer displayed while reading. You can do it all from the article
11863 @kindex v (Article)
11864 @cindex keys, reserved for users (Article)
11865 The key @kbd{v} is reserved for users. You can bind it to some
11866 command or better use it as a prefix key.
11868 A few additional keystrokes are available:
11873 @kindex SPACE (Article)
11874 @findex gnus-article-next-page
11875 Scroll forwards one page (@code{gnus-article-next-page}).
11876 This is exactly the same as @kbd{h SPACE h}.
11879 @kindex DEL (Article)
11880 @findex gnus-article-prev-page
11881 Scroll backwards one page (@code{gnus-article-prev-page}).
11882 This is exactly the same as @kbd{h DEL h}.
11885 @kindex C-c ^ (Article)
11886 @findex gnus-article-refer-article
11887 If point is in the neighborhood of a @code{Message-ID} and you press
11888 @kbd{C-c ^}, Gnus will try to get that article from the server
11889 (@code{gnus-article-refer-article}).
11892 @kindex C-c C-m (Article)
11893 @findex gnus-article-mail
11894 Send a reply to the address near point (@code{gnus-article-mail}). If
11895 given a prefix, include the mail.
11898 @kindex s (Article)
11899 @findex gnus-article-show-summary
11900 Reconfigure the buffers so that the summary buffer becomes visible
11901 (@code{gnus-article-show-summary}).
11904 @kindex ? (Article)
11905 @findex gnus-article-describe-briefly
11906 Give a very brief description of the available keystrokes
11907 (@code{gnus-article-describe-briefly}).
11910 @kindex TAB (Article)
11911 @findex gnus-article-next-button
11912 Go to the next button, if any (@code{gnus-article-next-button}). This
11913 only makes sense if you have buttonizing turned on.
11916 @kindex M-TAB (Article)
11917 @findex gnus-article-prev-button
11918 Go to the previous button, if any (@code{gnus-article-prev-button}).
11921 @kindex R (Article)
11922 @findex gnus-article-reply-with-original
11923 Send a reply to the current article and yank the current article
11924 (@code{gnus-article-reply-with-original}). If the region is active,
11925 only yank the text in the region.
11928 @kindex S W (Article)
11929 @findex gnus-article-wide-reply-with-original
11930 Send a wide reply to the current article and yank the current article
11931 (@code{gnus-article-wide-reply-with-original}). If the region is
11932 active, only yank the text in the region.
11935 @kindex F (Article)
11936 @findex gnus-article-followup-with-original
11937 Send a followup to the current article and yank the current article
11938 (@code{gnus-article-followup-with-original}). If the region is active,
11939 only yank the text in the region.
11946 @section Misc Article
11950 @item gnus-single-article-buffer
11951 @vindex gnus-single-article-buffer
11952 @cindex article buffers, several
11953 If non-@code{nil}, use the same article buffer for all the groups.
11954 (This is the default.) If @code{nil}, each group will have its own
11957 @vindex gnus-article-decode-hook
11958 @item gnus-article-decode-hook
11959 @cindex @acronym{MIME}
11960 Hook used to decode @acronym{MIME} articles. The default value is
11961 @code{(article-decode-charset article-decode-encoded-words)}
11963 @vindex gnus-article-prepare-hook
11964 @item gnus-article-prepare-hook
11965 This hook is called right after the article has been inserted into the
11966 article buffer. It is mainly intended for functions that do something
11967 depending on the contents; it should probably not be used for changing
11968 the contents of the article buffer.
11970 @item gnus-article-mode-hook
11971 @vindex gnus-article-mode-hook
11972 Hook called in article mode buffers.
11974 @item gnus-article-mode-syntax-table
11975 @vindex gnus-article-mode-syntax-table
11976 Syntax table used in article buffers. It is initialized from
11977 @code{text-mode-syntax-table}.
11979 @vindex gnus-article-over-scroll
11980 @item gnus-article-over-scroll
11981 If non-@code{nil}, allow scrolling the article buffer even when there
11982 no more new text to scroll in. The default is @code{nil}.
11984 @vindex gnus-article-mode-line-format
11985 @item gnus-article-mode-line-format
11986 This variable is a format string along the same lines as
11987 @code{gnus-summary-mode-line-format} (@pxref{Summary Buffer Mode
11988 Line}). It accepts the same format specifications as that variable,
11989 with two extensions:
11994 The @dfn{wash status} of the article. This is a short string with one
11995 character for each possible article wash operation that may have been
11996 performed. The characters and their meaning:
12001 Displayed when cited text may be hidden in the article buffer.
12004 Displayed when headers are hidden in the article buffer.
12007 Displayed when article is digitally signed or encrypted, and Gnus has
12008 hidden the security headers. (N.B. does not tell anything about
12009 security status, i.e. good or bad signature.)
12012 Displayed when the signature has been hidden in the Article buffer.
12015 Displayed when Gnus has treated overstrike characters in the article buffer.
12018 Displayed when Gnus has treated emphasised strings in the article buffer.
12023 The number of @acronym{MIME} parts in the article.
12027 @vindex gnus-break-pages
12029 @item gnus-break-pages
12030 Controls whether @dfn{page breaking} is to take place. If this variable
12031 is non-@code{nil}, the articles will be divided into pages whenever a
12032 page delimiter appears in the article. If this variable is @code{nil},
12033 paging will not be done.
12035 @item gnus-page-delimiter
12036 @vindex gnus-page-delimiter
12037 This is the delimiter mentioned above. By default, it is @samp{^L}
12041 @cindex internationalized domain names
12042 @vindex gnus-use-idna
12043 @item gnus-use-idna
12044 This variable controls whether Gnus performs IDNA decoding of
12045 internationalized domain names inside @samp{From}, @samp{To} and
12046 @samp{Cc} headers. @xref{IDNA, ,IDNA,message, The Message Manual},
12047 for how to compose such messages. This requires
12048 @uref{http://www.gnu.org/software/libidn/, GNU Libidn}, and this
12049 variable is only enabled if you have installed it.
12054 @node Composing Messages
12055 @chapter Composing Messages
12056 @cindex composing messages
12059 @cindex sending mail
12064 @cindex using s/mime
12065 @cindex using smime
12067 @kindex C-c C-c (Post)
12068 All commands for posting and mailing will put you in a message buffer
12069 where you can edit the article all you like, before you send the
12070 article by pressing @kbd{C-c C-c}. @xref{Top, , Overview, message,
12071 Message Manual}. Where the message will be posted/mailed to depends
12072 on your setup (@pxref{Posting Server}).
12075 * Mail:: Mailing and replying.
12076 * Posting Server:: What server should you post and mail via?
12077 * POP before SMTP:: You cannot send a mail unless you read a mail.
12078 * Mail and Post:: Mailing and posting at the same time.
12079 * Archived Messages:: Where Gnus stores the messages you've sent.
12080 * Posting Styles:: An easier way to specify who you are.
12081 * Drafts:: Postponing messages and rejected messages.
12082 * Rejected Articles:: What happens if the server doesn't like your article?
12083 * Signing and encrypting:: How to compose secure messages.
12086 Also @pxref{Canceling and Superseding} for information on how to
12087 remove articles you shouldn't have posted.
12093 Variables for customizing outgoing mail:
12096 @item gnus-uu-digest-headers
12097 @vindex gnus-uu-digest-headers
12098 List of regexps to match headers included in digested messages. The
12099 headers will be included in the sequence they are matched. If
12100 @code{nil} include all headers.
12102 @item gnus-add-to-list
12103 @vindex gnus-add-to-list
12104 If non-@code{nil}, add a @code{to-list} group parameter to mail groups
12105 that have none when you do a @kbd{a}.
12107 @item gnus-confirm-mail-reply-to-news
12108 @vindex gnus-confirm-mail-reply-to-news
12109 If non-@code{nil}, Gnus will ask you for a confirmation when you are
12110 about to reply to news articles by mail. If it is @code{nil}, nothing
12111 interferes in what you want to do. This can also be a function
12112 receiving the group name as the only parameter which should return
12113 non-@code{nil} if a confirmation is needed, or a regular expression
12114 matching group names, where confirmation should be asked for.
12116 If you find yourself never wanting to reply to mail, but occasionally
12117 press @kbd{R} anyway, this variable might be for you.
12119 @item gnus-confirm-treat-mail-like-news
12120 @vindex gnus-confirm-treat-mail-like-news
12121 If non-@code{nil}, Gnus also requests confirmation according to
12122 @code{gnus-confirm-mail-reply-to-news} when replying to mail. This is
12123 useful for treating mailing lists like newsgroups.
12128 @node Posting Server
12129 @section Posting Server
12131 When you press those magical @kbd{C-c C-c} keys to ship off your latest
12132 (extremely intelligent, of course) article, where does it go?
12134 Thank you for asking. I hate you.
12136 It can be quite complicated.
12138 @vindex gnus-post-method
12139 When posting news, Message usually invokes @code{message-send-news}
12140 (@pxref{News Variables, , News Variables, message, Message Manual}).
12141 Normally, Gnus will post using the same select method as you're
12142 reading from (which might be convenient if you're reading lots of
12143 groups from different private servers). However. If the server
12144 you're reading from doesn't allow posting, just reading, you probably
12145 want to use some other server to post your (extremely intelligent and
12146 fabulously interesting) articles. You can then set the
12147 @code{gnus-post-method} to some other method:
12150 (setq gnus-post-method '(nnspool ""))
12153 Now, if you've done this, and then this server rejects your article, or
12154 this server is down, what do you do then? To override this variable you
12155 can use a non-zero prefix to the @kbd{C-c C-c} command to force using
12156 the ``current'' server, to get back the default behavior, for posting.
12158 If you give a zero prefix (i.e., @kbd{C-u 0 C-c C-c}) to that command,
12159 Gnus will prompt you for what method to use for posting.
12161 You can also set @code{gnus-post-method} to a list of select methods.
12162 If that's the case, Gnus will always prompt you for what method to use
12165 Finally, if you want to always post using the native select method,
12166 you can set this variable to @code{native}.
12168 @vindex message-send-mail-function
12169 When sending mail, Message invokes the function specified by the
12170 variable @code{message-send-mail-function}. Gnus tries to set it to a
12171 value suitable for your system.
12172 @xref{Mail Variables, ,Mail Variables,message,Message manual}, for more
12175 @node POP before SMTP
12176 @section POP before SMTP
12177 @cindex pop before smtp
12178 @findex message-smtpmail-send-it
12179 @findex mail-source-touch-pop
12181 Does your @acronym{ISP} require the @acronym{POP}-before-@acronym{SMTP}
12182 authentication? It is whether you need to connect to the @acronym{POP}
12183 mail server within a certain time before sending mails. If so, there is
12184 a convenient way. To do that, put the following lines in your
12185 @file{~/.gnus.el} file:
12188 (setq message-send-mail-function 'message-smtpmail-send-it)
12189 (add-hook 'message-send-mail-hook 'mail-source-touch-pop)
12193 It means to let Gnus connect to the @acronym{POP} mail server in advance
12194 whenever you send a mail. The @code{mail-source-touch-pop} function
12195 does only a @acronym{POP} authentication according to the value of
12196 @code{mail-sources} without fetching mails, just before sending a mail.
12197 Note that you have to use @code{message-smtpmail-send-it} which runs
12198 @code{message-send-mail-hook} rather than @code{smtpmail-send-it} and
12199 set the value of @code{mail-sources} for a @acronym{POP} connection
12200 correctly. @xref{Mail Sources}.
12202 If you have two or more @acronym{POP} mail servers set in
12203 @code{mail-sources}, you may want to specify one of them to
12204 @code{mail-source-primary-source} as the @acronym{POP} mail server to be
12205 used for the @acronym{POP}-before-@acronym{SMTP} authentication. If it
12206 is your primary @acronym{POP} mail server (i.e., you are fetching mails
12207 mainly from that server), you can set it permanently as follows:
12210 (setq mail-source-primary-source
12211 '(pop :server "pop3.mail.server"
12212 :password "secret"))
12216 Otherwise, bind it dynamically only when performing the
12217 @acronym{POP}-before-@acronym{SMTP} authentication as follows:
12220 (add-hook 'message-send-mail-hook
12222 (let ((mail-source-primary-source
12223 '(pop :server "pop3.mail.server"
12224 :password "secret")))
12225 (mail-source-touch-pop))))
12228 @node Mail and Post
12229 @section Mail and Post
12231 Here's a list of variables relevant to both mailing and
12235 @item gnus-mailing-list-groups
12236 @findex gnus-mailing-list-groups
12237 @cindex mailing lists
12239 If your news server offers groups that are really mailing lists
12240 gatewayed to the @acronym{NNTP} server, you can read those groups without
12241 problems, but you can't post/followup to them without some difficulty.
12242 One solution is to add a @code{to-address} to the group parameters
12243 (@pxref{Group Parameters}). An easier thing to do is set the
12244 @code{gnus-mailing-list-groups} to a regexp that matches the groups that
12245 really are mailing lists. Then, at least, followups to the mailing
12246 lists will work most of the time. Posting to these groups (@kbd{a}) is
12247 still a pain, though.
12249 @item gnus-user-agent
12250 @vindex gnus-user-agent
12253 This variable controls which information should be exposed in the
12254 User-Agent header. It can be a list of symbols or a string. Valid
12255 symbols are @code{gnus} (show Gnus version) and @code{emacs} (show Emacs
12256 version). In addition to the Emacs version, you can add @code{codename}
12257 (show (S)XEmacs codename) or either @code{config} (show system
12258 configuration) or @code{type} (show system type). If you set it to a
12259 string, be sure to use a valid format, see RFC 2616.
12263 You may want to do spell-checking on messages that you send out. Or, if
12264 you don't want to spell-check by hand, you could add automatic
12265 spell-checking via the @code{ispell} package:
12268 @findex ispell-message
12270 (add-hook 'message-send-hook 'ispell-message)
12273 If you want to change the @code{ispell} dictionary based on what group
12274 you're in, you could say something like the following:
12277 (add-hook 'gnus-select-group-hook
12281 "^de\\." (gnus-group-real-name gnus-newsgroup-name))
12282 (ispell-change-dictionary "deutsch"))
12284 (ispell-change-dictionary "english")))))
12287 Modify to suit your needs.
12289 @vindex gnus-message-highlight-citation
12290 If @code{gnus-message-highlight-citation} is t, different levels of
12291 citations are highlighted like in Gnus article buffers also in message
12294 @node Archived Messages
12295 @section Archived Messages
12296 @cindex archived messages
12297 @cindex sent messages
12299 Gnus provides a few different methods for storing the mail and news you
12300 send. The default method is to use the @dfn{archive virtual server} to
12301 store the messages. If you want to disable this completely, the
12302 @code{gnus-message-archive-group} variable should be @code{nil}, which
12305 For archiving interesting messages in a group you read, see the
12306 @kbd{B c} (@code{gnus-summary-copy-article}) command (@pxref{Mail
12309 @vindex gnus-message-archive-method
12310 @code{gnus-message-archive-method} says what virtual server Gnus is to
12311 use to store sent messages. The default is @code{"archive"}, and when
12312 actually being used it is expanded into:
12315 (nnfolder "archive"
12316 (nnfolder-directory "~/Mail/archive")
12317 (nnfolder-active-file "~/Mail/archive/active")
12318 (nnfolder-get-new-mail nil)
12319 (nnfolder-inhibit-expiry t))
12323 @vindex gnus-update-message-archive-method
12324 Note: a server like this is saved in the @file{~/.newsrc.eld} file first
12325 so that it may be used as a real method of the server which is named
12326 @code{"archive"} (that is, for the case where
12327 @code{gnus-message-archive-method} is set to @code{"archive"}) ever
12328 since. If it once has been saved, it will never be updated by default
12329 even if you change the value of @code{gnus-message-archive-method}
12330 afterward. Therefore, the server @code{"archive"} doesn't necessarily
12331 mean the @code{nnfolder} server like this at all times. If you want the
12332 saved method to reflect always the value of
12333 @code{gnus-message-archive-method}, set the
12334 @code{gnus-update-message-archive-method} variable to a non-@code{nil}
12335 value. The default value of this variable is @code{nil}.
12338 You can, however, use any mail select method (@code{nnml},
12339 @code{nnmbox}, etc.). @code{nnfolder} is a quite likable select method
12340 for doing this sort of thing, though. If you don't like the default
12341 directory chosen, you could say something like:
12344 (setq gnus-message-archive-method
12345 '(nnfolder "archive"
12346 (nnfolder-inhibit-expiry t)
12347 (nnfolder-active-file "~/News/sent-mail/active")
12348 (nnfolder-directory "~/News/sent-mail/")))
12351 @vindex gnus-message-archive-group
12353 Gnus will insert @code{Gcc} headers in all outgoing messages that point
12354 to one or more group(s) on that server. Which group to use is
12355 determined by the @code{gnus-message-archive-group} variable.
12357 This variable can be used to do the following:
12361 Messages will be saved in that group.
12363 Note that you can include a select method in the group name, then the
12364 message will not be stored in the select method given by
12365 @code{gnus-message-archive-method}, but in the select method specified
12366 by the group name, instead. Suppose @code{gnus-message-archive-method}
12367 has the default value shown above. Then setting
12368 @code{gnus-message-archive-group} to @code{"foo"} means that outgoing
12369 messages are stored in @samp{nnfolder+archive:foo}, but if you use the
12370 value @code{"nnml:foo"}, then outgoing messages will be stored in
12373 @item a list of strings
12374 Messages will be saved in all those groups.
12376 @item an alist of regexps, functions and forms
12377 When a key ``matches'', the result is used.
12380 No message archiving will take place. This is the default.
12385 Just saving to a single group called @samp{MisK}:
12387 (setq gnus-message-archive-group "MisK")
12390 Saving to two groups, @samp{MisK} and @samp{safe}:
12392 (setq gnus-message-archive-group '("MisK" "safe"))
12395 Save to different groups based on what group you are in:
12397 (setq gnus-message-archive-group
12398 '(("^alt" "sent-to-alt")
12399 ("mail" "sent-to-mail")
12400 (".*" "sent-to-misc")))
12403 More complex stuff:
12405 (setq gnus-message-archive-group
12406 '((if (message-news-p)
12411 How about storing all news messages in one file, but storing all mail
12412 messages in one file per month:
12415 (setq gnus-message-archive-group
12416 '((if (message-news-p)
12418 (concat "mail." (format-time-string "%Y-%m")))))
12421 @c (XEmacs 19.13 doesn't have @code{format-time-string}, so you'll have to
12422 @c use a different value for @code{gnus-message-archive-group} there.)
12424 Now, when you send a message off, it will be stored in the appropriate
12425 group. (If you want to disable storing for just one particular message,
12426 you can just remove the @code{Gcc} header that has been inserted.) The
12427 archive group will appear in the group buffer the next time you start
12428 Gnus, or the next time you press @kbd{F} in the group buffer. You can
12429 enter it and read the articles in it just like you'd read any other
12430 group. If the group gets really big and annoying, you can simply rename
12431 if (using @kbd{G r} in the group buffer) to something
12432 nice---@samp{misc-mail-september-1995}, or whatever. New messages will
12433 continue to be stored in the old (now empty) group.
12435 That's the default method of archiving sent messages. Gnus offers a
12436 different way for the people who don't like the default method. In that
12437 case you should set @code{gnus-message-archive-group} to @code{nil};
12438 this will disable archiving.
12441 @item gnus-outgoing-message-group
12442 @vindex gnus-outgoing-message-group
12443 All outgoing messages will be put in this group. If you want to store
12444 all your outgoing mail and articles in the group @samp{nnml:archive},
12445 you set this variable to that value. This variable can also be a list of
12448 If you want to have greater control over what group to put each
12449 message in, you can set this variable to a function that checks the
12450 current newsgroup name and then returns a suitable group name (or list
12453 This variable can be used instead of @code{gnus-message-archive-group},
12454 but the latter is the preferred method.
12456 @item gnus-gcc-mark-as-read
12457 @vindex gnus-gcc-mark-as-read
12458 If non-@code{nil}, automatically mark @code{Gcc} articles as read.
12460 @item gnus-gcc-externalize-attachments
12461 @vindex gnus-gcc-externalize-attachments
12462 If @code{nil}, attach files as normal parts in Gcc copies; if a regexp
12463 and matches the Gcc group name, attach files as external parts; if it is
12464 @code{all}, attach local files as external parts; if it is other
12465 non-@code{nil}, the behavior is the same as @code{all}, but it may be
12466 changed in the future.
12471 @node Posting Styles
12472 @section Posting Styles
12473 @cindex posting styles
12476 All them variables, they make my head swim.
12478 So what if you want a different @code{Organization} and signature based
12479 on what groups you post to? And you post both from your home machine
12480 and your work machine, and you want different @code{From} lines, and so
12483 @vindex gnus-posting-styles
12484 One way to do stuff like that is to write clever hooks that change the
12485 variables you need to have changed. That's a bit boring, so somebody
12486 came up with the bright idea of letting the user specify these things in
12487 a handy alist. Here's an example of a @code{gnus-posting-styles}
12492 (signature "Peace and happiness")
12493 (organization "What me?"))
12495 (signature "Death to everybody"))
12496 ("comp.emacs.i-love-it"
12497 (organization "Emacs is it")))
12500 As you might surmise from this example, this alist consists of several
12501 @dfn{styles}. Each style will be applicable if the first element
12502 ``matches'', in some form or other. The entire alist will be iterated
12503 over, from the beginning towards the end, and each match will be
12504 applied, which means that attributes in later styles that match override
12505 the same attributes in earlier matching styles. So
12506 @samp{comp.programming.literate} will have the @samp{Death to everybody}
12507 signature and the @samp{What me?} @code{Organization} header.
12509 The first element in each style is called the @code{match}. If it's a
12510 string, then Gnus will try to regexp match it against the group name.
12511 If it is the form @code{(header @var{match} @var{regexp})}, then Gnus
12512 will look in the original article for a header whose name is
12513 @var{match} and compare that @var{regexp}. @var{match} and
12514 @var{regexp} are strings. (The original article is the one you are
12515 replying or following up to. If you are not composing a reply or a
12516 followup, then there is nothing to match against.) If the
12517 @code{match} is a function symbol, that function will be called with
12518 no arguments. If it's a variable symbol, then the variable will be
12519 referenced. If it's a list, then that list will be @code{eval}ed. In
12520 any case, if this returns a non-@code{nil} value, then the style is
12521 said to @dfn{match}.
12523 Each style may contain an arbitrary amount of @dfn{attributes}. Each
12524 attribute consists of a @code{(@var{name} @var{value})} pair. In
12525 addition, you can also use the @code{(@var{name} :file @var{value})}
12526 form or the @code{(@var{name} :value @var{value})} form. Where
12527 @code{:file} signifies @var{value} represents a file name and its
12528 contents should be used as the attribute value, @code{:value} signifies
12529 @var{value} does not represent a file name explicitly. The attribute
12530 name can be one of:
12533 @item @code{signature}
12534 @item @code{signature-file}
12535 @item @code{x-face-file}
12536 @item @code{address}, overriding @code{user-mail-address}
12537 @item @code{name}, overriding @code{(user-full-name)}
12541 Note that the @code{signature-file} attribute honors the variable
12542 @code{message-signature-directory}.
12544 The attribute name can also be a string or a symbol. In that case,
12545 this will be used as a header name, and the value will be inserted in
12546 the headers of the article; if the value is @code{nil}, the header
12547 name will be removed. If the attribute name is @code{eval}, the form
12548 is evaluated, and the result is thrown away.
12550 The attribute value can be a string (used verbatim), a function with
12551 zero arguments (the return value will be used), a variable (its value
12552 will be used) or a list (it will be @code{eval}ed and the return value
12553 will be used). The functions and sexps are called/@code{eval}ed in the
12554 message buffer that is being set up. The headers of the current article
12555 are available through the @code{message-reply-headers} variable, which
12556 is a vector of the following headers: number subject from date id
12557 references chars lines xref extra.
12559 @vindex message-reply-headers
12561 If you wish to check whether the message you are about to compose is
12562 meant to be a news article or a mail message, you can check the values
12563 of the @code{message-news-p} and @code{message-mail-p} functions.
12565 @findex message-mail-p
12566 @findex message-news-p
12568 So here's a new example:
12571 (setq gnus-posting-styles
12573 (signature-file "~/.signature")
12575 (x-face-file "~/.xface")
12576 (x-url (getenv "WWW_HOME"))
12577 (organization "People's Front Against MWM"))
12579 (signature my-funny-signature-randomizer))
12580 ((equal (system-name) "gnarly") ;; @r{A form}
12581 (signature my-quote-randomizer))
12582 (message-news-p ;; @r{A function symbol}
12583 (signature my-news-signature))
12584 (window-system ;; @r{A value symbol}
12585 ("X-Window-System" (format "%s" window-system)))
12586 ;; @r{If I'm replying to Larsi, set the Organization header.}
12587 ((header "from" "larsi.*org")
12588 (Organization "Somewhere, Inc."))
12589 ((posting-from-work-p) ;; @r{A user defined function}
12590 (signature-file "~/.work-signature")
12591 (address "user@@bar.foo")
12592 (body "You are fired.\n\nSincerely, your boss.")
12593 (organization "Important Work, Inc"))
12595 (From (save-excursion
12596 (set-buffer gnus-article-buffer)
12597 (message-fetch-field "to"))))
12599 (signature-file "~/.mail-signature"))))
12602 The @samp{nnml:.*} rule means that you use the @code{To} address as the
12603 @code{From} address in all your outgoing replies, which might be handy
12604 if you fill many roles.
12605 You may also use @code{message-alternative-emails} instead.
12606 @xref{Message Headers, ,Message Headers, message, Message Manual}.
12612 If you are writing a message (mail or news) and suddenly remember that
12613 you have a steak in the oven (or some pesto in the food processor, you
12614 craaazy vegetarians), you'll probably wish there was a method to save
12615 the message you are writing so that you can continue editing it some
12616 other day, and send it when you feel its finished.
12618 Well, don't worry about it. Whenever you start composing a message of
12619 some sort using the Gnus mail and post commands, the buffer you get will
12620 automatically associate to an article in a special @dfn{draft} group.
12621 If you save the buffer the normal way (@kbd{C-x C-s}, for instance), the
12622 article will be saved there. (Auto-save files also go to the draft
12626 @vindex nndraft-directory
12627 The draft group is a special group (which is implemented as an
12628 @code{nndraft} group, if you absolutely have to know) called
12629 @samp{nndraft:drafts}. The variable @code{nndraft-directory} says where
12630 @code{nndraft} is to store its files. What makes this group special is
12631 that you can't tick any articles in it or mark any articles as
12632 read---all articles in the group are permanently unread.
12634 If the group doesn't exist, it will be created and you'll be subscribed
12635 to it. The only way to make it disappear from the Group buffer is to
12636 unsubscribe it. The special properties of the draft group comes from
12637 a group property (@pxref{Group Parameters}), and if lost the group
12638 behaves like any other group. This means the commands below will not
12639 be available. To restore the special properties of the group, the
12640 simplest way is to kill the group, using @kbd{C-k}, and restart
12641 Gnus. The group is automatically created again with the
12642 correct parameters. The content of the group is not lost.
12644 @c @findex gnus-dissociate-buffer-from-draft
12645 @c @kindex C-c M-d (Mail)
12646 @c @kindex C-c M-d (Post)
12647 @c @findex gnus-associate-buffer-with-draft
12648 @c @kindex C-c C-d (Mail)
12649 @c @kindex C-c C-d (Post)
12650 @c If you're writing some super-secret message that you later want to
12651 @c encode with PGP before sending, you may wish to turn the auto-saving
12652 @c (and association with the draft group) off. You never know who might be
12653 @c interested in reading all your extremely valuable and terribly horrible
12654 @c and interesting secrets. The @kbd{C-c M-d}
12655 @c (@code{gnus-dissociate-buffer-from-draft}) command does that for you.
12656 @c If you change your mind and want to turn the auto-saving back on again,
12657 @c @kbd{C-c C-d} (@code{gnus-associate-buffer-with-draft} does that.
12659 @c @vindex gnus-use-draft
12660 @c To leave association with the draft group off by default, set
12661 @c @code{gnus-use-draft} to @code{nil}. It is @code{t} by default.
12663 @findex gnus-draft-edit-message
12664 @kindex D e (Draft)
12665 When you want to continue editing the article, you simply enter the
12666 draft group and push @kbd{D e} (@code{gnus-draft-edit-message}) to do
12667 that. You will be placed in a buffer where you left off.
12669 Rejected articles will also be put in this draft group (@pxref{Rejected
12672 @findex gnus-draft-send-all-messages
12673 @kindex D s (Draft)
12674 @findex gnus-draft-send-message
12675 @kindex D S (Draft)
12676 If you have lots of rejected messages you want to post (or mail) without
12677 doing further editing, you can use the @kbd{D s} command
12678 (@code{gnus-draft-send-message}). This command understands the
12679 process/prefix convention (@pxref{Process/Prefix}). The @kbd{D S}
12680 command (@code{gnus-draft-send-all-messages}) will ship off all messages
12683 @findex gnus-draft-toggle-sending
12684 @kindex D t (Draft)
12685 If you have some messages that you wish not to send, you can use the
12686 @kbd{D t} (@code{gnus-draft-toggle-sending}) command to mark the message
12687 as unsendable. This is a toggling command.
12690 @node Rejected Articles
12691 @section Rejected Articles
12692 @cindex rejected articles
12694 Sometimes a news server will reject an article. Perhaps the server
12695 doesn't like your face. Perhaps it just feels miserable. Perhaps
12696 @emph{there be demons}. Perhaps you have included too much cited text.
12697 Perhaps the disk is full. Perhaps the server is down.
12699 These situations are, of course, totally beyond the control of Gnus.
12700 (Gnus, of course, loves the way you look, always feels great, has angels
12701 fluttering around inside of it, doesn't care about how much cited text
12702 you include, never runs full and never goes down.) So Gnus saves these
12703 articles until some later time when the server feels better.
12705 The rejected articles will automatically be put in a special draft group
12706 (@pxref{Drafts}). When the server comes back up again, you'd then
12707 typically enter that group and send all the articles off.
12709 @node Signing and encrypting
12710 @section Signing and encrypting
12712 @cindex using s/mime
12713 @cindex using smime
12715 Gnus can digitally sign and encrypt your messages, using vanilla
12716 @acronym{PGP} format or @acronym{PGP/MIME} or @acronym{S/MIME}. For
12717 decoding such messages, see the @code{mm-verify-option} and
12718 @code{mm-decrypt-option} options (@pxref{Security}).
12720 @vindex gnus-message-replysign
12721 @vindex gnus-message-replyencrypt
12722 @vindex gnus-message-replysignencrypted
12723 Often, you would like to sign replies to people who send you signed
12724 messages. Even more often, you might want to encrypt messages which
12725 are in reply to encrypted messages. Gnus offers
12726 @code{gnus-message-replysign} to enable the former, and
12727 @code{gnus-message-replyencrypt} for the latter. In addition, setting
12728 @code{gnus-message-replysignencrypted} (on by default) will sign
12729 automatically encrypted messages.
12731 Instructing @acronym{MML} to perform security operations on a
12732 @acronym{MIME} part is done using the @kbd{C-c C-m s} key map for
12733 signing and the @kbd{C-c C-m c} key map for encryption, as follows.
12738 @kindex C-c C-m s s (Message)
12739 @findex mml-secure-message-sign-smime
12741 Digitally sign current message using @acronym{S/MIME}.
12744 @kindex C-c C-m s o (Message)
12745 @findex mml-secure-message-sign-pgp
12747 Digitally sign current message using @acronym{PGP}.
12750 @kindex C-c C-m s p (Message)
12751 @findex mml-secure-message-sign-pgp
12753 Digitally sign current message using @acronym{PGP/MIME}.
12756 @kindex C-c C-m c s (Message)
12757 @findex mml-secure-message-encrypt-smime
12759 Digitally encrypt current message using @acronym{S/MIME}.
12762 @kindex C-c C-m c o (Message)
12763 @findex mml-secure-message-encrypt-pgp
12765 Digitally encrypt current message using @acronym{PGP}.
12768 @kindex C-c C-m c p (Message)
12769 @findex mml-secure-message-encrypt-pgpmime
12771 Digitally encrypt current message using @acronym{PGP/MIME}.
12774 @kindex C-c C-m C-n (Message)
12775 @findex mml-unsecure-message
12776 Remove security related @acronym{MML} tags from message.
12780 @xref{Security, ,Security, message, Message Manual}, for more information.
12782 @node Select Methods
12783 @chapter Select Methods
12784 @cindex foreign groups
12785 @cindex select methods
12787 A @dfn{foreign group} is a group not read by the usual (or
12788 default) means. It could be, for instance, a group from a different
12789 @acronym{NNTP} server, it could be a virtual group, or it could be your own
12790 personal mail group.
12792 A foreign group (or any group, really) is specified by a @dfn{name} and
12793 a @dfn{select method}. To take the latter first, a select method is a
12794 list where the first element says what back end to use (e.g. @code{nntp},
12795 @code{nnspool}, @code{nnml}) and the second element is the @dfn{server
12796 name}. There may be additional elements in the select method, where the
12797 value may have special meaning for the back end in question.
12799 One could say that a select method defines a @dfn{virtual server}---so
12800 we do just that (@pxref{Server Buffer}).
12802 The @dfn{name} of the group is the name the back end will recognize the
12805 For instance, the group @samp{soc.motss} on the @acronym{NNTP} server
12806 @samp{some.where.edu} will have the name @samp{soc.motss} and select
12807 method @code{(nntp "some.where.edu")}. Gnus will call this group
12808 @samp{nntp+some.where.edu:soc.motss}, even though the @code{nntp}
12809 back end just knows this group as @samp{soc.motss}.
12811 The different methods all have their peculiarities, of course.
12814 * Server Buffer:: Making and editing virtual servers.
12815 * Getting News:: Reading USENET news with Gnus.
12816 * Getting Mail:: Reading your personal mail with Gnus.
12817 * Browsing the Web:: Getting messages from a plethora of Web sources.
12818 * IMAP:: Using Gnus as a @acronym{IMAP} client.
12819 * Other Sources:: Reading directories, files, SOUP packets.
12820 * Combined Groups:: Combining groups into one group.
12821 * Email Based Diary:: Using mails to manage diary events in Gnus.
12822 * Gnus Unplugged:: Reading news and mail offline.
12826 @node Server Buffer
12827 @section Server Buffer
12829 Traditionally, a @dfn{server} is a machine or a piece of software that
12830 one connects to, and then requests information from. Gnus does not
12831 connect directly to any real servers, but does all transactions through
12832 one back end or other. But that's just putting one layer more between
12833 the actual media and Gnus, so we might just as well say that each
12834 back end represents a virtual server.
12836 For instance, the @code{nntp} back end may be used to connect to several
12837 different actual @acronym{NNTP} servers, or, perhaps, to many different ports
12838 on the same actual @acronym{NNTP} server. You tell Gnus which back end to
12839 use, and what parameters to set by specifying a @dfn{select method}.
12841 These select method specifications can sometimes become quite
12842 complicated---say, for instance, that you want to read from the
12843 @acronym{NNTP} server @samp{news.funet.fi} on port number 13, which
12844 hangs if queried for @acronym{NOV} headers and has a buggy select. Ahem.
12845 Anyway, if you had to specify that for each group that used this
12846 server, that would be too much work, so Gnus offers a way of naming
12847 select methods, which is what you do in the server buffer.
12849 To enter the server buffer, use the @kbd{^}
12850 (@code{gnus-group-enter-server-mode}) command in the group buffer.
12853 * Server Buffer Format:: You can customize the look of this buffer.
12854 * Server Commands:: Commands to manipulate servers.
12855 * Example Methods:: Examples server specifications.
12856 * Creating a Virtual Server:: An example session.
12857 * Server Variables:: Which variables to set.
12858 * Servers and Methods:: You can use server names as select methods.
12859 * Unavailable Servers:: Some servers you try to contact may be down.
12862 @vindex gnus-server-mode-hook
12863 @code{gnus-server-mode-hook} is run when creating the server buffer.
12866 @node Server Buffer Format
12867 @subsection Server Buffer Format
12868 @cindex server buffer format
12870 @vindex gnus-server-line-format
12871 You can change the look of the server buffer lines by changing the
12872 @code{gnus-server-line-format} variable. This is a @code{format}-like
12873 variable, with some simple extensions:
12878 How the news is fetched---the back end name.
12881 The name of this server.
12884 Where the news is to be fetched from---the address.
12887 The opened/closed/denied status of the server.
12890 Whether this server is agentized.
12893 @vindex gnus-server-mode-line-format
12894 The mode line can also be customized by using the
12895 @code{gnus-server-mode-line-format} variable (@pxref{Mode Line
12896 Formatting}). The following specs are understood:
12906 Also @pxref{Formatting Variables}.
12909 @node Server Commands
12910 @subsection Server Commands
12911 @cindex server commands
12917 @cindex keys, reserved for users (Server)
12918 The key @kbd{v} is reserved for users. You can bind it to some
12919 command or better use it as a prefix key.
12923 @findex gnus-server-add-server
12924 Add a new server (@code{gnus-server-add-server}).
12928 @findex gnus-server-edit-server
12929 Edit a server (@code{gnus-server-edit-server}).
12932 @kindex SPACE (Server)
12933 @findex gnus-server-read-server
12934 Browse the current server (@code{gnus-server-read-server}).
12938 @findex gnus-server-exit
12939 Return to the group buffer (@code{gnus-server-exit}).
12943 @findex gnus-server-kill-server
12944 Kill the current server (@code{gnus-server-kill-server}).
12948 @findex gnus-server-yank-server
12949 Yank the previously killed server (@code{gnus-server-yank-server}).
12953 @findex gnus-server-copy-server
12954 Copy the current server (@code{gnus-server-copy-server}).
12958 @findex gnus-server-list-servers
12959 List all servers (@code{gnus-server-list-servers}).
12963 @findex gnus-server-scan-server
12964 Request that the server scan its sources for new articles
12965 (@code{gnus-server-scan-server}). This is mainly sensible with mail
12970 @findex gnus-server-regenerate-server
12971 Request that the server regenerate all its data structures
12972 (@code{gnus-server-regenerate-server}). This can be useful if you have
12973 a mail back end that has gotten out of sync.
12977 @findex gnus-server-compact-server
12979 Compact all groups in the server under point
12980 (@code{gnus-server-compact-server}). Currently implemented only in
12981 nnml (@pxref{Mail Spool}). This removes gaps between article numbers,
12982 hence getting a correct total article count.
12987 @node Example Methods
12988 @subsection Example Methods
12990 Most select methods are pretty simple and self-explanatory:
12993 (nntp "news.funet.fi")
12996 Reading directly from the spool is even simpler:
13002 As you can see, the first element in a select method is the name of the
13003 back end, and the second is the @dfn{address}, or @dfn{name}, if you
13006 After these two elements, there may be an arbitrary number of
13007 @code{(@var{variable} @var{form})} pairs.
13009 To go back to the first example---imagine that you want to read from
13010 port 15 on that machine. This is what the select method should
13014 (nntp "news.funet.fi" (nntp-port-number 15))
13017 You should read the documentation to each back end to find out what
13018 variables are relevant, but here's an @code{nnmh} example:
13020 @code{nnmh} is a mail back end that reads a spool-like structure. Say
13021 you have two structures that you wish to access: One is your private
13022 mail spool, and the other is a public one. Here's the possible spec for
13026 (nnmh "private" (nnmh-directory "~/private/mail/"))
13029 (This server is then called @samp{private}, but you may have guessed
13032 Here's the method for a public spool:
13036 (nnmh-directory "/usr/information/spool/")
13037 (nnmh-get-new-mail nil))
13043 If you are behind a firewall and only have access to the @acronym{NNTP}
13044 server from the firewall machine, you can instruct Gnus to @code{rlogin}
13045 on the firewall machine and telnet from there to the @acronym{NNTP} server.
13046 Doing this can be rather fiddly, but your virtual server definition
13047 should probably look something like this:
13051 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)
13052 (nntp-via-address "the.firewall.machine")
13053 (nntp-address "the.real.nntp.host")
13054 (nntp-end-of-line "\n"))
13057 If you want to use the wonderful @code{ssh} program to provide a
13058 compressed connection over the modem line, you could add the following
13059 configuration to the example above:
13062 (nntp-via-rlogin-command "ssh")
13065 See also @code{nntp-via-rlogin-command-switches}. Here's an example for
13066 an indirect connection:
13068 (setq gnus-select-method
13070 (nntp-address "news.server.example")
13071 (nntp-via-user-name "intermediate_user_name")
13072 (nntp-via-address "intermediate.host.example")
13073 (nntp-via-rlogin-command "ssh")
13074 (nntp-end-of-line "\n")
13075 (nntp-via-rlogin-command-switches ("-C" "-t" "-e" "none"))
13076 (nntp-open-connection-function nntp-open-via-rlogin-and-telnet)))
13079 If you're behind a firewall, but have direct access to the outside world
13080 through a wrapper command like "runsocks", you could open a socksified
13081 telnet connection to the news server as follows:
13085 (nntp-pre-command "runsocks")
13086 (nntp-open-connection-function nntp-open-via-telnet)
13087 (nntp-address "the.news.server")
13088 (nntp-end-of-line "\n"))
13091 This means that you have to have set up @code{ssh-agent} correctly to
13092 provide automatic authorization, of course. And to get a compressed
13093 connection, you have to have the @samp{Compression} option in the
13094 @code{ssh} @file{config} file.
13097 @node Creating a Virtual Server
13098 @subsection Creating a Virtual Server
13100 If you're saving lots of articles in the cache by using persistent
13101 articles, you may want to create a virtual server to read the cache.
13103 First you need to add a new server. The @kbd{a} command does that. It
13104 would probably be best to use @code{nnml} to read the cache. You
13105 could also use @code{nnspool} or @code{nnmh}, though.
13107 Type @kbd{a nnml RET cache RET}.
13109 You should now have a brand new @code{nnml} virtual server called
13110 @samp{cache}. You now need to edit it to have the right definitions.
13111 Type @kbd{e} to edit the server. You'll be entered into a buffer that
13112 will contain the following:
13122 (nnml-directory "~/News/cache/")
13123 (nnml-active-file "~/News/cache/active"))
13126 Type @kbd{C-c C-c} to return to the server buffer. If you now press
13127 @kbd{RET} over this virtual server, you should be entered into a browse
13128 buffer, and you should be able to enter any of the groups displayed.
13131 @node Server Variables
13132 @subsection Server Variables
13133 @cindex server variables
13134 @cindex server parameters
13136 One sticky point when defining variables (both on back ends and in Emacs
13137 in general) is that some variables are typically initialized from other
13138 variables when the definition of the variables is being loaded. If you
13139 change the ``base'' variable after the variables have been loaded, you
13140 won't change the ``derived'' variables.
13142 This typically affects directory and file variables. For instance,
13143 @code{nnml-directory} is @file{~/Mail/} by default, and all @code{nnml}
13144 directory variables are initialized from that variable, so
13145 @code{nnml-active-file} will be @file{~/Mail/active}. If you define a
13146 new virtual @code{nnml} server, it will @emph{not} suffice to set just
13147 @code{nnml-directory}---you have to explicitly set all the file
13148 variables to be what you want them to be. For a complete list of
13149 variables for each back end, see each back end's section later in this
13150 manual, but here's an example @code{nnml} definition:
13154 (nnml-directory "~/my-mail/")
13155 (nnml-active-file "~/my-mail/active")
13156 (nnml-newsgroups-file "~/my-mail/newsgroups"))
13159 Server variables are often called @dfn{server parameters}.
13161 @node Servers and Methods
13162 @subsection Servers and Methods
13164 Wherever you would normally use a select method
13165 (e.g. @code{gnus-secondary-select-method}, in the group select method,
13166 when browsing a foreign server) you can use a virtual server name
13167 instead. This could potentially save lots of typing. And it's nice all
13171 @node Unavailable Servers
13172 @subsection Unavailable Servers
13174 If a server seems to be unreachable, Gnus will mark that server as
13175 @code{denied}. That means that any subsequent attempt to make contact
13176 with that server will just be ignored. ``It can't be opened,'' Gnus
13177 will tell you, without making the least effort to see whether that is
13178 actually the case or not.
13180 That might seem quite naughty, but it does make sense most of the time.
13181 Let's say you have 10 groups subscribed to on server
13182 @samp{nephelococcygia.com}. This server is located somewhere quite far
13183 away from you and the machine is quite slow, so it takes 1 minute just
13184 to find out that it refuses connection to you today. If Gnus were to
13185 attempt to do that 10 times, you'd be quite annoyed, so Gnus won't
13186 attempt to do that. Once it has gotten a single ``connection refused'',
13187 it will regard that server as ``down''.
13189 So, what happens if the machine was only feeling unwell temporarily?
13190 How do you test to see whether the machine has come up again?
13192 You jump to the server buffer (@pxref{Server Buffer}) and poke it
13193 with the following commands:
13199 @findex gnus-server-open-server
13200 Try to establish connection to the server on the current line
13201 (@code{gnus-server-open-server}).
13205 @findex gnus-server-close-server
13206 Close the connection (if any) to the server
13207 (@code{gnus-server-close-server}).
13211 @findex gnus-server-deny-server
13212 Mark the current server as unreachable
13213 (@code{gnus-server-deny-server}).
13216 @kindex M-o (Server)
13217 @findex gnus-server-open-all-servers
13218 Open the connections to all servers in the buffer
13219 (@code{gnus-server-open-all-servers}).
13222 @kindex M-c (Server)
13223 @findex gnus-server-close-all-servers
13224 Close the connections to all servers in the buffer
13225 (@code{gnus-server-close-all-servers}).
13229 @findex gnus-server-remove-denials
13230 Remove all marks to whether Gnus was denied connection from any servers
13231 (@code{gnus-server-remove-denials}).
13235 @findex gnus-server-offline-server
13236 Set server status to offline (@code{gnus-server-offline-server}).
13242 @section Getting News
13243 @cindex reading news
13244 @cindex news back ends
13246 A newsreader is normally used for reading news. Gnus currently provides
13247 only two methods of getting news---it can read from an @acronym{NNTP} server,
13248 or it can read from a local spool.
13251 * NNTP:: Reading news from an @acronym{NNTP} server.
13252 * News Spool:: Reading news from the local spool.
13260 Subscribing to a foreign group from an @acronym{NNTP} server is rather easy.
13261 You just specify @code{nntp} as method and the address of the @acronym{NNTP}
13262 server as the, uhm, address.
13264 If the @acronym{NNTP} server is located at a non-standard port, setting the
13265 third element of the select method to this port number should allow you
13266 to connect to the right port. You'll have to edit the group info for
13267 that (@pxref{Foreign Groups}).
13269 The name of the foreign group can be the same as a native group. In
13270 fact, you can subscribe to the same group from as many different servers
13271 you feel like. There will be no name collisions.
13273 The following variables can be used to create a virtual @code{nntp}
13278 @item nntp-server-opened-hook
13279 @vindex nntp-server-opened-hook
13280 @cindex @sc{mode reader}
13282 @cindex authentication
13283 @cindex nntp authentication
13284 @findex nntp-send-authinfo
13285 @findex nntp-send-mode-reader
13286 is run after a connection has been made. It can be used to send
13287 commands to the @acronym{NNTP} server after it has been contacted. By
13288 default it sends the command @code{MODE READER} to the server with the
13289 @code{nntp-send-mode-reader} function. This function should always be
13290 present in this hook.
13292 @item nntp-authinfo-function
13293 @vindex nntp-authinfo-function
13294 @findex nntp-send-authinfo
13295 @vindex nntp-authinfo-file
13296 This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP}
13297 server. The default function is @code{nntp-send-authinfo}, which looks
13298 through your @file{~/.authinfo} (or whatever you've set the
13299 @code{nntp-authinfo-file} variable to) for applicable entries. If none
13300 are found, it will prompt you for a login name and a password. The
13301 format of the @file{~/.authinfo} file is (almost) the same as the
13302 @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp}
13303 manual page, but here are the salient facts:
13307 The file contains one or more line, each of which define one server.
13310 Each line may contain an arbitrary number of token/value pairs.
13312 The valid tokens include @samp{machine}, @samp{login}, @samp{password},
13313 @samp{default}. In addition Gnus introduces two new tokens, not present
13314 in the original @file{.netrc}/@code{ftp} syntax, namely @samp{port} and
13315 @samp{force}. (This is the only way the @file{.authinfo} file format
13316 deviates from the @file{.netrc} file format.) @samp{port} is used to
13317 indicate what port on the server the credentials apply to and
13318 @samp{force} is explained below.
13322 Here's an example file:
13325 machine news.uio.no login larsi password geheimnis
13326 machine nntp.ifi.uio.no login larsi force yes
13329 The token/value pairs may appear in any order; @samp{machine} doesn't
13330 have to be first, for instance.
13332 In this example, both login name and password have been supplied for the
13333 former server, while the latter has only the login name listed, and the
13334 user will be prompted for the password. The latter also has the
13335 @samp{force} tag, which means that the authinfo will be sent to the
13336 @var{nntp} server upon connection; the default (i.e., when there is not
13337 @samp{force} tag) is to not send authinfo to the @var{nntp} server
13338 until the @var{nntp} server asks for it.
13340 You can also add @samp{default} lines that will apply to all servers
13341 that don't have matching @samp{machine} lines.
13347 This will force sending @samp{AUTHINFO} commands to all servers not
13348 previously mentioned.
13350 Remember to not leave the @file{~/.authinfo} file world-readable.
13352 @item nntp-server-action-alist
13353 @vindex nntp-server-action-alist
13354 This is a list of regexps to match on server types and actions to be
13355 taken when matches are made. For instance, if you want Gnus to beep
13356 every time you connect to innd, you could say something like:
13359 (setq nntp-server-action-alist
13360 '(("innd" (ding))))
13363 You probably don't want to do that, though.
13365 The default value is
13368 '(("nntpd 1\\.5\\.11t"
13369 (remove-hook 'nntp-server-opened-hook
13370 'nntp-send-mode-reader)))
13373 This ensures that Gnus doesn't send the @code{MODE READER} command to
13374 nntpd 1.5.11t, since that command chokes that server, I've been told.
13376 @item nntp-maximum-request
13377 @vindex nntp-maximum-request
13378 If the @acronym{NNTP} server doesn't support @acronym{NOV} headers, this back end
13379 will collect headers by sending a series of @code{head} commands. To
13380 speed things up, the back end sends lots of these commands without
13381 waiting for reply, and then reads all the replies. This is controlled
13382 by the @code{nntp-maximum-request} variable, and is 400 by default. If
13383 your network is buggy, you should set this to 1.
13385 @item nntp-connection-timeout
13386 @vindex nntp-connection-timeout
13387 If you have lots of foreign @code{nntp} groups that you connect to
13388 regularly, you're sure to have problems with @acronym{NNTP} servers not
13389 responding properly, or being too loaded to reply within reasonable
13390 time. This is can lead to awkward problems, which can be helped
13391 somewhat by setting @code{nntp-connection-timeout}. This is an integer
13392 that says how many seconds the @code{nntp} back end should wait for a
13393 connection before giving up. If it is @code{nil}, which is the default,
13394 no timeouts are done.
13396 @item nntp-nov-is-evil
13397 @vindex nntp-nov-is-evil
13398 If the @acronym{NNTP} server does not support @acronym{NOV}, you could set this
13399 variable to @code{t}, but @code{nntp} usually checks automatically whether @acronym{NOV}
13402 @item nntp-xover-commands
13403 @vindex nntp-xover-commands
13404 @cindex @acronym{NOV}
13406 List of strings used as commands to fetch @acronym{NOV} lines from a
13407 server. The default value of this variable is @code{("XOVER"
13411 @vindex nntp-nov-gap
13412 @code{nntp} normally sends just one big request for @acronym{NOV} lines to
13413 the server. The server responds with one huge list of lines. However,
13414 if you have read articles 2-5000 in the group, and only want to read
13415 article 1 and 5001, that means that @code{nntp} will fetch 4999 @acronym{NOV}
13416 lines that you will not need. This variable says how
13417 big a gap between two consecutive articles is allowed to be before the
13418 @code{XOVER} request is split into several request. Note that if your
13419 network is fast, setting this variable to a really small number means
13420 that fetching will probably be slower. If this variable is @code{nil},
13421 @code{nntp} will never split requests. The default is 5.
13423 @item nntp-xref-number-is-evil
13424 @vindex nntp-xref-number-is-evil
13425 When Gnus refers to an article having the @code{Message-ID} that a user
13426 specifies or having the @code{Message-ID} of the parent article of the
13427 current one (@pxref{Finding the Parent}), Gnus sends a @code{HEAD}
13428 command to the @acronym{NNTP} server to know where it is, and the server
13429 returns the data containing the pairs of a group and an article number
13430 in the @code{Xref} header. Gnus normally uses the article number to
13431 refer to the article if the data shows that that article is in the
13432 current group, while it uses the @code{Message-ID} otherwise. However,
13433 some news servers, e.g., ones running Diablo, run multiple engines
13434 having the same articles but article numbers are not kept synchronized
13435 between them. In that case, the article number that appears in the
13436 @code{Xref} header varies by which engine is chosen, so you cannot refer
13437 to the parent article that is in the current group, for instance. If
13438 you connect to such a server, set this variable to a non-@code{nil}
13439 value, and Gnus never uses article numbers. For example:
13442 (setq gnus-select-method
13444 (nntp-address "newszilla.example.com")
13445 (nntp-xref-number-is-evil t)
13449 The default value of this server variable is @code{nil}.
13451 @item nntp-prepare-server-hook
13452 @vindex nntp-prepare-server-hook
13453 A hook run before attempting to connect to an @acronym{NNTP} server.
13455 @item nntp-record-commands
13456 @vindex nntp-record-commands
13457 If non-@code{nil}, @code{nntp} will log all commands it sends to the
13458 @acronym{NNTP} server (along with a timestamp) in the @samp{*nntp-log*}
13459 buffer. This is useful if you are debugging a Gnus/@acronym{NNTP} connection
13460 that doesn't seem to work.
13462 @item nntp-open-connection-function
13463 @vindex nntp-open-connection-function
13464 It is possible to customize how the connection to the nntp server will
13465 be opened. If you specify an @code{nntp-open-connection-function}
13466 parameter, Gnus will use that function to establish the connection.
13467 Seven pre-made functions are supplied. These functions can be grouped
13468 in two categories: direct connection functions (four pre-made), and
13469 indirect ones (three pre-made).
13471 @item nntp-never-echoes-commands
13472 @vindex nntp-never-echoes-commands
13473 Non-@code{nil} means the nntp server never echoes commands. It is
13474 reported that some nntps server doesn't echo commands. So, you may want
13475 to set this to non-@code{nil} in the method for such a server setting
13476 @code{nntp-open-connection-function} to @code{nntp-open-ssl-stream} for
13477 example. The default value is @code{nil}. Note that the
13478 @code{nntp-open-connection-functions-never-echo-commands} variable
13479 overrides the @code{nil} value of this variable.
13481 @item nntp-open-connection-functions-never-echo-commands
13482 @vindex nntp-open-connection-functions-never-echo-commands
13483 List of functions that never echo commands. Add or set a function which
13484 you set to @code{nntp-open-connection-function} to this list if it does
13485 not echo commands. Note that a non-@code{nil} value of the
13486 @code{nntp-never-echoes-commands} variable overrides this variable. The
13487 default value is @code{(nntp-open-network-stream)}.
13489 @item nntp-prepare-post-hook
13490 @vindex nntp-prepare-post-hook
13491 A hook run just before posting an article. If there is no
13492 @code{Message-ID} header in the article and the news server provides the
13493 recommended ID, it will be added to the article before running this
13494 hook. It is useful to make @code{Cancel-Lock} headers even if you
13495 inhibit Gnus to add a @code{Message-ID} header, you could say:
13498 (add-hook 'nntp-prepare-post-hook 'canlock-insert-header)
13501 Note that not all servers support the recommended ID. This works for
13502 INN versions 2.3.0 and later, for instance.
13507 * Direct Functions:: Connecting directly to the server.
13508 * Indirect Functions:: Connecting indirectly to the server.
13509 * Common Variables:: Understood by several connection functions.
13510 * NNTP marks:: Storing marks for @acronym{NNTP} servers.
13514 @node Direct Functions
13515 @subsubsection Direct Functions
13516 @cindex direct connection functions
13518 These functions are called direct because they open a direct connection
13519 between your machine and the @acronym{NNTP} server. The behavior of these
13520 functions is also affected by commonly understood variables
13521 (@pxref{Common Variables}).
13524 @findex nntp-open-network-stream
13525 @item nntp-open-network-stream
13526 This is the default, and simply connects to some port or other on the
13529 @findex nntp-open-tls-stream
13530 @item nntp-open-tls-stream
13531 Opens a connection to a server over a @dfn{secure} channel. To use
13532 this you must have @uref{http://www.gnu.org/software/gnutls/, GNUTLS}
13533 installed. You then define a server as follows:
13536 ;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
13537 ;; @r{however, @samp{gnutls-cli -p} doesn't like named ports.}
13539 (nntp "snews.bar.com"
13540 (nntp-open-connection-function nntp-open-tls-stream)
13541 (nntp-port-number )
13542 (nntp-address "snews.bar.com"))
13545 @findex nntp-open-ssl-stream
13546 @item nntp-open-ssl-stream
13547 Opens a connection to a server over a @dfn{secure} channel. To use
13548 this you must have @uref{http://www.openssl.org, OpenSSL} or
13549 @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay} installed. You
13550 then define a server as follows:
13553 ;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
13554 ;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
13556 (nntp "snews.bar.com"
13557 (nntp-open-connection-function nntp-open-ssl-stream)
13558 (nntp-port-number 563)
13559 (nntp-address "snews.bar.com"))
13562 @findex nntp-open-telnet-stream
13563 @item nntp-open-telnet-stream
13564 Opens a connection to an @acronym{NNTP} server by simply @samp{telnet}'ing
13565 it. You might wonder why this function exists, since we have the
13566 default @code{nntp-open-network-stream} which would do the job. (One
13567 of) the reason(s) is that if you are behind a firewall but have direct
13568 connections to the outside world thanks to a command wrapper like
13569 @code{runsocks}, you can use it like this:
13573 (nntp-pre-command "runsocks")
13574 (nntp-open-connection-function nntp-open-telnet-stream)
13575 (nntp-address "the.news.server"))
13578 With the default method, you would need to wrap your whole Emacs
13579 session, which is not a good idea.
13583 @node Indirect Functions
13584 @subsubsection Indirect Functions
13585 @cindex indirect connection functions
13587 These functions are called indirect because they connect to an
13588 intermediate host before actually connecting to the @acronym{NNTP} server.
13589 All of these functions and related variables are also said to belong to
13590 the ``via'' family of connection: they're all prefixed with ``via'' to make
13591 things cleaner. The behavior of these functions is also affected by
13592 commonly understood variables (@pxref{Common Variables}).
13595 @item nntp-open-via-rlogin-and-telnet
13596 @findex nntp-open-via-rlogin-and-telnet
13597 Does an @samp{rlogin} on a remote system, and then does a @samp{telnet}
13598 to the real @acronym{NNTP} server from there. This is useful for instance if
13599 you need to connect to a firewall machine first.
13601 @code{nntp-open-via-rlogin-and-telnet}-specific variables:
13604 @item nntp-via-rlogin-command
13605 @vindex nntp-via-rlogin-command
13606 Command used to log in on the intermediate host. The default is
13607 @samp{rsh}, but @samp{ssh} is a popular alternative.
13609 @item nntp-via-rlogin-command-switches
13610 @vindex nntp-via-rlogin-command-switches
13611 List of strings to be used as the switches to
13612 @code{nntp-via-rlogin-command}. The default is @code{nil}. If you use
13613 @samp{ssh} for @code{nntp-via-rlogin-command}, you may set this to
13614 @samp{("-C")} in order to compress all data connections, otherwise set
13615 this to @samp{("-t" "-e" "none")} or @samp{("-C" "-t" "-e" "none")} if
13616 the telnet command requires a pseudo-tty allocation on an intermediate
13620 Note that you may want to change the value for @code{nntp-end-of-line}
13621 to @samp{\n} (@pxref{Common Variables}).
13623 @item nntp-open-via-rlogin-and-netcat
13624 @findex nntp-open-via-rlogin-and-netcat
13625 Does essentially the same, but uses
13626 @uref{http://netcat.sourceforge.net/, netcat} instead of @samp{telnet}
13627 to connect to the real @acronym{NNTP} server from the intermediate host.
13629 @code{nntp-open-via-rlogin-and-netcat}-specific variables:
13632 @item nntp-via-netcat-command
13633 @vindex nntp-via-netcat-command
13634 Command used to connect to the real @acronym{NNTP} server from the
13635 intermediate host. The default is @samp{nc}. You can also use other
13636 programs like @uref{http://www.imasy.or.jp/~gotoh/ssh/connect.html,
13639 @item nntp-via-netcat-switches
13640 @vindex nntp-via-netcat-switches
13641 List of strings to be used as the switches to the
13642 @code{nntp-via-telnet-command} command. The default is @code{nil}.
13644 @item nntp-via-rlogin-command
13645 @vindex nntp-via-rlogin-command
13646 Command used to log in on the intermediate host. The default is
13647 @samp{rsh}, but @samp{ssh} is a popular alternative.
13649 @item nntp-via-rlogin-command-switches
13650 @vindex nntp-via-rlogin-command-switches
13651 List of strings to be used as the switches to
13652 @code{nntp-via-rlogin-command}. The default is @code{nil}.
13655 @item nntp-open-via-telnet-and-telnet
13656 @findex nntp-open-via-telnet-and-telnet
13657 Does essentially the same, but uses @samp{telnet} instead of
13658 @samp{rlogin} to connect to the intermediate host.
13660 @code{nntp-open-via-telnet-and-telnet}-specific variables:
13663 @item nntp-via-telnet-command
13664 @vindex nntp-via-telnet-command
13665 Command used to @code{telnet} the intermediate host. The default is
13668 @item nntp-via-telnet-switches
13669 @vindex nntp-via-telnet-switches
13670 List of strings to be used as the switches to the
13671 @code{nntp-via-telnet-command} command. The default is @samp{("-8")}.
13673 @item nntp-via-user-password
13674 @vindex nntp-via-user-password
13675 Password to use when logging in on the intermediate host.
13677 @item nntp-via-envuser
13678 @vindex nntp-via-envuser
13679 If non-@code{nil}, the intermediate @code{telnet} session (client and
13680 server both) will support the @code{ENVIRON} option and not prompt for
13681 login name. This works for Solaris @code{telnet}, for instance.
13683 @item nntp-via-shell-prompt
13684 @vindex nntp-via-shell-prompt
13685 Regexp matching the shell prompt on the intermediate host. The default
13686 is @samp{bash\\|\$ *\r?$\\|> *\r?}.
13690 Note that you may want to change the value for @code{nntp-end-of-line}
13691 to @samp{\n} (@pxref{Common Variables}).
13695 Here are some additional variables that are understood by all the above
13700 @item nntp-via-user-name
13701 @vindex nntp-via-user-name
13702 User name to use when connecting to the intermediate host.
13704 @item nntp-via-address
13705 @vindex nntp-via-address
13706 Address of the intermediate host to connect to.
13711 @node Common Variables
13712 @subsubsection Common Variables
13714 The following variables affect the behavior of all, or several of the
13715 pre-made connection functions. When not specified, all functions are
13716 affected (the values of the following variables will be used as the
13717 default if each virtual @code{nntp} server doesn't specify those server
13718 variables individually).
13722 @item nntp-pre-command
13723 @vindex nntp-pre-command
13724 A command wrapper to use when connecting through a non native
13725 connection function (all except @code{nntp-open-network-stream},
13726 @code{nntp-open-tls-stream}, and @code{nntp-open-ssl-stream}). This is
13727 where you would put a @samp{SOCKS} wrapper for instance.
13730 @vindex nntp-address
13731 The address of the @acronym{NNTP} server.
13733 @item nntp-port-number
13734 @vindex nntp-port-number
13735 Port number to connect to the @acronym{NNTP} server. The default is
13736 @samp{nntp}. If you use @acronym{NNTP} over
13737 @acronym{TLS}/@acronym{SSL}, you may want to use integer ports rather
13738 than named ports (i.e, use @samp{563} instead of @samp{snews} or
13739 @samp{nntps}), because external @acronym{TLS}/@acronym{SSL} tools may
13740 not work with named ports.
13742 @item nntp-end-of-line
13743 @vindex nntp-end-of-line
13744 String to use as end-of-line marker when talking to the @acronym{NNTP}
13745 server. This is @samp{\r\n} by default, but should be @samp{\n} when
13746 using a non native telnet connection function.
13748 @item nntp-telnet-command
13749 @vindex nntp-telnet-command
13750 Command to use when connecting to the @acronym{NNTP} server through
13751 @samp{telnet}. This is @emph{not} for an intermediate host. This is
13752 just for the real @acronym{NNTP} server. The default is
13755 @item nntp-telnet-switches
13756 @vindex nntp-telnet-switches
13757 A list of switches to pass to @code{nntp-telnet-command}. The default
13763 @subsubsection NNTP marks
13764 @cindex storing NNTP marks
13766 Gnus stores marks (@pxref{Marking Articles}) for @acronym{NNTP}
13767 servers in marks files. A marks file records what marks you have set
13768 in a group and each file is specific to the corresponding server.
13769 Marks files are stored in @file{~/News/marks}
13770 (@code{nntp-marks-directory}) under a classic hierarchy resembling
13771 that of a news server, for example marks for the group
13772 @samp{gmane.discuss} on the news.gmane.org server will be stored in
13773 the file @file{~/News/marks/news.gmane.org/gmane/discuss/.marks}.
13775 Marks files are useful because you can copy the @file{~/News/marks}
13776 directory (using rsync, scp or whatever) to another Gnus installation,
13777 and it will realize what articles you have read and marked. The data
13778 in @file{~/News/marks} has priority over the same data in
13779 @file{~/.newsrc.eld}.
13781 Note that marks files are very much server-specific: Gnus remembers
13782 the article numbers so if you don't use the same servers on both
13783 installations things are most likely to break (most @acronym{NNTP}
13784 servers do not use the same article numbers as any other server).
13785 However, if you use servers A, B, C on one installation and servers A,
13786 D, E on the other, you can sync the marks files for A and then you'll
13787 get synchronization for that server between the two installations.
13789 Using @acronym{NNTP} marks can possibly incur a performance penalty so
13790 if Gnus feels sluggish, try setting the @code{nntp-marks-is-evil}
13791 variable to @code{t}. Marks will then be stored in @file{~/.newsrc.eld}.
13797 @item nntp-marks-is-evil
13798 @vindex nntp-marks-is-evil
13799 If non-@code{nil}, this back end will ignore any marks files. The
13800 default is @code{nil}.
13802 @item nntp-marks-directory
13803 @vindex nntp-marks-directory
13804 The directory where marks for nntp groups will be stored.
13810 @subsection News Spool
13814 Subscribing to a foreign group from the local spool is extremely easy,
13815 and might be useful, for instance, to speed up reading groups that
13816 contain very big articles---@samp{alt.binaries.pictures.furniture}, for
13819 Anyway, you just specify @code{nnspool} as the method and @code{""} (or
13820 anything else) as the address.
13822 If you have access to a local spool, you should probably use that as the
13823 native select method (@pxref{Finding the News}). It is normally faster
13824 than using an @code{nntp} select method, but might not be. It depends.
13825 You just have to try to find out what's best at your site.
13829 @item nnspool-inews-program
13830 @vindex nnspool-inews-program
13831 Program used to post an article.
13833 @item nnspool-inews-switches
13834 @vindex nnspool-inews-switches
13835 Parameters given to the inews program when posting an article.
13837 @item nnspool-spool-directory
13838 @vindex nnspool-spool-directory
13839 Where @code{nnspool} looks for the articles. This is normally
13840 @file{/usr/spool/news/}.
13842 @item nnspool-nov-directory
13843 @vindex nnspool-nov-directory
13844 Where @code{nnspool} will look for @acronym{NOV} files. This is normally@*
13845 @file{/usr/spool/news/over.view/}.
13847 @item nnspool-lib-dir
13848 @vindex nnspool-lib-dir
13849 Where the news lib dir is (@file{/usr/lib/news/} by default).
13851 @item nnspool-active-file
13852 @vindex nnspool-active-file
13853 The name of the active file.
13855 @item nnspool-newsgroups-file
13856 @vindex nnspool-newsgroups-file
13857 The name of the group descriptions file.
13859 @item nnspool-history-file
13860 @vindex nnspool-history-file
13861 The name of the news history file.
13863 @item nnspool-active-times-file
13864 @vindex nnspool-active-times-file
13865 The name of the active date file.
13867 @item nnspool-nov-is-evil
13868 @vindex nnspool-nov-is-evil
13869 If non-@code{nil}, @code{nnspool} won't try to use any @acronym{NOV} files
13872 @item nnspool-sift-nov-with-sed
13873 @vindex nnspool-sift-nov-with-sed
13875 If non-@code{nil}, which is the default, use @code{sed} to get the
13876 relevant portion from the overview file. If @code{nil},
13877 @code{nnspool} will load the entire file into a buffer and process it
13884 @section Getting Mail
13885 @cindex reading mail
13888 Reading mail with a newsreader---isn't that just plain WeIrD? But of
13892 * Mail in a Newsreader:: Important introductory notes.
13893 * Getting Started Reading Mail:: A simple cookbook example.
13894 * Splitting Mail:: How to create mail groups.
13895 * Mail Sources:: How to tell Gnus where to get mail from.
13896 * Mail Back End Variables:: Variables for customizing mail handling.
13897 * Fancy Mail Splitting:: Gnus can do hairy splitting of incoming mail.
13898 * Group Mail Splitting:: Use group customize to drive mail splitting.
13899 * Incorporating Old Mail:: What about the old mail you have?
13900 * Expiring Mail:: Getting rid of unwanted mail.
13901 * Washing Mail:: Removing cruft from the mail you get.
13902 * Duplicates:: Dealing with duplicated mail.
13903 * Not Reading Mail:: Using mail back ends for reading other files.
13904 * Choosing a Mail Back End:: Gnus can read a variety of mail formats.
13908 @node Mail in a Newsreader
13909 @subsection Mail in a Newsreader
13911 If you are used to traditional mail readers, but have decided to switch
13912 to reading mail with Gnus, you may find yourself experiencing something
13913 of a culture shock.
13915 Gnus does not behave like traditional mail readers. If you want to make
13916 it behave that way, you can, but it's an uphill battle.
13918 Gnus, by default, handles all its groups using the same approach. This
13919 approach is very newsreaderly---you enter a group, see the new/unread
13920 messages, and when you read the messages, they get marked as read, and
13921 you don't see them any more. (Unless you explicitly ask for them.)
13923 In particular, you do not do anything explicitly to delete messages.
13925 Does this mean that all the messages that have been marked as read are
13926 deleted? How awful!
13928 But, no, it means that old messages are @dfn{expired} according to some
13929 scheme or other. For news messages, the expire process is controlled by
13930 the news administrator; for mail, the expire process is controlled by
13931 you. The expire process for mail is covered in depth in @ref{Expiring
13934 What many Gnus users find, after using it a while for both news and
13935 mail, is that the transport mechanism has very little to do with how
13936 they want to treat a message.
13938 Many people subscribe to several mailing lists. These are transported
13939 via @acronym{SMTP}, and are therefore mail. But we might go for weeks without
13940 answering, or even reading these messages very carefully. We may not
13941 need to save them because if we should need to read one again, they are
13942 archived somewhere else.
13944 Some people have local news groups which have only a handful of readers.
13945 These are transported via @acronym{NNTP}, and are therefore news. But we may need
13946 to read and answer a large fraction of the messages very carefully in
13947 order to do our work. And there may not be an archive, so we may need
13948 to save the interesting messages the same way we would personal mail.
13950 The important distinction turns out to be not the transport mechanism,
13951 but other factors such as how interested we are in the subject matter,
13952 or how easy it is to retrieve the message if we need to read it again.
13954 Gnus provides many options for sorting mail into ``groups'' which behave
13955 like newsgroups, and for treating each group (whether mail or news)
13958 Some users never get comfortable using the Gnus (ahem) paradigm and wish
13959 that Gnus should grow up and be a male, er, mail reader. It is possible
13960 to whip Gnus into a more mailreaderly being, but, as said before, it's
13961 not easy. People who prefer proper mail readers should try @sc{vm}
13962 instead, which is an excellent, and proper, mail reader.
13964 I don't mean to scare anybody off, but I want to make it clear that you
13965 may be required to learn a new way of thinking about messages. After
13966 you've been subjected to The Gnus Way, you will come to love it. I can
13967 guarantee it. (At least the guy who sold me the Emacs Subliminal
13968 Brain-Washing Functions that I've put into Gnus did guarantee it. You
13969 Will Be Assimilated. You Love Gnus. You Love The Gnus Mail Way.
13973 @node Getting Started Reading Mail
13974 @subsection Getting Started Reading Mail
13976 It's quite easy to use Gnus to read your new mail. You just plonk the
13977 mail back end of your choice into @code{gnus-secondary-select-methods},
13978 and things will happen automatically.
13980 For instance, if you want to use @code{nnml} (which is a ``one file per
13981 mail'' back end), you could put the following in your @file{~/.gnus.el} file:
13984 (setq gnus-secondary-select-methods '((nnml "")))
13987 Now, the next time you start Gnus, this back end will be queried for new
13988 articles, and it will move all the messages in your spool file to its
13989 directory, which is @file{~/Mail/} by default. The new group that will
13990 be created (@samp{mail.misc}) will be subscribed, and you can read it
13991 like any other group.
13993 You will probably want to split the mail into several groups, though:
13996 (setq nnmail-split-methods
13997 '(("junk" "^From:.*Lars Ingebrigtsen")
13998 ("crazy" "^Subject:.*die\\|^Organization:.*flabby")
14002 This will result in three new @code{nnml} mail groups being created:
14003 @samp{nnml:junk}, @samp{nnml:crazy}, and @samp{nnml:other}. All the
14004 mail that doesn't fit into the first two groups will be placed in the
14007 This should be sufficient for reading mail with Gnus. You might want to
14008 give the other sections in this part of the manual a perusal, though.
14009 Especially @pxref{Choosing a Mail Back End} and @pxref{Expiring Mail}.
14012 @node Splitting Mail
14013 @subsection Splitting Mail
14014 @cindex splitting mail
14015 @cindex mail splitting
14016 @cindex mail filtering (splitting)
14018 @vindex nnmail-split-methods
14019 The @code{nnmail-split-methods} variable says how the incoming mail is
14020 to be split into groups.
14023 (setq nnmail-split-methods
14024 '(("mail.junk" "^From:.*Lars Ingebrigtsen")
14025 ("mail.crazy" "^Subject:.*die\\|^Organization:.*flabby")
14026 ("mail.other" "")))
14029 This variable is a list of lists, where the first element of each of
14030 these lists is the name of the mail group (they do not have to be called
14031 something beginning with @samp{mail}, by the way), and the second
14032 element is a regular expression used on the header of each mail to
14033 determine if it belongs in this mail group. The first string may
14034 contain @samp{\\1} forms, like the ones used by @code{replace-match} to
14035 insert sub-expressions from the matched text. For instance:
14038 ("list.\\1" "From:.* \\(.*\\)-list@@majordomo.com")
14042 In that case, @code{nnmail-split-lowercase-expanded} controls whether
14043 the inserted text should be made lowercase. @xref{Fancy Mail Splitting}.
14045 The second element can also be a function. In that case, it will be
14046 called narrowed to the headers with the first element of the rule as the
14047 argument. It should return a non-@code{nil} value if it thinks that the
14048 mail belongs in that group.
14050 @cindex @samp{bogus} group
14051 The last of these groups should always be a general one, and the regular
14052 expression should @emph{always} be @samp{""} so that it matches any mails
14053 that haven't been matched by any of the other regexps. (These rules are
14054 processed from the beginning of the alist toward the end. The first rule
14055 to make a match will ``win'', unless you have crossposting enabled. In
14056 that case, all matching rules will ``win''.) If no rule matched, the mail
14057 will end up in the @samp{bogus} group. When new groups are created by
14058 splitting mail, you may want to run @code{gnus-group-find-new-groups} to
14059 see the new groups. This also applies to the @samp{bogus} group.
14061 If you like to tinker with this yourself, you can set this variable to a
14062 function of your choice. This function will be called without any
14063 arguments in a buffer narrowed to the headers of an incoming mail
14064 message. The function should return a list of group names that it
14065 thinks should carry this mail message.
14067 Note that the mail back ends are free to maul the poor, innocent,
14068 incoming headers all they want to. They all add @code{Lines} headers;
14069 some add @code{X-Gnus-Group} headers; most rename the Unix mbox
14070 @code{From<SPACE>} line to something else.
14072 @vindex nnmail-crosspost
14073 The mail back ends all support cross-posting. If several regexps match,
14074 the mail will be ``cross-posted'' to all those groups.
14075 @code{nnmail-crosspost} says whether to use this mechanism or not. Note
14076 that no articles are crossposted to the general (@samp{""}) group.
14078 @vindex nnmail-crosspost-link-function
14081 @code{nnmh} and @code{nnml} makes crossposts by creating hard links to
14082 the crossposted articles. However, not all file systems support hard
14083 links. If that's the case for you, set
14084 @code{nnmail-crosspost-link-function} to @code{copy-file}. (This
14085 variable is @code{add-name-to-file} by default.)
14087 @kindex M-x nnmail-split-history
14088 @findex nnmail-split-history
14089 If you wish to see where the previous mail split put the messages, you
14090 can use the @kbd{M-x nnmail-split-history} command. If you wish to see
14091 where re-spooling messages would put the messages, you can use
14092 @code{gnus-summary-respool-trace} and related commands (@pxref{Mail
14095 @vindex nnmail-split-header-length-limit
14096 Header lines longer than the value of
14097 @code{nnmail-split-header-length-limit} are excluded from the split
14100 @vindex nnmail-mail-splitting-decodes
14101 @vindex nnmail-mail-splitting-charset
14102 By default, splitting does not decode headers, so you can not match on
14103 non-@acronym{ASCII} strings. But it is useful if you want to match
14104 articles based on the raw header data. To enable it, set the
14105 @code{nnmail-mail-splitting-decodes} variable to a non-@code{nil} value.
14106 In addition, the value of the @code{nnmail-mail-splitting-charset}
14107 variable is used for decoding non-@acronym{MIME} encoded string when
14108 @code{nnmail-mail-splitting-decodes} is non-@code{nil}. The default
14109 value is @code{nil} which means not to decode non-@acronym{MIME} encoded
14110 string. A suitable value for you will be @code{undecided} or be the
14111 charset used normally in mails you are interested in.
14113 @vindex nnmail-resplit-incoming
14114 By default, splitting is performed on all incoming messages. If you
14115 specify a @code{directory} entry for the variable @code{mail-sources}
14116 (@pxref{Mail Source Specifiers}), however, then splitting does
14117 @emph{not} happen by default. You can set the variable
14118 @code{nnmail-resplit-incoming} to a non-@code{nil} value to make
14119 splitting happen even in this case. (This variable has no effect on
14120 other kinds of entries.)
14122 Gnus gives you all the opportunity you could possibly want for shooting
14123 yourself in the foot. Let's say you create a group that will contain
14124 all the mail you get from your boss. And then you accidentally
14125 unsubscribe from the group. Gnus will still put all the mail from your
14126 boss in the unsubscribed group, and so, when your boss mails you ``Have
14127 that report ready by Monday or you're fired!'', you'll never see it and,
14128 come Tuesday, you'll still believe that you're gainfully employed while
14129 you really should be out collecting empty bottles to save up for next
14130 month's rent money.
14134 @subsection Mail Sources
14136 Mail can be gotten from many different sources---the mail spool, from
14137 a @acronym{POP} mail server, from a procmail directory, or from a
14138 maildir, for instance.
14141 * Mail Source Specifiers:: How to specify what a mail source is.
14142 * Mail Source Customization:: Some variables that influence things.
14143 * Fetching Mail:: Using the mail source specifiers.
14147 @node Mail Source Specifiers
14148 @subsubsection Mail Source Specifiers
14150 @cindex mail server
14153 @cindex mail source
14155 You tell Gnus how to fetch mail by setting @code{mail-sources}
14156 (@pxref{Fetching Mail}) to a @dfn{mail source specifier}.
14161 (pop :server "pop3.mailserver.com" :user "myname")
14164 As can be observed, a mail source specifier is a list where the first
14165 element is a @dfn{mail source type}, followed by an arbitrary number of
14166 @dfn{keywords}. Keywords that are not explicitly specified are given
14169 The @code{mail-sources} is global for all mail groups. You can specify
14170 an additional mail source for a particular group by including the
14171 @code{group} mail specifier in @code{mail-sources}, and setting a
14172 @code{mail-source} group parameter (@pxref{Group Parameters}) specifying
14173 a single mail source. When this is used, @code{mail-sources} is
14174 typically just @code{(group)}; the @code{mail-source} parameter for a
14175 group might look like this:
14178 (mail-source . (file :path "home/user/spools/foo.spool"))
14181 This means that the group's (and only this group's) messages will be
14182 fetched from the spool file @samp{/user/spools/foo.spool}.
14184 The following mail source types are available:
14188 Get mail from a single file; typically from the mail spool.
14194 The file name. Defaults to the value of the @env{MAIL}
14195 environment variable or the value of @code{rmail-spool-directory}
14196 (usually something like @file{/usr/mail/spool/user-name}).
14200 Script run before/after fetching mail.
14203 An example file mail source:
14206 (file :path "/usr/spool/mail/user-name")
14209 Or using the default file name:
14215 If the mail spool file is not located on the local machine, it's best
14216 to use @acronym{POP} or @acronym{IMAP} or the like to fetch the mail.
14217 You can not use ange-ftp file names here---it has no way to lock the
14218 mail spool while moving the mail.
14220 If it's impossible to set up a proper server, you can use ssh instead.
14224 '((file :prescript "ssh host bin/getmail >%t")))
14227 The @samp{getmail} script would look something like the following:
14231 # getmail - move mail from spool to stdout
14234 MOVEMAIL=/usr/lib/emacs/20.3/i386-redhat-linux/movemail
14236 rm -f $TMP; $MOVEMAIL $MAIL $TMP >/dev/null && cat $TMP
14239 Alter this script to fit the @samp{movemail} and temporary
14240 file you want to use.
14244 @vindex nnmail-scan-directory-mail-source-once
14245 Get mail from several files in a directory. This is typically used
14246 when you have procmail split the incoming mail into several files.
14247 That is, there is a one-to-one correspondence between files in that
14248 directory and groups, so that mail from the file @file{foo.bar.spool}
14249 will be put in the group @code{foo.bar}. (You can change the suffix
14250 to be used instead of @code{.spool}.) Setting
14251 @code{nnmail-scan-directory-mail-source-once} to non-@code{nil} forces
14252 Gnus to scan the mail source only once. This is particularly useful
14253 if you want to scan mail groups at a specified level.
14255 @vindex nnmail-resplit-incoming
14256 There is also the variable @code{nnmail-resplit-incoming}, if you set
14257 that to a non-@code{nil} value, then the normal splitting process is
14258 applied to all the files from the directory, @ref{Splitting Mail}.
14264 The name of the directory where the files are. There is no default
14268 Only files ending with this suffix are used. The default is
14272 Only files that have this predicate return non-@code{nil} are returned.
14273 The default is @code{identity}. This is used as an additional
14274 filter---only files that have the right suffix @emph{and} satisfy this
14275 predicate are considered.
14279 Script run before/after fetching mail.
14283 An example directory mail source:
14286 (directory :path "/home/user-name/procmail-dir/"
14291 Get mail from a @acronym{POP} server.
14297 The name of the @acronym{POP} server. The default is taken from the
14298 @env{MAILHOST} environment variable.
14301 The port number of the @acronym{POP} server. This can be a number (eg,
14302 @samp{:port 1234}) or a string (eg, @samp{:port "pop3"}). If it is a
14303 string, it should be a service name as listed in @file{/etc/services} on
14304 Unix systems. The default is @samp{"pop3"}. On some systems you might
14305 need to specify it as @samp{"pop-3"} instead.
14308 The user name to give to the @acronym{POP} server. The default is the login
14312 The password to give to the @acronym{POP} server. If not specified,
14313 the user is prompted.
14316 The program to use to fetch mail from the @acronym{POP} server. This
14317 should be a @code{format}-like string. Here's an example:
14320 fetchmail %u@@%s -P %p %t
14323 The valid format specifier characters are:
14327 The name of the file the mail is to be moved to. This must always be
14328 included in this string.
14331 The name of the server.
14334 The port number of the server.
14337 The user name to use.
14340 The password to use.
14343 The values used for these specs are taken from the values you give the
14344 corresponding keywords.
14347 A script to be run before fetching the mail. The syntax is the same as
14348 the @code{:program} keyword. This can also be a function to be run.
14351 A script to be run after fetching the mail. The syntax is the same as
14352 the @code{:program} keyword. This can also be a function to be run.
14355 The function to use to fetch mail from the @acronym{POP} server. The
14356 function is called with one parameter---the name of the file where the
14357 mail should be moved to.
14359 @item :authentication
14360 This can be either the symbol @code{password} or the symbol @code{apop}
14361 and says what authentication scheme to use. The default is
14366 @vindex pop3-movemail
14367 @vindex pop3-leave-mail-on-server
14368 If the @code{:program} and @code{:function} keywords aren't specified,
14369 @code{pop3-movemail} will be used. If @code{pop3-leave-mail-on-server}
14370 is non-@code{nil} the mail is to be left on the @acronym{POP} server
14371 after fetching when using @code{pop3-movemail}. Note that POP servers
14372 maintain no state information between sessions, so what the client
14373 believes is there and what is actually there may not match up. If they
14374 do not, then you may get duplicate mails or the whole thing can fall
14375 apart and leave you with a corrupt mailbox.
14377 Here are some examples for getting mail from a @acronym{POP} server.
14378 Fetch from the default @acronym{POP} server, using the default user
14379 name, and default fetcher:
14385 Fetch from a named server with a named user and password:
14388 (pop :server "my.pop.server"
14389 :user "user-name" :password "secret")
14392 Use @samp{movemail} to move the mail:
14395 (pop :program "movemail po:%u %t %p")
14399 Get mail from a maildir. This is a type of mailbox that is supported by
14400 at least qmail and postfix, where each file in a special directory
14401 contains exactly one mail.
14407 The name of the directory where the mails are stored. The default is
14408 taken from the @env{MAILDIR} environment variable or
14411 The subdirectories of the Maildir. The default is
14412 @samp{("new" "cur")}.
14414 @c If you sometimes look at your mail through a pop3 daemon before fetching
14415 @c them with Gnus, you may also have to fetch your mails from the
14416 @c @code{cur} directory inside the maildir, like in the first example
14419 You can also get mails from remote hosts (because maildirs don't suffer
14420 from locking problems).
14424 Two example maildir mail sources:
14427 (maildir :path "/home/user-name/Maildir/"
14428 :subdirs ("cur" "new"))
14432 (maildir :path "/user@@remotehost.org:~/Maildir/"
14437 Get mail from a @acronym{IMAP} server. If you don't want to use
14438 @acronym{IMAP} as intended, as a network mail reading protocol (ie
14439 with nnimap), for some reason or other, Gnus let you treat it similar
14440 to a @acronym{POP} server and fetches articles from a given
14441 @acronym{IMAP} mailbox. @xref{IMAP}, for more information.
14443 Note that for the Kerberos, GSSAPI, @acronym{TLS}/@acronym{SSL} and STARTTLS support you
14444 may need external programs and libraries, @xref{IMAP}.
14450 The name of the @acronym{IMAP} server. The default is taken from the
14451 @env{MAILHOST} environment variable.
14454 The port number of the @acronym{IMAP} server. The default is @samp{143}, or
14455 @samp{993} for @acronym{TLS}/@acronym{SSL} connections.
14458 The user name to give to the @acronym{IMAP} server. The default is the login
14462 The password to give to the @acronym{IMAP} server. If not specified, the user is
14466 What stream to use for connecting to the server, this is one of the
14467 symbols in @code{imap-stream-alist}. Right now, this means
14468 @samp{gssapi}, @samp{kerberos4}, @samp{starttls}, @samp{tls},
14469 @samp{ssl}, @samp{shell} or the default @samp{network}.
14471 @item :authentication
14472 Which authenticator to use for authenticating to the server, this is
14473 one of the symbols in @code{imap-authenticator-alist}. Right now,
14474 this means @samp{gssapi}, @samp{kerberos4}, @samp{digest-md5},
14475 @samp{cram-md5}, @samp{anonymous} or the default @samp{login}.
14478 When using the `shell' :stream, the contents of this variable is
14479 mapped into the @code{imap-shell-program} variable. This should be a
14480 @code{format}-like string (or list of strings). Here's an example:
14486 Make sure nothing is interfering with the output of the program, e.g.,
14487 don't forget to redirect the error output to the void. The valid format
14488 specifier characters are:
14492 The name of the server.
14495 User name from @code{imap-default-user}.
14498 The port number of the server.
14501 The values used for these specs are taken from the values you give the
14502 corresponding keywords.
14505 The name of the mailbox to get mail from. The default is @samp{INBOX}
14506 which normally is the mailbox which receive incoming mail.
14509 The predicate used to find articles to fetch. The default, @samp{UNSEEN
14510 UNDELETED}, is probably the best choice for most people, but if you
14511 sometimes peek in your mailbox with a @acronym{IMAP} client and mark some
14512 articles as read (or; SEEN) you might want to set this to @samp{1:*}.
14513 Then all articles in the mailbox is fetched, no matter what. For a
14514 complete list of predicates, see RFC 2060 section 6.4.4.
14517 How to flag fetched articles on the server, the default @samp{\Deleted}
14518 will mark them as deleted, an alternative would be @samp{\Seen} which
14519 would simply mark them as read. These are the two most likely choices,
14520 but more flags are defined in RFC 2060 section 2.3.2.
14523 If non-@code{nil}, don't remove all articles marked as deleted in the
14524 mailbox after finishing the fetch.
14528 An example @acronym{IMAP} mail source:
14531 (imap :server "mail.mycorp.com"
14533 :fetchflag "\\Seen")
14537 Get mail from a webmail server, such as @uref{http://www.hotmail.com/},
14538 @uref{http://webmail.netscape.com/}, @uref{http://www.netaddress.com/},
14539 @uref{http://mail.yahoo.com/}.
14541 NOTE: Webmail largely depends on cookies. A "one-line-cookie" patch is
14542 required for url "4.0pre.46".
14544 WARNING: Mails may be lost. NO WARRANTY.
14550 The type of the webmail server. The default is @code{hotmail}. The
14551 alternatives are @code{netscape}, @code{netaddress}, @code{my-deja}.
14554 The user name to give to the webmail server. The default is the login
14558 The password to give to the webmail server. If not specified, the user is
14562 If non-@code{nil}, only fetch unread articles and don't move them to
14563 trash folder after finishing the fetch.
14567 An example webmail source:
14570 (webmail :subtype 'hotmail
14572 :password "secret")
14576 Get the actual mail source from the @code{mail-source} group parameter,
14577 @xref{Group Parameters}.
14582 @item Common Keywords
14583 Common keywords can be used in any type of mail source.
14589 If non-@code{nil}, fetch the mail even when Gnus is unplugged. If you
14590 use directory source to get mail, you can specify it as in this
14595 '((directory :path "/home/pavel/.Spool/"
14600 Gnus will then fetch your mail even when you are unplugged. This is
14601 useful when you use local mail and news.
14606 @subsubsection Function Interface
14608 Some of the above keywords specify a Lisp function to be executed.
14609 For each keyword @code{:foo}, the Lisp variable @code{foo} is bound to
14610 the value of the keyword while the function is executing. For example,
14611 consider the following mail-source setting:
14614 (setq mail-sources '((pop :user "jrl"
14615 :server "pophost" :function fetchfunc)))
14618 While the function @code{fetchfunc} is executing, the symbol @code{user}
14619 is bound to @code{"jrl"}, and the symbol @code{server} is bound to
14620 @code{"pophost"}. The symbols @code{port}, @code{password},
14621 @code{program}, @code{prescript}, @code{postscript}, @code{function},
14622 and @code{authentication} are also bound (to their default values).
14624 See above for a list of keywords for each type of mail source.
14627 @node Mail Source Customization
14628 @subsubsection Mail Source Customization
14630 The following is a list of variables that influence how the mail is
14631 fetched. You would normally not need to set or change any of these
14635 @item mail-source-crash-box
14636 @vindex mail-source-crash-box
14637 File where mail will be stored while processing it. The default is@*
14638 @file{~/.emacs-mail-crash-box}.
14641 @item mail-source-delete-incoming
14642 @vindex mail-source-delete-incoming
14643 If non-@code{nil}, delete incoming files after handling them. If
14644 @code{t}, delete the files immediately, if @code{nil}, never delete any
14645 files. If a positive number, delete files older than number of days
14646 (the deletion will only happen when receiving new mail). You may also
14647 set @code{mail-source-delete-incoming} to @code{nil} and call
14648 @code{mail-source-delete-old-incoming} from a hook or interactively.
14649 @code{mail-source-delete-incoming} defaults to @code{2} in alpha Gnusae
14650 and @code{10} in released Gnusae. @xref{Gnus Development}.
14652 @item mail-source-delete-old-incoming-confirm
14653 @vindex mail-source-delete-old-incoming-confirm
14654 If non-@code{nil}, ask for confirmation before deleting old incoming
14655 files. This variable only applies when
14656 @code{mail-source-delete-incoming} is a positive number.
14658 @item mail-source-ignore-errors
14659 @vindex mail-source-ignore-errors
14660 If non-@code{nil}, ignore errors when reading mail from a mail source.
14662 @item mail-source-directory
14663 @vindex mail-source-directory
14664 Directory where incoming mail source files (if any) will be stored. The
14665 default is @file{~/Mail/}. At present, the only thing this is used for
14666 is to say where the incoming files will be stored if the variable
14667 @code{mail-source-delete-incoming} is @code{nil} or a number.
14669 @item mail-source-incoming-file-prefix
14670 @vindex mail-source-incoming-file-prefix
14671 Prefix for file name for storing incoming mail. The default is
14672 @file{Incoming}, in which case files will end up with names like
14673 @file{Incoming30630D_} or @file{Incoming298602ZD}. This is really only
14674 relevant if @code{mail-source-delete-incoming} is @code{nil} or a
14677 @item mail-source-default-file-modes
14678 @vindex mail-source-default-file-modes
14679 All new mail files will get this file mode. The default is 384.
14681 @item mail-source-movemail-program
14682 @vindex mail-source-movemail-program
14683 If non-@code{nil}, name of program for fetching new mail. If
14684 @code{nil}, @code{movemail} in @var{exec-directory}.
14689 @node Fetching Mail
14690 @subsubsection Fetching Mail
14692 @vindex mail-sources
14693 The way to actually tell Gnus where to get new mail from is to set
14694 @code{mail-sources} to a list of mail source specifiers
14695 (@pxref{Mail Source Specifiers}).
14697 If this variable is @code{nil}, the mail back ends will never attempt to
14698 fetch mail by themselves.
14700 If you want to fetch mail both from your local spool as well as a
14701 @acronym{POP} mail server, you'd say something like:
14706 (pop :server "pop3.mail.server"
14707 :password "secret")))
14710 Or, if you don't want to use any of the keyword defaults:
14714 '((file :path "/var/spool/mail/user-name")
14715 (pop :server "pop3.mail.server"
14718 :password "secret")))
14722 When you use a mail back end, Gnus will slurp all your mail from your
14723 inbox and plonk it down in your home directory. Gnus doesn't move any
14724 mail if you're not using a mail back end---you have to do a lot of magic
14725 invocations first. At the time when you have finished drawing the
14726 pentagram, lightened the candles, and sacrificed the goat, you really
14727 shouldn't be too surprised when Gnus moves your mail.
14731 @node Mail Back End Variables
14732 @subsection Mail Back End Variables
14734 These variables are (for the most part) pertinent to all the various
14738 @vindex nnmail-read-incoming-hook
14739 @item nnmail-read-incoming-hook
14740 The mail back ends all call this hook after reading new mail. You can
14741 use this hook to notify any mail watch programs, if you want to.
14743 @vindex nnmail-split-hook
14744 @item nnmail-split-hook
14745 @findex gnus-article-decode-encoded-words
14746 @cindex RFC 1522 decoding
14747 @cindex RFC 2047 decoding
14748 Hook run in the buffer where the mail headers of each message is kept
14749 just before the splitting based on these headers is done. The hook is
14750 free to modify the buffer contents in any way it sees fit---the buffer
14751 is discarded after the splitting has been done, and no changes performed
14752 in the buffer will show up in any files.
14753 @code{gnus-article-decode-encoded-words} is one likely function to add
14756 @vindex nnmail-pre-get-new-mail-hook
14757 @vindex nnmail-post-get-new-mail-hook
14758 @item nnmail-pre-get-new-mail-hook
14759 @itemx nnmail-post-get-new-mail-hook
14760 These are two useful hooks executed when treating new incoming
14761 mail---@code{nnmail-pre-get-new-mail-hook} (is called just before
14762 starting to handle the new mail) and
14763 @code{nnmail-post-get-new-mail-hook} (is called when the mail handling
14764 is done). Here's and example of using these two hooks to change the
14765 default file modes the new mail files get:
14768 (add-hook 'nnmail-pre-get-new-mail-hook
14769 (lambda () (set-default-file-modes 511)))
14771 (add-hook 'nnmail-post-get-new-mail-hook
14772 (lambda () (set-default-file-modes 551)))
14775 @item nnmail-use-long-file-names
14776 @vindex nnmail-use-long-file-names
14777 If non-@code{nil}, the mail back ends will use long file and directory
14778 names. Groups like @samp{mail.misc} will end up in directories
14779 (assuming use of @code{nnml} back end) or files (assuming use of
14780 @code{nnfolder} back end) like @file{mail.misc}. If it is @code{nil},
14781 the same group will end up in @file{mail/misc}.
14783 @item nnmail-delete-file-function
14784 @vindex nnmail-delete-file-function
14785 @findex delete-file
14786 Function called to delete files. It is @code{delete-file} by default.
14788 @item nnmail-cache-accepted-message-ids
14789 @vindex nnmail-cache-accepted-message-ids
14790 If non-@code{nil}, put the @code{Message-ID}s of articles imported into
14791 the back end (via @code{Gcc}, for instance) into the mail duplication
14792 discovery cache. The default is @code{nil}.
14794 @item nnmail-cache-ignore-groups
14795 @vindex nnmail-cache-ignore-groups
14796 This can be a regular expression or a list of regular expressions.
14797 Group names that match any of the regular expressions will never be
14798 recorded in the @code{Message-ID} cache.
14800 This can be useful, for example, when using Fancy Splitting
14801 (@pxref{Fancy Mail Splitting}) together with the function
14802 @code{nnmail-split-fancy-with-parent}.
14807 @node Fancy Mail Splitting
14808 @subsection Fancy Mail Splitting
14809 @cindex mail splitting
14810 @cindex fancy mail splitting
14812 @vindex nnmail-split-fancy
14813 @findex nnmail-split-fancy
14814 If the rather simple, standard method for specifying how to split mail
14815 doesn't allow you to do what you want, you can set
14816 @code{nnmail-split-methods} to @code{nnmail-split-fancy}. Then you can
14817 play with the @code{nnmail-split-fancy} variable.
14819 Let's look at an example value of this variable first:
14822 ;; @r{Messages from the mailer daemon are not crossposted to any of}
14823 ;; @r{the ordinary groups. Warnings are put in a separate group}
14824 ;; @r{from real errors.}
14825 (| ("from" mail (| ("subject" "warn.*" "mail.warning")
14827 ;; @r{Non-error messages are crossposted to all relevant}
14828 ;; @r{groups, but we don't crosspost between the group for the}
14829 ;; @r{(ding) list and the group for other (ding) related mail.}
14830 (& (| (any "ding@@ifi\\.uio\\.no" "ding.list")
14831 ("subject" "ding" "ding.misc"))
14832 ;; @r{Other mailing lists@dots{}}
14833 (any "procmail@@informatik\\.rwth-aachen\\.de" "procmail.list")
14834 (any "SmartList@@informatik\\.rwth-aachen\\.de" "SmartList.list")
14835 ;; @r{Both lists below have the same suffix, so prevent}
14836 ;; @r{cross-posting to mkpkg.list of messages posted only to}
14837 ;; @r{the bugs- list, but allow cross-posting when the}
14838 ;; @r{message was really cross-posted.}
14839 (any "bugs-mypackage@@somewhere" "mypkg.bugs")
14840 (any "mypackage@@somewhere" - "bugs-mypackage" "mypkg.list")
14841 ;; @r{People@dots{}}
14842 (any "larsi@@ifi\\.uio\\.no" "people.Lars_Magne_Ingebrigtsen"))
14843 ;; @r{Unmatched mail goes to the catch all group.}
14847 This variable has the format of a @dfn{split}. A split is a
14848 (possibly) recursive structure where each split may contain other
14849 splits. Here are the possible split syntaxes:
14854 If the split is a string, that will be taken as a group name. Normal
14855 regexp match expansion will be done. See below for examples.
14857 @c Don't fold this line.
14858 @item (@var{field} @var{value} [- @var{restrict} [@dots{}] ] @var{split} [@var{invert-partial}])
14859 The split can be a list containing at least three elements. If the
14860 first element @var{field} (a regexp matching a header) contains
14861 @var{value} (also a regexp) then store the message as specified by
14864 If @var{restrict} (yet another regexp) matches some string after
14865 @var{field} and before the end of the matched @var{value}, the
14866 @var{split} is ignored. If none of the @var{restrict} clauses match,
14867 @var{split} is processed.
14869 The last element @var{invert-partial} is optional. If it is
14870 non-@code{nil}, the match-partial-words behavior controlled by the
14871 variable @code{nnmail-split-fancy-match-partial-words} (see below) is
14872 be inverted. (New in Gnus 5.10.7)
14874 @item (| @var{split} @dots{})
14875 If the split is a list, and the first element is @code{|} (vertical
14876 bar), then process each @var{split} until one of them matches. A
14877 @var{split} is said to match if it will cause the mail message to be
14878 stored in one or more groups.
14880 @item (& @var{split} @dots{})
14881 If the split is a list, and the first element is @code{&}, then
14882 process all @var{split}s in the list.
14885 If the split is the symbol @code{junk}, then don't save (i.e., delete)
14886 this message. Use with extreme caution.
14888 @item (: @var{function} @var{arg1} @var{arg2} @dots{})
14889 If the split is a list, and the first element is @samp{:}, then the
14890 second element will be called as a function with @var{args} given as
14891 arguments. The function should return a @var{split}.
14894 For instance, the following function could be used to split based on the
14895 body of the messages:
14898 (defun split-on-body ()
14902 (goto-char (point-min))
14903 (when (re-search-forward "Some.*string" nil t)
14907 The buffer is narrowed to the header of the message in question when
14908 @var{function} is run. That's why @code{(widen)} needs to be called
14909 after @code{save-excursion} and @code{save-restriction} in the example
14910 above. Also note that with the nnimap backend, message bodies will
14911 not be downloaded by default. You need to set
14912 @code{nnimap-split-download-body} to @code{t} to do that
14913 (@pxref{Splitting in IMAP}).
14915 @item (! @var{func} @var{split})
14916 If the split is a list, and the first element is @code{!}, then
14917 @var{split} will be processed, and @var{func} will be called as a
14918 function with the result of @var{split} as argument. @var{func}
14919 should return a split.
14922 If the split is @code{nil}, it is ignored.
14926 In these splits, @var{field} must match a complete field name.
14928 Normally, @var{value} in these splits must match a complete @emph{word}
14929 according to the fundamental mode syntax table. In other words, all
14930 @var{value}'s will be implicitly surrounded by @code{\<...\>} markers,
14931 which are word delimiters. Therefore, if you use the following split,
14935 (any "joe" "joemail")
14939 messages sent from @samp{joedavis@@foo.org} will normally not be filed
14940 in @samp{joemail}. If you want to alter this behavior, you can use any
14941 of the following three ways:
14945 @vindex nnmail-split-fancy-match-partial-words
14946 You can set the @code{nnmail-split-fancy-match-partial-words} variable
14947 to non-@code{nil} in order to ignore word boundaries and instead the
14948 match becomes more like a grep. This variable controls whether partial
14949 words are matched during fancy splitting. The default value is
14952 Note that it influences all @var{value}'s in your split rules.
14955 @var{value} beginning with @code{.*} ignores word boundaries in front of
14956 a word. Similarly, if @var{value} ends with @code{.*}, word boundaries
14957 in the rear of a word will be ignored. For example, the @var{value}
14958 @code{"@@example\\.com"} does not match @samp{foo@@example.com} but
14959 @code{".*@@example\\.com"} does.
14962 You can set the @var{invert-partial} flag in your split rules of the
14963 @samp{(@var{field} @var{value} @dots{})} types, aforementioned in this
14964 section. If the flag is set, word boundaries on both sides of a word
14965 are ignored even if @code{nnmail-split-fancy-match-partial-words} is
14966 @code{nil}. Contrarily, if the flag is set, word boundaries are not
14967 ignored even if @code{nnmail-split-fancy-match-partial-words} is
14968 non-@code{nil}. (New in Gnus 5.10.7)
14971 @vindex nnmail-split-abbrev-alist
14972 @var{field} and @var{value} can also be Lisp symbols, in that case
14973 they are expanded as specified by the variable
14974 @code{nnmail-split-abbrev-alist}. This is an alist of cons cells,
14975 where the @sc{car} of a cell contains the key, and the @sc{cdr}
14976 contains the associated value. Predefined entries in
14977 @code{nnmail-split-abbrev-alist} include:
14981 Matches the @samp{From}, @samp{Sender} and @samp{Resent-From} fields.
14983 Matches the @samp{To}, @samp{Cc}, @samp{Apparently-To},
14984 @samp{Resent-To} and @samp{Resent-Cc} fields.
14986 Is the union of the @code{from} and @code{to} entries.
14989 @vindex nnmail-split-fancy-syntax-table
14990 @code{nnmail-split-fancy-syntax-table} is the syntax table in effect
14991 when all this splitting is performed.
14993 If you want to have Gnus create groups dynamically based on some
14994 information in the headers (i.e., do @code{replace-match}-like
14995 substitutions in the group names), you can say things like:
14998 (any "debian-\\b\\(\\w+\\)@@lists.debian.org" "mail.debian.\\1")
15001 In this example, messages sent to @samp{debian-foo@@lists.debian.org}
15002 will be filed in @samp{mail.debian.foo}.
15004 If the string contains the element @samp{\&}, then the previously
15005 matched string will be substituted. Similarly, the elements @samp{\\1}
15006 up to @samp{\\9} will be substituted with the text matched by the
15007 groupings 1 through 9.
15009 @vindex nnmail-split-lowercase-expanded
15010 Where @code{nnmail-split-lowercase-expanded} controls whether the
15011 lowercase of the matched string should be used for the substitution.
15012 Setting it as non-@code{nil} is useful to avoid the creation of multiple
15013 groups when users send to an address using different case
15014 (i.e. mailing-list@@domain vs Mailing-List@@Domain). The default value
15017 @findex nnmail-split-fancy-with-parent
15018 @code{nnmail-split-fancy-with-parent} is a function which allows you to
15019 split followups into the same groups their parents are in. Sometimes
15020 you can't make splitting rules for all your mail. For example, your
15021 boss might send you personal mail regarding different projects you are
15022 working on, and as you can't tell your boss to put a distinguishing
15023 string into the subject line, you have to resort to manually moving the
15024 messages into the right group. With this function, you only have to do
15025 it once per thread.
15027 To use this feature, you have to set @code{nnmail-treat-duplicates}
15028 and @code{nnmail-cache-accepted-message-ids} to a non-@code{nil}
15029 value. And then you can include @code{nnmail-split-fancy-with-parent}
15030 using the colon feature, like so:
15032 (setq nnmail-treat-duplicates 'warn ; @r{or @code{delete}}
15033 nnmail-cache-accepted-message-ids t
15035 '(| (: nnmail-split-fancy-with-parent)
15036 ;; @r{other splits go here}
15040 This feature works as follows: when @code{nnmail-treat-duplicates} is
15041 non-@code{nil}, Gnus records the message id of every message it sees
15042 in the file specified by the variable
15043 @code{nnmail-message-id-cache-file}, together with the group it is in
15044 (the group is omitted for non-mail messages). When mail splitting is
15045 invoked, the function @code{nnmail-split-fancy-with-parent} then looks
15046 at the References (and In-Reply-To) header of each message to split
15047 and searches the file specified by @code{nnmail-message-id-cache-file}
15048 for the message ids. When it has found a parent, it returns the
15049 corresponding group name unless the group name matches the regexp
15050 @code{nnmail-split-fancy-with-parent-ignore-groups}. It is
15051 recommended that you set @code{nnmail-message-id-cache-length} to a
15052 somewhat higher number than the default so that the message ids are
15053 still in the cache. (A value of 5000 appears to create a file some
15054 300 kBytes in size.)
15055 @vindex nnmail-cache-accepted-message-ids
15056 When @code{nnmail-cache-accepted-message-ids} is non-@code{nil}, Gnus
15057 also records the message ids of moved articles, so that the followup
15058 messages goes into the new group.
15060 Also see the variable @code{nnmail-cache-ignore-groups} if you don't
15061 want certain groups to be recorded in the cache. For example, if all
15062 outgoing messages are written to an ``outgoing'' group, you could set
15063 @code{nnmail-cache-ignore-groups} to match that group name.
15064 Otherwise, answers to all your messages would end up in the
15065 ``outgoing'' group.
15068 @node Group Mail Splitting
15069 @subsection Group Mail Splitting
15070 @cindex mail splitting
15071 @cindex group mail splitting
15073 @findex gnus-group-split
15074 If you subscribe to dozens of mailing lists but you don't want to
15075 maintain mail splitting rules manually, group mail splitting is for you.
15076 You just have to set @code{to-list} and/or @code{to-address} in group
15077 parameters or group customization and set @code{nnmail-split-methods} to
15078 @code{gnus-group-split}. This splitting function will scan all groups
15079 for those parameters and split mail accordingly, i.e., messages posted
15080 from or to the addresses specified in the parameters @code{to-list} or
15081 @code{to-address} of a mail group will be stored in that group.
15083 Sometimes, mailing lists have multiple addresses, and you may want mail
15084 splitting to recognize them all: just set the @code{extra-aliases} group
15085 parameter to the list of additional addresses and it's done. If you'd
15086 rather use a regular expression, set @code{split-regexp}.
15088 All these parameters in a group will be used to create an
15089 @code{nnmail-split-fancy} split, in which the @var{field} is @samp{any},
15090 the @var{value} is a single regular expression that matches
15091 @code{to-list}, @code{to-address}, all of @code{extra-aliases} and all
15092 matches of @code{split-regexp}, and the @var{split} is the name of the
15093 group. @var{restrict}s are also supported: just set the
15094 @code{split-exclude} parameter to a list of regular expressions.
15096 If you can't get the right split to be generated using all these
15097 parameters, or you just need something fancier, you can set the
15098 parameter @code{split-spec} to an @code{nnmail-split-fancy} split. In
15099 this case, all other aforementioned parameters will be ignored by
15100 @code{gnus-group-split}. In particular, @code{split-spec} may be set to
15101 @code{nil}, in which case the group will be ignored by
15102 @code{gnus-group-split}.
15104 @vindex gnus-group-split-default-catch-all-group
15105 @code{gnus-group-split} will do cross-posting on all groups that match,
15106 by defining a single @code{&} fancy split containing one split for each
15107 group. If a message doesn't match any split, it will be stored in the
15108 group named in @code{gnus-group-split-default-catch-all-group}, unless
15109 some group has @code{split-spec} set to @code{catch-all}, in which case
15110 that group is used as the catch-all group. Even though this variable is
15111 often used just to name a group, it may also be set to an arbitrarily
15112 complex fancy split (after all, a group name is a fancy split), and this
15113 may be useful to split mail that doesn't go to any mailing list to
15114 personal mail folders. Note that this fancy split is added as the last
15115 element of a @code{|} split list that also contains a @code{&} split
15116 with the rules extracted from group parameters.
15118 It's time for an example. Assume the following group parameters have
15123 ((to-address . "bar@@femail.com")
15124 (split-regexp . ".*@@femail\\.com"))
15126 ((to-list . "foo@@nowhere.gov")
15127 (extra-aliases "foo@@localhost" "foo-redist@@home")
15128 (split-exclude "bugs-foo" "rambling-foo")
15129 (admin-address . "foo-request@@nowhere.gov"))
15131 ((split-spec . catch-all))
15134 Setting @code{nnmail-split-methods} to @code{gnus-group-split} will
15135 behave as if @code{nnmail-split-fancy} had been selected and variable
15136 @code{nnmail-split-fancy} had been set as follows:
15139 (| (& (any "\\(bar@@femail\\.com\\|.*@@femail\\.com\\)" "mail.bar")
15140 (any "\\(foo@@nowhere\\.gov\\|foo@@localhost\\|foo-redist@@home\\)"
15141 - "bugs-foo" - "rambling-foo" "mail.foo"))
15145 @findex gnus-group-split-fancy
15146 If you'd rather not use group splitting for all your mail groups, you
15147 may use it for only some of them, by using @code{nnmail-split-fancy}
15151 (: gnus-group-split-fancy @var{groups} @var{no-crosspost} @var{catch-all})
15154 @var{groups} may be a regular expression or a list of group names whose
15155 parameters will be scanned to generate the output split.
15156 @var{no-crosspost} can be used to disable cross-posting; in this case, a
15157 single @code{|} split will be output. @var{catch-all} is the fall back
15158 fancy split, used like @code{gnus-group-split-default-catch-all-group}.
15159 If @var{catch-all} is @code{nil}, or if @code{split-regexp} matches the
15160 empty string in any selected group, no catch-all split will be issued.
15161 Otherwise, if some group has @code{split-spec} set to @code{catch-all},
15162 this group will override the value of the @var{catch-all} argument.
15164 @findex gnus-group-split-setup
15165 Unfortunately, scanning all groups and their parameters can be quite
15166 slow, especially considering that it has to be done for every message.
15167 But don't despair! The function @code{gnus-group-split-setup} can be
15168 used to enable @code{gnus-group-split} in a much more efficient way. It
15169 sets @code{nnmail-split-methods} to @code{nnmail-split-fancy} and sets
15170 @code{nnmail-split-fancy} to the split produced by
15171 @code{gnus-group-split-fancy}. Thus, the group parameters are only
15172 scanned once, no matter how many messages are split.
15174 @findex gnus-group-split-update
15175 However, if you change group parameters, you'd have to update
15176 @code{nnmail-split-fancy} manually. You can do it by running
15177 @code{gnus-group-split-update}. If you'd rather have it updated
15178 automatically, just tell @code{gnus-group-split-setup} to do it for
15179 you. For example, add to your @file{~/.gnus.el}:
15182 (gnus-group-split-setup @var{auto-update} @var{catch-all})
15185 If @var{auto-update} is non-@code{nil}, @code{gnus-group-split-update}
15186 will be added to @code{nnmail-pre-get-new-mail-hook}, so you won't ever
15187 have to worry about updating @code{nnmail-split-fancy} again. If you
15188 don't omit @var{catch-all} (it's optional, equivalent to @code{nil}),
15189 @code{gnus-group-split-default-catch-all-group} will be set to its
15192 @vindex gnus-group-split-updated-hook
15193 Because you may want to change @code{nnmail-split-fancy} after it is set
15194 by @code{gnus-group-split-update}, this function will run
15195 @code{gnus-group-split-updated-hook} just before finishing.
15197 @node Incorporating Old Mail
15198 @subsection Incorporating Old Mail
15199 @cindex incorporating old mail
15200 @cindex import old mail
15202 Most people have lots of old mail stored in various file formats. If
15203 you have set up Gnus to read mail using one of the spiffy Gnus mail
15204 back ends, you'll probably wish to have that old mail incorporated into
15207 Doing so can be quite easy.
15209 To take an example: You're reading mail using @code{nnml}
15210 (@pxref{Mail Spool}), and have set @code{nnmail-split-methods} to a
15211 satisfactory value (@pxref{Splitting Mail}). You have an old Unix mbox
15212 file filled with important, but old, mail. You want to move it into
15213 your @code{nnml} groups.
15219 Go to the group buffer.
15222 Type @kbd{G f} and give the file name to the mbox file when prompted to create an
15223 @code{nndoc} group from the mbox file (@pxref{Foreign Groups}).
15226 Type @kbd{SPACE} to enter the newly created group.
15229 Type @kbd{M P b} to process-mark all articles in this group's buffer
15230 (@pxref{Setting Process Marks}).
15233 Type @kbd{B r} to respool all the process-marked articles, and answer
15234 @samp{nnml} when prompted (@pxref{Mail Group Commands}).
15237 All the mail messages in the mbox file will now also be spread out over
15238 all your @code{nnml} groups. Try entering them and check whether things
15239 have gone without a glitch. If things look ok, you may consider
15240 deleting the mbox file, but I wouldn't do that unless I was absolutely
15241 sure that all the mail has ended up where it should be.
15243 Respooling is also a handy thing to do if you're switching from one mail
15244 back end to another. Just respool all the mail in the old mail groups
15245 using the new mail back end.
15248 @node Expiring Mail
15249 @subsection Expiring Mail
15250 @cindex article expiry
15251 @cindex expiring mail
15253 Traditional mail readers have a tendency to remove mail articles when
15254 you mark them as read, in some way. Gnus takes a fundamentally
15255 different approach to mail reading.
15257 Gnus basically considers mail just to be news that has been received in
15258 a rather peculiar manner. It does not think that it has the power to
15259 actually change the mail, or delete any mail messages. If you enter a
15260 mail group, and mark articles as ``read'', or kill them in some other
15261 fashion, the mail articles will still exist on the system. I repeat:
15262 Gnus will not delete your old, read mail. Unless you ask it to, of
15265 To make Gnus get rid of your unwanted mail, you have to mark the
15266 articles as @dfn{expirable}. (With the default key bindings, this means
15267 that you have to type @kbd{E}.) This does not mean that the articles
15268 will disappear right away, however. In general, a mail article will be
15269 deleted from your system if, 1) it is marked as expirable, AND 2) it is
15270 more than one week old. If you do not mark an article as expirable, it
15271 will remain on your system until hell freezes over. This bears
15272 repeating one more time, with some spurious capitalizations: IF you do
15273 NOT mark articles as EXPIRABLE, Gnus will NEVER delete those ARTICLES.
15275 You do not have to mark articles as expirable by hand. Gnus provides
15276 two features, called ``auto-expire'' and ``total-expire'', that can help you
15277 with this. In a nutshell, ``auto-expire'' means that Gnus hits @kbd{E}
15278 for you when you select an article. And ``total-expire'' means that Gnus
15279 considers all articles as expirable that are read. So, in addition to
15280 the articles marked @samp{E}, also the articles marked @samp{r},
15281 @samp{R}, @samp{O}, @samp{K}, @samp{Y} and so on are considered
15284 When should either auto-expire or total-expire be used? Most people
15285 who are subscribed to mailing lists split each list into its own group
15286 and then turn on auto-expire or total-expire for those groups.
15287 (@xref{Splitting Mail}, for more information on splitting each list
15288 into its own group.)
15290 Which one is better, auto-expire or total-expire? It's not easy to
15291 answer. Generally speaking, auto-expire is probably faster. Another
15292 advantage of auto-expire is that you get more marks to work with: for
15293 the articles that are supposed to stick around, you can still choose
15294 between tick and dormant and read marks. But with total-expire, you
15295 only have dormant and ticked to choose from. The advantage of
15296 total-expire is that it works well with adaptive scoring (@pxref{Adaptive
15297 Scoring}). Auto-expire works with normal scoring but not with adaptive
15300 @vindex gnus-auto-expirable-newsgroups
15301 Groups that match the regular expression
15302 @code{gnus-auto-expirable-newsgroups} will have all articles that you
15303 read marked as expirable automatically. All articles marked as
15304 expirable have an @samp{E} in the first column in the summary buffer.
15306 By default, if you have auto expiry switched on, Gnus will mark all the
15307 articles you read as expirable, no matter if they were read or unread
15308 before. To avoid having articles marked as read marked as expirable
15309 automatically, you can put something like the following in your
15310 @file{~/.gnus.el} file:
15312 @vindex gnus-mark-article-hook
15314 (remove-hook 'gnus-mark-article-hook
15315 'gnus-summary-mark-read-and-unread-as-read)
15316 (add-hook 'gnus-mark-article-hook 'gnus-summary-mark-unread-as-read)
15319 Note that making a group auto-expirable doesn't mean that all read
15320 articles are expired---only the articles marked as expirable
15321 will be expired. Also note that using the @kbd{d} command won't make
15322 articles expirable---only semi-automatic marking of articles as read will
15323 mark the articles as expirable in auto-expirable groups.
15325 Let's say you subscribe to a couple of mailing lists, and you want the
15326 articles you have read to disappear after a while:
15329 (setq gnus-auto-expirable-newsgroups
15330 "mail.nonsense-list\\|mail.nice-list")
15333 Another way to have auto-expiry happen is to have the element
15334 @code{auto-expire} in the group parameters of the group.
15336 If you use adaptive scoring (@pxref{Adaptive Scoring}) and
15337 auto-expiring, you'll have problems. Auto-expiring and adaptive scoring
15338 don't really mix very well.
15340 @vindex nnmail-expiry-wait
15341 The @code{nnmail-expiry-wait} variable supplies the default time an
15342 expirable article has to live. Gnus starts counting days from when the
15343 message @emph{arrived}, not from when it was sent. The default is seven
15346 Gnus also supplies a function that lets you fine-tune how long articles
15347 are to live, based on what group they are in. Let's say you want to
15348 have one month expiry period in the @samp{mail.private} group, a one day
15349 expiry period in the @samp{mail.junk} group, and a six day expiry period
15352 @vindex nnmail-expiry-wait-function
15354 (setq nnmail-expiry-wait-function
15356 (cond ((string= group "mail.private")
15358 ((string= group "mail.junk")
15360 ((string= group "important")
15366 The group names this function is fed are ``unadorned'' group
15367 names---no @samp{nnml:} prefixes and the like.
15369 The @code{nnmail-expiry-wait} variable and
15370 @code{nnmail-expiry-wait-function} function can either be a number (not
15371 necessarily an integer) or one of the symbols @code{immediate} or
15374 You can also use the @code{expiry-wait} group parameter to selectively
15375 change the expiry period (@pxref{Group Parameters}).
15377 @vindex nnmail-expiry-target
15378 The normal action taken when expiring articles is to delete them.
15379 However, in some circumstances it might make more sense to move them
15380 to other groups instead of deleting them. The variable
15381 @code{nnmail-expiry-target} (and the @code{expiry-target} group
15382 parameter) controls this. The variable supplies a default value for
15383 all groups, which can be overridden for specific groups by the group
15384 parameter. default value is @code{delete}, but this can also be a
15385 string (which should be the name of the group the message should be
15386 moved to), or a function (which will be called in a buffer narrowed to
15387 the message in question, and with the name of the group being moved
15388 from as its parameter) which should return a target---either a group
15389 name or @code{delete}.
15391 Here's an example for specifying a group name:
15393 (setq nnmail-expiry-target "nnml:expired")
15396 @findex nnmail-fancy-expiry-target
15397 @vindex nnmail-fancy-expiry-targets
15398 Gnus provides a function @code{nnmail-fancy-expiry-target} which will
15399 expire mail to groups according to the variable
15400 @code{nnmail-fancy-expiry-targets}. Here's an example:
15403 (setq nnmail-expiry-target 'nnmail-fancy-expiry-target
15404 nnmail-fancy-expiry-targets
15405 '((to-from "boss" "nnfolder:Work")
15406 ("subject" "IMPORTANT" "nnfolder:IMPORTANT.%Y.%b")
15407 ("from" ".*" "nnfolder:Archive-%Y")))
15410 With this setup, any mail that has @code{IMPORTANT} in its Subject
15411 header and was sent in the year @code{YYYY} and month @code{MMM}, will
15412 get expired to the group @code{nnfolder:IMPORTANT.YYYY.MMM}. If its
15413 From or To header contains the string @code{boss}, it will get expired
15414 to @code{nnfolder:Work}. All other mail will get expired to
15415 @code{nnfolder:Archive-YYYY}.
15417 @vindex nnmail-keep-last-article
15418 If @code{nnmail-keep-last-article} is non-@code{nil}, Gnus will never
15419 expire the final article in a mail newsgroup. This is to make life
15420 easier for procmail users.
15422 @vindex gnus-total-expirable-newsgroups
15423 By the way: That line up there, about Gnus never expiring non-expirable
15424 articles, is a lie. If you put @code{total-expire} in the group
15425 parameters, articles will not be marked as expirable, but all read
15426 articles will be put through the expiry process. Use with extreme
15427 caution. Even more dangerous is the
15428 @code{gnus-total-expirable-newsgroups} variable. All groups that match
15429 this regexp will have all read articles put through the expiry process,
15430 which means that @emph{all} old mail articles in the groups in question
15431 will be deleted after a while. Use with extreme caution, and don't come
15432 crying to me when you discover that the regexp you used matched the
15433 wrong group and all your important mail has disappeared. Be a
15434 @emph{man}! Or a @emph{woman}! Whatever you feel more comfortable
15437 Most people make most of their mail groups total-expirable, though.
15439 @vindex gnus-inhibit-user-auto-expire
15440 If @code{gnus-inhibit-user-auto-expire} is non-@code{nil}, user marking
15441 commands will not mark an article as expirable, even if the group has
15442 auto-expire turned on.
15446 @subsection Washing Mail
15447 @cindex mail washing
15448 @cindex list server brain damage
15449 @cindex incoming mail treatment
15451 Mailers and list servers are notorious for doing all sorts of really,
15452 really stupid things with mail. ``Hey, RFC 822 doesn't explicitly
15453 prohibit us from adding the string @code{wE aRe ElItE!!!!!1!!} to the
15454 end of all lines passing through our server, so let's do that!!!!1!''
15455 Yes, but RFC 822 wasn't designed to be read by morons. Things that were
15456 considered to be self-evident were not discussed. So. Here we are.
15458 Case in point: The German version of Microsoft Exchange adds @samp{AW:
15459 } to the subjects of replies instead of @samp{Re: }. I could pretend to
15460 be shocked and dismayed by this, but I haven't got the energy. It is to
15463 Gnus provides a plethora of functions for washing articles while
15464 displaying them, but it might be nicer to do the filtering before
15465 storing the mail to disk. For that purpose, we have three hooks and
15466 various functions that can be put in these hooks.
15469 @item nnmail-prepare-incoming-hook
15470 @vindex nnmail-prepare-incoming-hook
15471 This hook is called before doing anything with the mail and is meant for
15472 grand, sweeping gestures. It is called in a buffer that contains all
15473 the new, incoming mail. Functions to be used include:
15476 @item nnheader-ms-strip-cr
15477 @findex nnheader-ms-strip-cr
15478 Remove trailing carriage returns from each line. This is default on
15479 Emacs running on MS machines.
15483 @item nnmail-prepare-incoming-header-hook
15484 @vindex nnmail-prepare-incoming-header-hook
15485 This hook is called narrowed to each header. It can be used when
15486 cleaning up the headers. Functions that can be used include:
15489 @item nnmail-remove-leading-whitespace
15490 @findex nnmail-remove-leading-whitespace
15491 Clear leading white space that ``helpful'' listservs have added to the
15492 headers to make them look nice. Aaah.
15494 (Note that this function works on both the header on the body of all
15495 messages, so it is a potentially dangerous function to use (if a body
15496 of a message contains something that looks like a header line). So
15497 rather than fix the bug, it is of course the right solution to make it
15498 into a feature by documenting it.)
15500 @item nnmail-remove-list-identifiers
15501 @findex nnmail-remove-list-identifiers
15502 Some list servers add an identifier---for example, @samp{(idm)}---to the
15503 beginning of all @code{Subject} headers. I'm sure that's nice for
15504 people who use stone age mail readers. This function will remove
15505 strings that match the @code{nnmail-list-identifiers} regexp, which can
15506 also be a list of regexp. @code{nnmail-list-identifiers} may not contain
15509 For instance, if you want to remove the @samp{(idm)} and the
15510 @samp{nagnagnag} identifiers:
15513 (setq nnmail-list-identifiers
15514 '("(idm)" "nagnagnag"))
15517 This can also be done non-destructively with
15518 @code{gnus-list-identifiers}, @xref{Article Hiding}.
15520 @item nnmail-remove-tabs
15521 @findex nnmail-remove-tabs
15522 Translate all @samp{TAB} characters into @samp{SPACE} characters.
15524 @item nnmail-ignore-broken-references
15525 @findex nnmail-ignore-broken-references
15526 @c @findex nnmail-fix-eudora-headers
15529 Some mail user agents (e.g. Eudora and Pegasus) produce broken
15530 @code{References} headers, but correct @code{In-Reply-To} headers. This
15531 function will get rid of the @code{References} header if the headers
15532 contain a line matching the regular expression
15533 @code{nnmail-broken-references-mailers}.
15537 @item nnmail-prepare-incoming-message-hook
15538 @vindex nnmail-prepare-incoming-message-hook
15539 This hook is called narrowed to each message. Functions to be used
15543 @item article-de-quoted-unreadable
15544 @findex article-de-quoted-unreadable
15545 Decode Quoted Readable encoding.
15552 @subsection Duplicates
15554 @vindex nnmail-treat-duplicates
15555 @vindex nnmail-message-id-cache-length
15556 @vindex nnmail-message-id-cache-file
15557 @cindex duplicate mails
15558 If you are a member of a couple of mailing lists, you will sometimes
15559 receive two copies of the same mail. This can be quite annoying, so
15560 @code{nnmail} checks for and treats any duplicates it might find. To do
15561 this, it keeps a cache of old @code{Message-ID}s---
15562 @code{nnmail-message-id-cache-file}, which is @file{~/.nnmail-cache} by
15563 default. The approximate maximum number of @code{Message-ID}s stored
15564 there is controlled by the @code{nnmail-message-id-cache-length}
15565 variable, which is 1000 by default. (So 1000 @code{Message-ID}s will be
15566 stored.) If all this sounds scary to you, you can set
15567 @code{nnmail-treat-duplicates} to @code{warn} (which is what it is by
15568 default), and @code{nnmail} won't delete duplicate mails. Instead it
15569 will insert a warning into the head of the mail saying that it thinks
15570 that this is a duplicate of a different message.
15572 This variable can also be a function. If that's the case, the function
15573 will be called from a buffer narrowed to the message in question with
15574 the @code{Message-ID} as a parameter. The function must return either
15575 @code{nil}, @code{warn}, or @code{delete}.
15577 You can turn this feature off completely by setting the variable to
15580 If you want all the duplicate mails to be put into a special
15581 @dfn{duplicates} group, you could do that using the normal mail split
15585 (setq nnmail-split-fancy
15586 '(| ;; @r{Messages duplicates go to a separate group.}
15587 ("gnus-warning" "duplicat\\(e\\|ion\\) of message" "duplicate")
15588 ;; @r{Message from daemons, postmaster, and the like to another.}
15589 (any mail "mail.misc")
15590 ;; @r{Other rules.}
15596 (setq nnmail-split-methods
15597 '(("duplicates" "^Gnus-Warning:.*duplicate")
15598 ;; @r{Other rules.}
15602 Here's a neat feature: If you know that the recipient reads her mail
15603 with Gnus, and that she has @code{nnmail-treat-duplicates} set to
15604 @code{delete}, you can send her as many insults as you like, just by
15605 using a @code{Message-ID} of a mail that you know that she's already
15606 received. Think of all the fun! She'll never see any of it! Whee!
15609 @node Not Reading Mail
15610 @subsection Not Reading Mail
15612 If you start using any of the mail back ends, they have the annoying
15613 habit of assuming that you want to read mail with them. This might not
15614 be unreasonable, but it might not be what you want.
15616 If you set @code{mail-sources} and @code{nnmail-spool-file} to
15617 @code{nil}, none of the back ends will ever attempt to read incoming
15618 mail, which should help.
15620 @vindex nnbabyl-get-new-mail
15621 @vindex nnmbox-get-new-mail
15622 @vindex nnml-get-new-mail
15623 @vindex nnmh-get-new-mail
15624 @vindex nnfolder-get-new-mail
15625 This might be too much, if, for instance, you are reading mail quite
15626 happily with @code{nnml} and just want to peek at some old Rmail
15627 file you have stashed away with @code{nnbabyl}. All back ends have
15628 variables called back-end-@code{get-new-mail}. If you want to disable
15629 the @code{nnbabyl} mail reading, you edit the virtual server for the
15630 group to have a setting where @code{nnbabyl-get-new-mail} to @code{nil}.
15632 All the mail back ends will call @code{nn}*@code{-prepare-save-mail-hook}
15633 narrowed to the article to be saved before saving it when reading
15637 @node Choosing a Mail Back End
15638 @subsection Choosing a Mail Back End
15640 Gnus will read the mail spool when you activate a mail group. The mail
15641 file is first copied to your home directory. What happens after that
15642 depends on what format you want to store your mail in.
15644 There are six different mail back ends in the standard Gnus, and more
15645 back ends are available separately. The mail back end most people use
15646 (because it is possibly the fastest) is @code{nnml} (@pxref{Mail
15650 * Unix Mail Box:: Using the (quite) standard Un*x mbox.
15651 * Rmail Babyl:: Emacs programs use the Rmail Babyl format.
15652 * Mail Spool:: Store your mail in a private spool?
15653 * MH Spool:: An mhspool-like back end.
15654 * Maildir:: Another one-file-per-message format.
15655 * Mail Folders:: Having one file for each group.
15656 * Comparing Mail Back Ends:: An in-depth looks at pros and cons.
15660 @node Unix Mail Box
15661 @subsubsection Unix Mail Box
15663 @cindex unix mail box
15665 @vindex nnmbox-active-file
15666 @vindex nnmbox-mbox-file
15667 The @dfn{nnmbox} back end will use the standard Un*x mbox file to store
15668 mail. @code{nnmbox} will add extra headers to each mail article to say
15669 which group it belongs in.
15671 Virtual server settings:
15674 @item nnmbox-mbox-file
15675 @vindex nnmbox-mbox-file
15676 The name of the mail box in the user's home directory. Default is
15679 @item nnmbox-active-file
15680 @vindex nnmbox-active-file
15681 The name of the active file for the mail box. Default is
15682 @file{~/.mbox-active}.
15684 @item nnmbox-get-new-mail
15685 @vindex nnmbox-get-new-mail
15686 If non-@code{nil}, @code{nnmbox} will read incoming mail and split it
15687 into groups. Default is @code{t}.
15692 @subsubsection Rmail Babyl
15696 @vindex nnbabyl-active-file
15697 @vindex nnbabyl-mbox-file
15698 The @dfn{nnbabyl} back end will use a Babyl mail box (aka. @dfn{Rmail
15699 mbox}) to store mail. @code{nnbabyl} will add extra headers to each
15700 mail article to say which group it belongs in.
15702 Virtual server settings:
15705 @item nnbabyl-mbox-file
15706 @vindex nnbabyl-mbox-file
15707 The name of the Rmail mbox file. The default is @file{~/RMAIL}
15709 @item nnbabyl-active-file
15710 @vindex nnbabyl-active-file
15711 The name of the active file for the rmail box. The default is
15712 @file{~/.rmail-active}
15714 @item nnbabyl-get-new-mail
15715 @vindex nnbabyl-get-new-mail
15716 If non-@code{nil}, @code{nnbabyl} will read incoming mail. Default is
15722 @subsubsection Mail Spool
15724 @cindex mail @acronym{NOV} spool
15726 The @dfn{nnml} spool mail format isn't compatible with any other known
15727 format. It should be used with some caution.
15729 @vindex nnml-directory
15730 If you use this back end, Gnus will split all incoming mail into files,
15731 one file for each mail, and put the articles into the corresponding
15732 directories under the directory specified by the @code{nnml-directory}
15733 variable. The default value is @file{~/Mail/}.
15735 You do not have to create any directories beforehand; Gnus will take
15738 If you have a strict limit as to how many files you are allowed to store
15739 in your account, you should not use this back end. As each mail gets its
15740 own file, you might very well occupy thousands of inodes within a few
15741 weeks. If this is no problem for you, and it isn't a problem for you
15742 having your friendly systems administrator walking around, madly,
15743 shouting ``Who is eating all my inodes?! Who? Who!?!'', then you should
15744 know that this is probably the fastest format to use. You do not have
15745 to trudge through a big mbox file just to read your new mail.
15747 @code{nnml} is probably the slowest back end when it comes to article
15748 splitting. It has to create lots of files, and it also generates
15749 @acronym{NOV} databases for the incoming mails. This makes it possibly the
15750 fastest back end when it comes to reading mail.
15752 @cindex self contained nnml servers
15754 When the marks file is used (which it is by default), @code{nnml}
15755 servers have the property that you may backup them using @code{tar} or
15756 similar, and later be able to restore them into Gnus (by adding the
15757 proper @code{nnml} server) and have all your marks be preserved. Marks
15758 for a group are usually stored in the @code{.marks} file (but see
15759 @code{nnml-marks-file-name}) within each @code{nnml} group's directory.
15760 Individual @code{nnml} groups are also possible to backup, use @kbd{G m}
15761 to restore the group (after restoring the backup into the nnml
15764 If for some reason you believe your @file{.marks} files are screwed
15765 up, you can just delete them all. Gnus will then correctly regenerate
15766 them next time it starts.
15768 Virtual server settings:
15771 @item nnml-directory
15772 @vindex nnml-directory
15773 All @code{nnml} directories will be placed under this directory. The
15774 default is the value of @code{message-directory} (whose default value
15777 @item nnml-active-file
15778 @vindex nnml-active-file
15779 The active file for the @code{nnml} server. The default is
15780 @file{~/Mail/active}.
15782 @item nnml-newsgroups-file
15783 @vindex nnml-newsgroups-file
15784 The @code{nnml} group descriptions file. @xref{Newsgroups File
15785 Format}. The default is @file{~/Mail/newsgroups}.
15787 @item nnml-get-new-mail
15788 @vindex nnml-get-new-mail
15789 If non-@code{nil}, @code{nnml} will read incoming mail. The default is
15792 @item nnml-nov-is-evil
15793 @vindex nnml-nov-is-evil
15794 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
15795 default is @code{nil}.
15797 @item nnml-nov-file-name
15798 @vindex nnml-nov-file-name
15799 The name of the @acronym{NOV} files. The default is @file{.overview}.
15801 @item nnml-prepare-save-mail-hook
15802 @vindex nnml-prepare-save-mail-hook
15803 Hook run narrowed to an article before saving.
15805 @item nnml-marks-is-evil
15806 @vindex nnml-marks-is-evil
15807 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
15808 default is @code{nil}.
15810 @item nnml-marks-file-name
15811 @vindex nnml-marks-file-name
15812 The name of the @dfn{marks} files. The default is @file{.marks}.
15814 @item nnml-use-compressed-files
15815 @vindex nnml-use-compressed-files
15816 If non-@code{nil}, @code{nnml} will allow using compressed message
15817 files. This requires @code{auto-compression-mode} to be enabled
15818 (@pxref{Compressed Files, ,Compressed Files, emacs, The Emacs Manual}).
15819 If the value of @code{nnml-use-compressed-files} is a string, it is used
15820 as the file extension specifying the compression program. You can set it
15821 to @samp{.bz2} if your Emacs supports it. A value of @code{t} is
15822 equivalent to @samp{.gz}.
15824 @item nnml-compressed-files-size-threshold
15825 @vindex nnml-compressed-files-size-threshold
15826 Default size threshold for compressed message files. Message files with
15827 bodies larger than that many characters will be automatically compressed
15828 if @code{nnml-use-compressed-files} is non-@code{nil}.
15832 @findex nnml-generate-nov-databases
15833 If your @code{nnml} groups and @acronym{NOV} files get totally out of
15834 whack, you can do a complete update by typing @kbd{M-x
15835 nnml-generate-nov-databases}. This command will trawl through the
15836 entire @code{nnml} hierarchy, looking at each and every article, so it
15837 might take a while to complete. A better interface to this
15838 functionality can be found in the server buffer (@pxref{Server
15843 @subsubsection MH Spool
15845 @cindex mh-e mail spool
15847 @code{nnmh} is just like @code{nnml}, except that is doesn't generate
15848 @acronym{NOV} databases and it doesn't keep an active file or marks
15849 file. This makes @code{nnmh} a @emph{much} slower back end than
15850 @code{nnml}, but it also makes it easier to write procmail scripts
15853 Virtual server settings:
15856 @item nnmh-directory
15857 @vindex nnmh-directory
15858 All @code{nnmh} directories will be located under this directory. The
15859 default is the value of @code{message-directory} (whose default is
15862 @item nnmh-get-new-mail
15863 @vindex nnmh-get-new-mail
15864 If non-@code{nil}, @code{nnmh} will read incoming mail. The default is
15868 @vindex nnmh-be-safe
15869 If non-@code{nil}, @code{nnmh} will go to ridiculous lengths to make
15870 sure that the articles in the folder are actually what Gnus thinks
15871 they are. It will check date stamps and stat everything in sight, so
15872 setting this to @code{t} will mean a serious slow-down. If you never
15873 use anything but Gnus to read the @code{nnmh} articles, you do not
15874 have to set this variable to @code{t}. The default is @code{nil}.
15879 @subsubsection Maildir
15883 @code{nnmaildir} stores mail in the maildir format, with each maildir
15884 corresponding to a group in Gnus. This format is documented here:
15885 @uref{http://cr.yp.to/proto/maildir.html} and here:
15886 @uref{http://www.qmail.org/man/man5/maildir.html}. @code{nnmaildir}
15887 also stores extra information in the @file{.nnmaildir/} directory
15890 Maildir format was designed to allow concurrent deliveries and
15891 reading, without needing locks. With other back ends, you would have
15892 your mail delivered to a spool of some kind, and then you would
15893 configure Gnus to split mail from that spool into your groups. You
15894 can still do that with @code{nnmaildir}, but the more common
15895 configuration is to have your mail delivered directly to the maildirs
15896 that appear as group in Gnus.
15898 @code{nnmaildir} is designed to be perfectly reliable: @kbd{C-g} will
15899 never corrupt its data in memory, and @code{SIGKILL} will never
15900 corrupt its data in the filesystem.
15902 @code{nnmaildir} stores article marks and @acronym{NOV} data in each
15903 maildir. So you can copy a whole maildir from one Gnus setup to
15904 another, and you will keep your marks.
15906 Virtual server settings:
15910 For each of your @code{nnmaildir} servers (it's very unlikely that
15911 you'd need more than one), you need to create a directory and populate
15912 it with maildirs or symlinks to maildirs (and nothing else; do not
15913 choose a directory already used for other purposes). Each maildir
15914 will be represented in Gnus as a newsgroup on that server; the
15915 filename of the symlink will be the name of the group. Any filenames
15916 in the directory starting with @samp{.} are ignored. The directory is
15917 scanned when you first start Gnus, and each time you type @kbd{g} in
15918 the group buffer; if any maildirs have been removed or added,
15919 @code{nnmaildir} notices at these times.
15921 The value of the @code{directory} parameter should be a Lisp form
15922 which is processed by @code{eval} and @code{expand-file-name} to get
15923 the path of the directory for this server. The form is @code{eval}ed
15924 only when the server is opened; the resulting string is used until the
15925 server is closed. (If you don't know about forms and @code{eval},
15926 don't worry---a simple string will work.) This parameter is not
15927 optional; you must specify it. I don't recommend using
15928 @code{"~/Mail"} or a subdirectory of it; several other parts of Gnus
15929 use that directory by default for various things, and may get confused
15930 if @code{nnmaildir} uses it too. @code{"~/.nnmaildir"} is a typical
15933 @item target-prefix
15934 This should be a Lisp form which is processed by @code{eval} and
15935 @code{expand-file-name}. The form is @code{eval}ed only when the
15936 server is opened; the resulting string is used until the server is
15939 When you create a group on an @code{nnmaildir} server, the maildir is
15940 created with @code{target-prefix} prepended to its name, and a symlink
15941 pointing to that maildir is created, named with the plain group name.
15942 So if @code{directory} is @code{"~/.nnmaildir"} and
15943 @code{target-prefix} is @code{"../maildirs/"}, then when you create
15944 the group @code{foo}, @code{nnmaildir} will create
15945 @file{~/.nnmaildir/../maildirs/foo} as a maildir, and will create
15946 @file{~/.nnmaildir/foo} as a symlink pointing to
15947 @file{../maildirs/foo}.
15949 You can set @code{target-prefix} to a string without any slashes to
15950 create both maildirs and symlinks in the same @code{directory}; in
15951 this case, any maildirs found in @code{directory} whose names start
15952 with @code{target-prefix} will not be listed as groups (but the
15953 symlinks pointing to them will be).
15955 As a special case, if @code{target-prefix} is @code{""} (the default),
15956 then when you create a group, the maildir will be created in
15957 @code{directory} without a corresponding symlink. Beware that you
15958 cannot use @code{gnus-group-delete-group} on such groups without the
15959 @code{force} argument.
15961 @item directory-files
15962 This should be a function with the same interface as
15963 @code{directory-files} (such as @code{directory-files} itself). It is
15964 used to scan the server's @code{directory} for maildirs. This
15965 parameter is optional; the default is
15966 @code{nnheader-directory-files-safe} if
15967 @code{nnheader-directory-files-is-safe} is @code{nil}, and
15968 @code{directory-files} otherwise.
15969 (@code{nnheader-directory-files-is-safe} is checked only once when the
15970 server is opened; if you want to check it each time the directory is
15971 scanned, you'll have to provide your own function that does that.)
15974 If non-@code{nil}, then after scanning for new mail in the group
15975 maildirs themselves as usual, this server will also incorporate mail
15976 the conventional Gnus way, from @code{mail-sources} according to
15977 @code{nnmail-split-methods} or @code{nnmail-split-fancy}. The default
15978 value is @code{nil}.
15980 Do @emph{not} use the same maildir both in @code{mail-sources} and as
15981 an @code{nnmaildir} group. The results might happen to be useful, but
15982 that would be by chance, not by design, and the results might be
15983 different in the future. If your split rules create new groups,
15984 remember to supply a @code{create-directory} server parameter.
15987 @subsubsection Group parameters
15989 @code{nnmaildir} uses several group parameters. It's safe to ignore
15990 all this; the default behavior for @code{nnmaildir} is the same as the
15991 default behavior for other mail back ends: articles are deleted after
15992 one week, etc. Except for the expiry parameters, all this
15993 functionality is unique to @code{nnmaildir}, so you can ignore it if
15994 you're just trying to duplicate the behavior you already have with
15997 If the value of any of these parameters is a vector, the first element
15998 is evaluated as a Lisp form and the result is used, rather than the
15999 original value. If the value is not a vector, the value itself is
16000 evaluated as a Lisp form. (This is why these parameters use names
16001 different from those of other, similar parameters supported by other
16002 back ends: they have different, though similar, meanings.) (For
16003 numbers, strings, @code{nil}, and @code{t}, you can ignore the
16004 @code{eval} business again; for other values, remember to use an extra
16005 quote and wrap the value in a vector when appropriate.)
16009 An integer specifying the minimum age, in seconds, of an article
16010 before it will be expired, or the symbol @code{never} to specify that
16011 articles should never be expired. If this parameter is not set,
16012 @code{nnmaildir} falls back to the usual
16013 @code{nnmail-expiry-wait}(@code{-function}) variables (the
16014 @code{expiry-wait} group parameter overrides @code{nnmail-expiry-wait}
16015 and makes @code{nnmail-expiry-wait-function} ineffective). If you
16016 wanted a value of 3 days, you could use something like @code{[(* 3 24
16017 60 60)]}; @code{nnmaildir} will evaluate the form and use the result.
16018 An article's age is measured starting from the article file's
16019 modification time. Normally, this is the same as the article's
16020 delivery time, but editing an article makes it younger. Moving an
16021 article (other than via expiry) may also make an article younger.
16024 If this is set to a string such as a full Gnus group name, like
16026 "backend+server.address.string:group.name"
16028 and if it is not the name of the same group that the parameter belongs
16029 to, then articles will be moved to the specified group during expiry
16030 before being deleted. @emph{If this is set to an @code{nnmaildir}
16031 group, the article will be just as old in the destination group as it
16032 was in the source group.} So be careful with @code{expire-age} in the
16033 destination group. If this is set to the name of the same group that
16034 the parameter belongs to, then the article is not expired at all. If
16035 you use the vector form, the first element is evaluated once for each
16036 article. So that form can refer to
16037 @code{nnmaildir-article-file-name}, etc., to decide where to put the
16038 article. @emph{Even if this parameter is not set, @code{nnmaildir}
16039 does not fall back to the @code{expiry-target} group parameter or the
16040 @code{nnmail-expiry-target} variable.}
16043 If this is set to @code{t}, @code{nnmaildir} will treat the articles
16044 in this maildir as read-only. This means: articles are not renamed
16045 from @file{new/} into @file{cur/}; articles are only found in
16046 @file{new/}, not @file{cur/}; articles are never deleted; articles
16047 cannot be edited. @file{new/} is expected to be a symlink to the
16048 @file{new/} directory of another maildir---e.g., a system-wide mailbox
16049 containing a mailing list of common interest. Everything in the
16050 maildir outside @file{new/} is @emph{not} treated as read-only, so for
16051 a shared mailbox, you do still need to set up your own maildir (or
16052 have write permission to the shared mailbox); your maildir just won't
16053 contain extra copies of the articles.
16055 @item directory-files
16056 A function with the same interface as @code{directory-files}. It is
16057 used to scan the directories in the maildir corresponding to this
16058 group to find articles. The default is the function specified by the
16059 server's @code{directory-files} parameter.
16061 @item distrust-Lines:
16062 If non-@code{nil}, @code{nnmaildir} will always count the lines of an
16063 article, rather than use the @code{Lines:} header field. If
16064 @code{nil}, the header field will be used if present.
16067 A list of mark symbols, such as @code{['(read expire)]}. Whenever
16068 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
16069 say that all articles have these marks, regardless of whether the
16070 marks stored in the filesystem say so. This is a proof-of-concept
16071 feature that will probably be removed eventually; it ought to be done
16072 in Gnus proper, or abandoned if it's not worthwhile.
16075 A list of mark symbols, such as @code{['(tick expire)]}. Whenever
16076 Gnus asks @code{nnmaildir} for article marks, @code{nnmaildir} will
16077 say that no articles have these marks, regardless of whether the marks
16078 stored in the filesystem say so. @code{never-marks} overrides
16079 @code{always-marks}. This is a proof-of-concept feature that will
16080 probably be removed eventually; it ought to be done in Gnus proper, or
16081 abandoned if it's not worthwhile.
16083 @item nov-cache-size
16084 An integer specifying the size of the @acronym{NOV} memory cache. To
16085 speed things up, @code{nnmaildir} keeps @acronym{NOV} data in memory
16086 for a limited number of articles in each group. (This is probably not
16087 worthwhile, and will probably be removed in the future.) This
16088 parameter's value is noticed only the first time a group is seen after
16089 the server is opened---i.e., when you first start Gnus, typically.
16090 The @acronym{NOV} cache is never resized until the server is closed
16091 and reopened. The default is an estimate of the number of articles
16092 that would be displayed in the summary buffer: a count of articles
16093 that are either marked with @code{tick} or not marked with
16094 @code{read}, plus a little extra.
16097 @subsubsection Article identification
16098 Articles are stored in the @file{cur/} subdirectory of each maildir.
16099 Each article file is named like @code{uniq:info}, where @code{uniq}
16100 contains no colons. @code{nnmaildir} ignores, but preserves, the
16101 @code{:info} part. (Other maildir readers typically use this part of
16102 the filename to store marks.) The @code{uniq} part uniquely
16103 identifies the article, and is used in various places in the
16104 @file{.nnmaildir/} subdirectory of the maildir to store information
16105 about the corresponding article. The full pathname of an article is
16106 available in the variable @code{nnmaildir-article-file-name} after you
16107 request the article in the summary buffer.
16109 @subsubsection NOV data
16110 An article identified by @code{uniq} has its @acronym{NOV} data (used
16111 to generate lines in the summary buffer) stored in
16112 @code{.nnmaildir/nov/uniq}. There is no
16113 @code{nnmaildir-generate-nov-databases} function. (There isn't much
16114 need for it---an article's @acronym{NOV} data is updated automatically
16115 when the article or @code{nnmail-extra-headers} has changed.) You can
16116 force @code{nnmaildir} to regenerate the @acronym{NOV} data for a
16117 single article simply by deleting the corresponding @acronym{NOV}
16118 file, but @emph{beware}: this will also cause @code{nnmaildir} to
16119 assign a new article number for this article, which may cause trouble
16120 with @code{seen} marks, the Agent, and the cache.
16122 @subsubsection Article marks
16123 An article identified by @code{uniq} is considered to have the mark
16124 @code{flag} when the file @file{.nnmaildir/marks/flag/uniq} exists.
16125 When Gnus asks @code{nnmaildir} for a group's marks, @code{nnmaildir}
16126 looks for such files and reports the set of marks it finds. When Gnus
16127 asks @code{nnmaildir} to store a new set of marks, @code{nnmaildir}
16128 creates and deletes the corresponding files as needed. (Actually,
16129 rather than create a new file for each mark, it just creates hard
16130 links to @file{.nnmaildir/markfile}, to save inodes.)
16132 You can invent new marks by creating a new directory in
16133 @file{.nnmaildir/marks/}. You can tar up a maildir and remove it from
16134 your server, untar it later, and keep your marks. You can add and
16135 remove marks yourself by creating and deleting mark files. If you do
16136 this while Gnus is running and your @code{nnmaildir} server is open,
16137 it's best to exit all summary buffers for @code{nnmaildir} groups and
16138 type @kbd{s} in the group buffer first, and to type @kbd{g} or
16139 @kbd{M-g} in the group buffer afterwards. Otherwise, Gnus might not
16140 pick up the changes, and might undo them.
16144 @subsubsection Mail Folders
16146 @cindex mbox folders
16147 @cindex mail folders
16149 @code{nnfolder} is a back end for storing each mail group in a
16150 separate file. Each file is in the standard Un*x mbox format.
16151 @code{nnfolder} will add extra headers to keep track of article
16152 numbers and arrival dates.
16154 @cindex self contained nnfolder servers
16156 When the marks file is used (which it is by default), @code{nnfolder}
16157 servers have the property that you may backup them using @code{tar} or
16158 similar, and later be able to restore them into Gnus (by adding the
16159 proper @code{nnfolder} server) and have all your marks be preserved.
16160 Marks for a group are usually stored in a file named as the mbox file
16161 with @code{.mrk} concatenated to it (but see
16162 @code{nnfolder-marks-file-suffix}) within the @code{nnfolder}
16163 directory. Individual @code{nnfolder} groups are also possible to
16164 backup, use @kbd{G m} to restore the group (after restoring the backup
16165 into the @code{nnfolder} directory).
16167 Virtual server settings:
16170 @item nnfolder-directory
16171 @vindex nnfolder-directory
16172 All the @code{nnfolder} mail boxes will be stored under this
16173 directory. The default is the value of @code{message-directory}
16174 (whose default is @file{~/Mail})
16176 @item nnfolder-active-file
16177 @vindex nnfolder-active-file
16178 The name of the active file. The default is @file{~/Mail/active}.
16180 @item nnfolder-newsgroups-file
16181 @vindex nnfolder-newsgroups-file
16182 The name of the group descriptions file. @xref{Newsgroups File
16183 Format}. The default is @file{~/Mail/newsgroups}
16185 @item nnfolder-get-new-mail
16186 @vindex nnfolder-get-new-mail
16187 If non-@code{nil}, @code{nnfolder} will read incoming mail. The
16188 default is @code{t}
16190 @item nnfolder-save-buffer-hook
16191 @vindex nnfolder-save-buffer-hook
16192 @cindex backup files
16193 Hook run before saving the folders. Note that Emacs does the normal
16194 backup renaming of files even with the @code{nnfolder} buffers. If
16195 you wish to switch this off, you could say something like the
16196 following in your @file{.emacs} file:
16199 (defun turn-off-backup ()
16200 (set (make-local-variable 'backup-inhibited) t))
16202 (add-hook 'nnfolder-save-buffer-hook 'turn-off-backup)
16205 @item nnfolder-delete-mail-hook
16206 @vindex nnfolder-delete-mail-hook
16207 Hook run in a buffer narrowed to the message that is to be deleted.
16208 This function can be used to copy the message to somewhere else, or to
16209 extract some information from it before removing it.
16211 @item nnfolder-nov-is-evil
16212 @vindex nnfolder-nov-is-evil
16213 If non-@code{nil}, this back end will ignore any @acronym{NOV} files. The
16214 default is @code{nil}.
16216 @item nnfolder-nov-file-suffix
16217 @vindex nnfolder-nov-file-suffix
16218 The extension for @acronym{NOV} files. The default is @file{.nov}.
16220 @item nnfolder-nov-directory
16221 @vindex nnfolder-nov-directory
16222 The directory where the @acronym{NOV} files should be stored. If
16223 @code{nil}, @code{nnfolder-directory} is used.
16225 @item nnfolder-marks-is-evil
16226 @vindex nnfolder-marks-is-evil
16227 If non-@code{nil}, this back end will ignore any @sc{marks} files. The
16228 default is @code{nil}.
16230 @item nnfolder-marks-file-suffix
16231 @vindex nnfolder-marks-file-suffix
16232 The extension for @sc{marks} files. The default is @file{.mrk}.
16234 @item nnfolder-marks-directory
16235 @vindex nnfolder-marks-directory
16236 The directory where the @sc{marks} files should be stored. If
16237 @code{nil}, @code{nnfolder-directory} is used.
16242 @findex nnfolder-generate-active-file
16243 @kindex M-x nnfolder-generate-active-file
16244 If you have lots of @code{nnfolder}-like files you'd like to read with
16245 @code{nnfolder}, you can use the @kbd{M-x nnfolder-generate-active-file}
16246 command to make @code{nnfolder} aware of all likely files in
16247 @code{nnfolder-directory}. This only works if you use long file names,
16250 @node Comparing Mail Back Ends
16251 @subsubsection Comparing Mail Back Ends
16253 First, just for terminology, the @dfn{back end} is the common word for a
16254 low-level access method---a transport, if you will, by which something
16255 is acquired. The sense is that one's mail has to come from somewhere,
16256 and so selection of a suitable back end is required in order to get that
16257 mail within spitting distance of Gnus.
16259 The same concept exists for Usenet itself: Though access to articles is
16260 typically done by @acronym{NNTP} these days, once upon a midnight dreary, everyone
16261 in the world got at Usenet by running a reader on the machine where the
16262 articles lay (the machine which today we call an @acronym{NNTP} server), and
16263 access was by the reader stepping into the articles' directory spool
16264 area directly. One can still select between either the @code{nntp} or
16265 @code{nnspool} back ends, to select between these methods, if one happens
16266 actually to live on the server (or can see its spool directly, anyway,
16269 The goal in selecting a mail back end is to pick one which
16270 simultaneously represents a suitable way of dealing with the original
16271 format plus leaving mail in a form that is convenient to use in the
16272 future. Here are some high and low points on each:
16277 UNIX systems have historically had a single, very common, and well-
16278 defined format. All messages arrive in a single @dfn{spool file}, and
16279 they are delineated by a line whose regular expression matches
16280 @samp{^From_}. (My notational use of @samp{_} is to indicate a space,
16281 to make it clear in this instance that this is not the RFC-specified
16282 @samp{From:} header.) Because Emacs and therefore Gnus emanate
16283 historically from the Unix environment, it is simplest if one does not
16284 mess a great deal with the original mailbox format, so if one chooses
16285 this back end, Gnus' primary activity in getting mail from the real spool
16286 area to Gnus' preferred directory is simply to copy it, with no
16287 (appreciable) format change in the process. It is the ``dumbest'' way
16288 to move mail into availability in the Gnus environment. This makes it
16289 fast to move into place, but slow to parse, when Gnus has to look at
16294 Once upon a time, there was the DEC-10 and DEC-20, running operating
16295 systems called TOPS and related things, and the usual (only?) mail
16296 reading environment was a thing called Babyl. I don't know what format
16297 was used for mail landing on the system, but Babyl had its own internal
16298 format to which mail was converted, primarily involving creating a
16299 spool-file-like entity with a scheme for inserting Babyl-specific
16300 headers and status bits above the top of each message in the file.
16301 Rmail was Emacs' first mail reader, it was written by Richard Stallman,
16302 and Stallman came out of that TOPS/Babyl environment, so he wrote Rmail
16303 to understand the mail files folks already had in existence. Gnus (and
16304 VM, for that matter) continue to support this format because it's
16305 perceived as having some good qualities in those mailer-specific
16306 headers/status bits stuff. Rmail itself still exists as well, of
16307 course, and is still maintained by Stallman.
16309 Both of the above forms leave your mail in a single file on your
16310 file system, and they must parse that entire file each time you take a
16315 @code{nnml} is the back end which smells the most as though you were
16316 actually operating with an @code{nnspool}-accessed Usenet system. (In
16317 fact, I believe @code{nnml} actually derived from @code{nnspool} code,
16318 lo these years ago.) One's mail is taken from the original spool file,
16319 and is then cut up into individual message files, 1:1. It maintains a
16320 Usenet-style active file (analogous to what one finds in an INN- or
16321 CNews-based news system in (for instance) @file{/var/lib/news/active},
16322 or what is returned via the @samp{NNTP LIST} verb) and also creates
16323 @dfn{overview} files for efficient group entry, as has been defined for
16324 @acronym{NNTP} servers for some years now. It is slower in mail-splitting,
16325 due to the creation of lots of files, updates to the @code{nnml} active
16326 file, and additions to overview files on a per-message basis, but it is
16327 extremely fast on access because of what amounts to the indexing support
16328 provided by the active file and overviews.
16330 @code{nnml} costs @dfn{inodes} in a big way; that is, it soaks up the
16331 resource which defines available places in the file system to put new
16332 files. Sysadmins take a dim view of heavy inode occupation within
16333 tight, shared file systems. But if you live on a personal machine where
16334 the file system is your own and space is not at a premium, @code{nnml}
16337 It is also problematic using this back end if you are living in a
16338 FAT16-based Windows world, since much space will be wasted on all these
16343 The Rand MH mail-reading system has been around UNIX systems for a very
16344 long time; it operates by splitting one's spool file of messages into
16345 individual files, but with little or no indexing support---@code{nnmh}
16346 is considered to be semantically equivalent to ``@code{nnml} without
16347 active file or overviews''. This is arguably the worst choice, because
16348 one gets the slowness of individual file creation married to the
16349 slowness of access parsing when learning what's new in one's groups.
16353 Basically the effect of @code{nnfolder} is @code{nnmbox} (the first
16354 method described above) on a per-group basis. That is, @code{nnmbox}
16355 itself puts @emph{all} one's mail in one file; @code{nnfolder} provides a
16356 little bit of optimization to this so that each of one's mail groups has
16357 a Unix mail box file. It's faster than @code{nnmbox} because each group
16358 can be parsed separately, and still provides the simple Unix mail box
16359 format requiring minimal effort in moving the mail around. In addition,
16360 it maintains an ``active'' file making it much faster for Gnus to figure
16361 out how many messages there are in each separate group.
16363 If you have groups that are expected to have a massive amount of
16364 messages, @code{nnfolder} is not the best choice, but if you receive
16365 only a moderate amount of mail, @code{nnfolder} is probably the most
16366 friendly mail back end all over.
16370 For configuring expiry and other things, @code{nnmaildir} uses
16371 incompatible group parameters, slightly different from those of other
16374 @code{nnmaildir} is largely similar to @code{nnml}, with some notable
16375 differences. Each message is stored in a separate file, but the
16376 filename is unrelated to the article number in Gnus. @code{nnmaildir}
16377 also stores the equivalent of @code{nnml}'s overview files in one file
16378 per article, so it uses about twice as many inodes as @code{nnml}. (Use
16379 @code{df -i} to see how plentiful your inode supply is.) If this slows
16380 you down or takes up very much space, consider switching to
16381 @uref{http://www.namesys.com/, ReiserFS} or another non-block-structured
16384 Since maildirs don't require locking for delivery, the maildirs you use
16385 as groups can also be the maildirs your mail is directly delivered to.
16386 This means you can skip Gnus' mail splitting if your mail is already
16387 organized into different mailboxes during delivery. A @code{directory}
16388 entry in @code{mail-sources} would have a similar effect, but would
16389 require one set of mailboxes for spooling deliveries (in mbox format,
16390 thus damaging message bodies), and another set to be used as groups (in
16391 whatever format you like). A maildir has a built-in spool, in the
16392 @code{new/} subdirectory. Beware that currently, mail moved from
16393 @code{new/} to @code{cur/} instead of via mail splitting will not
16394 undergo treatment such as duplicate checking.
16396 @code{nnmaildir} stores article marks for a given group in the
16397 corresponding maildir, in a way designed so that it's easy to manipulate
16398 them from outside Gnus. You can tar up a maildir, unpack it somewhere
16399 else, and still have your marks. @code{nnml} also stores marks, but
16400 it's not as easy to work with them from outside Gnus as with
16403 @code{nnmaildir} uses a significant amount of memory to speed things up.
16404 (It keeps in memory some of the things that @code{nnml} stores in files
16405 and that @code{nnmh} repeatedly parses out of message files.) If this
16406 is a problem for you, you can set the @code{nov-cache-size} group
16407 parameter to something small (0 would probably not work, but 1 probably
16408 would) to make it use less memory. This caching will probably be
16409 removed in the future.
16411 Startup is likely to be slower with @code{nnmaildir} than with other
16412 back ends. Everything else is likely to be faster, depending in part
16413 on your file system.
16415 @code{nnmaildir} does not use @code{nnoo}, so you cannot use @code{nnoo}
16416 to write an @code{nnmaildir}-derived back end.
16421 @node Browsing the Web
16422 @section Browsing the Web
16424 @cindex browsing the web
16428 Web-based discussion forums are getting more and more popular. On many
16429 subjects, the web-based forums have become the most important forums,
16430 eclipsing the importance of mailing lists and news groups. The reason
16431 is easy to understand---they are friendly to new users; you just point
16432 and click, and there's the discussion. With mailing lists, you have to
16433 go through a cumbersome subscription procedure, and most people don't
16434 even know what a news group is.
16436 The problem with this scenario is that web browsers are not very good at
16437 being newsreaders. They do not keep track of what articles you've read;
16438 they do not allow you to score on subjects you're interested in; they do
16439 not allow off-line browsing; they require you to click around and drive
16440 you mad in the end.
16442 So---if web browsers suck at reading discussion forums, why not use Gnus
16445 Gnus has been getting a bit of a collection of back ends for providing
16446 interfaces to these sources.
16450 * Web Searches:: Creating groups from articles that match a string.
16451 * Slashdot:: Reading the Slashdot comments.
16452 * Ultimate:: The Ultimate Bulletin Board systems.
16453 * Web Archive:: Reading mailing list archived on web.
16454 * RSS:: Reading RDF site summary.
16455 * Customizing W3:: Doing stuff to Emacs/W3 from Gnus.
16458 All the web sources require Emacs/W3 and the url library or those
16459 alternatives to work.
16461 The main caveat with all these web sources is that they probably won't
16462 work for a very long time. Gleaning information from the @acronym{HTML} data
16463 is guesswork at best, and when the layout is altered, the Gnus back end
16464 will fail. If you have reasonably new versions of these back ends,
16465 though, you should be ok.
16467 One thing all these Web methods have in common is that the Web sources
16468 are often down, unavailable or just plain too slow to be fun. In those
16469 cases, it makes a lot of sense to let the Gnus Agent (@pxref{Gnus
16470 Unplugged}) handle downloading articles, and then you can read them at
16471 leisure from your local disk. No more World Wide Wait for you.
16473 @node Archiving Mail
16474 @subsection Archiving Mail
16475 @cindex archiving mail
16476 @cindex backup of mail
16478 Some of the back ends, notably @code{nnml}, @code{nnfolder}, and
16479 @code{nnmaildir}, now actually store the article marks with each group.
16480 For these servers, archiving and restoring a group while preserving
16481 marks is fairly simple.
16483 (Preserving the group level and group parameters as well still
16484 requires ritual dancing and sacrifices to the @file{.newsrc.eld} deity
16487 To archive an entire @code{nnml}, @code{nnfolder}, or @code{nnmaildir}
16488 server, take a recursive copy of the server directory. There is no need
16489 to shut down Gnus, so archiving may be invoked by @code{cron} or
16490 similar. You restore the data by restoring the directory tree, and
16491 adding a server definition pointing to that directory in Gnus. The
16492 @ref{Article Backlog}, @ref{Asynchronous Fetching} and other things
16493 might interfere with overwriting data, so you may want to shut down Gnus
16494 before you restore the data.
16496 It is also possible to archive individual @code{nnml},
16497 @code{nnfolder}, or @code{nnmaildir} groups, while preserving marks.
16498 For @code{nnml} or @code{nnmaildir}, you copy all files in the group's
16499 directory. For @code{nnfolder} you need to copy both the base folder
16500 file itself (@file{FOO}, say), and the marks file (@file{FOO.mrk} in
16501 this example). Restoring the group is done with @kbd{G m} from the Group
16502 buffer. The last step makes Gnus notice the new directory.
16503 @code{nnmaildir} notices the new directory automatically, so @kbd{G m}
16504 is unnecessary in that case.
16507 @subsection Web Searches
16512 @cindex Usenet searches
16513 @cindex searching the Usenet
16515 It's, like, too neat to search the Usenet for articles that match a
16516 string, but it, like, totally @emph{sucks}, like, totally, to use one of
16517 those, like, Web browsers, and you, like, have to, rilly, like, look at
16518 the commercials, so, like, with Gnus you can do @emph{rad}, rilly,
16519 searches without having to use a browser.
16521 The @code{nnweb} back end allows an easy interface to the mighty search
16522 engine. You create an @code{nnweb} group, enter a search pattern, and
16523 then enter the group and read the articles like you would any normal
16524 group. The @kbd{G w} command in the group buffer (@pxref{Foreign
16525 Groups}) will do this in an easy-to-use fashion.
16527 @code{nnweb} groups don't really lend themselves to being solid
16528 groups---they have a very fleeting idea of article numbers. In fact,
16529 each time you enter an @code{nnweb} group (not even changing the search
16530 pattern), you are likely to get the articles ordered in a different
16531 manner. Not even using duplicate suppression (@pxref{Duplicate
16532 Suppression}) will help, since @code{nnweb} doesn't even know the
16533 @code{Message-ID} of the articles before reading them using some search
16534 engines (Google, for instance). The only possible way to keep track
16535 of which articles you've read is by scoring on the @code{Date}
16536 header---mark all articles posted before the last date you read the
16539 If the search engine changes its output substantially, @code{nnweb}
16540 won't be able to parse it and will fail. One could hardly fault the Web
16541 providers if they were to do this---their @emph{raison d'@^etre} is to
16542 make money off of advertisements, not to provide services to the
16543 community. Since @code{nnweb} washes the ads off all the articles, one
16544 might think that the providers might be somewhat miffed. We'll see.
16546 You must have the @code{url} and @code{W3} package or those alternatives
16547 (try @code{customize-group} on the @samp{mm-url} variable group)
16548 installed to be able to use @code{nnweb}.
16550 Virtual server variables:
16555 What search engine type is being used. The currently supported types
16556 are @code{google}, @code{dejanews}, and @code{gmane}. Note that
16557 @code{dejanews} is an alias to @code{google}.
16560 @vindex nnweb-search
16561 The search string to feed to the search engine.
16563 @item nnweb-max-hits
16564 @vindex nnweb-max-hits
16565 Advisory maximum number of hits per search to display. The default is
16568 @item nnweb-type-definition
16569 @vindex nnweb-type-definition
16570 Type-to-definition alist. This alist says what @code{nnweb} should do
16571 with the various search engine types. The following elements must be
16576 Function to decode the article and provide something that Gnus
16580 Function to create an article number to message header and URL alist.
16583 Function to send the search string to the search engine.
16586 The address the aforementioned function should send the search string
16590 Format string URL to fetch an article by @code{Message-ID}.
16597 @subsection Slashdot
16601 @uref{http://slashdot.org/, Slashdot} is a popular news site, with
16602 lively discussion following the news articles. @code{nnslashdot} will
16603 let you read this forum in a convenient manner.
16605 The easiest way to read this source is to put something like the
16606 following in your @file{~/.gnus.el} file:
16609 (setq gnus-secondary-select-methods
16610 '((nnslashdot "")))
16613 This will make Gnus query the @code{nnslashdot} back end for new comments
16614 and groups. The @kbd{F} command will subscribe each new news article as
16615 a new Gnus group, and you can read the comments by entering these
16616 groups. (Note that the default subscription method is to subscribe new
16617 groups as zombies. Other methods are available (@pxref{Subscription
16620 If you want to remove an old @code{nnslashdot} group, the @kbd{G DEL}
16621 command is the most handy tool (@pxref{Foreign Groups}).
16623 When following up to @code{nnslashdot} comments (or posting new
16624 comments), some light @acronym{HTML}izations will be performed. In
16625 particular, text quoted with @samp{> } will be quoted with
16626 @samp{blockquote} instead, and signatures will have @samp{br} added to
16627 the end of each line. Other than that, you can just write @acronym{HTML}
16628 directly into the message buffer. Note that Slashdot filters out some
16629 @acronym{HTML} forms.
16631 The following variables can be altered to change its behavior:
16634 @item nnslashdot-threaded
16635 Whether @code{nnslashdot} should display threaded groups or not. The
16636 default is @code{t}. To be able to display threads, @code{nnslashdot}
16637 has to retrieve absolutely all comments in a group upon entry. If a
16638 threaded display is not required, @code{nnslashdot} will only retrieve
16639 the comments that are actually wanted by the user. Threading is nicer,
16640 but much, much slower than unthreaded.
16642 @item nnslashdot-login-name
16643 @vindex nnslashdot-login-name
16644 The login name to use when posting.
16646 @item nnslashdot-password
16647 @vindex nnslashdot-password
16648 The password to use when posting.
16650 @item nnslashdot-directory
16651 @vindex nnslashdot-directory
16652 Where @code{nnslashdot} will store its files. The default is
16653 @file{~/News/slashdot/}.
16655 @item nnslashdot-active-url
16656 @vindex nnslashdot-active-url
16657 The @acronym{URL} format string that will be used to fetch the
16658 information on news articles and comments. The default is@*
16659 @samp{http://slashdot.org/search.pl?section=&min=%d}.
16661 @item nnslashdot-comments-url
16662 @vindex nnslashdot-comments-url
16663 The @acronym{URL} format string that will be used to fetch comments.
16665 @item nnslashdot-article-url
16666 @vindex nnslashdot-article-url
16667 The @acronym{URL} format string that will be used to fetch the news
16668 article. The default is
16669 @samp{http://slashdot.org/article.pl?sid=%s&mode=nocomment}.
16671 @item nnslashdot-threshold
16672 @vindex nnslashdot-threshold
16673 The score threshold. The default is -1.
16675 @item nnslashdot-group-number
16676 @vindex nnslashdot-group-number
16677 The number of old groups, in addition to the ten latest, to keep
16678 updated. The default is 0.
16685 @subsection Ultimate
16687 @cindex Ultimate Bulletin Board
16689 @uref{http://www.ultimatebb.com/, The Ultimate Bulletin Board} is
16690 probably the most popular Web bulletin board system used. It has a
16691 quite regular and nice interface, and it's possible to get the
16692 information Gnus needs to keep groups updated.
16694 The easiest way to get started with @code{nnultimate} is to say
16695 something like the following in the group buffer: @kbd{B nnultimate RET
16696 http://www.tcj.com/messboard/ubbcgi/ RET}. (Substitute the @acronym{URL}
16697 (not including @samp{Ultimate.cgi} or the like at the end) for a forum
16698 you're interested in; there's quite a list of them on the Ultimate web
16699 site.) Then subscribe to the groups you're interested in from the
16700 server buffer, and read them from the group buffer.
16702 The following @code{nnultimate} variables can be altered:
16705 @item nnultimate-directory
16706 @vindex nnultimate-directory
16707 The directory where @code{nnultimate} stores its files. The default is@*
16708 @file{~/News/ultimate/}.
16713 @subsection Web Archive
16715 @cindex Web Archive
16717 Some mailing lists only have archives on Web servers, such as
16718 @uref{http://www.egroups.com/} and
16719 @uref{http://www.mail-archive.com/}. It has a quite regular and nice
16720 interface, and it's possible to get the information Gnus needs to keep
16723 @findex gnus-group-make-warchive-group
16724 The easiest way to get started with @code{nnwarchive} is to say
16725 something like the following in the group buffer: @kbd{M-x
16726 gnus-group-make-warchive-group RET @var{an_egroup} RET egroups RET
16727 www.egroups.com RET @var{your@@email.address} RET}. (Substitute the
16728 @var{an_egroup} with the mailing list you subscribed, the
16729 @var{your@@email.address} with your email address.), or to browse the
16730 back end by @kbd{B nnwarchive RET mail-archive RET}.
16732 The following @code{nnwarchive} variables can be altered:
16735 @item nnwarchive-directory
16736 @vindex nnwarchive-directory
16737 The directory where @code{nnwarchive} stores its files. The default is@*
16738 @file{~/News/warchive/}.
16740 @item nnwarchive-login
16741 @vindex nnwarchive-login
16742 The account name on the web server.
16744 @item nnwarchive-passwd
16745 @vindex nnwarchive-passwd
16746 The password for your account on the web server.
16754 Some web sites have an RDF Site Summary (@acronym{RSS}).
16755 @acronym{RSS} is a format for summarizing headlines from news related
16756 sites (such as BBC or CNN). But basically anything list-like can be
16757 presented as an @acronym{RSS} feed: weblogs, changelogs or recent
16758 changes to a wiki (e.g. @url{http://cliki.net/recent-changes.rdf}).
16760 @acronym{RSS} has a quite regular and nice interface, and it's
16761 possible to get the information Gnus needs to keep groups updated.
16763 Note: you had better use Emacs which supports the @code{utf-8} coding
16764 system because @acronym{RSS} uses UTF-8 for encoding non-@acronym{ASCII}
16765 text by default. It is also used by default for non-@acronym{ASCII}
16768 @kindex G R (Group)
16769 Use @kbd{G R} from the group buffer to subscribe to a feed---you will be
16770 prompted for the location, the title and the description of the feed.
16771 The title, which allows any characters, will be used for the group name
16772 and the name of the group data file. The description can be omitted.
16774 An easy way to get started with @code{nnrss} is to say something like
16775 the following in the group buffer: @kbd{B nnrss RET RET y}, then
16776 subscribe to groups.
16778 The @code{nnrss} back end saves the group data file in
16779 @code{nnrss-directory} (see below) for each @code{nnrss} group. File
16780 names containing non-@acronym{ASCII} characters will be encoded by the
16781 coding system specified with the @code{nnmail-pathname-coding-system}
16782 variable. If it is @code{nil}, in Emacs the coding system defaults to
16783 the value of @code{default-file-name-coding-system}. If you are using
16784 XEmacs and want to use non-@acronym{ASCII} group names, you should set
16785 the value for the @code{nnmail-pathname-coding-system} variable properly.
16787 The @code{nnrss} back end generates @samp{multipart/alternative}
16788 @acronym{MIME} articles in which each contains a @samp{text/plain} part
16789 and a @samp{text/html} part.
16792 You can also use the following commands to import and export your
16793 subscriptions from a file in @acronym{OPML} format (Outline Processor
16796 @defun nnrss-opml-import file
16797 Prompt for an @acronym{OPML} file, and subscribe to each feed in the
16801 @defun nnrss-opml-export
16802 Write your current @acronym{RSS} subscriptions to a buffer in
16803 @acronym{OPML} format.
16806 The following @code{nnrss} variables can be altered:
16809 @item nnrss-directory
16810 @vindex nnrss-directory
16811 The directory where @code{nnrss} stores its files. The default is
16812 @file{~/News/rss/}.
16814 @item nnrss-file-coding-system
16815 @vindex nnrss-file-coding-system
16816 The coding system used when reading and writing the @code{nnrss} groups
16817 data files. The default is the value of
16818 @code{mm-universal-coding-system} (which defaults to @code{emacs-mule}
16819 in Emacs or @code{escape-quoted} in XEmacs).
16821 @item nnrss-ignore-article-fields
16822 @vindex nnrss-ignore-article-fields
16823 Some feeds update constantly article fields during their publications,
16824 e.g. to indicate the number of comments. However, if there is
16825 a difference between the local article and the distant one, the latter
16826 is considered to be new. To avoid this and discard some fields, set this
16827 variable to the list of fields to be ignored. The default is
16828 @code{'(slash:comments)}.
16830 @item nnrss-use-local
16831 @vindex nnrss-use-local
16832 @findex nnrss-generate-download-script
16833 If you set @code{nnrss-use-local} to @code{t}, @code{nnrss} will read
16834 the feeds from local files in @code{nnrss-directory}. You can use
16835 the command @code{nnrss-generate-download-script} to generate a
16836 download script using @command{wget}.
16838 @item nnrss-wash-html-in-text-plain-parts
16839 Non-@code{nil} means that @code{nnrss} renders text in @samp{text/plain}
16840 parts as @acronym{HTML}. The function specified by the
16841 @code{mm-text-html-renderer} variable (@pxref{Display Customization,
16842 ,Display Customization, emacs-mime, The Emacs MIME Manual}) will be used
16843 to render text. If it is @code{nil}, which is the default, text will
16844 simply be folded. Leave it @code{nil} if you prefer to see
16845 @samp{text/html} parts.
16848 The following code may be helpful, if you want to show the description in
16849 the summary buffer.
16852 (add-to-list 'nnmail-extra-headers nnrss-description-field)
16853 (setq gnus-summary-line-format "%U%R%z%I%(%[%4L: %-15,15f%]%) %s%uX\n")
16855 (defun gnus-user-format-function-X (header)
16857 (assq nnrss-description-field (mail-header-extra header))))
16858 (if descr (concat "\n\t" (cdr descr)) "")))
16861 The following code may be useful to open an nnrss url directly from the
16865 (require 'browse-url)
16867 (defun browse-nnrss-url (arg)
16869 (let ((url (assq nnrss-url-field
16872 (assq (gnus-summary-article-number)
16873 gnus-newsgroup-data))))))
16876 (browse-url (cdr url))
16877 (gnus-summary-mark-as-read-forward 1))
16878 (gnus-summary-scroll-up arg))))
16880 (eval-after-load "gnus"
16881 #'(define-key gnus-summary-mode-map
16882 (kbd "<RET>") 'browse-nnrss-url))
16883 (add-to-list 'nnmail-extra-headers nnrss-url-field)
16886 Even if you have added @code{"text/html"} to the
16887 @code{mm-discouraged-alternatives} variable (@pxref{Display
16888 Customization, ,Display Customization, emacs-mime, The Emacs MIME
16889 Manual}) since you don't want to see @acronym{HTML} parts, it might be
16890 more useful especially in @code{nnrss} groups to display
16891 @samp{text/html} parts. Here's an example of setting
16892 @code{mm-discouraged-alternatives} as a group parameter (@pxref{Group
16893 Parameters}) in order to display @samp{text/html} parts only in
16894 @code{nnrss} groups:
16897 ;; @r{Set the default value of @code{mm-discouraged-alternatives}.}
16898 (eval-after-load "gnus-sum"
16900 'gnus-newsgroup-variables
16901 '(mm-discouraged-alternatives
16902 . '("text/html" "image/.*"))))
16904 ;; @r{Display @samp{text/html} parts in @code{nnrss} groups.}
16907 '("\\`nnrss:" (mm-discouraged-alternatives nil)))
16911 @node Customizing W3
16912 @subsection Customizing W3
16918 Gnus uses the url library to fetch web pages and Emacs/W3 (or those
16919 alternatives) to display web pages. Emacs/W3 is documented in its own
16920 manual, but there are some things that may be more relevant for Gnus
16923 For instance, a common question is how to make Emacs/W3 follow links
16924 using the @code{browse-url} functions (which will call some external web
16925 browser like Netscape). Here's one way:
16928 (eval-after-load "w3"
16930 (fset 'w3-fetch-orig (symbol-function 'w3-fetch))
16931 (defun w3-fetch (&optional url target)
16932 (interactive (list (w3-read-url-with-default)))
16933 (if (eq major-mode 'gnus-article-mode)
16935 (w3-fetch-orig url target)))))
16938 Put that in your @file{.emacs} file, and hitting links in W3-rendered
16939 @acronym{HTML} in the Gnus article buffers will use @code{browse-url} to
16946 @cindex @acronym{IMAP}
16948 @acronym{IMAP} is a network protocol for reading mail (or news, or @dots{}),
16949 think of it as a modernized @acronym{NNTP}. Connecting to a @acronym{IMAP}
16950 server is much similar to connecting to a news server, you just
16951 specify the network address of the server.
16953 @acronym{IMAP} has two properties. First, @acronym{IMAP} can do
16954 everything that @acronym{POP} can, it can hence be viewed as a
16955 @acronym{POP++}. Secondly, @acronym{IMAP} is a mail storage protocol,
16956 similar to @acronym{NNTP} being a news storage protocol---however,
16957 @acronym{IMAP} offers more features than @acronym{NNTP} because news
16958 is more or less read-only whereas mail is read-write.
16960 If you want to use @acronym{IMAP} as a @acronym{POP++}, use an imap
16961 entry in @code{mail-sources}. With this, Gnus will fetch mails from
16962 the @acronym{IMAP} server and store them on the local disk. This is
16963 not the usage described in this section---@xref{Mail Sources}.
16965 If you want to use @acronym{IMAP} as a mail storage protocol, use an nnimap
16966 entry in @code{gnus-secondary-select-methods}. With this, Gnus will
16967 manipulate mails stored on the @acronym{IMAP} server. This is the kind of
16968 usage explained in this section.
16970 A server configuration in @file{~/.gnus.el} with a few @acronym{IMAP}
16971 servers might look something like the following. (Note that for
16972 @acronym{TLS}/@acronym{SSL}, you need external programs and libraries,
16976 (setq gnus-secondary-select-methods
16977 '((nnimap "simpleserver") ; @r{no special configuration}
16978 ; @r{perhaps a ssh port forwarded server:}
16980 (nnimap-address "localhost")
16981 (nnimap-server-port 1430))
16982 ; @r{a UW server running on localhost}
16984 (nnimap-server-port 143)
16985 (nnimap-address "localhost")
16986 (nnimap-list-pattern ("INBOX" "mail/*")))
16987 ; @r{anonymous public cyrus server:}
16988 (nnimap "cyrus.andrew.cmu.edu"
16989 (nnimap-authenticator anonymous)
16990 (nnimap-list-pattern "archive.*")
16991 (nnimap-stream network))
16992 ; @r{a ssl server on a non-standard port:}
16994 (nnimap-address "vic20.somewhere.com")
16995 (nnimap-server-port 9930)
16996 (nnimap-stream ssl))))
16999 After defining the new server, you can subscribe to groups on the
17000 server using normal Gnus commands such as @kbd{U} in the Group Buffer
17001 (@pxref{Subscription Commands}) or via the Server Buffer
17002 (@pxref{Server Buffer}).
17004 The following variables can be used to create a virtual @code{nnimap}
17009 @item nnimap-address
17010 @vindex nnimap-address
17012 The address of the remote @acronym{IMAP} server. Defaults to the virtual
17013 server name if not specified.
17015 @item nnimap-server-port
17016 @vindex nnimap-server-port
17017 Port on server to contact. Defaults to port 143, or 993 for @acronym{TLS}/@acronym{SSL}.
17019 Note that this should be an integer, example server specification:
17022 (nnimap "mail.server.com"
17023 (nnimap-server-port 4711))
17026 @item nnimap-list-pattern
17027 @vindex nnimap-list-pattern
17028 String or list of strings of mailboxes to limit available groups to.
17029 This is used when the server has very many mailboxes and you're only
17030 interested in a few---some servers export your home directory via
17031 @acronym{IMAP}, you'll probably want to limit the mailboxes to those in
17032 @file{~/Mail/*} then.
17034 The string can also be a cons of REFERENCE and the string as above, what
17035 REFERENCE is used for is server specific, but on the University of
17036 Washington server it's a directory that will be concatenated with the
17039 Example server specification:
17042 (nnimap "mail.server.com"
17043 (nnimap-list-pattern ("INBOX" "Mail/*" "alt.sex.*"
17044 ("~friend/Mail/" . "list/*"))))
17047 @item nnimap-stream
17048 @vindex nnimap-stream
17049 The type of stream used to connect to your server. By default, nnimap
17050 will detect and automatically use all of the below, with the exception
17051 of @acronym{TLS}/@acronym{SSL}. (@acronym{IMAP} over
17052 @acronym{TLS}/@acronym{SSL} is being replaced by STARTTLS, which can
17053 be automatically detected, but it's not widely deployed yet.)
17055 Example server specification:
17058 (nnimap "mail.server.com"
17059 (nnimap-stream ssl))
17062 Please note that the value of @code{nnimap-stream} is a symbol!
17066 @dfn{gssapi:} Connect with GSSAPI (usually Kerberos 5). Requires the
17067 @samp{gsasl} or @samp{imtest} program.
17069 @dfn{kerberos4:} Connect with Kerberos 4. Requires the @samp{imtest} program.
17071 @dfn{starttls:} Connect via the STARTTLS extension (similar to
17072 @acronym{TLS}/@acronym{SSL}). Requires the external library @samp{starttls.el} and program
17075 @dfn{tls:} Connect through @acronym{TLS}. Requires GNUTLS (the program
17076 @samp{gnutls-cli}).
17078 @dfn{ssl:} Connect through @acronym{SSL}. Requires OpenSSL (the program
17079 @samp{openssl}) or SSLeay (@samp{s_client}).
17081 @dfn{shell:} Use a shell command to start @acronym{IMAP} connection.
17083 @dfn{network:} Plain, TCP/IP network connection.
17086 @vindex imap-kerberos4-program
17087 The @samp{imtest} program is shipped with Cyrus IMAPD. If you're
17088 using @samp{imtest} from Cyrus IMAPD < 2.0.14 (which includes version
17089 1.5.x and 1.6.x) you need to frob @code{imap-process-connection-type}
17090 to make @code{imap.el} use a pty instead of a pipe when communicating
17091 with @samp{imtest}. You will then suffer from a line length
17092 restrictions on @acronym{IMAP} commands, which might make Gnus seem to hang
17093 indefinitely if you have many articles in a mailbox. The variable
17094 @code{imap-kerberos4-program} contain parameters to pass to the imtest
17097 For @acronym{TLS} connection, the @code{gnutls-cli} program from GNUTLS is
17098 needed. It is available from
17099 @uref{http://www.gnu.org/software/gnutls/}.
17101 @vindex imap-gssapi-program
17102 This parameter specifies a list of command lines that invoke a GSSAPI
17103 authenticated @acronym{IMAP} stream in a subshell. They are tried
17104 sequentially until a connection is made, or the list has been
17105 exhausted. By default, @samp{gsasl} from GNU SASL, available from
17106 @uref{http://www.gnu.org/software/gsasl/}, and the @samp{imtest}
17107 program from Cyrus IMAPD (see @code{imap-kerberos4-program}), are
17110 @vindex imap-ssl-program
17111 For @acronym{SSL} connections, the OpenSSL program is available from
17112 @uref{http://www.openssl.org/}. OpenSSL was formerly known as SSLeay,
17113 and nnimap support it too---although the most recent versions of
17114 SSLeay, 0.9.x, are known to have serious bugs making it
17115 useless. Earlier versions, especially 0.8.x, of SSLeay are known to
17116 work. The variable @code{imap-ssl-program} contain parameters to pass
17119 @vindex imap-shell-program
17120 @vindex imap-shell-host
17121 For @acronym{IMAP} connections using the @code{shell} stream, the
17122 variable @code{imap-shell-program} specify what program to call. Make
17123 sure nothing is interfering with the output of the program, e.g., don't
17124 forget to redirect the error output to the void.
17126 @item nnimap-authenticator
17127 @vindex nnimap-authenticator
17129 The authenticator used to connect to the server. By default, nnimap
17130 will use the most secure authenticator your server is capable of.
17132 Example server specification:
17135 (nnimap "mail.server.com"
17136 (nnimap-authenticator anonymous))
17139 Please note that the value of @code{nnimap-authenticator} is a symbol!
17143 @dfn{gssapi:} GSSAPI (usually kerberos 5) authentication. Requires
17144 external program @code{gsasl} or @code{imtest}.
17146 @dfn{kerberos4:} Kerberos 4 authentication. Requires external program
17149 @dfn{digest-md5:} Encrypted username/password via DIGEST-MD5. Requires
17150 external library @code{digest-md5.el}.
17152 @dfn{cram-md5:} Encrypted username/password via CRAM-MD5.
17154 @dfn{login:} Plain-text username/password via LOGIN.
17156 @dfn{anonymous:} Login as ``anonymous'', supplying your email address as password.
17159 @item nnimap-expunge-on-close
17161 @vindex nnimap-expunge-on-close
17162 Unlike Parmenides the @acronym{IMAP} designers have decided things that
17163 don't exist actually do exist. More specifically, @acronym{IMAP} has
17164 this concept of marking articles @code{Deleted} which doesn't actually
17165 delete them, and this (marking them @code{Deleted}, that is) is what
17166 nnimap does when you delete an article in Gnus (with @kbd{B DEL} or
17169 Since the articles aren't really removed when we mark them with the
17170 @code{Deleted} flag we'll need a way to actually delete them. Feel like
17171 running in circles yet?
17173 Traditionally, nnimap has removed all articles marked as @code{Deleted}
17174 when closing a mailbox but this is now configurable by this server
17177 The possible options are:
17182 The default behavior, delete all articles marked as ``Deleted'' when
17185 Never actually delete articles. Currently there is no way of showing
17186 the articles marked for deletion in nnimap, but other @acronym{IMAP} clients
17187 may allow you to do this. If you ever want to run the EXPUNGE command
17188 manually, @xref{Expunging mailboxes}.
17190 When closing mailboxes, nnimap will ask if you wish to expunge deleted
17195 @item nnimap-importantize-dormant
17196 @vindex nnimap-importantize-dormant
17198 If non-@code{nil} (the default), marks dormant articles as ticked (as
17199 well), for other @acronym{IMAP} clients. Within Gnus, dormant articles will
17200 naturally still (only) be marked as dormant. This is to make dormant
17201 articles stand out, just like ticked articles, in other @acronym{IMAP}
17202 clients. (In other words, Gnus has two ``Tick'' marks and @acronym{IMAP}
17205 Probably the only reason for frobbing this would be if you're trying
17206 enable per-user persistent dormant flags, using something like:
17209 (setcdr (assq 'dormant nnimap-mark-to-flag-alist)
17210 (format "gnus-dormant-%s" (user-login-name)))
17211 (setcdr (assq 'dormant nnimap-mark-to-predicate-alist)
17212 (format "KEYWORD gnus-dormant-%s" (user-login-name)))
17215 In this case, you would not want the per-user dormant flag showing up
17216 as ticked for other users.
17218 @item nnimap-expunge-search-string
17220 @vindex nnimap-expunge-search-string
17221 @cindex expiring @acronym{IMAP} mail
17223 This variable contain the @acronym{IMAP} search command sent to server when
17224 searching for articles eligible for expiring. The default is
17225 @code{"UID %s NOT SINCE %s"}, where the first @code{%s} is replaced by
17226 UID set and the second @code{%s} is replaced by a date.
17228 Probably the only useful value to change this to is
17229 @code{"UID %s NOT SENTSINCE %s"}, which makes nnimap use the Date: in
17230 messages instead of the internal article date. See section 6.4.4 of
17231 RFC 2060 for more information on valid strings.
17233 However, if @code{nnimap-search-uids-not-since-is-evil}
17234 is true, this variable has no effect since the search logic
17235 is reversed, as described below.
17237 @item nnimap-authinfo-file
17238 @vindex nnimap-authinfo-file
17240 A file containing credentials used to log in on servers. The format is
17241 (almost) the same as the @code{ftp} @file{~/.netrc} file. See the
17242 variable @code{nntp-authinfo-file} for exact syntax; also see
17243 @ref{NNTP}. An example of an .authinfo line for an IMAP server, is:
17246 machine students.uio.no login larsi password geheimnis port imap
17249 Note that it should be @code{port imap}, or @code{port 143}, if you
17250 use a @code{nnimap-stream} of @code{tls} or @code{ssl}, even if the
17251 actual port number used is port 993 for secured IMAP. For
17252 convenience, Gnus will accept @code{port imaps} as a synonym of
17255 @item nnimap-need-unselect-to-notice-new-mail
17256 @vindex nnimap-need-unselect-to-notice-new-mail
17258 Unselect mailboxes before looking for new mail in them. Some servers
17259 seem to need this under some circumstances; it was reported that
17262 @item nnimap-nov-is-evil
17263 @vindex nnimap-nov-is-evil
17264 @cindex Courier @acronym{IMAP} server
17265 @cindex @acronym{NOV}
17267 Never generate or use a local @acronym{NOV} database. Defaults to the
17268 value of @code{gnus-agent}.
17270 Using a @acronym{NOV} database usually makes header fetching much
17271 faster, but it uses the @code{UID SEARCH UID} command, which is very
17272 slow on some servers (notably some versions of Courier). Since the Gnus
17273 Agent caches the information in the @acronym{NOV} database without using
17274 the slow command, this variable defaults to true if the Agent is in use,
17275 and false otherwise.
17277 @item nnimap-search-uids-not-since-is-evil
17278 @vindex nnimap-search-uids-not-since-is-evil
17279 @cindex Courier @acronym{IMAP} server
17280 @cindex expiring @acronym{IMAP} mail
17282 Avoid the @code{UID SEARCH UID @var{message numbers} NOT SINCE
17283 @var{date}} command, which is slow on some @acronym{IMAP} servers
17284 (notably, some versions of Courier). Instead, use @code{UID SEARCH SINCE
17285 @var{date}} and prune the list of expirable articles within Gnus.
17287 When Gnus expires your mail (@pxref{Expiring Mail}), it starts with a
17288 list of expirable articles and asks the IMAP server questions like ``Of
17289 these articles, which ones are older than a week?'' While this seems
17290 like a perfectly reasonable question, some IMAP servers take a long time
17291 to answer it, since they seemingly go looking into every old article to
17292 see if it is one of the expirable ones. Curiously, the question ``Of
17293 @emph{all} articles, which ones are newer than a week?'' seems to be
17294 much faster to answer, so setting this variable causes Gnus to ask this
17295 question and figure out the answer to the real question itself.
17297 This problem can really sneak up on you: when you first configure Gnus,
17298 everything works fine, but once you accumulate a couple thousand
17299 messages, you start cursing Gnus for being so slow. On the other hand,
17300 if you get a lot of email within a week, setting this variable will
17301 cause a lot of network traffic between Gnus and the IMAP server.
17303 @item nnimap-logout-timeout
17304 @vindex nnimap-logout-timeout
17306 There is a case where a connection to a @acronym{IMAP} server is unable
17307 to close, when connecting to the server via a certain kind of network,
17308 e.g. @acronym{VPN}. In that case, it will be observed that a connection
17309 between Emacs and the local network looks alive even if the server has
17310 closed a connection for some reason (typically, a timeout).
17311 Consequently, Emacs continues waiting for a response from the server for
17312 the @code{LOGOUT} command that Emacs sent, or hangs in other words. If
17313 you are in such a network, setting this variable to a number of seconds
17314 will be helpful. If it is set, a hung connection will be closed
17315 forcibly, after this number of seconds from the time Emacs sends the
17316 @code{LOGOUT} command. It should not be too small value but too large
17317 value will be inconvenient too. Perhaps the value 1.0 will be a good
17318 candidate but it might be worth trying some other values.
17320 Example server specification:
17323 (nnimap "mail.server.com"
17324 (nnimap-logout-timeout 1.0))
17330 * Splitting in IMAP:: Splitting mail with nnimap.
17331 * Expiring in IMAP:: Expiring mail with nnimap.
17332 * Editing IMAP ACLs:: Limiting/enabling other users access to a mailbox.
17333 * Expunging mailboxes:: Equivalent of a ``compress mailbox'' button.
17334 * A note on namespaces:: How to (not) use @acronym{IMAP} namespace in Gnus.
17335 * Debugging IMAP:: What to do when things don't work.
17340 @node Splitting in IMAP
17341 @subsection Splitting in IMAP
17342 @cindex splitting imap mail
17344 Splitting is something Gnus users have loved and used for years, and now
17345 the rest of the world is catching up. Yeah, dream on, not many
17346 @acronym{IMAP} servers have server side splitting and those that have
17347 splitting seem to use some non-standard protocol. This means that
17348 @acronym{IMAP} support for Gnus has to do its own splitting.
17352 (Incidentally, people seem to have been dreaming on, and Sieve has
17353 gaining a market share and is supported by several IMAP servers.
17354 Fortunately, Gnus support it too, @xref{Sieve Commands}.)
17356 Here are the variables of interest:
17360 @item nnimap-split-crosspost
17361 @cindex splitting, crosspost
17363 @vindex nnimap-split-crosspost
17365 If non-@code{nil}, do crossposting if several split methods match the
17366 mail. If @code{nil}, the first match in @code{nnimap-split-rule}
17367 found will be used.
17369 Nnmail equivalent: @code{nnmail-crosspost}.
17371 @item nnimap-split-inbox
17372 @cindex splitting, inbox
17374 @vindex nnimap-split-inbox
17376 A string or a list of strings that gives the name(s) of @acronym{IMAP}
17377 mailboxes to split from. Defaults to @code{nil}, which means that
17378 splitting is disabled!
17381 (setq nnimap-split-inbox
17382 '("INBOX" ("~/friend/Mail" . "lists/*") "lists.imap"))
17385 No nnmail equivalent.
17387 @item nnimap-split-rule
17388 @cindex splitting, rules
17389 @vindex nnimap-split-rule
17391 New mail found in @code{nnimap-split-inbox} will be split according to
17394 This variable contains a list of lists, where the first element in the
17395 sublist gives the name of the @acronym{IMAP} mailbox to move articles
17396 matching the regexp in the second element in the sublist. Got that?
17397 Neither did I, we need examples.
17400 (setq nnimap-split-rule
17402 "^Sender: owner-nnimap@@vic20.globalcom.se")
17403 ("INBOX.junk" "^Subject:.*MAKE MONEY")
17404 ("INBOX.private" "")))
17407 This will put all articles from the nnimap mailing list into mailbox
17408 INBOX.nnimap, all articles containing MAKE MONEY in the Subject: line
17409 into INBOX.junk and everything else in INBOX.private.
17411 The first string may contain @samp{\\1} forms, like the ones used by
17412 replace-match to insert sub-expressions from the matched text. For
17416 ("INBOX.lists.\\1" "^Sender: owner-\\([a-z-]+\\)@@")
17419 The first element can also be the symbol @code{junk} to indicate that
17420 matching messages should simply be deleted. Use with care.
17422 The second element can also be a function. In that case, it will be
17423 called with the first element of the rule as the argument, in a buffer
17424 containing the headers of the article. It should return a
17425 non-@code{nil} value if it thinks that the mail belongs in that group.
17427 Nnmail users might recollect that the last regexp had to be empty to
17428 match all articles (like in the example above). This is not required in
17429 nnimap. Articles not matching any of the regexps will not be moved out
17430 of your inbox. (This might affect performance if you keep lots of
17431 unread articles in your inbox, since the splitting code would go over
17432 them every time you fetch new mail.)
17434 These rules are processed from the beginning of the alist toward the
17435 end. The first rule to make a match will ``win'', unless you have
17436 crossposting enabled. In that case, all matching rules will ``win''.
17438 This variable can also have a function as its value, the function will
17439 be called with the headers narrowed and should return a group where it
17440 thinks the article should be split to. See @code{nnimap-split-fancy}.
17442 The splitting code tries to create mailboxes if it needs to.
17444 To allow for different split rules on different virtual servers, and
17445 even different split rules in different inboxes on the same server,
17446 the syntax of this variable have been extended along the lines of:
17449 (setq nnimap-split-rule
17450 '(("my1server" (".*" (("ding" "ding@@gnus.org")
17451 ("junk" "From:.*Simon"))))
17452 ("my2server" ("INBOX" nnimap-split-fancy))
17453 ("my[34]server" (".*" (("private" "To:.*Simon")
17454 ("junk" my-junk-func))))))
17457 The virtual server name is in fact a regexp, so that the same rules
17458 may apply to several servers. In the example, the servers
17459 @code{my3server} and @code{my4server} both use the same rules.
17460 Similarly, the inbox string is also a regexp. The actual splitting
17461 rules are as before, either a function, or a list with group/regexp or
17462 group/function elements.
17464 Nnmail equivalent: @code{nnmail-split-methods}.
17466 @item nnimap-split-predicate
17468 @vindex nnimap-split-predicate
17470 Mail matching this predicate in @code{nnimap-split-inbox} will be
17471 split, it is a string and the default is @samp{UNSEEN UNDELETED}.
17473 This might be useful if you use another @acronym{IMAP} client to read mail in
17474 your inbox but would like Gnus to split all articles in the inbox
17475 regardless of readedness. Then you might change this to
17478 @item nnimap-split-fancy
17479 @cindex splitting, fancy
17480 @findex nnimap-split-fancy
17481 @vindex nnimap-split-fancy
17483 It's possible to set @code{nnimap-split-rule} to
17484 @code{nnmail-split-fancy} if you want to use fancy
17485 splitting. @xref{Fancy Mail Splitting}.
17487 However, to be able to have different fancy split rules for nnmail and
17488 nnimap back ends you can set @code{nnimap-split-rule} to
17489 @code{nnimap-split-fancy} and define the nnimap specific fancy split
17490 rule in @code{nnimap-split-fancy}.
17495 (setq nnimap-split-rule 'nnimap-split-fancy
17496 nnimap-split-fancy ...)
17499 Nnmail equivalent: @code{nnmail-split-fancy}.
17501 @item nnimap-split-download-body
17502 @findex nnimap-split-download-body
17503 @vindex nnimap-split-download-body
17505 Set to non-@code{nil} to download entire articles during splitting.
17506 This is generally not required, and will slow things down
17507 considerably. You may need it if you want to use an advanced
17508 splitting function that analyzes the body to split the article.
17512 @node Expiring in IMAP
17513 @subsection Expiring in IMAP
17514 @cindex expiring @acronym{IMAP} mail
17516 Even though @code{nnimap} is not a proper @code{nnmail} derived back
17517 end, it supports most features in regular expiring (@pxref{Expiring
17518 Mail}). Unlike splitting in @acronym{IMAP} (@pxref{Splitting in
17519 IMAP}) it does not clone the @code{nnmail} variables (i.e., creating
17520 @var{nnimap-expiry-wait}) but reuse the @code{nnmail} variables. What
17521 follows below are the variables used by the @code{nnimap} expiry
17524 A note on how the expire mark is stored on the @acronym{IMAP} server is
17525 appropriate here as well. The expire mark is translated into a
17526 @code{imap} client specific mark, @code{gnus-expire}, and stored on the
17527 message. This means that likely only Gnus will understand and treat
17528 the @code{gnus-expire} mark properly, although other clients may allow
17529 you to view client specific flags on the message. It also means that
17530 your server must support permanent storage of client specific flags on
17531 messages. Most do, fortunately.
17533 If expiring @acronym{IMAP} mail seems very slow, try setting the server
17534 variable @code{nnimap-search-uids-not-since-is-evil}.
17538 @item nnmail-expiry-wait
17539 @item nnmail-expiry-wait-function
17541 These variables are fully supported. The expire value can be a
17542 number, the symbol @code{immediate} or @code{never}.
17544 @item nnmail-expiry-target
17546 This variable is supported, and internally implemented by calling the
17547 @code{nnmail} functions that handle this. It contains an optimization
17548 that if the destination is a @acronym{IMAP} group on the same server, the
17549 article is copied instead of appended (that is, uploaded again).
17553 @node Editing IMAP ACLs
17554 @subsection Editing IMAP ACLs
17555 @cindex editing imap acls
17556 @cindex Access Control Lists
17557 @cindex Editing @acronym{IMAP} ACLs
17558 @kindex G l (Group)
17559 @findex gnus-group-nnimap-edit-acl
17561 ACL stands for Access Control List. ACLs are used in @acronym{IMAP} for
17562 limiting (or enabling) other users access to your mail boxes. Not all
17563 @acronym{IMAP} servers support this, this function will give an error if it
17566 To edit an ACL for a mailbox, type @kbd{G l}
17567 (@code{gnus-group-edit-nnimap-acl}) and you'll be presented with an ACL
17568 editing window with detailed instructions.
17570 Some possible uses:
17574 Giving ``anyone'' the ``lrs'' rights (lookup, read, keep seen/unseen flags)
17575 on your mailing list mailboxes enables other users on the same server to
17576 follow the list without subscribing to it.
17578 At least with the Cyrus server, you are required to give the user
17579 ``anyone'' posting ("p") capabilities to have ``plussing'' work (that is,
17580 mail sent to user+mailbox@@domain ending up in the @acronym{IMAP} mailbox
17584 @node Expunging mailboxes
17585 @subsection Expunging mailboxes
17589 @cindex manual expunging
17590 @kindex G x (Group)
17591 @findex gnus-group-nnimap-expunge
17593 If you're using the @code{never} setting of @code{nnimap-expunge-on-close},
17594 you may want the option of expunging all deleted articles in a mailbox
17595 manually. This is exactly what @kbd{G x} does.
17597 Currently there is no way of showing deleted articles, you can just
17600 @node A note on namespaces
17601 @subsection A note on namespaces
17602 @cindex IMAP namespace
17605 The @acronym{IMAP} protocol has a concept called namespaces, described
17606 by the following text in the RFC2060:
17609 5.1.2. Mailbox Namespace Naming Convention
17611 By convention, the first hierarchical element of any mailbox name
17612 which begins with "#" identifies the "namespace" of the remainder of
17613 the name. This makes it possible to disambiguate between different
17614 types of mailbox stores, each of which have their own namespaces.
17616 For example, implementations which offer access to USENET
17617 newsgroups MAY use the "#news" namespace to partition the USENET
17618 newsgroup namespace from that of other mailboxes. Thus, the
17619 comp.mail.misc newsgroup would have an mailbox name of
17620 "#news.comp.mail.misc", and the name "comp.mail.misc" could refer
17621 to a different object (e.g. a user's private mailbox).
17624 While there is nothing in this text that warrants concern for the
17625 @acronym{IMAP} implementation in Gnus, some servers use namespace
17626 prefixes in a way that does not work with how Gnus uses mailbox names.
17628 Specifically, University of Washington's @acronym{IMAP} server uses
17629 mailbox names like @code{#driver.mbx/read-mail} which are valid only
17630 in the @sc{create} and @sc{append} commands. After the mailbox is
17631 created (or a messages is appended to a mailbox), it must be accessed
17632 without the namespace prefix, i.e. @code{read-mail}. Since Gnus do
17633 not make it possible for the user to guarantee that user entered
17634 mailbox names will only be used with the CREATE and APPEND commands,
17635 you should simply not use the namespace prefixed mailbox names in
17638 See the UoW IMAPD documentation for the @code{#driver.*/} prefix
17639 for more information on how to use the prefixes. They are a power
17640 tool and should be used only if you are sure what the effects are.
17642 @node Debugging IMAP
17643 @subsection Debugging IMAP
17644 @cindex IMAP debugging
17645 @cindex protocol dump (IMAP)
17647 @acronym{IMAP} is a complex protocol, more so than @acronym{NNTP} or
17648 @acronym{POP3}. Implementation bugs are not unlikely, and we do our
17649 best to fix them right away. If you encounter odd behavior, chances
17650 are that either the server or Gnus is buggy.
17652 If you are familiar with network protocols in general, you will
17653 probably be able to extract some clues from the protocol dump of the
17654 exchanges between Gnus and the server. Even if you are not familiar
17655 with network protocols, when you include the protocol dump in
17656 @acronym{IMAP}-related bug reports you are helping us with data
17657 critical to solving the problem. Therefore, we strongly encourage you
17658 to include the protocol dump when reporting IMAP bugs in Gnus.
17662 Because the protocol dump, when enabled, generates lots of data, it is
17663 disabled by default. You can enable it by setting @code{imap-log} as
17670 This instructs the @code{imap.el} package to log any exchanges with
17671 the server. The log is stored in the buffer @samp{*imap-log*}. Look
17672 for error messages, which sometimes are tagged with the keyword
17673 @code{BAD}---but when submitting a bug, make sure to include all the
17676 @node Other Sources
17677 @section Other Sources
17679 Gnus can do more than just read news or mail. The methods described
17680 below allow Gnus to view directories and files as if they were
17684 * Directory Groups:: You can read a directory as if it was a newsgroup.
17685 * Anything Groups:: Dired? Who needs dired?
17686 * Document Groups:: Single files can be the basis of a group.
17687 * SOUP:: Reading @sc{soup} packets ``offline''.
17688 * Mail-To-News Gateways:: Posting articles via mail-to-news gateways.
17692 @node Directory Groups
17693 @subsection Directory Groups
17695 @cindex directory groups
17697 If you have a directory that has lots of articles in separate files in
17698 it, you might treat it as a newsgroup. The files have to have numerical
17701 This might be an opportune moment to mention @code{ange-ftp} (and its
17702 successor @code{efs}), that most wonderful of all wonderful Emacs
17703 packages. When I wrote @code{nndir}, I didn't think much about it---a
17704 back end to read directories. Big deal.
17706 @code{ange-ftp} changes that picture dramatically. For instance, if you
17707 enter the @code{ange-ftp} file name
17708 @file{/ftp.hpc.uh.edu:/pub/emacs/ding-list/} as the directory name,
17709 @code{ange-ftp} or @code{efs} will actually allow you to read this
17710 directory over at @samp{sina} as a newsgroup. Distributed news ahoy!
17712 @code{nndir} will use @acronym{NOV} files if they are present.
17714 @code{nndir} is a ``read-only'' back end---you can't delete or expire
17715 articles with this method. You can use @code{nnmh} or @code{nnml} for
17716 whatever you use @code{nndir} for, so you could switch to any of those
17717 methods if you feel the need to have a non-read-only @code{nndir}.
17720 @node Anything Groups
17721 @subsection Anything Groups
17724 From the @code{nndir} back end (which reads a single spool-like
17725 directory), it's just a hop and a skip to @code{nneething}, which
17726 pretends that any arbitrary directory is a newsgroup. Strange, but
17729 When @code{nneething} is presented with a directory, it will scan this
17730 directory and assign article numbers to each file. When you enter such
17731 a group, @code{nneething} must create ``headers'' that Gnus can use.
17732 After all, Gnus is a newsreader, in case you're forgetting.
17733 @code{nneething} does this in a two-step process. First, it snoops each
17734 file in question. If the file looks like an article (i.e., the first
17735 few lines look like headers), it will use this as the head. If this is
17736 just some arbitrary file without a head (e.g. a C source file),
17737 @code{nneething} will cobble up a header out of thin air. It will use
17738 file ownership, name and date and do whatever it can with these
17741 All this should happen automatically for you, and you will be presented
17742 with something that looks very much like a newsgroup. Totally like a
17743 newsgroup, to be precise. If you select an article, it will be displayed
17744 in the article buffer, just as usual.
17746 If you select a line that represents a directory, Gnus will pop you into
17747 a new summary buffer for this @code{nneething} group. And so on. You can
17748 traverse the entire disk this way, if you feel like, but remember that
17749 Gnus is not dired, really, and does not intend to be, either.
17751 There are two overall modes to this action---ephemeral or solid. When
17752 doing the ephemeral thing (i.e., @kbd{G D} from the group buffer), Gnus
17753 will not store information on what files you have read, and what files
17754 are new, and so on. If you create a solid @code{nneething} group the
17755 normal way with @kbd{G m}, Gnus will store a mapping table between
17756 article numbers and file names, and you can treat this group like any
17757 other groups. When you activate a solid @code{nneething} group, you will
17758 be told how many unread articles it contains, etc., etc.
17763 @item nneething-map-file-directory
17764 @vindex nneething-map-file-directory
17765 All the mapping files for solid @code{nneething} groups will be stored
17766 in this directory, which defaults to @file{~/.nneething/}.
17768 @item nneething-exclude-files
17769 @vindex nneething-exclude-files
17770 All files that match this regexp will be ignored. Nice to use to exclude
17771 auto-save files and the like, which is what it does by default.
17773 @item nneething-include-files
17774 @vindex nneething-include-files
17775 Regexp saying what files to include in the group. If this variable is
17776 non-@code{nil}, only files matching this regexp will be included.
17778 @item nneething-map-file
17779 @vindex nneething-map-file
17780 Name of the map files.
17784 @node Document Groups
17785 @subsection Document Groups
17787 @cindex documentation group
17790 @code{nndoc} is a cute little thing that will let you read a single file
17791 as a newsgroup. Several files types are supported:
17797 The Babyl (Rmail) mail box.
17802 The standard Unix mbox file.
17804 @cindex MMDF mail box
17806 The MMDF mail box format.
17809 Several news articles appended into a file.
17811 @cindex rnews batch files
17813 The rnews batch transport format.
17816 Netscape mail boxes.
17819 @acronym{MIME} multipart messages.
17821 @item standard-digest
17822 The standard (RFC 1153) digest format.
17825 A @acronym{MIME} digest of messages.
17827 @item lanl-gov-announce
17828 Announcement messages from LANL Gov Announce.
17830 @cindex forwarded messages
17831 @item rfc822-forward
17832 A message forwarded according to RFC822.
17835 The Outlook mail box.
17838 The Outlook Express dbx mail box.
17841 A bounce message from the Exim MTA.
17844 A message forwarded according to informal rules.
17847 An RFC934-forwarded message.
17853 A digest of Clarinet brief news items.
17856 Non-standard digest format---matches most things, but does it badly.
17862 You can also use the special ``file type'' @code{guess}, which means
17863 that @code{nndoc} will try to guess what file type it is looking at.
17864 @code{digest} means that @code{nndoc} should guess what digest type the
17867 @code{nndoc} will not try to change the file or insert any extra headers into
17868 it---it will simply, like, let you use the file as the basis for a
17869 group. And that's it.
17871 If you have some old archived articles that you want to insert into your
17872 new & spiffy Gnus mail back end, @code{nndoc} can probably help you with
17873 that. Say you have an old @file{RMAIL} file with mail that you now want
17874 to split into your new @code{nnml} groups. You look at that file using
17875 @code{nndoc} (using the @kbd{G f} command in the group buffer
17876 (@pxref{Foreign Groups})), set the process mark on all the articles in
17877 the buffer (@kbd{M P b}, for instance), and then re-spool (@kbd{B r})
17878 using @code{nnml}. If all goes well, all the mail in the @file{RMAIL}
17879 file is now also stored in lots of @code{nnml} directories, and you can
17880 delete that pesky @file{RMAIL} file. If you have the guts!
17882 Virtual server variables:
17885 @item nndoc-article-type
17886 @vindex nndoc-article-type
17887 This should be one of @code{mbox}, @code{babyl}, @code{digest},
17888 @code{news}, @code{rnews}, @code{mmdf}, @code{forward}, @code{rfc934},
17889 @code{rfc822-forward}, @code{mime-parts}, @code{standard-digest},
17890 @code{slack-digest}, @code{clari-briefs}, @code{nsmail}, @code{outlook},
17891 @code{oe-dbx}, @code{mailman}, and @code{mail-in-mail} or @code{guess}.
17893 @item nndoc-post-type
17894 @vindex nndoc-post-type
17895 This variable says whether Gnus is to consider the group a news group or
17896 a mail group. There are two valid values: @code{mail} (the default)
17901 * Document Server Internals:: How to add your own document types.
17905 @node Document Server Internals
17906 @subsubsection Document Server Internals
17908 Adding new document types to be recognized by @code{nndoc} isn't
17909 difficult. You just have to whip up a definition of what the document
17910 looks like, write a predicate function to recognize that document type,
17911 and then hook into @code{nndoc}.
17913 First, here's an example document type definition:
17917 (article-begin . "^\^A\^A\^A\^A\n")
17918 (body-end . "^\^A\^A\^A\^A\n"))
17921 The definition is simply a unique @dfn{name} followed by a series of
17922 regexp pseudo-variable settings. Below are the possible
17923 variables---don't be daunted by the number of variables; most document
17924 types can be defined with very few settings:
17927 @item first-article
17928 If present, @code{nndoc} will skip past all text until it finds
17929 something that match this regexp. All text before this will be
17932 @item article-begin
17933 This setting has to be present in all document type definitions. It
17934 says what the beginning of each article looks like. To do more
17935 complicated things that cannot be dealt with a simple regexp, you can
17936 use @code{article-begin-function} instead of this.
17938 @item article-begin-function
17939 If present, this should be a function that moves point to the beginning
17940 of each article. This setting overrides @code{article-begin}.
17943 If present, this should be a regexp that matches the head of the
17944 article. To do more complicated things that cannot be dealt with a
17945 simple regexp, you can use @code{head-begin-function} instead of this.
17947 @item head-begin-function
17948 If present, this should be a function that moves point to the head of
17949 the article. This setting overrides @code{head-begin}.
17952 This should match the end of the head of the article. It defaults to
17953 @samp{^$}---the empty line.
17956 This should match the beginning of the body of the article. It defaults
17957 to @samp{^\n}. To do more complicated things that cannot be dealt with
17958 a simple regexp, you can use @code{body-begin-function} instead of this.
17960 @item body-begin-function
17961 If present, this function should move point to the beginning of the body
17962 of the article. This setting overrides @code{body-begin}.
17965 If present, this should match the end of the body of the article. To do
17966 more complicated things that cannot be dealt with a simple regexp, you
17967 can use @code{body-end-function} instead of this.
17969 @item body-end-function
17970 If present, this function should move point to the end of the body of
17971 the article. This setting overrides @code{body-end}.
17974 If present, this should match the beginning of the file. All text
17975 before this regexp will be totally ignored.
17978 If present, this should match the end of the file. All text after this
17979 regexp will be totally ignored.
17983 So, using these variables @code{nndoc} is able to dissect a document
17984 file into a series of articles, each with a head and a body. However, a
17985 few more variables are needed since not all document types are all that
17986 news-like---variables needed to transform the head or the body into
17987 something that's palatable for Gnus:
17990 @item prepare-body-function
17991 If present, this function will be called when requesting an article. It
17992 will be called with point at the start of the body, and is useful if the
17993 document has encoded some parts of its contents.
17995 @item article-transform-function
17996 If present, this function is called when requesting an article. It's
17997 meant to be used for more wide-ranging transformation of both head and
17998 body of the article.
18000 @item generate-head-function
18001 If present, this function is called to generate a head that Gnus can
18002 understand. It is called with the article number as a parameter, and is
18003 expected to generate a nice head for the article in question. It is
18004 called when requesting the headers of all articles.
18006 @item generate-article-function
18007 If present, this function is called to generate an entire article that
18008 Gnus can understand. It is called with the article number as a
18009 parameter when requesting all articles.
18011 @item dissection-function
18012 If present, this function is called to dissect a document by itself,
18013 overriding @code{first-article}, @code{article-begin},
18014 @code{article-begin-function}, @code{head-begin},
18015 @code{head-begin-function}, @code{head-end}, @code{body-begin},
18016 @code{body-begin-function}, @code{body-end}, @code{body-end-function},
18017 @code{file-begin}, and @code{file-end}.
18021 Let's look at the most complicated example I can come up with---standard
18026 (first-article . ,(concat "^" (make-string 70 ?-) "\n\n+"))
18027 (article-begin . ,(concat "\n\n" (make-string 30 ?-) "\n\n+"))
18028 (prepare-body-function . nndoc-unquote-dashes)
18029 (body-end-function . nndoc-digest-body-end)
18030 (head-end . "^ ?$")
18031 (body-begin . "^ ?\n")
18032 (file-end . "^End of .*digest.*[0-9].*\n\\*\\*\\|^End of.*Digest *$")
18033 (subtype digest guess))
18036 We see that all text before a 70-width line of dashes is ignored; all
18037 text after a line that starts with that @samp{^End of} is also ignored;
18038 each article begins with a 30-width line of dashes; the line separating
18039 the head from the body may contain a single space; and that the body is
18040 run through @code{nndoc-unquote-dashes} before being delivered.
18042 To hook your own document definition into @code{nndoc}, use the
18043 @code{nndoc-add-type} function. It takes two parameters---the first
18044 is the definition itself and the second (optional) parameter says
18045 where in the document type definition alist to put this definition.
18046 The alist is traversed sequentially, and
18047 @code{nndoc-@var{type}-type-p} is called for a given type @var{type}.
18048 So @code{nndoc-mmdf-type-p} is called to see whether a document is of
18049 @code{mmdf} type, and so on. These type predicates should return
18050 @code{nil} if the document is not of the correct type; @code{t} if it
18051 is of the correct type; and a number if the document might be of the
18052 correct type. A high number means high probability; a low number
18053 means low probability with @samp{0} being the lowest valid number.
18061 In the PC world people often talk about ``offline'' newsreaders. These
18062 are thingies that are combined reader/news transport monstrosities.
18063 With built-in modem programs. Yecchh!
18065 Of course, us Unix Weenie types of human beans use things like
18066 @code{uucp} and, like, @code{nntpd} and set up proper news and mail
18067 transport things like Ghod intended. And then we just use normal
18070 However, it can sometimes be convenient to do something that's a bit
18071 easier on the brain if you have a very slow modem, and you're not really
18072 that interested in doing things properly.
18074 A file format called @sc{soup} has been developed for transporting news
18075 and mail from servers to home machines and back again. It can be a bit
18078 First some terminology:
18083 This is the machine that is connected to the outside world and where you
18084 get news and/or mail from.
18087 This is the machine that you want to do the actual reading and responding
18088 on. It is typically not connected to the rest of the world in any way.
18091 Something that contains messages and/or commands. There are two kinds
18095 @item message packets
18096 These are packets made at the server, and typically contain lots of
18097 messages for you to read. These are called @file{SoupoutX.tgz} by
18098 default, where @var{x} is a number.
18100 @item response packets
18101 These are packets made at the home machine, and typically contains
18102 replies that you've written. These are called @file{SoupinX.tgz} by
18103 default, where @var{x} is a number.
18113 You log in on the server and create a @sc{soup} packet. You can either
18114 use a dedicated @sc{soup} thingie (like the @code{awk} program), or you
18115 can use Gnus to create the packet with its @sc{soup} commands (@kbd{O
18116 s} and/or @kbd{G s b}; and then @kbd{G s p}) (@pxref{SOUP Commands}).
18119 You transfer the packet home. Rail, boat, car or modem will do fine.
18122 You put the packet in your home directory.
18125 You fire up Gnus on your home machine using the @code{nnsoup} back end as
18126 the native or secondary server.
18129 You read articles and mail and answer and followup to the things you
18130 want (@pxref{SOUP Replies}).
18133 You do the @kbd{G s r} command to pack these replies into a @sc{soup}
18137 You transfer this packet to the server.
18140 You use Gnus to mail this packet out with the @kbd{G s s} command.
18143 You then repeat until you die.
18147 So you basically have a bipartite system---you use @code{nnsoup} for
18148 reading and Gnus for packing/sending these @sc{soup} packets.
18151 * SOUP Commands:: Commands for creating and sending @sc{soup} packets
18152 * SOUP Groups:: A back end for reading @sc{soup} packets.
18153 * SOUP Replies:: How to enable @code{nnsoup} to take over mail and news.
18157 @node SOUP Commands
18158 @subsubsection SOUP Commands
18160 These are commands for creating and manipulating @sc{soup} packets.
18164 @kindex G s b (Group)
18165 @findex gnus-group-brew-soup
18166 Pack all unread articles in the current group
18167 (@code{gnus-group-brew-soup}). This command understands the
18168 process/prefix convention.
18171 @kindex G s w (Group)
18172 @findex gnus-soup-save-areas
18173 Save all @sc{soup} data files (@code{gnus-soup-save-areas}).
18176 @kindex G s s (Group)
18177 @findex gnus-soup-send-replies
18178 Send all replies from the replies packet
18179 (@code{gnus-soup-send-replies}).
18182 @kindex G s p (Group)
18183 @findex gnus-soup-pack-packet
18184 Pack all files into a @sc{soup} packet (@code{gnus-soup-pack-packet}).
18187 @kindex G s r (Group)
18188 @findex nnsoup-pack-replies
18189 Pack all replies into a replies packet (@code{nnsoup-pack-replies}).
18192 @kindex O s (Summary)
18193 @findex gnus-soup-add-article
18194 This summary-mode command adds the current article to a @sc{soup} packet
18195 (@code{gnus-soup-add-article}). It understands the process/prefix
18196 convention (@pxref{Process/Prefix}).
18201 There are a few variables to customize where Gnus will put all these
18206 @item gnus-soup-directory
18207 @vindex gnus-soup-directory
18208 Directory where Gnus will save intermediate files while composing
18209 @sc{soup} packets. The default is @file{~/SoupBrew/}.
18211 @item gnus-soup-replies-directory
18212 @vindex gnus-soup-replies-directory
18213 This is what Gnus will use as a temporary directory while sending our
18214 reply packets. @file{~/SoupBrew/SoupReplies/} is the default.
18216 @item gnus-soup-prefix-file
18217 @vindex gnus-soup-prefix-file
18218 Name of the file where Gnus stores the last used prefix. The default is
18219 @samp{gnus-prefix}.
18221 @item gnus-soup-packer
18222 @vindex gnus-soup-packer
18223 A format string command for packing a @sc{soup} packet. The default is
18224 @samp{tar cf - %s | gzip > $HOME/Soupout%d.tgz}.
18226 @item gnus-soup-unpacker
18227 @vindex gnus-soup-unpacker
18228 Format string command for unpacking a @sc{soup} packet. The default is
18229 @samp{gunzip -c %s | tar xvf -}.
18231 @item gnus-soup-packet-directory
18232 @vindex gnus-soup-packet-directory
18233 Where Gnus will look for reply packets. The default is @file{~/}.
18235 @item gnus-soup-packet-regexp
18236 @vindex gnus-soup-packet-regexp
18237 Regular expression matching @sc{soup} reply packets in
18238 @code{gnus-soup-packet-directory}.
18244 @subsubsection SOUP Groups
18247 @code{nnsoup} is the back end for reading @sc{soup} packets. It will
18248 read incoming packets, unpack them, and put them in a directory where
18249 you can read them at leisure.
18251 These are the variables you can use to customize its behavior:
18255 @item nnsoup-tmp-directory
18256 @vindex nnsoup-tmp-directory
18257 When @code{nnsoup} unpacks a @sc{soup} packet, it does it in this
18258 directory. (@file{/tmp/} by default.)
18260 @item nnsoup-directory
18261 @vindex nnsoup-directory
18262 @code{nnsoup} then moves each message and index file to this directory.
18263 The default is @file{~/SOUP/}.
18265 @item nnsoup-replies-directory
18266 @vindex nnsoup-replies-directory
18267 All replies will be stored in this directory before being packed into a
18268 reply packet. The default is @file{~/SOUP/replies/}.
18270 @item nnsoup-replies-format-type
18271 @vindex nnsoup-replies-format-type
18272 The @sc{soup} format of the replies packets. The default is @samp{?n}
18273 (rnews), and I don't think you should touch that variable. I probably
18274 shouldn't even have documented it. Drats! Too late!
18276 @item nnsoup-replies-index-type
18277 @vindex nnsoup-replies-index-type
18278 The index type of the replies packet. The default is @samp{?n}, which
18279 means ``none''. Don't fiddle with this one either!
18281 @item nnsoup-active-file
18282 @vindex nnsoup-active-file
18283 Where @code{nnsoup} stores lots of information. This is not an ``active
18284 file'' in the @code{nntp} sense; it's an Emacs Lisp file. If you lose
18285 this file or mess it up in any way, you're dead. The default is
18286 @file{~/SOUP/active}.
18288 @item nnsoup-packer
18289 @vindex nnsoup-packer
18290 Format string command for packing a reply @sc{soup} packet. The default
18291 is @samp{tar cf - %s | gzip > $HOME/Soupin%d.tgz}.
18293 @item nnsoup-unpacker
18294 @vindex nnsoup-unpacker
18295 Format string command for unpacking incoming @sc{soup} packets. The
18296 default is @samp{gunzip -c %s | tar xvf -}.
18298 @item nnsoup-packet-directory
18299 @vindex nnsoup-packet-directory
18300 Where @code{nnsoup} will look for incoming packets. The default is
18303 @item nnsoup-packet-regexp
18304 @vindex nnsoup-packet-regexp
18305 Regular expression matching incoming @sc{soup} packets. The default is
18308 @item nnsoup-always-save
18309 @vindex nnsoup-always-save
18310 If non-@code{nil}, save the replies buffer after each posted message.
18316 @subsubsection SOUP Replies
18318 Just using @code{nnsoup} won't mean that your postings and mailings end
18319 up in @sc{soup} reply packets automagically. You have to work a bit
18320 more for that to happen.
18322 @findex nnsoup-set-variables
18323 The @code{nnsoup-set-variables} command will set the appropriate
18324 variables to ensure that all your followups and replies end up in the
18327 In specific, this is what it does:
18330 (setq message-send-news-function 'nnsoup-request-post)
18331 (setq message-send-mail-function 'nnsoup-request-mail)
18334 And that's it, really. If you only want news to go into the @sc{soup}
18335 system you just use the first line. If you only want mail to be
18336 @sc{soup}ed you use the second.
18339 @node Mail-To-News Gateways
18340 @subsection Mail-To-News Gateways
18341 @cindex mail-to-news gateways
18344 If your local @code{nntp} server doesn't allow posting, for some reason
18345 or other, you can post using one of the numerous mail-to-news gateways.
18346 The @code{nngateway} back end provides the interface.
18348 Note that you can't read anything from this back end---it can only be
18354 @item nngateway-address
18355 @vindex nngateway-address
18356 This is the address of the mail-to-news gateway.
18358 @item nngateway-header-transformation
18359 @vindex nngateway-header-transformation
18360 News headers often have to be transformed in some odd way or other
18361 for the mail-to-news gateway to accept it. This variable says what
18362 transformation should be called, and defaults to
18363 @code{nngateway-simple-header-transformation}. The function is called
18364 narrowed to the headers to be transformed and with one parameter---the
18367 This default function just inserts a new @code{To} header based on the
18368 @code{Newsgroups} header and the gateway address.
18369 For instance, an article with this @code{Newsgroups} header:
18372 Newsgroups: alt.religion.emacs
18375 will get this @code{To} header inserted:
18378 To: alt-religion-emacs@@GATEWAY
18381 The following pre-defined functions exist:
18383 @findex nngateway-simple-header-transformation
18386 @item nngateway-simple-header-transformation
18387 Creates a @code{To} header that looks like
18388 @var{newsgroup}@@@code{nngateway-address}.
18390 @findex nngateway-mail2news-header-transformation
18392 @item nngateway-mail2news-header-transformation
18393 Creates a @code{To} header that looks like
18394 @code{nngateway-address}.
18402 (setq gnus-post-method
18404 "mail2news@@replay.com"
18405 (nngateway-header-transformation
18406 nngateway-mail2news-header-transformation)))
18409 So, to use this, simply say something like:
18412 (setq gnus-post-method '(nngateway "GATEWAY.ADDRESS"))
18417 @node Combined Groups
18418 @section Combined Groups
18420 Gnus allows combining a mixture of all the other group types into bigger
18424 * Virtual Groups:: Combining articles from many groups.
18425 * Kibozed Groups:: Looking through parts of the newsfeed for articles.
18429 @node Virtual Groups
18430 @subsection Virtual Groups
18432 @cindex virtual groups
18433 @cindex merging groups
18435 An @dfn{nnvirtual group} is really nothing more than a collection of
18438 For instance, if you are tired of reading many small groups, you can
18439 put them all in one big group, and then grow tired of reading one
18440 big, unwieldy group. The joys of computing!
18442 You specify @code{nnvirtual} as the method. The address should be a
18443 regexp to match component groups.
18445 All marks in the virtual group will stick to the articles in the
18446 component groups. So if you tick an article in a virtual group, the
18447 article will also be ticked in the component group from whence it
18448 came. (And vice versa---marks from the component groups will also be
18449 shown in the virtual group.). To create an empty virtual group, run
18450 @kbd{G V} (@code{gnus-group-make-empty-virtual}) in the group buffer
18451 and edit the method regexp with @kbd{M-e}
18452 (@code{gnus-group-edit-group-method})
18454 Here's an example @code{nnvirtual} method that collects all Andrea Dworkin
18455 newsgroups into one, big, happy newsgroup:
18458 (nnvirtual "^alt\\.fan\\.andrea-dworkin$\\|^rec\\.dworkin.*")
18461 The component groups can be native or foreign; everything should work
18462 smoothly, but if your computer explodes, it was probably my fault.
18464 Collecting the same group from several servers might actually be a good
18465 idea if users have set the Distribution header to limit distribution.
18466 If you would like to read @samp{soc.motss} both from a server in Japan
18467 and a server in Norway, you could use the following as the group regexp:
18470 "^nntp\\+server\\.jp:soc\\.motss$\\|^nntp\\+server\\.no:soc\\.motss$"
18473 (Remember, though, that if you're creating the group with @kbd{G m}, you
18474 shouldn't double the backslashes, and you should leave off the quote
18475 characters at the beginning and the end of the string.)
18477 This should work kinda smoothly---all articles from both groups should
18478 end up in this one, and there should be no duplicates. Threading (and
18479 the rest) will still work as usual, but there might be problems with the
18480 sequence of articles. Sorting on date might be an option here
18481 (@pxref{Selecting a Group}).
18483 One limitation, however---all groups included in a virtual
18484 group have to be alive (i.e., subscribed or unsubscribed). Killed or
18485 zombie groups can't be component groups for @code{nnvirtual} groups.
18487 @vindex nnvirtual-always-rescan
18488 If the @code{nnvirtual-always-rescan} variable is non-@code{nil} (which
18489 is the default), @code{nnvirtual} will always scan groups for unread
18490 articles when entering a virtual group. If this variable is @code{nil}
18491 and you read articles in a component group after the virtual group has
18492 been activated, the read articles from the component group will show up
18493 when you enter the virtual group. You'll also see this effect if you
18494 have two virtual groups that have a component group in common. If
18495 that's the case, you should set this variable to @code{t}. Or you can
18496 just tap @code{M-g} on the virtual group every time before you enter
18497 it---it'll have much the same effect.
18499 @code{nnvirtual} can have both mail and news groups as component groups.
18500 When responding to articles in @code{nnvirtual} groups, @code{nnvirtual}
18501 has to ask the back end of the component group the article comes from
18502 whether it is a news or mail back end. However, when you do a @kbd{^},
18503 there is typically no sure way for the component back end to know this,
18504 and in that case @code{nnvirtual} tells Gnus that the article came from a
18505 not-news back end. (Just to be on the safe side.)
18507 @kbd{C-c C-n} in the message buffer will insert the @code{Newsgroups}
18508 line from the article you respond to in these cases.
18510 @code{nnvirtual} groups do not inherit anything but articles and marks
18511 from component groups---group parameters, for instance, are not
18515 @node Kibozed Groups
18516 @subsection Kibozed Groups
18520 @dfn{Kibozing} is defined by the @acronym{OED} as ``grepping through
18521 (parts of) the news feed''. @code{nnkiboze} is a back end that will
18522 do this for you. Oh joy! Now you can grind any @acronym{NNTP} server
18523 down to a halt with useless requests! Oh happiness!
18525 @kindex G k (Group)
18526 To create a kibozed group, use the @kbd{G k} command in the group
18529 The address field of the @code{nnkiboze} method is, as with
18530 @code{nnvirtual}, a regexp to match groups to be ``included'' in the
18531 @code{nnkiboze} group. That's where most similarities between
18532 @code{nnkiboze} and @code{nnvirtual} end.
18534 In addition to this regexp detailing component groups, an
18535 @code{nnkiboze} group must have a score file to say what articles are
18536 to be included in the group (@pxref{Scoring}).
18538 @kindex M-x nnkiboze-generate-groups
18539 @findex nnkiboze-generate-groups
18540 You must run @kbd{M-x nnkiboze-generate-groups} after creating the
18541 @code{nnkiboze} groups you want to have. This command will take time.
18542 Lots of time. Oodles and oodles of time. Gnus has to fetch the
18543 headers from all the articles in all the component groups and run them
18544 through the scoring process to determine if there are any articles in
18545 the groups that are to be part of the @code{nnkiboze} groups.
18547 Please limit the number of component groups by using restrictive
18548 regexps. Otherwise your sysadmin may become annoyed with you, and the
18549 @acronym{NNTP} site may throw you off and never let you back in again.
18550 Stranger things have happened.
18552 @code{nnkiboze} component groups do not have to be alive---they can be dead,
18553 and they can be foreign. No restrictions.
18555 @vindex nnkiboze-directory
18556 The generation of an @code{nnkiboze} group means writing two files in
18557 @code{nnkiboze-directory}, which is @file{~/News/kiboze/} by default.
18558 One contains the @acronym{NOV} header lines for all the articles in
18559 the group, and the other is an additional @file{.newsrc} file to store
18560 information on what groups have been searched through to find
18561 component articles.
18563 Articles marked as read in the @code{nnkiboze} group will have
18564 their @acronym{NOV} lines removed from the @acronym{NOV} file.
18567 @node Email Based Diary
18568 @section Email Based Diary
18570 @cindex email based diary
18573 This section describes a special mail back end called @code{nndiary},
18574 and its companion library @code{gnus-diary}. It is ``special'' in the
18575 sense that it is not meant to be one of the standard alternatives for
18576 reading mail with Gnus. See @ref{Choosing a Mail Back End} for that.
18577 Instead, it is used to treat @emph{some} of your mails in a special way,
18578 namely, as event reminders.
18580 Here is a typical scenario:
18584 You've got a date with Andy Mc Dowell or Bruce Willis (select according
18585 to your sexual preference) in one month. You don't want to forget it.
18587 So you send a ``reminder'' message (actually, a diary one) to yourself.
18589 You forget all about it and keep on getting and reading new mail, as usual.
18591 From time to time, as you type `g' in the group buffer and as the date
18592 is getting closer, the message will pop up again to remind you of your
18593 appointment, just as if it were new and unread.
18595 Read your ``new'' messages, this one included, and start dreaming again
18596 of the night you're gonna have.
18598 Once the date is over (you actually fell asleep just after dinner), the
18599 message will be automatically deleted if it is marked as expirable.
18602 The Gnus Diary back end has the ability to handle regular appointments
18603 (that wouldn't ever be deleted) as well as punctual ones, operates as a
18604 real mail back end and is configurable in many ways. All of this is
18605 explained in the sections below.
18608 * The NNDiary Back End:: Basic setup and usage.
18609 * The Gnus Diary Library:: Utility toolkit on top of nndiary.
18610 * Sending or Not Sending:: A final note on sending diary messages.
18614 @node The NNDiary Back End
18615 @subsection The NNDiary Back End
18617 @cindex the nndiary back end
18619 @code{nndiary} is a back end very similar to @code{nnml} (@pxref{Mail
18620 Spool}). Actually, it could appear as a mix of @code{nnml} and
18621 @code{nndraft}. If you know @code{nnml}, you're already familiar with
18622 the message storing scheme of @code{nndiary}: one file per message, one
18623 directory per group.
18625 Before anything, there is one requirement to be able to run
18626 @code{nndiary} properly: you @emph{must} use the group timestamp feature
18627 of Gnus. This adds a timestamp to each group's parameters. @ref{Group
18628 Timestamp} to see how it's done.
18631 * Diary Messages:: What makes a message valid for nndiary.
18632 * Running NNDiary:: NNDiary has two modes of operation.
18633 * Customizing NNDiary:: Bells and whistles.
18636 @node Diary Messages
18637 @subsubsection Diary Messages
18638 @cindex nndiary messages
18639 @cindex nndiary mails
18641 @code{nndiary} messages are just normal ones, except for the mandatory
18642 presence of 7 special headers. These headers are of the form
18643 @code{X-Diary-<something>}, @code{<something>} being one of
18644 @code{Minute}, @code{Hour}, @code{Dom}, @code{Month}, @code{Year},
18645 @code{Time-Zone} and @code{Dow}. @code{Dom} means ``Day of Month'', and
18646 @code{dow} means ``Day of Week''. These headers actually behave like
18647 crontab specifications and define the event date(s):
18651 For all headers except the @code{Time-Zone} one, a header value is
18652 either a star (meaning all possible values), or a list of fields
18653 (separated by a comma).
18655 A field is either an integer, or a range.
18657 A range is two integers separated by a dash.
18659 Possible integer values are 0--59 for @code{Minute}, 0--23 for
18660 @code{Hour}, 1--31 for @code{Dom}, 1--12 for @code{Month}, above 1971
18661 for @code{Year} and 0--6 for @code{Dow} (0 meaning Sunday).
18663 As a special case, a star in either @code{Dom} or @code{Dow} doesn't
18664 mean ``all possible values'', but ``use only the other field''. Note
18665 that if both are star'ed, the use of either one gives the same result.
18667 The @code{Time-Zone} header is special in that it can only have one
18668 value (@code{GMT}, for instance). A star doesn't mean ``all possible
18669 values'' (because it makes no sense), but ``the current local time
18670 zone''. Most of the time, you'll be using a star here. However, for a
18671 list of available time zone values, see the variable
18672 @code{nndiary-headers}.
18675 As a concrete example, here are the diary headers to add to your message
18676 for specifying ``Each Monday and each 1st of month, at 12:00, 20:00,
18677 21:00, 22:00, 23:00 and 24:00, from 1999 to 2010'' (I'll let you find
18682 X-Diary-Hour: 12, 20-24
18685 X-Diary-Year: 1999-2010
18687 X-Diary-Time-Zone: *
18690 @node Running NNDiary
18691 @subsubsection Running NNDiary
18692 @cindex running nndiary
18693 @cindex nndiary operation modes
18695 @code{nndiary} has two modes of operation: ``traditional'' (the default)
18696 and ``autonomous''. In traditional mode, @code{nndiary} does not get new
18697 mail by itself. You have to move (@kbd{B m}) or copy (@kbd{B c}) mails
18698 from your primary mail back end to nndiary groups in order to handle them
18699 as diary messages. In autonomous mode, @code{nndiary} retrieves its own
18700 mail and handles it independently from your primary mail back end.
18702 One should note that Gnus is not inherently designed to allow several
18703 ``master'' mail back ends at the same time. However, this does make
18704 sense with @code{nndiary}: you really want to send and receive diary
18705 messages to your diary groups directly. So, @code{nndiary} supports
18706 being sort of a ``second primary mail back end'' (to my knowledge, it is
18707 the only back end offering this feature). However, there is a limitation
18708 (which I hope to fix some day): respooling doesn't work in autonomous
18711 In order to use @code{nndiary} in autonomous mode, you have several
18716 Allow @code{nndiary} to retrieve new mail by itself. Put the following
18717 line in your @file{~/.gnus.el} file:
18720 (setq nndiary-get-new-mail t)
18723 You must arrange for diary messages (those containing @code{X-Diary-*}
18724 headers) to be split in a private folder @emph{before} Gnus treat them.
18725 Again, this is needed because Gnus cannot (yet ?) properly handle
18726 multiple primary mail back ends. Getting those messages from a separate
18727 source will compensate this misfeature to some extent.
18729 As an example, here's my procmailrc entry to store diary files in
18730 @file{~/.nndiary} (the default @code{nndiary} mail source file):
18739 Once this is done, you might want to customize the following two options
18740 that affect the diary mail retrieval and splitting processes:
18742 @defvar nndiary-mail-sources
18743 This is the diary-specific replacement for the standard
18744 @code{mail-sources} variable. It obeys the same syntax, and defaults to
18745 @code{(file :path "~/.nndiary")}.
18748 @defvar nndiary-split-methods
18749 This is the diary-specific replacement for the standard
18750 @code{nnmail-split-methods} variable. It obeys the same syntax.
18753 Finally, you may add a permanent @code{nndiary} virtual server
18754 (something like @code{(nndiary "diary")} should do) to your
18755 @code{gnus-secondary-select-methods}.
18757 Hopefully, almost everything (see the TODO section in
18758 @file{nndiary.el}) will work as expected when you restart Gnus: in
18759 autonomous mode, typing @kbd{g} and @kbd{M-g} in the group buffer, will
18760 also get your new diary mails and split them according to your
18761 diary-specific rules, @kbd{F} will find your new diary groups etc.
18763 @node Customizing NNDiary
18764 @subsubsection Customizing NNDiary
18765 @cindex customizing nndiary
18766 @cindex nndiary customization
18768 Now that @code{nndiary} is up and running, it's time to customize it.
18769 The custom group is called @code{nndiary} (no, really ?!). You should
18770 browse it to figure out which options you'd like to tweak. The following
18771 two variables are probably the only ones you will want to change:
18773 @defvar nndiary-reminders
18774 This is the list of times when you want to be reminded of your
18775 appointments (e.g. 3 weeks before, then 2 days before, then 1 hour
18776 before and that's it). Remember that ``being reminded'' means that the
18777 diary message will pop up as brand new and unread again when you get new
18781 @defvar nndiary-week-starts-on-monday
18782 Rather self-explanatory. Otherwise, Sunday is assumed (this is the
18787 @node The Gnus Diary Library
18788 @subsection The Gnus Diary Library
18790 @cindex the gnus diary library
18792 Using @code{nndiary} manually (I mean, writing the headers by hand and
18793 so on) would be rather boring. Fortunately, there is a library called
18794 @code{gnus-diary} written on top of @code{nndiary}, that does many
18795 useful things for you.
18797 In order to use it, add the following line to your @file{~/.gnus.el} file:
18800 (require 'gnus-diary)
18803 Also, you shouldn't use any @code{gnus-user-format-function-[d|D]}
18804 (@pxref{Summary Buffer Lines}). @code{gnus-diary} provides both of these
18805 (sorry if you used them before).
18809 * Diary Summary Line Format:: A nicer summary buffer line format.
18810 * Diary Articles Sorting:: A nicer way to sort messages.
18811 * Diary Headers Generation:: Not doing it manually.
18812 * Diary Group Parameters:: Not handling them manually.
18815 @node Diary Summary Line Format
18816 @subsubsection Diary Summary Line Format
18817 @cindex diary summary buffer line
18818 @cindex diary summary line format
18820 Displaying diary messages in standard summary line format (usually
18821 something like @samp{From Joe: Subject}) is pretty useless. Most of
18822 the time, you're the one who wrote the message, and you mostly want to
18823 see the event's date.
18825 @code{gnus-diary} provides two supplemental user formats to be used in
18826 summary line formats. @code{D} corresponds to a formatted time string
18827 for the next occurrence of the event (e.g. ``Sat, Sep 22 01, 12:00''),
18828 while @code{d} corresponds to an approximative remaining time until the
18829 next occurrence of the event (e.g. ``in 6 months, 1 week'').
18831 For example, here's how Joe's birthday is displayed in my
18832 @code{nndiary+diary:birthdays} summary buffer (note that the message is
18833 expirable, but will never be deleted, as it specifies a periodic event):
18836 E Sat, Sep 22 01, 12:00: Joe's birthday (in 6 months, 1 week)
18839 In order to get something like the above, you would normally add the
18840 following line to your diary groups'parameters:
18843 (gnus-summary-line-format "%U%R%z %uD: %(%s%) (%ud)\n")
18846 However, @code{gnus-diary} does it automatically (@pxref{Diary Group
18847 Parameters}). You can however customize the provided summary line format
18848 with the following user options:
18850 @defvar gnus-diary-summary-line-format
18851 Defines the summary line format used for diary groups (@pxref{Summary
18852 Buffer Lines}). @code{gnus-diary} uses it to automatically update the
18853 diary groups'parameters.
18856 @defvar gnus-diary-time-format
18857 Defines the format to display dates in diary summary buffers. This is
18858 used by the @code{D} user format. See the docstring for details.
18861 @defvar gnus-diary-delay-format-function
18862 Defines the format function to use for displaying delays (remaining
18863 times) in diary summary buffers. This is used by the @code{d} user
18864 format. There are currently built-in functions for English and French;
18865 you can also define your own. See the docstring for details.
18868 @node Diary Articles Sorting
18869 @subsubsection Diary Articles Sorting
18870 @cindex diary articles sorting
18871 @cindex diary summary lines sorting
18872 @findex gnus-summary-sort-by-schedule
18873 @findex gnus-thread-sort-by-schedule
18874 @findex gnus-article-sort-by-schedule
18876 @code{gnus-diary} provides new sorting functions (@pxref{Sorting the
18877 Summary Buffer} ) called @code{gnus-summary-sort-by-schedule},
18878 @code{gnus-thread-sort-by-schedule} and
18879 @code{gnus-article-sort-by-schedule}. These functions let you organize
18880 your diary summary buffers from the closest event to the farthest one.
18882 @code{gnus-diary} automatically installs
18883 @code{gnus-summary-sort-by-schedule} as a menu item in the summary
18884 buffer's ``sort'' menu, and the two others as the primary (hence
18885 default) sorting functions in the group parameters (@pxref{Diary Group
18888 @node Diary Headers Generation
18889 @subsubsection Diary Headers Generation
18890 @cindex diary headers generation
18891 @findex gnus-diary-check-message
18893 @code{gnus-diary} provides a function called
18894 @code{gnus-diary-check-message} to help you handle the @code{X-Diary-*}
18895 headers. This function ensures that the current message contains all the
18896 required diary headers, and prompts you for values or corrections if
18899 This function is hooked into the @code{nndiary} back end, so that
18900 moving or copying an article to a diary group will trigger it
18901 automatically. It is also bound to @kbd{C-c D c} in @code{message-mode}
18902 and @code{article-edit-mode} in order to ease the process of converting
18903 a usual mail to a diary one.
18905 This function takes a prefix argument which will force prompting of
18906 all diary headers, regardless of their presence or validity. That way,
18907 you can very easily reschedule an already valid diary message, for
18910 @node Diary Group Parameters
18911 @subsubsection Diary Group Parameters
18912 @cindex diary group parameters
18914 When you create a new diary group, or visit one, @code{gnus-diary}
18915 automatically checks your group parameters and if needed, sets the
18916 summary line format to the diary-specific value, installs the
18917 diary-specific sorting functions, and also adds the different
18918 @code{X-Diary-*} headers to the group's posting-style. It is then easier
18919 to send a diary message, because if you use @kbd{C-u a} or @kbd{C-u m}
18920 on a diary group to prepare a message, these headers will be inserted
18921 automatically (although not filled with proper values yet).
18923 @node Sending or Not Sending
18924 @subsection Sending or Not Sending
18926 Well, assuming you've read all of the above, here are two final notes on
18927 mail sending with @code{nndiary}:
18931 @code{nndiary} is a @emph{real} mail back end. You really send real diary
18932 messsages for real. This means for instance that you can give
18933 appointments to anybody (provided they use Gnus and @code{nndiary}) by
18934 sending the diary message to them as well.
18936 However, since @code{nndiary} also has a @code{request-post} method, you
18937 can also use @kbd{C-u a} instead of @kbd{C-u m} on a diary group and the
18938 message won't actually be sent; just stored locally in the group. This
18939 comes in very handy for private appointments.
18942 @node Gnus Unplugged
18943 @section Gnus Unplugged
18948 @cindex Gnus unplugged
18950 In olden times (ca. February '88), people used to run their newsreaders
18951 on big machines with permanent connections to the net. News transport
18952 was dealt with by news servers, and all the newsreaders had to do was to
18953 read news. Believe it or not.
18955 Nowadays most people read news and mail at home, and use some sort of
18956 modem to connect to the net. To avoid running up huge phone bills, it
18957 would be nice to have a way to slurp down all the news and mail, hang up
18958 the phone, read for several hours, and then upload any responses you
18959 have to make. And then you repeat the procedure.
18961 Of course, you can use news servers for doing this as well. I've used
18962 @code{inn} together with @code{slurp}, @code{pop} and @code{sendmail}
18963 for some years, but doing that's a bore. Moving the news server
18964 functionality up to the newsreader makes sense if you're the only person
18965 reading news on a machine.
18967 Setting up Gnus as an ``offline'' newsreader is quite simple. In
18968 fact, you don't have to configure anything as the agent is now enabled
18969 by default (@pxref{Agent Variables, gnus-agent}).
18971 Of course, to use it as such, you have to learn a few new commands.
18974 * Agent Basics:: How it all is supposed to work.
18975 * Agent Categories:: How to tell the Gnus Agent what to download.
18976 * Agent Commands:: New commands for all the buffers.
18977 * Agent Visuals:: Ways that the agent may effect your summary buffer.
18978 * Agent as Cache:: The Agent is a big cache too.
18979 * Agent Expiry:: How to make old articles go away.
18980 * Agent Regeneration:: How to recover from lost connections and other accidents.
18981 * Agent and flags:: How the Agent maintains flags.
18982 * Agent and IMAP:: How to use the Agent with @acronym{IMAP}.
18983 * Outgoing Messages:: What happens when you post/mail something?
18984 * Agent Variables:: Customizing is fun.
18985 * Example Setup:: An example @file{~/.gnus.el} file for offline people.
18986 * Batching Agents:: How to fetch news from a @code{cron} job.
18987 * Agent Caveats:: What you think it'll do and what it does.
18992 @subsection Agent Basics
18994 First, let's get some terminology out of the way.
18996 The Gnus Agent is said to be @dfn{unplugged} when you have severed the
18997 connection to the net (and notified the Agent that this is the case).
18998 When the connection to the net is up again (and Gnus knows this), the
18999 Agent is @dfn{plugged}.
19001 The @dfn{local} machine is the one you're running on, and which isn't
19002 connected to the net continuously.
19004 @dfn{Downloading} means fetching things from the net to your local
19005 machine. @dfn{Uploading} is doing the opposite.
19007 You know that Gnus gives you all the opportunity you'd ever want for
19008 shooting yourself in the foot. Some people call it flexibility. Gnus
19009 is also customizable to a great extent, which means that the user has a
19010 say on how Gnus behaves. Other newsreaders might unconditionally shoot
19011 you in your foot, but with Gnus, you have a choice!
19013 Gnus is never really in plugged or unplugged state. Rather, it applies
19014 that state to each server individually. This means that some servers
19015 can be plugged while others can be unplugged. Additionally, some
19016 servers can be ignored by the Agent altogether (which means that
19017 they're kinda like plugged always).
19019 So when you unplug the Agent and then wonder why is Gnus opening a
19020 connection to the Net, the next step to do is to look whether all
19021 servers are agentized. If there is an unagentized server, you found
19024 Another thing is the @dfn{offline} state. Sometimes, servers aren't
19025 reachable. When Gnus notices this, it asks you whether you want the
19026 server to be switched to offline state. If you say yes, then the
19027 server will behave somewhat as if it was unplugged, except that Gnus
19028 will ask you whether you want to switch it back online again.
19030 Let's take a typical Gnus session using the Agent.
19035 @findex gnus-unplugged
19036 You start Gnus with @code{gnus-unplugged}. This brings up the Gnus
19037 Agent in a disconnected state. You can read all the news that you have
19038 already fetched while in this mode.
19041 You then decide to see whether any new news has arrived. You connect
19042 your machine to the net (using PPP or whatever), and then hit @kbd{J j}
19043 to make Gnus become @dfn{plugged} and use @kbd{g} to check for new mail
19044 as usual. To check for new mail in unplugged mode (@pxref{Mail
19045 Source Specifiers}).
19048 You can then read the new news immediately, or you can download the
19049 news onto your local machine. If you want to do the latter, you press
19050 @kbd{g} to check if there are any new news and then @kbd{J s} to fetch
19051 all the eligible articles in all the groups. (To let Gnus know which
19052 articles you want to download, @pxref{Agent Categories}).
19055 After fetching the articles, you press @kbd{J j} to make Gnus become
19056 unplugged again, and you shut down the PPP thing (or whatever). And
19057 then you read the news offline.
19060 And then you go to step 2.
19063 Here are some things you should do the first time (or so) that you use
19069 Decide which servers should be covered by the Agent. If you have a mail
19070 back end, it would probably be nonsensical to have it covered by the
19071 Agent. Go to the server buffer (@kbd{^} in the group buffer) and press
19072 @kbd{J a} on the server (or servers) that you wish to have covered by the
19073 Agent (@pxref{Server Agent Commands}), or @kbd{J r} on automatically
19074 added servers you do not wish to have covered by the Agent. By default,
19075 all @code{nntp} and @code{nnimap} servers in @code{gnus-select-method} and
19076 @code{gnus-secondary-select-methods} are agentized.
19079 Decide on download policy. It's fairly simple once you decide whether
19080 you are going to use agent categories, topic parameters, and/or group
19081 parameters to implement your policy. If you're new to gnus, it
19082 is probably best to start with a category, @xref{Agent Categories}.
19084 Both topic parameters (@pxref{Topic Parameters}) and agent categories
19085 (@pxref{Agent Categories}) provide for setting a policy that applies
19086 to multiple groups. Which you use is entirely up to you. Topic
19087 parameters do override categories so, if you mix the two, you'll have
19088 to take that into account. If you have a few groups that deviate from
19089 your policy, you can use group parameters (@pxref{Group Parameters}) to
19093 Uhm@dots{} that's it.
19097 @node Agent Categories
19098 @subsection Agent Categories
19100 One of the main reasons to integrate the news transport layer into the
19101 newsreader is to allow greater control over what articles to download.
19102 There's not much point in downloading huge amounts of articles, just to
19103 find out that you're not interested in reading any of them. It's better
19104 to be somewhat more conservative in choosing what to download, and then
19105 mark the articles for downloading manually if it should turn out that
19106 you're interested in the articles anyway.
19108 One of the more effective methods for controlling what is to be
19109 downloaded is to create a @dfn{category} and then assign some (or all)
19110 groups to this category. Groups that do not belong in any other
19111 category belong to the @code{default} category. Gnus has its own
19112 buffer for creating and managing categories.
19114 If you prefer, you can also use group parameters (@pxref{Group
19115 Parameters}) and topic parameters (@pxref{Topic Parameters}) for an
19116 alternative approach to controlling the agent. The only real
19117 difference is that categories are specific to the agent (so there is
19118 less to learn) while group and topic parameters include the kitchen
19121 Since you can set agent parameters in several different places we have
19122 a rule to decide which source to believe. This rule specifies that
19123 the parameter sources are checked in the following order: group
19124 parameters, topic parameters, agent category, and finally customizable
19125 variables. So you can mix all of these sources to produce a wide range
19126 of behavior, just don't blame me if you don't remember where you put
19130 * Category Syntax:: What a category looks like.
19131 * Category Buffer:: A buffer for maintaining categories.
19132 * Category Variables:: Customize'r'Us.
19136 @node Category Syntax
19137 @subsubsection Category Syntax
19139 A category consists of a name, the list of groups belonging to the
19140 category, and a number of optional parameters that override the
19141 customizable variables. The complete list of agent parameters are
19144 @cindex Agent Parameters
19147 The list of groups that are in this category.
19149 @item agent-predicate
19150 A predicate which (generally) gives a rough outline of which articles
19151 are eligible for downloading; and
19154 a score rule which (generally) gives you a finer granularity when
19155 deciding what articles to download. (Note that this @dfn{download
19156 score} is not necessarily related to normal scores.)
19158 @item agent-enable-expiration
19159 a boolean indicating whether the agent should expire old articles in
19160 this group. Most groups should be expired to conserve disk space. In
19161 fact, its probably safe to say that the gnus.* hierarchy contains the
19162 only groups that should not be expired.
19164 @item agent-days-until-old
19165 an integer indicating the number of days that the agent should wait
19166 before deciding that a read article is safe to expire.
19168 @item agent-low-score
19169 an integer that overrides the value of @code{gnus-agent-low-score}.
19171 @item agent-high-score
19172 an integer that overrides the value of @code{gnus-agent-high-score}.
19174 @item agent-short-article
19175 an integer that overrides the value of
19176 @code{gnus-agent-short-article}.
19178 @item agent-long-article
19179 an integer that overrides the value of @code{gnus-agent-long-article}.
19181 @item agent-enable-undownloaded-faces
19182 a symbol indicating whether the summary buffer should display
19183 undownloaded articles using the @code{gnus-summary-*-undownloaded-face}
19184 faces. Any symbol other than @code{nil} will enable the use of
19185 undownloaded faces.
19188 The name of a category can not be changed once the category has been
19191 Each category maintains a list of groups that are exclusive members of
19192 that category. The exclusivity rule is automatically enforced, add a
19193 group to a new category and it is automatically removed from its old
19196 A predicate in its simplest form can be a single predicate such as
19197 @code{true} or @code{false}. These two will download every available
19198 article or nothing respectively. In the case of these two special
19199 predicates an additional score rule is superfluous.
19201 Predicates of @code{high} or @code{low} download articles in respect of
19202 their scores in relationship to @code{gnus-agent-high-score} and
19203 @code{gnus-agent-low-score} as described below.
19205 To gain even finer control of what is to be regarded eligible for
19206 download a predicate can consist of a number of predicates with logical
19207 operators sprinkled in between.
19209 Perhaps some examples are in order.
19211 Here's a simple predicate. (It's the default predicate, in fact, used
19212 for all groups that don't belong to any other category.)
19218 Quite simple, eh? This predicate is true if and only if the article is
19219 short (for some value of ``short'').
19221 Here's a more complex predicate:
19230 This means that an article should be downloaded if it has a high score,
19231 or if the score is not low and the article is not long. You get the
19234 The available logical operators are @code{or}, @code{and} and
19235 @code{not}. (If you prefer, you can use the more ``C''-ish operators
19236 @samp{|}, @code{&} and @code{!} instead.)
19238 The following predicates are pre-defined, but if none of these fit what
19239 you want to do, you can write your own.
19241 When evaluating each of these predicates, the named constant will be
19242 bound to the value determined by calling
19243 @code{gnus-agent-find-parameter} on the appropriate parameter. For
19244 example, gnus-agent-short-article will be bound to
19245 @code{(gnus-agent-find-parameter group 'agent-short-article)}. This
19246 means that you can specify a predicate in your category then tune that
19247 predicate to individual groups.
19251 True if the article is shorter than @code{gnus-agent-short-article}
19252 lines; default 100.
19255 True if the article is longer than @code{gnus-agent-long-article}
19256 lines; default 200.
19259 True if the article has a download score less than
19260 @code{gnus-agent-low-score}; default 0.
19263 True if the article has a download score greater than
19264 @code{gnus-agent-high-score}; default 0.
19267 True if the Gnus Agent guesses that the article is spam. The
19268 heuristics may change over time, but at present it just computes a
19269 checksum and sees whether articles match.
19278 If you want to create your own predicate function, here's what you have
19279 to know: The functions are called with no parameters, but the
19280 @code{gnus-headers} and @code{gnus-score} dynamic variables are bound to
19283 For example, you could decide that you don't want to download articles
19284 that were posted more than a certain number of days ago (e.g. posted
19285 more than @code{gnus-agent-expire-days} ago) you might write a function
19286 something along the lines of the following:
19289 (defun my-article-old-p ()
19290 "Say whether an article is old."
19291 (< (time-to-days (date-to-time (mail-header-date gnus-headers)))
19292 (- (time-to-days (current-time)) gnus-agent-expire-days)))
19295 with the predicate then defined as:
19298 (not my-article-old-p)
19301 or you could append your predicate to the predefined
19302 @code{gnus-category-predicate-alist} in your @file{~/.gnus.el} or
19306 (require 'gnus-agent)
19307 (setq gnus-category-predicate-alist
19308 (append gnus-category-predicate-alist
19309 '((old . my-article-old-p))))
19312 and simply specify your predicate as:
19318 If/when using something like the above, be aware that there are many
19319 misconfigured systems/mailers out there and so an article's date is not
19320 always a reliable indication of when it was posted. Hell, some people
19321 just don't give a damn.
19323 The above predicates apply to @emph{all} the groups which belong to the
19324 category. However, if you wish to have a specific predicate for an
19325 individual group within a category, or you're just too lazy to set up a
19326 new category, you can enter a group's individual predicate in its group
19327 parameters like so:
19330 (agent-predicate . short)
19333 This is the group/topic parameter equivalent of the agent category default.
19334 Note that when specifying a single word predicate like this, the
19335 @code{agent-predicate} specification must be in dotted pair notation.
19337 The equivalent of the longer example from above would be:
19340 (agent-predicate or high (and (not low) (not long)))
19343 The outer parenthesis required in the category specification are not
19344 entered here as, not being in dotted pair notation, the value of the
19345 predicate is assumed to be a list.
19348 Now, the syntax of the download score is the same as the syntax of
19349 normal score files, except that all elements that require actually
19350 seeing the article itself are verboten. This means that only the
19351 following headers can be scored on: @code{Subject}, @code{From},
19352 @code{Date}, @code{Message-ID}, @code{References}, @code{Chars},
19353 @code{Lines}, and @code{Xref}.
19355 As with predicates, the specification of the @code{download score rule}
19356 to use in respect of a group can be in either the category definition if
19357 it's to be applicable to all groups in therein, or a group's parameters
19358 if it's to be specific to that group.
19360 In both of these places the @code{download score rule} can take one of
19367 This has the same syntax as a normal Gnus score file except only a
19368 subset of scoring keywords are available as mentioned above.
19374 Category specification
19378 ("Lars Ingebrigtsen" 1000000 nil s))
19384 Group/Topic Parameter specification
19387 (agent-score ("from"
19388 ("Lars Ingebrigtsen" 1000000 nil s))
19393 Again, note the omission of the outermost parenthesis here.
19399 These score files must @emph{only} contain the permitted scoring
19400 keywords stated above.
19406 Category specification
19409 ("~/News/agent.SCORE")
19415 ("~/News/agent.SCORE" "~/News/agent.group.SCORE")
19419 Group Parameter specification
19422 (agent-score "~/News/agent.SCORE")
19425 Additional score files can be specified as above. Need I say anything
19430 Use @code{normal} score files
19432 If you don't want to maintain two sets of scoring rules for a group, and
19433 your desired @code{downloading} criteria for a group are the same as your
19434 @code{reading} criteria then you can tell the agent to refer to your
19435 @code{normal} score files when deciding what to download.
19437 These directives in either the category definition or a group's
19438 parameters will cause the agent to read in all the applicable score
19439 files for a group, @emph{filtering out} those sections that do not
19440 relate to one of the permitted subset of scoring keywords.
19444 Category Specification
19451 Group Parameter specification
19454 (agent-score . file)
19459 @node Category Buffer
19460 @subsubsection Category Buffer
19462 You'd normally do all category maintenance from the category buffer.
19463 When you enter it for the first time (with the @kbd{J c} command from
19464 the group buffer), you'll only see the @code{default} category.
19466 The following commands are available in this buffer:
19470 @kindex q (Category)
19471 @findex gnus-category-exit
19472 Return to the group buffer (@code{gnus-category-exit}).
19475 @kindex e (Category)
19476 @findex gnus-category-customize-category
19477 Use a customization buffer to set all of the selected category's
19478 parameters at one time (@code{gnus-category-customize-category}).
19481 @kindex k (Category)
19482 @findex gnus-category-kill
19483 Kill the current category (@code{gnus-category-kill}).
19486 @kindex c (Category)
19487 @findex gnus-category-copy
19488 Copy the current category (@code{gnus-category-copy}).
19491 @kindex a (Category)
19492 @findex gnus-category-add
19493 Add a new category (@code{gnus-category-add}).
19496 @kindex p (Category)
19497 @findex gnus-category-edit-predicate
19498 Edit the predicate of the current category
19499 (@code{gnus-category-edit-predicate}).
19502 @kindex g (Category)
19503 @findex gnus-category-edit-groups
19504 Edit the list of groups belonging to the current category
19505 (@code{gnus-category-edit-groups}).
19508 @kindex s (Category)
19509 @findex gnus-category-edit-score
19510 Edit the download score rule of the current category
19511 (@code{gnus-category-edit-score}).
19514 @kindex l (Category)
19515 @findex gnus-category-list
19516 List all the categories (@code{gnus-category-list}).
19520 @node Category Variables
19521 @subsubsection Category Variables
19524 @item gnus-category-mode-hook
19525 @vindex gnus-category-mode-hook
19526 Hook run in category buffers.
19528 @item gnus-category-line-format
19529 @vindex gnus-category-line-format
19530 Format of the lines in the category buffer (@pxref{Formatting
19531 Variables}). Valid elements are:
19535 The name of the category.
19538 The number of groups in the category.
19541 @item gnus-category-mode-line-format
19542 @vindex gnus-category-mode-line-format
19543 Format of the category mode line (@pxref{Mode Line Formatting}).
19545 @item gnus-agent-short-article
19546 @vindex gnus-agent-short-article
19547 Articles that have fewer lines than this are short. Default 100.
19549 @item gnus-agent-long-article
19550 @vindex gnus-agent-long-article
19551 Articles that have more lines than this are long. Default 200.
19553 @item gnus-agent-low-score
19554 @vindex gnus-agent-low-score
19555 Articles that have a score lower than this have a low score. Default
19558 @item gnus-agent-high-score
19559 @vindex gnus-agent-high-score
19560 Articles that have a score higher than this have a high score. Default
19563 @item gnus-agent-expire-days
19564 @vindex gnus-agent-expire-days
19565 The number of days that a @samp{read} article must stay in the agent's
19566 local disk before becoming eligible for expiration (While the name is
19567 the same, this doesn't mean expiring the article on the server. It
19568 just means deleting the local copy of the article). What is also
19569 important to understand is that the counter starts with the time the
19570 article was written to the local disk and not the time the article was
19574 @item gnus-agent-enable-expiration
19575 @vindex gnus-agent-enable-expiration
19576 Determines whether articles in a group are, by default, expired or
19577 retained indefinitely. The default is @code{ENABLE} which means that
19578 you'll have to disable expiration when desired. On the other hand,
19579 you could set this to @code{DISABLE}. In that case, you would then
19580 have to enable expiration in selected groups.
19585 @node Agent Commands
19586 @subsection Agent Commands
19587 @findex gnus-agent-toggle-plugged
19588 @kindex J j (Agent)
19590 All the Gnus Agent commands are on the @kbd{J} submap. The @kbd{J j}
19591 (@code{gnus-agent-toggle-plugged}) command works in all modes, and
19592 toggles the plugged/unplugged state of the Gnus Agent.
19596 * Group Agent Commands:: Configure groups and fetch their contents.
19597 * Summary Agent Commands:: Manually select then fetch specific articles.
19598 * Server Agent Commands:: Select the servers that are supported by the agent.
19604 @node Group Agent Commands
19605 @subsubsection Group Agent Commands
19609 @kindex J u (Agent Group)
19610 @findex gnus-agent-fetch-groups
19611 Fetch all eligible articles in the current group
19612 (@code{gnus-agent-fetch-groups}).
19615 @kindex J c (Agent Group)
19616 @findex gnus-enter-category-buffer
19617 Enter the Agent category buffer (@code{gnus-enter-category-buffer}).
19620 @kindex J s (Agent Group)
19621 @findex gnus-agent-fetch-session
19622 Fetch all eligible articles in all groups
19623 (@code{gnus-agent-fetch-session}).
19626 @kindex J S (Agent Group)
19627 @findex gnus-group-send-queue
19628 Send all sendable messages in the queue group
19629 (@code{gnus-group-send-queue}). @xref{Drafts}.
19632 @kindex J a (Agent Group)
19633 @findex gnus-agent-add-group
19634 Add the current group to an Agent category
19635 (@code{gnus-agent-add-group}). This command understands the
19636 process/prefix convention (@pxref{Process/Prefix}).
19639 @kindex J r (Agent Group)
19640 @findex gnus-agent-remove-group
19641 Remove the current group from its category, if any
19642 (@code{gnus-agent-remove-group}). This command understands the
19643 process/prefix convention (@pxref{Process/Prefix}).
19646 @kindex J Y (Agent Group)
19647 @findex gnus-agent-synchronize-flags
19648 Synchronize flags changed while unplugged with remote server, if any.
19654 @node Summary Agent Commands
19655 @subsubsection Summary Agent Commands
19659 @kindex J # (Agent Summary)
19660 @findex gnus-agent-mark-article
19661 Mark the article for downloading (@code{gnus-agent-mark-article}).
19664 @kindex J M-# (Agent Summary)
19665 @findex gnus-agent-unmark-article
19666 Remove the downloading mark from the article
19667 (@code{gnus-agent-unmark-article}).
19671 @kindex @@ (Agent Summary)
19672 @findex gnus-agent-toggle-mark
19673 Toggle whether to download the article
19674 (@code{gnus-agent-toggle-mark}). The download mark is @samp{%} by
19678 @kindex J c (Agent Summary)
19679 @findex gnus-agent-catchup
19680 Mark all articles as read (@code{gnus-agent-catchup}) that are neither cached, downloaded, nor downloadable.
19683 @kindex J S (Agent Summary)
19684 @findex gnus-agent-fetch-group
19685 Download all eligible (@pxref{Agent Categories}) articles in this group.
19686 (@code{gnus-agent-fetch-group}).
19689 @kindex J s (Agent Summary)
19690 @findex gnus-agent-summary-fetch-series
19691 Download all processable articles in this group.
19692 (@code{gnus-agent-summary-fetch-series}).
19695 @kindex J u (Agent Summary)
19696 @findex gnus-agent-summary-fetch-group
19697 Download all downloadable articles in the current group
19698 (@code{gnus-agent-summary-fetch-group}).
19703 @node Server Agent Commands
19704 @subsubsection Server Agent Commands
19708 @kindex J a (Agent Server)
19709 @findex gnus-agent-add-server
19710 Add the current server to the list of servers covered by the Gnus Agent
19711 (@code{gnus-agent-add-server}).
19714 @kindex J r (Agent Server)
19715 @findex gnus-agent-remove-server
19716 Remove the current server from the list of servers covered by the Gnus
19717 Agent (@code{gnus-agent-remove-server}).
19722 @node Agent Visuals
19723 @subsection Agent Visuals
19725 If you open a summary while unplugged and, Gnus knows from the group's
19726 active range that there are more articles than the headers currently
19727 stored in the Agent, you may see some articles whose subject looks
19728 something like @samp{[Undownloaded article #####]}. These are
19729 placeholders for the missing headers. Aside from setting a mark,
19730 there is not much that can be done with one of these placeholders.
19731 When Gnus finally gets a chance to fetch the group's headers, the
19732 placeholders will automatically be replaced by the actual headers.
19733 You can configure the summary buffer's maneuvering to skip over the
19734 placeholders if you care (See @code{gnus-auto-goto-ignores}).
19736 While it may be obvious to all, the only headers and articles
19737 available while unplugged are those headers and articles that were
19738 fetched into the Agent while previously plugged. To put it another
19739 way, ``If you forget to fetch something while plugged, you might have a
19740 less than satisfying unplugged session''. For this reason, the Agent
19741 adds two visual effects to your summary buffer. These effects display
19742 the download status of each article so that you always know which
19743 articles will be available when unplugged.
19745 The first visual effect is the @samp{%O} spec. If you customize
19746 @code{gnus-summary-line-format} to include this specifier, you will add
19747 a single character field that indicates an article's download status.
19748 Articles that have been fetched into either the Agent or the Cache,
19749 will display @code{gnus-downloaded-mark} (defaults to @samp{+}). All
19750 other articles will display @code{gnus-undownloaded-mark} (defaults to
19751 @samp{-}). If you open a group that has not been agentized, a space
19752 (@samp{ }) will be displayed.
19754 The second visual effect are the undownloaded faces. The faces, there
19755 are three indicating the article's score (low, normal, high), seem to
19756 result in a love/hate response from many Gnus users. The problem is
19757 that the face selection is controlled by a list of condition tests and
19758 face names (See @code{gnus-summary-highlight}). Each condition is
19759 tested in the order in which it appears in the list so early
19760 conditions have precedence over later conditions. All of this means
19761 that, if you tick an undownloaded article, the article will continue
19762 to be displayed in the undownloaded face rather than the ticked face.
19764 If you use the Agent as a cache (to avoid downloading the same article
19765 each time you visit it or to minimize your connection time), the
19766 undownloaded face will probably seem like a good idea. The reason
19767 being that you do all of our work (marking, reading, deleting) with
19768 downloaded articles so the normal faces always appear. For those
19769 users using the agent to improve online performance by caching the NOV
19770 database (most users since 5.10.2), the undownloaded faces may appear
19771 to be an absolutely horrible idea. The issue being that, since none
19772 of their articles have been fetched into the Agent, all of the
19773 normal faces will be obscured by the undownloaded faces.
19775 If you would like to use the undownloaded faces, you must enable the
19776 undownloaded faces by setting the @code{agent-enable-undownloaded-faces}
19777 group parameter to @code{t}. This parameter, like all other agent
19778 parameters, may be set on an Agent Category (@pxref{Agent Categories}),
19779 a Group Topic (@pxref{Topic Parameters}), or an individual group
19780 (@pxref{Group Parameters}).
19782 The one problem common to all users using the agent is how quickly it
19783 can consume disk space. If you using the agent on many groups, it is
19784 even more difficult to effectively recover disk space. One solution
19785 is the @samp{%F} format available in @code{gnus-group-line-format}.
19786 This format will display the actual disk space used by articles
19787 fetched into both the agent and cache. By knowing which groups use
19788 the most space, users know where to focus their efforts when ``agent
19789 expiring'' articles.
19791 @node Agent as Cache
19792 @subsection Agent as Cache
19794 When Gnus is plugged, it is not efficient to download headers or
19795 articles from the server again, if they are already stored in the
19796 Agent. So, Gnus normally only downloads headers once, and stores them
19797 in the Agent. These headers are later used when generating the summary
19798 buffer, regardless of whether you are plugged or unplugged. Articles
19799 are not cached in the Agent by default though (that would potentially
19800 consume lots of disk space), but if you have already downloaded an
19801 article into the Agent, Gnus will not download the article from the
19802 server again but use the locally stored copy instead.
19804 If you so desire, you can configure the agent (see @code{gnus-agent-cache}
19805 @pxref{Agent Variables}) to always download headers and articles while
19806 plugged. Gnus will almost certainly be slower, but it will be kept
19807 synchronized with the server. That last point probably won't make any
19808 sense if you are using a nntp or nnimap back end.
19811 @subsection Agent Expiry
19813 @vindex gnus-agent-expire-days
19814 @findex gnus-agent-expire
19815 @kindex M-x gnus-agent-expire
19816 @kindex M-x gnus-agent-expire-group
19817 @findex gnus-agent-expire-group
19818 @cindex agent expiry
19819 @cindex Gnus agent expiry
19820 @cindex expiry, in Gnus agent
19822 The Agent back end, @code{nnagent}, doesn't handle expiry. Well, at
19823 least it doesn't handle it like other back ends. Instead, there are
19824 special @code{gnus-agent-expire} and @code{gnus-agent-expire-group}
19825 commands that will expire all read articles that are older than
19826 @code{gnus-agent-expire-days} days. They can be run whenever you feel
19827 that you're running out of space. Neither are particularly fast or
19828 efficient, and it's not a particularly good idea to interrupt them (with
19829 @kbd{C-g} or anything else) once you've started one of them.
19831 Note that other functions, e.g. @code{gnus-request-expire-articles},
19832 might run @code{gnus-agent-expire} for you to keep the agent
19833 synchronized with the group.
19835 The agent parameter @code{agent-enable-expiration} may be used to
19836 prevent expiration in selected groups.
19838 @vindex gnus-agent-expire-all
19839 If @code{gnus-agent-expire-all} is non-@code{nil}, the agent
19840 expiration commands will expire all articles---unread, read, ticked
19841 and dormant. If @code{nil} (which is the default), only read articles
19842 are eligible for expiry, and unread, ticked and dormant articles will
19843 be kept indefinitely.
19845 If you find that some articles eligible for expiry are never expired,
19846 perhaps some Gnus Agent files are corrupted. There's are special
19847 commands, @code{gnus-agent-regenerate} and
19848 @code{gnus-agent-regenerate-group}, to fix possible problems.
19850 @node Agent Regeneration
19851 @subsection Agent Regeneration
19853 @cindex agent regeneration
19854 @cindex Gnus agent regeneration
19855 @cindex regeneration
19857 The local data structures used by @code{nnagent} may become corrupted
19858 due to certain exceptional conditions. When this happens,
19859 @code{nnagent} functionality may degrade or even fail. The solution
19860 to this problem is to repair the local data structures by removing all
19861 internal inconsistencies.
19863 For example, if your connection to your server is lost while
19864 downloaded articles into the agent, the local data structures will not
19865 know about articles successfully downloaded prior to the connection
19866 failure. Running @code{gnus-agent-regenerate} or
19867 @code{gnus-agent-regenerate-group} will update the data structures
19868 such that you don't need to download these articles a second time.
19870 @findex gnus-agent-regenerate
19871 @kindex M-x gnus-agent-regenerate
19872 The command @code{gnus-agent-regenerate} will perform
19873 @code{gnus-agent-regenerate-group} on every agentized group. While
19874 you can run @code{gnus-agent-regenerate} in any buffer, it is strongly
19875 recommended that you first close all summary buffers.
19877 @findex gnus-agent-regenerate-group
19878 @kindex M-x gnus-agent-regenerate-group
19879 The command @code{gnus-agent-regenerate-group} uses the local copies
19880 of individual articles to repair the local @acronym{NOV}(header) database. It
19881 then updates the internal data structures that document which articles
19882 are stored locally. An optional argument will mark articles in the
19885 @node Agent and flags
19886 @subsection Agent and flags
19888 The Agent works with any Gnus back end including those, such as
19889 nnimap, that store flags (read, ticked, etc) on the server. Sadly,
19890 the Agent does not actually know which backends keep their flags in
19891 the backend server rather than in @file{.newsrc}. This means that the
19892 Agent, while unplugged or disconnected, will always record all changes
19893 to the flags in its own files.
19895 When you plug back in, Gnus will then check to see if you have any
19896 changed any flags and ask if you wish to synchronize these with the
19897 server. This behavior is customizable by @code{gnus-agent-synchronize-flags}.
19899 @vindex gnus-agent-synchronize-flags
19900 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
19901 never automatically synchronize flags. If it is @code{ask}, which is
19902 the default, the Agent will check if you made any changes and if so
19903 ask if you wish to synchronize these when you re-connect. If it has
19904 any other value, all flags will be synchronized automatically.
19906 If you do not wish to synchronize flags automatically when you
19907 re-connect, you can do it manually with the
19908 @code{gnus-agent-synchronize-flags} command that is bound to @kbd{J Y}
19909 in the group buffer.
19911 Technical note: the synchronization algorithm does not work by ``pushing''
19912 all local flags to the server, but rather by incrementally updated the
19913 server view of flags by changing only those flags that were changed by
19914 the user. Thus, if you set one flag on an article, quit the group then
19915 re-select the group and remove the flag; the flag will be set and
19916 removed from the server when you ``synchronize''. The queued flag
19917 operations can be found in the per-server @code{flags} file in the Agent
19918 directory. It's emptied when you synchronize flags.
19920 @node Agent and IMAP
19921 @subsection Agent and IMAP
19923 The Agent works with any Gnus back end, including nnimap. However,
19924 since there are some conceptual differences between @acronym{NNTP} and
19925 @acronym{IMAP}, this section (should) provide you with some information to
19926 make Gnus Agent work smoother as a @acronym{IMAP} Disconnected Mode client.
19928 Some things are currently not implemented in the Agent that you'd might
19929 expect from a disconnected @acronym{IMAP} client, including:
19934 Copying/moving articles into nnimap groups when unplugged.
19937 Creating/deleting nnimap groups when unplugged.
19941 @node Outgoing Messages
19942 @subsection Outgoing Messages
19944 By default, when Gnus is unplugged, all outgoing messages (both mail
19945 and news) are stored in the draft group ``queue'' (@pxref{Drafts}).
19946 You can view them there after posting, and edit them at will.
19948 You can control the circumstances under which outgoing mail is queued
19949 (see @code{gnus-agent-queue-mail}, @pxref{Agent Variables}). Outgoing
19950 news is always queued when Gnus is unplugged, and never otherwise.
19952 You can send the messages either from the draft group with the special
19953 commands available there, or you can use the @kbd{J S} command in the
19954 group buffer to send all the sendable messages in the draft group.
19955 Posting news will only work when Gnus is plugged, but you can send
19958 If sending mail while unplugged does not work for you and you worry
19959 about hitting @kbd{J S} by accident when unplugged, you can have Gnus
19960 ask you to confirm your action (see
19961 @code{gnus-agent-prompt-send-queue}, @pxref{Agent Variables}).
19963 @node Agent Variables
19964 @subsection Agent Variables
19969 Is the agent enabled? The default is @code{t}. When first enabled,
19970 the agent will use @code{gnus-agent-auto-agentize-methods} to
19971 automatically mark some back ends as agentized. You may change which
19972 back ends are agentized using the agent commands in the server buffer.
19974 To enter the server buffer, use the @kbd{^}
19975 (@code{gnus-group-enter-server-mode}) command in the group buffer.
19978 @item gnus-agent-directory
19979 @vindex gnus-agent-directory
19980 Where the Gnus Agent will store its files. The default is
19981 @file{~/News/agent/}.
19983 @item gnus-agent-handle-level
19984 @vindex gnus-agent-handle-level
19985 Groups on levels (@pxref{Group Levels}) higher than this variable will
19986 be ignored by the Agent. The default is @code{gnus-level-subscribed},
19987 which means that only subscribed group will be considered by the Agent
19990 @item gnus-agent-plugged-hook
19991 @vindex gnus-agent-plugged-hook
19992 Hook run when connecting to the network.
19994 @item gnus-agent-unplugged-hook
19995 @vindex gnus-agent-unplugged-hook
19996 Hook run when disconnecting from the network.
19998 @item gnus-agent-fetched-hook
19999 @vindex gnus-agent-fetched-hook
20000 Hook run when finished fetching articles.
20002 @item gnus-agent-cache
20003 @vindex gnus-agent-cache
20004 Variable to control whether use the locally stored @acronym{NOV} and
20005 articles when plugged, e.g. essentially using the Agent as a cache.
20006 The default is non-@code{nil}, which means to use the Agent as a cache.
20008 @item gnus-agent-go-online
20009 @vindex gnus-agent-go-online
20010 If @code{gnus-agent-go-online} is @code{nil}, the Agent will never
20011 automatically switch offline servers into online status. If it is
20012 @code{ask}, the default, the Agent will ask if you wish to switch
20013 offline servers into online status when you re-connect. If it has any
20014 other value, all offline servers will be automatically switched into
20017 @item gnus-agent-mark-unread-after-downloaded
20018 @vindex gnus-agent-mark-unread-after-downloaded
20019 If @code{gnus-agent-mark-unread-after-downloaded} is non-@code{nil},
20020 mark articles as unread after downloading. This is usually a safe
20021 thing to do as the newly downloaded article has obviously not been
20022 read. The default is @code{t}.
20024 @item gnus-agent-synchronize-flags
20025 @vindex gnus-agent-synchronize-flags
20026 If @code{gnus-agent-synchronize-flags} is @code{nil}, the Agent will
20027 never automatically synchronize flags. If it is @code{ask}, which is
20028 the default, the Agent will check if you made any changes and if so
20029 ask if you wish to synchronize these when you re-connect. If it has
20030 any other value, all flags will be synchronized automatically.
20032 @item gnus-agent-consider-all-articles
20033 @vindex gnus-agent-consider-all-articles
20034 If @code{gnus-agent-consider-all-articles} is non-@code{nil}, the
20035 agent will let the agent predicate decide whether articles need to be
20036 downloaded or not, for all articles. When @code{nil}, the default,
20037 the agent will only let the predicate decide whether unread articles
20038 are downloaded or not. If you enable this, you may also want to look
20039 into the agent expiry settings (@pxref{Category Variables}), so that
20040 the agent doesn't download articles which the agent will later expire,
20041 over and over again.
20043 @item gnus-agent-max-fetch-size
20044 @vindex gnus-agent-max-fetch-size
20045 The agent fetches articles into a temporary buffer prior to parsing
20046 them into individual files. To avoid exceeding the max. buffer size,
20047 the agent alternates between fetching and parsing until all articles
20048 have been fetched. @code{gnus-agent-max-fetch-size} provides a size
20049 limit to control how often the cycling occurs. A large value improves
20050 performance. A small value minimizes the time lost should the
20051 connection be lost while fetching (You may need to run
20052 @code{gnus-agent-regenerate-group} to update the group's state.
20053 However, all articles parsed prior to loosing the connection will be
20054 available while unplugged). The default is 10M so it is unusual to
20057 @item gnus-server-unopen-status
20058 @vindex gnus-server-unopen-status
20059 Perhaps not an Agent variable, but closely related to the Agent, this
20060 variable says what will happen if Gnus cannot open a server. If the
20061 Agent is enabled, the default, @code{nil}, makes Gnus ask the user
20062 whether to deny the server or whether to unplug the agent. If the
20063 Agent is disabled, Gnus always simply deny the server. Other choices
20064 for this variable include @code{denied} and @code{offline} the latter
20065 is only valid if the Agent is used.
20067 @item gnus-auto-goto-ignores
20068 @vindex gnus-auto-goto-ignores
20069 Another variable that isn't an Agent variable, yet so closely related
20070 that most will look for it here, this variable tells the summary
20071 buffer how to maneuver around undownloaded (only headers stored in the
20072 agent) and unfetched (neither article nor headers stored) articles.
20074 The valid values are @code{nil} (maneuver to any article),
20075 @code{undownloaded} (maneuvering while unplugged ignores articles that
20076 have not been fetched), @code{always-undownloaded} (maneuvering always
20077 ignores articles that have not been fetched), @code{unfetched}
20078 (maneuvering ignores articles whose headers have not been fetched).
20080 @item gnus-agent-queue-mail
20081 @vindex gnus-agent-queue-mail
20082 When @code{gnus-agent-queue-mail} is @code{always}, Gnus will always
20083 queue mail rather than sending it straight away. When @code{t}, Gnus
20084 will queue mail when unplugged only. When @code{nil}, never queue
20085 mail. The default is @code{t}.
20087 @item gnus-agent-prompt-send-queue
20088 @vindex gnus-agent-prompt-send-queue
20089 When @code{gnus-agent-prompt-send-queue} is non-@code{nil} Gnus will
20090 prompt you to confirm that you really wish to proceed if you hit
20091 @kbd{J S} while unplugged. The default is @code{nil}.
20093 @item gnus-agent-auto-agentize-methods
20094 @vindex gnus-agent-auto-agentize-methods
20095 If you have never used the Agent before (or more technically, if
20096 @file{~/News/agent/lib/servers} does not exist), Gnus will
20097 automatically agentize a few servers for you. This variable control
20098 which back ends should be auto-agentized. It is typically only useful
20099 to agentize remote back ends. The auto-agentizing has the same effect
20100 as running @kbd{J a} on the servers (@pxref{Server Agent Commands}).
20101 If the file exist, you must manage the servers manually by adding or
20102 removing them, this variable is only applicable the first time you
20103 start Gnus. The default is @samp{(nntp nnimap)}.
20108 @node Example Setup
20109 @subsection Example Setup
20111 If you don't want to read this manual, and you have a fairly standard
20112 setup, you may be able to use something like the following as your
20113 @file{~/.gnus.el} file to get started.
20116 ;; @r{Define how Gnus is to fetch news. We do this over @acronym{NNTP}}
20117 ;; @r{from your ISP's server.}
20118 (setq gnus-select-method '(nntp "news.your-isp.com"))
20120 ;; @r{Define how Gnus is to read your mail. We read mail from}
20121 ;; @r{your ISP's @acronym{POP} server.}
20122 (setq mail-sources '((pop :server "pop.your-isp.com")))
20124 ;; @r{Say how Gnus is to store the mail. We use nnml groups.}
20125 (setq gnus-secondary-select-methods '((nnml "")))
20127 ;; @r{Make Gnus into an offline newsreader.}
20128 ;; (gnus-agentize) ; @r{The obsolete setting.}
20129 ;; (setq gnus-agent t) ; @r{Now the default.}
20132 That should be it, basically. Put that in your @file{~/.gnus.el} file,
20133 edit to suit your needs, start up PPP (or whatever), and type @kbd{M-x
20136 If this is the first time you've run Gnus, you will be subscribed
20137 automatically to a few default newsgroups. You'll probably want to
20138 subscribe to more groups, and to do that, you have to query the
20139 @acronym{NNTP} server for a complete list of groups with the @kbd{A A}
20140 command. This usually takes quite a while, but you only have to do it
20143 After reading and parsing a while, you'll be presented with a list of
20144 groups. Subscribe to the ones you want to read with the @kbd{u}
20145 command. @kbd{l} to make all the killed groups disappear after you've
20146 subscribe to all the groups you want to read. (@kbd{A k} will bring
20147 back all the killed groups.)
20149 You can now read the groups at once, or you can download the articles
20150 with the @kbd{J s} command. And then read the rest of this manual to
20151 find out which of the other gazillion things you want to customize.
20154 @node Batching Agents
20155 @subsection Batching Agents
20156 @findex gnus-agent-batch
20158 Having the Gnus Agent fetch articles (and post whatever messages you've
20159 written) is quite easy once you've gotten things set up properly. The
20160 following shell script will do everything that is necessary:
20162 You can run a complete batch command from the command line with the
20163 following incantation:
20167 emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-agent-batch >/dev/null 2>&1
20171 @node Agent Caveats
20172 @subsection Agent Caveats
20174 The Gnus Agent doesn't seem to work like most other offline
20175 newsreaders. Here are some common questions that some imaginary people
20179 @item If I read an article while plugged, do they get entered into the Agent?
20181 @strong{No}. If you want this behavior, add
20182 @code{gnus-agent-fetch-selected-article} to
20183 @code{gnus-select-article-hook}.
20185 @item If I read an article while plugged, and the article already exists in
20186 the Agent, will it get downloaded once more?
20188 @strong{No}, unless @code{gnus-agent-cache} is @code{nil}.
20192 In short, when Gnus is unplugged, it only looks into the locally stored
20193 articles; when it's plugged, it talks to your ISP and may also use the
20194 locally stored articles.
20201 Other people use @dfn{kill files}, but we here at Gnus Towers like
20202 scoring better than killing, so we'd rather switch than fight. They do
20203 something completely different as well, so sit up straight and pay
20206 @vindex gnus-summary-mark-below
20207 All articles have a default score (@code{gnus-summary-default-score}),
20208 which is 0 by default. This score may be raised or lowered either
20209 interactively or by score files. Articles that have a score lower than
20210 @code{gnus-summary-mark-below} are marked as read.
20212 Gnus will read any @dfn{score files} that apply to the current group
20213 before generating the summary buffer.
20215 There are several commands in the summary buffer that insert score
20216 entries based on the current article. You can, for instance, ask Gnus to
20217 lower or increase the score of all articles with a certain subject.
20219 There are two sorts of scoring entries: Permanent and temporary.
20220 Temporary score entries are self-expiring entries. Any entries that are
20221 temporary and have not been used for, say, a week, will be removed
20222 silently to help keep the sizes of the score files down.
20225 * Summary Score Commands:: Adding score entries for the current group.
20226 * Group Score Commands:: General score commands.
20227 * Score Variables:: Customize your scoring. (My, what terminology).
20228 * Score File Format:: What a score file may contain.
20229 * Score File Editing:: You can edit score files by hand as well.
20230 * Adaptive Scoring:: Big Sister Gnus knows what you read.
20231 * Home Score File:: How to say where new score entries are to go.
20232 * Followups To Yourself:: Having Gnus notice when people answer you.
20233 * Scoring On Other Headers:: Scoring on non-standard headers.
20234 * Scoring Tips:: How to score effectively.
20235 * Reverse Scoring:: That problem child of old is not problem.
20236 * Global Score Files:: Earth-spanning, ear-splitting score files.
20237 * Kill Files:: They are still here, but they can be ignored.
20238 * Converting Kill Files:: Translating kill files to score files.
20239 * Advanced Scoring:: Using logical expressions to build score rules.
20240 * Score Decays:: It can be useful to let scores wither away.
20244 @node Summary Score Commands
20245 @section Summary Score Commands
20246 @cindex score commands
20248 The score commands that alter score entries do not actually modify real
20249 score files. That would be too inefficient. Gnus maintains a cache of
20250 previously loaded score files, one of which is considered the
20251 @dfn{current score file alist}. The score commands simply insert
20252 entries into this list, and upon group exit, this list is saved.
20254 The current score file is by default the group's local score file, even
20255 if no such score file actually exists. To insert score commands into
20256 some other score file (e.g. @file{all.SCORE}), you must first make this
20257 score file the current one.
20259 General score commands that don't actually change the score file:
20264 @kindex V s (Summary)
20265 @findex gnus-summary-set-score
20266 Set the score of the current article (@code{gnus-summary-set-score}).
20269 @kindex V S (Summary)
20270 @findex gnus-summary-current-score
20271 Display the score of the current article
20272 (@code{gnus-summary-current-score}).
20275 @kindex V t (Summary)
20276 @findex gnus-score-find-trace
20277 Display all score rules that have been used on the current article
20278 (@code{gnus-score-find-trace}). In the @code{*Score Trace*} buffer, you
20279 may type @kbd{e} to edit score file corresponding to the score rule on
20280 current line and @kbd{f} to format (@code{gnus-score-pretty-print}) the
20281 score file and edit it.
20284 @kindex V w (Summary)
20285 @findex gnus-score-find-favourite-words
20286 List words used in scoring (@code{gnus-score-find-favourite-words}).
20289 @kindex V R (Summary)
20290 @findex gnus-summary-rescore
20291 Run the current summary through the scoring process
20292 (@code{gnus-summary-rescore}). This might be useful if you're playing
20293 around with your score files behind Gnus' back and want to see the
20294 effect you're having.
20297 @kindex V c (Summary)
20298 @findex gnus-score-change-score-file
20299 Make a different score file the current
20300 (@code{gnus-score-change-score-file}).
20303 @kindex V e (Summary)
20304 @findex gnus-score-edit-current-scores
20305 Edit the current score file (@code{gnus-score-edit-current-scores}).
20306 You will be popped into a @code{gnus-score-mode} buffer (@pxref{Score
20310 @kindex V f (Summary)
20311 @findex gnus-score-edit-file
20312 Edit a score file and make this score file the current one
20313 (@code{gnus-score-edit-file}).
20316 @kindex V F (Summary)
20317 @findex gnus-score-flush-cache
20318 Flush the score cache (@code{gnus-score-flush-cache}). This is useful
20319 after editing score files.
20322 @kindex V C (Summary)
20323 @findex gnus-score-customize
20324 Customize a score file in a visually pleasing manner
20325 (@code{gnus-score-customize}).
20329 The rest of these commands modify the local score file.
20334 @kindex V m (Summary)
20335 @findex gnus-score-set-mark-below
20336 Prompt for a score, and mark all articles with a score below this as
20337 read (@code{gnus-score-set-mark-below}).
20340 @kindex V x (Summary)
20341 @findex gnus-score-set-expunge-below
20342 Prompt for a score, and add a score rule to the current score file to
20343 expunge all articles below this score
20344 (@code{gnus-score-set-expunge-below}).
20347 The keystrokes for actually making score entries follow a very regular
20348 pattern, so there's no need to list all the commands. (Hundreds of
20351 @findex gnus-summary-increase-score
20352 @findex gnus-summary-lower-score
20356 The first key is either @kbd{I} (upper case i) for increasing the score
20357 or @kbd{L} for lowering the score.
20359 The second key says what header you want to score on. The following
20360 keys are available:
20364 Score on the author name.
20367 Score on the subject line.
20370 Score on the @code{Xref} line---i.e., the cross-posting line.
20373 Score on the @code{References} line.
20379 Score on the number of lines.
20382 Score on the @code{Message-ID} header.
20385 Score on an ``extra'' header, that is, one of those in gnus-extra-headers,
20386 if your @acronym{NNTP} server tracks additional header data in overviews.
20389 Score on followups---this matches the author name, and adds scores to
20390 the followups to this author. (Using this key leads to the creation of
20391 @file{ADAPT} files.)
20400 Score on thread. (Using this key leads to the creation of @file{ADAPT}
20406 The third key is the match type. Which match types are valid depends on
20407 what headers you are scoring on.
20419 Substring matching.
20422 Fuzzy matching (@pxref{Fuzzy Matching}).
20451 Greater than number.
20456 The fourth and usually final key says whether this is a temporary (i.e.,
20457 expiring) score entry, or a permanent (i.e., non-expiring) score entry,
20458 or whether it is to be done immediately, without adding to the score
20463 Temporary score entry.
20466 Permanent score entry.
20469 Immediately scoring.
20473 If you are scoring on `e' (extra) headers, you will then be prompted for
20474 the header name on which you wish to score. This must be a header named
20475 in gnus-extra-headers, and @samp{TAB} completion is available.
20479 So, let's say you want to increase the score on the current author with
20480 exact matching permanently: @kbd{I a e p}. If you want to lower the
20481 score based on the subject line, using substring matching, and make a
20482 temporary score entry: @kbd{L s s t}. Pretty easy.
20484 To make things a bit more complicated, there are shortcuts. If you use
20485 a capital letter on either the second or third keys, Gnus will use
20486 defaults for the remaining one or two keystrokes. The defaults are
20487 ``substring'' and ``temporary''. So @kbd{I A} is the same as @kbd{I a s
20488 t}, and @kbd{I a R} is the same as @kbd{I a r t}.
20490 These functions take both the numerical prefix and the symbolic prefix
20491 (@pxref{Symbolic Prefixes}). A numerical prefix says how much to lower
20492 (or increase) the score of the article. A symbolic prefix of @code{a}
20493 says to use the @file{all.SCORE} file for the command instead of the
20494 current score file.
20496 @vindex gnus-score-mimic-keymap
20497 The @code{gnus-score-mimic-keymap} says whether these commands will
20498 pretend they are keymaps or not.
20501 @node Group Score Commands
20502 @section Group Score Commands
20503 @cindex group score commands
20505 There aren't many of these as yet, I'm afraid.
20510 @kindex W e (Group)
20511 @findex gnus-score-edit-all-score
20512 Edit the apply-to-all-groups all.SCORE file. You will be popped into
20513 a @code{gnus-score-mode} buffer (@pxref{Score File Editing}).
20516 @kindex W f (Group)
20517 @findex gnus-score-flush-cache
20518 Gnus maintains a cache of score alists to avoid having to reload them
20519 all the time. This command will flush the cache
20520 (@code{gnus-score-flush-cache}).
20524 You can do scoring from the command line by saying something like:
20526 @findex gnus-batch-score
20527 @cindex batch scoring
20529 $ emacs -batch -l ~/.emacs -l ~/.gnus.el -f gnus-batch-score
20533 @node Score Variables
20534 @section Score Variables
20535 @cindex score variables
20539 @item gnus-use-scoring
20540 @vindex gnus-use-scoring
20541 If @code{nil}, Gnus will not check for score files, and will not, in
20542 general, do any score-related work. This is @code{t} by default.
20544 @item gnus-kill-killed
20545 @vindex gnus-kill-killed
20546 If this variable is @code{nil}, Gnus will never apply score files to
20547 articles that have already been through the kill process. While this
20548 may save you lots of time, it also means that if you apply a kill file
20549 to a group, and then change the kill file and want to run it over you
20550 group again to kill more articles, it won't work. You have to set this
20551 variable to @code{t} to do that. (It is @code{t} by default.)
20553 @item gnus-kill-files-directory
20554 @vindex gnus-kill-files-directory
20555 All kill and score files will be stored in this directory, which is
20556 initialized from the @env{SAVEDIR} environment variable by default.
20557 This is @file{~/News/} by default.
20559 @item gnus-score-file-suffix
20560 @vindex gnus-score-file-suffix
20561 Suffix to add to the group name to arrive at the score file name
20562 (@file{SCORE} by default.)
20564 @item gnus-score-uncacheable-files
20565 @vindex gnus-score-uncacheable-files
20566 @cindex score cache
20567 All score files are normally cached to avoid excessive re-loading of
20568 score files. However, this might make your Emacs grow big and
20569 bloated, so this regexp can be used to weed out score files unlikely
20570 to be needed again. It would be a bad idea to deny caching of
20571 @file{all.SCORE}, while it might be a good idea to not cache
20572 @file{comp.infosystems.www.authoring.misc.ADAPT}. In fact, this
20573 variable is @samp{ADAPT$} by default, so no adaptive score files will
20576 @item gnus-save-score
20577 @vindex gnus-save-score
20578 If you have really complicated score files, and do lots of batch
20579 scoring, then you might set this variable to @code{t}. This will make
20580 Gnus save the scores into the @file{.newsrc.eld} file.
20582 If you do not set this to @code{t}, then manual scores (like those set
20583 with @kbd{V s} (@code{gnus-summary-set-score})) will not be preserved
20584 across group visits.
20586 @item gnus-score-interactive-default-score
20587 @vindex gnus-score-interactive-default-score
20588 Score used by all the interactive raise/lower commands to raise/lower
20589 score with. Default is 1000, which may seem excessive, but this is to
20590 ensure that the adaptive scoring scheme gets enough room to play with.
20591 We don't want the small changes from the adaptive scoring to overwrite
20592 manually entered data.
20594 @item gnus-summary-default-score
20595 @vindex gnus-summary-default-score
20596 Default score of an article, which is 0 by default.
20598 @item gnus-summary-expunge-below
20599 @vindex gnus-summary-expunge-below
20600 Don't display the summary lines of articles that have scores lower than
20601 this variable. This is @code{nil} by default, which means that no
20602 articles will be hidden. This variable is local to the summary buffers,
20603 and has to be set from @code{gnus-summary-mode-hook}.
20605 @item gnus-score-over-mark
20606 @vindex gnus-score-over-mark
20607 Mark (in the third column) used for articles with a score over the
20608 default. Default is @samp{+}.
20610 @item gnus-score-below-mark
20611 @vindex gnus-score-below-mark
20612 Mark (in the third column) used for articles with a score below the
20613 default. Default is @samp{-}.
20615 @item gnus-score-find-score-files-function
20616 @vindex gnus-score-find-score-files-function
20617 Function used to find score files for the current group. This function
20618 is called with the name of the group as the argument.
20620 Predefined functions available are:
20623 @item gnus-score-find-single
20624 @findex gnus-score-find-single
20625 Only apply the group's own score file.
20627 @item gnus-score-find-bnews
20628 @findex gnus-score-find-bnews
20629 Apply all score files that match, using bnews syntax. This is the
20630 default. If the current group is @samp{gnu.emacs.gnus}, for instance,
20631 @file{all.emacs.all.SCORE}, @file{not.alt.all.SCORE} and
20632 @file{gnu.all.SCORE} would all apply. In short, the instances of
20633 @samp{all} in the score file names are translated into @samp{.*}, and
20634 then a regexp match is done.
20636 This means that if you have some score entries that you want to apply to
20637 all groups, then you put those entries in the @file{all.SCORE} file.
20639 The score files are applied in a semi-random order, although Gnus will
20640 try to apply the more general score files before the more specific score
20641 files. It does this by looking at the number of elements in the score
20642 file names---discarding the @samp{all} elements.
20644 @item gnus-score-find-hierarchical
20645 @findex gnus-score-find-hierarchical
20646 Apply all score files from all the parent groups. This means that you
20647 can't have score files like @file{all.SCORE}, but you can have
20648 @file{SCORE}, @file{comp.SCORE} and @file{comp.emacs.SCORE} for each
20652 This variable can also be a list of functions. In that case, all
20653 these functions will be called with the group name as argument, and
20654 all the returned lists of score files will be applied. These
20655 functions can also return lists of lists of score alists directly. In
20656 that case, the functions that return these non-file score alists
20657 should probably be placed before the ``real'' score file functions, to
20658 ensure that the last score file returned is the local score file.
20661 For example, to do hierarchical scoring but use a non-server-specific
20662 overall score file, you could use the value
20664 (list (lambda (group) ("all.SCORE"))
20665 'gnus-score-find-hierarchical)
20668 @item gnus-score-expiry-days
20669 @vindex gnus-score-expiry-days
20670 This variable says how many days should pass before an unused score file
20671 entry is expired. If this variable is @code{nil}, no score file entries
20672 are expired. It's 7 by default.
20674 @item gnus-update-score-entry-dates
20675 @vindex gnus-update-score-entry-dates
20676 If this variable is non-@code{nil}, temporary score entries that have
20677 been triggered (matched) will have their dates updated. (This is how Gnus
20678 controls expiry---all non-matched-entries will become too old while
20679 matched entries will stay fresh and young.) However, if you set this
20680 variable to @code{nil}, even matched entries will grow old and will
20681 have to face that oh-so grim reaper.
20683 @item gnus-score-after-write-file-function
20684 @vindex gnus-score-after-write-file-function
20685 Function called with the name of the score file just written.
20687 @item gnus-score-thread-simplify
20688 @vindex gnus-score-thread-simplify
20689 If this variable is non-@code{nil}, article subjects will be
20690 simplified for subject scoring purposes in the same manner as with
20691 threading---according to the current value of
20692 @code{gnus-simplify-subject-functions}. If the scoring entry uses
20693 @code{substring} or @code{exact} matching, the match will also be
20694 simplified in this manner.
20699 @node Score File Format
20700 @section Score File Format
20701 @cindex score file format
20703 A score file is an @code{emacs-lisp} file that normally contains just a
20704 single form. Casual users are not expected to edit these files;
20705 everything can be changed from the summary buffer.
20707 Anyway, if you'd like to dig into it yourself, here's an example:
20711 ("Lars Ingebrigtsen" -10000)
20713 ("larsi\\|lmi" -50000 nil R))
20715 ("Ding is Badd" nil 728373))
20717 ("alt.politics" -1000 728372 s))
20722 (mark-and-expunge -10)
20726 (files "/hom/larsi/News/gnu.SCORE")
20727 (exclude-files "all.SCORE")
20728 (local (gnus-newsgroup-auto-expire t)
20729 (gnus-summary-make-false-root empty))
20733 This example demonstrates most score file elements. @xref{Advanced
20734 Scoring}, for a different approach.
20736 Even though this looks much like Lisp code, nothing here is actually
20737 @code{eval}ed. The Lisp reader is used to read this form, though, so it
20738 has to be valid syntactically, if not semantically.
20740 Six keys are supported by this alist:
20745 If the key is a string, it is the name of the header to perform the
20746 match on. Scoring can only be performed on these eight headers:
20747 @code{From}, @code{Subject}, @code{References}, @code{Message-ID},
20748 @code{Xref}, @code{Lines}, @code{Chars} and @code{Date}. In addition to
20749 these headers, there are three strings to tell Gnus to fetch the entire
20750 article and do the match on larger parts of the article: @code{Body}
20751 will perform the match on the body of the article, @code{Head} will
20752 perform the match on the head of the article, and @code{All} will
20753 perform the match on the entire article. Note that using any of these
20754 last three keys will slow down group entry @emph{considerably}. The
20755 final ``header'' you can score on is @code{Followup}. These score
20756 entries will result in new score entries being added for all follow-ups
20757 to articles that matches these score entries.
20759 Following this key is an arbitrary number of score entries, where each
20760 score entry has one to four elements.
20764 The first element is the @dfn{match element}. On most headers this will
20765 be a string, but on the Lines and Chars headers, this must be an
20769 If the second element is present, it should be a number---the @dfn{score
20770 element}. This number should be an integer in the neginf to posinf
20771 interval. This number is added to the score of the article if the match
20772 is successful. If this element is not present, the
20773 @code{gnus-score-interactive-default-score} number will be used
20774 instead. This is 1000 by default.
20777 If the third element is present, it should be a number---the @dfn{date
20778 element}. This date says when the last time this score entry matched,
20779 which provides a mechanism for expiring the score entries. It this
20780 element is not present, the score entry is permanent. The date is
20781 represented by the number of days since December 31, 1 BCE.
20784 If the fourth element is present, it should be a symbol---the @dfn{type
20785 element}. This element specifies what function should be used to see
20786 whether this score entry matches the article. What match types that can
20787 be used depends on what header you wish to perform the match on.
20790 @item From, Subject, References, Xref, Message-ID
20791 For most header types, there are the @code{r} and @code{R} (regexp), as
20792 well as @code{s} and @code{S} (substring) types, and @code{e} and
20793 @code{E} (exact match), and @code{w} (word match) types. If this
20794 element is not present, Gnus will assume that substring matching should
20795 be used. @code{R}, @code{S}, and @code{E} differ from the others in
20796 that the matches will be done in a case-sensitive manner. All these
20797 one-letter types are really just abbreviations for the @code{regexp},
20798 @code{string}, @code{exact}, and @code{word} types, which you can use
20799 instead, if you feel like.
20802 Just as for the standard string overview headers, if you are using
20803 gnus-extra-headers, you can score on these headers' values. In this
20804 case, there is a 5th element in the score entry, being the name of the
20805 header to be scored. The following entry is useful in your
20806 @file{all.SCORE} file in case of spam attacks from a single origin
20807 host, if your @acronym{NNTP} server tracks @samp{NNTP-Posting-Host} in
20811 ("111.222.333.444" -1000 nil s
20812 "NNTP-Posting-Host")
20816 These two headers use different match types: @code{<}, @code{>},
20817 @code{=}, @code{>=} and @code{<=}.
20819 These predicates are true if
20822 (PREDICATE HEADER MATCH)
20825 evaluates to non-@code{nil}. For instance, the advanced match
20826 @code{("lines" 4 <)} (@pxref{Advanced Scoring}) will result in the
20833 Or to put it another way: When using @code{<} on @code{Lines} with 4 as
20834 the match, we get the score added if the article has less than 4 lines.
20835 (It's easy to get confused and think it's the other way around. But
20836 it's not. I think.)
20838 When matching on @code{Lines}, be careful because some back ends (like
20839 @code{nndir}) do not generate @code{Lines} header, so every article ends
20840 up being marked as having 0 lines. This can lead to strange results if
20841 you happen to lower score of the articles with few lines.
20844 For the Date header we have three kinda silly match types:
20845 @code{before}, @code{at} and @code{after}. I can't really imagine this
20846 ever being useful, but, like, it would feel kinda silly not to provide
20847 this function. Just in case. You never know. Better safe than sorry.
20848 Once burnt, twice shy. Don't judge a book by its cover. Never not have
20849 sex on a first date. (I have been told that at least one person, and I
20850 quote, ``found this function indispensable'', however.)
20854 A more useful match type is @code{regexp}. With it, you can match the
20855 date string using a regular expression. The date is normalized to
20856 ISO8601 compact format first---@var{YYYYMMDD}@code{T}@var{HHMMSS}. If
20857 you want to match all articles that have been posted on April 1st in
20858 every year, you could use @samp{....0401.........} as a match string,
20859 for instance. (Note that the date is kept in its original time zone, so
20860 this will match articles that were posted when it was April 1st where
20861 the article was posted from. Time zones are such wholesome fun for the
20864 @item Head, Body, All
20865 These three match keys use the same match types as the @code{From} (etc)
20869 This match key is somewhat special, in that it will match the
20870 @code{From} header, and affect the score of not only the matching
20871 articles, but also all followups to the matching articles. This allows
20872 you e.g. increase the score of followups to your own articles, or
20873 decrease the score of followups to the articles of some known
20874 trouble-maker. Uses the same match types as the @code{From} header
20875 uses. (Using this match key will lead to creation of @file{ADAPT}
20879 This match key works along the same lines as the @code{Followup} match
20880 key. If you say that you want to score on a (sub-)thread started by an
20881 article with a @code{Message-ID} @var{x}, then you add a @samp{thread}
20882 match. This will add a new @samp{thread} match for each article that
20883 has @var{x} in its @code{References} header. (These new @samp{thread}
20884 matches will use the @code{Message-ID}s of these matching articles.)
20885 This will ensure that you can raise/lower the score of an entire thread,
20886 even though some articles in the thread may not have complete
20887 @code{References} headers. Note that using this may lead to
20888 undeterministic scores of the articles in the thread. (Using this match
20889 key will lead to creation of @file{ADAPT} files.)
20893 @cindex score file atoms
20895 The value of this entry should be a number. Any articles with a score
20896 lower than this number will be marked as read.
20899 The value of this entry should be a number. Any articles with a score
20900 lower than this number will be removed from the summary buffer.
20902 @item mark-and-expunge
20903 The value of this entry should be a number. Any articles with a score
20904 lower than this number will be marked as read and removed from the
20907 @item thread-mark-and-expunge
20908 The value of this entry should be a number. All articles that belong to
20909 a thread that has a total score below this number will be marked as read
20910 and removed from the summary buffer. @code{gnus-thread-score-function}
20911 says how to compute the total score for a thread.
20914 The value of this entry should be any number of file names. These files
20915 are assumed to be score files as well, and will be loaded the same way
20918 @item exclude-files
20919 The clue of this entry should be any number of files. These files will
20920 not be loaded, even though they would normally be so, for some reason or
20924 The value of this entry will be @code{eval}el. This element will be
20925 ignored when handling global score files.
20928 Read-only score files will not be updated or saved. Global score files
20929 should feature this atom (@pxref{Global Score Files}). (Note:
20930 @dfn{Global} here really means @dfn{global}; not your personal
20931 apply-to-all-groups score files.)
20934 The value of this entry should be a number. Articles that do not have
20935 parents will get this number added to their scores. Imagine you follow
20936 some high-volume newsgroup, like @samp{comp.lang.c}. Most likely you
20937 will only follow a few of the threads, also want to see any new threads.
20939 You can do this with the following two score file entries:
20943 (mark-and-expunge -100)
20946 When you enter the group the first time, you will only see the new
20947 threads. You then raise the score of the threads that you find
20948 interesting (with @kbd{I T} or @kbd{I S}), and ignore (@kbd{C y}) the
20949 rest. Next time you enter the group, you will see new articles in the
20950 interesting threads, plus any new threads.
20952 I.e.---the orphan score atom is for high-volume groups where a few
20953 interesting threads which can't be found automatically by ordinary
20954 scoring rules exist.
20957 This entry controls the adaptive scoring. If it is @code{t}, the
20958 default adaptive scoring rules will be used. If it is @code{ignore}, no
20959 adaptive scoring will be performed on this group. If it is a list, this
20960 list will be used as the adaptive scoring rules. If it isn't present,
20961 or is something other than @code{t} or @code{ignore}, the default
20962 adaptive scoring rules will be used. If you want to use adaptive
20963 scoring on most groups, you'd set @code{gnus-use-adaptive-scoring} to
20964 @code{t}, and insert an @code{(adapt ignore)} in the groups where you do
20965 not want adaptive scoring. If you only want adaptive scoring in a few
20966 groups, you'd set @code{gnus-use-adaptive-scoring} to @code{nil}, and
20967 insert @code{(adapt t)} in the score files of the groups where you want
20971 All adaptive score entries will go to the file named by this entry. It
20972 will also be applied when entering the group. This atom might be handy
20973 if you want to adapt on several groups at once, using the same adaptive
20974 file for a number of groups.
20977 @cindex local variables
20978 The value of this entry should be a list of @code{(@var{var}
20979 @var{value})} pairs. Each @var{var} will be made buffer-local to the
20980 current summary buffer, and set to the value specified. This is a
20981 convenient, if somewhat strange, way of setting variables in some
20982 groups if you don't like hooks much. Note that the @var{value} won't
20987 @node Score File Editing
20988 @section Score File Editing
20990 You normally enter all scoring commands from the summary buffer, but you
20991 might feel the urge to edit them by hand as well, so we've supplied you
20992 with a mode for that.
20994 It's simply a slightly customized @code{emacs-lisp} mode, with these
20995 additional commands:
21000 @kindex C-c C-c (Score)
21001 @findex gnus-score-edit-exit
21002 Save the changes you have made and return to the summary buffer
21003 (@code{gnus-score-edit-exit}).
21006 @kindex C-c C-d (Score)
21007 @findex gnus-score-edit-insert-date
21008 Insert the current date in numerical format
21009 (@code{gnus-score-edit-insert-date}). This is really the day number, if
21010 you were wondering.
21013 @kindex C-c C-p (Score)
21014 @findex gnus-score-pretty-print
21015 The adaptive score files are saved in an unformatted fashion. If you
21016 intend to read one of these files, you want to @dfn{pretty print} it
21017 first. This command (@code{gnus-score-pretty-print}) does that for
21022 Type @kbd{M-x gnus-score-mode} to use this mode.
21024 @vindex gnus-score-mode-hook
21025 @code{gnus-score-menu-hook} is run in score mode buffers.
21027 In the summary buffer you can use commands like @kbd{V f}, @kbd{V e} and
21028 @kbd{V t} to begin editing score files.
21031 @node Adaptive Scoring
21032 @section Adaptive Scoring
21033 @cindex adaptive scoring
21035 If all this scoring is getting you down, Gnus has a way of making it all
21036 happen automatically---as if by magic. Or rather, as if by artificial
21037 stupidity, to be precise.
21039 @vindex gnus-use-adaptive-scoring
21040 When you read an article, or mark an article as read, or kill an
21041 article, you leave marks behind. On exit from the group, Gnus can sniff
21042 these marks and add score elements depending on what marks it finds.
21043 You turn on this ability by setting @code{gnus-use-adaptive-scoring} to
21044 @code{t} or @code{(line)}. If you want score adaptively on separate
21045 words appearing in the subjects, you should set this variable to
21046 @code{(word)}. If you want to use both adaptive methods, set this
21047 variable to @code{(word line)}.
21049 @vindex gnus-default-adaptive-score-alist
21050 To give you complete control over the scoring process, you can customize
21051 the @code{gnus-default-adaptive-score-alist} variable. For instance, it
21052 might look something like this:
21055 (setq gnus-default-adaptive-score-alist
21056 '((gnus-unread-mark)
21057 (gnus-ticked-mark (from 4))
21058 (gnus-dormant-mark (from 5))
21059 (gnus-del-mark (from -4) (subject -1))
21060 (gnus-read-mark (from 4) (subject 2))
21061 (gnus-expirable-mark (from -1) (subject -1))
21062 (gnus-killed-mark (from -1) (subject -3))
21063 (gnus-kill-file-mark)
21064 (gnus-ancient-mark)
21065 (gnus-low-score-mark)
21066 (gnus-catchup-mark (from -1) (subject -1))))
21069 As you see, each element in this alist has a mark as a key (either a
21070 variable name or a ``real'' mark---a character). Following this key is
21071 a arbitrary number of header/score pairs. If there are no header/score
21072 pairs following the key, no adaptive scoring will be done on articles
21073 that have that key as the article mark. For instance, articles with
21074 @code{gnus-unread-mark} in the example above will not get adaptive score
21077 Each article can have only one mark, so just a single of these rules
21078 will be applied to each article.
21080 To take @code{gnus-del-mark} as an example---this alist says that all
21081 articles that have that mark (i.e., are marked with @samp{e}) will have a
21082 score entry added to lower based on the @code{From} header by -4, and
21083 lowered by @code{Subject} by -1. Change this to fit your prejudices.
21085 If you have marked 10 articles with the same subject with
21086 @code{gnus-del-mark}, the rule for that mark will be applied ten times.
21087 That means that that subject will get a score of ten times -1, which
21088 should be, unless I'm much mistaken, -10.
21090 If you have auto-expirable (mail) groups (@pxref{Expiring Mail}), all
21091 the read articles will be marked with the @samp{E} mark. This'll
21092 probably make adaptive scoring slightly impossible, so auto-expiring and
21093 adaptive scoring doesn't really mix very well.
21095 The headers you can score on are @code{from}, @code{subject},
21096 @code{message-id}, @code{references}, @code{xref}, @code{lines},
21097 @code{chars} and @code{date}. In addition, you can score on
21098 @code{followup}, which will create an adaptive score entry that matches
21099 on the @code{References} header using the @code{Message-ID} of the
21100 current article, thereby matching the following thread.
21102 If you use this scheme, you should set the score file atom @code{mark}
21103 to something small---like -300, perhaps, to avoid having small random
21104 changes result in articles getting marked as read.
21106 After using adaptive scoring for a week or so, Gnus should start to
21107 become properly trained and enhance the authors you like best, and kill
21108 the authors you like least, without you having to say so explicitly.
21110 You can control what groups the adaptive scoring is to be performed on
21111 by using the score files (@pxref{Score File Format}). This will also
21112 let you use different rules in different groups.
21114 @vindex gnus-adaptive-file-suffix
21115 The adaptive score entries will be put into a file where the name is the
21116 group name with @code{gnus-adaptive-file-suffix} appended. The default
21119 @vindex gnus-adaptive-pretty-print
21120 Adaptive score files can get huge and are not meant to be edited by
21121 human hands. If @code{gnus-adaptive-pretty-print} is @code{nil} (the
21122 deafult) those files will not be written in a human readable way.
21124 @vindex gnus-score-exact-adapt-limit
21125 When doing adaptive scoring, substring or fuzzy matching would probably
21126 give you the best results in most cases. However, if the header one
21127 matches is short, the possibility for false positives is great, so if
21128 the length of the match is less than
21129 @code{gnus-score-exact-adapt-limit}, exact matching will be used. If
21130 this variable is @code{nil}, exact matching will always be used to avoid
21133 @vindex gnus-default-adaptive-word-score-alist
21134 As mentioned above, you can adapt either on individual words or entire
21135 headers. If you adapt on words, the
21136 @code{gnus-default-adaptive-word-score-alist} variable says what score
21137 each instance of a word should add given a mark.
21140 (setq gnus-default-adaptive-word-score-alist
21141 `((,gnus-read-mark . 30)
21142 (,gnus-catchup-mark . -10)
21143 (,gnus-killed-mark . -20)
21144 (,gnus-del-mark . -15)))
21147 This is the default value. If you have adaption on words enabled, every
21148 word that appears in subjects of articles marked with
21149 @code{gnus-read-mark} will result in a score rule that increase the
21150 score with 30 points.
21152 @vindex gnus-default-ignored-adaptive-words
21153 @vindex gnus-ignored-adaptive-words
21154 Words that appear in the @code{gnus-default-ignored-adaptive-words} list
21155 will be ignored. If you wish to add more words to be ignored, use the
21156 @code{gnus-ignored-adaptive-words} list instead.
21158 @vindex gnus-adaptive-word-length-limit
21159 Some may feel that short words shouldn't count when doing adaptive
21160 scoring. If so, you may set @code{gnus-adaptive-word-length-limit} to
21161 an integer. Words shorter than this number will be ignored. This
21162 variable defaults to @code{nil}.
21164 @vindex gnus-adaptive-word-syntax-table
21165 When the scoring is done, @code{gnus-adaptive-word-syntax-table} is the
21166 syntax table in effect. It is similar to the standard syntax table, but
21167 it considers numbers to be non-word-constituent characters.
21169 @vindex gnus-adaptive-word-minimum
21170 If @code{gnus-adaptive-word-minimum} is set to a number, the adaptive
21171 word scoring process will never bring down the score of an article to
21172 below this number. The default is @code{nil}.
21174 @vindex gnus-adaptive-word-no-group-words
21175 If @code{gnus-adaptive-word-no-group-words} is set to @code{t}, gnus
21176 won't adaptively word score any of the words in the group name. Useful
21177 for groups like @samp{comp.editors.emacs}, where most of the subject
21178 lines contain the word @samp{emacs}.
21180 After using this scheme for a while, it might be nice to write a
21181 @code{gnus-psychoanalyze-user} command to go through the rules and see
21182 what words you like and what words you don't like. Or perhaps not.
21184 Note that the adaptive word scoring thing is highly experimental and is
21185 likely to change in the future. Initial impressions seem to indicate
21186 that it's totally useless as it stands. Some more work (involving more
21187 rigorous statistical methods) will have to be done to make this useful.
21190 @node Home Score File
21191 @section Home Score File
21193 The score file where new score file entries will go is called the
21194 @dfn{home score file}. This is normally (and by default) the score file
21195 for the group itself. For instance, the home score file for
21196 @samp{gnu.emacs.gnus} is @file{gnu.emacs.gnus.SCORE}.
21198 However, this may not be what you want. It is often convenient to share
21199 a common home score file among many groups---all @samp{emacs} groups
21200 could perhaps use the same home score file.
21202 @vindex gnus-home-score-file
21203 The variable that controls this is @code{gnus-home-score-file}. It can
21208 A string. Then this file will be used as the home score file for all
21212 A function. The result of this function will be used as the home score
21213 file. The function will be called with the name of the group as the
21217 A list. The elements in this list can be:
21221 @code{(@var{regexp} @var{file-name})}. If the @var{regexp} matches the
21222 group name, the @var{file-name} will be used as the home score file.
21225 A function. If the function returns non-@code{nil}, the result will
21226 be used as the home score file. The function will be called with the
21227 name of the group as the parameter.
21230 A string. Use the string as the home score file.
21233 The list will be traversed from the beginning towards the end looking
21238 So, if you want to use just a single score file, you could say:
21241 (setq gnus-home-score-file
21242 "my-total-score-file.SCORE")
21245 If you want to use @file{gnu.SCORE} for all @samp{gnu} groups and
21246 @file{rec.SCORE} for all @samp{rec} groups (and so on), you can say:
21248 @findex gnus-hierarchial-home-score-file
21250 (setq gnus-home-score-file
21251 'gnus-hierarchial-home-score-file)
21254 This is a ready-made function provided for your convenience.
21255 Other functions include
21258 @item gnus-current-home-score-file
21259 @findex gnus-current-home-score-file
21260 Return the ``current'' regular score file. This will make scoring
21261 commands add entry to the ``innermost'' matching score file.
21265 If you want to have one score file for the @samp{emacs} groups and
21266 another for the @samp{comp} groups, while letting all other groups use
21267 their own home score files:
21270 (setq gnus-home-score-file
21271 ;; @r{All groups that match the regexp @code{"\\.emacs"}}
21272 '(("\\.emacs" "emacs.SCORE")
21273 ;; @r{All the comp groups in one score file}
21274 ("^comp" "comp.SCORE")))
21277 @vindex gnus-home-adapt-file
21278 @code{gnus-home-adapt-file} works exactly the same way as
21279 @code{gnus-home-score-file}, but says what the home adaptive score file
21280 is instead. All new adaptive file entries will go into the file
21281 specified by this variable, and the same syntax is allowed.
21283 In addition to using @code{gnus-home-score-file} and
21284 @code{gnus-home-adapt-file}, you can also use group parameters
21285 (@pxref{Group Parameters}) and topic parameters (@pxref{Topic
21286 Parameters}) to achieve much the same. Group and topic parameters take
21287 precedence over this variable.
21290 @node Followups To Yourself
21291 @section Followups To Yourself
21293 Gnus offers two commands for picking out the @code{Message-ID} header in
21294 the current buffer. Gnus will then add a score rule that scores using
21295 this @code{Message-ID} on the @code{References} header of other
21296 articles. This will, in effect, increase the score of all articles that
21297 respond to the article in the current buffer. Quite useful if you want
21298 to easily note when people answer what you've said.
21302 @item gnus-score-followup-article
21303 @findex gnus-score-followup-article
21304 This will add a score to articles that directly follow up your own
21307 @item gnus-score-followup-thread
21308 @findex gnus-score-followup-thread
21309 This will add a score to all articles that appear in a thread ``below''
21313 @vindex message-sent-hook
21314 These two functions are both primarily meant to be used in hooks like
21315 @code{message-sent-hook}, like this:
21317 (add-hook 'message-sent-hook 'gnus-score-followup-thread)
21321 If you look closely at your own @code{Message-ID}, you'll notice that
21322 the first two or three characters are always the same. Here's two of
21326 <x6u3u47icf.fsf@@eyesore.no>
21327 <x6sp9o7ibw.fsf@@eyesore.no>
21330 So ``my'' ident on this machine is @samp{x6}. This can be
21331 exploited---the following rule will raise the score on all followups to
21336 ("<x6[0-9a-z]+\\.fsf\\(_-_\\)?@@.*eyesore\\.no>"
21340 Whether it's the first two or first three characters that are ``yours''
21341 is system-dependent.
21344 @node Scoring On Other Headers
21345 @section Scoring On Other Headers
21346 @cindex scoring on other headers
21348 Gnus is quite fast when scoring the ``traditional''
21349 headers---@samp{From}, @samp{Subject} and so on. However, scoring
21350 other headers requires writing a @code{head} scoring rule, which means
21351 that Gnus has to request every single article from the back end to find
21352 matches. This takes a long time in big groups.
21354 Now, there's not much you can do about this for news groups, but for
21355 mail groups, you have greater control. In @ref{To From Newsgroups},
21356 it's explained in greater detail what this mechanism does, but here's
21357 a cookbook example for @code{nnml} on how to allow scoring on the
21358 @samp{To} and @samp{Cc} headers.
21360 Put the following in your @file{~/.gnus.el} file.
21363 (setq gnus-extra-headers '(To Cc Newsgroups Keywords)
21364 nnmail-extra-headers gnus-extra-headers)
21367 Restart Gnus and rebuild your @code{nnml} overview files with the
21368 @kbd{M-x nnml-generate-nov-databases} command. This will take a long
21369 time if you have much mail.
21371 Now you can score on @samp{To} and @samp{Cc} as ``extra headers'' like
21372 so: @kbd{I e s p To RET <your name> RET}.
21376 @vindex gnus-inhibit-slow-scoring
21377 You can inhibit scoring the slow scoring on headers or body by setting
21378 the variable @code{gnus-inhibit-slow-scoring}. If
21379 @code{gnus-inhibit-slow-scoring} is regexp, slow scoring is inhibited if
21380 the group matches the regexp. If it is t, slow scoring on it is
21381 inhibited for all groups.
21385 @section Scoring Tips
21386 @cindex scoring tips
21392 @cindex scoring crossposts
21393 If you want to lower the score of crossposts, the line to match on is
21394 the @code{Xref} header.
21396 ("xref" (" talk.politics.misc:" -1000))
21399 @item Multiple crossposts
21400 If you want to lower the score of articles that have been crossposted to
21401 more than, say, 3 groups:
21404 ("[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+ +[^:\n]+:[0-9]+"
21408 @item Matching on the body
21409 This is generally not a very good idea---it takes a very long time.
21410 Gnus actually has to fetch each individual article from the server. But
21411 you might want to anyway, I guess. Even though there are three match
21412 keys (@code{Head}, @code{Body} and @code{All}), you should choose one
21413 and stick with it in each score file. If you use any two, each article
21414 will be fetched @emph{twice}. If you want to match a bit on the
21415 @code{Head} and a bit on the @code{Body}, just use @code{All} for all
21418 @item Marking as read
21419 You will probably want to mark articles that have scores below a certain
21420 number as read. This is most easily achieved by putting the following
21421 in your @file{all.SCORE} file:
21425 You may also consider doing something similar with @code{expunge}.
21427 @item Negated character classes
21428 If you say stuff like @code{[^abcd]*}, you may get unexpected results.
21429 That will match newlines, which might lead to, well, The Unknown. Say
21430 @code{[^abcd\n]*} instead.
21434 @node Reverse Scoring
21435 @section Reverse Scoring
21436 @cindex reverse scoring
21438 If you want to keep just articles that have @samp{Sex with Emacs} in the
21439 subject header, and expunge all other articles, you could put something
21440 like this in your score file:
21444 ("Sex with Emacs" 2))
21449 So, you raise all articles that match @samp{Sex with Emacs} and mark the
21450 rest as read, and expunge them to boot.
21453 @node Global Score Files
21454 @section Global Score Files
21455 @cindex global score files
21457 Sure, other newsreaders have ``global kill files''. These are usually
21458 nothing more than a single kill file that applies to all groups, stored
21459 in the user's home directory. Bah! Puny, weak newsreaders!
21461 What I'm talking about here are Global Score Files. Score files from
21462 all over the world, from users everywhere, uniting all nations in one
21463 big, happy score file union! Ange-score! New and untested!
21465 @vindex gnus-global-score-files
21466 All you have to do to use other people's score files is to set the
21467 @code{gnus-global-score-files} variable. One entry for each score file,
21468 or each score file directory. Gnus will decide by itself what score
21469 files are applicable to which group.
21471 To use the score file
21472 @file{/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE} and
21473 all score files in the @file{/ftp@@ftp.some-where:/pub/score} directory,
21477 (setq gnus-global-score-files
21478 '("/ftp@@ftp.gnus.org:/pub/larsi/ding/score/soc.motss.SCORE"
21479 "/ftp@@ftp.some-where:/pub/score/"))
21482 @findex gnus-score-search-global-directories
21484 Simple, eh? Directory names must end with a @samp{/}. These
21485 directories are typically scanned only once during each Gnus session.
21486 If you feel the need to manually re-scan the remote directories, you can
21487 use the @code{gnus-score-search-global-directories} command.
21489 Note that, at present, using this option will slow down group entry
21490 somewhat. (That is---a lot.)
21492 If you want to start maintaining score files for other people to use,
21493 just put your score file up for anonymous ftp and announce it to the
21494 world. Become a retro-moderator! Participate in the retro-moderator
21495 wars sure to ensue, where retro-moderators battle it out for the
21496 sympathy of the people, luring them to use their score files on false
21497 premises! Yay! The net is saved!
21499 Here are some tips for the would-be retro-moderator, off the top of my
21505 Articles heavily crossposted are probably junk.
21507 To lower a single inappropriate article, lower by @code{Message-ID}.
21509 Particularly brilliant authors can be raised on a permanent basis.
21511 Authors that repeatedly post off-charter for the group can safely be
21512 lowered out of existence.
21514 Set the @code{mark} and @code{expunge} atoms to obliterate the nastiest
21515 articles completely.
21518 Use expiring score entries to keep the size of the file down. You
21519 should probably have a long expiry period, though, as some sites keep
21520 old articles for a long time.
21523 @dots{} I wonder whether other newsreaders will support global score files
21524 in the future. @emph{Snicker}. Yup, any day now, newsreaders like Blue
21525 Wave, xrn and 1stReader are bound to implement scoring. Should we start
21526 holding our breath yet?
21530 @section Kill Files
21533 Gnus still supports those pesky old kill files. In fact, the kill file
21534 entries can now be expiring, which is something I wrote before Daniel
21535 Quinlan thought of doing score files, so I've left the code in there.
21537 In short, kill processing is a lot slower (and I do mean @emph{a lot})
21538 than score processing, so it might be a good idea to rewrite your kill
21539 files into score files.
21541 Anyway, a kill file is a normal @code{emacs-lisp} file. You can put any
21542 forms into this file, which means that you can use kill files as some
21543 sort of primitive hook function to be run on group entry, even though
21544 that isn't a very good idea.
21546 Normal kill files look like this:
21549 (gnus-kill "From" "Lars Ingebrigtsen")
21550 (gnus-kill "Subject" "ding")
21554 This will mark every article written by me as read, and remove the
21555 marked articles from the summary buffer. Very useful, you'll agree.
21557 Other programs use a totally different kill file syntax. If Gnus
21558 encounters what looks like a @code{rn} kill file, it will take a stab at
21561 Two summary functions for editing a @sc{gnus} kill file:
21566 @kindex M-k (Summary)
21567 @findex gnus-summary-edit-local-kill
21568 Edit this group's kill file (@code{gnus-summary-edit-local-kill}).
21571 @kindex M-K (Summary)
21572 @findex gnus-summary-edit-global-kill
21573 Edit the general kill file (@code{gnus-summary-edit-global-kill}).
21576 Two group mode functions for editing the kill files:
21581 @kindex M-k (Group)
21582 @findex gnus-group-edit-local-kill
21583 Edit this group's kill file (@code{gnus-group-edit-local-kill}).
21586 @kindex M-K (Group)
21587 @findex gnus-group-edit-global-kill
21588 Edit the general kill file (@code{gnus-group-edit-global-kill}).
21591 Kill file variables:
21594 @item gnus-kill-file-name
21595 @vindex gnus-kill-file-name
21596 A kill file for the group @samp{soc.motss} is normally called
21597 @file{soc.motss.KILL}. The suffix appended to the group name to get
21598 this file name is detailed by the @code{gnus-kill-file-name} variable.
21599 The ``global'' kill file (not in the score file sense of ``global'', of
21600 course) is just called @file{KILL}.
21602 @vindex gnus-kill-save-kill-file
21603 @item gnus-kill-save-kill-file
21604 If this variable is non-@code{nil}, Gnus will save the
21605 kill file after processing, which is necessary if you use expiring
21608 @item gnus-apply-kill-hook
21609 @vindex gnus-apply-kill-hook
21610 @findex gnus-apply-kill-file-unless-scored
21611 @findex gnus-apply-kill-file
21612 A hook called to apply kill files to a group. It is
21613 @code{(gnus-apply-kill-file)} by default. If you want to ignore the
21614 kill file if you have a score file for the same group, you can set this
21615 hook to @code{(gnus-apply-kill-file-unless-scored)}. If you don't want
21616 kill files to be processed, you should set this variable to @code{nil}.
21618 @item gnus-kill-file-mode-hook
21619 @vindex gnus-kill-file-mode-hook
21620 A hook called in kill-file mode buffers.
21625 @node Converting Kill Files
21626 @section Converting Kill Files
21628 @cindex converting kill files
21630 If you have loads of old kill files, you may want to convert them into
21631 score files. If they are ``regular'', you can use
21632 the @file{gnus-kill-to-score.el} package; if not, you'll have to do it
21635 The kill to score conversion package isn't included in Gnus by default.
21636 You can fetch it from
21637 @uref{http://www.stud.ifi.uio.no/~larsi/ding-various/gnus-kill-to-score.el}.
21639 If your old kill files are very complex---if they contain more
21640 non-@code{gnus-kill} forms than not, you'll have to convert them by
21641 hand. Or just let them be as they are. Gnus will still use them as
21645 @node Advanced Scoring
21646 @section Advanced Scoring
21648 Scoring on Subjects and From headers is nice enough, but what if you're
21649 really interested in what a person has to say only when she's talking
21650 about a particular subject? Or what if you really don't want to
21651 read what person A has to say when she's following up to person B, but
21652 want to read what she says when she's following up to person C?
21654 By using advanced scoring rules you may create arbitrarily complex
21658 * Advanced Scoring Syntax:: A definition.
21659 * Advanced Scoring Examples:: What they look like.
21660 * Advanced Scoring Tips:: Getting the most out of it.
21664 @node Advanced Scoring Syntax
21665 @subsection Advanced Scoring Syntax
21667 Ordinary scoring rules have a string as the first element in the rule.
21668 Advanced scoring rules have a list as the first element. The second
21669 element is the score to be applied if the first element evaluated to a
21670 non-@code{nil} value.
21672 These lists may consist of three logical operators, one redirection
21673 operator, and various match operators.
21680 This logical operator will evaluate each of its arguments until it finds
21681 one that evaluates to @code{false}, and then it'll stop. If all arguments
21682 evaluate to @code{true} values, then this operator will return
21687 This logical operator will evaluate each of its arguments until it finds
21688 one that evaluates to @code{true}. If no arguments are @code{true},
21689 then this operator will return @code{false}.
21694 This logical operator only takes a single argument. It returns the
21695 logical negation of the value of its argument.
21699 There is an @dfn{indirection operator} that will make its arguments
21700 apply to the ancestors of the current article being scored. For
21701 instance, @code{1-} will make score rules apply to the parent of the
21702 current article. @code{2-} will make score rules apply to the
21703 grandparent of the current article. Alternatively, you can write
21704 @code{^^}, where the number of @code{^}s (carets) says how far back into
21705 the ancestry you want to go.
21707 Finally, we have the match operators. These are the ones that do the
21708 real work. Match operators are header name strings followed by a match
21709 and a match type. A typical match operator looks like @samp{("from"
21710 "Lars Ingebrigtsen" s)}. The header names are the same as when using
21711 simple scoring, and the match types are also the same.
21714 @node Advanced Scoring Examples
21715 @subsection Advanced Scoring Examples
21717 Please note that the following examples are score file rules. To
21718 make a complete score file from them, surround them with another pair
21721 Let's say you want to increase the score of articles written by Lars
21722 when he's talking about Gnus:
21727 ("from" "Lars Ingebrigtsen")
21728 ("subject" "Gnus"))
21735 When he writes long articles, he sometimes has something nice to say:
21739 ("from" "Lars Ingebrigtsen")
21746 However, when he responds to things written by Reig Eigil Logge, you
21747 really don't want to read what he's written:
21751 ("from" "Lars Ingebrigtsen")
21752 (1- ("from" "Reig Eigil Logge")))
21756 Everybody that follows up Redmondo when he writes about disappearing
21757 socks should have their scores raised, but only when they talk about
21758 white socks. However, when Lars talks about socks, it's usually not
21765 ("from" "redmondo@@.*no" r)
21766 ("body" "disappearing.*socks" t)))
21767 (! ("from" "Lars Ingebrigtsen"))
21768 ("body" "white.*socks"))
21772 Suppose you're reading a high volume group and you're only interested
21773 in replies. The plan is to score down all articles that don't have
21774 subject that begin with "Re:", "Fw:" or "Fwd:" and then score up all
21775 parents of articles that have subjects that begin with reply marks.
21778 ((! ("subject" "re:\\|fwd?:" r))
21780 ((1- ("subject" "re:\\|fwd?:" r))
21784 The possibilities are endless.
21786 @node Advanced Scoring Tips
21787 @subsection Advanced Scoring Tips
21789 The @code{&} and @code{|} logical operators do short-circuit logic.
21790 That is, they stop processing their arguments when it's clear what the
21791 result of the operation will be. For instance, if one of the arguments
21792 of an @code{&} evaluates to @code{false}, there's no point in evaluating
21793 the rest of the arguments. This means that you should put slow matches
21794 (@samp{body}, @samp{header}) last and quick matches (@samp{from},
21795 @samp{subject}) first.
21797 The indirection arguments (@code{1-} and so on) will make their
21798 arguments work on previous generations of the thread. If you say
21809 Then that means ``score on the from header of the grandparent of the
21810 current article''. An indirection is quite fast, but it's better to say:
21816 ("subject" "Gnus")))
21823 (1- ("from" "Lars"))
21824 (1- ("subject" "Gnus")))
21829 @section Score Decays
21830 @cindex score decays
21833 You may find that your scores have a tendency to grow without
21834 bounds, especially if you're using adaptive scoring. If scores get too
21835 big, they lose all meaning---they simply max out and it's difficult to
21836 use them in any sensible way.
21838 @vindex gnus-decay-scores
21839 @findex gnus-decay-score
21840 @vindex gnus-decay-score-function
21841 Gnus provides a mechanism for decaying scores to help with this problem.
21842 When score files are loaded and @code{gnus-decay-scores} is
21843 non-@code{nil}, Gnus will run the score files through the decaying
21844 mechanism thereby lowering the scores of all non-permanent score rules.
21845 If @code{gnus-decay-scores} is a regexp, only score files matching this
21846 regexp are treated. E.g. you may set it to @samp{\\.ADAPT\\'} if only
21847 @emph{adaptive} score files should be decayed. The decay itself if
21848 performed by the @code{gnus-decay-score-function} function, which is
21849 @code{gnus-decay-score} by default. Here's the definition of that
21853 (defun gnus-decay-score (score)
21854 "Decay SCORE according to `gnus-score-decay-constant'
21855 and `gnus-score-decay-scale'."
21857 (* (if (< score 0) -1 1)
21859 (max gnus-score-decay-constant
21861 gnus-score-decay-scale)))))))
21862 (if (and (featurep 'xemacs)
21863 ;; XEmacs' floor can handle only the floating point
21864 ;; number below the half of the maximum integer.
21865 (> (abs n) (lsh -1 -2)))
21867 (car (split-string (number-to-string n) "\\.")))
21871 @vindex gnus-score-decay-scale
21872 @vindex gnus-score-decay-constant
21873 @code{gnus-score-decay-constant} is 3 by default and
21874 @code{gnus-score-decay-scale} is 0.05. This should cause the following:
21878 Scores between -3 and 3 will be set to 0 when this function is called.
21881 Scores with magnitudes between 3 and 60 will be shrunk by 3.
21884 Scores with magnitudes greater than 60 will be shrunk by 5% of the
21888 If you don't like this decay function, write your own. It is called
21889 with the score to be decayed as its only parameter, and it should return
21890 the new score, which should be an integer.
21892 Gnus will try to decay scores once a day. If you haven't run Gnus for
21893 four days, Gnus will decay the scores four times, for instance.
21898 @include message.texi
21899 @chapter Emacs MIME
21900 @include emacs-mime.texi
21902 @include sieve.texi
21914 * Process/Prefix:: A convention used by many treatment commands.
21915 * Interactive:: Making Gnus ask you many questions.
21916 * Symbolic Prefixes:: How to supply some Gnus functions with options.
21917 * Formatting Variables:: You can specify what buffers should look like.
21918 * Window Layout:: Configuring the Gnus buffer windows.
21919 * Faces and Fonts:: How to change how faces look.
21920 * Compilation:: How to speed Gnus up.
21921 * Mode Lines:: Displaying information in the mode lines.
21922 * Highlighting and Menus:: Making buffers look all nice and cozy.
21923 * Buttons:: Get tendinitis in ten easy steps!
21924 * Daemons:: Gnus can do things behind your back.
21925 * NoCeM:: How to avoid spam and other fatty foods.
21926 * Undo:: Some actions can be undone.
21927 * Predicate Specifiers:: Specifying predicates.
21928 * Moderation:: What to do if you're a moderator.
21929 * Fetching a Group:: Starting Gnus just to read a group.
21930 * Image Enhancements:: Modern versions of Emacs/XEmacs can display images.
21931 * Fuzzy Matching:: What's the big fuzz?
21932 * Thwarting Email Spam:: Simple ways to avoid unsolicited commercial email.
21933 * Spam Package:: A package for filtering and processing spam.
21934 * Other modes:: Interaction with other modes.
21935 * Various Various:: Things that are really various.
21939 @node Process/Prefix
21940 @section Process/Prefix
21941 @cindex process/prefix convention
21943 Many functions, among them functions for moving, decoding and saving
21944 articles, use what is known as the @dfn{Process/Prefix convention}.
21946 This is a method for figuring out what articles the user wants the
21947 command to be performed on.
21951 If the numeric prefix is N, perform the operation on the next N
21952 articles, starting with the current one. If the numeric prefix is
21953 negative, perform the operation on the previous N articles, starting
21954 with the current one.
21956 @vindex transient-mark-mode
21957 If @code{transient-mark-mode} in non-@code{nil} and the region is
21958 active, all articles in the region will be worked upon.
21960 If there is no numeric prefix, but some articles are marked with the
21961 process mark, perform the operation on the articles marked with
21964 If there is neither a numeric prefix nor any articles marked with the
21965 process mark, just perform the operation on the current article.
21967 Quite simple, really, but it needs to be made clear so that surprises
21970 Commands that react to the process mark will push the current list of
21971 process marked articles onto a stack and will then clear all process
21972 marked articles. You can restore the previous configuration with the
21973 @kbd{M P y} command (@pxref{Setting Process Marks}).
21975 @vindex gnus-summary-goto-unread
21976 One thing that seems to shock & horrify lots of people is that, for
21977 instance, @kbd{3 d} does exactly the same as @kbd{d} @kbd{d} @kbd{d}.
21978 Since each @kbd{d} (which marks the current article as read) by default
21979 goes to the next unread article after marking, this means that @kbd{3 d}
21980 will mark the next three unread articles as read, no matter what the
21981 summary buffer looks like. Set @code{gnus-summary-goto-unread} to
21982 @code{nil} for a more straightforward action.
21984 Many commands do not use the process/prefix convention. All commands
21985 that do explicitly say so in this manual. To apply the process/prefix
21986 convention to commands that do not use it, you can use the @kbd{M-&}
21987 command. For instance, to mark all the articles in the group as
21988 expirable, you could say @kbd{M P b M-& E}.
21992 @section Interactive
21993 @cindex interaction
21997 @item gnus-novice-user
21998 @vindex gnus-novice-user
21999 If this variable is non-@code{nil}, you are either a newcomer to the
22000 World of Usenet, or you are very cautious, which is a nice thing to be,
22001 really. You will be given questions of the type ``Are you sure you want
22002 to do this?'' before doing anything dangerous. This is @code{t} by
22005 @item gnus-expert-user
22006 @vindex gnus-expert-user
22007 If this variable is non-@code{nil}, you will seldom be asked any
22008 questions by Gnus. It will simply assume you know what you're doing, no
22009 matter how strange.
22011 @item gnus-interactive-catchup
22012 @vindex gnus-interactive-catchup
22013 Require confirmation before catching up a group if non-@code{nil}. It
22014 is @code{t} by default.
22016 @item gnus-interactive-exit
22017 @vindex gnus-interactive-exit
22018 Require confirmation before exiting Gnus. This variable is @code{t} by
22023 @node Symbolic Prefixes
22024 @section Symbolic Prefixes
22025 @cindex symbolic prefixes
22027 Quite a lot of Emacs commands react to the (numeric) prefix. For
22028 instance, @kbd{C-u 4 C-f} moves point four characters forward, and
22029 @kbd{C-u 9 0 0 I s s p} adds a permanent @code{Subject} substring score
22030 rule of 900 to the current article.
22032 This is all nice and well, but what if you want to give a command some
22033 additional information? Well, what most commands do is interpret the
22034 ``raw'' prefix in some special way. @kbd{C-u 0 C-x C-s} means that one
22035 doesn't want a backup file to be created when saving the current buffer,
22036 for instance. But what if you want to save without making a backup
22037 file, and you want Emacs to flash lights and play a nice tune at the
22038 same time? You can't, and you're probably perfectly happy that way.
22040 @kindex M-i (Summary)
22041 @findex gnus-symbolic-argument
22042 I'm not, so I've added a second prefix---the @dfn{symbolic prefix}. The
22043 prefix key is @kbd{M-i} (@code{gnus-symbolic-argument}), and the next
22044 character typed in is the value. You can stack as many @kbd{M-i}
22045 prefixes as you want. @kbd{M-i a C-M-u} means ``feed the @kbd{C-M-u}
22046 command the symbolic prefix @code{a}''. @kbd{M-i a M-i b C-M-u} means
22047 ``feed the @kbd{C-M-u} command the symbolic prefixes @code{a} and
22048 @code{b}''. You get the drift.
22050 Typing in symbolic prefixes to commands that don't accept them doesn't
22051 hurt, but it doesn't do any good either. Currently not many Gnus
22052 functions make use of the symbolic prefix.
22054 If you're interested in how Gnus implements this, @pxref{Extended
22058 @node Formatting Variables
22059 @section Formatting Variables
22060 @cindex formatting variables
22062 Throughout this manual you've probably noticed lots of variables called
22063 things like @code{gnus-group-line-format} and
22064 @code{gnus-summary-mode-line-format}. These control how Gnus is to
22065 output lines in the various buffers. There's quite a lot of them.
22066 Fortunately, they all use the same syntax, so there's not that much to
22069 Here's an example format spec (from the group buffer): @samp{%M%S%5y:
22070 %(%g%)\n}. We see that it is indeed extremely ugly, and that there are
22071 lots of percentages everywhere.
22074 * Formatting Basics:: A formatting variable is basically a format string.
22075 * Mode Line Formatting:: Some rules about mode line formatting variables.
22076 * Advanced Formatting:: Modifying output in various ways.
22077 * User-Defined Specs:: Having Gnus call your own functions.
22078 * Formatting Fonts:: Making the formatting look colorful and nice.
22079 * Positioning Point:: Moving point to a position after an operation.
22080 * Tabulation:: Tabulating your output.
22081 * Wide Characters:: Dealing with wide characters.
22084 Currently Gnus uses the following formatting variables:
22085 @code{gnus-group-line-format}, @code{gnus-summary-line-format},
22086 @code{gnus-server-line-format}, @code{gnus-topic-line-format},
22087 @code{gnus-group-mode-line-format},
22088 @code{gnus-summary-mode-line-format},
22089 @code{gnus-article-mode-line-format},
22090 @code{gnus-server-mode-line-format}, and
22091 @code{gnus-summary-pick-line-format}.
22093 All these format variables can also be arbitrary elisp forms. In that
22094 case, they will be @code{eval}ed to insert the required lines.
22096 @kindex M-x gnus-update-format
22097 @findex gnus-update-format
22098 Gnus includes a command to help you while creating your own format
22099 specs. @kbd{M-x gnus-update-format} will @code{eval} the current form,
22100 update the spec in question and pop you to a buffer where you can
22101 examine the resulting Lisp code to be run to generate the line.
22105 @node Formatting Basics
22106 @subsection Formatting Basics
22108 Each @samp{%} element will be replaced by some string or other when the
22109 buffer in question is generated. @samp{%5y} means ``insert the @samp{y}
22110 spec, and pad with spaces to get a 5-character field''.
22112 As with normal C and Emacs Lisp formatting strings, the numerical
22113 modifier between the @samp{%} and the formatting type character will
22114 @dfn{pad} the output so that it is always at least that long.
22115 @samp{%5y} will make the field always (at least) five characters wide by
22116 padding with spaces to the left. If you say @samp{%-5y}, it will pad to
22119 You may also wish to limit the length of the field to protect against
22120 particularly wide values. For that you can say @samp{%4,6y}, which
22121 means that the field will never be more than 6 characters wide and never
22122 less than 4 characters wide.
22124 Also Gnus supports some extended format specifications, such as
22125 @samp{%&user-date;}.
22128 @node Mode Line Formatting
22129 @subsection Mode Line Formatting
22131 Mode line formatting variables (e.g.,
22132 @code{gnus-summary-mode-line-format}) follow the same rules as other,
22133 buffer line oriented formatting variables (@pxref{Formatting Basics})
22134 with the following two differences:
22139 There must be no newline (@samp{\n}) at the end.
22142 The special @samp{%%b} spec can be used to display the buffer name.
22143 Well, it's no spec at all, really---@samp{%%} is just a way to quote
22144 @samp{%} to allow it to pass through the formatting machinery unmangled,
22145 so that Emacs receives @samp{%b}, which is something the Emacs mode line
22146 display interprets to mean ``show the buffer name''. For a full list of
22147 mode line specs Emacs understands, see the documentation of the
22148 @code{mode-line-format} variable.
22153 @node Advanced Formatting
22154 @subsection Advanced Formatting
22156 It is frequently useful to post-process the fields in some way.
22157 Padding, limiting, cutting off parts and suppressing certain values can
22158 be achieved by using @dfn{tilde modifiers}. A typical tilde spec might
22159 look like @samp{%~(cut 3)~(ignore "0")y}.
22161 These are the valid modifiers:
22166 Pad the field to the left with spaces until it reaches the required
22170 Pad the field to the right with spaces until it reaches the required
22175 Cut off characters from the left until it reaches the specified length.
22178 Cut off characters from the right until it reaches the specified
22183 Cut off the specified number of characters from the left.
22186 Cut off the specified number of characters from the right.
22189 Return an empty string if the field is equal to the specified value.
22192 Use the specified form as the field value when the @samp{@@} spec is
22198 "~(form (current-time-string))@@"
22203 Let's take an example. The @samp{%o} spec in the summary mode lines
22204 will return a date in compact ISO8601 format---@samp{19960809T230410}.
22205 This is quite a mouthful, so we want to shave off the century number and
22206 the time, leaving us with a six-character date. That would be
22207 @samp{%~(cut-left 2)~(max-right 6)~(pad 6)o}. (Cutting is done before
22208 maxing, and we need the padding to ensure that the date is never less
22209 than 6 characters to make it look nice in columns.)
22211 Ignoring is done first; then cutting; then maxing; and then as the very
22212 last operation, padding.
22214 If you use lots of these advanced thingies, you'll find that Gnus gets
22215 quite slow. This can be helped enormously by running @kbd{M-x
22216 gnus-compile} when you are satisfied with the look of your lines.
22217 @xref{Compilation}.
22220 @node User-Defined Specs
22221 @subsection User-Defined Specs
22223 All the specs allow for inserting user defined specifiers---@samp{u}.
22224 The next character in the format string should be a letter. Gnus
22225 will call the function @code{gnus-user-format-function-}@samp{X}, where
22226 @samp{X} is the letter following @samp{%u}. The function will be passed
22227 a single parameter---what the parameter means depends on what buffer
22228 it's being called from. The function should return a string, which will
22229 be inserted into the buffer just like information from any other
22230 specifier. This function may also be called with dummy values, so it
22231 should protect against that.
22233 Also Gnus supports extended user-defined specs, such as @samp{%u&foo;}.
22234 Gnus will call the function @code{gnus-user-format-function-}@samp{foo}.
22236 You can also use tilde modifiers (@pxref{Advanced Formatting} to achieve
22237 much the same without defining new functions. Here's an example:
22238 @samp{%~(form (count-lines (point-min) (point)))@@}. The form
22239 given here will be evaluated to yield the current line number, and then
22243 @node Formatting Fonts
22244 @subsection Formatting Fonts
22246 There are specs for highlighting, and these are shared by all the format
22247 variables. Text inside the @samp{%(} and @samp{%)} specifiers will get
22248 the special @code{mouse-face} property set, which means that it will be
22249 highlighted (with @code{gnus-mouse-face}) when you put the mouse pointer
22252 Text inside the @samp{%@{} and @samp{%@}} specifiers will have their
22253 normal faces set using @code{gnus-face-0}, which is @code{bold} by
22254 default. If you say @samp{%1@{}, you'll get @code{gnus-face-1} instead,
22255 and so on. Create as many faces as you wish. The same goes for the
22256 @code{mouse-face} specs---you can say @samp{%3(hello%)} to have
22257 @samp{hello} mouse-highlighted with @code{gnus-mouse-face-3}.
22259 Text inside the @samp{%<<} and @samp{%>>} specifiers will get the
22260 special @code{balloon-help} property set to
22261 @code{gnus-balloon-face-0}. If you say @samp{%1<<}, you'll get
22262 @code{gnus-balloon-face-1} and so on. The @code{gnus-balloon-face-*}
22263 variables should be either strings or symbols naming functions that
22264 return a string. When the mouse passes over text with this property
22265 set, a balloon window will appear and display the string. Please
22266 refer to @ref{Tooltips, ,Tooltips, emacs, The Emacs Manual},
22267 (in GNU Emacs) or the doc string of @code{balloon-help-mode} (in
22268 XEmacs) for more information on this. (For technical reasons, the
22269 guillemets have been approximated as @samp{<<} and @samp{>>} in this
22272 Here's an alternative recipe for the group buffer:
22275 ;; @r{Create three face types.}
22276 (setq gnus-face-1 'bold)
22277 (setq gnus-face-3 'italic)
22279 ;; @r{We want the article count to be in}
22280 ;; @r{a bold and green face. So we create}
22281 ;; @r{a new face called @code{my-green-bold}.}
22282 (copy-face 'bold 'my-green-bold)
22283 ;; @r{Set the color.}
22284 (set-face-foreground 'my-green-bold "ForestGreen")
22285 (setq gnus-face-2 'my-green-bold)
22287 ;; @r{Set the new & fancy format.}
22288 (setq gnus-group-line-format
22289 "%M%S%3@{%5y%@}%2[:%] %(%1@{%g%@}%)\n")
22292 I'm sure you'll be able to use this scheme to create totally unreadable
22293 and extremely vulgar displays. Have fun!
22295 Note that the @samp{%(} specs (and friends) do not make any sense on the
22296 mode-line variables.
22298 @node Positioning Point
22299 @subsection Positioning Point
22301 Gnus usually moves point to a pre-defined place on each line in most
22302 buffers. By default, point move to the first colon character on the
22303 line. You can customize this behavior in three different ways.
22305 You can move the colon character to somewhere else on the line.
22307 @findex gnus-goto-colon
22308 You can redefine the function that moves the point to the colon. The
22309 function is called @code{gnus-goto-colon}.
22311 But perhaps the most convenient way to deal with this, if you don't want
22312 to have a colon in your line, is to use the @samp{%*} specifier. If you
22313 put a @samp{%*} somewhere in your format line definition, Gnus will
22318 @subsection Tabulation
22320 You can usually line up your displays by padding and cutting your
22321 strings. However, when combining various strings of different size, it
22322 can often be more convenient to just output the strings, and then worry
22323 about lining up the following text afterwards.
22325 To do that, Gnus supplies tabulator specs---@samp{%=}. There are two
22326 different types---@dfn{hard tabulators} and @dfn{soft tabulators}.
22328 @samp{%50=} will insert space characters to pad the line up to column
22329 50. If the text is already past column 50, nothing will be inserted.
22330 This is the soft tabulator.
22332 @samp{%-50=} will insert space characters to pad the line up to column
22333 50. If the text is already past column 50, the excess text past column
22334 50 will be removed. This is the hard tabulator.
22337 @node Wide Characters
22338 @subsection Wide Characters
22340 Fixed width fonts in most countries have characters of the same width.
22341 Some countries, however, use Latin characters mixed with wider
22342 characters---most notable East Asian countries.
22344 The problem is that when formatting, Gnus assumes that if a string is 10
22345 characters wide, it'll be 10 Latin characters wide on the screen. In
22346 these countries, that's not true.
22348 @vindex gnus-use-correct-string-widths
22349 To help fix this, you can set @code{gnus-use-correct-string-widths} to
22350 @code{t}. This makes buffer generation slower, but the results will be
22351 prettier. The default value under XEmacs is @code{t} but @code{nil}
22355 @node Window Layout
22356 @section Window Layout
22357 @cindex window layout
22359 No, there's nothing here about X, so be quiet.
22361 @vindex gnus-use-full-window
22362 If @code{gnus-use-full-window} non-@code{nil}, Gnus will delete all
22363 other windows and occupy the entire Emacs screen by itself. It is
22364 @code{t} by default.
22366 Setting this variable to @code{nil} kinda works, but there are
22367 glitches. Use at your own peril.
22369 @vindex gnus-buffer-configuration
22370 @code{gnus-buffer-configuration} describes how much space each Gnus
22371 buffer should be given. Here's an excerpt of this variable:
22374 ((group (vertical 1.0 (group 1.0 point)
22375 (if gnus-carpal (group-carpal 4))))
22376 (article (vertical 1.0 (summary 0.25 point)
22380 This is an alist. The @dfn{key} is a symbol that names some action or
22381 other. For instance, when displaying the group buffer, the window
22382 configuration function will use @code{group} as the key. A full list of
22383 possible names is listed below.
22385 The @dfn{value} (i.e., the @dfn{split}) says how much space each buffer
22386 should occupy. To take the @code{article} split as an example -
22389 (article (vertical 1.0 (summary 0.25 point)
22393 This @dfn{split} says that the summary buffer should occupy 25% of upper
22394 half of the screen, and that it is placed over the article buffer. As
22395 you may have noticed, 100% + 25% is actually 125% (yup, I saw y'all
22396 reaching for that calculator there). However, the special number
22397 @code{1.0} is used to signal that this buffer should soak up all the
22398 rest of the space available after the rest of the buffers have taken
22399 whatever they need. There should be only one buffer with the @code{1.0}
22400 size spec per split.
22402 Point will be put in the buffer that has the optional third element
22403 @code{point}. In a @code{frame} split, the last subsplit having a leaf
22404 split where the tag @code{frame-focus} is a member (i.e. is the third or
22405 fourth element in the list, depending on whether the @code{point} tag is
22406 present) gets focus.
22408 Here's a more complicated example:
22411 (article (vertical 1.0 (group 4)
22412 (summary 0.25 point)
22413 (if gnus-carpal (summary-carpal 4))
22417 If the size spec is an integer instead of a floating point number,
22418 then that number will be used to say how many lines a buffer should
22419 occupy, not a percentage.
22421 If the @dfn{split} looks like something that can be @code{eval}ed (to be
22422 precise---if the @code{car} of the split is a function or a subr), this
22423 split will be @code{eval}ed. If the result is non-@code{nil}, it will
22424 be used as a split. This means that there will be three buffers if
22425 @code{gnus-carpal} is @code{nil}, and four buffers if @code{gnus-carpal}
22428 Not complicated enough for you? Well, try this on for size:
22431 (article (horizontal 1.0
22436 (summary 0.25 point)
22441 Whoops. Two buffers with the mystery 100% tag. And what's that
22442 @code{horizontal} thingie?
22444 If the first element in one of the split is @code{horizontal}, Gnus will
22445 split the window horizontally, giving you two windows side-by-side.
22446 Inside each of these strips you may carry on all you like in the normal
22447 fashion. The number following @code{horizontal} says what percentage of
22448 the screen is to be given to this strip.
22450 For each split, there @emph{must} be one element that has the 100% tag.
22451 The splitting is never accurate, and this buffer will eat any leftover
22452 lines from the splits.
22454 To be slightly more formal, here's a definition of what a valid split
22459 split = frame | horizontal | vertical | buffer | form
22460 frame = "(frame " size *split ")"
22461 horizontal = "(horizontal " size *split ")"
22462 vertical = "(vertical " size *split ")"
22463 buffer = "(" buf-name " " size *[ "point" ] *[ "frame-focus"] ")"
22464 size = number | frame-params
22465 buf-name = group | article | summary ...
22469 The limitations are that the @code{frame} split can only appear as the
22470 top-level split. @var{form} should be an Emacs Lisp form that should
22471 return a valid split. We see that each split is fully recursive, and
22472 may contain any number of @code{vertical} and @code{horizontal} splits.
22474 @vindex gnus-window-min-width
22475 @vindex gnus-window-min-height
22476 @cindex window height
22477 @cindex window width
22478 Finding the right sizes can be a bit complicated. No window may be less
22479 than @code{gnus-window-min-height} (default 1) characters high, and all
22480 windows must be at least @code{gnus-window-min-width} (default 1)
22481 characters wide. Gnus will try to enforce this before applying the
22482 splits. If you want to use the normal Emacs window width/height limit,
22483 you can just set these two variables to @code{nil}.
22485 If you're not familiar with Emacs terminology, @code{horizontal} and
22486 @code{vertical} splits may work the opposite way of what you'd expect.
22487 Windows inside a @code{horizontal} split are shown side-by-side, and
22488 windows within a @code{vertical} split are shown above each other.
22490 @findex gnus-configure-frame
22491 If you want to experiment with window placement, a good tip is to call
22492 @code{gnus-configure-frame} directly with a split. This is the function
22493 that does all the real work when splitting buffers. Below is a pretty
22494 nonsensical configuration with 5 windows; two for the group buffer and
22495 three for the article buffer. (I said it was nonsensical.) If you
22496 @code{eval} the statement below, you can get an idea of how that would
22497 look straight away, without going through the normal Gnus channels.
22498 Play with it until you're satisfied, and then use
22499 @code{gnus-add-configuration} to add your new creation to the buffer
22500 configuration list.
22503 (gnus-configure-frame
22507 (article 0.3 point))
22515 You might want to have several frames as well. No prob---just use the
22516 @code{frame} split:
22519 (gnus-configure-frame
22522 (summary 0.25 point frame-focus)
22524 (vertical ((height . 5) (width . 15)
22525 (user-position . t)
22526 (left . -1) (top . 1))
22531 This split will result in the familiar summary/article window
22532 configuration in the first (or ``main'') frame, while a small additional
22533 frame will be created where picons will be shown. As you can see,
22534 instead of the normal @code{1.0} top-level spec, each additional split
22535 should have a frame parameter alist as the size spec.
22536 @xref{Frame Parameters, , Frame Parameters, elisp, The GNU Emacs Lisp
22537 Reference Manual}. Under XEmacs, a frame property list will be
22538 accepted, too---for instance, @code{(height 5 width 15 left -1 top 1)}
22540 The list of all possible keys for @code{gnus-buffer-configuration} can
22541 be found in its default value.
22543 Note that the @code{message} key is used for both
22544 @code{gnus-group-mail} and @code{gnus-summary-mail-other-window}. If
22545 it is desirable to distinguish between the two, something like this
22549 (message (horizontal 1.0
22550 (vertical 1.0 (message 1.0 point))
22552 (if (buffer-live-p gnus-summary-buffer)
22557 One common desire for a multiple frame split is to have a separate frame
22558 for composing mail and news while leaving the original frame intact. To
22559 accomplish that, something like the following can be done:
22564 (if (not (buffer-live-p gnus-summary-buffer))
22565 (car (cdr (assoc 'group gnus-buffer-configuration)))
22566 (car (cdr (assoc 'summary gnus-buffer-configuration))))
22567 (vertical ((user-position . t) (top . 1) (left . 1)
22568 (name . "Message"))
22569 (message 1.0 point))))
22572 @findex gnus-add-configuration
22573 Since the @code{gnus-buffer-configuration} variable is so long and
22574 complicated, there's a function you can use to ease changing the config
22575 of a single setting: @code{gnus-add-configuration}. If, for instance,
22576 you want to change the @code{article} setting, you could say:
22579 (gnus-add-configuration
22580 '(article (vertical 1.0
22582 (summary .25 point)
22586 You'd typically stick these @code{gnus-add-configuration} calls in your
22587 @file{~/.gnus.el} file or in some startup hook---they should be run after
22588 Gnus has been loaded.
22590 @vindex gnus-always-force-window-configuration
22591 If all windows mentioned in the configuration are already visible, Gnus
22592 won't change the window configuration. If you always want to force the
22593 ``right'' window configuration, you can set
22594 @code{gnus-always-force-window-configuration} to non-@code{nil}.
22596 If you're using tree displays (@pxref{Tree Display}), and the tree
22597 window is displayed vertically next to another window, you may also want
22598 to fiddle with @code{gnus-tree-minimize-window} to avoid having the
22601 @subsection Example Window Configurations
22605 Narrow left hand side occupied by group buffer. Right hand side split
22606 between summary buffer (top one-sixth) and article buffer (bottom).
22621 (gnus-add-configuration
22624 (vertical 25 (group 1.0))
22626 (summary 0.16 point)
22629 (gnus-add-configuration
22632 (vertical 25 (group 1.0))
22633 (vertical 1.0 (summary 1.0 point)))))
22639 @node Faces and Fonts
22640 @section Faces and Fonts
22645 Fiddling with fonts and faces used to be very difficult, but these days
22646 it is very simple. You simply say @kbd{M-x customize-face}, pick out
22647 the face you want to alter, and alter it via the standard Customize
22652 @section Compilation
22653 @cindex compilation
22654 @cindex byte-compilation
22656 @findex gnus-compile
22658 Remember all those line format specification variables?
22659 @code{gnus-summary-line-format}, @code{gnus-group-line-format}, and so
22660 on. Now, Gnus will of course heed whatever these variables are, but,
22661 unfortunately, changing them will mean a quite significant slow-down.
22662 (The default values of these variables have byte-compiled functions
22663 associated with them, while the user-generated versions do not, of
22666 To help with this, you can run @kbd{M-x gnus-compile} after you've
22667 fiddled around with the variables and feel that you're (kind of)
22668 satisfied. This will result in the new specs being byte-compiled, and
22669 you'll get top speed again. Gnus will save these compiled specs in the
22670 @file{.newsrc.eld} file. (User-defined functions aren't compiled by
22671 this function, though---you should compile them yourself by sticking
22672 them into the @file{~/.gnus.el} file and byte-compiling that file.)
22676 @section Mode Lines
22679 @vindex gnus-updated-mode-lines
22680 @code{gnus-updated-mode-lines} says what buffers should keep their mode
22681 lines updated. It is a list of symbols. Supported symbols include
22682 @code{group}, @code{article}, @code{summary}, @code{server},
22683 @code{browse}, and @code{tree}. If the corresponding symbol is present,
22684 Gnus will keep that mode line updated with information that may be
22685 pertinent. If this variable is @code{nil}, screen refresh may be
22688 @cindex display-time
22690 @vindex gnus-mode-non-string-length
22691 By default, Gnus displays information on the current article in the mode
22692 lines of the summary and article buffers. The information Gnus wishes
22693 to display (e.g. the subject of the article) is often longer than the
22694 mode lines, and therefore have to be cut off at some point. The
22695 @code{gnus-mode-non-string-length} variable says how long the other
22696 elements on the line is (i.e., the non-info part). If you put
22697 additional elements on the mode line (e.g. a clock), you should modify
22700 @c Hook written by Francesco Potorti` <pot@cnuce.cnr.it>
22702 (add-hook 'display-time-hook
22703 (lambda () (setq gnus-mode-non-string-length
22705 (if line-number-mode 5 0)
22706 (if column-number-mode 4 0)
22707 (length display-time-string)))))
22710 If this variable is @code{nil} (which is the default), the mode line
22711 strings won't be chopped off, and they won't be padded either. Note
22712 that the default is unlikely to be desirable, as even the percentage
22713 complete in the buffer may be crowded off the mode line; the user should
22714 configure this variable appropriately for her configuration.
22717 @node Highlighting and Menus
22718 @section Highlighting and Menus
22720 @cindex highlighting
22723 @vindex gnus-visual
22724 The @code{gnus-visual} variable controls most of the Gnus-prettifying
22725 aspects. If @code{nil}, Gnus won't attempt to create menus or use fancy
22726 colors or fonts. This will also inhibit loading the @file{gnus-vis.el}
22729 This variable can be a list of visual properties that are enabled. The
22730 following elements are valid, and are all included by default:
22733 @item group-highlight
22734 Do highlights in the group buffer.
22735 @item summary-highlight
22736 Do highlights in the summary buffer.
22737 @item article-highlight
22738 Do highlights in the article buffer.
22740 Turn on highlighting in all buffers.
22742 Create menus in the group buffer.
22744 Create menus in the summary buffers.
22746 Create menus in the article buffer.
22748 Create menus in the browse buffer.
22750 Create menus in the server buffer.
22752 Create menus in the score buffers.
22754 Create menus in all buffers.
22757 So if you only want highlighting in the article buffer and menus in all
22758 buffers, you could say something like:
22761 (setq gnus-visual '(article-highlight menu))
22764 If you want highlighting only and no menus whatsoever, you'd say:
22767 (setq gnus-visual '(highlight))
22770 If @code{gnus-visual} is @code{t}, highlighting and menus will be used
22771 in all Gnus buffers.
22773 Other general variables that influence the look of all buffers include:
22776 @item gnus-mouse-face
22777 @vindex gnus-mouse-face
22778 This is the face (i.e., font) used for mouse highlighting in Gnus. No
22779 mouse highlights will be done if @code{gnus-visual} is @code{nil}.
22783 There are hooks associated with the creation of all the different menus:
22787 @item gnus-article-menu-hook
22788 @vindex gnus-article-menu-hook
22789 Hook called after creating the article mode menu.
22791 @item gnus-group-menu-hook
22792 @vindex gnus-group-menu-hook
22793 Hook called after creating the group mode menu.
22795 @item gnus-summary-menu-hook
22796 @vindex gnus-summary-menu-hook
22797 Hook called after creating the summary mode menu.
22799 @item gnus-server-menu-hook
22800 @vindex gnus-server-menu-hook
22801 Hook called after creating the server mode menu.
22803 @item gnus-browse-menu-hook
22804 @vindex gnus-browse-menu-hook
22805 Hook called after creating the browse mode menu.
22807 @item gnus-score-menu-hook
22808 @vindex gnus-score-menu-hook
22809 Hook called after creating the score mode menu.
22820 Those new-fangled @dfn{mouse} contraptions is very popular with the
22821 young, hep kids who don't want to learn the proper way to do things
22822 these days. Why, I remember way back in the summer of '89, when I was
22823 using Emacs on a Tops 20 system. Three hundred users on one single
22824 machine, and every user was running Simula compilers. Bah!
22828 @vindex gnus-carpal
22829 Well, you can make Gnus display bufferfuls of buttons you can click to
22830 do anything by setting @code{gnus-carpal} to @code{t}. Pretty simple,
22831 really. Tell the chiropractor I sent you.
22836 @item gnus-carpal-mode-hook
22837 @vindex gnus-carpal-mode-hook
22838 Hook run in all carpal mode buffers.
22840 @item gnus-carpal-button-face
22841 @vindex gnus-carpal-button-face
22842 Face used on buttons.
22844 @item gnus-carpal-header-face
22845 @vindex gnus-carpal-header-face
22846 Face used on carpal buffer headers.
22848 @item gnus-carpal-group-buffer-buttons
22849 @vindex gnus-carpal-group-buffer-buttons
22850 Buttons in the group buffer.
22852 @item gnus-carpal-summary-buffer-buttons
22853 @vindex gnus-carpal-summary-buffer-buttons
22854 Buttons in the summary buffer.
22856 @item gnus-carpal-server-buffer-buttons
22857 @vindex gnus-carpal-server-buffer-buttons
22858 Buttons in the server buffer.
22860 @item gnus-carpal-browse-buffer-buttons
22861 @vindex gnus-carpal-browse-buffer-buttons
22862 Buttons in the browse buffer.
22865 All the @code{buttons} variables are lists. The elements in these list
22866 are either cons cells where the @code{car} contains a text to be displayed and
22867 the @code{cdr} contains a function symbol, or a simple string.
22875 Gnus, being larger than any program ever written (allegedly), does lots
22876 of strange stuff that you may wish to have done while you're not
22877 present. For instance, you may want it to check for new mail once in a
22878 while. Or you may want it to close down all connections to all servers
22879 when you leave Emacs idle. And stuff like that.
22881 Gnus will let you do stuff like that by defining various
22882 @dfn{handlers}. Each handler consists of three elements: A
22883 @var{function}, a @var{time}, and an @var{idle} parameter.
22885 Here's an example of a handler that closes connections when Emacs has
22886 been idle for thirty minutes:
22889 (gnus-demon-close-connections nil 30)
22892 Here's a handler that scans for @acronym{PGP} headers every hour when
22896 (gnus-demon-scan-pgp 60 t)
22899 This @var{time} parameter and that @var{idle} parameter work together
22900 in a strange, but wonderful fashion. Basically, if @var{idle} is
22901 @code{nil}, then the function will be called every @var{time} minutes.
22903 If @var{idle} is @code{t}, then the function will be called after
22904 @var{time} minutes only if Emacs is idle. So if Emacs is never idle,
22905 the function will never be called. But once Emacs goes idle, the
22906 function will be called every @var{time} minutes.
22908 If @var{idle} is a number and @var{time} is a number, the function will
22909 be called every @var{time} minutes only when Emacs has been idle for
22910 @var{idle} minutes.
22912 If @var{idle} is a number and @var{time} is @code{nil}, the function
22913 will be called once every time Emacs has been idle for @var{idle}
22916 And if @var{time} is a string, it should look like @samp{07:31}, and
22917 the function will then be called once every day somewhere near that
22918 time. Modified by the @var{idle} parameter, of course.
22920 @vindex gnus-demon-timestep
22921 (When I say ``minute'' here, I really mean @code{gnus-demon-timestep}
22922 seconds. This is 60 by default. If you change that variable,
22923 all the timings in the handlers will be affected.)
22925 So, if you want to add a handler, you could put something like this in
22926 your @file{~/.gnus.el} file:
22928 @findex gnus-demon-add-handler
22930 (gnus-demon-add-handler 'gnus-demon-close-connections 30 t)
22933 @findex gnus-demon-add-nocem
22934 @findex gnus-demon-add-scanmail
22935 @findex gnus-demon-add-rescan
22936 @findex gnus-demon-add-scan-timestamps
22937 @findex gnus-demon-add-disconnection
22938 Some ready-made functions to do this have been created:
22939 @code{gnus-demon-add-nocem}, @code{gnus-demon-add-disconnection},
22940 @code{gnus-demon-add-nntp-close-connection},
22941 @code{gnus-demon-add-scan-timestamps}, @code{gnus-demon-add-rescan}, and
22942 @code{gnus-demon-add-scanmail}. Just put those functions in your
22943 @file{~/.gnus.el} if you want those abilities.
22945 @findex gnus-demon-init
22946 @findex gnus-demon-cancel
22947 @vindex gnus-demon-handlers
22948 If you add handlers to @code{gnus-demon-handlers} directly, you should
22949 run @code{gnus-demon-init} to make the changes take hold. To cancel all
22950 daemons, you can use the @code{gnus-demon-cancel} function.
22952 Note that adding daemons can be pretty naughty if you over do it. Adding
22953 functions that scan all news and mail from all servers every two seconds
22954 is a sure-fire way of getting booted off any respectable system. So
22963 @dfn{Spamming} is posting the same article lots and lots of times.
22964 Spamming is bad. Spamming is evil.
22966 Spamming is usually canceled within a day or so by various anti-spamming
22967 agencies. These agencies usually also send out @dfn{NoCeM} messages.
22968 NoCeM is pronounced ``no see-'em'', and means what the name
22969 implies---these are messages that make the offending articles, like, go
22972 What use are these NoCeM messages if the articles are canceled anyway?
22973 Some sites do not honor cancel messages and some sites just honor cancels
22974 from a select few people. Then you may wish to make use of the NoCeM
22975 messages, which are distributed in the @samp{alt.nocem.misc} newsgroup.
22977 Gnus can read and parse the messages in this group automatically, and
22978 this will make spam disappear.
22980 There are some variables to customize, of course:
22983 @item gnus-use-nocem
22984 @vindex gnus-use-nocem
22985 Set this variable to @code{t} to set the ball rolling. It is @code{nil}
22988 You can also set this variable to a positive number as a group level.
22989 In that case, Gnus scans NoCeM messages when checking new news if this
22990 value is not exceeding a group level that you specify as the prefix
22991 argument to some commands, e.g. @code{gnus},
22992 @code{gnus-group-get-new-news}, etc. Otherwise, Gnus does not scan
22993 NoCeM messages if you specify a group level to those commands. For
22994 example, if you use 1 or 2 on the mail groups and the levels on the news
22995 groups remain the default, 3 is the best choice.
22997 @item gnus-nocem-groups
22998 @vindex gnus-nocem-groups
22999 Gnus will look for NoCeM messages in the groups in this list. The
23002 ("news.lists.filters" "news.admin.net-abuse.bulletins"
23003 "alt.nocem.misc" "news.admin.net-abuse.announce")
23006 @item gnus-nocem-issuers
23007 @vindex gnus-nocem-issuers
23008 There are many people issuing NoCeM messages. This list says what
23009 people you want to listen to. The default is
23011 ("Automoose-1" "clewis@@ferret.ocunix.on.ca"
23012 "cosmo.roadkill" "SpamHippo" "hweede@@snafu.de")
23014 fine, upstanding citizens all of them.
23016 Known despammers that you can put in this list are listed at@*
23017 @uref{http://www.xs4all.nl/~rosalind/nocemreg/nocemreg.html}.
23019 You do not have to heed NoCeM messages from all these people---just the
23020 ones you want to listen to. You also don't have to accept all NoCeM
23021 messages from the people you like. Each NoCeM message has a @dfn{type}
23022 header that gives the message a (more or less, usually less) rigorous
23023 definition. Common types are @samp{spam}, @samp{spew}, @samp{mmf},
23024 @samp{binary}, and @samp{troll}. To specify this, you have to use
23025 @code{(@var{issuer} @var{conditions} @dots{})} elements in the list.
23026 Each condition is either a string (which is a regexp that matches types
23027 you want to use) or a list on the form @code{(not @var{string})}, where
23028 @var{string} is a regexp that matches types you don't want to use.
23030 For instance, if you want all NoCeM messages from Chris Lewis except his
23031 @samp{troll} messages, you'd say:
23034 ("clewis@@ferret.ocunix.on.ca" ".*" (not "troll"))
23037 On the other hand, if you just want nothing but his @samp{spam} and
23038 @samp{spew} messages, you'd say:
23041 ("clewis@@ferret.ocunix.on.ca" (not ".*") "spew" "spam")
23044 The specs are applied left-to-right.
23047 @item gnus-nocem-verifyer
23048 @vindex gnus-nocem-verifyer
23050 This should be a function for verifying that the NoCeM issuer is who she
23051 says she is. The default is @code{pgg-verify}, which returns
23052 non-@code{nil} if the verification is successful, otherwise (including
23053 the case the NoCeM message was not signed) returns @code{nil}. If this
23054 is too slow and you don't care for verification (which may be dangerous),
23055 you can set this variable to @code{nil}.
23057 Formerly the default was @code{mc-verify}, which is a Mailcrypt
23058 function. While you can still use it, you can change it into
23059 @code{pgg-verify} running with GnuPG if you are willing to add the
23060 @acronym{PGP} public keys to GnuPG's keyring.
23062 @item gnus-nocem-directory
23063 @vindex gnus-nocem-directory
23064 This is where Gnus will store its NoCeM cache files. The default is@*
23065 @file{~/News/NoCeM/}.
23067 @item gnus-nocem-expiry-wait
23068 @vindex gnus-nocem-expiry-wait
23069 The number of days before removing old NoCeM entries from the cache.
23070 The default is 15. If you make it shorter Gnus will be faster, but you
23071 might then see old spam.
23073 @item gnus-nocem-check-from
23074 @vindex gnus-nocem-check-from
23075 Non-@code{nil} means check for valid issuers in message bodies.
23076 Otherwise don't bother fetching articles unless their author matches a
23077 valid issuer; that is much faster if you are selective about the
23080 @item gnus-nocem-check-article-limit
23081 @vindex gnus-nocem-check-article-limit
23082 If non-@code{nil}, the maximum number of articles to check in any NoCeM
23083 group. NoCeM groups can be huge and very slow to process.
23087 Using NoCeM could potentially be a memory hog. If you have many living
23088 (i. e., subscribed or unsubscribed groups), your Emacs process will grow
23089 big. If this is a problem, you should kill off all (or most) of your
23090 unsubscribed groups (@pxref{Subscription Commands}).
23097 It is very useful to be able to undo actions one has done. In normal
23098 Emacs buffers, it's easy enough---you just push the @code{undo} button.
23099 In Gnus buffers, however, it isn't that simple.
23101 The things Gnus displays in its buffer is of no value whatsoever to
23102 Gnus---it's all just data designed to look nice to the user.
23103 Killing a group in the group buffer with @kbd{C-k} makes the line
23104 disappear, but that's just a side-effect of the real action---the
23105 removal of the group in question from the internal Gnus structures.
23106 Undoing something like that can't be done by the normal Emacs
23107 @code{undo} function.
23109 Gnus tries to remedy this somewhat by keeping track of what the user
23110 does and coming up with actions that would reverse the actions the user
23111 takes. When the user then presses the @code{undo} key, Gnus will run
23112 the code to reverse the previous action, or the previous actions.
23113 However, not all actions are easily reversible, so Gnus currently offers
23114 a few key functions to be undoable. These include killing groups,
23115 yanking groups, and changing the list of read articles of groups.
23116 That's it, really. More functions may be added in the future, but each
23117 added function means an increase in data to be stored, so Gnus will
23118 never be totally undoable.
23120 @findex gnus-undo-mode
23121 @vindex gnus-use-undo
23123 The undoability is provided by the @code{gnus-undo-mode} minor mode. It
23124 is used if @code{gnus-use-undo} is non-@code{nil}, which is the
23125 default. The @kbd{C-M-_} key performs the @code{gnus-undo}
23126 command, which should feel kinda like the normal Emacs @code{undo}
23130 @node Predicate Specifiers
23131 @section Predicate Specifiers
23132 @cindex predicate specifiers
23134 Some Gnus variables are @dfn{predicate specifiers}. This is a special
23135 form that allows flexible specification of predicates without having
23136 to type all that much.
23138 These specifiers are lists consisting of functions, symbols and lists.
23143 (or gnus-article-unseen-p
23144 gnus-article-unread-p)
23147 The available symbols are @code{or}, @code{and} and @code{not}. The
23148 functions all take one parameter.
23150 @findex gnus-make-predicate
23151 Internally, Gnus calls @code{gnus-make-predicate} on these specifiers
23152 to create a function that can be called. This input parameter to this
23153 function will be passed along to all the functions in the predicate
23158 @section Moderation
23161 If you are a moderator, you can use the @file{gnus-mdrtn.el} package.
23162 It is not included in the standard Gnus package. Write a mail to
23163 @samp{larsi@@gnus.org} and state what group you moderate, and you'll
23166 The moderation package is implemented as a minor mode for summary
23170 (add-hook 'gnus-summary-mode-hook 'gnus-moderate)
23173 in your @file{~/.gnus.el} file.
23175 If you are the moderator of @samp{rec.zoofle}, this is how it's
23180 You split your incoming mail by matching on
23181 @samp{Newsgroups:.*rec.zoofle}, which will put all the to-be-posted
23182 articles in some mail group---for instance, @samp{nnml:rec.zoofle}.
23185 You enter that group once in a while and post articles using the @kbd{e}
23186 (edit-and-post) or @kbd{s} (just send unedited) commands.
23189 If, while reading the @samp{rec.zoofle} newsgroup, you happen upon some
23190 articles that weren't approved by you, you can cancel them with the
23194 To use moderation mode in these two groups, say:
23197 (setq gnus-moderated-list
23198 "^nnml:rec.zoofle$\\|^rec.zoofle$")
23202 @node Fetching a Group
23203 @section Fetching a Group
23204 @cindex fetching a group
23206 @findex gnus-fetch-group
23207 It is sometimes convenient to be able to just say ``I want to read this
23208 group and I don't care whether Gnus has been started or not''. This is
23209 perhaps more useful for people who write code than for users, but the
23210 command @code{gnus-fetch-group} provides this functionality in any case.
23211 It takes the group name as a parameter.
23214 @node Image Enhancements
23215 @section Image Enhancements
23217 XEmacs, as well as Emacs 21@footnote{Emacs 21 on MS Windows doesn't
23218 support images, Emacs 22 does.} and up, are able to display pictures and
23219 stuff, so Gnus has taken advantage of that.
23222 * X-Face:: Display a funky, teensy black-and-white image.
23223 * Face:: Display a funkier, teensier colored image.
23224 * Smileys:: Show all those happy faces the way they were meant to be shown.
23225 * Picons:: How to display pictures of what you're reading.
23226 * XVarious:: Other XEmacsy Gnusey variables.
23234 @code{X-Face} headers describe a 48x48 pixel black-and-white (1 bit
23235 depth) image that's supposed to represent the author of the message.
23236 It seems to be supported by an ever-growing number of mail and news
23240 @findex gnus-article-display-x-face
23241 @vindex gnus-article-x-face-command
23242 @vindex gnus-article-x-face-too-ugly
23250 Viewing an @code{X-Face} header either requires an Emacs that has
23251 @samp{compface} support (which most XEmacs versions have), or that you
23252 have suitable conversion or display programs installed. If your Emacs
23253 has image support the default action is to display the face before the
23254 @code{From} header. If there's no native @code{X-Face} support, Gnus
23255 will try to convert the @code{X-Face} header using external programs
23256 from the @code{pbmplus} package and friends, see below. For XEmacs it's
23257 faster if XEmacs has been compiled with @code{X-Face} support. The
23258 default action under Emacs without image support is to fork off the
23259 @code{display} program.
23261 On a GNU/Linux system, the @code{display} program is included in the
23262 ImageMagick package. For external conversion programs look for packages
23263 with names like @code{netpbm}, @code{libgr-progs} and @code{compface}.
23264 On Windows, you may use the packages @code{netpbm} and @code{compface}
23265 from @url{http://gnuwin32.sourceforge.net}. You need to add the
23266 @code{bin} directory to your @code{PATH} environment variable.
23267 @c In fact only the following DLLs and binaries seem to be required:
23268 @c compface1.dll uncompface.exe libnetpbm10.dll icontopbm.exe
23270 The variable @code{gnus-article-x-face-command} controls which programs
23271 are used to display the @code{X-Face} header. If this variable is a
23272 string, this string will be executed in a sub-shell. If it is a
23273 function, this function will be called with the face as the argument.
23274 If @code{gnus-article-x-face-too-ugly} (which is a regexp) matches the
23275 @code{From} header, the face will not be shown.
23277 (Note: @code{x-face} is used in the variable/function names, not
23285 @vindex gnus-x-face
23286 Face to show X-Face. The colors from this face are used as the
23287 foreground and background colors of the displayed X-Faces. The
23288 default colors are black and white.
23290 @item gnus-face-properties-alist
23291 @vindex gnus-face-properties-alist
23292 Alist of image types and properties applied to Face (@pxref{Face}) and
23293 X-Face images. The default value is @code{((pbm . (:face gnus-x-face))
23294 (png . nil))} for Emacs or @code{((xface . (:face gnus-x-face)))} for
23295 XEmacs. Here are examples:
23298 ;; Specify the altitude of Face and X-Face images in the From header.
23299 (setq gnus-face-properties-alist
23300 '((pbm . (:face gnus-x-face :ascent 80))
23301 (png . (:ascent 80))))
23303 ;; Show Face and X-Face images as pressed buttons.
23304 (setq gnus-face-properties-alist
23305 '((pbm . (:face gnus-x-face :relief -2))
23306 (png . (:relief -2))))
23309 @pxref{Image Descriptors, ,Image Descriptors, elisp, The Emacs Lisp
23310 Reference Manual} for the valid properties for various image types.
23311 Currently, @code{pbm} is used for X-Face images and @code{png} is used
23312 for Face images in Emacs. Only the @code{:face} property is effective
23313 on the @code{xface} image type in XEmacs if it is built with the
23314 @samp{libcompface} library.
23317 If you use posting styles, you can use an @code{x-face-file} entry in
23318 @code{gnus-posting-styles}, @xref{Posting Styles}. If you don't, Gnus
23319 provides a few convenience functions and variables to allow easier
23320 insertion of X-Face headers in outgoing messages. You also need the
23321 above mentioned ImageMagick, netpbm or other image conversion packages
23322 (depending the values of the variables below) for these functions.
23324 @findex gnus-random-x-face
23325 @vindex gnus-convert-pbm-to-x-face-command
23326 @vindex gnus-x-face-directory
23327 @code{gnus-random-x-face} goes through all the @samp{pbm} files in
23328 @code{gnus-x-face-directory} and picks one at random, and then
23329 converts it to the X-Face format by using the
23330 @code{gnus-convert-pbm-to-x-face-command} shell command. The
23331 @samp{pbm} files should be 48x48 pixels big. It returns the X-Face
23332 header data as a string.
23334 @findex gnus-insert-random-x-face-header
23335 @code{gnus-insert-random-x-face-header} calls
23336 @code{gnus-random-x-face} and inserts a @samp{X-Face} header with the
23337 randomly generated data.
23339 @findex gnus-x-face-from-file
23340 @vindex gnus-convert-image-to-x-face-command
23341 @code{gnus-x-face-from-file} takes a GIF file as the parameter, and then
23342 converts the file to X-Face format by using the
23343 @code{gnus-convert-image-to-x-face-command} shell command.
23345 Here's how you would typically use the first function. Put something
23346 like the following in your @file{~/.gnus.el} file:
23349 (setq message-required-news-headers
23350 (nconc message-required-news-headers
23351 (list '(X-Face . gnus-random-x-face))))
23354 Using the last function would be something like this:
23357 (setq message-required-news-headers
23358 (nconc message-required-news-headers
23359 (list '(X-Face . (lambda ()
23360 (gnus-x-face-from-file
23361 "~/My-face.gif"))))))
23369 @c #### FIXME: faces and x-faces' implementations should really be harmonized.
23371 @code{Face} headers are essentially a funkier version of @code{X-Face}
23372 ones. They describe a 48x48 pixel colored image that's supposed to
23373 represent the author of the message.
23376 @findex gnus-article-display-face
23377 The contents of a @code{Face} header must be a base64 encoded PNG image.
23378 See @uref{http://quimby.gnus.org/circus/face/} for the precise
23381 The @code{gnus-face-properties-alist} variable affects the appearance of
23382 displayed Face images. @xref{X-Face}.
23384 Viewing an @code{Face} header requires an Emacs that is able to display
23387 @c (if (featurep 'xemacs)
23389 @c (image-type-available-p 'png))
23391 Gnus provides a few convenience functions and variables to allow
23392 easier insertion of Face headers in outgoing messages.
23394 @findex gnus-convert-png-to-face
23395 @code{gnus-convert-png-to-face} takes a 48x48 PNG image, no longer than
23396 726 bytes long, and converts it to a face.
23398 @findex gnus-face-from-file
23399 @vindex gnus-convert-image-to-face-command
23400 @code{gnus-face-from-file} takes a JPEG file as the parameter, and then
23401 converts the file to Face format by using the
23402 @code{gnus-convert-image-to-face-command} shell command.
23404 Here's how you would typically use this function. Put something like the
23405 following in your @file{~/.gnus.el} file:
23408 (setq message-required-news-headers
23409 (nconc message-required-news-headers
23410 (list '(Face . (lambda ()
23411 (gnus-face-from-file "~/face.jpg"))))))
23416 @subsection Smileys
23421 \gnusfig{-3cm}{0.5cm}{\epsfig{figure=ps/BigFace,height=20cm}}
23426 @dfn{Smiley} is a package separate from Gnus, but since Gnus is
23427 currently the only package that uses Smiley, it is documented here.
23429 In short---to use Smiley in Gnus, put the following in your
23430 @file{~/.gnus.el} file:
23433 (setq gnus-treat-display-smileys t)
23436 Smiley maps text smiley faces---@samp{:-)}, @samp{8-)}, @samp{:-(} and
23437 the like---to pictures and displays those instead of the text smiley
23438 faces. The conversion is controlled by a list of regexps that matches
23439 text and maps that to file names.
23441 @vindex smiley-regexp-alist
23442 The alist used is specified by the @code{smiley-regexp-alist}
23443 variable. The first item in each element is the regexp to be matched;
23444 the second element is the regexp match group that is to be replaced by
23445 the picture; and the third element is the name of the file to be
23448 The following variables customize the appearance of the smileys:
23453 @vindex smiley-style
23454 Specifies the smiley style. Predefined smiley styles include
23455 @code{low-color} (small 13x14 pixel, three-color images), @code{medium}
23456 (more colorful images, 16x16 pixel), and @code{grayscale} (grayscale
23457 images, 14x14 pixel). The default depends on the height of the default
23460 @item smiley-data-directory
23461 @vindex smiley-data-directory
23462 Where Smiley will look for smiley faces files. You shouldn't set this
23463 variable anymore. Customize @code{smiley-style} instead.
23465 @item gnus-smiley-file-types
23466 @vindex gnus-smiley-file-types
23467 List of suffixes on smiley file names to try.
23481 So@dots{} You want to slow down your news reader even more! This is a
23482 good way to do so. It's also a great way to impress people staring
23483 over your shoulder as you read news.
23485 What are Picons? To quote directly from the Picons Web site:
23494 @dfn{Picons} is short for ``personal icons''. They're small,
23495 constrained images used to represent users and domains on the net,
23496 organized into databases so that the appropriate image for a given
23497 e-mail address can be found. Besides users and domains, there are picon
23498 databases for Usenet newsgroups and weather forecasts. The picons are
23499 in either monochrome @code{XBM} format or color @code{XPM} and
23500 @code{GIF} formats.
23503 @vindex gnus-picon-databases
23504 For instructions on obtaining and installing the picons databases,
23505 point your Web browser at
23506 @uref{http://www.cs.indiana.edu/picons/ftp/index.html}.
23508 If you are using Debian GNU/Linux, saying @samp{apt-get install
23509 picons.*} will install the picons where Gnus can find them.
23511 To enable displaying picons, simply make sure that
23512 @code{gnus-picon-databases} points to the directory containing the
23515 @vindex gnus-picon-style
23516 The variable @code{gnus-picon-style} controls how picons are displayed.
23517 If @code{inline}, the textual representation is replaced. If
23518 @code{right}, picons are added right to the textual representation.
23520 The following variables offer control over where things are located.
23524 @item gnus-picon-databases
23525 @vindex gnus-picon-databases
23526 The location of the picons database. This is a list of directories
23527 containing the @file{news}, @file{domains}, @file{users} (and so on)
23528 subdirectories. Defaults to @code{("/usr/lib/picon"
23529 "/usr/local/faces")}.
23531 @item gnus-picon-news-directories
23532 @vindex gnus-picon-news-directories
23533 List of subdirectories to search in @code{gnus-picon-databases} for
23534 newsgroups faces. @code{("news")} is the default.
23536 @item gnus-picon-user-directories
23537 @vindex gnus-picon-user-directories
23538 List of subdirectories to search in @code{gnus-picon-databases} for user
23539 faces. @code{("users" "usenix" "local" "misc")} is the default.
23541 @item gnus-picon-domain-directories
23542 @vindex gnus-picon-domain-directories
23543 List of subdirectories to search in @code{gnus-picon-databases} for
23544 domain name faces. Defaults to @code{("domains")}. Some people may
23545 want to add @samp{"unknown"} to this list.
23547 @item gnus-picon-file-types
23548 @vindex gnus-picon-file-types
23549 Ordered list of suffixes on picon file names to try. Defaults to
23550 @code{("xpm" "gif" "xbm")} minus those not built-in your Emacs.
23556 @subsection Various XEmacs Variables
23559 @item gnus-xmas-glyph-directory
23560 @vindex gnus-xmas-glyph-directory
23561 This is where Gnus will look for pictures. Gnus will normally
23562 auto-detect this directory, but you may set it manually if you have an
23563 unusual directory structure.
23565 @item gnus-xmas-modeline-glyph
23566 @vindex gnus-xmas-modeline-glyph
23567 A glyph displayed in all Gnus mode lines. It is a tiny gnu head by
23572 @subsubsection Toolbar
23576 @item gnus-use-toolbar
23577 @vindex gnus-use-toolbar
23578 This variable specifies the position to display the toolbar. If
23579 @code{nil}, don't display toolbars. If it is non-@code{nil}, it should
23580 be one of the symbols @code{default}, @code{top}, @code{bottom},
23581 @code{right}, and @code{left}. @code{default} means to use the default
23582 toolbar, the rest mean to display the toolbar on the place which those
23583 names show. The default is @code{default}.
23585 @item gnus-toolbar-thickness
23586 @vindex gnus-toolbar-thickness
23587 Cons of the height and the width specifying the thickness of a toolbar.
23588 The height is used for the toolbar displayed on the top or the bottom,
23589 the width is used for the toolbar displayed on the right or the left.
23590 The default is that of the default toolbar.
23592 @item gnus-group-toolbar
23593 @vindex gnus-group-toolbar
23594 The toolbar in the group buffer.
23596 @item gnus-summary-toolbar
23597 @vindex gnus-summary-toolbar
23598 The toolbar in the summary buffer.
23600 @item gnus-summary-mail-toolbar
23601 @vindex gnus-summary-mail-toolbar
23602 The toolbar in the summary buffer of mail groups.
23613 @node Fuzzy Matching
23614 @section Fuzzy Matching
23615 @cindex fuzzy matching
23617 Gnus provides @dfn{fuzzy matching} of @code{Subject} lines when doing
23618 things like scoring, thread gathering and thread comparison.
23620 As opposed to regular expression matching, fuzzy matching is very fuzzy.
23621 It's so fuzzy that there's not even a definition of what @dfn{fuzziness}
23622 means, and the implementation has changed over time.
23624 Basically, it tries to remove all noise from lines before comparing.
23625 @samp{Re: }, parenthetical remarks, white space, and so on, are filtered
23626 out of the strings before comparing the results. This often leads to
23627 adequate results---even when faced with strings generated by text
23628 manglers masquerading as newsreaders.
23631 @node Thwarting Email Spam
23632 @section Thwarting Email Spam
23636 @cindex unsolicited commercial email
23638 In these last days of the Usenet, commercial vultures are hanging about
23639 and grepping through news like crazy to find email addresses they can
23640 foist off their scams and products to. As a reaction to this, many
23641 people have started putting nonsense addresses into their @code{From}
23642 lines. I think this is counterproductive---it makes it difficult for
23643 people to send you legitimate mail in response to things you write, as
23644 well as making it difficult to see who wrote what. This rewriting may
23645 perhaps be a bigger menace than the unsolicited commercial email itself
23648 The biggest problem I have with email spam is that it comes in under
23649 false pretenses. I press @kbd{g} and Gnus merrily informs me that I
23650 have 10 new emails. I say ``Golly gee! Happy is me!'' and select the
23651 mail group, only to find two pyramid schemes, seven advertisements
23652 (``New! Miracle tonic for growing full, lustrous hair on your toes!'')
23653 and one mail asking me to repent and find some god.
23655 This is annoying. Here's what you can do about it.
23658 * The problem of spam:: Some background, and some solutions
23659 * Anti-Spam Basics:: Simple steps to reduce the amount of spam.
23660 * SpamAssassin:: How to use external anti-spam tools.
23661 * Hashcash:: Reduce spam by burning CPU time.
23664 @node The problem of spam
23665 @subsection The problem of spam
23667 @cindex spam filtering approaches
23668 @cindex filtering approaches, spam
23670 @cindex unsolicited commercial email
23672 First, some background on spam.
23674 If you have access to e-mail, you are familiar with spam (technically
23675 termed @acronym{UCE}, Unsolicited Commercial E-mail). Simply put, it
23676 exists because e-mail delivery is very cheap compared to paper mail,
23677 so only a very small percentage of people need to respond to an UCE to
23678 make it worthwhile to the advertiser. Ironically, one of the most
23679 common spams is the one offering a database of e-mail addresses for
23680 further spamming. Senders of spam are usually called @emph{spammers},
23681 but terms like @emph{vermin}, @emph{scum}, @emph{sociopaths}, and
23682 @emph{morons} are in common use as well.
23684 Spam comes from a wide variety of sources. It is simply impossible to
23685 dispose of all spam without discarding useful messages. A good
23686 example is the TMDA system, which requires senders
23687 unknown to you to confirm themselves as legitimate senders before
23688 their e-mail can reach you. Without getting into the technical side
23689 of TMDA, a downside is clearly that e-mail from legitimate sources may
23690 be discarded if those sources can't or won't confirm themselves
23691 through the TMDA system. Another problem with TMDA is that it
23692 requires its users to have a basic understanding of e-mail delivery
23695 The simplest approach to filtering spam is filtering, at the mail
23696 server or when you sort through incoming mail. If you get 200 spam
23697 messages per day from @samp{random-address@@vmadmin.com}, you block
23698 @samp{vmadmin.com}. If you get 200 messages about @samp{VIAGRA}, you
23699 discard all messages with @samp{VIAGRA} in the message. If you get
23700 lots of spam from Bulgaria, for example, you try to filter all mail
23701 from Bulgarian IPs.
23703 This, unfortunately, is a great way to discard legitimate e-mail. The
23704 risks of blocking a whole country (Bulgaria, Norway, Nigeria, China,
23705 etc.) or even a continent (Asia, Africa, Europe, etc.) from contacting
23706 you should be obvious, so don't do it if you have the choice.
23708 In another instance, the very informative and useful RISKS digest has
23709 been blocked by overzealous mail filters because it @strong{contained}
23710 words that were common in spam messages. Nevertheless, in isolated
23711 cases, with great care, direct filtering of mail can be useful.
23713 Another approach to filtering e-mail is the distributed spam
23714 processing, for instance DCC implements such a system. In essence,
23715 @var{N} systems around the world agree that a machine @var{X} in
23716 Ghana, Estonia, or California is sending out spam e-mail, and these
23717 @var{N} systems enter @var{X} or the spam e-mail from @var{X} into a
23718 database. The criteria for spam detection vary---it may be the number
23719 of messages sent, the content of the messages, and so on. When a user
23720 of the distributed processing system wants to find out if a message is
23721 spam, he consults one of those @var{N} systems.
23723 Distributed spam processing works very well against spammers that send
23724 a large number of messages at once, but it requires the user to set up
23725 fairly complicated checks. There are commercial and free distributed
23726 spam processing systems. Distributed spam processing has its risks as
23727 well. For instance legitimate e-mail senders have been accused of
23728 sending spam, and their web sites and mailing lists have been shut
23729 down for some time because of the incident.
23731 The statistical approach to spam filtering is also popular. It is
23732 based on a statistical analysis of previous spam messages. Usually
23733 the analysis is a simple word frequency count, with perhaps pairs of
23734 words or 3-word combinations thrown into the mix. Statistical
23735 analysis of spam works very well in most of the cases, but it can
23736 classify legitimate e-mail as spam in some cases. It takes time to
23737 run the analysis, the full message must be analyzed, and the user has
23738 to store the database of spam analysis. Statistical analysis on the
23739 server is gaining popularity. This has the advantage of letting the
23740 user Just Read Mail, but has the disadvantage that it's harder to tell
23741 the server that it has misclassified mail.
23743 Fighting spam is not easy, no matter what anyone says. There is no
23744 magic switch that will distinguish Viagra ads from Mom's e-mails.
23745 Even people are having a hard time telling spam apart from non-spam,
23746 because spammers are actively looking to fool us into thinking they
23747 are Mom, essentially. Spamming is irritating, irresponsible, and
23748 idiotic behavior from a bunch of people who think the world owes them
23749 a favor. We hope the following sections will help you in fighting the
23752 @node Anti-Spam Basics
23753 @subsection Anti-Spam Basics
23757 @cindex unsolicited commercial email
23759 One way of dealing with spam is having Gnus split out all spam into a
23760 @samp{spam} mail group (@pxref{Splitting Mail}).
23762 First, pick one (1) valid mail address that you can be reached at, and
23763 put it in your @code{From} header of all your news articles. (I've
23764 chosen @samp{larsi@@trym.ifi.uio.no}, but for many addresses on the form
23765 @samp{larsi+usenet@@ifi.uio.no} will be a better choice. Ask your
23766 sysadmin whether your sendmail installation accepts keywords in the local
23767 part of the mail address.)
23770 (setq message-default-news-headers
23771 "From: Lars Magne Ingebrigtsen <larsi@@trym.ifi.uio.no>\n")
23774 Then put the following split rule in @code{nnmail-split-fancy}
23775 (@pxref{Fancy Mail Splitting}):
23779 (to "larsi@@trym.ifi.uio.no"
23780 (| ("subject" "re:.*" "misc")
23781 ("references" ".*@@.*" "misc")
23786 This says that all mail to this address is suspect, but if it has a
23787 @code{Subject} that starts with a @samp{Re:} or has a @code{References}
23788 header, it's probably ok. All the rest goes to the @samp{spam} group.
23789 (This idea probably comes from Tim Pierce.)
23791 In addition, many mail spammers talk directly to your @acronym{SMTP} server
23792 and do not include your email address explicitly in the @code{To}
23793 header. Why they do this is unknown---perhaps it's to thwart this
23794 thwarting scheme? In any case, this is trivial to deal with---you just
23795 put anything not addressed to you in the @samp{spam} group by ending
23796 your fancy split rule in this way:
23801 (to "larsi" "misc")
23805 In my experience, this will sort virtually everything into the right
23806 group. You still have to check the @samp{spam} group from time to time to
23807 check for legitimate mail, though. If you feel like being a good net
23808 citizen, you can even send off complaints to the proper authorities on
23809 each unsolicited commercial email---at your leisure.
23811 This works for me. It allows people an easy way to contact me (they can
23812 just press @kbd{r} in the usual way), and I'm not bothered at all with
23813 spam. It's a win-win situation. Forging @code{From} headers to point
23814 to non-existent domains is yucky, in my opinion.
23816 Be careful with this approach. Spammers are wise to it.
23820 @subsection SpamAssassin, Vipul's Razor, DCC, etc
23821 @cindex SpamAssassin
23822 @cindex Vipul's Razor
23825 The days where the hints in the previous section were sufficient in
23826 avoiding spam are coming to an end. There are many tools out there
23827 that claim to reduce the amount of spam you get. This section could
23828 easily become outdated fast, as new products replace old, but
23829 fortunately most of these tools seem to have similar interfaces. Even
23830 though this section will use SpamAssassin as an example, it should be
23831 easy to adapt it to most other tools.
23833 Note that this section does not involve the @code{spam.el} package,
23834 which is discussed in the next section. If you don't care for all
23835 the features of @code{spam.el}, you can make do with these simple
23838 If the tool you are using is not installed on the mail server, you
23839 need to invoke it yourself. Ideas on how to use the
23840 @code{:postscript} mail source parameter (@pxref{Mail Source
23841 Specifiers}) follow.
23845 '((file :prescript "formail -bs spamassassin < /var/mail/%u")
23849 "mv %t /tmp/foo; formail -bs spamc < /tmp/foo > %t")))
23852 Once you manage to process your incoming spool somehow, thus making
23853 the mail contain e.g.@: a header indicating it is spam, you are ready to
23854 filter it out. Using normal split methods (@pxref{Splitting Mail}):
23857 (setq nnmail-split-methods '(("spam" "^X-Spam-Flag: YES")
23861 Or using fancy split methods (@pxref{Fancy Mail Splitting}):
23864 (setq nnmail-split-methods 'nnmail-split-fancy
23865 nnmail-split-fancy '(| ("X-Spam-Flag" "YES" "spam")
23869 Some people might not like the idea of piping the mail through various
23870 programs using a @code{:prescript} (if some program is buggy, you
23871 might lose all mail). If you are one of them, another solution is to
23872 call the external tools during splitting. Example fancy split method:
23875 (setq nnmail-split-fancy '(| (: kevin-spamassassin)
23877 (defun kevin-spamassassin ()
23881 (if (eq 1 (call-process-region (point-min) (point-max)
23882 "spamc" nil nil nil "-c"))
23886 Note that with the nnimap back end, message bodies will not be
23887 downloaded by default. You need to set
23888 @code{nnimap-split-download-body} to @code{t} to do that
23889 (@pxref{Splitting in IMAP}).
23891 That is about it. As some spam is likely to get through anyway, you
23892 might want to have a nifty function to call when you happen to read
23893 spam. And here is the nifty function:
23896 (defun my-gnus-raze-spam ()
23897 "Submit SPAM to Vipul's Razor, then mark it as expirable."
23899 (gnus-summary-show-raw-article)
23900 (gnus-summary-save-in-pipe "razor-report -f -d")
23901 (gnus-summary-mark-as-expirable 1))
23905 @subsection Hashcash
23908 A novel technique to fight spam is to require senders to do something
23909 costly and demonstrably unique for each message they send. This has
23910 the obvious drawback that you cannot rely on everyone in the world
23911 using this technique, since it is not part of the Internet standards,
23912 but it may be useful in smaller communities.
23914 While the tools in the previous section work well in practice, they
23915 work only because the tools are constantly maintained and updated as
23916 new form of spam appears. This means that a small percentage of spam
23917 will always get through. It also means that somewhere, someone needs
23918 to read lots of spam to update these tools. Hashcash avoids that, but
23919 instead prefers that everyone you contact through e-mail supports the
23920 scheme. You can view the two approaches as pragmatic vs dogmatic.
23921 The approaches have their own advantages and disadvantages, but as
23922 often in the real world, a combination of them is stronger than either
23923 one of them separately.
23926 The ``something costly'' is to burn CPU time, more specifically to
23927 compute a hash collision up to a certain number of bits. The
23928 resulting hashcash cookie is inserted in a @samp{X-Hashcash:} header.
23929 For more details, and for the external application @code{hashcash} you
23930 need to install to use this feature, see
23931 @uref{http://www.hashcash.org/}. Even more information can be found
23932 at @uref{http://www.camram.org/}.
23934 If you wish to generate hashcash for each message you send, you can
23935 customize @code{message-generate-hashcash} (@pxref{Mail Headers, ,Mail
23936 Headers,message, The Message Manual}), as in:
23939 (setq message-generate-hashcash t)
23942 You will need to set up some additional variables as well:
23946 @item hashcash-default-payment
23947 @vindex hashcash-default-payment
23948 This variable indicates the default number of bits the hash collision
23949 should consist of. By default this is 20. Suggested useful values
23952 @item hashcash-payment-alist
23953 @vindex hashcash-payment-alist
23954 Some receivers may require you to spend burn more CPU time than the
23955 default. This variable contains a list of @samp{(@var{addr}
23956 @var{amount})} cells, where @var{addr} is the receiver (email address
23957 or newsgroup) and @var{amount} is the number of bits in the collision
23958 that is needed. It can also contain @samp{(@var{addr} @var{string}
23959 @var{amount})} cells, where the @var{string} is the string to use
23960 (normally the email address or newsgroup name is used).
23962 @item hashcash-path
23963 @vindex hashcash-path
23964 Where the @code{hashcash} binary is installed. This variable should
23965 be automatically set by @code{executable-find}, but if it's @code{nil}
23966 (usually because the @code{hashcash} binary is not in your path)
23967 you'll get a warning when you check hashcash payments and an error
23968 when you generate hashcash payments.
23972 Gnus can verify hashcash cookies, although this can also be done by
23973 hand customized mail filtering scripts. To verify a hashcash cookie
23974 in a message, use the @code{mail-check-payment} function in the
23975 @code{hashcash.el} library. You can also use the @code{spam.el}
23976 package with the @code{spam-use-hashcash} back end to validate hashcash
23977 cookies in incoming mail and filter mail accordingly (@pxref{Anti-spam
23978 Hashcash Payments}).
23981 @section Spam Package
23982 @cindex spam filtering
23985 The Spam package provides Gnus with a centralized mechanism for
23986 detecting and filtering spam. It filters new mail, and processes
23987 messages according to whether they are spam or ham. (@dfn{Ham} is the
23988 name used throughout this manual to indicate non-spam messages.)
23991 * Spam Package Introduction::
23992 * Filtering Incoming Mail::
23993 * Detecting Spam in Groups::
23994 * Spam and Ham Processors::
23995 * Spam Package Configuration Examples::
23997 * Extending the Spam package::
23998 * Spam Statistics Package::
24001 @node Spam Package Introduction
24002 @subsection Spam Package Introduction
24003 @cindex spam filtering
24004 @cindex spam filtering sequence of events
24007 You must read this section to understand how the Spam package works.
24008 Do not skip, speed-read, or glance through this section.
24010 Make sure you read the section on the @code{spam.el} sequence of
24011 events. See @xref{Extending the Spam package}.
24013 @cindex spam-initialize
24014 @vindex spam-use-stat
24015 To use the Spam package, you @strong{must} first run the function
24016 @code{spam-initialize}:
24022 This autoloads @code{spam.el} and installs the various hooks necessary
24023 to let the Spam package do its job. In order to make use of the Spam
24024 package, you have to set up certain group parameters and variables,
24025 which we will describe below. All of the variables controlling the
24026 Spam package can be found in the @samp{spam} customization group.
24028 There are two ``contact points'' between the Spam package and the rest
24029 of Gnus: checking new mail for spam, and leaving a group.
24031 Checking new mail for spam is done in one of two ways: while splitting
24032 incoming mail, or when you enter a group.
24034 The first way, checking for spam while splitting incoming mail, is
24035 suited to mail back ends such as @code{nnml} or @code{nnimap}, where
24036 new mail appears in a single spool file. The Spam package processes
24037 incoming mail, and sends mail considered to be spam to a designated
24038 ``spam'' group. @xref{Filtering Incoming Mail}.
24040 The second way is suited to back ends such as @code{nntp}, which have
24041 no incoming mail spool, or back ends where the server is in charge of
24042 splitting incoming mail. In this case, when you enter a Gnus group,
24043 the unseen or unread messages in that group are checked for spam.
24044 Detected spam messages are marked as spam. @xref{Detecting Spam in
24047 @cindex spam back ends
24048 In either case, you have to tell the Spam package what method to use
24049 to detect spam messages. There are several methods, or @dfn{spam back
24050 ends} (not to be confused with Gnus back ends!) to choose from: spam
24051 ``blacklists'' and ``whitelists'', dictionary-based filters, and so
24052 forth. @xref{Spam Back Ends}.
24054 In the Gnus summary buffer, messages that have been identified as spam
24055 always appear with a @samp{$} symbol.
24057 The Spam package divides Gnus groups into three categories: ham
24058 groups, spam groups, and unclassified groups. You should mark each of
24059 the groups you subscribe to as either a ham group or a spam group,
24060 using the @code{spam-contents} group parameter (@pxref{Group
24061 Parameters}). Spam groups have a special property: when you enter a
24062 spam group, all unseen articles are marked as spam. Thus, mail split
24063 into a spam group is automatically marked as spam.
24065 Identifying spam messages is only half of the Spam package's job. The
24066 second half comes into play whenever you exit a group buffer. At this
24067 point, the Spam package does several things:
24069 First, it calls @dfn{spam and ham processors} to process the articles
24070 according to whether they are spam or ham. There is a pair of spam
24071 and ham processors associated with each spam back end, and what the
24072 processors do depends on the back end. At present, the main role of
24073 spam and ham processors is for dictionary-based spam filters: they add
24074 the contents of the messages in the group to the filter's dictionary,
24075 to improve its ability to detect future spam. The @code{spam-process}
24076 group parameter specifies what spam processors to use. @xref{Spam and
24079 If the spam filter failed to mark a spam message, you can mark it
24080 yourself, so that the message is processed as spam when you exit the
24090 @findex gnus-summary-mark-as-spam
24091 @findex gnus-summary-mark-as-spam
24092 Mark current article as spam, showing it with the @samp{$} mark
24093 (@code{gnus-summary-mark-as-spam}).
24097 Similarly, you can unmark an article if it has been erroneously marked
24098 as spam. @xref{Setting Marks}.
24100 Normally, a ham message found in a non-ham group is not processed as
24101 ham---the rationale is that it should be moved into a ham group for
24102 further processing (see below). However, you can force these articles
24103 to be processed as ham by setting
24104 @code{spam-process-ham-in-spam-groups} and
24105 @code{spam-process-ham-in-nonham-groups}.
24107 @vindex gnus-ham-process-destinations
24108 @vindex gnus-spam-process-destinations
24109 The second thing that the Spam package does when you exit a group is
24110 to move ham articles out of spam groups, and spam articles out of ham
24111 groups. Ham in a spam group is moved to the group specified by the
24112 variable @code{gnus-ham-process-destinations}, or the group parameter
24113 @code{ham-process-destination}. Spam in a ham group is moved to the
24114 group specified by the variable @code{gnus-spam-process-destinations},
24115 or the group parameter @code{spam-process-destination}. If these
24116 variables are not set, the articles are left in their current group.
24117 If an article cannot be moved (e.g., with a read-only backend such
24118 as @acronym{NNTP}), it is copied.
24120 If an article is moved to another group, it is processed again when
24121 you visit the new group. Normally, this is not a problem, but if you
24122 want each article to be processed only once, load the
24123 @code{gnus-registry.el} package and set the variable
24124 @code{spam-log-to-registry} to @code{t}. @xref{Spam Package
24125 Configuration Examples}.
24127 Normally, spam groups ignore @code{gnus-spam-process-destinations}.
24128 However, if you set @code{spam-move-spam-nonspam-groups-only} to
24129 @code{nil}, spam will also be moved out of spam groups, depending on
24130 the @code{spam-process-destination} parameter.
24132 The final thing the Spam package does is to mark spam articles as
24133 expired, which is usually the right thing to do.
24135 If all this seems confusing, don't worry. Soon it will be as natural
24136 as typing Lisp one-liners on a neural interface@dots{} err, sorry, that's
24137 50 years in the future yet. Just trust us, it's not so bad.
24139 @node Filtering Incoming Mail
24140 @subsection Filtering Incoming Mail
24141 @cindex spam filtering
24142 @cindex spam filtering incoming mail
24145 To use the Spam package to filter incoming mail, you must first set up
24146 fancy mail splitting. @xref{Fancy Mail Splitting}. The Spam package
24147 defines a special splitting function that you can add to your fancy
24148 split variable (either @code{nnmail-split-fancy} or
24149 @code{nnimap-split-fancy}, depending on your mail back end):
24155 @vindex spam-split-group
24157 The @code{spam-split} function scans incoming mail according to your
24158 chosen spam back end(s), and sends messages identified as spam to a
24159 spam group. By default, the spam group is a group named @samp{spam},
24160 but you can change this by customizing @code{spam-split-group}. Make
24161 sure the contents of @code{spam-split-group} are an unqualified group
24162 name. For instance, in an @code{nnimap} server @samp{your-server},
24163 the value @samp{spam} means @samp{nnimap+your-server:spam}. The value
24164 @samp{nnimap+server:spam} is therefore wrong---it gives the group
24165 @samp{nnimap+your-server:nnimap+server:spam}.
24167 @code{spam-split} does not modify the contents of messages in any way.
24169 @vindex nnimap-split-download-body
24170 Note for IMAP users: if you use the @code{spam-check-bogofilter},
24171 @code{spam-check-ifile}, and @code{spam-check-stat} spam back ends,
24172 you should also set set the variable @code{nnimap-split-download-body}
24173 to @code{t}. These spam back ends are most useful when they can
24174 ``scan'' the full message body. By default, the nnimap back end only
24175 retrieves the message headers; @code{nnimap-split-download-body} tells
24176 it to retrieve the message bodies as well. We don't set this by
24177 default because it will slow @acronym{IMAP} down, and that is not an
24178 appropriate decision to make on behalf of the user. @xref{Splitting
24181 You have to specify one or more spam back ends for @code{spam-split}
24182 to use, by setting the @code{spam-use-*} variables. @xref{Spam Back
24183 Ends}. Normally, @code{spam-split} simply uses all the spam back ends
24184 you enabled in this way. However, you can tell @code{spam-split} to
24185 use only some of them. Why this is useful? Suppose you are using the
24186 @code{spam-use-regex-headers} and @code{spam-use-blackholes} spam back
24187 ends, and the following split rule:
24190 nnimap-split-fancy '(|
24191 (any "ding" "ding")
24193 ;; @r{default mailbox}
24198 The problem is that you want all ding messages to make it to the ding
24199 folder. But that will let obvious spam (for example, spam detected by
24200 SpamAssassin, and @code{spam-use-regex-headers}) through, when it's
24201 sent to the ding list. On the other hand, some messages to the ding
24202 list are from a mail server in the blackhole list, so the invocation
24203 of @code{spam-split} can't be before the ding rule.
24205 The solution is to let SpamAssassin headers supersede ding rules, and
24206 perform the other @code{spam-split} rules (including a second
24207 invocation of the regex-headers check) after the ding rule. This is
24208 done by passing a parameter to @code{spam-split}:
24213 ;; @r{spam detected by @code{spam-use-regex-headers} goes to @samp{regex-spam}}
24214 (: spam-split "regex-spam" 'spam-use-regex-headers)
24215 (any "ding" "ding")
24216 ;; @r{all other spam detected by spam-split goes to @code{spam-split-group}}
24218 ;; @r{default mailbox}
24223 This lets you invoke specific @code{spam-split} checks depending on
24224 your particular needs, and target the results of those checks to a
24225 particular spam group. You don't have to throw all mail into all the
24226 spam tests. Another reason why this is nice is that messages to
24227 mailing lists you have rules for don't have to have resource-intensive
24228 blackhole checks performed on them. You could also specify different
24229 spam checks for your nnmail split vs. your nnimap split. Go crazy.
24231 You should set the @code{spam-use-*} variables for whatever spam back
24232 ends you intend to use. The reason is that when loading
24233 @file{spam.el}, some conditional loading is done depending on what
24234 @code{spam-use-xyz} variables you have set. @xref{Spam Back Ends}.
24236 @c @emph{TODO: spam.el needs to provide a uniform way of training all the
24237 @c statistical databases. Some have that functionality built-in, others
24240 @node Detecting Spam in Groups
24241 @subsection Detecting Spam in Groups
24243 To detect spam when visiting a group, set the group's
24244 @code{spam-autodetect} and @code{spam-autodetect-methods} group
24245 parameters. These are accessible with @kbd{G c} or @kbd{G p}, as
24246 usual (@pxref{Group Parameters}).
24248 You should set the @code{spam-use-*} variables for whatever spam back
24249 ends you intend to use. The reason is that when loading
24250 @file{spam.el}, some conditional loading is done depending on what
24251 @code{spam-use-xyz} variables you have set.
24253 By default, only unseen articles are processed for spam. You can
24254 force Gnus to recheck all messages in the group by setting the
24255 variable @code{spam-autodetect-recheck-messages} to @code{t}.
24257 If you use the @code{spam-autodetect} method of checking for spam, you
24258 can specify different spam detection methods for different groups.
24259 For instance, the @samp{ding} group may have @code{spam-use-BBDB} as
24260 the autodetection method, while the @samp{suspect} group may have the
24261 @code{spam-use-blacklist} and @code{spam-use-bogofilter} methods
24262 enabled. Unlike with @code{spam-split}, you don't have any control
24263 over the @emph{sequence} of checks, but this is probably unimportant.
24265 @node Spam and Ham Processors
24266 @subsection Spam and Ham Processors
24267 @cindex spam filtering
24268 @cindex spam filtering variables
24269 @cindex spam variables
24272 @vindex gnus-spam-process-newsgroups
24273 Spam and ham processors specify special actions to take when you exit
24274 a group buffer. Spam processors act on spam messages, and ham
24275 processors on ham messages. At present, the main role of these
24276 processors is to update the dictionaries of dictionary-based spam back
24277 ends such as Bogofilter (@pxref{Bogofilter}) and the Spam Statistics
24278 package (@pxref{Spam Statistics Filtering}).
24280 The spam and ham processors that apply to each group are determined by
24281 the group's@code{spam-process} group parameter. If this group
24282 parameter is not defined, they are determined by the variable
24283 @code{gnus-spam-process-newsgroups}.
24285 @vindex gnus-spam-newsgroup-contents
24286 Gnus learns from the spam you get. You have to collect your spam in
24287 one or more spam groups, and set or customize the variable
24288 @code{spam-junk-mailgroups} as appropriate. You can also declare
24289 groups to contain spam by setting their group parameter
24290 @code{spam-contents} to @code{gnus-group-spam-classification-spam}, or
24291 by customizing the corresponding variable
24292 @code{gnus-spam-newsgroup-contents}. The @code{spam-contents} group
24293 parameter and the @code{gnus-spam-newsgroup-contents} variable can
24294 also be used to declare groups as @emph{ham} groups if you set their
24295 classification to @code{gnus-group-spam-classification-ham}. If
24296 groups are not classified by means of @code{spam-junk-mailgroups},
24297 @code{spam-contents}, or @code{gnus-spam-newsgroup-contents}, they are
24298 considered @emph{unclassified}. All groups are unclassified by
24301 @vindex gnus-spam-mark
24303 In spam groups, all messages are considered to be spam by default:
24304 they get the @samp{$} mark (@code{gnus-spam-mark}) when you enter the
24305 group. If you have seen a message, had it marked as spam, then
24306 unmarked it, it won't be marked as spam when you enter the group
24307 thereafter. You can disable that behavior, so all unread messages
24308 will get the @samp{$} mark, if you set the
24309 @code{spam-mark-only-unseen-as-spam} parameter to @code{nil}. You
24310 should remove the @samp{$} mark when you are in the group summary
24311 buffer for every message that is not spam after all. To remove the
24312 @samp{$} mark, you can use @kbd{M-u} to ``unread'' the article, or
24313 @kbd{d} for declaring it read the non-spam way. When you leave a
24314 group, all spam-marked (@samp{$}) articles are sent to a spam
24315 processor which will study them as spam samples.
24317 Messages may also be deleted in various other ways, and unless
24318 @code{ham-marks} group parameter gets overridden below, marks @samp{R}
24319 and @samp{r} for default read or explicit delete, marks @samp{X} and
24320 @samp{K} for automatic or explicit kills, as well as mark @samp{Y} for
24321 low scores, are all considered to be associated with articles which
24322 are not spam. This assumption might be false, in particular if you
24323 use kill files or score files as means for detecting genuine spam, you
24324 should then adjust the @code{ham-marks} group parameter.
24327 You can customize this group or topic parameter to be the list of
24328 marks you want to consider ham. By default, the list contains the
24329 deleted, read, killed, kill-filed, and low-score marks (the idea is
24330 that these articles have been read, but are not spam). It can be
24331 useful to also include the tick mark in the ham marks. It is not
24332 recommended to make the unread mark a ham mark, because it normally
24333 indicates a lack of classification. But you can do it, and we'll be
24338 You can customize this group or topic parameter to be the list of
24339 marks you want to consider spam. By default, the list contains only
24340 the spam mark. It is not recommended to change that, but you can if
24341 you really want to.
24344 When you leave @emph{any} group, regardless of its
24345 @code{spam-contents} classification, all spam-marked articles are sent
24346 to a spam processor, which will study these as spam samples. If you
24347 explicit kill a lot, you might sometimes end up with articles marked
24348 @samp{K} which you never saw, and which might accidentally contain
24349 spam. Best is to make sure that real spam is marked with @samp{$},
24352 @vindex gnus-ham-process-destinations
24353 When you leave a @emph{spam} group, all spam-marked articles are
24354 marked as expired after processing with the spam processor. This is
24355 not done for @emph{unclassified} or @emph{ham} groups. Also, any
24356 @strong{ham} articles in a spam group will be moved to a location
24357 determined by either the @code{ham-process-destination} group
24358 parameter or a match in the @code{gnus-ham-process-destinations}
24359 variable, which is a list of regular expressions matched with group
24360 names (it's easiest to customize this variable with @kbd{M-x
24361 customize-variable @key{RET} gnus-ham-process-destinations}). Each
24362 group name list is a standard Lisp list, if you prefer to customize
24363 the variable manually. If the @code{ham-process-destination}
24364 parameter is not set, ham articles are left in place. If the
24365 @code{spam-mark-ham-unread-before-move-from-spam-group} parameter is
24366 set, the ham articles are marked as unread before being moved.
24368 If ham can not be moved---because of a read-only back end such as
24369 @acronym{NNTP}, for example, it will be copied.
24371 Note that you can use multiples destinations per group or regular
24372 expression! This enables you to send your ham to a regular mail
24373 group and to a @emph{ham training} group.
24375 When you leave a @emph{ham} group, all ham-marked articles are sent to
24376 a ham processor, which will study these as non-spam samples.
24378 @vindex spam-process-ham-in-spam-groups
24379 By default the variable @code{spam-process-ham-in-spam-groups} is
24380 @code{nil}. Set it to @code{t} if you want ham found in spam groups
24381 to be processed. Normally this is not done, you are expected instead
24382 to send your ham to a ham group and process it there.
24384 @vindex spam-process-ham-in-nonham-groups
24385 By default the variable @code{spam-process-ham-in-nonham-groups} is
24386 @code{nil}. Set it to @code{t} if you want ham found in non-ham (spam
24387 or unclassified) groups to be processed. Normally this is not done,
24388 you are expected instead to send your ham to a ham group and process
24391 @vindex gnus-spam-process-destinations
24392 When you leave a @emph{ham} or @emph{unclassified} group, all
24393 @strong{spam} articles are moved to a location determined by either
24394 the @code{spam-process-destination} group parameter or a match in the
24395 @code{gnus-spam-process-destinations} variable, which is a list of
24396 regular expressions matched with group names (it's easiest to
24397 customize this variable with @kbd{M-x customize-variable @key{RET}
24398 gnus-spam-process-destinations}). Each group name list is a standard
24399 Lisp list, if you prefer to customize the variable manually. If the
24400 @code{spam-process-destination} parameter is not set, the spam
24401 articles are only expired. The group name is fully qualified, meaning
24402 that if you see @samp{nntp:servername} before the group name in the
24403 group buffer then you need it here as well.
24405 If spam can not be moved---because of a read-only back end such as
24406 @acronym{NNTP}, for example, it will be copied.
24408 Note that you can use multiples destinations per group or regular
24409 expression! This enables you to send your spam to multiple @emph{spam
24412 @vindex spam-log-to-registry
24413 The problem with processing ham and spam is that Gnus doesn't track
24414 this processing by default. Enable the @code{spam-log-to-registry}
24415 variable so @code{spam.el} will use @code{gnus-registry.el} to track
24416 what articles have been processed, and avoid processing articles
24417 multiple times. Keep in mind that if you limit the number of registry
24418 entries, this won't work as well as it does without a limit.
24420 @vindex spam-mark-only-unseen-as-spam
24421 Set this variable if you want only unseen articles in spam groups to
24422 be marked as spam. By default, it is set. If you set it to
24423 @code{nil}, unread articles will also be marked as spam.
24425 @vindex spam-mark-ham-unread-before-move-from-spam-group
24426 Set this variable if you want ham to be unmarked before it is moved
24427 out of the spam group. This is very useful when you use something
24428 like the tick mark @samp{!} to mark ham---the article will be placed
24429 in your @code{ham-process-destination}, unmarked as if it came fresh
24430 from the mail server.
24432 @vindex spam-autodetect-recheck-messages
24433 When autodetecting spam, this variable tells @code{spam.el} whether
24434 only unseen articles or all unread articles should be checked for
24435 spam. It is recommended that you leave it off.
24437 @node Spam Package Configuration Examples
24438 @subsection Spam Package Configuration Examples
24439 @cindex spam filtering
24440 @cindex spam filtering configuration examples
24441 @cindex spam configuration examples
24444 @subsubheading Ted's setup
24446 From Ted Zlatanov <tzz@@lifelogs.com>.
24448 ;; @r{for @code{gnus-registry-split-fancy-with-parent} and spam autodetection}
24449 ;; @r{see @file{gnus-registry.el} for more information}
24450 (gnus-registry-initialize)
24454 spam-log-to-registry t ; @r{for spam autodetection}
24456 spam-use-regex-headers t ; @r{catch X-Spam-Flag (SpamAssassin)}
24457 ;; @r{all groups with @samp{spam} in the name contain spam}
24458 gnus-spam-newsgroup-contents
24459 '(("spam" gnus-group-spam-classification-spam))
24460 ;; @r{see documentation for these}
24461 spam-move-spam-nonspam-groups-only nil
24462 spam-mark-only-unseen-as-spam t
24463 spam-mark-ham-unread-before-move-from-spam-group t
24464 nnimap-split-rule 'nnimap-split-fancy
24465 ;; @r{understand what this does before you copy it to your own setup!}
24466 nnimap-split-fancy '(|
24467 ;; @r{trace references to parents and put in their group}
24468 (: gnus-registry-split-fancy-with-parent)
24469 ;; @r{this will catch server-side SpamAssassin tags}
24470 (: spam-split 'spam-use-regex-headers)
24471 (any "ding" "ding")
24472 ;; @r{note that spam by default will go to @samp{spam}}
24474 ;; @r{default mailbox}
24477 ;; @r{my parameters, set with @kbd{G p}}
24479 ;; @r{all nnml groups, and all nnimap groups except}
24480 ;; @r{@samp{nnimap+mail.lifelogs.com:train} and}
24481 ;; @r{@samp{nnimap+mail.lifelogs.com:spam}: any spam goes to nnimap training,}
24482 ;; @r{because it must have been detected manually}
24484 ((spam-process-destination . "nnimap+mail.lifelogs.com:train"))
24486 ;; @r{all @acronym{NNTP} groups}
24487 ;; @r{autodetect spam with the blacklist and ham with the BBDB}
24488 ((spam-autodetect-methods spam-use-blacklist spam-use-BBDB)
24489 ;; @r{send all spam to the training group}
24490 (spam-process-destination . "nnimap+mail.lifelogs.com:train"))
24492 ;; @r{only some @acronym{NNTP} groups, where I want to autodetect spam}
24493 ((spam-autodetect . t))
24495 ;; @r{my nnimap @samp{nnimap+mail.lifelogs.com:spam} group}
24497 ;; @r{this is a spam group}
24498 ((spam-contents gnus-group-spam-classification-spam)
24500 ;; @r{any spam (which happens when I enter for all unseen messages,}
24501 ;; @r{because of the @code{gnus-spam-newsgroup-contents} setting above), goes to}
24502 ;; @r{@samp{nnimap+mail.lifelogs.com:train} unless I mark it as ham}
24504 (spam-process-destination "nnimap+mail.lifelogs.com:train")
24506 ;; @r{any ham goes to my @samp{nnimap+mail.lifelogs.com:mail} folder, but}
24507 ;; @r{also to my @samp{nnimap+mail.lifelogs.com:trainham} folder for training}
24509 (ham-process-destination "nnimap+mail.lifelogs.com:mail"
24510 "nnimap+mail.lifelogs.com:trainham")
24511 ;; @r{in this group, only @samp{!} marks are ham}
24513 (gnus-ticked-mark))
24514 ;; @r{remembers senders in the blacklist on the way out---this is}
24515 ;; @r{definitely not needed, it just makes me feel better}
24516 (spam-process (gnus-group-spam-exit-processor-blacklist)))
24518 ;; @r{Later, on the @acronym{IMAP} server I use the @samp{train} group for training}
24519 ;; @r{SpamAssassin to recognize spam, and the @samp{trainham} group fora}
24520 ;; @r{recognizing ham---but Gnus has nothing to do with it.}
24524 @subsubheading Using @code{spam.el} on an IMAP server with a statistical filter on the server
24525 From Reiner Steib <reiner.steib@@gmx.de>.
24527 My provider has set up bogofilter (in combination with @acronym{DCC}) on
24528 the mail server (@acronym{IMAP}). Recognized spam goes to
24529 @samp{spam.detected}, the rest goes through the normal filter rules,
24530 i.e. to @samp{some.folder} or to @samp{INBOX}. Training on false
24531 positives or negatives is done by copying or moving the article to
24532 @samp{training.ham} or @samp{training.spam} respectively. A cron job on
24533 the server feeds those to bogofilter with the suitable ham or spam
24534 options and deletes them from the @samp{training.ham} and
24535 @samp{training.spam} folders.
24537 With the following entries in @code{gnus-parameters}, @code{spam.el}
24538 does most of the job for me:
24541 ("nnimap:spam\\.detected"
24542 (gnus-article-sort-functions '(gnus-article-sort-by-chars))
24543 (ham-process-destination "nnimap:INBOX" "nnimap:training.ham")
24544 (spam-contents gnus-group-spam-classification-spam))
24545 ("nnimap:\\(INBOX\\|other-folders\\)"
24546 (spam-process-destination . "nnimap:training.spam")
24547 (spam-contents gnus-group-spam-classification-ham))
24552 @item @b{The Spam folder:}
24554 In the folder @samp{spam.detected}, I have to check for false positives
24555 (i.e. legitimate mails, that were wrongly judged as spam by
24556 bogofilter or DCC).
24558 Because of the @code{gnus-group-spam-classification-spam} entry, all
24559 messages are marked as spam (with @code{$}). When I find a false
24560 positive, I mark the message with some other ham mark
24561 (@code{ham-marks}, @ref{Spam and Ham Processors}). On group exit,
24562 those messages are copied to both groups, @samp{INBOX} (where I want
24563 to have the article) and @samp{training.ham} (for training bogofilter)
24564 and deleted from the @samp{spam.detected} folder.
24566 The @code{gnus-article-sort-by-chars} entry simplifies detection of
24567 false positives for me. I receive lots of worms (sweN, @dots{}), that all
24568 have a similar size. Grouping them by size (i.e. chars) makes finding
24569 other false positives easier. (Of course worms aren't @i{spam}
24570 (@acronym{UCE}, @acronym{UBE}) strictly speaking. Anyhow, bogofilter is
24571 an excellent tool for filtering those unwanted mails for me.)
24573 @item @b{Ham folders:}
24575 In my ham folders, I just hit @kbd{S x}
24576 (@code{gnus-summary-mark-as-spam}) whenever I see an unrecognized spam
24577 mail (false negative). On group exit, those messages are moved to
24578 @samp{training.spam}.
24581 @subsubheading Reporting spam articles in Gmane groups with @code{spam-report.el}
24583 From Reiner Steib <reiner.steib@@gmx.de>.
24585 With following entry in @code{gnus-parameters}, @kbd{S x}
24586 (@code{gnus-summary-mark-as-spam}) marks articles in @code{gmane.*}
24587 groups as spam and reports the to Gmane at group exit:
24591 (spam-process (gnus-group-spam-exit-processor-report-gmane)))
24594 Additionally, I use @code{(setq spam-report-gmane-use-article-number nil)}
24595 because I don't read the groups directly from news.gmane.org, but
24596 through my local news server (leafnode). I.e. the article numbers are
24597 not the same as on news.gmane.org, thus @code{spam-report.el} has to check
24598 the @code{X-Report-Spam} header to find the correct number.
24600 @node Spam Back Ends
24601 @subsection Spam Back Ends
24602 @cindex spam back ends
24604 The spam package offers a variety of back ends for detecting spam.
24605 Each back end defines a set of methods for detecting spam
24606 (@pxref{Filtering Incoming Mail}, @pxref{Detecting Spam in Groups}),
24607 and a pair of spam and ham processors (@pxref{Spam and Ham
24611 * Blacklists and Whitelists::
24612 * BBDB Whitelists::
24613 * Gmane Spam Reporting::
24614 * Anti-spam Hashcash Payments::
24616 * Regular Expressions Header Matching::
24618 * SpamAssassin back end::
24619 * ifile spam filtering::
24620 * Spam Statistics Filtering::
24624 @node Blacklists and Whitelists
24625 @subsubsection Blacklists and Whitelists
24626 @cindex spam filtering
24627 @cindex whitelists, spam filtering
24628 @cindex blacklists, spam filtering
24631 @defvar spam-use-blacklist
24633 Set this variable to @code{t} if you want to use blacklists when
24634 splitting incoming mail. Messages whose senders are in the blacklist
24635 will be sent to the @code{spam-split-group}. This is an explicit
24636 filter, meaning that it acts only on mail senders @emph{declared} to
24641 @defvar spam-use-whitelist
24643 Set this variable to @code{t} if you want to use whitelists when
24644 splitting incoming mail. Messages whose senders are not in the
24645 whitelist will be sent to the next spam-split rule. This is an
24646 explicit filter, meaning that unless someone is in the whitelist, their
24647 messages are not assumed to be spam or ham.
24651 @defvar spam-use-whitelist-exclusive
24653 Set this variable to @code{t} if you want to use whitelists as an
24654 implicit filter, meaning that every message will be considered spam
24655 unless the sender is in the whitelist. Use with care.
24659 @defvar gnus-group-spam-exit-processor-blacklist
24661 Add this symbol to a group's @code{spam-process} parameter by
24662 customizing the group parameters or the
24663 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24664 added to a group's @code{spam-process} parameter, the senders of
24665 spam-marked articles will be added to the blacklist.
24669 Instead of the obsolete
24670 @code{gnus-group-spam-exit-processor-blacklist}, it is recommended
24671 that you use @code{(spam spam-use-blacklist)}. Everything will work
24672 the same way, we promise.
24676 @defvar gnus-group-ham-exit-processor-whitelist
24678 Add this symbol to a group's @code{spam-process} parameter by
24679 customizing the group parameters or the
24680 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24681 added to a group's @code{spam-process} parameter, the senders of
24682 ham-marked articles in @emph{ham} groups will be added to the
24687 Instead of the obsolete
24688 @code{gnus-group-ham-exit-processor-whitelist}, it is recommended
24689 that you use @code{(ham spam-use-whitelist)}. Everything will work
24690 the same way, we promise.
24694 Blacklists are lists of regular expressions matching addresses you
24695 consider to be spam senders. For instance, to block mail from any
24696 sender at @samp{vmadmin.com}, you can put @samp{vmadmin.com} in your
24697 blacklist. You start out with an empty blacklist. Blacklist entries
24698 use the Emacs regular expression syntax.
24700 Conversely, whitelists tell Gnus what addresses are considered
24701 legitimate. All messages from whitelisted addresses are considered
24702 non-spam. Also see @ref{BBDB Whitelists}. Whitelist entries use the
24703 Emacs regular expression syntax.
24705 The blacklist and whitelist file locations can be customized with the
24706 @code{spam-directory} variable (@file{~/News/spam} by default), or
24707 the @code{spam-whitelist} and @code{spam-blacklist} variables
24708 directly. The whitelist and blacklist files will by default be in the
24709 @code{spam-directory} directory, named @file{whitelist} and
24710 @file{blacklist} respectively.
24712 @node BBDB Whitelists
24713 @subsubsection BBDB Whitelists
24714 @cindex spam filtering
24715 @cindex BBDB whitelists, spam filtering
24716 @cindex BBDB, spam filtering
24719 @defvar spam-use-BBDB
24721 Analogous to @code{spam-use-whitelist} (@pxref{Blacklists and
24722 Whitelists}), but uses the BBDB as the source of whitelisted
24723 addresses, without regular expressions. You must have the BBDB loaded
24724 for @code{spam-use-BBDB} to work properly. Messages whose senders are
24725 not in the BBDB will be sent to the next spam-split rule. This is an
24726 explicit filter, meaning that unless someone is in the BBDB, their
24727 messages are not assumed to be spam or ham.
24731 @defvar spam-use-BBDB-exclusive
24733 Set this variable to @code{t} if you want to use the BBDB as an
24734 implicit filter, meaning that every message will be considered spam
24735 unless the sender is in the BBDB. Use with care. Only sender
24736 addresses in the BBDB will be allowed through; all others will be
24737 classified as spammers.
24739 While @code{spam-use-BBDB-exclusive} @emph{can} be used as an alias
24740 for @code{spam-use-BBDB} as far as @code{spam.el} is concerned, it is
24741 @emph{not} a separate back end. If you set
24742 @code{spam-use-BBDB-exclusive} to t, @emph{all} your BBDB splitting
24747 @defvar gnus-group-ham-exit-processor-BBDB
24749 Add this symbol to a group's @code{spam-process} parameter by
24750 customizing the group parameters or the
24751 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24752 added to a group's @code{spam-process} parameter, the senders of
24753 ham-marked articles in @emph{ham} groups will be added to the
24758 Instead of the obsolete
24759 @code{gnus-group-ham-exit-processor-BBDB}, it is recommended
24760 that you use @code{(ham spam-use-BBDB)}. Everything will work
24761 the same way, we promise.
24765 @node Gmane Spam Reporting
24766 @subsubsection Gmane Spam Reporting
24767 @cindex spam reporting
24768 @cindex Gmane, spam reporting
24769 @cindex Gmane, spam reporting
24772 @defvar gnus-group-spam-exit-processor-report-gmane
24774 Add this symbol to a group's @code{spam-process} parameter by
24775 customizing the group parameters or the
24776 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24777 added to a group's @code{spam-process} parameter, the spam-marked
24778 articles groups will be reported to the Gmane administrators via a
24781 Gmane can be found at @uref{http://gmane.org}.
24785 Instead of the obsolete
24786 @code{gnus-group-spam-exit-processor-report-gmane}, it is recommended
24787 that you use @code{(spam spam-use-gmane)}. Everything will work the
24788 same way, we promise.
24792 @defvar spam-report-gmane-use-article-number
24794 This variable is @code{t} by default. Set it to @code{nil} if you are
24795 running your own news server, for instance, and the local article
24796 numbers don't correspond to the Gmane article numbers. When
24797 @code{spam-report-gmane-use-article-number} is @code{nil},
24798 @code{spam-report.el} will fetch the number from the article headers.
24802 @defvar spam-report-user-mail-address
24804 Mail address exposed in the User-Agent spam reports to Gmane. It allows
24805 the Gmane administrators to contact you in case of misreports. The
24806 default is @code{user-mail-address}.
24810 @node Anti-spam Hashcash Payments
24811 @subsubsection Anti-spam Hashcash Payments
24812 @cindex spam filtering
24813 @cindex hashcash, spam filtering
24816 @defvar spam-use-hashcash
24818 Similar to @code{spam-use-whitelist} (@pxref{Blacklists and
24819 Whitelists}), but uses hashcash tokens for whitelisting messages
24820 instead of the sender address. Messages without a hashcash payment
24821 token will be sent to the next spam-split rule. This is an explicit
24822 filter, meaning that unless a hashcash token is found, the messages
24823 are not assumed to be spam or ham.
24828 @subsubsection Blackholes
24829 @cindex spam filtering
24830 @cindex blackholes, spam filtering
24833 @defvar spam-use-blackholes
24835 This option is disabled by default. You can let Gnus consult the
24836 blackhole-type distributed spam processing systems (DCC, for instance)
24837 when you set this option. The variable @code{spam-blackhole-servers}
24838 holds the list of blackhole servers Gnus will consult. The current
24839 list is fairly comprehensive, but make sure to let us know if it
24840 contains outdated servers.
24842 The blackhole check uses the @code{dig.el} package, but you can tell
24843 @code{spam.el} to use @code{dns.el} instead for better performance if
24844 you set @code{spam-use-dig} to @code{nil}. It is not recommended at
24845 this time to set @code{spam-use-dig} to @code{nil} despite the
24846 possible performance improvements, because some users may be unable to
24847 use it, but you can try it and see if it works for you.
24851 @defvar spam-blackhole-servers
24853 The list of servers to consult for blackhole checks.
24857 @defvar spam-blackhole-good-server-regex
24859 A regular expression for IPs that should not be checked against the
24860 blackhole server list. When set to @code{nil}, it has no effect.
24864 @defvar spam-use-dig
24866 Use the @code{dig.el} package instead of the @code{dns.el} package.
24867 The default setting of @code{t} is recommended.
24871 Blackhole checks are done only on incoming mail. There is no spam or
24872 ham processor for blackholes.
24874 @node Regular Expressions Header Matching
24875 @subsubsection Regular Expressions Header Matching
24876 @cindex spam filtering
24877 @cindex regular expressions header matching, spam filtering
24880 @defvar spam-use-regex-headers
24882 This option is disabled by default. You can let Gnus check the
24883 message headers against lists of regular expressions when you set this
24884 option. The variables @code{spam-regex-headers-spam} and
24885 @code{spam-regex-headers-ham} hold the list of regular expressions.
24886 Gnus will check against the message headers to determine if the
24887 message is spam or ham, respectively.
24891 @defvar spam-regex-headers-spam
24893 The list of regular expressions that, when matched in the headers of
24894 the message, positively identify it as spam.
24898 @defvar spam-regex-headers-ham
24900 The list of regular expressions that, when matched in the headers of
24901 the message, positively identify it as ham.
24905 Regular expression header checks are done only on incoming mail.
24906 There is no specific spam or ham processor for regular expressions.
24909 @subsubsection Bogofilter
24910 @cindex spam filtering
24911 @cindex bogofilter, spam filtering
24914 @defvar spam-use-bogofilter
24916 Set this variable if you want @code{spam-split} to use Eric Raymond's
24919 With a minimum of care for associating the @samp{$} mark for spam
24920 articles only, Bogofilter training all gets fairly automatic. You
24921 should do this until you get a few hundreds of articles in each
24922 category, spam or not. The command @kbd{S t} in summary mode, either
24923 for debugging or for curiosity, shows the @emph{spamicity} score of
24924 the current article (between 0.0 and 1.0).
24926 Bogofilter determines if a message is spam based on a specific
24927 threshold. That threshold can be customized, consult the Bogofilter
24930 If the @code{bogofilter} executable is not in your path, Bogofilter
24931 processing will be turned off.
24933 You should not enable this if you use @code{spam-use-bogofilter-headers}.
24942 @findex spam-bogofilter-score
24943 Get the Bogofilter spamicity score (@code{spam-bogofilter-score}).
24946 @defvar spam-use-bogofilter-headers
24948 Set this variable if you want @code{spam-split} to use Eric Raymond's
24949 speedy Bogofilter, looking only at the message headers. It works
24950 similarly to @code{spam-use-bogofilter}, but the @code{X-Bogosity} header
24951 must be in the message already. Normally you would do this with a
24952 procmail recipe or something similar; consult the Bogofilter
24953 installation documents for details.
24955 You should not enable this if you use @code{spam-use-bogofilter}.
24959 @defvar gnus-group-spam-exit-processor-bogofilter
24960 Add this symbol to a group's @code{spam-process} parameter by
24961 customizing the group parameters or the
24962 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24963 added to a group's @code{spam-process} parameter, spam-marked articles
24964 will be added to the Bogofilter spam database.
24968 Instead of the obsolete
24969 @code{gnus-group-spam-exit-processor-bogofilter}, it is recommended
24970 that you use @code{(spam spam-use-bogofilter)}. Everything will work
24971 the same way, we promise.
24974 @defvar gnus-group-ham-exit-processor-bogofilter
24975 Add this symbol to a group's @code{spam-process} parameter by
24976 customizing the group parameters or the
24977 @code{gnus-spam-process-newsgroups} variable. When this symbol is
24978 added to a group's @code{spam-process} parameter, the ham-marked
24979 articles in @emph{ham} groups will be added to the Bogofilter database
24980 of non-spam messages.
24984 Instead of the obsolete
24985 @code{gnus-group-ham-exit-processor-bogofilter}, it is recommended
24986 that you use @code{(ham spam-use-bogofilter)}. Everything will work
24987 the same way, we promise.
24990 @defvar spam-bogofilter-database-directory
24992 This is the directory where Bogofilter will store its databases. It
24993 is not specified by default, so Bogofilter will use its own default
24994 database directory.
24998 The Bogofilter mail classifier is similar to @command{ifile} in intent and
24999 purpose. A ham and a spam processor are provided, plus the
25000 @code{spam-use-bogofilter} and @code{spam-use-bogofilter-headers}
25001 variables to indicate to spam-split that Bogofilter should either be
25002 used, or has already been used on the article. The 0.9.2.1 version of
25003 Bogofilter was used to test this functionality.
25005 @node SpamAssassin back end
25006 @subsubsection SpamAssassin back end
25007 @cindex spam filtering
25008 @cindex spamassassin, spam filtering
25011 @defvar spam-use-spamassassin
25013 Set this variable if you want @code{spam-split} to use SpamAssassin.
25015 SpamAssassin assigns a score to each article based on a set of rules
25016 and tests, including a Bayesian filter. The Bayesian filter can be
25017 trained by associating the @samp{$} mark for spam articles. The
25018 spam score can be viewed by using the command @kbd{S t} in summary
25021 If you set this variable, each article will be processed by
25022 SpamAssassin when @code{spam-split} is called. If your mail is
25023 preprocessed by SpamAssassin, and you want to just use the
25024 SpamAssassin headers, set @code{spam-use-spamassassin-headers}
25027 You should not enable this if you use
25028 @code{spam-use-spamassassin-headers}.
25032 @defvar spam-use-spamassassin-headers
25034 Set this variable if your mail is preprocessed by SpamAssassin and
25035 want @code{spam-split} to split based on the SpamAssassin headers.
25037 You should not enable this if you use @code{spam-use-spamassassin}.
25041 @defvar spam-spamassassin-program
25043 This variable points to the SpamAssassin executable. If you have
25044 @code{spamd} running, you can set this variable to the @code{spamc}
25045 executable for faster processing. See the SpamAssassin documentation
25046 for more information on @code{spamd}/@code{spamc}.
25050 SpamAssassin is a powerful and flexible spam filter that uses a wide
25051 variety of tests to identify spam. A ham and a spam processors are
25052 provided, plus the @code{spam-use-spamassassin} and
25053 @code{spam-use-spamassassin-headers} variables to indicate to
25054 spam-split that SpamAssassin should be either used, or has already
25055 been used on the article. The 2.63 version of SpamAssassin was used
25056 to test this functionality.
25058 @node ifile spam filtering
25059 @subsubsection ifile spam filtering
25060 @cindex spam filtering
25061 @cindex ifile, spam filtering
25064 @defvar spam-use-ifile
25066 Enable this variable if you want @code{spam-split} to use @command{ifile}, a
25067 statistical analyzer similar to Bogofilter.
25071 @defvar spam-ifile-all-categories
25073 Enable this variable if you want @code{spam-use-ifile} to give you all
25074 the ifile categories, not just spam/non-spam. If you use this, make
25075 sure you train ifile as described in its documentation.
25079 @defvar spam-ifile-spam-category
25081 This is the category of spam messages as far as ifile is concerned.
25082 The actual string used is irrelevant, but you probably want to leave
25083 the default value of @samp{spam}.
25086 @defvar spam-ifile-database
25088 This is the filename for the ifile database. It is not specified by
25089 default, so ifile will use its own default database name.
25093 The ifile mail classifier is similar to Bogofilter in intent and
25094 purpose. A ham and a spam processor are provided, plus the
25095 @code{spam-use-ifile} variable to indicate to spam-split that ifile
25096 should be used. The 1.2.1 version of ifile was used to test this
25099 @node Spam Statistics Filtering
25100 @subsubsection Spam Statistics Filtering
25101 @cindex spam filtering
25102 @cindex spam-stat, spam filtering
25106 This back end uses the Spam Statistics Emacs Lisp package to perform
25107 statistics-based filtering (@pxref{Spam Statistics Package}). Before
25108 using this, you may want to perform some additional steps to
25109 initialize your Spam Statistics dictionary. @xref{Creating a
25110 spam-stat dictionary}.
25112 @defvar spam-use-stat
25116 @defvar gnus-group-spam-exit-processor-stat
25117 Add this symbol to a group's @code{spam-process} parameter by
25118 customizing the group parameters or the
25119 @code{gnus-spam-process-newsgroups} variable. When this symbol is
25120 added to a group's @code{spam-process} parameter, the spam-marked
25121 articles will be added to the spam-stat database of spam messages.
25125 Instead of the obsolete
25126 @code{gnus-group-spam-exit-processor-stat}, it is recommended
25127 that you use @code{(spam spam-use-stat)}. Everything will work
25128 the same way, we promise.
25131 @defvar gnus-group-ham-exit-processor-stat
25132 Add this symbol to a group's @code{spam-process} parameter by
25133 customizing the group parameters or the
25134 @code{gnus-spam-process-newsgroups} variable. When this symbol is
25135 added to a group's @code{spam-process} parameter, the ham-marked
25136 articles in @emph{ham} groups will be added to the spam-stat database
25137 of non-spam messages.
25141 Instead of the obsolete
25142 @code{gnus-group-ham-exit-processor-stat}, it is recommended
25143 that you use @code{(ham spam-use-stat)}. Everything will work
25144 the same way, we promise.
25147 This enables @code{spam.el} to cooperate with @file{spam-stat.el}.
25148 @file{spam-stat.el} provides an internal (Lisp-only) spam database,
25149 which unlike ifile or Bogofilter does not require external programs.
25150 A spam and a ham processor, and the @code{spam-use-stat} variable for
25151 @code{spam-split} are provided.
25154 @subsubsection Using SpamOracle with Gnus
25155 @cindex spam filtering
25159 An easy way to filter out spam is to use SpamOracle. SpamOracle is an
25160 statistical mail filtering tool written by Xavier Leroy and needs to be
25161 installed separately.
25163 There are several ways to use SpamOracle with Gnus. In all cases, your
25164 mail is piped through SpamOracle in its @emph{mark} mode. SpamOracle will
25165 then enter an @samp{X-Spam} header indicating whether it regards the
25166 mail as a spam mail or not.
25168 One possibility is to run SpamOracle as a @code{:prescript} from the
25169 @xref{Mail Source Specifiers}, (@pxref{SpamAssassin}). This method has
25170 the advantage that the user can see the @emph{X-Spam} headers.
25172 The easiest method is to make @file{spam.el} (@pxref{Spam Package})
25175 @vindex spam-use-spamoracle
25176 To enable SpamOracle usage by @code{spam.el}, set the variable
25177 @code{spam-use-spamoracle} to @code{t} and configure the
25178 @code{nnmail-split-fancy} or @code{nnimap-split-fancy}. @xref{Spam
25179 Package}. In this example the @samp{INBOX} of an nnimap server is
25180 filtered using SpamOracle. Mails recognized as spam mails will be
25181 moved to @code{spam-split-group}, @samp{Junk} in this case. Ham
25182 messages stay in @samp{INBOX}:
25185 (setq spam-use-spamoracle t
25186 spam-split-group "Junk"
25187 nnimap-split-inbox '("INBOX")
25188 nnimap-split-rule 'nnimap-split-fancy
25189 nnimap-split-fancy '(| (: spam-split) "INBOX"))
25192 @defvar spam-use-spamoracle
25193 Set to @code{t} if you want Gnus to enable spam filtering using
25197 @defvar spam-spamoracle-binary
25198 Gnus uses the SpamOracle binary called @file{spamoracle} found in the
25199 user's PATH. Using the variable @code{spam-spamoracle-binary}, this
25203 @defvar spam-spamoracle-database
25204 By default, SpamOracle uses the file @file{~/.spamoracle.db} as a database to
25205 store its analysis. This is controlled by the variable
25206 @code{spam-spamoracle-database} which defaults to @code{nil}. That means
25207 the default SpamOracle database will be used. In case you want your
25208 database to live somewhere special, set
25209 @code{spam-spamoracle-database} to this path.
25212 SpamOracle employs a statistical algorithm to determine whether a
25213 message is spam or ham. In order to get good results, meaning few
25214 false hits or misses, SpamOracle needs training. SpamOracle learns
25215 the characteristics of your spam mails. Using the @emph{add} mode
25216 (training mode) one has to feed good (ham) and spam mails to
25217 SpamOracle. This can be done by pressing @kbd{|} in the Summary
25218 buffer and pipe the mail to a SpamOracle process or using
25219 @file{spam.el}'s spam- and ham-processors, which is much more
25220 convenient. For a detailed description of spam- and ham-processors,
25221 @xref{Spam Package}.
25223 @defvar gnus-group-spam-exit-processor-spamoracle
25224 Add this symbol to a group's @code{spam-process} parameter by
25225 customizing the group parameter or the
25226 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
25227 to a group's @code{spam-process} parameter, spam-marked articles will be
25228 sent to SpamOracle as spam samples.
25232 Instead of the obsolete
25233 @code{gnus-group-spam-exit-processor-spamoracle}, it is recommended
25234 that you use @code{(spam spam-use-spamoracle)}. Everything will work
25235 the same way, we promise.
25238 @defvar gnus-group-ham-exit-processor-spamoracle
25239 Add this symbol to a group's @code{spam-process} parameter by
25240 customizing the group parameter or the
25241 @code{gnus-spam-process-newsgroups} variable. When this symbol is added
25242 to a group's @code{spam-process} parameter, the ham-marked articles in
25243 @emph{ham} groups will be sent to the SpamOracle as samples of ham
25248 Instead of the obsolete
25249 @code{gnus-group-ham-exit-processor-spamoracle}, it is recommended
25250 that you use @code{(ham spam-use-spamoracle)}. Everything will work
25251 the same way, we promise.
25254 @emph{Example:} These are the Group Parameters of a group that has been
25255 classified as a ham group, meaning that it should only contain ham
25258 ((spam-contents gnus-group-spam-classification-ham)
25259 (spam-process ((ham spam-use-spamoracle)
25260 (spam spam-use-spamoracle))))
25262 For this group the @code{spam-use-spamoracle} is installed for both
25263 ham and spam processing. If the group contains spam message
25264 (e.g. because SpamOracle has not had enough sample messages yet) and
25265 the user marks some messages as spam messages, these messages will be
25266 processed by SpamOracle. The processor sends the messages to
25267 SpamOracle as new samples for spam.
25269 @node Extending the Spam package
25270 @subsection Extending the Spam package
25271 @cindex spam filtering
25272 @cindex spam elisp package, extending
25273 @cindex extending the spam elisp package
25275 Say you want to add a new back end called blackbox. For filtering
25276 incoming mail, provide the following:
25284 (defvar spam-use-blackbox nil
25285 "True if blackbox should be used.")
25288 Write @code{spam-check-blackbox} if Blackbox can check incoming mail.
25290 Write @code{spam-blackbox-register-routine} and
25291 @code{spam-blackbox-unregister-routine} using the bogofilter
25292 register/unregister routines as a start, or other restister/unregister
25293 routines more appropriate to Blackbox, if Blackbox can
25294 register/unregister spam and ham.
25299 The @code{spam-check-blackbox} function should return @samp{nil} or
25300 @code{spam-split-group}, observing the other conventions. See the
25301 existing @code{spam-check-*} functions for examples of what you can
25302 do, and stick to the template unless you fully understand the reasons
25307 For processing spam and ham messages, provide the following:
25314 Note you don't have to provide a spam or a ham processor. Only
25315 provide them if Blackbox supports spam or ham processing.
25317 Also, ham and spam processors are being phased out as single
25318 variables. Instead the form @code{(spam spam-use-blackbox)} or
25319 @code{(ham spam-use-blackbox)} is favored. For now, spam/ham
25320 processor variables are still around but they won't be for long.
25323 (defvar gnus-group-spam-exit-processor-blackbox "blackbox-spam"
25324 "The Blackbox summary exit spam processor.
25325 Only applicable to spam groups.")
25327 (defvar gnus-group-ham-exit-processor-blackbox "blackbox-ham"
25328 "The whitelist summary exit ham processor.
25329 Only applicable to non-spam (unclassified and ham) groups.")
25338 (const :tag "Spam: Blackbox" (spam spam-use-blackbox))
25339 (const :tag "Ham: Blackbox" (ham spam-use-blackbox))
25341 to the @code{spam-process} group parameter in @code{gnus.el}. Make
25342 sure you do it twice, once for the parameter and once for the
25343 variable customization.
25347 (variable-item spam-use-blackbox)
25349 to the @code{spam-autodetect-methods} group parameter in
25350 @code{gnus.el} if Blackbox can check incoming mail for spam contents.
25352 Finally, use the appropriate @code{spam-install-*-backend} function in
25353 @code{spam.el}. Here are the available functions.
25359 @code{spam-install-backend-alias}
25361 This function will simply install an alias for a back end that does
25362 everything like the original back end. It is currently only used to
25363 make @code{spam-use-BBDB-exclusive} act like @code{spam-use-BBDB}.
25366 @code{spam-install-nocheck-backend}
25368 This function installs a back end that has no check function, but can
25369 register/unregister ham or spam. The @code{spam-use-gmane} back end is
25373 @code{spam-install-checkonly-backend}
25375 This function will install a back end that can only check incoming mail
25376 for spam contents. It can't register or unregister messages.
25377 @code{spam-use-blackholes} and @code{spam-use-hashcash} are such
25381 @code{spam-install-statistical-checkonly-backend}
25383 This function installs a statistical back end (one which requires the
25384 full body of a message to check it) that can only check incoming mail
25385 for contents. @code{spam-use-regex-body} is such a filter.
25388 @code{spam-install-statistical-backend}
25390 This function install a statistical back end with incoming checks and
25391 registration/unregistration routines. @code{spam-use-bogofilter} is
25395 @code{spam-install-backend}
25397 This is the most normal back end installation, where a back end that can
25398 check and register/unregister messages is set up without statistical
25399 abilities. The @code{spam-use-BBDB} is such a back end.
25402 @code{spam-install-mover-backend}
25404 Mover back ends are internal to @code{spam.el} and specifically move
25405 articles around when the summary is exited. You will very probably
25406 never install such a back end.
25411 @node Spam Statistics Package
25412 @subsection Spam Statistics Package
25413 @cindex Paul Graham
25414 @cindex Graham, Paul
25415 @cindex naive Bayesian spam filtering
25416 @cindex Bayesian spam filtering, naive
25417 @cindex spam filtering, naive Bayesian
25419 Paul Graham has written an excellent essay about spam filtering using
25420 statistics: @uref{http://www.paulgraham.com/spam.html,A Plan for
25421 Spam}. In it he describes the inherent deficiency of rule-based
25422 filtering as used by SpamAssassin, for example: Somebody has to write
25423 the rules, and everybody else has to install these rules. You are
25424 always late. It would be much better, he argues, to filter mail based
25425 on whether it somehow resembles spam or non-spam. One way to measure
25426 this is word distribution. He then goes on to describe a solution
25427 that checks whether a new mail resembles any of your other spam mails
25430 The basic idea is this: Create a two collections of your mail, one
25431 with spam, one with non-spam. Count how often each word appears in
25432 either collection, weight this by the total number of mails in the
25433 collections, and store this information in a dictionary. For every
25434 word in a new mail, determine its probability to belong to a spam or a
25435 non-spam mail. Use the 15 most conspicuous words, compute the total
25436 probability of the mail being spam. If this probability is higher
25437 than a certain threshold, the mail is considered to be spam.
25439 The Spam Statistics package adds support to Gnus for this kind of
25440 filtering. It can be used as one of the back ends of the Spam package
25441 (@pxref{Spam Package}), or by itself.
25443 Before using the Spam Statistics package, you need to set it up.
25444 First, you need two collections of your mail, one with spam, one with
25445 non-spam. Then you need to create a dictionary using these two
25446 collections, and save it. And last but not least, you need to use
25447 this dictionary in your fancy mail splitting rules.
25450 * Creating a spam-stat dictionary::
25451 * Splitting mail using spam-stat::
25452 * Low-level interface to the spam-stat dictionary::
25455 @node Creating a spam-stat dictionary
25456 @subsubsection Creating a spam-stat dictionary
25458 Before you can begin to filter spam based on statistics, you must
25459 create these statistics based on two mail collections, one with spam,
25460 one with non-spam. These statistics are then stored in a dictionary
25461 for later use. In order for these statistics to be meaningful, you
25462 need several hundred emails in both collections.
25464 Gnus currently supports only the nnml back end for automated dictionary
25465 creation. The nnml back end stores all mails in a directory, one file
25466 per mail. Use the following:
25468 @defun spam-stat-process-spam-directory
25469 Create spam statistics for every file in this directory. Every file
25470 is treated as one spam mail.
25473 @defun spam-stat-process-non-spam-directory
25474 Create non-spam statistics for every file in this directory. Every
25475 file is treated as one non-spam mail.
25478 Usually you would call @code{spam-stat-process-spam-directory} on a
25479 directory such as @file{~/Mail/mail/spam} (this usually corresponds to
25480 the group @samp{nnml:mail.spam}), and you would call
25481 @code{spam-stat-process-non-spam-directory} on a directory such as
25482 @file{~/Mail/mail/misc} (this usually corresponds to the group
25483 @samp{nnml:mail.misc}).
25485 When you are using @acronym{IMAP}, you won't have the mails available
25486 locally, so that will not work. One solution is to use the Gnus Agent
25487 to cache the articles. Then you can use directories such as
25488 @file{"~/News/agent/nnimap/mail.yourisp.com/personal_spam"} for
25489 @code{spam-stat-process-spam-directory}. @xref{Agent as Cache}.
25492 This variable holds the hash-table with all the statistics---the
25493 dictionary we have been talking about. For every word in either
25494 collection, this hash-table stores a vector describing how often the
25495 word appeared in spam and often it appeared in non-spam mails.
25498 If you want to regenerate the statistics from scratch, you need to
25499 reset the dictionary.
25501 @defun spam-stat-reset
25502 Reset the @code{spam-stat} hash-table, deleting all the statistics.
25505 When you are done, you must save the dictionary. The dictionary may
25506 be rather large. If you will not update the dictionary incrementally
25507 (instead, you will recreate it once a month, for example), then you
25508 can reduce the size of the dictionary by deleting all words that did
25509 not appear often enough or that do not clearly belong to only spam or
25510 only non-spam mails.
25512 @defun spam-stat-reduce-size
25513 Reduce the size of the dictionary. Use this only if you do not want
25514 to update the dictionary incrementally.
25517 @defun spam-stat-save
25518 Save the dictionary.
25521 @defvar spam-stat-file
25522 The filename used to store the dictionary. This defaults to
25523 @file{~/.spam-stat.el}.
25526 @node Splitting mail using spam-stat
25527 @subsubsection Splitting mail using spam-stat
25529 This section describes how to use the Spam statistics
25530 @emph{independently} of the @xref{Spam Package}.
25532 First, add the following to your @file{~/.gnus.el} file:
25535 (require 'spam-stat)
25539 This will load the necessary Gnus code, and the dictionary you
25542 Next, you need to adapt your fancy splitting rules: You need to
25543 determine how to use @code{spam-stat}. The following examples are for
25544 the nnml back end. Using the nnimap back end works just as well. Just
25545 use @code{nnimap-split-fancy} instead of @code{nnmail-split-fancy}.
25547 In the simplest case, you only have two groups, @samp{mail.misc} and
25548 @samp{mail.spam}. The following expression says that mail is either
25549 spam or it should go into @samp{mail.misc}. If it is spam, then
25550 @code{spam-stat-split-fancy} will return @samp{mail.spam}.
25553 (setq nnmail-split-fancy
25554 `(| (: spam-stat-split-fancy)
25558 @defvar spam-stat-split-fancy-spam-group
25559 The group to use for spam. Default is @samp{mail.spam}.
25562 If you also filter mail with specific subjects into other groups, use
25563 the following expression. Only mails not matching the regular
25564 expression are considered potential spam.
25567 (setq nnmail-split-fancy
25568 `(| ("Subject" "\\bspam-stat\\b" "mail.emacs")
25569 (: spam-stat-split-fancy)
25573 If you want to filter for spam first, then you must be careful when
25574 creating the dictionary. Note that @code{spam-stat-split-fancy} must
25575 consider both mails in @samp{mail.emacs} and in @samp{mail.misc} as
25576 non-spam, therefore both should be in your collection of non-spam
25577 mails, when creating the dictionary!
25580 (setq nnmail-split-fancy
25581 `(| (: spam-stat-split-fancy)
25582 ("Subject" "\\bspam-stat\\b" "mail.emacs")
25586 You can combine this with traditional filtering. Here, we move all
25587 HTML-only mails into the @samp{mail.spam.filtered} group. Note that since
25588 @code{spam-stat-split-fancy} will never see them, the mails in
25589 @samp{mail.spam.filtered} should be neither in your collection of spam mails,
25590 nor in your collection of non-spam mails, when creating the
25594 (setq nnmail-split-fancy
25595 `(| ("Content-Type" "text/html" "mail.spam.filtered")
25596 (: spam-stat-split-fancy)
25597 ("Subject" "\\bspam-stat\\b" "mail.emacs")
25602 @node Low-level interface to the spam-stat dictionary
25603 @subsubsection Low-level interface to the spam-stat dictionary
25605 The main interface to using @code{spam-stat}, are the following functions:
25607 @defun spam-stat-buffer-is-spam
25608 Called in a buffer, that buffer is considered to be a new spam mail.
25609 Use this for new mail that has not been processed before.
25612 @defun spam-stat-buffer-is-no-spam
25613 Called in a buffer, that buffer is considered to be a new non-spam
25614 mail. Use this for new mail that has not been processed before.
25617 @defun spam-stat-buffer-change-to-spam
25618 Called in a buffer, that buffer is no longer considered to be normal
25619 mail but spam. Use this to change the status of a mail that has
25620 already been processed as non-spam.
25623 @defun spam-stat-buffer-change-to-non-spam
25624 Called in a buffer, that buffer is no longer considered to be spam but
25625 normal mail. Use this to change the status of a mail that has already
25626 been processed as spam.
25629 @defun spam-stat-save
25630 Save the hash table to the file. The filename used is stored in the
25631 variable @code{spam-stat-file}.
25634 @defun spam-stat-load
25635 Load the hash table from a file. The filename used is stored in the
25636 variable @code{spam-stat-file}.
25639 @defun spam-stat-score-word
25640 Return the spam score for a word.
25643 @defun spam-stat-score-buffer
25644 Return the spam score for a buffer.
25647 @defun spam-stat-split-fancy
25648 Use this function for fancy mail splitting. Add the rule @samp{(:
25649 spam-stat-split-fancy)} to @code{nnmail-split-fancy}
25652 Make sure you load the dictionary before using it. This requires the
25653 following in your @file{~/.gnus.el} file:
25656 (require 'spam-stat)
25660 Typical test will involve calls to the following functions:
25663 Reset: (setq spam-stat (make-hash-table :test 'equal))
25664 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
25665 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
25666 Save table: (spam-stat-save)
25667 File size: (nth 7 (file-attributes spam-stat-file))
25668 Number of words: (hash-table-count spam-stat)
25669 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
25670 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
25671 Reduce table size: (spam-stat-reduce-size)
25672 Save table: (spam-stat-save)
25673 File size: (nth 7 (file-attributes spam-stat-file))
25674 Number of words: (hash-table-count spam-stat)
25675 Test spam: (spam-stat-test-directory "~/Mail/mail/spam")
25676 Test non-spam: (spam-stat-test-directory "~/Mail/mail/misc")
25679 Here is how you would create your dictionary:
25682 Reset: (setq spam-stat (make-hash-table :test 'equal))
25683 Learn spam: (spam-stat-process-spam-directory "~/Mail/mail/spam")
25684 Learn non-spam: (spam-stat-process-non-spam-directory "~/Mail/mail/misc")
25685 Repeat for any other non-spam group you need...
25686 Reduce table size: (spam-stat-reduce-size)
25687 Save table: (spam-stat-save)
25691 @section Interaction with other modes
25696 @code{gnus-dired-minor-mode} provides some useful functions for dired
25697 buffers. It is enabled with
25699 (add-hook 'dired-mode-hook 'turn-on-gnus-dired-mode)
25704 @findex gnus-dired-attach
25705 @cindex attachments, selection via dired
25706 Send dired's marked files as an attachment (@code{gnus-dired-attach}).
25707 You will be prompted for a message buffer.
25710 @findex gnus-dired-find-file-mailcap
25711 Visit a file according to the appropriate mailcap entry
25712 (@code{gnus-dired-find-file-mailcap}). With prefix, open file in a new
25716 @findex gnus-dired-print
25717 Print file according to the mailcap entry (@code{gnus-dired-print}). If
25718 there is no print command, print in a PostScript image.
25721 @node Various Various
25722 @section Various Various
25728 @item gnus-home-directory
25729 @vindex gnus-home-directory
25730 All Gnus file and directory variables will be initialized from this
25731 variable, which defaults to @file{~/}.
25733 @item gnus-directory
25734 @vindex gnus-directory
25735 Most Gnus storage file and directory variables will be initialized from
25736 this variable, which defaults to the @env{SAVEDIR} environment
25737 variable, or @file{~/News/} if that variable isn't set.
25739 Note that Gnus is mostly loaded when the @file{~/.gnus.el} file is read.
25740 This means that other directory variables that are initialized from this
25741 variable won't be set properly if you set this variable in
25742 @file{~/.gnus.el}. Set this variable in @file{.emacs} instead.
25744 @item gnus-default-directory
25745 @vindex gnus-default-directory
25746 Not related to the above variable at all---this variable says what the
25747 default directory of all Gnus buffers should be. If you issue commands
25748 like @kbd{C-x C-f}, the prompt you'll get starts in the current buffer's
25749 default directory. If this variable is @code{nil} (which is the
25750 default), the default directory will be the default directory of the
25751 buffer you were in when you started Gnus.
25754 @vindex gnus-verbose
25755 This variable is an integer between zero and ten. The higher the value,
25756 the more messages will be displayed. If this variable is zero, Gnus
25757 will never flash any messages, if it is seven (which is the default),
25758 most important messages will be shown, and if it is ten, Gnus won't ever
25759 shut up, but will flash so many messages it will make your head swim.
25761 @item gnus-verbose-backends
25762 @vindex gnus-verbose-backends
25763 This variable works the same way as @code{gnus-verbose}, but it applies
25764 to the Gnus back ends instead of Gnus proper.
25766 @item gnus-add-timestamp-to-message
25767 @vindex gnus-add-timestamp-to-message
25768 This variable controls whether to add timestamps to messages that are
25769 controlled by @code{gnus-verbose} and @code{gnus-verbose-backends} and
25770 are issued. The default value is @code{nil} which means never to add
25771 timestamp. If it is @code{log}, add timestamps to only the messages
25772 that go into the @samp{*Messages*} buffer (in XEmacs, it is the
25773 @w{@samp{ *Message-Log*}} buffer). If it is neither @code{nil} nor
25774 @code{log}, add timestamps not only to log messages but also to the ones
25775 displayed in the echo area.
25777 @item nnheader-max-head-length
25778 @vindex nnheader-max-head-length
25779 When the back ends read straight heads of articles, they all try to read
25780 as little as possible. This variable (default 8192) specifies
25781 the absolute max length the back ends will try to read before giving up
25782 on finding a separator line between the head and the body. If this
25783 variable is @code{nil}, there is no upper read bound. If it is
25784 @code{t}, the back ends won't try to read the articles piece by piece,
25785 but read the entire articles. This makes sense with some versions of
25786 @code{ange-ftp} or @code{efs}.
25788 @item nnheader-head-chop-length
25789 @vindex nnheader-head-chop-length
25790 This variable (default 2048) says how big a piece of each article to
25791 read when doing the operation described above.
25793 @item nnheader-file-name-translation-alist
25794 @vindex nnheader-file-name-translation-alist
25796 @cindex invalid characters in file names
25797 @cindex characters in file names
25798 This is an alist that says how to translate characters in file names.
25799 For instance, if @samp{:} is invalid as a file character in file names
25800 on your system (you OS/2 user you), you could say something like:
25804 (setq nnheader-file-name-translation-alist
25809 In fact, this is the default value for this variable on OS/2 and MS
25810 Windows (phooey) systems.
25812 @item gnus-hidden-properties
25813 @vindex gnus-hidden-properties
25814 This is a list of properties to use to hide ``invisible'' text. It is
25815 @code{(invisible t intangible t)} by default on most systems, which
25816 makes invisible text invisible and intangible.
25818 @item gnus-parse-headers-hook
25819 @vindex gnus-parse-headers-hook
25820 A hook called before parsing headers. It can be used, for instance, to
25821 gather statistics on the headers fetched, or perhaps you'd like to prune
25822 some headers. I don't see why you'd want that, though.
25824 @item gnus-shell-command-separator
25825 @vindex gnus-shell-command-separator
25826 String used to separate two shell commands. The default is @samp{;}.
25828 @item gnus-invalid-group-regexp
25829 @vindex gnus-invalid-group-regexp
25831 Regexp to match ``invalid'' group names when querying user for a group
25832 name. The default value catches some @strong{really} invalid group
25833 names who could possibly mess up Gnus internally (like allowing
25834 @samp{:} in a group name, which is normally used to delimit method and
25837 @acronym{IMAP} users might want to allow @samp{/} in group names though.
25845 Well, that's the manual---you can get on with your life now. Keep in
25846 touch. Say hello to your cats from me.
25848 My @strong{ghod}---I just can't stand goodbyes. Sniffle.
25850 Ol' Charles Reznikoff said it pretty well, so I leave the floor to him:
25856 Not because of victories @*
25859 but for the common sunshine,@*
25861 the largess of the spring.
25865 but for the day's work done@*
25866 as well as I was able;@*
25867 not for a seat upon the dais@*
25868 but at the common table.@*
25873 @chapter Appendices
25876 * XEmacs:: Requirements for installing under XEmacs.
25877 * History:: How Gnus got where it is today.
25878 * On Writing Manuals:: Why this is not a beginner's guide.
25879 * Terminology:: We use really difficult, like, words here.
25880 * Customization:: Tailoring Gnus to your needs.
25881 * Troubleshooting:: What you might try if things do not work.
25882 * Gnus Reference Guide:: Rilly, rilly technical stuff.
25883 * Emacs for Heathens:: A short introduction to Emacsian terms.
25884 * Frequently Asked Questions:: The Gnus FAQ
25891 @cindex installing under XEmacs
25893 XEmacs is distributed as a collection of packages. You should install
25894 whatever packages the Gnus XEmacs package requires. The current
25895 requirements are @samp{gnus}, @samp{mail-lib}, @samp{xemacs-base},
25896 @samp{eterm}, @samp{sh-script}, @samp{net-utils}, @samp{os-utils},
25897 @samp{dired}, @samp{mh-e}, @samp{sieve}, @samp{ps-print}, @samp{W3},
25898 @samp{pgg}, @samp{mailcrypt}, @samp{ecrypto}, and @samp{sasl}.
25905 @sc{gnus} was written by Masanobu @sc{Umeda}. When autumn crept up in
25906 '94, Lars Magne Ingebrigtsen grew bored and decided to rewrite Gnus.
25908 If you want to investigate the person responsible for this outrage,
25909 you can point your (feh!) web browser to
25910 @uref{http://quimby.gnus.org/}. This is also the primary
25911 distribution point for the new and spiffy versions of Gnus, and is
25912 known as The Site That Destroys Newsrcs And Drives People Mad.
25914 During the first extended alpha period of development, the new Gnus was
25915 called ``(ding) Gnus''. @dfn{(ding)} is, of course, short for
25916 @dfn{ding is not Gnus}, which is a total and utter lie, but who cares?
25917 (Besides, the ``Gnus'' in this abbreviation should probably be
25918 pronounced ``news'' as @sc{Umeda} intended, which makes it a more
25919 appropriate name, don't you think?)
25921 In any case, after spending all that energy on coming up with a new and
25922 spunky name, we decided that the name was @emph{too} spunky, so we
25923 renamed it back again to ``Gnus''. But in mixed case. ``Gnus'' vs.
25924 ``@sc{gnus}''. New vs. old.
25927 * Gnus Versions:: What Gnus versions have been released.
25928 * Other Gnus Versions:: Other Gnus versions that also have been released.
25929 * Why?:: What's the point of Gnus?
25930 * Compatibility:: Just how compatible is Gnus with @sc{gnus}?
25931 * Conformity:: Gnus tries to conform to all standards.
25932 * Emacsen:: Gnus can be run on a few modern Emacsen.
25933 * Gnus Development:: How Gnus is developed.
25934 * Contributors:: Oodles of people.
25935 * New Features:: Pointers to some of the new stuff in Gnus.
25939 @node Gnus Versions
25940 @subsection Gnus Versions
25942 @cindex September Gnus
25944 @cindex Quassia Gnus
25945 @cindex Pterodactyl Gnus
25948 @cindex Gnus versions
25950 The first ``proper'' release of Gnus 5 was done in November 1995 when it
25951 was included in the Emacs 19.30 distribution (132 (ding) Gnus releases
25952 plus 15 Gnus 5.0 releases).
25954 In May 1996 the next Gnus generation (aka. ``September Gnus'' (after 99
25955 releases)) was released under the name ``Gnus 5.2'' (40 releases).
25957 On July 28th 1996 work on Red Gnus was begun, and it was released on
25958 January 25th 1997 (after 84 releases) as ``Gnus 5.4'' (67 releases).
25960 On September 13th 1997, Quassia Gnus was started and lasted 37 releases.
25961 It was released as ``Gnus 5.6'' on March 8th 1998 (46 releases).
25963 Gnus 5.6 begat Pterodactyl Gnus on August 29th 1998 and was released as
25964 ``Gnus 5.8'' (after 99 releases and a CVS repository) on December 3rd
25967 On the 26th of October 2000, Oort Gnus was begun and was released as
25968 Gnus 5.10 on May 1st 2003 (24 releases).
25970 On the January 4th 2004, No Gnus was begun.
25972 If you happen upon a version of Gnus that has a prefixed name --
25973 ``(ding) Gnus'', ``September Gnus'', ``Red Gnus'', ``Quassia Gnus'',
25974 ``Pterodactyl Gnus'', ``Oort Gnus'', ``No Gnus'' -- don't panic.
25975 Don't let it know that you're frightened. Back away. Slowly. Whatever
25976 you do, don't run. Walk away, calmly, until you're out of its reach.
25977 Find a proper released version of Gnus and snuggle up to that instead.
25980 @node Other Gnus Versions
25981 @subsection Other Gnus Versions
25984 In addition to the versions of Gnus which have had their releases
25985 coordinated by Lars, one major development has been Semi-gnus from
25986 Japan. It's based on a library called @acronym{SEMI}, which provides
25987 @acronym{MIME} capabilities.
25989 These Gnusae are based mainly on Gnus 5.6 and Pterodactyl Gnus.
25990 Collectively, they are called ``Semi-gnus'', and different strains are
25991 called T-gnus, ET-gnus, Nana-gnus and Chaos. These provide powerful
25992 @acronym{MIME} and multilingualization things, especially important for
25999 What's the point of Gnus?
26001 I want to provide a ``rad'', ``happening'', ``way cool'' and ``hep''
26002 newsreader, that lets you do anything you can think of. That was my
26003 original motivation, but while working on Gnus, it has become clear to
26004 me that this generation of newsreaders really belong in the stone age.
26005 Newsreaders haven't developed much since the infancy of the net. If the
26006 volume continues to rise with the current rate of increase, all current
26007 newsreaders will be pretty much useless. How do you deal with
26008 newsgroups that have thousands of new articles each day? How do you
26009 keep track of millions of people who post?
26011 Gnus offers no real solutions to these questions, but I would very much
26012 like to see Gnus being used as a testing ground for new methods of
26013 reading and fetching news. Expanding on @sc{Umeda}-san's wise decision
26014 to separate the newsreader from the back ends, Gnus now offers a simple
26015 interface for anybody who wants to write new back ends for fetching mail
26016 and news from different sources. I have added hooks for customizations
26017 everywhere I could imagine it being useful. By doing so, I'm inviting
26018 every one of you to explore and invent.
26020 May Gnus never be complete. @kbd{C-u 100 M-x all-hail-emacs} and
26021 @kbd{C-u 100 M-x all-hail-xemacs}.
26024 @node Compatibility
26025 @subsection Compatibility
26027 @cindex compatibility
26028 Gnus was designed to be fully compatible with @sc{gnus}. Almost all key
26029 bindings have been kept. More key bindings have been added, of course,
26030 but only in one or two obscure cases have old bindings been changed.
26035 @center In a cloud bones of steel.
26039 All commands have kept their names. Some internal functions have changed
26042 The @code{gnus-uu} package has changed drastically. @xref{Decoding
26045 One major compatibility question is the presence of several summary
26046 buffers. All variables relevant while reading a group are
26047 buffer-local to the summary buffer they belong in. Although many
26048 important variables have their values copied into their global
26049 counterparts whenever a command is executed in the summary buffer, this
26050 change might lead to incorrect values being used unless you are careful.
26052 All code that relies on knowledge of @sc{gnus} internals will probably
26053 fail. To take two examples: Sorting @code{gnus-newsrc-alist} (or
26054 changing it in any way, as a matter of fact) is strictly verboten. Gnus
26055 maintains a hash table that points to the entries in this alist (which
26056 speeds up many functions), and changing the alist directly will lead to
26060 @cindex highlighting
26061 Old hilit19 code does not work at all. In fact, you should probably
26062 remove all hilit code from all Gnus hooks
26063 (@code{gnus-group-prepare-hook} and @code{gnus-summary-prepare-hook}).
26064 Gnus provides various integrated functions for highlighting. These are
26065 faster and more accurate. To make life easier for everybody, Gnus will
26066 by default remove all hilit calls from all hilit hooks. Uncleanliness!
26069 Packages like @code{expire-kill} will no longer work. As a matter of
26070 fact, you should probably remove all old @sc{gnus} packages (and other
26071 code) when you start using Gnus. More likely than not, Gnus already
26072 does what you have written code to make @sc{gnus} do. (Snicker.)
26074 Even though old methods of doing things are still supported, only the
26075 new methods are documented in this manual. If you detect a new method of
26076 doing something while reading this manual, that does not mean you have
26077 to stop doing it the old way.
26079 Gnus understands all @sc{gnus} startup files.
26081 @kindex M-x gnus-bug
26083 @cindex reporting bugs
26085 Overall, a casual user who hasn't written much code that depends on
26086 @sc{gnus} internals should suffer no problems. If problems occur,
26087 please let me know by issuing that magic command @kbd{M-x gnus-bug}.
26089 @vindex gnus-bug-create-help-buffer
26090 If you are in the habit of sending bug reports @emph{very} often, you
26091 may find the helpful help buffer annoying after a while. If so, set
26092 @code{gnus-bug-create-help-buffer} to @code{nil} to avoid having it pop
26097 @subsection Conformity
26099 No rebels without a clue here, ma'am. We conform to all standards known
26100 to (wo)man. Except for those standards and/or conventions we disagree
26108 There are no known breaches of this standard.
26112 There are no known breaches of this standard, either.
26114 @item Son-of-RFC 1036
26115 @cindex Son-of-RFC 1036
26116 We do have some breaches to this one.
26122 These are considered to be ``vanity headers'', while I consider them
26123 to be consumer information. After seeing so many badly formatted
26124 articles coming from @code{tin} and @code{Netscape} I know not to use
26125 either of those for posting articles. I would not have known that if
26126 it wasn't for the @code{X-Newsreader} header.
26131 USEFOR is an IETF working group writing a successor to RFC 1036, based
26132 on Son-of-RFC 1036. They have produced a number of drafts proposing
26133 various changes to the format of news articles. The Gnus towers will
26134 look into implementing the changes when the draft is accepted as an RFC.
26136 @item MIME - RFC 2045-2049 etc
26137 @cindex @acronym{MIME}
26138 All the various @acronym{MIME} RFCs are supported.
26140 @item Disposition Notifications - RFC 2298
26141 Message Mode is able to request notifications from the receiver.
26143 @item PGP - RFC 1991 and RFC 2440
26146 RFC 1991 is the original @acronym{PGP} message specification,
26147 published as an informational RFC. RFC 2440 was the follow-up, now
26148 called Open PGP, and put on the Standards Track. Both document a
26149 non-@acronym{MIME} aware @acronym{PGP} format. Gnus supports both
26150 encoding (signing and encryption) and decoding (verification and
26153 @item PGP/MIME - RFC 2015/3156
26154 RFC 2015 (superseded by 3156 which references RFC 2440 instead of RFC
26155 1991) describes the @acronym{MIME}-wrapping around the RFC 1991/2440 format.
26156 Gnus supports both encoding and decoding.
26158 @item S/MIME - RFC 2633
26159 RFC 2633 describes the @acronym{S/MIME} format.
26161 @item IMAP - RFC 1730/2060, RFC 2195, RFC 2086, RFC 2359, RFC 2595, RFC 1731
26162 RFC 1730 is @acronym{IMAP} version 4, updated somewhat by RFC 2060
26163 (@acronym{IMAP} 4 revision 1). RFC 2195 describes CRAM-MD5
26164 authentication for @acronym{IMAP}. RFC 2086 describes access control
26165 lists (ACLs) for @acronym{IMAP}. RFC 2359 describes a @acronym{IMAP}
26166 protocol enhancement. RFC 2595 describes the proper @acronym{TLS}
26167 integration (STARTTLS) with @acronym{IMAP}. RFC 1731 describes the
26168 GSSAPI/Kerberos4 mechanisms for @acronym{IMAP}.
26172 If you ever notice Gnus acting non-compliant with regards to the texts
26173 mentioned above, don't hesitate to drop a note to Gnus Towers and let us
26178 @subsection Emacsen
26184 Gnus should work on:
26192 XEmacs 21.4 and up.
26196 This Gnus version will absolutely not work on any Emacsen older than
26197 that. Not reliably, at least. Older versions of Gnus may work on older
26198 Emacs versions. Particularly, Gnus 5.10.8 should also work on Emacs
26199 20.7 and XEmacs 21.1.
26201 There are some vague differences between Gnus on the various
26202 platforms---XEmacs features more graphics (a logo and a toolbar)---but
26203 other than that, things should look pretty much the same under all
26207 @node Gnus Development
26208 @subsection Gnus Development
26210 Gnus is developed in a two-phased cycle. The first phase involves much
26211 discussion on the @samp{ding@@gnus.org} mailing list, where people
26212 propose changes and new features, post patches and new back ends. This
26213 phase is called the @dfn{alpha} phase, since the Gnusae released in this
26214 phase are @dfn{alpha releases}, or (perhaps more commonly in other
26215 circles) @dfn{snapshots}. During this phase, Gnus is assumed to be
26216 unstable and should not be used by casual users. Gnus alpha releases
26217 have names like ``Red Gnus'' and ``Quassia Gnus''.
26219 After futzing around for 50-100 alpha releases, Gnus is declared
26220 @dfn{frozen}, and only bug fixes are applied. Gnus loses the prefix,
26221 and is called things like ``Gnus 5.6.32'' instead. Normal people are
26222 supposed to be able to use these, and these are mostly discussed on the
26223 @samp{gnu.emacs.gnus} newsgroup.
26226 @vindex mail-source-delete-incoming
26227 Some variable defaults differ between alpha Gnusae and released Gnusae,
26228 in particular, @code{mail-source-delete-incoming}. This is to prevent
26229 lossage of mail if an alpha release hiccups while handling the mail.
26230 @xref{Mail Source Customization}.
26232 The division of discussion between the ding mailing list and the Gnus
26233 newsgroup is not purely based on publicity concerns. It's true that
26234 having people write about the horrible things that an alpha Gnus release
26235 can do (sometimes) in a public forum may scare people off, but more
26236 importantly, talking about new experimental features that have been
26237 introduced may confuse casual users. New features are frequently
26238 introduced, fiddled with, and judged to be found wanting, and then
26239 either discarded or totally rewritten. People reading the mailing list
26240 usually keep up with these rapid changes, while people on the newsgroup
26241 can't be assumed to do so.
26244 @c ding = gmane.emacs.gnus.general
26245 @c newsgroup = gnu.emacs.gnus = gmane.emacs.gnus.user = info-gnus-english
26249 @subsection Contributors
26250 @cindex contributors
26252 The new Gnus version couldn't have been done without the help of all the
26253 people on the (ding) mailing list. Every day for over a year I have
26254 gotten billions of nice bug reports from them, filling me with joy,
26255 every single one of them. Smooches. The people on the list have been
26256 tried beyond endurance, what with my ``oh, that's a neat idea <type
26257 type>, yup, I'll release it right away <ship off> no wait, that doesn't
26258 work at all <type type>, yup, I'll ship that one off right away <ship
26259 off> no, wait, that absolutely does not work'' policy for releases.
26260 Micro$oft---bah. Amateurs. I'm @emph{much} worse. (Or is that
26261 ``worser''? ``much worser''? ``worsest''?)
26263 I would like to take this opportunity to thank the Academy for@dots{} oops,
26269 Masanobu @sc{Umeda}---the writer of the original @sc{gnus}.
26272 Shenghuo Zhu---uudecode.el, mm-uu.el, rfc1843.el, webmail.el,
26273 nnwarchive and many, many other things connected with @acronym{MIME} and
26274 other types of en/decoding, as well as general bug fixing, new
26275 functionality and stuff.
26278 Per Abrahamsen---custom, scoring, highlighting and @sc{soup} code (as
26279 well as numerous other things).
26282 Luis Fernandes---design and graphics.
26285 Joe Reiss---creator of the smiley faces.
26288 Justin Sheehy---the @acronym{FAQ} maintainer.
26291 Erik Naggum---help, ideas, support, code and stuff.
26294 Wes Hardaker---@file{gnus-picon.el} and the manual section on
26295 @dfn{picons} (@pxref{Picons}).
26298 Kim-Minh Kaplan---further work on the picon code.
26301 Brad Miller---@file{gnus-gl.el} and the GroupLens manual section.
26304 Sudish Joseph---innumerable bug fixes.
26307 Ilja Weis---@file{gnus-topic.el}.
26310 Steven L. Baur---lots and lots and lots of bugs detections and fixes.
26313 Vladimir Alexiev---the refcard and reference booklets.
26316 Felix Lee & Jamie Zawinski---I stole some pieces from the XGnus
26317 distribution by Felix Lee and JWZ.
26320 Scott Byer---@file{nnfolder.el} enhancements & rewrite.
26323 Peter Mutsaers---orphan article scoring code.
26326 Ken Raeburn---POP mail support.
26329 Hallvard B Furuseth---various bits and pieces, especially dealing with
26333 Brian Edmonds---@file{gnus-bbdb.el}.
26336 David Moore---rewrite of @file{nnvirtual.el} and many other things.
26339 Kevin Davidson---came up with the name @dfn{ding}, so blame him.
26342 Fran@,{c}ois Pinard---many, many interesting and thorough bug reports, as
26343 well as autoconf support.
26347 This manual was proof-read by Adrian Aichner, with Ricardo Nassif, Mark
26348 Borges, and Jost Krieger proof-reading parts of the manual.
26350 The following people have contributed many patches and suggestions:
26365 Jason L. Tibbitts, III,
26367 Katsumi Yamaoka, @c Yamaoka
26371 Also thanks to the following for patches and stuff:
26381 Alexei V. Barantsev,
26396 Massimo Campostrini,
26401 Jae-you Chung, @c ?
26402 James H. Cloos, Jr.,
26406 Andrew J. Cosgriff,
26409 Geoffrey T. Dairiki,
26415 Michael Welsh Duggan,
26420 Enami Tsugutomo, @c Enami
26424 Nelson Jose dos Santos Ferreira,
26432 Arne Georg Gleditsch,
26434 Michelangelo Grigni,
26438 Kenichi Handa, @c Handa
26440 Yoshiki Hayashi, @c Hayashi
26442 Hisashige Kenji, @c Hisashige
26450 Fran@,{c}ois Felix Ingrand,
26451 Tatsuya Ichikawa, @c Ichikawa
26452 Ishikawa Ichiro, @c Ishikawa
26454 Iwamuro Motonori, @c Iwamuro
26464 Peter Skov Knudsen,
26465 Shuhei Kobayashi, @c Kobayashi
26467 Koseki Yoshinori, @c Koseki
26468 Thor Kristoffersen,
26471 Seokchan Lee, @c Lee
26489 Morioka Tomohiko, @c Morioka
26490 Erik Toubro Nielsen,
26497 Masaharu Onishi, @c Onishi
26502 Jens-Ulrik Holger Petersen,
26506 John McClary Prevost,
26512 Lars Balker Rasmussen,
26517 Christian von Roques,
26520 Wolfgang Rupprecht,
26527 Philippe Schnoebelen,
26529 Randal L. Schwartz,
26543 Kiyokazu Suto, @c Suto
26548 Tozawa Akihiko, @c Tozawa
26568 For a full overview of what each person has done, the ChangeLogs
26569 included in the Gnus alpha distributions should give ample reading
26570 (550kB and counting).
26572 Apologies to everybody that I've forgotten, of which there are many, I'm
26575 Gee, that's quite a list of people. I guess that must mean that there
26576 actually are people who are using Gnus. Who'd'a thunk it!
26580 @subsection New Features
26581 @cindex new features
26584 * ding Gnus:: New things in Gnus 5.0/5.1, the first new Gnus.
26585 * September Gnus:: The Thing Formally Known As Gnus 5.2/5.3.
26586 * Red Gnus:: Third time best---Gnus 5.4/5.5.
26587 * Quassia Gnus:: Two times two is four, or Gnus 5.6/5.7.
26588 * Pterodactyl Gnus:: Pentad also starts with P, AKA Gnus 5.8/5.9.
26589 * Oort Gnus:: It's big. It's far out. Gnus 5.10/5.11.
26590 * No Gnus:: Very punny.
26593 These lists are, of course, just @emph{short} overviews of the
26594 @emph{most} important new features. No, really. There are tons more.
26595 Yes, we have feeping creaturism in full effect.
26598 @subsubsection (ding) Gnus
26600 New features in Gnus 5.0/5.1:
26605 The look of all buffers can be changed by setting format-like variables
26606 (@pxref{Group Buffer Format} and @pxref{Summary Buffer Format}).
26609 Local spool and several @acronym{NNTP} servers can be used at once
26610 (@pxref{Select Methods}).
26613 You can combine groups into virtual groups (@pxref{Virtual Groups}).
26616 You can read a number of different mail formats (@pxref{Getting Mail}).
26617 All the mail back ends implement a convenient mail expiry scheme
26618 (@pxref{Expiring Mail}).
26621 Gnus can use various strategies for gathering threads that have lost
26622 their roots (thereby gathering loose sub-threads into one thread) or it
26623 can go back and retrieve enough headers to build a complete thread
26624 (@pxref{Customizing Threading}).
26627 Killed groups can be displayed in the group buffer, and you can read
26628 them as well (@pxref{Listing Groups}).
26631 Gnus can do partial group updates---you do not have to retrieve the
26632 entire active file just to check for new articles in a few groups
26633 (@pxref{The Active File}).
26636 Gnus implements a sliding scale of subscribedness to groups
26637 (@pxref{Group Levels}).
26640 You can score articles according to any number of criteria
26641 (@pxref{Scoring}). You can even get Gnus to find out how to score
26642 articles for you (@pxref{Adaptive Scoring}).
26645 Gnus maintains a dribble buffer that is auto-saved the normal Emacs
26646 manner, so it should be difficult to lose much data on what you have
26647 read if your machine should go down (@pxref{Auto Save}).
26650 Gnus now has its own startup file (@file{~/.gnus.el}) to avoid
26651 cluttering up the @file{.emacs} file.
26654 You can set the process mark on both groups and articles and perform
26655 operations on all the marked items (@pxref{Process/Prefix}).
26658 You can grep through a subset of groups and create a group from the
26659 results (@pxref{Kibozed Groups}).
26662 You can list subsets of groups according to, well, anything
26663 (@pxref{Listing Groups}).
26666 You can browse foreign servers and subscribe to groups from those
26667 servers (@pxref{Browse Foreign Server}).
26670 Gnus can fetch articles, asynchronously, on a second connection to the
26671 server (@pxref{Asynchronous Fetching}).
26674 You can cache articles locally (@pxref{Article Caching}).
26677 The uudecode functions have been expanded and generalized
26678 (@pxref{Decoding Articles}).
26681 You can still post uuencoded articles, which was a little-known feature
26682 of @sc{gnus}' past (@pxref{Uuencoding and Posting}).
26685 Fetching parents (and other articles) now actually works without
26686 glitches (@pxref{Finding the Parent}).
26689 Gnus can fetch @acronym{FAQ}s and group descriptions (@pxref{Group Information}).
26692 Digests (and other files) can be used as the basis for groups
26693 (@pxref{Document Groups}).
26696 Articles can be highlighted and customized (@pxref{Customizing
26700 URLs and other external references can be buttonized (@pxref{Article
26704 You can do lots of strange stuff with the Gnus window & frame
26705 configuration (@pxref{Window Layout}).
26708 You can click on buttons instead of using the keyboard
26714 @node September Gnus
26715 @subsubsection September Gnus
26719 \gnusfig{-28cm}{0cm}{\epsfig{figure=ps/september,height=20cm}}
26723 New features in Gnus 5.2/5.3:
26728 A new message composition mode is used. All old customization variables
26729 for @code{mail-mode}, @code{rnews-reply-mode} and @code{gnus-msg} are
26733 Gnus is now able to generate @dfn{sparse} threads---threads where
26734 missing articles are represented by empty nodes (@pxref{Customizing
26738 (setq gnus-build-sparse-threads 'some)
26742 Outgoing articles are stored on a special archive server
26743 (@pxref{Archived Messages}).
26746 Partial thread regeneration now happens when articles are
26750 Gnus can make use of GroupLens predictions.
26753 Picons (personal icons) can be displayed under XEmacs (@pxref{Picons}).
26756 A @code{trn}-like tree buffer can be displayed (@pxref{Tree Display}).
26759 (setq gnus-use-trees t)
26763 An @code{nn}-like pick-and-read minor mode is available for the summary
26764 buffers (@pxref{Pick and Read}).
26767 (add-hook 'gnus-summary-mode-hook 'gnus-pick-mode)
26771 In binary groups you can use a special binary minor mode (@pxref{Binary
26775 Groups can be grouped in a folding topic hierarchy (@pxref{Group
26779 (add-hook 'gnus-group-mode-hook 'gnus-topic-mode)
26783 Gnus can re-send and bounce mail (@pxref{Summary Mail Commands}).
26786 Groups can now have a score, and bubbling based on entry frequency
26787 is possible (@pxref{Group Score}).
26790 (add-hook 'gnus-summary-exit-hook 'gnus-summary-bubble-group)
26794 Groups can be process-marked, and commands can be performed on
26795 groups of groups (@pxref{Marking Groups}).
26798 Caching is possible in virtual groups.
26801 @code{nndoc} now understands all kinds of digests, mail boxes, rnews
26802 news batches, ClariNet briefs collections, and just about everything
26803 else (@pxref{Document Groups}).
26806 Gnus has a new back end (@code{nnsoup}) to create/read SOUP packets
26810 The Gnus cache is much faster.
26813 Groups can be sorted according to many criteria (@pxref{Sorting
26817 New group parameters have been introduced to set list-addresses and
26818 expiry times (@pxref{Group Parameters}).
26821 All formatting specs allow specifying faces to be used
26822 (@pxref{Formatting Fonts}).
26825 There are several more commands for setting/removing/acting on process
26826 marked articles on the @kbd{M P} submap (@pxref{Setting Process Marks}).
26829 The summary buffer can be limited to show parts of the available
26830 articles based on a wide range of criteria. These commands have been
26831 bound to keys on the @kbd{/} submap (@pxref{Limiting}).
26834 Articles can be made persistent with the @kbd{*} command
26835 (@pxref{Persistent Articles}).
26838 All functions for hiding article elements are now toggles.
26841 Article headers can be buttonized (@pxref{Article Washing}).
26844 All mail back ends support fetching articles by @code{Message-ID}.
26847 Duplicate mail can now be treated properly (@pxref{Duplicates}).
26850 All summary mode commands are available directly from the article
26851 buffer (@pxref{Article Keymap}).
26854 Frames can be part of @code{gnus-buffer-configuration} (@pxref{Window
26858 Mail can be re-scanned by a daemonic process (@pxref{Daemons}).
26861 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fseptember,height=5cm}]{\epsfig{figure=ps/fseptember,height=5cm}}
26866 Gnus can make use of NoCeM files to weed out spam (@pxref{NoCeM}).
26869 (setq gnus-use-nocem t)
26873 Groups can be made permanently visible (@pxref{Listing Groups}).
26876 (setq gnus-permanently-visible-groups "^nnml:")
26880 Many new hooks have been introduced to make customizing easier.
26883 Gnus respects the @code{Mail-Copies-To} header.
26886 Threads can be gathered by looking at the @code{References} header
26887 (@pxref{Customizing Threading}).
26890 (setq gnus-summary-thread-gathering-function
26891 'gnus-gather-threads-by-references)
26895 Read articles can be stored in a special backlog buffer to avoid
26896 refetching (@pxref{Article Backlog}).
26899 (setq gnus-keep-backlog 50)
26903 A clean copy of the current article is always stored in a separate
26904 buffer to allow easier treatment.
26907 Gnus can suggest where to save articles (@pxref{Saving Articles}).
26910 Gnus doesn't have to do as much prompting when saving (@pxref{Saving
26914 (setq gnus-prompt-before-saving t)
26918 @code{gnus-uu} can view decoded files asynchronously while fetching
26919 articles (@pxref{Other Decode Variables}).
26922 (setq gnus-uu-grabbed-file-functions 'gnus-uu-grab-view)
26926 Filling in the article buffer now works properly on cited text
26927 (@pxref{Article Washing}).
26930 Hiding cited text adds buttons to toggle hiding, and how much
26931 cited text to hide is now customizable (@pxref{Article Hiding}).
26934 (setq gnus-cited-lines-visible 2)
26938 Boring headers can be hidden (@pxref{Article Hiding}).
26941 Default scoring values can now be set from the menu bar.
26944 Further syntax checking of outgoing articles have been added.
26950 @subsubsection Red Gnus
26952 New features in Gnus 5.4/5.5:
26956 \gnusfig{-5.5cm}{-4cm}{\epsfig{figure=ps/red,height=20cm}}
26963 @file{nntp.el} has been totally rewritten in an asynchronous fashion.
26966 Article prefetching functionality has been moved up into
26967 Gnus (@pxref{Asynchronous Fetching}).
26970 Scoring can now be performed with logical operators like @code{and},
26971 @code{or}, @code{not}, and parent redirection (@pxref{Advanced
26975 Article washing status can be displayed in the
26976 article mode line (@pxref{Misc Article}).
26979 @file{gnus.el} has been split into many smaller files.
26982 Suppression of duplicate articles based on Message-ID can be done
26983 (@pxref{Duplicate Suppression}).
26986 (setq gnus-suppress-duplicates t)
26990 New variables for specifying what score and adapt files are to be
26991 considered home score and adapt files (@pxref{Home Score File}) have
26995 @code{nndoc} was rewritten to be easily extendable (@pxref{Document
26996 Server Internals}).
26999 Groups can inherit group parameters from parent topics (@pxref{Topic
27003 Article editing has been revamped and is now actually usable.
27006 Signatures can be recognized in more intelligent fashions
27007 (@pxref{Article Signature}).
27010 Summary pick mode has been made to look more @code{nn}-like. Line
27011 numbers are displayed and the @kbd{.} command can be used to pick
27012 articles (@code{Pick and Read}).
27015 Commands for moving the @file{.newsrc.eld} from one server to
27016 another have been added (@pxref{Changing Servers}).
27019 There's a way now to specify that ``uninteresting'' fields be suppressed
27020 when generating lines in buffers (@pxref{Advanced Formatting}).
27023 Several commands in the group buffer can be undone with @kbd{C-M-_}
27027 Scoring can be done on words using the new score type @code{w}
27028 (@pxref{Score File Format}).
27031 Adaptive scoring can be done on a Subject word-by-word basis
27032 (@pxref{Adaptive Scoring}).
27035 (setq gnus-use-adaptive-scoring '(word))
27039 Scores can be decayed (@pxref{Score Decays}).
27042 (setq gnus-decay-scores t)
27046 Scoring can be performed using a regexp on the Date header. The Date is
27047 normalized to compact ISO 8601 format first (@pxref{Score File Format}).
27050 A new command has been added to remove all data on articles from
27051 the native server (@pxref{Changing Servers}).
27054 A new command for reading collections of documents
27055 (@code{nndoc} with @code{nnvirtual} on top) has been added---@kbd{C-M-d}
27056 (@pxref{Really Various Summary Commands}).
27059 Process mark sets can be pushed and popped (@pxref{Setting Process
27063 A new mail-to-news back end makes it possible to post even when the @acronym{NNTP}
27064 server doesn't allow posting (@pxref{Mail-To-News Gateways}).
27067 A new back end for reading searches from Web search engines
27068 (@dfn{DejaNews}, @dfn{Alta Vista}, @dfn{InReference}) has been added
27069 (@pxref{Web Searches}).
27072 Groups inside topics can now be sorted using the standard sorting
27073 functions, and each topic can be sorted independently (@pxref{Topic
27077 Subsets of the groups can be sorted independently (@code{Sorting
27081 Cached articles can be pulled into the groups (@pxref{Summary Generation
27085 \marginpar[\mbox{}\hfill\epsfig{figure=ps/fred,width=3cm}]{\epsfig{figure=ps/fred,width=3cm}}
27090 Score files are now applied in a more reliable order (@pxref{Score
27094 Reports on where mail messages end up can be generated (@pxref{Splitting
27098 More hooks and functions have been added to remove junk from incoming
27099 mail before saving the mail (@pxref{Washing Mail}).
27102 Emphasized text can be properly fontisized:
27108 @subsubsection Quassia Gnus
27110 New features in Gnus 5.6:
27115 New functionality for using Gnus as an offline newsreader has been
27116 added. A plethora of new commands and modes have been added.
27117 @xref{Gnus Unplugged}, for the full story.
27120 The @code{nndraft} back end has returned, but works differently than
27121 before. All Message buffers are now also articles in the @code{nndraft}
27122 group, which is created automatically.
27125 @code{gnus-alter-header-function} can now be used to alter header
27129 @code{gnus-summary-goto-article} now accept Message-ID's.
27132 A new Message command for deleting text in the body of a message
27133 outside the region: @kbd{C-c C-v}.
27136 You can now post to component group in @code{nnvirtual} groups with
27140 @code{nntp-rlogin-program}---new variable to ease customization.
27143 @code{C-u C-c C-c} in @code{gnus-article-edit-mode} will now inhibit
27144 re-highlighting of the article buffer.
27147 New element in @code{gnus-boring-article-headers}---@code{long-to}.
27150 @kbd{M-i} symbolic prefix command. @xref{Symbolic Prefixes}, for
27154 @kbd{L} and @kbd{I} in the summary buffer now take the symbolic prefix
27155 @kbd{a} to add the score rule to the @file{all.SCORE} file.
27158 @code{gnus-simplify-subject-functions} variable to allow greater
27159 control over simplification.
27162 @kbd{A T}---new command for fetching the current thread.
27165 @kbd{/ T}---new command for including the current thread in the
27169 @kbd{M-RET} is a new Message command for breaking cited text.
27172 @samp{\\1}-expressions are now valid in @code{nnmail-split-methods}.
27175 The @code{custom-face-lookup} function has been removed.
27176 If you used this function in your initialization files, you must
27177 rewrite them to use @code{face-spec-set} instead.
27180 Canceling now uses the current select method. Symbolic prefix
27181 @kbd{a} forces normal posting method.
27184 New command to translate M******** sm*rtq**t*s into proper
27188 For easier debugging of @code{nntp}, you can set
27189 @code{nntp-record-commands} to a non-@code{nil} value.
27192 @code{nntp} now uses @file{~/.authinfo}, a @file{.netrc}-like file, for
27193 controlling where and how to send @sc{authinfo} to @acronym{NNTP} servers.
27196 A command for editing group parameters from the summary buffer
27200 A history of where mails have been split is available.
27203 A new article date command has been added---@code{article-date-iso8601}.
27206 Subjects can be simplified when threading by setting
27207 @code{gnus-score-thread-simplify}.
27210 A new function for citing in Message has been
27211 added---@code{message-cite-original-without-signature}.
27214 @code{article-strip-all-blank-lines}---new article command.
27217 A new Message command to kill to the end of the article has
27221 A minimum adaptive score can be specified by using the
27222 @code{gnus-adaptive-word-minimum} variable.
27225 The ``lapsed date'' article header can be kept continually
27226 updated by the @code{gnus-start-date-timer} command.
27229 Web listserv archives can be read with the @code{nnlistserv} back end.
27232 Old dejanews archives can now be read by @code{nnweb}.
27236 @node Pterodactyl Gnus
27237 @subsubsection Pterodactyl Gnus
27239 New features in Gnus 5.8:
27244 The mail-fetching functions have changed. See the manual for the
27245 many details. In particular, all procmail fetching variables are gone.
27247 If you used procmail like in
27250 (setq nnmail-use-procmail t)
27251 (setq nnmail-spool-file 'procmail)
27252 (setq nnmail-procmail-directory "~/mail/incoming/")
27253 (setq nnmail-procmail-suffix "\\.in")
27256 this now has changed to
27260 '((directory :path "~/mail/incoming/"
27264 @xref{Mail Source Specifiers}.
27267 Gnus is now a @acronym{MIME}-capable reader. This affects many parts of
27268 Gnus, and adds a slew of new commands. See the manual for details.
27271 Gnus has also been multilingualized. This also affects too
27272 many parts of Gnus to summarize here, and adds many new variables.
27275 @code{gnus-auto-select-first} can now be a function to be
27276 called to position point.
27279 The user can now decide which extra headers should be included in
27280 summary buffers and @acronym{NOV} files.
27283 @code{gnus-article-display-hook} has been removed. Instead, a number
27284 of variables starting with @code{gnus-treat-} have been added.
27287 The Gnus posting styles have been redone again and now works in a
27288 subtly different manner.
27291 New web-based back ends have been added: @code{nnslashdot},
27292 @code{nnwarchive} and @code{nnultimate}. nnweb has been revamped,
27293 again, to keep up with ever-changing layouts.
27296 Gnus can now read @acronym{IMAP} mail via @code{nnimap}.
27301 @subsubsection Oort Gnus
27304 New features in Gnus 5.10:
27308 @item Installation changes
27309 @c ***********************
27313 Upgrading from previous (stable) version if you have used Oort.
27315 If you have tried Oort (the unstable Gnus branch leading to this
27316 release) but went back to a stable version, be careful when upgrading to
27317 this version. In particular, you will probably want to remove all
27318 @file{.marks} (nnml) and @file{.mrk} (nnfolder) files, so that flags are
27319 read from your @file{.newsrc.eld} instead of from the
27320 @file{.marks}/@file{.mrk} file where this release store flags. See a
27321 later entry for more information about marks. Note that downgrading
27322 isn't save in general.
27325 Lisp files are now installed in @file{.../site-lisp/gnus/} by default.
27326 It defaulted to @file{.../site-lisp/} formerly. In addition to this,
27327 the new installer issues a warning if other Gnus installations which
27328 will shadow the latest one are detected. You can then remove those
27329 shadows manually or remove them using @code{make
27330 remove-installed-shadows}.
27333 New @file{make.bat} for compiling and installing Gnus under MS Windows
27335 Use @file{make.bat} if you want to install Gnus under MS Windows, the
27336 first argument to the batch-program should be the directory where
27337 @file{xemacs.exe} respectively @file{emacs.exe} is located, if you want
27338 to install Gnus after compiling it, give @file{make.bat} @code{/copy} as
27339 the second parameter.
27341 @file{make.bat} has been rewritten from scratch, it now features
27342 automatic recognition of XEmacs and GNU Emacs, generates
27343 @file{gnus-load.el}, checks if errors occur while compilation and
27344 generation of info files and reports them at the end of the build
27345 process. It now uses @code{makeinfo} if it is available and falls
27346 back to @file{infohack.el} otherwise. @file{make.bat} should now
27347 install all files which are necessary to run Gnus and be generally a
27348 complete replacement for the @code{configure; make; make install}
27349 cycle used under Unix systems.
27351 The new @file{make.bat} makes @file{make-x.bat} and @file{xemacs.mak}
27352 superfluous, so they have been removed.
27355 @file{~/News/overview/} not used.
27357 As a result of the following change, the @file{~/News/overview/}
27358 directory is not used any more. You can safely delete the entire
27361 @c FIXME: `gnus-load' is mentioned in README, which is not included in
27362 @c CVS. We should find a better place for this item.
27364 @code{(require 'gnus-load)}
27366 If you use a stand-alone Gnus distribution, you'd better add
27367 @code{(require 'gnus-load)} into your @file{~/.emacs} after adding the Gnus
27368 lisp directory into load-path.
27370 File @file{gnus-load.el} contains autoload commands, functions and variables,
27371 some of which may not be included in distributions of Emacsen.
27375 @item New packages and libraries within Gnus
27376 @c *****************************************
27381 The revised Gnus @acronym{FAQ} is included in the manual,
27382 @xref{Frequently Asked Questions}.
27385 @acronym{TLS} wrapper shipped with Gnus
27387 @acronym{TLS}/@acronym{SSL} is now supported in @acronym{IMAP} and
27388 @acronym{NNTP} via @file{tls.el} and GNUTLS. The old
27389 @acronym{TLS}/@acronym{SSL} support via (external third party)
27390 @file{ssl.el} and OpenSSL still works.
27393 Improved anti-spam features.
27395 Gnus is now able to take out spam from your mail and news streams
27396 using a wide variety of programs and filter rules. Among the supported
27397 methods are RBL blocklists, bogofilter and white/blacklists. Hooks
27398 for easy use of external packages such as SpamAssassin and Hashcash
27399 are also new. @ref{Thwarting Email Spam} and @ref{Spam Package}.
27400 @c FIXME: @xref{Spam Package}?. Should this be under Misc?
27403 Gnus supports server-side mail filtering using Sieve.
27405 Sieve rules can be added as Group Parameters for groups, and the
27406 complete Sieve script is generated using @kbd{D g} from the Group
27407 buffer, and then uploaded to the server using @kbd{C-c C-l} in the
27408 generated Sieve buffer. @xref{Sieve Commands}, and the new Sieve
27409 manual @ref{Top, , Top, sieve, Emacs Sieve}.
27413 @item Changes in group mode
27414 @c ************************
27419 @code{gnus-group-read-ephemeral-group} can be called interactively,
27423 Retrieval of charters and control messages
27425 There are new commands for fetching newsgroup charters (@kbd{H c}) and
27426 control messages (@kbd{H C}).
27429 The new variable @code{gnus-parameters} can be used to set group parameters.
27431 Earlier this was done only via @kbd{G p} (or @kbd{G c}), which stored
27432 the parameters in @file{~/.newsrc.eld}, but via this variable you can
27433 enjoy the powers of customize, and simplified backups since you set the
27434 variable in @file{~/.gnus.el} instead of @file{~/.newsrc.eld}. The
27435 variable maps regular expressions matching group names to group
27438 (setq gnus-parameters
27440 (gnus-show-threads nil)
27441 (gnus-use-scoring nil))
27442 ("^nnimap:\\(foo.bar\\)$"
27443 (to-group . "\\1"))))
27447 Unread count correct in nnimap groups.
27449 The estimated number of unread articles in the group buffer should now
27450 be correct for nnimap groups. This is achieved by calling
27451 @code{nnimap-fixup-unread-after-getting-new-news} from the
27452 @code{gnus-setup-news-hook} (called on startup) and
27453 @code{gnus-after-getting-new-news-hook}. (called after getting new
27454 mail). If you have modified those variables from the default, you may
27455 want to add @code{nnimap-fixup-unread-after-getting-new-news} again. If
27456 you were happy with the estimate and want to save some (minimal) time
27457 when getting new mail, remove the function.
27460 Group names are treated as UTF-8 by default.
27462 This is supposedly what USEFOR wanted to migrate to. See
27463 @code{gnus-group-name-charset-group-alist} and
27464 @code{gnus-group-name-charset-method-alist} for customization.
27467 @code{gnus-group-charset-alist} and
27468 @code{gnus-group-ignored-charsets-alist}.
27470 The regexps in these variables are compared with full group names
27471 instead of real group names in 5.8. Users who customize these
27472 variables should change those regexps accordingly. For example:
27474 ("^han\\>" euc-kr) -> ("\\(^\\|:\\)han\\>" euc-kr)
27478 Old intermediate incoming mail files (@file{Incoming*}) are deleted
27479 after a couple of days, not immediately. @xref{Mail Source
27480 Customization}. (New in Gnus 5.10.10)
27484 @item Changes in summary and article mode
27485 @c **************************************
27490 @kbd{F} (@code{gnus-article-followup-with-original}) and @kbd{R}
27491 (@code{gnus-article-reply-with-original}) only yank the text in the
27492 region if the region is active.
27495 In draft groups, @kbd{e} is now bound to @code{gnus-draft-edit-message}.
27496 Use @kbd{B w} for @code{gnus-summary-edit-article} instead.
27501 More buttons for URLs, mail addresses, Message-IDs, Info links, man
27502 pages and Emacs or Gnus related references. @xref{Article Buttons}. The
27503 variables @code{gnus-button-@var{*}-level} can be used to control the
27504 appearance of all article buttons. @xref{Article Button Levels}.
27507 Single-part yenc encoded attachments can be decoded.
27512 The picons code has been reimplemented to work in GNU Emacs---some of
27513 the previous options have been removed or renamed.
27515 Picons are small ``personal icons'' representing users, domain and
27516 newsgroups, which can be displayed in the Article buffer.
27520 If the new option @code{gnus-treat-body-boundary} is non-@code{nil}, a
27521 boundary line is drawn at the end of the headers.
27524 Signed article headers (X-PGP-Sig) can be verified with @kbd{W p}.
27527 The Summary Buffer uses an arrow in the fringe to indicate the current
27528 article. Use @code{(setq gnus-summary-display-arrow nil)} to disable it.
27531 Warn about email replies to news
27533 Do you often find yourself replying to news by email by mistake? Then
27534 the new option @code{gnus-confirm-mail-reply-to-news} is just the thing for
27538 If the new option @code{gnus-summary-display-while-building} is
27539 non-@code{nil}, the summary buffer is shown and updated as it's being
27543 The new @code{recent} mark @samp{.} indicates newly arrived messages (as
27544 opposed to old but unread messages).
27547 Gnus supports RFC 2369 mailing list headers, and adds a number of
27548 related commands in mailing list groups. @xref{Mailing List}.
27551 The Date header can be displayed in a format that can be read aloud
27552 in English. @xref{Article Date}.
27555 diffs are automatically highlighted in groups matching
27556 @code{mm-uu-diff-groups-regexp}
27559 Better handling of Microsoft citation styles
27561 Gnus now tries to recognize the mangled header block that some Microsoft
27562 mailers use to indicate that the rest of the message is a citation, even
27563 though it is not quoted in any way. The variable
27564 @code{gnus-cite-unsightly-citation-regexp} matches the start of these
27567 The new command @kbd{W Y f}
27568 (@code{gnus-article-outlook-deuglify-article}) allows deuglifying broken
27569 Outlook (Express) articles.
27572 @code{gnus-article-skip-boring}
27574 If you set @code{gnus-article-skip-boring} to @code{t}, then Gnus will
27575 not scroll down to show you a page that contains only boring text,
27576 which by default means cited text and signature. You can customize
27577 what is skippable using @code{gnus-article-boring-faces}.
27579 This feature is especially useful if you read many articles that
27580 consist of a little new content at the top with a long, untrimmed
27581 message cited below.
27584 Smileys (@samp{:-)}, @samp{;-)} etc) are now displayed graphically in
27587 Put @code{(setq gnus-treat-display-smileys nil)} in @file{~/.gnus.el} to
27591 Face headers handling. @xref{Face}.
27594 In the summary buffer, the new command @kbd{/ N} inserts new messages
27595 and @kbd{/ o} inserts old messages.
27598 Gnus decodes morse encoded messages if you press @kbd{W m}.
27601 @code{gnus-summary-line-format}
27603 The default value changed to @samp{%U%R%z%I%(%[%4L: %-23,23f%]%)
27604 %s\n}. Moreover @code{gnus-extra-headers},
27605 @code{nnmail-extra-headers} and @code{gnus-ignored-from-addresses}
27606 changed their default so that the users name will be replaced by the
27607 recipient's name or the group name posting to for @acronym{NNTP}
27611 Deleting of attachments.
27613 The command @code{gnus-mime-save-part-and-strip} (bound to @kbd{C-o}
27614 on @acronym{MIME} buttons) saves a part and replaces the part with an
27615 external one. @code{gnus-mime-delete-part} (bound to @kbd{d} on
27616 @acronym{MIME} buttons) removes a part. It works only on back ends
27617 that support editing.
27620 @code{gnus-default-charset}
27622 The default value is determined from the
27623 @code{current-language-environment} variable, instead of
27624 @code{iso-8859-1}. Also the @samp{.*} item in
27625 @code{gnus-group-charset-alist} is removed.
27628 Printing capabilities are enhanced.
27630 Gnus supports Muttprint natively with @kbd{O P} from the Summary and
27631 Article buffers. Also, each individual @acronym{MIME} part can be
27632 printed using @kbd{p} on the @acronym{MIME} button.
27635 Extended format specs.
27637 Format spec @samp{%&user-date;} is added into
27638 @code{gnus-summary-line-format-alist}. Also, user defined extended
27639 format specs are supported. The extended format specs look like
27640 @samp{%u&foo;}, which invokes function
27641 @code{gnus-user-format-function-@var{foo}}. Because @samp{&} is used as the
27642 escape character, old user defined format @samp{%u&} is no longer supported.
27645 @kbd{/ *} (@code{gnus-summary-limit-include-cached}) is rewritten.
27646 @c FIXME: Was this a user-visible change?
27648 It was aliased to @kbd{Y c}
27649 (@code{gnus-summary-insert-cached-articles}). The new function filters
27650 out other articles.
27653 Some limiting commands accept a @kbd{C-u} prefix to negate the match.
27655 If @kbd{C-u} is used on subject, author or extra headers, i.e., @kbd{/
27656 s}, @kbd{/ a}, and @kbd{/ x}
27657 (@code{gnus-summary-limit-to-@{subject,author,extra@}}) respectively, the
27658 result will be to display all articles that do not match the expression.
27661 Gnus inlines external parts (message/external).
27665 @item Changes in Message mode and related Gnus features
27666 @c ****************************************************
27673 You can delay the sending of a message with @kbd{C-c C-j} in the Message
27674 buffer. The messages are delivered at specified time. This is useful
27675 for sending yourself reminders. @xref{Delayed Articles}.
27678 If the new option @code{nnml-use-compressed-files} is non-@code{nil},
27679 the nnml back end allows compressed message files.
27682 The new option @code{gnus-gcc-mark-as-read} automatically marks
27683 Gcc articles as read.
27686 Externalizing of attachments
27688 If @code{gnus-gcc-externalize-attachments} or
27689 @code{message-fcc-externalize-attachments} is non-@code{nil}, attach
27690 local files as external parts.
27693 The envelope sender address can be customized when using Sendmail.
27694 @xref{Mail Variables, Mail Variables,, message, Message Manual}.
27697 Gnus no longer generate the Sender: header automatically.
27699 Earlier it was generated when the user configurable email address was
27700 different from the Gnus guessed default user address. As the guessing
27701 algorithm is rarely correct these days, and (more controversially) the
27702 only use of the Sender: header was to check if you are entitled to
27703 cancel/supersede news (which is now solved by Cancel Locks instead,
27704 see another entry), generation of the header has been disabled by
27705 default. See the variables @code{message-required-headers},
27706 @code{message-required-news-headers}, and
27707 @code{message-required-mail-headers}.
27710 Features from third party @file{message-utils.el} added to @file{message.el}.
27712 Message now asks if you wish to remove @samp{(was: <old subject>)} from
27713 subject lines (see @code{message-subject-trailing-was-query}). @kbd{C-c
27714 M-m} and @kbd{C-c M-f} inserts markers indicating included text.
27715 @kbd{C-c C-f a} adds a X-No-Archive: header. @kbd{C-c C-f x} inserts
27716 appropriate headers and a note in the body for cross-postings and
27717 followups (see the variables @code{message-cross-post-@var{*}}).
27720 References and X-Draft-From headers are no longer generated when you
27721 start composing messages and @code{message-generate-headers-first} is
27725 Easy inclusion of X-Faces headers. @xref{X-Face}.
27728 Group Carbon Copy (GCC) quoting
27730 To support groups that contains SPC and other weird characters, groups
27731 are quoted before they are placed in the Gcc: header. This means
27732 variables such as @code{gnus-message-archive-group} should no longer
27733 contain quote characters to make groups containing SPC work. Also, if
27734 you are using the string @samp{nnml:foo, nnml:bar} (indicating Gcc
27735 into two groups) you must change it to return the list
27736 @code{("nnml:foo" "nnml:bar")}, otherwise the Gcc: line will be quoted
27737 incorrectly. Note that returning the string @samp{nnml:foo, nnml:bar}
27738 was incorrect earlier, it just didn't generate any problems since it
27739 was inserted directly.
27742 @code{message-insinuate-rmail}
27744 Adding @code{(message-insinuate-rmail)} and @code{(setq
27745 mail-user-agent 'gnus-user-agent)} in @file{.emacs} convinces Rmail to
27746 compose, reply and forward messages in message-mode, where you can
27747 enjoy the power of @acronym{MML}.
27750 @code{message-minibuffer-local-map}
27752 The line below enables BBDB in resending a message:
27754 (define-key message-minibuffer-local-map [(tab)]
27755 'bbdb-complete-name)
27759 @code{gnus-posting-styles}
27761 Add a new format of match like
27763 ((header "to" "larsi.*org")
27764 (Organization "Somewhere, Inc."))
27766 The old format like the lines below is obsolete, but still accepted.
27768 (header "to" "larsi.*org"
27769 (Organization "Somewhere, Inc."))
27773 @code{message-ignored-news-headers} and @code{message-ignored-mail-headers}
27775 @samp{X-Draft-From} and @samp{X-Gnus-Agent-Meta-Information} have been
27776 added into these two variables. If you customized those, perhaps you
27777 need add those two headers too.
27780 Gnus supports the ``format=flowed'' (RFC 2646) parameter. On
27781 composing messages, it is enabled by @code{use-hard-newlines}.
27782 Decoding format=flowed was present but not documented in earlier
27786 The option @code{mm-fill-flowed} can be used to disable treatment of
27787 ``format=flowed'' messages. Also, flowed text is disabled when sending
27788 inline PGP signed messages. @xref{Flowed text, , Flowed text,
27789 emacs-mime, The Emacs MIME Manual}. (New in Gnus 5.10.7)
27790 @c This entry is also present in the node "No Gnus".
27793 Gnus supports the generation of RFC 2298 Disposition Notification requests.
27795 This is invoked with the @kbd{C-c M-n} key binding from message mode.
27798 Message supports the Importance: (RFC 2156) header.
27800 In the message buffer, @kbd{C-c C-f C-i} or @kbd{C-c C-u} cycles through
27804 Gnus supports Cancel Locks in News.
27806 This means a header @samp{Cancel-Lock} is inserted in news posting. It is
27807 used to determine if you wrote an article or not (for canceling and
27808 superseding). Gnus generates a random password string the first time
27809 you post a message, and saves it in your @file{~/.emacs} using the Custom
27810 system. While the variable is called @code{canlock-password}, it is not
27811 security sensitive data. Publishing your canlock string on the web
27812 will not allow anyone to be able to anything she could not already do.
27813 The behavior can be changed by customizing @code{message-insert-canlock}.
27816 Gnus supports @acronym{PGP} (RFC 1991/2440), @acronym{PGP/MIME} (RFC
27817 2015/3156) and @acronym{S/MIME} (RFC 2630-2633).
27819 It needs an external @acronym{S/MIME} and OpenPGP implementation, but no
27820 additional Lisp libraries. This add several menu items to the
27821 Attachments menu, and @kbd{C-c RET} key bindings, when composing
27822 messages. This also obsoletes @code{gnus-article-hide-pgp-hook}.
27825 @acronym{MML} (Mime compose) prefix changed from @kbd{M-m} to @kbd{C-c
27828 This change was made to avoid conflict with the standard binding of
27829 @code{back-to-indentation}, which is also useful in message mode.
27832 The default for @code{message-forward-show-mml} changed to the symbol
27835 The behavior for the @code{best} value is to show @acronym{MML} (i.e.,
27836 convert to @acronym{MIME}) when appropriate. @acronym{MML} will not be
27837 used when forwarding signed or encrypted messages, as the conversion
27838 invalidate the digital signature.
27841 If @code{auto-compression-mode} is enabled, attachments are automatically
27842 decompressed when activated.
27843 @c FIXME: Does this affect article or message mode?
27846 Support for non-@acronym{ASCII} domain names
27848 Message supports non-@acronym{ASCII} domain names in From:, To: and
27849 Cc: and will query you whether to perform encoding when you try to
27850 send a message. The variable @code{message-use-idna} controls this.
27851 Gnus will also decode non-@acronym{ASCII} domain names in From:, To:
27852 and Cc: when you view a message. The variable @code{gnus-use-idna}
27855 @item You can now drag and drop attachments to the Message buffer.
27856 See @code{mml-dnd-protocol-alist} and @code{mml-dnd-attach-options}.
27857 @xref{MIME, ,MIME, message, Message Manual}.
27858 @c New in 5.10.9 / 5.11
27862 @item Changes in back ends
27863 @c ***********************
27867 Gnus can display RSS newsfeeds as a newsgroup. @xref{RSS}.
27870 The nndoc back end now supports mailman digests and exim bounces.
27873 Gnus supports Maildir groups.
27875 Gnus includes a new back end @file{nnmaildir.el}. @xref{Maildir}.
27878 The nnml and nnfolder back ends store marks for each groups.
27880 This makes it possible to take backup of nnml/nnfolder servers/groups
27881 separately of @file{~/.newsrc.eld}, while preserving marks. It also
27882 makes it possible to share articles and marks between users (without
27883 sharing the @file{~/.newsrc.eld} file) within e.g. a department. It
27884 works by storing the marks stored in @file{~/.newsrc.eld} in a per-group
27885 file @file{.marks} (for nnml) and @file{@var{groupname}.mrk} (for
27886 nnfolder, named @var{groupname}). If the nnml/nnfolder is moved to
27887 another machine, Gnus will automatically use the @file{.marks} or
27888 @file{.mrk} file instead of the information in @file{~/.newsrc.eld}.
27889 The new server variables @code{nnml-marks-is-evil} and
27890 @code{nnfolder-marks-is-evil} can be used to disable this feature.
27900 The menu bar item (in Group and Summary buffer) named ``Misc'' has
27901 been renamed to ``Gnus''.
27904 The menu bar item (in Message mode) named ``@acronym{MML}'' has been
27905 renamed to ``Attachments''. Note that this menu also contains security
27906 related stuff, like signing and encryption (@pxref{Security, Security,,
27907 message, Message Manual}).
27910 The tool bars have been updated to use GNOME icons in Group, Summary and
27911 Message mode. You can also customize the tool bars. This is a new
27912 feature in Gnus 5.10.9. (Only for Emacs, not in XEmacs.)
27914 @item The tool bar icons are now (de)activated correctly
27915 in the group buffer, see the variable @code{gnus-group-update-tool-bar}.
27916 Its default value depends on your Emacs version. This is a new feature
27921 @item Miscellaneous changes
27922 @c ************************
27929 The Gnus Agent has seen a major updated and is now enabled by default,
27930 and all nntp and nnimap servers from @code{gnus-select-method} and
27931 @code{gnus-secondary-select-method} are agentized by default. Earlier
27932 only the server in @code{gnus-select-method} was agentized by the
27933 default, and the agent was disabled by default. When the agent is
27934 enabled, headers are now also retrieved from the Agent cache instead
27935 of the back ends when possible. Earlier this only happened in the
27936 unplugged state. You can enroll or remove servers with @kbd{J a} and
27937 @kbd{J r} in the server buffer. Gnus will not download articles into
27938 the Agent cache, unless you instruct it to do so, though, by using
27939 @kbd{J u} or @kbd{J s} from the Group buffer. You revert to the old
27940 behavior of having the Agent disabled with @code{(setq gnus-agent
27941 nil)}. Note that putting @code{(gnus-agentize)} in @file{~/.gnus.el}
27942 is not needed any more.
27945 Gnus reads the @acronym{NOV} and articles in the Agent if plugged.
27947 If one reads an article while plugged, and the article already exists
27948 in the Agent, it won't get downloaded once more. @code{(setq
27949 gnus-agent-cache nil)} reverts to the old behavior.
27954 @code{gnus-dired-minor-mode} (see @ref{Other modes}) installs key
27955 bindings in dired buffers to send a file as an attachment, open a file
27956 using the appropriate mailcap entry, and print a file using the mailcap
27960 The format spec @code{%C} for positioning point has changed to @code{%*}.
27963 @code{gnus-slave-unplugged}
27965 A new command which starts Gnus offline in slave mode.
27972 @subsubsection No Gnus
27975 New features in No Gnus:
27976 @c FIXME: Gnus 5.12?
27978 @include gnus-news.texi
27984 @section The Manual
27988 This manual was generated from a TeXinfo file and then run through
27989 either @code{texi2dvi}
27991 or my own home-brewed TeXinfo to \LaTeX\ transformer,
27992 and then run through @code{latex} and @code{dvips}
27994 to get what you hold in your hands now.
27996 The following conventions have been used:
28001 This is a @samp{string}
28004 This is a @kbd{keystroke}
28007 This is a @file{file}
28010 This is a @code{symbol}
28014 So if I were to say ``set @code{flargnoze} to @samp{yes}'', that would
28018 (setq flargnoze "yes")
28021 If I say ``set @code{flumphel} to @code{yes}'', that would mean:
28024 (setq flumphel 'yes)
28027 @samp{yes} and @code{yes} are two @emph{very} different things---don't
28028 ever get them confused.
28032 Of course, everything in this manual is of vital interest, so you should
28033 read it all. Several times. However, if you feel like skimming the
28034 manual, look for that gnu head you should see in the margin over
28035 there---it means that what's being discussed is of more importance than
28036 the rest of the stuff. (On the other hand, if everything is infinitely
28037 important, how can anything be more important than that? Just one more
28038 of the mysteries of this world, I guess.)
28044 @node On Writing Manuals
28045 @section On Writing Manuals
28047 I guess most manuals are written after-the-fact; documenting a program
28048 that's already there. This is not how this manual is written. When
28049 implementing something, I write the manual entry for that something
28050 straight away. I then see that it's difficult to explain the
28051 functionality, so I write how it's supposed to be, and then I change the
28052 implementation. Writing the documentation and writing the code go hand
28055 This, of course, means that this manual has no, or little, flow. It
28056 documents absolutely everything in Gnus, but often not where you're
28057 looking for it. It is a reference manual, and not a guide to how to get
28060 That would be a totally different book, that should be written using the
28061 reference manual as source material. It would look quite different.
28066 @section Terminology
28068 @cindex terminology
28073 This is what you are supposed to use this thing for---reading news.
28074 News is generally fetched from a nearby @acronym{NNTP} server, and is
28075 generally publicly available to everybody. If you post news, the entire
28076 world is likely to read just what you have written, and they'll all
28077 snigger mischievously. Behind your back.
28081 Everything that's delivered to you personally is mail. Some news/mail
28082 readers (like Gnus) blur the distinction between mail and news, but
28083 there is a difference. Mail is private. News is public. Mailing is
28084 not posting, and replying is not following up.
28088 Send a mail to the person who has written what you are reading.
28092 Post an article to the current newsgroup responding to the article you
28097 Gnus considers mail and news to be mostly the same, really. The only
28098 difference is how to access the actual articles. News articles are
28099 commonly fetched via the protocol @acronym{NNTP}, whereas mail
28100 messages could be read from a file on the local disk. The internal
28101 architecture of Gnus thus comprises a ``front end'' and a number of
28102 ``back ends''. Internally, when you enter a group (by hitting
28103 @key{RET}, say), you thereby invoke a function in the front end in
28104 Gnus. The front end then ``talks'' to a back end and says things like
28105 ``Give me the list of articles in the foo group'' or ``Show me article
28108 So a back end mainly defines either a protocol (the @code{nntp} back
28109 end accesses news via @acronym{NNTP}, the @code{nnimap} back end
28110 accesses mail via @acronym{IMAP}) or a file format and directory
28111 layout (the @code{nnspool} back end accesses news via the common
28112 ``spool directory'' format, the @code{nnml} back end access mail via a
28113 file format and directory layout that's quite similar).
28115 Gnus does not handle the underlying media, so to speak---this is all
28116 done by the back ends. A back end is a collection of functions to
28117 access the articles.
28119 However, sometimes the term ``back end'' is also used where ``server''
28120 would have been more appropriate. And then there is the term ``select
28121 method'' which can mean either. The Gnus terminology can be quite
28126 Gnus will always use one method (and back end) as the @dfn{native}, or
28127 default, way of getting news.
28131 You can also have any number of foreign groups active at the same time.
28132 These are groups that use non-native non-secondary back ends for getting
28137 Secondary back ends are somewhere half-way between being native and being
28138 foreign, but they mostly act like they are native.
28142 A message that has been posted as news.
28145 @cindex mail message
28146 A message that has been mailed.
28150 A mail message or news article
28154 The top part of a message, where administrative information (etc.) is
28159 The rest of an article. Everything not in the head is in the
28164 A line from the head of an article.
28168 A collection of such lines, or a collection of heads. Or even a
28169 collection of @acronym{NOV} lines.
28171 @item @acronym{NOV}
28172 @cindex @acronym{NOV}
28173 @acronym{NOV} stands for News OverView, which is a type of news server
28174 header which provide datas containing the condensed header information
28175 of articles. They are produced by the server itself; in the @code{nntp}
28176 back end Gnus uses the ones that the @acronym{NNTP} server makes, but
28177 Gnus makes them by itself for some backends (in particular, @code{nnml}).
28179 When Gnus enters a group, it asks the back end for the headers of all
28180 unread articles in the group. Most servers support the News OverView
28181 format, which is more compact and much faster to read and parse than the
28182 normal @sc{head} format.
28184 The @acronym{NOV} data consist of one or more text lines (@pxref{Text
28185 Lines, ,Motion by Text Lines, elisp, The Emacs Lisp Reference Manual})
28186 where each line has the header information of one article. The header
28187 information is a tab-separated series of the header's contents including
28188 an article number, a subject, an author, a date, a message-id,
28191 Those data enable Gnus to generate summary lines quickly. However, if
28192 the server does not support @acronym{NOV} or you disable it purposely or
28193 for some reason, Gnus will try to generate the header information by
28194 parsing each article's headers one by one. It will take time.
28195 Therefore, it is not usually a good idea to set nn*-nov-is-evil
28196 (@pxref{Slow/Expensive Connection}) to a non-@code{nil} value unless you
28197 know that the server makes wrong @acronym{NOV} data.
28201 Each group is subscribed at some @dfn{level} or other (1-9). The ones
28202 that have a lower level are ``more'' subscribed than the groups with a
28203 higher level. In fact, groups on levels 1-5 are considered
28204 @dfn{subscribed}; 6-7 are @dfn{unsubscribed}; 8 are @dfn{zombies}; and 9
28205 are @dfn{killed}. Commands for listing groups and scanning for new
28206 articles will all use the numeric prefix as @dfn{working level}.
28208 @item killed groups
28209 @cindex killed groups
28210 No information on killed groups is stored or updated, which makes killed
28211 groups much easier to handle than subscribed groups.
28213 @item zombie groups
28214 @cindex zombie groups
28215 Just like killed groups, only slightly less dead.
28218 @cindex active file
28219 The news server has to keep track of what articles it carries, and what
28220 groups exist. All this information in stored in the active file, which
28221 is rather large, as you might surmise.
28224 @cindex bogus groups
28225 A group that exists in the @file{.newsrc} file, but isn't known to the
28226 server (i.e., it isn't in the active file), is a @emph{bogus group}.
28227 This means that the group probably doesn't exist (any more).
28230 @cindex activating groups
28231 The act of asking the server for info on a group and computing the
28232 number of unread articles is called @dfn{activating the group}.
28233 Un-activated groups are listed with @samp{*} in the group buffer.
28237 News servers store their articles locally in one fashion or other.
28238 One old-fashioned storage method is to have just one file per
28239 article. That's called a ``traditional spool''.
28243 A machine one can connect to and get news (or mail) from.
28245 @item select method
28246 @cindex select method
28247 A structure that specifies the back end, the server and the virtual
28250 @item virtual server
28251 @cindex virtual server
28252 A named select method. Since a select method defines all there is to
28253 know about connecting to a (physical) server, taking the thing as a
28254 whole is a virtual server.
28258 Taking a buffer and running it through a filter of some sort. The
28259 result will (more often than not) be cleaner and more pleasing than the
28262 @item ephemeral groups
28263 @cindex ephemeral groups
28264 @cindex temporary groups
28265 Most groups store data on what articles you have read. @dfn{Ephemeral}
28266 groups are groups that will have no data stored---when you exit the
28267 group, it'll disappear into the aether.
28270 @cindex solid groups
28271 This is the opposite of ephemeral groups. All groups listed in the
28272 group buffer are solid groups.
28274 @item sparse articles
28275 @cindex sparse articles
28276 These are article placeholders shown in the summary buffer when
28277 @code{gnus-build-sparse-threads} has been switched on.
28281 To put responses to articles directly after the articles they respond
28282 to---in a hierarchical fashion.
28286 @cindex thread root
28287 The first article in a thread is the root. It is the ancestor of all
28288 articles in the thread.
28292 An article that has responses.
28296 An article that responds to a different article---its parent.
28300 A collection of messages in one file. The most common digest format is
28301 specified by RFC 1153.
28304 @cindex splitting, terminology
28305 @cindex mail sorting
28306 @cindex mail filtering (splitting)
28307 The action of sorting your emails according to certain rules. Sometimes
28308 incorrectly called mail filtering.
28314 @node Customization
28315 @section Customization
28316 @cindex general customization
28318 All variables are properly documented elsewhere in this manual. This
28319 section is designed to give general pointers on how to customize Gnus
28320 for some quite common situations.
28323 * Slow/Expensive Connection:: You run a local Emacs and get the news elsewhere.
28324 * Slow Terminal Connection:: You run a remote Emacs.
28325 * Little Disk Space:: You feel that having large setup files is icky.
28326 * Slow Machine:: You feel like buying a faster machine.
28330 @node Slow/Expensive Connection
28331 @subsection Slow/Expensive Connection
28333 If you run Emacs on a machine locally, and get your news from a machine
28334 over some very thin strings, you want to cut down on the amount of data
28335 Gnus has to get from the server.
28339 @item gnus-read-active-file
28340 Set this to @code{nil}, which will inhibit Gnus from requesting the
28341 entire active file from the server. This file is often very large. You
28342 also have to set @code{gnus-check-new-newsgroups} and
28343 @code{gnus-check-bogus-newsgroups} to @code{nil} to make sure that Gnus
28344 doesn't suddenly decide to fetch the active file anyway.
28346 @item gnus-nov-is-evil
28347 @vindex gnus-nov-is-evil
28348 Usually this one must @emph{always} be @code{nil} (which is the
28349 default). If, for example, you wish to not use @acronym{NOV}
28350 (@pxref{Terminology}) with the @code{nntp} back end (@pxref{Crosspost
28351 Handling}), set @code{nntp-nov-is-evil} to a non-@code{nil} value
28352 instead of setting this. But you normally do not need to set
28353 @code{nntp-nov-is-evil} since Gnus by itself will detect whether the
28354 @acronym{NNTP} server supports @acronym{NOV}. Anyway, grabbing article
28355 headers from the @acronym{NNTP} server will not be very fast if you tell
28356 Gnus not to use @acronym{NOV}.
28358 As the variables for the other back ends, there are
28359 @code{nndiary-nov-is-evil}, @code{nndir-nov-is-evil},
28360 @code{nnfolder-nov-is-evil}, @code{nnimap-nov-is-evil},
28361 @code{nnml-nov-is-evil}, @code{nnspool-nov-is-evil}, and
28362 @code{nnwarchive-nov-is-evil}. Note that a non-@code{nil} value for
28363 @code{gnus-nov-is-evil} overrides all those variables.@footnote{Although
28364 the back ends @code{nnkiboze}, @code{nnslashdot}, @code{nnultimate}, and
28365 @code{nnwfm} don't have their own nn*-nov-is-evil.}
28369 @node Slow Terminal Connection
28370 @subsection Slow Terminal Connection
28372 Let's say you use your home computer for dialing up the system that runs
28373 Emacs and Gnus. If your modem is slow, you want to reduce (as much as
28374 possible) the amount of data sent over the wires.
28378 @item gnus-auto-center-summary
28379 Set this to @code{nil} to inhibit Gnus from re-centering the summary
28380 buffer all the time. If it is @code{vertical}, do only vertical
28381 re-centering. If it is neither @code{nil} nor @code{vertical}, do both
28382 horizontal and vertical recentering.
28384 @item gnus-visible-headers
28385 Cut down on the headers included in the articles to the
28386 minimum. You can, in fact, make do without them altogether---most of the
28387 useful data is in the summary buffer, anyway. Set this variable to
28388 @samp{^NEVVVVER} or @samp{From:}, or whatever you feel you need.
28390 Use the following to enable all the available hiding features:
28392 (setq gnus-treat-hide-headers 'head
28393 gnus-treat-hide-signature t
28394 gnus-treat-hide-citation t)
28397 @item gnus-use-full-window
28398 By setting this to @code{nil}, you can make all the windows smaller.
28399 While this doesn't really cut down much generally, it means that you
28400 have to see smaller portions of articles before deciding that you didn't
28401 want to read them anyway.
28403 @item gnus-thread-hide-subtree
28404 If this is non-@code{nil}, all threads in the summary buffer will be
28408 @item gnus-updated-mode-lines
28409 If this is @code{nil}, Gnus will not put information in the buffer mode
28410 lines, which might save some time.
28414 @node Little Disk Space
28415 @subsection Little Disk Space
28418 The startup files can get rather large, so you may want to cut their
28419 sizes a bit if you are running out of space.
28423 @item gnus-save-newsrc-file
28424 If this is @code{nil}, Gnus will never save @file{.newsrc}---it will
28425 only save @file{.newsrc.eld}. This means that you will not be able to
28426 use any other newsreaders than Gnus. This variable is @code{t} by
28429 @item gnus-read-newsrc-file
28430 If this is @code{nil}, Gnus will never read @file{.newsrc}---it will
28431 only read @file{.newsrc.eld}. This means that you will not be able to
28432 use any other newsreaders than Gnus. This variable is @code{t} by
28435 @item gnus-save-killed-list
28436 If this is @code{nil}, Gnus will not save the list of dead groups. You
28437 should also set @code{gnus-check-new-newsgroups} to @code{ask-server}
28438 and @code{gnus-check-bogus-newsgroups} to @code{nil} if you set this
28439 variable to @code{nil}. This variable is @code{t} by default.
28445 @subsection Slow Machine
28446 @cindex slow machine
28448 If you have a slow machine, or are just really impatient, there are a
28449 few things you can do to make Gnus run faster.
28451 Set @code{gnus-check-new-newsgroups} and
28452 @code{gnus-check-bogus-newsgroups} to @code{nil} to make startup faster.
28454 Set @code{gnus-show-threads}, @code{gnus-use-cross-reference} and
28455 @code{gnus-nov-is-evil} to @code{nil} to make entering and exiting the
28456 summary buffer faster. Also @pxref{Slow/Expensive Connection}.
28460 @node Troubleshooting
28461 @section Troubleshooting
28462 @cindex troubleshooting
28464 Gnus works @emph{so} well straight out of the box---I can't imagine any
28472 Make sure your computer is switched on.
28475 Make sure that you really load the current Gnus version. If you have
28476 been running @sc{gnus}, you need to exit Emacs and start it up again before
28480 Try doing an @kbd{M-x gnus-version}. If you get something that looks
28482 @samp{No Gnus v0.7} @c Adjust ../Makefile.in if you change this line!
28484 you have the right files loaded. Otherwise you have some old @file{.el}
28485 files lying around. Delete these.
28488 Read the help group (@kbd{G h} in the group buffer) for a
28489 @acronym{FAQ} and a how-to.
28492 @vindex max-lisp-eval-depth
28493 Gnus works on many recursive structures, and in some extreme (and very
28494 rare) cases Gnus may recurse down ``too deeply'' and Emacs will beep at
28495 you. If this happens to you, set @code{max-lisp-eval-depth} to 500 or
28496 something like that.
28499 If all else fails, report the problem as a bug.
28502 @cindex reporting bugs
28504 @kindex M-x gnus-bug
28506 If you find a bug in Gnus, you can report it with the @kbd{M-x gnus-bug}
28507 command. @kbd{M-x set-variable RET debug-on-error RET t RET}, and send
28508 me the backtrace. I will fix bugs, but I can only fix them if you send
28509 me a precise description as to how to reproduce the bug.
28511 You really can never be too detailed in a bug report. Always use the
28512 @kbd{M-x gnus-bug} command when you make bug reports, even if it creates
28513 a 10Kb mail each time you use it, and even if you have sent me your
28514 environment 500 times before. I don't care. I want the full info each
28517 It is also important to remember that I have no memory whatsoever. If
28518 you send a bug report, and I send you a reply, and then you just send
28519 back ``No, it's not! Moron!'', I will have no idea what you are
28520 insulting me about. Always over-explain everything. It's much easier
28521 for all of us---if I don't have all the information I need, I will just
28522 mail you and ask for more info, and everything takes more time.
28524 If the problem you're seeing is very visual, and you can't quite explain
28525 it, copy the Emacs window to a file (with @code{xwd}, for instance), put
28526 it somewhere it can be reached, and include the URL of the picture in
28530 If you would like to contribute a patch to fix bugs or make
28531 improvements, please produce the patch using @samp{diff -u}.
28534 If you want to debug your problem further before reporting, possibly
28535 in order to solve the problem yourself and send a patch, you can use
28536 edebug. Debugging Lisp code is documented in the Elisp manual
28537 (@pxref{Debugging, , Debugging Lisp Programs, elisp, The GNU Emacs
28538 Lisp Reference Manual}). To get you started with edebug, consider if
28539 you discover some weird behavior when pressing @kbd{c}, the first
28540 step is to do @kbd{C-h k c} and click on the hyperlink (Emacs only) in
28541 the documentation buffer that leads you to the function definition,
28542 then press @kbd{M-x edebug-defun RET} with point inside that function,
28543 return to Gnus and press @kbd{c} to invoke the code. You will be
28544 placed in the lisp buffer and can single step using @kbd{SPC} and
28545 evaluate expressions using @kbd{M-:} or inspect variables using
28546 @kbd{C-h v}, abort execution with @kbd{q}, and resume execution with
28547 @kbd{c} or @kbd{g}.
28552 Sometimes, a problem do not directly generate an elisp error but
28553 manifests itself by causing Gnus to be very slow. In these cases, you
28554 can use @kbd{M-x toggle-debug-on-quit} and press @kbd{C-g} when things are
28555 slow, and then try to analyze the backtrace (repeating the procedure
28556 helps isolating the real problem areas).
28558 A fancier approach is to use the elisp profiler, ELP. The profiler is
28559 (or should be) fully documented elsewhere, but to get you started
28560 there are a few steps that need to be followed. First, instrument the
28561 part of Gnus you are interested in for profiling, e.g. @kbd{M-x
28562 elp-instrument-package RET gnus} or @kbd{M-x elp-instrument-package
28563 RET message}. Then perform the operation that is slow and press
28564 @kbd{M-x elp-results}. You will then see which operations that takes
28565 time, and can debug them further. If the entire operation takes much
28566 longer than the time spent in the slowest function in the profiler
28567 output, you probably profiled the wrong part of Gnus. To reset
28568 profiling statistics, use @kbd{M-x elp-reset-all}. @kbd{M-x
28569 elp-restore-all} is supposed to remove profiling, but given the
28570 complexities and dynamic code generation in Gnus, it might not always
28573 @cindex gnu.emacs.gnus
28574 @cindex ding mailing list
28575 If you just need help, you are better off asking on
28576 @samp{gnu.emacs.gnus}. I'm not very helpful. You can also ask on
28577 @email{ding@@gnus.org, the ding mailing list}. Write to
28578 @email{ding-request@@gnus.org} to subscribe.
28582 @node Gnus Reference Guide
28583 @section Gnus Reference Guide
28585 It is my hope that other people will figure out smart stuff that Gnus
28586 can do, and that other people will write those smart things as well. To
28587 facilitate that I thought it would be a good idea to describe the inner
28588 workings of Gnus. And some of the not-so-inner workings, while I'm at
28591 You can never expect the internals of a program not to change, but I
28592 will be defining (in some details) the interface between Gnus and its
28593 back ends (this is written in stone), the format of the score files
28594 (ditto), data structures (some are less likely to change than others)
28595 and general methods of operation.
28598 * Gnus Utility Functions:: Common functions and variable to use.
28599 * Back End Interface:: How Gnus communicates with the servers.
28600 * Score File Syntax:: A BNF definition of the score file standard.
28601 * Headers:: How Gnus stores headers internally.
28602 * Ranges:: A handy format for storing mucho numbers.
28603 * Group Info:: The group info format.
28604 * Extended Interactive:: Symbolic prefixes and stuff.
28605 * Emacs/XEmacs Code:: Gnus can be run under all modern Emacsen.
28606 * Various File Formats:: Formats of files that Gnus use.
28610 @node Gnus Utility Functions
28611 @subsection Gnus Utility Functions
28612 @cindex Gnus utility functions
28613 @cindex utility functions
28615 @cindex internal variables
28617 When writing small functions to be run from hooks (and stuff), it's
28618 vital to have access to the Gnus internal functions and variables.
28619 Below is a list of the most common ones.
28623 @item gnus-newsgroup-name
28624 @vindex gnus-newsgroup-name
28625 This variable holds the name of the current newsgroup.
28627 @item gnus-find-method-for-group
28628 @findex gnus-find-method-for-group
28629 A function that returns the select method for @var{group}.
28631 @item gnus-group-real-name
28632 @findex gnus-group-real-name
28633 Takes a full (prefixed) Gnus group name, and returns the unprefixed
28636 @item gnus-group-prefixed-name
28637 @findex gnus-group-prefixed-name
28638 Takes an unprefixed group name and a select method, and returns the full
28639 (prefixed) Gnus group name.
28641 @item gnus-get-info
28642 @findex gnus-get-info
28643 Returns the group info list for @var{group}.
28645 @item gnus-group-unread
28646 @findex gnus-group-unread
28647 The number of unread articles in @var{group}, or @code{t} if that is
28651 @findex gnus-active
28652 The active entry for @var{group}.
28654 @item gnus-set-active
28655 @findex gnus-set-active
28656 Set the active entry for @var{group}.
28658 @item gnus-add-current-to-buffer-list
28659 @findex gnus-add-current-to-buffer-list
28660 Adds the current buffer to the list of buffers to be killed on Gnus
28663 @item gnus-continuum-version
28664 @findex gnus-continuum-version
28665 Takes a Gnus version string as a parameter and returns a floating point
28666 number. Earlier versions will always get a lower number than later
28669 @item gnus-group-read-only-p
28670 @findex gnus-group-read-only-p
28671 Says whether @var{group} is read-only or not.
28673 @item gnus-news-group-p
28674 @findex gnus-news-group-p
28675 Says whether @var{group} came from a news back end.
28677 @item gnus-ephemeral-group-p
28678 @findex gnus-ephemeral-group-p
28679 Says whether @var{group} is ephemeral or not.
28681 @item gnus-server-to-method
28682 @findex gnus-server-to-method
28683 Returns the select method corresponding to @var{server}.
28685 @item gnus-server-equal
28686 @findex gnus-server-equal
28687 Says whether two virtual servers are equal.
28689 @item gnus-group-native-p
28690 @findex gnus-group-native-p
28691 Says whether @var{group} is native or not.
28693 @item gnus-group-secondary-p
28694 @findex gnus-group-secondary-p
28695 Says whether @var{group} is secondary or not.
28697 @item gnus-group-foreign-p
28698 @findex gnus-group-foreign-p
28699 Says whether @var{group} is foreign or not.
28701 @item gnus-group-find-parameter
28702 @findex gnus-group-find-parameter
28703 Returns the parameter list of @var{group}. If given a second parameter,
28704 returns the value of that parameter for @var{group}.
28706 @item gnus-group-set-parameter
28707 @findex gnus-group-set-parameter
28708 Takes three parameters; @var{group}, @var{parameter} and @var{value}.
28710 @item gnus-narrow-to-body
28711 @findex gnus-narrow-to-body
28712 Narrows the current buffer to the body of the article.
28714 @item gnus-check-backend-function
28715 @findex gnus-check-backend-function
28716 Takes two parameters, @var{function} and @var{group}. If the back end
28717 @var{group} comes from supports @var{function}, return non-@code{nil}.
28720 (gnus-check-backend-function "request-scan" "nnml:misc")
28724 @item gnus-read-method
28725 @findex gnus-read-method
28726 Prompts the user for a select method.
28731 @node Back End Interface
28732 @subsection Back End Interface
28734 Gnus doesn't know anything about @acronym{NNTP}, spools, mail or virtual
28735 groups. It only knows how to talk to @dfn{virtual servers}. A virtual
28736 server is a @dfn{back end} and some @dfn{back end variables}. As examples
28737 of the first, we have @code{nntp}, @code{nnspool} and @code{nnmbox}. As
28738 examples of the latter we have @code{nntp-port-number} and
28739 @code{nnmbox-directory}.
28741 When Gnus asks for information from a back end---say @code{nntp}---on
28742 something, it will normally include a virtual server name in the
28743 function parameters. (If not, the back end should use the ``current''
28744 virtual server.) For instance, @code{nntp-request-list} takes a virtual
28745 server as its only (optional) parameter. If this virtual server hasn't
28746 been opened, the function should fail.
28748 Note that a virtual server name has no relation to some physical server
28749 name. Take this example:
28753 (nntp-address "ifi.uio.no")
28754 (nntp-port-number 4324))
28757 Here the virtual server name is @samp{odd-one} while the name of
28758 the physical server is @samp{ifi.uio.no}.
28760 The back ends should be able to switch between several virtual servers.
28761 The standard back ends implement this by keeping an alist of virtual
28762 server environments that they pull down/push up when needed.
28764 There are two groups of interface functions: @dfn{required functions},
28765 which must be present, and @dfn{optional functions}, which Gnus will
28766 always check for presence before attempting to call 'em.
28768 All these functions are expected to return data in the buffer
28769 @code{nntp-server-buffer} (@samp{ *nntpd*}), which is somewhat
28770 unfortunately named, but we'll have to live with it. When I talk about
28771 @dfn{resulting data}, I always refer to the data in that buffer. When I
28772 talk about @dfn{return value}, I talk about the function value returned by
28773 the function call. Functions that fail should return @code{nil} as the
28776 Some back ends could be said to be @dfn{server-forming} back ends, and
28777 some might be said not to be. The latter are back ends that generally
28778 only operate on one group at a time, and have no concept of ``server''
28779 ---they have a group, and they deliver info on that group and nothing
28782 Gnus identifies each message by way of group name and article number. A
28783 few remarks about these article numbers might be useful. First of all,
28784 the numbers are positive integers. Secondly, it is normally not
28785 possible for later articles to ``re-use'' older article numbers without
28786 confusing Gnus. That is, if a group has ever contained a message
28787 numbered 42, then no other message may get that number, or Gnus will get
28788 mightily confused.@footnote{See the function
28789 @code{nnchoke-request-update-info}, @ref{Optional Back End Functions}.}
28790 Third, article numbers must be assigned in order of arrival in the
28791 group; this is not necessarily the same as the date of the message.
28793 The previous paragraph already mentions all the ``hard'' restrictions that
28794 article numbers must fulfill. But it seems that it might be useful to
28795 assign @emph{consecutive} article numbers, for Gnus gets quite confused
28796 if there are holes in the article numbering sequence. However, due to
28797 the ``no-reuse'' restriction, holes cannot be avoided altogether. It's
28798 also useful for the article numbers to start at 1 to avoid running out
28799 of numbers as long as possible.
28801 Note that by convention, back ends are named @code{nnsomething}, but
28802 Gnus also comes with some @code{nnnotbackends}, such as
28803 @file{nnheader.el}, @file{nnmail.el} and @file{nnoo.el}.
28805 In the examples and definitions I will refer to the imaginary back end
28808 @cindex @code{nnchoke}
28811 * Required Back End Functions:: Functions that must be implemented.
28812 * Optional Back End Functions:: Functions that need not be implemented.
28813 * Error Messaging:: How to get messages and report errors.
28814 * Writing New Back Ends:: Extending old back ends.
28815 * Hooking New Back Ends Into Gnus:: What has to be done on the Gnus end.
28816 * Mail-like Back Ends:: Some tips on mail back ends.
28820 @node Required Back End Functions
28821 @subsubsection Required Back End Functions
28825 @item (nnchoke-retrieve-headers ARTICLES &optional GROUP SERVER FETCH-OLD)
28827 @var{articles} is either a range of article numbers or a list of
28828 @code{Message-ID}s. Current back ends do not fully support either---only
28829 sequences (lists) of article numbers, and most back ends do not support
28830 retrieval of @code{Message-ID}s. But they should try for both.
28832 The result data should either be HEADs or @acronym{NOV} lines, and the result
28833 value should either be @code{headers} or @code{nov} to reflect this.
28834 This might later be expanded to @code{various}, which will be a mixture
28835 of HEADs and @acronym{NOV} lines, but this is currently not supported by Gnus.
28837 If @var{fetch-old} is non-@code{nil} it says to try fetching ``extra
28838 headers'', in some meaning of the word. This is generally done by
28839 fetching (at most) @var{fetch-old} extra headers less than the smallest
28840 article number in @code{articles}, and filling the gaps as well. The
28841 presence of this parameter can be ignored if the back end finds it
28842 cumbersome to follow the request. If this is non-@code{nil} and not a
28843 number, do maximum fetches.
28845 Here's an example HEAD:
28848 221 1056 Article retrieved.
28849 Path: ifi.uio.no!sturles
28850 From: sturles@@ifi.uio.no (Sturle Sunde)
28851 Newsgroups: ifi.discussion
28852 Subject: Re: Something very droll
28853 Date: 27 Oct 1994 14:02:57 +0100
28854 Organization: Dept. of Informatics, University of Oslo, Norway
28856 Message-ID: <38o8e1$a0o@@holmenkollen.ifi.uio.no>
28857 References: <38jdmq$4qu@@visbur.ifi.uio.no>
28858 NNTP-Posting-Host: holmenkollen.ifi.uio.no
28862 So a @code{headers} return value would imply that there's a number of
28863 these in the data buffer.
28865 Here's a BNF definition of such a buffer:
28869 head = error / valid-head
28870 error-message = [ "4" / "5" ] 2number " " <error message> eol
28871 valid-head = valid-message *header "." eol
28872 valid-message = "221 " <number> " Article retrieved." eol
28873 header = <text> eol
28877 (The version of BNF used here is the one used in RFC822.)
28879 If the return value is @code{nov}, the data buffer should contain
28880 @dfn{network overview database} lines. These are basically fields
28884 nov-buffer = *nov-line
28885 nov-line = field 7*8[ <TAB> field ] eol
28886 field = <text except TAB>
28889 For a closer look at what should be in those fields,
28893 @item (nnchoke-open-server SERVER &optional DEFINITIONS)
28895 @var{server} is here the virtual server name. @var{definitions} is a
28896 list of @code{(VARIABLE VALUE)} pairs that define this virtual server.
28898 If the server can't be opened, no error should be signaled. The back end
28899 may then choose to refuse further attempts at connecting to this
28900 server. In fact, it should do so.
28902 If the server is opened already, this function should return a
28903 non-@code{nil} value. There should be no data returned.
28906 @item (nnchoke-close-server &optional SERVER)
28908 Close connection to @var{server} and free all resources connected
28909 to it. Return @code{nil} if the server couldn't be closed for some
28912 There should be no data returned.
28915 @item (nnchoke-request-close)
28917 Close connection to all servers and free all resources that the back end
28918 have reserved. All buffers that have been created by that back end
28919 should be killed. (Not the @code{nntp-server-buffer}, though.) This
28920 function is generally only called when Gnus is shutting down.
28922 There should be no data returned.
28925 @item (nnchoke-server-opened &optional SERVER)
28927 If @var{server} is the current virtual server, and the connection to the
28928 physical server is alive, then this function should return a
28929 non-@code{nil} value. This function should under no circumstances
28930 attempt to reconnect to a server we have lost connection to.
28932 There should be no data returned.
28935 @item (nnchoke-status-message &optional SERVER)
28937 This function should return the last error message from @var{server}.
28939 There should be no data returned.
28942 @item (nnchoke-request-article ARTICLE &optional GROUP SERVER TO-BUFFER)
28944 The result data from this function should be the article specified by
28945 @var{article}. This might either be a @code{Message-ID} or a number.
28946 It is optional whether to implement retrieval by @code{Message-ID}, but
28947 it would be nice if that were possible.
28949 If @var{to-buffer} is non-@code{nil}, the result data should be returned
28950 in this buffer instead of the normal data buffer. This is to make it
28951 possible to avoid copying large amounts of data from one buffer to
28952 another, while Gnus mainly requests articles to be inserted directly
28953 into its article buffer.
28955 If it is at all possible, this function should return a cons cell where
28956 the @code{car} is the group name the article was fetched from, and the @code{cdr} is
28957 the article number. This will enable Gnus to find out what the real
28958 group and article numbers are when fetching articles by
28959 @code{Message-ID}. If this isn't possible, @code{t} should be returned
28960 on successful article retrieval.
28963 @item (nnchoke-request-group GROUP &optional SERVER FAST)
28965 Get data on @var{group}. This function also has the side effect of
28966 making @var{group} the current group.
28968 If @var{fast}, don't bother to return useful data, just make @var{group}
28971 Here's an example of some result data and a definition of the same:
28974 211 56 1000 1059 ifi.discussion
28977 The first number is the status, which should be 211. Next is the
28978 total number of articles in the group, the lowest article number, the
28979 highest article number, and finally the group name. Note that the total
28980 number of articles may be less than one might think while just
28981 considering the highest and lowest article numbers, but some articles
28982 may have been canceled. Gnus just discards the total-number, so
28983 whether one should take the bother to generate it properly (if that is a
28984 problem) is left as an exercise to the reader. If the group contains no
28985 articles, the lowest article number should be reported as 1 and the
28989 group-status = [ error / info ] eol
28990 error = [ "4" / "5" ] 2<number> " " <Error message>
28991 info = "211 " 3* [ <number> " " ] <string>
28995 @item (nnchoke-close-group GROUP &optional SERVER)
28997 Close @var{group} and free any resources connected to it. This will be
28998 a no-op on most back ends.
29000 There should be no data returned.
29003 @item (nnchoke-request-list &optional SERVER)
29005 Return a list of all groups available on @var{server}. And that means
29008 Here's an example from a server that only carries two groups:
29011 ifi.test 0000002200 0000002000 y
29012 ifi.discussion 3324 3300 n
29015 On each line we have a group name, then the highest article number in
29016 that group, the lowest article number, and finally a flag. If the group
29017 contains no articles, the lowest article number should be reported as 1
29018 and the highest as 0.
29021 active-file = *active-line
29022 active-line = name " " <number> " " <number> " " flags eol
29024 flags = "n" / "y" / "m" / "x" / "j" / "=" name
29027 The flag says whether the group is read-only (@samp{n}), is moderated
29028 (@samp{m}), is dead (@samp{x}), is aliased to some other group
29029 (@samp{=other-group}) or none of the above (@samp{y}).
29032 @item (nnchoke-request-post &optional SERVER)
29034 This function should post the current buffer. It might return whether
29035 the posting was successful or not, but that's not required. If, for
29036 instance, the posting is done asynchronously, it has generally not been
29037 completed by the time this function concludes. In that case, this
29038 function should set up some kind of sentinel to beep the user loud and
29039 clear if the posting could not be completed.
29041 There should be no result data from this function.
29046 @node Optional Back End Functions
29047 @subsubsection Optional Back End Functions
29051 @item (nnchoke-retrieve-groups GROUPS &optional SERVER)
29053 @var{groups} is a list of groups, and this function should request data
29054 on all those groups. How it does it is of no concern to Gnus, but it
29055 should attempt to do this in a speedy fashion.
29057 The return value of this function can be either @code{active} or
29058 @code{group}, which says what the format of the result data is. The
29059 former is in the same format as the data from
29060 @code{nnchoke-request-list}, while the latter is a buffer full of lines
29061 in the same format as @code{nnchoke-request-group} gives.
29064 group-buffer = *active-line / *group-status
29068 @item (nnchoke-request-update-info GROUP INFO &optional SERVER)
29070 A Gnus group info (@pxref{Group Info}) is handed to the back end for
29071 alterations. This comes in handy if the back end really carries all
29072 the information (as is the case with virtual and imap groups). This
29073 function should destructively alter the info to suit its needs, and
29074 should return a non-@code{nil} value (exceptionally,
29075 @code{nntp-request-update-info} always returns @code{nil} not to waste
29076 the network resources).
29078 There should be no result data from this function.
29081 @item (nnchoke-request-type GROUP &optional ARTICLE)
29083 When the user issues commands for ``sending news'' (@kbd{F} in the
29084 summary buffer, for instance), Gnus has to know whether the article the
29085 user is following up on is news or mail. This function should return
29086 @code{news} if @var{article} in @var{group} is news, @code{mail} if it
29087 is mail and @code{unknown} if the type can't be decided. (The
29088 @var{article} parameter is necessary in @code{nnvirtual} groups which
29089 might very well combine mail groups and news groups.) Both @var{group}
29090 and @var{article} may be @code{nil}.
29092 There should be no result data from this function.
29095 @item (nnchoke-request-set-mark GROUP ACTION &optional SERVER)
29097 Set/remove/add marks on articles. Normally Gnus handles the article
29098 marks (such as read, ticked, expired etc) internally, and store them in
29099 @file{~/.newsrc.eld}. Some back ends (such as @acronym{IMAP}) however carry
29100 all information about the articles on the server, so Gnus need to
29101 propagate the mark information to the server.
29103 @var{action} is a list of mark setting requests, having this format:
29106 (RANGE ACTION MARK)
29109 @var{range} is a range of articles you wish to update marks on.
29110 @var{action} is @code{add} or @code{del}, used to add marks or remove
29111 marks (preserving all marks not mentioned). @var{mark} is a list of
29112 marks; where each mark is a symbol. Currently used marks are
29113 @code{read}, @code{tick}, @code{reply}, @code{expire}, @code{killed},
29114 @code{dormant}, @code{save}, @code{download}, @code{unsend},
29115 @code{forward} and @code{recent}, but your back end should, if
29116 possible, not limit itself to these.
29118 Given contradictory actions, the last action in the list should be the
29119 effective one. That is, if your action contains a request to add the
29120 @code{tick} mark on article 1 and, later in the list, a request to
29121 remove the mark on the same article, the mark should in fact be removed.
29123 An example action list:
29126 (((5 12 30) 'del '(tick))
29127 ((10 . 90) 'add '(read expire))
29128 ((92 94) 'del '(read)))
29131 The function should return a range of articles it wasn't able to set the
29132 mark on (currently not used for anything).
29134 There should be no result data from this function.
29136 @item (nnchoke-request-update-mark GROUP ARTICLE MARK)
29138 If the user tries to set a mark that the back end doesn't like, this
29139 function may change the mark. Gnus will use whatever this function
29140 returns as the mark for @var{article} instead of the original
29141 @var{mark}. If the back end doesn't care, it must return the original
29142 @var{mark}, and not @code{nil} or any other type of garbage.
29144 The only use for this I can see is what @code{nnvirtual} does with
29145 it---if a component group is auto-expirable, marking an article as read
29146 in the virtual group should result in the article being marked as
29149 There should be no result data from this function.
29152 @item (nnchoke-request-scan &optional GROUP SERVER)
29154 This function may be called at any time (by Gnus or anything else) to
29155 request that the back end check for incoming articles, in one way or
29156 another. A mail back end will typically read the spool file or query
29157 the @acronym{POP} server when this function is invoked. The
29158 @var{group} doesn't have to be heeded---if the back end decides that
29159 it is too much work just scanning for a single group, it may do a
29160 total scan of all groups. It would be nice, however, to keep things
29161 local if that's practical.
29163 There should be no result data from this function.
29166 @item (nnchoke-request-group-description GROUP &optional SERVER)
29168 The result data from this function should be a description of
29172 description-line = name <TAB> description eol
29174 description = <text>
29177 @item (nnchoke-request-list-newsgroups &optional SERVER)
29179 The result data from this function should be the description of all
29180 groups available on the server.
29183 description-buffer = *description-line
29187 @item (nnchoke-request-newgroups DATE &optional SERVER)
29189 The result data from this function should be all groups that were
29190 created after @samp{date}, which is in normal human-readable date format
29191 (i.e., the date format used in mail and news headers, and returned by
29192 the function @code{message-make-date} by default). The data should be
29193 in the active buffer format.
29195 It is okay for this function to return ``too many'' groups; some back ends
29196 might find it cheaper to return the full list of groups, rather than
29197 just the new groups. But don't do this for back ends with many groups.
29198 Normally, if the user creates the groups herself, there won't be too
29199 many groups, so @code{nnml} and the like are probably safe. But for
29200 back ends like @code{nntp}, where the groups have been created by the
29201 server, it is quite likely that there can be many groups.
29204 @item (nnchoke-request-create-group GROUP &optional SERVER)
29206 This function should create an empty group with name @var{group}.
29208 There should be no return data.
29211 @item (nnchoke-request-expire-articles ARTICLES &optional GROUP SERVER FORCE)
29213 This function should run the expiry process on all articles in the
29214 @var{articles} range (which is currently a simple list of article
29215 numbers.) It is left up to the back end to decide how old articles
29216 should be before they are removed by this function. If @var{force} is
29217 non-@code{nil}, all @var{articles} should be deleted, no matter how new
29220 This function should return a list of articles that it did not/was not
29223 There should be no result data returned.
29226 @item (nnchoke-request-move-article ARTICLE GROUP SERVER ACCEPT-FORM &optional LAST)
29228 This function should move @var{article} (which is a number) from
29229 @var{group} by calling @var{accept-form}.
29231 This function should ready the article in question for moving by
29232 removing any header lines it has added to the article, and generally
29233 should ``tidy up'' the article. Then it should @code{eval}
29234 @var{accept-form} in the buffer where the ``tidy'' article is. This
29235 will do the actual copying. If this @code{eval} returns a
29236 non-@code{nil} value, the article should be removed.
29238 If @var{last} is @code{nil}, that means that there is a high likelihood
29239 that there will be more requests issued shortly, so that allows some
29242 The function should return a cons where the @code{car} is the group name and
29243 the @code{cdr} is the article number that the article was entered as.
29245 There should be no data returned.
29248 @item (nnchoke-request-accept-article GROUP &optional SERVER LAST)
29250 This function takes the current buffer and inserts it into @var{group}.
29251 If @var{last} in @code{nil}, that means that there will be more calls to
29252 this function in short order.
29254 The function should return a cons where the @code{car} is the group name and
29255 the @code{cdr} is the article number that the article was entered as.
29257 The group should exist before the back end is asked to accept the
29258 article for that group.
29260 There should be no data returned.
29263 @item (nnchoke-request-replace-article ARTICLE GROUP BUFFER)
29265 This function should remove @var{article} (which is a number) from
29266 @var{group} and insert @var{buffer} there instead.
29268 There should be no data returned.
29271 @item (nnchoke-request-delete-group GROUP FORCE &optional SERVER)
29273 This function should delete @var{group}. If @var{force}, it should
29274 really delete all the articles in the group, and then delete the group
29275 itself. (If there is such a thing as ``the group itself''.)
29277 There should be no data returned.
29280 @item (nnchoke-request-rename-group GROUP NEW-NAME &optional SERVER)
29282 This function should rename @var{group} into @var{new-name}. All
29283 articles in @var{group} should move to @var{new-name}.
29285 There should be no data returned.
29290 @node Error Messaging
29291 @subsubsection Error Messaging
29293 @findex nnheader-report
29294 @findex nnheader-get-report
29295 The back ends should use the function @code{nnheader-report} to report
29296 error conditions---they should not raise errors when they aren't able to
29297 perform a request. The first argument to this function is the back end
29298 symbol, and the rest are interpreted as arguments to @code{format} if
29299 there are multiple of them, or just a string if there is one of them.
29300 This function must always returns @code{nil}.
29303 (nnheader-report 'nnchoke "You did something totally bogus")
29305 (nnheader-report 'nnchoke "Could not request group %s" group)
29308 Gnus, in turn, will call @code{nnheader-get-report} when it gets a
29309 @code{nil} back from a server, and this function returns the most
29310 recently reported message for the back end in question. This function
29311 takes one argument---the server symbol.
29313 Internally, these functions access @var{back-end}@code{-status-string},
29314 so the @code{nnchoke} back end will have its error message stored in
29315 @code{nnchoke-status-string}.
29318 @node Writing New Back Ends
29319 @subsubsection Writing New Back Ends
29321 Many back ends are quite similar. @code{nnml} is just like
29322 @code{nnspool}, but it allows you to edit the articles on the server.
29323 @code{nnmh} is just like @code{nnml}, but it doesn't use an active file,
29324 and it doesn't maintain overview databases. @code{nndir} is just like
29325 @code{nnml}, but it has no concept of ``groups'', and it doesn't allow
29328 It would make sense if it were possible to ``inherit'' functions from
29329 back ends when writing new back ends. And, indeed, you can do that if you
29330 want to. (You don't have to if you don't want to, of course.)
29332 All the back ends declare their public variables and functions by using a
29333 package called @code{nnoo}.
29335 To inherit functions from other back ends (and allow other back ends to
29336 inherit functions from the current back end), you should use the
29342 This macro declares the first parameter to be a child of the subsequent
29343 parameters. For instance:
29346 (nnoo-declare nndir
29350 @code{nndir} has declared here that it intends to inherit functions from
29351 both @code{nnml} and @code{nnmh}.
29354 This macro is equivalent to @code{defvar}, but registers the variable as
29355 a public server variable. Most state-oriented variables should be
29356 declared with @code{defvoo} instead of @code{defvar}.
29358 In addition to the normal @code{defvar} parameters, it takes a list of
29359 variables in the parent back ends to map the variable to when executing
29360 a function in those back ends.
29363 (defvoo nndir-directory nil
29364 "Where nndir will look for groups."
29365 nnml-current-directory nnmh-current-directory)
29368 This means that @code{nnml-current-directory} will be set to
29369 @code{nndir-directory} when an @code{nnml} function is called on behalf
29370 of @code{nndir}. (The same with @code{nnmh}.)
29372 @item nnoo-define-basics
29373 This macro defines some common functions that almost all back ends should
29377 (nnoo-define-basics nndir)
29381 This macro is just like @code{defun} and takes the same parameters. In
29382 addition to doing the normal @code{defun} things, it registers the
29383 function as being public so that other back ends can inherit it.
29385 @item nnoo-map-functions
29386 This macro allows mapping of functions from the current back end to
29387 functions from the parent back ends.
29390 (nnoo-map-functions nndir
29391 (nnml-retrieve-headers 0 nndir-current-group 0 0)
29392 (nnmh-request-article 0 nndir-current-group 0 0))
29395 This means that when @code{nndir-retrieve-headers} is called, the first,
29396 third, and fourth parameters will be passed on to
29397 @code{nnml-retrieve-headers}, while the second parameter is set to the
29398 value of @code{nndir-current-group}.
29401 This macro allows importing functions from back ends. It should be the
29402 last thing in the source file, since it will only define functions that
29403 haven't already been defined.
29409 nnmh-request-newgroups)
29413 This means that calls to @code{nndir-request-list} should just be passed
29414 on to @code{nnmh-request-list}, while all public functions from
29415 @code{nnml} that haven't been defined in @code{nndir} yet should be
29420 Below is a slightly shortened version of the @code{nndir} back end.
29423 ;;; @r{nndir.el --- single directory newsgroup access for Gnus}
29424 ;; @r{Copyright (C) 1995,96 Free Software Foundation, Inc.}
29428 (require 'nnheader)
29432 (eval-when-compile (require 'cl))
29434 (nnoo-declare nndir
29437 (defvoo nndir-directory nil
29438 "Where nndir will look for groups."
29439 nnml-current-directory nnmh-current-directory)
29441 (defvoo nndir-nov-is-evil nil
29442 "*Non-nil means that nndir will never retrieve NOV headers."
29445 (defvoo nndir-current-group ""
29447 nnml-current-group nnmh-current-group)
29448 (defvoo nndir-top-directory nil nil nnml-directory nnmh-directory)
29449 (defvoo nndir-get-new-mail nil nil nnml-get-new-mail nnmh-get-new-mail)
29451 (defvoo nndir-status-string "" nil nnmh-status-string)
29452 (defconst nndir-version "nndir 1.0")
29454 ;;; @r{Interface functions.}
29456 (nnoo-define-basics nndir)
29458 (deffoo nndir-open-server (server &optional defs)
29459 (setq nndir-directory
29460 (or (cadr (assq 'nndir-directory defs))
29462 (unless (assq 'nndir-directory defs)
29463 (push `(nndir-directory ,server) defs))
29464 (push `(nndir-current-group
29465 ,(file-name-nondirectory
29466 (directory-file-name nndir-directory)))
29468 (push `(nndir-top-directory
29469 ,(file-name-directory (directory-file-name nndir-directory)))
29471 (nnoo-change-server 'nndir server defs))
29473 (nnoo-map-functions nndir
29474 (nnml-retrieve-headers 0 nndir-current-group 0 0)
29475 (nnmh-request-article 0 nndir-current-group 0 0)
29476 (nnmh-request-group nndir-current-group 0 0)
29477 (nnmh-close-group nndir-current-group 0))
29481 nnmh-status-message
29483 nnmh-request-newgroups))
29489 @node Hooking New Back Ends Into Gnus
29490 @subsubsection Hooking New Back Ends Into Gnus
29492 @vindex gnus-valid-select-methods
29493 @findex gnus-declare-backend
29494 Having Gnus start using your new back end is rather easy---you just
29495 declare it with the @code{gnus-declare-backend} functions. This will
29496 enter the back end into the @code{gnus-valid-select-methods} variable.
29498 @code{gnus-declare-backend} takes two parameters---the back end name and
29499 an arbitrary number of @dfn{abilities}.
29504 (gnus-declare-backend "nnchoke" 'mail 'respool 'address)
29507 The above line would then go in the @file{nnchoke.el} file.
29509 The abilities can be:
29513 This is a mailish back end---followups should (probably) go via mail.
29515 This is a newsish back end---followups should (probably) go via news.
29517 This back end supports both mail and news.
29519 This is neither a post nor mail back end---it's something completely
29522 It supports respooling---or rather, it is able to modify its source
29523 articles and groups.
29525 The name of the server should be in the virtual server name. This is
29526 true for almost all back ends.
29527 @item prompt-address
29528 The user should be prompted for an address when doing commands like
29529 @kbd{B} in the group buffer. This is true for back ends like
29530 @code{nntp}, but not @code{nnmbox}, for instance.
29534 @node Mail-like Back Ends
29535 @subsubsection Mail-like Back Ends
29537 One of the things that separate the mail back ends from the rest of the
29538 back ends is the heavy dependence by most of the mail back ends on
29539 common functions in @file{nnmail.el}. For instance, here's the
29540 definition of @code{nnml-request-scan}:
29543 (deffoo nnml-request-scan (&optional group server)
29544 (setq nnml-article-file-alist nil)
29545 (nnmail-get-new-mail 'nnml 'nnml-save-nov nnml-directory group))
29548 It simply calls @code{nnmail-get-new-mail} with a few parameters,
29549 and @code{nnmail} takes care of all the moving and splitting of the
29552 This function takes four parameters.
29556 This should be a symbol to designate which back end is responsible for
29559 @item exit-function
29560 This function should be called after the splitting has been performed.
29562 @item temp-directory
29563 Where the temporary files should be stored.
29566 This optional argument should be a group name if the splitting is to be
29567 performed for one group only.
29570 @code{nnmail-get-new-mail} will call @var{back-end}@code{-save-mail} to
29571 save each article. @var{back-end}@code{-active-number} will be called to
29572 find the article number assigned to this article.
29574 The function also uses the following variables:
29575 @var{back-end}@code{-get-new-mail} (to see whether to get new mail for
29576 this back end); and @var{back-end}@code{-group-alist} and
29577 @var{back-end}@code{-active-file} to generate the new active file.
29578 @var{back-end}@code{-group-alist} should be a group-active alist, like
29582 (("a-group" (1 . 10))
29583 ("some-group" (34 . 39)))
29587 @node Score File Syntax
29588 @subsection Score File Syntax
29590 Score files are meant to be easily parseable, but yet extremely
29591 mallable. It was decided that something that had the same read syntax
29592 as an Emacs Lisp list would fit that spec.
29594 Here's a typical score file:
29598 ("win95" -10000 nil s)
29605 BNF definition of a score file:
29608 score-file = "" / "(" *element ")"
29609 element = rule / atom
29610 rule = string-rule / number-rule / date-rule
29611 string-rule = "(" quote string-header quote space *string-match ")"
29612 number-rule = "(" quote number-header quote space *number-match ")"
29613 date-rule = "(" quote date-header quote space *date-match ")"
29615 string-header = "subject" / "from" / "references" / "message-id" /
29616 "xref" / "body" / "head" / "all" / "followup"
29617 number-header = "lines" / "chars"
29618 date-header = "date"
29619 string-match = "(" quote <string> quote [ "" / [ space score [ "" /
29620 space date [ "" / [ space string-match-t ] ] ] ] ] ")"
29621 score = "nil" / <integer>
29622 date = "nil" / <natural number>
29623 string-match-t = "nil" / "s" / "substring" / "S" / "Substring" /
29624 "r" / "regex" / "R" / "Regex" /
29625 "e" / "exact" / "E" / "Exact" /
29626 "f" / "fuzzy" / "F" / "Fuzzy"
29627 number-match = "(" <integer> [ "" / [ space score [ "" /
29628 space date [ "" / [ space number-match-t ] ] ] ] ] ")"
29629 number-match-t = "nil" / "=" / "<" / ">" / ">=" / "<="
29630 date-match = "(" quote <string> quote [ "" / [ space score [ "" /
29631 space date [ "" / [ space date-match-t ] ] ] ] ")"
29632 date-match-t = "nil" / "at" / "before" / "after"
29633 atom = "(" [ required-atom / optional-atom ] ")"
29634 required-atom = mark / expunge / mark-and-expunge / files /
29635 exclude-files / read-only / touched
29636 optional-atom = adapt / local / eval
29637 mark = "mark" space nil-or-number
29638 nil-or-number = "nil" / <integer>
29639 expunge = "expunge" space nil-or-number
29640 mark-and-expunge = "mark-and-expunge" space nil-or-number
29641 files = "files" *[ space <string> ]
29642 exclude-files = "exclude-files" *[ space <string> ]
29643 read-only = "read-only" [ space "nil" / space "t" ]
29644 adapt = "adapt" [ space "ignore" / space "t" / space adapt-rule ]
29645 adapt-rule = "(" *[ <string> *[ "(" <string> <integer> ")" ] ")"
29646 local = "local" *[ space "(" <string> space <form> ")" ]
29647 eval = "eval" space <form>
29648 space = *[ " " / <TAB> / <NEWLINE> ]
29651 Any unrecognized elements in a score file should be ignored, but not
29654 As you can see, white space is needed, but the type and amount of white
29655 space is irrelevant. This means that formatting of the score file is
29656 left up to the programmer---if it's simpler to just spew it all out on
29657 one looong line, then that's ok.
29659 The meaning of the various atoms are explained elsewhere in this
29660 manual (@pxref{Score File Format}).
29664 @subsection Headers
29666 Internally Gnus uses a format for storing article headers that
29667 corresponds to the @acronym{NOV} format in a mysterious fashion. One could
29668 almost suspect that the author looked at the @acronym{NOV} specification and
29669 just shamelessly @emph{stole} the entire thing, and one would be right.
29671 @dfn{Header} is a severely overloaded term. ``Header'' is used in
29672 RFC 1036 to talk about lines in the head of an article (e.g.,
29673 @code{From}). It is used by many people as a synonym for
29674 ``head''---``the header and the body''. (That should be avoided, in my
29675 opinion.) And Gnus uses a format internally that it calls ``header'',
29676 which is what I'm talking about here. This is a 9-element vector,
29677 basically, with each header (ouch) having one slot.
29679 These slots are, in order: @code{number}, @code{subject}, @code{from},
29680 @code{date}, @code{id}, @code{references}, @code{chars}, @code{lines},
29681 @code{xref}, and @code{extra}. There are macros for accessing and
29682 setting these slots---they all have predictable names beginning with
29683 @code{mail-header-} and @code{mail-header-set-}, respectively.
29685 All these slots contain strings, except the @code{extra} slot, which
29686 contains an alist of header/value pairs (@pxref{To From Newsgroups}).
29692 @sc{gnus} introduced a concept that I found so useful that I've started
29693 using it a lot and have elaborated on it greatly.
29695 The question is simple: If you have a large amount of objects that are
29696 identified by numbers (say, articles, to take a @emph{wild} example)
29697 that you want to qualify as being ``included'', a normal sequence isn't
29698 very useful. (A 200,000 length sequence is a bit long-winded.)
29700 The solution is as simple as the question: You just collapse the
29704 (1 2 3 4 5 6 10 11 12)
29707 is transformed into
29710 ((1 . 6) (10 . 12))
29713 To avoid having those nasty @samp{(13 . 13)} elements to denote a
29714 lonesome object, a @samp{13} is a valid element:
29717 ((1 . 6) 7 (10 . 12))
29720 This means that comparing two ranges to find out whether they are equal
29721 is slightly tricky:
29724 ((1 . 5) 7 8 (10 . 12))
29730 ((1 . 5) (7 . 8) (10 . 12))
29733 are equal. In fact, any non-descending list is a range:
29739 is a perfectly valid range, although a pretty long-winded one. This is
29746 and is equal to the previous range.
29748 Here's a BNF definition of ranges. Of course, one must remember the
29749 semantic requirement that the numbers are non-descending. (Any number
29750 of repetition of the same number is allowed, but apt to disappear in
29754 range = simple-range / normal-range
29755 simple-range = "(" number " . " number ")"
29756 normal-range = "(" start-contents ")"
29757 contents = "" / simple-range *[ " " contents ] /
29758 number *[ " " contents ]
29761 Gnus currently uses ranges to keep track of read articles and article
29762 marks. I plan on implementing a number of range operators in C if The
29763 Powers That Be are willing to let me. (I haven't asked yet, because I
29764 need to do some more thinking on what operators I need to make life
29765 totally range-based without ever having to convert back to normal
29770 @subsection Group Info
29772 Gnus stores all permanent info on groups in a @dfn{group info} list.
29773 This list is from three to six elements (or more) long and exhaustively
29774 describes the group.
29776 Here are two example group infos; one is a very simple group while the
29777 second is a more complex one:
29780 ("no.group" 5 ((1 . 54324)))
29782 ("nnml:my.mail" 3 ((1 . 5) 9 (20 . 55))
29783 ((tick (15 . 19)) (replied 3 6 (19 . 3)))
29785 ((auto-expire . t) (to-address . "ding@@gnus.org")))
29788 The first element is the @dfn{group name}---as Gnus knows the group,
29789 anyway. The second element is the @dfn{subscription level}, which
29790 normally is a small integer. (It can also be the @dfn{rank}, which is a
29791 cons cell where the @code{car} is the level and the @code{cdr} is the
29792 score.) The third element is a list of ranges of read articles. The
29793 fourth element is a list of lists of article marks of various kinds.
29794 The fifth element is the select method (or virtual server, if you like).
29795 The sixth element is a list of @dfn{group parameters}, which is what
29796 this section is about.
29798 Any of the last three elements may be missing if they are not required.
29799 In fact, the vast majority of groups will normally only have the first
29800 three elements, which saves quite a lot of cons cells.
29802 Here's a BNF definition of the group info format:
29805 info = "(" group space ralevel space read
29806 [ "" / [ space marks-list [ "" / [ space method [ "" /
29807 space parameters ] ] ] ] ] ")"
29808 group = quote <string> quote
29809 ralevel = rank / level
29810 level = <integer in the range of 1 to inf>
29811 rank = "(" level "." score ")"
29812 score = <integer in the range of 1 to inf>
29814 marks-lists = nil / "(" *marks ")"
29815 marks = "(" <string> range ")"
29816 method = "(" <string> *elisp-forms ")"
29817 parameters = "(" *elisp-forms ")"
29820 Actually that @samp{marks} rule is a fib. A @samp{marks} is a
29821 @samp{<string>} consed on to a @samp{range}, but that's a bitch to say
29824 If you have a Gnus info and want to access the elements, Gnus offers a
29825 series of macros for getting/setting these elements.
29828 @item gnus-info-group
29829 @itemx gnus-info-set-group
29830 @findex gnus-info-group
29831 @findex gnus-info-set-group
29832 Get/set the group name.
29834 @item gnus-info-rank
29835 @itemx gnus-info-set-rank
29836 @findex gnus-info-rank
29837 @findex gnus-info-set-rank
29838 Get/set the group rank (@pxref{Group Score}).
29840 @item gnus-info-level
29841 @itemx gnus-info-set-level
29842 @findex gnus-info-level
29843 @findex gnus-info-set-level
29844 Get/set the group level.
29846 @item gnus-info-score
29847 @itemx gnus-info-set-score
29848 @findex gnus-info-score
29849 @findex gnus-info-set-score
29850 Get/set the group score (@pxref{Group Score}).
29852 @item gnus-info-read
29853 @itemx gnus-info-set-read
29854 @findex gnus-info-read
29855 @findex gnus-info-set-read
29856 Get/set the ranges of read articles.
29858 @item gnus-info-marks
29859 @itemx gnus-info-set-marks
29860 @findex gnus-info-marks
29861 @findex gnus-info-set-marks
29862 Get/set the lists of ranges of marked articles.
29864 @item gnus-info-method
29865 @itemx gnus-info-set-method
29866 @findex gnus-info-method
29867 @findex gnus-info-set-method
29868 Get/set the group select method.
29870 @item gnus-info-params
29871 @itemx gnus-info-set-params
29872 @findex gnus-info-params
29873 @findex gnus-info-set-params
29874 Get/set the group parameters.
29877 All the getter functions take one parameter---the info list. The setter
29878 functions take two parameters---the info list and the new value.
29880 The last three elements in the group info aren't mandatory, so it may be
29881 necessary to extend the group info before setting the element. If this
29882 is necessary, you can just pass on a non-@code{nil} third parameter to
29883 the three final setter functions to have this happen automatically.
29886 @node Extended Interactive
29887 @subsection Extended Interactive
29888 @cindex interactive
29889 @findex gnus-interactive
29891 Gnus extends the standard Emacs @code{interactive} specification
29892 slightly to allow easy use of the symbolic prefix (@pxref{Symbolic
29893 Prefixes}). Here's an example of how this is used:
29896 (defun gnus-summary-increase-score (&optional score symp)
29897 (interactive (gnus-interactive "P\ny"))
29902 The best thing to do would have been to implement
29903 @code{gnus-interactive} as a macro which would have returned an
29904 @code{interactive} form, but this isn't possible since Emacs checks
29905 whether a function is interactive or not by simply doing an @code{assq}
29906 on the lambda form. So, instead we have @code{gnus-interactive}
29907 function that takes a string and returns values that are usable to
29908 @code{interactive}.
29910 This function accepts (almost) all normal @code{interactive} specs, but
29915 @vindex gnus-current-prefix-symbol
29916 The current symbolic prefix---the @code{gnus-current-prefix-symbol}
29920 @vindex gnus-current-prefix-symbols
29921 A list of the current symbolic prefixes---the
29922 @code{gnus-current-prefix-symbol} variable.
29925 The current article number---the @code{gnus-summary-article-number}
29929 The current article header---the @code{gnus-summary-article-header}
29933 The current group name---the @code{gnus-group-group-name}
29939 @node Emacs/XEmacs Code
29940 @subsection Emacs/XEmacs Code
29944 While Gnus runs under Emacs, XEmacs and Mule, I decided that one of the
29945 platforms must be the primary one. I chose Emacs. Not because I don't
29946 like XEmacs or Mule, but because it comes first alphabetically.
29948 This means that Gnus will byte-compile under Emacs with nary a warning,
29949 while XEmacs will pump out gigabytes of warnings while byte-compiling.
29950 As I use byte-compilation warnings to help me root out trivial errors in
29951 Gnus, that's very useful.
29953 I've also consistently used Emacs function interfaces, but have used
29954 Gnusey aliases for the functions. To take an example: Emacs defines a
29955 @code{run-at-time} function while XEmacs defines a @code{start-itimer}
29956 function. I then define a function called @code{gnus-run-at-time} that
29957 takes the same parameters as the Emacs @code{run-at-time}. When running
29958 Gnus under Emacs, the former function is just an alias for the latter.
29959 However, when running under XEmacs, the former is an alias for the
29960 following function:
29963 (defun gnus-xmas-run-at-time (time repeat function &rest args)
29967 (,function ,@@args))
29971 This sort of thing has been done for bunches of functions. Gnus does
29972 not redefine any native Emacs functions while running under XEmacs---it
29973 does this @code{defalias} thing with Gnus equivalents instead. Cleaner
29976 In the cases where the XEmacs function interface was obviously cleaner,
29977 I used it instead. For example @code{gnus-region-active-p} is an alias
29978 for @code{region-active-p} in XEmacs, whereas in Emacs it is a function.
29980 Of course, I could have chosen XEmacs as my native platform and done
29981 mapping functions the other way around. But I didn't. The performance
29982 hit these indirections impose on Gnus under XEmacs should be slight.
29985 @node Various File Formats
29986 @subsection Various File Formats
29989 * Active File Format:: Information on articles and groups available.
29990 * Newsgroups File Format:: Group descriptions.
29994 @node Active File Format
29995 @subsubsection Active File Format
29997 The active file lists all groups available on the server in
29998 question. It also lists the highest and lowest current article numbers
30001 Here's an excerpt from a typical active file:
30004 soc.motss 296030 293865 y
30005 alt.binaries.pictures.fractals 3922 3913 n
30006 comp.sources.unix 1605 1593 m
30007 comp.binaries.ibm.pc 5097 5089 y
30008 no.general 1000 900 y
30011 Here's a pseudo-BNF definition of this file:
30014 active = *group-line
30015 group-line = group spc high-number spc low-number spc flag <NEWLINE>
30016 group = <non-white-space string>
30018 high-number = <non-negative integer>
30019 low-number = <positive integer>
30020 flag = "y" / "n" / "m" / "j" / "x" / "=" group
30023 For a full description of this file, see the manual pages for
30024 @samp{innd}, in particular @samp{active(5)}.
30027 @node Newsgroups File Format
30028 @subsubsection Newsgroups File Format
30030 The newsgroups file lists groups along with their descriptions. Not all
30031 groups on the server have to be listed, and not all groups in the file
30032 have to exist on the server. The file is meant purely as information to
30035 The format is quite simple; a group name, a tab, and the description.
30036 Here's the definition:
30040 line = group tab description <NEWLINE>
30041 group = <non-white-space string>
30043 description = <string>
30048 @node Emacs for Heathens
30049 @section Emacs for Heathens
30051 Believe it or not, but some people who use Gnus haven't really used
30052 Emacs much before they embarked on their journey on the Gnus Love Boat.
30053 If you are one of those unfortunates whom ``@kbd{C-M-a}'', ``kill the
30054 region'', and ``set @code{gnus-flargblossen} to an alist where the key
30055 is a regexp that is used for matching on the group name'' are magical
30056 phrases with little or no meaning, then this appendix is for you. If
30057 you are already familiar with Emacs, just ignore this and go fondle your
30061 * Keystrokes:: Entering text and executing commands.
30062 * Emacs Lisp:: The built-in Emacs programming language.
30067 @subsection Keystrokes
30071 Q: What is an experienced Emacs user?
30074 A: A person who wishes that the terminal had pedals.
30077 Yes, when you use Emacs, you are apt to use the control key, the shift
30078 key and the meta key a lot. This is very annoying to some people
30079 (notably @code{vi}le users), and the rest of us just love the hell out
30080 of it. Just give up and submit. Emacs really does stand for
30081 ``Escape-Meta-Alt-Control-Shift'', and not ``Editing Macros'', as you
30082 may have heard from other disreputable sources (like the Emacs author).
30084 The shift keys are normally located near your pinky fingers, and are
30085 normally used to get capital letters and stuff. You probably use it all
30086 the time. The control key is normally marked ``CTRL'' or something like
30087 that. The meta key is, funnily enough, never marked as such on any
30088 keyboard. The one I'm currently at has a key that's marked ``Alt'',
30089 which is the meta key on this keyboard. It's usually located somewhere
30090 to the left hand side of the keyboard, usually on the bottom row.
30092 Now, us Emacs people don't say ``press the meta-control-m key'',
30093 because that's just too inconvenient. We say ``press the @kbd{C-M-m}
30094 key''. @kbd{M-} is the prefix that means ``meta'' and ``C-'' is the
30095 prefix that means ``control''. So ``press @kbd{C-k}'' means ``press
30096 down the control key, and hold it down while you press @kbd{k}''.
30097 ``Press @kbd{C-M-k}'' means ``press down and hold down the meta key and
30098 the control key and then press @kbd{k}''. Simple, ay?
30100 This is somewhat complicated by the fact that not all keyboards have a
30101 meta key. In that case you can use the ``escape'' key. Then @kbd{M-k}
30102 means ``press escape, release escape, press @kbd{k}''. That's much more
30103 work than if you have a meta key, so if that's the case, I respectfully
30104 suggest you get a real keyboard with a meta key. You can't live without
30110 @subsection Emacs Lisp
30112 Emacs is the King of Editors because it's really a Lisp interpreter.
30113 Each and every key you tap runs some Emacs Lisp code snippet, and since
30114 Emacs Lisp is an interpreted language, that means that you can configure
30115 any key to run any arbitrary code. You just, like, do it.
30117 Gnus is written in Emacs Lisp, and is run as a bunch of interpreted
30118 functions. (These are byte-compiled for speed, but it's still
30119 interpreted.) If you decide that you don't like the way Gnus does
30120 certain things, it's trivial to have it do something a different way.
30121 (Well, at least if you know how to write Lisp code.) However, that's
30122 beyond the scope of this manual, so we are simply going to talk about
30123 some common constructs that you normally use in your @file{~/.gnus.el}
30124 file to customize Gnus. (You can also use the @file{~/.emacs} file, but
30125 in order to set things of Gnus up, it is much better to use the
30126 @file{~/.gnus.el} file, @xref{Startup Files}.)
30128 If you want to set the variable @code{gnus-florgbnize} to four (4), you
30129 write the following:
30132 (setq gnus-florgbnize 4)
30135 This function (really ``special form'') @code{setq} is the one that can
30136 set a variable to some value. This is really all you need to know. Now
30137 you can go and fill your @file{~/.gnus.el} file with lots of these to
30138 change how Gnus works.
30140 If you have put that thing in your @file{~/.gnus.el} file, it will be
30141 read and @code{eval}ed (which is Lisp-ese for ``run'') the next time you
30142 start Gnus. If you want to change the variable right away, simply say
30143 @kbd{C-x C-e} after the closing parenthesis. That will @code{eval} the
30144 previous ``form'', which is a simple @code{setq} statement here.
30146 Go ahead---just try it, if you're located at your Emacs. After you
30147 @kbd{C-x C-e}, you will see @samp{4} appear in the echo area, which
30148 is the return value of the form you @code{eval}ed.
30152 If the manual says ``set @code{gnus-read-active-file} to @code{some}'',
30156 (setq gnus-read-active-file 'some)
30159 On the other hand, if the manual says ``set @code{gnus-nntp-server} to
30160 @samp{nntp.ifi.uio.no}'', that means:
30163 (setq gnus-nntp-server "nntp.ifi.uio.no")
30166 So be careful not to mix up strings (the latter) with symbols (the
30167 former). The manual is unambiguous, but it can be confusing.
30170 @include gnus-faq.texi
30172 @node GNU Free Documentation License
30173 @chapter GNU Free Documentation License
30174 @include doclicense.texi
30194 @c Local Variables:
30196 @c coding: iso-8859-1
30200 arch-tag: c9fa47e7-78ca-4681-bda9-9fef45d1c819